Missing package namespace declaration

[Ryan J Ollos]

Is TracPygit2Plugin intended to be a namespace package?

I'm still trying to understand namespace packages. The ​packaging documentation says:

Every distribution that uses the namespace package must include an identical __init__.py. If any distribution does not, it will cause the namespace logic to fail and the other sub-packages will not be importable. Any additional code in __init__.py will be inaccessible.

Here is the layout for TracMercurial:

$ cat tracext/__init__.py
__import__('pkg_resources').declare_namespace(__name__)
$ python setup.py bdist_wheel
[...]
$ pip install dist/TracMercurial-0.12.0.31.dev0-py2-none-any.whl
[...]
$ find pve/lib/python2.7/site-packages/tracext/ -name "*.py"
pve/lib/python2.7/site-packages/tracext/hg/hooks.py
pve/lib/python2.7/site-packages/tracext/hg/backend.py
pve/lib/python2.7/site-packages/tracext/hg/__init__.py

Note there is no __init__.py in pve/lib/python2.7/site-packages/tracext.

TracPygit2Plugin yields:

$ cat tracext/__init__.py
$ python setup.py bdist_wheel
[...]
$ pip install dist/TracPygit2Plugin-0.12.0.1-py2-none-any.whl
[...]
$ find pve/lib/python2.7/site-packages/tracext/ -name "*.py"
$ pve/lib/python2.7/site-packages/tracext/pygit2/pygit2_fs.py
$ pve/lib/python2.7/site-packages/tracext/pygit2/__init__.py
$ pve/lib/python2.7/site-packages/tracext/pygit2/translation.py
$ pve/lib/python2.7/site-packages/tracext/__init__.py
$ pve/lib/python2.7/site-packages/tracext/hg/hooks.py
$ pve/lib/python2.7/site-packages/tracext/hg/backend.py
$ pve/lib/python2.7/site-packages/tracext/hg/__init__.py

With patch, now there is again no __init__.py in pve/lib/python2.7/site-packages/tracext.

setup.py

@@ -14 +14 @@
         'author': 'Jun Omae',
         'author_email': 'jun66j5@gmail.com',
         'packages': find_packages(exclude=['*.tests*']),
+        'namespace_packages': ['tracext'],
         'package_data': {
             'tracext.pygit2': ['locale/*/LC_MESSAGES/*.mo'],
         },

tracext/__init__.py

@@ +1 @@
+__import__('pkg_resources').declare_namespace(__name__)

$ python setup.py bdist_wheel
[...]
$ pip install dist/TracPygit2Plugin-0.12.0.1-py2-none-any.whl
[...]
$ find pve/lib/python2.7/site-packages/tracext/ -name "*.py"
pve/lib/python2.7/site-packages/tracext/pygit2/pygit2_fs.py
pve/lib/python2.7/site-packages/tracext/pygit2/__init__.py
pve/lib/python2.7/site-packages/tracext/pygit2/translation.py
pve/lib/python2.7/site-packages/tracext/hg/hooks.py
pve/lib/python2.7/site-packages/tracext/hg/backend.py
pve/lib/python2.7/site-packages/tracext/hg/__init__.py

[Ryan J Ollos]

See also: ​trac-github issue 131.

[Jun Omae]

In 18704:

TracPygit2Plugin: add package namespace declaration (closes #13400)

Patch by: Ryan J Ollos