Participer au site avec un Tip
Rechercher
 

Améliorations / Corrections

Vous avez des améliorations (ou des corrections) à proposer pour ce document : je vous remerçie par avance de m'en faire part, cela m'aide à améliorer le site.

Emplacement :

Description des améliorations :

Python 3.11.3

Contenu du module « pydoc »

Liste des classes du module pydoc

Nom de la classe Description
deque deque([iterable[, maxlen]]) --> deque object [extrait de deque.__doc__]
Doc
Helper
HTMLDoc Formatter class for HTML documentation. [extrait de HTMLDoc.__doc__]
HTMLRepr Class for safely making an HTML representation of a Python object. [extrait de HTMLRepr.__doc__]
ModuleScanner An interruptible scanner that searches module synopses. [extrait de ModuleScanner.__doc__]
Repr
TextDoc Formatter class for text documentation. [extrait de TextDoc.__doc__]
TextRepr Class for safely making a text representation of a Python object. [extrait de TextRepr.__doc__]

Liste des exceptions du module pydoc

Nom de la classe d'exception Description
ErrorDuringImport Errors that occurred while trying to import something to document it. [extrait de ErrorDuringImport.__doc__]

Liste des fonctions du module pydoc

Signature de la fonction Description
allmethods(cl)
apropos(key) Print all the one-line module summaries that contain a substring. [extrait de apropos.__doc__]
browse(port=0, *, open_browser=True, hostname='localhost') Start the enhanced pydoc web server and open a web browser. [extrait de browse.__doc__]
classify_class_attrs(object) Wrap inspect.classify_class_attrs, with fixup for data descriptors. [extrait de classify_class_attrs.__doc__]
classname(object, modname) Get a class name and qualify it with a module name if necessary. [extrait de classname.__doc__]
cli() Command-line interface (looks at sys.argv to decide what to do). [extrait de cli.__doc__]
cram(text, maxlen) Omit part of a string if needed to make it fit in a maximum length. [extrait de cram.__doc__]
describe(thing) Produce a short description of the given thing. [extrait de describe.__doc__]
doc(thing, title='Python Library Documentation: %s', forceload=0, output=None) Display text documentation, given an object or a path to an object. [extrait de doc.__doc__]
format_exception_only(exc, /, value=<implicit>) Format the exception part of a traceback. [extrait de format_exception_only.__doc__]
getdoc(object) Get the doc string or comments for an object. [extrait de getdoc.__doc__]
getpager() Decide what method to use for paging through text. [extrait de getpager.__doc__]
help(request=<object object at 0x7f721bac4be0>)
importfile(path) Import a Python source file or compiled file given its path. [extrait de importfile.__doc__]
isdata(object) Check if an object is of a type that probably means it's data. [extrait de isdata.__doc__]
ispackage(path) Guess whether a path refers to a package directory. [extrait de ispackage.__doc__]
ispath(x)
locate(path, forceload=0) Locate an object by name or dotted path, importing as necessary. [extrait de locate.__doc__]
pager(text) The first time this is called, determine what kind of pager to use. [extrait de pager.__doc__]
pathdirs() Convert sys.path into a list of absolute, existing, unique paths. [extrait de pathdirs.__doc__]
pipepager(text, cmd) Page through text by feeding it to another program. [extrait de pipepager.__doc__]
plain(text) Remove boldface formatting from text. [extrait de plain.__doc__]
plainpager(text) Simply print unformatted text. This is the ultimate fallback. [extrait de plainpager.__doc__]
render_doc(thing, title='Python Library Documentation: %s', forceload=0, renderer=None) Render text documentation, given an object or a path to an object. [extrait de render_doc.__doc__]
replace(text, *pairs) Do a series of global replacements on a string. [extrait de replace.__doc__]
resolve(thing, forceload=0) Given an object or a path to an object, get the object and its name. [extrait de resolve.__doc__]
safeimport(path, forceload=0, cache={}) Import a module; handle errors; return None if the module isn't found. [extrait de safeimport.__doc__]
sort_attributes(attrs, object) Sort the attrs list in-place by _fields and then alphabetically by name [extrait de sort_attributes.__doc__]
source_synopsis(file)
splitdoc(doc) Split a doc string into a synopsis line (if any) and the rest. [extrait de splitdoc.__doc__]
stripid(text) Remove the hexadecimal id from a Python object representation. [extrait de stripid.__doc__]
synopsis(filename, cache={}) Get the one-line summary out of a module file. [extrait de synopsis.__doc__]
tempfilepager(text, cmd) Page through text by invoking a program on a temporary file. [extrait de tempfilepager.__doc__]
ttypager(text) Page through text on a text terminal. [extrait de ttypager.__doc__]
visiblename(name, all=None, obj=None) Decide whether to show documentation on a variable. [extrait de visiblename.__doc__]
writedoc(thing, forceload=0) Write HTML documentation to a file in the current directory. [extrait de writedoc.__doc__]
writedocs(dir, pkgpath='', done=None) Write out HTML documentation for all modules in a directory tree. [extrait de writedocs.__doc__]

Liste des variables globales du module pydoc

Nom de la variable globale Valeur
html <pydoc.HTMLDoc object at 0x7f720d4553d0>
plaintext <pydoc._PlainTextDoc object at 0x7f720d455390>
text <pydoc.TextDoc object at 0x7f720d455350>