Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/mkdocstrings/griffe
/ functions
Functions
1,229 in github.com/mkdocstrings/griffe
⨍
Functions
1,229
◇
Types & classes
163
↳
Endpoints
4
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:439
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:452
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:473
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:490
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:501
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:517
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:534
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:559
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:573
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:613
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:626
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:638
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:652
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:693
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:708
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:733
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:819
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:846
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:861
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:880
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:900
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:940
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:955
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:980
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:994
Method
iterate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:1008
Function
json_decoder
Decode dictionaries as data classes. The [`json.loads`][] method walks the tree from bottom to top. Examples: >>> import json
packages/griffelib/src/griffe/_internal/encoders.py:339
Method
keywords
The class keywords.
packages/griffelib/src/griffe/_internal/models.py:1920
Method
kind
The target's kind, or `Kind.ALIAS` if the target cannot be resolved. See also: [`is_kind`][griffe.Alias.is_kind].
packages/griffelib/src/griffe/_internal/models.py:1439
Method
kind
The kind of this admonition.
packages/griffelib/src/griffe/_internal/docstrings/models.py:92
Method
kind
The kind of this node.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:142
Method
labels
The target labels (`property`, `dataclass`, etc.). See also: [`has_labels`][griffe.Alias.has_labels].
packages/griffelib/src/griffe/_internal/models.py:1635
Method
last
The last part of this attribute (on the right).
packages/griffelib/src/griffe/_internal/expressions.py:301
Method
lineno
The starting line number of the target object. See also: [`endlineno`][griffe.Alias.endlineno].
packages/griffelib/src/griffe/_internal/models.py:1589
Method
lines
The lines of the docstring. See also: [`source`][griffe.Docstring.source].
packages/griffelib/src/griffe/_internal/models.py:131
Method
lines
The lines containing the source of this object. See also: [`lines_collection`][griffe.Object.lines_collection], [`source`][griffe.Obj
packages/griffelib/src/griffe/_internal/models.py:1166
Method
lines
The lines containing the source of this object. See also: [`source`][griffe.Alias.source], [`lines_collection`][griffe.Alias.lines_co
packages/griffelib/src/griffe/_internal/models.py:1869
Method
lines_collection
The lines collection attached to this object or its parents. See also: [`lines`][griffe.Object.lines], [`source`][griffe.Object.sourc
packages/griffelib/src/griffe/_internal/models.py:1150
Method
lines_collection
The lines collection attached to this object or its parents. See also: [`lines`][griffe.Alias.lines], [`source`][griffe.Alias.source]
packages/griffelib/src/griffe/_internal/models.py:1857
Method
members
The target's members (modules, classes, functions, attributes, type aliases). See also: [`inherited_members`][griffe.Alias.inherited_members]
packages/griffelib/src/griffe/_internal/models.py:1499
Method
modernize
(self)
packages/griffelib/src/griffe/_internal/expressions.py:285
Method
modernize
(self)
packages/griffelib/src/griffe/_internal/expressions.py:736
Method
modernize
(self)
packages/griffelib/src/griffe/_internal/expressions.py:907
Method
modernize
(self)
packages/griffelib/src/griffe/_internal/expressions.py:964
Method
module
The parent module of this object. See also: [`package`][griffe.Object.package]. Examples: >>> import griffe
packages/griffelib/src/griffe/_internal/models.py:986
Method
module
The parent module of this object. See also: [`package`][griffe.Alias.package]. Raises: ValueError: When the object is no
packages/griffelib/src/griffe/_internal/models.py:1793
Method
module
The object's module, fetched from the node tree.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:97
Method
module_path
The object's module path.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:106
Method
modules
The module members. This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/mixins.py:268
Method
modules_collection
The modules collection attached to this object or its parents. Raises: ValueError: When no modules collection can be found in the
packages/griffelib/src/griffe/_internal/models.py:1137
Method
modules_collection
The modules collection attached to the alias parents.
packages/griffelib/src/griffe/_internal/models.py:1493
Method
mro
Return a list of classes in order corresponding to Python's MRO. See also: [`bases`][griffe.Class.bases], [`resolved_bases`][griffe.C
packages/griffelib/src/griffe/_internal/models.py:2462
Method
on_alias
(self, *, alias: Alias, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:236
Method
on_alias_instance
Run when an Alias has been created. Warning: This method runs while the object tree is still being constructed: data
packages/griffelib/src/griffe/_internal/extensions/base.py:387
Method
on_alias_instance
(self, *, node: ast.AST | ObjectNode, alias: Alias, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:105
Method
on_attribute
Run on attributes once the object tree has been fully constructed. Note: This method runs once the object tree has been fully con
packages/griffelib/src/griffe/_internal/extensions/base.py:330
Method
on_attribute
(self, *, attr: Attribute, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:239
Method
on_attribute_instance
Run when an Attribute has been created. Warning: This method runs while the object tree is still being constructed: d
packages/griffelib/src/griffe/_internal/extensions/base.py:308
Method
on_attribute_instance
(self, *, node: ast.AST | ObjectNode, attr: Attribute, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:60
Method
on_attribute_node
Run when visiting a new attribute node during static/dynamic analysis. Parameters: node: The currently visited node.
packages/griffelib/src/griffe/_internal/extensions/base.py:299
Method
on_attribute_node
(self, *, node: ast.AST | ObjectNode, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:63
Method
on_class
Run on classes once the object tree has been fully constructed. Note: This method runs once the object tree has been fully constr
packages/griffelib/src/griffe/_internal/extensions/base.py:220
Method
on_class
Add an `__init__` method to `TypedDict` classes if missing.
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:191
Method
on_class
(self, *, cls: Class, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:242
Method
on_class_instance
Run when a Class has been created. Warning: This method runs while the object tree is still being constructed: data m
packages/griffelib/src/griffe/_internal/extensions/base.py:198
Method
on_class_instance
(self, *, node: ast.AST | ObjectNode, cls: Class, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:66
Method
on_class_members
Run when members of a Class have been loaded. Warning: This method runs while the object tree is still being constructed:
packages/griffelib/src/griffe/_internal/extensions/base.py:233
Method
on_class_members
(self, *, node: ast.AST | ObjectNode, cls: Class, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:69
Method
on_class_node
Run when visiting a new class node during static/dynamic analysis. Parameters: node: The currently visited node. agen
packages/griffelib/src/griffe/_internal/extensions/base.py:189
Method
on_class_node
(self, *, node: ast.AST | ObjectNode, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:72
Method
on_function
Run on functions once the object tree has been fully constructed. Note: This method runs once the object tree has been fully cons
packages/griffelib/src/griffe/_internal/extensions/base.py:286
Method
on_function
Expand `**kwargs: Unpack[TypedDict]` in function signatures.
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:218
Method
on_function
(self, *, func: Function, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:245
Method
on_function_instance
Run when a Function has been created. Warning: This method runs while the object tree is still being constructed: dat
packages/griffelib/src/griffe/_internal/extensions/base.py:264
Method
on_function_instance
(self, *, node: ast.AST | ObjectNode, func: Function, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:75
Method
on_function_node
Run when visiting a new function node during static/dynamic analysis. Parameters: node: The currently visited node. a
packages/griffelib/src/griffe/_internal/extensions/base.py:255
Method
on_function_node
(self, *, node: ast.AST | ObjectNode, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:78
Method
on_instance
Run when an Object has been created. Warning: This method runs while the object tree is still being constructed: data
packages/griffelib/src/griffe/_internal/extensions/base.py:73
Method
on_instance
(self, *, node: ast.AST | ObjectNode, obj: Object, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:81
Method
on_members
Run when members of an Object have been loaded. Warning: This method runs while the object tree is still being constructed:
packages/griffelib/src/griffe/_internal/extensions/base.py:108
Method
on_members
(self, *, node: ast.AST | ObjectNode, obj: Object, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:84
Method
on_module
Run on modules once the object tree has been fully constructed. Note: This method runs once the object tree has been fully constr
packages/griffelib/src/griffe/_internal/extensions/base.py:154
Method
on_module
(self, *, mod: Module, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:248
Method
on_module_instance
Run when a Module has been created. Warning: This method runs while the object tree is still being constructed: data
packages/griffelib/src/griffe/_internal/extensions/base.py:132
Method
on_module_instance
(self, *, node: ast.AST | ObjectNode, mod: Module, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:87
Method
on_module_members
Run when members of a Module have been loaded. Warning: This method runs while the object tree is still being constructed:
packages/griffelib/src/griffe/_internal/extensions/base.py:167
Method
on_module_members
(self, *, node: ast.AST | ObjectNode, mod: Module, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:90
Method
on_module_node
Run when visiting a new module node during static/dynamic analysis. Parameters: node: The currently visited node. age
packages/griffelib/src/griffe/_internal/extensions/base.py:123
Method
on_module_node
(self, *, node: ast.AST | ObjectNode, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:93
Method
on_node
Run when visiting a new node during static/dynamic analysis. Parameters: node: The currently visited node.
packages/griffelib/src/griffe/_internal/extensions/base.py:66
Method
on_node
(self, *, node: ast.AST | ObjectNode, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:96
Method
on_object
Run on objects (every kind) once the object tree has been fully constructed. Note: This method runs once the object tree has been
packages/griffelib/src/griffe/_internal/extensions/base.py:95
Method
on_object
(self, *, obj: Object, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:251
Method
on_package
Run when a package has been completely loaded. Note: This method runs once the object tree has been fully constructed:
packages/griffelib/src/griffe/_internal/extensions/base.py:424
Method
on_package
Hook for loaded packages. Parameters: pkg: The loaded package.
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:227
Method
on_package
(self, *, pkg: Module, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:254
Method
on_type_alias
Run on type aliases once the object tree has been fully constructed. Note: This method runs once the object tree has been fully c
packages/griffelib/src/griffe/_internal/extensions/base.py:374
Method
on_type_alias
(self, *, type_alias: TypeAlias, loader: GriffeLoader, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:257
Method
on_type_alias_instance
Run when a TypeAlias has been created. Warning: This method runs while the object tree is still being constructed: da
packages/griffelib/src/griffe/_internal/extensions/base.py:352
Method
on_type_alias_instance
(self, *, node: ast.AST | ObjectNode, type_alias: TypeAlias, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:99
← previous
next →
701–800 of 1,229, ranked by callers