sphinx.ext.autodoc.UninitializedInstanceAttributeMixin

class documentation

class UninitializedInstanceAttributeMixin(DataDocumenterMixinBase):

Mixin for AttributeDocumenter to provide the feature for supporting uninitialized instance attributes (PEP-526 styled, annotation only attributes).

Example:

class Foo:

attr: int #: This is a target of this mix-in.

Method	`get_doc`	Undocumented
Method	`import_object`	Check the exisitence of uninitialized instance attribute when failed to import the attribute.
Method	`is_uninitialized_instance_attribute`	Check the subject is an annotation only attribute.
Method	`should_suppress_value_header`	Check :value: header should be suppressed.
Instance Variable	`object`	Undocumented
Instance Variable	`parent`	Undocumented

Method	`should_suppress_directive_header`	Check directive header should be suppressed.
Method	`update_content`	Update docstring for the NewType object.
Class Variable	`config`	Undocumented
Class Variable	`env`	Undocumented
Class Variable	`modname`	Undocumented
Class Variable	`objpath`	Undocumented

def get_doc(self, ignore=None):

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

def import_object(self, raiseerror=False):

overridden in sphinx.ext.autodoc.AttributeDocumenter

Check the exisitence of uninitialized instance attribute when failed to import the attribute.

def is_uninitialized_instance_attribute(self, parent):

Check the subject is an annotation only attribute.

def should_suppress_value_header(self):

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_value_header

overridden in sphinx.ext.autodoc.AttributeDocumenter

Check :value: header should be suppressed.

Returns
`bool`	Undocumented

object =

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.object

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

parent =

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.parent

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented