포장 전주곡 :

리소스 파일 읽기에 대해 걱정하기 전에 첫 번째 단계는 데이터 파일이 처음에 배포판에 패키징되었는지 확인하는 것입니다. 소스 트리에서 직접 쉽게 읽을 수 있지만 중요한 부분은 이러한 리소스 파일이 설치된 패키지 내의 코드에서 액세스 할 수 있는지 확인하십시오 .

다음과 같이 프로젝트를 구조화하여 데이터 파일을 패키지 내의 하위 디렉토리에 넣습니다 .

.
├── package
│   ├── __init__.py
│   ├── templates
│   │   └── temp_file
│   ├── mymodule1.py
│   └── mymodule2.py
├── README.rst
├── MANIFEST.in
└── setup.py

당신은 통과해야 include_package_data=True에 setup()전화를 겁니다. 매니페스트 파일은 setuptools / distutils를 사용하고 소스 배포를 빌드하려는 경우에만 필요합니다. templates/temp_file이 예제 프로젝트 구조에 대해 패키지를 가져 오려면 매니페스트 파일에 다음과 같은 줄을 추가하십시오.

recursive-include package *

역사적인 cruft note : 기본적으로 패키지 데이터 파일을 포함하는 flit, poetry와 같은 최신 빌드 백엔드에는 매니페스트 파일을 사용할 필요가 없습니다 . 따라서 사용 중이고 파일 pyproject.toml이없는 경우 .setup.pyMANIFEST.in

이제 포장을 벗어난 상태에서 읽기 부분에 …

추천:

표준 라이브러리 pkgutilAPI를 사용하십시오 . 라이브러리 코드에서 다음과 같이 보일 것입니다.

# within package/mymodule1.py, for example
import pkgutil

data = pkgutil.get_data(__name__, "templates/temp_file")
print("data:", repr(data))
text = pkgutil.get_data(__name__, "templates/temp_file").decode()
print("text:", repr(text))

그것은 zip에서 작동합니다. Python 2 및 Python 3에서 작동합니다. 타사 종속성이 필요하지 않습니다. 나는 실제로 어떤 단점도 알고 있지 않습니다 (당신이 있다면 대답에 대해 언급하십시오).

피하는 나쁜 방법 :

나쁜 방법 # 1 : 소스 파일의 상대 경로 사용

이것은 현재 허용되는 답변입니다. 기껏해야 다음과 같이 보입니다.

from pathlib import Path

resource_path = Path(__file__).parent / "templates"
data = resource_path.joinpath("temp_file").read_bytes()
print("data", repr(data))

그게 무슨 문제입니까? 사용 가능한 파일 및 하위 디렉토리가 있다는 가정이 올바르지 않습니다. 이 접근 방식은 zip 또는 wheel로 압축 된 코드를 실행하는 경우에는 작동하지 않으며 패키지가 파일 시스템으로 추출되는지 여부에 관계없이 완전히 사용자가 제어 할 수 없습니다.

나쁜 방법 # 2 : pkg_resources API 사용

이것은 최고 투표 답변에 설명되어 있습니다. 다음과 같이 보입니다.

from pkg_resources import resource_string

data = resource_string(__name__, "templates/temp_file")
print("data", repr(data))

그게 무슨 문제입니까? setuptools 에 대한 런타임 종속성을 추가합니다. 이는 바람직하게는 설치 시간 종속성 이어야 합니다. 코드가 설치된 모든 패키지 의 작업 세트를 구축하기 때문에 가져 오기 및 사용 이 정말 느려질 수 있습니다.pkg_resources 패키지 리소스 . 설치시에는 큰 문제는 아니지만 (설치가 한 번만 종료되기 때문에) 런타임에는보기 흉합니다.

나쁜 방법 # 3 : importlib.resources API 사용

이것은 현재 최다 투표 답변의 권장 사항입니다. 최근 표준 라이브러리 추가 ( Python 3.7의 새로운 기능 )이지만 백 포트도 사용할 수 있습니다. 다음과 같이 보입니다.

try:
    from importlib.resources import read_binary
    from importlib.resources import read_text
except ImportError:
    # Python 2.x backport
    from importlib_resources import read_binary
    from importlib_resources import read_text

data = read_binary("package.templates", "temp_file")
print("data", repr(data))
text = read_text("package.templates", "temp_file")
print("text", repr(text))

그게 무슨 문제입니까? 글쎄, 안타깝게도 아직 작동하지 않습니다. 이는 여전히 불완전한 API이므로을 사용 importlib.resources하면 templates/__init__.py데이터 파일이 하위 디렉토리가 아닌 하위 패키지 내에 상주 하도록 빈 파일을 추가해야합니다 . 또한 package/templates하위 디렉토리를 package.templates자체적으로 가져올 수있는 하위 패키지 로 노출합니다 . 그다지 큰 문제가 아니고 불편하지 않다면 계속해서 __init__.py파일을 추가 하고 가져 오기 시스템을 사용하여 리소스에 액세스 할 수 있습니다. 그러나 그 동안 my_resources.py파일 로 만들고 모듈에서 일부 바이트 또는 문자열 변수를 정의한 다음 Python 코드로 가져 오는 것이 좋습니다. 여기서 어느 쪽이든 무거운 작업을 수행하는 것은 수입 시스템입니다.

예제 프로젝트 :

github 에서 예제 프로젝트를 만들고 PyPI에 업로드했습니다 . 위에서 설명한 네 가지 접근 방식을 모두 보여줍니다. 다음과 같이 사용해보십시오.

$ pip install resources-example
$ resources-example

자세한 내용은 https://github.com/wimglenn/resources-example 을 참조 하십시오 .

답변

lidtk
├── bin
│   └── lidtk
├── lidtk
│   ├── analysis
│   │   ├── char_distribution.py
│   │   └── create_cm.py
│   ├── classifiers
│   │   ├── char_dist_metric_train_test.py
│   │   ├── char_features.py
│   │   ├── cld2
│   │   │   ├── cld2_preds.txt
│   │   │   └── cld2wili.py
│   │   ├── get_cld2.py
│   │   ├── text_cat
│   │   │   ├── __init__.py
│   │   │   ├── README.md   <---------- say you want to get this
│   │   │   └── textcat_ngram.py
│   │   └── tfidf_features.py
│   ├── data
│   │   ├── __init__.py
│   │   ├── create_ml_dataset.py
│   │   ├── download_documents.py
│   │   ├── language_utils.py
│   │   ├── pickle_to_txt.py
│   │   └── wili.py
│   ├── __init__.py
│   ├── get_predictions.py
│   ├── languages.csv
│   └── utils.py
├── README.md
├── setup.cfg
└── setup.py

import pkg_resources

# __name__ in case you're within the package
# - otherwise it would be 'lidtk' in this example as it is the package name
path = 'classifiers/text_cat/README.md'  # always use slash
filepath = pkg_resources.resource_filename(__name__, path)

mypackage/
    __init__.py
    somedata.dat
    spam.py

import pkgutil
data = pkgutil.get_data(__package__, 'somedata.dat')

import os
from mypackage

templates_dir = os.path.join(os.path.dirname(mypackage.__file__), 'templates')
template_file = os.path.join(templates_dir, 'template.txt')

os.environ['PYTHON_EGG_CACHE'] = path