pydocspec.ext.opt.attrs

module documentation

(source)

Handles attrs classes like:

@attr.s(auto_attribs=True)
class MyData:
    name:str
    age:float
    permissions = attr.ib()

Class	`AttrsClassMixin`	No class docstring; 2/2 properties documented
Class	`AttrsDataMixin`	No class docstring; 1/1 property documented
Function	`setup_extension`	Undocumented
Function	`uses_auto_attribs`	Does the given `attr.s()` decoration contain `auto_attribs=True`? :param call: AST of the call to `attr.s()`.
Variable	`_attrs_decorator_signature`	Signature of the `attr.s` class decorator.

def setup_extension(r): (source)

Undocumented

Parameters
r:`pydocspec.ext.ExtRegistrar`	Undocumented

def uses_auto_attribs(call, ctx): (source)

Does the given attr.s() decoration contain auto_attribs=True? :param call: AST of the call to attr.s().

This function will assume that attr.s() is called without verifying that.

Parameters
call:`astroid.nodes.Call`	Undocumented
ctx:`pydocspec.ApiObject`	Namespace that contains the call, used for error reporting.
Returns
`bool`	`True` if `True` is passed for `auto_attribs`, `False` in all other cases: if `auto_attribs` is not passed, if an explicit `False` is passed or if an error was reported.

_attrs_decorator_signature = (source)

Signature of the attr.s class decorator.