griffe API reference

303 public APIs from griffe (mkdocstrings/griffe) — 90 classes, 42 functions, 171 methods. Signatures extracted by static analysis of the actual source.

Repository: mkdocstrings/griffe

Kind	Count
Classes	90
Functions	42
Methods	171

API list

funcduties.build(ctx:Context) -> None

Build source and wheel distributions.

funcduties.changelog(ctx:Context, bump:str='') -> None

Update the changelog in-place with latest commits.

funcduties.check(ctx:Context) -> None

Check it all!

funcduties.check_api(ctx:Context, *cli_args:str) -> None

Check for API breaking changes.

funcduties.check_docs(ctx:Context) -> None

Check if the documentation builds correctly.

funcduties.check_quality(ctx:Context) -> None

Check the code quality.

funcduties.check_types(ctx:Context) -> None

Check that the code is correctly typed.

funcduties.coverage(ctx:Context) -> None

Report coverage as text and HTML.

funcduties.docs(ctx:Context, *host:str='127.0.0.1', *port:int=8000, *cli_args:str) -> None

Serve the documentation (localhost:8000).

funcduties.docs_deploy(ctx:Context) -> None

Deploy the documentation to GitHub pages.

funcduties.format(ctx:Context) -> None

Run formatting tools on the code.

funcduties.fuzz(ctx:Context, *size:int=20, *min_seed:int=0, *max_seed:int=1000000, *seeds:_Seeds=_Seeds()) -> None

Fuzz Griffe against generated Python code.

funcduties.publish(ctx:Context) -> None

Publish source and wheel distributions to PyPI.

funcduties.release(ctx:Context, version:str='') -> None

Release a new version of the project.

funcduties.test(ctx:Context, *cli_args:str) -> None

Run the test suite.

funcpackages.griffecli.src.griffecli._internal.cli.get_parser() -> argparse.ArgumentParser

Return the CLI argument parser.

funcpackages.griffecli.src.griffecli._internal.cli.main(args:list[str] | None=None) -> int

Run the main program.

classpackages.griffelib.src.griffe._internal.agents.inspector.Inspector

This class is used to instantiate an inspector.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.generic_inspect(node:ObjectNode) -> None

Extend the base generic inspection with extensions.

method

packages.griffelib.src.griffe._internal.agents.inspector.Inspector.handle_attribute(node:ObjectNode, annotation:str | Expr | None=None) -> None

Handle an attribute.

method

packages.griffelib.src.griffe._internal.agents.inspector.Inspector.handle_function(node:ObjectNode, labels:set | None=None) -> None

Handle a function.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect(node:ObjectNode) -> None

Extend the base inspection with extensions.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_attribute(node:ObjectNode) -> None

Inspect an attribute.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_builtin_function(node:ObjectNode) -> None

Inspect a builtin function.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_builtin_method(node:ObjectNode) -> None

Inspect a builtin method.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_cached_property(node:ObjectNode) -> None

Inspect a cached property.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_class(node:ObjectNode) -> None

Inspect a class.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_classmethod(node:ObjectNode) -> None

Inspect a class method.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_coroutine(node:ObjectNode) -> None

Inspect a coroutine.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_function(node:ObjectNode) -> None

Inspect a function.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_getset_descriptor(node:ObjectNode) -> None

Inspect a get/set descriptor.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_method(node:ObjectNode) -> None

Inspect a method.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_method_descriptor(node:ObjectNode) -> None

Inspect a method descriptor.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_module(node:ObjectNode) -> None

Inspect a module.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_property(node:ObjectNode) -> None

Inspect a property.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_staticmethod(node:ObjectNode) -> None

Inspect a static method.

methodpackages.griffelib.src.griffe._internal.agents.inspector.Inspector.inspect_type_alias(node:ObjectNode) -> None

Inspect a type alias.

funcpackages.griffelib.src.griffe._internal.agents.nodes.assignments.get_name(node:ast.AST) -> str

Extract name from an assignment node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.assignments.get_names(node:ast.AST) -> list[str]

Extract names from an assignment node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_children(node:AST) -> Iterator[AST]

Return the children of an AST node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_first_child(node:AST) -> AST

