mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-18 14:40:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Correct documentation to match implementation: "Class" instead of

Browse source 
"class_descriptor", "Function" instead of "function_descriptor".  Note
default path value for readmodule*.  Wrap some long paragraphs.  Don't
mention 'inpackage' which isn't part of the public API.
This commit is contained in:
Skip Montanaro 2008-04-28 02:59:45 +00:00
parent fe1372c7d5
commit f30f6e8216
1 changed files with 46 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

91
Doc/library/pyclbr.rst
View file

@ -7,75 +7,75 @@
.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
The :mod:`pyclbr` can be used to determine some limited information about the The :mod:`pyclbr` module can be used to determine some limited information
classes, methods and top-level functions defined in a module. The information about the classes, methods and top-level functions defined in a module. The
provided is sufficient to implement a traditional three-pane class browser. The information provided is sufficient to implement a traditional three-pane
information is extracted from the source code rather than by importing the class browser. The information is extracted from the source code rather
module, so this module is safe to use with untrusted source code. This than by importing the module, so this module is safe to use with untrusted
restriction makes it impossible to use this module with modules not implemented code. This restriction makes it impossible to use this module with modules
in Python, including many standard and optional extension modules. not implemented in Python, including all standard and optional extension
modules.
.. function:: readmodule(module[, path]) .. function:: readmodule(module[, path=None])
Read a module and return a dictionary mapping class names to class descriptor Read a module and return a dictionary mapping class names to class
objects. The parameter *module* should be the name of a module as a string; descriptor objects. The parameter *module* should be the name of a
it may be the name of a module within a package. The *path* parameter should module as a string; it may be the name of a module within a package. The
be a sequence, and is used to augment the value of ``sys.path``, which is *path* parameter should be a sequence, and is used to augment the value
used to locate module source code. of ``sys.path``, which is used to locate module source code.
.. The 'inpackage' parameter appears to be for internal use only....
.. function:: readmodule_ex(module[, path]) .. function:: readmodule_ex(module[, path=None])
Like :func:`readmodule`, but the returned dictionary, in addition to mapping Like :func:`readmodule`, but the returned dictionary, in addition to
class names to class descriptor objects, also maps top-level function names to mapping class names to class descriptor objects, also maps top-level
function descriptor objects. Moreover, if the module being read is a package, function names to function descriptor objects. Moreover, if the module
the key ``'__path__'`` in the returned dictionary has as its value a list which being read is a package, the key ``'__path__'`` in the returned
contains the package search path. dictionary has as its value a list which contains the package search
path.
.. The 'inpackage' parameter appears to be for internal use only....
.. _pyclbr-class-objects: .. _pyclbr-class-objects:
Class Descriptor Objects Class Objects
------------------------ -------------
The class descriptor objects used as values in the dictionary returned by The :class:`Class` objects used as values in the dictionary returned by
:func:`readmodule` and :func:`readmodule_ex` provide the following data members: :func:`readmodule` and :func:`readmodule_ex` provide the following data
members:
.. attribute:: class_descriptor.module .. attribute:: Class.module
The name of the module defining the class described by the class descriptor. The name of the module defining the class described by the class descriptor.
.. attribute:: class_descriptor.name .. attribute:: Class.name
The name of the class. The name of the class.
.. attribute:: class_descriptor.super .. attribute:: Class.super
A list of class descriptors which describe the immediate base classes of the A list of :class:`Class` objects which describe the immediate base
class being described. Classes which are named as superclasses but which are classes of the class being described. Classes which are named as
not discoverable by :func:`readmodule` are listed as a string with the class superclasses but which are not discoverable by :func:`readmodule` are
name instead of class descriptors. listed as a string with the class name instead of as :class:`Class`
objects.
.. attribute:: class_descriptor.methods .. attribute:: Class.methods
A dictionary mapping method names to line numbers. A dictionary mapping method names to line numbers.
.. attribute:: class_descriptor.file .. attribute:: Class.file
Name of the file containing the ``class`` statement defining the class. Name of the file containing the ``class`` statement defining the class.
.. attribute:: class_descriptor.lineno .. attribute:: Class.lineno
The line number of the ``class`` statement within the file named by The line number of the ``class`` statement within the file named by
:attr:`file`. :attr:`file`.
@ -83,30 +83,31 @@ The class descriptor objects used as values in the dictionary returned by
.. _pyclbr-function-objects: .. _pyclbr-function-objects:
Function Descriptor Objects Function Objects
--------------------------- ----------------
The function descriptor objects used as values in the dictionary returned by The :class:`Function` objects used as values in the dictionary returned by
:func:`readmodule_ex` provide the following data members: :func:`readmodule_ex` provide the following data members:
.. attribute:: function_descriptor.module .. attribute:: Function.module
The name of the module defining the function described by the function The name of the module defining the function described by the function
descriptor. descriptor.
.. attribute:: function_descriptor.name .. attribute:: Function.name
The name of the function. The name of the function.
.. attribute:: function_descriptor.file .. attribute:: Function.file
Name of the file containing the ``def`` statement defining the function. Name of the file containing the ``def`` statement defining the function.
.. attribute:: function_descriptor.lineno .. attribute:: Function.lineno
The line number of the ``def`` statement within the file named by :attr:`file`. The line number of the ``def`` statement within the file named by
:attr:`file`.