Python：使用setuptools将文件/模块分发到另一个包中

Question

Generically, I'm trying to distribute a module/file that I want to be part of a another python package that has already set up a directory structure under site-packages.

For the given structure under site-packages:

-- main_package
   -- __init__.py
   -- sub_package
      -- __init__.py
      -- bar.py

I have a module foo.py that I want to exist next to the module bar.py , both under the package sub_package . If I just setup the structure in my repo along the lines of a typical package then the __init__.py that setuptools requires clobber the existing __init__.py files for the main_package and sub_package . Ideally this would be a wheel or sdist that could be distributed from our own pypi.

I've tried using py_module , but I can't get it to place the module anywhere other than the top level under site-packages.

Specifically, I'm trying to distribute a saltstack external_pillar into the salt/pillar/ structure already setup by salt. There are multiple salt instances that may or may not want the external_pillar, so simply bundling up the pillar into the salt distribution we have isn't feasible.

Answer 1

You may be looking for namespace packages .

With in your case a structure like this:

`-- main_package
   |  # no __init__.py here
   `-- sub_package
      |-- __init__.py
      `-- foo.py

Python 3.3 added implicit namespace packages from PEP 420. All that is required to create a native namespace package is that you just omit __init__.py from the namespace package directory.

...

It is extremely important that every distribution that uses the namespace package omits the __init__.py or uses a pkgutil-style __init__.py . If any distribution does not, it will cause the namespace logic to fail and the other sub-packages will not be importable.

...

Finally, every distribution must provide the namespace_packages argument to setup() in setup.py.

However, from your question I am not sure whether sub_package already exists in main_package or not.

If it does, I am not sure of the structure to use to extend sub_package while not shadowing its modules, you may need to use an alternate sub-package name to achieve this.