MCPcopy Create free account

hub / github.com/mkdocstrings/griffe / functions

Functions1,229 in github.com/mkdocstrings/griffe

↓ 1 callersFunction_get_git_remote_url
(repo: str | Path = ".")
packages/griffelib/src/griffe/_internal/git.py:137
↓ 1 callersFunction_get_latest_tag
Deprecated. Get latest tag of a Git repository. Parameters: repo: The path to Git repository. Returns: The latest tag.
packages/griffelib/src/griffe/_internal/git.py:67
↓ 1 callersFunction_get_metadata
()
scripts/gen_credits.py:62
↓ 1 callersMethod_get_or_create_parent_module
( self, module: Module, subparts: tuple[str, ...], subpath: Path, )
packages/griffelib/src/griffe/_internal/loader.py:708
↓ 1 callersFunction_get_source_link
( service: KnownGitService, remote_url: str, commit_hash: str, filepath: str | Path, linen
packages/griffelib/src/griffe/_internal/git.py:204
↓ 1 callersFunction_get_version
Get version of the given distribution. Parameters: dist: A distribution name. Returns: A version number.
packages/griffelib/src/griffe/_internal/debug.py:65
↓ 1 callersFunction_interpreter_name_version
()
packages/griffelib/src/griffe/_internal/debug.py:54
↓ 1 callersFunction_is_pkg_style_namespace
(init_module: Path)
packages/griffelib/src/griffe/_internal/finder.py:425
↓ 1 callersFunction_is_tracked
(filepath: str | Path, repo: str | Path = ".")
packages/griffelib/src/griffe/_internal/git.py:223
↓ 1 callersMethod_itercount
(self, root: Object | Alias)
packages/griffelib/src/griffe/_internal/stats.py:74
↓ 1 callersFunction_load_expression
(expression: dict)
packages/griffelib/src/griffe/_internal/encoders.py:102
↓ 1 callersFunction_load_extension_path
(path: str)
packages/griffelib/src/griffe/_internal/extensions/base.py:484
↓ 1 callersMethod_load_module_path
( self, module_name: str, module_path: Path | list[Path], *, submodule
packages/griffelib/src/griffe/_internal/loader.py:573
↓ 1 callersMethod_load_package
(self, package: Package | NamespacePackage, *, submodules: bool = True)
packages/griffelib/src/griffe/_internal/loader.py:539
↓ 1 callersFunction_load_packages
( packages: Sequence[str], *, extensions: Extensions | None = None, search_paths: Sequence[str
packages/griffecli/src/griffecli/_internal/cli.py:64
↓ 1 callersFunction_load_parameter
(obj_dict: dict[str, Any])
packages/griffelib/src/griffe/_internal/encoders.py:122
↓ 1 callersMethod_load_submodule
(self, module: Module, subparts: tuple[str, ...], subpath: Path)
packages/griffelib/src/griffe/_internal/loader.py:602
↓ 1 callersMethod_load_submodules
(self, module: Module)
packages/griffelib/src/griffe/_internal/loader.py:598
↓ 1 callersFunction_load_type_parameter
(obj_dict: dict[str, Any])
packages/griffelib/src/griffe/_internal/encoders.py:132
↓ 1 callersFunction_merge_attribute_stubs
(attribute: Attribute, stubs: Attribute)
packages/griffelib/src/griffe/_internal/merger.py:40
↓ 1 callersFunction_merge_class_stubs
(class_: Class, stubs: Class)
packages/griffelib/src/griffe/_internal/merger.py:24
↓ 1 callersFunction_merge_fields
(metadata: dict)
scripts/gen_credits.py:35
↓ 1 callersFunction_merge_function_stubs
(function: Function, stubs: Function)
packages/griffelib/src/griffe/_internal/merger.py:31
↓ 1 callersFunction_merge_overload_annotations
(function: Function, overloads: list[Function])
packages/griffelib/src/griffe/_internal/merger.py:85
↓ 1 callersFunction_merge_type_alias_stubs
(type_alias: TypeAlias, stubs: TypeAlias)
packages/griffelib/src/griffe/_internal/merger.py:47
↓ 1 callersFunction_modules
(obj: griffe.Module)
packages/griffelib/tests/test_api.py:221
↓ 1 callersMethod_mro
(self, seen: tuple[str, ...] = ())
packages/griffelib/src/griffe/_internal/models.py:2451
↓ 1 callersFunction_normalize
(value: str)
packages/griffelib/src/griffe/_internal/git.py:30
↓ 1 callersFunction_parsed_values_to_sections
(parsed_values: _ParsedValues)
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:428
↓ 1 callersMethod_patch_loggers
(cls, get_logger_func: Callable)
packages/griffelib/src/griffe/_internal/logger.py:49
↓ 1 callersMethod_pick_member
(self, name: str, member: Any)
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:285
↓ 1 callersFunction_public_path
(obj: griffe.Object | griffe.Alias)
packages/griffelib/tests/test_api.py:150
↓ 1 callersFunction_read_block
(docstring: Docstring, *, offset: int, **options: Any)
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:161
↓ 1 callersFunction_render_api
(path: Path, root: Path, heading_level: int = 4)
scripts/gen_structure_docs.py:46
↓ 1 callersFunction_render_call_graph
(module: Path)
scripts/gen_structure_docs.py:21
↓ 1 callersFunction_render_credits
()
scripts/gen_credits.py:119
↓ 1 callersFunction_reorder_parameters
(parameters: list[Parameter])
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:139
↓ 1 callersMethod_resolve_target
(self)
packages/griffelib/src/griffe/_internal/models.py:2151
↓ 1 callersFunction_returns_are_compatible
(old_function: Function, new_function: Function)
packages/griffelib/src/griffe/_internal/diff.py:658
↓ 1 callersFunction_same_components
(a: str, b: str, /)
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:36
↓ 1 callersFunction_set_dataclass_init
(class_: Class)
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:157
↓ 1 callersFunction_set_license
(metadata: PackageMetadata)
scripts/gen_credits.py:74
↓ 1 callersFunction_strip_blank_lines
(lines: list[str])
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:474
↓ 1 callersFunction_tmp_worktree
Deprecated. Context manager that checks out the given reference in the given repository to a temporary worktree. Parameters: repo: Path t
packages/griffelib/src/griffe/_internal/git.py:104
↓ 1 callersFunction_unwrap_annotation
(annotation: str | Expr | None, *, default_required: bool)
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:29
↓ 1 callersMethod_visit_module
(self, module_name: str, module_path: Path, parent: Module | None = None)
packages/griffelib/src/griffe/_internal/loader.py:661
↓ 1 callersFunctionallrun
Run a command in all virtual environments. ```bash make multirun <CMD> [ARG...] ``` This command runs an arbitrary command inside th
scripts/make.py:202
↓ 1 callersMethodas_text
Format the statistics as text. Returns: Text stats.
packages/griffelib/src/griffe/_internal/stats.py:86
↓ 1 callersFunctionast_next_siblings
Return the next siblings of this node, starting from the closest. Parameters: node: The AST node. Yields: The next siblings.
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:66
↓ 1 callersFunctionast_previous_siblings
Return the previous siblings of this node, starting from the closest. Parameters: node: The AST node. Yields: The previous s
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:50
↓ 1 callersFunctionc3linear_merge
Merge lists of lists in the order defined by the C3Linear algorithm. Parameters: *lists: Lists of items. Returns: The merged
packages/griffelib/src/griffe/_internal/c3linear.py:93
↓ 1 callersFunctioncd
Change directory to `path` and restore the previous directory on exit.
packages/griffelib/tests/test_extensions/test_base.py:43
↓ 1 callersFunctioncheck
Check for API breaking changes in two versions of the same package. Parameters: package: The package to load and check. against:
packages/griffecli/src/griffecli/_internal/cli.py:431
↓ 1 callersFunctionclean
Delete build artifacts and cache files. ```bash make clean ``` This command simply deletes build artifacts and cache files and folde
scripts/make.py:241
↓ 1 callersMethodexplain
Explain the breakage by showing old and new value. Parameters: style: The explanation style to use. Returns:
packages/griffelib/src/griffe/_internal/diff.py:120
↓ 1 callersFunctionfails
(code: str, filepath: Path)
duties.py:498
↓ 1 callersMethodfrom_package
Create a GitInfo instance from a Griffe package. Returns: The GitInfo instance, or None if unknown.
packages/griffelib/src/griffe/_internal/git.py:241
↓ 1 callersFunctionget__all__
Get the values declared in `__all__`. Parameters: node: The assignment node. parent: The parent module. Returns: A s
packages/griffelib/src/griffe/_internal/agents/nodes/exports.py:65
↓ 1 callersMethodget_base_property
Check decorators to return the base property in case of setters and deleters. Parameters: decorators: The decorators to check.
packages/griffelib/src/griffe/_internal/agents/visitor.py:371
↓ 1 callersFunctionget_docstring
Extract a docstring. Parameters: node: The node to extract the docstring from. strict: Whether to skip searching the body (functi
packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py:8
↓ 1 callersFunctionget_instance_names
Extract names from an assignment node, only for instance attributes. Parameters: node: The node to extract names from. Returns:
packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py:66
↓ 1 callersMethodget_module
Build and return the object representing the module attached to this inspector. This method triggers a complete inspection of the module memb
packages/griffelib/src/griffe/_internal/agents/inspector.py:206
↓ 1 callersMethodget_module
Build and return the object representing the module attached to this visitor. This method triggers a complete visit of the module nodes.
packages/griffelib/src/griffe/_internal/agents/visitor.py:246
↓ 1 callersFunctionget_parser
Return the CLI argument parser. Returns: An argparse parser.
packages/griffecli/src/griffecli/_internal/cli.py:128
↓ 1 callersMethodget_source_link
Get the source link for the file at the given line numbers. Returns: The source link, or None if unknown.
packages/griffelib/src/griffe/_internal/git.py:265
↓ 1 callersFunctionget_version
()
scripts/get_version.py:20
↓ 1 callersMethodhandle_attribute
Handle an attribute. Parameters: node: The node to inspect. annotation: A potential annotation.
packages/griffelib/src/griffe/_internal/agents/inspector.py:543
↓ 1 callersFunctionhelp
Print this help. Add task name to print help. ```bash make help [TASK] ``` When the Python dependencies are not installed, this
scripts/make.py:84
↓ 1 callersFunctioninfer_docstring_style
Infer the parser to use for the docstring. The 'heuristics' method uses regular expressions. The 'max_sections' method parses the docstring w
packages/griffelib/src/griffe/_internal/docstrings/auto.py:116
↓ 1 callersMethodinsert_search_path
Insert a search path at the given position. The path will be resolved (absolute, normalized). The path won't be inserted if it is alr
packages/griffelib/src/griffe/_internal/finder.py:134
↓ 1 callersMethodinspect
Inspect a node. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/extensions/base.py:48
↓ 1 callersMethodinspect_module
Inspect a module. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:299
↓ 1 callersFunctionmain
Main entry point.
scripts/make.py:287
↓ 1 callersMethodmatches
Check if a line matches the field type. Parameters: line: Line to check against Returns: True if the line ma
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:52
↓ 1 callersMethodon_alias
Run on aliases 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:411
↓ 1 callersFunctionparse
Parse a docstring. Parameters: docstring: The docstring to parse. parent: The docstring's parent object.
packages/griffelib/tests/test_docstrings/helpers.py:46
↓ 1 callersMethodremove
Remove an item from the lists. Once an item removed from heads, the leftmost elements of the tails get promoted to become the new hea
packages/griffelib/src/griffe/_internal/c3linear.py:82
↓ 1 callersMethodresolve_module_aliases
Follow aliases: try to recursively resolve all found aliases. Parameters: obj: The object and its members to recurse on.
packages/griffelib/src/griffe/_internal/loader.py:450
↓ 1 callersFunctionsetup
Setup all virtual environments (install dependencies). ```bash make setup ``` The `setup` command installs all the Python dependenci
scripts/make.py:111
↓ 1 callersMethodsignature
Construct the class/function signature. Parameters: return_type: Whether to include the return type in the signature.
packages/griffelib/src/griffe/_internal/models.py:2052
↓ 1 callersMethodsignature
Construct the class signature. Parameters: return_type: Whether to include the return type in the signature. name: Th
packages/griffelib/src/griffe/_internal/models.py:2411
↓ 1 callersMethodversion
The version of this deprecation.
packages/griffelib/src/griffe/_internal/docstrings/models.py:114
↓ 1 callersMethodvisit
Visit a node. Parameters: node: The node to visit.
packages/griffelib/src/griffe/_internal/extensions/base.py:31
↓ 1 callersFunctionvscode
Configure VSCode to work on this project. ```bash make vscode ``` This command configures the [VSCode editor](https://code.visualstu
scripts/make.py:263
↓ 1 callersFunctionvtree
Link objects together, vertically. Parameters: *objects: A sequence of objects. The first one is at the top of the tree. return_l
packages/griffelib/src/griffe/_internal/helpers.py:360
↓ 1 callersFunctionwarn
(docstring: Docstring, offset: int, message: str, log_level: LogLevel = LogLevel.warning)
packages/griffelib/src/griffe/_internal/docstrings/utils.py:38
Method__bool__
An object is always true-ish.
packages/griffelib/src/griffe/_internal/models.py:717
Method__bool__
An alias is always true-ish.
packages/griffelib/src/griffe/_internal/models.py:1426
Method__bool__
A lines collection is always true-ish.
packages/griffelib/src/griffe/_internal/collections.py:36
Method__bool__
A modules collection is always true-ish.
packages/griffelib/src/griffe/_internal/collections.py:76
Method__bool__
Whether this section has a true-ish value.
packages/griffelib/src/griffe/_internal/docstrings/models.py:242
Method__call__
(self, *args: Any, **kwargs: Any)
packages/griffecli/src/griffecli/_internal/cli.py:47
Method__call__
(self, node: Any, parent: Module | Class, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:1366
Method__call__
( # noqa: D102 self, docstring: str, parent: ParentType | None = None, **pars
packages/griffelib/tests/test_docstrings/helpers.py:27
Method__contains__
Return True if any linearization's tail contains an item.
packages/griffelib/src/griffe/_internal/c3linear.py:56
Method__contains__
Whether a parameter with the given name is present.
packages/griffelib/src/griffe/_internal/models.py:362
Method__contains__
Whether a type parameter with the given name is present.
packages/griffelib/src/griffe/_internal/models.py:542
Method__contains__
Check if a file path is in the collection.
packages/griffelib/src/griffe/_internal/collections.py:32
Method__contains__
Check if a module is in the collection.
packages/griffelib/src/griffe/_internal/collections.py:80
Method__delitem__
Delete a parameter by index or name.
packages/griffelib/src/griffe/_internal/models.py:342
← previousnext →201–300 of 1,229, ranked by callers