diff options
Diffstat (limited to 'Doc/library/imp.rst')
| -rw-r--r-- | Doc/library/imp.rst | 46 |
1 files changed, 37 insertions, 9 deletions
diff --git a/Doc/library/imp.rst b/Doc/library/imp.rst index 2d83893d33..6e9845ed00 100644 --- a/Doc/library/imp.rst +++ b/Doc/library/imp.rst @@ -190,8 +190,43 @@ This module provides an interface to the mechanisms used to implement the continue to use the old class definition. The same is true for derived classes. -The following constants with integer values, defined in this module, are used to -indicate the search result of :func:`find_module`. +The following functions are conveniences for handling :pep:`3147` byte-compiled +file paths. + +.. versionadded:: 3.2 + +.. function:: cache_from_source(path, debug_override=None) + + Return the :pep:`3147` path to the byte-compiled file associated with the + source *path*. For example, if *path* is ``/foo/bar/baz.py`` the return + value would be ``/foo/bar/__pycache__/baz.cpython-32.pyc`` for Python 3.2. + The ``cpython-32`` string comes from the current magic tag (see + :func:`get_tag`). The returned path will end in ``.pyc`` when + ``__debug__`` is True or ``.pyo`` for an optimized Python + (i.e. ``__debug__`` is False). By passing in True or False for + *debug_override* you can override the system's value for ``__debug__`` for + extension selection. + + *path* need not exist. + + +.. function:: source_from_cache(path) + + Given the *path* to a :pep:`3147` file name, return the associated source code + file path. For example, if *path* is + ``/foo/bar/__pycache__/baz.cpython-32.pyc`` the returned path would be + ``/foo/bar/baz.py``. *path* need not exist, however if it does not conform + to :pep:`3147` format, a ``ValueError`` is raised. + + +.. function:: get_tag() + + Return the :pep:`3147` magic tag string matching this version of Python's + magic number, as returned by :func:`get_magic`. + + +The following constants with integer values, defined in this module, are used +to indicate the search result of :func:`find_module`. .. data:: PY_SOURCE @@ -273,10 +308,3 @@ in that version, since :func:`find_module` has been extended and # Since we may exit via an exception, close fp explicitly. if fp: fp.close() - -.. index:: module: knee - -A more complete example that implements hierarchical module names and includes a -:func:`reload` function can be found in the module :mod:`knee`. The :mod:`knee` -module can be found in :file:`Demo/imputil/` in the Python source distribution. - |