Как получить доступ к метаданным пакета python из консоли python?

Question

Если я создал пакет python с использованием distutils.core, например. через

setup(
    ext_package="foo", 
    author="me", 
    version="1.0", 
    description="foo package", 
    packages=["foo",], 
) 

где все метаданные идут (для чего это предназначено?) и как я могу получить к нему доступ изнутри python. В частности, как я могу получить информацию об авторе из консоли питона после делать что-то вроде

>>> import foo 

Answer 1

Один способ получить доступ к метаданным является использование pip:

import pip 

package = [pckg for pckg in pip.get_installed_distributions() 
      if pckg.project_name == 'package_name'][0] 
# package var will contain some metadata: version, project_name and others. 

или pkg_resources

from pkg_resources import get_distribution 

pkg = get_distribution('package_name') # also contains a metadata 

Answer 2

Метаданные хранятся в файле <package>-<version>-<py version>.egg-info.

при создании модуля, вы должны иметь следующую строку:

Writing /usr/lib/python2.7/site-packages/foobar-1.0-py2.7.egg-info

Этот файл содержит метаданные:

Metadata-Version: 1.0 
Name: Foobar 
Version: 1.0 
Summary: foobar 
Home-page: http://foobar.com/ 
Author: foobar 
Author-email: foobar@foobar.net 
License: UNKNOWN 
Description: UNKNOWN 
Platform: UNKNOWN 

Если вы хотите получить доступ к нему, лучший способ с pip или pkg_resources (по словам Александра Жукова) ex:

>>> import pkg_resources 
>>> d = pkg_resources.get_distribution('Foobar') 
>>> d.version 
'1.0' 
>>> d.location 
'/usr/lib/python2.7/site-packages' 

Answer 3

Одно из этих данных заключается в том, что оно отображается на Pypi (http://pypi.python.org/), если вы собираетесь опубликовать свой пакет там. Один из способов структурировать, как так:

в верхнем уровне foo модуля:

__author__= "me" 
__version__= "1.0" 
__description__= "foo package" 

в setup.py:

import foo 
setup(

    author = foo.__author__, 
    version = foo.__version__, 
    description = foo.__description__, 
    packages = ["foo",], 

) 

Таким образом, вам нужно только обновить метаданные в одном место, а так как данные определены в главном модуле пакетов, он будет доступен оттуда.

Answer 4

Учитывая setup.py следующим образом:

from distutils.core import setup 

setup(
    name   = 'TestApp', 
    version  = '0.0.1', 
    author  = 'saaj', 
    py_modules = ['app'], 
    test_suite = 'test' 
) 

Для некоторых сценариев и автоматизации без установки пакета, где pip, easy_install и даже setuptools не предоставляют параметры командной строки или публичный API-интерфейсы для чтения всех метаданных (например, test_suite), вот немного Hacky способ:

python3 -c "import sys, types; m = types.ModuleType('distutils.core'); \ 
    m.setup = lambda **kwargs: print(kwargs); \ 
    sys.modules['distutils.core'] = m; import setup" 

Это напечатает dict из именованных аргументов, переданных setup().

{'author': 'saaj', 'version': '0.0.1', 'name': 'TestApp', 
    'test_suite': 'test', 'py_modules': ['app']} 

Вы можете заменить print в lambda на то, что выход вам нужно. Если ваш setup.py импортирует setup() от setuptools, что на самом деле рекомендуется, просто замените «distutils.. Ядро»с "Setuptools" в сниппет

отформатированный фрагмент следующим образом:

import sys 
import types 

m = types.ModuleType('distutils.core') 
m.setup = lambda **kwargs: print(kwargs) 
sys.modules['distutils.core'] = m 

import setup # import you setup.py with mocked setup()