mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-24 19:54:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Logical markup.

Browse source 
Spell emdash right.
This commit is contained in:
Fred Drake 1998-03-08 06:41:57 +00:00
parent 0c2af2bef6
commit bccc64020e
2 changed files with 88 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

86
Doc/lib/libimp.tex
View file

@ -4,10 +4,9 @@
\index{import} \index{import}
This module provides an interface to the mechanisms used to implement This module provides an interface to the mechanisms used to implement
the \code{import} statement. It defines the following constants and the \keyword{import} statement. It defines the following constants and
functions: functions:
\setindexsubitem{(in module imp)}
\begin{funcdesc}{get_magic}{} \begin{funcdesc}{get_magic}{}
Return the magic string value used to recognize byte-compiled code Return the magic string value used to recognize byte-compiled code
@ -23,21 +22,21 @@ module name to form the filename to search for, \var{mode} is the mode
string to pass to the built-in \code{open} function to open the file string to pass to the built-in \code{open} function to open the file
(this can be \code{'r'} for text files or \code{'rb'} for binary (this can be \code{'r'} for text files or \code{'rb'} for binary
files), and \var{type} is the file type, which has one of the values files), and \var{type} is the file type, which has one of the values
\code{PY_SOURCE}, \code{PY_COMPILED}, or \code{C_EXTENSION}, defined \constant{PY_SOURCE}, \constant{PY_COMPILED}, or
below. \constant{C_EXTENSION}, described below.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{find_module}{name\optional{, path}} \begin{funcdesc}{find_module}{name\optional{, path}}
Try to find the module \var{name} on the search path \var{path}. If Try to find the module \var{name} on the search path \var{path}. If
\var{path} is a list of directory names, each directory is searched \var{path} is a list of directory names, each directory is searched
for files with any of the suffixes returned by \code{get_suffixes()} for files with any of the suffixes returned by \function{get_suffixes()}
above. Invalid names in the list are silently ignored (but all list above. Invalid names in the list are silently ignored (but all list
items must be strings). If \var{path} is omitted or \code{None}, the items must be strings). If \var{path} is omitted or \code{None}, the
list of directory names given by \code{sys.path} is searched, but list of directory names given by \code{sys.path} is searched, but
first it searches a few special places: it tries to find a built-in first it searches a few special places: it tries to find a built-in
module with the given name (\code{C_BUILTIN}), then a frozen module module with the given name (\constant{C_BUILTIN}), then a frozen module
(\code{PY_FROZEN}), and on some systems some other places are looked (\constant{PY_FROZEN}), and on some systems some other places are looked
in as well (on the Mac, it looks for a resource (\code{PY_RESOURCE}); in as well (on the Mac, it looks for a resource (\constant{PY_RESOURCE});
on Windows, it looks in the registry which may point to a specific on Windows, it looks in the registry which may point to a specific
file). file).
@ -46,42 +45,44 @@ If search is successful, the return value is a triple
\var{file} is an open file object positioned at the beginning, \var{file} is an open file object positioned at the beginning,
\var{pathname} is the pathname of the \var{pathname} is the pathname of the
file found, and \var{description} is a triple as contained in the list file found, and \var{description} is a triple as contained in the list
returned by \code{get_suffixes} describing the kind of module found. returned by \function{get_suffixes()} describing the kind of module found.
If the module does not live in a file, the returned \var{file} is If the module does not live in a file, the returned \var{file} is
\code{None}, \var{filename} is the empty string, and the \code{None}, \var{filename} is the empty string, and the
\var{description} tuple contains empty strings for its suffix and \var{description} tuple contains empty strings for its suffix and
mode; the module type is as indicate in parentheses dabove. If the mode; the module type is as indicate in parentheses dabove. If the
search is unsuccessful, \code{ImportError} is raised. Other search is unsuccessful, \exception{ImportError} is raised. Other
exceptions indicate problems with the arguments or environment. exceptions indicate problems with the arguments or environment.
This function does not handle hierarchical module names (names This function does not handle hierarchical module names (names
containing dots). In order to find \var{P}.\var{M}, i.e., submodule containing dots). In order to find \var{P}.\var{M}, i.e., submodule
\var{M} of package \var{P}, use \code{find_module()} and \var{M} of package \var{P}, use \function{find_module()} and
\code{load_module()} to find and load package \var{P}, and then use \function{load_module()} to find and load package \var{P}, and then use
\code{find_module()} with the \var{path} argument set to \function{find_module()} with the \var{path} argument set to
\code{\var{P}.__path__}. When \var{P} itself has a dotted name, apply \code{\var{P}.__path__}. When \var{P} itself has a dotted name, apply
this recipe recursively. this recipe recursively.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{load_module}{name, file, filename, description} \begin{funcdesc}{load_module}{name, file, filename, description}
Load a module that was previously found by \code{find_module()} (or by Load a module that was previously found by \function{find_module()} (or by
an otherwise conducted search yielding compatible results). This an otherwise conducted search yielding compatible results). This
function does more than importing the module: if the module was function does more than importing the module: if the module was
already imported, it is equivalent to a \code{reload()}! The already imported, it is equivalent to a
\function{reload()}\bifuncindex{reload}! The
\var{name} argument indicates the full module name (including the \var{name} argument indicates the full module name (including the
package name, if this is a submodule of a package). The \var{file} package name, if this is a submodule of a package). The \var{file}
argument is an open file, and \var{filename} is the corresponding argument is an open file, and \var{filename} is the corresponding
file name; these can be \code{None} and \code{""}, respectively, when file name; these can be \code{None} and \code{''}, respectively, when
the module is not being loaded from a file. The \var{description} the module is not being loaded from a file. The \var{description}
argument is a tuple as returned by \code{find_module()} describing what argument is a tuple as returned by \function{find_module()} describing
kind of module must be loaded. what kind of module must be loaded.
If the load is successful, the return value is the module object; If the load is successful, the return value is the module object;
otherwise, an exception (usually \code{ImportError}) is raised. otherwise, an exception (usually \exception{ImportError}) is raised.
\strong{Important:} the caller is responsible for closing the \strong{Important:} the caller is responsible for closing the
\var{file} argument, if it was not \code{None}, even when an exception \var{file} argument, if it was not \code{None}, even when an exception
is raised. This is best done using a try-finally statement. is raised. This is best done using a \keyword{try}
... \keyword{finally} statement.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{new_module}{name} \begin{funcdesc}{new_module}{name}
@ -90,7 +91,7 @@ Return a new empty module object called \var{name}. This object is
\end{funcdesc} \end{funcdesc}
The following constants with integer values, defined in this module, The following constants with integer values, defined in this module,
are used to indicate the search result of \code{find_module()}. are used to indicate the search result of \function{find_module()}.
\begin{datadesc}{PY_SOURCE} \begin{datadesc}{PY_SOURCE}
The module was found as a source file. The module was found as a source file.
@ -118,11 +119,11 @@ The module was found as a built-in module.
\end{datadesc} \end{datadesc}
\begin{datadesc}{PY_FROZEN} \begin{datadesc}{PY_FROZEN}
The module was found as a frozen module (see \code{init_frozen()}). The module was found as a frozen module (see \function{init_frozen()}).
\end{datadesc} \end{datadesc}
The following constant and functions are obsolete; their functionality The following constant and functions are obsolete; their functionality
is available through \code{find_module()} or \code{load_module()}. is available through \function{find_module()} or \function{load_module()}.
They are kept around for backward compatibility: They are kept around for backward compatibility:
\begin{datadesc}{SEARCH_ERROR} \begin{datadesc}{SEARCH_ERROR}
@ -133,8 +134,8 @@ Unused.
Initialize the built-in module called \var{name} and return its module Initialize the built-in module called \var{name} and return its module
object. If the module was already initialized, it will be initialized object. If the module was already initialized, it will be initialized
\emph{again}. A few modules cannot be initialized twice --- attempting \emph{again}. A few modules cannot be initialized twice --- attempting
to initialize these again will raise an \code{ImportError} exception. to initialize these again will raise an \exception{ImportError}
If there is no exception. If there is no
built-in module called \var{name}, \code{None} is returned. built-in module called \var{name}, \code{None} is returned.
\end{funcdesc} \end{funcdesc}
@ -144,21 +145,22 @@ object. If the module was already initialized, it will be initialized
\emph{again}. If there is no frozen module called \var{name}, \emph{again}. If there is no frozen module called \var{name},
\code{None} is returned. (Frozen modules are modules written in \code{None} is returned. (Frozen modules are modules written in
Python whose compiled byte-code object is incorporated into a Python whose compiled byte-code object is incorporated into a
custom-built Python interpreter by Python's \code{freeze} utility. custom-built Python interpreter by Python's \program{freeze} utility.
See \file{Tools/freeze} for now.) See \file{Tools/freeze/} for now.)
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{is_builtin}{name} \begin{funcdesc}{is_builtin}{name}
Return \code{1} if there is a built-in module called \var{name} which can be Return \code{1} if there is a built-in module called \var{name} which
initialized again. Return \code{-1} if there is a built-in module can be initialized again. Return \code{-1} if there is a built-in
called \var{name} which cannot be initialized again (see module called \var{name} which cannot be initialized again (see
\code{init_builtin()}). Return \code{0} if there is no built-in module \function{init_builtin()}). Return \code{0} if there is no built-in
called \var{name}. module called \var{name}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{is_frozen}{name} \begin{funcdesc}{is_frozen}{name}
Return \code{1} if there is a frozen module (see \code{init_frozen()}) Return \code{1} if there is a frozen module (see
called \var{name}, \code{0} if there is no such module. \function{init_frozen()}) called \var{name}, or \code{0} if there is
no such module.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{load_compiled}{name, pathname, file} \begin{funcdesc}{load_compiled}{name, pathname, file}
@ -180,7 +182,7 @@ already initialized, it will be initialized \emph{again}. Some modules
don't like that and may raise an exception. The \var{pathname} don't like that and may raise an exception. The \var{pathname}
argument must point to the shared library. The \var{name} argument is argument must point to the shared library. The \var{name} argument is
used to construct the name of the initialization function: an external used to construct the name of the initialization function: an external
C function called \code{init\var{name}()} in the shared library is C function called \samp{init\var{name}()} in the shared library is
called. The optional \var{file} argment is ignored. (Note: using called. The optional \var{file} argment is ignored. (Note: using
shared libraries is highly system dependent, and not all systems shared libraries is highly system dependent, and not all systems
support it.) support it.)
@ -195,7 +197,7 @@ to the source file. The \var{file} argument is the source
file, open for reading as text, from the beginning. file, open for reading as text, from the beginning.
It must currently be a real file It must currently be a real file
object, not a user-defined class emulating a file. Note that if a object, not a user-defined class emulating a file. Note that if a
properly matching byte-compiled file (with suffix \code{.pyc}) exists, properly matching byte-compiled file (with suffix \file{.pyc}) exists,
it will be used instead of parsing the given source file. it will be used instead of parsing the given source file.
\end{funcdesc} \end{funcdesc}
@ -206,8 +208,8 @@ it will be used instead of parsing the given source file.
The following function emulates what was the standard import statement The following function emulates what was the standard import statement
up to Python 1.4 (i.e., no hierarchical module names). (This up to Python 1.4 (i.e., no hierarchical module names). (This
\emph{implementation} wouldn't work in that version, since \emph{implementation} wouldn't work in that version, since
\code{imp.find_module()} has been extended and \function{find_module()} has been extended and
\code{imp.load_module()} has been added in 1.4.) \function{load_module()} has been added in 1.4.)
\begin{verbatim} \begin{verbatim}
import imp import sys import imp import sys
@ -233,7 +235,7 @@ def __import__(name, globals=None, locals=None, fromlist=None):
\end{verbatim} \end{verbatim}
A more complete example that implements hierarchical module names and A more complete example that implements hierarchical module names and
includes a \code{reload()} function can be found in the standard includes a \function{reload()}\bifuncindex{reload} function can be
module \code{knee}\refstmodindex{knee} (which is intended as an found in the standard module \module{knee}\refstmodindex{knee} (which
example only -- don't rely on any part of it being a standard is intended as an example only --- don't rely on any part of it being
interface). a standard interface).

