Как создать пакет пространства имен в Python?

TL; DR:

на Python 3.3 вам не нужно ничего делать, просто не кладите __init__.py в директории пакета и он будет просто работать. На pre-3.3, выберите pkgutil.extend_path() - решение pkg_resources.declare_namespace() один, потому что он защищен от будущего и уже совместим с неявными пакетами пространства имен.

Python 3.3 представляет неявные пакеты пространств имен, см. PEP 420.

это означает, что теперь есть три типа объектов это может быть создано import foo:

• модуль, представленный
• обычный пакет, представленный каталогом foo содержащий
• пакет пространства имен, представленный одним или несколькими каталогами foo без __init__.py файлы

пакеты тоже являются модулями, но здесь я имею в виду" непакетный модуль", когда говорю"модуль".

сначала он сканирует sys.path для модуля или обычная упаковка. Если это удается, он прекращает поиск и создает и инициализирует модуль или пакет. Если он не нашел модуля или обычного пакета, но нашел хотя бы один каталог, он создает и инициализирует пакет пространства имен.

модули и обычные пакеты имеют __file__ установить на были созданы. Пакеты Regular и namespace имеют __path__установите в каталог или каталоги, из которых они были созданы.

когда вы import foo.bar выше поиск происходит сначала для foo, то если пакет был найден, поиск bar осуществляется с foo.__path__как путь поиска вместо sys.path. Если foo.bar найдено foo и foo.bar создаются и инициализируются.

Итак, как смешиваются обычные пакеты и пакеты пространства имен? Обычно они этого не делают, но старые pkgutil явный метод пакета пространства имен был расширен, чтобы включить неявные пакеты пространства имен.

если у вас уже есть обычный пакет это имеет __init__.py такой:

from pkgutil import extend_path
__path__ = extend_path(__path__, __name__)

... поведение legacy заключается в добавлении любого другого обычный пакеты по искомому пути к своему __path__. Но в Python 3.3 он также добавляет пакеты пространств имен.

так что вы можете иметь следующую структуру каталогов:

├── path1
│   └── package
│       ├── __init__.py
│       └── foo.py
├── path2
│   └── package
│       └── bar.py
└── path3
    └── package
        ├── __init__.py
        └── baz.py

... и пока эти двое ... --2--> есть extend_path строки (и path1, path2 и path3 в своем sys.path) import package.foo, import package.bar и import package.baz все работа.

pkg_resources.declare_namespace(__name__) не был обновлен для включения неявных пакетов пространства имен.