cpython-withatomic / Doc / libni.tex

\section{Built-in Module \sectcode{ni}}
\label{module-ni}
\bimodindex{ni}

\strong{Warning: This module is obsolete.}  As of Python 1.5a4,
package support (with different semantics for \code{__init__} and no
support for \code{__domain__} or \code{__}) is built in the
interpreter.  The ni module is retained only for backward
compatibility.  As of Python 1.5b2, it has been renamed to \code{ni1}; 
if you really need it, you can use \code{import ni1}, but the
recommended approach is to rely on the built-in package support,
converting existing packages if needed.  Note that mixing \code{ni}
and the built-in package support doesn't work once you import
\code{ni}, all packages use it.

The \code{ni} module defines a new importing scheme, which supports
packages containing several Python modules.  To enable package
support, execute \code{import ni} before importing any packages.  Importing
this module automatically installs the relevant import hooks.  There
are no publicly-usable functions or variables in the \code{ni} module.

To create a package named \code{spam} containing sub-modules \code{ham}, \code{bacon} and
\code{eggs}, create a directory \file{spam} somewhere on Python's module search
path, as given in \code{sys.path}.  Then, create files called \file{ham.py}, \file{bacon.py} and
\file{eggs.py} inside \file{spam}.

To import module \code{ham} from package \code{spam} and use function
\code{hamneggs()} from that module, you can use any of the following
possibilities:

\bcode\begin{verbatim}
import spam.ham		# *not* "import spam" !!!
spam.ham.hamneggs()
\end{verbatim}\ecode
%
\bcode\begin{verbatim}
from spam import ham
ham.hamneggs()
\end{verbatim}\ecode
%
\bcode\begin{verbatim}
from spam.ham import hamneggs
hamneggs()
\end{verbatim}\ecode
%
\code{import spam} creates an
empty package named \code{spam} if one does not already exist, but it does
\emph{not} automatically import \code{spam}'s submodules.  
The only submodule that is guaranteed to be imported is
\code{spam.__init__}, if it exists; it would be in a file named
\file{__init__.py} in the \file{spam} directory.  Note that
\code{spam.__init__} is a submodule of package spam.  It can refer to
spam's namespace as \code{__} (two underscores):

\bcode\begin{verbatim}
__.spam_inited = 1		# Set a package-level variable
\end{verbatim}\ecode
%
Additional initialization code (setting up variables, importing other
submodules) can be performed in \file{spam/__init__.py}.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.