Return the first child of this node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_kind(node:AST) -> str

Return the kind of an AST node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_last_child(node:AST) -> AST

Return the lasts child of this node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_next(node:AST) -> AST

Return the next sibling of this node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_previous(node:AST) -> AST

Return the previous sibling of this node.

funcpackages.griffelib.src.griffe._internal.agents.nodes.ast.ast_siblings(node:AST) -> Iterator[AST]

Return the siblings of this node.

func

packages.griffelib.src.griffe._internal.agents.nodes.docstrings.get_docstring(node:ast.AST, *strict:bool=False) -> tuple[str | None, int | None, int | None]

Extract a docstring.

func

packages.griffelib.src.griffe._internal.agents.nodes.exports.get__all__(node:ast.Assign | ast.AnnAssign | ast.AugAssign, parent:Module) -> list[str | ExprName]

Get the values declared in `__all__`.

classpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode

Helper class to represent an object tree.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.children() -> Sequence[ObjectNode]

The children of this node.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.is_class() -> bool

Whether this node's object is a class.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.is_function() -> bool

Whether this node's object is a function.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.is_method() -> bool

Whether this node's object is a method.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.is_module() -> bool

Whether this node's object is a module.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.is_property() -> bool

Whether this node's object is a property.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.kind() -> ObjectKind

The kind of this node.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.module_path() -> str | None

The object's module path.

methodpackages.griffelib.src.griffe._internal.agents.nodes.runtime.ObjectNode.path() -> str

The object's (Python) path.

funcpackages.griffelib.src.griffe._internal.agents.nodes.values.get_value(node:ast.AST | None) -> str | None

Get the string representation of a node.

classpackages.griffelib.src.griffe._internal.agents.visitor.Visitor

This class is used to instantiate a visitor.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.generic_visit(node:ast.AST) -> None

Extend the base generic visit with extensions.

method

packages.griffelib.src.griffe._internal.agents.visitor.Visitor.handle_attribute(node:ast.Assign | ast.AnnAssign, annotation:str | Expr | None=None) -> None

Handle an attribute (assignment) node.

method

packages.griffelib.src.griffe._internal.agents.visitor.Visitor.handle_function(node:ast.AsyncFunctionDef | ast.FunctionDef, labels:set | None=None) -> None

Handle a function definition node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit(node:ast.AST) -> None

Extend the base visit with extensions.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_annassign(node:ast.AnnAssign) -> None

Visit an annotated assignment node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_assign(node:ast.Assign) -> None

Visit an assignment node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_asyncfunctiondef(node:ast.AsyncFunctionDef) -> None

Visit an async function definition node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_augassign(node:ast.AugAssign) -> None

Visit an augmented assignment node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_classdef(node:ast.ClassDef) -> None

Visit a class definition node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_functiondef(node:ast.FunctionDef) -> None

Visit a function definition node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_if(node:ast.If) -> None

Visit an "if" node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_import(node:ast.Import) -> None

Visit an import node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_importfrom(node:ast.ImportFrom) -> None

Visit an "import from" node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_module(node:ast.Module) -> None

Visit a module node.

methodpackages.griffelib.src.griffe._internal.agents.visitor.Visitor.visit_typealias(node:ast.TypeAlias) -> None

Visit a type alias node.

classpackages.griffelib.src.griffe._internal.diff.Breakage

Breakages can explain what broke from a version to another.

methodpackages.griffelib.src.griffe._internal.diff.Breakage.as_dict(*full:bool=False, **kwargs:Any) -> dict[str, Any]

Return this object's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.diff.Breakage.explain(style:ExplanationStyle=ExplanationStyle.ONE_LINE) -> str

Explain the breakage by showing old and new value.

classpackages.griffelib.src.griffe._internal.diff.ObjectRemovedBreakage

Specific breakage class for removed objects.

classpackages.griffelib.src.griffe._internal.diff.ParameterMovedBreakage

Specific breakage class for moved parameters.

classpackages.griffelib.src.griffe._internal.diff.ParameterRemovedBreakage

Specific breakage class for removed parameters.

classpackages.griffelib.src.griffe._internal.docstrings.auto.AutoOptions

Options for Auto-style docstrings.

