Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# `autodoc2.astroid_utils`

## Module Contents

### Functions

`resolve_import_alias` |
`is_constructor` |
`get_full_import_name` |
`get_assign_value` |
`get_const_values` |
`get_assign_annotation` |
`resolve_annotation` |
`resolve_qualname` |
`get_module_all` |
`is_decorated_with_singledispatch` |
`is_singledispatch_decorator` |
`is_decorated_as_singledispatch_register` |
`is_decorated_with_property` |
`is_property_decorator` |
`is_decorated_with_property_setter` |
`get_class_docstring` |
`is_exception` |
`is_decorated_with_overload` |
`is_overload_decorator` |
`get_func_docstring` |
`get_return_annotation` |
`get_args_info` |
`_iter_args` |
`_merge_annotations` |
`_is_ellipsis` |

### API

autodoc2.astroid_utils.resolve_import_alias(name: str, import_names: list[tuple[str, str | None]]) → str

autodoc2.astroid_utils.is_constructor(node: astroid.nodes.NodeNG) → bool

autodoc2.astroid_utils.get_full_import_name(import_from: astroid.nodes.ImportFrom, name: str) → str

autodoc2.astroid_utils.get_assign_value(node: astroid.nodes.NodeNG) → None | tuple[str, Any]

autodoc2.astroid_utils.get_const_values(node: astroid.nodes.NodeNG) → Any

autodoc2.astroid_utils.get_assign_annotation(node: astroid.nodes.Assign) → None | str

autodoc2.astroid_utils.resolve_annotation(annotation: astroid.nodes.NodeNG) → str

autodoc2.astroid_utils.resolve_qualname(node: astroid.nodes.NodeNG, basename: str) → str

autodoc2.astroid_utils.get_module_all(node: astroid.nodes.Module) → None | list[str]

autodoc2.astroid_utils.is_decorated_with_singledispatch(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef) → bool

autodoc2.astroid_utils.is_singledispatch_decorator(decorator: astroid.Name) → bool

autodoc2.astroid_utils.is_decorated_as_singledispatch_register(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef) → bool

autodoc2.astroid_utils.is_decorated_with_property(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef) → bool

autodoc2.astroid_utils.is_property_decorator(decorator: astroid.Name) → bool

autodoc2.astroid_utils.is_decorated_with_property_setter(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef) → bool

autodoc2.astroid_utils.get_class_docstring(node: astroid.nodes.ClassDef) → tuple[str, str | None]

autodoc2.astroid_utils.is_exception(node: astroid.nodes.ClassDef) → bool

autodoc2.astroid_utils.is_decorated_with_overload(node: astroid.nodes.FunctionDef) → bool

autodoc2.astroid_utils.is_overload_decorator(decorator: astroid.Name | astroid.Attribute) → bool

autodoc2.astroid_utils.get_func_docstring(node: astroid.nodes.FunctionDef) → tuple[str, None | str]

autodoc2.astroid_utils.get_return_annotation(node: astroid.nodes.FunctionDef) → None | str

autodoc2.astroid_utils.get_args_info(args_node: astroid.Arguments) → list[tuple[None | str, None | str, None | str, None | str]]

autodoc2.astroid_utils._iter_args(args: list[astroid.nodes.NodeNG], annotations: list[astroid.nodes.NodeNG], defaults: list[astroid.nodes.NodeNG]) → Iterable[tuple[str, None | str, str | None]]

autodoc2.astroid_utils._merge_annotations(annotations: Iterable[Any], comment_annotations: Iterable[Any]) → Iterable[Any]

autodoc2.astroid_utils._is_ellipsis(node: Any) → bool