cpython: f84040b11211 (original) (raw)

Mercurial > cpython

changeset 73041:f84040b11211

Document that packaging doesn’t create __init__.py files (#3902). The bug reported expected distutils to create an __init__.py file for a project using only C extension modules. IMO, how Python imports packages and submodules is well documented, and it’s never suggested that distutils might create an __init__.py file, so I’m adding this clarification to the packaging docs but won’t backport unless other people tell me they shared the same wrong expectation. Thanks to Mike Hoy for his help with the patch. [#3902]

Éric Araujo merwok@netwok.org
date	Fri, 21 Oct 2011 07:34:00 +0200
parents	21c33aa2178b
children	0aad55c8ff26
files	Doc/library/packaging.compiler.rst Doc/packaging/setupscript.rst
diffstat	2 files changed, 8 insertions(+), 0 deletions(-)[+] [-] Doc/library/packaging.compiler.rst 4 Doc/packaging/setupscript.rst 4

line wrap: on

line diff

--- a/Doc/library/packaging.compiler.rst +++ b/Doc/library/packaging.compiler.rst @@ -675,3 +675,7 @@ extension modules. | | abort the build process, but | | | | simply skip the extension. | | +------------------------+--------------------------------+---------------------------+ + +To distribute extension modules that live in a package (e.g. package.ext), +you need to create you need to create a :file:{package}/__init__.py file to +let Python recognize and import your module.

--- a/Doc/packaging/setupscript.rst +++ b/Doc/packaging/setupscript.rst @@ -177,6 +177,10 @@ resulting object code are identical in b in the filesystem (and therefore where in Python's namespace hierarchy) the resulting extension lives. +If your distribution contains only one or more extension modules in a package, +you need to create a :file:{package}/__init__.py file anyway, otherwise Python +won't be able to import anything. + If you have a number of extensions all in the same package (or all under the same base package), use the :option:ext_package keyword argument to :func:setup. For example, ::