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
__delitem__
Delete a type parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:522
Method
__delitem__
Delete a member with its name or path. This method is part of the consumer API: do not use when producing Griffe trees! Memb
packages/griffelib/src/griffe/_internal/mixins.py:87
Method
__eq__
Two name expressions are equal if they have the same `name` value (`parent` is ignored).
packages/griffelib/src/griffe/_internal/expressions.py:727
Method
__eq__
Parameters are equal if all their attributes except `docstring` and `function` are equal.
packages/griffelib/src/griffe/_internal/models.py:258
Function
__getattr__
(attr: str)
packages/griffelib/src/griffe/__init__.py:613
Method
__getattr__
(self, name: str)
packages/griffelib/src/griffe/_internal/logger.py:28
Method
__getitem__
Get a parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:319
Method
__getitem__
Get a type parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:499
Method
__getitem__
Get the lines of a file path.
packages/griffelib/src/griffe/_internal/collections.py:24
Method
__getitem__
Get a member with its name or path. This method is part of the consumer API: do not use when producing Griffe trees! Members
packages/griffelib/src/griffe/_internal/mixins.py:37
Method
__init__
(self, cli_value: str = "")
duties.py:471
Method
__init__
(self, nargs: int | str | None = 0, **kwargs: Any)
packages/griffecli/src/griffecli/_internal/cli.py:44
Method
__init__
Initialize the loader. Parameters: extensions: The extensions to use. search_paths: The paths to search into.
packages/griffelib/src/griffe/_internal/loader.py:53
Method
__init__
Initialize the encoder. Parameters: *args: See [`json.JSONEncoder`][]. full: Whether to dump full data or base data.
packages/griffelib/src/griffe/_internal/encoders.py:55
Method
__init__
Initialize the list. Parameters: *lists: Lists of items.
packages/griffelib/src/griffe/_internal/c3linear.py:48
Method
__init__
Initialize the exception. Parameters: alias: The alias that could not be resolved.
packages/griffelib/src/griffe/_internal/exceptions.py:34
Method
__init__
Initialize the decorator. Parameters: value: The decorator code. lineno: The starting line number. endlin
packages/griffelib/src/griffe/_internal/models.py:37
Method
__init__
Initialize the docstring. Parameters: value: The docstring value. lineno: The starting line number. endli
packages/griffelib/src/griffe/_internal/models.py:77
Method
__init__
Initialize the parameter. Parameters: name: The parameter name, without leading stars (`*` or `**`). annotation: The
packages/griffelib/src/griffe/_internal/models.py:216
Method
__init__
Initialize the parameters container. Parameters: *parameters: The initial parameters to add to the container.
packages/griffelib/src/griffe/_internal/models.py:308
Method
__init__
Initialize the type parameter. Parameters: name: The type parameter name, without leading stars (`*` or `**`). kind:
packages/griffelib/src/griffe/_internal/models.py:387
Method
__init__
Initialize the type parameters container. Parameters: *type_parameters: The initial type parameters to add to the container.
packages/griffelib/src/griffe/_internal/models.py:488
Method
__init__
Initialize the object. Parameters: name: The object name, as declared in the code. lineno: The object starting line,
packages/griffelib/src/griffe/_internal/models.py:579
Method
__init__
Initialize the module. Parameters: *args: See [`griffe.Object`][]. filepath: The module file path (directory for name
packages/griffelib/src/griffe/_internal/models.py:2240
Method
__init__
Initialize the class. Parameters: *args: See [`griffe.Object`][]. bases: The list of base classes, if any.
packages/griffelib/src/griffe/_internal/models.py:2363
Method
__init__
Initialize the function. Parameters: *args: See [`griffe.Object`][]. parameters: The function parameters.
packages/griffelib/src/griffe/_internal/models.py:2492
Method
__init__
Initialize the function. Parameters: *args: See [`griffe.Object`][]. value: The attribute value, if any.
packages/griffelib/src/griffe/_internal/models.py:2662
Method
__init__
Initialize the function. Parameters: *args: See [`griffe.Object`][]. value: The type alias value. **kwarg
packages/griffelib/src/griffe/_internal/models.py:2711
Method
__init__
Initialize the finder. Parameters: search_paths: Optional paths to search into.
packages/griffelib/src/griffe/_internal/finder.py:102
Method
__init__
(self, name: str)
packages/griffelib/src/griffe/_internal/logger.py:24
Method
__init__
Initialize the breakage. Parameters: obj: The object related to the breakage. old_value: The old value. n
packages/griffelib/src/griffe/_internal/diff.py:79
Method
__init__
Initialize the collection.
packages/griffelib/src/griffe/_internal/collections.py:20
Method
__init__
Initialize the collection.
packages/griffelib/src/griffe/_internal/collections.py:71
Method
__init__
Initialiwe the stats object. Parameters: loader: The loader to compute stats for.
packages/griffelib/src/griffe/_internal/stats.py:20
Method
__init__
Initialize the element. Parameters: name: The element name. description: The element description. annotat
packages/griffelib/src/griffe/_internal/docstrings/models.py:51
Method
__init__
Initialize the section. Parameters: title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:231
Method
__init__
Initialize the section. Parameters: value: The section text. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:270
Method
__init__
Initialize the section. Parameters: value: The section parameters. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:286
Method
__init__
Initialize the section. Parameters: value: The section type parameters. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:308
Method
__init__
Initialize the section. Parameters: value: The section exceptions. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:324
Method
__init__
Initialize the section. Parameters: value: The section warnings. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:340
Method
__init__
Initialize the section. Parameters: value: The section returned items. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:356
Method
__init__
Initialize the section. Parameters: value: The section yielded items. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:372
Method
__init__
Initialize the section. Parameters: value: The section received items. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:388
Method
__init__
Initialize the section. Parameters: value: The section examples. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:404
Method
__init__
Initialize the section. Parameters: value: The section attributes. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:424
Method
__init__
Initialize the section. Parameters: value: The section functions. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:440
Method
__init__
Initialize the section. Parameters: value: The section classes. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:456
Method
__init__
Initialize the section. Parameters: value: The section classes. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:472
Method
__init__
Initialize the section. Parameters: value: The section modules. title: An optional title.
packages/griffelib/src/griffe/_internal/docstrings/models.py:488
Method
__init__
Initialize the section. Parameters: version: The deprecation version. text: The deprecation text. title:
packages/griffelib/src/griffe/_internal/docstrings/models.py:504
Method
__init__
Initialize the section. Parameters: kind: The admonition kind. text: The admonition text. title: An optio
packages/griffelib/src/griffe/_internal/docstrings/models.py:521
Method
__init__
Initialize the extensions container. Parameters: *extensions: The extensions to add.
packages/griffelib/src/griffe/_internal/extensions/base.py:445
Method
__init__
Initialize the inspector. Parameters: module_name: The module name. filepath: The optional filepath. exte
packages/griffelib/src/griffe/_internal/agents/inspector.py:122
Method
__init__
Initialize the visitor. Parameters: module_name: The module name. filepath: The module filepath. code: Th
packages/griffelib/src/griffe/_internal/agents/visitor.py:137
Method
__init__
Initialize the object. Parameters: obj: A Python object. name: The object's name. parent: The object's pa
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:52
Method
__init__
(self, *args: Any, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:54
Method
__init__
(self, *args: Any, python_version: str, **kwargs: Any)
scripts/make.py:163
Method
__iter__
Iterate on the expression syntax and elements.
packages/griffelib/src/griffe/_internal/expressions.py:168
Method
__iter__
Iterate over the parameters, in order.
packages/griffelib/src/griffe/_internal/models.py:358
Method
__iter__
Iterate over the type parameters, in order.
packages/griffelib/src/griffe/_internal/models.py:538
Method
__len__
The number of parameters.
packages/griffelib/src/griffe/_internal/models.py:354
Method
__len__
The number of type parameters.
packages/griffelib/src/griffe/_internal/models.py:534
Method
__len__
The number of members in this object, recursively.
packages/griffelib/src/griffe/_internal/models.py:721
Method
__len__
The length of an alias is always 1.
packages/griffelib/src/griffe/_internal/models.py:1430
Method
__post_init__
(self)
packages/griffelib/src/griffe/_internal/helpers.py:48
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/c3linear.py:64
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:255
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:316
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:430
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:496
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:713
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:1422
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/models.py:2253
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/diff.py:100
Method
__repr__
(self)
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:86
Method
__setitem__
Set a parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:329
Method
__setitem__
Set a type parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:509
Method
__setitem__
Set the lines of a file path.
packages/griffelib/src/griffe/_internal/collections.py:28
Method
__setitem__
Set a member with its name or path. This method is part of the consumer API: do not use when producing Griffe trees! Paramet
packages/griffelib/src/griffe/_internal/mixins.py:142
Method
__str__
(self)
packages/griffelib/src/griffe/_internal/expressions.py:165
Method
__str__
(self)
packages/griffelib/src/griffe/_internal/models.py:249
Method
__str__
(self)
packages/griffelib/src/griffe/_internal/enumerations.py:200
Method
__str__
(self)
packages/griffelib/src/griffe/_internal/diff.py:97
Function
_build_attribute
(node: ast.Attribute, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1114
Function
_build_binop
(node: ast.BinOp, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1126
Function
_build_boolop
(node: ast.BoolOp, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1134
Function
_build_call
(node: ast.Call, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1141
Function
_build_compare
(node: ast.Compare, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1148
Function
_build_comprehension
(node: ast.comprehension, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1156
Function
_build_constant
( node: ast.Constant, parent: Module | Class, *, in_formatted_str: bool = False, in_joined
packages/griffelib/src/griffe/_internal/expressions.py:1165
Function
_build_dict
(node: ast.Dict, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1204
Function
_build_dictcomp
(node: ast.DictComp, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1211
Function
_build_formatted
( node: ast.FormattedValue, parent: Module | Class, *, in_formatted_str: bool = False, # noqa
packages/griffelib/src/griffe/_internal/expressions.py:1219
Function
_build_generatorexp
(node: ast.GeneratorExp, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1229
Function
_build_ifexp
(node: ast.IfExp, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1236
Function
_build_interpolation
(node: ast.Interpolation, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1402
Function
_build_joinedstr
( node: ast.JoinedStr, parent: Module | Class, *, in_joined_str: bool = False, # noqa: ARG001
packages/griffelib/src/griffe/_internal/expressions.py:1244
Function
_build_keyword
(node: ast.keyword, parent: Module | Class, function: Expr | None = None, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1254
Function
_build_lambda
(node: ast.Lambda, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1260
← previous
next →
301–400 of 1,229, ranked by callers