Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Open sidebar
Kirill Smelkov
cpython
Commits
4a80a3ec
Commit
4a80a3ec
authored
22 years ago
by
Fred Drake
Browse files
Options
Download
Email Patches
Plain Diff
Added docs for (draft) pkgutil module.
parent
633d90c7
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
52 additions
and
0 deletions
+52
-0
Doc/Makefile.deps
Doc/Makefile.deps
+1
-0
Doc/lib/lib.tex
Doc/lib/lib.tex
+1
-0
Doc/lib/libpkgutil.tex
Doc/lib/libpkgutil.tex
+50
-0
No files found.
Doc/Makefile.deps
View file @
4a80a3ec
...
...
@@ -120,6 +120,7 @@ LIBFILES= $(MANSTYLES) $(INDEXSTYLES) $(COMMONTEX) \
lib/libmarshal.tex
\
lib/libwarnings.tex
\
lib/libimp.tex
\
lib/libpkgutil.tex
\
lib/libparser.tex
\
lib/libbltin.tex
\
lib/libmain.tex
\
...
...
This diff is collapsed.
Click to expand it.
Doc/lib/lib.tex
View file @
4a80a3ec
...
...
@@ -90,6 +90,7 @@ and how to embed it in other applications.
\input
{
libmarshal
}
\input
{
libwarnings
}
\input
{
libimp
}
\input
{
libpkgutil
}
\input
{
libcode
}
\input
{
libcodeop
}
\input
{
libpprint
}
...
...
This diff is collapsed.
Click to expand it.
Doc/lib/libpkgutil.tex
0 → 100644
View file @
4a80a3ec
\section
{
\module
{
pkgutil
}
---
Package extension utility
}
\declaremodule
{
standard
}{
pkgutil
}
\modulesynopsis
{
Utilities to support extension of packages.
}
\versionadded
{
2.3
}
\begin{notice}
[warning]
This is an experimental module. It may be withdrawn or completely
changed up to an including the release of Python 2.3 beta 1.
\end{notice}
This module provides a single function:
\begin{funcdesc}
{
extend
_
path
}{
path, name
}
Extend the search path for the modules which comprise a package.
Intended use is to place the following code in a package's
\file
{__
init
__
.py
}
:
\begin{verbatim}
from pkgutil import extend
_
path
__
path
__
= extend
_
path(
__
path
__
,
__
name
__
)
\end{verbatim}
This will add to the package's
\code
{__
path
__}
all subdirectories of
directories on
\code
{
sys.path
}
named after the package. This is
useful if one wants to distribute different parts of a single
logical package as multiple directories.
It also looks for
\file
{
*.pkg
}
files beginning where
\code
{
*
}
matches the
\var
{
name
}
argument. This feature is similar to
\file
{
*.pth
}
files (see the
\refmodule
{
site
}
module for more
information), except that it doesn't special-case lines starting
with
\code
{
import
}
. A
\file
{
*.pkg
}
file is trusted at face value:
apart from checking for duplicates, all entries found in a
\file
{
*.pkg
}
file are added to the path, regardless of whether they
exist the filesystem. (This is a feature.)
If the input path is not a list (as is the case for frozen
packages) it is returned unchanged. The input path is not
modified; an extended copy is returned. Items are only appended
to the copy at the end.
It is assumed that
\code
{
sys.path
}
is a sequence. Items of
\code
{
sys.path
}
that are not (Unicode or 8-bit) strings referring to
existing directories are ignored. Unicode items on
\code
{
sys.path
}
that cause errors when used as filenames may cause this function to
raise an exception (in line with
\function
{
os.path.isdir()
}
behavior).
\end{funcdesc}
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment