Поиск файла в дистрибутиве модуля Python

Question

Я написал пакет Python, который включает в себя базу данных bsddb с предварительно вычисленными значениями для одного из более трудоемких вычислений. Для простоты мой установочный скрипт устанавливает файл базы данных в тот же каталог, что и код, который обращается к базе данных (в Unix что-то вроде /usr/lib/python2.5/site-packages/mypackage/).

Как сохранить окончательное местоположение файла базы данных, чтобы мой код мог получить к нему доступ? Прямо сейчас я использую взлом на основе __file__ переменная в модуле, которая обращается к базе данных:

dbname = os.path.join (os.path.dirname (__ file__), "database.dat")

Это работает, но кажется... хакерским. Есть лучший способ сделать это? Мне бы хотелось, чтобы скрипт установки просто взял окончательное место установки из модуля distutils и поместил его в файл "dbconfig.py", который устанавливается вместе с кодом, который обращается к базе данных.

Answer 1

Попробуйте использовать pkg_resources, который является частью setuptools (и доступен на всех питонах, к которым у меня есть доступ прямо сейчас):

>>> import pkg_resources
>>> pkg_resources.resource_ filename(__name__, "foo.config")
'foo.config'
>>> pkg_resources.resource_filename('tempfile', "foo.config")
'/usr/lib/python2.4/foo.config'

Более подробно обсуждается использование pkg_resources для получения ресурсов на странице яйца и на странице pkg_resources.

Также обратите внимание, что, где это возможно, рекомендуется использовать pkg_resources.resource_stream или pkg_resources.resource_string, потому что, если пакет является частью яйца, resource_filename скопирует файл во временный каталог.

Answer 2

Использование pkgutil.get_data, Это двоюродный брат pkg_resources.resource_stream, но в стандартной библиотеке, и должен работать как с плоскими установками файловой системы, так и с заархивированными пакетами и другими импортерами.

Answer 3

Это, вероятно, способ сделать это, не прибегая к чему-то более сложному, например, используя setuptools для установки файлов, к которым они принадлежат.

Обратите внимание, что есть проблема с этим подходом, потому что в ОС с реальной структурой безопасности (UNIX и т. Д.) Пользователь, выполняющий ваш сценарий, может не иметь прав доступа к БД в системном каталоге, где он установлен.

Answer 4

Используйте стандартную библиотеку Python-3.7 importlib.resourcesмодуль, который более эффективен, чем setuptools:pkg_resources(в предыдущих версиях Python используйте importlib_resourcesбиблиотека).

Внимание: чтобы это работало, папка, в которой находится файл данных, должна быть обычным пакетом python. Это означает, что вы должны добавить__init__.py файл в него, если еще не там.

Тогда вы можете получить к нему доступ так:

try:
  import importlib.resources as importlib_resources
except ImportError:
  # In PY<3.7 fall-back to backported `importlib_resources`.
  import importlib_resources


## Note that the actual package could have been used, 
#  not just its (string) name, with something like: 
#      from XXX import YYY as data_pkg
data_pkg = '.'
fname = 'database.dat'

db_bytes = importlib_resources.read_binary(data_pkg, fname)
# or if a file-like stream is needed:
with importlib_resources.open_binary(data_pkg, fname) as db_file:
    ...