sphinx.domains.python.PyObject

class documentation

class PyObject(ObjectDescription[Tuple[str, str]]):

Known subclasses: sphinx.domains.python.PyAttribute, sphinx.domains.python.PyClasslike, sphinx.domains.python.PyFunction, sphinx.domains.python.PyMethod, sphinx.domains.python.PyProperty, sphinx.domains.python.PyVariable

View In Hierarchy

Description of a general Python object.

Unknown Field: vartype
allow_nesting	bool

Method	`add_target_and_index`	Undocumented
Method	`after_content`	Handle object de-nesting after content
Method	`before_content`	Handle object nesting before content
Method	`get_index_text`	Return the text for the index entry of the object.
Method	`get_signature_prefix`	May return a prefix to put before the object name in the signature.
Method	`handle_signature`	Transform a Python signature into RST nodes.
Method	`needs_arglist`	May return true if an empty argument list is to be generated even if the document contains none.
Class Variable	`allow_nesting`	Class is an object that allows for nested namespaces
Class Variable	`doc_field_types`	Undocumented
Class Variable	`option_spec`	Undocumented

def add_target_and_index(self, name_cls, sig, signode):

overridden in sphinx.domains.python.PyFunction

Undocumented

Parameters
name_cls:`Tuple[str, str]`	Undocumented
sig:`str`	Undocumented
signode:`desc_signature`	Undocumented

def after_content(self):

Handle object de-nesting after content

If this class is a nestable object, removing the last nested class prefix ends further nesting in the object.

If this class is not a nestable object, the list of classes should not be altered as we didn't affect the nesting levels in before_content.

def before_content(self):

Handle object nesting before content

PyObject represents Python language constructs. For constructs that are nestable, such as a Python classes, this method will build up a stack of the nesting hierarchy so that it can be later de-nested correctly, in after_content.

For constructs that aren't nestable, the stack is bypassed, and instead only the most recent object is tracked. This object prefix name will be removed with after_content.

def get_index_text(self, modname, name):

overridden in sphinx.domains.python.PyAttribute, sphinx.domains.python.PyClasslike, sphinx.domains.python.PyFunction, sphinx.domains.python.PyMethod, sphinx.domains.python.PyProperty, sphinx.domains.python.PyVariable

Return the text for the index entry of the object.

Parameters
modname:`str`	Undocumented
name:`Tuple[str, str]`	Undocumented
Returns
`str`	Undocumented

def get_signature_prefix(self, sig):

overridden in sphinx.domains.python.PyClasslike, sphinx.domains.python.PyFunction, sphinx.domains.python.PyMethod, sphinx.domains.python.PyProperty

May return a prefix to put before the object name in the signature.

Parameters
sig:`str`	Undocumented
Returns
`List[nodes.Node]`	Undocumented

def handle_signature(self, sig, signode):

overridden in sphinx.domains.python.PyAttribute, sphinx.domains.python.PyDecoratorFunction, sphinx.domains.python.PyDecoratorMethod, sphinx.domains.python.PyProperty, sphinx.domains.python.PyVariable

Transform a Python signature into RST nodes.

Return (fully qualified name of the thing, classname if any).

If inside a class, the current class name is handled intelligently: * it is stripped from the displayed name if present * it is added to the full name (return value) if not present

Parameters
sig:`str`	Undocumented
signode:`desc_signature`	Undocumented
Returns
`Tuple[str, str]`	Undocumented

def needs_arglist(self):

overridden in sphinx.domains.python.PyFunction, sphinx.domains.python.PyMethod

May return true if an empty argument list is to be generated even if the document contains none.

Returns
`bool`	Undocumented

allow_nesting: bool =

overridden in sphinx.domains.python.PyClasslike

Class is an object that allows for nested namespaces

doc_field_types =

Undocumented

option_spec: OptionSpec =

Undocumented