MCPcopy Create free account

hub / github.com/mkdocstrings/griffe / functions

Functions1,229 in github.com/mkdocstrings/griffe

Function_read_returns_section
( docstring: Docstring, *, offset: int, returns_multiple_items: bool = True, returns_named
packages/griffelib/src/griffe/_internal/docstrings/google.py:637
Function_read_returns_section
( docstring: Docstring, *, offset: int, warnings: bool = True, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:430
Function_read_type_aliases_section
( docstring: Docstring, *, offset: int, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/google.py:462
Function_read_type_aliases_section
( docstring: Docstring, *, offset: int, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:740
Function_read_type_parameters_section
( docstring: Docstring, *, offset: int, warn_unknown_params: bool = True, **options: Any,
packages/griffelib/src/griffe/_internal/docstrings/google.py:277
Function_read_type_parameters_section
( docstring: Docstring, *, offset: int, warn_unknown_params: bool = True, **options: Any,
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:334
Function_read_warns_section
( docstring: Docstring, *, offset: int, warnings: bool = True, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/google.py:546
Function_read_warns_section
( docstring: Docstring, *, offset: int, warnings: bool = True, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:612
Function_read_yields_section
( docstring: Docstring, *, offset: int, returns_multiple_items: bool = True, returns_named
packages/griffelib/src/griffe/_internal/docstrings/google.py:683
Function_read_yields_section
( docstring: Docstring, *, offset: int, warnings: bool = True, **options: Any, )
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:489
Method_relative_filepath
(self)
packages/griffelib/src/griffe/_internal/diff.py:138
Method_relative_package_filepath
(self)
packages/griffelib/src/griffe/_internal/diff.py:144
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:174
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:312
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:333
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:354
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:375
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:396
Method_relative_path
(self)
packages/griffelib/src/griffe/_internal/diff.py:417
Function_validate
(obj: dict, schema: dict)
packages/griffelib/tests/test_encoders.py:154
Methodadd
Add a type parameter to the container. Parameters: type_parameter: The function parameter to add. Raises: Va
packages/griffelib/src/griffe/_internal/models.py:550
Methodalias_target_path
Alias target path of this node, if the node should be an alias.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:295
Methodaliases
The aliases pointing to this object.
packages/griffelib/src/griffe/_internal/models.py:1673
Methodall_members
Members of the collection. This property is overwritten to simply return `self.members`, as `all_members` does not make sense for a m
packages/griffelib/src/griffe/_internal/collections.py:85
Methodall_members
All members (declared and inherited). This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/mixins.py:257
Methodannotation
The attribute type annotation.
packages/griffelib/src/griffe/_internal/models.py:2031
Methodannotation
The type annotation of the returned value.
packages/griffelib/src/griffe/_internal/models.py:2523
Methodas_dict
Return the expression as a dictionary. Parameters: **kwargs: Configuration options (none available yet). Returns:
packages/griffelib/src/griffe/_internal/expressions.py:201
Methodas_dict
Return this decorator's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/models.py:58
Methodas_dict
Return this docstring's data as a dictionary. Parameters: full: Whether to return full info, or just base info. **kwa
packages/griffelib/src/griffe/_internal/models.py:185
Methodas_dict
Return this parameter's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/models.py:274
Methodas_dict
Return this type parameter's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/models.py:458
Methodas_dict
Return this object's data as a dictionary. See also: [`as_json`][griffe.Object.as_json]. Parameters: full: Whether to re
packages/griffelib/src/griffe/_internal/models.py:1240
Methodas_dict
Return this module's data as a dictionary. See also: [`as_json`][griffe.Module.as_json]. Parameters: **kwargs: Additiona
packages/griffelib/src/griffe/_internal/models.py:2337
Methodas_dict
Return this class' data as a dictionary. See also: [`as_json`][griffe.Class.as_json]. Parameters: **kwargs: Additional s
packages/griffelib/src/griffe/_internal/models.py:2470
Methodas_dict
Return this function's data as a dictionary. See also: [`as_json`][griffe.Function.as_json]. Parameters: **kwargs: Addit
packages/griffelib/src/griffe/_internal/models.py:2565
Methodas_dict
Return this attribute's data as a dictionary. See also: [`as_json`][griffe.Attribute.as_json]. Parameters: **kwargs: Add
packages/griffelib/src/griffe/_internal/models.py:2687
Methodas_dict
Return this type alias's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/models.py:2728
Methodas_dict
Return this object's data as a dictionary. Parameters: full: Whether to return full info, or just base info. **kwargs
packages/griffelib/src/griffe/_internal/diff.py:103
Methodas_dict
Return this element's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/docstrings/models.py:73
Methodas_dict
Return this section's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/docstrings/models.py:246
Methodas_json
Return this object's data as a JSON string. Parameters: full: Whether to return full info, or just base info. **kwarg
packages/griffelib/src/griffe/_internal/mixins.py:215
Functionast_first_child
Return the first child of this node. Parameters: node: The AST node. Raises: LastNodeError: When the node does not have chil
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:137
Functionast_last_child
Return the lasts child of this node. Parameters: node: The AST node. Raises: LastNodeError: When the node does not have chil
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:155
Functionast_previous
Return the previous sibling of this node. Parameters: node: The AST node. Raises: LastNodeError: When the node does not have
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:100
Functionast_siblings
Return the siblings of this node. Parameters: node: The AST node. Yields: The siblings.
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:82
Methodattributes
The attribute members. This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/mixins.py:295
Methodbases
The class bases. See also: [`Class`][griffe.Class], [`resolved_bases`][griffe.Alias.resolved_bases], [`mro`][griffe.Alias.mro
packages/griffelib/src/griffe/_internal/models.py:1910
Methodbound
The type parameter bound.
packages/griffelib/src/griffe/_internal/models.py:434
Methodbound
The bound of this type parameter.
packages/griffelib/src/griffe/_internal/docstrings/models.py:169
Functionbuild
Build source and wheel distributions. ```bash make build ``` Build distributions of your project for the current version. Distri
duties.py:359
Methodcallable_path
The path of the callable used as decorator.
packages/griffelib/src/griffe/_internal/models.py:53
Methodcanonical_name
Name of the expressed name/attribute/parameter.
packages/griffelib/src/griffe/_internal/expressions.py:229
Methodcanonical_path
Path of the expressed name/attribute.
packages/griffelib/src/griffe/_internal/expressions.py:224
Methodcanonical_path
The canonical path of this attribute.
packages/griffelib/src/griffe/_internal/expressions.py:318
Methodcanonical_path
The canonical path of this subscript's left part.
packages/griffelib/src/griffe/_internal/expressions.py:373
Methodcanonical_path
Path of the expressed keyword.
packages/griffelib/src/griffe/_internal/expressions.py:607
Methodcanonical_path
The canonical name (resolved one, not alias name).
packages/griffelib/src/griffe/_internal/expressions.py:754
Methodcanonical_path
The canonical path of this subscript's left part.
packages/griffelib/src/griffe/_internal/expressions.py:926
Methodcanonical_path
The full dotted path of this object. The canonical path is the path where the object was defined (not imported). See also: [`path`][
packages/griffelib/src/griffe/_internal/models.py:1125
Methodcanonical_path
The full dotted path of this object. The canonical path is the path where the object was defined (not imported). See also: [`path`][
packages/griffelib/src/griffe/_internal/models.py:1847
Functionchangelog
Update the changelog in-place with latest commits. ```bash make changelog [bump=VERSION] ``` Update the changelog in-place. The chan
duties.py:48
Functioncheck
Check it all! ```bash make check ``` Composite command to run all the check commands: - [`check-quality`][], to check the code
duties.py:91
Functioncheck_api
Check for API breaking changes. ```bash make check-api ``` Compare the current code to the latest version (Git tag) using [Griff
duties.py:260
Functioncheck_docs
Check if the documentation builds correctly. ```bash make check-docs ``` Build the docs with [MkDocs](https://www.mkdocs.org/) in st
duties.py:176
Functioncheck_quality
Check the code quality. ```bash make check-quality ``` Check the code quality using [Ruff](https://astral.sh/ruff). The configu
duties.py:108
Functioncheck_types
Check that the code is correctly typed. ```bash make check-types ``` Run type-checking on the code with [ty](https://astral.sh/ty/).
duties.py:203
Methodchildren
The children of this node.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:175
Methodclasses
The class members. This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/mixins.py:277
Methodclassname
The expression class name.
packages/griffelib/src/griffe/_internal/expressions.py:214
Methodconstraints
The type parameter constraints.
packages/griffelib/src/griffe/_internal/models.py:445
Methodconstraints
The constraints of this type parameter.
packages/griffelib/src/griffe/_internal/docstrings/models.py:180
Methodcontents
The contents of this admonition.
packages/griffelib/src/griffe/_internal/docstrings/models.py:101
Functioncoverage
Report coverage as text and HTML. ```bash make coverage ``` Combine coverage data from multiple test runs with [Coverage.py](https:/
duties.py:428
Methoddecorators
The class/function decorators. See also: [`Function`][griffe.Function], [`Class`][griffe.Class].
packages/griffelib/src/griffe/_internal/models.py:1925
Methoddefault
Return a serializable representation of the given object. Parameters: obj: The object to serialize. Returns:
packages/griffelib/src/griffe/_internal/encoders.py:77
Methoddefault
The default value of this parameter.
packages/griffelib/src/griffe/_internal/docstrings/models.py:147
Methoddefault
The default value of this type parameter.
packages/griffelib/src/griffe/_internal/docstrings/models.py:160
Methoddeleter
The deleter linked to this function (property).
packages/griffelib/src/griffe/_internal/models.py:2017
Methoddisable
Temporarily disable logging.
packages/griffelib/src/griffe/_internal/logger.py:33
Functiondocs
Serve the documentation (localhost:8000). ```bash make docs ``` This task uses [MkDocs](https://www.mkdocs.org/) to serve the docume
duties.py:305
Functiondocs_deploy
Deploy the documentation to GitHub pages. ```bash make docs-deploy ``` Use [MkDocs](https://www.mkdocs.org/) to build and deploy the
duties.py:327
Methoddocstring
The target docstring. See also: [`has_docstring`][griffe.Alias.has_docstring], [`has_docstrings`][griffe.Alias.has_docstrings].
packages/griffelib/src/griffe/_internal/models.py:1613
Functiondump
Load packages data and dump it as JSON. Parameters: packages: The packages to load and dump. output: Where to output the JSON-ser
packages/griffecli/src/griffecli/_internal/cli.py:332
Methodendlineno
The ending line number of the target object. See also: [`lineno`][griffe.Alias.lineno].
packages/griffelib/src/griffe/_internal/models.py:1601
Methodexhausted
True if all elements of the lists are exhausted.
packages/griffelib/src/griffe/_internal/c3linear.py:78
Methodexports
The names of the objects exported by this (module) object through the `__all__` variable. Exports can contain string (object names) or resolv
packages/griffelib/src/griffe/_internal/models.py:1654
Methodextra
Namespaced dictionaries storing extra metadata for this object, used by extensions.
packages/griffelib/src/griffe/_internal/models.py:1584
Methodfilepath
The file path (or directory list for namespace packages) where this object was defined. See also: [`relative_filepath`][griffe.Object.relativ
packages/griffelib/src/griffe/_internal/models.py:1027
Methodfilepath
The file path (or directory list for namespace packages) where this object was defined. See also: [`relative_filepath`][griffe.Alias.relative
packages/griffelib/src/griffe/_internal/models.py:1812
Methodfilepath
The file path of this module. Raises: BuiltinModuleError: When the instance filepath is None.
packages/griffelib/src/griffe/_internal/models.py:2260
Methodfilter_members
Filter and return members based on predicates. See also: [`members`][griffe.Object.members]. Parameters: *predicates: A
packages/griffelib/src/griffe/_internal/models.py:967
Methodfilter_members
Filter and return members based on predicates. See also: [`members`][griffe.Alias.members], [`get_member`][griffe.Alias.get_member],
packages/griffelib/src/griffe/_internal/models.py:1777
Methodfinal_target
The final, resolved target, if possible. This will iterate through the targets until a non-alias object is found. See also: [`target
packages/griffelib/src/griffe/_internal/models.py:2093
Methodfinder
The module source finder.
packages/griffelib/src/griffe/_internal/loader.py:101
Methodfirst
The first part of this attribute (on the left).
packages/griffelib/src/griffe/_internal/expressions.py:308
Functionfixture_stdlib_loader
Yield a GriffeLoader instance. During teardown, resolve aliases and access inherited members to make sure that no exception is raised when co
packages/griffelib/tests/test_stdlib.py:32
Functionformat
Run formatting tools on the code. ```bash make format ``` Format the code with [Ruff](https://astral.sh/ruff). This command will
duties.py:341
Methodfunctions
The function members. This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/mixins.py:286
Functionfuzz
Fuzz Griffe against generated Python code. Parameters: ctx: The context instance (passed automatically). size: The size of the ca
duties.py:477
← previousnext →501–600 of 1,229, ranked by callers