Como crio um pacote de namespace no Python?

No Python, um pacote de namespace permite espalhar o código Python entre vários projetos. Isso é útil quando você deseja liberar bibliotecas relacionadas como downloads separados. Por exemplo, com os diretórios Package-1e Package-2em PYTHONPATH,

Package-1/namespace/__init__.py
Package-1/namespace/module1/__init__.py
Package-2/namespace/__init__.py
Package-2/namespace/module2/__init__.py

o usuário final pode import namespace.module1e import namespace.module2.

Qual é a melhor maneira de definir um pacote de namespace para que mais de um produto Python possa definir módulos nesse namespace?

TL; DR:

No Python 3.3, você não precisa fazer nada, apenas não coloque nenhum __init__.pyem seus diretórios de pacotes de espaço para nome e ele simplesmente funcionará. Na versão anterior à 3.3, escolha a pkgutil.extend_path()solução em vez de pkg_resources.declare_namespace()outra, porque ela é à prova do futuro e já é compatível com pacotes de espaço para nome implícitos.

O Python 3.3 apresenta pacotes implícitos de namespace, consulte PEP 420 .

Isso significa que agora existem três tipos de objetos que podem ser criados por um import foo:

• Um módulo representado por um foo.pyarquivo
• Um pacote regular, representado por um diretório que foocontém um __init__.pyarquivo
• Um pacote de namespace, representado por um ou mais diretórios foosem nenhum __init__.pyarquivo

Pacotes também são módulos, mas aqui quero dizer "módulo sem pacote" quando digo "módulo".

Primeiro, ele procura sys.pathpor um módulo ou pacote regular. Se for bem-sucedido, ele interrompe a pesquisa e cria e inicializa o módulo ou pacote. Se não encontrou nenhum módulo ou pacote regular, mas encontrou pelo menos um diretório, ele cria e inicializa um pacote de namespace.

Módulos e pacotes regulares foram __file__definidos para o .pyarquivo de onde foram criados. Pacotes regulares e de namespace foram __path__definidos para o diretório ou diretórios dos quais foram criados.

Quando você faz isso import foo.bar, a pesquisa acima acontece primeiro e foo, se um pacote foi encontrado, a pesquisa baré feita com foo.__path__o caminho de pesquisa em vez de sys.path. Se foo.barfor encontrado fooe foo.barcriado e inicializado.

Então, como os pacotes regulares e os pacotes de namespace se misturam? Normalmente não, mas o pkgutilmétodo antigo do pacote de espaço para nome explícito foi estendido para incluir pacotes implícitos de espaço para nome.

Se você possui um pacote regular que possui uma __init__.pyaparência semelhante a esta:

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

... o comportamento herdado é adicionar outros pacotes regulares no caminho pesquisado ao seu __path__. Mas no Python 3.3, ele também adiciona pacotes de namespace.

Então você pode ter a seguinte estrutura de diretórios:

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

... e contanto que os dois __init__.pytenham as extend_pathlinhas (e path1, path2e path3estejam na sua sys.path) import package.foo, import package.bare import package.baztodos funcionem.

pkg_resources.declare_namespace(__name__) não foi atualizado para incluir pacotes implícitos de namespace.

Há um módulo padrão, chamado pkgutil , com o qual você pode 'anexar' módulos a um determinado espaço para nome.

Com a estrutura de diretórios que você forneceu:

Package-1/namespace/__init__.py
Package-1/namespace/module1/__init__.py
Package-2/namespace/__init__.py
Package-2/namespace/module2/__init__.py

Você deve colocar essas duas linhas em ambos Package-1/namespace/__init__.pye Package-2/namespace/__init__.py(*):

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

(* uma vez que, a menos que você declare uma dependência entre eles, você não sabe qual deles será reconhecido primeiro - consulte PEP 420 para obter mais informações)

Como a documentação diz:

Isso adicionará a __path__todos os subdiretórios de diretórios sys.pathdo pacote com o nome do pacote.

A partir de agora, você poderá distribuir esses dois pacotes independentemente.

Esta seção deve ser bastante auto-explicativa.

Em resumo, insira o código do espaço para nome __init__.py, atualize setup.pypara declarar um espaço para nome e você estará livre para ir.

Esta é uma pergunta antiga, mas alguém comentou recentemente no meu blog que minha postagem sobre pacotes de namespace ainda era relevante, então pensei em vincular a ele aqui, pois fornece um exemplo prático de como fazê-lo:

https://web.archive.org/web/20150425043954/http://cdent.tumblr.com/post/216241761/python-namespace-packages-for-tiddlyweb

O link para este artigo mostra as principais entranhas do que está acontecendo:

http://www.siafoo.net/article/77#multiple-distributions-one-virtual-package

O __import__("pkg_resources").declare_namespace(__name__)truque é basicamente impulsionar o gerenciamento de plugins no TiddlyWeb e até agora parece estar dando certo.

Você tem seus conceitos de namespace do Python de trás para frente, não é possível no python colocar pacotes em módulos. Pacotes contêm módulos e não o contrário.

Um pacote Python é simplesmente uma pasta que contém um __init__.pyarquivo. Um módulo é qualquer outro arquivo em um pacote (ou diretamente no PYTHONPATH) que possui um.py extensão. Portanto, no seu exemplo, você tem dois pacotes, mas nenhum módulo definido. Se você considerar que um pacote é uma pasta do sistema de arquivos e um módulo é um arquivo, você verá por que os pacotes contêm módulos e não o contrário.

Portanto, no seu exemplo, assumindo que o Pacote 1 e o Pacote 2 sejam pastas no sistema de arquivos que você colocou no caminho do Python, você pode ter o seguinte:

Package-1/
  namespace/
  __init__.py
  module1.py
Package-2/
  namespace/
  __init__.py
  module2.py

Agora você tem um pacote namespacecom dois módulos module1e module2. e, a menos que você tenha um bom motivo, provavelmente deverá colocar os módulos na pasta e ter apenas isso no caminho do python, como abaixo:

Package-1/
  namespace/
  __init__.py
  module1.py
  module2.py