classpackages.griffelib.src.griffe._internal.docstrings.auto.PerStyleOptions

Per-style options for docstring parsing.

classpackages.griffelib.src.griffe._internal.docstrings.google.GoogleOptions

Options for parsing Google-style docstrings.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringAdmonition

This class represents an admonition.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringAdmonition.contents() -> str

The contents of this admonition.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringAdmonition.kind() -> str | Expr | None

The kind of this admonition.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringClass

This class represents a documented class.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringClass.signature() -> str | Expr | None

The class signature.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringDeprecated.version() -> str

The version of this deprecation.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringElement

This base class represents annotated, nameless elements.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringElement.as_dict(**kwargs:Any) -> dict[str, Any]

Return this element's data as a dictionary.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringFunction

This class represents a documented function.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringFunction.signature() -> str | Expr | None

The function signature.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringModule

This class represents a documented module.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringNamedElement

This base class represents annotated, named elements.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringNamedElement.as_dict(**kwargs:Any) -> dict[str, Any]

Return this element's data as a dictionary.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSection

This class represents a docstring section.

methodpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSection.as_dict(**kwargs:Any) -> dict[str, Any]

Return this section's data as a dictionary.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionClasses

This class represents a classes section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionExamples

This class represents an examples section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionModules

This class represents a modules section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionRaises

This class represents a raises section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionReceives

This class represents a receives section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionReturns

This class represents a returns section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionText

This class represents a text section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionWarns

This class represents a warns section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringSectionYields

This class represents a yields section.

classpackages.griffelib.src.griffe._internal.docstrings.models.DocstringWarn

This class represents a documented warn value.

classpackages.griffelib.src.griffe._internal.docstrings.numpy.NumpyOptions

Options for parsing Numpydoc-style docstrings.

func

packages.griffelib.src.griffe._internal.docstrings.parsers.parse(docstring:Docstring, parser:DocstringStyle | Parser | None, **options:Any) -> list[DocstringSection]

Parse the docstring.

classpackages.griffelib.src.griffe._internal.docstrings.sphinx.SphinxOptions

Options for parsing Sphinx-style docstrings.

func

packages.griffelib.src.griffe._internal.docstrings.sphinx.parse_sphinx(docstring:Docstring, *warn_unknown_params:bool=True, *warnings:bool=True) -> list[DocstringSection]

Parse a Sphinx-style docstring.

func

packages.griffelib.src.griffe._internal.docstrings.utils.docstring_warning(docstring:Docstring, offset:int, message:str, log_level:LogLevel=LogLevel.warning) -> None

Log a warning when parsing a docstring.

classpackages.griffelib.src.griffe._internal.encoders.JSONEncoder

JSON encoder.

methodpackages.griffelib.src.griffe._internal.encoders.JSONEncoder.default(obj:Any) -> Any

Return a serializable representation of the given object.

classpackages.griffelib.src.griffe._internal.enumerations.BreakageKind

Enumeration of the possible API breakages.

classpackages.griffelib.src.griffe._internal.enumerations.Kind

Enumeration of the different object kinds.

classpackages.griffelib.src.griffe._internal.enumerations.LogLevel

Enumeration of available log levels.

classpackages.griffelib.src.griffe._internal.enumerations.ParameterKind

Enumeration of the different parameter kinds.

classpackages.griffelib.src.griffe._internal.enumerations.Parser

Enumeration of the different docstring parsers.

classpackages.griffelib.src.griffe._internal.exceptions.AliasResolutionError

Exception for alias that cannot be resolved.

classpackages.griffelib.src.griffe._internal.exceptions.CyclicAliasError

Exception raised when a cycle is detected in aliases.

classpackages.griffelib.src.griffe._internal.exceptions.ExtensionError

Base class for errors raised by extensions.

classpackages.griffelib.src.griffe._internal.exceptions.GitError

Exception raised for errors related to Git.

classpackages.griffelib.src.griffe._internal.exceptions.GriffeError

The base exception for all Griffe errors.

classpackages.griffelib.src.griffe._internal.exceptions.LoadingError

The base exception for all Griffe errors.

classpackages.griffelib.src.griffe._internal.expressions.Expr

