sphinx.ext.autodoc.ObjectMember

class documentation

class ObjectMember(tuple):

View In Hierarchy

A member of object.

This is used for the result of Documenter.get_object_members() to represent each member of the object.

Note

An instance of this class behaves as a tuple of (name, object) for compatibility to old Sphinx. The behavior will be dropped in the future. Therefore extensions should not use the tuple interface.

Method __init__ Undocumented
Method __new__ Undocumented
Instance Variable __name__ Undocumented
Instance Variable class​_ Undocumented
Instance Variable docstring Undocumented
Instance Variable object Undocumented
Instance Variable skipped Undocumented
def __init__(self, name, obj, docstring=None, class_=None, skipped=False):

Undocumented

Parameters
name:strUndocumented
obj:AnyUndocumented
docstring:Optional[str]Undocumented
class​_:AnyUndocumented
skipped:boolUndocumented
def __new__(cls, name, obj, **kwargs):

Undocumented

Parameters
name:strUndocumented
obj:AnyUndocumented
**kwargs:AnyUndocumented
Returns
AnyUndocumented
__name__ =

Undocumented

class_ =

Undocumented

docstring =

Undocumented

object =

Undocumented

skipped =

Undocumented