MCPcopy Create free account

hub / github.com/mkdocstrings/griffe / functions

Functions1,229 in github.com/mkdocstrings/griffe

Methodgeneric_inspect
Extend the base generic inspection with extensions. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/extensions/base.py:56
Methodgeneric_visit
Visit children nodes. Parameters: node: The node to visit the children of.
packages/griffelib/src/griffe/_internal/extensions/base.py:39
Functionget_logger
Create and return a new logger instance. Parameters: name: The logger name. Returns: The logger.
packages/griffelib/src/griffe/_internal/logger.py:93
Methodgit_info
Git information for this object, if available.
packages/griffelib/src/griffe/_internal/models.py:726
Methodgit_info
Get the Git information for this object, if available.
packages/griffelib/src/griffe/_internal/models.py:1564
Functiongit_repo
Fixture that creates a git repo with multiple tagged versions. For each directory in `tests/test_git/_repo/` - the contents of the direc
packages/griffelib/tests/test_git.py:41
Methodhas_docstring
Whether this object has a docstring (empty or not). See also: [`docstring`][griffe.Object.docstring], [`has_docstrings`][griffe.Objec
packages/griffelib/src/griffe/_internal/models.py:757
Methodhas_docstring
Whether this alias' target has a non-empty docstring. See also: [`has_docstrings`][griffe.Alias.has_docstrings], [`docstring`][griffe
packages/griffelib/src/griffe/_internal/models.py:1451
Methodhas_docstrings
Whether this object or any of its members has a docstring (empty or not). Inherited members are not considered. Imported members are not cons
packages/griffelib/src/griffe/_internal/models.py:774
Methodhas_docstrings
Whether this alias' target or any of its members has a non-empty docstring. See also: [`has_docstring`][griffe.Alias.has_docstring],
packages/griffelib/src/griffe/_internal/models.py:1463
Methodhas_labels
Tell if this object has all the given labels. See also: [`labels`][griffe.Object.labels]. Parameters: *labels: Labels th
packages/griffelib/src/griffe/_internal/models.py:954
Methodhead
Head of the dependency.
packages/griffelib/src/griffe/_internal/c3linear.py:21
Methodheads
Return the heads.
packages/griffelib/src/griffe/_internal/c3linear.py:68
Functionhtree
Link objects together, horizontally. Parameters: *objects: A sequence of objects. All objects starting at the second become members of th
packages/griffelib/src/griffe/_internal/helpers.py:383
Methodimports
The other objects imported by this alias' target. Keys are the names within the object (`from ... import ... as AS_NAME`), while the
packages/griffelib/src/griffe/_internal/models.py:1643
Methodimports_future_annotations
Whether this module import future annotations.
packages/griffelib/src/griffe/_internal/models.py:1934
Methodimports_future_annotations
Whether this module import future annotations.
packages/griffelib/src/griffe/_internal/models.py:2271
Methodinherited_members
Members that are inherited from base classes. This method is part of the consumer API: do not use when producing Griffe trees!
packages/griffelib/src/griffe/_internal/models.py:821
Methodinherited_members
Members that are inherited from base classes. Each inherited member of the target will be wrapped in an alias, to preserve correct ob
packages/griffelib/src/griffe/_internal/models.py:1519
Methodinspect_attribute
Inspect an attribute. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:535
Methodinspect_builtin_function
Inspect a builtin function. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:404
Methodinspect_builtin_method
Inspect a builtin method. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:380
Methodinspect_cached_property
Inspect a cached property. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:420
Methodinspect_class
Inspect a class. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:322
Methodinspect_classmethod
Inspect a class method. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:364
Methodinspect_coroutine
Inspect a coroutine. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:396
Methodinspect_function
Inspect a function. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:412
Methodinspect_getset_descriptor
Inspect a get/set descriptor. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:436
Methodinspect_method
Inspect a method. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:388
Methodinspect_method_descriptor
Inspect a method descriptor. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:372
Methodinspect_property
Inspect a property. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:428
Methodinspect_staticmethod
Inspect a static method. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:356
Methodinspect_type_alias
Inspect a type alias. Parameters: node: The node to inspect.
packages/griffelib/src/griffe/_internal/agents/inspector.py:510
Methodis_attribute
Whether this object is an attribute. See also: [`is_module`][griffe.Object.is_module]. [`is_class`][griffe.Object.is_class],
packages/griffelib/src/griffe/_internal/models.py:884
Methodis_attribute
Whether this object is an attribute. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`
packages/griffelib/src/griffe/_internal/models.py:1739
Methodis_attribute
Whether this node's object is an attribute.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:275
Methodis_builtin_function
Whether this node's object is a builtin function.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:208
Methodis_builtin_method
Whether this node's object is a builtin method.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:248
Methodis_class
Whether this object is a class. See also: [`is_module`][griffe.Object.is_module]. [`is_function`][griffe.Object.is_function],
packages/griffelib/src/griffe/_internal/models.py:858
Methodis_class
Whether this object is a class. See also: [`is_module`][griffe.Alias.is_module], [`is_function`][griffe.Alias.is_function], [
packages/griffelib/src/griffe/_internal/models.py:1713
Methodis_class
Whether this node's object is a class.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:189
Methodis_class_private
Whether this object/alias is class-private (starts with `__` and is a class member).
packages/griffelib/src/griffe/_internal/mixins.py:323
Methodis_classmethod
Whether this node's object is a classmethod.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:264
Methodis_classvar
Whether this attribute is annotated with `ClassVar`.
packages/griffelib/src/griffe/_internal/expressions.py:235
Methodis_coroutine
Whether this node's object is a coroutine.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:213
Methodis_deprecated
Whether this object is deprecated.
packages/griffelib/src/griffe/_internal/mixins.py:421
Methodis_enum_class
Whether this name resolves to an enumeration class.
packages/griffelib/src/griffe/_internal/expressions.py:777
Methodis_enum_instance
Whether this name resolves to an enumeration instance.
packages/griffelib/src/griffe/_internal/expressions.py:789
Methodis_enum_value
Whether this name resolves to an enumeration value.
packages/griffelib/src/griffe/_internal/expressions.py:797
Methodis_exported
Whether this object/alias is exported (listed in `__all__`).
packages/griffelib/src/griffe/_internal/mixins.py:335
Methodis_function
Whether this object is a function. See also: [`is_module`][griffe.Object.is_module]. [`is_class`][griffe.Object.is_class], [
packages/griffelib/src/griffe/_internal/models.py:871
Methodis_function
Whether this object is a function. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`is
packages/griffelib/src/griffe/_internal/models.py:1726
Methodis_function
Whether this node's object is a function.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:194
Methodis_generator
Whether this expression is a generator.
packages/griffelib/src/griffe/_internal/expressions.py:250
Methodis_generic
Whether this object is generic.
packages/griffelib/src/griffe/_internal/mixins.py:427
Methodis_getset_descriptor
Whether this node's object is a get/set descriptor.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:218
Methodis_imported
Whether this object/alias was imported from another module.
packages/griffelib/src/griffe/_internal/mixins.py:330
Methodis_init_method
Whether this function is an `__init__` method.
packages/griffelib/src/griffe/_internal/models.py:910
Methodis_init_method
Whether this method is an `__init__` method.
packages/griffelib/src/griffe/_internal/models.py:1939
Methodis_init_method
Whether this function is an `__init__` method.
packages/griffelib/src/griffe/_internal/models.py:2561
Methodis_init_module
Whether this object is an `__init__.py` module. See also: [`is_module`][griffe.Object.is_module].
packages/griffelib/src/griffe/_internal/models.py:915
Methodis_init_module
Whether this module is an `__init__.py` module. See also: [`is_module`][griffe.Alias.is_module].
packages/griffelib/src/griffe/_internal/models.py:1944
Methodis_init_module
Whether this module is an `__init__.py` module. See also: [`is_module`][griffe.Module.is_module].
packages/griffelib/src/griffe/_internal/models.py:2280
Methodis_iterator
Whether this expression is an iterator.
packages/griffelib/src/griffe/_internal/expressions.py:245
Methodis_kind
Tell if this object is of the given kind. See also: [`is_module`][griffe.Object.is_module], [`is_class`][griffe.Object.is_class],
packages/griffelib/src/griffe/_internal/models.py:793
Methodis_kind
Tell if this object is of the given kind. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class],
packages/griffelib/src/griffe/_internal/models.py:1677
Methodis_method
Whether this node's object is a method.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:233
Methodis_method_descriptor
Whether this node's object is a method descriptor. Built-in methods (e.g. those implemented in C/Rust) are often method descriptors,
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:239
Methodis_module
Whether this object is a module. See also: [`is_init_module`][griffe.Object.is_init_module]. [`is_class`][griffe.Object.is_class],
packages/griffelib/src/griffe/_internal/models.py:844
Methodis_module
Whether this object is a module. See also: [`is_init_module`][griffe.Alias.is_init_module]. [`is_class`][griffe.Alias.is_class],
packages/griffelib/src/griffe/_internal/models.py:1699
Methodis_module
Whether this node's object is a module.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:184
Methodis_namespace_package
Whether this object is a namespace package (top folder, no `__init__.py`). See also: [`is_namespace_subpackage`][griffe.Object.is_namespace_
packages/griffelib/src/griffe/_internal/models.py:939
Methodis_namespace_package
Whether this module is a namespace package (top folder, no `__init__.py`). See also: [`is_namespace_subpackage`][griffe.Alias.is_namespace_su
packages/griffelib/src/griffe/_internal/models.py:1968
Methodis_namespace_package
Whether this module is a namespace package (top folder, no `__init__.py`). See also: [`is_namespace_subpackage`][griffe.Module.is_namespace_s
packages/griffelib/src/griffe/_internal/models.py:2309
Methodis_namespace_subpackage
Whether this object is a namespace subpackage. See also: [`is_namespace_package`][griffe.Object.is_namespace_package].
packages/griffelib/src/griffe/_internal/models.py:947
Methodis_namespace_subpackage
Whether this module is a namespace subpackage. See also: [`is_namespace_package`][griffe.Alias.is_namespace_package].
packages/griffelib/src/griffe/_internal/models.py:1976
Methodis_namespace_subpackage
Whether this module is a namespace subpackage. See also: [`is_namespace_package`][griffe.Module.is_namespace_package].
packages/griffelib/src/griffe/_internal/models.py:2320
Methodis_package
Whether this object is a package (top module). See also: [`is_subpackage`][griffe.Object.is_subpackage].
packages/griffelib/src/griffe/_internal/models.py:923
Methodis_package
Whether this module is a package (top module). See also: [`is_subpackage`][griffe.Alias.is_subpackage].
packages/griffelib/src/griffe/_internal/models.py:1952
Methodis_package
Whether this module is a package (top module). See also: [`is_subpackage`][griffe.Module.is_subpackage].
packages/griffelib/src/griffe/_internal/models.py:2293
Methodis_private
Whether this object/alias is private (starts with `_`) but not special.
packages/griffelib/src/griffe/_internal/mixins.py:313
Methodis_property
Whether this node's object is a property.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:223
Methodis_public
Whether this object is considered public. In modules, developers can mark objects as public thanks to the `__all__` variable. In clas
packages/griffelib/src/griffe/_internal/mixins.py:376
Methodis_special
Whether this object/alias is special ("dunder" attribute/method, starts and end with `__`).
packages/griffelib/src/griffe/_internal/mixins.py:318
Methodis_staticmethod
Whether this node's object is a staticmethod.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:253
Methodis_subpackage
Whether this object is a subpackage. See also: [`is_package`][griffe.Object.is_package].
packages/griffelib/src/griffe/_internal/models.py:931
Methodis_subpackage
Whether this module is a subpackage. See also: [`is_package`][griffe.Alias.is_package].
packages/griffelib/src/griffe/_internal/models.py:1960
Methodis_subpackage
Whether this module is a subpackage. See also: [`is_package`][griffe.Module.is_package].
packages/griffelib/src/griffe/_internal/models.py:2301
Methodis_tuple
Whether this expression is a tuple.
packages/griffelib/src/griffe/_internal/expressions.py:240
Methodis_type_alias
Whether this object is a type alias. See also: [`is_module`][griffe.Object.is_module]. [`is_class`][griffe.Object.is_class],
packages/griffelib/src/griffe/_internal/models.py:897
Methodis_type_alias
Whether this object is a type alias. See also: [`is_module`][griffe.Alias.is_module], [`is_class`][griffe.Alias.is_class], [`
packages/griffelib/src/griffe/_internal/models.py:1752
Methodis_type_alias
Whether this node's object is a type alias.
packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py:200
Methodis_type_parameter
Whether this name resolves to a type parameter.
packages/griffelib/src/griffe/_internal/expressions.py:805
Methodis_wildcard_exposed
Whether this object/alias is exposed to wildcard imports. To be exposed to wildcard imports, an object/alias must: - be available at
packages/griffelib/src/griffe/_internal/mixins.py:344
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:278
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:334
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:354
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:377
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:395
Methoditerate
(self, *, flat: bool = True)
packages/griffelib/src/griffe/_internal/expressions.py:416
← previousnext →601–700 of 1,229, ranked by callers