86
Doc/libimp.tex
View file

@ -4,10 +4,9 @@
\index{import} \index{import}
This module provides an interface to the mechanisms used to implement This module provides an interface to the mechanisms used to implement
the \code{import} statement. It defines the following constants and the \keyword{import} statement. It defines the following constants and
functions: functions:
\setindexsubitem{(in module imp)}
\begin{funcdesc}{get_magic}{} \begin{funcdesc}{get_magic}{}
Return the magic string value used to recognize byte-compiled code Return the magic string value used to recognize byte-compiled code
@ -23,21 +22,21 @@ module name to form the filename to search for, \var{mode} is the mode
string to pass to the built-in \code{open} function to open the file string to pass to the built-in \code{open} function to open the file
(this can be \code{'r'} for text files or \code{'rb'} for binary (this can be \code{'r'} for text files or \code{'rb'} for binary
files), and \var{type} is the file type, which has one of the values files), and \var{type} is the file type, which has one of the values
\code{PY_SOURCE}, \code{PY_COMPILED}, or \code{C_EXTENSION}, defined \constant{PY_SOURCE}, \constant{PY_COMPILED}, or
below. \constant{C_EXTENSION}, described below.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{find_module}{name\optional{, path}} \begin{funcdesc}{find_module}{name\optional{, path}}
Try to find the module \var{name} on the search path \var{path}. If Try to find the module \var{name} on the search path \var{path}. If
\var{path} is a list of directory names, each directory is searched \var{path} is a list of directory names, each directory is searched
for files with any of the suffixes returned by \code{get_suffixes()} for files with any of the suffixes returned by \function{get_suffixes()}
above. Invalid names in the list are silently ignored (but all list above. Invalid names in the list are silently ignored (but all list
items must be strings). If \var{path} is omitted or \code{None}, the items must be strings). If \var{path} is omitted or \code{None}, the
list of directory names given by \code{sys.path} is searched, but list of directory names given by \code{sys.path} is searched, but
first it searches a few special places: it tries to find a built-in first it searches a few special places: it tries to find a built-in
module with the given name (\code{C_BUILTIN}), then a frozen module module with the given name (\constant{C_BUILTIN}), then a frozen module
(\code{PY_FROZEN}), and on some systems some other places are looked (\constant{PY_FROZEN}), and on some systems some other places are looked
in as well (on the Mac, it looks for a resource (\code{PY_RESOURCE}); in as well (on the Mac, it looks for a resource (\constant{PY_RESOURCE});
on Windows, it looks in the registry which may point to a specific on Windows, it looks in the registry which may point to a specific
file). file).
@ -46,42 +45,44 @@ If search is successful, the return value is a triple
\var{file} is an open file object positioned at the beginning, \var{file} is an open file object positioned at the beginning,
\var{pathname} is the pathname of the \var{pathname} is the pathname of the
file found, and \var{description} is a triple as contained in the list file found, and \var{description} is a triple as contained in the list
returned by \code{get_suffixes} describing the kind of module found. returned by \function{get_suffixes()} describing the kind of module found.
If the module does not live in a file, the returned \var{file} is If the module does not live in a file, the returned \var{file} is
\code{None}, \var{filename} is the empty string, and the \code{None}, \var{filename} is the empty string, and the
\var{description} tuple contains empty strings for its suffix and \var{description} tuple contains empty strings for its suffix and
mode; the module type is as indicate in parentheses dabove. If the mode; the module type is as indicate in parentheses dabove. If the
search is unsuccessful, \code{ImportError} is raised. Other search is unsuccessful, \exception{ImportError} is raised. Other
exceptions indicate problems with the arguments or environment. exceptions indicate problems with the arguments or environment.
This function does not handle hierarchical module names (names This function does not handle hierarchical module names (names
containing dots). In order to find \var{P}.\var{M}, i.e., submodule containing dots). In order to find \var{P}.\var{M}, i.e., submodule
\var{M} of package \var{P}, use \code{find_module()} and \var{M} of package \var{P}, use \function{find_module()} and
\code{load_module()} to find and load package \var{P}, and then use \function{load_module()} to find and load package \var{P}, and then use
\code{find_module()} with the \var{path} argument set to \function{find_module()} with the \var{path} argument set to
\code{\var{P}.__path__}. When \var{P} itself has a dotted name, apply \code{\var{P}.__path__}. When \var{P} itself has a dotted name, apply
this recipe recursively. this recipe recursively.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{load_module}{name, file, filename, description} \begin{funcdesc}{load_module}{name, file, filename, description}
Load a module that was previously found by \code{find_module()} (or by Load a module that was previously found by \function{find_module()} (or by
an otherwise conducted search yielding compatible results). This an otherwise conducted search yielding compatible results). This
function does more than importing the module: if the module was function does more than importing the module: if the module was
already imported, it is equivalent to a \code{reload()}! The already imported, it is equivalent to a
\function{reload()}\bifuncindex{reload}! The
\var{name} argument indicates the full module name (including the \var{name} argument indicates the full module name (including the
package name, if this is a submodule of a package). The \var{file} package name, if this is a submodule of a package). The \var{file}
argument is an open file, and \var{filename} is the corresponding argument is an open file, and \var{filename} is the corresponding
file name; these can be \code{None} and \code{""}, respectively, when file name; these can be \code{None} and \code{''}, respectively, when
the module is not being loaded from a file. The \var{description} the module is not being loaded from a file. The \var{description}
argument is a tuple as returned by \code{find_module()} describing what argument is a tuple as returned by \function{find_module()} describing
kind of module must be loaded. what kind of module must be loaded.
If the load is successful, the return value is the module object; If the load is successful, the return value is the module object;
otherwise, an exception (usually \code{ImportError}) is raised. otherwise, an exception (usually \exception{ImportError}) is raised.
\strong{Important:} the caller is responsible for closing the \strong{Important:} the caller is responsible for closing the
\var{file} argument, if it was not \code{None}, even when an exception \var{file} argument, if it was not \code{None}, even when an exception
is raised. This is best done using a try-finally statement. is raised. This is best done using a \keyword{try}
... \keyword{finally} statement.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{new_module}{name} \begin{funcdesc}{new_module}{name}
@ -90,7 +91,7 @@ Return a new empty module object called \var{name}. This object is
\end{funcdesc} \end{funcdesc}
The following constants with integer values, defined in this module, The following constants with integer values, defined in this module,
are used to indicate the search result of \code{find_module()}. are used to indicate the search result of \function{find_module()}.
\begin{datadesc}{PY_SOURCE} \begin{datadesc}{PY_SOURCE}
The module was found as a source file. The module was found as a source file.
@ -118,11 +119,11 @@ The module was found as a built-in module.
\end{datadesc} \end{datadesc}
\begin{datadesc}{PY_FROZEN} \begin{datadesc}{PY_FROZEN}
The module was found as a frozen module (see \code{init_frozen()}). The module was found as a frozen module (see \function{init_frozen()}).
\end{datadesc} \end{datadesc}
The following constant and functions are obsolete; their functionality The following constant and functions are obsolete; their functionality
is available through \code{find_module()} or \code{load_module()}. is available through \function{find_module()} or \function{load_module()}.
They are kept around for backward compatibility: They are kept around for backward compatibility:
\begin{datadesc}{SEARCH_ERROR} \begin{datadesc}{SEARCH_ERROR}
@ -133,8 +134,8 @@ Unused.
Initialize the built-in module called \var{name} and return its module Initialize the built-in module called \var{name} and return its module
object. If the module was already initialized, it will be initialized object. If the module was already initialized, it will be initialized
\emph{again}. A few modules cannot be initialized twice --- attempting \emph{again}. A few modules cannot be initialized twice --- attempting
to initialize these again will raise an \code{ImportError} exception. to initialize these again will raise an \exception{ImportError}
If there is no exception. If there is no
built-in module called \var{name}, \code{None} is returned. built-in module called \var{name}, \code{None} is returned.
\end{funcdesc} \end{funcdesc}
@ -144,21 +145,22 @@ object. If the module was already initialized, it will be initialized
\emph{again}. If there is no frozen module called \var{name}, \emph{again}. If there is no frozen module called \var{name},
\code{None} is returned. (Frozen modules are modules written in \code{None} is returned. (Frozen modules are modules written in
Python whose compiled byte-code object is incorporated into a Python whose compiled byte-code object is incorporated into a
custom-built Python interpreter by Python's \code{freeze} utility. custom-built Python interpreter by Python's \program{freeze} utility.
See \file{Tools/freeze} for now.) See \file{Tools/freeze/} for now.)
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{is_builtin}{name} \begin{funcdesc}{is_builtin}{name}
Return \code{1} if there is a built-in module called \var{name} which can be Return \code{1} if there is a built-in module called \var{name} which
initialized again. Return \code{-1} if there is a built-in module can be initialized again. Return \code{-1} if there is a built-in
called \var{name} which cannot be initialized again (see module called \var{name} which cannot be initialized again (see
\code{init_builtin()}). Return \code{0} if there is no built-in module \function{init_builtin()}). Return \code{0} if there is no built-in
called \var{name}. module called \var{name}.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{is_frozen}{name} \begin{funcdesc}{is_frozen}{name}
Return \code{1} if there is a frozen module (see \code{init_frozen()}) Return \code{1} if there is a frozen module (see
called \var{name}, \code{0} if there is no such module. \function{init_frozen()}) called \var{name}, or \code{0} if there is
no such module.
\end{funcdesc} \end{funcdesc}
\begin{funcdesc}{load_compiled}{name, pathname, file} \begin{funcdesc}{load_compiled}{name, pathname, file}
@ -180,7 +182,7 @@ already initialized, it will be initialized \emph{again}. Some modules
don't like that and may raise an exception. The \var{pathname} don't like that and may raise an exception. The \var{pathname}
argument must point to the shared library. The \var{name} argument is argument must point to the shared library. The \var{name} argument is
used to construct the name of the initialization function: an external used to construct the name of the initialization function: an external
C function called \code{init\var{name}()} in the shared library is C function called \samp{init\var{name}()} in the shared library is
called. The optional \var{file} argment is ignored. (Note: using called. The optional \var{file} argment is ignored. (Note: using
shared libraries is highly system dependent, and not all systems shared libraries is highly system dependent, and not all systems
support it.) support it.)
@ -195,7 +197,7 @@ to the source file. The \var{file} argument is the source
file, open for reading as text, from the beginning. file, open for reading as text, from the beginning.
It must currently be a real file It must currently be a real file
object, not a user-defined class emulating a file. Note that if a object, not a user-defined class emulating a file. Note that if a
properly matching byte-compiled file (with suffix \code{.pyc}) exists, properly matching byte-compiled file (with suffix \file{.pyc}) exists,
it will be used instead of parsing the given source file. it will be used instead of parsing the given source file.
\end{funcdesc} \end{funcdesc}
@ -206,8 +208,8 @@ it will be used instead of parsing the given source file.
The following function emulates what was the standard import statement The following function emulates what was the standard import statement
up to Python 1.4 (i.e., no hierarchical module names). (This up to Python 1.4 (i.e., no hierarchical module names). (This
\emph{implementation} wouldn't work in that version, since \emph{implementation} wouldn't work in that version, since
\code{imp.find_module()} has been extended and \function{find_module()} has been extended and
\code{imp.load_module()} has been added in 1.4.) \function{load_module()} has been added in 1.4.)
\begin{verbatim} \begin{verbatim}
import imp import sys import imp import sys
@ -233,7 +235,7 @@ def __import__(name, globals=None, locals=None, fromlist=None):
\end{verbatim} \end{verbatim}
A more complete example that implements hierarchical module names and A more complete example that implements hierarchical module names and
includes a \code{reload()} function can be found in the standard includes a \function{reload()}\bifuncindex{reload} function can be
module \code{knee}\refstmodindex{knee} (which is intended as an found in the standard module \module{knee}\refstmodindex{knee} (which
example only -- don't rely on any part of it being a standard is intended as an example only --- don't rely on any part of it being
interface). a standard interface).