Base class for expressions.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.as_dict(**kwargs:Any) -> dict[str, Any]

Return the expression as a dictionary.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.canonical_path() -> str

Path of the expressed name/attribute.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.classname() -> str

The expression class name.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.is_generator() -> bool

Whether this expression is a generator.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.is_iterator() -> bool

Whether this expression is an iterator.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.is_tuple() -> bool

Whether this expression is a tuple.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.iterate(*flat:bool=True) -> Iterator[str | Expr]

Iterate on the expression elements.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.modernize() -> Expr

Modernize the expression.

methodpackages.griffelib.src.griffe._internal.expressions.Expr.path() -> str

Path of the expressed name/attribute.

classpackages.griffelib.src.griffe._internal.expressions.ExprAttribute

Attributes like `a.b`.

methodpackages.griffelib.src.griffe._internal.expressions.ExprAttribute.append(value:ExprName) -> None

Append a name to this attribute.

methodpackages.griffelib.src.griffe._internal.expressions.ExprAttribute.canonical_path() -> str

The canonical path of this attribute.

methodpackages.griffelib.src.griffe._internal.expressions.ExprAttribute.path() -> str

The path of this attribute.

classpackages.griffelib.src.griffe._internal.expressions.ExprAwait

Await expressions like `await call()`.

classpackages.griffelib.src.griffe._internal.expressions.ExprBinOp

Binary operations like `a + b`.

classpackages.griffelib.src.griffe._internal.expressions.ExprBoolOp

Boolean operations like `a or b`.

classpackages.griffelib.src.griffe._internal.expressions.ExprCall

Calls like `f()`.

classpackages.griffelib.src.griffe._internal.expressions.ExprCompare

Comparisons like `a > b`.

classpackages.griffelib.src.griffe._internal.expressions.ExprComprehension

Comprehensions like `a for b in c if d`.

classpackages.griffelib.src.griffe._internal.expressions.ExprConstant

Constants like `"a"` or `1`.

classpackages.griffelib.src.griffe._internal.expressions.ExprDict

Dictionaries like `{"a": 0}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprDictComp

Dict comprehensions like `{k: v for k, v in a}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprExtSlice

Extended slice like `a[x:y, z]`.

classpackages.griffelib.src.griffe._internal.expressions.ExprFormatted

Formatted string like `{1 + 1}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprIfExp

Conditions like `a if b else c`.

classpackages.griffelib.src.griffe._internal.expressions.ExprInterpolation

Template string interpolation like `{name}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprJoinedStr

Joined strings like `f"a {b} c"`.

classpackages.griffelib.src.griffe._internal.expressions.ExprKeyword

Keyword arguments like `a=b`.

methodpackages.griffelib.src.griffe._internal.expressions.ExprKeyword.canonical_path() -> str

Path of the expressed keyword.

classpackages.griffelib.src.griffe._internal.expressions.ExprLambda

Lambda expressions like `lambda a: a.b`.

classpackages.griffelib.src.griffe._internal.expressions.ExprList

Lists like `[0, 1, 2]`.

classpackages.griffelib.src.griffe._internal.expressions.ExprListComp

List comprehensions like `[a for b in c]`.

classpackages.griffelib.src.griffe._internal.expressions.ExprNamedExpr

Named/assignment expressions like `a := b`.

classpackages.griffelib.src.griffe._internal.expressions.ExprSet

