X7ROOT File Manager
Current Path:
/usr/share/doc/python3-docs/html/library
usr
/
share
/
doc
/
python3-docs
/
html
/
library
/
π
..
π
2to3.html
(60.26 KB)
π
__future__.html
(15.42 KB)
π
__main__.html
(8.81 KB)
π
_dummy_thread.html
(8.98 KB)
π
_thread.html
(22.06 KB)
π
abc.html
(40.42 KB)
π
aifc.html
(27.46 KB)
π
allos.html
(31.48 KB)
π
archiving.html
(11.71 KB)
π
argparse.html
(268.54 KB)
π
array.html
(32.76 KB)
π
ast.html
(38.67 KB)
π
asynchat.html
(31.78 KB)
π
asyncio-dev.html
(50.65 KB)
π
asyncio-eventloop.html
(108.61 KB)
π
asyncio-eventloops.html
(32.25 KB)
π
asyncio-protocol.html
(85.38 KB)
π
asyncio-queue.html
(23.4 KB)
π
asyncio-stream.html
(59.58 KB)
π
asyncio-subprocess.html
(56.66 KB)
π
asyncio-sync.html
(34.84 KB)
π
asyncio-task.html
(82 KB)
π
asyncio.html
(27.37 KB)
π
asyncore.html
(41.71 KB)
π
atexit.html
(18 KB)
π
audioop.html
(34.61 KB)
π
base64.html
(35.6 KB)
π
bdb.html
(42.41 KB)
π
binary.html
(12.42 KB)
π
binascii.html
(24.17 KB)
π
binhex.html
(11.4 KB)
π
bisect.html
(25 KB)
π
builtins.html
(11.33 KB)
π
bz2.html
(32.58 KB)
π
calendar.html
(38.61 KB)
π
cgi.html
(54.57 KB)
π
cgitb.html
(12.47 KB)
π
chunk.html
(16.48 KB)
π
cmath.html
(33.37 KB)
π
cmd.html
(42.78 KB)
π
code.html
(27.23 KB)
π
codecs.html
(130.93 KB)
π
codeop.html
(13.97 KB)
π
collections.abc.html
(59.48 KB)
π
collections.html
(151.31 KB)
π
colorsys.html
(12.33 KB)
π
compileall.html
(27.6 KB)
π
concurrency.html
(20.71 KB)
π
concurrent.futures.html
(59.24 KB)
π
concurrent.html
(7.77 KB)
π
configparser.html
(137.75 KB)
π
constants.html
(17.09 KB)
π
contextlib.html
(86.72 KB)
π
copy.html
(13.52 KB)
π
copyreg.html
(14.38 KB)
π
crypt.html
(19.85 KB)
π
crypto.html
(10.66 KB)
π
csv.html
(67.42 KB)
π
ctypes.html
(258.33 KB)
π
curses.ascii.html
(24.61 KB)
π
curses.html
(171.44 KB)
π
curses.panel.html
(16.31 KB)
π
custominterp.html
(8.53 KB)
π
datatypes.html
(23.39 KB)
π
datetime.html
(299.25 KB)
π
dbm.html
(42.11 KB)
π
debug.html
(13.66 KB)
π
decimal.html
(228.01 KB)
π
development.html
(24.53 KB)
π
difflib.html
(93.9 KB)
π
dis.html
(103.7 KB)
π
distribution.html
(10.26 KB)
π
distutils.html
(10.63 KB)
π
doctest.html
(175.54 KB)
π
dummy_threading.html
(9.1 KB)
π
email.charset.html
(25.81 KB)
π
email.compat32-message.html
(84.13 KB)
π
email.contentmanager.html
(29.32 KB)
π
email.encoders.html
(13.92 KB)
π
email.errors.html
(19.24 KB)
π
email.examples.html
(56.52 KB)
π
email.generator.html
(40.82 KB)
π
email.header.html
(30.49 KB)
π
email.headerregistry.html
(56.32 KB)
π
email.html
(27.09 KB)
π
email.iterators.html
(13.21 KB)
π
email.message.html
(85.17 KB)
π
email.mime.html
(35.24 KB)
π
email.parser.html
(46.32 KB)
π
email.policy.html
(73.48 KB)
π
email.util.html
(33.06 KB)
π
ensurepip.html
(18.26 KB)
π
enum.html
(130.81 KB)
π
errno.html
(40.36 KB)
π
exceptions.html
(83.16 KB)
π
faulthandler.html
(22.85 KB)
π
fcntl.html
(26.68 KB)
π
filecmp.html
(24.45 KB)
π
fileformats.html
(10.87 KB)
π
fileinput.html
(29.33 KB)
π
filesys.html
(13.1 KB)
π
fnmatch.html
(16.59 KB)
π
formatter.html
(36.78 KB)
π
fpectl.html
(17.13 KB)
π
fractions.html
(29.22 KB)
π
frameworks.html
(13.16 KB)
π
ftplib.html
(53.15 KB)
π
functional.html
(8.79 KB)
π
functions.html
(196.76 KB)
π
functools.html
(63.43 KB)
π
gc.html
(28.83 KB)
π
getopt.html
(24.76 KB)
π
getpass.html
(11.78 KB)
π
gettext.html
(74.84 KB)
π
glob.html
(18 KB)
π
grp.html
(12.09 KB)
π
gzip.html
(31.9 KB)
π
hashlib.html
(77.69 KB)
π
heapq.html
(34.7 KB)
π
hmac.html
(17.41 KB)
π
html.entities.html
(11.09 KB)
π
html.html
(10.85 KB)
π
html.parser.html
(40.86 KB)
π
http.client.html
(63.72 KB)
π
http.cookiejar.html
(93.94 KB)
π
http.cookies.html
(38.41 KB)
π
http.html
(36.72 KB)
π
http.server.html
(56.83 KB)
π
i18n.html
(10.22 KB)
π
idle.html
(47.28 KB)
π
imaplib.html
(65.76 KB)
π
imghdr.html
(13.14 KB)
π
imp.html
(47.02 KB)
π
importlib.html
(169.05 KB)
π
index.html
(66.18 KB)
π
inspect.html
(127.3 KB)
π
internet.html
(30.36 KB)
π
intro.html
(9.67 KB)
π
io.html
(119.81 KB)
π
ipaddress.html
(103.39 KB)
π
ipc.html
(32.95 KB)
π
itertools.html
(129.71 KB)
π
json.html
(79.18 KB)
π
keyword.html
(8.71 KB)
π
language.html
(13.33 KB)
π
linecache.html
(13.18 KB)
π
locale.html
(60.1 KB)
π
logging.config.html
(83.49 KB)
π
logging.handlers.html
(109.76 KB)
π
logging.html
(131.69 KB)
π
lzma.html
(55.16 KB)
π
macpath.html
(9.04 KB)
π
mailbox.html
(153.63 KB)
π
mailcap.html
(14.33 KB)
π
markup.html
(18.9 KB)
π
marshal.html
(17.89 KB)
π
math.html
(52.4 KB)
π
mimetypes.html
(30.67 KB)
π
misc.html
(7.93 KB)
π
mm.html
(9.79 KB)
π
mmap.html
(33.49 KB)
π
modulefinder.html
(18.12 KB)
π
modules.html
(10.66 KB)
π
msilib.html
(55.86 KB)
π
msvcrt.html
(21.47 KB)
π
multiprocessing.html
(356.92 KB)
π
netdata.html
(17.06 KB)
π
netrc.html
(14.23 KB)
π
nis.html
(11.39 KB)
π
nntplib.html
(67.97 KB)
π
numbers.html
(40.46 KB)
π
numeric.html
(15.17 KB)
π
operator.html
(79.55 KB)
π
optparse.html
(244.08 KB)
π
os.html
(388.71 KB)
π
os.path.html
(52.56 KB)
π
ossaudiodev.html
(46.82 KB)
π
othergui.html
(10.02 KB)
π
parser.html
(41.41 KB)
π
pathlib.html
(113.99 KB)
π
pdb.html
(51.43 KB)
π
persistence.html
(14.92 KB)
π
pickle.html
(112.36 KB)
π
pickletools.html
(16.69 KB)
π
pipes.html
(15.62 KB)
π
pkgutil.html
(31.13 KB)
π
platform.html
(32.94 KB)
π
plistlib.html
(28.6 KB)
π
poplib.html
(30.21 KB)
π
posix.html
(17.2 KB)
π
pprint.html
(40.99 KB)
π
profile.html
(70.16 KB)
π
pty.html
(17.18 KB)
π
pwd.html
(12.79 KB)
π
py_compile.html
(15.14 KB)
π
pyclbr.html
(16.13 KB)
π
pydoc.html
(15.62 KB)
π
pyexpat.html
(86.85 KB)
π
python.html
(16.73 KB)
π
queue.html
(27.54 KB)
π
quopri.html
(13.53 KB)
π
random.html
(59.22 KB)
π
re.html
(186.7 KB)
π
readline.html
(41.15 KB)
π
reprlib.html
(24.38 KB)
π
resource.html
(35.7 KB)
π
rlcompleter.html
(14.05 KB)
π
runpy.html
(25.98 KB)
π
sched.html
(19.56 KB)
π
secrets.html
(24.15 KB)
π
select.html
(61.35 KB)
π
selectors.html
(35 KB)
π
shelve.html
(28.1 KB)
π
shlex.html
(47.83 KB)
π
shutil.html
(72.47 KB)
π
signal.html
(53.77 KB)
π
site.html
(31.49 KB)
π
smtpd.html
(35.05 KB)
π
smtplib.html
(66.83 KB)
π
sndhdr.html
(12.15 KB)
π
socket.html
(191.48 KB)
π
socketserver.html
(80 KB)
π
spwd.html
(12.04 KB)
π
sqlite3.html
(158.08 KB)
π
ssl.html
(260.08 KB)
π
stat.html
(43.67 KB)
π
statistics.html
(48.88 KB)
π
stdtypes.html
(454.74 KB)
π
string.html
(93.03 KB)
π
stringprep.html
(18.22 KB)
π
struct.html
(49.9 KB)
π
subprocess.html
(138.6 KB)
π
sunau.html
(31.01 KB)
π
superseded.html
(13.46 KB)
π
symbol.html
(8.64 KB)
π
symtable.html
(25.5 KB)
π
sys.html
(138.35 KB)
π
sysconfig.html
(29.55 KB)
π
syslog.html
(20.53 KB)
π
tabnanny.html
(11.98 KB)
π
tarfile.html
(94.49 KB)
π
telnetlib.html
(29.7 KB)
π
tempfile.html
(40.42 KB)
π
termios.html
(17.75 KB)
π
test.html
(76.71 KB)
π
text.html
(13.46 KB)
π
textwrap.html
(37.11 KB)
π
threading.html
(101.04 KB)
π
time.html
(77.76 KB)
π
timeit.html
(44.19 KB)
π
tk.html
(22.75 KB)
π
tkinter.html
(80.99 KB)
π
tkinter.scrolledtext.html
(9.72 KB)
π
tkinter.tix.html
(50.64 KB)
π
tkinter.ttk.html
(108.08 KB)
π
token.html
(22.13 KB)
π
tokenize.html
(31.4 KB)
π
trace.html
(28.46 KB)
π
traceback.html
(56.24 KB)
π
tracemalloc.html
(98.77 KB)
π
tty.html
(10.29 KB)
π
turtle.html
(244.5 KB)
π
types.html
(36.19 KB)
π
typing.html
(135.91 KB)
π
undoc.html
(8.97 KB)
π
unicodedata.html
(20.61 KB)
π
unittest.html
(244.81 KB)
π
unittest.mock-examples.html
(164.2 KB)
π
unittest.mock.html
(293.06 KB)
π
unix.html
(11.5 KB)
π
urllib.error.html
(14.13 KB)
π
urllib.html
(9.34 KB)
π
urllib.parse.html
(74.54 KB)
π
urllib.request.html
(173.05 KB)
π
urllib.robotparser.html
(16.75 KB)
π
uu.html
(11.92 KB)
π
uuid.html
(31.21 KB)
π
venv.html
(72.18 KB)
π
warnings.html
(49.14 KB)
π
wave.html
(29.17 KB)
π
weakref.html
(63.76 KB)
π
webbrowser.html
(26.27 KB)
π
windows.html
(10.38 KB)
π
winreg.html
(65.17 KB)
π
winsound.html
(20.77 KB)
π
wsgiref.html
(92.28 KB)
π
xdrlib.html
(32.96 KB)
π
xml.dom.html
(95.28 KB)
π
xml.dom.minidom.html
(40.51 KB)
π
xml.dom.pulldom.html
(23.65 KB)
π
xml.etree.elementtree.html
(132.32 KB)
π
xml.html
(18.81 KB)
π
xml.sax.handler.html
(41.66 KB)
π
xml.sax.html
(24.92 KB)
π
xml.sax.reader.html
(44.79 KB)
π
xml.sax.utils.html
(16.53 KB)
π
xmlrpc.client.html
(70.26 KB)
π
xmlrpc.html
(8.33 KB)
π
xmlrpc.server.html
(48.04 KB)
π
zipapp.html
(44.05 KB)
π
zipfile.html
(78.16 KB)
π
zipimport.html
(22.51 KB)
π
zlib.html
(33.75 KB)
Editing: pkgutil.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="X-UA-Compatible" content="IE=Edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>31.2. pkgutil β Package extension utility — Python 3.6.7 documentation</title> <link rel="stylesheet" href="../_static/pydoctheme.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 3.6.7 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="next" title="31.3. modulefinder β Find modules used by a script" href="modulefinder.html" /> <link rel="prev" title="31.1. zipimport β Import modules from Zip archives" href="zipimport.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <link rel="canonical" href="https://docs.python.org/3/library/pkgutil.html" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head><body> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="modulefinder.html" title="31.3. modulefinder β Find modules used by a script" accesskey="N">next</a> |</li> <li class="right" > <a href="zipimport.html" title="31.1. zipimport β Import modules from Zip archives" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="modules.html" accesskey="U">31. Importing Modules</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <div class="section" id="module-pkgutil"> <span id="pkgutil-package-extension-utility"></span><h1>31.2. <a class="reference internal" href="#module-pkgutil" title="pkgutil: Utilities for the import system."><code class="xref py py-mod docutils literal notranslate"><span class="pre">pkgutil</span></code></a> β Package extension utility<a class="headerlink" href="#module-pkgutil" title="Permalink to this headline">ΒΆ</a></h1> <p><strong>Source code:</strong> <a class="reference external" href="https://github.com/python/cpython/tree/3.6/Lib/pkgutil.py">Lib/pkgutil.py</a></p> <hr class="docutils" /> <p>This module provides utilities for the import system, in particular package support.</p> <dl class="class"> <dt id="pkgutil.ModuleInfo"> <em class="property">class </em><code class="descclassname">pkgutil.</code><code class="descname">ModuleInfo</code><span class="sig-paren">(</span><em>module_finder</em>, <em>name</em>, <em>ispkg</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.ModuleInfo" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>A namedtuple that holds a brief summary of a moduleβs info.</p> <div class="versionadded"> <p><span class="versionmodified">New in version 3.6.</span></p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.extend_path"> <code class="descclassname">pkgutil.</code><code class="descname">extend_path</code><span class="sig-paren">(</span><em>path</em>, <em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.extend_path" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Extend the search path for the modules which comprise a package. Intended use is to place the following code in a packageβs <code class="file docutils literal notranslate"><span class="pre">__init__.py</span></code>:</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pkgutil</span> <span class="k">import</span> <span class="n">extend_path</span> <span class="n">__path__</span> <span class="o">=</span> <span class="n">extend_path</span><span class="p">(</span><span class="n">__path__</span><span class="p">,</span> <span class="vm">__name__</span><span class="p">)</span> </pre></div> </div> <p>This will add to the packageβs <code class="docutils literal notranslate"><span class="pre">__path__</span></code> all subdirectories of directories on <code class="docutils literal notranslate"><span class="pre">sys.path</span></code> named after the package. This is useful if one wants to distribute different parts of a single logical package as multiple directories.</p> <p>It also looks for <code class="file docutils literal notranslate"><span class="pre">*.pkg</span></code> files beginning where <code class="docutils literal notranslate"><span class="pre">*</span></code> matches the <em>name</em> argument. This feature is similar to <code class="file docutils literal notranslate"><span class="pre">*.pth</span></code> files (see the <a class="reference internal" href="site.html#module-site" title="site: Module responsible for site-specific configuration."><code class="xref py py-mod docutils literal notranslate"><span class="pre">site</span></code></a> module for more information), except that it doesnβt special-case lines starting with <code class="docutils literal notranslate"><span class="pre">import</span></code>. A <code class="file docutils literal notranslate"><span class="pre">*.pkg</span></code> file is trusted at face value: apart from checking for duplicates, all entries found in a <code class="file docutils literal notranslate"><span class="pre">*.pkg</span></code> file are added to the path, regardless of whether they exist on the filesystem. (This is a feature.)</p> <p>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.</p> <p>It is assumed that <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a> is a sequence. Items of <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a> that are not strings referring to existing directories are ignored. Unicode items on <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a> that cause errors when used as filenames may cause this function to raise an exception (in line with <a class="reference internal" href="os.path.html#os.path.isdir" title="os.path.isdir"><code class="xref py py-func docutils literal notranslate"><span class="pre">os.path.isdir()</span></code></a> behavior).</p> </dd></dl> <dl class="class"> <dt id="pkgutil.ImpImporter"> <em class="property">class </em><code class="descclassname">pkgutil.</code><code class="descname">ImpImporter</code><span class="sig-paren">(</span><em>dirname=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.ImpImporter" title="Permalink to this definition">ΒΆ</a></dt> <dd><p><span class="target" id="index-0"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0302"><strong>PEP 302</strong></a> Finder that wraps Pythonβs βclassicβ import algorithm.</p> <p>If <em>dirname</em> is a string, a <span class="target" id="index-1"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0302"><strong>PEP 302</strong></a> finder is created that searches that directory. If <em>dirname</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, a <span class="target" id="index-2"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0302"><strong>PEP 302</strong></a> finder is created that searches the current <a class="reference internal" href="sys.html#sys.path" title="sys.path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path</span></code></a>, plus any modules that are frozen or built-in.</p> <p>Note that <a class="reference internal" href="#pkgutil.ImpImporter" title="pkgutil.ImpImporter"><code class="xref py py-class docutils literal notranslate"><span class="pre">ImpImporter</span></code></a> does not currently support being used by placement on <a class="reference internal" href="sys.html#sys.meta_path" title="sys.meta_path"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.meta_path</span></code></a>.</p> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 3.3: </span>This emulation is no longer needed, as the standard import mechanism is now fully PEP 302 compliant and available in <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a>.</p> </div> </dd></dl> <dl class="class"> <dt id="pkgutil.ImpLoader"> <em class="property">class </em><code class="descclassname">pkgutil.</code><code class="descname">ImpLoader</code><span class="sig-paren">(</span><em>fullname</em>, <em>file</em>, <em>filename</em>, <em>etc</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.ImpLoader" title="Permalink to this definition">ΒΆ</a></dt> <dd><p><a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">Loader</span></a> that wraps Pythonβs βclassicβ import algorithm.</p> <div class="deprecated"> <p><span class="versionmodified">Deprecated since version 3.3: </span>This emulation is no longer needed, as the standard import mechanism is now fully PEP 302 compliant and available in <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a>.</p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.find_loader"> <code class="descclassname">pkgutil.</code><code class="descname">find_loader</code><span class="sig-paren">(</span><em>fullname</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.find_loader" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Retrieve a module <a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">loader</span></a> for the given <em>fullname</em>.</p> <p>This is a backwards compatibility wrapper around <a class="reference internal" href="importlib.html#importlib.util.find_spec" title="importlib.util.find_spec"><code class="xref py py-func docutils literal notranslate"><span class="pre">importlib.util.find_spec()</span></code></a> that converts most failures to <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImportError</span></code></a> and only returns the loader rather than the full <code class="xref py py-class docutils literal notranslate"><span class="pre">ModuleSpec</span></code>.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.4: </span>Updated to be based on <span class="target" id="index-3"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0451"><strong>PEP 451</strong></a></p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.get_importer"> <code class="descclassname">pkgutil.</code><code class="descname">get_importer</code><span class="sig-paren">(</span><em>path_item</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.get_importer" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Retrieve a <a class="reference internal" href="../glossary.html#term-finder"><span class="xref std std-term">finder</span></a> for the given <em>path_item</em>.</p> <p>The returned finder is cached in <a class="reference internal" href="sys.html#sys.path_importer_cache" title="sys.path_importer_cache"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path_importer_cache</span></code></a> if it was newly created by a path hook.</p> <p>The cache (or part of it) can be cleared manually if a rescan of <a class="reference internal" href="sys.html#sys.path_hooks" title="sys.path_hooks"><code class="xref py py-data docutils literal notranslate"><span class="pre">sys.path_hooks</span></code></a> is necessary.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.get_loader"> <code class="descclassname">pkgutil.</code><code class="descname">get_loader</code><span class="sig-paren">(</span><em>module_or_name</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.get_loader" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Get a <a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">loader</span></a> object for <em>module_or_name</em>.</p> <p>If the module or package is accessible via the normal import mechanism, a wrapper around the relevant part of that machinery is returned. Returns <code class="docutils literal notranslate"><span class="pre">None</span></code> if the module cannot be found or imported. If the named module is not already imported, its containing package (if any) is imported, in order to establish the package <code class="docutils literal notranslate"><span class="pre">__path__</span></code>.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.4: </span>Updated to be based on <span class="target" id="index-4"></span><a class="pep reference external" href="https://www.python.org/dev/peps/pep-0451"><strong>PEP 451</strong></a></p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.iter_importers"> <code class="descclassname">pkgutil.</code><code class="descname">iter_importers</code><span class="sig-paren">(</span><em>fullname=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.iter_importers" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Yield <a class="reference internal" href="../glossary.html#term-finder"><span class="xref std std-term">finder</span></a> objects for the given module name.</p> <p>If fullname contains a β.β, the finders will be for the package containing fullname, otherwise they will be all registered top level finders (i.e. those on both sys.meta_path and sys.path_hooks).</p> <p>If the named module is in a package, that package is imported as a side effect of invoking this function.</p> <p>If no module name is specified, all top level finders are produced.</p> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.iter_modules"> <code class="descclassname">pkgutil.</code><code class="descname">iter_modules</code><span class="sig-paren">(</span><em>path=None</em>, <em>prefix=''</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.iter_modules" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Yields <a class="reference internal" href="#pkgutil.ModuleInfo" title="pkgutil.ModuleInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModuleInfo</span></code></a> for all submodules on <em>path</em>, or, if <em>path</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, all top-level modules on <code class="docutils literal notranslate"><span class="pre">sys.path</span></code>.</p> <p><em>path</em> should be either <code class="docutils literal notranslate"><span class="pre">None</span></code> or a list of paths to look for modules in.</p> <p><em>prefix</em> is a string to output on the front of every module name on output.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Only works for a <a class="reference internal" href="../glossary.html#term-finder"><span class="xref std std-term">finder</span></a> which defines an <code class="docutils literal notranslate"><span class="pre">iter_modules()</span></code> method. This interface is non-standard, so the module also provides implementations for <a class="reference internal" href="importlib.html#importlib.machinery.FileFinder" title="importlib.machinery.FileFinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.machinery.FileFinder</span></code></a> and <a class="reference internal" href="zipimport.html#zipimport.zipimporter" title="zipimport.zipimporter"><code class="xref py py-class docutils literal notranslate"><span class="pre">zipimport.zipimporter</span></code></a>.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.walk_packages"> <code class="descclassname">pkgutil.</code><code class="descname">walk_packages</code><span class="sig-paren">(</span><em>path=None</em>, <em>prefix=''</em>, <em>onerror=None</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.walk_packages" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Yields <a class="reference internal" href="#pkgutil.ModuleInfo" title="pkgutil.ModuleInfo"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModuleInfo</span></code></a> for all modules recursively on <em>path</em>, or, if <em>path</em> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, all accessible modules.</p> <p><em>path</em> should be either <code class="docutils literal notranslate"><span class="pre">None</span></code> or a list of paths to look for modules in.</p> <p><em>prefix</em> is a string to output on the front of every module name on output.</p> <p>Note that this function must import all <em>packages</em> (<em>not</em> all modules!) on the given <em>path</em>, in order to access the <code class="docutils literal notranslate"><span class="pre">__path__</span></code> attribute to find submodules.</p> <p><em>onerror</em> is a function which gets called with one argument (the name of the package which was being imported) if any exception occurs while trying to import a package. If no <em>onerror</em> function is supplied, <a class="reference internal" href="exceptions.html#ImportError" title="ImportError"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ImportError</span></code></a>s are caught and ignored, while all other exceptions are propagated, terminating the search.</p> <p>Examples:</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="c1"># list all modules python can access</span> <span class="n">walk_packages</span><span class="p">()</span> <span class="c1"># list all submodules of ctypes</span> <span class="n">walk_packages</span><span class="p">(</span><span class="n">ctypes</span><span class="o">.</span><span class="n">__path__</span><span class="p">,</span> <span class="n">ctypes</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s1">'.'</span><span class="p">)</span> </pre></div> </div> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">Only works for a <a class="reference internal" href="../glossary.html#term-finder"><span class="xref std std-term">finder</span></a> which defines an <code class="docutils literal notranslate"><span class="pre">iter_modules()</span></code> method. This interface is non-standard, so the module also provides implementations for <a class="reference internal" href="importlib.html#importlib.machinery.FileFinder" title="importlib.machinery.FileFinder"><code class="xref py py-class docutils literal notranslate"><span class="pre">importlib.machinery.FileFinder</span></code></a> and <a class="reference internal" href="zipimport.html#zipimport.zipimporter" title="zipimport.zipimporter"><code class="xref py py-class docutils literal notranslate"><span class="pre">zipimport.zipimporter</span></code></a>.</p> </div> <div class="versionchanged"> <p><span class="versionmodified">Changed in version 3.3: </span>Updated to be based directly on <a class="reference internal" href="importlib.html#module-importlib" title="importlib: The implementation of the import machinery."><code class="xref py py-mod docutils literal notranslate"><span class="pre">importlib</span></code></a> rather than relying on the package internal PEP 302 import emulation.</p> </div> </dd></dl> <dl class="function"> <dt id="pkgutil.get_data"> <code class="descclassname">pkgutil.</code><code class="descname">get_data</code><span class="sig-paren">(</span><em>package</em>, <em>resource</em><span class="sig-paren">)</span><a class="headerlink" href="#pkgutil.get_data" title="Permalink to this definition">ΒΆ</a></dt> <dd><p>Get a resource from a package.</p> <p>This is a wrapper for the <a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">loader</span></a> <a class="reference internal" href="importlib.html#importlib.abc.ResourceLoader.get_data" title="importlib.abc.ResourceLoader.get_data"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_data</span></code></a> API. The <em>package</em> argument should be the name of a package, in standard module format (<code class="docutils literal notranslate"><span class="pre">foo.bar</span></code>). The <em>resource</em> argument should be in the form of a relative filename, using <code class="docutils literal notranslate"><span class="pre">/</span></code> as the path separator. The parent directory name <code class="docutils literal notranslate"><span class="pre">..</span></code> is not allowed, and nor is a rooted name (starting with a <code class="docutils literal notranslate"><span class="pre">/</span></code>).</p> <p>The function returns a binary string that is the contents of the specified resource.</p> <p>For packages located in the filesystem, which have already been imported, this is the rough equivalent of:</p> <div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="n">d</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">modules</span><span class="p">[</span><span class="n">package</span><span class="p">]</span><span class="o">.</span><span class="vm">__file__</span><span class="p">)</span> <span class="n">data</span> <span class="o">=</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">resource</span><span class="p">),</span> <span class="s1">'rb'</span><span class="p">)</span><span class="o">.</span><span class="n">read</span><span class="p">()</span> </pre></div> </div> <p>If the package cannot be located or loaded, or it uses a <a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">loader</span></a> which does not support <a class="reference internal" href="importlib.html#importlib.abc.ResourceLoader.get_data" title="importlib.abc.ResourceLoader.get_data"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_data</span></code></a>, then <code class="docutils literal notranslate"><span class="pre">None</span></code> is returned. In particular, the <a class="reference internal" href="../glossary.html#term-loader"><span class="xref std std-term">loader</span></a> for <a class="reference internal" href="../glossary.html#term-namespace-package"><span class="xref std std-term">namespace packages</span></a> does not support <a class="reference internal" href="importlib.html#importlib.abc.ResourceLoader.get_data" title="importlib.abc.ResourceLoader.get_data"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get_data</span></code></a>.</p> </dd></dl> </div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="zipimport.html" title="previous chapter">31.1. <code class="docutils literal notranslate"><span class="pre">zipimport</span></code> β Import modules from Zip archives</a></p> <h4>Next topic</h4> <p class="topless"><a href="modulefinder.html" title="next chapter">31.3. <code class="docutils literal notranslate"><span class="pre">modulefinder</span></code> β Find modules used by a script</a></p> <div role="note" aria-label="source link"> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li> <a href="https://github.com/python/cpython/blob/3.6/Doc/library/pkgutil.rst" rel="nofollow">Show Source </a> </li> </ul> </div> </div> </div> <div class="clearer"></div> </div> <div class="related" role="navigation" aria-label="related navigation"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="modulefinder.html" title="31.3. modulefinder β Find modules used by a script" >next</a> |</li> <li class="right" > <a href="zipimport.html" title="31.1. zipimport β Import modules from Zip archives" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="https://www.python.org/">Python</a> »</li> <li> <a href="../index.html">3.6.7 Documentation</a> » </li> <li class="nav-item nav-item-1"><a href="index.html" >The Python Standard Library</a> »</li> <li class="nav-item nav-item-2"><a href="modules.html" >31. Importing Modules</a> »</li> <li class="right"> <div class="inline-search" style="display: none" role="search"> <form class="inline-search" action="../search.html" method="get"> <input placeholder="Quick search" type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> <script type="text/javascript">$('.inline-search').show(0);</script> | </li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 2001-2023, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="https://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Dec 18, 2023. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.7.6. </div> </body> </html>
Upload File
Create Folder