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
↓ 3 callers
Function
get_expression
Build an expression from an AST. Parameters: node: The annotation node. parent: The parent used to resolve the name. memb
packages/griffelib/src/griffe/_internal/expressions.py:1424
↓ 3 callers
Function
get_name
Extract name from an assignment node. Parameters: node: The node to extract names from. Returns: A list of names.
packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py:26
↓ 3 callers
Function
get_names
Extract names from an assignment node. Parameters: node: The node to extract names from. Returns: A list of names.
packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py:54
↓ 3 callers
Function
module_vtree
Link objects together, vertically. Parameters: path: The complete module path, like `"a.b.c.d"`. leaf_package: Whether the deepes
packages/griffelib/src/griffe/_internal/helpers.py:403
↓ 3 callers
Function
parser
Wrap a parser to help testing. Parameters: parser_module: The parser module containing a `parse` function. Yields: The wrapp
packages/griffelib/tests/test_docstrings/helpers.py:35
↓ 3 callers
Method
resolve_target
Resolve the target. See also: [`target`][griffe.Alias.target], [`final_target`][griffe.Alias.final_target], [`resolved`][grif
packages/griffelib/src/griffe/_internal/models.py:2118
↓ 3 callers
Function
temporary_pyfile
Create a Python file containing the given code in a temporary directory. Parameters: code: The code to write to the temporary file.
packages/griffelib/src/griffe/_internal/helpers.py:54
↓ 3 callers
Function
visit
Parse and visit a module file. We provide this function for static analysis. It uses a [`NodeVisitor`][ast.NodeVisitor]-like class, the [`Vis
packages/griffelib/src/griffe/_internal/agents/visitor.py:80
↓ 2 callers
Method
_contents
(self, path: Path)
packages/griffelib/src/griffe/_internal/finder.py:376
↓ 2 callers
Method
_create_module
(self, module_name: str, module_path: Path | list[Path])
packages/griffelib/src/griffe/_internal/loader.py:653
↓ 2 callers
Function
_dataclass_parameters
(class_: Class)
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:66
↓ 2 callers
Function
_error_details
(error: BaseException, objpath: str)
packages/griffelib/src/griffe/_internal/importer.py:17
↓ 2 callers
Function
_expr_args
(expr: Expr)
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:32
↓ 2 callers
Function
_expr_as_dict
(expression: Expr, **kwargs: Any)
packages/griffelib/src/griffe/_internal/expressions.py:143
↓ 2 callers
Method
_format_kind
(self, *, colors: bool = True)
packages/griffelib/src/griffe/_internal/diff.py:196
↓ 2 callers
Method
_format_location
(self, *, colors: bool = True)
packages/griffelib/src/griffe/_internal/diff.py:188
↓ 2 callers
Method
_get
(cls, name: str = "griffe")
packages/griffelib/src/griffe/_internal/logger.py:43
↓ 2 callers
Function
_get_deps
(base_deps: dict[str, Requirement], metadata: Metadata)
scripts/gen_credits.py:88
↓ 2 callers
Function
_get_modulelevel_internal_objects
(internal_api: griffe.Module)
packages/griffelib/tests/test_api.py:100
↓ 2 callers
Function
_get_or_set_attrs
(cls: Class)
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:65
↓ 2 callers
Function
_get_public_objects
(public_api: griffe.Module)
packages/griffelib/tests/test_api.py:104
↓ 2 callers
Function
_get_reexported_names
(module: ModuleType)
packages/griffelib/tests/test_api.py:53
↓ 2 callers
Function
_get_repo_root
Deprecated. Get the root of a Git repository. Parameters: repo: The path to a Git repository. Returns: The root of the repos
packages/griffelib/src/griffe/_internal/git.py:87
↓ 2 callers
Function
_load_decorators
(obj_dict: dict)
packages/griffelib/src/griffe/_internal/encoders.py:98
↓ 2 callers
Function
_load_extension
Load a configured extension. Parameters: extension: An extension, with potential configuration options. Raises: ExtensionNot
packages/griffelib/src/griffe/_internal/extensions/base.py:495
↓ 2 callers
Function
_merge_annotations
(annotations: Sequence[Expr])
packages/griffelib/src/griffe/_internal/merger.py:77
↓ 2 callers
Function
_merge_module_stubs
(module: Module, stubs: Module)
packages/griffelib/src/griffe/_internal/merger.py:18
↓ 2 callers
Function
_merge_stubs_members
(obj: Module | Class, stubs: Module | Class)
packages/griffelib/src/griffe/_internal/merger.py:110
↓ 2 callers
Function
_merge_stubs_overloads
(obj: Module | Class, stubs: Module | Class)
packages/griffelib/src/griffe/_internal/merger.py:62
↓ 2 callers
Method
_module_name_path
(self, path: Path)
packages/griffelib/src/griffe/_internal/finder.py:361
↓ 2 callers
Function
_params_from_attrs
(required: Iterable[_TypedDictAttr], optional: Iterable[_TypedDictAttr])
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:170
↓ 2 callers
Method
_post_load
(self, module: Module, obj_path: str)
packages/griffelib/src/griffe/_internal/loader.py:216
↓ 2 callers
Function
_print_data
(data: str, output_file: str | IO | None)
packages/griffecli/src/griffecli/_internal/cli.py:54
↓ 2 callers
Function
_read_parameters
( docstring: Docstring, *, offset: int, warn_unknown_params: bool = True, warn_missing_typ
packages/griffelib/src/griffe/_internal/docstrings/google.py:187
↓ 2 callers
Function
_read_parameters
( docstring: Docstring, *, offset: int, warn_unknown_params: bool = True, warn_missing_typ
packages/griffelib/src/griffe/_internal/docstrings/numpy.py:223
↓ 2 callers
Function
_requirements
(deps: Iterable[str])
scripts/gen_credits.py:49
↓ 2 callers
Method
_to_binop
(elements: Sequence[Expr], op: str)
packages/griffelib/src/griffe/_internal/expressions.py:255
↓ 2 callers
Method
_top_module_name
(self, path: Path)
packages/griffelib/src/griffe/_internal/finder.py:401
↓ 2 callers
Function
_type_based_yield
( old_member: Object | Alias, new_member: Object | Alias, *, seen_paths: set[str], )
packages/griffelib/src/griffe/_internal/diff.py:621
↓ 2 callers
Function
_update_docstring
( func: Function, required: Iterable[_TypedDictAttr], optional: Iterable[_TypedDictAttr], kwpa
packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py:109
↓ 2 callers
Method
_update_target_aliases
(self)
packages/griffelib/src/griffe/_internal/models.py:2167
↓ 2 callers
Function
_uv_install
(venv: Path)
scripts/make.py:43
↓ 2 callers
Function
_yield_public_objects
( obj: griffe.Module | griffe.Class, *, modules: bool = False, modulelevel: bool = True, i
packages/griffelib/tests/test_api.py:63
↓ 2 callers
Function
add_common_options
(subparser: argparse.ArgumentParser)
packages/griffecli/src/griffecli/_internal/cli.py:151
↓ 2 callers
Function
add_subparser
(command: str, text: str, **kwargs: Any)
packages/griffecli/src/griffecli/_internal/cli.py:222
↓ 2 callers
Method
append_search_path
Append a search path. The path will be resolved (absolute, normalized). The path won't be appended if it is already in the search pat
packages/griffelib/src/griffe/_internal/finder.py:119
↓ 2 callers
Method
as_dict
Return this element's data as a dictionary. Parameters: **kwargs: Additional serialization options. Returns:
packages/griffelib/src/griffe/_internal/docstrings/models.py:33
↓ 2 callers
Function
ast_kind
Return the kind of an AST node. Parameters: node: The AST node. Returns: The node kind.
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:14
↓ 2 callers
Function
ast_next
Return the next sibling of this node. Parameters: node: The AST node. Raises: LastNodeError: When the node does not have nex
packages/griffelib/src/griffe/_internal/agents/nodes/ast.py:119
↓ 2 callers
Function
clear_sys_modules
Clear `sys.modules` of a module and its submodules. Use this function after having used `temporary_pypackage` and `inspect` together. Better
packages/griffelib/tests/helpers.py:12
↓ 2 callers
Method
decorators_to_labels
Build and return a set of labels based on decorators. Parameters: decorators: The decorators to check. Returns:
packages/griffelib/src/griffe/_internal/agents/visitor.py:353
↓ 2 callers
Method
expand_exports
Expand exports: try to recursively expand all module exports (`__all__` values). See also: [`Module.exports`][griffe.Module.exports].
packages/griffelib/src/griffe/_internal/loader.py:293
↓ 2 callers
Method
generic_inspect
Extend the base generic inspection with extensions. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:262
↓ 2 callers
Function
get_parameters
(node: ast.arguments)
packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py:18
↓ 2 callers
Function
get_value
Get the string representation of a node. Parameters: node: The node to represent. Returns: The representing code for the nod
packages/griffelib/src/griffe/_internal/agents/nodes/values.py:15
↓ 2 callers
Method
handle_attribute
Handle an attribute (assignment) node. Parameters: node: The node to visit. annotation: A potential annotation.
packages/griffelib/src/griffe/_internal/agents/visitor.py:613
↓ 2 callers
Method
handle_function
Handle a function definition node. Parameters: node: The node to visit. labels: Labels to add to the data object.
packages/griffelib/src/griffe/_internal/agents/visitor.py:395
↓ 2 callers
Method
inspect
Extend the base inspection with extensions. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:254
↓ 2 callers
Method
iter_submodules
Iterate on a module's submodules, if any. Parameters: path: The module path. seen: If not none, this set is used to s
packages/griffelib/src/griffe/_internal/finder.py:278
↓ 2 callers
Function
load_pypi
Load and return a module from a specific package version downloaded using pip. Parameters: package: The package import name. dist
packages/griffelib/src/griffe/_internal/loader.py:937
↓ 2 callers
Function
main
Run the main program. This function is executed when you type `griffe` or `python -m griffe`. Parameters: args: Arguments passed fro
packages/griffecli/src/griffecli/_internal/cli.py:590
↓ 2 callers
Function
merge_stubs
Merge stubs into a module. Parameters: mod1: A regular module or stubs module. mod2: A regular module or stubs module. Raise
packages/griffelib/src/griffe/_internal/merger.py:154
↓ 2 callers
Function
parse
Parse the docstring. Parameters: docstring: The docstring to parse. parser: The docstring parser to use. If None, return a single
packages/griffelib/src/griffe/_internal/docstrings/parsers.py:35
↓ 2 callers
Function
relative_to_absolute
Convert a relative import path to an absolute one. Parameters: node: The "from ... import ..." AST node. name: The imported name.
packages/griffelib/src/griffe/_internal/agents/nodes/imports.py:13
↓ 2 callers
Function
run3x
Run a command in the virtual environment for Python 3.x. ```bash make 3.x <CMD> [ARG...] ``` This command runs an arbitrary command
scripts/make.py:226
↓ 2 callers
Function
safe_get__all__
Safely (no exception) extract values in `__all__`. Parameters: node: The `__all__` assignment node. parent: The parent used to re
packages/griffelib/src/griffe/_internal/agents/nodes/exports.py:80
↓ 2 callers
Method
signature
Construct the function signature. Parameters: return_type: Whether to include the return type in the signature. name:
packages/griffelib/src/griffe/_internal/models.py:2582
↓ 2 callers
Method
stats
Compute some statistics. Returns: Some statistics.
packages/griffelib/src/griffe/_internal/loader.py:528
↓ 2 callers
Method
submodules
Return the list of a module's submodules. Parameters: module: The parent module. Returns: A list of tuples c
packages/griffelib/src/griffe/_internal/finder.py:344
↓ 2 callers
Function
sys_path
Redefine `sys.path` temporarily. Parameters: *paths: The paths to use when importing modules. If no paths are given, keep `sy
packages/griffelib/src/griffe/_internal/importer.py:22
↓ 2 callers
Method
visit
Extend the base visit with extensions. Parameters: node: The node to visit.
packages/griffelib/src/griffe/_internal/agents/visitor.py:260
↓ 1 callers
Method
__init__
Initialize the exception. Parameters: chain: The cyclic chain of items (such as target path).
packages/griffelib/src/griffe/_internal/exceptions.py:56
↓ 1 callers
Method
__init__
(self, *args: Any, **kwargs: Any)
packages/griffelib/tests/test_extensions/test_base.py:230
↓ 1 callers
Method
__len__
(self)
packages/griffelib/src/griffe/_internal/c3linear.py:60
↓ 1 callers
Function
_access_inherited_members
(obj: Object | Alias)
packages/griffelib/tests/test_stdlib.py:19
↓ 1 callers
Function
_alias_incompatibilities
( old_obj: Object | Alias, new_obj: Object | Alias, *, seen_paths: set[str], )
packages/griffelib/src/griffe/_internal/diff.py:584
↓ 1 callers
Method
_append_search_path
(self, path: Path)
packages/griffelib/src/griffe/_internal/finder.py:130
↓ 1 callers
Function
_apply_recursively
(mod_cls: Module | Class, processed: set[str])
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:203
↓ 1 callers
Function
_assert_git_repo
Deprecated. Assert that a directory is a Git repository. Parameters: path: Path to a directory. Raises: OSError: When the di
packages/griffelib/src/griffe/_internal/git.py:50
↓ 1 callers
Function
_attribute_incompatibilities
(old_attribute: Attribute, new_attribute: Attribute)
packages/griffelib/src/griffe/_internal/diff.py:575
↓ 1 callers
Function
_class_incompatibilities
( old_class: Class, new_class: Class, *, seen_paths: set[str], )
packages/griffelib/src/griffe/_internal/diff.py:487
↓ 1 callers
Function
_consolidate_continuation_lines
(lines: list[str], offset: int)
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:457
↓ 1 callers
Function
_convert_parameter
( parameter: SignatureParameter, *, parent: Module | Class, member: str | None = None, )
packages/griffelib/src/griffe/_internal/agents/inspector.py:601
↓ 1 callers
Function
_copy_contents
Copy *contents* of src into dst. Parameters: src: the folder whose contents will be copied to dst dst: the destination folder
packages/griffelib/tests/test_git.py:24
↓ 1 callers
Function
_dataclass_arguments
(decorators: list[Decorator])
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:49
↓ 1 callers
Function
_del_members_annotated_as_initvar
(class_: Class)
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:195
↓ 1 callers
Function
_determine_param_annotation
( docstring: Docstring, name: str, directive_type: str | Expr | None, parsed_values: _ParsedVa
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:209
↓ 1 callers
Function
_determine_param_default
(docstring: Docstring, name: str)
packages/griffelib/src/griffe/_internal/docstrings/sphinx.py:202
↓ 1 callers
Method
_expand_wildcard
(self, wildcard_obj: Alias)
packages/griffelib/src/griffe/_internal/loader.py:738
↓ 1 callers
Method
_extend_from_pth_files
(self)
packages/griffelib/src/griffe/_internal/finder.py:384
↓ 1 callers
Function
_extra_marker
(req: Requirement)
scripts/gen_credits.py:53
↓ 1 callers
Function
_field_arguments
(attribute: Attribute)
packages/griffelib/src/griffe/_internal/extensions/dataclasses.py:55
↓ 1 callers
Function
_field_as_dict
( element: str | bool | Expr | list[str | Expr] | None, # noqa: FBT001 **kwargs: Any, )
packages/griffelib/src/griffe/_internal/expressions.py:132
↓ 1 callers
Method
_filter_py_modules
(self, path: Path)
packages/griffelib/src/griffe/_internal/finder.py:393
↓ 1 callers
Method
_fire_load_events
(self, obj: Object)
packages/griffelib/src/griffe/_internal/loader.py:197
↓ 1 callers
Function
_function_incompatibilities
(old_function: Function, new_function: Function)
packages/griffelib/src/griffe/_internal/diff.py:500
↓ 1 callers
Function
_get_changelog_version
()
duties.py:41
↓ 1 callers
Function
_get_debug_info
Get debug/environment information. Returns: Environment information.
packages/griffelib/src/griffe/_internal/debug.py:80
↓ 1 callers
Function
_get_git_commit_hash
(repo: str | Path = ".")
packages/griffelib/src/griffe/_internal/git.py:217
↓ 1 callers
Function
_get_git_known_service
(git_remote_url: str)
packages/griffelib/src/griffe/_internal/git.py:163
← previous
next →
101–200 of 1,229, ranked by callers