Sets like `{0, 1, 2}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprSetComp

Set comprehensions like `{a for b in c}`.

classpackages.griffelib.src.griffe._internal.expressions.ExprSlice

Slices like `[a:b:c]`.

classpackages.griffelib.src.griffe._internal.expressions.ExprSubscript

Subscripts like `a[b]`.

methodpackages.griffelib.src.griffe._internal.expressions.ExprSubscript.path() -> str

The path of this subscript's left part.

classpackages.griffelib.src.griffe._internal.expressions.ExprTemplateStr

Template strings like `t"a {name}"`.

classpackages.griffelib.src.griffe._internal.expressions.ExprTuple

Tuples like `(0, 1, 2)`.

classpackages.griffelib.src.griffe._internal.expressions.ExprUnaryOp

Unary operations like `-1`.

classpackages.griffelib.src.griffe._internal.expressions.ExprVarKeyword

Variadic keyword parameters like `**kwargs`.

classpackages.griffelib.src.griffe._internal.expressions.ExprVarPositional

Variadic positional parameters like `*args`.

classpackages.griffelib.src.griffe._internal.expressions.ExprYield

Yield statements like `yield a`.

classpackages.griffelib.src.griffe._internal.expressions.ExprYieldFrom

Yield statements like `yield from a`.

func

packages.griffelib.src.griffe._internal.expressions.get_expression(node:ast.AST | None, parent:Module | Class, *member:str | None=None, *parse_strings:bool | None=None) -> Expr | None

Build an expression from an AST.

classpackages.griffelib.src.griffe._internal.extensions.base.Extension

Base class for Griffe extensions.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extension.generic_inspect(node:ObjectNode) -> None

Extend the base generic inspection with extensions.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extension.generic_visit(node:ast.AST) -> None

Visit children nodes.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extension.inspect(node:ObjectNode) -> None

Inspect a node.

method

packages.griffelib.src.griffe._internal.extensions.base.Extension.on_alias_instance(*node:ast.AST | ObjectNode, *alias:Alias, *agent:Visitor | Inspector, **kwargs:Any) -> None

Run when an Alias has been created.

method

packages.griffelib.src.griffe._internal.extensions.base.Extension.on_class_instance(*node:ast.AST | ObjectNode, *cls:Class, *agent:Visitor | Inspector, **kwargs:Any) -> None

Run when a Class has been created.

method

packages.griffelib.src.griffe._internal.extensions.base.Extension.on_instance(*node:ast.AST | ObjectNode, *obj:Object, *agent:Visitor | Inspector, **kwargs:Any) -> None

Run when an Object has been created.

method

packages.griffelib.src.griffe._internal.extensions.base.Extension.on_module_instance(*node:ast.AST | ObjectNode, *mod:Module, *agent:Visitor | Inspector, **kwargs:Any) -> None

Run when a Module has been created.

method

packages.griffelib.src.griffe._internal.extensions.base.Extension.on_package(*pkg:Module, *loader:GriffeLoader, **kwargs:Any) -> None

Run when a package has been completely loaded.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extension.visit(node:ast.AST) -> None

Visit a node.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extensions.add(*extensions:Extension) -> None

Add extensions to this container.

methodpackages.griffelib.src.griffe._internal.extensions.base.Extensions.call(event:str, **kwargs:Any) -> None

Call the extension hook for the given event.

funcpackages.griffelib.src.griffe._internal.extensions.base.load_extensions(*exts:LoadableExtensionType) -> Extensions

Load configured extensions.

methodpackages.griffelib.src.griffe._internal.finder.ModuleFinder.append_search_path(path:Path) -> None

Append a search path.

methodpackages.griffelib.src.griffe._internal.finder.ModuleFinder.find_package(module_name:str) -> Package | NamespacePackage

Find a package or namespace package.

methodpackages.griffelib.src.griffe._internal.finder.ModuleFinder.insert_search_path(position:int, path:Path) -> None

Insert a search path at the given position.

method

packages.griffelib.src.griffe._internal.finder.ModuleFinder.iter_submodules(path:Path | list[Path], seen:set | None=None) -> Iterator[NamePartsAndPathType]

Iterate on a module's submodules, if any.

methodpackages.griffelib.src.griffe._internal.finder.ModuleFinder.submodules(module:Module) -> list[NamePartsAndPathType]

Return the list of a module's submodules.

classpackages.griffelib.src.griffe._internal.git.GitInfo

Information about a Git repository.

methodpackages.griffelib.src.griffe._internal.git.GitInfo.from_package(package:Module) -> GitInfo | None

Create a GitInfo instance from a Griffe package.

classpackages.griffelib.src.griffe._internal.helpers.TmpPackage

A temporary package.

funcpackages.griffelib.src.griffe._internal.helpers.htree(*objects:Object) -> Object

Link objects together, horizontally.

func

packages.griffelib.src.griffe._internal.helpers.module_vtree(path:str, *leaf_package:bool=True, *return_leaf:bool=False) -> Module

Link objects together, vertically.

funcpackages.griffelib.src.griffe._internal.helpers.vtree(*return_leaf:bool=False, *objects:Object) -> Object

Link objects together, vertically.

func

packages.griffelib.src.griffe._internal.importer.dynamic_import(import_path:str, import_paths:Sequence[str | Path] | None=None) -> Any

Dynamically import the specified object.

funcpackages.griffelib.src.griffe._internal.importer.sys_path(*paths:str | Path) -> Iterator[None]

Redefine `sys.path` temporarily.

methodpackages.griffelib.src.griffe._internal.logger.Logger.disable() -> Iterator[None]

Temporarily disable logging.

funcpackages.griffelib.src.griffe._internal.logger.get_logger(name:str='griffe') -> Logger

Create and return a new logger instance.

funcpackages.griffelib.src.griffe._internal.logger.patch_loggers(get_logger_func:Callable[[str], Any]) -> None

Patch Griffe logger and Griffe extensions' loggers.

funcpackages.griffelib.src.griffe._internal.merger.merge_stubs(mod1:Module, mod2:Module) -> Module

Merge stubs into a module.

classpackages.griffelib.src.griffe._internal.mixins.DelMembersMixin

Mixin class to share methods for deleting members.

methodpackages.griffelib.src.griffe._internal.mixins.DelMembersMixin.del_member(key:str | Sequence[str]) -> None

Delete a member with its name or path.

methodpackages.griffelib.src.griffe._internal.mixins.GetMembersMixin.get_member(key:str | Sequence[str]) -> Any

Get a member with its name or path.

classpackages.griffelib.src.griffe._internal.mixins.SetMembersMixin

Mixin class to share methods for setting members.

method

packages.griffelib.src.griffe._internal.mixins.SetMembersMixin.set_member(key:str | Sequence[str], value:Object | Alias) -> None

Set a member with its name or path.

methodpackages.griffelib.src.griffe._internal.models.Alias.aliases() -> dict[str, Alias]

The aliases pointing to this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.annotation() -> str | Expr | None

The attribute type annotation.

methodpackages.griffelib.src.griffe._internal.models.Alias.as_dict(*full:bool=False, **kwargs:Any) -> dict[str, Any]

Return this alias' data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Alias.as_json(*full:bool=False, **kwargs:Any) -> str

Return this target's data as a JSON string.

methodpackages.griffelib.src.griffe._internal.models.Alias.bases() -> list[Expr | str]

The class bases.

methodpackages.griffelib.src.griffe._internal.models.Alias.canonical_path() -> str

The full dotted path of this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.decorators() -> list[Decorator]

The class/function decorators.

methodpackages.griffelib.src.griffe._internal.models.Alias.docstring() -> Docstring | None

The target docstring.

methodpackages.griffelib.src.griffe._internal.models.Alias.endlineno() -> int | None

The ending line number of the target object.

methodpackages.griffelib.src.griffe._internal.models.Alias.final_target() -> Object

The final, resolved target, if possible.

methodpackages.griffelib.src.griffe._internal.models.Alias.has_labels(*labels:str) -> bool

Tell if this object has all the given labels.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_attribute() -> bool

Whether this object is an attribute.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_class() -> bool

Whether this object is a class.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_function() -> bool

Whether this object is a function.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_init_method() -> bool

Whether this method is an `__init__` method.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_init_module() -> bool

Whether this module is an `__init__.py` module.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_kind(kind:str | Kind | set[str | Kind]) -> bool

Tell if this object is of the given kind.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_module() -> bool

Whether this object is a module.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_package() -> bool

Whether this module is a package (top module).

methodpackages.griffelib.src.griffe._internal.models.Alias.is_subpackage() -> bool

Whether this module is a subpackage.

methodpackages.griffelib.src.griffe._internal.models.Alias.is_type_alias() -> bool

Whether this object is a type alias.

methodpackages.griffelib.src.griffe._internal.models.Alias.keywords() -> dict[str, Expr | str]

The class keywords.

methodpackages.griffelib.src.griffe._internal.models.Alias.lineno() -> int | None

The starting line number of the target object.

methodpackages.griffelib.src.griffe._internal.models.Alias.lines() -> list[str]

The lines containing the source of this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.module() -> Module

The parent module of this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.parent() -> Module | Class | Alias | None

The parent of this alias.

methodpackages.griffelib.src.griffe._internal.models.Alias.path() -> str

The dotted path / import path of this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.resolve(name:str) -> str

Resolve a name within this object's and parents' scope.

methodpackages.griffelib.src.griffe._internal.models.Alias.resolve_target() -> None

Resolve the target.

methodpackages.griffelib.src.griffe._internal.models.Alias.resolved() -> bool

Whether this alias' target is resolved.

methodpackages.griffelib.src.griffe._internal.models.Alias.resolved_bases() -> list[Object]

Resolved class bases.

methodpackages.griffelib.src.griffe._internal.models.Alias.returns() -> str | Expr | None

The function return type annotation.

methodpackages.griffelib.src.griffe._internal.models.Alias.setter() -> Function | None

The setter linked to this function (property).

methodpackages.griffelib.src.griffe._internal.models.Alias.signature(*return_type:bool=False, *name:str | None=None) -> str

Construct the class/function signature.

methodpackages.griffelib.src.griffe._internal.models.Alias.source() -> str

The source code of this object.

methodpackages.griffelib.src.griffe._internal.models.Alias.type_parameters() -> TypeParameters

The target type parameters.

methodpackages.griffelib.src.griffe._internal.models.Alias.value() -> str | Expr | None

The attribute or type alias value.

methodpackages.griffelib.src.griffe._internal.models.Attribute.as_dict(**kwargs:Any) -> dict[str, Any]

Return this attribute's data as a dictionary.

classpackages.griffelib.src.griffe._internal.models.Class

The class representing a Python class.

methodpackages.griffelib.src.griffe._internal.models.Class.as_dict(**kwargs:Any) -> dict[str, Any]

Return this class' data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Class.resolved_bases() -> list[Object]

Resolved class bases.

methodpackages.griffelib.src.griffe._internal.models.Class.signature(*return_type:bool=False, *name:str | None=None) -> str

Construct the class signature.

classpackages.griffelib.src.griffe._internal.models.Decorator

This class represents decorators.

methodpackages.griffelib.src.griffe._internal.models.Decorator.as_dict(**kwargs:Any) -> dict[str, Any]

Return this decorator's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Decorator.callable_path() -> str

The path of the callable used as decorator.

classpackages.griffelib.src.griffe._internal.models.Docstring

This class represents docstrings.

methodpackages.griffelib.src.griffe._internal.models.Docstring.as_dict(*full:bool=False, **kwargs:Any) -> dict[str, Any]

Return this docstring's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Docstring.lines() -> list[str]

The lines of the docstring.

method

packages.griffelib.src.griffe._internal.models.Docstring.parse(parser:DocstringStyle | Parser | None=None, **options:Any) -> list[DocstringSection]

Parse the docstring into structured data.

classpackages.griffelib.src.griffe._internal.models.Function

The class representing a Python function.

methodpackages.griffelib.src.griffe._internal.models.Function.annotation() -> str | Expr | None

The type annotation of the returned value.

methodpackages.griffelib.src.griffe._internal.models.Function.as_dict(**kwargs:Any) -> dict[str, Any]

Return this function's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Function.is_init_method() -> bool

Whether this function is an `__init__` method.

methodpackages.griffelib.src.griffe._internal.models.Function.resolve(name:str) -> str

Resolve a name within this object's and parents' scope.

methodpackages.griffelib.src.griffe._internal.models.Function.signature(*return_type:bool=True, *name:str | None=None) -> str

Construct the function signature.

classpackages.griffelib.src.griffe._internal.models.Module

The class representing a Python module.

methodpackages.griffelib.src.griffe._internal.models.Module.as_dict(**kwargs:Any) -> dict[str, Any]

Return this module's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Module.filepath() -> Path | list[Path]

The file path of this module.

methodpackages.griffelib.src.griffe._internal.models.Module.is_package() -> bool

Whether this module is a package (top module).

methodpackages.griffelib.src.griffe._internal.models.Module.is_subpackage() -> bool

Whether this module is a subpackage.

classpackages.griffelib.src.griffe._internal.models.Object

An abstract class representing a Python object.

methodpackages.griffelib.src.griffe._internal.models.Object.as_dict(*full:bool=False, **kwargs:Any) -> dict[str, Any]

Return this object's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Object.canonical_path() -> str

The full dotted path of this object.

methodpackages.griffelib.src.griffe._internal.models.Object.has_labels(*labels:str) -> bool

Tell if this object has all the given labels.

methodpackages.griffelib.src.griffe._internal.models.Object.is_attribute() -> bool

Whether this object is an attribute.

methodpackages.griffelib.src.griffe._internal.models.Object.is_class() -> bool

Whether this object is a class.

methodpackages.griffelib.src.griffe._internal.models.Object.is_function() -> bool

Whether this object is a function.

methodpackages.griffelib.src.griffe._internal.models.Object.is_init_method() -> bool

Whether this function is an `__init__` method.

methodpackages.griffelib.src.griffe._internal.models.Object.is_kind(kind:str | Kind | set[str | Kind]) -> bool

Tell if this object is of the given kind.

methodpackages.griffelib.src.griffe._internal.models.Object.is_module() -> bool

Whether this object is a module.

methodpackages.griffelib.src.griffe._internal.models.Object.is_package() -> bool

Whether this object is a package (top module).

methodpackages.griffelib.src.griffe._internal.models.Object.is_subpackage() -> bool

Whether this object is a subpackage.

methodpackages.griffelib.src.griffe._internal.models.Object.is_type_alias() -> bool

Whether this object is a type alias.

methodpackages.griffelib.src.griffe._internal.models.Object.lines() -> list[str]

The lines containing the source of this object.

methodpackages.griffelib.src.griffe._internal.models.Object.module() -> Module

The parent module of this object.

methodpackages.griffelib.src.griffe._internal.models.Object.path() -> str

The dotted path of this object.

methodpackages.griffelib.src.griffe._internal.models.Object.resolve(name:str) -> str

Resolve a name within this object's and parents' scope.

methodpackages.griffelib.src.griffe._internal.models.Object.source() -> str

The source code of this object.

methodpackages.griffelib.src.griffe._internal.models.Object.source_link() -> str | None

Source link for this object, if available.

classpackages.griffelib.src.griffe._internal.models.Parameter

This class represent a function parameter.

methodpackages.griffelib.src.griffe._internal.models.Parameter.as_dict(*full:bool=False, **kwargs:Any) -> dict[str, Any]

Return this parameter's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.Parameter.required() -> bool

Whether this parameter is required.

classpackages.griffelib.src.griffe._internal.models.Parameters

This class is a container for parameters.

methodpackages.griffelib.src.griffe._internal.models.Parameters.add(parameter:Parameter) -> None

Add a parameter to the container.

classpackages.griffelib.src.griffe._internal.models.TypeAlias

The class representing a Python type alias.

methodpackages.griffelib.src.griffe._internal.models.TypeAlias.as_dict(**kwargs:Any) -> dict[str, Any]

Return this type alias's data as a dictionary.

classpackages.griffelib.src.griffe._internal.models.TypeParameter

This class represents a type parameter.

methodpackages.griffelib.src.griffe._internal.models.TypeParameter.as_dict(**kwargs:Any) -> dict[str, Any]

Return this type parameter's data as a dictionary.

methodpackages.griffelib.src.griffe._internal.models.TypeParameter.bound() -> str | Expr | None

The type parameter bound.

methodpackages.griffelib.src.griffe._internal.models.TypeParameter.constraints() -> tuple[str | Expr, ...] | None

The type parameter constraints.

classpackages.griffelib.src.griffe._internal.models.TypeParameters

This class is a container for type parameters.

methodpackages.griffelib.src.griffe._internal.models.TypeParameters.add(type_parameter:TypeParameter) -> None

Add a type parameter to the container.

classpackages.griffelib.src.griffe._internal.stats.Stats

Load statistics for a Griffe loader.

methodpackages.griffelib.src.griffe._internal.stats.Stats.as_text() -> str

Format the statistics as text.

About this data

These signatures were extracted from the public source of mkdocstrings/griffe using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries