{"kind": "module", "name": "griffe", "runtime": true, "exports": ["Alias", "AliasResolutionError", "Attribute", "AttributeChangedTypeBreakage", "AttributeChangedValueBreakage", "AutoOptions", "Breakage", "BreakageKind", "BuiltinModuleError", "Class", "ClassRemovedBaseBreakage", "CyclicAliasError", "DataclassesExtension", "Decorator", "DelMembersMixin", "Docstring", "DocstringAdmonition", "DocstringAttribute", "DocstringClass", "DocstringDeprecated", "DocstringDetectionMethod", "DocstringElement", "DocstringFunction", "DocstringModule", "DocstringNamedElement", "DocstringOptions", "DocstringParameter", "DocstringRaise", "DocstringReceive", "DocstringReturn", "DocstringSection", "DocstringSectionAdmonition", "DocstringSectionAttributes", "DocstringSectionClasses", "DocstringSectionDeprecated", "DocstringSectionExamples", "DocstringSectionFunctions", "DocstringSectionKind", "DocstringSectionModules", "DocstringSectionOtherParameters", "DocstringSectionParameters", "DocstringSectionRaises", "DocstringSectionReceives", "DocstringSectionReturns", "DocstringSectionText", "DocstringSectionTypeAliases", "DocstringSectionTypeParameters", "DocstringSectionWarns", "DocstringSectionYields", "DocstringStyle", "DocstringTypeAlias", "DocstringTypeParameter", "DocstringWarn", "DocstringYield", "ExplanationStyle", "Expr", "ExprAttribute", "ExprBinOp", "ExprBoolOp", "ExprCall", "ExprCompare", "ExprComprehension", "ExprConstant", "ExprDict", "ExprDictComp", "ExprExtSlice", "ExprFormatted", "ExprGeneratorExp", "ExprIfExp", "ExprInterpolation", "ExprJoinedStr", "ExprKeyword", "ExprLambda", "ExprList", "ExprListComp", "ExprName", "ExprNamedExpr", "ExprParameter", "ExprSet", "ExprSetComp", "ExprSlice", "ExprSubscript", "ExprTemplateStr", "ExprTuple", "ExprUnaryOp", "ExprVarKeyword", "ExprVarPositional", "ExprYield", "ExprYieldFrom", "Extension", "ExtensionError", "ExtensionNotLoadedError", "Extensions", "Function", "GetMembersMixin", "GitError", "GitInfo", "GoogleOptions", "GriffeError", "GriffeLoader", "Inspector", "JSONEncoder", "Kind", "KnownGitService", "LastNodeError", "LinesCollection", "LoadableExtensionType", "LoadingError", "LogLevel", "Logger", "Module", "ModuleFinder", "ModulesCollection", "NamePartsAndPathType", "NamePartsType", "NameResolutionError", "NamespacePackage", "NumpyOptions", "Object", "ObjectAliasMixin", "ObjectChangedKindBreakage", "ObjectKind", "ObjectNode", "ObjectRemovedBreakage", "Package", "Parameter", "ParameterAddedRequiredBreakage", "ParameterChangedDefaultBreakage", "ParameterChangedKindBreakage", "ParameterChangedRequiredBreakage", "ParameterKind", "ParameterMovedBreakage", "ParameterRemovedBreakage", "Parameters", "ParametersType", "Parser", "PerStyleOptions", "ReturnChangedTypeBreakage", "RootNodeError", "SerializationMixin", "SetMembersMixin", "SphinxOptions", "Stats", "TmpPackage", "TypeAlias", "TypeParameter", "TypeParameterKind", "TypeParameters", "UnhandledEditableModuleError", "UnimportableModuleError", "UnpackTypedDictExtension", "Visitor", "ast_children", "ast_first_child", "ast_kind", "ast_last_child", "ast_next", "ast_next_siblings", "ast_previous", "ast_previous_siblings", "ast_siblings", "builtin_decorators", "builtin_extensions", "c3linear_merge", "docstring_warning", "dynamic_import", "find_breaking_changes", "get__all__", "get_annotation", "get_base_class", "get_class_keyword", "get_condition", "get_docstring", "get_expression", "get_instance_names", "get_logger", "get_name", "get_names", "get_parameters", "get_value", "htree", "infer_docstring_style", "inspect", "json_decoder", "load", "load_extensions", "load_git", "load_pypi", "logger", "merge_stubs", "module_vtree", "parse", "parse_auto", "parse_docstring_annotation", "parse_google", "parse_numpy", "parse_sphinx", "parsers", "patch_loggers", "relative_to_absolute", "safe_get__all__", "safe_get_annotation", "safe_get_base_class", "safe_get_class_keyword", "safe_get_condition", "safe_get_expression", "safe_get_value", "stdlib_decorators", "sys_path", "temporary_inspected_module", "temporary_inspected_package", "temporary_pyfile", "temporary_pypackage", "temporary_visited_module", "temporary_visited_package", "typing_overload", "visit", "vtree"], "imports": {"annotations": "__future__.annotations", "Inspector": "griffe._internal.agents.inspector.Inspector", "inspect": "griffe._internal.agents.inspector.inspect", "get_instance_names": "griffe._internal.agents.nodes.assignments.get_instance_names", "get_name": "griffe._internal.agents.nodes.assignments.get_name", "get_names": "griffe._internal.agents.nodes.assignments.get_names", "ast_children": "griffe._internal.agents.nodes.ast.ast_children", "ast_first_child": "griffe._internal.agents.nodes.ast.ast_first_child", "ast_kind": "griffe._internal.agents.nodes.ast.ast_kind", "ast_last_child": "griffe._internal.agents.nodes.ast.ast_last_child", "ast_next": "griffe._internal.agents.nodes.ast.ast_next", "ast_next_siblings": "griffe._internal.agents.nodes.ast.ast_next_siblings", "ast_previous": "griffe._internal.agents.nodes.ast.ast_previous", "ast_previous_siblings": "griffe._internal.agents.nodes.ast.ast_previous_siblings", "ast_siblings": "griffe._internal.agents.nodes.ast.ast_siblings", "get_docstring": "griffe._internal.agents.nodes.docstrings.get_docstring", "get__all__": "griffe._internal.agents.nodes.exports.get__all__", "safe_get__all__": "griffe._internal.agents.nodes.exports.safe_get__all__", "relative_to_absolute": "griffe._internal.agents.nodes.imports.relative_to_absolute", "ParametersType": "griffe._internal.agents.nodes.parameters.ParametersType", "get_parameters": "griffe._internal.agents.nodes.parameters.get_parameters", "ObjectNode": "griffe._internal.agents.nodes.runtime.ObjectNode", "get_value": "griffe._internal.agents.nodes.values.get_value", "safe_get_value": "griffe._internal.agents.nodes.values.safe_get_value", "Visitor": "griffe._internal.agents.visitor.Visitor", "builtin_decorators": "griffe._internal.agents.visitor.builtin_decorators", "stdlib_decorators": "griffe._internal.agents.visitor.stdlib_decorators", "typing_overload": "griffe._internal.agents.visitor.typing_overload", "visit": "griffe._internal.agents.visitor.visit", "c3linear_merge": "griffe._internal.c3linear.c3linear_merge", "LinesCollection": "griffe._internal.collections.LinesCollection", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "AttributeChangedTypeBreakage": "griffe._internal.diff.AttributeChangedTypeBreakage", "AttributeChangedValueBreakage": "griffe._internal.diff.AttributeChangedValueBreakage", "Breakage": "griffe._internal.diff.Breakage", "ClassRemovedBaseBreakage": "griffe._internal.diff.ClassRemovedBaseBreakage", "ObjectChangedKindBreakage": "griffe._internal.diff.ObjectChangedKindBreakage", "ObjectRemovedBreakage": "griffe._internal.diff.ObjectRemovedBreakage", "ParameterAddedRequiredBreakage": "griffe._internal.diff.ParameterAddedRequiredBreakage", "ParameterChangedDefaultBreakage": "griffe._internal.diff.ParameterChangedDefaultBreakage", "ParameterChangedKindBreakage": "griffe._internal.diff.ParameterChangedKindBreakage", "ParameterChangedRequiredBreakage": "griffe._internal.diff.ParameterChangedRequiredBreakage", "ParameterMovedBreakage": "griffe._internal.diff.ParameterMovedBreakage", "ParameterRemovedBreakage": "griffe._internal.diff.ParameterRemovedBreakage", "ReturnChangedTypeBreakage": "griffe._internal.diff.ReturnChangedTypeBreakage", "find_breaking_changes": "griffe._internal.diff.find_breaking_changes", "AutoOptions": "griffe._internal.docstrings.auto.AutoOptions", "DocstringDetectionMethod": "griffe._internal.docstrings.auto.DocstringDetectionMethod", "PerStyleOptions": "griffe._internal.docstrings.auto.PerStyleOptions", "infer_docstring_style": "griffe._internal.docstrings.auto.infer_docstring_style", "parse_auto": "griffe._internal.docstrings.auto.parse_auto", "GoogleOptions": "griffe._internal.docstrings.google.GoogleOptions", "parse_google": "griffe._internal.docstrings.google.parse_google", "DocstringAdmonition": "griffe._internal.docstrings.models.DocstringAdmonition", "DocstringAttribute": "griffe._internal.docstrings.models.DocstringAttribute", "DocstringClass": "griffe._internal.docstrings.models.DocstringClass", "DocstringDeprecated": "griffe._internal.docstrings.models.DocstringDeprecated", "DocstringElement": "griffe._internal.docstrings.models.DocstringElement", "DocstringFunction": "griffe._internal.docstrings.models.DocstringFunction", "DocstringModule": "griffe._internal.docstrings.models.DocstringModule", "DocstringNamedElement": "griffe._internal.docstrings.models.DocstringNamedElement", "DocstringParameter": "griffe._internal.docstrings.models.DocstringParameter", "DocstringRaise": "griffe._internal.docstrings.models.DocstringRaise", "DocstringReceive": "griffe._internal.docstrings.models.DocstringReceive", "DocstringReturn": "griffe._internal.docstrings.models.DocstringReturn", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "DocstringSectionAdmonition": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "DocstringSectionAttributes": "griffe._internal.docstrings.models.DocstringSectionAttributes", "DocstringSectionClasses": "griffe._internal.docstrings.models.DocstringSectionClasses", "DocstringSectionDeprecated": "griffe._internal.docstrings.models.DocstringSectionDeprecated", "DocstringSectionExamples": "griffe._internal.docstrings.models.DocstringSectionExamples", "DocstringSectionFunctions": "griffe._internal.docstrings.models.DocstringSectionFunctions", "DocstringSectionModules": "griffe._internal.docstrings.models.DocstringSectionModules", "DocstringSectionOtherParameters": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "DocstringSectionParameters": "griffe._internal.docstrings.models.DocstringSectionParameters", "DocstringSectionRaises": "griffe._internal.docstrings.models.DocstringSectionRaises", "DocstringSectionReceives": "griffe._internal.docstrings.models.DocstringSectionReceives", "DocstringSectionReturns": "griffe._internal.docstrings.models.DocstringSectionReturns", "DocstringSectionText": "griffe._internal.docstrings.models.DocstringSectionText", "DocstringSectionTypeAliases": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "DocstringSectionTypeParameters": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "DocstringSectionWarns": "griffe._internal.docstrings.models.DocstringSectionWarns", "DocstringSectionYields": "griffe._internal.docstrings.models.DocstringSectionYields", "DocstringTypeAlias": "griffe._internal.docstrings.models.DocstringTypeAlias", "DocstringTypeParameter": "griffe._internal.docstrings.models.DocstringTypeParameter", "DocstringWarn": "griffe._internal.docstrings.models.DocstringWarn", "DocstringYield": "griffe._internal.docstrings.models.DocstringYield", "NumpyOptions": "griffe._internal.docstrings.numpy.NumpyOptions", "parse_numpy": "griffe._internal.docstrings.numpy.parse_numpy", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "parse": "griffe._internal.docstrings.parsers.parse", "parsers": "griffe._internal.docstrings.parsers.parsers", "SphinxOptions": "griffe._internal.docstrings.sphinx.SphinxOptions", "parse_sphinx": "griffe._internal.docstrings.sphinx.parse_sphinx", "docstring_warning": "griffe._internal.docstrings.utils.docstring_warning", "parse_docstring_annotation": "griffe._internal.docstrings.utils.parse_docstring_annotation", "JSONEncoder": "griffe._internal.encoders.JSONEncoder", "json_decoder": "griffe._internal.encoders.json_decoder", "BreakageKind": "griffe._internal.enumerations.BreakageKind", "DocstringSectionKind": "griffe._internal.enumerations.DocstringSectionKind", "ExplanationStyle": "griffe._internal.enumerations.ExplanationStyle", "Kind": "griffe._internal.enumerations.Kind", "LogLevel": "griffe._internal.enumerations.LogLevel", "ObjectKind": "griffe._internal.enumerations.ObjectKind", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "Parser": "griffe._internal.enumerations.Parser", "TypeParameterKind": "griffe._internal.enumerations.TypeParameterKind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "BuiltinModuleError": "griffe._internal.exceptions.BuiltinModuleError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "ExtensionError": "griffe._internal.exceptions.ExtensionError", "ExtensionNotLoadedError": "griffe._internal.exceptions.ExtensionNotLoadedError", "GitError": "griffe._internal.exceptions.GitError", "GriffeError": "griffe._internal.exceptions.GriffeError", "LastNodeError": "griffe._internal.exceptions.LastNodeError", "LoadingError": "griffe._internal.exceptions.LoadingError", "NameResolutionError": "griffe._internal.exceptions.NameResolutionError", "RootNodeError": "griffe._internal.exceptions.RootNodeError", "UnhandledEditableModuleError": "griffe._internal.exceptions.UnhandledEditableModuleError", "UnimportableModuleError": "griffe._internal.exceptions.UnimportableModuleError", "Expr": "griffe._internal.expressions.Expr", "ExprAttribute": "griffe._internal.expressions.ExprAttribute", "ExprBinOp": "griffe._internal.expressions.ExprBinOp", "ExprBoolOp": "griffe._internal.expressions.ExprBoolOp", "ExprCall": "griffe._internal.expressions.ExprCall", "ExprCompare": "griffe._internal.expressions.ExprCompare", "ExprComprehension": "griffe._internal.expressions.ExprComprehension", "ExprConstant": "griffe._internal.expressions.ExprConstant", "ExprDict": "griffe._internal.expressions.ExprDict", "ExprDictComp": "griffe._internal.expressions.ExprDictComp", "ExprExtSlice": "griffe._internal.expressions.ExprExtSlice", "ExprFormatted": "griffe._internal.expressions.ExprFormatted", "ExprGeneratorExp": "griffe._internal.expressions.ExprGeneratorExp", "ExprIfExp": "griffe._internal.expressions.ExprIfExp", "ExprInterpolation": "griffe._internal.expressions.ExprInterpolation", "ExprJoinedStr": "griffe._internal.expressions.ExprJoinedStr", "ExprKeyword": "griffe._internal.expressions.ExprKeyword", "ExprLambda": "griffe._internal.expressions.ExprLambda", "ExprList": "griffe._internal.expressions.ExprList", "ExprListComp": "griffe._internal.expressions.ExprListComp", "ExprName": "griffe._internal.expressions.ExprName", "ExprNamedExpr": "griffe._internal.expressions.ExprNamedExpr", "ExprParameter": "griffe._internal.expressions.ExprParameter", "ExprSet": "griffe._internal.expressions.ExprSet", "ExprSetComp": "griffe._internal.expressions.ExprSetComp", "ExprSlice": "griffe._internal.expressions.ExprSlice", "ExprSubscript": "griffe._internal.expressions.ExprSubscript", "ExprTemplateStr": "griffe._internal.expressions.ExprTemplateStr", "ExprTuple": "griffe._internal.expressions.ExprTuple", "ExprUnaryOp": "griffe._internal.expressions.ExprUnaryOp", "ExprVarKeyword": "griffe._internal.expressions.ExprVarKeyword", "ExprVarPositional": "griffe._internal.expressions.ExprVarPositional", "ExprYield": "griffe._internal.expressions.ExprYield", "ExprYieldFrom": "griffe._internal.expressions.ExprYieldFrom", "get_annotation": "griffe._internal.expressions.get_annotation", "get_base_class": "griffe._internal.expressions.get_base_class", "get_class_keyword": "griffe._internal.expressions.get_class_keyword", "get_condition": "griffe._internal.expressions.get_condition", "get_expression": "griffe._internal.expressions.get_expression", "safe_get_annotation": "griffe._internal.expressions.safe_get_annotation", "safe_get_base_class": "griffe._internal.expressions.safe_get_base_class", "safe_get_class_keyword": "griffe._internal.expressions.safe_get_class_keyword", "safe_get_condition": "griffe._internal.expressions.safe_get_condition", "safe_get_expression": "griffe._internal.expressions.safe_get_expression", "Extension": "griffe._internal.extensions.base.Extension", "Extensions": "griffe._internal.extensions.base.Extensions", "LoadableExtensionType": "griffe._internal.extensions.base.LoadableExtensionType", "builtin_extensions": "griffe._internal.extensions.base.builtin_extensions", "load_extensions": "griffe._internal.extensions.base.load_extensions", "DataclassesExtension": "griffe._internal.extensions.dataclasses.DataclassesExtension", "UnpackTypedDictExtension": "griffe._internal.extensions.unpack_typeddict.UnpackTypedDictExtension", "ModuleFinder": "griffe._internal.finder.ModuleFinder", "NamePartsAndPathType": "griffe._internal.finder.NamePartsAndPathType", "NamePartsType": "griffe._internal.finder.NamePartsType", "NamespacePackage": "griffe._internal.finder.NamespacePackage", "Package": "griffe._internal.finder.Package", "GitInfo": "griffe._internal.git.GitInfo", "KnownGitService": "griffe._internal.git.KnownGitService", "dynamic_import": "griffe._internal.importer.dynamic_import", "sys_path": "griffe._internal.importer.sys_path", "GriffeLoader": "griffe._internal.loader.GriffeLoader", "load": "griffe._internal.loader.load", "load_git": "griffe._internal.loader.load_git", "load_pypi": "griffe._internal.loader.load_pypi", "Logger": "griffe._internal.logger.Logger", "get_logger": "griffe._internal.logger.get_logger", "logger": "griffe._internal.logger.logger", "patch_loggers": "griffe._internal.logger.patch_loggers", "merge_stubs": "griffe._internal.merger.merge_stubs", "DelMembersMixin": "griffe._internal.mixins.DelMembersMixin", "GetMembersMixin": "griffe._internal.mixins.GetMembersMixin", "ObjectAliasMixin": "griffe._internal.mixins.ObjectAliasMixin", "SerializationMixin": "griffe._internal.mixins.SerializationMixin", "SetMembersMixin": "griffe._internal.mixins.SetMembersMixin", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Decorator": "griffe._internal.models.Decorator", "Docstring": "griffe._internal.models.Docstring", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters", "TypeAlias": "griffe._internal.models.TypeAlias", "TypeParameter": "griffe._internal.models.TypeParameter", "TypeParameters": "griffe._internal.models.TypeParameters", "Stats": "griffe._internal.stats.Stats", "TmpPackage": "griffe._internal.tests.TmpPackage", "htree": "griffe._internal.tests.htree", "module_vtree": "griffe._internal.tests.module_vtree", "temporary_inspected_module": "griffe._internal.tests.temporary_inspected_module", "temporary_inspected_package": "griffe._internal.tests.temporary_inspected_package", "temporary_pyfile": "griffe._internal.tests.temporary_pyfile", "temporary_pypackage": "griffe._internal.tests.temporary_pypackage", "temporary_visited_module": "griffe._internal.tests.temporary_visited_module", "temporary_visited_package": "griffe._internal.tests.temporary_visited_package", "vtree": "griffe._internal.tests.vtree", "__cli_all__": "griffecli.__all__"}, "docstring": {"value": "Griffe library package.\n\nSignatures for entire Python programs.\nExtract the structure, the frame, the skeleton of your project,\nto generate API documentation or find breaking changes in your API.\n\nThe entirety of the library API is exposed here, in the top-level `griffe` module.\n\nAll messages written to standard output or error are logged using the `logging` module.\nOur logger's name is set to `\"griffe\"` and is public (you can rely on it).\nYou can obtain the logger from the standard `logging` module: `logging.getLogger(\"griffe\")`.\nActual logging messages are not part of the public API (they might change without notice).\n\nRaised exceptions throughout the package are part of the public API (you can rely on them).\nTheir actual messages are not part of the public API (they might change without notice).\n\nThe following paragraphs will help you discover the package's content.\n\n## Loaders\n\nTo load API data, Griffe provides several high-level functions.\n\n- [`griffe.load`][]: Load and return a Griffe object.\n- [`griffe.load_git`][]: Load and return a module from a specific Git reference.\n- [`griffe.load_pypi`][]: Load and return a module from a specific package version downloaded using pip.\n\n## Models\n\nThe data loaded by Griffe is represented by several classes.\n\n- [`griffe.Module`][]: The class representing a Python module.\n- [`griffe.Class`][]: The class representing a Python class.\n- [`griffe.Function`][]: The class representing a Python function or method.\n- [`griffe.Attribute`][]: The class representing a Python attribute.\n- [`griffe.Alias`][]: This class represents an alias, or indirection, to an object declared in another module.\n\nAdditional classes are available to represent other concepts.\n\n- [`griffe.Decorator`][]: This class represents a decorator.\n- [`griffe.Parameters`][]: This class is a container for parameters.\n- [`griffe.Parameter`][]: This class represent a function parameter.\n\n## Agents\n\nGriffe is able to analyze code both statically and dynamically, using the following \"agents\".\nHowever most of the time you will only need to use the loaders above.\n\n- [`griffe.visit`][]: Parse and visit a module file.\n- [`griffe.inspect`][]: Inspect a module.\n\n## Serializers\n\nGriffe can serizalize data to dictionary and JSON.\n\n- [`griffe.Object.as_json`][griffe.Object.as_json]\n- [`griffe.Object.from_json`][griffe.Object.from_json]\n- [`griffe.JSONEncoder`][]: JSON encoder for Griffe objects.\n- [`griffe.json_decoder`][]: JSON decoder for Griffe objects.\n\n## API checks\n\nGriffe can compare two versions of the same package to find breaking changes.\n\n- [`griffe.find_breaking_changes`][]: Find breaking changes between two versions of the same API.\n- [`griffe.Breakage`][]: Breakage classes can explain what broke from a version to another.\n\n## Extensions\n\nGriffe supports extensions. You can create your own extension by subclassing the `griffe.Extension` class.\n\n- [`griffe.load_extensions`][]: Load configured extensions.\n- [`griffe.Extension`][]: Base class for Griffe extensions.\n\n## Docstrings\n\nGriffe can parse docstrings into structured data.\n\nMain class:\n\n- [`griffe.Docstring`][]: This class represents docstrings.\n\nDocstring section and element classes all start with `Docstring`.\n\nDocstring parsers:\n\n- [`griffe.parse`][]: Parse the docstring.\n- [`griffe.parse_auto`][]: Parse a docstring by automatically detecting the style it uses.\n- [`griffe.parse_google`][]: Parse a Google-style docstring.\n- [`griffe.parse_numpy`][]: Parse a Numpydoc-style docstring.\n- [`griffe.parse_sphinx`][]: Parse a Sphinx-style docstring.\n\n## Exceptions\n\nGriffe uses several exceptions to signal errors.\n\n- [`griffe.GriffeError`][]: The base exception for all Griffe errors.\n- [`griffe.LoadingError`][]: Exception for loading errors.\n- [`griffe.NameResolutionError`][]: Exception for names that cannot be resolved in a object scope.\n- [`griffe.UnhandledEditableModuleError`][]: Exception for unhandled editables modules, when searching modules.\n- [`griffe.UnimportableModuleError`][]: Exception for modules that cannot be imported.\n- [`griffe.AliasResolutionError`][]: Exception for aliases that cannot be resolved.\n- [`griffe.CyclicAliasError`][]: Exception raised when a cycle is detected in aliases.\n- [`griffe.LastNodeError`][]: Exception raised when trying to access a next or previous node.\n- [`griffe.RootNodeError`][]: Exception raised when trying to use siblings properties on a root node.\n- [`griffe.BuiltinModuleError`][]: Exception raised when trying to access the filepath of a builtin module.\n- [`griffe.ExtensionError`][]: Base class for errors raised by extensions.\n- [`griffe.ExtensionNotLoadedError`][]: Exception raised when an extension could not be loaded.\n- [`griffe.GitError`][]: Exception raised for errors related to Git.\n\n# Expressions\n\nGriffe stores snippets of code (attribute values, decorators, base class, type annotations) as expressions.\nExpressions are basically abstract syntax trees (AST) with a few differences compared to the nodes returned by [`ast`][].\nGriffe provides a few helpers to extract expressions from regular AST nodes.\n\n- [`griffe.get_annotation`][]: Get a type annotation as expression.\n- [`griffe.get_base_class`][]: Get a base class as expression.\n- [`griffe.get_class_keyword`][]: Get a class keyword as expression.\n- [`griffe.get_condition`][]: Get a condition as expression.\n- [`griffe.get_expression`][]: Get an expression from an AST node.\n- [`griffe.safe_get_annotation`][]: Get a type annotation as expression, safely (returns `None` on error).\n- [`griffe.safe_get_base_class`][]: Get a base class as expression, safely (returns `None` on error).\n- [`griffe.safe_get_class_keyword`][]: Get a class keyword as expression, safely (returns `None` on error).\n- [`griffe.safe_get_condition`][]: Get a condition as expression, safely (returns `None` on error).\n- [`griffe.safe_get_expression`][]: Get an expression from an AST node, safely (returns `None` on error).\n\nThe base class for expressions.\n\n- [`griffe.Expr`][]\n\nExpression classes all start with `Expr`.\n\n# Loggers\n\nIf you want to log messages from extensions, get a logger with `get_logger`.\nThe `logger` attribute is used by Griffe itself. You can use it to temporarily disable Griffe logging.\n\n- [`griffe.logger`][]: Our global logger, used throughout the library.\n- [`griffe.get_logger`][]: Create and return a new logger instance.\n\n# Helpers\n\nTo test your Griffe extensions, or to load API data from code in memory, Griffe provides the following helpers.\n\n- [`griffe.temporary_pyfile`][]: Create a Python file containing the given code in a temporary directory.\n- [`griffe.temporary_pypackage`][]: Create a package containing the given modules in a temporary directory.\n- [`griffe.temporary_visited_module`][]: Create and visit a temporary module with the given code.\n- [`griffe.temporary_visited_package`][]: Create and visit a temporary package.\n- [`griffe.temporary_inspected_module`][]: Create and inspect a temporary module with the given code.\n- [`griffe.temporary_inspected_package`][]: Create and inspect a temporary package.", "lineno": 5, "endlineno": 155, "parsed": [{"kind": "text", "value": "Griffe library package.\n\nSignatures for entire Python programs.\nExtract the structure, the frame, the skeleton of your project,\nto generate API documentation or find breaking changes in your API.\n\nThe entirety of the library API is exposed here, in the top-level `griffe` module.\n\nAll messages written to standard output or error are logged using the `logging` module.\nOur logger's name is set to `\"griffe\"` and is public (you can rely on it).\nYou can obtain the logger from the standard `logging` module: `logging.getLogger(\"griffe\")`.\nActual logging messages are not part of the public API (they might change without notice).\n\nRaised exceptions throughout the package are part of the public API (you can rely on them).\nTheir actual messages are not part of the public API (they might change without notice).\n\nThe following paragraphs will help you discover the package's content.\n\n## Loaders\n\nTo load API data, Griffe provides several high-level functions.\n\n- [`griffe.load`][]: Load and return a Griffe object.\n- [`griffe.load_git`][]: Load and return a module from a specific Git reference.\n- [`griffe.load_pypi`][]: Load and return a module from a specific package version downloaded using pip.\n\n## Models\n\nThe data loaded by Griffe is represented by several classes.\n\n- [`griffe.Module`][]: The class representing a Python module.\n- [`griffe.Class`][]: The class representing a Python class.\n- [`griffe.Function`][]: The class representing a Python function or method.\n- [`griffe.Attribute`][]: The class representing a Python attribute.\n- [`griffe.Alias`][]: This class represents an alias, or indirection, to an object declared in another module.\n\nAdditional classes are available to represent other concepts.\n\n- [`griffe.Decorator`][]: This class represents a decorator.\n- [`griffe.Parameters`][]: This class is a container for parameters.\n- [`griffe.Parameter`][]: This class represent a function parameter.\n\n## Agents\n\nGriffe is able to analyze code both statically and dynamically, using the following \"agents\".\nHowever most of the time you will only need to use the loaders above.\n\n- [`griffe.visit`][]: Parse and visit a module file.\n- [`griffe.inspect`][]: Inspect a module.\n\n## Serializers\n\nGriffe can serizalize data to dictionary and JSON.\n\n- [`griffe.Object.as_json`][griffe.Object.as_json]\n- [`griffe.Object.from_json`][griffe.Object.from_json]\n- [`griffe.JSONEncoder`][]: JSON encoder for Griffe objects.\n- [`griffe.json_decoder`][]: JSON decoder for Griffe objects.\n\n## API checks\n\nGriffe can compare two versions of the same package to find breaking changes.\n\n- [`griffe.find_breaking_changes`][]: Find breaking changes between two versions of the same API.\n- [`griffe.Breakage`][]: Breakage classes can explain what broke from a version to another.\n\n## Extensions\n\nGriffe supports extensions. You can create your own extension by subclassing the `griffe.Extension` class.\n\n- [`griffe.load_extensions`][]: Load configured extensions.\n- [`griffe.Extension`][]: Base class for Griffe extensions.\n\n## Docstrings\n\nGriffe can parse docstrings into structured data.\n\nMain class:\n\n- [`griffe.Docstring`][]: This class represents docstrings.\n\nDocstring section and element classes all start with `Docstring`.\n\nDocstring parsers:\n\n- [`griffe.parse`][]: Parse the docstring.\n- [`griffe.parse_auto`][]: Parse a docstring by automatically detecting the style it uses.\n- [`griffe.parse_google`][]: Parse a Google-style docstring.\n- [`griffe.parse_numpy`][]: Parse a Numpydoc-style docstring.\n- [`griffe.parse_sphinx`][]: Parse a Sphinx-style docstring.\n\n## Exceptions\n\nGriffe uses several exceptions to signal errors.\n\n- [`griffe.GriffeError`][]: The base exception for all Griffe errors.\n- [`griffe.LoadingError`][]: Exception for loading errors.\n- [`griffe.NameResolutionError`][]: Exception for names that cannot be resolved in a object scope.\n- [`griffe.UnhandledEditableModuleError`][]: Exception for unhandled editables modules, when searching modules.\n- [`griffe.UnimportableModuleError`][]: Exception for modules that cannot be imported.\n- [`griffe.AliasResolutionError`][]: Exception for aliases that cannot be resolved.\n- [`griffe.CyclicAliasError`][]: Exception raised when a cycle is detected in aliases.\n- [`griffe.LastNodeError`][]: Exception raised when trying to access a next or previous node.\n- [`griffe.RootNodeError`][]: Exception raised when trying to use siblings properties on a root node.\n- [`griffe.BuiltinModuleError`][]: Exception raised when trying to access the filepath of a builtin module.\n- [`griffe.ExtensionError`][]: Base class for errors raised by extensions.\n- [`griffe.ExtensionNotLoadedError`][]: Exception raised when an extension could not be loaded.\n- [`griffe.GitError`][]: Exception raised for errors related to Git.\n\n# Expressions\n\nGriffe stores snippets of code (attribute values, decorators, base class, type annotations) as expressions.\nExpressions are basically abstract syntax trees (AST) with a few differences compared to the nodes returned by [`ast`][].\nGriffe provides a few helpers to extract expressions from regular AST nodes.\n\n- [`griffe.get_annotation`][]: Get a type annotation as expression.\n- [`griffe.get_base_class`][]: Get a base class as expression.\n- [`griffe.get_class_keyword`][]: Get a class keyword as expression.\n- [`griffe.get_condition`][]: Get a condition as expression.\n- [`griffe.get_expression`][]: Get an expression from an AST node.\n- [`griffe.safe_get_annotation`][]: Get a type annotation as expression, safely (returns `None` on error).\n- [`griffe.safe_get_base_class`][]: Get a base class as expression, safely (returns `None` on error).\n- [`griffe.safe_get_class_keyword`][]: Get a class keyword as expression, safely (returns `None` on error).\n- [`griffe.safe_get_condition`][]: Get a condition as expression, safely (returns `None` on error).\n- [`griffe.safe_get_expression`][]: Get an expression from an AST node, safely (returns `None` on error).\n\nThe base class for expressions.\n\n- [`griffe.Expr`][]\n\nExpression classes all start with `Expr`.\n\n# Loggers\n\nIf you want to log messages from extensions, get a logger with `get_logger`.\nThe `logger` attribute is used by Griffe itself. You can use it to temporarily disable Griffe logging.\n\n- [`griffe.logger`][]: Our global logger, used throughout the library.\n- [`griffe.get_logger`][]: Create and return a new logger instance.\n\n# Helpers\n\nTo test your Griffe extensions, or to load API data from code in memory, Griffe provides the following helpers.\n\n- [`griffe.temporary_pyfile`][]: Create a Python file containing the given code in a temporary directory.\n- [`griffe.temporary_pypackage`][]: Create a package containing the given modules in a temporary directory.\n- [`griffe.temporary_visited_module`][]: Create and visit a temporary module with the given code.\n- [`griffe.temporary_visited_package`][]: Create and visit a temporary package.\n- [`griffe.temporary_inspected_module`][]: Create and inspect a temporary module with the given code.\n- [`griffe.temporary_inspected_package`][]: Create and inspect a temporary package."}]}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 157, "endlineno": 157, "analysis": "static", "path": "griffe.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Inspector": {"kind": "alias", "name": "Inspector", "target_path": "griffe._internal.agents.inspector.Inspector", "runtime": true, "inherited": false, "lineno": 159, "endlineno": 159, "analysis": "static", "path": "griffe.Inspector", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "inspect": {"kind": "alias", "name": "inspect", "target_path": "griffe._internal.agents.inspector.inspect", "runtime": true, "inherited": false, "lineno": 159, "endlineno": 159, "analysis": "static", "path": "griffe.inspect", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_instance_names": {"kind": "alias", "name": "get_instance_names", "target_path": "griffe._internal.agents.nodes.assignments.get_instance_names", "runtime": true, "inherited": false, "lineno": 160, "endlineno": 160, "analysis": "static", "path": "griffe.get_instance_names", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_name": {"kind": "alias", "name": "get_name", "target_path": "griffe._internal.agents.nodes.assignments.get_name", "runtime": true, "inherited": false, "lineno": 160, "endlineno": 160, "analysis": "static", "path": "griffe.get_name", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_names": {"kind": "alias", "name": "get_names", "target_path": "griffe._internal.agents.nodes.assignments.get_names", "runtime": true, "inherited": false, "lineno": 160, "endlineno": 160, "analysis": "static", "path": "griffe.get_names", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_children": {"kind": "alias", "name": "ast_children", "target_path": "griffe._internal.agents.nodes.ast.ast_children", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_children", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_first_child": {"kind": "alias", "name": "ast_first_child", "target_path": "griffe._internal.agents.nodes.ast.ast_first_child", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_first_child", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_kind": {"kind": "alias", "name": "ast_kind", "target_path": "griffe._internal.agents.nodes.ast.ast_kind", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_kind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_last_child": {"kind": "alias", "name": "ast_last_child", "target_path": "griffe._internal.agents.nodes.ast.ast_last_child", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_last_child", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_next": {"kind": "alias", "name": "ast_next", "target_path": "griffe._internal.agents.nodes.ast.ast_next", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_next", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_next_siblings": {"kind": "alias", "name": "ast_next_siblings", "target_path": "griffe._internal.agents.nodes.ast.ast_next_siblings", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_next_siblings", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_previous": {"kind": "alias", "name": "ast_previous", "target_path": "griffe._internal.agents.nodes.ast.ast_previous", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_previous", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_previous_siblings": {"kind": "alias", "name": "ast_previous_siblings", "target_path": "griffe._internal.agents.nodes.ast.ast_previous_siblings", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_previous_siblings", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ast_siblings": {"kind": "alias", "name": "ast_siblings", "target_path": "griffe._internal.agents.nodes.ast.ast_siblings", "runtime": true, "inherited": false, "lineno": 161, "endlineno": 171, "analysis": "static", "path": "griffe.ast_siblings", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_docstring": {"kind": "alias", "name": "get_docstring", "target_path": "griffe._internal.agents.nodes.docstrings.get_docstring", "runtime": true, "inherited": false, "lineno": 172, "endlineno": 172, "analysis": "static", "path": "griffe.get_docstring", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get__all__": {"kind": "alias", "name": "get__all__", "target_path": "griffe._internal.agents.nodes.exports.get__all__", "runtime": true, "inherited": false, "lineno": 173, "endlineno": 173, "analysis": "static", "path": "griffe.get__all__", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get__all__": {"kind": "alias", "name": "safe_get__all__", "target_path": "griffe._internal.agents.nodes.exports.safe_get__all__", "runtime": true, "inherited": false, "lineno": 173, "endlineno": 173, "analysis": "static", "path": "griffe.safe_get__all__", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "relative_to_absolute": {"kind": "alias", "name": "relative_to_absolute", "target_path": "griffe._internal.agents.nodes.imports.relative_to_absolute", "runtime": true, "inherited": false, "lineno": 174, "endlineno": 174, "analysis": "static", "path": "griffe.relative_to_absolute", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParametersType": {"kind": "alias", "name": "ParametersType", "target_path": "griffe._internal.agents.nodes.parameters.ParametersType", "runtime": true, "inherited": false, "lineno": 175, "endlineno": 175, "analysis": "static", "path": "griffe.ParametersType", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_parameters": {"kind": "alias", "name": "get_parameters", "target_path": "griffe._internal.agents.nodes.parameters.get_parameters", "runtime": true, "inherited": false, "lineno": 175, "endlineno": 175, "analysis": "static", "path": "griffe.get_parameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ObjectNode": {"kind": "alias", "name": "ObjectNode", "target_path": "griffe._internal.agents.nodes.runtime.ObjectNode", "runtime": true, "inherited": false, "lineno": 176, "endlineno": 176, "analysis": "static", "path": "griffe.ObjectNode", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_value": {"kind": "alias", "name": "get_value", "target_path": "griffe._internal.agents.nodes.values.get_value", "runtime": true, "inherited": false, "lineno": 177, "endlineno": 177, "analysis": "static", "path": "griffe.get_value", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_value": {"kind": "alias", "name": "safe_get_value", "target_path": "griffe._internal.agents.nodes.values.safe_get_value", "runtime": true, "inherited": false, "lineno": 177, "endlineno": 177, "analysis": "static", "path": "griffe.safe_get_value", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Visitor": {"kind": "alias", "name": "Visitor", "target_path": "griffe._internal.agents.visitor.Visitor", "runtime": true, "inherited": false, "lineno": 178, "endlineno": 178, "analysis": "static", "path": "griffe.Visitor", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "builtin_decorators": {"kind": "alias", "name": "builtin_decorators", "target_path": "griffe._internal.agents.visitor.builtin_decorators", "runtime": true, "inherited": false, "lineno": 178, "endlineno": 178, "analysis": "static", "path": "griffe.builtin_decorators", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "stdlib_decorators": {"kind": "alias", "name": "stdlib_decorators", "target_path": "griffe._internal.agents.visitor.stdlib_decorators", "runtime": true, "inherited": false, "lineno": 178, "endlineno": 178, "analysis": "static", "path": "griffe.stdlib_decorators", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "typing_overload": {"kind": "alias", "name": "typing_overload", "target_path": "griffe._internal.agents.visitor.typing_overload", "runtime": true, "inherited": false, "lineno": 178, "endlineno": 178, "analysis": "static", "path": "griffe.typing_overload", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "visit": {"kind": "alias", "name": "visit", "target_path": "griffe._internal.agents.visitor.visit", "runtime": true, "inherited": false, "lineno": 178, "endlineno": 178, "analysis": "static", "path": "griffe.visit", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "c3linear_merge": {"kind": "alias", "name": "c3linear_merge", "target_path": "griffe._internal.c3linear.c3linear_merge", "runtime": true, "inherited": false, "lineno": 179, "endlineno": 179, "analysis": "static", "path": "griffe.c3linear_merge", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": true, "inherited": false, "lineno": 180, "endlineno": 180, "analysis": "static", "path": "griffe.LinesCollection", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": true, "inherited": false, "lineno": 180, "endlineno": 180, "analysis": "static", "path": "griffe.ModulesCollection", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "AttributeChangedTypeBreakage": {"kind": "alias", "name": "AttributeChangedTypeBreakage", "target_path": "griffe._internal.diff.AttributeChangedTypeBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.AttributeChangedTypeBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "AttributeChangedValueBreakage": {"kind": "alias", "name": "AttributeChangedValueBreakage", "target_path": "griffe._internal.diff.AttributeChangedValueBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.AttributeChangedValueBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Breakage": {"kind": "alias", "name": "Breakage", "target_path": "griffe._internal.diff.Breakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.Breakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ClassRemovedBaseBreakage": {"kind": "alias", "name": "ClassRemovedBaseBreakage", "target_path": "griffe._internal.diff.ClassRemovedBaseBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ClassRemovedBaseBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ObjectChangedKindBreakage": {"kind": "alias", "name": "ObjectChangedKindBreakage", "target_path": "griffe._internal.diff.ObjectChangedKindBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ObjectChangedKindBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ObjectRemovedBreakage": {"kind": "alias", "name": "ObjectRemovedBreakage", "target_path": "griffe._internal.diff.ObjectRemovedBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ObjectRemovedBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterAddedRequiredBreakage": {"kind": "alias", "name": "ParameterAddedRequiredBreakage", "target_path": "griffe._internal.diff.ParameterAddedRequiredBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterAddedRequiredBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterChangedDefaultBreakage": {"kind": "alias", "name": "ParameterChangedDefaultBreakage", "target_path": "griffe._internal.diff.ParameterChangedDefaultBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterChangedDefaultBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterChangedKindBreakage": {"kind": "alias", "name": "ParameterChangedKindBreakage", "target_path": "griffe._internal.diff.ParameterChangedKindBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterChangedKindBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterChangedRequiredBreakage": {"kind": "alias", "name": "ParameterChangedRequiredBreakage", "target_path": "griffe._internal.diff.ParameterChangedRequiredBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterChangedRequiredBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterMovedBreakage": {"kind": "alias", "name": "ParameterMovedBreakage", "target_path": "griffe._internal.diff.ParameterMovedBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterMovedBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterRemovedBreakage": {"kind": "alias", "name": "ParameterRemovedBreakage", "target_path": "griffe._internal.diff.ParameterRemovedBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ParameterRemovedBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ReturnChangedTypeBreakage": {"kind": "alias", "name": "ReturnChangedTypeBreakage", "target_path": "griffe._internal.diff.ReturnChangedTypeBreakage", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.ReturnChangedTypeBreakage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "find_breaking_changes": {"kind": "alias", "name": "find_breaking_changes", "target_path": "griffe._internal.diff.find_breaking_changes", "runtime": true, "inherited": false, "lineno": 181, "endlineno": 196, "analysis": "static", "path": "griffe.find_breaking_changes", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "AutoOptions": {"kind": "alias", "name": "AutoOptions", "target_path": "griffe._internal.docstrings.auto.AutoOptions", "runtime": true, "inherited": false, "lineno": 197, "endlineno": 203, "analysis": "static", "path": "griffe.AutoOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringDetectionMethod": {"kind": "alias", "name": "DocstringDetectionMethod", "target_path": "griffe._internal.docstrings.auto.DocstringDetectionMethod", "runtime": true, "inherited": false, "lineno": 197, "endlineno": 203, "analysis": "static", "path": "griffe.DocstringDetectionMethod", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "PerStyleOptions": {"kind": "alias", "name": "PerStyleOptions", "target_path": "griffe._internal.docstrings.auto.PerStyleOptions", "runtime": true, "inherited": false, "lineno": 197, "endlineno": 203, "analysis": "static", "path": "griffe.PerStyleOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "infer_docstring_style": {"kind": "alias", "name": "infer_docstring_style", "target_path": "griffe._internal.docstrings.auto.infer_docstring_style", "runtime": true, "inherited": false, "lineno": 197, "endlineno": 203, "analysis": "static", "path": "griffe.infer_docstring_style", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse_auto": {"kind": "alias", "name": "parse_auto", "target_path": "griffe._internal.docstrings.auto.parse_auto", "runtime": true, "inherited": false, "lineno": 197, "endlineno": 203, "analysis": "static", "path": "griffe.parse_auto", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GoogleOptions": {"kind": "alias", "name": "GoogleOptions", "target_path": "griffe._internal.docstrings.google.GoogleOptions", "runtime": true, "inherited": false, "lineno": 204, "endlineno": 204, "analysis": "static", "path": "griffe.GoogleOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse_google": {"kind": "alias", "name": "parse_google", "target_path": "griffe._internal.docstrings.google.parse_google", "runtime": true, "inherited": false, "lineno": 204, "endlineno": 204, "analysis": "static", "path": "griffe.parse_google", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringAdmonition": {"kind": "alias", "name": "DocstringAdmonition", "target_path": "griffe._internal.docstrings.models.DocstringAdmonition", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringAdmonition", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringAttribute": {"kind": "alias", "name": "DocstringAttribute", "target_path": "griffe._internal.docstrings.models.DocstringAttribute", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringAttribute", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringClass": {"kind": "alias", "name": "DocstringClass", "target_path": "griffe._internal.docstrings.models.DocstringClass", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringClass", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringDeprecated": {"kind": "alias", "name": "DocstringDeprecated", "target_path": "griffe._internal.docstrings.models.DocstringDeprecated", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringDeprecated", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringElement": {"kind": "alias", "name": "DocstringElement", "target_path": "griffe._internal.docstrings.models.DocstringElement", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringElement", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringFunction": {"kind": "alias", "name": "DocstringFunction", "target_path": "griffe._internal.docstrings.models.DocstringFunction", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringFunction", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringModule": {"kind": "alias", "name": "DocstringModule", "target_path": "griffe._internal.docstrings.models.DocstringModule", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringModule", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringNamedElement": {"kind": "alias", "name": "DocstringNamedElement", "target_path": "griffe._internal.docstrings.models.DocstringNamedElement", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringNamedElement", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringParameter": {"kind": "alias", "name": "DocstringParameter", "target_path": "griffe._internal.docstrings.models.DocstringParameter", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringParameter", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringRaise": {"kind": "alias", "name": "DocstringRaise", "target_path": "griffe._internal.docstrings.models.DocstringRaise", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringRaise", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringReceive": {"kind": "alias", "name": "DocstringReceive", "target_path": "griffe._internal.docstrings.models.DocstringReceive", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringReceive", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringReturn": {"kind": "alias", "name": "DocstringReturn", "target_path": "griffe._internal.docstrings.models.DocstringReturn", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringReturn", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSection", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionAdmonition": {"kind": "alias", "name": "DocstringSectionAdmonition", "target_path": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionAdmonition", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionAttributes": {"kind": "alias", "name": "DocstringSectionAttributes", "target_path": "griffe._internal.docstrings.models.DocstringSectionAttributes", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionAttributes", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionClasses": {"kind": "alias", "name": "DocstringSectionClasses", "target_path": "griffe._internal.docstrings.models.DocstringSectionClasses", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionClasses", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionDeprecated": {"kind": "alias", "name": "DocstringSectionDeprecated", "target_path": "griffe._internal.docstrings.models.DocstringSectionDeprecated", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionDeprecated", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionExamples": {"kind": "alias", "name": "DocstringSectionExamples", "target_path": "griffe._internal.docstrings.models.DocstringSectionExamples", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionExamples", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionFunctions": {"kind": "alias", "name": "DocstringSectionFunctions", "target_path": "griffe._internal.docstrings.models.DocstringSectionFunctions", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionFunctions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionModules": {"kind": "alias", "name": "DocstringSectionModules", "target_path": "griffe._internal.docstrings.models.DocstringSectionModules", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionModules", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionOtherParameters": {"kind": "alias", "name": "DocstringSectionOtherParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionOtherParameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionParameters": {"kind": "alias", "name": "DocstringSectionParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionParameters", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionParameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionRaises": {"kind": "alias", "name": "DocstringSectionRaises", "target_path": "griffe._internal.docstrings.models.DocstringSectionRaises", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionRaises", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionReceives": {"kind": "alias", "name": "DocstringSectionReceives", "target_path": "griffe._internal.docstrings.models.DocstringSectionReceives", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionReceives", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionReturns": {"kind": "alias", "name": "DocstringSectionReturns", "target_path": "griffe._internal.docstrings.models.DocstringSectionReturns", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionReturns", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionText": {"kind": "alias", "name": "DocstringSectionText", "target_path": "griffe._internal.docstrings.models.DocstringSectionText", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionText", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionTypeAliases": {"kind": "alias", "name": "DocstringSectionTypeAliases", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionTypeAliases", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionTypeParameters": {"kind": "alias", "name": "DocstringSectionTypeParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionTypeParameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionWarns": {"kind": "alias", "name": "DocstringSectionWarns", "target_path": "griffe._internal.docstrings.models.DocstringSectionWarns", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionWarns", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionYields": {"kind": "alias", "name": "DocstringSectionYields", "target_path": "griffe._internal.docstrings.models.DocstringSectionYields", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringSectionYields", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringTypeAlias": {"kind": "alias", "name": "DocstringTypeAlias", "target_path": "griffe._internal.docstrings.models.DocstringTypeAlias", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringTypeAlias", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringTypeParameter": {"kind": "alias", "name": "DocstringTypeParameter", "target_path": "griffe._internal.docstrings.models.DocstringTypeParameter", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringTypeParameter", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringWarn": {"kind": "alias", "name": "DocstringWarn", "target_path": "griffe._internal.docstrings.models.DocstringWarn", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringWarn", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringYield": {"kind": "alias", "name": "DocstringYield", "target_path": "griffe._internal.docstrings.models.DocstringYield", "runtime": true, "inherited": false, "lineno": 205, "endlineno": 240, "analysis": "static", "path": "griffe.DocstringYield", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "NumpyOptions": {"kind": "alias", "name": "NumpyOptions", "target_path": "griffe._internal.docstrings.numpy.NumpyOptions", "runtime": true, "inherited": false, "lineno": 241, "endlineno": 241, "analysis": "static", "path": "griffe.NumpyOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse_numpy": {"kind": "alias", "name": "parse_numpy", "target_path": "griffe._internal.docstrings.numpy.parse_numpy", "runtime": true, "inherited": false, "lineno": 241, "endlineno": 241, "analysis": "static", "path": "griffe.parse_numpy", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": true, "inherited": false, "lineno": 242, "endlineno": 247, "analysis": "static", "path": "griffe.DocstringOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": true, "inherited": false, "lineno": 242, "endlineno": 247, "analysis": "static", "path": "griffe.DocstringStyle", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse": {"kind": "alias", "name": "parse", "target_path": "griffe._internal.docstrings.parsers.parse", "runtime": true, "inherited": false, "lineno": 242, "endlineno": 247, "analysis": "static", "path": "griffe.parse", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parsers": {"kind": "alias", "name": "parsers", "target_path": "griffe._internal.docstrings.parsers.parsers", "runtime": true, "inherited": false, "lineno": 242, "endlineno": 247, "analysis": "static", "path": "griffe.parsers", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "SphinxOptions": {"kind": "alias", "name": "SphinxOptions", "target_path": "griffe._internal.docstrings.sphinx.SphinxOptions", "runtime": true, "inherited": false, "lineno": 248, "endlineno": 248, "analysis": "static", "path": "griffe.SphinxOptions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse_sphinx": {"kind": "alias", "name": "parse_sphinx", "target_path": "griffe._internal.docstrings.sphinx.parse_sphinx", "runtime": true, "inherited": false, "lineno": 248, "endlineno": 248, "analysis": "static", "path": "griffe.parse_sphinx", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "docstring_warning": {"kind": "alias", "name": "docstring_warning", "target_path": "griffe._internal.docstrings.utils.docstring_warning", "runtime": true, "inherited": false, "lineno": 249, "endlineno": 249, "analysis": "static", "path": "griffe.docstring_warning", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "parse_docstring_annotation": {"kind": "alias", "name": "parse_docstring_annotation", "target_path": "griffe._internal.docstrings.utils.parse_docstring_annotation", "runtime": true, "inherited": false, "lineno": 249, "endlineno": 249, "analysis": "static", "path": "griffe.parse_docstring_annotation", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "JSONEncoder": {"kind": "alias", "name": "JSONEncoder", "target_path": "griffe._internal.encoders.JSONEncoder", "runtime": true, "inherited": false, "lineno": 250, "endlineno": 250, "analysis": "static", "path": "griffe.JSONEncoder", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "json_decoder": {"kind": "alias", "name": "json_decoder", "target_path": "griffe._internal.encoders.json_decoder", "runtime": true, "inherited": false, "lineno": 250, "endlineno": 250, "analysis": "static", "path": "griffe.json_decoder", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "BreakageKind": {"kind": "alias", "name": "BreakageKind", "target_path": "griffe._internal.enumerations.BreakageKind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.BreakageKind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DocstringSectionKind": {"kind": "alias", "name": "DocstringSectionKind", "target_path": "griffe._internal.enumerations.DocstringSectionKind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.DocstringSectionKind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExplanationStyle": {"kind": "alias", "name": "ExplanationStyle", "target_path": "griffe._internal.enumerations.ExplanationStyle", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.ExplanationStyle", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.Kind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.LogLevel", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ObjectKind": {"kind": "alias", "name": "ObjectKind", "target_path": "griffe._internal.enumerations.ObjectKind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.ObjectKind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.ParameterKind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.Parser", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "TypeParameterKind": {"kind": "alias", "name": "TypeParameterKind", "target_path": "griffe._internal.enumerations.TypeParameterKind", "runtime": true, "inherited": false, "lineno": 251, "endlineno": 261, "analysis": "static", "path": "griffe.TypeParameterKind", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.AliasResolutionError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "BuiltinModuleError": {"kind": "alias", "name": "BuiltinModuleError", "target_path": "griffe._internal.exceptions.BuiltinModuleError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.BuiltinModuleError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.CyclicAliasError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExtensionError": {"kind": "alias", "name": "ExtensionError", "target_path": "griffe._internal.exceptions.ExtensionError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.ExtensionError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExtensionNotLoadedError": {"kind": "alias", "name": "ExtensionNotLoadedError", "target_path": "griffe._internal.exceptions.ExtensionNotLoadedError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.ExtensionNotLoadedError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GitError": {"kind": "alias", "name": "GitError", "target_path": "griffe._internal.exceptions.GitError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.GitError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GriffeError": {"kind": "alias", "name": "GriffeError", "target_path": "griffe._internal.exceptions.GriffeError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.GriffeError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "LastNodeError": {"kind": "alias", "name": "LastNodeError", "target_path": "griffe._internal.exceptions.LastNodeError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.LastNodeError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "LoadingError": {"kind": "alias", "name": "LoadingError", "target_path": "griffe._internal.exceptions.LoadingError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.LoadingError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "NameResolutionError": {"kind": "alias", "name": "NameResolutionError", "target_path": "griffe._internal.exceptions.NameResolutionError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.NameResolutionError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "RootNodeError": {"kind": "alias", "name": "RootNodeError", "target_path": "griffe._internal.exceptions.RootNodeError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.RootNodeError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "UnhandledEditableModuleError": {"kind": "alias", "name": "UnhandledEditableModuleError", "target_path": "griffe._internal.exceptions.UnhandledEditableModuleError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.UnhandledEditableModuleError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "UnimportableModuleError": {"kind": "alias", "name": "UnimportableModuleError", "target_path": "griffe._internal.exceptions.UnimportableModuleError", "runtime": true, "inherited": false, "lineno": 262, "endlineno": 276, "analysis": "static", "path": "griffe.UnimportableModuleError", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.Expr", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprAttribute": {"kind": "alias", "name": "ExprAttribute", "target_path": "griffe._internal.expressions.ExprAttribute", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprAttribute", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprBinOp": {"kind": "alias", "name": "ExprBinOp", "target_path": "griffe._internal.expressions.ExprBinOp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprBinOp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprBoolOp": {"kind": "alias", "name": "ExprBoolOp", "target_path": "griffe._internal.expressions.ExprBoolOp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprBoolOp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprCall": {"kind": "alias", "name": "ExprCall", "target_path": "griffe._internal.expressions.ExprCall", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprCall", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprCompare": {"kind": "alias", "name": "ExprCompare", "target_path": "griffe._internal.expressions.ExprCompare", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprCompare", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprComprehension": {"kind": "alias", "name": "ExprComprehension", "target_path": "griffe._internal.expressions.ExprComprehension", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprComprehension", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprConstant": {"kind": "alias", "name": "ExprConstant", "target_path": "griffe._internal.expressions.ExprConstant", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprConstant", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprDict": {"kind": "alias", "name": "ExprDict", "target_path": "griffe._internal.expressions.ExprDict", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprDict", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprDictComp": {"kind": "alias", "name": "ExprDictComp", "target_path": "griffe._internal.expressions.ExprDictComp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprDictComp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprExtSlice": {"kind": "alias", "name": "ExprExtSlice", "target_path": "griffe._internal.expressions.ExprExtSlice", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprExtSlice", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprFormatted": {"kind": "alias", "name": "ExprFormatted", "target_path": "griffe._internal.expressions.ExprFormatted", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprFormatted", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprGeneratorExp": {"kind": "alias", "name": "ExprGeneratorExp", "target_path": "griffe._internal.expressions.ExprGeneratorExp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprGeneratorExp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprIfExp": {"kind": "alias", "name": "ExprIfExp", "target_path": "griffe._internal.expressions.ExprIfExp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprIfExp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprInterpolation": {"kind": "alias", "name": "ExprInterpolation", "target_path": "griffe._internal.expressions.ExprInterpolation", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprInterpolation", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprJoinedStr": {"kind": "alias", "name": "ExprJoinedStr", "target_path": "griffe._internal.expressions.ExprJoinedStr", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprJoinedStr", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprKeyword": {"kind": "alias", "name": "ExprKeyword", "target_path": "griffe._internal.expressions.ExprKeyword", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprKeyword", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprLambda": {"kind": "alias", "name": "ExprLambda", "target_path": "griffe._internal.expressions.ExprLambda", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprLambda", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprList": {"kind": "alias", "name": "ExprList", "target_path": "griffe._internal.expressions.ExprList", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprList", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprListComp": {"kind": "alias", "name": "ExprListComp", "target_path": "griffe._internal.expressions.ExprListComp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprListComp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprName", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprNamedExpr": {"kind": "alias", "name": "ExprNamedExpr", "target_path": "griffe._internal.expressions.ExprNamedExpr", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprNamedExpr", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprParameter": {"kind": "alias", "name": "ExprParameter", "target_path": "griffe._internal.expressions.ExprParameter", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprParameter", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprSet": {"kind": "alias", "name": "ExprSet", "target_path": "griffe._internal.expressions.ExprSet", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprSet", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprSetComp": {"kind": "alias", "name": "ExprSetComp", "target_path": "griffe._internal.expressions.ExprSetComp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprSetComp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprSlice": {"kind": "alias", "name": "ExprSlice", "target_path": "griffe._internal.expressions.ExprSlice", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprSlice", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprSubscript": {"kind": "alias", "name": "ExprSubscript", "target_path": "griffe._internal.expressions.ExprSubscript", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprSubscript", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprTemplateStr": {"kind": "alias", "name": "ExprTemplateStr", "target_path": "griffe._internal.expressions.ExprTemplateStr", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprTemplateStr", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprTuple": {"kind": "alias", "name": "ExprTuple", "target_path": "griffe._internal.expressions.ExprTuple", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprTuple", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprUnaryOp": {"kind": "alias", "name": "ExprUnaryOp", "target_path": "griffe._internal.expressions.ExprUnaryOp", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprUnaryOp", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprVarKeyword": {"kind": "alias", "name": "ExprVarKeyword", "target_path": "griffe._internal.expressions.ExprVarKeyword", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprVarKeyword", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprVarPositional": {"kind": "alias", "name": "ExprVarPositional", "target_path": "griffe._internal.expressions.ExprVarPositional", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprVarPositional", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprYield": {"kind": "alias", "name": "ExprYield", "target_path": "griffe._internal.expressions.ExprYield", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprYield", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ExprYieldFrom": {"kind": "alias", "name": "ExprYieldFrom", "target_path": "griffe._internal.expressions.ExprYieldFrom", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.ExprYieldFrom", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_annotation": {"kind": "alias", "name": "get_annotation", "target_path": "griffe._internal.expressions.get_annotation", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.get_annotation", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_base_class": {"kind": "alias", "name": "get_base_class", "target_path": "griffe._internal.expressions.get_base_class", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.get_base_class", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_class_keyword": {"kind": "alias", "name": "get_class_keyword", "target_path": "griffe._internal.expressions.get_class_keyword", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.get_class_keyword", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_condition": {"kind": "alias", "name": "get_condition", "target_path": "griffe._internal.expressions.get_condition", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.get_condition", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_expression": {"kind": "alias", "name": "get_expression", "target_path": "griffe._internal.expressions.get_expression", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.get_expression", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_annotation": {"kind": "alias", "name": "safe_get_annotation", "target_path": "griffe._internal.expressions.safe_get_annotation", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.safe_get_annotation", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_base_class": {"kind": "alias", "name": "safe_get_base_class", "target_path": "griffe._internal.expressions.safe_get_base_class", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.safe_get_base_class", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_class_keyword": {"kind": "alias", "name": "safe_get_class_keyword", "target_path": "griffe._internal.expressions.safe_get_class_keyword", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.safe_get_class_keyword", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_condition": {"kind": "alias", "name": "safe_get_condition", "target_path": "griffe._internal.expressions.safe_get_condition", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.safe_get_condition", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "safe_get_expression": {"kind": "alias", "name": "safe_get_expression", "target_path": "griffe._internal.expressions.safe_get_expression", "runtime": true, "inherited": false, "lineno": 277, "endlineno": 322, "analysis": "static", "path": "griffe.safe_get_expression", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Extension": {"kind": "alias", "name": "Extension", "target_path": "griffe._internal.extensions.base.Extension", "runtime": true, "inherited": false, "lineno": 323, "endlineno": 329, "analysis": "static", "path": "griffe.Extension", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Extensions": {"kind": "alias", "name": "Extensions", "target_path": "griffe._internal.extensions.base.Extensions", "runtime": true, "inherited": false, "lineno": 323, "endlineno": 329, "analysis": "static", "path": "griffe.Extensions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "LoadableExtensionType": {"kind": "alias", "name": "LoadableExtensionType", "target_path": "griffe._internal.extensions.base.LoadableExtensionType", "runtime": true, "inherited": false, "lineno": 323, "endlineno": 329, "analysis": "static", "path": "griffe.LoadableExtensionType", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "builtin_extensions": {"kind": "alias", "name": "builtin_extensions", "target_path": "griffe._internal.extensions.base.builtin_extensions", "runtime": true, "inherited": false, "lineno": 323, "endlineno": 329, "analysis": "static", "path": "griffe.builtin_extensions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "load_extensions": {"kind": "alias", "name": "load_extensions", "target_path": "griffe._internal.extensions.base.load_extensions", "runtime": true, "inherited": false, "lineno": 323, "endlineno": 329, "analysis": "static", "path": "griffe.load_extensions", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DataclassesExtension": {"kind": "alias", "name": "DataclassesExtension", "target_path": "griffe._internal.extensions.dataclasses.DataclassesExtension", "runtime": true, "inherited": false, "lineno": 330, "endlineno": 330, "analysis": "static", "path": "griffe.DataclassesExtension", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "UnpackTypedDictExtension": {"kind": "alias", "name": "UnpackTypedDictExtension", "target_path": "griffe._internal.extensions.unpack_typeddict.UnpackTypedDictExtension", "runtime": true, "inherited": false, "lineno": 331, "endlineno": 331, "analysis": "static", "path": "griffe.UnpackTypedDictExtension", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ModuleFinder": {"kind": "alias", "name": "ModuleFinder", "target_path": "griffe._internal.finder.ModuleFinder", "runtime": true, "inherited": false, "lineno": 332, "endlineno": 332, "analysis": "static", "path": "griffe.ModuleFinder", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "NamePartsAndPathType": {"kind": "alias", "name": "NamePartsAndPathType", "target_path": "griffe._internal.finder.NamePartsAndPathType", "runtime": true, "inherited": false, "lineno": 332, "endlineno": 332, "analysis": "static", "path": "griffe.NamePartsAndPathType", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "NamePartsType": {"kind": "alias", "name": "NamePartsType", "target_path": "griffe._internal.finder.NamePartsType", "runtime": true, "inherited": false, "lineno": 332, "endlineno": 332, "analysis": "static", "path": "griffe.NamePartsType", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "NamespacePackage": {"kind": "alias", "name": "NamespacePackage", "target_path": "griffe._internal.finder.NamespacePackage", "runtime": true, "inherited": false, "lineno": 332, "endlineno": 332, "analysis": "static", "path": "griffe.NamespacePackage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Package": {"kind": "alias", "name": "Package", "target_path": "griffe._internal.finder.Package", "runtime": true, "inherited": false, "lineno": 332, "endlineno": 332, "analysis": "static", "path": "griffe.Package", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GitInfo": {"kind": "alias", "name": "GitInfo", "target_path": "griffe._internal.git.GitInfo", "runtime": true, "inherited": false, "lineno": 333, "endlineno": 333, "analysis": "static", "path": "griffe.GitInfo", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "KnownGitService": {"kind": "alias", "name": "KnownGitService", "target_path": "griffe._internal.git.KnownGitService", "runtime": true, "inherited": false, "lineno": 333, "endlineno": 333, "analysis": "static", "path": "griffe.KnownGitService", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "dynamic_import": {"kind": "alias", "name": "dynamic_import", "target_path": "griffe._internal.importer.dynamic_import", "runtime": true, "inherited": false, "lineno": 334, "endlineno": 334, "analysis": "static", "path": "griffe.dynamic_import", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "sys_path": {"kind": "alias", "name": "sys_path", "target_path": "griffe._internal.importer.sys_path", "runtime": true, "inherited": false, "lineno": 334, "endlineno": 334, "analysis": "static", "path": "griffe.sys_path", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GriffeLoader": {"kind": "alias", "name": "GriffeLoader", "target_path": "griffe._internal.loader.GriffeLoader", "runtime": true, "inherited": false, "lineno": 335, "endlineno": 335, "analysis": "static", "path": "griffe.GriffeLoader", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "load": {"kind": "alias", "name": "load", "target_path": "griffe._internal.loader.load", "runtime": true, "inherited": false, "lineno": 335, "endlineno": 335, "analysis": "static", "path": "griffe.load", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "load_git": {"kind": "alias", "name": "load_git", "target_path": "griffe._internal.loader.load_git", "runtime": true, "inherited": false, "lineno": 335, "endlineno": 335, "analysis": "static", "path": "griffe.load_git", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "load_pypi": {"kind": "alias", "name": "load_pypi", "target_path": "griffe._internal.loader.load_pypi", "runtime": true, "inherited": false, "lineno": 335, "endlineno": 335, "analysis": "static", "path": "griffe.load_pypi", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Logger": {"kind": "alias", "name": "Logger", "target_path": "griffe._internal.logger.Logger", "runtime": true, "inherited": false, "lineno": 336, "endlineno": 336, "analysis": "static", "path": "griffe.Logger", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "get_logger": {"kind": "alias", "name": "get_logger", "target_path": "griffe._internal.logger.get_logger", "runtime": true, "inherited": false, "lineno": 336, "endlineno": 336, "analysis": "static", "path": "griffe.get_logger", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 336, "endlineno": 336, "analysis": "static", "path": "griffe.logger", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "patch_loggers": {"kind": "alias", "name": "patch_loggers", "target_path": "griffe._internal.logger.patch_loggers", "runtime": true, "inherited": false, "lineno": 336, "endlineno": 336, "analysis": "static", "path": "griffe.patch_loggers", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "merge_stubs": {"kind": "alias", "name": "merge_stubs", "target_path": "griffe._internal.merger.merge_stubs", "runtime": true, "inherited": false, "lineno": 337, "endlineno": 337, "analysis": "static", "path": "griffe.merge_stubs", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "DelMembersMixin": {"kind": "alias", "name": "DelMembersMixin", "target_path": "griffe._internal.mixins.DelMembersMixin", "runtime": true, "inherited": false, "lineno": 338, "endlineno": 344, "analysis": "static", "path": "griffe.DelMembersMixin", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "GetMembersMixin": {"kind": "alias", "name": "GetMembersMixin", "target_path": "griffe._internal.mixins.GetMembersMixin", "runtime": true, "inherited": false, "lineno": 338, "endlineno": 344, "analysis": "static", "path": "griffe.GetMembersMixin", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "ObjectAliasMixin": {"kind": "alias", "name": "ObjectAliasMixin", "target_path": "griffe._internal.mixins.ObjectAliasMixin", "runtime": true, "inherited": false, "lineno": 338, "endlineno": 344, "analysis": "static", "path": "griffe.ObjectAliasMixin", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "SerializationMixin": {"kind": "alias", "name": "SerializationMixin", "target_path": "griffe._internal.mixins.SerializationMixin", "runtime": true, "inherited": false, "lineno": 338, "endlineno": 344, "analysis": "static", "path": "griffe.SerializationMixin", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "SetMembersMixin": {"kind": "alias", "name": "SetMembersMixin", "target_path": "griffe._internal.mixins.SetMembersMixin", "runtime": true, "inherited": false, "lineno": 338, "endlineno": 344, "analysis": "static", "path": "griffe.SetMembersMixin", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Alias", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Attribute", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Class", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Decorator": {"kind": "alias", "name": "Decorator", "target_path": "griffe._internal.models.Decorator", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Decorator", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Docstring", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Function", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Module", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Object", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Parameter", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.Parameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.TypeAlias", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "TypeParameter": {"kind": "alias", "name": "TypeParameter", "target_path": "griffe._internal.models.TypeParameter", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.TypeParameter", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "TypeParameters": {"kind": "alias", "name": "TypeParameters", "target_path": "griffe._internal.models.TypeParameters", "runtime": true, "inherited": false, "lineno": 345, "endlineno": 359, "analysis": "static", "path": "griffe.TypeParameters", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "Stats": {"kind": "alias", "name": "Stats", "target_path": "griffe._internal.stats.Stats", "runtime": true, "inherited": false, "lineno": 360, "endlineno": 360, "analysis": "static", "path": "griffe.Stats", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "TmpPackage": {"kind": "alias", "name": "TmpPackage", "target_path": "griffe._internal.tests.TmpPackage", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.TmpPackage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "htree": {"kind": "alias", "name": "htree", "target_path": "griffe._internal.tests.htree", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.htree", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "module_vtree": {"kind": "alias", "name": "module_vtree", "target_path": "griffe._internal.tests.module_vtree", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.module_vtree", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_inspected_module": {"kind": "alias", "name": "temporary_inspected_module", "target_path": "griffe._internal.tests.temporary_inspected_module", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_inspected_module", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_inspected_package": {"kind": "alias", "name": "temporary_inspected_package", "target_path": "griffe._internal.tests.temporary_inspected_package", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_inspected_package", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_pyfile": {"kind": "alias", "name": "temporary_pyfile", "target_path": "griffe._internal.tests.temporary_pyfile", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_pyfile", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_pypackage": {"kind": "alias", "name": "temporary_pypackage", "target_path": "griffe._internal.tests.temporary_pypackage", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_pypackage", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_visited_module": {"kind": "alias", "name": "temporary_visited_module", "target_path": "griffe._internal.tests.temporary_visited_module", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_visited_module", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "temporary_visited_package": {"kind": "alias", "name": "temporary_visited_package", "target_path": "griffe._internal.tests.temporary_visited_package", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.temporary_visited_package", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "vtree": {"kind": "alias", "name": "vtree", "target_path": "griffe._internal.tests.vtree", "runtime": true, "inherited": false, "lineno": 361, "endlineno": 372, "analysis": "static", "path": "griffe.vtree", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": true, "is_wildcard_exposed": true}, "__all__": {"kind": "attribute", "name": "__all__", "runtime": true, "lineno": 378, "endlineno": 597, "labels": ["module-attribute"], "analysis": "static", "path": "griffe.__all__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__init__.py", "relative_package_filepath": "griffe/__init__.py", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__init__.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/__init__.py#L378-L597", "value": {"elements": ["'Alias'", "'AliasResolutionError'", "'Attribute'", "'AttributeChangedTypeBreakage'", "'AttributeChangedValueBreakage'", "'AutoOptions'", "'Breakage'", "'BreakageKind'", "'BuiltinModuleError'", "'Class'", "'ClassRemovedBaseBreakage'", "'CyclicAliasError'", "'DataclassesExtension'", "'Decorator'", "'DelMembersMixin'", "'Docstring'", "'DocstringAdmonition'", "'DocstringAttribute'", "'DocstringClass'", "'DocstringDeprecated'", "'DocstringDetectionMethod'", "'DocstringElement'", "'DocstringFunction'", "'DocstringModule'", "'DocstringNamedElement'", "'DocstringOptions'", "'DocstringParameter'", "'DocstringRaise'", "'DocstringReceive'", "'DocstringReturn'", "'DocstringSection'", "'DocstringSectionAdmonition'", "'DocstringSectionAttributes'", "'DocstringSectionClasses'", "'DocstringSectionDeprecated'", "'DocstringSectionExamples'", "'DocstringSectionFunctions'", "'DocstringSectionKind'", "'DocstringSectionModules'", "'DocstringSectionOtherParameters'", "'DocstringSectionParameters'", "'DocstringSectionRaises'", "'DocstringSectionReceives'", "'DocstringSectionReturns'", "'DocstringSectionText'", "'DocstringSectionTypeAliases'", "'DocstringSectionTypeParameters'", "'DocstringSectionWarns'", "'DocstringSectionYields'", "'DocstringStyle'", "'DocstringTypeAlias'", "'DocstringTypeParameter'", "'DocstringWarn'", "'DocstringYield'", "'ExplanationStyle'", "'Expr'", "'ExprAttribute'", "'ExprBinOp'", "'ExprBoolOp'", "'ExprCall'", "'ExprCompare'", "'ExprComprehension'", "'ExprConstant'", "'ExprDict'", "'ExprDictComp'", "'ExprExtSlice'", "'ExprFormatted'", "'ExprGeneratorExp'", "'ExprIfExp'", "'ExprInterpolation'", "'ExprJoinedStr'", "'ExprKeyword'", "'ExprLambda'", "'ExprList'", "'ExprListComp'", "'ExprName'", "'ExprNamedExpr'", "'ExprParameter'", "'ExprSet'", "'ExprSetComp'", "'ExprSlice'", "'ExprSubscript'", "'ExprTemplateStr'", "'ExprTuple'", "'ExprUnaryOp'", "'ExprVarKeyword'", "'ExprVarPositional'", "'ExprYield'", "'ExprYieldFrom'", "'Extension'", "'ExtensionError'", "'ExtensionNotLoadedError'", "'Extensions'", "'Function'", "'GetMembersMixin'", "'GitError'", "'GitInfo'", "'GoogleOptions'", "'GriffeError'", "'GriffeLoader'", "'Inspector'", "'JSONEncoder'", "'Kind'", "'KnownGitService'", "'LastNodeError'", "'LinesCollection'", "'LoadableExtensionType'", "'LoadingError'", "'LogLevel'", "'Logger'", "'Module'", "'ModuleFinder'", "'ModulesCollection'", "'NamePartsAndPathType'", "'NamePartsType'", "'NameResolutionError'", "'NamespacePackage'", "'NumpyOptions'", "'Object'", "'ObjectAliasMixin'", "'ObjectChangedKindBreakage'", "'ObjectKind'", "'ObjectNode'", "'ObjectRemovedBreakage'", "'Package'", "'Parameter'", "'ParameterAddedRequiredBreakage'", "'ParameterChangedDefaultBreakage'", "'ParameterChangedKindBreakage'", "'ParameterChangedRequiredBreakage'", "'ParameterKind'", "'ParameterMovedBreakage'", "'ParameterRemovedBreakage'", "'Parameters'", "'ParametersType'", "'Parser'", "'PerStyleOptions'", "'ReturnChangedTypeBreakage'", "'RootNodeError'", "'SerializationMixin'", "'SetMembersMixin'", "'SphinxOptions'", "'Stats'", "'TmpPackage'", "'TypeAlias'", "'TypeParameter'", "'TypeParameterKind'", "'TypeParameters'", "'UnhandledEditableModuleError'", "'UnimportableModuleError'", "'UnpackTypedDictExtension'", "'Visitor'", "'ast_children'", "'ast_first_child'", "'ast_kind'", "'ast_last_child'", "'ast_next'", "'ast_next_siblings'", "'ast_previous'", "'ast_previous_siblings'", "'ast_siblings'", "'builtin_decorators'", "'builtin_extensions'", "'c3linear_merge'", "'docstring_warning'", "'dynamic_import'", "'find_breaking_changes'", "'get__all__'", "'get_annotation'", "'get_base_class'", "'get_class_keyword'", "'get_condition'", "'get_docstring'", "'get_expression'", "'get_instance_names'", "'get_logger'", "'get_name'", "'get_names'", "'get_parameters'", "'get_value'", "'htree'", "'infer_docstring_style'", "'inspect'", "'json_decoder'", "'load'", "'load_extensions'", "'load_git'", "'load_pypi'", "'logger'", "'merge_stubs'", "'module_vtree'", "'parse'", "'parse_auto'", "'parse_docstring_annotation'", "'parse_google'", "'parse_numpy'", "'parse_sphinx'", "'parsers'", "'patch_loggers'", "'relative_to_absolute'", "'safe_get__all__'", "'safe_get_annotation'", "'safe_get_base_class'", "'safe_get_class_keyword'", "'safe_get_condition'", "'safe_get_expression'", "'safe_get_value'", "'stdlib_decorators'", "'sys_path'", "'temporary_inspected_module'", "'temporary_inspected_package'", "'temporary_pyfile'", "'temporary_pypackage'", "'temporary_visited_module'", "'temporary_visited_package'", "'typing_overload'", "'visit'", "'vtree'"], "cls": "ExprList"}}, "griffecli/*": {"kind": "alias", "name": "griffecli/*", "target_path": "griffecli", "runtime": true, "inherited": false, "lineno": 601, "endlineno": 601, "analysis": "static", "path": "griffe.griffecli/*", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false}, "__cli_all__": {"kind": "alias", "name": "__cli_all__", "target_path": "griffecli.__all__", "runtime": true, "inherited": false, "lineno": 602, "endlineno": 602, "analysis": "static", "path": "griffe.__cli_all__", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_MISSING_FROM_GRIFFECLI": {"kind": "attribute", "name": "_MISSING_FROM_GRIFFECLI", "runtime": true, "lineno": 605, "endlineno": 611, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._MISSING_FROM_GRIFFECLI", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__init__.py", "relative_package_filepath": "griffe/__init__.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__init__.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/__init__.py#L605-L611", "value": {"elements": ["'DEFAULT_LOG_LEVEL'", "'check'", "'dump'", "'get_parser'", "'main'"], "cls": "ExprSet"}}, "__getattr__": {"kind": "function", "name": "__getattr__", "runtime": true, "lineno": 613, "endlineno": 616, "analysis": "static", "path": "griffe.__getattr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__init__.py", "relative_package_filepath": "griffe/__init__.py", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__init__.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/__init__.py#L613-L616", "decorators": [], "parameters": [{"name": "attr", "annotation": {"member": "__getattr__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__getattr__", "name": "object", "cls": "ExprName"}}, "_REEXPORTED_EXTERNAL_API": {"kind": "attribute", "name": "_REEXPORTED_EXTERNAL_API", "runtime": true, "lineno": 620, "endlineno": 620, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._REEXPORTED_EXTERNAL_API", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__init__.py", "relative_package_filepath": "griffe/__init__.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__init__.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/__init__.py#L620-L620", "value": {"arguments": [{"member": null, "name": "__cli_all__", "cls": "ExprName"}], "function": {"member": null, "name": "set", "cls": "ExprName"}, "cls": "ExprCall"}}, "__main__": {"kind": "module", "name": "__main__", "runtime": true, "imports": {"sys": "sys", "main": "griffecli.main"}, "docstring": {"value": "Entry-point module, in case you use `python -m griffe`.\n\nWhy does this file exist, and why `__main__`? For more info, read:\n\n- https://www.python.org/dev/peps/pep-0338/\n- https://docs.python.org/3/using/cmdline.html#cmdoption-m", "lineno": 1, "endlineno": 7, "parsed": [{"kind": "text", "value": "Entry-point module, in case you use `python -m griffe`.\n\nWhy does this file exist, and why `__main__`? For more info, read:\n\n- https://www.python.org/dev/peps/pep-0338/\n- https://docs.python.org/3/using/cmdline.html#cmdoption-m"}]}, "members": {"sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe.__main__.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "main": {"kind": "alias", "name": "main", "target_path": "griffecli.main", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe.__main__.main", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}}, "analysis": "static", "path": "griffe.__main__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__main__.py", "relative_package_filepath": "griffe/__main__.py", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__main__.py"}, "_internal": {"kind": "module", "name": "_internal", "runtime": true, "members": {"stats": {"kind": "module", "name": "stats", "runtime": true, "imports": {"annotations": "__future__.annotations", "defaultdict": "collections.defaultdict", "Path": "pathlib.Path", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Kind": "griffe._internal.enumerations.Kind", "GriffeLoader": "griffe._internal.loader.GriffeLoader", "Alias": "griffe._internal.models.Alias", "Object": "griffe._internal.models.Object"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.stats.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "defaultdict": {"kind": "alias", "name": "defaultdict", "target_path": "collections.defaultdict", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.stats.defaultdict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.stats.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.stats.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.stats.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GriffeLoader": {"kind": "alias", "name": "GriffeLoader", "target_path": "griffe._internal.loader.GriffeLoader", "runtime": false, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.stats.GriffeLoader", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.stats.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.stats.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Stats": {"kind": "class", "name": "Stats", "runtime": true, "lineno": 17, "endlineno": 160, "docstring": {"value": "Load statistics for a Griffe loader.", "lineno": 18, "endlineno": 18, "parsed": [{"kind": "text", "value": "Load statistics for a Griffe loader."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 20, "endlineno": 72, "docstring": {"value": "Initialiwe the stats object.\n\nParameters:\n    loader: The loader to compute stats for.", "lineno": 21, "endlineno": 25, "parsed": [{"kind": "parameters", "value": [{"name": "loader", "annotation": {"member": "__init__", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader to compute stats for."}]}]}, "analysis": "static", "path": "griffe._internal.stats.Stats.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L20-L72", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "loader", "annotation": {"member": "__init__", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "loader": {"kind": "attribute", "name": "loader", "runtime": true, "lineno": 26, "endlineno": 26, "docstring": {"value": "The loader to compute stats for.", "lineno": 27, "endlineno": 27, "parsed": [{"kind": "text", "value": "The loader to compute stats for."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.loader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L26-L26", "value": {"member": null, "name": "loader", "cls": "ExprName"}}, "by_kind": {"kind": "attribute", "name": "by_kind", "runtime": true, "lineno": 44, "endlineno": 50, "docstring": {"value": "Number of objects by kind.", "lineno": 51, "endlineno": 51, "parsed": [{"kind": "text", "value": "Number of objects by kind."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.by_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L44-L50", "value": {"keys": [{"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "MODULE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "CLASS", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "FUNCTION", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "TYPE_ALIAS", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": ["0", "0", "0", "0", "0"], "cls": "ExprDict"}}, "packages": {"kind": "attribute", "name": "packages", "runtime": true, "lineno": 53, "endlineno": 53, "docstring": {"value": "Number of packages.", "lineno": 54, "endlineno": 54, "parsed": [{"kind": "text", "value": "Number of packages."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.packages", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L53-L53", "value": {"arguments": [{"member": null, "name": "top_modules", "cls": "ExprName"}], "function": {"member": null, "name": "len", "cls": "ExprName"}, "cls": "ExprCall"}}, "modules_by_extension": {"kind": "attribute", "name": "modules_by_extension", "runtime": true, "lineno": 56, "endlineno": 56, "docstring": {"value": "Number of modules by extension.", "lineno": 57, "endlineno": 57, "parsed": [{"kind": "text", "value": "Number of modules by extension."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.modules_by_extension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L56-L56", "value": {"member": null, "name": "modules_by_extension", "cls": "ExprName"}}, "lines": {"kind": "attribute", "name": "lines", "runtime": true, "lineno": 59, "endlineno": 59, "docstring": {"value": "Total number of lines.", "lineno": 60, "endlineno": 60, "parsed": [{"kind": "text", "value": "Total number of lines."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L59-L59", "value": {"arguments": [{"element": {"arguments": [{"member": null, "name": "lines", "cls": "ExprName"}], "function": {"member": null, "name": "len", "cls": "ExprName"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"arguments": [], "function": {"values": [{"member": null, "name": "loader", "cls": "ExprName"}, {"member": null, "name": "lines_collection", "cls": "ExprName"}, {"member": null, "name": "values", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "target": {"member": null, "name": "lines", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprGeneratorExp"}], "function": {"member": null, "name": "sum", "cls": "ExprName"}, "cls": "ExprCall"}}, "time_spent_visiting": {"kind": "attribute", "name": "time_spent_visiting", "runtime": true, "lineno": 62, "endlineno": 62, "docstring": {"value": "Time spent visiting modules.", "lineno": 63, "endlineno": 63, "parsed": [{"kind": "text", "value": "Time spent visiting modules."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.time_spent_visiting", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L62-L62", "value": "0"}, "time_spent_inspecting": {"kind": "attribute", "name": "time_spent_inspecting", "runtime": true, "lineno": 65, "endlineno": 65, "docstring": {"value": "Time spent inspecting modules.", "lineno": 66, "endlineno": 66, "parsed": [{"kind": "text", "value": "Time spent inspecting modules."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.time_spent_inspecting", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L65-L65", "value": "0"}, "time_spent_serializing": {"kind": "attribute", "name": "time_spent_serializing", "runtime": true, "lineno": 68, "endlineno": 68, "docstring": {"value": "Time spent serializing objects.", "lineno": 69, "endlineno": 69, "parsed": [{"kind": "text", "value": "Time spent serializing objects."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.stats.Stats.time_spent_serializing", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L68-L68", "value": "0"}, "_itercount": {"kind": "function", "name": "_itercount", "runtime": true, "lineno": 74, "endlineno": 84, "analysis": "static", "path": "griffe._internal.stats.Stats._itercount", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L74-L84", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "root", "annotation": {"left": {"member": "_itercount", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_itercount", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "as_text": {"kind": "function", "name": "as_text", "runtime": true, "lineno": 86, "endlineno": 160, "docstring": {"value": "Format the statistics as text.\n\nReturns:\n    Text stats.", "lineno": 87, "endlineno": 91, "parsed": [{"kind": "text", "value": "Format the statistics as text."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "as_text", "name": "str", "cls": "ExprName"}, "description": "Text stats."}]}]}, "analysis": "static", "path": "griffe._internal.stats.Stats.as_text", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L86-L160", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "as_text", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.stats.Stats", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/stats.py#L17-L160", "bases": [], "decorators": []}}, "analysis": "static", "path": "griffe._internal.stats", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/stats.py", "relative_package_filepath": "griffe/_internal/stats.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/stats.py"}, "encoders": {"kind": "module", "name": "encoders", "runtime": true, "imports": {"annotations": "__future__.annotations", "json": "json", "Path": "pathlib.Path", "PosixPath": "pathlib.PosixPath", "WindowsPath": "pathlib.WindowsPath", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "expressions": "griffe._internal.expressions", "Kind": "griffe._internal.enumerations.Kind", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "TypeParameterKind": "griffe._internal.enumerations.TypeParameterKind", "GitInfo": "griffe._internal.git.GitInfo", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Decorator": "griffe._internal.models.Decorator", "Docstring": "griffe._internal.models.Docstring", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters", "TypeAlias": "griffe._internal.models.TypeAlias", "TypeParameter": "griffe._internal.models.TypeParameter", "TypeParameters": "griffe._internal.models.TypeParameters", "Callable": "collections.abc.Callable"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.encoders.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "json": {"kind": "alias", "name": "json", "target_path": "json", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.encoders.json", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.encoders.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "PosixPath": {"kind": "alias", "name": "PosixPath", "target_path": "pathlib.PosixPath", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.encoders.PosixPath", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "WindowsPath": {"kind": "alias", "name": "WindowsPath", "target_path": "pathlib.WindowsPath", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.encoders.WindowsPath", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.encoders.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.encoders.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "expressions": {"kind": "alias", "name": "expressions", "target_path": "griffe._internal.expressions", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.encoders.expressions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.encoders.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.encoders.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameterKind": {"kind": "alias", "name": "TypeParameterKind", "target_path": "griffe._internal.enumerations.TypeParameterKind", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.encoders.TypeParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GitInfo": {"kind": "alias", "name": "GitInfo", "target_path": "griffe._internal.git.GitInfo", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.encoders.GitInfo", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Decorator": {"kind": "alias", "name": "Decorator", "target_path": "griffe._internal.models.Decorator", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Decorator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Parameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.Parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameter": {"kind": "alias", "name": "TypeParameter", "target_path": "griffe._internal.models.TypeParameter", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.TypeParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameters": {"kind": "alias", "name": "TypeParameters", "target_path": "griffe._internal.models.TypeParameters", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 27, "analysis": "static", "path": "griffe._internal.encoders.TypeParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 30, "endlineno": 30, "analysis": "static", "path": "griffe._internal.encoders.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_json_encoder_map": {"kind": "attribute", "name": "_json_encoder_map", "runtime": true, "lineno": 32, "endlineno": 37, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.encoders._json_encoder_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L32-L37", "value": {"keys": [{"member": null, "name": "Path", "cls": "ExprName"}, {"member": null, "name": "PosixPath", "cls": "ExprName"}, {"member": null, "name": "WindowsPath", "cls": "ExprName"}, {"member": null, "name": "set", "cls": "ExprName"}], "values": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "sorted", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "type", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Any", "cls": "ExprName"}], "cls": "ExprList"}, {"member": null, "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "JSONEncoder": {"kind": "class", "name": "JSONEncoder", "runtime": true, "lineno": 40, "endlineno": 89, "docstring": {"value": "JSON encoder.\n\nJSON encoders can be used directly, or through\nthe [`json.dump`][] or [`json.dumps`][] methods.\n\nExamples:\n    >>> from griffe import JSONEncoder\n    >>> JSONEncoder(full=True).encode(..., **kwargs)\n\n    >>> import json\n    >>> from griffe import JSONEncoder\n    >>> json.dumps(..., cls=JSONEncoder, full=True, **kwargs)", "lineno": 41, "endlineno": 53, "parsed": [{"kind": "text", "value": "JSON encoder.\n\nJSON encoders can be used directly, or through\nthe [`json.dump`][] or [`json.dumps`][] methods."}, {"kind": "examples", "value": [["examples", ">>> from griffe import JSONEncoder\n>>> JSONEncoder(full=True).encode(..., **kwargs)"], ["examples", ">>> import json\n>>> from griffe import JSONEncoder\n>>> json.dumps(..., cls=JSONEncoder, full=True, **kwargs)"]]}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 55, "endlineno": 75, "docstring": {"value": "Initialize the encoder.\n\nParameters:\n    *args: See [`json.JSONEncoder`][].\n    full: Whether to dump full data or base data.\n        If you plan to reload the data in Python memory\n        using the [`json_decoder`][griffe.json_decoder],\n        you don't need the full data as it can be inferred again\n        using the base data. If you want to feed a non-Python\n        tool instead, dump the full data.\n    **kwargs: See [`json.JSONEncoder`][].", "lineno": 61, "endlineno": 72, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`json.JSONEncoder`][].", "value": "()"}, {"name": "full", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether to dump full data or base data.\nIf you plan to reload the data in Python memory\nusing the [`json_decoder`][griffe.json_decoder],\nyou don't need the full data as it can be inferred again\nusing the base data. If you want to feed a non-Python\ntool instead, dump the full data.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`json.JSONEncoder`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.encoders.JSONEncoder.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L55-L75", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "full", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "full": {"kind": "attribute", "name": "full", "runtime": true, "lineno": 74, "endlineno": 74, "docstring": {"value": "Whether to dump full data or base data.", "lineno": 75, "endlineno": 75, "parsed": [{"kind": "text", "value": "Whether to dump full data or base data."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.encoders.JSONEncoder.full", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L74-L74", "value": {"member": null, "name": "full", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "default": {"kind": "function", "name": "default", "runtime": true, "lineno": 77, "endlineno": 89, "docstring": {"value": "Return a serializable representation of the given object.\n\nParameters:\n    obj: The object to serialize.\n\nReturns:\n    A serializable representation.", "lineno": 78, "endlineno": 85, "parsed": [{"kind": "text", "value": "Return a serializable representation of the given object."}, {"kind": "parameters", "value": [{"name": "obj", "annotation": {"member": "default", "name": "Any", "cls": "ExprName"}, "description": "The object to serialize."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "default", "name": "Any", "cls": "ExprName"}, "description": "A serializable representation."}]}]}, "analysis": "static", "path": "griffe._internal.encoders.JSONEncoder.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L77-L89", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "default", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "default", "name": "Any", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.encoders.JSONEncoder", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L40-L89", "bases": [{"values": [{"member": "JSONEncoder", "name": "json", "cls": "ExprName"}, {"member": null, "name": "JSONEncoder", "cls": "ExprName"}], "cls": "ExprAttribute"}], "decorators": []}, "_load_docstring": {"kind": "function", "name": "_load_docstring", "runtime": true, "lineno": 92, "endlineno": 95, "analysis": "static", "path": "griffe._internal.encoders._load_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L92-L95", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"member": "_load_docstring", "name": "dict", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_load_docstring", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_load_decorators": {"kind": "function", "name": "_load_decorators", "runtime": true, "lineno": 98, "endlineno": 99, "analysis": "static", "path": "griffe._internal.encoders._load_decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L98-L99", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"member": "_load_decorators", "name": "dict", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_load_decorators", "name": "list", "cls": "ExprName"}, "slice": {"member": "_load_decorators", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_load_expression": {"kind": "function", "name": "_load_expression", "runtime": true, "lineno": 102, "endlineno": 119, "analysis": "static", "path": "griffe._internal.encoders._load_expression", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L102-L119", "decorators": [], "parameters": [{"name": "expression", "annotation": {"member": "_load_expression", "name": "dict", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"values": [{"member": "_load_expression", "name": "expressions", "cls": "ExprName"}, {"member": null, "name": "Expr", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "_load_parameter": {"kind": "function", "name": "_load_parameter", "runtime": true, "lineno": 122, "endlineno": 129, "analysis": "static", "path": "griffe._internal.encoders._load_parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L122-L129", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_parameter", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_parameter", "name": "str", "cls": "ExprName"}, {"member": "_load_parameter", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_parameter", "name": "Parameter", "cls": "ExprName"}}, "_load_type_parameter": {"kind": "function", "name": "_load_type_parameter", "runtime": true, "lineno": 132, "endlineno": 138, "analysis": "static", "path": "griffe._internal.encoders._load_type_parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L132-L138", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_type_parameter", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_type_parameter", "name": "str", "cls": "ExprName"}, {"member": "_load_type_parameter", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_type_parameter", "name": "TypeParameter", "cls": "ExprName"}}, "_load_git_info": {"kind": "function", "name": "_load_git_info", "runtime": true, "lineno": 141, "endlineno": 147, "analysis": "static", "path": "griffe._internal.encoders._load_git_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L141-L147", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_git_info", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_git_info", "name": "str", "cls": "ExprName"}, {"member": "_load_git_info", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_git_info", "name": "GitInfo", "cls": "ExprName"}}, "_attach_parent_to_expr": {"kind": "function", "name": "_attach_parent_to_expr", "runtime": true, "lineno": 150, "endlineno": 157, "analysis": "static", "path": "griffe._internal.encoders._attach_parent_to_expr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L150-L157", "decorators": [], "parameters": [{"name": "expr", "annotation": {"left": {"left": {"values": [{"member": "_attach_parent_to_expr", "name": "expressions", "cls": "ExprName"}, {"member": null, "name": "Expr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "_attach_parent_to_expr", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_attach_parent_to_expr", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_attach_parent_to_expr", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_attach_parent_to_exprs": {"kind": "function", "name": "_attach_parent_to_exprs", "runtime": true, "lineno": 160, "endlineno": 194, "analysis": "static", "path": "griffe._internal.encoders._attach_parent_to_exprs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L160-L194", "decorators": [], "parameters": [{"name": "obj", "annotation": {"left": {"left": {"left": {"member": "_attach_parent_to_exprs", "name": "Class", "cls": "ExprName"}, "operator": "|", "right": {"member": "_attach_parent_to_exprs", "name": "Function", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_attach_parent_to_exprs", "name": "Attribute", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_attach_parent_to_exprs", "name": "TypeAlias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_attach_parent_to_exprs", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_attach_parent_to_exprs", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_load_module": {"kind": "function", "name": "_load_module", "runtime": true, "lineno": 197, "endlineno": 221, "analysis": "static", "path": "griffe._internal.encoders._load_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L197-L221", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_module", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_module", "name": "str", "cls": "ExprName"}, {"member": "_load_module", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_module", "name": "Module", "cls": "ExprName"}}, "_load_class": {"kind": "function", "name": "_load_class", "runtime": true, "lineno": 224, "endlineno": 249, "analysis": "static", "path": "griffe._internal.encoders._load_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L224-L249", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_class", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_class", "name": "str", "cls": "ExprName"}, {"member": "_load_class", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_class", "name": "Class", "cls": "ExprName"}}, "_load_function": {"kind": "function", "name": "_load_function", "runtime": true, "lineno": 252, "endlineno": 271, "analysis": "static", "path": "griffe._internal.encoders._load_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L252-L271", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_function", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_function", "name": "str", "cls": "ExprName"}, {"member": "_load_function", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_function", "name": "Function", "cls": "ExprName"}}, "_load_attribute": {"kind": "function", "name": "_load_attribute", "runtime": true, "lineno": 274, "endlineno": 291, "analysis": "static", "path": "griffe._internal.encoders._load_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L274-L291", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_attribute", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_attribute", "name": "str", "cls": "ExprName"}, {"member": "_load_attribute", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_attribute", "name": "Attribute", "cls": "ExprName"}}, "_load_alias": {"kind": "function", "name": "_load_alias", "runtime": true, "lineno": 294, "endlineno": 306, "analysis": "static", "path": "griffe._internal.encoders._load_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L294-L306", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_alias", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_alias", "name": "str", "cls": "ExprName"}, {"member": "_load_alias", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_alias", "name": "Alias", "cls": "ExprName"}}, "_load_type_alias": {"kind": "function", "name": "_load_type_alias", "runtime": true, "lineno": 309, "endlineno": 326, "analysis": "static", "path": "griffe._internal.encoders._load_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L309-L326", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "_load_type_alias", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_type_alias", "name": "str", "cls": "ExprName"}, {"member": "_load_type_alias", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_type_alias", "name": "TypeAlias", "cls": "ExprName"}}, "_loader_map": {"kind": "attribute", "name": "_loader_map", "runtime": true, "lineno": 329, "endlineno": 336, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.encoders._loader_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L329-L336", "value": {"keys": [{"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "MODULE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "CLASS", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "FUNCTION", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "ALIAS", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "TYPE_ALIAS", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_load_module", "cls": "ExprName"}, {"member": null, "name": "_load_class", "cls": "ExprName"}, {"member": null, "name": "_load_function", "cls": "ExprName"}, {"member": null, "name": "_load_attribute", "cls": "ExprName"}, {"member": null, "name": "_load_alias", "cls": "ExprName"}, {"member": null, "name": "_load_type_alias", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "cls": "ExprList"}, {"left": {"member": null, "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "json_decoder": {"kind": "function", "name": "json_decoder", "runtime": true, "lineno": 339, "endlineno": 374, "docstring": {"value": "Decode dictionaries as data classes.\n\nThe [`json.loads`][] method walks the tree from bottom to top.\n\nExamples:\n    >>> import json\n    >>> from griffe import json_decoder\n    >>> json.loads(..., object_hook=json_decoder)\n\nParameters:\n    obj_dict: The dictionary to decode.\n\nReturns:\n    An instance of a data class.", "lineno": 342, "endlineno": 356, "parsed": [{"kind": "text", "value": "Decode dictionaries as data classes.\n\nThe [`json.loads`][] method walks the tree from bottom to top."}, {"kind": "examples", "value": [["examples", ">>> import json\n>>> from griffe import json_decoder\n>>> json.loads(..., object_hook=json_decoder)"]]}, {"kind": "parameters", "value": [{"name": "obj_dict", "annotation": {"left": {"member": "json_decoder", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "json_decoder", "name": "str", "cls": "ExprName"}, {"member": "json_decoder", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "The dictionary to decode."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"left": {"left": {"left": {"left": {"left": {"left": {"member": "json_decoder", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "json_decoder", "name": "str", "cls": "ExprName"}, {"member": "json_decoder", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"member": "json_decoder", "name": "Object", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "TypeParameter", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "json_decoder", "name": "expressions", "cls": "ExprName"}, {"member": null, "name": "Expr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "description": "An instance of a data class."}]}]}, "analysis": "static", "path": "griffe._internal.encoders.json_decoder", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/encoders.py#L339-L374", "decorators": [], "parameters": [{"name": "obj_dict", "annotation": {"left": {"member": "json_decoder", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "json_decoder", "name": "str", "cls": "ExprName"}, {"member": "json_decoder", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"left": {"left": {"left": {"left": {"left": {"left": {"member": "json_decoder", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "json_decoder", "name": "str", "cls": "ExprName"}, {"member": "json_decoder", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"member": "json_decoder", "name": "Object", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "TypeParameter", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "json_decoder", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "json_decoder", "name": "expressions", "cls": "ExprName"}, {"member": null, "name": "Expr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.encoders", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/encoders.py", "relative_package_filepath": "griffe/_internal/encoders.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/encoders.py"}, "merger": {"kind": "module", "name": "merger", "runtime": true, "imports": {"annotations": "__future__.annotations", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "Expr": "griffe._internal.expressions.Expr", "logger": "griffe._internal.logger.logger", "Sequence": "collections.abc.Sequence", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "TypeAlias": "griffe._internal.models.TypeAlias"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.merger.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.merger.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.merger.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.merger.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.merger.CyclicAliasError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.merger.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.merger.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.merger.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.merger.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_merge_module_stubs": {"kind": "function", "name": "_merge_module_stubs", "runtime": true, "lineno": 18, "endlineno": 21, "analysis": "static", "path": "griffe._internal.merger._merge_module_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L18-L21", "decorators": [], "parameters": [{"name": "module", "annotation": {"member": "_merge_module_stubs", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_module_stubs", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_class_stubs": {"kind": "function", "name": "_merge_class_stubs", "runtime": true, "lineno": 24, "endlineno": 28, "analysis": "static", "path": "griffe._internal.merger._merge_class_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L24-L28", "decorators": [], "parameters": [{"name": "class_", "annotation": {"member": "_merge_class_stubs", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_class_stubs", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_function_stubs": {"kind": "function", "name": "_merge_function_stubs", "runtime": true, "lineno": 31, "endlineno": 37, "analysis": "static", "path": "griffe._internal.merger._merge_function_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L31-L37", "decorators": [], "parameters": [{"name": "function", "annotation": {"member": "_merge_function_stubs", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_function_stubs", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_attribute_stubs": {"kind": "function", "name": "_merge_attribute_stubs", "runtime": true, "lineno": 40, "endlineno": 44, "analysis": "static", "path": "griffe._internal.merger._merge_attribute_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L40-L44", "decorators": [], "parameters": [{"name": "attribute", "annotation": {"member": "_merge_attribute_stubs", "name": "Attribute", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_attribute_stubs", "name": "Attribute", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_type_alias_stubs": {"kind": "function", "name": "_merge_type_alias_stubs", "runtime": true, "lineno": 47, "endlineno": 49, "analysis": "static", "path": "griffe._internal.merger._merge_type_alias_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L47-L49", "decorators": [], "parameters": [{"name": "type_alias", "annotation": {"member": "_merge_type_alias_stubs", "name": "TypeAlias", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_type_alias_stubs", "name": "TypeAlias", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_stubs_docstring": {"kind": "function", "name": "_merge_stubs_docstring", "runtime": true, "lineno": 52, "endlineno": 54, "analysis": "static", "path": "griffe._internal.merger._merge_stubs_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L52-L54", "decorators": [], "parameters": [{"name": "obj", "annotation": {"member": "_merge_stubs_docstring", "name": "Object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"member": "_merge_stubs_docstring", "name": "Object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_stubs_type_parameters": {"kind": "function", "name": "_merge_stubs_type_parameters", "runtime": true, "lineno": 57, "endlineno": 59, "analysis": "static", "path": "griffe._internal.merger._merge_stubs_type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L57-L59", "decorators": [], "parameters": [{"name": "obj", "annotation": {"left": {"left": {"member": "_merge_stubs_type_parameters", "name": "Class", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_type_parameters", "name": "Function", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_merge_stubs_type_parameters", "name": "TypeAlias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"left": {"left": {"member": "_merge_stubs_type_parameters", "name": "Class", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_type_parameters", "name": "Function", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_merge_stubs_type_parameters", "name": "TypeAlias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_stubs_overloads": {"kind": "function", "name": "_merge_stubs_overloads", "runtime": true, "lineno": 62, "endlineno": 67, "analysis": "static", "path": "griffe._internal.merger._merge_stubs_overloads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L62-L67", "decorators": [], "parameters": [{"name": "obj", "annotation": {"left": {"member": "_merge_stubs_overloads", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_overloads", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"left": {"member": "_merge_stubs_overloads", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_overloads", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_annotations": {"kind": "function", "name": "_merge_annotations", "runtime": true, "lineno": 70, "endlineno": 75, "analysis": "static", "path": "griffe._internal.merger._merge_annotations", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L70-L75", "decorators": [], "parameters": [{"name": "annotations", "annotation": {"left": {"member": "_merge_annotations", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "_merge_annotations", "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_merge_annotations", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_merge_overload_annotations": {"kind": "function", "name": "_merge_overload_annotations", "runtime": true, "lineno": 78, "endlineno": 100, "analysis": "static", "path": "griffe._internal.merger._merge_overload_annotations", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L78-L100", "decorators": [], "parameters": [{"name": "function", "annotation": {"member": "_merge_overload_annotations", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "overloads", "annotation": {"left": {"member": "_merge_overload_annotations", "name": "list", "cls": "ExprName"}, "slice": {"member": "_merge_overload_annotations", "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_merge_stubs_members": {"kind": "function", "name": "_merge_stubs_members", "runtime": true, "lineno": 103, "endlineno": 144, "analysis": "static", "path": "griffe._internal.merger._merge_stubs_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L103-L144", "decorators": [], "parameters": [{"name": "obj", "annotation": {"left": {"member": "_merge_stubs_members", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_members", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "stubs", "annotation": {"left": {"member": "_merge_stubs_members", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_merge_stubs_members", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "merge_stubs": {"kind": "function", "name": "merge_stubs", "runtime": true, "lineno": 147, "endlineno": 170, "docstring": {"value": "Merge stubs into a module.\n\nParameters:\n    mod1: A regular module or stubs module.\n    mod2: A regular module or stubs module.\n\nRaises:\n    ValueError: When both modules are regular modules (no stubs is passed).\n\nReturns:\n    The regular module.", "lineno": 148, "endlineno": 159, "parsed": [{"kind": "text", "value": "Merge stubs into a module."}, {"kind": "parameters", "value": [{"name": "mod1", "annotation": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}, "description": "A regular module or stubs module."}, {"name": "mod2", "annotation": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}, "description": "A regular module or stubs module."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When both modules are regular modules (no stubs is passed)."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}, "description": "The regular module."}]}]}, "analysis": "static", "path": "griffe._internal.merger.merge_stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/merger.py#L147-L170", "decorators": [], "parameters": [{"name": "mod1", "annotation": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "mod2", "annotation": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "merge_stubs", "name": "Module", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.merger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/merger.py", "relative_package_filepath": "griffe/_internal/merger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/merger.py"}, "mixins": {"kind": "module", "name": "mixins", "runtime": true, "imports": {"annotations": "__future__.annotations", "json": "json", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "TypeVar": "typing.TypeVar", "Kind": "griffe._internal.enumerations.Kind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "BuiltinModuleError": "griffe._internal.exceptions.BuiltinModuleError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "merge_stubs": "griffe._internal.merger.merge_stubs", "Sequence": "collections.abc.Sequence", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "TypeAlias": "griffe._internal.models.TypeAlias"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.mixins.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "json": {"kind": "alias", "name": "json", "target_path": "json", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.mixins.json", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.mixins.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.mixins.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.mixins.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeVar": {"kind": "alias", "name": "TypeVar", "target_path": "typing.TypeVar", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.mixins.TypeVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.mixins.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.mixins.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "BuiltinModuleError": {"kind": "alias", "name": "BuiltinModuleError", "target_path": "griffe._internal.exceptions.BuiltinModuleError", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.mixins.BuiltinModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.mixins.CyclicAliasError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "merge_stubs": {"kind": "alias", "name": "merge_stubs", "target_path": "griffe._internal.merger.merge_stubs", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.mixins.merge_stubs", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.mixins.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.mixins.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_ObjType": {"kind": "attribute", "name": "_ObjType", "runtime": true, "lineno": 19, "endlineno": 19, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.mixins._ObjType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L19-L19", "value": {"arguments": ["'_ObjType'"], "function": {"member": null, "name": "TypeVar", "cls": "ExprName"}, "cls": "ExprCall"}}, "_get_parts": {"kind": "function", "name": "_get_parts", "runtime": true, "lineno": 22, "endlineno": 31, "analysis": "static", "path": "griffe._internal.mixins._get_parts", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L22-L31", "decorators": [], "parameters": [{"name": "key", "annotation": {"left": {"member": "_get_parts", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_get_parts", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "_get_parts", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_parts", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "_get_parts", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "GetMembersMixin": {"kind": "class", "name": "GetMembersMixin", "runtime": true, "lineno": 34, "endlineno": 79, "docstring": {"value": "Mixin class to share methods for accessing members.", "lineno": 35, "endlineno": 35, "parsed": [{"kind": "text", "value": "Mixin class to share methods for accessing members."}]}, "members": {"__getitem__": {"kind": "function", "name": "__getitem__", "runtime": true, "lineno": 37, "endlineno": 57, "docstring": {"value": "Get a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nMembers will be looked up in both declared members and inherited ones,\ntriggering computation of the latter.\n\nParameters:\n    key: The name or path of the member.\n\nExamples:\n    >>> foo = griffe_object[\"foo\"]\n    >>> bar = griffe_object[\"path.to.bar\"]\n    >>> qux = griffe_object[(\"path\", \"to\", \"qux\")]", "lineno": 38, "endlineno": 53, "parsed": [{"kind": "text", "value": "Get a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nMembers will be looked up in both declared members and inherited ones,\ntriggering computation of the latter."}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__getitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}]}, {"kind": "examples", "value": [["examples", ">>> foo = griffe_object[\"foo\"]\n>>> bar = griffe_object[\"path.to.bar\"]\n>>> qux = griffe_object[(\"path\", \"to\", \"qux\")]"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.GetMembersMixin.__getitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L37-L57", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__getitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__getitem__", "name": "Any", "cls": "ExprName"}}, "get_member": {"kind": "function", "name": "get_member", "runtime": true, "lineno": 59, "endlineno": 79, "docstring": {"value": "Get a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions).\n\nMembers will be looked up in declared members only, not inherited ones.\n\nParameters:\n    key: The name or path of the member.\n\nExamples:\n    >>> foo = griffe_object[\"foo\"]\n    >>> bar = griffe_object[\"path.to.bar\"]\n    >>> bar = griffe_object[(\"path\", \"to\", \"bar\")]", "lineno": 60, "endlineno": 75, "parsed": [{"kind": "text", "value": "Get a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions).\n\nMembers will be looked up in declared members only, not inherited ones."}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "get_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "get_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "get_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}]}, {"kind": "examples", "value": [["examples", ">>> foo = griffe_object[\"foo\"]\n>>> bar = griffe_object[\"path.to.bar\"]\n>>> bar = griffe_object[(\"path\", \"to\", \"bar\")]"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.GetMembersMixin.get_member", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L59-L79", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "get_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "get_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "get_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "get_member", "name": "Any", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.mixins.GetMembersMixin", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L34-L79", "bases": [], "decorators": []}, "DelMembersMixin": {"kind": "class", "name": "DelMembersMixin", "runtime": true, "lineno": 84, "endlineno": 136, "docstring": {"value": "Mixin class to share methods for deleting members.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Mixin class to share methods for deleting members."}]}, "members": {"__delitem__": {"kind": "function", "name": "__delitem__", "runtime": true, "lineno": 87, "endlineno": 112, "docstring": {"value": "Delete a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nMembers will be looked up in both declared members and inherited ones,\ntriggering computation of the latter.\n\nParameters:\n    key: The name or path of the member.\n\nExamples:\n    >>> del griffe_object[\"foo\"]\n    >>> del griffe_object[\"path.to.bar\"]\n    >>> del griffe_object[(\"path\", \"to\", \"qux\")]", "lineno": 88, "endlineno": 103, "parsed": [{"kind": "text", "value": "Delete a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nMembers will be looked up in both declared members and inherited ones,\ntriggering computation of the latter."}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__delitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}]}, {"kind": "examples", "value": [["examples", ">>> del griffe_object[\"foo\"]\n>>> del griffe_object[\"path.to.bar\"]\n>>> del griffe_object[(\"path\", \"to\", \"qux\")]"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.DelMembersMixin.__delitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L87-L112", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__delitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "del_member": {"kind": "function", "name": "del_member", "runtime": true, "lineno": 114, "endlineno": 136, "docstring": {"value": "Delete a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions).\n\nMembers will be looked up in declared members only, not inherited ones.\n\nParameters:\n    key: The name or path of the member.\n\nExamples:\n    >>> griffe_object.del_member(\"foo\")\n    >>> griffe_object.del_member(\"path.to.bar\")\n    >>> griffe_object.del_member((\"path\", \"to\", \"qux\"))", "lineno": 115, "endlineno": 130, "parsed": [{"kind": "text", "value": "Delete a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions).\n\nMembers will be looked up in declared members only, not inherited ones."}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "del_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "del_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "del_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}]}, {"kind": "examples", "value": [["examples", ">>> griffe_object.del_member(\"foo\")\n>>> griffe_object.del_member(\"path.to.bar\")\n>>> griffe_object.del_member((\"path\", \"to\", \"qux\"))"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.DelMembersMixin.del_member", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L114-L136", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "del_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "del_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "del_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.mixins.DelMembersMixin", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L84-L136", "bases": [], "decorators": []}, "SetMembersMixin": {"kind": "class", "name": "SetMembersMixin", "runtime": true, "lineno": 139, "endlineno": 209, "docstring": {"value": "Mixin class to share methods for setting members.", "lineno": 140, "endlineno": 140, "parsed": [{"kind": "text", "value": "Mixin class to share methods for setting members."}]}, "members": {"__setitem__": {"kind": "function", "name": "__setitem__", "runtime": true, "lineno": 142, "endlineno": 166, "docstring": {"value": "Set a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nParameters:\n    key: The name or path of the member.\n    value: The member.\n\nExamples:\n    >>> griffe_object[\"foo\"] = foo\n    >>> griffe_object[\"path.to.bar\"] = bar\n    >>> griffe_object[(\"path\", \"to\", \"qux\")] = qux", "lineno": 143, "endlineno": 156, "parsed": [{"kind": "text", "value": "Set a member with its name or path.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__setitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}, {"name": "value", "annotation": {"left": {"member": "__setitem__", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "__setitem__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The member."}]}, {"kind": "examples", "value": [["examples", ">>> griffe_object[\"foo\"] = foo\n>>> griffe_object[\"path.to.bar\"] = bar\n>>> griffe_object[(\"path\", \"to\", \"qux\")] = qux"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.SetMembersMixin.__setitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L142-L166", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__setitem__", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__setitem__", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "__setitem__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "set_member": {"kind": "function", "name": "set_member", "runtime": true, "lineno": 168, "endlineno": 209, "docstring": {"value": "Set a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions).\n\nParameters:\n    key: The name or path of the member.\n    value: The member.\n\nExamples:\n    >>> griffe_object.set_member(\"foo\", foo)\n    >>> griffe_object.set_member(\"path.to.bar\", bar)\n    >>> griffe_object.set_member((\"path\", \"to\", \"qux\"), qux)", "lineno": 169, "endlineno": 183, "parsed": [{"kind": "text", "value": "Set a member with its name or path.\n\nThis method is part of the producer API:\nyou can use it safely while building Griffe trees\n(for example in Griffe extensions)."}, {"kind": "parameters", "value": [{"name": "key", "annotation": {"left": {"member": "set_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "set_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "set_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The name or path of the member."}, {"name": "value", "annotation": {"left": {"member": "set_member", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "set_member", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The member."}]}, {"kind": "examples", "value": [["examples", ">>> griffe_object.set_member(\"foo\", foo)\n>>> griffe_object.set_member(\"path.to.bar\", bar)\n>>> griffe_object.set_member((\"path\", \"to\", \"qux\"), qux)"]]}]}, "analysis": "static", "path": "griffe._internal.mixins.SetMembersMixin.set_member", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L168-L209", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": "set_member", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "set_member", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "set_member", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "set_member", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "set_member", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.mixins.SetMembersMixin", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L139-L209", "bases": [], "decorators": []}, "SerializationMixin": {"kind": "class", "name": "SerializationMixin", "runtime": true, "lineno": 212, "endlineno": 250, "docstring": {"value": "Mixin class to share methods for de/serializing objects.", "lineno": 213, "endlineno": 213, "parsed": [{"kind": "text", "value": "Mixin class to share methods for de/serializing objects."}]}, "members": {"as_json": {"kind": "function", "name": "as_json", "runtime": true, "lineno": 215, "endlineno": 227, "docstring": {"value": "Return this object's data as a JSON string.\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options passed to encoder.\n\nReturns:\n    A JSON string.", "lineno": 216, "endlineno": 224, "parsed": [{"kind": "text", "value": "Return this object's data as a JSON string."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_json", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_json", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options passed to encoder.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "as_json", "name": "str", "cls": "ExprName"}, "description": "A JSON string."}]}]}, "analysis": "static", "path": "griffe._internal.mixins.SerializationMixin.as_json", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L215-L227", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_json", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_json", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "as_json", "name": "str", "cls": "ExprName"}}, "from_json": {"kind": "function", "name": "from_json", "runtime": true, "lineno": 229, "endlineno": 250, "docstring": {"value": "Create an instance of this class from a JSON string.\n\nParameters:\n    json_string: JSON to decode into Object.\n    **kwargs: Additional options passed to decoder.\n\nReturns:\n    An Object instance.\n\nRaises:\n    TypeError: When the json_string does not represent and object\n        of the class from which this classmethod has been called.", "lineno": 231, "endlineno": 243, "parsed": [{"kind": "text", "value": "Create an instance of this class from a JSON string."}, {"kind": "parameters", "value": [{"name": "json_string", "annotation": {"member": "from_json", "name": "str", "cls": "ExprName"}, "description": "JSON to decode into Object."}, {"name": "**kwargs", "annotation": {"member": "from_json", "name": "Any", "cls": "ExprName"}, "description": "Additional options passed to decoder.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "from_json", "name": "_ObjType", "cls": "ExprName"}, "description": "An Object instance."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "TypeError", "cls": "ExprName"}, "description": "When the json_string does not represent and object\nof the class from which this classmethod has been called."}]}]}, "labels": ["classmethod"], "analysis": "static", "path": "griffe._internal.mixins.SerializationMixin.from_json", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L229-L250", "decorators": [{"value": {"member": null, "name": "classmethod", "cls": "ExprName"}, "lineno": 229, "endlineno": 229}], "parameters": [{"name": "cls", "annotation": {"left": {"member": "from_json", "name": "type", "cls": "ExprName"}, "slice": {"member": "from_json", "name": "_ObjType", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "json_string", "annotation": {"member": "from_json", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "from_json", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "from_json", "name": "_ObjType", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.mixins.SerializationMixin", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L212-L250", "bases": [], "decorators": []}, "ObjectAliasMixin": {"kind": "class", "name": "ObjectAliasMixin", "runtime": true, "lineno": 253, "endlineno": 429, "docstring": {"value": "Mixin class to share methods that appear both in objects and aliases, unchanged.", "lineno": 254, "endlineno": 254, "parsed": [{"kind": "text", "value": "Mixin class to share methods that appear both in objects and aliases, unchanged."}]}, "members": {"all_members": {"kind": "attribute", "name": "all_members", "runtime": true, "lineno": 257, "endlineno": 265, "docstring": {"value": "All members (declared and inherited).\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 258, "endlineno": 262, "parsed": [{"kind": "text", "value": "All members (declared and inherited).\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.all_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L257-L265", "annotation": {"left": {"member": "all_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "all_members", "name": "str", "cls": "ExprName"}, {"left": {"member": "all_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "all_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "modules": {"kind": "attribute", "name": "modules", "runtime": true, "lineno": 268, "endlineno": 274, "docstring": {"value": "The module members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 269, "endlineno": 273, "parsed": [{"kind": "text", "value": "The module members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.modules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L268-L274", "annotation": {"left": {"member": "modules", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "modules", "name": "str", "cls": "ExprName"}, {"member": "modules", "name": "Module", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "classes": {"kind": "attribute", "name": "classes", "runtime": true, "lineno": 277, "endlineno": 283, "docstring": {"value": "The class members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 278, "endlineno": 282, "parsed": [{"kind": "text", "value": "The class members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.classes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L277-L283", "annotation": {"left": {"member": "classes", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "classes", "name": "str", "cls": "ExprName"}, {"member": "classes", "name": "Class", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "functions": {"kind": "attribute", "name": "functions", "runtime": true, "lineno": 286, "endlineno": 292, "docstring": {"value": "The function members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 287, "endlineno": 291, "parsed": [{"kind": "text", "value": "The function members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.functions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L286-L292", "annotation": {"left": {"member": "functions", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "functions", "name": "str", "cls": "ExprName"}, {"member": "functions", "name": "Function", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "attributes": {"kind": "attribute", "name": "attributes", "runtime": true, "lineno": 295, "endlineno": 301, "docstring": {"value": "The attribute members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 296, "endlineno": 300, "parsed": [{"kind": "text", "value": "The attribute members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.attributes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L295-L301", "annotation": {"left": {"member": "attributes", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "attributes", "name": "str", "cls": "ExprName"}, {"member": "attributes", "name": "Attribute", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "type_aliases": {"kind": "attribute", "name": "type_aliases", "runtime": true, "lineno": 304, "endlineno": 310, "docstring": {"value": "The type alias members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 305, "endlineno": 309, "parsed": [{"kind": "text", "value": "The type alias members.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.type_aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L304-L310", "annotation": {"left": {"member": "type_aliases", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "type_aliases", "name": "str", "cls": "ExprName"}, {"member": "type_aliases", "name": "TypeAlias", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "is_private": {"kind": "attribute", "name": "is_private", "runtime": true, "lineno": 313, "endlineno": 315, "docstring": {"value": "Whether this object/alias is private (starts with `_`) but not special.", "lineno": 314, "endlineno": 314, "parsed": [{"kind": "text", "value": "Whether this object/alias is private (starts with `_`) but not special."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_private", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L313-L315", "annotation": {"member": "is_private", "name": "bool", "cls": "ExprName"}}, "is_special": {"kind": "attribute", "name": "is_special", "runtime": true, "lineno": 318, "endlineno": 320, "docstring": {"value": "Whether this object/alias is special (\"dunder\" attribute/method, starts and end with `__`).", "lineno": 319, "endlineno": 319, "parsed": [{"kind": "text", "value": "Whether this object/alias is special (\"dunder\" attribute/method, starts and end with `__`)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_special", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L318-L320", "annotation": {"member": "is_special", "name": "bool", "cls": "ExprName"}}, "is_class_private": {"kind": "attribute", "name": "is_class_private", "runtime": true, "lineno": 323, "endlineno": 327, "docstring": {"value": "Whether this object/alias is class-private (starts with `__` and is a class member).", "lineno": 324, "endlineno": 324, "parsed": [{"kind": "text", "value": "Whether this object/alias is class-private (starts with `__` and is a class member)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_class_private", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L323-L327", "annotation": {"member": "is_class_private", "name": "bool", "cls": "ExprName"}}, "is_imported": {"kind": "attribute", "name": "is_imported", "runtime": true, "lineno": 330, "endlineno": 332, "docstring": {"value": "Whether this object/alias was imported from another module.", "lineno": 331, "endlineno": 331, "parsed": [{"kind": "text", "value": "Whether this object/alias was imported from another module."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_imported", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L330-L332", "annotation": {"member": "is_imported", "name": "bool", "cls": "ExprName"}}, "is_exported": {"kind": "attribute", "name": "is_exported", "runtime": true, "lineno": 335, "endlineno": 341, "docstring": {"value": "Whether this object/alias is exported (listed in `__all__`).", "lineno": 336, "endlineno": 336, "parsed": [{"kind": "text", "value": "Whether this object/alias is exported (listed in `__all__`)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_exported", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L335-L341", "annotation": {"member": "is_exported", "name": "bool", "cls": "ExprName"}}, "is_wildcard_exposed": {"kind": "attribute", "name": "is_wildcard_exposed", "runtime": true, "lineno": 344, "endlineno": 373, "docstring": {"value": "Whether this object/alias is exposed to wildcard imports.\n\nTo be exposed to wildcard imports, an object/alias must:\n\n- be available at runtime\n- have a module as parent\n- be listed in `__all__` if `__all__` is defined\n- or not be private (having a name starting with an underscore)\n\nSpecial case for Griffe trees: a submodule is only exposed if its parent imports it.\n\nReturns:\n    True or False.", "lineno": 345, "endlineno": 358, "parsed": [{"kind": "text", "value": "Whether this object/alias is exposed to wildcard imports.\n\nTo be exposed to wildcard imports, an object/alias must:\n\n- be available at runtime\n- have a module as parent\n- be listed in `__all__` if `__all__` is defined\n- or not be private (having a name starting with an underscore)\n\nSpecial case for Griffe trees: a submodule is only exposed if its parent imports it."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "is_wildcard_exposed", "name": "bool", "cls": "ExprName"}, "description": "True or False."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_wildcard_exposed", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L344-L373", "annotation": {"member": "is_wildcard_exposed", "name": "bool", "cls": "ExprName"}}, "is_public": {"kind": "attribute", "name": "is_public", "runtime": true, "lineno": 376, "endlineno": 418, "docstring": {"value": "Whether this object is considered public.\n\nIn modules, developers can mark objects as public thanks to the `__all__` variable.\nIn classes however, there is no convention or standard to do so.\n\nTherefore, to decide whether an object is public, we follow this algorithm:\n\n- If the object's `public` attribute is set (boolean), return its value.\n- If the object is listed in its parent's (a module) `__all__` attribute, it is public.\n- If the parent (module) defines `__all__` and the object is not listed in, it is private.\n- If the object has a private name, it is private.\n- If the object was imported from another module, it is private.\n- Otherwise, the object is public.", "lineno": 377, "endlineno": 390, "parsed": [{"kind": "text", "value": "Whether this object is considered public.\n\nIn modules, developers can mark objects as public thanks to the `__all__` variable.\nIn classes however, there is no convention or standard to do so.\n\nTherefore, to decide whether an object is public, we follow this algorithm:\n\n- If the object's `public` attribute is set (boolean), return its value.\n- If the object is listed in its parent's (a module) `__all__` attribute, it is public.\n- If the parent (module) defines `__all__` and the object is not listed in, it is private.\n- If the object has a private name, it is private.\n- If the object was imported from another module, it is private.\n- Otherwise, the object is public."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_public", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L376-L418", "annotation": {"member": "is_public", "name": "bool", "cls": "ExprName"}}, "is_deprecated": {"kind": "attribute", "name": "is_deprecated", "runtime": true, "lineno": 421, "endlineno": 424, "docstring": {"value": "Whether this object is deprecated.", "lineno": 422, "endlineno": 422, "parsed": [{"kind": "text", "value": "Whether this object is deprecated."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_deprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L421-L424", "annotation": {"member": "is_deprecated", "name": "bool", "cls": "ExprName"}}, "is_generic": {"kind": "attribute", "name": "is_generic", "runtime": true, "lineno": 427, "endlineno": 429, "docstring": {"value": "Whether this object is generic.", "lineno": 428, "endlineno": 428, "parsed": [{"kind": "text", "value": "Whether this object is generic."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin.is_generic", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L427-L429", "annotation": {"member": "is_generic", "name": "bool", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.mixins.ObjectAliasMixin", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/mixins.py#L253-L429", "bases": [{"member": "ObjectAliasMixin", "name": "GetMembersMixin", "cls": "ExprName"}, {"member": "ObjectAliasMixin", "name": "SetMembersMixin", "cls": "ExprName"}, {"member": "ObjectAliasMixin", "name": "DelMembersMixin", "cls": "ExprName"}, {"member": "ObjectAliasMixin", "name": "SerializationMixin", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.mixins", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/mixins.py", "relative_package_filepath": "griffe/_internal/mixins.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/mixins.py"}, "exceptions": {"kind": "module", "name": "exceptions", "runtime": true, "imports": {"annotations": "__future__.annotations", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Alias": "griffe._internal.models.Alias"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.exceptions.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.exceptions.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": false, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.exceptions.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "GriffeError": {"kind": "class", "name": "GriffeError", "runtime": true, "lineno": 11, "endlineno": 12, "docstring": {"value": "The base exception for all Griffe errors.", "lineno": 12, "endlineno": 12, "parsed": [{"kind": "text", "value": "The base exception for all Griffe errors."}]}, "analysis": "static", "path": "griffe._internal.exceptions.GriffeError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L11-L12", "bases": [{"member": "GriffeError", "name": "Exception", "cls": "ExprName"}], "decorators": []}, "LoadingError": {"kind": "class", "name": "LoadingError", "runtime": true, "lineno": 15, "endlineno": 16, "docstring": {"value": "The base exception for all Griffe errors.", "lineno": 16, "endlineno": 16, "parsed": [{"kind": "text", "value": "The base exception for all Griffe errors."}]}, "analysis": "static", "path": "griffe._internal.exceptions.LoadingError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L15-L16", "bases": [{"member": "LoadingError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "NameResolutionError": {"kind": "class", "name": "NameResolutionError", "runtime": true, "lineno": 19, "endlineno": 20, "docstring": {"value": "Exception for names that cannot be resolved in a object scope.", "lineno": 20, "endlineno": 20, "parsed": [{"kind": "text", "value": "Exception for names that cannot be resolved in a object scope."}]}, "analysis": "static", "path": "griffe._internal.exceptions.NameResolutionError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L19-L20", "bases": [{"member": "NameResolutionError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "UnhandledEditableModuleError": {"kind": "class", "name": "UnhandledEditableModuleError", "runtime": true, "lineno": 23, "endlineno": 24, "docstring": {"value": "Exception for unhandled editables modules, when searching modules.", "lineno": 24, "endlineno": 24, "parsed": [{"kind": "text", "value": "Exception for unhandled editables modules, when searching modules."}]}, "analysis": "static", "path": "griffe._internal.exceptions.UnhandledEditableModuleError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L23-L24", "bases": [{"member": "UnhandledEditableModuleError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "UnimportableModuleError": {"kind": "class", "name": "UnimportableModuleError", "runtime": true, "lineno": 27, "endlineno": 28, "docstring": {"value": "Exception for modules that cannot be imported.", "lineno": 28, "endlineno": 28, "parsed": [{"kind": "text", "value": "Exception for modules that cannot be imported."}]}, "analysis": "static", "path": "griffe._internal.exceptions.UnimportableModuleError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L27-L28", "bases": [{"member": "UnimportableModuleError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "AliasResolutionError": {"kind": "class", "name": "AliasResolutionError", "runtime": true, "lineno": 31, "endlineno": 50, "docstring": {"value": "Exception for alias that cannot be resolved.", "lineno": 32, "endlineno": 32, "parsed": [{"kind": "text", "value": "Exception for alias that cannot be resolved."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 34, "endlineno": 50, "docstring": {"value": "Initialize the exception.\n\nParameters:\n    alias: The alias that could not be resolved.", "lineno": 35, "endlineno": 39, "parsed": [{"kind": "parameters", "value": [{"name": "alias", "annotation": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "description": "The alias that could not be resolved."}]}]}, "analysis": "static", "path": "griffe._internal.exceptions.AliasResolutionError.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L34-L50", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "alias", "annotation": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "alias": {"kind": "attribute", "name": "alias", "runtime": true, "lineno": 40, "endlineno": 40, "docstring": {"value": "The alias that triggered the error.", "lineno": 41, "endlineno": 41, "parsed": [{"kind": "text", "value": "The alias that triggered the error."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.exceptions.AliasResolutionError.alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L40-L40", "value": {"member": null, "name": "alias", "cls": "ExprName"}, "annotation": {"member": null, "name": "Alias", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.exceptions.AliasResolutionError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L31-L50", "bases": [{"member": "AliasResolutionError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "CyclicAliasError": {"kind": "class", "name": "CyclicAliasError", "runtime": true, "lineno": 53, "endlineno": 65, "docstring": {"value": "Exception raised when a cycle is detected in aliases.", "lineno": 54, "endlineno": 54, "parsed": [{"kind": "text", "value": "Exception raised when a cycle is detected in aliases."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 56, "endlineno": 65, "docstring": {"value": "Initialize the exception.\n\nParameters:\n    chain: The cyclic chain of items (such as target path).", "lineno": 57, "endlineno": 61, "parsed": [{"kind": "parameters", "value": [{"name": "chain", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The cyclic chain of items (such as target path)."}]}]}, "analysis": "static", "path": "griffe._internal.exceptions.CyclicAliasError.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L56-L65", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "chain", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "chain": {"kind": "attribute", "name": "chain", "runtime": true, "lineno": 62, "endlineno": 62, "docstring": {"value": "The chain of aliases that created the cycle.", "lineno": 63, "endlineno": 63, "parsed": [{"kind": "text", "value": "The chain of aliases that created the cycle."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.exceptions.CyclicAliasError.chain", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L62-L62", "value": {"member": null, "name": "chain", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.exceptions.CyclicAliasError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L53-L65", "bases": [{"member": "CyclicAliasError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "LastNodeError": {"kind": "class", "name": "LastNodeError", "runtime": true, "lineno": 68, "endlineno": 69, "docstring": {"value": "Exception raised when trying to access a next or previous node.", "lineno": 69, "endlineno": 69, "parsed": [{"kind": "text", "value": "Exception raised when trying to access a next or previous node."}]}, "analysis": "static", "path": "griffe._internal.exceptions.LastNodeError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L68-L69", "bases": [{"member": "LastNodeError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "RootNodeError": {"kind": "class", "name": "RootNodeError", "runtime": true, "lineno": 72, "endlineno": 73, "docstring": {"value": "Exception raised when trying to use siblings properties on a root node.", "lineno": 73, "endlineno": 73, "parsed": [{"kind": "text", "value": "Exception raised when trying to use siblings properties on a root node."}]}, "analysis": "static", "path": "griffe._internal.exceptions.RootNodeError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L72-L73", "bases": [{"member": "RootNodeError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "BuiltinModuleError": {"kind": "class", "name": "BuiltinModuleError", "runtime": true, "lineno": 76, "endlineno": 77, "docstring": {"value": "Exception raised when trying to access the filepath of a builtin module.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "Exception raised when trying to access the filepath of a builtin module."}]}, "analysis": "static", "path": "griffe._internal.exceptions.BuiltinModuleError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L76-L77", "bases": [{"member": "BuiltinModuleError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "ExtensionError": {"kind": "class", "name": "ExtensionError", "runtime": true, "lineno": 80, "endlineno": 81, "docstring": {"value": "Base class for errors raised by extensions.", "lineno": 81, "endlineno": 81, "parsed": [{"kind": "text", "value": "Base class for errors raised by extensions."}]}, "analysis": "static", "path": "griffe._internal.exceptions.ExtensionError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L80-L81", "bases": [{"member": "ExtensionError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}, "ExtensionNotLoadedError": {"kind": "class", "name": "ExtensionNotLoadedError", "runtime": true, "lineno": 84, "endlineno": 85, "docstring": {"value": "Exception raised when an extension could not be loaded.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Exception raised when an extension could not be loaded."}]}, "analysis": "static", "path": "griffe._internal.exceptions.ExtensionNotLoadedError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L84-L85", "bases": [{"member": "ExtensionNotLoadedError", "name": "ExtensionError", "cls": "ExprName"}], "decorators": []}, "GitError": {"kind": "class", "name": "GitError", "runtime": true, "lineno": 88, "endlineno": 89, "docstring": {"value": "Exception raised for errors related to Git.", "lineno": 89, "endlineno": 89, "parsed": [{"kind": "text", "value": "Exception raised for errors related to Git."}]}, "analysis": "static", "path": "griffe._internal.exceptions.GitError", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/exceptions.py#L88-L89", "bases": [{"member": "GitError", "name": "GriffeError", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.exceptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/exceptions.py", "relative_package_filepath": "griffe/_internal/exceptions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/exceptions.py"}, "enumerations": {"kind": "module", "name": "enumerations", "runtime": true, "imports": {"annotations": "__future__.annotations", "Enum": "enum.Enum"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.enumerations.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Enum": {"kind": "alias", "name": "Enum", "target_path": "enum.Enum", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.enumerations.Enum", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "class", "name": "LogLevel", "runtime": true, "lineno": 8, "endlineno": 24, "docstring": {"value": "Enumeration of available log levels.", "lineno": 9, "endlineno": 9, "parsed": [{"kind": "text", "value": "Enumeration of available log levels."}]}, "members": {"trace": {"kind": "attribute", "name": "trace", "runtime": true, "lineno": 11, "endlineno": 11, "docstring": {"value": "The TRACE log level.", "lineno": 12, "endlineno": 12, "parsed": [{"kind": "text", "value": "The TRACE log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.trace", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L11-L11", "value": "'trace'"}, "debug": {"kind": "attribute", "name": "debug", "runtime": true, "lineno": 13, "endlineno": 13, "docstring": {"value": "The DEBUG log level.", "lineno": 14, "endlineno": 14, "parsed": [{"kind": "text", "value": "The DEBUG log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.debug", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L13-L13", "value": "'debug'"}, "info": {"kind": "attribute", "name": "info", "runtime": true, "lineno": 15, "endlineno": 15, "docstring": {"value": "The INFO log level.", "lineno": 16, "endlineno": 16, "parsed": [{"kind": "text", "value": "The INFO log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L15-L15", "value": "'info'"}, "success": {"kind": "attribute", "name": "success", "runtime": true, "lineno": 17, "endlineno": 17, "docstring": {"value": "The SUCCESS log level.", "lineno": 18, "endlineno": 18, "parsed": [{"kind": "text", "value": "The SUCCESS log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.success", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L17-L17", "value": "'success'"}, "warning": {"kind": "attribute", "name": "warning", "runtime": true, "lineno": 19, "endlineno": 19, "docstring": {"value": "The WARNING log level.", "lineno": 20, "endlineno": 20, "parsed": [{"kind": "text", "value": "The WARNING log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.warning", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L19-L19", "value": "'warning'"}, "error": {"kind": "attribute", "name": "error", "runtime": true, "lineno": 21, "endlineno": 21, "docstring": {"value": "The ERROR log level.", "lineno": 22, "endlineno": 22, "parsed": [{"kind": "text", "value": "The ERROR log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.error", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L21-L21", "value": "'error'"}, "critical": {"kind": "attribute", "name": "critical", "runtime": true, "lineno": 23, "endlineno": 23, "docstring": {"value": "The CRITICAL log level.", "lineno": 24, "endlineno": 24, "parsed": [{"kind": "text", "value": "The CRITICAL log level."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.LogLevel.critical", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L23-L23", "value": "'critical'"}}, "analysis": "static", "path": "griffe._internal.enumerations.LogLevel", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L8-L24", "bases": [{"member": "LogLevel", "name": "str", "cls": "ExprName"}, {"member": "LogLevel", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "DocstringSectionKind": {"kind": "class", "name": "DocstringSectionKind", "runtime": true, "lineno": 27, "endlineno": 63, "docstring": {"value": "Enumeration of the possible docstring section kinds.", "lineno": 28, "endlineno": 28, "parsed": [{"kind": "text", "value": "Enumeration of the possible docstring section kinds."}]}, "members": {"text": {"kind": "attribute", "name": "text", "runtime": true, "lineno": 30, "endlineno": 30, "docstring": {"value": "Text section.", "lineno": 31, "endlineno": 31, "parsed": [{"kind": "text", "value": "Text section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.text", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L30-L30", "value": "'text'"}, "parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 32, "endlineno": 32, "docstring": {"value": "Parameters section.", "lineno": 33, "endlineno": 33, "parsed": [{"kind": "text", "value": "Parameters section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L32-L32", "value": "'parameters'"}, "other_parameters": {"kind": "attribute", "name": "other_parameters", "runtime": true, "lineno": 34, "endlineno": 34, "docstring": {"value": "Other parameters (keyword arguments) section.", "lineno": 35, "endlineno": 35, "parsed": [{"kind": "text", "value": "Other parameters (keyword arguments) section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.other_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L34-L34", "value": "'other parameters'"}, "type_parameters": {"kind": "attribute", "name": "type_parameters", "runtime": true, "lineno": 36, "endlineno": 36, "docstring": {"value": "Type parameters section.", "lineno": 37, "endlineno": 37, "parsed": [{"kind": "text", "value": "Type parameters section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L36-L36", "value": "'type parameters'"}, "raises": {"kind": "attribute", "name": "raises", "runtime": true, "lineno": 38, "endlineno": 38, "docstring": {"value": "Raises (exceptions) section.", "lineno": 39, "endlineno": 39, "parsed": [{"kind": "text", "value": "Raises (exceptions) section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.raises", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L38-L38", "value": "'raises'"}, "warns": {"kind": "attribute", "name": "warns", "runtime": true, "lineno": 40, "endlineno": 40, "docstring": {"value": "Warnings section.", "lineno": 41, "endlineno": 41, "parsed": [{"kind": "text", "value": "Warnings section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.warns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L40-L40", "value": "'warns'"}, "returns": {"kind": "attribute", "name": "returns", "runtime": true, "lineno": 42, "endlineno": 42, "docstring": {"value": "Returned value(s) section.", "lineno": 43, "endlineno": 43, "parsed": [{"kind": "text", "value": "Returned value(s) section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.returns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L42-L42", "value": "'returns'"}, "yields": {"kind": "attribute", "name": "yields", "runtime": true, "lineno": 44, "endlineno": 44, "docstring": {"value": "Yielded value(s) (generators) section.", "lineno": 45, "endlineno": 45, "parsed": [{"kind": "text", "value": "Yielded value(s) (generators) section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.yields", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L44-L44", "value": "'yields'"}, "receives": {"kind": "attribute", "name": "receives", "runtime": true, "lineno": 46, "endlineno": 46, "docstring": {"value": "Received value(s) (generators) section.", "lineno": 47, "endlineno": 47, "parsed": [{"kind": "text", "value": "Received value(s) (generators) section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.receives", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L46-L46", "value": "'receives'"}, "examples": {"kind": "attribute", "name": "examples", "runtime": true, "lineno": 48, "endlineno": 48, "docstring": {"value": "Examples section.", "lineno": 49, "endlineno": 49, "parsed": [{"kind": "text", "value": "Examples section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.examples", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L48-L48", "value": "'examples'"}, "attributes": {"kind": "attribute", "name": "attributes", "runtime": true, "lineno": 50, "endlineno": 50, "docstring": {"value": "Attributes section.", "lineno": 51, "endlineno": 51, "parsed": [{"kind": "text", "value": "Attributes section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.attributes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L50-L50", "value": "'attributes'"}, "functions": {"kind": "attribute", "name": "functions", "runtime": true, "lineno": 52, "endlineno": 52, "docstring": {"value": "Functions section.", "lineno": 53, "endlineno": 53, "parsed": [{"kind": "text", "value": "Functions section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.functions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L52-L52", "value": "'functions'"}, "classes": {"kind": "attribute", "name": "classes", "runtime": true, "lineno": 54, "endlineno": 54, "docstring": {"value": "Classes section.", "lineno": 55, "endlineno": 55, "parsed": [{"kind": "text", "value": "Classes section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.classes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L54-L54", "value": "'classes'"}, "type_aliases": {"kind": "attribute", "name": "type_aliases", "runtime": true, "lineno": 56, "endlineno": 56, "docstring": {"value": "Type aliases section.", "lineno": 57, "endlineno": 57, "parsed": [{"kind": "text", "value": "Type aliases section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.type_aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L56-L56", "value": "'type aliases'"}, "modules": {"kind": "attribute", "name": "modules", "runtime": true, "lineno": 58, "endlineno": 58, "docstring": {"value": "Modules section.", "lineno": 59, "endlineno": 59, "parsed": [{"kind": "text", "value": "Modules section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.modules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L58-L58", "value": "'modules'"}, "deprecated": {"kind": "attribute", "name": "deprecated", "runtime": true, "lineno": 60, "endlineno": 60, "docstring": {"value": "Deprecation section.", "lineno": 61, "endlineno": 61, "parsed": [{"kind": "text", "value": "Deprecation section."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.deprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L60-L60", "value": "'deprecated'"}, "admonition": {"kind": "attribute", "name": "admonition", "runtime": true, "lineno": 62, "endlineno": 62, "docstring": {"value": "Admonition block.", "lineno": 63, "endlineno": 63, "parsed": [{"kind": "text", "value": "Admonition block."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind.admonition", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L62-L62", "value": "'admonition'"}}, "analysis": "static", "path": "griffe._internal.enumerations.DocstringSectionKind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L27-L63", "bases": [{"member": "DocstringSectionKind", "name": "str", "cls": "ExprName"}, {"member": "DocstringSectionKind", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "ParameterKind": {"kind": "class", "name": "ParameterKind", "runtime": true, "lineno": 66, "endlineno": 78, "docstring": {"value": "Enumeration of the different parameter kinds.", "lineno": 67, "endlineno": 67, "parsed": [{"kind": "text", "value": "Enumeration of the different parameter kinds."}]}, "members": {"positional_only": {"kind": "attribute", "name": "positional_only", "runtime": true, "lineno": 69, "endlineno": 69, "docstring": {"value": "Positional-only parameter.", "lineno": 70, "endlineno": 70, "parsed": [{"kind": "text", "value": "Positional-only parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind.positional_only", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L69-L69", "value": "'positional-only'"}, "positional_or_keyword": {"kind": "attribute", "name": "positional_or_keyword", "runtime": true, "lineno": 71, "endlineno": 71, "docstring": {"value": "Positional or keyword parameter.", "lineno": 72, "endlineno": 72, "parsed": [{"kind": "text", "value": "Positional or keyword parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind.positional_or_keyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L71-L71", "value": "'positional or keyword'"}, "var_positional": {"kind": "attribute", "name": "var_positional", "runtime": true, "lineno": 73, "endlineno": 73, "docstring": {"value": "Variadic positional parameter.", "lineno": 74, "endlineno": 74, "parsed": [{"kind": "text", "value": "Variadic positional parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind.var_positional", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L73-L73", "value": "'variadic positional'"}, "keyword_only": {"kind": "attribute", "name": "keyword_only", "runtime": true, "lineno": 75, "endlineno": 75, "docstring": {"value": "Keyword-only parameter.", "lineno": 76, "endlineno": 76, "parsed": [{"kind": "text", "value": "Keyword-only parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind.keyword_only", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L75-L75", "value": "'keyword-only'"}, "var_keyword": {"kind": "attribute", "name": "var_keyword", "runtime": true, "lineno": 77, "endlineno": 77, "docstring": {"value": "Variadic keyword parameter.", "lineno": 78, "endlineno": 78, "parsed": [{"kind": "text", "value": "Variadic keyword parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind.var_keyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L77-L77", "value": "'variadic keyword'"}}, "analysis": "static", "path": "griffe._internal.enumerations.ParameterKind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L66-L78", "bases": [{"member": "ParameterKind", "name": "str", "cls": "ExprName"}, {"member": "ParameterKind", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "TypeParameterKind": {"kind": "class", "name": "TypeParameterKind", "runtime": true, "lineno": 81, "endlineno": 89, "docstring": {"value": "Enumeration of the different type parameter kinds.", "lineno": 82, "endlineno": 82, "parsed": [{"kind": "text", "value": "Enumeration of the different type parameter kinds."}]}, "members": {"type_var": {"kind": "attribute", "name": "type_var", "runtime": true, "lineno": 84, "endlineno": 84, "docstring": {"value": "Type variable.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Type variable."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.TypeParameterKind.type_var", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L84-L84", "value": "'type-var'"}, "type_var_tuple": {"kind": "attribute", "name": "type_var_tuple", "runtime": true, "lineno": 86, "endlineno": 86, "docstring": {"value": "Type variable tuple.", "lineno": 87, "endlineno": 87, "parsed": [{"kind": "text", "value": "Type variable tuple."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.TypeParameterKind.type_var_tuple", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L86-L86", "value": "'type-var-tuple'"}, "param_spec": {"kind": "attribute", "name": "param_spec", "runtime": true, "lineno": 88, "endlineno": 88, "docstring": {"value": "Parameter specification variable.", "lineno": 89, "endlineno": 89, "parsed": [{"kind": "text", "value": "Parameter specification variable."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.TypeParameterKind.param_spec", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L88-L88", "value": "'param-spec'"}}, "analysis": "static", "path": "griffe._internal.enumerations.TypeParameterKind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L81-L89", "bases": [{"member": "TypeParameterKind", "name": "str", "cls": "ExprName"}, {"member": "TypeParameterKind", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "Kind": {"kind": "class", "name": "Kind", "runtime": true, "lineno": 92, "endlineno": 106, "docstring": {"value": "Enumeration of the different object kinds.", "lineno": 93, "endlineno": 93, "parsed": [{"kind": "text", "value": "Enumeration of the different object kinds."}]}, "members": {"MODULE": {"kind": "attribute", "name": "MODULE", "runtime": true, "lineno": 95, "endlineno": 95, "docstring": {"value": "Modules.", "lineno": 96, "endlineno": 96, "parsed": [{"kind": "text", "value": "Modules."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.MODULE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L95-L95", "value": "'module'"}, "CLASS": {"kind": "attribute", "name": "CLASS", "runtime": true, "lineno": 97, "endlineno": 97, "docstring": {"value": "Classes.", "lineno": 98, "endlineno": 98, "parsed": [{"kind": "text", "value": "Classes."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.CLASS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L97-L97", "value": "'class'"}, "FUNCTION": {"kind": "attribute", "name": "FUNCTION", "runtime": true, "lineno": 99, "endlineno": 99, "docstring": {"value": "Functions and methods.", "lineno": 100, "endlineno": 100, "parsed": [{"kind": "text", "value": "Functions and methods."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.FUNCTION", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L99-L99", "value": "'function'"}, "ATTRIBUTE": {"kind": "attribute", "name": "ATTRIBUTE", "runtime": true, "lineno": 101, "endlineno": 101, "docstring": {"value": "Attributes and properties.", "lineno": 102, "endlineno": 102, "parsed": [{"kind": "text", "value": "Attributes and properties."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.ATTRIBUTE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L101-L101", "value": "'attribute'"}, "ALIAS": {"kind": "attribute", "name": "ALIAS", "runtime": true, "lineno": 103, "endlineno": 103, "docstring": {"value": "Aliases (imported objects).", "lineno": 104, "endlineno": 104, "parsed": [{"kind": "text", "value": "Aliases (imported objects)."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.ALIAS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L103-L103", "value": "'alias'"}, "TYPE_ALIAS": {"kind": "attribute", "name": "TYPE_ALIAS", "runtime": true, "lineno": 105, "endlineno": 105, "docstring": {"value": "Type aliases.", "lineno": 106, "endlineno": 106, "parsed": [{"kind": "text", "value": "Type aliases."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Kind.TYPE_ALIAS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L105-L105", "value": "'type alias'"}}, "analysis": "static", "path": "griffe._internal.enumerations.Kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L92-L106", "bases": [{"member": "Kind", "name": "str", "cls": "ExprName"}, {"member": "Kind", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "ExplanationStyle": {"kind": "class", "name": "ExplanationStyle", "runtime": true, "lineno": 109, "endlineno": 119, "docstring": {"value": "Enumeration of the possible styles for explanations.", "lineno": 110, "endlineno": 110, "parsed": [{"kind": "text", "value": "Enumeration of the possible styles for explanations."}]}, "members": {"ONE_LINE": {"kind": "attribute", "name": "ONE_LINE", "runtime": true, "lineno": 112, "endlineno": 112, "docstring": {"value": "Explanations on one-line.", "lineno": 113, "endlineno": 113, "parsed": [{"kind": "text", "value": "Explanations on one-line."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ExplanationStyle.ONE_LINE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L112-L112", "value": "'oneline'"}, "VERBOSE": {"kind": "attribute", "name": "VERBOSE", "runtime": true, "lineno": 114, "endlineno": 114, "docstring": {"value": "Explanations on multiple lines.", "lineno": 115, "endlineno": 115, "parsed": [{"kind": "text", "value": "Explanations on multiple lines."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ExplanationStyle.VERBOSE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L114-L114", "value": "'verbose'"}, "MARKDOWN": {"kind": "attribute", "name": "MARKDOWN", "runtime": true, "lineno": 116, "endlineno": 116, "docstring": {"value": "Explanations in Markdown, adapted to changelogs.", "lineno": 117, "endlineno": 117, "parsed": [{"kind": "text", "value": "Explanations in Markdown, adapted to changelogs."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ExplanationStyle.MARKDOWN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L116-L116", "value": "'markdown'"}, "GITHUB": {"kind": "attribute", "name": "GITHUB", "runtime": true, "lineno": 118, "endlineno": 118, "docstring": {"value": "Explanation as GitHub workflow commands warnings, adapted to CI.", "lineno": 119, "endlineno": 119, "parsed": [{"kind": "text", "value": "Explanation as GitHub workflow commands warnings, adapted to CI."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ExplanationStyle.GITHUB", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L118-L118", "value": "'github'"}}, "analysis": "static", "path": "griffe._internal.enumerations.ExplanationStyle", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L109-L119", "bases": [{"member": "ExplanationStyle", "name": "str", "cls": "ExprName"}, {"member": "ExplanationStyle", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "BreakageKind": {"kind": "class", "name": "BreakageKind", "runtime": true, "lineno": 122, "endlineno": 148, "docstring": {"value": "Enumeration of the possible API breakages.", "lineno": 123, "endlineno": 123, "parsed": [{"kind": "text", "value": "Enumeration of the possible API breakages."}]}, "members": {"PARAMETER_MOVED": {"kind": "attribute", "name": "PARAMETER_MOVED", "runtime": true, "lineno": 125, "endlineno": 125, "docstring": {"value": "Positional parameter was moved", "lineno": 126, "endlineno": 126, "parsed": [{"kind": "text", "value": "Positional parameter was moved"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_MOVED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L125-L125", "value": "'Positional parameter was moved'"}, "PARAMETER_REMOVED": {"kind": "attribute", "name": "PARAMETER_REMOVED", "runtime": true, "lineno": 127, "endlineno": 127, "docstring": {"value": "Parameter was removed", "lineno": 128, "endlineno": 128, "parsed": [{"kind": "text", "value": "Parameter was removed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_REMOVED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L127-L127", "value": "'Parameter was removed'"}, "PARAMETER_CHANGED_KIND": {"kind": "attribute", "name": "PARAMETER_CHANGED_KIND", "runtime": true, "lineno": 129, "endlineno": 129, "docstring": {"value": "Parameter kind was changed", "lineno": 130, "endlineno": 130, "parsed": [{"kind": "text", "value": "Parameter kind was changed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_CHANGED_KIND", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L129-L129", "value": "'Parameter kind was changed'"}, "PARAMETER_CHANGED_DEFAULT": {"kind": "attribute", "name": "PARAMETER_CHANGED_DEFAULT", "runtime": true, "lineno": 131, "endlineno": 131, "docstring": {"value": "Parameter default was changed", "lineno": 132, "endlineno": 132, "parsed": [{"kind": "text", "value": "Parameter default was changed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_CHANGED_DEFAULT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L131-L131", "value": "'Parameter default was changed'"}, "PARAMETER_CHANGED_REQUIRED": {"kind": "attribute", "name": "PARAMETER_CHANGED_REQUIRED", "runtime": true, "lineno": 133, "endlineno": 133, "docstring": {"value": "Parameter is now required", "lineno": 134, "endlineno": 134, "parsed": [{"kind": "text", "value": "Parameter is now required"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_CHANGED_REQUIRED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L133-L133", "value": "'Parameter is now required'"}, "PARAMETER_ADDED_REQUIRED": {"kind": "attribute", "name": "PARAMETER_ADDED_REQUIRED", "runtime": true, "lineno": 135, "endlineno": 135, "docstring": {"value": "Parameter was added as required", "lineno": 136, "endlineno": 136, "parsed": [{"kind": "text", "value": "Parameter was added as required"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.PARAMETER_ADDED_REQUIRED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L135-L135", "value": "'Parameter was added as required'"}, "RETURN_CHANGED_TYPE": {"kind": "attribute", "name": "RETURN_CHANGED_TYPE", "runtime": true, "lineno": 137, "endlineno": 137, "docstring": {"value": "Return types are incompatible", "lineno": 138, "endlineno": 138, "parsed": [{"kind": "text", "value": "Return types are incompatible"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.RETURN_CHANGED_TYPE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L137-L137", "value": "'Return types are incompatible'"}, "OBJECT_REMOVED": {"kind": "attribute", "name": "OBJECT_REMOVED", "runtime": true, "lineno": 139, "endlineno": 139, "docstring": {"value": "Public object was removed", "lineno": 140, "endlineno": 140, "parsed": [{"kind": "text", "value": "Public object was removed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.OBJECT_REMOVED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L139-L139", "value": "'Public object was removed'"}, "OBJECT_CHANGED_KIND": {"kind": "attribute", "name": "OBJECT_CHANGED_KIND", "runtime": true, "lineno": 141, "endlineno": 141, "docstring": {"value": "Public object points to a different kind of object", "lineno": 142, "endlineno": 142, "parsed": [{"kind": "text", "value": "Public object points to a different kind of object"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.OBJECT_CHANGED_KIND", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L141-L141", "value": "'Public object points to a different kind of object'"}, "ATTRIBUTE_CHANGED_TYPE": {"kind": "attribute", "name": "ATTRIBUTE_CHANGED_TYPE", "runtime": true, "lineno": 143, "endlineno": 143, "docstring": {"value": "Attribute types are incompatible", "lineno": 144, "endlineno": 144, "parsed": [{"kind": "text", "value": "Attribute types are incompatible"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.ATTRIBUTE_CHANGED_TYPE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L143-L143", "value": "'Attribute types are incompatible'"}, "ATTRIBUTE_CHANGED_VALUE": {"kind": "attribute", "name": "ATTRIBUTE_CHANGED_VALUE", "runtime": true, "lineno": 145, "endlineno": 145, "docstring": {"value": "Attribute value was changed", "lineno": 146, "endlineno": 146, "parsed": [{"kind": "text", "value": "Attribute value was changed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.ATTRIBUTE_CHANGED_VALUE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L145-L145", "value": "'Attribute value was changed'"}, "CLASS_REMOVED_BASE": {"kind": "attribute", "name": "CLASS_REMOVED_BASE", "runtime": true, "lineno": 147, "endlineno": 147, "docstring": {"value": "Base class was removed", "lineno": 148, "endlineno": 148, "parsed": [{"kind": "text", "value": "Base class was removed"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind.CLASS_REMOVED_BASE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L147-L147", "value": "'Base class was removed'"}}, "analysis": "static", "path": "griffe._internal.enumerations.BreakageKind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L122-L148", "bases": [{"member": "BreakageKind", "name": "str", "cls": "ExprName"}, {"member": "BreakageKind", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "Parser": {"kind": "class", "name": "Parser", "runtime": true, "lineno": 151, "endlineno": 161, "docstring": {"value": "Enumeration of the different docstring parsers.", "lineno": 152, "endlineno": 152, "parsed": [{"kind": "text", "value": "Enumeration of the different docstring parsers."}]}, "members": {"auto": {"kind": "attribute", "name": "auto", "runtime": true, "lineno": 154, "endlineno": 154, "docstring": {"value": "Infer docstring parser.", "lineno": 155, "endlineno": 155, "parsed": [{"kind": "text", "value": "Infer docstring parser."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Parser.auto", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L154-L154", "value": "'auto'"}, "google": {"kind": "attribute", "name": "google", "runtime": true, "lineno": 156, "endlineno": 156, "docstring": {"value": "Google-style docstrings parser.", "lineno": 157, "endlineno": 157, "parsed": [{"kind": "text", "value": "Google-style docstrings parser."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Parser.google", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L156-L156", "value": "'google'"}, "sphinx": {"kind": "attribute", "name": "sphinx", "runtime": true, "lineno": 158, "endlineno": 158, "docstring": {"value": "Sphinx-style docstrings parser.", "lineno": 159, "endlineno": 159, "parsed": [{"kind": "text", "value": "Sphinx-style docstrings parser."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Parser.sphinx", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L158-L158", "value": "'sphinx'"}, "numpy": {"kind": "attribute", "name": "numpy", "runtime": true, "lineno": 160, "endlineno": 160, "docstring": {"value": "Numpydoc-style docstrings parser.", "lineno": 161, "endlineno": 161, "parsed": [{"kind": "text", "value": "Numpydoc-style docstrings parser."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.Parser.numpy", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L160-L160", "value": "'numpy'"}}, "analysis": "static", "path": "griffe._internal.enumerations.Parser", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L151-L161", "bases": [{"member": "Parser", "name": "str", "cls": "ExprName"}, {"member": "Parser", "name": "Enum", "cls": "ExprName"}], "decorators": []}, "ObjectKind": {"kind": "class", "name": "ObjectKind", "runtime": true, "lineno": 164, "endlineno": 199, "docstring": {"value": "Enumeration of the different runtime object kinds.", "lineno": 165, "endlineno": 165, "parsed": [{"kind": "text", "value": "Enumeration of the different runtime object kinds."}]}, "members": {"MODULE": {"kind": "attribute", "name": "MODULE", "runtime": true, "lineno": 167, "endlineno": 167, "docstring": {"value": "Modules.", "lineno": 168, "endlineno": 168, "parsed": [{"kind": "text", "value": "Modules."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.MODULE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L167-L167", "value": "'module'"}, "CLASS": {"kind": "attribute", "name": "CLASS", "runtime": true, "lineno": 169, "endlineno": 169, "docstring": {"value": "Classes.", "lineno": 170, "endlineno": 170, "parsed": [{"kind": "text", "value": "Classes."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.CLASS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L169-L169", "value": "'class'"}, "STATICMETHOD": {"kind": "attribute", "name": "STATICMETHOD", "runtime": true, "lineno": 171, "endlineno": 171, "docstring": {"value": "Static methods.", "lineno": 172, "endlineno": 172, "parsed": [{"kind": "text", "value": "Static methods."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.STATICMETHOD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L171-L171", "value": "'staticmethod'"}, "CLASSMETHOD": {"kind": "attribute", "name": "CLASSMETHOD", "runtime": true, "lineno": 173, "endlineno": 173, "docstring": {"value": "Class methods.", "lineno": 174, "endlineno": 174, "parsed": [{"kind": "text", "value": "Class methods."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.CLASSMETHOD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L173-L173", "value": "'classmethod'"}, "METHOD_DESCRIPTOR": {"kind": "attribute", "name": "METHOD_DESCRIPTOR", "runtime": true, "lineno": 175, "endlineno": 175, "docstring": {"value": "Method descriptors.", "lineno": 176, "endlineno": 176, "parsed": [{"kind": "text", "value": "Method descriptors."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.METHOD_DESCRIPTOR", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L175-L175", "value": "'method_descriptor'"}, "METHOD": {"kind": "attribute", "name": "METHOD", "runtime": true, "lineno": 177, "endlineno": 177, "docstring": {"value": "Methods.", "lineno": 178, "endlineno": 178, "parsed": [{"kind": "text", "value": "Methods."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.METHOD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L177-L177", "value": "'method'"}, "BUILTIN_METHOD": {"kind": "attribute", "name": "BUILTIN_METHOD", "runtime": true, "lineno": 179, "endlineno": 179, "docstring": {"value": "Built-in methods.", "lineno": 180, "endlineno": 180, "parsed": [{"kind": "text", "value": "Built-in methods."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.BUILTIN_METHOD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L179-L179", "value": "'builtin_method'"}, "COROUTINE": {"kind": "attribute", "name": "COROUTINE", "runtime": true, "lineno": 181, "endlineno": 181, "docstring": {"value": "Coroutines", "lineno": 182, "endlineno": 182, "parsed": [{"kind": "text", "value": "Coroutines"}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.COROUTINE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L181-L181", "value": "'coroutine'"}, "FUNCTION": {"kind": "attribute", "name": "FUNCTION", "runtime": true, "lineno": 183, "endlineno": 183, "docstring": {"value": "Functions.", "lineno": 184, "endlineno": 184, "parsed": [{"kind": "text", "value": "Functions."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.FUNCTION", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L183-L183", "value": "'function'"}, "BUILTIN_FUNCTION": {"kind": "attribute", "name": "BUILTIN_FUNCTION", "runtime": true, "lineno": 185, "endlineno": 185, "docstring": {"value": "Built-in functions.", "lineno": 186, "endlineno": 186, "parsed": [{"kind": "text", "value": "Built-in functions."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.BUILTIN_FUNCTION", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L185-L185", "value": "'builtin_function'"}, "CACHED_PROPERTY": {"kind": "attribute", "name": "CACHED_PROPERTY", "runtime": true, "lineno": 187, "endlineno": 187, "docstring": {"value": "Cached properties.", "lineno": 188, "endlineno": 188, "parsed": [{"kind": "text", "value": "Cached properties."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.CACHED_PROPERTY", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L187-L187", "value": "'cached_property'"}, "GETSET_DESCRIPTOR": {"kind": "attribute", "name": "GETSET_DESCRIPTOR", "runtime": true, "lineno": 189, "endlineno": 189, "docstring": {"value": "Get/set descriptors.", "lineno": 190, "endlineno": 190, "parsed": [{"kind": "text", "value": "Get/set descriptors."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.GETSET_DESCRIPTOR", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L189-L189", "value": "'getset_descriptor'"}, "PROPERTY": {"kind": "attribute", "name": "PROPERTY", "runtime": true, "lineno": 191, "endlineno": 191, "docstring": {"value": "Properties.", "lineno": 192, "endlineno": 192, "parsed": [{"kind": "text", "value": "Properties."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.PROPERTY", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L191-L191", "value": "'property'"}, "TYPE_ALIAS": {"kind": "attribute", "name": "TYPE_ALIAS", "runtime": true, "lineno": 193, "endlineno": 193, "docstring": {"value": "Type aliases.", "lineno": 194, "endlineno": 194, "parsed": [{"kind": "text", "value": "Type aliases."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.TYPE_ALIAS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L193-L193", "value": "'type_alias'"}, "ATTRIBUTE": {"kind": "attribute", "name": "ATTRIBUTE", "runtime": true, "lineno": 195, "endlineno": 195, "docstring": {"value": "Attributes.", "lineno": 196, "endlineno": 196, "parsed": [{"kind": "text", "value": "Attributes."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.ATTRIBUTE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L195-L195", "value": "'attribute'"}, "__str__": {"kind": "function", "name": "__str__", "runtime": true, "lineno": 198, "endlineno": 199, "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind.__str__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L198-L199", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__str__", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.enumerations.ObjectKind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/enumerations.py#L164-L199", "bases": [{"member": "ObjectKind", "name": "str", "cls": "ExprName"}, {"member": "ObjectKind", "name": "Enum", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.enumerations", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/enumerations.py", "relative_package_filepath": "griffe/_internal/enumerations.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/enumerations.py"}, "tests": {"kind": "module", "name": "tests", "runtime": true, "imports": {"annotations": "__future__.annotations", "sys": "sys", "tempfile": "tempfile", "contextmanager": "contextlib.contextmanager", "dataclass": "dataclasses.dataclass", "invalidate_caches": "importlib.invalidate_caches", "Path": "pathlib.Path", "dedent": "textwrap.dedent", "TYPE_CHECKING": "typing.TYPE_CHECKING", "inspect": "griffe._internal.agents.inspector.inspect", "visit": "griffe._internal.agents.visitor.visit", "LinesCollection": "griffe._internal.collections.LinesCollection", "load": "griffe._internal.loader.load", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "Iterator": "collections.abc.Iterator", "Mapping": "collections.abc.Mapping", "Sequence": "collections.abc.Sequence", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "Parser": "griffe._internal.enumerations.Parser", "Extensions": "griffe._internal.extensions.base.Extensions"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.tests.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.tests.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "tempfile": {"kind": "alias", "name": "tempfile", "target_path": "tempfile", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.tests.tempfile", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "contextmanager": {"kind": "alias", "name": "contextmanager", "target_path": "contextlib.contextmanager", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.tests.contextmanager", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.tests.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "invalidate_caches": {"kind": "alias", "name": "invalidate_caches", "target_path": "importlib.invalidate_caches", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.tests.invalidate_caches", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.tests.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dedent": {"kind": "alias", "name": "dedent", "target_path": "textwrap.dedent", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.tests.dedent", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.tests.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "inspect": {"kind": "alias", "name": "inspect", "target_path": "griffe._internal.agents.inspector.inspect", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.tests.inspect", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "visit": {"kind": "alias", "name": "visit", "target_path": "griffe._internal.agents.visitor.visit", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.tests.visit", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.tests.LinesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "load": {"kind": "alias", "name": "load", "target_path": "griffe._internal.loader.load", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.tests.load", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.tests.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.tests.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.tests.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Mapping": {"kind": "alias", "name": "Mapping", "target_path": "collections.abc.Mapping", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.tests.Mapping", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.tests.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.tests.ModulesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.tests.DocstringOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.tests.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": false, "inherited": false, "lineno": 27, "endlineno": 27, "analysis": "static", "path": "griffe._internal.tests.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Extensions": {"kind": "alias", "name": "Extensions", "target_path": "griffe._internal.extensions.base.Extensions", "runtime": false, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.tests.Extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_TMPDIR_PREFIX": {"kind": "attribute", "name": "_TMPDIR_PREFIX", "runtime": true, "lineno": 30, "endlineno": 30, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.tests._TMPDIR_PREFIX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L30-L30", "value": "'griffe_'"}, "TmpPackage": {"kind": "class", "name": "TmpPackage", "runtime": true, "lineno": 33, "endlineno": 50, "docstring": {"value": "A temporary package.\n\nThe `tmpdir` and `path` parameters can be passed as relative path.\nThey will be resolved to absolute paths after initialization.", "lineno": 35, "endlineno": 39, "parsed": [{"kind": "text", "value": "A temporary package.\n\nThe `tmpdir` and `path` parameters can be passed as relative path.\nThey will be resolved to absolute paths after initialization."}]}, "labels": ["dataclass"], "members": {"tmpdir": {"kind": "attribute", "name": "tmpdir", "runtime": true, "lineno": 41, "endlineno": 41, "docstring": {"value": "The temporary directory containing the package.", "lineno": 42, "endlineno": 42, "parsed": [{"kind": "text", "value": "The temporary directory containing the package."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.tests.TmpPackage.tmpdir", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L41-L41", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 43, "endlineno": 43, "docstring": {"value": "The package name, as to dynamically import it.", "lineno": 44, "endlineno": 44, "parsed": [{"kind": "text", "value": "The package name, as to dynamically import it."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.tests.TmpPackage.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L43-L43", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 45, "endlineno": 45, "docstring": {"value": "The package path.", "lineno": 46, "endlineno": 46, "parsed": [{"kind": "text", "value": "The package path."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.tests.TmpPackage.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L45-L45", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "__post_init__": {"kind": "function", "name": "__post_init__", "runtime": true, "lineno": 48, "endlineno": 50, "analysis": "static", "path": "griffe._internal.tests.TmpPackage.__post_init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L48-L50", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.tests.TmpPackage.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "tmpdir", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The temporary directory containing the package.", "lineno": 42, "endlineno": 42, "parsed": [{"kind": "text", "value": "The temporary directory containing the package."}]}}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The package name, as to dynamically import it.", "lineno": 44, "endlineno": 44, "parsed": [{"kind": "text", "value": "The package name, as to dynamically import it."}]}}, {"name": "path", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The package path.", "lineno": 46, "endlineno": 46, "parsed": [{"kind": "text", "value": "The package path."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.tests.TmpPackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L33-L50", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 33, "endlineno": 33}]}, "temporary_pyfile": {"kind": "function", "name": "temporary_pyfile", "runtime": true, "lineno": 53, "endlineno": 68, "docstring": {"value": "Create a Python file containing the given code in a temporary directory.\n\nParameters:\n    code: The code to write to the temporary file.\n    module_name: The name of the temporary module.\n\nYields:\n    module_name: The module name, as to dynamically import it.\n    module_path: The module path.", "lineno": 55, "endlineno": 64, "parsed": [{"kind": "text", "value": "Create a Python file containing the given code in a temporary directory."}, {"kind": "parameters", "value": [{"name": "code", "annotation": {"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, "description": "The code to write to the temporary file."}, {"name": "module_name", "annotation": {"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, "description": "The name of the temporary module.", "value": "'module'"}]}, {"kind": "yields", "value": [{"name": "module_name", "annotation": {"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, "description": "The module name, as to dynamically import it."}, {"name": "module_path", "annotation": {"member": "temporary_pyfile", "name": "Path", "cls": "ExprName"}, "description": "The module path."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_pyfile", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L53-L68", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 53, "endlineno": 53}], "parameters": [{"name": "code", "annotation": {"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": "'module'"}], "returns": {"left": {"member": "temporary_pyfile", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "temporary_pyfile", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_pyfile", "name": "str", "cls": "ExprName"}, {"member": "temporary_pyfile", "name": "Path", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}}, "temporary_pypackage": {"kind": "function", "name": "temporary_pypackage", "runtime": true, "lineno": 71, "endlineno": 117, "docstring": {"value": "Create a package containing the given modules in a temporary directory.\n\nParameters:\n    package: The package name. Example: `\"a\"` gives\n        a package named `a`, while `\"a/b\"` gives a namespace package\n        named `a` with a package inside named `b`.\n        If `init` is false, then `b` is also a namespace package.\n    modules: Additional modules to create in the package.\n        If a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\n        If a dict, keys are the file names and values their contents:\n        `{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.\n    init: Whether to create an `__init__` module in the top package.\n    inits: Whether to create `__init__` modules in subpackages.\n\nYields:\n    A temporary package.", "lineno": 79, "endlineno": 95, "parsed": [{"kind": "text", "value": "Create a package containing the given modules in a temporary directory."}, {"kind": "parameters", "value": [{"name": "package", "annotation": {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, "description": "The package name. Example: `\"a\"` gives\na package named `a`, while `\"a/b\"` gives a namespace package\nnamed `a` with a package inside named `b`.\nIf `init` is false, then `b` is also a namespace package."}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_pypackage", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_pypackage", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional modules to create in the package.\nIf a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\nIf a dict, keys are the file names and values their contents:\n`{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.", "value": "None"}, {"name": "init", "annotation": {"member": "temporary_pypackage", "name": "bool", "cls": "ExprName"}, "description": "Whether to create an `__init__` module in the top package.", "value": "True"}, {"name": "inits", "annotation": {"member": "temporary_pypackage", "name": "bool", "cls": "ExprName"}, "description": "Whether to create `__init__` modules in subpackages.", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "temporary_pypackage", "name": "TmpPackage", "cls": "ExprName"}, "description": "A temporary package."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_pypackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L71-L117", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 71, "endlineno": 71}], "parameters": [{"name": "package", "annotation": {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_pypackage", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_pypackage", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}, {"member": "temporary_pypackage", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "init", "annotation": {"member": "temporary_pypackage", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "inits", "annotation": {"member": "temporary_pypackage", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "temporary_pypackage", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "temporary_pypackage", "name": "TmpPackage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "temporary_visited_package": {"kind": "function", "name": "temporary_visited_package", "runtime": true, "lineno": 120, "endlineno": 185, "docstring": {"value": "Create and visit a temporary package.\n\nParameters:\n    package: The package name. Example: `\"a\"` gives\n        a package named `a`, while `\"a/b\"` gives a namespace package\n        named `a` with a package inside named `b`.\n        If `init` is false, then `b` is also a namespace package.\n    modules: Additional modules to create in the package.\n        If a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\n        If a dict, keys are the file names and values their contents:\n        `{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.\n    init: Whether to create an `__init__` module in the top package.\n    inits: Whether to create `__init__` modules in subpackages.\n    extensions: The extensions to use.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules when visiting them is not possible.\n    store_source: Whether to store code source in the lines collection.\n    resolve_aliases: Whether to resolve aliases.\n    resolve_external: Whether to try to load unspecified modules to resolve aliases.\n        Default value (`None`) means to load external modules only if they are the private sibling\n        or the origin module (for example when `ast` imports from `_ast`).\n    resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.\n    search_sys_path: Whether to search the system paths for the package.\n\nYields:\n    A module.", "lineno": 139, "endlineno": 168, "parsed": [{"kind": "text", "value": "Create and visit a temporary package."}, {"kind": "parameters", "value": [{"name": "package", "annotation": {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, "description": "The package name. Example: `\"a\"` gives\na package named `a`, while `\"a/b\"` gives a namespace package\nnamed `a` with a package inside named `b`.\nIf `init` is false, then `b` is also a namespace package."}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_visited_package", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_visited_package", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional modules to create in the package.\nIf a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\nIf a dict, keys are the file names and values their contents:\n`{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.", "value": "None"}, {"name": "init", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to create an `__init__` module in the top package.", "value": "True"}, {"name": "inits", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to create `__init__` modules in subpackages.", "value": "True"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_visited_package", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_visited_package", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_visited_package", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_visited_package", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_visited_package", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_visited_package", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules when visiting them is not possible.", "value": "False"}, {"name": "store_source", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to store code source in the lines collection.", "value": "True"}, {"name": "resolve_aliases", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to resolve aliases.", "value": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try to load unspecified modules to resolve aliases.\nDefault value (`None`) means to load external modules only if they are the private sibling\nor the origin module (for example when `ast` imports from `_ast`).", "value": "None"}, {"name": "resolve_implicit", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}, {"name": "search_sys_path", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to search the system paths for the package.", "value": "False"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "temporary_visited_package", "name": "Module", "cls": "ExprName"}, "description": "A module."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_visited_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L120-L185", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 120, "endlineno": 120}], "parameters": [{"name": "package", "annotation": {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_visited_package", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_visited_package", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}, {"member": "temporary_visited_package", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "init", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "inits", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_visited_package", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_visited_package", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_visited_package", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_visited_package", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_visited_package", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_visited_package", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "store_source", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "resolve_aliases", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "resolve_implicit", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "search_sys_path", "annotation": {"member": "temporary_visited_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "temporary_visited_package", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "temporary_visited_package", "name": "Module", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "temporary_inspected_package": {"kind": "function", "name": "temporary_inspected_package", "runtime": true, "lineno": 188, "endlineno": 259, "docstring": {"value": "Create and inspect a temporary package.\n\nParameters:\n    package: The package name. Example: `\"a\"` gives\n        a package named `a`, while `\"a/b\"` gives a namespace package\n        named `a` with a package inside named `b`.\n        If `init` is false, then `b` is also a namespace package.\n    modules: Additional modules to create in the package.\n        If a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\n        If a dict, keys are the file names and values their contents:\n        `{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.\n    init: Whether to create an `__init__` module in the top package.\n    inits: Whether to create `__init__` modules in subpackages.\n    extensions: The extensions to use.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules.\n    store_source: Whether to store code source in the lines collection.\n    resolve_aliases: Whether to resolve aliases.\n    resolve_external: Whether to try to load unspecified modules to resolve aliases.\n        Default value (`None`) means to load external modules only if they are the private sibling\n        or the origin module (for example when `ast` imports from `_ast`).\n    resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.\n    search_sys_path: Whether to search the system paths for the package.\n\nYields:\n    A module.", "lineno": 207, "endlineno": 236, "parsed": [{"kind": "text", "value": "Create and inspect a temporary package."}, {"kind": "parameters", "value": [{"name": "package", "annotation": {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, "description": "The package name. Example: `\"a\"` gives\na package named `a`, while `\"a/b\"` gives a namespace package\nnamed `a` with a package inside named `b`.\nIf `init` is false, then `b` is also a namespace package."}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_inspected_package", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_inspected_package", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional modules to create in the package.\nIf a list, simply touch the files: `[\"b.py\", \"c/d.py\", \"e/f\"]`.\nIf a dict, keys are the file names and values their contents:\n`{\"b.py\": \"b = 1\", \"c/d.py\": \"print('hey from c')\"}`.", "value": "None"}, {"name": "init", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to create an `__init__` module in the top package.", "value": "True"}, {"name": "inits", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to create `__init__` modules in subpackages.", "value": "True"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_inspected_package", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_inspected_package", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_inspected_package", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_inspected_package", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_inspected_package", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_inspected_package", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules.", "value": "True"}, {"name": "store_source", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to store code source in the lines collection.", "value": "True"}, {"name": "resolve_aliases", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to resolve aliases.", "value": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try to load unspecified modules to resolve aliases.\nDefault value (`None`) means to load external modules only if they are the private sibling\nor the origin module (for example when `ast` imports from `_ast`).", "value": "None"}, {"name": "resolve_implicit", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}, {"name": "search_sys_path", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "description": "Whether to search the system paths for the package.", "value": "False"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "temporary_inspected_package", "name": "Module", "cls": "ExprName"}, "description": "A module."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_inspected_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L188-L259", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 188, "endlineno": 188}], "parameters": [{"name": "package", "annotation": {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "modules", "annotation": {"left": {"left": {"left": {"member": "temporary_inspected_package", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "temporary_inspected_package", "name": "Mapping", "cls": "ExprName"}, "slice": {"elements": [{"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}, {"member": "temporary_inspected_package", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "init", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "inits", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_inspected_package", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_inspected_package", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_inspected_package", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_inspected_package", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_inspected_package", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_inspected_package", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "store_source", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "resolve_aliases", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "resolve_implicit", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "search_sys_path", "annotation": {"member": "temporary_inspected_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "temporary_inspected_package", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_package", "name": "Module", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "temporary_visited_module": {"kind": "function", "name": "temporary_visited_module", "runtime": true, "lineno": 262, "endlineno": 305, "docstring": {"value": "Create and visit a temporary module with the given code.\n\nParameters:\n    code: The code of the module.\n    module_name: The name of the temporary module.\n    extensions: The extensions to use when visiting the AST.\n    parent: The optional parent of this module.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n\nYields:\n    The visited module.", "lineno": 274, "endlineno": 288, "parsed": [{"kind": "text", "value": "Create and visit a temporary module with the given code."}, {"kind": "parameters", "value": [{"name": "code", "annotation": {"member": "temporary_visited_module", "name": "str", "cls": "ExprName"}, "description": "The code of the module."}, {"name": "module_name", "annotation": {"member": "temporary_visited_module", "name": "str", "cls": "ExprName"}, "description": "The name of the temporary module.", "value": "'module'"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_visited_module", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use when visiting the AST.", "value": "None"}, {"name": "parent", "annotation": {"left": {"member": "temporary_visited_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The optional parent of this module.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_visited_module", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_visited_module", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_visited_module", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_visited_module", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_visited_module", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "temporary_visited_module", "name": "Module", "cls": "ExprName"}, "description": "The visited module."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_visited_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L262-L305", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 262, "endlineno": 262}], "parameters": [{"name": "code", "annotation": {"member": "temporary_visited_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "temporary_visited_module", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": "'module'"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_visited_module", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "temporary_visited_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_visited_module", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_visited_module", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_visited_module", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_visited_module", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_visited_module", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "temporary_visited_module", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "temporary_visited_module", "name": "Module", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "temporary_inspected_module": {"kind": "function", "name": "temporary_inspected_module", "runtime": true, "lineno": 308, "endlineno": 357, "docstring": {"value": "Create and inspect a temporary module with the given code.\n\nParameters:\n    code: The code of the module.\n    module_name: The name of the temporary module.\n    import_paths: Paths to import the module from.\n    extensions: The extensions to use when visiting the AST.\n    parent: The optional parent of this module.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n\nYields:\n    The inspected module.", "lineno": 321, "endlineno": 336, "parsed": [{"kind": "text", "value": "Create and inspect a temporary module with the given code."}, {"kind": "parameters", "value": [{"name": "code", "annotation": {"member": "temporary_inspected_module", "name": "str", "cls": "ExprName"}, "description": "The code of the module."}, {"name": "module_name", "annotation": {"member": "temporary_inspected_module", "name": "str", "cls": "ExprName"}, "description": "The name of the temporary module.", "value": "'module'"}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "temporary_inspected_module", "name": "list", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Paths to import the module from.", "value": "None"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_inspected_module", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use when visiting the AST.", "value": "None"}, {"name": "parent", "annotation": {"left": {"member": "temporary_inspected_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The optional parent of this module.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_inspected_module", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_inspected_module", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_inspected_module", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_inspected_module", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_inspected_module", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "temporary_inspected_module", "name": "Module", "cls": "ExprName"}, "description": "The inspected module."}]}]}, "analysis": "static", "path": "griffe._internal.tests.temporary_inspected_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L308-L357", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 308, "endlineno": 308}], "parameters": [{"name": "code", "annotation": {"member": "temporary_inspected_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "temporary_inspected_module", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": "'module'"}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "temporary_inspected_module", "name": "list", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "extensions", "annotation": {"left": {"member": "temporary_inspected_module", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "temporary_inspected_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "temporary_inspected_module", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "temporary_inspected_module", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "temporary_inspected_module", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "temporary_inspected_module", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "temporary_inspected_module", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "temporary_inspected_module", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "temporary_inspected_module", "name": "Module", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "vtree": {"kind": "function", "name": "vtree", "runtime": true, "lineno": 360, "endlineno": 380, "docstring": {"value": "Link objects together, vertically.\n\nParameters:\n    *objects: A sequence of objects. The first one is at the top of the tree.\n    return_leaf: Whether to return the leaf instead of the root.\n\nRaises:\n    ValueError: When no objects are provided.\n\nReturns:\n    The top or leaf object.", "lineno": 361, "endlineno": 372, "parsed": [{"kind": "text", "value": "Link objects together, vertically."}, {"kind": "parameters", "value": [{"name": "*objects", "annotation": {"member": "vtree", "name": "Object", "cls": "ExprName"}, "description": "A sequence of objects. The first one is at the top of the tree.", "value": "()"}, {"name": "return_leaf", "annotation": {"member": "vtree", "name": "bool", "cls": "ExprName"}, "description": "Whether to return the leaf instead of the root.", "value": "False"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no objects are provided."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "vtree", "name": "Object", "cls": "ExprName"}, "description": "The top or leaf object."}]}]}, "analysis": "static", "path": "griffe._internal.tests.vtree", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L360-L380", "decorators": [], "parameters": [{"name": "objects", "annotation": {"member": "vtree", "name": "Object", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "return_leaf", "annotation": {"member": "vtree", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"member": "vtree", "name": "Object", "cls": "ExprName"}}, "htree": {"kind": "function", "name": "htree", "runtime": true, "lineno": 383, "endlineno": 400, "docstring": {"value": "Link objects together, horizontally.\n\nParameters:\n    *objects: A sequence of objects. All objects starting at the second become members of the first.\n\nRaises:\n    ValueError: When no objects are provided.\n\nReturns:\n    The first given object, with all the other objects as members of it.", "lineno": 384, "endlineno": 394, "parsed": [{"kind": "text", "value": "Link objects together, horizontally."}, {"kind": "parameters", "value": [{"name": "*objects", "annotation": {"member": "htree", "name": "Object", "cls": "ExprName"}, "description": "A sequence of objects. All objects starting at the second become members of the first.", "value": "()"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no objects are provided."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "htree", "name": "Object", "cls": "ExprName"}, "description": "The first given object, with all the other objects as members of it."}]}]}, "analysis": "static", "path": "griffe._internal.tests.htree", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L383-L400", "decorators": [], "parameters": [{"name": "objects", "annotation": {"member": "htree", "name": "Object", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": {"member": "htree", "name": "Object", "cls": "ExprName"}}, "module_vtree": {"kind": "function", "name": "module_vtree", "runtime": true, "lineno": 403, "endlineno": 422, "docstring": {"value": "Link objects together, vertically.\n\nParameters:\n    path: The complete module path, like `\"a.b.c.d\"`.\n    leaf_package: Whether the deepest module should also be a package.\n    return_leaf: Whether to return the leaf instead of the root.\n\nRaises:\n    ValueError: When no objects are provided.\n\nReturns:\n    The top or leaf module.", "lineno": 404, "endlineno": 416, "parsed": [{"kind": "text", "value": "Link objects together, vertically."}, {"kind": "parameters", "value": [{"name": "path", "annotation": {"member": "module_vtree", "name": "str", "cls": "ExprName"}, "description": "The complete module path, like `\"a.b.c.d\"`."}, {"name": "leaf_package", "annotation": {"member": "module_vtree", "name": "bool", "cls": "ExprName"}, "description": "Whether the deepest module should also be a package.", "value": "True"}, {"name": "return_leaf", "annotation": {"member": "module_vtree", "name": "bool", "cls": "ExprName"}, "description": "Whether to return the leaf instead of the root.", "value": "False"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no objects are provided."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "module_vtree", "name": "Module", "cls": "ExprName"}, "description": "The top or leaf module."}]}]}, "analysis": "static", "path": "griffe._internal.tests.module_vtree", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/tests.py#L403-L422", "decorators": [], "parameters": [{"name": "path", "annotation": {"member": "module_vtree", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "leaf_package", "annotation": {"member": "module_vtree", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "return_leaf", "annotation": {"member": "module_vtree", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"member": "module_vtree", "name": "Module", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.tests", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/tests.py", "relative_package_filepath": "griffe/_internal/tests.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/tests.py"}, "expressions": {"kind": "module", "name": "expressions", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "sys": "sys", "dataclass": "dataclasses.dataclass", "getfields": "dataclasses.fields", "IntEnum": "enum.IntEnum", "auto": "enum.auto", "partial": "functools.partial", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "Protocol": "typing.Protocol", "get_parameters": "griffe._internal.agents.nodes.parameters.get_parameters", "LogLevel": "griffe._internal.enumerations.LogLevel", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "NameResolutionError": "griffe._internal.exceptions.NameResolutionError", "logger": "griffe._internal.logger.logger", "Iterable": "collections.abc.Iterable", "Iterator": "collections.abc.Iterator", "Sequence": "collections.abc.Sequence", "Path": "pathlib.Path", "Class": "griffe._internal.models.Class", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.expressions.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.expressions.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.expressions.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.expressions.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "getfields": {"kind": "alias", "name": "getfields", "target_path": "dataclasses.fields", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.expressions.getfields", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "IntEnum": {"kind": "alias", "name": "IntEnum", "target_path": "enum.IntEnum", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.expressions.IntEnum", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "auto": {"kind": "alias", "name": "auto", "target_path": "enum.auto", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.expressions.auto", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "partial": {"kind": "alias", "name": "partial", "target_path": "functools.partial", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.expressions.partial", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.expressions.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.expressions.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Protocol": {"kind": "alias", "name": "Protocol", "target_path": "typing.Protocol", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.expressions.Protocol", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_parameters": {"kind": "alias", "name": "get_parameters", "target_path": "griffe._internal.agents.nodes.parameters.get_parameters", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.expressions.get_parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.expressions.LogLevel", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.expressions.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "NameResolutionError": {"kind": "alias", "name": "NameResolutionError", "target_path": "griffe._internal.exceptions.NameResolutionError", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.expressions.NameResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.expressions.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterable": {"kind": "alias", "name": "Iterable", "target_path": "collections.abc.Iterable", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.expressions.Iterable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.expressions.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.expressions.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 24, "endlineno": 24, "analysis": "static", "path": "griffe._internal.expressions.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.expressions.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.expressions.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.expressions.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_OperatorPrecedence": {"kind": "class", "name": "_OperatorPrecedence", "runtime": true, "lineno": 29, "endlineno": 63, "members": {"NONE": {"kind": "attribute", "name": "NONE", "runtime": true, "lineno": 42, "endlineno": 42, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.NONE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L42-L42", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "YIELD": {"kind": "attribute", "name": "YIELD", "runtime": true, "lineno": 44, "endlineno": 44, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.YIELD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L44-L44", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "ASSIGN": {"kind": "attribute", "name": "ASSIGN", "runtime": true, "lineno": 45, "endlineno": 45, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.ASSIGN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L45-L45", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "STARRED": {"kind": "attribute", "name": "STARRED", "runtime": true, "lineno": 46, "endlineno": 46, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.STARRED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L46-L46", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "LAMBDA": {"kind": "attribute", "name": "LAMBDA", "runtime": true, "lineno": 47, "endlineno": 47, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.LAMBDA", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L47-L47", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "IF_ELSE": {"kind": "attribute", "name": "IF_ELSE", "runtime": true, "lineno": 48, "endlineno": 48, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.IF_ELSE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L48-L48", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "OR": {"kind": "attribute", "name": "OR", "runtime": true, "lineno": 49, "endlineno": 49, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.OR", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L49-L49", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "AND": {"kind": "attribute", "name": "AND", "runtime": true, "lineno": 50, "endlineno": 50, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.AND", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L50-L50", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "NOT": {"kind": "attribute", "name": "NOT", "runtime": true, "lineno": 51, "endlineno": 51, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.NOT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L51-L51", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "COMP_MEMB_ID": {"kind": "attribute", "name": "COMP_MEMB_ID", "runtime": true, "lineno": 52, "endlineno": 52, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.COMP_MEMB_ID", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L52-L52", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "BIT_OR": {"kind": "attribute", "name": "BIT_OR", "runtime": true, "lineno": 53, "endlineno": 53, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.BIT_OR", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L53-L53", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "BIT_XOR": {"kind": "attribute", "name": "BIT_XOR", "runtime": true, "lineno": 54, "endlineno": 54, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.BIT_XOR", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L54-L54", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "BIT_AND": {"kind": "attribute", "name": "BIT_AND", "runtime": true, "lineno": 55, "endlineno": 55, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.BIT_AND", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L55-L55", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "LEFT_RIGHT_SHIFT": {"kind": "attribute", "name": "LEFT_RIGHT_SHIFT", "runtime": true, "lineno": 56, "endlineno": 56, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.LEFT_RIGHT_SHIFT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L56-L56", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "ADD_SUB": {"kind": "attribute", "name": "ADD_SUB", "runtime": true, "lineno": 57, "endlineno": 57, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.ADD_SUB", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L57-L57", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "MUL_DIV_REMAIN": {"kind": "attribute", "name": "MUL_DIV_REMAIN", "runtime": true, "lineno": 58, "endlineno": 58, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.MUL_DIV_REMAIN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L58-L58", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "POS_NEG_BIT_NOT": {"kind": "attribute", "name": "POS_NEG_BIT_NOT", "runtime": true, "lineno": 59, "endlineno": 59, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.POS_NEG_BIT_NOT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L59-L59", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "EXPONENT": {"kind": "attribute", "name": "EXPONENT", "runtime": true, "lineno": 60, "endlineno": 60, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.EXPONENT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L60-L60", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "AWAIT": {"kind": "attribute", "name": "AWAIT", "runtime": true, "lineno": 61, "endlineno": 61, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.AWAIT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L61-L61", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "CALL_ATTRIBUTE": {"kind": "attribute", "name": "CALL_ATTRIBUTE", "runtime": true, "lineno": 62, "endlineno": 62, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.CALL_ATTRIBUTE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L62-L62", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}, "ATOMIC": {"kind": "attribute", "name": "ATOMIC", "runtime": true, "lineno": 63, "endlineno": 63, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence.ATOMIC", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L63-L63", "value": {"arguments": [], "function": {"member": null, "name": "auto", "cls": "ExprName"}, "cls": "ExprCall"}}}, "analysis": "static", "path": "griffe._internal.expressions._OperatorPrecedence", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L29-L63", "bases": [{"member": "_OperatorPrecedence", "name": "IntEnum", "cls": "ExprName"}], "decorators": []}, "_yield": {"kind": "function", "name": "_yield", "runtime": true, "lineno": 66, "endlineno": 106, "analysis": "static", "path": "griffe._internal.expressions._yield", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L66-L106", "decorators": [], "parameters": [{"name": "element", "annotation": {"left": {"left": {"member": "_yield", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_yield", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "_yield", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_yield", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_yield", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "_yield", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "is_left", "annotation": {"member": "_yield", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "outer_precedence", "annotation": {"member": "_yield", "name": "_OperatorPrecedence", "cls": "ExprName"}, "kind": "keyword-only", "default": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}}], "returns": {"left": {"member": "_yield", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "_yield", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_yield", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_join": {"kind": "function", "name": "_join", "runtime": true, "lineno": 109, "endlineno": 129, "docstring": {"value": "Apply a separator between elements.\n\nThe caller is assumed to provide their own grouping\n(e.g. lists, tuples, slice) and will prevent parentheses from being added.", "lineno": 115, "endlineno": 119, "parsed": [{"kind": "text", "value": "Apply a separator between elements.\n\nThe caller is assumed to provide their own grouping\n(e.g. lists, tuples, slice) and will prevent parentheses from being added."}]}, "analysis": "static", "path": "griffe._internal.expressions._join", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L109-L129", "decorators": [], "parameters": [{"name": "elements", "annotation": {"left": {"member": "_join", "name": "Iterable", "cls": "ExprName"}, "slice": {"left": {"left": {"member": "_join", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_join", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "_join", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_join", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_join", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "joint", "annotation": {"left": {"member": "_join", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_join", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "_join", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "_join", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "_join", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_join", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_field_as_dict": {"kind": "function", "name": "_field_as_dict", "runtime": true, "lineno": 132, "endlineno": 140, "analysis": "static", "path": "griffe._internal.expressions._field_as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L132-L140", "decorators": [], "parameters": [{"name": "element", "annotation": {"left": {"left": {"left": {"left": {"member": "_field_as_dict", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "bool", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "_field_as_dict", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_field_as_dict", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_field_as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"left": {"left": {"left": {"member": "_field_as_dict", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "bool", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "list", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_field_as_dict", "name": "dict", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "_expr_as_dict": {"kind": "function", "name": "_expr_as_dict", "runtime": true, "lineno": 143, "endlineno": 150, "analysis": "static", "path": "griffe._internal.expressions._expr_as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L143-L150", "decorators": [], "parameters": [{"name": "expression", "annotation": {"member": "_expr_as_dict", "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_expr_as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_expr_as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_expr_as_dict", "name": "str", "cls": "ExprName"}, {"member": "_expr_as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_modern_types": {"kind": "attribute", "name": "_modern_types", "runtime": true, "lineno": 153, "endlineno": 158, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._modern_types", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L153-L158", "value": {"keys": ["'typing.Tuple'", "'typing.Dict'", "'typing.List'", "'typing.Set'"], "values": ["'tuple'", "'dict'", "'list'", "'set'"], "cls": "ExprDict"}}, "Expr": {"kind": "class", "name": "Expr", "runtime": true, "lineno": 161, "endlineno": 268, "docstring": {"value": "Base class for expressions.", "lineno": 163, "endlineno": 163, "parsed": [{"kind": "text", "value": "Base class for expressions."}]}, "labels": ["dataclass"], "members": {"__str__": {"kind": "function", "name": "__str__", "runtime": true, "lineno": 165, "endlineno": 166, "analysis": "static", "path": "griffe._internal.expressions.Expr.__str__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L165-L166", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__str__", "name": "str", "cls": "ExprName"}}, "__iter__": {"kind": "function", "name": "__iter__", "runtime": true, "lineno": 168, "endlineno": 170, "docstring": {"value": "Iterate on the expression syntax and elements.", "lineno": 169, "endlineno": 169, "parsed": [{"kind": "text", "value": "Iterate on the expression syntax and elements."}]}, "analysis": "static", "path": "griffe._internal.expressions.Expr.__iter__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L168-L170", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "__iter__", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "__iter__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__iter__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 172, "endlineno": 189, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.Expr.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L172-L189", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "modernize": {"kind": "function", "name": "modernize", "runtime": true, "lineno": 191, "endlineno": 199, "docstring": {"value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`.\n\nReturns:\n    A modernized expression.", "lineno": 192, "endlineno": 198, "parsed": [{"kind": "text", "value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "modernize", "name": "Expr", "cls": "ExprName"}, "description": "A modernized expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.Expr.modernize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L191-L199", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "modernize", "name": "Expr", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 201, "endlineno": 211, "docstring": {"value": "Return the expression as a dictionary.\n\nParameters:\n    **kwargs: Configuration options (none available yet).\n\n\nReturns:\n    A dictionary.", "lineno": 202, "endlineno": 210, "parsed": [{"kind": "text", "value": "Return the expression as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Configuration options (none available yet).", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.Expr.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L201-L211", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "classname": {"kind": "attribute", "name": "classname", "runtime": true, "lineno": 214, "endlineno": 216, "docstring": {"value": "The expression class name.", "lineno": 215, "endlineno": 215, "parsed": [{"kind": "text", "value": "The expression class name."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.classname", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L214-L216", "annotation": {"member": "classname", "name": "str", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 219, "endlineno": 221, "docstring": {"value": "Path of the expressed name/attribute.", "lineno": 220, "endlineno": 220, "parsed": [{"kind": "text", "value": "Path of the expressed name/attribute."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L219-L221", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 224, "endlineno": 226, "docstring": {"value": "Path of the expressed name/attribute.", "lineno": 225, "endlineno": 225, "parsed": [{"kind": "text", "value": "Path of the expressed name/attribute."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L224-L226", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "canonical_name": {"kind": "attribute", "name": "canonical_name", "runtime": true, "lineno": 229, "endlineno": 232, "docstring": {"value": "Name of the expressed name/attribute/parameter.", "lineno": 230, "endlineno": 230, "parsed": [{"kind": "text", "value": "Name of the expressed name/attribute/parameter."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.canonical_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L229-L232", "annotation": {"member": "canonical_name", "name": "str", "cls": "ExprName"}}, "is_classvar": {"kind": "attribute", "name": "is_classvar", "runtime": true, "lineno": 235, "endlineno": 237, "docstring": {"value": "Whether this attribute is annotated with `ClassVar`.", "lineno": 236, "endlineno": 236, "parsed": [{"kind": "text", "value": "Whether this attribute is annotated with `ClassVar`."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.is_classvar", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L235-L237", "annotation": {"member": "is_classvar", "name": "bool", "cls": "ExprName"}}, "is_tuple": {"kind": "attribute", "name": "is_tuple", "runtime": true, "lineno": 240, "endlineno": 242, "docstring": {"value": "Whether this expression is a tuple.", "lineno": 241, "endlineno": 241, "parsed": [{"kind": "text", "value": "Whether this expression is a tuple."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.is_tuple", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L240-L242", "annotation": {"member": "is_tuple", "name": "bool", "cls": "ExprName"}}, "is_iterator": {"kind": "attribute", "name": "is_iterator", "runtime": true, "lineno": 245, "endlineno": 247, "docstring": {"value": "Whether this expression is an iterator.", "lineno": 246, "endlineno": 246, "parsed": [{"kind": "text", "value": "Whether this expression is an iterator."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.is_iterator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L245-L247", "annotation": {"member": "is_iterator", "name": "bool", "cls": "ExprName"}}, "is_generator": {"kind": "attribute", "name": "is_generator", "runtime": true, "lineno": 250, "endlineno": 252, "docstring": {"value": "Whether this expression is a generator.", "lineno": 251, "endlineno": 251, "parsed": [{"kind": "text", "value": "Whether this expression is a generator."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.Expr.is_generator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L250-L252", "annotation": {"member": "is_generator", "name": "bool", "cls": "ExprName"}}, "_to_binop": {"kind": "function", "name": "_to_binop", "runtime": true, "lineno": 254, "endlineno": 268, "labels": ["staticmethod"], "analysis": "static", "path": "griffe._internal.expressions.Expr._to_binop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L254-L268", "decorators": [{"value": {"member": null, "name": "staticmethod", "cls": "ExprName"}, "lineno": 254, "endlineno": 254}], "parameters": [{"name": "elements", "annotation": {"left": {"member": "_to_binop", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "_to_binop", "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "op", "annotation": {"member": "_to_binop", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_to_binop", "name": "ExprBinOp", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.Expr.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.Expr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L161-L268", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 161, "endlineno": 161}]}, "ExprAttribute": {"kind": "class", "name": "ExprAttribute", "runtime": true, "lineno": 271, "endlineno": 320, "docstring": {"value": "Attributes like `a.b`.", "lineno": 273, "endlineno": 273, "parsed": [{"kind": "text", "value": "Attributes like `a.b`."}]}, "labels": ["dataclass"], "members": {"values": {"kind": "attribute", "name": "values", "runtime": true, "lineno": 275, "endlineno": 275, "docstring": {"value": "The different parts of the dotted chain.", "lineno": 276, "endlineno": 276, "parsed": [{"kind": "text", "value": "The different parts of the dotted chain."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L275-L275", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 278, "endlineno": 283, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L278-L283", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "modernize": {"kind": "function", "name": "modernize", "runtime": true, "lineno": 285, "endlineno": 288, "docstring": {"value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`.\n\nReturns:\n    A modernized expression.", "lineno": 192, "endlineno": 198, "parsed": [{"kind": "text", "value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "modernize", "name": "Expr", "cls": "ExprName"}, "description": "A modernized expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.modernize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L285-L288", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "modernize", "name": "ExprName", "cls": "ExprName"}, "operator": "|", "right": {"member": "modernize", "name": "ExprAttribute", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "append": {"kind": "function", "name": "append", "runtime": true, "lineno": 290, "endlineno": 298, "docstring": {"value": "Append a name to this attribute.\n\nParameters:\n    value: The expression name to append.", "lineno": 291, "endlineno": 295, "parsed": [{"kind": "text", "value": "Append a name to this attribute."}, {"kind": "parameters", "value": [{"name": "value", "annotation": {"member": "append", "name": "ExprName", "cls": "ExprName"}, "description": "The expression name to append."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.append", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L290-L298", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": "append", "name": "ExprName", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "last": {"kind": "attribute", "name": "last", "runtime": true, "lineno": 301, "endlineno": 305, "docstring": {"value": "The last part of this attribute (on the right).", "lineno": 302, "endlineno": 302, "parsed": [{"kind": "text", "value": "The last part of this attribute (on the right)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.last", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L301-L305", "annotation": {"member": "last", "name": "ExprName", "cls": "ExprName"}}, "first": {"kind": "attribute", "name": "first", "runtime": true, "lineno": 308, "endlineno": 310, "docstring": {"value": "The first part of this attribute (on the left).", "lineno": 309, "endlineno": 309, "parsed": [{"kind": "text", "value": "The first part of this attribute (on the left)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.first", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L308-L310", "annotation": {"left": {"member": "first", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "first", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 313, "endlineno": 315, "docstring": {"value": "The path of this attribute.", "lineno": 314, "endlineno": 314, "parsed": [{"kind": "text", "value": "The path of this attribute."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L313-L315", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 318, "endlineno": 320, "docstring": {"value": "The canonical path of this attribute.", "lineno": 319, "endlineno": 319, "parsed": [{"kind": "text", "value": "The canonical path of this attribute."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L318-L320", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprAttribute.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "values", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The different parts of the dotted chain.", "lineno": 276, "endlineno": 276, "parsed": [{"kind": "text", "value": "The different parts of the dotted chain."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprAttribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L271-L320", "bases": [{"member": "ExprAttribute", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 271, "endlineno": 271}]}, "ExprBinOp": {"kind": "class", "name": "ExprBinOp", "runtime": true, "lineno": 323, "endlineno": 342, "docstring": {"value": "Binary operations like `a + b`.", "lineno": 325, "endlineno": 325, "parsed": [{"kind": "text", "value": "Binary operations like `a + b`."}]}, "labels": ["dataclass"], "members": {"left": {"kind": "attribute", "name": "left", "runtime": true, "lineno": 327, "endlineno": 327, "docstring": {"value": "Left part.", "lineno": 328, "endlineno": 328, "parsed": [{"kind": "text", "value": "Left part."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprBinOp.left", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L327-L327", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "operator": {"kind": "attribute", "name": "operator", "runtime": true, "lineno": 329, "endlineno": 329, "docstring": {"value": "Binary operator.", "lineno": 330, "endlineno": 330, "parsed": [{"kind": "text", "value": "Binary operator."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprBinOp.operator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L329-L329", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "right": {"kind": "attribute", "name": "right", "runtime": true, "lineno": 331, "endlineno": 331, "docstring": {"value": "Right part.", "lineno": 332, "endlineno": 332, "parsed": [{"kind": "text", "value": "Right part."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprBinOp.right", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L331-L331", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 334, "endlineno": 342, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprBinOp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L334-L342", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprBinOp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "left", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Left part.", "lineno": 328, "endlineno": 328, "parsed": [{"kind": "text", "value": "Left part."}]}}, {"name": "operator", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Binary operator.", "lineno": 330, "endlineno": 330, "parsed": [{"kind": "text", "value": "Binary operator."}]}}, {"name": "right", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Right part.", "lineno": 332, "endlineno": 332, "parsed": [{"kind": "text", "value": "Right part."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprBinOp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L323-L342", "bases": [{"member": "ExprBinOp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 323, "endlineno": 323}]}, "ExprBoolOp": {"kind": "class", "name": "ExprBoolOp", "runtime": true, "lineno": 345, "endlineno": 360, "docstring": {"value": "Boolean operations like `a or b`.", "lineno": 347, "endlineno": 347, "parsed": [{"kind": "text", "value": "Boolean operations like `a or b`."}]}, "labels": ["dataclass"], "members": {"operator": {"kind": "attribute", "name": "operator", "runtime": true, "lineno": 349, "endlineno": 349, "docstring": {"value": "Boolean operator.", "lineno": 350, "endlineno": 350, "parsed": [{"kind": "text", "value": "Boolean operator."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprBoolOp.operator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L349-L349", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "values": {"kind": "attribute", "name": "values", "runtime": true, "lineno": 351, "endlineno": 351, "docstring": {"value": "Operands.", "lineno": 352, "endlineno": 352, "parsed": [{"kind": "text", "value": "Operands."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprBoolOp.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L351-L351", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 354, "endlineno": 360, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprBoolOp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L354-L360", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprBoolOp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "operator", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Boolean operator.", "lineno": 350, "endlineno": 350, "parsed": [{"kind": "text", "value": "Boolean operator."}]}}, {"name": "values", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Operands.", "lineno": 352, "endlineno": 352, "parsed": [{"kind": "text", "value": "Operands."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprBoolOp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L345-L360", "bases": [{"member": "ExprBoolOp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 345, "endlineno": 345}]}, "ExprCall": {"kind": "class", "name": "ExprCall", "runtime": true, "lineno": 363, "endlineno": 381, "docstring": {"value": "Calls like `f()`.", "lineno": 365, "endlineno": 365, "parsed": [{"kind": "text", "value": "Calls like `f()`."}]}, "labels": ["dataclass"], "members": {"function": {"kind": "attribute", "name": "function", "runtime": true, "lineno": 367, "endlineno": 367, "docstring": {"value": "Function called.", "lineno": 368, "endlineno": 368, "parsed": [{"kind": "text", "value": "Function called."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprCall.function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L367-L367", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}}, "arguments": {"kind": "attribute", "name": "arguments", "runtime": true, "lineno": 369, "endlineno": 369, "docstring": {"value": "Passed arguments.", "lineno": 370, "endlineno": 370, "parsed": [{"kind": "text", "value": "Passed arguments."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprCall.arguments", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L369-L369", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 373, "endlineno": 375, "docstring": {"value": "The canonical path of this subscript's left part.", "lineno": 374, "endlineno": 374, "parsed": [{"kind": "text", "value": "The canonical path of this subscript's left part."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprCall.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L373-L375", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 377, "endlineno": 381, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprCall.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L377-L381", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprCall.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "function", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Function called.", "lineno": 368, "endlineno": 368, "parsed": [{"kind": "text", "value": "Function called."}]}}, {"name": "arguments", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Passed arguments.", "lineno": 370, "endlineno": 370, "parsed": [{"kind": "text", "value": "Passed arguments."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprCall", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L363-L381", "bases": [{"member": "ExprCall", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 363, "endlineno": 363}]}, "ExprCompare": {"kind": "class", "name": "ExprCompare", "runtime": true, "lineno": 384, "endlineno": 400, "docstring": {"value": "Comparisons like `a > b`.", "lineno": 386, "endlineno": 386, "parsed": [{"kind": "text", "value": "Comparisons like `a > b`."}]}, "labels": ["dataclass"], "members": {"left": {"kind": "attribute", "name": "left", "runtime": true, "lineno": 388, "endlineno": 388, "docstring": {"value": "Left part.", "lineno": 389, "endlineno": 389, "parsed": [{"kind": "text", "value": "Left part."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprCompare.left", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L388-L388", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "operators": {"kind": "attribute", "name": "operators", "runtime": true, "lineno": 390, "endlineno": 390, "docstring": {"value": "Comparison operators.", "lineno": 391, "endlineno": 391, "parsed": [{"kind": "text", "value": "Comparison operators."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprCompare.operators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L390-L390", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "comparators": {"kind": "attribute", "name": "comparators", "runtime": true, "lineno": 392, "endlineno": 392, "docstring": {"value": "Things compared.", "lineno": 393, "endlineno": 393, "parsed": [{"kind": "text", "value": "Things compared."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprCompare.comparators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L392-L392", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 395, "endlineno": 400, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprCompare.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L395-L400", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprCompare.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "left", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Left part.", "lineno": 389, "endlineno": 389, "parsed": [{"kind": "text", "value": "Left part."}]}}, {"name": "operators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Comparison operators.", "lineno": 391, "endlineno": 391, "parsed": [{"kind": "text", "value": "Comparison operators."}]}}, {"name": "comparators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Things compared.", "lineno": 393, "endlineno": 393, "parsed": [{"kind": "text", "value": "Things compared."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprCompare", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L384-L400", "bases": [{"member": "ExprCompare", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 384, "endlineno": 384}]}, "ExprComprehension": {"kind": "class", "name": "ExprComprehension", "runtime": true, "lineno": 403, "endlineno": 425, "docstring": {"value": "Comprehensions like `a for b in c if d`.", "lineno": 405, "endlineno": 405, "parsed": [{"kind": "text", "value": "Comprehensions like `a for b in c if d`."}]}, "labels": ["dataclass"], "members": {"target": {"kind": "attribute", "name": "target", "runtime": true, "lineno": 407, "endlineno": 407, "docstring": {"value": "Comprehension target (value added to the result).", "lineno": 408, "endlineno": 408, "parsed": [{"kind": "text", "value": "Comprehension target (value added to the result)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension.target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L407-L407", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterable": {"kind": "attribute", "name": "iterable", "runtime": true, "lineno": 409, "endlineno": 409, "docstring": {"value": "Value iterated on.", "lineno": 410, "endlineno": 410, "parsed": [{"kind": "text", "value": "Value iterated on."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension.iterable", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L409-L409", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "conditions": {"kind": "attribute", "name": "conditions", "runtime": true, "lineno": 411, "endlineno": 411, "docstring": {"value": "Conditions to include the target in the result.", "lineno": 412, "endlineno": 412, "parsed": [{"kind": "text", "value": "Conditions to include the target in the result."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension.conditions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L411-L411", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "is_async": {"kind": "attribute", "name": "is_async", "runtime": true, "lineno": 413, "endlineno": 413, "docstring": {"value": "Async comprehension or not.", "lineno": 414, "endlineno": 414, "parsed": [{"kind": "text", "value": "Async comprehension or not."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension.is_async", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L413-L413", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 416, "endlineno": 425, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L416-L425", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprComprehension.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "target", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Comprehension target (value added to the result).", "lineno": 408, "endlineno": 408, "parsed": [{"kind": "text", "value": "Comprehension target (value added to the result)."}]}}, {"name": "iterable", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Value iterated on.", "lineno": 410, "endlineno": 410, "parsed": [{"kind": "text", "value": "Value iterated on."}]}}, {"name": "conditions", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Conditions to include the target in the result.", "lineno": 412, "endlineno": 412, "parsed": [{"kind": "text", "value": "Conditions to include the target in the result."}]}}, {"name": "is_async", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "positional or keyword", "default": "False", "docstring": {"value": "Async comprehension or not.", "lineno": 414, "endlineno": 414, "parsed": [{"kind": "text", "value": "Async comprehension or not."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprComprehension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L403-L425", "bases": [{"member": "ExprComprehension", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 403, "endlineno": 403}]}, "ExprConstant": {"kind": "class", "name": "ExprConstant", "runtime": true, "lineno": 432, "endlineno": 440, "docstring": {"value": "Constants like `\"a\"` or `1`.", "lineno": 434, "endlineno": 434, "parsed": [{"kind": "text", "value": "Constants like `\"a\"` or `1`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 436, "endlineno": 436, "docstring": {"value": "Constant value.", "lineno": 437, "endlineno": 437, "parsed": [{"kind": "text", "value": "Constant value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprConstant.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L436-L436", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 439, "endlineno": 440, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprConstant.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L439-L440", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprConstant.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Constant value.", "lineno": 437, "endlineno": 437, "parsed": [{"kind": "text", "value": "Constant value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprConstant", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L432-L440", "bases": [{"member": "ExprConstant", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 432, "endlineno": 432}]}, "ExprDict": {"kind": "class", "name": "ExprDict", "runtime": true, "lineno": 443, "endlineno": 459, "docstring": {"value": "Dictionaries like `{\"a\": 0}`.", "lineno": 445, "endlineno": 445, "parsed": [{"kind": "text", "value": "Dictionaries like `{\"a\": 0}`."}]}, "labels": ["dataclass"], "members": {"keys": {"kind": "attribute", "name": "keys", "runtime": true, "lineno": 447, "endlineno": 447, "docstring": {"value": "Dict keys.", "lineno": 448, "endlineno": 448, "parsed": [{"kind": "text", "value": "Dict keys."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprDict.keys", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L447-L447", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "values": {"kind": "attribute", "name": "values", "runtime": true, "lineno": 449, "endlineno": 449, "docstring": {"value": "Dict values.", "lineno": 450, "endlineno": 450, "parsed": [{"kind": "text", "value": "Dict values."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprDict.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L449-L449", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 452, "endlineno": 459, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprDict.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L452-L459", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprDict.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "keys", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Dict keys.", "lineno": 448, "endlineno": 448, "parsed": [{"kind": "text", "value": "Dict keys."}]}}, {"name": "values", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Dict values.", "lineno": 450, "endlineno": 450, "parsed": [{"kind": "text", "value": "Dict values."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprDict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L443-L459", "bases": [{"member": "ExprDict", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 443, "endlineno": 443}]}, "ExprDictComp": {"kind": "class", "name": "ExprDictComp", "runtime": true, "lineno": 462, "endlineno": 480, "docstring": {"value": "Dict comprehensions like `{k: v for k, v in a}`.", "lineno": 464, "endlineno": 464, "parsed": [{"kind": "text", "value": "Dict comprehensions like `{k: v for k, v in a}`."}]}, "labels": ["dataclass"], "members": {"key": {"kind": "attribute", "name": "key", "runtime": true, "lineno": 466, "endlineno": 466, "docstring": {"value": "Target key.", "lineno": 467, "endlineno": 467, "parsed": [{"kind": "text", "value": "Target key."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprDictComp.key", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L466-L466", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 468, "endlineno": 468, "docstring": {"value": "Target value.", "lineno": 469, "endlineno": 469, "parsed": [{"kind": "text", "value": "Target value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprDictComp.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L468-L468", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "generators": {"kind": "attribute", "name": "generators", "runtime": true, "lineno": 470, "endlineno": 470, "docstring": {"value": "Generators iterated on.", "lineno": 471, "endlineno": 471, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprDictComp.generators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L470-L470", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 473, "endlineno": 480, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprDictComp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L473-L480", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprDictComp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Target key.", "lineno": 467, "endlineno": 467, "parsed": [{"kind": "text", "value": "Target key."}]}}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Target value.", "lineno": 469, "endlineno": 469, "parsed": [{"kind": "text", "value": "Target value."}]}}, {"name": "generators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Generators iterated on.", "lineno": 471, "endlineno": 471, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprDictComp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L462-L480", "bases": [{"member": "ExprDictComp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 462, "endlineno": 462}]}, "ExprExtSlice": {"kind": "class", "name": "ExprExtSlice", "runtime": true, "lineno": 483, "endlineno": 491, "docstring": {"value": "Extended slice like `a[x:y, z]`.", "lineno": 485, "endlineno": 485, "parsed": [{"kind": "text", "value": "Extended slice like `a[x:y, z]`."}]}, "labels": ["dataclass"], "members": {"dims": {"kind": "attribute", "name": "dims", "runtime": true, "lineno": 487, "endlineno": 487, "docstring": {"value": "Dims.", "lineno": 488, "endlineno": 488, "parsed": [{"kind": "text", "value": "Dims."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprExtSlice.dims", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L487-L487", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 490, "endlineno": 491, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprExtSlice.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L490-L491", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprExtSlice.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "dims", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Dims.", "lineno": 488, "endlineno": 488, "parsed": [{"kind": "text", "value": "Dims."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprExtSlice", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L483-L491", "bases": [{"member": "ExprExtSlice", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 483, "endlineno": 483}]}, "ExprFormatted": {"kind": "class", "name": "ExprFormatted", "runtime": true, "lineno": 494, "endlineno": 505, "docstring": {"value": "Formatted string like `{1 + 1}`.", "lineno": 496, "endlineno": 496, "parsed": [{"kind": "text", "value": "Formatted string like `{1 + 1}`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 498, "endlineno": 498, "docstring": {"value": "Formatted value.", "lineno": 499, "endlineno": 499, "parsed": [{"kind": "text", "value": "Formatted value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprFormatted.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L498-L498", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 501, "endlineno": 505, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprFormatted.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L501-L505", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprFormatted.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Formatted value.", "lineno": 499, "endlineno": 499, "parsed": [{"kind": "text", "value": "Formatted value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprFormatted", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L494-L505", "bases": [{"member": "ExprFormatted", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 494, "endlineno": 494}]}, "ExprGeneratorExp": {"kind": "class", "name": "ExprGeneratorExp", "runtime": true, "lineno": 508, "endlineno": 520, "docstring": {"value": "Generator expressions like `a for b in c for d in e`.", "lineno": 510, "endlineno": 510, "parsed": [{"kind": "text", "value": "Generator expressions like `a for b in c for d in e`."}]}, "labels": ["dataclass"], "members": {"element": {"kind": "attribute", "name": "element", "runtime": true, "lineno": 512, "endlineno": 512, "docstring": {"value": "Yielded element.", "lineno": 513, "endlineno": 513, "parsed": [{"kind": "text", "value": "Yielded element."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprGeneratorExp.element", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L512-L512", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "generators": {"kind": "attribute", "name": "generators", "runtime": true, "lineno": 514, "endlineno": 514, "docstring": {"value": "Generators iterated on.", "lineno": 515, "endlineno": 515, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprGeneratorExp.generators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L514-L514", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 517, "endlineno": 520, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprGeneratorExp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L517-L520", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprGeneratorExp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "element", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Yielded element.", "lineno": 513, "endlineno": 513, "parsed": [{"kind": "text", "value": "Yielded element."}]}}, {"name": "generators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Generators iterated on.", "lineno": 515, "endlineno": 515, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprGeneratorExp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L508-L520", "bases": [{"member": "ExprGeneratorExp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 508, "endlineno": 508}]}, "ExprIfExp": {"kind": "class", "name": "ExprIfExp", "runtime": true, "lineno": 523, "endlineno": 549, "docstring": {"value": "Conditions like `a if b else c`.", "lineno": 525, "endlineno": 525, "parsed": [{"kind": "text", "value": "Conditions like `a if b else c`."}]}, "labels": ["dataclass"], "members": {"body": {"kind": "attribute", "name": "body", "runtime": true, "lineno": 527, "endlineno": 527, "docstring": {"value": "Value if test.", "lineno": 528, "endlineno": 528, "parsed": [{"kind": "text", "value": "Value if test."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprIfExp.body", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L527-L527", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "test": {"kind": "attribute", "name": "test", "runtime": true, "lineno": 529, "endlineno": 529, "docstring": {"value": "Condition.", "lineno": 530, "endlineno": 530, "parsed": [{"kind": "text", "value": "Condition."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprIfExp.test", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L529-L529", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "orelse": {"kind": "attribute", "name": "orelse", "runtime": true, "lineno": 531, "endlineno": 531, "docstring": {"value": "Other expression.", "lineno": 532, "endlineno": 532, "parsed": [{"kind": "text", "value": "Other expression."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprIfExp.orelse", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L531-L531", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 534, "endlineno": 549, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprIfExp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L534-L549", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprIfExp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "body", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Value if test.", "lineno": 528, "endlineno": 528, "parsed": [{"kind": "text", "value": "Value if test."}]}}, {"name": "test", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Condition.", "lineno": 530, "endlineno": 530, "parsed": [{"kind": "text", "value": "Condition."}]}}, {"name": "orelse", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Other expression.", "lineno": 532, "endlineno": 532, "parsed": [{"kind": "text", "value": "Other expression."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprIfExp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L523-L549", "bases": [{"member": "ExprIfExp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 523, "endlineno": 523}]}, "ExprInterpolation": {"kind": "class", "name": "ExprInterpolation", "runtime": true, "lineno": 552, "endlineno": 563, "docstring": {"value": "Template string interpolation like `{name}`.", "lineno": 554, "endlineno": 554, "parsed": [{"kind": "text", "value": "Template string interpolation like `{name}`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 556, "endlineno": 556, "docstring": {"value": "Interpolated value.", "lineno": 557, "endlineno": 557, "parsed": [{"kind": "text", "value": "Interpolated value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprInterpolation.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L556-L556", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 559, "endlineno": 563, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprInterpolation.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L559-L563", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprInterpolation.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Interpolated value.", "lineno": 557, "endlineno": 557, "parsed": [{"kind": "text", "value": "Interpolated value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprInterpolation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L552-L563", "bases": [{"member": "ExprInterpolation", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 552, "endlineno": 552}]}, "ExprJoinedStr": {"kind": "class", "name": "ExprJoinedStr", "runtime": true, "lineno": 566, "endlineno": 576, "docstring": {"value": "Joined strings like `f\"a {b} c\"`.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "Joined strings like `f\"a {b} c\"`."}]}, "labels": ["dataclass"], "members": {"values": {"kind": "attribute", "name": "values", "runtime": true, "lineno": 570, "endlineno": 570, "docstring": {"value": "Joined values.", "lineno": 571, "endlineno": 571, "parsed": [{"kind": "text", "value": "Joined values."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprJoinedStr.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L570-L570", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 573, "endlineno": 576, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprJoinedStr.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L573-L576", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprJoinedStr.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "values", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Joined values.", "lineno": 571, "endlineno": 571, "parsed": [{"kind": "text", "value": "Joined values."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprJoinedStr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L566-L576", "bases": [{"member": "ExprJoinedStr", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 566, "endlineno": 566}]}, "ExprKeyword": {"kind": "class", "name": "ExprKeyword", "runtime": true, "lineno": 579, "endlineno": 616, "docstring": {"value": "Keyword arguments like `a=b`.", "lineno": 581, "endlineno": 581, "parsed": [{"kind": "text", "value": "Keyword arguments like `a=b`."}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 583, "endlineno": 583, "docstring": {"value": "Name.", "lineno": 584, "endlineno": 584, "parsed": [{"kind": "text", "value": "Name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L583-L583", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 585, "endlineno": 585, "docstring": {"value": "Value.", "lineno": 586, "endlineno": 586, "parsed": [{"kind": "text", "value": "Value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L585-L585", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "function": {"kind": "attribute", "name": "function", "runtime": true, "lineno": 603, "endlineno": 603, "docstring": {"value": "Expression referencing the function called with this parameter.", "lineno": 604, "endlineno": 604, "parsed": [{"kind": "text", "value": "Expression referencing the function called with this parameter."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword.function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L603-L603", "value": "None", "annotation": {"left": {"member": null, "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 607, "endlineno": 611, "docstring": {"value": "Path of the expressed keyword.", "lineno": 608, "endlineno": 608, "parsed": [{"kind": "text", "value": "Path of the expressed keyword."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L607-L611", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 613, "endlineno": 616, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L613-L616", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprKeyword.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Name.", "lineno": 584, "endlineno": 584, "parsed": [{"kind": "text", "value": "Name."}]}}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Value.", "lineno": 586, "endlineno": 586, "parsed": [{"kind": "text", "value": "Value."}]}}, {"name": "function", "annotation": {"left": {"member": null, "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Expression referencing the function called with this parameter.", "lineno": 604, "endlineno": 604, "parsed": [{"kind": "text", "value": "Expression referencing the function called with this parameter."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprKeyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L579-L616", "bases": [{"member": "ExprKeyword", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 579, "endlineno": 579}]}, "ExprVarPositional": {"kind": "class", "name": "ExprVarPositional", "runtime": true, "lineno": 619, "endlineno": 628, "docstring": {"value": "Variadic positional parameters like `*args`.", "lineno": 621, "endlineno": 621, "parsed": [{"kind": "text", "value": "Variadic positional parameters like `*args`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 623, "endlineno": 623, "docstring": {"value": "Starred value.", "lineno": 624, "endlineno": 624, "parsed": [{"kind": "text", "value": "Starred value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprVarPositional.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L623-L623", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 626, "endlineno": 628, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprVarPositional.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L626-L628", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprVarPositional.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Starred value.", "lineno": 624, "endlineno": 624, "parsed": [{"kind": "text", "value": "Starred value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprVarPositional", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L619-L628", "bases": [{"member": "ExprVarPositional", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 619, "endlineno": 619}]}, "ExprVarKeyword": {"kind": "class", "name": "ExprVarKeyword", "runtime": true, "lineno": 631, "endlineno": 640, "docstring": {"value": "Variadic keyword parameters like `**kwargs`.", "lineno": 633, "endlineno": 633, "parsed": [{"kind": "text", "value": "Variadic keyword parameters like `**kwargs`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 635, "endlineno": 635, "docstring": {"value": "Double-starred value.", "lineno": 636, "endlineno": 636, "parsed": [{"kind": "text", "value": "Double-starred value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprVarKeyword.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L635-L635", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 638, "endlineno": 640, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprVarKeyword.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L638-L640", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprVarKeyword.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Double-starred value.", "lineno": 636, "endlineno": 636, "parsed": [{"kind": "text", "value": "Double-starred value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprVarKeyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L631-L640", "bases": [{"member": "ExprVarKeyword", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 631, "endlineno": 631}]}, "ExprLambda": {"kind": "class", "name": "ExprLambda", "runtime": true, "lineno": 643, "endlineno": 683, "docstring": {"value": "Lambda expressions like `lambda a: a.b`.", "lineno": 645, "endlineno": 645, "parsed": [{"kind": "text", "value": "Lambda expressions like `lambda a: a.b`."}]}, "labels": ["dataclass"], "members": {"parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 647, "endlineno": 647, "docstring": {"value": "Lambda's parameters.", "lineno": 648, "endlineno": 648, "parsed": [{"kind": "text", "value": "Lambda's parameters."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprLambda.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L647-L647", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "ExprParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "body": {"kind": "attribute", "name": "body", "runtime": true, "lineno": 649, "endlineno": 649, "docstring": {"value": "Lambda's body.", "lineno": 650, "endlineno": 650, "parsed": [{"kind": "text", "value": "Lambda's body."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprLambda.body", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L649-L649", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 652, "endlineno": 683, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprLambda.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L652-L683", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprLambda.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "parameters", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "ExprParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Lambda's parameters.", "lineno": 648, "endlineno": 648, "parsed": [{"kind": "text", "value": "Lambda's parameters."}]}}, {"name": "body", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Lambda's body.", "lineno": 650, "endlineno": 650, "parsed": [{"kind": "text", "value": "Lambda's body."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprLambda", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L643-L683", "bases": [{"member": "ExprLambda", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 643, "endlineno": 643}]}, "ExprList": {"kind": "class", "name": "ExprList", "runtime": true, "lineno": 686, "endlineno": 696, "docstring": {"value": "Lists like `[0, 1, 2]`.", "lineno": 688, "endlineno": 688, "parsed": [{"kind": "text", "value": "Lists like `[0, 1, 2]`."}]}, "labels": ["dataclass"], "members": {"elements": {"kind": "attribute", "name": "elements", "runtime": true, "lineno": 690, "endlineno": 690, "docstring": {"value": "List elements.", "lineno": 691, "endlineno": 691, "parsed": [{"kind": "text", "value": "List elements."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprList.elements", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L690-L690", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 693, "endlineno": 696, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprList.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L693-L696", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprList.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "elements", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "List elements.", "lineno": 691, "endlineno": 691, "parsed": [{"kind": "text", "value": "List elements."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprList", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L686-L696", "bases": [{"member": "ExprList", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 686, "endlineno": 686}]}, "ExprListComp": {"kind": "class", "name": "ExprListComp", "runtime": true, "lineno": 699, "endlineno": 713, "docstring": {"value": "List comprehensions like `[a for b in c]`.", "lineno": 701, "endlineno": 701, "parsed": [{"kind": "text", "value": "List comprehensions like `[a for b in c]`."}]}, "labels": ["dataclass"], "members": {"element": {"kind": "attribute", "name": "element", "runtime": true, "lineno": 703, "endlineno": 703, "docstring": {"value": "Target value.", "lineno": 704, "endlineno": 704, "parsed": [{"kind": "text", "value": "Target value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprListComp.element", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L703-L703", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "generators": {"kind": "attribute", "name": "generators", "runtime": true, "lineno": 705, "endlineno": 705, "docstring": {"value": "Generators iterated on.", "lineno": 706, "endlineno": 706, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprListComp.generators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L705-L705", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 708, "endlineno": 713, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprListComp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L708-L713", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprListComp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "element", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Target value.", "lineno": 704, "endlineno": 704, "parsed": [{"kind": "text", "value": "Target value."}]}}, {"name": "generators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Generators iterated on.", "lineno": 706, "endlineno": 706, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprListComp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L699-L713", "bases": [{"member": "ExprListComp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 699, "endlineno": 699}]}, "ExprName": {"kind": "class", "name": "ExprName", "runtime": true, "lineno": 716, "endlineno": 807, "docstring": {"value": "This class represents a Python object identified by a name in a given scope.", "lineno": 718, "endlineno": 718, "parsed": [{"kind": "text", "value": "This class represents a Python object identified by a name in a given scope."}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 720, "endlineno": 720, "docstring": {"value": "Actual name.", "lineno": 721, "endlineno": 721, "parsed": [{"kind": "text", "value": "Actual name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L720-L720", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 722, "endlineno": 722, "docstring": {"value": "Parent (for resolution in its scope).", "lineno": 723, "endlineno": 723, "parsed": [{"kind": "text", "value": "Parent (for resolution in its scope)."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L722-L722", "value": "None", "annotation": {"left": {"left": {"left": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Module", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Function", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "member": {"kind": "attribute", "name": "member", "runtime": true, "lineno": 724, "endlineno": 724, "docstring": {"value": "Member name (for resolution in its scope).", "lineno": 725, "endlineno": 725, "parsed": [{"kind": "text", "value": "Member name (for resolution in its scope)."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.member", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L724-L724", "value": "None", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__eq__": {"kind": "function", "name": "__eq__", "runtime": true, "lineno": 727, "endlineno": 731, "docstring": {"value": "Two name expressions are equal if they have the same `name` value (`parent` is ignored).", "lineno": 728, "endlineno": 728, "parsed": [{"kind": "text", "value": "Two name expressions are equal if they have the same `name` value (`parent` is ignored)."}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprName.__eq__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L727-L731", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "other", "annotation": {"member": "__eq__", "name": "object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__eq__", "name": "bool", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 733, "endlineno": 734, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprName.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L733-L734", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "iterate", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "modernize": {"kind": "function", "name": "modernize", "runtime": true, "lineno": 736, "endlineno": 739, "docstring": {"value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`.\n\nReturns:\n    A modernized expression.", "lineno": 192, "endlineno": 198, "parsed": [{"kind": "text", "value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "modernize", "name": "Expr", "cls": "ExprName"}, "description": "A modernized expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprName.modernize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L736-L739", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "modernize", "name": "ExprName", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 742, "endlineno": 751, "docstring": {"value": "The full, resolved name.\n\nIf it was given when creating the name, return that.\nIf a callable was given, call it and return its result.\nIt the name cannot be resolved, return the source.", "lineno": 743, "endlineno": 748, "parsed": [{"kind": "text", "value": "The full, resolved name.\n\nIf it was given when creating the name, return that.\nIf a callable was given, call it and return its result.\nIt the name cannot be resolved, return the source."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L742-L751", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 754, "endlineno": 766, "docstring": {"value": "The canonical name (resolved one, not alias name).", "lineno": 755, "endlineno": 755, "parsed": [{"kind": "text", "value": "The canonical name (resolved one, not alias name)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L754-L766", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "resolved": {"kind": "attribute", "name": "resolved", "runtime": true, "lineno": 769, "endlineno": 774, "docstring": {"value": "The resolved object this name refers to.", "lineno": 770, "endlineno": 770, "parsed": [{"kind": "text", "value": "The resolved object this name refers to."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.resolved", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L769-L774", "annotation": {"left": {"left": {"member": "resolved", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "resolved", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "is_enum_class": {"kind": "attribute", "name": "is_enum_class", "runtime": true, "lineno": 777, "endlineno": 786, "docstring": {"value": "Whether this name resolves to an enumeration class.", "lineno": 778, "endlineno": 778, "parsed": [{"kind": "text", "value": "Whether this name resolves to an enumeration class."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.is_enum_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L777-L786", "annotation": {"member": "is_enum_class", "name": "bool", "cls": "ExprName"}}, "is_enum_instance": {"kind": "attribute", "name": "is_enum_instance", "runtime": true, "lineno": 789, "endlineno": 794, "docstring": {"value": "Whether this name resolves to an enumeration instance.", "lineno": 790, "endlineno": 790, "parsed": [{"kind": "text", "value": "Whether this name resolves to an enumeration instance."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.is_enum_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L789-L794", "annotation": {"member": "is_enum_instance", "name": "bool", "cls": "ExprName"}}, "is_enum_value": {"kind": "attribute", "name": "is_enum_value", "runtime": true, "lineno": 797, "endlineno": 802, "docstring": {"value": "Whether this name resolves to an enumeration value.", "lineno": 798, "endlineno": 798, "parsed": [{"kind": "text", "value": "Whether this name resolves to an enumeration value."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.is_enum_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L797-L802", "annotation": {"member": "is_enum_value", "name": "bool", "cls": "ExprName"}}, "is_type_parameter": {"kind": "attribute", "name": "is_type_parameter", "runtime": true, "lineno": 805, "endlineno": 807, "docstring": {"value": "Whether this name resolves to a type parameter.", "lineno": 806, "endlineno": 806, "parsed": [{"kind": "text", "value": "Whether this name resolves to a type parameter."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprName.is_type_parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L805-L807", "annotation": {"member": "is_type_parameter", "name": "bool", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprName.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Actual name.", "lineno": 721, "endlineno": 721, "parsed": [{"kind": "text", "value": "Actual name."}]}}, {"name": "parent", "annotation": {"left": {"left": {"left": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Module", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Function", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Parent (for resolution in its scope).", "lineno": 723, "endlineno": 723, "parsed": [{"kind": "text", "value": "Parent (for resolution in its scope)."}]}}, {"name": "member", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Member name (for resolution in its scope).", "lineno": 725, "endlineno": 725, "parsed": [{"kind": "text", "value": "Member name (for resolution in its scope)."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprName", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L716-L807", "bases": [{"member": "ExprName", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "False", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 716, "endlineno": 716}]}, "ExprNamedExpr": {"kind": "class", "name": "ExprNamedExpr", "runtime": true, "lineno": 810, "endlineno": 822, "docstring": {"value": "Named/assignment expressions like `a := b`.", "lineno": 812, "endlineno": 812, "parsed": [{"kind": "text", "value": "Named/assignment expressions like `a := b`."}]}, "labels": ["dataclass"], "members": {"target": {"kind": "attribute", "name": "target", "runtime": true, "lineno": 814, "endlineno": 814, "docstring": {"value": "Target name.", "lineno": 815, "endlineno": 815, "parsed": [{"kind": "text", "value": "Target name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprNamedExpr.target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L814-L814", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 816, "endlineno": 816, "docstring": {"value": "Value.", "lineno": 817, "endlineno": 817, "parsed": [{"kind": "text", "value": "Value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprNamedExpr.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L816-L816", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 819, "endlineno": 822, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprNamedExpr.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L819-L822", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprNamedExpr.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "target", "annotation": {"member": null, "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Target name.", "lineno": 815, "endlineno": 815, "parsed": [{"kind": "text", "value": "Target name."}]}}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Value.", "lineno": 817, "endlineno": 817, "parsed": [{"kind": "text", "value": "Value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprNamedExpr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L810-L822", "bases": [{"member": "ExprNamedExpr", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 810, "endlineno": 810}]}, "ExprParameter": {"kind": "class", "name": "ExprParameter", "runtime": true, "lineno": 825, "endlineno": 836, "docstring": {"value": "Parameters in function signatures like `a: int = 0`.", "lineno": 827, "endlineno": 827, "parsed": [{"kind": "text", "value": "Parameters in function signatures like `a: int = 0`."}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 829, "endlineno": 829, "docstring": {"value": "Parameter name.", "lineno": 830, "endlineno": 830, "parsed": [{"kind": "text", "value": "Parameter name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprParameter.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L829-L829", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 831, "endlineno": 831, "docstring": {"value": "Parameter kind.", "lineno": 832, "endlineno": 832, "parsed": [{"kind": "text", "value": "Parameter kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprParameter.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L831-L831", "value": {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_or_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "ParameterKind", "cls": "ExprName"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 833, "endlineno": 833, "docstring": {"value": "Parameter type.", "lineno": 834, "endlineno": 834, "parsed": [{"kind": "text", "value": "Parameter type."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprParameter.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L833-L833", "value": "None", "annotation": {"left": {"member": null, "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "default": {"kind": "attribute", "name": "default", "runtime": true, "lineno": 835, "endlineno": 835, "docstring": {"value": "Parameter default.", "lineno": 836, "endlineno": 836, "parsed": [{"kind": "text", "value": "Parameter default."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprParameter.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L835-L835", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprParameter.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Parameter name.", "lineno": 830, "endlineno": 830, "parsed": [{"kind": "text", "value": "Parameter name."}]}}, {"name": "kind", "annotation": {"member": null, "name": "ParameterKind", "cls": "ExprName"}, "kind": "positional or keyword", "default": {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_or_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}, "docstring": {"value": "Parameter kind.", "lineno": 832, "endlineno": 832, "parsed": [{"kind": "text", "value": "Parameter kind."}]}}, {"name": "annotation", "annotation": {"left": {"member": null, "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Parameter type.", "lineno": 834, "endlineno": 834, "parsed": [{"kind": "text", "value": "Parameter type."}]}}, {"name": "default", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Parameter default.", "lineno": 836, "endlineno": 836, "parsed": [{"kind": "text", "value": "Parameter default."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprParameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L825-L836", "bases": [{"member": "ExprParameter", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 825, "endlineno": 825}]}, "ExprSet": {"kind": "class", "name": "ExprSet", "runtime": true, "lineno": 839, "endlineno": 849, "docstring": {"value": "Sets like `{0, 1, 2}`.", "lineno": 841, "endlineno": 841, "parsed": [{"kind": "text", "value": "Sets like `{0, 1, 2}`."}]}, "labels": ["dataclass"], "members": {"elements": {"kind": "attribute", "name": "elements", "runtime": true, "lineno": 843, "endlineno": 843, "docstring": {"value": "Set elements.", "lineno": 844, "endlineno": 844, "parsed": [{"kind": "text", "value": "Set elements."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSet.elements", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L843-L843", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 846, "endlineno": 849, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprSet.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L846-L849", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprSet.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "elements", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Set elements.", "lineno": 844, "endlineno": 844, "parsed": [{"kind": "text", "value": "Set elements."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprSet", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L839-L849", "bases": [{"member": "ExprSet", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 839, "endlineno": 839}]}, "ExprSetComp": {"kind": "class", "name": "ExprSetComp", "runtime": true, "lineno": 852, "endlineno": 866, "docstring": {"value": "Set comprehensions like `{a for b in c}`.", "lineno": 854, "endlineno": 854, "parsed": [{"kind": "text", "value": "Set comprehensions like `{a for b in c}`."}]}, "labels": ["dataclass"], "members": {"element": {"kind": "attribute", "name": "element", "runtime": true, "lineno": 856, "endlineno": 856, "docstring": {"value": "Target value.", "lineno": 857, "endlineno": 857, "parsed": [{"kind": "text", "value": "Target value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSetComp.element", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L856-L856", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "generators": {"kind": "attribute", "name": "generators", "runtime": true, "lineno": 858, "endlineno": 858, "docstring": {"value": "Generators iterated on.", "lineno": 859, "endlineno": 859, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSetComp.generators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L858-L858", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 861, "endlineno": 866, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprSetComp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L861-L866", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprSetComp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "element", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Target value.", "lineno": 857, "endlineno": 857, "parsed": [{"kind": "text", "value": "Target value."}]}}, {"name": "generators", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Generators iterated on.", "lineno": 859, "endlineno": 859, "parsed": [{"kind": "text", "value": "Generators iterated on."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprSetComp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L852-L866", "bases": [{"member": "ExprSetComp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 852, "endlineno": 852}]}, "ExprSlice": {"kind": "class", "name": "ExprSlice", "runtime": true, "lineno": 869, "endlineno": 888, "docstring": {"value": "Slices like `[a:b:c]`.", "lineno": 871, "endlineno": 871, "parsed": [{"kind": "text", "value": "Slices like `[a:b:c]`."}]}, "labels": ["dataclass"], "members": {"lower": {"kind": "attribute", "name": "lower", "runtime": true, "lineno": 873, "endlineno": 873, "docstring": {"value": "Lower bound.", "lineno": 874, "endlineno": 874, "parsed": [{"kind": "text", "value": "Lower bound."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSlice.lower", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L873-L873", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "upper": {"kind": "attribute", "name": "upper", "runtime": true, "lineno": 875, "endlineno": 875, "docstring": {"value": "Upper bound.", "lineno": 876, "endlineno": 876, "parsed": [{"kind": "text", "value": "Upper bound."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSlice.upper", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L875-L875", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "step": {"kind": "attribute", "name": "step", "runtime": true, "lineno": 877, "endlineno": 877, "docstring": {"value": "Iteration step.", "lineno": 878, "endlineno": 878, "parsed": [{"kind": "text", "value": "Iteration step."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSlice.step", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L877-L877", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 880, "endlineno": 888, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprSlice.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L880-L888", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprSlice.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "lower", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Lower bound.", "lineno": 874, "endlineno": 874, "parsed": [{"kind": "text", "value": "Lower bound."}]}}, {"name": "upper", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Upper bound.", "lineno": 876, "endlineno": 876, "parsed": [{"kind": "text", "value": "Upper bound."}]}}, {"name": "step", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Iteration step.", "lineno": 878, "endlineno": 878, "parsed": [{"kind": "text", "value": "Iteration step."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprSlice", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L869-L888", "bases": [{"member": "ExprSlice", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 869, "endlineno": 869}]}, "ExprSubscript": {"kind": "class", "name": "ExprSubscript", "runtime": true, "lineno": 891, "endlineno": 930, "docstring": {"value": "Subscripts like `a[b]`.", "lineno": 893, "endlineno": 893, "parsed": [{"kind": "text", "value": "Subscripts like `a[b]`."}]}, "labels": ["dataclass"], "members": {"left": {"kind": "attribute", "name": "left", "runtime": true, "lineno": 895, "endlineno": 895, "docstring": {"value": "Left part.", "lineno": 896, "endlineno": 896, "parsed": [{"kind": "text", "value": "Left part."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.left", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L895-L895", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "slice": {"kind": "attribute", "name": "slice", "runtime": true, "lineno": 897, "endlineno": 897, "docstring": {"value": "Slice part.", "lineno": 898, "endlineno": 898, "parsed": [{"kind": "text", "value": "Slice part."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.slice", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L897-L897", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 900, "endlineno": 905, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L900-L905", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "modernize": {"kind": "function", "name": "modernize", "runtime": true, "lineno": 907, "endlineno": 916, "docstring": {"value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`.\n\nReturns:\n    A modernized expression.", "lineno": 192, "endlineno": 198, "parsed": [{"kind": "text", "value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "modernize", "name": "Expr", "cls": "ExprName"}, "description": "A modernized expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.modernize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L907-L916", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "modernize", "name": "ExprBinOp", "cls": "ExprName"}, "operator": "|", "right": {"member": "modernize", "name": "ExprSubscript", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 919, "endlineno": 923, "docstring": {"value": "The path of this subscript's left part.", "lineno": 920, "endlineno": 920, "parsed": [{"kind": "text", "value": "The path of this subscript's left part."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L919-L923", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 926, "endlineno": 930, "docstring": {"value": "The canonical path of this subscript's left part.", "lineno": 927, "endlineno": 927, "parsed": [{"kind": "text", "value": "The canonical path of this subscript's left part."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L926-L930", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprSubscript.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "left", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Left part.", "lineno": 896, "endlineno": 896, "parsed": [{"kind": "text", "value": "Left part."}]}}, {"name": "slice", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Slice part.", "lineno": 898, "endlineno": 898, "parsed": [{"kind": "text", "value": "Slice part."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprSubscript", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L891-L930", "bases": [{"member": "ExprSubscript", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 891, "endlineno": 891}]}, "ExprTemplateStr": {"kind": "class", "name": "ExprTemplateStr", "runtime": true, "lineno": 933, "endlineno": 943, "docstring": {"value": "Template strings like `t\"a {name}\"`.", "lineno": 935, "endlineno": 935, "parsed": [{"kind": "text", "value": "Template strings like `t\"a {name}\"`."}]}, "labels": ["dataclass"], "members": {"values": {"kind": "attribute", "name": "values", "runtime": true, "lineno": 937, "endlineno": 937, "docstring": {"value": "Joined values.", "lineno": 938, "endlineno": 938, "parsed": [{"kind": "text", "value": "Joined values."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprTemplateStr.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L937-L937", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 940, "endlineno": 943, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprTemplateStr.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L940-L943", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprTemplateStr.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "values", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Joined values.", "lineno": 938, "endlineno": 938, "parsed": [{"kind": "text", "value": "Joined values."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprTemplateStr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L933-L943", "bases": [{"member": "ExprTemplateStr", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 933, "endlineno": 933}]}, "ExprTuple": {"kind": "class", "name": "ExprTuple", "runtime": true, "lineno": 946, "endlineno": 968, "docstring": {"value": "Tuples like `(0, 1, 2)`.", "lineno": 948, "endlineno": 948, "parsed": [{"kind": "text", "value": "Tuples like `(0, 1, 2)`."}]}, "labels": ["dataclass"], "members": {"elements": {"kind": "attribute", "name": "elements", "runtime": true, "lineno": 950, "endlineno": 950, "docstring": {"value": "Tuple elements.", "lineno": 951, "endlineno": 951, "parsed": [{"kind": "text", "value": "Tuple elements."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprTuple.elements", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L950-L950", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "implicit": {"kind": "attribute", "name": "implicit", "runtime": true, "lineno": 952, "endlineno": 952, "docstring": {"value": "Whether the tuple is implicit (e.g. without parentheses in a subscript's slice).", "lineno": 953, "endlineno": 953, "parsed": [{"kind": "text", "value": "Whether the tuple is implicit (e.g. without parentheses in a subscript's slice)."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprTuple.implicit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L952-L952", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 955, "endlineno": 962, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprTuple.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L955-L962", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "modernize": {"kind": "function", "name": "modernize", "runtime": true, "lineno": 964, "endlineno": 968, "docstring": {"value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`.\n\nReturns:\n    A modernized expression.", "lineno": 192, "endlineno": 198, "parsed": [{"kind": "text", "value": "Modernize the expression.\n\nFor example, use PEP 604 type unions `|` instead of `typing.Union`."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "modernize", "name": "Expr", "cls": "ExprName"}, "description": "A modernized expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprTuple.modernize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L964-L968", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "modernize", "name": "ExprTuple", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprTuple.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "elements", "annotation": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Tuple elements.", "lineno": 951, "endlineno": 951, "parsed": [{"kind": "text", "value": "Tuple elements."}]}}, {"name": "implicit", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "positional or keyword", "default": "False", "docstring": {"value": "Whether the tuple is implicit (e.g. without parentheses in a subscript's slice).", "lineno": 953, "endlineno": 953, "parsed": [{"kind": "text", "value": "Whether the tuple is implicit (e.g. without parentheses in a subscript's slice)."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprTuple", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L946-L968", "bases": [{"member": "ExprTuple", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 946, "endlineno": 946}]}, "ExprUnaryOp": {"kind": "class", "name": "ExprUnaryOp", "runtime": true, "lineno": 971, "endlineno": 984, "docstring": {"value": "Unary operations like `-1`.", "lineno": 973, "endlineno": 973, "parsed": [{"kind": "text", "value": "Unary operations like `-1`."}]}, "labels": ["dataclass"], "members": {"operator": {"kind": "attribute", "name": "operator", "runtime": true, "lineno": 975, "endlineno": 975, "docstring": {"value": "Unary operator.", "lineno": 976, "endlineno": 976, "parsed": [{"kind": "text", "value": "Unary operator."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprUnaryOp.operator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L975-L975", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 977, "endlineno": 977, "docstring": {"value": "Value.", "lineno": 978, "endlineno": 978, "parsed": [{"kind": "text", "value": "Value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprUnaryOp.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L977-L977", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 980, "endlineno": 984, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprUnaryOp.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L980-L984", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprUnaryOp.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "operator", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Unary operator.", "lineno": 976, "endlineno": 976, "parsed": [{"kind": "text", "value": "Unary operator."}]}}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Value.", "lineno": 978, "endlineno": 978, "parsed": [{"kind": "text", "value": "Value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprUnaryOp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L971-L984", "bases": [{"member": "ExprUnaryOp", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 971, "endlineno": 971}]}, "ExprYield": {"kind": "class", "name": "ExprYield", "runtime": true, "lineno": 987, "endlineno": 998, "docstring": {"value": "Yield statements like `yield a`.", "lineno": 989, "endlineno": 989, "parsed": [{"kind": "text", "value": "Yield statements like `yield a`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 991, "endlineno": 991, "docstring": {"value": "Yielded value.", "lineno": 992, "endlineno": 992, "parsed": [{"kind": "text", "value": "Yielded value."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprYield.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L991-L991", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 994, "endlineno": 998, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprYield.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L994-L998", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprYield.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Yielded value.", "lineno": 992, "endlineno": 992, "parsed": [{"kind": "text", "value": "Yielded value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprYield", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L987-L998", "bases": [{"member": "ExprYield", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 987, "endlineno": 987}]}, "ExprYieldFrom": {"kind": "class", "name": "ExprYieldFrom", "runtime": true, "lineno": 1001, "endlineno": 1010, "docstring": {"value": "Yield statements like `yield from a`.", "lineno": 1003, "endlineno": 1003, "parsed": [{"kind": "text", "value": "Yield statements like `yield from a`."}]}, "labels": ["dataclass"], "members": {"value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 1005, "endlineno": 1005, "docstring": {"value": "Yielded-from value.", "lineno": 1006, "endlineno": 1006, "parsed": [{"kind": "text", "value": "Yielded-from value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.expressions.ExprYieldFrom.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1005-L1005", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iterate": {"kind": "function", "name": "iterate", "runtime": true, "lineno": 1008, "endlineno": 1010, "docstring": {"value": "Iterate on the expression elements.\n\nParameters:\n    flat: Expressions are trees.\n\n        When flat is false, this method iterates only on the first layer of the tree.\n        To iterate on all the subparts of the expression, you have to do so recursively.\n        It allows to handle each subpart specifically (for example subscripts, attribute, etc.),\n        without them getting rendered as strings.\n\n        On the contrary, when flat is true, the whole tree is flattened as a sequence\n        of strings and instances of [Names][griffe.ExprName].\n\nYields:\n    Strings and names when flat, strings and expressions otherwise.", "lineno": 173, "endlineno": 188, "parsed": [{"kind": "text", "value": "Iterate on the expression elements."}, {"kind": "parameters", "value": [{"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "description": "Expressions are trees.\n\nWhen flat is false, this method iterates only on the first layer of the tree.\nTo iterate on all the subparts of the expression, you have to do so recursively.\nIt allows to handle each subpart specifically (for example subscripts, attribute, etc.),\nwithout them getting rendered as strings.\n\nOn the contrary, when flat is true, the whole tree is flattened as a sequence\nof strings and instances of [Names][griffe.ExprName].", "value": "True"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Strings and names when flat, strings and expressions otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.ExprYieldFrom.iterate", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1008-L1010", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "flat", "annotation": {"member": "iterate", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "iterate", "name": "Iterator", "cls": "ExprName"}, "slice": {"left": {"member": "iterate", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "iterate", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.expressions.ExprYieldFrom.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Yielded-from value.", "lineno": 1006, "endlineno": 1006, "parsed": [{"kind": "text", "value": "Yielded-from value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.expressions.ExprYieldFrom", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1001-L1010", "bases": [{"member": "ExprYieldFrom", "name": "Expr", "cls": "ExprName"}], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "eq", "value": "True", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "slots", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 1001, "endlineno": 1001}]}, "_unary_op_map": {"kind": "attribute", "name": "_unary_op_map", "runtime": true, "lineno": 1013, "endlineno": 1018, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._unary_op_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1013-L1018", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Invert", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Not", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "UAdd", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "USub", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": ["'~'", "'not'", "'+'", "'-'"], "cls": "ExprDict"}}, "_binary_op_map": {"kind": "attribute", "name": "_binary_op_map", "runtime": true, "lineno": 1020, "endlineno": 1034, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._binary_op_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1020-L1034", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Add", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BitAnd", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BitOr", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BitXor", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Div", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FloorDiv", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "LShift", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "MatMult", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Mod", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Mult", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Pow", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "RShift", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Sub", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": ["'+'", "'&'", "'|'", "'^'", "'/'", "'//'", "'<<'", "'@'", "'%'", "'*'", "'**'", "'>>'", "'-'"], "cls": "ExprDict"}}, "_bool_op_map": {"kind": "attribute", "name": "_bool_op_map", "runtime": true, "lineno": 1036, "endlineno": 1039, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._bool_op_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1036-L1039", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "And", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Or", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": ["'and'", "'or'"], "cls": "ExprDict"}}, "_compare_op_map": {"kind": "attribute", "name": "_compare_op_map", "runtime": true, "lineno": 1041, "endlineno": 1052, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._compare_op_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1041-L1052", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Eq", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "NotEq", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Lt", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "LtE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Gt", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "GtE", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Is", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "IsNot", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "In", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "NotIn", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": ["'=='", "'!='", "'<'", "'<='", "'>'", "'>='", "'is'", "'is not'", "'in'", "'not in'"], "cls": "ExprDict"}}, "_precedence_map": {"kind": "attribute", "name": "_precedence_map", "runtime": true, "lineno": 1055, "endlineno": 1107, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._precedence_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1055-L1107", "value": {"keys": [{"member": null, "name": "ExprName", "cls": "ExprName"}, {"member": null, "name": "ExprConstant", "cls": "ExprName"}, {"member": null, "name": "ExprJoinedStr", "cls": "ExprName"}, {"member": null, "name": "ExprFormatted", "cls": "ExprName"}, {"member": null, "name": "ExprList", "cls": "ExprName"}, {"member": null, "name": "ExprTuple", "cls": "ExprName"}, {"member": null, "name": "ExprSet", "cls": "ExprName"}, {"member": null, "name": "ExprDict", "cls": "ExprName"}, {"member": null, "name": "ExprListComp", "cls": "ExprName"}, {"member": null, "name": "ExprSetComp", "cls": "ExprName"}, {"member": null, "name": "ExprDictComp", "cls": "ExprName"}, {"member": null, "name": "ExprAttribute", "cls": "ExprName"}, {"member": null, "name": "ExprSubscript", "cls": "ExprName"}, {"member": null, "name": "ExprCall", "cls": "ExprName"}, {"member": null, "name": "ExprUnaryOp", "cls": "ExprName"}, {"member": null, "name": "ExprBinOp", "cls": "ExprName"}, {"member": null, "name": "ExprBoolOp", "cls": "ExprName"}, {"member": null, "name": "ExprCompare", "cls": "ExprName"}, {"member": null, "name": "ExprIfExp", "cls": "ExprName"}, {"member": null, "name": "ExprNamedExpr", "cls": "ExprName"}, {"member": null, "name": "ExprLambda", "cls": "ExprName"}, {"member": null, "name": "ExprGeneratorExp", "cls": "ExprName"}, {"member": null, "name": "ExprVarPositional", "cls": "ExprName"}, {"member": null, "name": "ExprVarKeyword", "cls": "ExprName"}, {"member": null, "name": "ExprYield", "cls": "ExprName"}, {"member": null, "name": "ExprYieldFrom", "cls": "ExprName"}, {"member": null, "name": "ExprComprehension", "cls": "ExprName"}, {"member": null, "name": "ExprExtSlice", "cls": "ExprName"}, {"member": null, "name": "ExprKeyword", "cls": "ExprName"}, {"member": null, "name": "ExprParameter", "cls": "ExprName"}, {"member": null, "name": "ExprSlice", "cls": "ExprName"}], "values": [{"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ATOMIC", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "CALL_ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "CALL_ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "CALL_ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"arguments": [{"values": [{"member": null, "name": "e", "cls": "ExprName"}, {"member": null, "name": "operator", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "POS_NEG_BIT_NOT", "cls": "ExprName"}], "cls": "ExprAttribute"}], "function": {"values": [{"keys": ["'not'"], "values": [{"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NOT", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}, {"member": null, "name": "get", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "e", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"left": {"keys": ["'**'", "'*'", "'@'", "'/'", "'//'", "'%'", "'+'", "'-'", "'<<'", "'>>'", "'&'", "'^'", "'|'"], "values": [{"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "EXPONENT", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "MUL_DIV_REMAIN", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "MUL_DIV_REMAIN", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "MUL_DIV_REMAIN", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "MUL_DIV_REMAIN", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "MUL_DIV_REMAIN", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ADD_SUB", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ADD_SUB", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "LEFT_RIGHT_SHIFT", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "LEFT_RIGHT_SHIFT", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "BIT_AND", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "BIT_XOR", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "BIT_OR", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}, "slice": {"values": [{"member": null, "name": "e", "cls": "ExprName"}, {"member": null, "name": "operator", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprSubscript"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "e", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"left": {"keys": ["'and'", "'or'"], "values": [{"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "AND", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "OR", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}, "slice": {"values": [{"member": null, "name": "e", "cls": "ExprName"}, {"member": null, "name": "operator", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprSubscript"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "e", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "COMP_MEMB_ID", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "IF_ELSE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "ASSIGN", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "LAMBDA", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "LAMBDA", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "STARRED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "STARRED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "YIELD", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "YIELD", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NONE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NONE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NONE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NONE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"member": null, "name": "_OperatorPrecedence", "cls": "ExprName"}, {"member": null, "name": "NONE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "_", "cls": "ExprParameter"}], "cls": "ExprLambda"}], "cls": "ExprDict"}}, "_get_precedence": {"kind": "function", "name": "_get_precedence", "runtime": true, "lineno": 1110, "endlineno": 1111, "analysis": "static", "path": "griffe._internal.expressions._get_precedence", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1110-L1111", "decorators": [], "parameters": [{"name": "expr", "annotation": {"member": "_get_precedence", "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_precedence", "name": "_OperatorPrecedence", "cls": "ExprName"}}, "_build_attribute": {"kind": "function", "name": "_build_attribute", "runtime": true, "lineno": 1114, "endlineno": 1123, "analysis": "static", "path": "griffe._internal.expressions._build_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1114-L1123", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_attribute", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_attribute", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_attribute", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_attribute", "name": "Expr", "cls": "ExprName"}}, "_build_binop": {"kind": "function", "name": "_build_binop", "runtime": true, "lineno": 1126, "endlineno": 1131, "analysis": "static", "path": "griffe._internal.expressions._build_binop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1126-L1131", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_binop", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BinOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_binop", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_binop", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_binop", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_binop", "name": "Expr", "cls": "ExprName"}}, "_build_boolop": {"kind": "function", "name": "_build_boolop", "runtime": true, "lineno": 1134, "endlineno": 1138, "analysis": "static", "path": "griffe._internal.expressions._build_boolop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1134-L1138", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_boolop", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BoolOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_boolop", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_boolop", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_boolop", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_boolop", "name": "Expr", "cls": "ExprName"}}, "_build_call": {"kind": "function", "name": "_build_call", "runtime": true, "lineno": 1141, "endlineno": 1145, "analysis": "static", "path": "griffe._internal.expressions._build_call", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1141-L1145", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_call", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Call", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_call", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_call", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_call", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_call", "name": "Expr", "cls": "ExprName"}}, "_build_compare": {"kind": "function", "name": "_build_compare", "runtime": true, "lineno": 1148, "endlineno": 1153, "analysis": "static", "path": "griffe._internal.expressions._build_compare", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1148-L1153", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_compare", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Compare", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_compare", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_compare", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_compare", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_compare", "name": "Expr", "cls": "ExprName"}}, "_build_comprehension": {"kind": "function", "name": "_build_comprehension", "runtime": true, "lineno": 1156, "endlineno": 1162, "analysis": "static", "path": "griffe._internal.expressions._build_comprehension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1156-L1162", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_comprehension", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "comprehension", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_comprehension", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_comprehension", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_comprehension", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_comprehension", "name": "Expr", "cls": "ExprName"}}, "_build_constant": {"kind": "function", "name": "_build_constant", "runtime": true, "lineno": 1165, "endlineno": 1201, "analysis": "static", "path": "griffe._internal.expressions._build_constant", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1165-L1201", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_constant", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Constant", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_constant", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_constant", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "in_formatted_str", "annotation": {"member": "_build_constant", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "in_joined_str", "annotation": {"member": "_build_constant", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "parse_strings", "annotation": {"member": "_build_constant", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "literal_strings", "annotation": {"member": "_build_constant", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "_build_constant", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_build_constant", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_constant", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "_build_dict": {"kind": "function", "name": "_build_dict", "runtime": true, "lineno": 1204, "endlineno": 1208, "analysis": "static", "path": "griffe._internal.expressions._build_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1204-L1208", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_dict", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Dict", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_dict", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_dict", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_dict", "name": "Expr", "cls": "ExprName"}}, "_build_dictcomp": {"kind": "function", "name": "_build_dictcomp", "runtime": true, "lineno": 1211, "endlineno": 1216, "analysis": "static", "path": "griffe._internal.expressions._build_dictcomp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1211-L1216", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_dictcomp", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "DictComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_dictcomp", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_dictcomp", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_dictcomp", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_dictcomp", "name": "Expr", "cls": "ExprName"}}, "_build_formatted": {"kind": "function", "name": "_build_formatted", "runtime": true, "lineno": 1219, "endlineno": 1226, "analysis": "static", "path": "griffe._internal.expressions._build_formatted", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1219-L1226", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_formatted", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FormattedValue", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_formatted", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_formatted", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "in_formatted_str", "annotation": {"member": "_build_formatted", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "_build_formatted", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_formatted", "name": "Expr", "cls": "ExprName"}}, "_build_generatorexp": {"kind": "function", "name": "_build_generatorexp", "runtime": true, "lineno": 1229, "endlineno": 1233, "analysis": "static", "path": "griffe._internal.expressions._build_generatorexp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1229-L1233", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_generatorexp", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "GeneratorExp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_generatorexp", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_generatorexp", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_generatorexp", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_generatorexp", "name": "Expr", "cls": "ExprName"}}, "_build_ifexp": {"kind": "function", "name": "_build_ifexp", "runtime": true, "lineno": 1236, "endlineno": 1241, "analysis": "static", "path": "griffe._internal.expressions._build_ifexp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1236-L1241", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_ifexp", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "IfExp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_ifexp", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_ifexp", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_ifexp", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_ifexp", "name": "Expr", "cls": "ExprName"}}, "_build_joinedstr": {"kind": "function", "name": "_build_joinedstr", "runtime": true, "lineno": 1244, "endlineno": 1251, "analysis": "static", "path": "griffe._internal.expressions._build_joinedstr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1244-L1251", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_joinedstr", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "JoinedStr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_joinedstr", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_joinedstr", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "in_joined_str", "annotation": {"member": "_build_joinedstr", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "_build_joinedstr", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_joinedstr", "name": "Expr", "cls": "ExprName"}}, "_build_keyword": {"kind": "function", "name": "_build_keyword", "runtime": true, "lineno": 1254, "endlineno": 1257, "analysis": "static", "path": "griffe._internal.expressions._build_keyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1254-L1257", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_keyword", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_keyword", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_keyword", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "function", "annotation": {"left": {"member": "_build_keyword", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "kwargs", "annotation": {"member": "_build_keyword", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_keyword", "name": "Expr", "cls": "ExprName"}}, "_build_lambda": {"kind": "function", "name": "_build_lambda", "runtime": true, "lineno": 1260, "endlineno": 1274, "analysis": "static", "path": "griffe._internal.expressions._build_lambda", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1260-L1274", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_lambda", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Lambda", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_lambda", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_lambda", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_lambda", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_lambda", "name": "Expr", "cls": "ExprName"}}, "_build_list": {"kind": "function", "name": "_build_list", "runtime": true, "lineno": 1277, "endlineno": 1278, "analysis": "static", "path": "griffe._internal.expressions._build_list", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1277-L1278", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_list", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "List", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_list", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_list", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_list", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_list", "name": "Expr", "cls": "ExprName"}}, "_build_listcomp": {"kind": "function", "name": "_build_listcomp", "runtime": true, "lineno": 1281, "endlineno": 1282, "analysis": "static", "path": "griffe._internal.expressions._build_listcomp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1281-L1282", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_listcomp", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ListComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_listcomp", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_listcomp", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_listcomp", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_listcomp", "name": "Expr", "cls": "ExprName"}}, "_build_name": {"kind": "function", "name": "_build_name", "runtime": true, "lineno": 1285, "endlineno": 1286, "analysis": "static", "path": "griffe._internal.expressions._build_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1285-L1286", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_name", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_name", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "member", "annotation": {"left": {"member": "_build_name", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "kwargs", "annotation": {"member": "_build_name", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_name", "name": "Expr", "cls": "ExprName"}}, "_build_named_expr": {"kind": "function", "name": "_build_named_expr", "runtime": true, "lineno": 1289, "endlineno": 1290, "analysis": "static", "path": "griffe._internal.expressions._build_named_expr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1289-L1290", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_named_expr", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "NamedExpr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_named_expr", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_named_expr", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_named_expr", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_named_expr", "name": "Expr", "cls": "ExprName"}}, "_build_set": {"kind": "function", "name": "_build_set", "runtime": true, "lineno": 1293, "endlineno": 1294, "analysis": "static", "path": "griffe._internal.expressions._build_set", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1293-L1294", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_set", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Set", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_set", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_set", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_set", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_set", "name": "Expr", "cls": "ExprName"}}, "_build_setcomp": {"kind": "function", "name": "_build_setcomp", "runtime": true, "lineno": 1297, "endlineno": 1298, "analysis": "static", "path": "griffe._internal.expressions._build_setcomp", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1297-L1298", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_setcomp", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "SetComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_setcomp", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_setcomp", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_setcomp", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_setcomp", "name": "Expr", "cls": "ExprName"}}, "_build_slice": {"kind": "function", "name": "_build_slice", "runtime": true, "lineno": 1301, "endlineno": 1306, "analysis": "static", "path": "griffe._internal.expressions._build_slice", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1301-L1306", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_slice", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Slice", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_slice", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_slice", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_slice", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_slice", "name": "Expr", "cls": "ExprName"}}, "_build_starred": {"kind": "function", "name": "_build_starred", "runtime": true, "lineno": 1309, "endlineno": 1310, "analysis": "static", "path": "griffe._internal.expressions._build_starred", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1309-L1310", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_starred", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Starred", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_starred", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_starred", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_starred", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_starred", "name": "Expr", "cls": "ExprName"}}, "_build_subscript": {"kind": "function", "name": "_build_subscript", "runtime": true, "lineno": 1313, "endlineno": 1339, "analysis": "static", "path": "griffe._internal.expressions._build_subscript", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1313-L1339", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_subscript", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Subscript", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_subscript", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_subscript", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parse_strings", "annotation": {"member": "_build_subscript", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "literal_strings", "annotation": {"member": "_build_subscript", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "subscript_slice", "annotation": {"member": "_build_subscript", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "_build_subscript", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_subscript", "name": "Expr", "cls": "ExprName"}}, "_build_tuple": {"kind": "function", "name": "_build_tuple", "runtime": true, "lineno": 1342, "endlineno": 1350, "analysis": "static", "path": "griffe._internal.expressions._build_tuple", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1342-L1350", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_tuple", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_tuple", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_tuple", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "subscript_slice", "annotation": {"member": "_build_tuple", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "compr_target", "annotation": {"member": "_build_tuple", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "_build_tuple", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_tuple", "name": "Expr", "cls": "ExprName"}}, "_build_unaryop": {"kind": "function", "name": "_build_unaryop", "runtime": true, "lineno": 1353, "endlineno": 1354, "analysis": "static", "path": "griffe._internal.expressions._build_unaryop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1353-L1354", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_unaryop", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "UnaryOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_unaryop", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_unaryop", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_unaryop", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_unaryop", "name": "Expr", "cls": "ExprName"}}, "_build_yield": {"kind": "function", "name": "_build_yield", "runtime": true, "lineno": 1357, "endlineno": 1358, "analysis": "static", "path": "griffe._internal.expressions._build_yield", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1357-L1358", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_yield", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Yield", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_yield", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_yield", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_yield", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_yield", "name": "Expr", "cls": "ExprName"}}, "_build_yield_from": {"kind": "function", "name": "_build_yield_from", "runtime": true, "lineno": 1361, "endlineno": 1362, "analysis": "static", "path": "griffe._internal.expressions._build_yield_from", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1361-L1362", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_yield_from", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "YieldFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_yield_from", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_yield_from", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_yield_from", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_yield_from", "name": "Expr", "cls": "ExprName"}}, "_BuildCallable": {"kind": "class", "name": "_BuildCallable", "runtime": true, "lineno": 1365, "endlineno": 1366, "members": {"__call__": {"kind": "function", "name": "__call__", "runtime": true, "lineno": 1366, "endlineno": 1366, "analysis": "static", "path": "griffe._internal.expressions._BuildCallable.__call__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1366-L1366", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "__call__", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "__call__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "__call__", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "__call__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "__call__", "name": "Expr", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.expressions._BuildCallable", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1365-L1366", "bases": [{"member": "_BuildCallable", "name": "Protocol", "cls": "ExprName"}], "decorators": []}, "_node_map": {"kind": "attribute", "name": "_node_map", "runtime": true, "lineno": 1369, "endlineno": 1398, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._node_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1369-L1398", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BinOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BoolOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Call", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Compare", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "comprehension", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Constant", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Dict", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "DictComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FormattedValue", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "GeneratorExp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "IfExp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "JoinedStr", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Lambda", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "List", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ListComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "NamedExpr", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Set", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "SetComp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Slice", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Starred", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Subscript", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "UnaryOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Yield", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "YieldFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_build_attribute", "cls": "ExprName"}, {"member": null, "name": "_build_binop", "cls": "ExprName"}, {"member": null, "name": "_build_boolop", "cls": "ExprName"}, {"member": null, "name": "_build_call", "cls": "ExprName"}, {"member": null, "name": "_build_compare", "cls": "ExprName"}, {"member": null, "name": "_build_comprehension", "cls": "ExprName"}, {"member": null, "name": "_build_constant", "cls": "ExprName"}, {"member": null, "name": "_build_dict", "cls": "ExprName"}, {"member": null, "name": "_build_dictcomp", "cls": "ExprName"}, {"member": null, "name": "_build_formatted", "cls": "ExprName"}, {"member": null, "name": "_build_generatorexp", "cls": "ExprName"}, {"member": null, "name": "_build_ifexp", "cls": "ExprName"}, {"member": null, "name": "_build_joinedstr", "cls": "ExprName"}, {"member": null, "name": "_build_keyword", "cls": "ExprName"}, {"member": null, "name": "_build_lambda", "cls": "ExprName"}, {"member": null, "name": "_build_list", "cls": "ExprName"}, {"member": null, "name": "_build_listcomp", "cls": "ExprName"}, {"member": null, "name": "_build_name", "cls": "ExprName"}, {"member": null, "name": "_build_named_expr", "cls": "ExprName"}, {"member": null, "name": "_build_set", "cls": "ExprName"}, {"member": null, "name": "_build_setcomp", "cls": "ExprName"}, {"member": null, "name": "_build_slice", "cls": "ExprName"}, {"member": null, "name": "_build_starred", "cls": "ExprName"}, {"member": null, "name": "_build_subscript", "cls": "ExprName"}, {"member": null, "name": "_build_tuple", "cls": "ExprName"}, {"member": null, "name": "_build_unaryop", "cls": "ExprName"}, {"member": null, "name": "_build_yield", "cls": "ExprName"}, {"member": null, "name": "_build_yield_from", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "type", "cls": "ExprName"}, {"member": null, "name": "_BuildCallable", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_build_interpolation": {"kind": "function", "name": "_build_interpolation", "runtime": true, "lineno": 1402, "endlineno": 1403, "analysis": "static", "path": "griffe._internal.expressions._build_interpolation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1402-L1403", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_interpolation", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Interpolation", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_interpolation", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_interpolation", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_interpolation", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_interpolation", "name": "Expr", "cls": "ExprName"}}, "_build_templatestr": {"kind": "function", "name": "_build_templatestr", "runtime": true, "lineno": 1405, "endlineno": 1410, "analysis": "static", "path": "griffe._internal.expressions._build_templatestr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1405-L1410", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build_templatestr", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "TemplateStr", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build_templatestr", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build_templatestr", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_build_templatestr", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build_templatestr", "name": "Expr", "cls": "ExprName"}}, "_build": {"kind": "function", "name": "_build", "runtime": true, "lineno": 1420, "endlineno": 1421, "analysis": "static", "path": "griffe._internal.expressions._build", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1420-L1421", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_build", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional-only", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_build", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_build", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional-only", "default": null}, {"name": "kwargs", "annotation": {"member": "_build", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_build", "name": "Expr", "cls": "ExprName"}}, "get_expression": {"kind": "function", "name": "get_expression", "runtime": true, "lineno": 1424, "endlineno": 1451, "docstring": {"value": "Build an expression from an AST.\n\nParameters:\n    node: The annotation node.\n    parent: The parent used to resolve the name.\n    member: The member name (for resolution in its scope).\n    parse_strings: Whether to try and parse strings as type annotations.\n\nReturns:\n    A string or resovable name or expression.", "lineno": 1431, "endlineno": 1441, "parsed": [{"kind": "text", "value": "Build an expression from an AST."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "get_expression", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The annotation node."}, {"name": "parent", "annotation": {"left": {"member": "get_expression", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "get_expression", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The parent used to resolve the name."}, {"name": "member", "annotation": {"left": {"member": "get_expression", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The member name (for resolution in its scope).", "value": "None"}, {"name": "parse_strings", "annotation": {"left": {"member": "get_expression", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try and parse strings as type annotations.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_expression", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A string or resovable name or expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.get_expression", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1424-L1451", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"values": [{"member": "get_expression", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "get_expression", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "get_expression", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "member", "annotation": {"left": {"member": "get_expression", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parse_strings", "annotation": {"left": {"member": "get_expression", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "get_expression", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "safe_get_expression": {"kind": "function", "name": "safe_get_expression", "runtime": true, "lineno": 1454, "endlineno": 1491, "docstring": {"value": "Safely (no exception) build a resolvable annotation.\n\nParameters:\n    node: The annotation node.\n    parent: The parent used to resolve the name.\n    member: The member name (for resolution in its scope).\n    parse_strings: Whether to try and parse strings as type annotations.\n    log_level: Log level to use to log a message. None to disable logging.\n    msg_format: A format string for the log message. Available placeholders:\n        path, lineno, node, error.\n\nReturns:\n    A string or resovable name or expression.", "lineno": 1463, "endlineno": 1476, "parsed": [{"kind": "text", "value": "Safely (no exception) build a resolvable annotation."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "safe_get_expression", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The annotation node."}, {"name": "parent", "annotation": {"left": {"member": "safe_get_expression", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get_expression", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The parent used to resolve the name."}, {"name": "member", "annotation": {"left": {"member": "safe_get_expression", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The member name (for resolution in its scope).", "value": "None"}, {"name": "parse_strings", "annotation": {"left": {"member": "safe_get_expression", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try and parse strings as type annotations.", "value": "None"}, {"name": "log_level", "annotation": {"left": {"member": "safe_get_expression", "name": "LogLevel", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Log level to use to log a message. None to disable logging.", "value": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "error", "cls": "ExprName"}], "cls": "ExprAttribute"}}, {"name": "msg_format", "annotation": {"member": "safe_get_expression", "name": "str", "cls": "ExprName"}, "description": "A format string for the log message. Available placeholders:\npath, lineno, node, error.", "value": "'{path}:{lineno}: Failed to get expression from {node_class}: {error}'"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "safe_get_expression", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A string or resovable name or expression."}]}]}, "analysis": "static", "path": "griffe._internal.expressions.safe_get_expression", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1454-L1491", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"values": [{"member": "safe_get_expression", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "safe_get_expression", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get_expression", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "member", "annotation": {"left": {"member": "safe_get_expression", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parse_strings", "annotation": {"left": {"member": "safe_get_expression", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "log_level", "annotation": {"left": {"member": "safe_get_expression", "name": "LogLevel", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "error", "cls": "ExprName"}], "cls": "ExprAttribute"}}, {"name": "msg_format", "annotation": {"member": "safe_get_expression", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": "'{path}:{lineno}: Failed to get expression from {node_class}: {error}'"}], "returns": {"left": {"member": "safe_get_expression", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_msg_format": {"kind": "attribute", "name": "_msg_format", "runtime": true, "lineno": 1494, "endlineno": 1494, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions._msg_format", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1494-L1494", "value": "'{path}:{lineno}: Failed to get %s expression from {node_class}: {error}'"}, "get_annotation": {"kind": "attribute", "name": "get_annotation", "runtime": true, "lineno": 1495, "endlineno": 1495, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.get_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1495-L1495", "value": {"arguments": [{"member": null, "name": "get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "None", "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "safe_get_annotation": {"kind": "attribute", "name": "safe_get_annotation", "runtime": true, "lineno": 1496, "endlineno": 1500, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.safe_get_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1496-L1500", "value": {"arguments": [{"member": null, "name": "safe_get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "None", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "msg_format", "value": {"left": {"member": null, "name": "_msg_format", "cls": "ExprName"}, "operator": "%", "right": "'annotation'", "cls": "ExprBinOp"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "get_base_class": {"kind": "attribute", "name": "get_base_class", "runtime": true, "lineno": 1501, "endlineno": 1501, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.get_base_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1501-L1501", "value": {"arguments": [{"member": null, "name": "get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "safe_get_base_class": {"kind": "attribute", "name": "safe_get_base_class", "runtime": true, "lineno": 1502, "endlineno": 1506, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.safe_get_base_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1502-L1506", "value": {"arguments": [{"member": null, "name": "safe_get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "msg_format", "value": {"left": {"member": null, "name": "_msg_format", "cls": "ExprName"}, "operator": "%", "right": "'base class'", "cls": "ExprBinOp"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "get_class_keyword": {"kind": "attribute", "name": "get_class_keyword", "runtime": true, "lineno": 1507, "endlineno": 1507, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.get_class_keyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1507-L1507", "value": {"arguments": [{"member": null, "name": "get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "safe_get_class_keyword": {"kind": "attribute", "name": "safe_get_class_keyword", "runtime": true, "lineno": 1508, "endlineno": 1512, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.safe_get_class_keyword", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1508-L1512", "value": {"arguments": [{"member": null, "name": "safe_get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "msg_format", "value": {"left": {"member": null, "name": "_msg_format", "cls": "ExprName"}, "operator": "%", "right": "'class keyword'", "cls": "ExprBinOp"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "get_condition": {"kind": "attribute", "name": "get_condition", "runtime": true, "lineno": 1513, "endlineno": 1513, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.get_condition", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1513-L1513", "value": {"arguments": [{"member": null, "name": "get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}, "safe_get_condition": {"kind": "attribute", "name": "safe_get_condition", "runtime": true, "lineno": 1514, "endlineno": 1518, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.expressions.safe_get_condition", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/expressions.py#L1514-L1518", "value": {"arguments": [{"member": null, "name": "safe_get_expression", "cls": "ExprName"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "parse_strings", "value": "False", "cls": "ExprKeyword"}, {"function": {"member": null, "name": "partial", "cls": "ExprName"}, "name": "msg_format", "value": {"left": {"member": null, "name": "_msg_format", "cls": "ExprName"}, "operator": "%", "right": "'condition'", "cls": "ExprBinOp"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "partial", "cls": "ExprName"}, "cls": "ExprCall"}}}, "analysis": "static", "path": "griffe._internal.expressions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/expressions.py", "relative_package_filepath": "griffe/_internal/expressions.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/expressions.py"}, "debug": {"kind": "module", "name": "debug", "runtime": true, "imports": {"annotations": "__future__.annotations", "os": "os", "platform": "platform", "sys": "sys", "dataclass": "dataclasses.dataclass", "metadata": "importlib.metadata"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.debug.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "os": {"kind": "alias", "name": "os", "target_path": "os", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.debug.os", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "platform": {"kind": "alias", "name": "platform", "target_path": "platform", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.debug.platform", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.debug.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.debug.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "metadata": {"kind": "alias", "name": "metadata", "target_path": "importlib.metadata", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.debug.metadata", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_Variable": {"kind": "class", "name": "_Variable", "runtime": true, "lineno": 16, "endlineno": 23, "docstring": {"value": "Dataclass describing an environment variable.", "lineno": 18, "endlineno": 18, "parsed": [{"kind": "text", "value": "Dataclass describing an environment variable."}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 20, "endlineno": 20, "docstring": {"value": "Variable name.", "lineno": 21, "endlineno": 21, "parsed": [{"kind": "text", "value": "Variable name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Variable.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L20-L20", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 22, "endlineno": 22, "docstring": {"value": "Variable value.", "lineno": 23, "endlineno": 23, "parsed": [{"kind": "text", "value": "Variable value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Variable.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L22-L22", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.debug._Variable.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Variable name.", "lineno": 21, "endlineno": 21, "parsed": [{"kind": "text", "value": "Variable name."}]}}, {"name": "value", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Variable value.", "lineno": 23, "endlineno": 23, "parsed": [{"kind": "text", "value": "Variable value."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.debug._Variable", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L16-L23", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 16, "endlineno": 16}]}, "_Package": {"kind": "class", "name": "_Package", "runtime": true, "lineno": 26, "endlineno": 33, "docstring": {"value": "Dataclass describing a Python package.", "lineno": 28, "endlineno": 28, "parsed": [{"kind": "text", "value": "Dataclass describing a Python package."}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 30, "endlineno": 30, "docstring": {"value": "Package name.", "lineno": 31, "endlineno": 31, "parsed": [{"kind": "text", "value": "Package name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Package.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L30-L30", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "version": {"kind": "attribute", "name": "version", "runtime": true, "lineno": 32, "endlineno": 32, "docstring": {"value": "Package version.", "lineno": 33, "endlineno": 33, "parsed": [{"kind": "text", "value": "Package version."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Package.version", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L32-L32", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.debug._Package.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Package name.", "lineno": 31, "endlineno": 31, "parsed": [{"kind": "text", "value": "Package name."}]}}, {"name": "version", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Package version.", "lineno": 33, "endlineno": 33, "parsed": [{"kind": "text", "value": "Package version."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.debug._Package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L26-L33", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 26, "endlineno": 26}]}, "_Environment": {"kind": "class", "name": "_Environment", "runtime": true, "lineno": 36, "endlineno": 51, "docstring": {"value": "Dataclass to store environment information.", "lineno": 38, "endlineno": 38, "parsed": [{"kind": "text", "value": "Dataclass to store environment information."}]}, "labels": ["dataclass"], "members": {"interpreter_name": {"kind": "attribute", "name": "interpreter_name", "runtime": true, "lineno": 40, "endlineno": 40, "docstring": {"value": "Python interpreter name.", "lineno": 41, "endlineno": 41, "parsed": [{"kind": "text", "value": "Python interpreter name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.interpreter_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L40-L40", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "interpreter_version": {"kind": "attribute", "name": "interpreter_version", "runtime": true, "lineno": 42, "endlineno": 42, "docstring": {"value": "Python interpreter version.", "lineno": 43, "endlineno": 43, "parsed": [{"kind": "text", "value": "Python interpreter version."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.interpreter_version", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L42-L42", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "interpreter_path": {"kind": "attribute", "name": "interpreter_path", "runtime": true, "lineno": 44, "endlineno": 44, "docstring": {"value": "Path to Python executable.", "lineno": 45, "endlineno": 45, "parsed": [{"kind": "text", "value": "Path to Python executable."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.interpreter_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L44-L44", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "platform": {"kind": "attribute", "name": "platform", "runtime": true, "lineno": 46, "endlineno": 46, "docstring": {"value": "Operating System.", "lineno": 47, "endlineno": 47, "parsed": [{"kind": "text", "value": "Operating System."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.platform", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L46-L46", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "packages": {"kind": "attribute", "name": "packages", "runtime": true, "lineno": 48, "endlineno": 48, "docstring": {"value": "Installed packages.", "lineno": 49, "endlineno": 49, "parsed": [{"kind": "text", "value": "Installed packages."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.packages", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L48-L48", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "_Package", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "variables": {"kind": "attribute", "name": "variables", "runtime": true, "lineno": 50, "endlineno": 50, "docstring": {"value": "Environment variables.", "lineno": 51, "endlineno": 51, "parsed": [{"kind": "text", "value": "Environment variables."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.debug._Environment.variables", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L50-L50", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "_Variable", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.debug._Environment.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "interpreter_name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Python interpreter name.", "lineno": 41, "endlineno": 41, "parsed": [{"kind": "text", "value": "Python interpreter name."}]}}, {"name": "interpreter_version", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Python interpreter version.", "lineno": 43, "endlineno": 43, "parsed": [{"kind": "text", "value": "Python interpreter version."}]}}, {"name": "interpreter_path", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Path to Python executable.", "lineno": 45, "endlineno": 45, "parsed": [{"kind": "text", "value": "Path to Python executable."}]}}, {"name": "platform", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Operating System.", "lineno": 47, "endlineno": 47, "parsed": [{"kind": "text", "value": "Operating System."}]}}, {"name": "packages", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "_Package", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Installed packages.", "lineno": 49, "endlineno": 49, "parsed": [{"kind": "text", "value": "Installed packages."}]}}, {"name": "variables", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "_Variable", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Environment variables.", "lineno": 51, "endlineno": 51, "parsed": [{"kind": "text", "value": "Environment variables."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.debug._Environment", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L36-L51", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 36, "endlineno": 36}]}, "_interpreter_name_version": {"kind": "function", "name": "_interpreter_name_version", "runtime": true, "lineno": 54, "endlineno": 62, "analysis": "static", "path": "griffe._internal.debug._interpreter_name_version", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L54-L62", "decorators": [], "parameters": [], "returns": {"left": {"member": "_interpreter_name_version", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_interpreter_name_version", "name": "str", "cls": "ExprName"}, {"member": "_interpreter_name_version", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_get_version": {"kind": "function", "name": "_get_version", "runtime": true, "lineno": 65, "endlineno": 77, "docstring": {"value": "Get version of the given distribution.\n\nParameters:\n    dist: A distribution name.\n\nReturns:\n    A version number.", "lineno": 66, "endlineno": 73, "parsed": [{"kind": "text", "value": "Get version of the given distribution."}, {"kind": "parameters", "value": [{"name": "dist", "annotation": {"member": "_get_version", "name": "str", "cls": "ExprName"}, "description": "A distribution name.", "value": "'griffelib'"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "_get_version", "name": "str", "cls": "ExprName"}, "description": "A version number."}]}]}, "analysis": "static", "path": "griffe._internal.debug._get_version", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L65-L77", "decorators": [], "parameters": [{"name": "dist", "annotation": {"member": "_get_version", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "'griffelib'"}], "returns": {"member": "_get_version", "name": "str", "cls": "ExprName"}}, "_get_debug_info": {"kind": "function", "name": "_get_debug_info", "runtime": true, "lineno": 80, "endlineno": 96, "docstring": {"value": "Get debug/environment information.\n\nReturns:\n    Environment information.", "lineno": 81, "endlineno": 85, "parsed": [{"kind": "text", "value": "Get debug/environment information."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "_get_debug_info", "name": "_Environment", "cls": "ExprName"}, "description": "Environment information."}]}]}, "analysis": "static", "path": "griffe._internal.debug._get_debug_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L80-L96", "decorators": [], "parameters": [], "returns": {"member": "_get_debug_info", "name": "_Environment", "cls": "ExprName"}}, "_print_debug_info": {"kind": "function", "name": "_print_debug_info", "runtime": true, "lineno": 99, "endlineno": 109, "docstring": {"value": "Print debug/environment information.", "lineno": 100, "endlineno": 100, "parsed": [{"kind": "text", "value": "Print debug/environment information."}]}, "analysis": "static", "path": "griffe._internal.debug._print_debug_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/debug.py#L99-L109", "decorators": [], "parameters": [], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.debug", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/debug.py", "relative_package_filepath": "griffe/_internal/debug.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/debug.py"}, "diff": {"kind": "module", "name": "diff", "runtime": true, "imports": {"annotations": "__future__.annotations", "contextlib": "contextlib", "Path": "pathlib.Path", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "BreakageKind": "griffe._internal.enumerations.BreakageKind", "ExplanationStyle": "griffe._internal.enumerations.ExplanationStyle", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "_WORKTREE_PREFIX": "griffe._internal.git._WORKTREE_PREFIX", "logger": "griffe._internal.logger.logger", "Iterable": "collections.abc.Iterable", "Iterator": "collections.abc.Iterator", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Function": "griffe._internal.models.Function", "Object": "griffe._internal.models.Object"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.diff.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "contextlib": {"kind": "alias", "name": "contextlib", "target_path": "contextlib", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.diff.contextlib", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.diff.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.diff.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.diff.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "BreakageKind": {"kind": "alias", "name": "BreakageKind", "target_path": "griffe._internal.enumerations.BreakageKind", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.diff.BreakageKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExplanationStyle": {"kind": "alias", "name": "ExplanationStyle", "target_path": "griffe._internal.enumerations.ExplanationStyle", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.diff.ExplanationStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.diff.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.diff.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_WORKTREE_PREFIX": {"kind": "alias", "name": "_WORKTREE_PREFIX", "target_path": "griffe._internal.git._WORKTREE_PREFIX", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.diff._WORKTREE_PREFIX", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.diff.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterable": {"kind": "alias", "name": "Iterable", "target_path": "collections.abc.Iterable", "runtime": false, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.diff.Iterable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.diff.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.diff.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.diff.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.diff.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.diff.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.diff.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_POSITIONAL": {"kind": "attribute", "name": "_POSITIONAL", "runtime": true, "lineno": 25, "endlineno": 25, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.diff._POSITIONAL", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L25-L25", "value": {"arguments": [{"elements": [{"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_only", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_or_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_KEYWORD": {"kind": "attribute", "name": "_KEYWORD", "runtime": true, "lineno": 26, "endlineno": 26, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.diff._KEYWORD", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L26-L26", "value": {"arguments": [{"elements": [{"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "keyword_only", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_or_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_POSITIONAL_KEYWORD_ONLY": {"kind": "attribute", "name": "_POSITIONAL_KEYWORD_ONLY", "runtime": true, "lineno": 27, "endlineno": 27, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.diff._POSITIONAL_KEYWORD_ONLY", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L27-L27", "value": {"arguments": [{"elements": [{"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_only", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "keyword_only", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_VARIADIC": {"kind": "attribute", "name": "_VARIADIC", "runtime": true, "lineno": 28, "endlineno": 28, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.diff._VARIADIC", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L28-L28", "value": {"arguments": [{"elements": [{"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "var_positional", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "var_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_ANSI": {"kind": "class", "name": "_ANSI", "runtime": true, "lineno": 32, "endlineno": 70, "members": {"FG_BLACK": {"kind": "attribute", "name": "FG_BLACK", "runtime": true, "lineno": 33, "endlineno": 33, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_BLACK", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L33-L33", "value": "'\\x1b[30m'"}, "FG_RED": {"kind": "attribute", "name": "FG_RED", "runtime": true, "lineno": 34, "endlineno": 34, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_RED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L34-L34", "value": "'\\x1b[31m'"}, "FG_GREEN": {"kind": "attribute", "name": "FG_GREEN", "runtime": true, "lineno": 35, "endlineno": 35, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_GREEN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L35-L35", "value": "'\\x1b[32m'"}, "FG_YELLOW": {"kind": "attribute", "name": "FG_YELLOW", "runtime": true, "lineno": 36, "endlineno": 36, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_YELLOW", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L36-L36", "value": "'\\x1b[33m'"}, "FG_BLUE": {"kind": "attribute", "name": "FG_BLUE", "runtime": true, "lineno": 37, "endlineno": 37, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_BLUE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L37-L37", "value": "'\\x1b[34m'"}, "FG_MAGENTA": {"kind": "attribute", "name": "FG_MAGENTA", "runtime": true, "lineno": 38, "endlineno": 38, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_MAGENTA", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L38-L38", "value": "'\\x1b[35m'"}, "FG_CYAN": {"kind": "attribute", "name": "FG_CYAN", "runtime": true, "lineno": 39, "endlineno": 39, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_CYAN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L39-L39", "value": "'\\x1b[36m'"}, "FG_WHITE": {"kind": "attribute", "name": "FG_WHITE", "runtime": true, "lineno": 40, "endlineno": 40, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_WHITE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L40-L40", "value": "'\\x1b[37m'"}, "FG_RESET": {"kind": "attribute", "name": "FG_RESET", "runtime": true, "lineno": 41, "endlineno": 41, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_RESET", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L41-L41", "value": "'\\x1b[39m'"}, "FG_LIGHTBLACK_EX": {"kind": "attribute", "name": "FG_LIGHTBLACK_EX", "runtime": true, "lineno": 42, "endlineno": 42, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTBLACK_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L42-L42", "value": "'\\x1b[90m'"}, "FG_LIGHTRED_EX": {"kind": "attribute", "name": "FG_LIGHTRED_EX", "runtime": true, "lineno": 43, "endlineno": 43, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTRED_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L43-L43", "value": "'\\x1b[91m'"}, "FG_LIGHTGREEN_EX": {"kind": "attribute", "name": "FG_LIGHTGREEN_EX", "runtime": true, "lineno": 44, "endlineno": 44, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTGREEN_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L44-L44", "value": "'\\x1b[92m'"}, "FG_LIGHTYELLOW_EX": {"kind": "attribute", "name": "FG_LIGHTYELLOW_EX", "runtime": true, "lineno": 45, "endlineno": 45, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTYELLOW_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L45-L45", "value": "'\\x1b[93m'"}, "FG_LIGHTBLUE_EX": {"kind": "attribute", "name": "FG_LIGHTBLUE_EX", "runtime": true, "lineno": 46, "endlineno": 46, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTBLUE_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L46-L46", "value": "'\\x1b[94m'"}, "FG_LIGHTMAGENTA_EX": {"kind": "attribute", "name": "FG_LIGHTMAGENTA_EX", "runtime": true, "lineno": 47, "endlineno": 47, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTMAGENTA_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L47-L47", "value": "'\\x1b[95m'"}, "FG_LIGHTCYAN_EX": {"kind": "attribute", "name": "FG_LIGHTCYAN_EX", "runtime": true, "lineno": 48, "endlineno": 48, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTCYAN_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L48-L48", "value": "'\\x1b[96m'"}, "FG_LIGHTWHITE_EX": {"kind": "attribute", "name": "FG_LIGHTWHITE_EX", "runtime": true, "lineno": 49, "endlineno": 49, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.FG_LIGHTWHITE_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L49-L49", "value": "'\\x1b[97m'"}, "BG_BLACK": {"kind": "attribute", "name": "BG_BLACK", "runtime": true, "lineno": 50, "endlineno": 50, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_BLACK", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L50-L50", "value": "'\\x1b[40m'"}, "BG_RED": {"kind": "attribute", "name": "BG_RED", "runtime": true, "lineno": 51, "endlineno": 51, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_RED", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L51-L51", "value": "'\\x1b[41m'"}, "BG_GREEN": {"kind": "attribute", "name": "BG_GREEN", "runtime": true, "lineno": 52, "endlineno": 52, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_GREEN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L52-L52", "value": "'\\x1b[42m'"}, "BG_YELLOW": {"kind": "attribute", "name": "BG_YELLOW", "runtime": true, "lineno": 53, "endlineno": 53, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_YELLOW", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L53-L53", "value": "'\\x1b[43m'"}, "BG_BLUE": {"kind": "attribute", "name": "BG_BLUE", "runtime": true, "lineno": 54, "endlineno": 54, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_BLUE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L54-L54", "value": "'\\x1b[44m'"}, "BG_MAGENTA": {"kind": "attribute", "name": "BG_MAGENTA", "runtime": true, "lineno": 55, "endlineno": 55, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_MAGENTA", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L55-L55", "value": "'\\x1b[45m'"}, "BG_CYAN": {"kind": "attribute", "name": "BG_CYAN", "runtime": true, "lineno": 56, "endlineno": 56, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_CYAN", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L56-L56", "value": "'\\x1b[46m'"}, "BG_WHITE": {"kind": "attribute", "name": "BG_WHITE", "runtime": true, "lineno": 57, "endlineno": 57, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_WHITE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L57-L57", "value": "'\\x1b[47m'"}, "BG_RESET": {"kind": "attribute", "name": "BG_RESET", "runtime": true, "lineno": 58, "endlineno": 58, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_RESET", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L58-L58", "value": "'\\x1b[49m'"}, "BG_LIGHTBLACK_EX": {"kind": "attribute", "name": "BG_LIGHTBLACK_EX", "runtime": true, "lineno": 59, "endlineno": 59, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTBLACK_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L59-L59", "value": "'\\x1b[100m'"}, "BG_LIGHTRED_EX": {"kind": "attribute", "name": "BG_LIGHTRED_EX", "runtime": true, "lineno": 60, "endlineno": 60, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTRED_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L60-L60", "value": "'\\x1b[101m'"}, "BG_LIGHTGREEN_EX": {"kind": "attribute", "name": "BG_LIGHTGREEN_EX", "runtime": true, "lineno": 61, "endlineno": 61, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTGREEN_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L61-L61", "value": "'\\x1b[102m'"}, "BG_LIGHTYELLOW_EX": {"kind": "attribute", "name": "BG_LIGHTYELLOW_EX", "runtime": true, "lineno": 62, "endlineno": 62, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTYELLOW_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L62-L62", "value": "'\\x1b[103m'"}, "BG_LIGHTBLUE_EX": {"kind": "attribute", "name": "BG_LIGHTBLUE_EX", "runtime": true, "lineno": 63, "endlineno": 63, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTBLUE_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L63-L63", "value": "'\\x1b[104m'"}, "BG_LIGHTMAGENTA_EX": {"kind": "attribute", "name": "BG_LIGHTMAGENTA_EX", "runtime": true, "lineno": 64, "endlineno": 64, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTMAGENTA_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L64-L64", "value": "'\\x1b[105m'"}, "BG_LIGHTCYAN_EX": {"kind": "attribute", "name": "BG_LIGHTCYAN_EX", "runtime": true, "lineno": 65, "endlineno": 65, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTCYAN_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L65-L65", "value": "'\\x1b[106m'"}, "BG_LIGHTWHITE_EX": {"kind": "attribute", "name": "BG_LIGHTWHITE_EX", "runtime": true, "lineno": 66, "endlineno": 66, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BG_LIGHTWHITE_EX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L66-L66", "value": "'\\x1b[107m'"}, "BRIGHT": {"kind": "attribute", "name": "BRIGHT", "runtime": true, "lineno": 67, "endlineno": 67, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.BRIGHT", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L67-L67", "value": "'\\x1b[1m'"}, "DIM": {"kind": "attribute", "name": "DIM", "runtime": true, "lineno": 68, "endlineno": 68, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.DIM", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L68-L68", "value": "'\\x1b[2m'"}, "NORMAL": {"kind": "attribute", "name": "NORMAL", "runtime": true, "lineno": 69, "endlineno": 69, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.NORMAL", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L69-L69", "value": "'\\x1b[22m'"}, "RESET_ALL": {"kind": "attribute", "name": "RESET_ALL", "runtime": true, "lineno": 70, "endlineno": 70, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff._ANSI.RESET_ALL", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L70-L70", "value": "'\\x1b[0m'"}}, "analysis": "static", "path": "griffe._internal.diff._ANSI", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L32-L70", "bases": [], "decorators": []}, "Breakage": {"kind": "class", "name": "Breakage", "runtime": true, "lineno": 73, "endlineno": 281, "docstring": {"value": "Breakages can explain what broke from a version to another.", "lineno": 74, "endlineno": 74, "parsed": [{"kind": "text", "value": "Breakages can explain what broke from a version to another."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 76, "endlineno": 76, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.Breakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L76-L76", "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 79, "endlineno": 95, "docstring": {"value": "Initialize the breakage.\n\nParameters:\n    obj: The object related to the breakage.\n    old_value: The old value.\n    new_value: The new, incompatible value.\n    details: Some details about the breakage.", "lineno": 80, "endlineno": 87, "parsed": [{"kind": "parameters", "value": [{"name": "obj", "annotation": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "description": "The object related to the breakage."}, {"name": "old_value", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "The old value."}, {"name": "new_value", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "The new, incompatible value."}, {"name": "details", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "Some details about the breakage.", "value": "''"}]}]}, "analysis": "static", "path": "griffe._internal.diff.Breakage.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L79-L95", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "old_value", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "new_value", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "details", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "''"}], "returns": "None"}, "obj": {"kind": "attribute", "name": "obj", "runtime": true, "lineno": 88, "endlineno": 88, "docstring": {"value": "The object related to the breakage.", "lineno": 89, "endlineno": 89, "parsed": [{"kind": "text", "value": "The object related to the breakage."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.Breakage.obj", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L88-L88", "value": {"member": null, "name": "obj", "cls": "ExprName"}}, "old_value": {"kind": "attribute", "name": "old_value", "runtime": true, "lineno": 90, "endlineno": 90, "docstring": {"value": "The old value.", "lineno": 91, "endlineno": 91, "parsed": [{"kind": "text", "value": "The old value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.Breakage.old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L90-L90", "value": {"member": null, "name": "old_value", "cls": "ExprName"}}, "new_value": {"kind": "attribute", "name": "new_value", "runtime": true, "lineno": 92, "endlineno": 92, "docstring": {"value": "The new, incompatible value.", "lineno": 93, "endlineno": 93, "parsed": [{"kind": "text", "value": "The new, incompatible value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.Breakage.new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L92-L92", "value": {"member": null, "name": "new_value", "cls": "ExprName"}}, "details": {"kind": "attribute", "name": "details", "runtime": true, "lineno": 94, "endlineno": 94, "docstring": {"value": "Some details about the breakage.", "lineno": 95, "endlineno": 95, "parsed": [{"kind": "text", "value": "Some details about the breakage."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.Breakage.details", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L94-L94", "value": {"member": null, "name": "details", "cls": "ExprName"}}, "__str__": {"kind": "function", "name": "__str__", "runtime": true, "lineno": 97, "endlineno": 98, "analysis": "static", "path": "griffe._internal.diff.Breakage.__str__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L97-L98", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__str__", "name": "str", "cls": "ExprName"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 100, "endlineno": 101, "analysis": "static", "path": "griffe._internal.diff.Breakage.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L100-L101", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 103, "endlineno": 118, "docstring": {"value": "Return this object's data as a dictionary.\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 104, "endlineno": 112, "parsed": [{"kind": "text", "value": "Return this object's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.diff.Breakage.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L103-L118", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "explain": {"kind": "function", "name": "explain", "runtime": true, "lineno": 120, "endlineno": 129, "docstring": {"value": "Explain the breakage by showing old and new value.\n\nParameters:\n    style: The explanation style to use.\n\nReturns:\n    An explanation.", "lineno": 121, "endlineno": 128, "parsed": [{"kind": "text", "value": "Explain the breakage by showing old and new value."}, {"kind": "parameters", "value": [{"name": "style", "annotation": {"member": "explain", "name": "ExplanationStyle", "cls": "ExprName"}, "description": "The explanation style to use.", "value": {"values": [{"member": null, "name": "ExplanationStyle", "cls": "ExprName"}, {"member": null, "name": "ONE_LINE", "cls": "ExprName"}], "cls": "ExprAttribute"}}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "explain", "name": "str", "cls": "ExprName"}, "description": "An explanation."}]}]}, "analysis": "static", "path": "griffe._internal.diff.Breakage.explain", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L120-L129", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "style", "annotation": {"member": "explain", "name": "ExplanationStyle", "cls": "ExprName"}, "kind": "positional or keyword", "default": {"values": [{"member": null, "name": "ExplanationStyle", "cls": "ExprName"}, {"member": null, "name": "ONE_LINE", "cls": "ExprName"}], "cls": "ExprAttribute"}}], "returns": {"member": "explain", "name": "str", "cls": "ExprName"}}, "_filepath": {"kind": "attribute", "name": "_filepath", "runtime": true, "lineno": 132, "endlineno": 135, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L132-L135", "annotation": {"member": "_filepath", "name": "Path", "cls": "ExprName"}}, "_relative_filepath": {"kind": "attribute", "name": "_relative_filepath", "runtime": true, "lineno": 138, "endlineno": 141, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._relative_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L138-L141", "annotation": {"member": "_relative_filepath", "name": "Path", "cls": "ExprName"}}, "_relative_package_filepath": {"kind": "attribute", "name": "_relative_package_filepath", "runtime": true, "lineno": 144, "endlineno": 147, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._relative_package_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L144-L147", "annotation": {"member": "_relative_package_filepath", "name": "Path", "cls": "ExprName"}}, "_location": {"kind": "attribute", "name": "_location", "runtime": true, "lineno": 150, "endlineno": 159, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._location", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L150-L159", "annotation": {"member": "_location", "name": "Path", "cls": "ExprName"}}, "_canonical_path": {"kind": "attribute", "name": "_canonical_path", "runtime": true, "lineno": 162, "endlineno": 165, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L162-L165", "annotation": {"member": "_canonical_path", "name": "str", "cls": "ExprName"}}, "_module_path": {"kind": "attribute", "name": "_module_path", "runtime": true, "lineno": 168, "endlineno": 171, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._module_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L168-L171", "annotation": {"member": "_module_path", "name": "str", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 174, "endlineno": 175, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L174-L175", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_lineno": {"kind": "attribute", "name": "_lineno", "runtime": true, "lineno": 178, "endlineno": 186, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.Breakage._lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L178-L186", "annotation": {"member": "_lineno", "name": "int", "cls": "ExprName"}}, "_format_location": {"kind": "function", "name": "_format_location", "runtime": true, "lineno": 188, "endlineno": 191, "analysis": "static", "path": "griffe._internal.diff.Breakage._format_location", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L188-L191", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_location", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_location", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 193, "endlineno": 194, "analysis": "static", "path": "griffe._internal.diff.Breakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L193-L194", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_kind": {"kind": "function", "name": "_format_kind", "runtime": true, "lineno": 196, "endlineno": 199, "analysis": "static", "path": "griffe._internal.diff.Breakage._format_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L196-L199", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_kind", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_kind", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 201, "endlineno": 202, "analysis": "static", "path": "griffe._internal.diff.Breakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L201-L202", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 204, "endlineno": 205, "analysis": "static", "path": "griffe._internal.diff.Breakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L204-L205", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}, "_explain_oneline": {"kind": "function", "name": "_explain_oneline", "runtime": true, "lineno": 207, "endlineno": 221, "analysis": "static", "path": "griffe._internal.diff.Breakage._explain_oneline", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L207-L221", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "_explain_oneline", "name": "str", "cls": "ExprName"}}, "_explain_verbose": {"kind": "function", "name": "_explain_verbose", "runtime": true, "lineno": 223, "endlineno": 239, "analysis": "static", "path": "griffe._internal.diff.Breakage._explain_verbose", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L223-L239", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "_explain_verbose", "name": "str", "cls": "ExprName"}}, "_explain_markdown": {"kind": "function", "name": "_explain_markdown", "runtime": true, "lineno": 241, "endlineno": 259, "analysis": "static", "path": "griffe._internal.diff.Breakage._explain_markdown", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L241-L259", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "_explain_markdown", "name": "str", "cls": "ExprName"}}, "_explain_github": {"kind": "function", "name": "_explain_github", "runtime": true, "lineno": 261, "endlineno": 281, "analysis": "static", "path": "griffe._internal.diff.Breakage._explain_github", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L261-L281", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "_explain_github", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.Breakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L73-L281", "bases": [], "decorators": []}, "ParameterMovedBreakage": {"kind": "class", "name": "ParameterMovedBreakage", "runtime": true, "lineno": 284, "endlineno": 302, "docstring": {"value": "Specific breakage class for moved parameters.", "lineno": 285, "endlineno": 285, "parsed": [{"kind": "text", "value": "Specific breakage class for moved parameters."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 287, "endlineno": 287, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L287-L287", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_MOVED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 290, "endlineno": 291, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L290-L291", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 293, "endlineno": 296, "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L293-L296", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 298, "endlineno": 299, "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L298-L299", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 301, "endlineno": 302, "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L301-L302", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterMovedBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L284-L302", "bases": [{"member": "ParameterMovedBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ParameterRemovedBreakage": {"kind": "class", "name": "ParameterRemovedBreakage", "runtime": true, "lineno": 305, "endlineno": 323, "docstring": {"value": "Specific breakage class for removed parameters.", "lineno": 306, "endlineno": 306, "parsed": [{"kind": "text", "value": "Specific breakage class for removed parameters."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 308, "endlineno": 308, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L308-L308", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_REMOVED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 311, "endlineno": 312, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L311-L312", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 314, "endlineno": 317, "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L314-L317", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 319, "endlineno": 320, "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L319-L320", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 322, "endlineno": 323, "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L322-L323", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterRemovedBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L305-L323", "bases": [{"member": "ParameterRemovedBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ParameterChangedKindBreakage": {"kind": "class", "name": "ParameterChangedKindBreakage", "runtime": true, "lineno": 326, "endlineno": 344, "docstring": {"value": "Specific breakage class for parameters whose kind changed.", "lineno": 327, "endlineno": 327, "parsed": [{"kind": "text", "value": "Specific breakage class for parameters whose kind changed."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 329, "endlineno": 329, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L329-L329", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_CHANGED_KIND", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 332, "endlineno": 333, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L332-L333", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 335, "endlineno": 338, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L335-L338", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 340, "endlineno": 341, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L340-L341", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 343, "endlineno": 344, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L343-L344", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedKindBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L326-L344", "bases": [{"member": "ParameterChangedKindBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ParameterChangedDefaultBreakage": {"kind": "class", "name": "ParameterChangedDefaultBreakage", "runtime": true, "lineno": 347, "endlineno": 365, "docstring": {"value": "Specific breakage class for parameters whose default value changed.", "lineno": 348, "endlineno": 348, "parsed": [{"kind": "text", "value": "Specific breakage class for parameters whose default value changed."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 350, "endlineno": 350, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L350-L350", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_CHANGED_DEFAULT", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 353, "endlineno": 354, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L353-L354", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 356, "endlineno": 359, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L356-L359", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 361, "endlineno": 362, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L361-L362", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 364, "endlineno": 365, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L364-L365", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedDefaultBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L347-L365", "bases": [{"member": "ParameterChangedDefaultBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ParameterChangedRequiredBreakage": {"kind": "class", "name": "ParameterChangedRequiredBreakage", "runtime": true, "lineno": 368, "endlineno": 386, "docstring": {"value": "Specific breakage class for parameters which became required.", "lineno": 369, "endlineno": 369, "parsed": [{"kind": "text", "value": "Specific breakage class for parameters which became required."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 371, "endlineno": 371, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L371-L371", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_CHANGED_REQUIRED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 374, "endlineno": 375, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L374-L375", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 377, "endlineno": 380, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L377-L380", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 382, "endlineno": 383, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L382-L383", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 385, "endlineno": 386, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L385-L386", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterChangedRequiredBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L368-L386", "bases": [{"member": "ParameterChangedRequiredBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ParameterAddedRequiredBreakage": {"kind": "class", "name": "ParameterAddedRequiredBreakage", "runtime": true, "lineno": 389, "endlineno": 407, "docstring": {"value": "Specific breakage class for new parameters added as required.", "lineno": 390, "endlineno": 390, "parsed": [{"kind": "text", "value": "Specific breakage class for new parameters added as required."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 392, "endlineno": 392, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L392-L392", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "PARAMETER_ADDED_REQUIRED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_relative_path": {"kind": "attribute", "name": "_relative_path", "runtime": true, "lineno": 395, "endlineno": 396, "labels": ["property"], "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage._relative_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L395-L396", "annotation": {"member": "_relative_path", "name": "str", "cls": "ExprName"}}, "_format_title": {"kind": "function", "name": "_format_title", "runtime": true, "lineno": 398, "endlineno": 401, "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage._format_title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L398-L401", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_title", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_title", "name": "str", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 403, "endlineno": 404, "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L403-L404", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 406, "endlineno": 407, "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L406-L407", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ParameterAddedRequiredBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L389-L407", "bases": [{"member": "ParameterAddedRequiredBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ReturnChangedTypeBreakage": {"kind": "class", "name": "ReturnChangedTypeBreakage", "runtime": true, "lineno": 410, "endlineno": 413, "docstring": {"value": "Specific breakage class for return values which changed type.", "lineno": 411, "endlineno": 411, "parsed": [{"kind": "text", "value": "Specific breakage class for return values which changed type."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 413, "endlineno": 413, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ReturnChangedTypeBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L413-L413", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "RETURN_CHANGED_TYPE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ReturnChangedTypeBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L410-L413", "bases": [{"member": "ReturnChangedTypeBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ObjectRemovedBreakage": {"kind": "class", "name": "ObjectRemovedBreakage", "runtime": true, "lineno": 416, "endlineno": 425, "docstring": {"value": "Specific breakage class for removed objects.", "lineno": 417, "endlineno": 417, "parsed": [{"kind": "text", "value": "Specific breakage class for removed objects."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 419, "endlineno": 419, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ObjectRemovedBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L419-L419", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "OBJECT_REMOVED", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 421, "endlineno": 422, "analysis": "static", "path": "griffe._internal.diff.ObjectRemovedBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L421-L422", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 424, "endlineno": 425, "analysis": "static", "path": "griffe._internal.diff.ObjectRemovedBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L424-L425", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ObjectRemovedBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L416-L425", "bases": [{"member": "ObjectRemovedBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ObjectChangedKindBreakage": {"kind": "class", "name": "ObjectChangedKindBreakage", "runtime": true, "lineno": 428, "endlineno": 437, "docstring": {"value": "Specific breakage class for objects whose kind changed.", "lineno": 429, "endlineno": 429, "parsed": [{"kind": "text", "value": "Specific breakage class for objects whose kind changed."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 431, "endlineno": 431, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ObjectChangedKindBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L431-L431", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "OBJECT_CHANGED_KIND", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 433, "endlineno": 434, "analysis": "static", "path": "griffe._internal.diff.ObjectChangedKindBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L433-L434", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 436, "endlineno": 437, "analysis": "static", "path": "griffe._internal.diff.ObjectChangedKindBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L436-L437", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ObjectChangedKindBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L428-L437", "bases": [{"member": "ObjectChangedKindBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "AttributeChangedTypeBreakage": {"kind": "class", "name": "AttributeChangedTypeBreakage", "runtime": true, "lineno": 440, "endlineno": 443, "docstring": {"value": "Specific breakage class for attributes whose type changed.", "lineno": 441, "endlineno": 441, "parsed": [{"kind": "text", "value": "Specific breakage class for attributes whose type changed."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 443, "endlineno": 443, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.AttributeChangedTypeBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L443-L443", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "ATTRIBUTE_CHANGED_TYPE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.AttributeChangedTypeBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L440-L443", "bases": [{"member": "AttributeChangedTypeBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "AttributeChangedValueBreakage": {"kind": "class", "name": "AttributeChangedValueBreakage", "runtime": true, "lineno": 446, "endlineno": 449, "docstring": {"value": "Specific breakage class for attributes whose value changed.", "lineno": 447, "endlineno": 447, "parsed": [{"kind": "text", "value": "Specific breakage class for attributes whose value changed."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 449, "endlineno": 449, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.AttributeChangedValueBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L449-L449", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "ATTRIBUTE_CHANGED_VALUE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.AttributeChangedValueBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L446-L449", "bases": [{"member": "AttributeChangedValueBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "ClassRemovedBaseBreakage": {"kind": "class", "name": "ClassRemovedBaseBreakage", "runtime": true, "lineno": 452, "endlineno": 461, "docstring": {"value": "Specific breakage class for removed base classes.", "lineno": 453, "endlineno": 453, "parsed": [{"kind": "text", "value": "Specific breakage class for removed base classes."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 455, "endlineno": 455, "docstring": {"value": "The kind of breakage.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "The kind of breakage."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.diff.ClassRemovedBaseBreakage.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L455-L455", "value": {"values": [{"member": null, "name": "BreakageKind", "cls": "ExprName"}, {"member": null, "name": "CLASS_REMOVED_BASE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "BreakageKind", "cls": "ExprName"}}, "_format_old_value": {"kind": "function", "name": "_format_old_value", "runtime": true, "lineno": 457, "endlineno": 458, "analysis": "static", "path": "griffe._internal.diff.ClassRemovedBaseBreakage._format_old_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L457-L458", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_old_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_old_value", "name": "str", "cls": "ExprName"}}, "_format_new_value": {"kind": "function", "name": "_format_new_value", "runtime": true, "lineno": 460, "endlineno": 461, "analysis": "static", "path": "griffe._internal.diff.ClassRemovedBaseBreakage._format_new_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L460-L461", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "colors", "annotation": {"member": "_format_new_value", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_format_new_value", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.diff.ClassRemovedBaseBreakage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L452-L461", "bases": [{"member": "ClassRemovedBaseBreakage", "name": "Breakage", "cls": "ExprName"}], "decorators": []}, "_class_incompatibilities": {"kind": "function", "name": "_class_incompatibilities", "runtime": true, "lineno": 465, "endlineno": 474, "analysis": "static", "path": "griffe._internal.diff._class_incompatibilities", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L465-L474", "decorators": [], "parameters": [{"name": "old_class", "annotation": {"member": "_class_incompatibilities", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "new_class", "annotation": {"member": "_class_incompatibilities", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "seen_paths", "annotation": {"left": {"member": "_class_incompatibilities", "name": "set", "cls": "ExprName"}, "slice": {"member": "_class_incompatibilities", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "keyword-only", "default": null}], "returns": {"left": {"member": "_class_incompatibilities", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_class_incompatibilities", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_function_incompatibilities": {"kind": "function", "name": "_function_incompatibilities", "runtime": true, "lineno": 478, "endlineno": 550, "analysis": "static", "path": "griffe._internal.diff._function_incompatibilities", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L478-L550", "decorators": [], "parameters": [{"name": "old_function", "annotation": {"member": "_function_incompatibilities", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "new_function", "annotation": {"member": "_function_incompatibilities", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_function_incompatibilities", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_function_incompatibilities", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_attribute_incompatibilities": {"kind": "function", "name": "_attribute_incompatibilities", "runtime": true, "lineno": 553, "endlineno": 559, "analysis": "static", "path": "griffe._internal.diff._attribute_incompatibilities", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L553-L559", "decorators": [], "parameters": [{"name": "old_attribute", "annotation": {"member": "_attribute_incompatibilities", "name": "Attribute", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "new_attribute", "annotation": {"member": "_attribute_incompatibilities", "name": "Attribute", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_attribute_incompatibilities", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_attribute_incompatibilities", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_alias_incompatibilities": {"kind": "function", "name": "_alias_incompatibilities", "runtime": true, "lineno": 562, "endlineno": 575, "analysis": "static", "path": "griffe._internal.diff._alias_incompatibilities", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L562-L575", "decorators": [], "parameters": [{"name": "old_obj", "annotation": {"left": {"member": "_alias_incompatibilities", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_alias_incompatibilities", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "new_obj", "annotation": {"left": {"member": "_alias_incompatibilities", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_alias_incompatibilities", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "seen_paths", "annotation": {"left": {"member": "_alias_incompatibilities", "name": "set", "cls": "ExprName"}, "slice": {"member": "_alias_incompatibilities", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "keyword-only", "default": null}], "returns": {"left": {"member": "_alias_incompatibilities", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_alias_incompatibilities", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_member_incompatibilities": {"kind": "function", "name": "_member_incompatibilities", "runtime": true, "lineno": 578, "endlineno": 596, "analysis": "static", "path": "griffe._internal.diff._member_incompatibilities", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L578-L596", "decorators": [], "parameters": [{"name": "old_obj", "annotation": {"left": {"member": "_member_incompatibilities", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_member_incompatibilities", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "new_obj", "annotation": {"left": {"member": "_member_incompatibilities", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_member_incompatibilities", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "seen_paths", "annotation": {"left": {"left": {"member": "_member_incompatibilities", "name": "set", "cls": "ExprName"}, "slice": {"member": "_member_incompatibilities", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "_member_incompatibilities", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_member_incompatibilities", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_type_based_yield": {"kind": "function", "name": "_type_based_yield", "runtime": true, "lineno": 599, "endlineno": 633, "analysis": "static", "path": "griffe._internal.diff._type_based_yield", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L599-L633", "decorators": [], "parameters": [{"name": "old_member", "annotation": {"left": {"member": "_type_based_yield", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_type_based_yield", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "new_member", "annotation": {"left": {"member": "_type_based_yield", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_type_based_yield", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "seen_paths", "annotation": {"left": {"member": "_type_based_yield", "name": "set", "cls": "ExprName"}, "slice": {"member": "_type_based_yield", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "keyword-only", "default": null}], "returns": {"left": {"member": "_type_based_yield", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_type_based_yield", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_returns_are_compatible": {"kind": "function", "name": "_returns_are_compatible", "runtime": true, "lineno": 636, "endlineno": 654, "analysis": "static", "path": "griffe._internal.diff._returns_are_compatible", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L636-L654", "decorators": [], "parameters": [{"name": "old_function", "annotation": {"member": "_returns_are_compatible", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "new_function", "annotation": {"member": "_returns_are_compatible", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_returns_are_compatible", "name": "bool", "cls": "ExprName"}}, "_sentinel": {"kind": "attribute", "name": "_sentinel", "runtime": true, "lineno": 657, "endlineno": 657, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.diff._sentinel", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L657-L657", "value": {"arguments": [], "function": {"member": null, "name": "object", "cls": "ExprName"}, "cls": "ExprCall"}}, "find_breaking_changes": {"kind": "function", "name": "find_breaking_changes", "runtime": true, "lineno": 660, "endlineno": 683, "docstring": {"value": "Find breaking changes between two versions of the same API.\n\nThe function will iterate recursively on all objects\nand yield breaking changes with detailed information.\n\nParameters:\n    old_obj: The old version of an object.\n    new_obj: The new version of an object.\n\nYields:\n    Breaking changes.\n\nExamples:\n    >>> import sys, griffe\n    >>> new = griffe.load(\"pkg\")\n    >>> old = griffe.load_git(\"pkg\", \"1.2.3\")\n    >>> for breakage in griffe.find_breaking_changes(old, new)\n    ...     print(breakage.explain(style=style), file=sys.stderr)", "lineno": 664, "endlineno": 682, "parsed": [{"kind": "text", "value": "Find breaking changes between two versions of the same API.\n\nThe function will iterate recursively on all objects\nand yield breaking changes with detailed information."}, {"kind": "parameters", "value": [{"name": "old_obj", "annotation": {"left": {"member": "find_breaking_changes", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_breaking_changes", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The old version of an object."}, {"name": "new_obj", "annotation": {"left": {"member": "find_breaking_changes", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_breaking_changes", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The new version of an object."}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "find_breaking_changes", "name": "Breakage", "cls": "ExprName"}, "description": "Breaking changes."}]}, {"kind": "examples", "value": [["examples", ">>> import sys, griffe\n>>> new = griffe.load(\"pkg\")\n>>> old = griffe.load_git(\"pkg\", \"1.2.3\")\n>>> for breakage in griffe.find_breaking_changes(old, new)\n...     print(breakage.explain(style=style), file=sys.stderr)"]]}]}, "analysis": "static", "path": "griffe._internal.diff.find_breaking_changes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/diff.py#L660-L683", "decorators": [], "parameters": [{"name": "old_obj", "annotation": {"left": {"member": "find_breaking_changes", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_breaking_changes", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "new_obj", "annotation": {"left": {"member": "find_breaking_changes", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_breaking_changes", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "find_breaking_changes", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "find_breaking_changes", "name": "Breakage", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.diff", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/diff.py", "relative_package_filepath": "griffe/_internal/diff.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/diff.py"}, "models": {"kind": "module", "name": "models", "runtime": true, "imports": {"annotations": "__future__.annotations", "inspect": "inspect", "defaultdict": "collections.defaultdict", "suppress": "contextlib.suppress", "asdict": "dataclasses.asdict", "Path": "pathlib.Path", "dedent": "textwrap.dedent", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "Literal": "typing.Literal", "cast": "typing.cast", "c3linear_merge": "griffe._internal.c3linear.c3linear_merge", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "parse": "griffe._internal.docstrings.parsers.parse", "Kind": "griffe._internal.enumerations.Kind", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "Parser": "griffe._internal.enumerations.Parser", "TypeParameterKind": "griffe._internal.enumerations.TypeParameterKind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "BuiltinModuleError": "griffe._internal.exceptions.BuiltinModuleError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "NameResolutionError": "griffe._internal.exceptions.NameResolutionError", "ExprCall": "griffe._internal.expressions.ExprCall", "ExprName": "griffe._internal.expressions.ExprName", "ExprTuple": "griffe._internal.expressions.ExprTuple", "logger": "griffe._internal.logger.logger", "ObjectAliasMixin": "griffe._internal.mixins.ObjectAliasMixin", "Callable": "collections.abc.Callable", "Sequence": "collections.abc.Sequence", "LinesCollection": "griffe._internal.collections.LinesCollection", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "Expr": "griffe._internal.expressions.Expr", "GitInfo": "griffe._internal.git.GitInfo", "cached_property": "functools.cached_property"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.models.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "inspect": {"kind": "alias", "name": "inspect", "target_path": "inspect", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.models.inspect", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "defaultdict": {"kind": "alias", "name": "defaultdict", "target_path": "collections.defaultdict", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.models.defaultdict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.models.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "asdict": {"kind": "alias", "name": "asdict", "target_path": "dataclasses.asdict", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.models.asdict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.models.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dedent": {"kind": "alias", "name": "dedent", "target_path": "textwrap.dedent", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.models.dedent", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.models.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.models.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.models.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cast": {"kind": "alias", "name": "cast", "target_path": "typing.cast", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.models.cast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "c3linear_merge": {"kind": "alias", "name": "c3linear_merge", "target_path": "griffe._internal.c3linear.c3linear_merge", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.models.c3linear_merge", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.models.DocstringOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.models.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse": {"kind": "alias", "name": "parse", "target_path": "griffe._internal.docstrings.parsers.parse", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.models.parse", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.models.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.models.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.models.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameterKind": {"kind": "alias", "name": "TypeParameterKind", "target_path": "griffe._internal.enumerations.TypeParameterKind", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.models.TypeParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.models.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "BuiltinModuleError": {"kind": "alias", "name": "BuiltinModuleError", "target_path": "griffe._internal.exceptions.BuiltinModuleError", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.models.BuiltinModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.models.CyclicAliasError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "NameResolutionError": {"kind": "alias", "name": "NameResolutionError", "target_path": "griffe._internal.exceptions.NameResolutionError", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.models.NameResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprCall": {"kind": "alias", "name": "ExprCall", "target_path": "griffe._internal.expressions.ExprCall", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.models.ExprCall", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.models.ExprName", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprTuple": {"kind": "alias", "name": "ExprTuple", "target_path": "griffe._internal.expressions.ExprTuple", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.models.ExprTuple", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.models.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ObjectAliasMixin": {"kind": "alias", "name": "ObjectAliasMixin", "target_path": "griffe._internal.mixins.ObjectAliasMixin", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.models.ObjectAliasMixin", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.models.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.models.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.models.LinesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.models.ModulesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": false, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.models.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 27, "endlineno": 27, "analysis": "static", "path": "griffe._internal.models.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "GitInfo": {"kind": "alias", "name": "GitInfo", "target_path": "griffe._internal.git.GitInfo", "runtime": false, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.models.GitInfo", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "cached_property": {"kind": "alias", "name": "cached_property", "target_path": "functools.cached_property", "runtime": true, "inherited": false, "lineno": 31, "endlineno": 31, "analysis": "static", "path": "griffe._internal.models.cached_property", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Decorator": {"kind": "class", "name": "Decorator", "runtime": true, "lineno": 34, "endlineno": 71, "docstring": {"value": "This class represents decorators.", "lineno": 35, "endlineno": 35, "parsed": [{"kind": "text", "value": "This class represents decorators."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 37, "endlineno": 50, "docstring": {"value": "Initialize the decorator.\n\nParameters:\n    value: The decorator code.\n    lineno: The starting line number.\n    endlineno: The ending line number.", "lineno": 38, "endlineno": 44, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The decorator code."}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The starting line number."}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The ending line number."}]}]}, "analysis": "static", "path": "griffe._internal.models.Decorator.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L37-L50", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 45, "endlineno": 45, "docstring": {"value": "The decorator value (as a Griffe expression or string).", "lineno": 46, "endlineno": 46, "parsed": [{"kind": "text", "value": "The decorator value (as a Griffe expression or string)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Decorator.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L45-L45", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "lineno": {"kind": "attribute", "name": "lineno", "runtime": true, "lineno": 47, "endlineno": 47, "docstring": {"value": "The starting line number of the decorator.", "lineno": 48, "endlineno": 48, "parsed": [{"kind": "text", "value": "The starting line number of the decorator."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Decorator.lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L47-L47", "value": {"member": null, "name": "lineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "endlineno": {"kind": "attribute", "name": "endlineno", "runtime": true, "lineno": 49, "endlineno": 49, "docstring": {"value": "The ending line number of the decorator.", "lineno": 50, "endlineno": 50, "parsed": [{"kind": "text", "value": "The ending line number of the decorator."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Decorator.endlineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L49-L49", "value": {"member": null, "name": "endlineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "callable_path": {"kind": "attribute", "name": "callable_path", "runtime": true, "lineno": 53, "endlineno": 56, "docstring": {"value": "The path of the callable used as decorator.", "lineno": 54, "endlineno": 54, "parsed": [{"kind": "text", "value": "The path of the callable used as decorator."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Decorator.callable_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L53-L56", "annotation": {"member": "callable_path", "name": "str", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 58, "endlineno": 71, "docstring": {"value": "Return this decorator's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 59, "endlineno": 66, "parsed": [{"kind": "text", "value": "Return this decorator's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Decorator.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L58-L71", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Decorator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L34-L71", "bases": [], "decorators": []}, "Docstring": {"kind": "class", "name": "Docstring", "runtime": true, "lineno": 74, "endlineno": 207, "docstring": {"value": "This class represents docstrings.", "lineno": 75, "endlineno": 75, "parsed": [{"kind": "text", "value": "This class represents docstrings."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 77, "endlineno": 128, "docstring": {"value": "Initialize the docstring.\n\nParameters:\n    value: The docstring value.\n    lineno: The starting line number.\n    endlineno: The ending line number.\n    parent: The parent object on which this docstring is attached.\n    parser: The docstring parser to use. By default, no parsing is done.\n    parser_options: Additional docstring parsing options.", "lineno": 87, "endlineno": 96, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The docstring value."}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The starting line number.", "value": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The ending line number.", "value": "None"}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The parent object on which this docstring is attached.", "value": "None"}, {"name": "parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "parser_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional docstring parsing options.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.models.Docstring.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L77-L128", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parser_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 97, "endlineno": 97, "docstring": {"value": "The original value of the docstring, cleaned by `inspect.cleandoc`.\n\nSee also: [`source`][griffe.Docstring.source].", "lineno": 98, "endlineno": 101, "parsed": [{"kind": "text", "value": "The original value of the docstring, cleaned by `inspect.cleandoc`.\n\nSee also: [`source`][griffe.Docstring.source]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L97-L97", "value": {"arguments": [{"arguments": [], "function": {"values": [{"member": null, "name": "value", "cls": "ExprName"}, {"member": null, "name": "rstrip", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}], "function": {"values": [{"member": null, "name": "inspect", "cls": "ExprName"}, {"member": null, "name": "cleandoc", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "lineno": {"kind": "attribute", "name": "lineno", "runtime": true, "lineno": 103, "endlineno": 103, "docstring": {"value": "The starting line number of the docstring.\n\nSee also: [`endlineno`][griffe.Docstring.endlineno].", "lineno": 104, "endlineno": 106, "parsed": [{"kind": "text", "value": "The starting line number of the docstring.\n\nSee also: [`endlineno`][griffe.Docstring.endlineno]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L103-L103", "value": {"member": null, "name": "lineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "endlineno": {"kind": "attribute", "name": "endlineno", "runtime": true, "lineno": 108, "endlineno": 108, "docstring": {"value": "The ending line number of the docstring.\n\nSee also: [`lineno`][griffe.Docstring.lineno].", "lineno": 109, "endlineno": 111, "parsed": [{"kind": "text", "value": "The ending line number of the docstring.\n\nSee also: [`lineno`][griffe.Docstring.lineno]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.endlineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L108-L108", "value": {"member": null, "name": "endlineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 113, "endlineno": 113, "docstring": {"value": "The object this docstring is attached to.", "lineno": 114, "endlineno": 114, "parsed": [{"kind": "text", "value": "The object this docstring is attached to."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L113-L113", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Object", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "parser": {"kind": "attribute", "name": "parser", "runtime": true, "lineno": 116, "endlineno": 116, "docstring": {"value": "The selected docstring parser.\n\nSee also: [`parser_options`][griffe.Docstring.parser_options],\n[`parse`][griffe.Docstring.parse].", "lineno": 117, "endlineno": 121, "parsed": [{"kind": "text", "value": "The selected docstring parser.\n\nSee also: [`parser_options`][griffe.Docstring.parser_options],\n[`parse`][griffe.Docstring.parse]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.parser", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L116-L116", "value": {"member": null, "name": "parser", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "parser_options": {"kind": "attribute", "name": "parser_options", "runtime": true, "lineno": 123, "endlineno": 123, "docstring": {"value": "The configured parsing options.\n\nSee also: [`parser`][griffe.Docstring.parser],\n[`parse`][griffe.Docstring.parse].", "lineno": 124, "endlineno": 128, "parsed": [{"kind": "text", "value": "The configured parsing options.\n\nSee also: [`parser`][griffe.Docstring.parser],\n[`parse`][griffe.Docstring.parse]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Docstring.parser_options", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L123-L123", "value": {"operator": "or", "values": [{"member": null, "name": "parser_options", "cls": "ExprName"}, {"keys": [], "values": [], "cls": "ExprDict"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "DocstringOptions", "cls": "ExprName"}}, "lines": {"kind": "attribute", "name": "lines", "runtime": true, "lineno": 131, "endlineno": 136, "docstring": {"value": "The lines of the docstring.\n\nSee also: [`source`][griffe.Docstring.source].", "lineno": 132, "endlineno": 135, "parsed": [{"kind": "text", "value": "The lines of the docstring.\n\nSee also: [`source`][griffe.Docstring.source]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Docstring.lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L131-L136", "annotation": {"left": {"member": "lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "source": {"kind": "attribute", "name": "source", "runtime": true, "lineno": 139, "endlineno": 158, "docstring": {"value": "The original, uncleaned value of the docstring as written in the source.\n\nIt is a simple concatenation of the source lines. These source lines will include\nquotes (single/double/triple) and might include leading whitespace and indentation,\nas well as trailing comments.\n\nRaises:\n    ValueError: If the original docstring cannot be retrieved\n        (no parent, no line numbers, or attached to namespace package).\n\nSee also: [`value`][griffe.Docstring.value].", "lineno": 140, "endlineno": 151, "parsed": [{"kind": "text", "value": "The original, uncleaned value of the docstring as written in the source.\n\nIt is a simple concatenation of the source lines. These source lines will include\nquotes (single/double/triple) and might include leading whitespace and indentation,\nas well as trailing comments."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "If the original docstring cannot be retrieved\n(no parent, no line numbers, or attached to namespace package)."}]}, {"kind": "text", "value": "See also: [`value`][griffe.Docstring.value]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Docstring.source", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L139-L158", "annotation": {"member": "source", "name": "str", "cls": "ExprName"}}, "parsed": {"kind": "attribute", "name": "parsed", "runtime": true, "lineno": 161, "endlineno": 163, "docstring": {"value": "The docstring sections, parsed into structured data.", "lineno": 162, "endlineno": 162, "parsed": [{"kind": "text", "value": "The docstring sections, parsed into structured data."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.models.Docstring.parsed", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L161-L163", "annotation": {"left": {"member": "parsed", "name": "list", "cls": "ExprName"}, "slice": {"member": "parsed", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "parse": {"kind": "function", "name": "parse", "runtime": true, "lineno": 165, "endlineno": 183, "docstring": {"value": "Parse the docstring into structured data.\n\nSee also: [`parser`][griffe.Docstring.parser],\n[`parser_options`][griffe.Docstring.parser_options].\n\nParameters:\n    parser: The docstring parser to use.\n        In order: use the given parser, or the self parser, or no parser (return a single text section).\n    **options: Additional docstring parsing options.\n\nReturns:\n    The parsed docstring as a list of sections.", "lineno": 170, "endlineno": 182, "parsed": [{"kind": "text", "value": "Parse the docstring into structured data.\n\nSee also: [`parser`][griffe.Docstring.parser],\n[`parser_options`][griffe.Docstring.parser_options]."}, {"kind": "parameters", "value": [{"name": "parser", "annotation": {"left": {"left": {"member": "parse", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use.\nIn order: use the given parser, or the self parser, or no parser (return a single text section).", "value": "None"}, {"name": "**options", "annotation": {"member": "parse", "name": "Any", "cls": "ExprName"}, "description": "Additional docstring parsing options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The parsed docstring as a list of sections."}]}]}, "analysis": "static", "path": "griffe._internal.models.Docstring.parse", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L165-L183", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "parser", "annotation": {"left": {"left": {"member": "parse", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "options", "annotation": {"member": "parse", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "parse", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 185, "endlineno": 207, "docstring": {"value": "Return this docstring's data as a dictionary.\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 191, "endlineno": 199, "parsed": [{"kind": "text", "value": "Return this docstring's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Docstring.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L185-L207", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L74-L207", "bases": [], "decorators": []}, "Parameter": {"kind": "class", "name": "Parameter", "runtime": true, "lineno": 210, "endlineno": 291, "docstring": {"value": "This class represent a function parameter.\n\nSee also: [`Parameters`][griffe.Parameters].", "lineno": 211, "endlineno": 214, "parsed": [{"kind": "text", "value": "This class represent a function parameter.\n\nSee also: [`Parameters`][griffe.Parameters]."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 216, "endlineno": 247, "docstring": {"value": "Initialize the parameter.\n\nParameters:\n    name: The parameter name, without leading stars (`*` or `**`).\n    annotation: The parameter annotation, if any.\n    kind: The parameter kind.\n    default: The parameter default, if any.\n    docstring: The parameter docstring.", "lineno": 225, "endlineno": 233, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The parameter name, without leading stars (`*` or `**`)."}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The parameter annotation, if any.", "value": "None"}, {"name": "kind", "annotation": {"left": {"member": "__init__", "name": "ParameterKind", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The parameter kind.", "value": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The parameter default, if any.", "value": "None"}, {"name": "docstring", "annotation": {"left": {"member": "__init__", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The parameter docstring.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.models.Parameter.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L216-L247", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kind", "annotation": {"left": {"member": "__init__", "name": "ParameterKind", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring", "annotation": {"left": {"member": "__init__", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 234, "endlineno": 234, "docstring": {"value": "The parameter name.", "lineno": 235, "endlineno": 235, "parsed": [{"kind": "text", "value": "The parameter name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L234-L234", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 236, "endlineno": 236, "docstring": {"value": "The parameter type annotation.", "lineno": 237, "endlineno": 237, "parsed": [{"kind": "text", "value": "The parameter type annotation."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L236-L236", "value": {"member": null, "name": "annotation", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 238, "endlineno": 238, "docstring": {"value": "The parameter kind.", "lineno": 239, "endlineno": 239, "parsed": [{"kind": "text", "value": "The parameter kind."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L238-L238", "value": {"member": null, "name": "kind", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "ParameterKind", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "default": {"kind": "attribute", "name": "default", "runtime": true, "lineno": 240, "endlineno": 240, "docstring": {"value": "The parameter default value.", "lineno": 241, "endlineno": 241, "parsed": [{"kind": "text", "value": "The parameter default value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L240-L240", "value": {"member": null, "name": "default", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring": {"kind": "attribute", "name": "docstring", "runtime": true, "lineno": 242, "endlineno": 242, "docstring": {"value": "The parameter docstring.", "lineno": 243, "endlineno": 243, "parsed": [{"kind": "text", "value": "The parameter docstring."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L242-L242", "value": {"member": null, "name": "docstring", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "function": {"kind": "attribute", "name": "function", "runtime": true, "lineno": 246, "endlineno": 246, "docstring": {"value": "The parent function of the parameter.", "lineno": 247, "endlineno": 247, "parsed": [{"kind": "text", "value": "The parent function of the parameter."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameter.function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L246-L246", "value": "None", "annotation": {"left": {"member": null, "name": "Function", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__str__": {"kind": "function", "name": "__str__", "runtime": true, "lineno": 249, "endlineno": 253, "analysis": "static", "path": "griffe._internal.models.Parameter.__str__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L249-L253", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__str__", "name": "str", "cls": "ExprName"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 255, "endlineno": 256, "analysis": "static", "path": "griffe._internal.models.Parameter.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L255-L256", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "__eq__": {"kind": "function", "name": "__eq__", "runtime": true, "lineno": 258, "endlineno": 267, "docstring": {"value": "Parameters are equal if all their attributes except `docstring` and `function` are equal.", "lineno": 259, "endlineno": 259, "parsed": [{"kind": "text", "value": "Parameters are equal if all their attributes except `docstring` and `function` are equal."}]}, "analysis": "static", "path": "griffe._internal.models.Parameter.__eq__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L258-L267", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional-only", "default": null}, {"name": "value", "annotation": {"member": "__eq__", "name": "object", "cls": "ExprName"}, "kind": "positional-only", "default": null}], "returns": {"member": "__eq__", "name": "bool", "cls": "ExprName"}}, "required": {"kind": "attribute", "name": "required", "runtime": true, "lineno": 270, "endlineno": 272, "docstring": {"value": "Whether this parameter is required.", "lineno": 271, "endlineno": 271, "parsed": [{"kind": "text", "value": "Whether this parameter is required."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Parameter.required", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L270-L272", "annotation": {"member": "required", "name": "bool", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 274, "endlineno": 291, "docstring": {"value": "Return this parameter's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 275, "endlineno": 282, "parsed": [{"kind": "text", "value": "Return this parameter's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Parameter.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L274-L291", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L210-L291", "bases": [], "decorators": []}, "Parameters": {"kind": "class", "name": "Parameters", "runtime": true, "lineno": 294, "endlineno": 381, "docstring": {"value": "This class is a container for parameters.\n\nIt allows to get parameters using their position (index) or their name:\n\n```pycon\n>>> parameters = Parameters(Parameter(\"hello\"))\n>>> parameters[0] is parameters[\"hello\"]\nTrue\n```\n\nSee also: [`Parameter`][griffe.Parameter].", "lineno": 295, "endlineno": 306, "parsed": [{"kind": "text", "value": "This class is a container for parameters.\n\nIt allows to get parameters using their position (index) or their name:\n\n```pycon\n>>> parameters = Parameters(Parameter(\"hello\"))\n>>> parameters[0] is parameters[\"hello\"]\nTrue\n```\n\nSee also: [`Parameter`][griffe.Parameter]."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 308, "endlineno": 314, "docstring": {"value": "Initialize the parameters container.\n\nParameters:\n    *parameters: The initial parameters to add to the container.", "lineno": 309, "endlineno": 313, "parsed": [{"kind": "parameters", "value": [{"name": "*parameters", "annotation": {"member": "__init__", "name": "Parameter", "cls": "ExprName"}, "description": "The initial parameters to add to the container.", "value": "()"}]}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L308-L314", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "parameters", "annotation": {"member": "__init__", "name": "Parameter", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": "None"}, "_params": {"kind": "attribute", "name": "_params", "runtime": true, "lineno": 314, "endlineno": 314, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Parameters._params", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L314-L314", "value": {"arguments": [{"member": null, "name": "parameters", "cls": "ExprName"}], "function": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Parameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 316, "endlineno": 317, "analysis": "static", "path": "griffe._internal.models.Parameters.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L316-L317", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "__getitem__": {"kind": "function", "name": "__getitem__", "runtime": true, "lineno": 319, "endlineno": 327, "docstring": {"value": "Get a parameter by index or name.", "lineno": 320, "endlineno": 320, "parsed": [{"kind": "text", "value": "Get a parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__getitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L319-L327", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__getitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__getitem__", "name": "Parameter", "cls": "ExprName"}}, "__setitem__": {"kind": "function", "name": "__setitem__", "runtime": true, "lineno": 329, "endlineno": 340, "docstring": {"value": "Set a parameter by index or name.", "lineno": 330, "endlineno": 330, "parsed": [{"kind": "text", "value": "Set a parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__setitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L329-L340", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__setitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parameter", "annotation": {"member": "__setitem__", "name": "Parameter", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__delitem__": {"kind": "function", "name": "__delitem__", "runtime": true, "lineno": 342, "endlineno": 352, "docstring": {"value": "Delete a parameter by index or name.", "lineno": 343, "endlineno": 343, "parsed": [{"kind": "text", "value": "Delete a parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__delitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L342-L352", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__delitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__len__": {"kind": "function", "name": "__len__", "runtime": true, "lineno": 354, "endlineno": 356, "docstring": {"value": "The number of parameters.", "lineno": 355, "endlineno": 355, "parsed": [{"kind": "text", "value": "The number of parameters."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__len__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L354-L356", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": null}, "__iter__": {"kind": "function", "name": "__iter__", "runtime": true, "lineno": 358, "endlineno": 360, "docstring": {"value": "Iterate over the parameters, in order.", "lineno": 359, "endlineno": 359, "parsed": [{"kind": "text", "value": "Iterate over the parameters, in order."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__iter__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L358-L360", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": null}, "__contains__": {"kind": "function", "name": "__contains__", "runtime": true, "lineno": 362, "endlineno": 368, "docstring": {"value": "Whether a parameter with the given name is present.", "lineno": 363, "endlineno": 363, "parsed": [{"kind": "text", "value": "Whether a parameter with the given name is present."}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.__contains__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L362-L368", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "param_name", "annotation": {"member": "__contains__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": null}, "add": {"kind": "function", "name": "add", "runtime": true, "lineno": 370, "endlineno": 381, "docstring": {"value": "Add a parameter to the container.\n\nParameters:\n    parameter: The function parameter to add.\n\nRaises:\n    ValueError: When a parameter with the same name is already present.", "lineno": 371, "endlineno": 378, "parsed": [{"kind": "text", "value": "Add a parameter to the container."}, {"kind": "parameters", "value": [{"name": "parameter", "annotation": {"member": "add", "name": "Parameter", "cls": "ExprName"}, "description": "The function parameter to add."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When a parameter with the same name is already present."}]}]}, "analysis": "static", "path": "griffe._internal.models.Parameters.add", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L370-L381", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "parameter", "annotation": {"member": "add", "name": "Parameter", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.models.Parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L294-L381", "bases": [], "decorators": []}, "TypeParameter": {"kind": "class", "name": "TypeParameter", "runtime": true, "lineno": 384, "endlineno": 473, "docstring": {"value": "This class represents a type parameter.", "lineno": 385, "endlineno": 385, "parsed": [{"kind": "text", "value": "This class represents a type parameter."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 387, "endlineno": 428, "docstring": {"value": "Initialize the type parameter.\n\nParameters:\n    name: The type parameter name, without leading stars (`*` or `**`).\n    kind: The type parameter kind.\n    bound: The type parameter bound, if any.\n        Mutually exclusive with `constraints`.\n    constraints: The type parameter constraints, if any.\n        Mutually exclusive with `bound`.\n    default: The type parameter default, if any.\n\nRaises:\n    ValueError: When more than one of `bound` and `constraints` is set.", "lineno": 396, "endlineno": 409, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The type parameter name, without leading stars (`*` or `**`)."}, {"name": "kind", "annotation": {"member": "__init__", "name": "TypeParameterKind", "cls": "ExprName"}, "description": "The type parameter kind."}, {"name": "bound", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type parameter bound, if any.\nMutually exclusive with `constraints`.", "value": "None"}, {"name": "constraints", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type parameter constraints, if any.\nMutually exclusive with `bound`.", "value": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type parameter default, if any.", "value": "None"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When more than one of `bound` and `constraints` is set."}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameter.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L387-L428", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "kind", "annotation": {"member": "__init__", "name": "TypeParameterKind", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "bound", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "constraints", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 413, "endlineno": 413, "docstring": {"value": "The type parameter name.", "lineno": 414, "endlineno": 414, "parsed": [{"kind": "text", "value": "The type parameter name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L413-L413", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 416, "endlineno": 416, "docstring": {"value": "The type parameter kind.", "lineno": 417, "endlineno": 417, "parsed": [{"kind": "text", "value": "The type parameter kind."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L416-L416", "value": {"member": null, "name": "kind", "cls": "ExprName"}, "annotation": {"member": null, "name": "TypeParameterKind", "cls": "ExprName"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 419, "endlineno": 419, "docstring": {"value": "The type parameter bound or constraints.", "lineno": 420, "endlineno": 420, "parsed": [{"kind": "text", "value": "The type parameter bound or constraints."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L419-L419", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "constraints": {"kind": "attribute", "name": "constraints", "runtime": true, "lineno": 445, "endlineno": 449, "docstring": {"value": "The type parameter constraints.", "lineno": 446, "endlineno": 446, "parsed": [{"kind": "text", "value": "The type parameter constraints."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.constraints", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L445-L449", "annotation": {"left": {"left": {"member": "constraints", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "constraints", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "constraints", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "bound": {"kind": "attribute", "name": "bound", "runtime": true, "lineno": 434, "endlineno": 438, "docstring": {"value": "The type parameter bound.", "lineno": 435, "endlineno": 435, "parsed": [{"kind": "text", "value": "The type parameter bound."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.bound", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L434-L438", "annotation": {"left": {"left": {"member": "bound", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "bound", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "default": {"kind": "attribute", "name": "default", "runtime": true, "lineno": 427, "endlineno": 427, "docstring": {"value": "The type parameter default value.", "lineno": 428, "endlineno": 428, "parsed": [{"kind": "text", "value": "The type parameter default value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeParameter.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L427-L427", "value": {"member": null, "name": "default", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 430, "endlineno": 431, "analysis": "static", "path": "griffe._internal.models.TypeParameter.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L430-L431", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 458, "endlineno": 473, "docstring": {"value": "Return this type parameter's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 459, "endlineno": 466, "parsed": [{"kind": "text", "value": "Return this type parameter's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameter.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L458-L473", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.TypeParameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L384-L473", "bases": [], "decorators": []}, "TypeParameters": {"kind": "class", "name": "TypeParameters", "runtime": true, "lineno": 476, "endlineno": 561, "docstring": {"value": "This class is a container for type parameters.\n\nIt allows to get type parameters using their position (index) or their name:\n\n```pycon\n>>> type_parameters = TypeParameters(TypeParameter(\"hello\"), kind=TypeParameterKind.type_var)\n>>> type_parameters[0] is type_parameters[\"hello\"]\nTrue\n```", "lineno": 477, "endlineno": 486, "parsed": [{"kind": "text", "value": "This class is a container for type parameters.\n\nIt allows to get type parameters using their position (index) or their name:\n\n```pycon\n>>> type_parameters = TypeParameters(TypeParameter(\"hello\"), kind=TypeParameterKind.type_var)\n>>> type_parameters[0] is type_parameters[\"hello\"]\nTrue\n```"}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 488, "endlineno": 494, "docstring": {"value": "Initialize the type parameters container.\n\nParameters:\n    *type_parameters: The initial type parameters to add to the container.", "lineno": 489, "endlineno": 493, "parsed": [{"kind": "parameters", "value": [{"name": "*type_parameters", "annotation": {"member": "__init__", "name": "TypeParameter", "cls": "ExprName"}, "description": "The initial type parameters to add to the container.", "value": "()"}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L488-L494", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "type_parameters", "annotation": {"member": "__init__", "name": "TypeParameter", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": "None"}, "_type_params": {"kind": "attribute", "name": "_type_params", "runtime": true, "lineno": 494, "endlineno": 494, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeParameters._type_params", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L494-L494", "value": {"arguments": [{"member": null, "name": "type_parameters", "cls": "ExprName"}], "function": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "TypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 496, "endlineno": 497, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L496-L497", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "__getitem__": {"kind": "function", "name": "__getitem__", "runtime": true, "lineno": 499, "endlineno": 507, "docstring": {"value": "Get a type parameter by index or name.", "lineno": 500, "endlineno": 500, "parsed": [{"kind": "text", "value": "Get a type parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__getitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L499-L507", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__getitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__getitem__", "name": "TypeParameter", "cls": "ExprName"}}, "__setitem__": {"kind": "function", "name": "__setitem__", "runtime": true, "lineno": 509, "endlineno": 520, "docstring": {"value": "Set a type parameter by index or name.", "lineno": 510, "endlineno": 510, "parsed": [{"kind": "text", "value": "Set a type parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__setitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L509-L520", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__setitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "type_parameter", "annotation": {"member": "__setitem__", "name": "TypeParameter", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__delitem__": {"kind": "function", "name": "__delitem__", "runtime": true, "lineno": 522, "endlineno": 532, "docstring": {"value": "Delete a type parameter by index or name.", "lineno": 523, "endlineno": 523, "parsed": [{"kind": "text", "value": "Delete a type parameter by index or name."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__delitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L522-L532", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name_or_index", "annotation": {"left": {"member": "__delitem__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": {"member": "__delitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__len__": {"kind": "function", "name": "__len__", "runtime": true, "lineno": 534, "endlineno": 536, "docstring": {"value": "The number of type parameters.", "lineno": 535, "endlineno": 535, "parsed": [{"kind": "text", "value": "The number of type parameters."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__len__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L534-L536", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": null}, "__iter__": {"kind": "function", "name": "__iter__", "runtime": true, "lineno": 538, "endlineno": 540, "docstring": {"value": "Iterate over the type parameters, in order.", "lineno": 539, "endlineno": 539, "parsed": [{"kind": "text", "value": "Iterate over the type parameters, in order."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__iter__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L538-L540", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": null}, "__contains__": {"kind": "function", "name": "__contains__", "runtime": true, "lineno": 542, "endlineno": 548, "docstring": {"value": "Whether a type parameter with the given name is present.", "lineno": 543, "endlineno": 543, "parsed": [{"kind": "text", "value": "Whether a type parameter with the given name is present."}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.__contains__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L542-L548", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "type_param_name", "annotation": {"member": "__contains__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": null}, "add": {"kind": "function", "name": "add", "runtime": true, "lineno": 550, "endlineno": 561, "docstring": {"value": "Add a type parameter to the container.\n\nParameters:\n    type_parameter: The function parameter to add.\n\nRaises:\n    ValueError: When a type parameter with the same name is already present.", "lineno": 551, "endlineno": 558, "parsed": [{"kind": "text", "value": "Add a type parameter to the container."}, {"kind": "parameters", "value": [{"name": "type_parameter", "annotation": {"member": "add", "name": "TypeParameter", "cls": "ExprName"}, "description": "The function parameter to add."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When a type parameter with the same name is already present."}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeParameters.add", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L550-L561", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "type_parameter", "annotation": {"member": "add", "name": "TypeParameter", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.models.TypeParameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L476-L561", "bases": [], "decorators": []}, "Object": {"kind": "class", "name": "Object", "runtime": true, "lineno": 564, "endlineno": 1324, "docstring": {"value": "An abstract class representing a Python object.", "lineno": 565, "endlineno": 565, "parsed": [{"kind": "text", "value": "An abstract class representing a Python object."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 567, "endlineno": 567, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L567-L567", "annotation": {"member": null, "name": "Kind", "cls": "ExprName"}}, "is_alias": {"kind": "attribute", "name": "is_alias", "runtime": true, "lineno": 569, "endlineno": 569, "docstring": {"value": "Always false for objects.", "lineno": 570, "endlineno": 570, "parsed": [{"kind": "text", "value": "Always false for objects."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.is_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L569-L569", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "is_collection": {"kind": "attribute", "name": "is_collection", "runtime": true, "lineno": 571, "endlineno": 571, "docstring": {"value": "Always false for objects.", "lineno": 572, "endlineno": 572, "parsed": [{"kind": "text", "value": "Always false for objects."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.is_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L571-L571", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "inherited": {"kind": "attribute", "name": "inherited", "runtime": true, "lineno": 573, "endlineno": 573, "docstring": {"value": "Always false for objects.\n\nOnly aliases can be marked as inherited.", "lineno": 574, "endlineno": 577, "parsed": [{"kind": "text", "value": "Always false for objects.\n\nOnly aliases can be marked as inherited."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.inherited", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L573-L573", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 579, "endlineno": 711, "docstring": {"value": "Initialize the object.\n\nParameters:\n    name: The object name, as declared in the code.\n    lineno: The object starting line, or None for modules. Lines start at 1.\n    endlineno: The object ending line (inclusive), or None for modules.\n    runtime: Whether this object is present at runtime or not.\n    docstring: The object docstring.\n    type_parameters: The object type parameters, if any.\n    parent: The object parent.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    git_info: Git information.\n    analysis: The type of analysis used to load this object.\n        None means the object was created manually.", "lineno": 594, "endlineno": 609, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The object name, as declared in the code."}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object starting line, or None for modules. Lines start at 1.", "value": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object ending line (inclusive), or None for modules.", "value": "None"}, {"name": "runtime", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether this object is present at runtime or not.", "value": "True"}, {"name": "docstring", "annotation": {"left": {"member": "__init__", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object docstring.", "value": "None"}, {"name": "type_parameters", "annotation": {"left": {"member": "__init__", "name": "TypeParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object type parameters, if any.", "value": "None"}, {"name": "parent", "annotation": {"left": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object parent.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "git_info", "annotation": {"left": {"member": "__init__", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Git information.", "value": "None"}, {"name": "analysis", "annotation": {"left": {"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type of analysis used to load this object.\nNone means the object was created manually.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L579-L711", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "runtime", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "docstring", "annotation": {"left": {"member": "__init__", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "type_parameters", "annotation": {"left": {"member": "__init__", "name": "TypeParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "git_info", "annotation": {"left": {"member": "__init__", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "analysis", "annotation": {"left": {"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 610, "endlineno": 610, "docstring": {"value": "The object name.", "lineno": 611, "endlineno": 611, "parsed": [{"kind": "text", "value": "The object name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L610-L610", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "lineno": {"kind": "attribute", "name": "lineno", "runtime": true, "lineno": 613, "endlineno": 613, "docstring": {"value": "The starting line number of the object.\n\nSee also: [`endlineno`][griffe.Object.endlineno].", "lineno": 614, "endlineno": 617, "parsed": [{"kind": "text", "value": "The starting line number of the object.\n\nSee also: [`endlineno`][griffe.Object.endlineno]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L613-L613", "value": {"member": null, "name": "lineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "endlineno": {"kind": "attribute", "name": "endlineno", "runtime": true, "lineno": 619, "endlineno": 619, "docstring": {"value": "The ending line number of the object.\n\nSee also: [`lineno`][griffe.Object.lineno].", "lineno": 620, "endlineno": 623, "parsed": [{"kind": "text", "value": "The ending line number of the object.\n\nSee also: [`lineno`][griffe.Object.lineno]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.endlineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L619-L619", "value": {"member": null, "name": "endlineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring": {"kind": "attribute", "name": "docstring", "runtime": true, "lineno": 625, "endlineno": 625, "docstring": {"value": "The object docstring.\n\nSee also: [`has_docstring`][griffe.Object.has_docstring],\n[`has_docstrings`][griffe.Object.has_docstrings].", "lineno": 626, "endlineno": 630, "parsed": [{"kind": "text", "value": "The object docstring.\n\nSee also: [`has_docstring`][griffe.Object.has_docstring],\n[`has_docstrings`][griffe.Object.has_docstrings]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L625-L625", "value": {"member": null, "name": "docstring", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "type_parameters": {"kind": "attribute", "name": "type_parameters", "runtime": true, "lineno": 635, "endlineno": 635, "docstring": {"value": "The object type parameters.", "lineno": 636, "endlineno": 636, "parsed": [{"kind": "text", "value": "The object type parameters."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L635-L635", "value": {"operator": "or", "values": [{"member": null, "name": "type_parameters", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "TypeParameters", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "TypeParameters", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 638, "endlineno": 638, "docstring": {"value": "The parent of the object (none if top module).", "lineno": 639, "endlineno": 639, "parsed": [{"kind": "text", "value": "The parent of the object (none if top module)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L638-L638", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "members": {"kind": "attribute", "name": "members", "runtime": true, "lineno": 641, "endlineno": 641, "docstring": {"value": "The object members (modules, classes, functions, attributes, type aliases).\n\nSee also: [`inherited_members`][griffe.Object.inherited_members],\n[`get_member`][griffe.Object.get_member],\n[`set_member`][griffe.Object.set_member],\n[`filter_members`][griffe.Object.filter_members].", "lineno": 642, "endlineno": 648, "parsed": [{"kind": "text", "value": "The object members (modules, classes, functions, attributes, type aliases).\n\nSee also: [`inherited_members`][griffe.Object.inherited_members],\n[`get_member`][griffe.Object.get_member],\n[`set_member`][griffe.Object.set_member],\n[`filter_members`][griffe.Object.filter_members]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L641-L641", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "labels": {"kind": "attribute", "name": "labels", "runtime": true, "lineno": 650, "endlineno": 650, "docstring": {"value": "The object labels (`property`, `dataclass`, etc.).\n\nSee also: [`has_labels`][griffe.Object.has_labels].", "lineno": 651, "endlineno": 653, "parsed": [{"kind": "text", "value": "The object labels (`property`, `dataclass`, etc.).\n\nSee also: [`has_labels`][griffe.Object.has_labels]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.labels", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L650-L650", "value": {"arguments": [], "function": {"member": null, "name": "set", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "set", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "imports": {"kind": "attribute", "name": "imports", "runtime": true, "lineno": 655, "endlineno": 655, "docstring": {"value": "The other objects imported by this object.\n\nKeys are the names within the object (`from ... import ... as AS_NAME`),\nwhile the values are the actual names of the objects (`from ... import REAL_NAME as ...`).", "lineno": 656, "endlineno": 660, "parsed": [{"kind": "text", "value": "The other objects imported by this object.\n\nKeys are the names within the object (`from ... import ... as AS_NAME`),\nwhile the values are the actual names of the objects (`from ... import REAL_NAME as ...`)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.imports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L655-L655", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "exports": {"kind": "attribute", "name": "exports", "runtime": true, "lineno": 662, "endlineno": 662, "docstring": {"value": "The names of the objects exported by this (module) object through the `__all__` variable.\n\nExports can contain string (object names) or resolvable names,\nlike other lists of exports coming from submodules:\n\n```python\nfrom .submodule import __all__ as submodule_all\n\n__all__ = [\"hello\", *submodule_all]\n```\n\nExports get expanded by the loader before it expands wildcards and resolves aliases.\n\nSee also: [`GriffeLoader.expand_exports`][griffe.GriffeLoader.expand_exports].", "lineno": 663, "endlineno": 677, "parsed": [{"kind": "text", "value": "The names of the objects exported by this (module) object through the `__all__` variable.\n\nExports can contain string (object names) or resolvable names,\nlike other lists of exports coming from submodules:\n\n```python\nfrom .submodule import __all__ as submodule_all\n\n__all__ = [\"hello\", *submodule_all]\n```\n\nExports get expanded by the loader before it expands wildcards and resolves aliases.\n\nSee also: [`GriffeLoader.expand_exports`][griffe.GriffeLoader.expand_exports]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.exports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L662-L662", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "aliases": {"kind": "attribute", "name": "aliases", "runtime": true, "lineno": 679, "endlineno": 679, "docstring": {"value": "The aliases pointing to this object.", "lineno": 680, "endlineno": 680, "parsed": [{"kind": "text", "value": "The aliases pointing to this object."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L679-L679", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Alias", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "runtime": {"kind": "attribute", "name": "runtime", "runtime": true, "lineno": 682, "endlineno": 682, "docstring": {"value": "Whether this object is available at runtime.\n\nTypically, type-guarded objects (under an `if TYPE_CHECKING` condition)\nare not available at runtime.", "lineno": 683, "endlineno": 687, "parsed": [{"kind": "text", "value": "Whether this object is available at runtime.\n\nTypically, type-guarded objects (under an `if TYPE_CHECKING` condition)\nare not available at runtime."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.runtime", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L682-L682", "value": {"member": null, "name": "runtime", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "extra": {"kind": "attribute", "name": "extra", "runtime": true, "lineno": 689, "endlineno": 689, "docstring": {"value": "Namespaced dictionaries storing extra metadata for this object, used by extensions.", "lineno": 690, "endlineno": 690, "parsed": [{"kind": "text", "value": "Namespaced dictionaries storing extra metadata for this object, used by extensions."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.extra", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L689-L689", "value": {"arguments": [{"member": null, "name": "dict", "cls": "ExprName"}], "function": {"member": null, "name": "defaultdict", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "public": {"kind": "attribute", "name": "public", "runtime": true, "lineno": 692, "endlineno": 692, "docstring": {"value": "Whether this object is public.", "lineno": 693, "endlineno": 693, "parsed": [{"kind": "text", "value": "Whether this object is public."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.public", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L692-L692", "value": "None", "annotation": {"left": {"member": null, "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "deprecated": {"kind": "attribute", "name": "deprecated", "runtime": true, "lineno": 695, "endlineno": 695, "docstring": {"value": "Whether this object is deprecated (boolean or deprecation message).", "lineno": 696, "endlineno": 696, "parsed": [{"kind": "text", "value": "Whether this object is deprecated (boolean or deprecation message)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.deprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L695-L695", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "bool", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "analysis": {"kind": "attribute", "name": "analysis", "runtime": true, "lineno": 698, "endlineno": 698, "docstring": {"value": "The type of analysis used to load this object.\n\nNone means the object was created manually.", "lineno": 699, "endlineno": 702, "parsed": [{"kind": "text", "value": "The type of analysis used to load this object.\n\nNone means the object was created manually."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object.analysis", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L698-L698", "value": {"member": null, "name": "analysis", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_lines_collection": {"kind": "attribute", "name": "_lines_collection", "runtime": true, "lineno": 704, "endlineno": 704, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object._lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L704-L704", "value": {"member": null, "name": "lines_collection", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_modules_collection": {"kind": "attribute", "name": "_modules_collection", "runtime": true, "lineno": 705, "endlineno": 705, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object._modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L705-L705", "value": {"member": null, "name": "modules_collection", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_git_info": {"kind": "attribute", "name": "_git_info", "runtime": true, "lineno": 706, "endlineno": 706, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object._git_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L706-L706", "value": {"member": null, "name": "git_info", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_source_link": {"kind": "attribute", "name": "_source_link", "runtime": true, "lineno": 707, "endlineno": 707, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Object._source_link", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L707-L707", "value": "None", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 713, "endlineno": 714, "analysis": "static", "path": "griffe._internal.models.Object.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L713-L714", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "__bool__": {"kind": "function", "name": "__bool__", "runtime": true, "lineno": 717, "endlineno": 719, "docstring": {"value": "An object is always true-ish.", "lineno": 718, "endlineno": 718, "parsed": [{"kind": "text", "value": "An object is always true-ish."}]}, "analysis": "static", "path": "griffe._internal.models.Object.__bool__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L717-L719", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__bool__", "name": "bool", "cls": "ExprName"}}, "__len__": {"kind": "function", "name": "__len__", "runtime": true, "lineno": 721, "endlineno": 723, "docstring": {"value": "The number of members in this object, recursively.", "lineno": 722, "endlineno": 722, "parsed": [{"kind": "text", "value": "The number of members in this object, recursively."}]}, "analysis": "static", "path": "griffe._internal.models.Object.__len__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L721-L723", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__len__", "name": "int", "cls": "ExprName"}}, "git_info": {"kind": "attribute", "name": "git_info", "runtime": true, "lineno": 726, "endlineno": 730, "docstring": {"value": "Git information for this object, if available.", "lineno": 727, "endlineno": 727, "parsed": [{"kind": "text", "value": "Git information for this object, if available."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Object.git_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L726-L730", "annotation": {"left": {"member": "git_info", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "source_link": {"kind": "attribute", "name": "source_link", "runtime": true, "lineno": 738, "endlineno": 749, "docstring": {"value": "Source link for this object, if available.", "lineno": 739, "endlineno": 739, "parsed": [{"kind": "text", "value": "Source link for this object, if available."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Object.source_link", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L738-L749", "annotation": {"left": {"member": "source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "has_docstring": {"kind": "attribute", "name": "has_docstring", "runtime": true, "lineno": 757, "endlineno": 763, "docstring": {"value": "Whether this object has a docstring (empty or not).\n\nSee also: [`docstring`][griffe.Object.docstring],\n[`has_docstrings`][griffe.Object.has_docstrings].", "lineno": 758, "endlineno": 762, "parsed": [{"kind": "text", "value": "Whether this object has a docstring (empty or not).\n\nSee also: [`docstring`][griffe.Object.docstring],\n[`has_docstrings`][griffe.Object.has_docstrings]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.has_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L757-L763", "annotation": {"member": "has_docstring", "name": "bool", "cls": "ExprName"}}, "has_docstrings": {"kind": "attribute", "name": "has_docstrings", "runtime": true, "lineno": 774, "endlineno": 791, "docstring": {"value": "Whether this object or any of its members has a docstring (empty or not).\n\nInherited members are not considered. Imported members are not considered,\nunless they are also public.\n\nSee also: [`docstring`][griffe.Object.docstring],\n[`has_docstring`][griffe.Object.has_docstring].", "lineno": 775, "endlineno": 782, "parsed": [{"kind": "text", "value": "Whether this object or any of its members has a docstring (empty or not).\n\nInherited members are not considered. Imported members are not considered,\nunless they are also public.\n\nSee also: [`docstring`][griffe.Object.docstring],\n[`has_docstring`][griffe.Object.has_docstring]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.has_docstrings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L774-L791", "annotation": {"member": "has_docstrings", "name": "bool", "cls": "ExprName"}}, "is_kind": {"kind": "function", "name": "is_kind", "runtime": true, "lineno": 793, "endlineno": 818, "docstring": {"value": "Tell if this object is of the given kind.\n\nSee also: [`is_module`][griffe.Object.is_module],\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias].\n\nParameters:\n    kind: An instance or set of kinds (strings or enumerations).\n\nRaises:\n    ValueError: When an empty set is given as argument.\n\nReturns:\n    True or False.", "lineno": 794, "endlineno": 811, "parsed": [{"kind": "text", "value": "Tell if this object is of the given kind.\n\nSee also: [`is_module`][griffe.Object.is_module],\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias]."}, {"kind": "parameters", "value": [{"name": "kind", "annotation": {"left": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "is_kind", "name": "set", "cls": "ExprName"}, "slice": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "An instance or set of kinds (strings or enumerations)."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When an empty set is given as argument."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "is_kind", "name": "bool", "cls": "ExprName"}, "description": "True or False."}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.is_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L793-L818", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kind", "annotation": {"left": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "is_kind", "name": "set", "cls": "ExprName"}, "slice": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "is_kind", "name": "bool", "cls": "ExprName"}}, "inherited_members": {"kind": "attribute", "name": "inherited_members", "runtime": true, "lineno": 821, "endlineno": 841, "docstring": {"value": "Members that are inherited from base classes.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`members`][griffe.Object.members].", "lineno": 822, "endlineno": 828, "parsed": [{"kind": "text", "value": "Members that are inherited from base classes.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`members`][griffe.Object.members]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.inherited_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L821-L841", "annotation": {"left": {"member": "inherited_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "inherited_members", "name": "str", "cls": "ExprName"}, {"member": "inherited_members", "name": "Alias", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "is_module": {"kind": "attribute", "name": "is_module", "runtime": true, "lineno": 844, "endlineno": 855, "docstring": {"value": "Whether this object is a module.\n\nSee also:  [`is_init_module`][griffe.Object.is_init_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind].", "lineno": 845, "endlineno": 854, "parsed": [{"kind": "text", "value": "Whether this object is a module.\n\nSee also:  [`is_init_module`][griffe.Object.is_init_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L844-L855", "annotation": {"member": "is_module", "name": "bool", "cls": "ExprName"}}, "is_class": {"kind": "attribute", "name": "is_class", "runtime": true, "lineno": 858, "endlineno": 868, "docstring": {"value": "Whether this object is a class.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind].", "lineno": 859, "endlineno": 867, "parsed": [{"kind": "text", "value": "Whether this object is a class.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L858-L868", "annotation": {"member": "is_class", "name": "bool", "cls": "ExprName"}}, "is_function": {"kind": "attribute", "name": "is_function", "runtime": true, "lineno": 871, "endlineno": 881, "docstring": {"value": "Whether this object is a function.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind].", "lineno": 872, "endlineno": 880, "parsed": [{"kind": "text", "value": "Whether this object is a function.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L871-L881", "annotation": {"member": "is_function", "name": "bool", "cls": "ExprName"}}, "is_attribute": {"kind": "attribute", "name": "is_attribute", "runtime": true, "lineno": 884, "endlineno": 894, "docstring": {"value": "Whether this object is an attribute.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind].", "lineno": 885, "endlineno": 893, "parsed": [{"kind": "text", "value": "Whether this object is an attribute.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_type_alias`][griffe.Object.is_type_alias],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L884-L894", "annotation": {"member": "is_attribute", "name": "bool", "cls": "ExprName"}}, "is_type_alias": {"kind": "attribute", "name": "is_type_alias", "runtime": true, "lineno": 897, "endlineno": 907, "docstring": {"value": "Whether this object is a type alias.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind].", "lineno": 898, "endlineno": 906, "parsed": [{"kind": "text", "value": "Whether this object is a type alias.\n\nSee also:  [`is_module`][griffe.Object.is_module].\n[`is_class`][griffe.Object.is_class],\n[`is_function`][griffe.Object.is_function],\n[`is_attribute`][griffe.Object.is_attribute],\n[`is_alias`][griffe.Object.is_alias],\n[`is_kind`][griffe.Object.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L897-L907", "annotation": {"member": "is_type_alias", "name": "bool", "cls": "ExprName"}}, "is_init_method": {"kind": "attribute", "name": "is_init_method", "runtime": true, "lineno": 910, "endlineno": 912, "docstring": {"value": "Whether this function is an `__init__` method.", "lineno": 911, "endlineno": 911, "parsed": [{"kind": "text", "value": "Whether this function is an `__init__` method."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_init_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L910-L912", "annotation": {"member": "is_init_method", "name": "bool", "cls": "ExprName"}}, "is_init_module": {"kind": "attribute", "name": "is_init_module", "runtime": true, "lineno": 915, "endlineno": 920, "docstring": {"value": "Whether this object is an `__init__.py` module.\n\nSee also:  [`is_module`][griffe.Object.is_module].", "lineno": 916, "endlineno": 919, "parsed": [{"kind": "text", "value": "Whether this object is an `__init__.py` module.\n\nSee also:  [`is_module`][griffe.Object.is_module]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_init_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L915-L920", "annotation": {"member": "is_init_module", "name": "bool", "cls": "ExprName"}}, "is_package": {"kind": "attribute", "name": "is_package", "runtime": true, "lineno": 923, "endlineno": 928, "docstring": {"value": "Whether this object is a package (top module).\n\nSee also:  [`is_subpackage`][griffe.Object.is_subpackage].", "lineno": 924, "endlineno": 927, "parsed": [{"kind": "text", "value": "Whether this object is a package (top module).\n\nSee also:  [`is_subpackage`][griffe.Object.is_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L923-L928", "annotation": {"member": "is_package", "name": "bool", "cls": "ExprName"}}, "is_subpackage": {"kind": "attribute", "name": "is_subpackage", "runtime": true, "lineno": 931, "endlineno": 936, "docstring": {"value": "Whether this object is a subpackage.\n\nSee also:  [`is_package`][griffe.Object.is_package].", "lineno": 932, "endlineno": 935, "parsed": [{"kind": "text", "value": "Whether this object is a subpackage.\n\nSee also:  [`is_package`][griffe.Object.is_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L931-L936", "annotation": {"member": "is_subpackage", "name": "bool", "cls": "ExprName"}}, "is_namespace_package": {"kind": "attribute", "name": "is_namespace_package", "runtime": true, "lineno": 939, "endlineno": 944, "docstring": {"value": "Whether this object is a namespace package (top folder, no `__init__.py`).\n\nSee also:  [`is_namespace_subpackage`][griffe.Object.is_namespace_subpackage].", "lineno": 940, "endlineno": 943, "parsed": [{"kind": "text", "value": "Whether this object is a namespace package (top folder, no `__init__.py`).\n\nSee also:  [`is_namespace_subpackage`][griffe.Object.is_namespace_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_namespace_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L939-L944", "annotation": {"member": "is_namespace_package", "name": "bool", "cls": "ExprName"}}, "is_namespace_subpackage": {"kind": "attribute", "name": "is_namespace_subpackage", "runtime": true, "lineno": 947, "endlineno": 952, "docstring": {"value": "Whether this object is a namespace subpackage.\n\nSee also:  [`is_namespace_package`][griffe.Object.is_namespace_package].", "lineno": 948, "endlineno": 951, "parsed": [{"kind": "text", "value": "Whether this object is a namespace subpackage.\n\nSee also:  [`is_namespace_package`][griffe.Object.is_namespace_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.is_namespace_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L947-L952", "annotation": {"member": "is_namespace_subpackage", "name": "bool", "cls": "ExprName"}}, "has_labels": {"kind": "function", "name": "has_labels", "runtime": true, "lineno": 954, "endlineno": 965, "docstring": {"value": "Tell if this object has all the given labels.\n\nSee also: [`labels`][griffe.Object.labels].\n\nParameters:\n    *labels: Labels that must be present.\n\nReturns:\n    True or False.", "lineno": 955, "endlineno": 964, "parsed": [{"kind": "text", "value": "Tell if this object has all the given labels.\n\nSee also: [`labels`][griffe.Object.labels]."}, {"kind": "parameters", "value": [{"name": "*labels", "annotation": {"member": "has_labels", "name": "str", "cls": "ExprName"}, "description": "Labels that must be present.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "has_labels", "name": "bool", "cls": "ExprName"}, "description": "True or False."}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.has_labels", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L954-L965", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "labels", "annotation": {"member": "has_labels", "name": "str", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": {"member": "has_labels", "name": "bool", "cls": "ExprName"}}, "filter_members": {"kind": "function", "name": "filter_members", "runtime": true, "lineno": 967, "endlineno": 983, "docstring": {"value": "Filter and return members based on predicates.\n\nSee also: [`members`][griffe.Object.members].\n\nParameters:\n    *predicates: A list of predicates, i.e. callables accepting a member as argument and returning a boolean.\n\nReturns:\n    A dictionary of members.", "lineno": 968, "endlineno": 977, "parsed": [{"kind": "text", "value": "Filter and return members based on predicates.\n\nSee also: [`members`][griffe.Object.members]."}, {"kind": "parameters", "value": [{"name": "*predicates", "annotation": {"left": {"member": "filter_members", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "cls": "ExprList"}, {"member": "filter_members", "name": "bool", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A list of predicates, i.e. callables accepting a member as argument and returning a boolean.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "filter_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "filter_members", "name": "str", "cls": "ExprName"}, {"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary of members."}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.filter_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L967-L983", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "predicates", "annotation": {"left": {"member": "filter_members", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "cls": "ExprList"}, {"member": "filter_members", "name": "bool", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "variadic positional", "default": "()"}], "returns": {"left": {"member": "filter_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "filter_members", "name": "str", "cls": "ExprName"}, {"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "module": {"kind": "attribute", "name": "module", "runtime": true, "lineno": 986, "endlineno": 1007, "docstring": {"value": "The parent module of this object.\n\nSee also: [`package`][griffe.Object.package].\n\nExamples:\n    >>> import griffe\n    >>> markdown = griffe.load(\"markdown\")\n    >>> markdown[\"core.Markdown.references\"].module\n    Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))\n    >>> # The `module` of a module is itself.\n    >>> markdown[\"core\"].module\n    Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))\n\nRaises:\n    ValueError: When the object is not a module and does not have a parent.", "lineno": 987, "endlineno": 1002, "parsed": [{"kind": "text", "value": "The parent module of this object.\n\nSee also: [`package`][griffe.Object.package]."}, {"kind": "examples", "value": [["examples", ">>> import griffe\n>>> markdown = griffe.load(\"markdown\")\n>>> markdown[\"core.Markdown.references\"].module\nModule(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))\n>>> # The `module` of a module is itself.\n>>> markdown[\"core\"].module\nModule(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/core.py'))"]]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the object is not a module and does not have a parent."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L986-L1007", "annotation": {"member": "module", "name": "Module", "cls": "ExprName"}}, "package": {"kind": "attribute", "name": "package", "runtime": true, "lineno": 1010, "endlineno": 1024, "docstring": {"value": "The absolute top module (the package) of this object.\n\nSee also: [`module`][griffe.Object.module].\n\nExamples:\n    >>> import griffe\n    >>> markdown = griffe.load(\"markdown\")\n    >>> markdown[\"core.Markdown.references\"].package\n    Module(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py'))", "lineno": 1011, "endlineno": 1020, "parsed": [{"kind": "text", "value": "The absolute top module (the package) of this object.\n\nSee also: [`module`][griffe.Object.module]."}, {"kind": "examples", "value": [["examples", ">>> import griffe\n>>> markdown = griffe.load(\"markdown\")\n>>> markdown[\"core.Markdown.references\"].package\nModule(PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py'))"]]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1010-L1024", "annotation": {"member": "package", "name": "Module", "cls": "ExprName"}}, "filepath": {"kind": "attribute", "name": "filepath", "runtime": true, "lineno": 1027, "endlineno": 1039, "docstring": {"value": "The file path (or directory list for namespace packages) where this object was defined.\n\nSee also: [`relative_filepath`][griffe.Object.relative_filepath],\n[`relative_package_filepath`][griffe.Object.relative_package_filepath].\n\nExamples:\n    >>> import griffe\n    >>> markdown = griffe.load(\"markdown\")\n    >>> markdown.filepath\n    PosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py')", "lineno": 1028, "endlineno": 1038, "parsed": [{"kind": "text", "value": "The file path (or directory list for namespace packages) where this object was defined.\n\nSee also: [`relative_filepath`][griffe.Object.relative_filepath],\n[`relative_package_filepath`][griffe.Object.relative_package_filepath]."}, {"kind": "examples", "value": [["examples", ">>> import griffe\n>>> markdown = griffe.load(\"markdown\")\n>>> markdown.filepath\nPosixPath('~/project/.venv/lib/python3.11/site-packages/markdown/__init__.py')"]]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1027-L1039", "annotation": {"left": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "filepath", "name": "list", "cls": "ExprName"}, "slice": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "relative_package_filepath": {"kind": "attribute", "name": "relative_package_filepath", "runtime": true, "lineno": 1042, "endlineno": 1083, "docstring": {"value": "The file path where this object was defined, relative to the top module path.\n\nSee also: [`filepath`][griffe.Object.filepath],\n[`relative_filepath`][griffe.Object.relative_filepath].\n\nRaises:\n    ValueError: When the relative path could not be computed.", "lineno": 1043, "endlineno": 1050, "parsed": [{"kind": "text", "value": "The file path where this object was defined, relative to the top module path.\n\nSee also: [`filepath`][griffe.Object.filepath],\n[`relative_filepath`][griffe.Object.relative_filepath]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the relative path could not be computed."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.relative_package_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1042-L1083", "annotation": {"member": "relative_package_filepath", "name": "Path", "cls": "ExprName"}}, "relative_filepath": {"kind": "attribute", "name": "relative_filepath", "runtime": true, "lineno": 1086, "endlineno": 1106, "docstring": {"value": "The file path where this object was defined, relative to the current working directory.\n\nIf this object's file path is not relative to the current working directory, return its absolute path.\n\nSee also: [`filepath`][griffe.Object.filepath],\n[`relative_package_filepath`][griffe.Object.relative_package_filepath].\n\nRaises:\n    ValueError: When the relative path could not be computed.", "lineno": 1087, "endlineno": 1096, "parsed": [{"kind": "text", "value": "The file path where this object was defined, relative to the current working directory.\n\nIf this object's file path is not relative to the current working directory, return its absolute path.\n\nSee also: [`filepath`][griffe.Object.filepath],\n[`relative_package_filepath`][griffe.Object.relative_package_filepath]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the relative path could not be computed."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.relative_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1086-L1106", "annotation": {"member": "relative_filepath", "name": "Path", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 1109, "endlineno": 1122, "docstring": {"value": "The dotted path of this object.\n\nOn regular objects (not aliases), the path is the canonical path.\n\nSee also: [`canonical_path`][griffe.Object.canonical_path].\n\nExamples:\n    >>> import griffe\n    >>> markdown = griffe.load(\"markdown\")\n    >>> markdown[\"core.Markdown.references\"].path\n    'markdown.core.Markdown.references'", "lineno": 1110, "endlineno": 1121, "parsed": [{"kind": "text", "value": "The dotted path of this object.\n\nOn regular objects (not aliases), the path is the canonical path.\n\nSee also: [`canonical_path`][griffe.Object.canonical_path]."}, {"kind": "examples", "value": [["examples", ">>> import griffe\n>>> markdown = griffe.load(\"markdown\")\n>>> markdown[\"core.Markdown.references\"].path\n'markdown.core.Markdown.references'"]]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1109-L1122", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 1125, "endlineno": 1134, "docstring": {"value": "The full dotted path of this object.\n\nThe canonical path is the path where the object was defined (not imported).\n\nSee also: [`path`][griffe.Object.path].", "lineno": 1126, "endlineno": 1131, "parsed": [{"kind": "text", "value": "The full dotted path of this object.\n\nThe canonical path is the path where the object was defined (not imported).\n\nSee also: [`path`][griffe.Object.path]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1125-L1134", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "modules_collection": {"kind": "attribute", "name": "modules_collection", "runtime": true, "lineno": 1137, "endlineno": 1147, "docstring": {"value": "The modules collection attached to this object or its parents.\n\nRaises:\n    ValueError: When no modules collection can be found in the object or its parents.", "lineno": 1138, "endlineno": 1142, "parsed": [{"kind": "text", "value": "The modules collection attached to this object or its parents."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no modules collection can be found in the object or its parents."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1137-L1147", "annotation": {"member": "modules_collection", "name": "ModulesCollection", "cls": "ExprName"}}, "lines_collection": {"kind": "attribute", "name": "lines_collection", "runtime": true, "lineno": 1150, "endlineno": 1163, "docstring": {"value": "The lines collection attached to this object or its parents.\n\nSee also: [`lines`][griffe.Object.lines],\n[`source`][griffe.Object.source].\n\nRaises:\n    ValueError: When no modules collection can be found in the object or its parents.", "lineno": 1151, "endlineno": 1158, "parsed": [{"kind": "text", "value": "The lines collection attached to this object or its parents.\n\nSee also: [`lines`][griffe.Object.lines],\n[`source`][griffe.Object.source]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no modules collection can be found in the object or its parents."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1150-L1163", "annotation": {"member": "lines_collection", "name": "LinesCollection", "cls": "ExprName"}}, "lines": {"kind": "attribute", "name": "lines", "runtime": true, "lineno": 1166, "endlineno": 1186, "docstring": {"value": "The lines containing the source of this object.\n\nSee also: [`lines_collection`][griffe.Object.lines_collection],\n[`source`][griffe.Object.source].", "lineno": 1167, "endlineno": 1171, "parsed": [{"kind": "text", "value": "The lines containing the source of this object.\n\nSee also: [`lines_collection`][griffe.Object.lines_collection],\n[`source`][griffe.Object.source]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1166-L1186", "annotation": {"left": {"member": "lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "source": {"kind": "attribute", "name": "source", "runtime": true, "lineno": 1189, "endlineno": 1195, "docstring": {"value": "The source code of this object.\n\nSee also: [`lines`][griffe.Object.lines],\n[`lines_collection`][griffe.Object.lines_collection].", "lineno": 1190, "endlineno": 1194, "parsed": [{"kind": "text", "value": "The source code of this object.\n\nSee also: [`lines`][griffe.Object.lines],\n[`lines_collection`][griffe.Object.lines_collection]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Object.source", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1189-L1195", "annotation": {"member": "source", "name": "str", "cls": "ExprName"}}, "resolve": {"kind": "function", "name": "resolve", "runtime": true, "lineno": 1197, "endlineno": 1238, "docstring": {"value": "Resolve a name within this object's and parents' scope.\n\nParameters:\n    name: The name to resolve.\n\nRaises:\n    NameResolutionError: When the name could not be resolved.\n\nReturns:\n    The resolved name.", "lineno": 1198, "endlineno": 1208, "parsed": [{"kind": "text", "value": "Resolve a name within this object's and parents' scope."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The name to resolve."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "NameResolutionError", "cls": "ExprName"}, "description": "When the name could not be resolved."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The resolved name."}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.resolve", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1197-L1238", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "resolve", "name": "str", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 1240, "endlineno": 1324, "docstring": {"value": "Return this object's data as a dictionary.\n\nSee also: [`as_json`][griffe.Object.as_json].\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 1241, "endlineno": 1251, "parsed": [{"kind": "text", "value": "Return this object's data as a dictionary.\n\nSee also: [`as_json`][griffe.Object.as_json]."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Object.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1240-L1324", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Object", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L564-L1324", "bases": [{"member": "Object", "name": "ObjectAliasMixin", "cls": "ExprName"}], "decorators": []}, "Alias": {"kind": "class", "name": "Alias", "runtime": true, "lineno": 1327, "endlineno": 2232, "docstring": {"value": "This class represents an alias, or indirection, to an object declared in another module.\n\nAliases represent objects that are in the scope of a module or class,\nbut were imported from another module.\n\nThey behave almost exactly like regular objects, to a few exceptions:\n\n- line numbers are those of the alias, not the target\n- the path is the alias path, not the canonical one\n- the name can be different from the target's\n- if the target can be resolved, the kind is the target's kind\n- if the target cannot be resolved, the kind becomes [Kind.ALIAS][griffe.Kind]", "lineno": 1328, "endlineno": 1340, "parsed": [{"kind": "text", "value": "This class represents an alias, or indirection, to an object declared in another module.\n\nAliases represent objects that are in the scope of a module or class,\nbut were imported from another module.\n\nThey behave almost exactly like regular objects, to a few exceptions:\n\n- line numbers are those of the alias, not the target\n- the path is the alias path, not the canonical one\n- the name can be different from the target's\n- if the target can be resolved, the kind is the target's kind\n- if the target cannot be resolved, the kind becomes [Kind.ALIAS][griffe.Kind]"}]}, "members": {"is_alias": {"kind": "attribute", "name": "is_alias", "runtime": true, "lineno": 1342, "endlineno": 1342, "docstring": {"value": "Always true for aliases.", "lineno": 1343, "endlineno": 1343, "parsed": [{"kind": "text", "value": "Always true for aliases."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.is_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1342-L1342", "value": "True", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "is_collection": {"kind": "attribute", "name": "is_collection", "runtime": true, "lineno": 1344, "endlineno": 1344, "docstring": {"value": "Always false for aliases.\n\nSee also: [`ModulesCollection`][griffe.ModulesCollection].", "lineno": 1345, "endlineno": 1348, "parsed": [{"kind": "text", "value": "Always false for aliases.\n\nSee also: [`ModulesCollection`][griffe.ModulesCollection]."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.is_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1344-L1344", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 1350, "endlineno": 1420, "docstring": {"value": "Initialize the alias.\n\nParameters:\n    name: The alias name.\n    target: If it's a string, the target resolution is delayed until accessing the target property.\n        If it's an object, or even another alias, the target is immediately set.\n    lineno: The alias starting line number.\n    endlineno: The alias ending line number.\n    runtime: Whether this alias is present at runtime or not.\n    parent: The alias parent.\n    inherited: Whether this alias wraps an inherited member.\n    wildcard_imported: Whether this alias was created using a wildcard import.\n    analysis: The type of analysis used to load this alias.\n        None means the alias was created manually.", "lineno": 1363, "endlineno": 1377, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The alias name."}, {"name": "target", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "If it's a string, the target resolution is delayed until accessing the target property.\nIf it's an object, or even another alias, the target is immediately set."}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The alias starting line number.", "value": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The alias ending line number.", "value": "None"}, {"name": "runtime", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether this alias is present at runtime or not.", "value": "True"}, {"name": "parent", "annotation": {"left": {"left": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The alias parent.", "value": "None"}, {"name": "inherited", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether this alias wraps an inherited member.", "value": "False"}, {"name": "wildcard_imported", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether this alias was created using a wildcard import.", "value": "False"}, {"name": "analysis", "annotation": {"left": {"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type of analysis used to load this alias.\nNone means the alias was created manually.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1350-L1420", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "target", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Object", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "endlineno", "annotation": {"left": {"member": "__init__", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "runtime", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "parent", "annotation": {"left": {"left": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "__init__", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "inherited", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "wildcard_imported", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "analysis", "annotation": {"left": {"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 1378, "endlineno": 1378, "docstring": {"value": "The alias name.", "lineno": 1379, "endlineno": 1379, "parsed": [{"kind": "text", "value": "The alias name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1378-L1378", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "alias_lineno": {"kind": "attribute", "name": "alias_lineno", "runtime": true, "lineno": 1381, "endlineno": 1381, "docstring": {"value": "The starting line number of the alias.", "lineno": 1382, "endlineno": 1382, "parsed": [{"kind": "text", "value": "The starting line number of the alias."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.alias_lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1381-L1381", "value": {"member": null, "name": "lineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "alias_endlineno": {"kind": "attribute", "name": "alias_endlineno", "runtime": true, "lineno": 1384, "endlineno": 1384, "docstring": {"value": "The ending line number of the alias.", "lineno": 1385, "endlineno": 1385, "parsed": [{"kind": "text", "value": "The ending line number of the alias."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.alias_endlineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1384-L1384", "value": {"member": null, "name": "endlineno", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "runtime": {"kind": "attribute", "name": "runtime", "runtime": true, "lineno": 1387, "endlineno": 1387, "docstring": {"value": "Whether this alias is available at runtime.", "lineno": 1388, "endlineno": 1388, "parsed": [{"kind": "text", "value": "Whether this alias is available at runtime."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.runtime", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1387-L1387", "value": {"member": null, "name": "runtime", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "inherited": {"kind": "attribute", "name": "inherited", "runtime": true, "lineno": 1390, "endlineno": 1390, "docstring": {"value": "Whether this alias represents an inherited member.", "lineno": 1391, "endlineno": 1391, "parsed": [{"kind": "text", "value": "Whether this alias represents an inherited member."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.inherited", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1390-L1390", "value": {"member": null, "name": "inherited", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "wildcard_imported": {"kind": "attribute", "name": "wildcard_imported", "runtime": true, "lineno": 1393, "endlineno": 1393, "docstring": {"value": "Whether this alias was created using a wildcard import.", "lineno": 1394, "endlineno": 1394, "parsed": [{"kind": "text", "value": "Whether this alias was created using a wildcard import."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.wildcard_imported", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1393-L1393", "value": {"member": null, "name": "wildcard_imported", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "public": {"kind": "attribute", "name": "public", "runtime": true, "lineno": 1396, "endlineno": 1396, "docstring": {"value": "Whether this alias is public.", "lineno": 1397, "endlineno": 1397, "parsed": [{"kind": "text", "value": "Whether this alias is public."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.public", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1396-L1396", "value": "None", "annotation": {"left": {"member": null, "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "deprecated": {"kind": "attribute", "name": "deprecated", "runtime": true, "lineno": 1399, "endlineno": 1399, "docstring": {"value": "Whether this alias is deprecated (boolean or deprecation message).", "lineno": 1400, "endlineno": 1400, "parsed": [{"kind": "text", "value": "Whether this alias is deprecated (boolean or deprecation message)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.deprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1399-L1399", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "bool", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "analysis": {"kind": "attribute", "name": "analysis", "runtime": true, "lineno": 1402, "endlineno": 1402, "docstring": {"value": "The type of analysis used to load this alias.\n\nNone means the alias was created manually.", "lineno": 1403, "endlineno": 1406, "parsed": [{"kind": "text", "value": "The type of analysis used to load this alias.\n\nNone means the alias was created manually."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.analysis", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1402-L1402", "value": {"member": null, "name": "analysis", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'static'", "'dynamic'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_parent": {"kind": "attribute", "name": "_parent", "runtime": true, "lineno": 1408, "endlineno": 1408, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias._parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1408-L1408", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"left": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_passed_through": {"kind": "attribute", "name": "_passed_through", "runtime": true, "lineno": 1409, "endlineno": 1409, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias._passed_through", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1409-L1409", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "target_path": {"kind": "attribute", "name": "target_path", "runtime": true, "lineno": 1411, "endlineno": 1411, "docstring": {"value": "The path of this alias' target.", "lineno": 1412, "endlineno": 1412, "parsed": [{"kind": "text", "value": "The path of this alias' target."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias.target_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1411-L1411", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "_target": {"kind": "attribute", "name": "_target", "runtime": true, "lineno": 1415, "endlineno": 1415, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Alias._target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1415-L1415", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 1422, "endlineno": 1423, "analysis": "static", "path": "griffe._internal.models.Alias.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1422-L1423", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "__bool__": {"kind": "function", "name": "__bool__", "runtime": true, "lineno": 1426, "endlineno": 1428, "docstring": {"value": "An alias is always true-ish.", "lineno": 1427, "endlineno": 1427, "parsed": [{"kind": "text", "value": "An alias is always true-ish."}]}, "analysis": "static", "path": "griffe._internal.models.Alias.__bool__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1426-L1428", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__bool__", "name": "bool", "cls": "ExprName"}}, "__len__": {"kind": "function", "name": "__len__", "runtime": true, "lineno": 1430, "endlineno": 1432, "docstring": {"value": "The length of an alias is always 1.", "lineno": 1431, "endlineno": 1431, "parsed": [{"kind": "text", "value": "The length of an alias is always 1."}]}, "analysis": "static", "path": "griffe._internal.models.Alias.__len__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1430-L1432", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__len__", "name": "int", "cls": "ExprName"}}, "kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 1439, "endlineno": 1448, "docstring": {"value": "The target's kind, or `Kind.ALIAS` if the target cannot be resolved.\n\nSee also: [`is_kind`][griffe.Alias.is_kind].", "lineno": 1440, "endlineno": 1443, "parsed": [{"kind": "text", "value": "The target's kind, or `Kind.ALIAS` if the target cannot be resolved.\n\nSee also: [`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1439-L1448", "annotation": {"member": "kind", "name": "Kind", "cls": "ExprName"}}, "has_docstring": {"kind": "attribute", "name": "has_docstring", "runtime": true, "lineno": 1451, "endlineno": 1460, "docstring": {"value": "Whether this alias' target has a non-empty docstring.\n\nSee also: [`has_docstrings`][griffe.Alias.has_docstrings],\n[`docstring`][griffe.Alias.docstring].", "lineno": 1452, "endlineno": 1456, "parsed": [{"kind": "text", "value": "Whether this alias' target has a non-empty docstring.\n\nSee also: [`has_docstrings`][griffe.Alias.has_docstrings],\n[`docstring`][griffe.Alias.docstring]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.has_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1451-L1460", "annotation": {"member": "has_docstring", "name": "bool", "cls": "ExprName"}}, "has_docstrings": {"kind": "attribute", "name": "has_docstrings", "runtime": true, "lineno": 1463, "endlineno": 1472, "docstring": {"value": "Whether this alias' target or any of its members has a non-empty docstring.\n\nSee also: [`has_docstring`][griffe.Alias.has_docstring],\n[`docstring`][griffe.Alias.docstring].", "lineno": 1464, "endlineno": 1468, "parsed": [{"kind": "text", "value": "Whether this alias' target or any of its members has a non-empty docstring.\n\nSee also: [`has_docstring`][griffe.Alias.has_docstring],\n[`docstring`][griffe.Alias.docstring]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.has_docstrings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1463-L1472", "annotation": {"member": "has_docstrings", "name": "bool", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 1475, "endlineno": 1477, "docstring": {"value": "The parent of this alias.", "lineno": 1476, "endlineno": 1476, "parsed": [{"kind": "text", "value": "The parent of this alias."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1475-L1477", "annotation": {"left": {"left": {"left": {"member": "parent", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "parent", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "parent", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 1485, "endlineno": 1490, "docstring": {"value": "The dotted path / import path of this object.\n\nSee also: [`canonical_path`][griffe.Alias.canonical_path].", "lineno": 1486, "endlineno": 1489, "parsed": [{"kind": "text", "value": "The dotted path / import path of this object.\n\nSee also: [`canonical_path`][griffe.Alias.canonical_path]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1485-L1490", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "modules_collection": {"kind": "attribute", "name": "modules_collection", "runtime": true, "lineno": 1493, "endlineno": 1496, "docstring": {"value": "The modules collection attached to the alias parents.", "lineno": 1494, "endlineno": 1494, "parsed": [{"kind": "text", "value": "The modules collection attached to the alias parents."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1493-L1496", "annotation": {"member": "modules_collection", "name": "ModulesCollection", "cls": "ExprName"}}, "members": {"kind": "attribute", "name": "members", "runtime": true, "lineno": 1499, "endlineno": 1516, "docstring": {"value": "The target's members (modules, classes, functions, attributes, type aliases).\n\nSee also: [`inherited_members`][griffe.Alias.inherited_members],\n[`get_member`][griffe.Alias.get_member],\n[`set_member`][griffe.Alias.set_member],\n[`filter_members`][griffe.Alias.filter_members].", "lineno": 1500, "endlineno": 1506, "parsed": [{"kind": "text", "value": "The target's members (modules, classes, functions, attributes, type aliases).\n\nSee also: [`inherited_members`][griffe.Alias.inherited_members],\n[`get_member`][griffe.Alias.get_member],\n[`set_member`][griffe.Alias.set_member],\n[`filter_members`][griffe.Alias.filter_members]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1499-L1516", "annotation": {"left": {"member": "members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "members", "name": "str", "cls": "ExprName"}, {"left": {"member": "members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "inherited_members": {"kind": "attribute", "name": "inherited_members", "runtime": true, "lineno": 1519, "endlineno": 1539, "docstring": {"value": "Members that are inherited from base classes.\n\nEach inherited member of the target will be wrapped in an alias,\nto preserve correct object access paths.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`members`][griffe.Alias.members].", "lineno": 1520, "endlineno": 1529, "parsed": [{"kind": "text", "value": "Members that are inherited from base classes.\n\nEach inherited member of the target will be wrapped in an alias,\nto preserve correct object access paths.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`members`][griffe.Alias.members]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.inherited_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1519-L1539", "annotation": {"left": {"member": "inherited_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "inherited_members", "name": "str", "cls": "ExprName"}, {"member": "inherited_members", "name": "Alias", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "as_json": {"kind": "function", "name": "as_json", "runtime": true, "lineno": 1541, "endlineno": 1556, "docstring": {"value": "Return this target's data as a JSON string.\n\nSee also: [`as_dict`][griffe.Alias.as_dict].\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options passed to encoder.\n\nReturns:\n    A JSON string.", "lineno": 1542, "endlineno": 1552, "parsed": [{"kind": "text", "value": "Return this target's data as a JSON string.\n\nSee also: [`as_dict`][griffe.Alias.as_dict]."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_json", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_json", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options passed to encoder.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "as_json", "name": "str", "cls": "ExprName"}, "description": "A JSON string."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.as_json", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1541-L1556", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_json", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_json", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "as_json", "name": "str", "cls": "ExprName"}}, "git_info": {"kind": "attribute", "name": "git_info", "runtime": true, "lineno": 1564, "endlineno": 1566, "docstring": {"value": "Get the Git information for this object, if available.", "lineno": 1565, "endlineno": 1565, "parsed": [{"kind": "text", "value": "Get the Git information for this object, if available."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.git_info", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1564-L1566", "annotation": {"left": {"member": "git_info", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "source_link": {"kind": "attribute", "name": "source_link", "runtime": true, "lineno": 1574, "endlineno": 1576, "docstring": {"value": "Get the source link for this object, if available.", "lineno": 1575, "endlineno": 1575, "parsed": [{"kind": "text", "value": "Get the source link for this object, if available."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.source_link", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1574-L1576", "annotation": {"left": {"member": "source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "extra": {"kind": "attribute", "name": "extra", "runtime": true, "lineno": 1584, "endlineno": 1586, "docstring": {"value": "Namespaced dictionaries storing extra metadata for this object, used by extensions.", "lineno": 1585, "endlineno": 1585, "parsed": [{"kind": "text", "value": "Namespaced dictionaries storing extra metadata for this object, used by extensions."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.extra", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1584-L1586", "annotation": {"member": "extra", "name": "dict", "cls": "ExprName"}}, "lineno": {"kind": "attribute", "name": "lineno", "runtime": true, "lineno": 1589, "endlineno": 1594, "docstring": {"value": "The starting line number of the target object.\n\nSee also: [`endlineno`][griffe.Alias.endlineno].", "lineno": 1590, "endlineno": 1593, "parsed": [{"kind": "text", "value": "The starting line number of the target object.\n\nSee also: [`endlineno`][griffe.Alias.endlineno]."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.lineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1589-L1594", "annotation": {"left": {"member": "lineno", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "endlineno": {"kind": "attribute", "name": "endlineno", "runtime": true, "lineno": 1601, "endlineno": 1606, "docstring": {"value": "The ending line number of the target object.\n\nSee also: [`lineno`][griffe.Alias.lineno].", "lineno": 1602, "endlineno": 1605, "parsed": [{"kind": "text", "value": "The ending line number of the target object.\n\nSee also: [`lineno`][griffe.Alias.lineno]."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.endlineno", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1601-L1606", "annotation": {"left": {"member": "endlineno", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring": {"kind": "attribute", "name": "docstring", "runtime": true, "lineno": 1613, "endlineno": 1619, "docstring": {"value": "The target docstring.\n\nSee also: [`has_docstring`][griffe.Alias.has_docstring],\n[`has_docstrings`][griffe.Alias.has_docstrings].", "lineno": 1614, "endlineno": 1618, "parsed": [{"kind": "text", "value": "The target docstring.\n\nSee also: [`has_docstring`][griffe.Alias.has_docstring],\n[`has_docstrings`][griffe.Alias.has_docstrings]."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1613-L1619", "annotation": {"left": {"member": "docstring", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "type_parameters": {"kind": "attribute", "name": "type_parameters", "runtime": true, "lineno": 1626, "endlineno": 1628, "docstring": {"value": "The target type parameters.", "lineno": 1627, "endlineno": 1627, "parsed": [{"kind": "text", "value": "The target type parameters."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1626-L1628", "annotation": {"member": "type_parameters", "name": "TypeParameters", "cls": "ExprName"}}, "labels": {"kind": "attribute", "name": "labels", "runtime": true, "lineno": 1635, "endlineno": 1640, "docstring": {"value": "The target labels (`property`, `dataclass`, etc.).\n\nSee also: [`has_labels`][griffe.Alias.has_labels].", "lineno": 1636, "endlineno": 1639, "parsed": [{"kind": "text", "value": "The target labels (`property`, `dataclass`, etc.).\n\nSee also: [`has_labels`][griffe.Alias.has_labels]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.labels", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1635-L1640", "annotation": {"left": {"member": "labels", "name": "set", "cls": "ExprName"}, "slice": {"member": "labels", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "imports": {"kind": "attribute", "name": "imports", "runtime": true, "lineno": 1643, "endlineno": 1651, "docstring": {"value": "The other objects imported by this alias' target.\n\nKeys are the names within the object (`from ... import ... as AS_NAME`),\nwhile the values are the actual names of the objects (`from ... import REAL_NAME as ...`).\n\nSee also: [`is_imported`][griffe.Alias.is_imported].", "lineno": 1644, "endlineno": 1650, "parsed": [{"kind": "text", "value": "The other objects imported by this alias' target.\n\nKeys are the names within the object (`from ... import ... as AS_NAME`),\nwhile the values are the actual names of the objects (`from ... import REAL_NAME as ...`).\n\nSee also: [`is_imported`][griffe.Alias.is_imported]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.imports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1643-L1651", "annotation": {"left": {"member": "imports", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "imports", "name": "str", "cls": "ExprName"}, {"member": "imports", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "exports": {"kind": "attribute", "name": "exports", "runtime": true, "lineno": 1654, "endlineno": 1670, "docstring": {"value": "The names of the objects exported by this (module) object through the `__all__` variable.\n\nExports can contain string (object names) or resolvable names,\nlike other lists of exports coming from submodules:\n\n```python\nfrom .submodule import __all__ as submodule_all\n\n__all__ = [\"hello\", *submodule_all]\n```\n\nExports get expanded by the loader before it expands wildcards and resolves aliases.\n\nSee also: [`GriffeLoader.expand_exports`][griffe.GriffeLoader.expand_exports].", "lineno": 1655, "endlineno": 1669, "parsed": [{"kind": "text", "value": "The names of the objects exported by this (module) object through the `__all__` variable.\n\nExports can contain string (object names) or resolvable names,\nlike other lists of exports coming from submodules:\n\n```python\nfrom .submodule import __all__ as submodule_all\n\n__all__ = [\"hello\", *submodule_all]\n```\n\nExports get expanded by the loader before it expands wildcards and resolves aliases.\n\nSee also: [`GriffeLoader.expand_exports`][griffe.GriffeLoader.expand_exports]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.exports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1654-L1670", "annotation": {"left": {"left": {"member": "exports", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "exports", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "exports", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "aliases": {"kind": "attribute", "name": "aliases", "runtime": true, "lineno": 1673, "endlineno": 1675, "docstring": {"value": "The aliases pointing to this object.", "lineno": 1674, "endlineno": 1674, "parsed": [{"kind": "text", "value": "The aliases pointing to this object."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1673-L1675", "annotation": {"left": {"member": "aliases", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "aliases", "name": "str", "cls": "ExprName"}, {"member": "aliases", "name": "Alias", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "is_kind": {"kind": "function", "name": "is_kind", "runtime": true, "lineno": 1677, "endlineno": 1696, "docstring": {"value": "Tell if this object is of the given kind.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias].\n\nParameters:\n    kind: An instance or set of kinds (strings or enumerations).\n\nRaises:\n    ValueError: When an empty set is given as argument.\n\nReturns:\n    True or False.", "lineno": 1678, "endlineno": 1695, "parsed": [{"kind": "text", "value": "Tell if this object is of the given kind.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias]."}, {"kind": "parameters", "value": [{"name": "kind", "annotation": {"left": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "is_kind", "name": "set", "cls": "ExprName"}, "slice": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "An instance or set of kinds (strings or enumerations)."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When an empty set is given as argument."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "is_kind", "name": "bool", "cls": "ExprName"}, "description": "True or False."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.is_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1677-L1696", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kind", "annotation": {"left": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "is_kind", "name": "set", "cls": "ExprName"}, "slice": {"left": {"member": "is_kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "is_kind", "name": "Kind", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "is_kind", "name": "bool", "cls": "ExprName"}}, "is_module": {"kind": "attribute", "name": "is_module", "runtime": true, "lineno": 1699, "endlineno": 1710, "docstring": {"value": "Whether this object is a module.\n\nSee also:  [`is_init_module`][griffe.Alias.is_init_module].\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind].", "lineno": 1700, "endlineno": 1709, "parsed": [{"kind": "text", "value": "Whether this object is a module.\n\nSee also:  [`is_init_module`][griffe.Alias.is_init_module].\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1699-L1710", "annotation": {"member": "is_module", "name": "bool", "cls": "ExprName"}}, "is_class": {"kind": "attribute", "name": "is_class", "runtime": true, "lineno": 1713, "endlineno": 1723, "docstring": {"value": "Whether this object is a class.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind].", "lineno": 1714, "endlineno": 1722, "parsed": [{"kind": "text", "value": "Whether this object is a class.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1713-L1723", "annotation": {"member": "is_class", "name": "bool", "cls": "ExprName"}}, "is_function": {"kind": "attribute", "name": "is_function", "runtime": true, "lineno": 1726, "endlineno": 1736, "docstring": {"value": "Whether this object is a function.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind].", "lineno": 1727, "endlineno": 1735, "parsed": [{"kind": "text", "value": "Whether this object is a function.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1726-L1736", "annotation": {"member": "is_function", "name": "bool", "cls": "ExprName"}}, "is_attribute": {"kind": "attribute", "name": "is_attribute", "runtime": true, "lineno": 1739, "endlineno": 1749, "docstring": {"value": "Whether this object is an attribute.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind].", "lineno": 1740, "endlineno": 1748, "parsed": [{"kind": "text", "value": "Whether this object is an attribute.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_type_alias`][griffe.Alias.is_type_alias],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1739-L1749", "annotation": {"member": "is_attribute", "name": "bool", "cls": "ExprName"}}, "is_type_alias": {"kind": "attribute", "name": "is_type_alias", "runtime": true, "lineno": 1752, "endlineno": 1762, "docstring": {"value": "Whether this object is a type alias.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind].", "lineno": 1753, "endlineno": 1761, "parsed": [{"kind": "text", "value": "Whether this object is a type alias.\n\nSee also: [`is_module`][griffe.Alias.is_module],\n[`is_class`][griffe.Alias.is_class],\n[`is_function`][griffe.Alias.is_function],\n[`is_attribute`][griffe.Alias.is_attribute],\n[`is_alias`][griffe.Alias.is_alias],\n[`is_kind`][griffe.Alias.is_kind]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1752-L1762", "annotation": {"member": "is_type_alias", "name": "bool", "cls": "ExprName"}}, "has_labels": {"kind": "function", "name": "has_labels", "runtime": true, "lineno": 1764, "endlineno": 1775, "docstring": {"value": "Tell if this object has all the given labels.\n\nSee also: [`labels`][griffe.Alias.labels].\n\nParameters:\n    *labels: Labels that must be present.\n\nReturns:\n    True or False.", "lineno": 1765, "endlineno": 1774, "parsed": [{"kind": "text", "value": "Tell if this object has all the given labels.\n\nSee also: [`labels`][griffe.Alias.labels]."}, {"kind": "parameters", "value": [{"name": "*labels", "annotation": {"member": "has_labels", "name": "str", "cls": "ExprName"}, "description": "Labels that must be present.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "has_labels", "name": "bool", "cls": "ExprName"}, "description": "True or False."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.has_labels", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1764-L1775", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "labels", "annotation": {"member": "has_labels", "name": "str", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": {"member": "has_labels", "name": "bool", "cls": "ExprName"}}, "filter_members": {"kind": "function", "name": "filter_members", "runtime": true, "lineno": 1777, "endlineno": 1790, "docstring": {"value": "Filter and return members based on predicates.\n\nSee also: [`members`][griffe.Alias.members],\n[`get_member`][griffe.Alias.get_member],\n[`set_member`][griffe.Alias.set_member].\n\nParameters:\n    *predicates: A list of predicates, i.e. callables accepting a member as argument and returning a boolean.\n\nReturns:\n    A dictionary of members.", "lineno": 1778, "endlineno": 1789, "parsed": [{"kind": "text", "value": "Filter and return members based on predicates.\n\nSee also: [`members`][griffe.Alias.members],\n[`get_member`][griffe.Alias.get_member],\n[`set_member`][griffe.Alias.set_member]."}, {"kind": "parameters", "value": [{"name": "*predicates", "annotation": {"left": {"member": "filter_members", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "cls": "ExprList"}, {"member": "filter_members", "name": "bool", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A list of predicates, i.e. callables accepting a member as argument and returning a boolean.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "filter_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "filter_members", "name": "str", "cls": "ExprName"}, {"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary of members."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.filter_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1777-L1790", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "predicates", "annotation": {"left": {"member": "filter_members", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "cls": "ExprList"}, {"member": "filter_members", "name": "bool", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "variadic positional", "default": "()"}], "returns": {"left": {"member": "filter_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "filter_members", "name": "str", "cls": "ExprName"}, {"left": {"member": "filter_members", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "filter_members", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "module": {"kind": "attribute", "name": "module", "runtime": true, "lineno": 1793, "endlineno": 1801, "docstring": {"value": "The parent module of this object.\n\nSee also: [`package`][griffe.Alias.package].\n\nRaises:\n    ValueError: When the object is not a module and does not have a parent.", "lineno": 1794, "endlineno": 1800, "parsed": [{"kind": "text", "value": "The parent module of this object.\n\nSee also: [`package`][griffe.Alias.package]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the object is not a module and does not have a parent."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1793-L1801", "annotation": {"member": "module", "name": "Module", "cls": "ExprName"}}, "package": {"kind": "attribute", "name": "package", "runtime": true, "lineno": 1804, "endlineno": 1809, "docstring": {"value": "The absolute top module (the package) of this object.\n\nSee also: [`module`][griffe.Alias.module].", "lineno": 1805, "endlineno": 1808, "parsed": [{"kind": "text", "value": "The absolute top module (the package) of this object.\n\nSee also: [`module`][griffe.Alias.module]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1804-L1809", "annotation": {"member": "package", "name": "Module", "cls": "ExprName"}}, "filepath": {"kind": "attribute", "name": "filepath", "runtime": true, "lineno": 1812, "endlineno": 1818, "docstring": {"value": "The file path (or directory list for namespace packages) where this object was defined.\n\nSee also: [`relative_filepath`][griffe.Alias.relative_filepath],\n[`relative_package_filepath`][griffe.Alias.relative_package_filepath].", "lineno": 1813, "endlineno": 1817, "parsed": [{"kind": "text", "value": "The file path (or directory list for namespace packages) where this object was defined.\n\nSee also: [`relative_filepath`][griffe.Alias.relative_filepath],\n[`relative_package_filepath`][griffe.Alias.relative_package_filepath]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1812-L1818", "annotation": {"left": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "filepath", "name": "list", "cls": "ExprName"}, "slice": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "relative_filepath": {"kind": "attribute", "name": "relative_filepath", "runtime": true, "lineno": 1821, "endlineno": 1832, "docstring": {"value": "The file path where this object was defined, relative to the current working directory.\n\nIf this object's file path is not relative to the current working directory, return its absolute path.\n\nSee also: [`filepath`][griffe.Alias.filepath],\n[`relative_package_filepath`][griffe.Alias.relative_package_filepath].\n\nRaises:\n    ValueError: When the relative path could not be computed.", "lineno": 1822, "endlineno": 1831, "parsed": [{"kind": "text", "value": "The file path where this object was defined, relative to the current working directory.\n\nIf this object's file path is not relative to the current working directory, return its absolute path.\n\nSee also: [`filepath`][griffe.Alias.filepath],\n[`relative_package_filepath`][griffe.Alias.relative_package_filepath]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the relative path could not be computed."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.relative_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1821-L1832", "annotation": {"member": "relative_filepath", "name": "Path", "cls": "ExprName"}}, "relative_package_filepath": {"kind": "attribute", "name": "relative_package_filepath", "runtime": true, "lineno": 1835, "endlineno": 1844, "docstring": {"value": "The file path where this object was defined, relative to the top module path.\n\nSee also: [`filepath`][griffe.Alias.filepath],\n[`relative_filepath`][griffe.Alias.relative_filepath].\n\nRaises:\n    ValueError: When the relative path could not be computed.", "lineno": 1836, "endlineno": 1843, "parsed": [{"kind": "text", "value": "The file path where this object was defined, relative to the top module path.\n\nSee also: [`filepath`][griffe.Alias.filepath],\n[`relative_filepath`][griffe.Alias.relative_filepath]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When the relative path could not be computed."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.relative_package_filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1835-L1844", "annotation": {"member": "relative_package_filepath", "name": "Path", "cls": "ExprName"}}, "canonical_path": {"kind": "attribute", "name": "canonical_path", "runtime": true, "lineno": 1847, "endlineno": 1854, "docstring": {"value": "The full dotted path of this object.\n\nThe canonical path is the path where the object was defined (not imported).\n\nSee also: [`path`][griffe.Alias.path].", "lineno": 1848, "endlineno": 1853, "parsed": [{"kind": "text", "value": "The full dotted path of this object.\n\nThe canonical path is the path where the object was defined (not imported).\n\nSee also: [`path`][griffe.Alias.path]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.canonical_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1847-L1854", "annotation": {"member": "canonical_path", "name": "str", "cls": "ExprName"}}, "lines_collection": {"kind": "attribute", "name": "lines_collection", "runtime": true, "lineno": 1857, "endlineno": 1866, "docstring": {"value": "The lines collection attached to this object or its parents.\n\nSee also: [`lines`][griffe.Alias.lines],\n[`source`][griffe.Alias.source].\n\nRaises:\n    ValueError: When no modules collection can be found in the object or its parents.", "lineno": 1858, "endlineno": 1865, "parsed": [{"kind": "text", "value": "The lines collection attached to this object or its parents.\n\nSee also: [`lines`][griffe.Alias.lines],\n[`source`][griffe.Alias.source]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ValueError", "cls": "ExprName"}, "description": "When no modules collection can be found in the object or its parents."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1857-L1866", "annotation": {"member": "lines_collection", "name": "LinesCollection", "cls": "ExprName"}}, "lines": {"kind": "attribute", "name": "lines", "runtime": true, "lineno": 1869, "endlineno": 1875, "docstring": {"value": "The lines containing the source of this object.\n\nSee also: [`source`][griffe.Alias.source],\n[`lines_collection`][griffe.Alias.lines_collection].", "lineno": 1870, "endlineno": 1874, "parsed": [{"kind": "text", "value": "The lines containing the source of this object.\n\nSee also: [`source`][griffe.Alias.source],\n[`lines_collection`][griffe.Alias.lines_collection]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1869-L1875", "annotation": {"left": {"member": "lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "source": {"kind": "attribute", "name": "source", "runtime": true, "lineno": 1878, "endlineno": 1884, "docstring": {"value": "The source code of this object.\n\nSee also: [`lines`][griffe.Alias.lines],\n[`lines_collection`][griffe.Alias.lines_collection].", "lineno": 1879, "endlineno": 1883, "parsed": [{"kind": "text", "value": "The source code of this object.\n\nSee also: [`lines`][griffe.Alias.lines],\n[`lines_collection`][griffe.Alias.lines_collection]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.source", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1878-L1884", "annotation": {"member": "source", "name": "str", "cls": "ExprName"}}, "resolve": {"kind": "function", "name": "resolve", "runtime": true, "lineno": 1886, "endlineno": 1898, "docstring": {"value": "Resolve a name within this object's and parents' scope.\n\nParameters:\n    name: The name to resolve.\n\nRaises:\n    NameResolutionError: When the name could not be resolved.\n\nReturns:\n    The resolved name.", "lineno": 1887, "endlineno": 1897, "parsed": [{"kind": "text", "value": "Resolve a name within this object's and parents' scope."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The name to resolve."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "NameResolutionError", "cls": "ExprName"}, "description": "When the name could not be resolved."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The resolved name."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.resolve", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1886-L1898", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "resolve", "name": "str", "cls": "ExprName"}}, "_filepath": {"kind": "attribute", "name": "_filepath", "runtime": true, "lineno": 1906, "endlineno": 1907, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias._filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1906-L1907", "annotation": {"left": {"left": {"member": "_filepath", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_filepath", "name": "list", "cls": "ExprName"}, "slice": {"member": "_filepath", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "bases": {"kind": "attribute", "name": "bases", "runtime": true, "lineno": 1910, "endlineno": 1917, "docstring": {"value": "The class bases.\n\nSee also: [`Class`][griffe.Class],\n[`resolved_bases`][griffe.Alias.resolved_bases],\n[`mro`][griffe.Alias.mro].", "lineno": 1911, "endlineno": 1916, "parsed": [{"kind": "text", "value": "The class bases.\n\nSee also: [`Class`][griffe.Class],\n[`resolved_bases`][griffe.Alias.resolved_bases],\n[`mro`][griffe.Alias.mro]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.bases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1910-L1917", "annotation": {"left": {"member": "bases", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "bases", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": {"member": "bases", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "keywords": {"kind": "attribute", "name": "keywords", "runtime": true, "lineno": 1920, "endlineno": 1922, "docstring": {"value": "The class keywords.", "lineno": 1921, "endlineno": 1921, "parsed": [{"kind": "text", "value": "The class keywords."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.keywords", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1920-L1922", "annotation": {"left": {"member": "keywords", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "keywords", "name": "str", "cls": "ExprName"}, {"left": {"member": "keywords", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": {"member": "keywords", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "decorators": {"kind": "attribute", "name": "decorators", "runtime": true, "lineno": 1925, "endlineno": 1931, "docstring": {"value": "The class/function decorators.\n\nSee also: [`Function`][griffe.Function],\n[`Class`][griffe.Class].", "lineno": 1926, "endlineno": 1930, "parsed": [{"kind": "text", "value": "The class/function decorators.\n\nSee also: [`Function`][griffe.Function],\n[`Class`][griffe.Class]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1925-L1931", "annotation": {"left": {"member": "decorators", "name": "list", "cls": "ExprName"}, "slice": {"member": "decorators", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "imports_future_annotations": {"kind": "attribute", "name": "imports_future_annotations", "runtime": true, "lineno": 1934, "endlineno": 1936, "docstring": {"value": "Whether this module import future annotations.", "lineno": 1935, "endlineno": 1935, "parsed": [{"kind": "text", "value": "Whether this module import future annotations."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.imports_future_annotations", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1934-L1936", "annotation": {"member": "imports_future_annotations", "name": "bool", "cls": "ExprName"}}, "is_init_method": {"kind": "attribute", "name": "is_init_method", "runtime": true, "lineno": 1939, "endlineno": 1941, "docstring": {"value": "Whether this method is an `__init__` method.", "lineno": 1940, "endlineno": 1940, "parsed": [{"kind": "text", "value": "Whether this method is an `__init__` method."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_init_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1939-L1941", "annotation": {"member": "is_init_method", "name": "bool", "cls": "ExprName"}}, "is_init_module": {"kind": "attribute", "name": "is_init_module", "runtime": true, "lineno": 1944, "endlineno": 1949, "docstring": {"value": "Whether this module is an `__init__.py` module.\n\nSee also: [`is_module`][griffe.Alias.is_module].", "lineno": 1945, "endlineno": 1948, "parsed": [{"kind": "text", "value": "Whether this module is an `__init__.py` module.\n\nSee also: [`is_module`][griffe.Alias.is_module]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_init_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1944-L1949", "annotation": {"member": "is_init_module", "name": "bool", "cls": "ExprName"}}, "is_package": {"kind": "attribute", "name": "is_package", "runtime": true, "lineno": 1952, "endlineno": 1957, "docstring": {"value": "Whether this module is a package (top module).\n\nSee also: [`is_subpackage`][griffe.Alias.is_subpackage].", "lineno": 1953, "endlineno": 1956, "parsed": [{"kind": "text", "value": "Whether this module is a package (top module).\n\nSee also: [`is_subpackage`][griffe.Alias.is_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1952-L1957", "annotation": {"member": "is_package", "name": "bool", "cls": "ExprName"}}, "is_subpackage": {"kind": "attribute", "name": "is_subpackage", "runtime": true, "lineno": 1960, "endlineno": 1965, "docstring": {"value": "Whether this module is a subpackage.\n\nSee also: [`is_package`][griffe.Alias.is_package].", "lineno": 1961, "endlineno": 1964, "parsed": [{"kind": "text", "value": "Whether this module is a subpackage.\n\nSee also: [`is_package`][griffe.Alias.is_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1960-L1965", "annotation": {"member": "is_subpackage", "name": "bool", "cls": "ExprName"}}, "is_namespace_package": {"kind": "attribute", "name": "is_namespace_package", "runtime": true, "lineno": 1968, "endlineno": 1973, "docstring": {"value": "Whether this module is a namespace package (top folder, no `__init__.py`).\n\nSee also: [`is_namespace_subpackage`][griffe.Alias.is_namespace_subpackage].", "lineno": 1969, "endlineno": 1972, "parsed": [{"kind": "text", "value": "Whether this module is a namespace package (top folder, no `__init__.py`).\n\nSee also: [`is_namespace_subpackage`][griffe.Alias.is_namespace_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_namespace_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1968-L1973", "annotation": {"member": "is_namespace_package", "name": "bool", "cls": "ExprName"}}, "is_namespace_subpackage": {"kind": "attribute", "name": "is_namespace_subpackage", "runtime": true, "lineno": 1976, "endlineno": 1981, "docstring": {"value": "Whether this module is a namespace subpackage.\n\nSee also: [`is_namespace_package`][griffe.Alias.is_namespace_package].", "lineno": 1977, "endlineno": 1980, "parsed": [{"kind": "text", "value": "Whether this module is a namespace subpackage.\n\nSee also: [`is_namespace_package`][griffe.Alias.is_namespace_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.is_namespace_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1976-L1981", "annotation": {"member": "is_namespace_subpackage", "name": "bool", "cls": "ExprName"}}, "overloads": {"kind": "attribute", "name": "overloads", "runtime": true, "lineno": 1984, "endlineno": 1986, "docstring": {"value": "The overloaded signatures declared in this class/module or for this function.", "lineno": 1985, "endlineno": 1985, "parsed": [{"kind": "text", "value": "The overloaded signatures declared in this class/module or for this function."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.overloads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1984-L1986", "annotation": {"left": {"left": {"left": {"member": "overloads", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "overloads", "name": "str", "cls": "ExprName"}, {"left": {"member": "overloads", "name": "list", "cls": "ExprName"}, "slice": {"member": "overloads", "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "overloads", "name": "list", "cls": "ExprName"}, "slice": {"member": "overloads", "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 1993, "endlineno": 2000, "docstring": {"value": "The parameters of the current function or `__init__` method for classes.\n\nThis property can fetch inherited members,\nand therefore is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 1994, "endlineno": 1999, "parsed": [{"kind": "text", "value": "The parameters of the current function or `__init__` method for classes.\n\nThis property can fetch inherited members,\nand therefore is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1993-L2000", "annotation": {"member": "parameters", "name": "Parameters", "cls": "ExprName"}}, "returns": {"kind": "attribute", "name": "returns", "runtime": true, "lineno": 2003, "endlineno": 2005, "docstring": {"value": "The function return type annotation.", "lineno": 2004, "endlineno": 2004, "parsed": [{"kind": "text", "value": "The function return type annotation."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.returns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2003-L2005", "annotation": {"left": {"left": {"member": "returns", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "returns", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "setter": {"kind": "attribute", "name": "setter", "runtime": true, "lineno": 2012, "endlineno": 2014, "docstring": {"value": "The setter linked to this function (property).", "lineno": 2013, "endlineno": 2013, "parsed": [{"kind": "text", "value": "The setter linked to this function (property)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.setter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2012-L2014", "annotation": {"left": {"member": "setter", "name": "Function", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "deleter": {"kind": "attribute", "name": "deleter", "runtime": true, "lineno": 2017, "endlineno": 2019, "docstring": {"value": "The deleter linked to this function (property).", "lineno": 2018, "endlineno": 2018, "parsed": [{"kind": "text", "value": "The deleter linked to this function (property)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.deleter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2017-L2019", "annotation": {"left": {"member": "deleter", "name": "Function", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 2022, "endlineno": 2024, "docstring": {"value": "The attribute or type alias value.", "lineno": 2023, "endlineno": 2023, "parsed": [{"kind": "text", "value": "The attribute or type alias value."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2022-L2024", "annotation": {"left": {"left": {"member": "value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "value", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 2031, "endlineno": 2033, "docstring": {"value": "The attribute type annotation.", "lineno": 2032, "endlineno": 2032, "parsed": [{"kind": "text", "value": "The attribute type annotation."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2031-L2033", "annotation": {"left": {"left": {"member": "annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "resolved_bases": {"kind": "attribute", "name": "resolved_bases", "runtime": true, "lineno": 2040, "endlineno": 2046, "docstring": {"value": "Resolved class bases.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 2041, "endlineno": 2045, "parsed": [{"kind": "text", "value": "Resolved class bases.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.resolved_bases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2040-L2046", "annotation": {"left": {"member": "resolved_bases", "name": "list", "cls": "ExprName"}, "slice": {"member": "resolved_bases", "name": "Object", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "mro": {"kind": "function", "name": "mro", "runtime": true, "lineno": 2048, "endlineno": 2050, "docstring": {"value": "Return a list of classes in order corresponding to Python's MRO.", "lineno": 2049, "endlineno": 2049, "parsed": [{"kind": "text", "value": "Return a list of classes in order corresponding to Python's MRO."}]}, "analysis": "static", "path": "griffe._internal.models.Alias.mro", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2048-L2050", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "mro", "name": "list", "cls": "ExprName"}, "slice": {"member": "mro", "name": "Class", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "signature": {"kind": "function", "name": "signature", "runtime": true, "lineno": 2052, "endlineno": 2062, "docstring": {"value": "Construct the class/function signature.\n\nParameters:\n    return_type: Whether to include the return type in the signature.\n    name: The name of the class/function to use in the signature.\n\nReturns:\n    A string representation of the class/function signature.", "lineno": 2053, "endlineno": 2061, "parsed": [{"kind": "text", "value": "Construct the class/function signature."}, {"kind": "parameters", "value": [{"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "description": "Whether to include the return type in the signature.", "value": "False"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The name of the class/function to use in the signature.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "signature", "name": "str", "cls": "ExprName"}, "description": "A string representation of the class/function signature."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.signature", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2052-L2062", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "signature", "name": "str", "cls": "ExprName"}}, "target": {"kind": "attribute", "name": "target", "runtime": true, "lineno": 2069, "endlineno": 2081, "docstring": {"value": "The resolved target (actual object), if possible.\n\nUpon accessing this property, if the target is not already resolved,\na lookup is done using the modules collection to find the target.\n\nSee also: [`final_target`][griffe.Alias.final_target],\n[`resolve_target`][griffe.Alias.resolve_target],\n[`resolved`][griffe.Alias.resolved].", "lineno": 2070, "endlineno": 2078, "parsed": [{"kind": "text", "value": "The resolved target (actual object), if possible.\n\nUpon accessing this property, if the target is not already resolved,\na lookup is done using the modules collection to find the target.\n\nSee also: [`final_target`][griffe.Alias.final_target],\n[`resolve_target`][griffe.Alias.resolve_target],\n[`resolved`][griffe.Alias.resolved]."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.models.Alias.target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2069-L2081", "annotation": {"left": {"member": "target", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "target", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "final_target": {"kind": "attribute", "name": "final_target", "runtime": true, "lineno": 2093, "endlineno": 2116, "docstring": {"value": "The final, resolved target, if possible.\n\nThis will iterate through the targets until a non-alias object is found.\n\nSee also: [`target`][griffe.Alias.target],\n[`resolve_target`][griffe.Alias.resolve_target],\n[`resolved`][griffe.Alias.resolved].", "lineno": 2094, "endlineno": 2101, "parsed": [{"kind": "text", "value": "The final, resolved target, if possible.\n\nThis will iterate through the targets until a non-alias object is found.\n\nSee also: [`target`][griffe.Alias.target],\n[`resolve_target`][griffe.Alias.resolve_target],\n[`resolved`][griffe.Alias.resolved]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.final_target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2093-L2116", "annotation": {"member": "final_target", "name": "Object", "cls": "ExprName"}}, "resolve_target": {"kind": "function", "name": "resolve_target", "runtime": true, "lineno": 2118, "endlineno": 2149, "docstring": {"value": "Resolve the target.\n\nSee also: [`target`][griffe.Alias.target],\n[`final_target`][griffe.Alias.final_target],\n[`resolved`][griffe.Alias.resolved].\n\nRaises:\n    AliasResolutionError: When the target cannot be resolved.\n        It happens when the target does not exist,\n        or could not be loaded (unhandled dynamic object?),\n        or when the target is from a module that was not loaded\n        and added to the collection.\n    CyclicAliasError: When the resolved target is the alias itself.", "lineno": 2119, "endlineno": 2132, "parsed": [{"kind": "text", "value": "Resolve the target.\n\nSee also: [`target`][griffe.Alias.target],\n[`final_target`][griffe.Alias.final_target],\n[`resolved`][griffe.Alias.resolved]."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "AliasResolutionError", "cls": "ExprName"}, "description": "When the target cannot be resolved.\nIt happens when the target does not exist,\nor could not be loaded (unhandled dynamic object?),\nor when the target is from a module that was not loaded\nand added to the collection."}, {"annotation": {"member": null, "name": "CyclicAliasError", "cls": "ExprName"}, "description": "When the resolved target is the alias itself."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.resolve_target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2118-L2149", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_resolve_target": {"kind": "function", "name": "_resolve_target", "runtime": true, "lineno": 2151, "endlineno": 2165, "analysis": "static", "path": "griffe._internal.models.Alias._resolve_target", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2151-L2165", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_update_target_aliases": {"kind": "function", "name": "_update_target_aliases", "runtime": true, "lineno": 2167, "endlineno": 2169, "analysis": "static", "path": "griffe._internal.models.Alias._update_target_aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2167-L2169", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "resolved": {"kind": "attribute", "name": "resolved", "runtime": true, "lineno": 2172, "endlineno": 2174, "docstring": {"value": "Whether this alias' target is resolved.", "lineno": 2173, "endlineno": 2173, "parsed": [{"kind": "text", "value": "Whether this alias' target is resolved."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.resolved", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2172-L2174", "annotation": {"member": "resolved", "name": "bool", "cls": "ExprName"}}, "wildcard": {"kind": "attribute", "name": "wildcard", "runtime": true, "lineno": 2177, "endlineno": 2184, "docstring": {"value": "The module on which the wildcard import is performed (if any).\n\nSee also: [`GriffeLoader.expand_wildcards`][griffe.GriffeLoader.expand_wildcards].", "lineno": 2178, "endlineno": 2181, "parsed": [{"kind": "text", "value": "The module on which the wildcard import is performed (if any).\n\nSee also: [`GriffeLoader.expand_wildcards`][griffe.GriffeLoader.expand_wildcards]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Alias.wildcard", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2177-L2184", "annotation": {"left": {"member": "wildcard", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2186, "endlineno": 2232, "docstring": {"value": "Return this alias' data as a dictionary.\n\nSee also: [`as_json`][griffe.Alias.as_json].\n\nParameters:\n    full: Whether to return full info, or just base info.\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2187, "endlineno": 2197, "parsed": [{"kind": "text", "value": "Return this alias' data as a dictionary.\n\nSee also: [`as_json`][griffe.Alias.as_json]."}, {"kind": "parameters", "value": [{"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "description": "Whether to return full info, or just base info.", "value": "False"}, {"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Alias.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2186-L2232", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "full", "annotation": {"member": "as_dict", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L1327-L2232", "bases": [{"member": "Alias", "name": "ObjectAliasMixin", "cls": "ExprName"}], "decorators": []}, "Module": {"kind": "class", "name": "Module", "runtime": true, "lineno": 2235, "endlineno": 2355, "docstring": {"value": "The class representing a Python module.", "lineno": 2236, "endlineno": 2236, "parsed": [{"kind": "text", "value": "The class representing a Python module."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 2238, "endlineno": 2238, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Module.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2238-L2238", "value": {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "MODULE", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 2240, "endlineno": 2251, "docstring": {"value": "Initialize the module.\n\nParameters:\n    *args: See [`griffe.Object`][].\n    filepath: The module file path (directory for namespace [sub]packages, none for builtin modules).\n    **kwargs: See [`griffe.Object`][].", "lineno": 2241, "endlineno": 2247, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "()"}, {"name": "filepath", "annotation": {"left": {"left": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The module file path (directory for namespace [sub]packages, none for builtin modules).", "value": "None"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.models.Module.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2240-L2251", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "filepath", "annotation": {"left": {"left": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "_filepath": {"kind": "attribute", "name": "_filepath", "runtime": true, "lineno": 2249, "endlineno": 2249, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Module._filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2249-L2249", "value": {"member": null, "name": "filepath", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "overloads": {"kind": "attribute", "name": "overloads", "runtime": true, "lineno": 2250, "endlineno": 2250, "docstring": {"value": "The overloaded signatures declared in this module.", "lineno": 2251, "endlineno": 2251, "parsed": [{"kind": "text", "value": "The overloaded signatures declared in this module."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Module.overloads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2250-L2250", "value": {"arguments": [{"member": null, "name": "list", "cls": "ExprName"}], "function": {"member": null, "name": "defaultdict", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 2253, "endlineno": 2257, "analysis": "static", "path": "griffe._internal.models.Module.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2253-L2257", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "filepath": {"kind": "attribute", "name": "filepath", "runtime": true, "lineno": 2260, "endlineno": 2268, "docstring": {"value": "The file path of this module.\n\nRaises:\n    BuiltinModuleError: When the instance filepath is None.", "lineno": 2261, "endlineno": 2265, "parsed": [{"kind": "text", "value": "The file path of this module."}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "BuiltinModuleError", "cls": "ExprName"}, "description": "When the instance filepath is None."}]}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2260-L2268", "annotation": {"left": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "filepath", "name": "list", "cls": "ExprName"}, "slice": {"member": "filepath", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "imports_future_annotations": {"kind": "attribute", "name": "imports_future_annotations", "runtime": true, "lineno": 2271, "endlineno": 2277, "docstring": {"value": "Whether this module import future annotations.", "lineno": 2272, "endlineno": 2272, "parsed": [{"kind": "text", "value": "Whether this module import future annotations."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.imports_future_annotations", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2271-L2277", "annotation": {"member": "imports_future_annotations", "name": "bool", "cls": "ExprName"}}, "is_init_module": {"kind": "attribute", "name": "is_init_module", "runtime": true, "lineno": 2280, "endlineno": 2290, "docstring": {"value": "Whether this module is an `__init__.py` module.\n\nSee also: [`is_module`][griffe.Module.is_module].", "lineno": 2281, "endlineno": 2284, "parsed": [{"kind": "text", "value": "Whether this module is an `__init__.py` module.\n\nSee also: [`is_module`][griffe.Module.is_module]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.is_init_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2280-L2290", "annotation": {"member": "is_init_module", "name": "bool", "cls": "ExprName"}}, "is_package": {"kind": "attribute", "name": "is_package", "runtime": true, "lineno": 2293, "endlineno": 2298, "docstring": {"value": "Whether this module is a package (top module).\n\nSee also: [`is_subpackage`][griffe.Module.is_subpackage].", "lineno": 2294, "endlineno": 2297, "parsed": [{"kind": "text", "value": "Whether this module is a package (top module).\n\nSee also: [`is_subpackage`][griffe.Module.is_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.is_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2293-L2298", "annotation": {"member": "is_package", "name": "bool", "cls": "ExprName"}}, "is_subpackage": {"kind": "attribute", "name": "is_subpackage", "runtime": true, "lineno": 2301, "endlineno": 2306, "docstring": {"value": "Whether this module is a subpackage.\n\nSee also: [`is_package`][griffe.Module.is_package].", "lineno": 2302, "endlineno": 2305, "parsed": [{"kind": "text", "value": "Whether this module is a subpackage.\n\nSee also: [`is_package`][griffe.Module.is_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.is_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2301-L2306", "annotation": {"member": "is_subpackage", "name": "bool", "cls": "ExprName"}}, "is_namespace_package": {"kind": "attribute", "name": "is_namespace_package", "runtime": true, "lineno": 2309, "endlineno": 2317, "docstring": {"value": "Whether this module is a namespace package (top folder, no `__init__.py`).\n\nSee also: [`is_namespace_subpackage`][griffe.Module.is_namespace_subpackage].", "lineno": 2310, "endlineno": 2313, "parsed": [{"kind": "text", "value": "Whether this module is a namespace package (top folder, no `__init__.py`).\n\nSee also: [`is_namespace_subpackage`][griffe.Module.is_namespace_subpackage]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.is_namespace_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2309-L2317", "annotation": {"member": "is_namespace_package", "name": "bool", "cls": "ExprName"}}, "is_namespace_subpackage": {"kind": "attribute", "name": "is_namespace_subpackage", "runtime": true, "lineno": 2320, "endlineno": 2335, "docstring": {"value": "Whether this module is a namespace subpackage.\n\nSee also: [`is_namespace_package`][griffe.Module.is_namespace_package].", "lineno": 2321, "endlineno": 2324, "parsed": [{"kind": "text", "value": "Whether this module is a namespace subpackage.\n\nSee also: [`is_namespace_package`][griffe.Module.is_namespace_package]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Module.is_namespace_subpackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2320-L2335", "annotation": {"member": "is_namespace_subpackage", "name": "bool", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2337, "endlineno": 2355, "docstring": {"value": "Return this module's data as a dictionary.\n\nSee also: [`as_json`][griffe.Module.as_json].\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2338, "endlineno": 2347, "parsed": [{"kind": "text", "value": "Return this module's data as a dictionary.\n\nSee also: [`as_json`][griffe.Module.as_json]."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Module.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2337-L2355", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2235-L2355", "bases": [{"member": "Module", "name": "Object", "cls": "ExprName"}], "decorators": []}, "Class": {"kind": "class", "name": "Class", "runtime": true, "lineno": 2358, "endlineno": 2484, "docstring": {"value": "The class representing a Python class.", "lineno": 2359, "endlineno": 2359, "parsed": [{"kind": "text", "value": "The class representing a Python class."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 2361, "endlineno": 2361, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Class.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2361-L2361", "value": {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "CLASS", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 2363, "endlineno": 2396, "docstring": {"value": "Initialize the class.\n\nParameters:\n    *args: See [`griffe.Object`][].\n    bases: The list of base classes, if any.\n    decorators: The class decorators, if any.\n    keywords: The class keywords arguments, if any.\n    **kwargs: See [`griffe.Object`][].", "lineno": 2371, "endlineno": 2379, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "()"}, {"name": "bases", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The list of base classes, if any.", "value": "None"}, {"name": "decorators", "annotation": {"left": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The class decorators, if any.", "value": "None"}, {"name": "keywords", "annotation": {"left": {"left": {"member": "__init__", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "__init__", "name": "str", "cls": "ExprName"}, {"member": "__init__", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The class keywords arguments, if any.", "value": "None"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.models.Class.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2363-L2396", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "bases", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "decorators", "annotation": {"left": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "keywords", "annotation": {"left": {"left": {"member": "__init__", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "__init__", "name": "str", "cls": "ExprName"}, {"member": "__init__", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "bases": {"kind": "attribute", "name": "bases", "runtime": true, "lineno": 2382, "endlineno": 2382, "docstring": {"value": "The class bases.\n\nSee also: [`resolved_bases`][griffe.Class.resolved_bases],\n[`mro`][griffe.Class.mro].", "lineno": 2383, "endlineno": 2387, "parsed": [{"kind": "text", "value": "The class bases.\n\nSee also: [`resolved_bases`][griffe.Class.resolved_bases],\n[`mro`][griffe.Class.mro]."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Class.bases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2382-L2382", "value": {"body": {"arguments": [{"member": null, "name": "bases", "cls": "ExprName"}], "function": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprCall"}, "orelse": {"elements": [], "cls": "ExprList"}, "test": {"member": null, "name": "bases", "cls": "ExprName"}, "cls": "ExprIfExp"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "decorators": {"kind": "attribute", "name": "decorators", "runtime": true, "lineno": 2389, "endlineno": 2389, "docstring": {"value": "The class decorators.", "lineno": 2390, "endlineno": 2390, "parsed": [{"kind": "text", "value": "The class decorators."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Class.decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2389-L2389", "value": {"operator": "or", "values": [{"member": null, "name": "decorators", "cls": "ExprName"}, {"elements": [], "cls": "ExprList"}], "cls": "ExprBoolOp"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "keywords": {"kind": "attribute", "name": "keywords", "runtime": true, "lineno": 2392, "endlineno": 2392, "docstring": {"value": "The class keywords arguments.", "lineno": 2393, "endlineno": 2393, "parsed": [{"kind": "text", "value": "The class keywords arguments."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Class.keywords", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2392-L2392", "value": {"operator": "or", "values": [{"member": null, "name": "keywords", "cls": "ExprName"}, {"keys": [], "values": [], "cls": "ExprDict"}], "cls": "ExprBoolOp"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "overloads": {"kind": "attribute", "name": "overloads", "runtime": true, "lineno": 2395, "endlineno": 2395, "docstring": {"value": "The overloaded signatures declared in this class.", "lineno": 2396, "endlineno": 2396, "parsed": [{"kind": "text", "value": "The overloaded signatures declared in this class."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Class.overloads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2395-L2395", "value": {"arguments": [{"member": null, "name": "list", "cls": "ExprName"}], "function": {"member": null, "name": "defaultdict", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 2399, "endlineno": 2409, "docstring": {"value": "The parameters of this class' `__init__` method, if any.\n\nThis property fetches inherited members,\nand therefore is part of the consumer API:\ndo not use when producing Griffe trees!", "lineno": 2400, "endlineno": 2405, "parsed": [{"kind": "text", "value": "The parameters of this class' `__init__` method, if any.\n\nThis property fetches inherited members,\nand therefore is part of the consumer API:\ndo not use when producing Griffe trees!"}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Class.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2399-L2409", "annotation": {"member": "parameters", "name": "Parameters", "cls": "ExprName"}}, "signature": {"kind": "function", "name": "signature", "runtime": true, "lineno": 2411, "endlineno": 2426, "docstring": {"value": "Construct the class signature.\n\nParameters:\n    return_type: Whether to include the return type in the signature.\n    name: The name of the class to use in the signature.\n\nReturns:\n    A string representation of the class signature.", "lineno": 2412, "endlineno": 2420, "parsed": [{"kind": "text", "value": "Construct the class signature."}, {"kind": "parameters", "value": [{"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "description": "Whether to include the return type in the signature.", "value": "False"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The name of the class to use in the signature.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "signature", "name": "str", "cls": "ExprName"}, "description": "A string representation of the class signature."}]}]}, "analysis": "static", "path": "griffe._internal.models.Class.signature", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2411-L2426", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "signature", "name": "str", "cls": "ExprName"}}, "resolved_bases": {"kind": "attribute", "name": "resolved_bases", "runtime": true, "lineno": 2429, "endlineno": 2449, "docstring": {"value": "Resolved class bases.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`bases`][griffe.Class.bases],\n[`mro`][griffe.Class.mro].", "lineno": 2430, "endlineno": 2437, "parsed": [{"kind": "text", "value": "Resolved class bases.\n\nThis method is part of the consumer API:\ndo not use when producing Griffe trees!\n\nSee also: [`bases`][griffe.Class.bases],\n[`mro`][griffe.Class.mro]."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Class.resolved_bases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2429-L2449", "annotation": {"left": {"member": "resolved_bases", "name": "list", "cls": "ExprName"}, "slice": {"member": "resolved_bases", "name": "Object", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_mro": {"kind": "function", "name": "_mro", "runtime": true, "lineno": 2451, "endlineno": 2460, "analysis": "static", "path": "griffe._internal.models.Class._mro", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2451-L2460", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "seen", "annotation": {"left": {"member": "_mro", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_mro", "name": "str", "cls": "ExprName"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"elements": [], "implicit": false, "cls": "ExprTuple"}}], "returns": {"left": {"member": "_mro", "name": "list", "cls": "ExprName"}, "slice": {"member": "_mro", "name": "Class", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "mro": {"kind": "function", "name": "mro", "runtime": true, "lineno": 2462, "endlineno": 2468, "docstring": {"value": "Return a list of classes in order corresponding to Python's MRO.\n\nSee also: [`bases`][griffe.Class.bases],\n[`resolved_bases`][griffe.Class.resolved_bases].", "lineno": 2463, "endlineno": 2467, "parsed": [{"kind": "text", "value": "Return a list of classes in order corresponding to Python's MRO.\n\nSee also: [`bases`][griffe.Class.bases],\n[`resolved_bases`][griffe.Class.resolved_bases]."}]}, "analysis": "static", "path": "griffe._internal.models.Class.mro", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2462-L2468", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "mro", "name": "list", "cls": "ExprName"}, "slice": {"member": "mro", "name": "Class", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2470, "endlineno": 2484, "docstring": {"value": "Return this class' data as a dictionary.\n\nSee also: [`as_json`][griffe.Class.as_json].\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2471, "endlineno": 2480, "parsed": [{"kind": "text", "value": "Return this class' data as a dictionary.\n\nSee also: [`as_json`][griffe.Class.as_json]."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Class.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2470-L2484", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2358-L2484", "bases": [{"member": "Class", "name": "Object", "cls": "ExprName"}], "decorators": []}, "Function": {"kind": "class", "name": "Function", "runtime": true, "lineno": 2487, "endlineno": 2654, "docstring": {"value": "The class representing a Python function.", "lineno": 2488, "endlineno": 2488, "parsed": [{"kind": "text", "value": "The class representing a Python function."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 2490, "endlineno": 2490, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Function.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2490-L2490", "value": {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "FUNCTION", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 2492, "endlineno": 2520, "docstring": {"value": "Initialize the function.\n\nParameters:\n    *args: See [`griffe.Object`][].\n    parameters: The function parameters.\n    returns: The function return annotation.\n    decorators: The function decorators, if any.\n    **kwargs: See [`griffe.Object`][].", "lineno": 2500, "endlineno": 2508, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "()"}, {"name": "parameters", "annotation": {"left": {"member": "__init__", "name": "Parameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The function parameters.", "value": "None"}, {"name": "returns", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The function return annotation.", "value": "None"}, {"name": "decorators", "annotation": {"left": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The function decorators, if any.", "value": "None"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.models.Function.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2492-L2520", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "parameters", "annotation": {"left": {"member": "__init__", "name": "Parameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "returns", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "decorators", "annotation": {"left": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 2510, "endlineno": 2510, "docstring": {"value": "The function parameters.", "lineno": 2511, "endlineno": 2511, "parsed": [{"kind": "text", "value": "The function parameters."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Function.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2510-L2510", "value": {"operator": "or", "values": [{"member": null, "name": "parameters", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "Parameters", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "Parameters", "cls": "ExprName"}}, "returns": {"kind": "attribute", "name": "returns", "runtime": true, "lineno": 2512, "endlineno": 2512, "docstring": {"value": "The function return type annotation.", "lineno": 2513, "endlineno": 2513, "parsed": [{"kind": "text", "value": "The function return type annotation."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Function.returns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2512-L2512", "value": {"member": null, "name": "returns", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "decorators": {"kind": "attribute", "name": "decorators", "runtime": true, "lineno": 2514, "endlineno": 2514, "docstring": {"value": "The function decorators.", "lineno": 2515, "endlineno": 2515, "parsed": [{"kind": "text", "value": "The function decorators."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Function.decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2514-L2514", "value": {"operator": "or", "values": [{"member": null, "name": "decorators", "cls": "ExprName"}, {"elements": [], "cls": "ExprList"}], "cls": "ExprBoolOp"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "overloads": {"kind": "attribute", "name": "overloads", "runtime": true, "lineno": 2516, "endlineno": 2516, "docstring": {"value": "The overloaded signatures of this function.", "lineno": 2517, "endlineno": 2517, "parsed": [{"kind": "text", "value": "The overloaded signatures of this function."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Function.overloads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2516-L2516", "value": "None", "annotation": {"left": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Function", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 2523, "endlineno": 2525, "docstring": {"value": "The type annotation of the returned value.", "lineno": 2524, "endlineno": 2524, "parsed": [{"kind": "text", "value": "The type annotation of the returned value."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Function.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2523-L2525", "annotation": {"left": {"left": {"member": "annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "resolve": {"kind": "function", "name": "resolve", "runtime": true, "lineno": 2527, "endlineno": 2558, "docstring": {"value": "Resolve a name within this object's and parents' scope.\n\nParameters:\n    name: The name to resolve.\n\nRaises:\n    NameResolutionError: When the name could not be resolved.\n\nReturns:\n    The resolved name.", "lineno": 2528, "endlineno": 2538, "parsed": [{"kind": "text", "value": "Resolve a name within this object's and parents' scope."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The name to resolve."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "NameResolutionError", "cls": "ExprName"}, "description": "When the name could not be resolved."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "description": "The resolved name."}]}]}, "analysis": "static", "path": "griffe._internal.models.Function.resolve", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2527-L2558", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "resolve", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "resolve", "name": "str", "cls": "ExprName"}}, "is_init_method": {"kind": "attribute", "name": "is_init_method", "runtime": true, "lineno": 2561, "endlineno": 2563, "docstring": {"value": "Whether this function is an `__init__` method.", "lineno": 2562, "endlineno": 2562, "parsed": [{"kind": "text", "value": "Whether this function is an `__init__` method."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.models.Function.is_init_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2561-L2563", "annotation": {"member": "is_init_method", "name": "bool", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2565, "endlineno": 2580, "docstring": {"value": "Return this function's data as a dictionary.\n\nSee also: [`as_json`][griffe.Function.as_json].\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2566, "endlineno": 2575, "parsed": [{"kind": "text", "value": "Return this function's data as a dictionary.\n\nSee also: [`as_json`][griffe.Function.as_json]."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Function.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2565-L2580", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "signature": {"kind": "function", "name": "signature", "runtime": true, "lineno": 2582, "endlineno": 2654, "docstring": {"value": "Construct the function signature.\n\nParameters:\n    return_type: Whether to include the return type in the signature.\n    name: The name of the function to use in the signature.\n\nReturns:\n    A string representation of the function signature.", "lineno": 2583, "endlineno": 2591, "parsed": [{"kind": "text", "value": "Construct the function signature."}, {"kind": "parameters", "value": [{"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "description": "Whether to include the return type in the signature.", "value": "True"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The name of the function to use in the signature.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "signature", "name": "str", "cls": "ExprName"}, "description": "A string representation of the function signature."}]}]}, "analysis": "static", "path": "griffe._internal.models.Function.signature", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2582-L2654", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "return_type", "annotation": {"member": "signature", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "name", "annotation": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "signature", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.models.Function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2487-L2654", "bases": [{"member": "Function", "name": "Object", "cls": "ExprName"}], "decorators": []}, "Attribute": {"kind": "class", "name": "Attribute", "runtime": true, "lineno": 2657, "endlineno": 2703, "docstring": {"value": "The class representing a Python module/class/instance attribute.", "lineno": 2658, "endlineno": 2658, "parsed": [{"kind": "text", "value": "The class representing a Python module/class/instance attribute."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 2660, "endlineno": 2660, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Attribute.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2660-L2660", "value": {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "ATTRIBUTE", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 2662, "endlineno": 2685, "docstring": {"value": "Initialize the function.\n\nParameters:\n    *args: See [`griffe.Object`][].\n    value: The attribute value, if any.\n    annotation: The attribute annotation, if any.\n    **kwargs: See [`griffe.Object`][].", "lineno": 2669, "endlineno": 2676, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "()"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The attribute value, if any.", "value": "None"}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The attribute annotation, if any.", "value": "None"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.models.Attribute.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2662-L2685", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 2678, "endlineno": 2678, "docstring": {"value": "The attribute value.", "lineno": 2679, "endlineno": 2679, "parsed": [{"kind": "text", "value": "The attribute value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Attribute.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2678-L2678", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 2680, "endlineno": 2680, "docstring": {"value": "The attribute type annotation.", "lineno": 2681, "endlineno": 2681, "parsed": [{"kind": "text", "value": "The attribute type annotation."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Attribute.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2680-L2680", "value": {"member": null, "name": "annotation", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "setter": {"kind": "attribute", "name": "setter", "runtime": true, "lineno": 2682, "endlineno": 2682, "docstring": {"value": "The setter linked to this property.", "lineno": 2683, "endlineno": 2683, "parsed": [{"kind": "text", "value": "The setter linked to this property."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Attribute.setter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2682-L2682", "value": "None", "annotation": {"left": {"member": null, "name": "Function", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "deleter": {"kind": "attribute", "name": "deleter", "runtime": true, "lineno": 2684, "endlineno": 2684, "docstring": {"value": "The deleter linked to this property.", "lineno": 2685, "endlineno": 2685, "parsed": [{"kind": "text", "value": "The deleter linked to this property."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.Attribute.deleter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2684-L2684", "value": "None", "annotation": {"left": {"member": null, "name": "Function", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2687, "endlineno": 2703, "docstring": {"value": "Return this attribute's data as a dictionary.\n\nSee also: [`as_json`][griffe.Attribute.as_json].\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2688, "endlineno": 2697, "parsed": [{"kind": "text", "value": "Return this attribute's data as a dictionary.\n\nSee also: [`as_json`][griffe.Attribute.as_json]."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.Attribute.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2687-L2703", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.Attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2657-L2703", "bases": [{"member": "Attribute", "name": "Object", "cls": "ExprName"}], "decorators": []}, "TypeAlias": {"kind": "class", "name": "TypeAlias", "runtime": true, "lineno": 2706, "endlineno": 2739, "docstring": {"value": "The class representing a Python type alias.", "lineno": 2707, "endlineno": 2707, "parsed": [{"kind": "text", "value": "The class representing a Python type alias."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 2709, "endlineno": 2709, "docstring": {"value": "The object kind.", "lineno": 568, "endlineno": 568, "parsed": [{"kind": "text", "value": "The object kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeAlias.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2709-L2709", "value": {"values": [{"member": null, "name": "Kind", "cls": "ExprName"}, {"member": null, "name": "TYPE_ALIAS", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 2711, "endlineno": 2726, "docstring": {"value": "Initialize the function.\n\nParameters:\n    *args: See [`griffe.Object`][].\n    value: The type alias value.\n    **kwargs: See [`griffe.Object`][].", "lineno": 2717, "endlineno": 2723, "parsed": [{"kind": "parameters", "value": [{"name": "*args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "()"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The type alias value.", "value": "None"}, {"name": "**kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "See [`griffe.Object`][].", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeAlias.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2711-L2726", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "args", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "kwargs", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 2725, "endlineno": 2725, "docstring": {"value": "The type alias value.", "lineno": 2726, "endlineno": 2726, "parsed": [{"kind": "text", "value": "The type alias value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.models.TypeAlias.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2725-L2725", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 2728, "endlineno": 2739, "docstring": {"value": "Return this type alias's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 2729, "endlineno": 2736, "parsed": [{"kind": "text", "value": "Return this type alias's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.models.TypeAlias.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2728-L2739", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.models.TypeAlias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/models.py#L2706-L2739", "bases": [{"member": "TypeAlias", "name": "Object", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.models", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/models.py", "relative_package_filepath": "griffe/_internal/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/models.py"}, "finder": {"kind": "module", "name": "finder", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "os": "os", "re": "re", "sys": "sys", "defaultdict": "collections.defaultdict", "suppress": "contextlib.suppress", "dataclass": "dataclasses.dataclass", "chain": "itertools.chain", "Path": "pathlib.Path", "TYPE_CHECKING": "typing.TYPE_CHECKING", "ClassVar": "typing.ClassVar", "UnhandledEditableModuleError": "griffe._internal.exceptions.UnhandledEditableModuleError", "logger": "griffe._internal.logger.logger", "Iterator": "collections.abc.Iterator", "Sequence": "collections.abc.Sequence", "Pattern": "re.Pattern", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.finder.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.finder.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "os": {"kind": "alias", "name": "os", "target_path": "os", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.finder.os", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.finder.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.finder.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "defaultdict": {"kind": "alias", "name": "defaultdict", "target_path": "collections.defaultdict", "runtime": true, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.finder.defaultdict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 24, "analysis": "static", "path": "griffe._internal.finder.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.finder.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "chain": {"kind": "alias", "name": "chain", "target_path": "itertools.chain", "runtime": true, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.finder.chain", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 27, "analysis": "static", "path": "griffe._internal.finder.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.finder.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ClassVar": {"kind": "alias", "name": "ClassVar", "target_path": "typing.ClassVar", "runtime": true, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.finder.ClassVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "UnhandledEditableModuleError": {"kind": "alias", "name": "UnhandledEditableModuleError", "target_path": "griffe._internal.exceptions.UnhandledEditableModuleError", "runtime": true, "inherited": false, "lineno": 30, "endlineno": 30, "analysis": "static", "path": "griffe._internal.finder.UnhandledEditableModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 31, "endlineno": 31, "analysis": "static", "path": "griffe._internal.finder.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 34, "endlineno": 34, "analysis": "static", "path": "griffe._internal.finder.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 34, "endlineno": 34, "analysis": "static", "path": "griffe._internal.finder.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Pattern": {"kind": "alias", "name": "Pattern", "target_path": "re.Pattern", "runtime": false, "inherited": false, "lineno": 35, "endlineno": 35, "analysis": "static", "path": "griffe._internal.finder.Pattern", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 37, "endlineno": 37, "analysis": "static", "path": "griffe._internal.finder.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_editable_editables_patterns": {"kind": "attribute", "name": "_editable_editables_patterns", "runtime": true, "lineno": 40, "endlineno": 40, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._editable_editables_patterns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L40-L40", "value": {"element": {"arguments": [{"member": null, "name": "pat", "cls": "ExprName"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"elements": ["'^__editables_\\\\w+\\\\.py$'", "'^_editable_impl_\\\\w+\\\\.py$'"], "implicit": false, "cls": "ExprTuple"}, "target": {"member": null, "name": "pat", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprListComp"}}, "_editable_setuptools_patterns": {"kind": "attribute", "name": "_editable_setuptools_patterns", "runtime": true, "lineno": 41, "endlineno": 41, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._editable_setuptools_patterns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L41-L41", "value": {"element": {"arguments": [{"member": null, "name": "pat", "cls": "ExprName"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"elements": ["'^__editable__\\\\w+\\\\.py$'"], "implicit": false, "cls": "ExprTuple"}, "target": {"member": null, "name": "pat", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprListComp"}}, "_editable_scikit_build_core_patterns": {"kind": "attribute", "name": "_editable_scikit_build_core_patterns", "runtime": true, "lineno": 42, "endlineno": 42, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._editable_scikit_build_core_patterns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L42-L42", "value": {"element": {"arguments": [{"member": null, "name": "pat", "cls": "ExprName"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"elements": ["'^_\\\\w+_editable.py$'"], "implicit": false, "cls": "ExprTuple"}, "target": {"member": null, "name": "pat", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprListComp"}}, "_editable_meson_python_patterns": {"kind": "attribute", "name": "_editable_meson_python_patterns", "runtime": true, "lineno": 43, "endlineno": 43, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._editable_meson_python_patterns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L43-L43", "value": {"element": {"arguments": [{"member": null, "name": "pat", "cls": "ExprName"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"elements": ["'^_\\\\w+_editable_loader.py$'"], "implicit": false, "cls": "ExprTuple"}, "target": {"member": null, "name": "pat", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprListComp"}}, "NamePartsType": {"kind": "attribute", "name": "NamePartsType", "runtime": true, "lineno": 45, "endlineno": 45, "docstring": {"value": "Type alias for the parts of a module name.", "lineno": 46, "endlineno": 46, "parsed": [{"kind": "text", "value": "Type alias for the parts of a module name."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder.NamePartsType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L45-L45", "value": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "NamePartsAndPathType": {"kind": "attribute", "name": "NamePartsAndPathType", "runtime": true, "lineno": 47, "endlineno": 47, "docstring": {"value": "Type alias for the parts of a module name and its path.", "lineno": 48, "endlineno": 48, "parsed": [{"kind": "text", "value": "Type alias for the parts of a module name and its path."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder.NamePartsAndPathType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L47-L47", "value": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "NamePartsType", "cls": "ExprName"}, {"member": null, "name": "Path", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_match_pattern": {"kind": "function", "name": "_match_pattern", "runtime": true, "lineno": 51, "endlineno": 52, "analysis": "static", "path": "griffe._internal.finder._match_pattern", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L51-L52", "decorators": [], "parameters": [{"name": "string", "annotation": {"member": "_match_pattern", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "patterns", "annotation": {"left": {"member": "_match_pattern", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "_match_pattern", "name": "Pattern", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_match_pattern", "name": "bool", "cls": "ExprName"}}, "Package": {"kind": "class", "name": "Package", "runtime": true, "lineno": 55, "endlineno": 70, "docstring": {"value": "This class is a simple placeholder used during the process of finding packages.\n\nParameters:\n    name: The package name.\n    path: The package path(s).\n    stubs: An optional path to the related stubs file (.pyi).", "lineno": 57, "endlineno": 63, "parsed": [{"kind": "text", "value": "This class is a simple placeholder used during the process of finding packages."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "description": "The package name."}, {"name": "path", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "description": "The package path(s)."}, {"name": "stubs", "annotation": {"left": {"member": null, "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional path to the related stubs file (.pyi).", "value": "None"}]}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 65, "endlineno": 65, "docstring": {"value": "Package name.", "lineno": 66, "endlineno": 66, "parsed": [{"kind": "text", "value": "Package name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.Package.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L65-L65", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 67, "endlineno": 67, "docstring": {"value": "Package folder path.", "lineno": 68, "endlineno": 68, "parsed": [{"kind": "text", "value": "Package folder path."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.Package.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L67-L67", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "stubs": {"kind": "attribute", "name": "stubs", "runtime": true, "lineno": 69, "endlineno": 69, "docstring": {"value": "Package stubs file.", "lineno": 70, "endlineno": 70, "parsed": [{"kind": "text", "value": "Package stubs file."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.Package.stubs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L69-L69", "value": "None", "annotation": {"left": {"member": null, "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.finder.Package.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Package name.", "lineno": 66, "endlineno": 66, "parsed": [{"kind": "text", "value": "Package name."}]}}, {"name": "path", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Package folder path.", "lineno": 68, "endlineno": 68, "parsed": [{"kind": "text", "value": "Package folder path."}]}}, {"name": "stubs", "annotation": {"left": {"member": null, "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None", "docstring": {"value": "Package stubs file.", "lineno": 70, "endlineno": 70, "parsed": [{"kind": "text", "value": "Package stubs file."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.finder.Package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L55-L70", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 55, "endlineno": 55}]}, "NamespacePackage": {"kind": "class", "name": "NamespacePackage", "runtime": true, "lineno": 73, "endlineno": 85, "docstring": {"value": "This class is a simple placeholder used during the process of finding packages.\n\nParameters:\n    name: The package name.\n    path: The package paths.", "lineno": 75, "endlineno": 80, "parsed": [{"kind": "text", "value": "This class is a simple placeholder used during the process of finding packages."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "description": "The package name."}, {"name": "path", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The package paths."}]}]}, "labels": ["dataclass"], "members": {"name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 82, "endlineno": 82, "docstring": {"value": "Namespace package name.", "lineno": 83, "endlineno": 83, "parsed": [{"kind": "text", "value": "Namespace package name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.NamespacePackage.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L82-L82", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 84, "endlineno": 84, "docstring": {"value": "Namespace package folder paths.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Namespace package folder paths."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.NamespacePackage.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L84-L84", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.finder.NamespacePackage.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Namespace package name.", "lineno": 83, "endlineno": 83, "parsed": [{"kind": "text", "value": "Namespace package name."}]}}, {"name": "path", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "Namespace package folder paths.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Namespace package folder paths."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.finder.NamespacePackage", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L73-L85", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 73, "endlineno": 73}]}, "ModuleFinder": {"kind": "class", "name": "ModuleFinder", "runtime": true, "lineno": 88, "endlineno": 415, "docstring": {"value": "The Griffe finder, allowing to find modules on the file system.\n\nThe module finder is generally not used directly.\nEach [`GriffeLoader`][griffe.GriffeLoader] instance creates its own module finder instance.\nThe finder can be configured when instantiating the loader\nthanks to the [loader][griffe.GriffeLoader]'s `search_paths` parameter.", "lineno": 89, "endlineno": 95, "parsed": [{"kind": "text", "value": "The Griffe finder, allowing to find modules on the file system.\n\nThe module finder is generally not used directly.\nEach [`GriffeLoader`][griffe.GriffeLoader] instance creates its own module finder instance.\nThe finder can be configured when instantiating the loader\nthanks to the [loader][griffe.GriffeLoader]'s `search_paths` parameter."}]}, "members": {"accepted_py_module_extensions": {"kind": "attribute", "name": "accepted_py_module_extensions", "runtime": true, "lineno": 97, "endlineno": 97, "docstring": {"value": "List of extensions supported by the finder.", "lineno": 98, "endlineno": 98, "parsed": [{"kind": "text", "value": "List of extensions supported by the finder."}]}, "labels": ["class-attribute"], "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.accepted_py_module_extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L97-L97", "value": {"elements": ["'.py'", "'.pyc'", "'.pyo'", "'.pyd'", "'.pyi'", "'.so'"], "cls": "ExprList"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "extensions_set": {"kind": "attribute", "name": "extensions_set", "runtime": true, "lineno": 99, "endlineno": 99, "docstring": {"value": "Set of extensions supported by the finder.", "lineno": 100, "endlineno": 100, "parsed": [{"kind": "text", "value": "Set of extensions supported by the finder."}]}, "labels": ["class-attribute"], "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.extensions_set", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L99-L99", "value": {"arguments": [{"member": null, "name": "accepted_py_module_extensions", "cls": "ExprName"}], "function": {"member": null, "name": "set", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "set", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 102, "endlineno": 117, "docstring": {"value": "Initialize the finder.\n\nParameters:\n    search_paths: Optional paths to search into.", "lineno": 103, "endlineno": 107, "parsed": [{"kind": "parameters", "value": [{"name": "search_paths", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Optional paths to search into.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L102-L117", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "_paths_contents": {"kind": "attribute", "name": "_paths_contents", "runtime": true, "lineno": 108, "endlineno": 108, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._paths_contents", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L108-L108", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "Path", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "search_paths": {"kind": "attribute", "name": "search_paths", "runtime": true, "lineno": 109, "endlineno": 109, "docstring": {"value": "The finder search paths.", "lineno": 110, "endlineno": 110, "parsed": [{"kind": "text", "value": "The finder search paths."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.search_paths", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L109-L109", "value": {"elements": [], "cls": "ExprList"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_always_scan_for": {"kind": "attribute", "name": "_always_scan_for", "runtime": true, "lineno": 116, "endlineno": 116, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._always_scan_for", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L116-L116", "value": {"arguments": [{"member": null, "name": "list", "cls": "ExprName"}], "function": {"member": null, "name": "defaultdict", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "append_search_path": {"kind": "function", "name": "append_search_path", "runtime": true, "lineno": 119, "endlineno": 128, "docstring": {"value": "Append a search path.\n\nThe path will be resolved (absolute, normalized).\nThe path won't be appended if it is already in the search paths list.\n\nParameters:\n    path: The path to append.", "lineno": 120, "endlineno": 127, "parsed": [{"kind": "text", "value": "Append a search path.\n\nThe path will be resolved (absolute, normalized).\nThe path won't be appended if it is already in the search paths list."}, {"kind": "parameters", "value": [{"name": "path", "annotation": {"member": "append_search_path", "name": "Path", "cls": "ExprName"}, "description": "The path to append."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.append_search_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L119-L128", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "append_search_path", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_append_search_path": {"kind": "function", "name": "_append_search_path", "runtime": true, "lineno": 130, "endlineno": 132, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._append_search_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L130-L132", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "_append_search_path", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "insert_search_path": {"kind": "function", "name": "insert_search_path", "runtime": true, "lineno": 134, "endlineno": 146, "docstring": {"value": "Insert a search path at the given position.\n\nThe path will be resolved (absolute, normalized).\nThe path won't be inserted if it is already in the search paths list.\n\nParameters:\n    position: The insert position in the list.\n    path: The path to insert.", "lineno": 135, "endlineno": 143, "parsed": [{"kind": "text", "value": "Insert a search path at the given position.\n\nThe path will be resolved (absolute, normalized).\nThe path won't be inserted if it is already in the search paths list."}, {"kind": "parameters", "value": [{"name": "position", "annotation": {"member": "insert_search_path", "name": "int", "cls": "ExprName"}, "description": "The insert position in the list."}, {"name": "path", "annotation": {"member": "insert_search_path", "name": "Path", "cls": "ExprName"}, "description": "The path to insert."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.insert_search_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L134-L146", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "position", "annotation": {"member": "insert_search_path", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "insert_search_path", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "find_spec": {"kind": "function", "name": "find_spec", "runtime": true, "lineno": 148, "endlineno": 229, "docstring": {"value": "Find the top-level parent module of a module.\n\nIf a Path is passed, only try to find the module as a file path.\nIf a string is passed, first try to find the module as a file path,\nthen look into the search paths.\n\nParameters:\n    module: The module name or path.\n    try_relative_path: Whether to try finding the module as a relative path,\n        when the given module is not already a path.\n    find_stubs_package: Whether to search for stubs-only package.\n        If both the package and its stubs are found, they'll be merged together.\n        If only the stubs are found, they'll be used as the package itself.\n\nRaises:\n    FileNotFoundError: When a Path was passed and the module could not be found:\n\n        - the directory has no `__init__.py` file in it\n        - the path does not exist\n\n    ModuleNotFoundError: When a string was passed and the module could not be found:\n\n        - no `module/__init__.py`\n        - no `module.py`\n        - no `module.pth`\n        - no `module` directory (namespace packages)\n        - or unsupported .pth file\n\nReturns:\n    The name of the module, and an instance representing its (namespace) package.", "lineno": 155, "endlineno": 185, "parsed": [{"kind": "text", "value": "Find the top-level parent module of a module.\n\nIf a Path is passed, only try to find the module as a file path.\nIf a string is passed, first try to find the module as a file path,\nthen look into the search paths."}, {"kind": "parameters", "value": [{"name": "module", "annotation": {"left": {"member": "find_spec", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_spec", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The module name or path."}, {"name": "try_relative_path", "annotation": {"member": "find_spec", "name": "bool", "cls": "ExprName"}, "description": "Whether to try finding the module as a relative path,\nwhen the given module is not already a path.", "value": "True"}, {"name": "find_stubs_package", "annotation": {"member": "find_spec", "name": "bool", "cls": "ExprName"}, "description": "Whether to search for stubs-only package.\nIf both the package and its stubs are found, they'll be merged together.\nIf only the stubs are found, they'll be used as the package itself.", "value": "False"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "FileNotFoundError", "cls": "ExprName"}, "description": "When a Path was passed and the module could not be found:\n\n- the directory has no `__init__.py` file in it\n- the path does not exist"}, {"annotation": {"member": null, "name": "ModuleNotFoundError", "cls": "ExprName"}, "description": "When a string was passed and the module could not be found:\n\n- no `module/__init__.py`\n- no `module.py`\n- no `module.pth`\n- no `module` directory (namespace packages)\n- or unsupported .pth file"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "find_spec", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "find_spec", "name": "str", "cls": "ExprName"}, {"left": {"member": "find_spec", "name": "Package", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_spec", "name": "NamespacePackage", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "The name of the module, and an instance representing its (namespace) package."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.find_spec", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L148-L229", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"left": {"member": "find_spec", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_spec", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "try_relative_path", "annotation": {"member": "find_spec", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "find_stubs_package", "annotation": {"member": "find_spec", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "find_spec", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "find_spec", "name": "str", "cls": "ExprName"}, {"left": {"member": "find_spec", "name": "Package", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_spec", "name": "NamespacePackage", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "find_package": {"kind": "function", "name": "find_package", "runtime": true, "lineno": 231, "endlineno": 276, "docstring": {"value": "Find a package or namespace package.\n\nParameters:\n    module_name: The module name.\n\nRaises:\n    ModuleNotFoundError: When the module cannot be found.\n\nReturns:\n    A package or namespace package wrapper.", "lineno": 232, "endlineno": 242, "parsed": [{"kind": "text", "value": "Find a package or namespace package."}, {"kind": "parameters", "value": [{"name": "module_name", "annotation": {"member": "find_package", "name": "str", "cls": "ExprName"}, "description": "The module name."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ModuleNotFoundError", "cls": "ExprName"}, "description": "When the module cannot be found."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "find_package", "name": "Package", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_package", "name": "NamespacePackage", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "A package or namespace package wrapper."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.find_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L231-L276", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "find_package", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "find_package", "name": "Package", "cls": "ExprName"}, "operator": "|", "right": {"member": "find_package", "name": "NamespacePackage", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "iter_submodules": {"kind": "function", "name": "iter_submodules", "runtime": true, "lineno": 278, "endlineno": 342, "docstring": {"value": "Iterate on a module's submodules, if any.\n\nParameters:\n    path: The module path.\n    seen: If not none, this set is used to skip some files.\n        The goal is to replicate the behavior of Python by\n        only using the first packages (with `__init__` modules)\n        of the same name found in different namespace packages.\n        As soon as we find an `__init__` module, we add its parent\n        path to the `seen` set, which will be reused when scanning\n        the next namespace packages.\n\nYields:\n    name_parts (tuple[str, ...]): The parts of a submodule name.\n    filepath (Path): A submodule filepath.", "lineno": 283, "endlineno": 298, "parsed": [{"kind": "text", "value": "Iterate on a module's submodules, if any."}, {"kind": "parameters", "value": [{"name": "path", "annotation": {"left": {"member": "iter_submodules", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "iter_submodules", "name": "list", "cls": "ExprName"}, "slice": {"member": "iter_submodules", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "The module path."}, {"name": "seen", "annotation": {"left": {"member": "iter_submodules", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "If not none, this set is used to skip some files.\nThe goal is to replicate the behavior of Python by\nonly using the first packages (with `__init__` modules)\nof the same name found in different namespace packages.\nAs soon as we find an `__init__` module, we add its parent\npath to the `seen` set, which will be reused when scanning\nthe next namespace packages.", "value": "None"}]}, {"kind": "yields", "value": [{"name": "name_parts", "annotation": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "The parts of a submodule name."}, {"name": "filepath", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "description": "A submodule filepath."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.iter_submodules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L278-L342", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"left": {"member": "iter_submodules", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "iter_submodules", "name": "list", "cls": "ExprName"}, "slice": {"member": "iter_submodules", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "seen", "annotation": {"left": {"member": "iter_submodules", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"left": {"member": "iter_submodules", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "iter_submodules", "name": "NamePartsAndPathType", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "submodules": {"kind": "function", "name": "submodules", "runtime": true, "lineno": 344, "endlineno": 359, "docstring": {"value": "Return the list of a module's submodules.\n\nParameters:\n    module: The parent module.\n\nReturns:\n    A list of tuples containing the parts of the submodule name and its path.", "lineno": 345, "endlineno": 352, "parsed": [{"kind": "text", "value": "Return the list of a module's submodules."}, {"kind": "parameters", "value": [{"name": "module", "annotation": {"member": "submodules", "name": "Module", "cls": "ExprName"}, "description": "The parent module."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "submodules", "name": "list", "cls": "ExprName"}, "slice": {"member": "submodules", "name": "NamePartsAndPathType", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of tuples containing the parts of the submodule name and its path."}]}]}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder.submodules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L344-L359", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "submodules", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "submodules", "name": "list", "cls": "ExprName"}, "slice": {"member": "submodules", "name": "NamePartsAndPathType", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_module_name_path": {"kind": "function", "name": "_module_name_path", "runtime": true, "lineno": 361, "endlineno": 374, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._module_name_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L361-L374", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "_module_name_path", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_module_name_path", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_module_name_path", "name": "str", "cls": "ExprName"}, {"member": "_module_name_path", "name": "Path", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_contents": {"kind": "function", "name": "_contents", "runtime": true, "lineno": 376, "endlineno": 382, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._contents", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L376-L382", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "_contents", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_contents", "name": "list", "cls": "ExprName"}, "slice": {"member": "_contents", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_extend_from_pth_files": {"kind": "function", "name": "_extend_from_pth_files", "runtime": true, "lineno": 384, "endlineno": 391, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._extend_from_pth_files", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L384-L391", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_filter_py_modules": {"kind": "function", "name": "_filter_py_modules", "runtime": true, "lineno": 393, "endlineno": 399, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._filter_py_modules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L393-L399", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "_filter_py_modules", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_filter_py_modules", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_filter_py_modules", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_top_module_name": {"kind": "function", "name": "_top_module_name", "runtime": true, "lineno": 401, "endlineno": 415, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder._top_module_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L401-L415", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": "_top_module_name", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_top_module_name", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.finder.ModuleFinder", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L88-L415", "bases": [], "decorators": []}, "_re_pkgresources": {"kind": "attribute", "name": "_re_pkgresources", "runtime": true, "lineno": 418, "endlineno": 418, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._re_pkgresources", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L418-L418", "value": {"arguments": ["'(?:__import__\\\\([\\\\\"\\']pkg_resources[\\\\\"\\']\\\\).declare_namespace\\\\(__name__\\\\))'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}}, "_re_pkgutil": {"kind": "attribute", "name": "_re_pkgutil", "runtime": true, "lineno": 419, "endlineno": 419, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._re_pkgutil", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L419-L419", "value": {"arguments": ["'(?:__path__ = __import__\\\\([\\\\\"\\']pkgutil[\\\\\"\\']\\\\).extend_path\\\\(__path__, __name__\\\\))'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}}, "_re_import_line": {"kind": "attribute", "name": "_re_import_line", "runtime": true, "lineno": 420, "endlineno": 420, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.finder._re_import_line", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L420-L420", "value": {"arguments": ["'^import[ \\\\t]+\\\\w+$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}}, "_is_pkg_style_namespace": {"kind": "function", "name": "_is_pkg_style_namespace", "runtime": true, "lineno": 425, "endlineno": 427, "analysis": "static", "path": "griffe._internal.finder._is_pkg_style_namespace", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L425-L427", "decorators": [], "parameters": [{"name": "init_module", "annotation": {"member": "_is_pkg_style_namespace", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_is_pkg_style_namespace", "name": "bool", "cls": "ExprName"}}, "_module_depth": {"kind": "function", "name": "_module_depth", "runtime": true, "lineno": 430, "endlineno": 431, "analysis": "static", "path": "griffe._internal.finder._module_depth", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L430-L431", "decorators": [], "parameters": [{"name": "name_parts_and_path", "annotation": {"member": "_module_depth", "name": "NamePartsAndPathType", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_module_depth", "name": "int", "cls": "ExprName"}}, "_SP": {"kind": "class", "name": "_SP", "runtime": true, "lineno": 434, "endlineno": 437, "labels": ["dataclass"], "members": {"path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 436, "endlineno": 436, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.finder._SP.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L436-L436", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "always_scan_for": {"kind": "attribute", "name": "always_scan_for", "runtime": true, "lineno": 437, "endlineno": 437, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.finder._SP.always_scan_for", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L437-L437", "value": "''", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.finder._SP.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "path", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "always_scan_for", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "''"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.finder._SP", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L434-L437", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 434, "endlineno": 434}]}, "_handle_pth_file": {"kind": "function", "name": "_handle_pth_file", "runtime": true, "lineno": 440, "endlineno": 467, "analysis": "static", "path": "griffe._internal.finder._handle_pth_file", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L440-L467", "decorators": [], "parameters": [{"name": "path", "annotation": {"member": "_handle_pth_file", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_handle_pth_file", "name": "list", "cls": "ExprName"}, "slice": {"member": "_handle_pth_file", "name": "_SP", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_handle_editable_module": {"kind": "function", "name": "_handle_editable_module", "runtime": true, "lineno": 470, "endlineno": 515, "analysis": "static", "path": "griffe._internal.finder._handle_editable_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/finder.py#L470-L515", "decorators": [], "parameters": [{"name": "path", "annotation": {"member": "_handle_editable_module", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_handle_editable_module", "name": "list", "cls": "ExprName"}, "slice": {"member": "_handle_editable_module", "name": "_SP", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.finder", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/finder.py", "relative_package_filepath": "griffe/_internal/finder.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/finder.py"}, "git": {"kind": "module", "name": "git", "runtime": true, "imports": {"annotations": "__future__.annotations", "os": "os", "re": "re", "shutil": "shutil", "subprocess": "subprocess", "unicodedata": "unicodedata", "contextmanager": "contextlib.contextmanager", "dataclass": "dataclasses.dataclass", "Path": "pathlib.Path", "TemporaryDirectory": "tempfile.TemporaryDirectory", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Literal": "typing.Literal", "urlsplit": "urllib.parse.urlsplit", "urlunsplit": "urllib.parse.urlunsplit", "BuiltinModuleError": "griffe._internal.exceptions.BuiltinModuleError", "GitError": "griffe._internal.exceptions.GitError", "Iterator": "collections.abc.Iterator", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.git.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "os": {"kind": "alias", "name": "os", "target_path": "os", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.git.os", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.git.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "shutil": {"kind": "alias", "name": "shutil", "target_path": "shutil", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.git.shutil", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "subprocess": {"kind": "alias", "name": "subprocess", "target_path": "subprocess", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.git.subprocess", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "unicodedata": {"kind": "alias", "name": "unicodedata", "target_path": "unicodedata", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.git.unicodedata", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "contextmanager": {"kind": "alias", "name": "contextmanager", "target_path": "contextlib.contextmanager", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.git.contextmanager", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.git.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.git.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TemporaryDirectory": {"kind": "alias", "name": "TemporaryDirectory", "target_path": "tempfile.TemporaryDirectory", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.git.TemporaryDirectory", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.git.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.git.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "urlsplit": {"kind": "alias", "name": "urlsplit", "target_path": "urllib.parse.urlsplit", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.git.urlsplit", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "urlunsplit": {"kind": "alias", "name": "urlunsplit", "target_path": "urllib.parse.urlunsplit", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.git.urlunsplit", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "BuiltinModuleError": {"kind": "alias", "name": "BuiltinModuleError", "target_path": "griffe._internal.exceptions.BuiltinModuleError", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.git.BuiltinModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GitError": {"kind": "alias", "name": "GitError", "target_path": "griffe._internal.exceptions.GitError", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.git.GitError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.git.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 24, "endlineno": 24, "analysis": "static", "path": "griffe._internal.git.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_WORKTREE_PREFIX": {"kind": "attribute", "name": "_WORKTREE_PREFIX", "runtime": true, "lineno": 27, "endlineno": 27, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.git._WORKTREE_PREFIX", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L27-L27", "value": "'griffe-worktree-'"}, "_normalize": {"kind": "function", "name": "_normalize", "runtime": true, "lineno": 30, "endlineno": 33, "analysis": "static", "path": "griffe._internal.git._normalize", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L30-L33", "decorators": [], "parameters": [{"name": "value", "annotation": {"member": "_normalize", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_normalize", "name": "str", "cls": "ExprName"}}, "_git": {"kind": "function", "name": "_git", "runtime": true, "lineno": 36, "endlineno": 47, "analysis": "static", "path": "griffe._internal.git._git", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L36-L47", "decorators": [], "parameters": [{"name": "args", "annotation": {"member": "_git", "name": "str", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}, {"name": "check", "annotation": {"member": "_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_git", "name": "str", "cls": "ExprName"}}, "_assert_git_repo": {"kind": "function", "name": "_assert_git_repo", "runtime": true, "lineno": 50, "endlineno": 64, "docstring": {"value": "Deprecated. Assert that a directory is a Git repository.\n\nParameters:\n    path: Path to a directory.\n\nRaises:\n    OSError: When the directory is not a Git repository.", "lineno": 51, "endlineno": 58, "parsed": [{"kind": "text", "value": "Deprecated. Assert that a directory is a Git repository."}, {"kind": "parameters", "value": [{"name": "path", "annotation": {"left": {"member": "_assert_git_repo", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_assert_git_repo", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Path to a directory."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "OSError", "cls": "ExprName"}, "description": "When the directory is not a Git repository."}]}]}, "analysis": "static", "path": "griffe._internal.git._assert_git_repo", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L50-L64", "decorators": [], "parameters": [{"name": "path", "annotation": {"left": {"member": "_assert_git_repo", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_assert_git_repo", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_get_latest_tag": {"kind": "function", "name": "_get_latest_tag", "runtime": true, "lineno": 67, "endlineno": 84, "docstring": {"value": "Deprecated. Get latest tag of a Git repository.\n\nParameters:\n    repo: The path to Git repository.\n\nReturns:\n    The latest tag.", "lineno": 68, "endlineno": 75, "parsed": [{"kind": "text", "value": "Deprecated. Get latest tag of a Git repository."}, {"kind": "parameters", "value": [{"name": "repo", "annotation": {"left": {"member": "_get_latest_tag", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_latest_tag", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The path to Git repository."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "_get_latest_tag", "name": "str", "cls": "ExprName"}, "description": "The latest tag."}]}]}, "analysis": "static", "path": "griffe._internal.git._get_latest_tag", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L67-L84", "decorators": [], "parameters": [{"name": "repo", "annotation": {"left": {"member": "_get_latest_tag", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_latest_tag", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_latest_tag", "name": "str", "cls": "ExprName"}}, "_get_repo_root": {"kind": "function", "name": "_get_repo_root", "runtime": true, "lineno": 87, "endlineno": 100, "docstring": {"value": "Deprecated. Get the root of a Git repository.\n\nParameters:\n    repo: The path to a Git repository.\n\nReturns:\n    The root of the repository.", "lineno": 88, "endlineno": 95, "parsed": [{"kind": "text", "value": "Deprecated. Get the root of a Git repository."}, {"kind": "parameters", "value": [{"name": "repo", "annotation": {"left": {"member": "_get_repo_root", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_repo_root", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The path to a Git repository."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "_get_repo_root", "name": "Path", "cls": "ExprName"}, "description": "The root of the repository."}]}]}, "analysis": "static", "path": "griffe._internal.git._get_repo_root", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L87-L100", "decorators": [], "parameters": [{"name": "repo", "annotation": {"left": {"member": "_get_repo_root", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_repo_root", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_repo_root", "name": "Path", "cls": "ExprName"}}, "_tmp_worktree": {"kind": "function", "name": "_tmp_worktree", "runtime": true, "lineno": 103, "endlineno": 134, "docstring": {"value": "Deprecated. Context manager that checks out the given reference in the given repository to a temporary worktree.\n\nParameters:\n    repo: Path to the repository (i.e. the directory *containing* the `.git` directory)\n    ref: A Git reference such as a commit, tag or branch.\n\nYields:\n    The path to the temporary worktree.\n\nRaises:\n    OSError: If `repo` is not a valid `.git` repository\n    RuntimeError: If the `git` executable is unavailable, or if it cannot create a worktree", "lineno": 105, "endlineno": 117, "parsed": [{"kind": "text", "value": "Deprecated. Context manager that checks out the given reference in the given repository to a temporary worktree."}, {"kind": "parameters", "value": [{"name": "repo", "annotation": {"left": {"member": "_tmp_worktree", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_tmp_worktree", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Path to the repository (i.e. the directory *containing* the `.git` directory)", "value": "'.'"}, {"name": "ref", "annotation": {"member": "_tmp_worktree", "name": "str", "cls": "ExprName"}, "description": "A Git reference such as a commit, tag or branch.", "value": "'HEAD'"}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "_tmp_worktree", "name": "Path", "cls": "ExprName"}, "description": "The path to the temporary worktree."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "OSError", "cls": "ExprName"}, "description": "If `repo` is not a valid `.git` repository"}, {"annotation": {"member": null, "name": "RuntimeError", "cls": "ExprName"}, "description": "If the `git` executable is unavailable, or if it cannot create a worktree"}]}]}, "analysis": "static", "path": "griffe._internal.git._tmp_worktree", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L103-L134", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 103, "endlineno": 103}], "parameters": [{"name": "repo", "annotation": {"left": {"member": "_tmp_worktree", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_tmp_worktree", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "'.'"}, {"name": "ref", "annotation": {"member": "_tmp_worktree", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "'HEAD'"}], "returns": {"left": {"member": "_tmp_worktree", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_tmp_worktree", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_get_git_remote_url": {"kind": "function", "name": "_get_git_remote_url", "runtime": true, "lineno": 137, "endlineno": 154, "analysis": "static", "path": "griffe._internal.git._get_git_remote_url", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L137-L154", "decorators": [], "parameters": [{"name": "repo", "annotation": {"left": {"member": "_get_git_remote_url", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_git_remote_url", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "'.'"}], "returns": {"member": "_get_git_remote_url", "name": "str", "cls": "ExprName"}}, "KnownGitService": {"kind": "attribute", "name": "KnownGitService", "runtime": true, "lineno": 157, "endlineno": 157, "docstring": {"value": "Known Git hosting services.", "lineno": 158, "endlineno": 158, "parsed": [{"kind": "text", "value": "Known Git hosting services."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.git.KnownGitService", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L157-L157", "value": {"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'github'", "'gitlab'", "'sourcehut'", "'gitea'", "'gogs'", "'forgejo'", "'codeberg'", "'radicle'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_service_re": {"kind": "attribute", "name": "_service_re", "runtime": true, "lineno": 160, "endlineno": 160, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.git._service_re", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L160-L160", "value": {"arguments": [{"values": ["(", {"value": {"arguments": [{"values": [{"member": null, "name": "KnownGitService", "cls": "ExprName"}, {"member": null, "name": "__args__", "cls": "ExprName"}], "cls": "ExprAttribute"}], "function": {"values": ["'|'", {"member": null, "name": "join", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "cls": "ExprFormatted"}, ")"], "cls": "ExprJoinedStr"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}}, "_get_git_known_service": {"kind": "function", "name": "_get_git_known_service", "runtime": true, "lineno": 163, "endlineno": 170, "analysis": "static", "path": "griffe._internal.git._get_git_known_service", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L163-L170", "decorators": [], "parameters": [{"name": "git_remote_url", "annotation": {"member": "_get_git_known_service", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_git_known_service", "name": "KnownGitService", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_RADICLE_URL": {"kind": "attribute", "name": "_RADICLE_URL", "runtime": true, "lineno": 181, "endlineno": 181, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.git._RADICLE_URL", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L181-L181", "value": "'https://app.radicle.at/nodes/seed.radicle.at'"}, "_get_radicle_url": {"kind": "function", "name": "_get_radicle_url", "runtime": true, "lineno": 184, "endlineno": 187, "analysis": "static", "path": "griffe._internal.git._get_radicle_url", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L184-L187", "decorators": [], "parameters": [{"name": "url_or_rid", "annotation": {"member": "_get_radicle_url", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "commit_hash", "annotation": {"member": "_get_radicle_url", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"member": "_get_radicle_url", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"member": "_get_radicle_url", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "endlineno", "annotation": {"member": "_get_radicle_url", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_radicle_url", "name": "str", "cls": "ExprName"}}, "_service_to_url": {"kind": "attribute", "name": "_service_to_url", "runtime": true, "lineno": 190, "endlineno": 201, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.git._service_to_url", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L190-L201", "value": {"keys": ["'github'", "'gitlab'", "'sourcehut'", "'gogs'", "'gitea'", "'codeberg'", "'forgejo'", "'radicle'"], "values": [{"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/blob/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/-/blob/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/tree/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/blob/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/src/commit/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/src/commit/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"body": {"values": [{"value": {"member": null, "name": "url", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/src/commit/", {"value": {"member": null, "name": "ch", "cls": "ExprName"}, "cls": "ExprFormatted"}, "/", {"value": {"member": null, "name": "fp", "cls": "ExprName"}, "cls": "ExprFormatted"}, "#L", {"value": {"member": null, "name": "ln", "cls": "ExprName"}, "cls": "ExprFormatted"}, "-L", {"value": {"member": null, "name": "eln", "cls": "ExprName"}, "cls": "ExprFormatted"}], "cls": "ExprJoinedStr"}, "parameters": [{"annotation": null, "default": null, "kind": "positional or keyword", "name": "url", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ch", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "fp", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "ln", "cls": "ExprParameter"}, {"annotation": null, "default": null, "kind": "positional or keyword", "name": "eln", "cls": "ExprParameter"}], "cls": "ExprLambda"}, {"member": null, "name": "_get_radicle_url", "cls": "ExprName"}], "cls": "ExprDict"}}, "_get_source_link": {"kind": "function", "name": "_get_source_link", "runtime": true, "lineno": 204, "endlineno": 214, "analysis": "static", "path": "griffe._internal.git._get_source_link", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L204-L214", "decorators": [], "parameters": [{"name": "service", "annotation": {"member": "_get_source_link", "name": "KnownGitService", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "remote_url", "annotation": {"member": "_get_source_link", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "commit_hash", "annotation": {"member": "_get_source_link", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"member": "_get_source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_source_link", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"member": "_get_source_link", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "endlineno", "annotation": {"member": "_get_source_link", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_get_git_commit_hash": {"kind": "function", "name": "_get_git_commit_hash", "runtime": true, "lineno": 217, "endlineno": 220, "analysis": "static", "path": "griffe._internal.git._get_git_commit_hash", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L217-L220", "decorators": [], "parameters": [{"name": "repo", "annotation": {"left": {"member": "_get_git_commit_hash", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_get_git_commit_hash", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "'.'"}], "returns": {"member": "_get_git_commit_hash", "name": "str", "cls": "ExprName"}}, "_is_tracked": {"kind": "function", "name": "_is_tracked", "runtime": true, "lineno": 223, "endlineno": 224, "analysis": "static", "path": "griffe._internal.git._is_tracked", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L223-L224", "decorators": [], "parameters": [{"name": "filepath", "annotation": {"left": {"member": "_is_tracked", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_is_tracked", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "repo", "annotation": {"left": {"member": "_is_tracked", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_is_tracked", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "'.'"}], "returns": {"member": "_is_tracked", "name": "bool", "cls": "ExprName"}}, "GitInfo": {"kind": "class", "name": "GitInfo", "runtime": true, "lineno": 227, "endlineno": 271, "docstring": {"value": "Information about a Git repository.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "Information about a Git repository."}]}, "labels": ["dataclass"], "members": {"repository": {"kind": "attribute", "name": "repository", "runtime": true, "lineno": 231, "endlineno": 231, "docstring": {"value": "The path to the Git repository.", "lineno": 232, "endlineno": 232, "parsed": [{"kind": "text", "value": "The path to the Git repository."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.git.GitInfo.repository", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L231-L231", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "service": {"kind": "attribute", "name": "service", "runtime": true, "lineno": 233, "endlineno": 233, "docstring": {"value": "The Git hosting service (used to build the right URLs).", "lineno": 234, "endlineno": 234, "parsed": [{"kind": "text", "value": "The Git hosting service (used to build the right URLs)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.git.GitInfo.service", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L233-L233", "annotation": {"member": null, "name": "KnownGitService", "cls": "ExprName"}}, "remote_url": {"kind": "attribute", "name": "remote_url", "runtime": true, "lineno": 235, "endlineno": 235, "docstring": {"value": "The remote URL of the Git repository.", "lineno": 236, "endlineno": 236, "parsed": [{"kind": "text", "value": "The remote URL of the Git repository."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.git.GitInfo.remote_url", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L235-L235", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "commit_hash": {"kind": "attribute", "name": "commit_hash", "runtime": true, "lineno": 237, "endlineno": 237, "docstring": {"value": "A commit hash (usually the current checked-out one).", "lineno": 238, "endlineno": 238, "parsed": [{"kind": "text", "value": "A commit hash (usually the current checked-out one)."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.git.GitInfo.commit_hash", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L237-L237", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "from_package": {"kind": "function", "name": "from_package", "runtime": true, "lineno": 240, "endlineno": 263, "docstring": {"value": "Create a GitInfo instance from a Griffe package.\n\nReturns:\n    The GitInfo instance, or None if unknown.", "lineno": 242, "endlineno": 246, "parsed": [{"kind": "text", "value": "Create a GitInfo instance from a Griffe package."}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "from_package", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The GitInfo instance, or None if unknown."}]}]}, "labels": ["classmethod"], "analysis": "static", "path": "griffe._internal.git.GitInfo.from_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L240-L263", "decorators": [{"value": {"member": null, "name": "classmethod", "cls": "ExprName"}, "lineno": 240, "endlineno": 240}], "parameters": [{"name": "cls", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "package", "annotation": {"member": "from_package", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "from_package", "name": "GitInfo", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "get_source_link": {"kind": "function", "name": "get_source_link", "runtime": true, "lineno": 265, "endlineno": 271, "docstring": {"value": "Get the source link for the file at the given line numbers.\n\nReturns:\n    The source link, or None if unknown.", "lineno": 266, "endlineno": 270, "parsed": [{"kind": "text", "value": "Get the source link for the file at the given line numbers."}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The source link, or None if unknown."}]}]}, "analysis": "static", "path": "griffe._internal.git.GitInfo.get_source_link", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L265-L271", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"member": "get_source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "get_source_link", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "lineno", "annotation": {"member": "get_source_link", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "endlineno", "annotation": {"member": "get_source_link", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get_source_link", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.git.GitInfo.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "repository", "annotation": {"member": null, "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The path to the Git repository.", "lineno": 232, "endlineno": 232, "parsed": [{"kind": "text", "value": "The path to the Git repository."}]}}, {"name": "service", "annotation": {"member": null, "name": "KnownGitService", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The Git hosting service (used to build the right URLs).", "lineno": 234, "endlineno": 234, "parsed": [{"kind": "text", "value": "The Git hosting service (used to build the right URLs)."}]}}, {"name": "remote_url", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "The remote URL of the Git repository.", "lineno": 236, "endlineno": 236, "parsed": [{"kind": "text", "value": "The remote URL of the Git repository."}]}}, {"name": "commit_hash", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null, "docstring": {"value": "A commit hash (usually the current checked-out one).", "lineno": 238, "endlineno": 238, "parsed": [{"kind": "text", "value": "A commit hash (usually the current checked-out one)."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.git.GitInfo", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/git.py#L227-L271", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 227, "endlineno": 227}]}}, "analysis": "static", "path": "griffe._internal.git", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/git.py", "relative_package_filepath": "griffe/_internal/git.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/git.py"}, "collections": {"kind": "module", "name": "collections", "runtime": true, "imports": {"annotations": "__future__.annotations", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "DelMembersMixin": "griffe._internal.mixins.DelMembersMixin", "GetMembersMixin": "griffe._internal.mixins.GetMembersMixin", "SetMembersMixin": "griffe._internal.mixins.SetMembersMixin", "ItemsView": "collections.abc.ItemsView", "KeysView": "collections.abc.KeysView", "ValuesView": "collections.abc.ValuesView", "Path": "pathlib.Path", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.collections.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.collections.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.collections.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DelMembersMixin": {"kind": "alias", "name": "DelMembersMixin", "target_path": "griffe._internal.mixins.DelMembersMixin", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.collections.DelMembersMixin", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GetMembersMixin": {"kind": "alias", "name": "GetMembersMixin", "target_path": "griffe._internal.mixins.GetMembersMixin", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.collections.GetMembersMixin", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "SetMembersMixin": {"kind": "alias", "name": "SetMembersMixin", "target_path": "griffe._internal.mixins.SetMembersMixin", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.collections.SetMembersMixin", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ItemsView": {"kind": "alias", "name": "ItemsView", "target_path": "collections.abc.ItemsView", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.collections.ItemsView", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "KeysView": {"kind": "alias", "name": "KeysView", "target_path": "collections.abc.KeysView", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.collections.KeysView", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ValuesView": {"kind": "alias", "name": "ValuesView", "target_path": "collections.abc.ValuesView", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.collections.ValuesView", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.collections.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.collections.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "LinesCollection": {"kind": "class", "name": "LinesCollection", "runtime": true, "lineno": 17, "endlineno": 62, "docstring": {"value": "A simple dictionary containing the modules source code lines.", "lineno": 18, "endlineno": 18, "parsed": [{"kind": "text", "value": "A simple dictionary containing the modules source code lines."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 20, "endlineno": 22, "docstring": {"value": "Initialize the collection.", "lineno": 21, "endlineno": 21, "parsed": [{"kind": "text", "value": "Initialize the collection."}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L20-L22", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_data": {"kind": "attribute", "name": "_data", "runtime": true, "lineno": 22, "endlineno": 22, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.collections.LinesCollection._data", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L22-L22", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "Path", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "__getitem__": {"kind": "function", "name": "__getitem__", "runtime": true, "lineno": 24, "endlineno": 26, "docstring": {"value": "Get the lines of a file path.", "lineno": 25, "endlineno": 25, "parsed": [{"kind": "text", "value": "Get the lines of a file path."}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.__getitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L24-L26", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"member": "__getitem__", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "__getitem__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__getitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__setitem__": {"kind": "function", "name": "__setitem__", "runtime": true, "lineno": 28, "endlineno": 30, "docstring": {"value": "Set the lines of a file path.", "lineno": 29, "endlineno": 29, "parsed": [{"kind": "text", "value": "Set the lines of a file path."}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.__setitem__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L28-L30", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "key", "annotation": {"member": "__setitem__", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__setitem__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__setitem__", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "__contains__": {"kind": "function", "name": "__contains__", "runtime": true, "lineno": 32, "endlineno": 34, "docstring": {"value": "Check if a file path is in the collection.", "lineno": 33, "endlineno": 33, "parsed": [{"kind": "text", "value": "Check if a file path is in the collection."}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.__contains__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L32-L34", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "item", "annotation": {"member": "__contains__", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__contains__", "name": "bool", "cls": "ExprName"}}, "__bool__": {"kind": "function", "name": "__bool__", "runtime": true, "lineno": 36, "endlineno": 38, "docstring": {"value": "A lines collection is always true-ish.", "lineno": 37, "endlineno": 37, "parsed": [{"kind": "text", "value": "A lines collection is always true-ish."}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.__bool__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L36-L38", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__bool__", "name": "bool", "cls": "ExprName"}}, "keys": {"kind": "function", "name": "keys", "runtime": true, "lineno": 40, "endlineno": 46, "docstring": {"value": "Return the collection keys.\n\nReturns:\n    The collection keys.", "lineno": 41, "endlineno": 45, "parsed": [{"kind": "text", "value": "Return the collection keys."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "keys", "name": "KeysView", "cls": "ExprName"}, "description": "The collection keys."}]}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.keys", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L40-L46", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "keys", "name": "KeysView", "cls": "ExprName"}}, "values": {"kind": "function", "name": "values", "runtime": true, "lineno": 48, "endlineno": 54, "docstring": {"value": "Return the collection values.\n\nReturns:\n    The collection values.", "lineno": 49, "endlineno": 53, "parsed": [{"kind": "text", "value": "Return the collection values."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "values", "name": "ValuesView", "cls": "ExprName"}, "description": "The collection values."}]}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L48-L54", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "values", "name": "ValuesView", "cls": "ExprName"}}, "items": {"kind": "function", "name": "items", "runtime": true, "lineno": 56, "endlineno": 62, "docstring": {"value": "Return the collection items.\n\nReturns:\n    The collection items.", "lineno": 57, "endlineno": 61, "parsed": [{"kind": "text", "value": "Return the collection items."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "items", "name": "ItemsView", "cls": "ExprName"}, "description": "The collection items."}]}]}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection.items", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L56-L62", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "items", "name": "ItemsView", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.collections.LinesCollection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L17-L62", "bases": [], "decorators": []}, "ModulesCollection": {"kind": "class", "name": "ModulesCollection", "runtime": true, "lineno": 65, "endlineno": 91, "docstring": {"value": "A collection of modules, allowing easy access to members.", "lineno": 66, "endlineno": 66, "parsed": [{"kind": "text", "value": "A collection of modules, allowing easy access to members."}]}, "members": {"is_collection": {"kind": "attribute", "name": "is_collection", "runtime": true, "lineno": 68, "endlineno": 68, "docstring": {"value": "Marked as collection to distinguish from objects.", "lineno": 69, "endlineno": 69, "parsed": [{"kind": "text", "value": "Marked as collection to distinguish from objects."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.is_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L68-L68", "value": "True"}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 71, "endlineno": 74, "docstring": {"value": "Initialize the collection.", "lineno": 72, "endlineno": 72, "parsed": [{"kind": "text", "value": "Initialize the collection."}]}, "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L71-L74", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": "None"}, "members": {"kind": "attribute", "name": "members", "runtime": true, "lineno": 73, "endlineno": 73, "docstring": {"value": "Members (modules) of the collection.", "lineno": 74, "endlineno": 74, "parsed": [{"kind": "text", "value": "Members (modules) of the collection."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L73-L73", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Module", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "__bool__": {"kind": "function", "name": "__bool__", "runtime": true, "lineno": 76, "endlineno": 78, "docstring": {"value": "A modules collection is always true-ish.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "A modules collection is always true-ish."}]}, "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.__bool__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L76-L78", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__bool__", "name": "bool", "cls": "ExprName"}}, "__contains__": {"kind": "function", "name": "__contains__", "runtime": true, "lineno": 80, "endlineno": 82, "docstring": {"value": "Check if a module is in the collection.", "lineno": 81, "endlineno": 81, "parsed": [{"kind": "text", "value": "Check if a module is in the collection."}]}, "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.__contains__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L80-L82", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "item", "annotation": {"member": "__contains__", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__contains__", "name": "bool", "cls": "ExprName"}}, "all_members": {"kind": "attribute", "name": "all_members", "runtime": true, "lineno": 85, "endlineno": 91, "docstring": {"value": "Members of the collection.\n\nThis property is overwritten to simply return `self.members`,\nas `all_members` does not make sense for a modules collection.", "lineno": 86, "endlineno": 90, "parsed": [{"kind": "text", "value": "Members of the collection.\n\nThis property is overwritten to simply return `self.members`,\nas `all_members` does not make sense for a modules collection."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.collections.ModulesCollection.all_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L85-L91", "annotation": {"left": {"member": "all_members", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "all_members", "name": "str", "cls": "ExprName"}, {"member": "all_members", "name": "Module", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.collections.ModulesCollection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/collections.py#L65-L91", "bases": [{"member": "ModulesCollection", "name": "GetMembersMixin", "cls": "ExprName"}, {"member": "ModulesCollection", "name": "SetMembersMixin", "cls": "ExprName"}, {"member": "ModulesCollection", "name": "DelMembersMixin", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.collections", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/collections.py", "relative_package_filepath": "griffe/_internal/collections.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/collections.py"}, "importer": {"kind": "module", "name": "importer", "runtime": true, "imports": {"annotations": "__future__.annotations", "sys": "sys", "contextmanager": "contextlib.contextmanager", "import_module": "importlib.import_module", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "Iterator": "collections.abc.Iterator", "Sequence": "collections.abc.Sequence", "Path": "pathlib.Path"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.importer.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.importer.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "contextmanager": {"kind": "alias", "name": "contextmanager", "target_path": "contextlib.contextmanager", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.importer.contextmanager", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "import_module": {"kind": "alias", "name": "import_module", "target_path": "importlib.import_module", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.importer.import_module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.importer.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.importer.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.importer.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.importer.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.importer.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_error_details": {"kind": "function", "name": "_error_details", "runtime": true, "lineno": 17, "endlineno": 18, "analysis": "static", "path": "griffe._internal.importer._error_details", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/importer.py", "relative_package_filepath": "griffe/_internal/importer.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/importer.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/importer.py#L17-L18", "decorators": [], "parameters": [{"name": "error", "annotation": {"member": "_error_details", "name": "BaseException", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "objpath", "annotation": {"member": "_error_details", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_error_details", "name": "str", "cls": "ExprName"}}, "sys_path": {"kind": "function", "name": "sys_path", "runtime": true, "lineno": 21, "endlineno": 40, "docstring": {"value": "Redefine `sys.path` temporarily.\n\nParameters:\n    *paths: The paths to use when importing modules.\n        If no paths are given, keep `sys.path` untouched.\n\nYields:\n    Nothing.", "lineno": 23, "endlineno": 31, "parsed": [{"kind": "text", "value": "Redefine `sys.path` temporarily."}, {"kind": "parameters", "value": [{"name": "*paths", "annotation": {"left": {"member": "sys_path", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "sys_path", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The paths to use when importing modules.\nIf no paths are given, keep `sys.path` untouched.", "value": "()"}]}, {"kind": "yields", "value": [{"name": "", "annotation": "None", "description": "Nothing."}]}]}, "analysis": "static", "path": "griffe._internal.importer.sys_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/importer.py", "relative_package_filepath": "griffe/_internal/importer.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/importer.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/importer.py#L21-L40", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 21, "endlineno": 21}], "parameters": [{"name": "paths", "annotation": {"left": {"member": "sys_path", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "sys_path", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "variadic positional", "default": "()"}], "returns": {"left": {"member": "sys_path", "name": "Iterator", "cls": "ExprName"}, "slice": "None", "cls": "ExprSubscript"}}, "dynamic_import": {"kind": "function", "name": "dynamic_import", "runtime": true, "lineno": 43, "endlineno": 123, "docstring": {"value": "Dynamically import the specified object.\n\nIt can be a module, class, method, function, attribute, type alias,\nnested arbitrarily.\n\nIt works like this:\n\n- for a given object path `a.b.x.y`\n- it tries to import `a.b.x.y` as a module (with `importlib.import_module`)\n- if it fails, it tries again with `a.b.x`, storing `y`\n- then `a.b`, storing `x.y`\n- then `a`, storing `b.x.y`\n- if nothing worked, it raises an error\n- if one of the iteration worked, it moves on, and...\n- it tries to get the remaining (stored) parts with `getattr`\n- for example it gets `b` from `a`, then `x` from `b`, etc.\n- if a single attribute access fails, it raises an error\n- if everything worked, it returns the last obtained attribute\n\nSince the function potentially tries multiple things before succeeding,\nall errors happening along the way are recorded, and re-emitted with\nan `ImportError` when it fails, to let users know what was tried.\n\nIMPORTANT: The paths given through the `import_paths` parameter are used\nto temporarily patch `sys.path`: this function is therefore not thread-safe.\n\nIMPORTANT: The paths given as `import_paths` must be *correct*.\nThe contents of `sys.path` must be consistent to what a user of the imported code\nwould expect. Given a set of paths, if the import fails for a user, it will fail here too,\nwith potentially unintuitive errors. If we wanted to make this function more robust,\nwe could add a loop to \"roll the window\" of given paths, shifting them to the left\n(for example: `(\"/a/a\", \"/a/b\", \"/a/c/\")`, then `(\"/a/b\", \"/a/c\", \"/a/a/\")`,\nthen `(\"/a/c\", \"/a/a\", \"/a/b/\")`), to make sure each entry is given highest priority\nat least once, maintaining relative order, but we deem this unnecessary for now.\n\nParameters:\n    import_path: The path of the object to import.\n    import_paths: The (sys) paths to import the object from.\n\nRaises:\n    ModuleNotFoundError: When the object's module could not be found.\n    ImportError: When there was an import error or when couldn't get the attribute.\n\nReturns:\n    The imported object.", "lineno": 44, "endlineno": 89, "parsed": [{"kind": "text", "value": "Dynamically import the specified object.\n\nIt can be a module, class, method, function, attribute, type alias,\nnested arbitrarily.\n\nIt works like this:\n\n- for a given object path `a.b.x.y`\n- it tries to import `a.b.x.y` as a module (with `importlib.import_module`)\n- if it fails, it tries again with `a.b.x`, storing `y`\n- then `a.b`, storing `x.y`\n- then `a`, storing `b.x.y`\n- if nothing worked, it raises an error\n- if one of the iteration worked, it moves on, and...\n- it tries to get the remaining (stored) parts with `getattr`\n- for example it gets `b` from `a`, then `x` from `b`, etc.\n- if a single attribute access fails, it raises an error\n- if everything worked, it returns the last obtained attribute\n\nSince the function potentially tries multiple things before succeeding,\nall errors happening along the way are recorded, and re-emitted with\nan `ImportError` when it fails, to let users know what was tried.\n\nIMPORTANT: The paths given through the `import_paths` parameter are used\nto temporarily patch `sys.path`: this function is therefore not thread-safe.\n\nIMPORTANT: The paths given as `import_paths` must be *correct*.\nThe contents of `sys.path` must be consistent to what a user of the imported code\nwould expect. Given a set of paths, if the import fails for a user, it will fail here too,\nwith potentially unintuitive errors. If we wanted to make this function more robust,\nwe could add a loop to \"roll the window\" of given paths, shifting them to the left\n(for example: `(\"/a/a\", \"/a/b\", \"/a/c/\")`, then `(\"/a/b\", \"/a/c\", \"/a/a/\")`,\nthen `(\"/a/c\", \"/a/a\", \"/a/b/\")`), to make sure each entry is given highest priority\nat least once, maintaining relative order, but we deem this unnecessary for now."}, {"kind": "parameters", "value": [{"name": "import_path", "annotation": {"member": "dynamic_import", "name": "str", "cls": "ExprName"}, "description": "The path of the object to import."}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "dynamic_import", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "dynamic_import", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "dynamic_import", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The (sys) paths to import the object from.", "value": "None"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ModuleNotFoundError", "cls": "ExprName"}, "description": "When the object's module could not be found."}, {"annotation": {"member": null, "name": "ImportError", "cls": "ExprName"}, "description": "When there was an import error or when couldn't get the attribute."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "dynamic_import", "name": "Any", "cls": "ExprName"}, "description": "The imported object."}]}]}, "analysis": "static", "path": "griffe._internal.importer.dynamic_import", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/importer.py", "relative_package_filepath": "griffe/_internal/importer.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/importer.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/importer.py#L43-L123", "decorators": [], "parameters": [{"name": "import_path", "annotation": {"member": "dynamic_import", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "dynamic_import", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "dynamic_import", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "dynamic_import", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"member": "dynamic_import", "name": "Any", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.importer", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/importer.py", "relative_package_filepath": "griffe/_internal/importer.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/importer.py"}, "loader": {"kind": "module", "name": "loader", "runtime": true, "imports": {"annotations": "__future__.annotations", "re": "re", "shutil": "shutil", "subprocess": "subprocess", "sys": "sys", "tempfile": "tempfile", "suppress": "contextlib.suppress", "datetime": "datetime.datetime", "timezone": "datetime.timezone", "cached_property": "functools.cached_property", "find_spec": "importlib.util.find_spec", "Path": "pathlib.Path", "TYPE_CHECKING": "typing.TYPE_CHECKING", "ClassVar": "typing.ClassVar", "cast": "typing.cast", "inspect": "griffe._internal.agents.inspector.inspect", "visit": "griffe._internal.agents.visitor.visit", "LinesCollection": "griffe._internal.collections.LinesCollection", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "Kind": "griffe._internal.enumerations.Kind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "LoadingError": "griffe._internal.exceptions.LoadingError", "UnimportableModuleError": "griffe._internal.exceptions.UnimportableModuleError", "ExprName": "griffe._internal.expressions.ExprName", "Extensions": "griffe._internal.extensions.base.Extensions", "load_extensions": "griffe._internal.extensions.base.load_extensions", "ModuleFinder": "griffe._internal.finder.ModuleFinder", "NamespacePackage": "griffe._internal.finder.NamespacePackage", "Package": "griffe._internal.finder.Package", "GitInfo": "griffe._internal.git.GitInfo", "_tmp_worktree": "griffe._internal.git._tmp_worktree", "dynamic_import": "griffe._internal.importer.dynamic_import", "logger": "griffe._internal.logger.logger", "merge_stubs": "griffe._internal.merger.merge_stubs", "Alias": "griffe._internal.models.Alias", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "Stats": "griffe._internal.stats.Stats", "Sequence": "collections.abc.Sequence", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "Parser": "griffe._internal.enumerations.Parser"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.loader.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.loader.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "shutil": {"kind": "alias", "name": "shutil", "target_path": "shutil", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.loader.shutil", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "subprocess": {"kind": "alias", "name": "subprocess", "target_path": "subprocess", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.loader.subprocess", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.loader.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "tempfile": {"kind": "alias", "name": "tempfile", "target_path": "tempfile", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.loader.tempfile", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.loader.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "datetime": {"kind": "alias", "name": "datetime", "target_path": "datetime.datetime", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.loader.datetime", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "timezone": {"kind": "alias", "name": "timezone", "target_path": "datetime.timezone", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.loader.timezone", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cached_property": {"kind": "alias", "name": "cached_property", "target_path": "functools.cached_property", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.loader.cached_property", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "find_spec": {"kind": "alias", "name": "find_spec", "target_path": "importlib.util.find_spec", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.loader.find_spec", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.loader.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.loader.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ClassVar": {"kind": "alias", "name": "ClassVar", "target_path": "typing.ClassVar", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.loader.ClassVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cast": {"kind": "alias", "name": "cast", "target_path": "typing.cast", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.loader.cast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "inspect": {"kind": "alias", "name": "inspect", "target_path": "griffe._internal.agents.inspector.inspect", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.loader.inspect", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "visit": {"kind": "alias", "name": "visit", "target_path": "griffe._internal.agents.visitor.visit", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.loader.visit", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.loader.LinesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.loader.ModulesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.loader.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 26, "analysis": "static", "path": "griffe._internal.loader.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 26, "analysis": "static", "path": "griffe._internal.loader.CyclicAliasError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LoadingError": {"kind": "alias", "name": "LoadingError", "target_path": "griffe._internal.exceptions.LoadingError", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 26, "analysis": "static", "path": "griffe._internal.loader.LoadingError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "UnimportableModuleError": {"kind": "alias", "name": "UnimportableModuleError", "target_path": "griffe._internal.exceptions.UnimportableModuleError", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 26, "analysis": "static", "path": "griffe._internal.loader.UnimportableModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 27, "analysis": "static", "path": "griffe._internal.loader.ExprName", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Extensions": {"kind": "alias", "name": "Extensions", "target_path": "griffe._internal.extensions.base.Extensions", "runtime": true, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.loader.Extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "load_extensions": {"kind": "alias", "name": "load_extensions", "target_path": "griffe._internal.extensions.base.load_extensions", "runtime": true, "inherited": false, "lineno": 28, "endlineno": 28, "analysis": "static", "path": "griffe._internal.loader.load_extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ModuleFinder": {"kind": "alias", "name": "ModuleFinder", "target_path": "griffe._internal.finder.ModuleFinder", "runtime": true, "inherited": false, "lineno": 29, "endlineno": 29, "analysis": "static", "path": "griffe._internal.loader.ModuleFinder", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "NamespacePackage": {"kind": "alias", "name": "NamespacePackage", "target_path": "griffe._internal.finder.NamespacePackage", "runtime": true, "inherited": false, "lineno": 29, "endlineno": 29, "analysis": "static", "path": "griffe._internal.loader.NamespacePackage", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Package": {"kind": "alias", "name": "Package", "target_path": "griffe._internal.finder.Package", "runtime": true, "inherited": false, "lineno": 29, "endlineno": 29, "analysis": "static", "path": "griffe._internal.loader.Package", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GitInfo": {"kind": "alias", "name": "GitInfo", "target_path": "griffe._internal.git.GitInfo", "runtime": true, "inherited": false, "lineno": 30, "endlineno": 30, "analysis": "static", "path": "griffe._internal.loader.GitInfo", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_tmp_worktree": {"kind": "alias", "name": "_tmp_worktree", "target_path": "griffe._internal.git._tmp_worktree", "runtime": true, "inherited": false, "lineno": 30, "endlineno": 30, "analysis": "static", "path": "griffe._internal.loader._tmp_worktree", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "dynamic_import": {"kind": "alias", "name": "dynamic_import", "target_path": "griffe._internal.importer.dynamic_import", "runtime": true, "inherited": false, "lineno": 31, "endlineno": 31, "analysis": "static", "path": "griffe._internal.loader.dynamic_import", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 32, "endlineno": 32, "analysis": "static", "path": "griffe._internal.loader.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "merge_stubs": {"kind": "alias", "name": "merge_stubs", "target_path": "griffe._internal.merger.merge_stubs", "runtime": true, "inherited": false, "lineno": 33, "endlineno": 33, "analysis": "static", "path": "griffe._internal.loader.merge_stubs", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 34, "analysis": "static", "path": "griffe._internal.loader.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 34, "analysis": "static", "path": "griffe._internal.loader.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 34, "analysis": "static", "path": "griffe._internal.loader.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Stats": {"kind": "alias", "name": "Stats", "target_path": "griffe._internal.stats.Stats", "runtime": true, "inherited": false, "lineno": 35, "endlineno": 35, "analysis": "static", "path": "griffe._internal.loader.Stats", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 38, "endlineno": 38, "analysis": "static", "path": "griffe._internal.loader.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": false, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.loader.DocstringOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": false, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.loader.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": false, "inherited": false, "lineno": 41, "endlineno": 41, "analysis": "static", "path": "griffe._internal.loader.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "GriffeLoader": {"kind": "class", "name": "GriffeLoader", "runtime": true, "lineno": 44, "endlineno": 744, "docstring": {"value": "The Griffe loader, allowing to load data from modules.", "lineno": 45, "endlineno": 45, "parsed": [{"kind": "text", "value": "The Griffe loader, allowing to load data from modules."}]}, "members": {"ignored_modules": {"kind": "attribute", "name": "ignored_modules", "runtime": true, "lineno": 47, "endlineno": 47, "docstring": {"value": "Special modules to ignore when loading.\n\nFor example, `debugpy` and `_pydev` are used when debugging with VSCode and should generally never be loaded.", "lineno": 48, "endlineno": 51, "parsed": [{"kind": "text", "value": "Special modules to ignore when loading.\n\nFor example, `debugpy` and `_pydev` are used when debugging with VSCode and should generally never be loaded."}]}, "labels": ["class-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.ignored_modules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L47-L47", "value": {"elements": ["'debugpy'", "'_pydev'"], "cls": "ExprSet"}, "annotation": {"left": {"member": null, "name": "set", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 53, "endlineno": 98, "docstring": {"value": "Initialize the loader.\n\nParameters:\n    extensions: The extensions to use.\n    search_paths: The paths to search into.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules when visiting them is not possible.\n    store_source: Whether to store code source in the lines collection.", "lineno": 66, "endlineno": 77, "parsed": [{"kind": "parameters", "value": [{"name": "extensions", "annotation": {"left": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The paths to search into.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules when visiting them is not possible.", "value": "True"}, {"name": "store_source", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "description": "Whether to store code source in the lines collection.", "value": "True"}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L53-L98", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"left": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "__init__", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "force_inspection", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "store_source", "annotation": {"member": "__init__", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": "None"}, "extensions": {"kind": "attribute", "name": "extensions", "runtime": true, "lineno": 78, "endlineno": 78, "docstring": {"value": "Loaded Griffe extensions.", "lineno": 79, "endlineno": 79, "parsed": [{"kind": "text", "value": "Loaded Griffe extensions."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L78-L78", "value": {"operator": "or", "values": [{"member": null, "name": "extensions", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "load_extensions", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "Extensions", "cls": "ExprName"}}, "docstring_parser": {"kind": "attribute", "name": "docstring_parser", "runtime": true, "lineno": 80, "endlineno": 80, "docstring": {"value": "Selected docstring parser.", "lineno": 81, "endlineno": 81, "parsed": [{"kind": "text", "value": "Selected docstring parser."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.docstring_parser", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L80-L80", "value": {"member": null, "name": "docstring_parser", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring_options": {"kind": "attribute", "name": "docstring_options", "runtime": true, "lineno": 82, "endlineno": 82, "docstring": {"value": "Configured parsing options.", "lineno": 83, "endlineno": 83, "parsed": [{"kind": "text", "value": "Configured parsing options."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.docstring_options", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L82-L82", "value": {"operator": "or", "values": [{"member": null, "name": "docstring_options", "cls": "ExprName"}, {"keys": [], "values": [], "cls": "ExprDict"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "DocstringOptions", "cls": "ExprName"}}, "lines_collection": {"kind": "attribute", "name": "lines_collection", "runtime": true, "lineno": 84, "endlineno": 84, "docstring": {"value": "Collection of source code lines.", "lineno": 85, "endlineno": 85, "parsed": [{"kind": "text", "value": "Collection of source code lines."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L84-L84", "value": {"operator": "or", "values": [{"member": null, "name": "lines_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "LinesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "LinesCollection", "cls": "ExprName"}}, "modules_collection": {"kind": "attribute", "name": "modules_collection", "runtime": true, "lineno": 86, "endlineno": 86, "docstring": {"value": "Collection of modules.", "lineno": 87, "endlineno": 87, "parsed": [{"kind": "text", "value": "Collection of modules."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L86-L86", "value": {"operator": "or", "values": [{"member": null, "name": "modules_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}}, "allow_inspection": {"kind": "attribute", "name": "allow_inspection", "runtime": true, "lineno": 88, "endlineno": 88, "docstring": {"value": "Whether to allow inspecting (importing) modules for which we can't find sources.", "lineno": 89, "endlineno": 89, "parsed": [{"kind": "text", "value": "Whether to allow inspecting (importing) modules for which we can't find sources."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.allow_inspection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L88-L88", "value": {"member": null, "name": "allow_inspection", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "force_inspection": {"kind": "attribute", "name": "force_inspection", "runtime": true, "lineno": 90, "endlineno": 90, "docstring": {"value": "Whether to force inspecting (importing) modules, even when sources were found.", "lineno": 91, "endlineno": 91, "parsed": [{"kind": "text", "value": "Whether to force inspecting (importing) modules, even when sources were found."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.force_inspection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L90-L90", "value": {"member": null, "name": "force_inspection", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "store_source": {"kind": "attribute", "name": "store_source", "runtime": true, "lineno": 92, "endlineno": 92, "docstring": {"value": "Whether to store source code in the lines collection.", "lineno": 93, "endlineno": 93, "parsed": [{"kind": "text", "value": "Whether to store source code in the lines collection."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.store_source", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L92-L92", "value": {"member": null, "name": "store_source", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "_search_paths": {"kind": "attribute", "name": "_search_paths", "runtime": true, "lineno": 94, "endlineno": 94, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._search_paths", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L94-L94", "value": {"member": null, "name": "search_paths", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_time_stats": {"kind": "attribute", "name": "_time_stats", "runtime": true, "lineno": 95, "endlineno": 98, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._time_stats", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L95-L98", "value": {"keys": ["'time_spent_visiting'", "'time_spent_inspecting'"], "values": ["0", "0"], "cls": "ExprDict"}, "annotation": {"member": null, "name": "dict", "cls": "ExprName"}}, "finder": {"kind": "attribute", "name": "finder", "runtime": true, "lineno": 101, "endlineno": 103, "docstring": {"value": "The module source finder.", "lineno": 102, "endlineno": 102, "parsed": [{"kind": "text", "value": "The module source finder."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.finder", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L101-L103", "annotation": {"member": "finder", "name": "ModuleFinder", "cls": "ExprName"}}, "load": {"kind": "function", "name": "load", "runtime": true, "lineno": 105, "endlineno": 195, "docstring": {"value": "Load an object as a Griffe object, given its Python or file path.\n\nNote that this will load the whole object's package,\nand return only the specified object.\nThe rest of the package can be accessed from the returned object\nwith regular methods and properties (`parent`, `members`, etc.).\n\nExamples:\n    >>> loader.load(\"griffe.Module\")\n    Alias(\"Module\", \"griffe._internal.models.Module\")\n\nParameters:\n    objspec: The Python path of an object, or file path to a module.\n    submodules: Whether to recurse on the submodules.\n        This parameter only makes sense when loading a package (top-level module).\n    try_relative_path: Whether to try finding the module as a relative path.\n    find_stubs_package: Whether to search for stubs-only package.\n        If both the package and its stubs are found, they'll be merged together.\n        If only the stubs are found, they'll be used as the package itself.\n\nRaises:\n    LoadingError: When loading a module failed for various reasons.\n    ModuleNotFoundError: When a module was not found and inspection is disallowed.\n\nReturns:\n    A Griffe object.", "lineno": 114, "endlineno": 140, "parsed": [{"kind": "text", "value": "Load an object as a Griffe object, given its Python or file path.\n\nNote that this will load the whole object's package,\nand return only the specified object.\nThe rest of the package can be accessed from the returned object\nwith regular methods and properties (`parent`, `members`, etc.)."}, {"kind": "examples", "value": [["examples", ">>> loader.load(\"griffe.Module\")\nAlias(\"Module\", \"griffe._internal.models.Module\")"]]}, {"kind": "parameters", "value": [{"name": "objspec", "annotation": {"left": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The Python path of an object, or file path to a module.", "value": "None"}, {"name": "submodules", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to recurse on the submodules.\nThis parameter only makes sense when loading a package (top-level module).", "value": "True"}, {"name": "try_relative_path", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to try finding the module as a relative path.", "value": "True"}, {"name": "find_stubs_package", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to search for stubs-only package.\nIf both the package and its stubs are found, they'll be merged together.\nIf only the stubs are found, they'll be used as the package itself.", "value": "False"}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "LoadingError", "cls": "ExprName"}, "description": "When loading a module failed for various reasons."}, {"annotation": {"member": null, "name": "ModuleNotFoundError", "cls": "ExprName"}, "description": "When a module was not found and inspection is disallowed."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "load", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "A Griffe object."}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.load", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L105-L195", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional-only", "default": null}, {"name": "objspec", "annotation": {"left": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional-only", "default": "None"}, {"name": "submodules", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "try_relative_path", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "find_stubs_package", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "load", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "_fire_load_events": {"kind": "function", "name": "_fire_load_events", "runtime": true, "lineno": 197, "endlineno": 214, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._fire_load_events", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L197-L214", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "_fire_load_events", "name": "Object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_post_load": {"kind": "function", "name": "_post_load", "runtime": true, "lineno": 216, "endlineno": 235, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._post_load", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L216-L235", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "_post_load", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "obj_path", "annotation": {"member": "_post_load", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_post_load", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_post_load", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "resolve_aliases": {"kind": "function", "name": "resolve_aliases", "runtime": true, "lineno": 237, "endlineno": 291, "docstring": {"value": "Resolve aliases.\n\nParameters:\n    implicit: When false, only try to resolve an alias if it is explicitly exported.\n    external: When false, don't try to load unspecified modules to resolve aliases.\n    max_iterations: Maximum number of iterations on the loader modules collection.\n\nReturns:\n    The unresolved aliases and the number of iterations done.", "lineno": 244, "endlineno": 253, "parsed": [{"kind": "text", "value": "Resolve aliases."}, {"kind": "parameters", "value": [{"name": "implicit", "annotation": {"member": "resolve_aliases", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}, {"name": "external", "annotation": {"left": {"member": "resolve_aliases", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "When false, don't try to load unspecified modules to resolve aliases.", "value": "None"}, {"name": "max_iterations", "annotation": {"left": {"member": "resolve_aliases", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Maximum number of iterations on the loader modules collection.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "resolve_aliases", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "resolve_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"member": "resolve_aliases", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "The unresolved aliases and the number of iterations done."}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.resolve_aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L237-L291", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "implicit", "annotation": {"member": "resolve_aliases", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "external", "annotation": {"left": {"member": "resolve_aliases", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "max_iterations", "annotation": {"left": {"member": "resolve_aliases", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "resolve_aliases", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "resolve_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"member": "resolve_aliases", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "expand_exports": {"kind": "function", "name": "expand_exports", "runtime": true, "lineno": 293, "endlineno": 332, "docstring": {"value": "Expand exports: try to recursively expand all module exports (`__all__` values).\n\nSee also: [`Module.exports`][griffe.Module.exports].\n\nParameters:\n    module: The module to recurse on.\n    seen: Used to avoid infinite recursion.", "lineno": 294, "endlineno": 301, "parsed": [{"kind": "text", "value": "Expand exports: try to recursively expand all module exports (`__all__` values).\n\nSee also: [`Module.exports`][griffe.Module.exports]."}, {"kind": "parameters", "value": [{"name": "module", "annotation": {"member": "expand_exports", "name": "Module", "cls": "ExprName"}, "description": "The module to recurse on."}, {"name": "seen", "annotation": {"left": {"member": "expand_exports", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Used to avoid infinite recursion.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.expand_exports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L293-L332", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "expand_exports", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "seen", "annotation": {"left": {"member": "expand_exports", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "expand_wildcards": {"kind": "function", "name": "expand_wildcards", "runtime": true, "lineno": 334, "endlineno": 448, "docstring": {"value": "Expand wildcards: try to recursively expand all found wildcards.\n\nSee also: [`Alias.wildcard`][griffe.Alias.wildcard].\n\nParameters:\n    obj: The object and its members to recurse on.\n    external: When true, try to load unspecified modules to expand wildcards.\n    seen: Used to avoid infinite recursion.", "lineno": 341, "endlineno": 349, "parsed": [{"kind": "text", "value": "Expand wildcards: try to recursively expand all found wildcards.\n\nSee also: [`Alias.wildcard`][griffe.Alias.wildcard]."}, {"kind": "parameters", "value": [{"name": "obj", "annotation": {"member": "expand_wildcards", "name": "Object", "cls": "ExprName"}, "description": "The object and its members to recurse on."}, {"name": "external", "annotation": {"left": {"member": "expand_wildcards", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "When true, try to load unspecified modules to expand wildcards.", "value": "None"}, {"name": "seen", "annotation": {"left": {"member": "expand_wildcards", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Used to avoid infinite recursion.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.expand_wildcards", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L334-L448", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "expand_wildcards", "name": "Object", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "external", "annotation": {"left": {"member": "expand_wildcards", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "seen", "annotation": {"left": {"member": "expand_wildcards", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "resolve_module_aliases": {"kind": "function", "name": "resolve_module_aliases", "runtime": true, "lineno": 450, "endlineno": 526, "docstring": {"value": "Follow aliases: try to recursively resolve all found aliases.\n\nParameters:\n    obj: The object and its members to recurse on.\n    implicit: When false, only try to resolve an alias if it is explicitly exported.\n    external: When false, don't try to load unspecified modules to resolve aliases.\n    seen: Used to avoid infinite recursion.\n    load_failures: Set of external packages we failed to load (to prevent retries).\n\nReturns:\n    Both sets of resolved and unresolved aliases.", "lineno": 459, "endlineno": 470, "parsed": [{"kind": "text", "value": "Follow aliases: try to recursively resolve all found aliases."}, {"kind": "parameters", "value": [{"name": "obj", "annotation": {"left": {"member": "resolve_module_aliases", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "resolve_module_aliases", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The object and its members to recurse on."}, {"name": "implicit", "annotation": {"member": "resolve_module_aliases", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}, {"name": "external", "annotation": {"left": {"member": "resolve_module_aliases", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "When false, don't try to load unspecified modules to resolve aliases.", "value": "None"}, {"name": "seen", "annotation": {"left": {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Used to avoid infinite recursion.", "value": "None"}, {"name": "load_failures", "annotation": {"left": {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Set of external packages we failed to load (to prevent retries).", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "resolve_module_aliases", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "Both sets of resolved and unresolved aliases."}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.resolve_module_aliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L450-L526", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"left": {"member": "resolve_module_aliases", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "resolve_module_aliases", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "implicit", "annotation": {"member": "resolve_module_aliases", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "external", "annotation": {"left": {"member": "resolve_module_aliases", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "seen", "annotation": {"left": {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "load_failures", "annotation": {"left": {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "resolve_module_aliases", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"left": {"member": "resolve_module_aliases", "name": "set", "cls": "ExprName"}, "slice": {"member": "resolve_module_aliases", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "stats": {"kind": "function", "name": "stats", "runtime": true, "lineno": 528, "endlineno": 537, "docstring": {"value": "Compute some statistics.\n\nReturns:\n    Some statistics.", "lineno": 529, "endlineno": 533, "parsed": [{"kind": "text", "value": "Compute some statistics."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "stats", "name": "Stats", "cls": "ExprName"}, "description": "Some statistics."}]}]}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader.stats", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L528-L537", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "stats", "name": "Stats", "cls": "ExprName"}}, "_load_package": {"kind": "function", "name": "_load_package", "runtime": true, "lineno": 539, "endlineno": 552, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._load_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L539-L552", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "package", "annotation": {"left": {"member": "_load_package", "name": "Package", "cls": "ExprName"}, "operator": "|", "right": {"member": "_load_package", "name": "NamespacePackage", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "submodules", "annotation": {"member": "_load_package", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_load_package", "name": "Module", "cls": "ExprName"}}, "_load_module": {"kind": "function", "name": "_load_module", "runtime": true, "lineno": 554, "endlineno": 571, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._load_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L554-L571", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "_load_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_path", "annotation": {"left": {"member": "_load_module", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_module", "name": "list", "cls": "ExprName"}, "slice": {"member": "_load_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "submodules", "annotation": {"member": "_load_module", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "parent", "annotation": {"left": {"member": "_load_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "_load_module", "name": "Module", "cls": "ExprName"}}, "_load_module_path": {"kind": "function", "name": "_load_module_path", "runtime": true, "lineno": 573, "endlineno": 596, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._load_module_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L573-L596", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "_load_module_path", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_path", "annotation": {"left": {"member": "_load_module_path", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_module_path", "name": "list", "cls": "ExprName"}, "slice": {"member": "_load_module_path", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "submodules", "annotation": {"member": "_load_module_path", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "parent", "annotation": {"left": {"member": "_load_module_path", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "_load_module_path", "name": "Module", "cls": "ExprName"}}, "_load_submodules": {"kind": "function", "name": "_load_submodules", "runtime": true, "lineno": 598, "endlineno": 600, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._load_submodules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L598-L600", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "_load_submodules", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_load_submodule": {"kind": "function", "name": "_load_submodule", "runtime": true, "lineno": 602, "endlineno": 651, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._load_submodule", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L602-L651", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "_load_submodule", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "subparts", "annotation": {"left": {"member": "_load_submodule", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_submodule", "name": "str", "cls": "ExprName"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "subpath", "annotation": {"member": "_load_submodule", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_create_module": {"kind": "function", "name": "_create_module", "runtime": true, "lineno": 653, "endlineno": 659, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._create_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L653-L659", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "_create_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_path", "annotation": {"left": {"member": "_create_module", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_create_module", "name": "list", "cls": "ExprName"}, "slice": {"member": "_create_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_create_module", "name": "Module", "cls": "ExprName"}}, "_visit_module": {"kind": "function", "name": "_visit_module", "runtime": true, "lineno": 661, "endlineno": 679, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._visit_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L661-L679", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "_visit_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "module_path", "annotation": {"member": "_visit_module", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_visit_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"member": "_visit_module", "name": "Module", "cls": "ExprName"}}, "_inspect_module": {"kind": "function", "name": "_inspect_module", "runtime": true, "lineno": 681, "endlineno": 706, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._inspect_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L681-L706", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "_inspect_module", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"member": "_inspect_module", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "_inspect_module", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"member": "_inspect_module", "name": "Module", "cls": "ExprName"}}, "_get_or_create_parent_module": {"kind": "function", "name": "_get_or_create_parent_module", "runtime": true, "lineno": 708, "endlineno": 736, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._get_or_create_parent_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L708-L736", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module", "annotation": {"member": "_get_or_create_parent_module", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "subparts", "annotation": {"left": {"member": "_get_or_create_parent_module", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_get_or_create_parent_module", "name": "str", "cls": "ExprName"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "subpath", "annotation": {"member": "_get_or_create_parent_module", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_or_create_parent_module", "name": "Module", "cls": "ExprName"}}, "_expand_wildcard": {"kind": "function", "name": "_expand_wildcard", "runtime": true, "lineno": 738, "endlineno": 744, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader._expand_wildcard", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L738-L744", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "wildcard_obj", "annotation": {"member": "_expand_wildcard", "name": "Alias", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_expand_wildcard", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_expand_wildcard", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_expand_wildcard", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "_expand_wildcard", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, {"left": {"member": "_expand_wildcard", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"member": "_expand_wildcard", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.loader.GriffeLoader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L44-L744", "bases": [], "decorators": []}, "load": {"kind": "function", "name": "load", "runtime": true, "lineno": 747, "endlineno": 849, "docstring": {"value": "Load and return a Griffe object.\n\nIn Griffe's context, loading means:\n\n- searching for a package, and finding it on the file system or as a builtin module\n    (see the [`ModuleFinder`][griffe.ModuleFinder] class for more information)\n- extracting information from each of its (sub)modules, by either parsing\n    the source code (see the [`visit`][griffe.visit] function)\n    or inspecting the module at runtime (see the [`inspect`][griffe.inspect] function)\n\nThe extracted information is stored in a collection of modules, which can be queried later.\nEach collected module is a tree of objects, representing the structure of the module.\nSee the [`Module`][griffe.Module], [`Class`][griffe.Class],\n[`Function`][griffe.Function], [`Attribute`][griffe.Attribute], and\n[`TypeAlias`][griffe.TypeAlias] classes for more information.\n\nThe main class used to load modules is [`GriffeLoader`][griffe.GriffeLoader].\nConvenience functions like this one and [`load_git`][griffe.load_git] are also available.\n\nExample:\n    ```python\n    import griffe\n\n    module = griffe.load(...)\n    ```\n\n    This is a shortcut for:\n\n    ```python\n    from griffe import GriffeLoader\n\n    loader = GriffeLoader(...)\n    module = loader.load(...)\n    ```\n\n    See the documentation for the loader: [`GriffeLoader`][griffe.GriffeLoader].\n\nParameters:\n    objspec: The Python path of an object, or file path to a module.\n    submodules: Whether to recurse on the submodules.\n        This parameter only makes sense when loading a package (top-level module).\n    try_relative_path: Whether to try finding the module as a relative path.\n    extensions: The extensions to use.\n    search_paths: The paths to search into.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules when visiting them is not possible.\n    force_inspection: Whether to force using dynamic analysis when loading data.\n    store_source: Whether to store code source in the lines collection.\n    find_stubs_package: Whether to search for stubs-only package.\n        If both the package and its stubs are found, they'll be merged together.\n        If only the stubs are found, they'll be used as the package itself.\n    resolve_aliases: Whether to resolve aliases.\n    resolve_external: Whether to try to load unspecified modules to resolve aliases.\n        Default value (`None`) means to load external modules only if they are the private sibling\n        or the origin module (for example when `ast` imports from `_ast`).\n    resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.\n\nReturns:\n    A Griffe object.", "lineno": 767, "endlineno": 829, "parsed": [{"kind": "text", "value": "Load and return a Griffe object.\n\nIn Griffe's context, loading means:\n\n- searching for a package, and finding it on the file system or as a builtin module\n    (see the [`ModuleFinder`][griffe.ModuleFinder] class for more information)\n- extracting information from each of its (sub)modules, by either parsing\n    the source code (see the [`visit`][griffe.visit] function)\n    or inspecting the module at runtime (see the [`inspect`][griffe.inspect] function)\n\nThe extracted information is stored in a collection of modules, which can be queried later.\nEach collected module is a tree of objects, representing the structure of the module.\nSee the [`Module`][griffe.Module], [`Class`][griffe.Class],\n[`Function`][griffe.Function], [`Attribute`][griffe.Attribute], and\n[`TypeAlias`][griffe.TypeAlias] classes for more information.\n\nThe main class used to load modules is [`GriffeLoader`][griffe.GriffeLoader].\nConvenience functions like this one and [`load_git`][griffe.load_git] are also available."}, {"kind": "admonition", "value": {"annotation": "example", "description": "```python\nimport griffe\n\nmodule = griffe.load(...)\n```\n\nThis is a shortcut for:\n\n```python\nfrom griffe import GriffeLoader\n\nloader = GriffeLoader(...)\nmodule = loader.load(...)\n```\n\nSee the documentation for the loader: [`GriffeLoader`][griffe.GriffeLoader]."}, "title": "Example"}, {"kind": "parameters", "value": [{"name": "objspec", "annotation": {"left": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The Python path of an object, or file path to a module.", "value": "None"}, {"name": "submodules", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to recurse on the submodules.\nThis parameter only makes sense when loading a package (top-level module).", "value": "True"}, {"name": "try_relative_path", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to try finding the module as a relative path.", "value": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The paths to search into.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules when visiting them is not possible.", "value": "True"}, {"name": "force_inspection", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to force using dynamic analysis when loading data.", "value": "False"}, {"name": "store_source", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to store code source in the lines collection.", "value": "True"}, {"name": "find_stubs_package", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to search for stubs-only package.\nIf both the package and its stubs are found, they'll be merged together.\nIf only the stubs are found, they'll be used as the package itself.", "value": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "Whether to resolve aliases.", "value": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try to load unspecified modules to resolve aliases.\nDefault value (`None`) means to load external modules only if they are the private sibling\nor the origin module (for example when `ast` imports from `_ast`).", "value": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "load", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "A Griffe object."}]}]}, "analysis": "static", "path": "griffe._internal.loader.load", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L747-L849", "decorators": [], "parameters": [{"name": "objspec", "annotation": {"left": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional-only", "default": "None"}, {"name": "submodules", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "try_relative_path", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "force_inspection", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "store_source", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "find_stubs_package", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "load", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "load_git": {"kind": "function", "name": "load_git", "runtime": true, "lineno": 852, "endlineno": 934, "docstring": {"value": "Load and return a module from a specific Git reference.\n\nThis function will create a temporary\n[git worktree](https://git-scm.com/docs/git-worktree) at the requested reference\nbefore loading `module` with [`griffe.load`][griffe.load].\n\nThis function requires that the `git` executable is installed.\n\nExamples:\n    ```python\n    from griffe import load_git\n\n    old_api = load_git(\"my_module\", ref=\"v0.1.0\", repo=\"path/to/repo\")\n    ```\n\nParameters:\n    objspec: The Python path of an object, or file path to a module.\n    ref: A Git reference such as a commit, tag or branch.\n    repo: Path to the repository (i.e. the directory *containing* the `.git` directory)\n    submodules: Whether to recurse on the submodules.\n        This parameter only makes sense when loading a package (top-level module).\n    extensions: The extensions to use.\n    search_paths: The paths to search into (relative to the repository root).\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules when visiting them is not possible.\n    force_inspection: Whether to force using dynamic analysis when loading data.\n    find_stubs_package: Whether to search for stubs-only package.\n        If both the package and its stubs are found, they'll be merged together.\n        If only the stubs are found, they'll be used as the package itself.\n    resolve_aliases: Whether to resolve aliases.\n    resolve_external: Whether to try to load unspecified modules to resolve aliases.\n        Default value (`None`) means to load external modules only if they are the private sibling\n        or the origin module (for example when `ast` imports from `_ast`).\n    resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.\n\nReturns:\n    A Griffe object.", "lineno": 872, "endlineno": 912, "parsed": [{"kind": "text", "value": "Load and return a module from a specific Git reference.\n\nThis function will create a temporary\n[git worktree](https://git-scm.com/docs/git-worktree) at the requested reference\nbefore loading `module` with [`griffe.load`][griffe.load].\n\nThis function requires that the `git` executable is installed."}, {"kind": "examples", "value": [["text", "```python\nfrom griffe import load_git\n\nold_api = load_git(\"my_module\", ref=\"v0.1.0\", repo=\"path/to/repo\")\n```"]]}, {"kind": "parameters", "value": [{"name": "objspec", "annotation": {"left": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The Python path of an object, or file path to a module.", "value": "None"}, {"name": "ref", "annotation": {"member": "load_git", "name": "str", "cls": "ExprName"}, "description": "A Git reference such as a commit, tag or branch.", "value": "'HEAD'"}, {"name": "repo", "annotation": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "Path to the repository (i.e. the directory *containing* the `.git` directory)", "value": "'.'"}, {"name": "submodules", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "Whether to recurse on the submodules.\nThis parameter only makes sense when loading a package (top-level module).", "value": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load_git", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load_git", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The paths to search into (relative to the repository root).", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load_git", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load_git", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load_git", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load_git", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules when visiting them is not possible.", "value": "True"}, {"name": "force_inspection", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "Whether to force using dynamic analysis when loading data.", "value": "False"}, {"name": "find_stubs_package", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "Whether to search for stubs-only package.\nIf both the package and its stubs are found, they'll be merged together.\nIf only the stubs are found, they'll be used as the package itself.", "value": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "Whether to resolve aliases.", "value": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try to load unspecified modules to resolve aliases.\nDefault value (`None`) means to load external modules only if they are the private sibling\nor the origin module (for example when `ast` imports from `_ast`).", "value": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "load_git", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "A Griffe object."}]}]}, "analysis": "static", "path": "griffe._internal.loader.load_git", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L852-L934", "decorators": [], "parameters": [{"name": "objspec", "annotation": {"left": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional-only", "default": "None"}, {"name": "ref", "annotation": {"member": "load_git", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": "'HEAD'"}, {"name": "repo", "annotation": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "'.'"}, {"name": "submodules", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load_git", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load_git", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load_git", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load_git", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load_git", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load_git", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load_git", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "force_inspection", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "find_stubs_package", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load_git", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "load_git", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_git", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "load_pypi": {"kind": "function", "name": "load_pypi", "runtime": true, "lineno": 937, "endlineno": 1059, "docstring": {"value": "Load and return a module from a specific package version downloaded using pip.\n\nParameters:\n    package: The package import name.\n    distribution: The distribution name.\n    version_spec: The version specifier to use when installing with pip.\n    submodules: Whether to recurse on the submodules.\n        This parameter only makes sense when loading a package (top-level module).\n    extensions: The extensions to use.\n    search_paths: The paths to search into (relative to the repository root).\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n    allow_inspection: Whether to allow inspecting modules when visiting them is not possible.\n    force_inspection: Whether to force using dynamic analysis when loading data.\n    find_stubs_package: Whether to search for stubs-only package.\n        If both the package and its stubs are found, they'll be merged together.\n        If only the stubs are found, they'll be used as the package itself.\n    resolve_aliases: Whether to resolve aliases.\n    resolve_external: Whether to try to load unspecified modules to resolve aliases.\n        Default value (`None`) means to load external modules only if they are the private sibling\n        or the origin module (for example when `ast` imports from `_ast`).\n    resolve_implicit: When false, only try to resolve an alias if it is explicitly exported.", "lineno": 956, "endlineno": 980, "parsed": [{"kind": "text", "value": "Load and return a module from a specific package version downloaded using pip."}, {"kind": "parameters", "value": [{"name": "package", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "description": "The package import name."}, {"name": "distribution", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "description": "The distribution name."}, {"name": "version_spec", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "description": "The version specifier to use when installing with pip."}, {"name": "submodules", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "Whether to recurse on the submodules.\nThis parameter only makes sense when loading a package (top-level module).", "value": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load_pypi", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use.", "value": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load_pypi", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_pypi", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The paths to search into (relative to the repository root).", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load_pypi", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_pypi", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load_pypi", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load_pypi", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load_pypi", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}, {"name": "allow_inspection", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "Whether to allow inspecting modules when visiting them is not possible.", "value": "True"}, {"name": "force_inspection", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "Whether to force using dynamic analysis when loading data.", "value": "False"}, {"name": "find_stubs_package", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "Whether to search for stubs-only package.\nIf both the package and its stubs are found, they'll be merged together.\nIf only the stubs are found, they'll be used as the package itself.", "value": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "Whether to resolve aliases.", "value": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Whether to try to load unspecified modules to resolve aliases.\nDefault value (`None`) means to load external modules only if they are the private sibling\nor the origin module (for example when `ast` imports from `_ast`).", "value": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "description": "When false, only try to resolve an alias if it is explicitly exported.", "value": "False"}]}]}, "analysis": "static", "path": "griffe._internal.loader.load_pypi", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/loader.py#L937-L1059", "decorators": [], "parameters": [{"name": "package", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "distribution", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "version_spec", "annotation": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "submodules", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "extensions", "annotation": {"left": {"member": "load_pypi", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "search_paths", "annotation": {"left": {"left": {"member": "load_pypi", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "load_pypi", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_pypi", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "load_pypi", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_pypi", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "load_pypi", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "load_pypi", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "load_pypi", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "allow_inspection", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "force_inspection", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "find_stubs_package", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_aliases", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "resolve_external", "annotation": {"left": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "resolve_implicit", "annotation": {"member": "load_pypi", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "load_pypi", "name": "Object", "cls": "ExprName"}, "operator": "|", "right": {"member": "load_pypi", "name": "Alias", "cls": "ExprName"}, "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.loader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/loader.py", "relative_package_filepath": "griffe/_internal/loader.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/loader.py"}, "c3linear": {"kind": "module", "name": "c3linear", "runtime": true, "imports": {"annotations": "__future__.annotations", "deque": "collections.deque", "islice": "itertools.islice", "TypeVar": "typing.TypeVar"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.c3linear.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "deque": {"kind": "alias", "name": "deque", "target_path": "collections.deque", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.c3linear.deque", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "islice": {"kind": "alias", "name": "islice", "target_path": "itertools.islice", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.c3linear.islice", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeVar": {"kind": "alias", "name": "TypeVar", "target_path": "typing.TypeVar", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.c3linear.TypeVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_T": {"kind": "attribute", "name": "_T", "runtime": true, "lineno": 14, "endlineno": 14, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.c3linear._T", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L14-L14", "value": {"arguments": ["'_T'"], "function": {"member": null, "name": "TypeVar", "cls": "ExprName"}, "cls": "ExprCall"}}, "_Dependency": {"kind": "class", "name": "_Dependency", "runtime": true, "lineno": 17, "endlineno": 37, "docstring": {"value": "A class representing a (doubly-ended) queue of items.", "lineno": 18, "endlineno": 18, "parsed": [{"kind": "text", "value": "A class representing a (doubly-ended) queue of items."}]}, "members": {"head": {"kind": "attribute", "name": "head", "runtime": true, "lineno": 21, "endlineno": 26, "docstring": {"value": "Head of the dependency.", "lineno": 22, "endlineno": 22, "parsed": [{"kind": "text", "value": "Head of the dependency."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.c3linear._Dependency.head", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L21-L26", "annotation": {"left": {"member": "head", "name": "_T", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "tail": {"kind": "attribute", "name": "tail", "runtime": true, "lineno": 29, "endlineno": 37, "docstring": {"value": "Tail of the dependency.\n\nThe `islice` object is sufficient for iteration or testing membership (`in`).", "lineno": 30, "endlineno": 33, "parsed": [{"kind": "text", "value": "Tail of the dependency.\n\nThe `islice` object is sufficient for iteration or testing membership (`in`)."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.c3linear._Dependency.tail", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L29-L37", "annotation": {"member": "tail", "name": "islice", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.c3linear._Dependency", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L17-L37", "bases": [{"left": {"member": "_Dependency", "name": "deque", "cls": "ExprName"}, "slice": {"member": "_Dependency", "name": "_T", "cls": "ExprName"}, "cls": "ExprSubscript"}], "decorators": []}, "_DependencyList": {"kind": "class", "name": "_DependencyList", "runtime": true, "lineno": 40, "endlineno": 90, "docstring": {"value": "A class representing a list of linearizations (dependencies).\n\nThe last element of DependencyList is a list of parents.\nIt's needed  to the merge process preserves the local\nprecedence order of direct parent classes.", "lineno": 41, "endlineno": 46, "parsed": [{"kind": "text", "value": "A class representing a list of linearizations (dependencies).\n\nThe last element of DependencyList is a list of parents.\nIt's needed  to the merge process preserves the local\nprecedence order of direct parent classes."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 48, "endlineno": 54, "docstring": {"value": "Initialize the list.\n\nParameters:\n    *lists: Lists of items.", "lineno": 49, "endlineno": 53, "parsed": [{"kind": "parameters", "value": [{"name": "*lists", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "_T", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "description": "Lists of items.", "value": "()"}]}]}, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L48-L54", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "lists", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "_T", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "kind": "variadic positional", "default": "()"}], "returns": "None"}, "_lists": {"kind": "attribute", "name": "_lists", "runtime": true, "lineno": 54, "endlineno": 54, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.c3linear._DependencyList._lists", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L54-L54", "value": {"element": {"arguments": [{"member": null, "name": "lst", "cls": "ExprName"}], "function": {"member": null, "name": "_Dependency", "cls": "ExprName"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"member": null, "name": "lists", "cls": "ExprName"}, "target": {"member": null, "name": "lst", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprListComp"}}, "__contains__": {"kind": "function", "name": "__contains__", "runtime": true, "lineno": 56, "endlineno": 58, "docstring": {"value": "Return True if any linearization's tail contains an item.", "lineno": 57, "endlineno": 57, "parsed": [{"kind": "text", "value": "Return True if any linearization's tail contains an item."}]}, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.__contains__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L56-L58", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "item", "annotation": {"member": "__contains__", "name": "_T", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__contains__", "name": "bool", "cls": "ExprName"}}, "__len__": {"kind": "function", "name": "__len__", "runtime": true, "lineno": 60, "endlineno": 62, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.__len__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L60-L62", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__len__", "name": "int", "cls": "ExprName"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 64, "endlineno": 65, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L64-L65", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "heads": {"kind": "attribute", "name": "heads", "runtime": true, "lineno": 68, "endlineno": 70, "docstring": {"value": "Return the heads.", "lineno": 69, "endlineno": 69, "parsed": [{"kind": "text", "value": "Return the heads."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.heads", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L68-L70", "annotation": {"left": {"member": "heads", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "heads", "name": "_T", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "tails": {"kind": "attribute", "name": "tails", "runtime": true, "lineno": 73, "endlineno": 75, "docstring": {"value": "Return self so that `__contains__` could be called.", "lineno": 74, "endlineno": 74, "parsed": [{"kind": "text", "value": "Return self so that `__contains__` could be called."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.tails", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L73-L75", "annotation": {"member": "tails", "name": "_DependencyList", "cls": "ExprName"}}, "exhausted": {"kind": "attribute", "name": "exhausted", "runtime": true, "lineno": 78, "endlineno": 80, "docstring": {"value": "True if all elements of the lists are exhausted.", "lineno": 79, "endlineno": 79, "parsed": [{"kind": "text", "value": "True if all elements of the lists are exhausted."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.exhausted", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L78-L80", "annotation": {"member": "exhausted", "name": "bool", "cls": "ExprName"}}, "remove": {"kind": "function", "name": "remove", "runtime": true, "lineno": 82, "endlineno": 90, "docstring": {"value": "Remove an item from the lists.\n\nOnce an item removed from heads, the leftmost elements of the tails\nget promoted to become the new heads.", "lineno": 83, "endlineno": 87, "parsed": [{"kind": "text", "value": "Remove an item from the lists.\n\nOnce an item removed from heads, the leftmost elements of the tails\nget promoted to become the new heads."}]}, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList.remove", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L82-L90", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "item", "annotation": {"left": {"member": "remove", "name": "_T", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.c3linear._DependencyList", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L40-L90", "bases": [], "decorators": []}, "c3linear_merge": {"kind": "function", "name": "c3linear_merge", "runtime": true, "lineno": 93, "endlineno": 119, "docstring": {"value": "Merge lists of lists in the order defined by the C3Linear algorithm.\n\nParameters:\n    *lists: Lists of items.\n\nReturns:\n    The merged list of items.", "lineno": 94, "endlineno": 101, "parsed": [{"kind": "text", "value": "Merge lists of lists in the order defined by the C3Linear algorithm."}, {"kind": "parameters", "value": [{"name": "*lists", "annotation": {"left": {"member": "c3linear_merge", "name": "list", "cls": "ExprName"}, "slice": {"member": "c3linear_merge", "name": "_T", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "Lists of items.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "c3linear_merge", "name": "list", "cls": "ExprName"}, "slice": {"member": "c3linear_merge", "name": "_T", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The merged list of items."}]}]}, "analysis": "static", "path": "griffe._internal.c3linear.c3linear_merge", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/c3linear.py#L93-L119", "decorators": [], "parameters": [{"name": "lists", "annotation": {"left": {"member": "c3linear_merge", "name": "list", "cls": "ExprName"}, "slice": {"member": "c3linear_merge", "name": "_T", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "variadic positional", "default": "()"}], "returns": {"left": {"member": "c3linear_merge", "name": "list", "cls": "ExprName"}, "slice": {"member": "c3linear_merge", "name": "_T", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.c3linear", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/c3linear.py", "relative_package_filepath": "griffe/_internal/c3linear.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/c3linear.py"}, "logger": {"kind": "module", "name": "logger", "runtime": true, "imports": {"annotations": "__future__.annotations", "logging": "logging", "contextmanager": "contextlib.contextmanager", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "ClassVar": "typing.ClassVar", "Callable": "collections.abc.Callable", "Iterator": "collections.abc.Iterator"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.logger.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logging": {"kind": "alias", "name": "logging", "target_path": "logging", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.logger.logging", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "contextmanager": {"kind": "alias", "name": "contextmanager", "target_path": "contextlib.contextmanager", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.logger.contextmanager", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.logger.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.logger.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ClassVar": {"kind": "alias", "name": "ClassVar", "target_path": "typing.ClassVar", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.logger.ClassVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.logger.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.logger.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Logger": {"kind": "class", "name": "Logger", "runtime": true, "lineno": 20, "endlineno": 55, "members": {"_default_logger": {"kind": "attribute", "name": "_default_logger", "runtime": true, "lineno": 21, "endlineno": 21, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.logger.Logger._default_logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L21-L21", "value": {"values": [{"member": null, "name": "logging", "cls": "ExprName"}, {"member": null, "name": "getLogger", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "Any", "cls": "ExprName"}}, "_instances": {"kind": "attribute", "name": "_instances", "runtime": true, "lineno": 22, "endlineno": 22, "labels": ["class-attribute"], "analysis": "static", "path": "griffe._internal.logger.Logger._instances", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L22-L22", "value": {"keys": [], "values": [], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Logger", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 24, "endlineno": 26, "analysis": "static", "path": "griffe._internal.logger.Logger.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L24-L26", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_logger": {"kind": "attribute", "name": "_logger", "runtime": true, "lineno": 26, "endlineno": 26, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.logger.Logger._logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L26-L26", "value": {"arguments": [{"member": null, "name": "name", "cls": "ExprName"}], "function": {"values": [{"member": null, "name": "self", "cls": "ExprName"}, {"member": null, "name": "__class__", "cls": "ExprName"}, {"member": null, "name": "_default_logger", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}}, "__getattr__": {"kind": "function", "name": "__getattr__", "runtime": true, "lineno": 28, "endlineno": 30, "analysis": "static", "path": "griffe._internal.logger.Logger.__getattr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L28-L30", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__getattr__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "__getattr__", "name": "Any", "cls": "ExprName"}}, "disable": {"kind": "function", "name": "disable", "runtime": true, "lineno": 32, "endlineno": 40, "docstring": {"value": "Temporarily disable logging.", "lineno": 34, "endlineno": 34, "parsed": [{"kind": "text", "value": "Temporarily disable logging."}]}, "analysis": "static", "path": "griffe._internal.logger.Logger.disable", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L32-L40", "decorators": [{"value": {"member": null, "name": "contextmanager", "cls": "ExprName"}, "lineno": 32, "endlineno": 32}], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "disable", "name": "Iterator", "cls": "ExprName"}, "slice": "None", "cls": "ExprSubscript"}}, "_get": {"kind": "function", "name": "_get", "runtime": true, "lineno": 42, "endlineno": 46, "labels": ["classmethod"], "analysis": "static", "path": "griffe._internal.logger.Logger._get", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L42-L46", "decorators": [{"value": {"member": null, "name": "classmethod", "cls": "ExprName"}, "lineno": 42, "endlineno": 42}], "parameters": [{"name": "cls", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "_get", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "'griffe'"}], "returns": {"member": "_get", "name": "Logger", "cls": "ExprName"}}, "_patch_loggers": {"kind": "function", "name": "_patch_loggers", "runtime": true, "lineno": 48, "endlineno": 55, "labels": ["classmethod"], "analysis": "static", "path": "griffe._internal.logger.Logger._patch_loggers", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L48-L55", "decorators": [{"value": {"member": null, "name": "classmethod", "cls": "ExprName"}, "lineno": 48, "endlineno": 48}], "parameters": [{"name": "cls", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "get_logger_func", "annotation": {"member": "_patch_loggers", "name": "Callable", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.logger.Logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L20-L55", "bases": [], "decorators": []}, "logger": {"kind": "attribute", "name": "logger", "runtime": true, "lineno": 58, "endlineno": 58, "docstring": {"value": "Our global logger, used throughout the library.\n\nGriffe's output and error messages are logging messages.\n\nGriffe provides the [`patch_loggers`][griffe.patch_loggers]\nfunction so dependent libraries can patch Griffe loggers as they see fit.\n\nFor example, to fit in the MkDocs logging configuration\nand prefix each log message with the module name:\n\n```python\nimport logging\nfrom griffe import patch_loggers\n\n\nclass LoggerAdapter(logging.LoggerAdapter):\n    def __init__(self, prefix, logger):\n        super().__init__(logger, {})\n        self.prefix = prefix\n\n    def process(self, msg, kwargs):\n        return f\"{self.prefix}: {msg}\", kwargs\n\n\ndef get_logger(name):\n    logger = logging.getLogger(f\"mkdocs.plugins.{name}\")\n    return LoggerAdapter(name, logger)\n\n\npatch_loggers(get_logger)\n```", "lineno": 59, "endlineno": 90, "parsed": [{"kind": "text", "value": "Our global logger, used throughout the library.\n\nGriffe's output and error messages are logging messages.\n\nGriffe provides the [`patch_loggers`][griffe.patch_loggers]\nfunction so dependent libraries can patch Griffe loggers as they see fit.\n\nFor example, to fit in the MkDocs logging configuration\nand prefix each log message with the module name:\n\n```python\nimport logging\nfrom griffe import patch_loggers\n\n\nclass LoggerAdapter(logging.LoggerAdapter):\n    def __init__(self, prefix, logger):\n        super().__init__(logger, {})\n        self.prefix = prefix\n\n    def process(self, msg, kwargs):\n        return f\"{self.prefix}: {msg}\", kwargs\n\n\ndef get_logger(name):\n    logger = logging.getLogger(f\"mkdocs.plugins.{name}\")\n    return LoggerAdapter(name, logger)\n\n\npatch_loggers(get_logger)\n```"}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.logger.logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L58-L58", "value": {"arguments": [], "function": {"values": [{"member": null, "name": "Logger", "cls": "ExprName"}, {"member": null, "name": "_get", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Logger", "cls": "ExprName"}}, "get_logger": {"kind": "function", "name": "get_logger", "runtime": true, "lineno": 93, "endlineno": 102, "docstring": {"value": "Create and return a new logger instance.\n\nParameters:\n    name: The logger name.\n\nReturns:\n    The logger.", "lineno": 94, "endlineno": 101, "parsed": [{"kind": "text", "value": "Create and return a new logger instance."}, {"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "get_logger", "name": "str", "cls": "ExprName"}, "description": "The logger name.", "value": "'griffe'"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "get_logger", "name": "Logger", "cls": "ExprName"}, "description": "The logger."}]}]}, "analysis": "static", "path": "griffe._internal.logger.get_logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L93-L102", "decorators": [], "parameters": [{"name": "name", "annotation": {"member": "get_logger", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": "'griffe'"}], "returns": {"member": "get_logger", "name": "Logger", "cls": "ExprName"}}, "patch_loggers": {"kind": "function", "name": "patch_loggers", "runtime": true, "lineno": 105, "endlineno": 111, "docstring": {"value": "Patch Griffe logger and Griffe extensions' loggers.\n\nParameters:\n    get_logger_func: A function accepting a name as parameter and returning a logger.", "lineno": 106, "endlineno": 110, "parsed": [{"kind": "text", "value": "Patch Griffe logger and Griffe extensions' loggers."}, {"kind": "parameters", "value": [{"name": "get_logger_func", "annotation": {"left": {"member": "patch_loggers", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": "patch_loggers", "name": "str", "cls": "ExprName"}], "cls": "ExprList"}, {"member": "patch_loggers", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A function accepting a name as parameter and returning a logger."}]}]}, "analysis": "static", "path": "griffe._internal.logger.patch_loggers", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/logger.py#L105-L111", "decorators": [], "parameters": [{"name": "get_logger_func", "annotation": {"left": {"member": "patch_loggers", "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": "patch_loggers", "name": "str", "cls": "ExprName"}], "cls": "ExprList"}, {"member": "patch_loggers", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.logger", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/logger.py", "relative_package_filepath": "griffe/_internal/logger.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/logger.py"}, "agents": {"kind": "module", "name": "agents", "runtime": true, "members": {"visitor": {"kind": "module", "name": "visitor", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "sys": "sys", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Final": "typing.Final", "get_instance_names": "griffe._internal.agents.nodes.assignments.get_instance_names", "get_names": "griffe._internal.agents.nodes.assignments.get_names", "ast_children": "griffe._internal.agents.nodes.ast.ast_children", "ast_kind": "griffe._internal.agents.nodes.ast.ast_kind", "ast_next": "griffe._internal.agents.nodes.ast.ast_next", "get_docstring": "griffe._internal.agents.nodes.docstrings.get_docstring", "safe_get__all__": "griffe._internal.agents.nodes.exports.safe_get__all__", "relative_to_absolute": "griffe._internal.agents.nodes.imports.relative_to_absolute", "get_parameters": "griffe._internal.agents.nodes.parameters.get_parameters", "LinesCollection": "griffe._internal.collections.LinesCollection", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "Kind": "griffe._internal.enumerations.Kind", "TypeParameterKind": "griffe._internal.enumerations.TypeParameterKind", "AliasResolutionError": "griffe._internal.exceptions.AliasResolutionError", "CyclicAliasError": "griffe._internal.exceptions.CyclicAliasError", "LastNodeError": "griffe._internal.exceptions.LastNodeError", "Expr": "griffe._internal.expressions.Expr", "ExprName": "griffe._internal.expressions.ExprName", "safe_get_annotation": "griffe._internal.expressions.safe_get_annotation", "safe_get_base_class": "griffe._internal.expressions.safe_get_base_class", "safe_get_class_keyword": "griffe._internal.expressions.safe_get_class_keyword", "safe_get_condition": "griffe._internal.expressions.safe_get_condition", "safe_get_expression": "griffe._internal.expressions.safe_get_expression", "Extensions": "griffe._internal.extensions.base.Extensions", "load_extensions": "griffe._internal.extensions.base.load_extensions", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Decorator": "griffe._internal.models.Decorator", "Docstring": "griffe._internal.models.Docstring", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters", "TypeAlias": "griffe._internal.models.TypeAlias", "TypeParameter": "griffe._internal.models.TypeParameter", "TypeParameters": "griffe._internal.models.TypeParameters", "Path": "pathlib.Path", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "Parser": "griffe._internal.enumerations.Parser"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.agents.visitor.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.visitor.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.visitor.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.agents.visitor.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.visitor.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Final": {"kind": "alias", "name": "Final", "target_path": "typing.Final", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.visitor.Final", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_instance_names": {"kind": "alias", "name": "get_instance_names", "target_path": "griffe._internal.agents.nodes.assignments.get_instance_names", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.visitor.get_instance_names", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_names": {"kind": "alias", "name": "get_names", "target_path": "griffe._internal.agents.nodes.assignments.get_names", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.visitor.get_names", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast_children": {"kind": "alias", "name": "ast_children", "target_path": "griffe._internal.agents.nodes.ast.ast_children", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.visitor.ast_children", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast_kind": {"kind": "alias", "name": "ast_kind", "target_path": "griffe._internal.agents.nodes.ast.ast_kind", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.visitor.ast_kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast_next": {"kind": "alias", "name": "ast_next", "target_path": "griffe._internal.agents.nodes.ast.ast_next", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.visitor.ast_next", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_docstring": {"kind": "alias", "name": "get_docstring", "target_path": "griffe._internal.agents.nodes.docstrings.get_docstring", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.visitor.get_docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get__all__": {"kind": "alias", "name": "safe_get__all__", "target_path": "griffe._internal.agents.nodes.exports.safe_get__all__", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get__all__", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "relative_to_absolute": {"kind": "alias", "name": "relative_to_absolute", "target_path": "griffe._internal.agents.nodes.imports.relative_to_absolute", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.agents.visitor.relative_to_absolute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_parameters": {"kind": "alias", "name": "get_parameters", "target_path": "griffe._internal.agents.nodes.parameters.get_parameters", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.agents.visitor.get_parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.agents.visitor.LinesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.agents.visitor.ModulesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.agents.visitor.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameterKind": {"kind": "alias", "name": "TypeParameterKind", "target_path": "griffe._internal.enumerations.TypeParameterKind", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.agents.visitor.TypeParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AliasResolutionError": {"kind": "alias", "name": "AliasResolutionError", "target_path": "griffe._internal.exceptions.AliasResolutionError", "runtime": true, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.agents.visitor.AliasResolutionError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "CyclicAliasError": {"kind": "alias", "name": "CyclicAliasError", "target_path": "griffe._internal.exceptions.CyclicAliasError", "runtime": true, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.agents.visitor.CyclicAliasError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LastNodeError": {"kind": "alias", "name": "LastNodeError", "target_path": "griffe._internal.exceptions.LastNodeError", "runtime": true, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.agents.visitor.LastNodeError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.ExprName", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_annotation": {"kind": "alias", "name": "safe_get_annotation", "target_path": "griffe._internal.expressions.safe_get_annotation", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_base_class": {"kind": "alias", "name": "safe_get_base_class", "target_path": "griffe._internal.expressions.safe_get_base_class", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get_base_class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_class_keyword": {"kind": "alias", "name": "safe_get_class_keyword", "target_path": "griffe._internal.expressions.safe_get_class_keyword", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get_class_keyword", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_condition": {"kind": "alias", "name": "safe_get_condition", "target_path": "griffe._internal.expressions.safe_get_condition", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get_condition", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_expression": {"kind": "alias", "name": "safe_get_expression", "target_path": "griffe._internal.expressions.safe_get_expression", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 32, "analysis": "static", "path": "griffe._internal.agents.visitor.safe_get_expression", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Extensions": {"kind": "alias", "name": "Extensions", "target_path": "griffe._internal.extensions.base.Extensions", "runtime": true, "inherited": false, "lineno": 33, "endlineno": 33, "analysis": "static", "path": "griffe._internal.agents.visitor.Extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "load_extensions": {"kind": "alias", "name": "load_extensions", "target_path": "griffe._internal.extensions.base.load_extensions", "runtime": true, "inherited": false, "lineno": 33, "endlineno": 33, "analysis": "static", "path": "griffe._internal.agents.visitor.load_extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Decorator": {"kind": "alias", "name": "Decorator", "target_path": "griffe._internal.models.Decorator", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Decorator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Parameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.Parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameter": {"kind": "alias", "name": "TypeParameter", "target_path": "griffe._internal.models.TypeParameter", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.TypeParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameters": {"kind": "alias", "name": "TypeParameters", "target_path": "griffe._internal.models.TypeParameters", "runtime": true, "inherited": false, "lineno": 34, "endlineno": 47, "analysis": "static", "path": "griffe._internal.agents.visitor.TypeParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 50, "endlineno": 50, "analysis": "static", "path": "griffe._internal.agents.visitor.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": false, "inherited": false, "lineno": 52, "endlineno": 52, "analysis": "static", "path": "griffe._internal.agents.visitor.DocstringOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": false, "inherited": false, "lineno": 52, "endlineno": 52, "analysis": "static", "path": "griffe._internal.agents.visitor.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": false, "inherited": false, "lineno": 53, "endlineno": 53, "analysis": "static", "path": "griffe._internal.agents.visitor.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "builtin_decorators": {"kind": "attribute", "name": "builtin_decorators", "runtime": true, "lineno": 56, "endlineno": 60, "docstring": {"value": "Mapping of builtin decorators to labels.", "lineno": 61, "endlineno": 61, "parsed": [{"kind": "text", "value": "Mapping of builtin decorators to labels."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.builtin_decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L56-L60", "value": {"keys": ["'property'", "'staticmethod'", "'classmethod'"], "values": ["'property'", "'staticmethod'", "'classmethod'"], "cls": "ExprDict"}}, "stdlib_decorators": {"kind": "attribute", "name": "stdlib_decorators", "runtime": true, "lineno": 63, "endlineno": 70, "docstring": {"value": "Mapping of standard library decorators to labels.", "lineno": 71, "endlineno": 71, "parsed": [{"kind": "text", "value": "Mapping of standard library decorators to labels."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.stdlib_decorators", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L63-L70", "value": {"keys": ["'abc.abstractmethod'", "'functools.cache'", "'functools.cached_property'", "'cached_property.cached_property'", "'functools.lru_cache'", "'dataclasses.dataclass'"], "values": [{"elements": ["'abstractmethod'"], "cls": "ExprSet"}, {"elements": ["'cached'"], "cls": "ExprSet"}, {"elements": ["'cached'", "'property'"], "cls": "ExprSet"}, {"elements": ["'cached'", "'property'"], "cls": "ExprSet"}, {"elements": ["'cached'"], "cls": "ExprSet"}, {"elements": ["'dataclass'"], "cls": "ExprSet"}], "cls": "ExprDict"}}, "typing_overload": {"kind": "attribute", "name": "typing_overload", "runtime": true, "lineno": 73, "endlineno": 73, "docstring": {"value": "Set of recognized typing overload decorators.\n\nWhen such a decorator is found, the decorated function becomes an overload.", "lineno": 74, "endlineno": 77, "parsed": [{"kind": "text", "value": "Set of recognized typing overload decorators.\n\nWhen such a decorator is found, the decorated function becomes an overload."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.typing_overload", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L73-L73", "value": {"elements": ["'typing.overload'", "'typing_extensions.overload'"], "cls": "ExprSet"}}, "visit": {"kind": "function", "name": "visit", "runtime": true, "lineno": 80, "endlineno": 128, "docstring": {"value": "Parse and visit a module file.\n\nWe provide this function for static analysis. It uses a [`NodeVisitor`][ast.NodeVisitor]-like class,\nthe [`Visitor`][griffe.Visitor], to compile and parse code (using [`compile`][])\nthen visit the resulting AST (Abstract Syntax Tree).\n\nImportant:\n    This function is generally not used directly.\n    In most cases, users can rely on the [`GriffeLoader`][griffe.GriffeLoader]\n    and its accompanying [`load`][griffe.load] shortcut and their respective options\n    to load modules using static analysis.\n\nParameters:\n    module_name: The module name (as when importing [from] it).\n    filepath: The module file path.\n    code: The module contents.\n    extensions: The extensions to use when visiting the AST.\n    parent: The optional parent of this module.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n\nReturns:\n    The module, with its members populated.", "lineno": 92, "endlineno": 117, "parsed": [{"kind": "text", "value": "Parse and visit a module file.\n\nWe provide this function for static analysis. It uses a [`NodeVisitor`][ast.NodeVisitor]-like class,\nthe [`Visitor`][griffe.Visitor], to compile and parse code (using [`compile`][])\nthen visit the resulting AST (Abstract Syntax Tree)."}, {"kind": "admonition", "value": {"annotation": "important", "description": "This function is generally not used directly.\nIn most cases, users can rely on the [`GriffeLoader`][griffe.GriffeLoader]\nand its accompanying [`load`][griffe.load] shortcut and their respective options\nto load modules using static analysis."}, "title": "Important"}, {"kind": "parameters", "value": [{"name": "module_name", "annotation": {"member": "visit", "name": "str", "cls": "ExprName"}, "description": "The module name (as when importing [from] it)."}, {"name": "filepath", "annotation": {"member": "visit", "name": "Path", "cls": "ExprName"}, "description": "The module file path."}, {"name": "code", "annotation": {"member": "visit", "name": "str", "cls": "ExprName"}, "description": "The module contents."}, {"name": "extensions", "annotation": {"left": {"member": "visit", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use when visiting the AST.", "value": "None"}, {"name": "parent", "annotation": {"left": {"member": "visit", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The optional parent of this module.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "visit", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "visit", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "visit", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "visit", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "visit", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "visit", "name": "Module", "cls": "ExprName"}, "description": "The module, with its members populated."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.visit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L80-L128", "decorators": [], "parameters": [{"name": "module_name", "annotation": {"member": "visit", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"member": "visit", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "code", "annotation": {"member": "visit", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"left": {"member": "visit", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "visit", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "visit", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "visit", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "visit", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "visit", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "visit", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "visit", "name": "Module", "cls": "ExprName"}}, "Visitor": {"kind": "class", "name": "Visitor", "runtime": true, "lineno": 131, "endlineno": 768, "docstring": {"value": "This class is used to instantiate a visitor.\n\nVisitors iterate on AST nodes to extract data from them.", "lineno": 132, "endlineno": 135, "parsed": [{"kind": "text", "value": "This class is used to instantiate a visitor.\n\nVisitors iterate on AST nodes to extract data from them."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 137, "endlineno": 195, "docstring": {"value": "Initialize the visitor.\n\nParameters:\n    module_name: The module name.\n    filepath: The module filepath.\n    code: The module source code.\n    extensions: The extensions to use when visiting.\n    parent: An optional parent for the final module object.\n    docstring_parser: The docstring parser to use.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.", "lineno": 149, "endlineno": 161, "parsed": [{"kind": "parameters", "value": [{"name": "module_name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The module name."}, {"name": "filepath", "annotation": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "description": "The module filepath."}, {"name": "code", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The module source code."}, {"name": "extensions", "annotation": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "description": "The extensions to use when visiting."}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional parent for the final module object.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L137-L195", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "code", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "module_name": {"kind": "attribute", "name": "module_name", "runtime": true, "lineno": 164, "endlineno": 164, "docstring": {"value": "The module name.", "lineno": 165, "endlineno": 165, "parsed": [{"kind": "text", "value": "The module name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.module_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L164-L164", "value": {"member": null, "name": "module_name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "filepath": {"kind": "attribute", "name": "filepath", "runtime": true, "lineno": 167, "endlineno": 167, "docstring": {"value": "The module filepath.", "lineno": 168, "endlineno": 168, "parsed": [{"kind": "text", "value": "The module filepath."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L167-L167", "value": {"member": null, "name": "filepath", "cls": "ExprName"}, "annotation": {"member": null, "name": "Path", "cls": "ExprName"}}, "code": {"kind": "attribute", "name": "code", "runtime": true, "lineno": 170, "endlineno": 170, "docstring": {"value": "The module source code.", "lineno": 171, "endlineno": 171, "parsed": [{"kind": "text", "value": "The module source code."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.code", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L170-L170", "value": {"member": null, "name": "code", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "extensions": {"kind": "attribute", "name": "extensions", "runtime": true, "lineno": 173, "endlineno": 173, "docstring": {"value": "The extensions to use when visiting the AST.", "lineno": 174, "endlineno": 174, "parsed": [{"kind": "text", "value": "The extensions to use when visiting the AST."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L173-L173", "value": {"member": null, "name": "extensions", "cls": "ExprName"}, "annotation": {"member": null, "name": "Extensions", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 176, "endlineno": 176, "docstring": {"value": "An optional parent for the final module object.", "lineno": 177, "endlineno": 177, "parsed": [{"kind": "text", "value": "An optional parent for the final module object."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L176-L176", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "current": {"kind": "attribute", "name": "current", "runtime": true, "lineno": 179, "endlineno": 179, "docstring": {"value": "The current object being visited.", "lineno": 180, "endlineno": 180, "parsed": [{"kind": "text", "value": "The current object being visited."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.current", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L179-L179", "value": "None", "annotation": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "docstring_parser": {"kind": "attribute", "name": "docstring_parser", "runtime": true, "lineno": 182, "endlineno": 182, "docstring": {"value": "The docstring parser to use.", "lineno": 183, "endlineno": 183, "parsed": [{"kind": "text", "value": "The docstring parser to use."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.docstring_parser", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L182-L182", "value": {"member": null, "name": "docstring_parser", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring_options": {"kind": "attribute", "name": "docstring_options", "runtime": true, "lineno": 185, "endlineno": 185, "docstring": {"value": "The docstring parsing options.", "lineno": 186, "endlineno": 186, "parsed": [{"kind": "text", "value": "The docstring parsing options."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.docstring_options", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L185-L185", "value": {"operator": "or", "values": [{"member": null, "name": "docstring_options", "cls": "ExprName"}, {"keys": [], "values": [], "cls": "ExprDict"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "DocstringOptions", "cls": "ExprName"}}, "lines_collection": {"kind": "attribute", "name": "lines_collection", "runtime": true, "lineno": 188, "endlineno": 188, "docstring": {"value": "A collection of source code lines.", "lineno": 189, "endlineno": 189, "parsed": [{"kind": "text", "value": "A collection of source code lines."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L188-L188", "value": {"operator": "or", "values": [{"member": null, "name": "lines_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "LinesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "LinesCollection", "cls": "ExprName"}}, "modules_collection": {"kind": "attribute", "name": "modules_collection", "runtime": true, "lineno": 191, "endlineno": 191, "docstring": {"value": "A collection of modules.", "lineno": 192, "endlineno": 192, "parsed": [{"kind": "text", "value": "A collection of modules."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L191-L191", "value": {"operator": "or", "values": [{"member": null, "name": "modules_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}}, "type_guarded": {"kind": "attribute", "name": "type_guarded", "runtime": true, "lineno": 194, "endlineno": 194, "docstring": {"value": "Whether the current code branch is type-guarded.", "lineno": 195, "endlineno": 195, "parsed": [{"kind": "text", "value": "Whether the current code branch is type-guarded."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.type_guarded", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L194-L194", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "_get_docstring": {"kind": "function", "name": "_get_docstring", "runtime": true, "lineno": 197, "endlineno": 207, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor._get_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L197-L207", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "_get_docstring", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "strict", "annotation": {"member": "_get_docstring", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "_get_docstring", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_type_parameter_kind_map": {"kind": "attribute", "name": "_type_parameter_kind_map", "runtime": true, "lineno": 211, "endlineno": 215, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor._type_parameter_kind_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L211-L215", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "TypeVar", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "TypeVarTuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ParamSpec", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "type_var", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "type_var_tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "param_spec", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "Final", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": null, "name": "type", "cls": "ExprName"}, "slice": {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "type_param", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprSubscript"}, {"member": null, "name": "TypeParameterKind", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}}, "_get_type_parameters": {"kind": "function", "name": "_get_type_parameters", "runtime": true, "lineno": 238, "endlineno": 244, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor._get_type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L238-L244", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"left": {"values": [{"member": "_get_type_parameters", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "_get_type_parameters", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AsyncFunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "_get_type_parameters", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ClassDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "scope", "annotation": {"left": {"member": "_get_type_parameters", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "_get_type_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_type_parameters", "name": "TypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "get_module": {"kind": "function", "name": "get_module", "runtime": true, "lineno": 246, "endlineno": 258, "docstring": {"value": "Build and return the object representing the module attached to this visitor.\n\nThis method triggers a complete visit of the module nodes.\n\nReturns:\n    A module instance.", "lineno": 247, "endlineno": 253, "parsed": [{"kind": "text", "value": "Build and return the object representing the module attached to this visitor.\n\nThis method triggers a complete visit of the module nodes."}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "get_module", "name": "Module", "cls": "ExprName"}, "description": "A module instance."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.get_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L246-L258", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "get_module", "name": "Module", "cls": "ExprName"}}, "visit": {"kind": "function", "name": "visit", "runtime": true, "lineno": 260, "endlineno": 266, "docstring": {"value": "Extend the base visit with extensions.\n\nParameters:\n    node: The node to visit.", "lineno": 261, "endlineno": 265, "parsed": [{"kind": "text", "value": "Extend the base visit with extensions."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L260-L266", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "generic_visit": {"kind": "function", "name": "generic_visit", "runtime": true, "lineno": 268, "endlineno": 275, "docstring": {"value": "Extend the base generic visit with extensions.\n\nParameters:\n    node: The node to visit.", "lineno": 269, "endlineno": 273, "parsed": [{"kind": "text", "value": "Extend the base generic visit with extensions."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "generic_visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.generic_visit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L268-L275", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "generic_visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_module": {"kind": "function", "name": "visit_module", "runtime": true, "lineno": 277, "endlineno": 298, "docstring": {"value": "Visit a module node.\n\nParameters:\n    node: The node to visit.", "lineno": 278, "endlineno": 282, "parsed": [{"kind": "text", "value": "Visit a module node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_module", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Module", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L277-L298", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_module", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Module", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_classdef": {"kind": "function", "name": "visit_classdef", "runtime": true, "lineno": 300, "endlineno": 351, "docstring": {"value": "Visit a class definition node.\n\nParameters:\n    node: The node to visit.", "lineno": 301, "endlineno": 305, "parsed": [{"kind": "text", "value": "Visit a class definition node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_classdef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ClassDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_classdef", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L300-L351", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_classdef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ClassDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "decorators_to_labels": {"kind": "function", "name": "decorators_to_labels", "runtime": true, "lineno": 353, "endlineno": 369, "docstring": {"value": "Build and return a set of labels based on decorators.\n\nParameters:\n    decorators: The decorators to check.\n\nReturns:\n    A set of labels.", "lineno": 354, "endlineno": 361, "parsed": [{"kind": "text", "value": "Build and return a set of labels based on decorators."}, {"kind": "parameters", "value": [{"name": "decorators", "annotation": {"left": {"member": "decorators_to_labels", "name": "list", "cls": "ExprName"}, "slice": {"member": "decorators_to_labels", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The decorators to check."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "decorators_to_labels", "name": "set", "cls": "ExprName"}, "slice": {"member": "decorators_to_labels", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A set of labels."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.decorators_to_labels", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L353-L369", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "decorators", "annotation": {"left": {"member": "decorators_to_labels", "name": "list", "cls": "ExprName"}, "slice": {"member": "decorators_to_labels", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "decorators_to_labels", "name": "set", "cls": "ExprName"}, "slice": {"member": "decorators_to_labels", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "get_base_property": {"kind": "function", "name": "get_base_property", "runtime": true, "lineno": 371, "endlineno": 393, "docstring": {"value": "Check decorators to return the base property in case of setters and deleters.\n\nParameters:\n    decorators: The decorators to check.\n\nReturns:\n    base_property: The property for which the setter/deleted is set.\n    property_function: Either `\"setter\"` or `\"deleter\"`.", "lineno": 372, "endlineno": 380, "parsed": [{"kind": "text", "value": "Check decorators to return the base property in case of setters and deleters."}, {"kind": "parameters", "value": [{"name": "decorators", "annotation": {"left": {"member": "get_base_property", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_base_property", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The decorators to check."}]}, {"kind": "returns", "value": [{"name": "base_property", "annotation": {"left": {"member": "get_base_property", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The property for which the setter/deleted is set."}, {"name": "property_function", "annotation": {"left": {"member": "get_base_property", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Either `\"setter\"` or `\"deleter\"`."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.get_base_property", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L371-L393", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "decorators", "annotation": {"left": {"member": "get_base_property", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_base_property", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "function", "annotation": {"member": "get_base_property", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get_base_property", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "handle_function": {"kind": "function", "name": "handle_function", "runtime": true, "lineno": 395, "endlineno": 499, "docstring": {"value": "Handle a function definition node.\n\nParameters:\n    node: The node to visit.\n    labels: Labels to add to the data object.", "lineno": 396, "endlineno": 401, "parsed": [{"kind": "text", "value": "Handle a function definition node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "handle_function", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AsyncFunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "handle_function", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "description": "The node to visit."}, {"name": "labels", "annotation": {"left": {"member": "handle_function", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Labels to add to the data object.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.handle_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L395-L499", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "handle_function", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AsyncFunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "handle_function", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "labels", "annotation": {"left": {"member": "handle_function", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "visit_functiondef": {"kind": "function", "name": "visit_functiondef", "runtime": true, "lineno": 501, "endlineno": 507, "docstring": {"value": "Visit a function definition node.\n\nParameters:\n    node: The node to visit.", "lineno": 502, "endlineno": 506, "parsed": [{"kind": "text", "value": "Visit a function definition node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_functiondef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_functiondef", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L501-L507", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_functiondef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "FunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_asyncfunctiondef": {"kind": "function", "name": "visit_asyncfunctiondef", "runtime": true, "lineno": 509, "endlineno": 515, "docstring": {"value": "Visit an async function definition node.\n\nParameters:\n    node: The node to visit.", "lineno": 510, "endlineno": 514, "parsed": [{"kind": "text", "value": "Visit an async function definition node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_asyncfunctiondef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AsyncFunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_asyncfunctiondef", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L509-L515", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_asyncfunctiondef", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AsyncFunctionDef", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_typealias": {"kind": "function", "name": "visit_typealias", "runtime": true, "lineno": 520, "endlineno": 554, "docstring": {"value": "Visit a type alias node.\n\nParameters:\n    node: The node to visit.", "lineno": 521, "endlineno": 525, "parsed": [{"kind": "text", "value": "Visit a type alias node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_typealias", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "TypeAlias", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_typealias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L520-L554", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_typealias", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "TypeAlias", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_import": {"kind": "function", "name": "visit_import", "runtime": true, "lineno": 556, "endlineno": 575, "docstring": {"value": "Visit an import node.\n\nParameters:\n    node: The node to visit.", "lineno": 557, "endlineno": 561, "parsed": [{"kind": "text", "value": "Visit an import node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_import", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Import", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_import", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L556-L575", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_import", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Import", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_importfrom": {"kind": "function", "name": "visit_importfrom", "runtime": true, "lineno": 577, "endlineno": 611, "docstring": {"value": "Visit an \"import from\" node.\n\nParameters:\n    node: The node to visit.", "lineno": 578, "endlineno": 582, "parsed": [{"kind": "text", "value": "Visit an \"import from\" node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_importfrom", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ImportFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_importfrom", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L577-L611", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_importfrom", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ImportFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "handle_attribute": {"kind": "function", "name": "handle_attribute", "runtime": true, "lineno": 613, "endlineno": 718, "docstring": {"value": "Handle an attribute (assignment) node.\n\nParameters:\n    node: The node to visit.\n    annotation: A potential annotation.", "lineno": 618, "endlineno": 623, "parsed": [{"kind": "text", "value": "Handle an attribute (assignment) node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "handle_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "handle_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "description": "The node to visit."}, {"name": "annotation", "annotation": {"left": {"left": {"member": "handle_attribute", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "handle_attribute", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A potential annotation.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.handle_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L613-L718", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "handle_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "handle_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": "handle_attribute", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "handle_attribute", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "visit_assign": {"kind": "function", "name": "visit_assign", "runtime": true, "lineno": 720, "endlineno": 726, "docstring": {"value": "Visit an assignment node.\n\nParameters:\n    node: The node to visit.", "lineno": 721, "endlineno": 725, "parsed": [{"kind": "text", "value": "Visit an assignment node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_assign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_assign", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L720-L726", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_assign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_annassign": {"kind": "function", "name": "visit_annassign", "runtime": true, "lineno": 728, "endlineno": 734, "docstring": {"value": "Visit an annotated assignment node.\n\nParameters:\n    node: The node to visit.", "lineno": 729, "endlineno": 733, "parsed": [{"kind": "text", "value": "Visit an annotated assignment node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_annassign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_annassign", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L728-L734", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_annassign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_augassign": {"kind": "function", "name": "visit_augassign", "runtime": true, "lineno": 736, "endlineno": 755, "docstring": {"value": "Visit an augmented assignment node.\n\nParameters:\n    node: The node to visit.", "lineno": 737, "endlineno": 741, "parsed": [{"kind": "text", "value": "Visit an augmented assignment node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_augassign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_augassign", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L736-L755", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_augassign", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "visit_if": {"kind": "function", "name": "visit_if", "runtime": true, "lineno": 757, "endlineno": 768, "docstring": {"value": "Visit an \"if\" node.\n\nParameters:\n    node: The node to visit.", "lineno": 758, "endlineno": 762, "parsed": [{"kind": "text", "value": "Visit an \"if\" node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit_if", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "If", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor.visit_if", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L757-L768", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit_if", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "If", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.agents.visitor.Visitor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/visitor.py#L131-L768", "bases": [], "decorators": []}}, "analysis": "static", "path": "griffe._internal.agents.visitor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/visitor.py", "relative_package_filepath": "griffe/_internal/agents/visitor.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/visitor.py"}, "inspector": {"kind": "module", "name": "inspector", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "functools": "functools", "types": "types", "typing": "typing", "SignatureParameter": "inspect.Parameter", "Signature": "inspect.Signature", "cleandoc": "inspect.cleandoc", "getsourcelines": "inspect.getsourcelines", "unwrap": "inspect.unwrap", "getsignature": "inspect.signature", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "ObjectNode": "griffe._internal.agents.nodes.runtime.ObjectNode", "LinesCollection": "griffe._internal.collections.LinesCollection", "ModulesCollection": "griffe._internal.collections.ModulesCollection", "Kind": "griffe._internal.enumerations.Kind", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "TypeParameterKind": "griffe._internal.enumerations.TypeParameterKind", "Expr": "griffe._internal.expressions.Expr", "ExprBinOp": "griffe._internal.expressions.ExprBinOp", "ExprSubscript": "griffe._internal.expressions.ExprSubscript", "ExprTuple": "griffe._internal.expressions.ExprTuple", "safe_get_annotation": "griffe._internal.expressions.safe_get_annotation", "Extensions": "griffe._internal.extensions.base.Extensions", "load_extensions": "griffe._internal.extensions.base.load_extensions", "dynamic_import": "griffe._internal.importer.dynamic_import", "logger": "griffe._internal.logger.logger", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Docstring": "griffe._internal.models.Docstring", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters", "TypeAlias": "griffe._internal.models.TypeAlias", "TypeParameter": "griffe._internal.models.TypeParameter", "TypeParameters": "griffe._internal.models.TypeParameters", "Sequence": "collections.abc.Sequence", "Path": "pathlib.Path", "DocstringOptions": "griffe._internal.docstrings.parsers.DocstringOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "Parser": "griffe._internal.enumerations.Parser", "typing_extensions": "typing_extensions"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.agents.inspector.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.inspector.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "functools": {"kind": "alias", "name": "functools", "target_path": "functools", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.inspector.functools", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "types": {"kind": "alias", "name": "types", "target_path": "types", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.agents.inspector.types", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "typing": {"kind": "alias", "name": "typing", "target_path": "typing", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.inspector.typing", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "SignatureParameter": {"kind": "alias", "name": "SignatureParameter", "target_path": "inspect.Parameter", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.inspector.SignatureParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Signature": {"kind": "alias", "name": "Signature", "target_path": "inspect.Signature", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.inspector.Signature", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cleandoc": {"kind": "alias", "name": "cleandoc", "target_path": "inspect.cleandoc", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.inspector.cleandoc", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "getsourcelines": {"kind": "alias", "name": "getsourcelines", "target_path": "inspect.getsourcelines", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.inspector.getsourcelines", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "unwrap": {"kind": "alias", "name": "unwrap", "target_path": "inspect.unwrap", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.inspector.unwrap", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "getsignature": {"kind": "alias", "name": "getsignature", "target_path": "inspect.signature", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.agents.inspector.getsignature", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.agents.inspector.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.agents.inspector.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ObjectNode": {"kind": "alias", "name": "ObjectNode", "target_path": "griffe._internal.agents.nodes.runtime.ObjectNode", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.agents.inspector.ObjectNode", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LinesCollection": {"kind": "alias", "name": "LinesCollection", "target_path": "griffe._internal.collections.LinesCollection", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.inspector.LinesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ModulesCollection": {"kind": "alias", "name": "ModulesCollection", "target_path": "griffe._internal.collections.ModulesCollection", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.inspector.ModulesCollection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Kind": {"kind": "alias", "name": "Kind", "target_path": "griffe._internal.enumerations.Kind", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.inspector.Kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.inspector.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameterKind": {"kind": "alias", "name": "TypeParameterKind", "target_path": "griffe._internal.enumerations.TypeParameterKind", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.inspector.TypeParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.inspector.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprBinOp": {"kind": "alias", "name": "ExprBinOp", "target_path": "griffe._internal.expressions.ExprBinOp", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.inspector.ExprBinOp", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprSubscript": {"kind": "alias", "name": "ExprSubscript", "target_path": "griffe._internal.expressions.ExprSubscript", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.inspector.ExprSubscript", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprTuple": {"kind": "alias", "name": "ExprTuple", "target_path": "griffe._internal.expressions.ExprTuple", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.inspector.ExprTuple", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_annotation": {"kind": "alias", "name": "safe_get_annotation", "target_path": "griffe._internal.expressions.safe_get_annotation", "runtime": true, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.agents.inspector.safe_get_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Extensions": {"kind": "alias", "name": "Extensions", "target_path": "griffe._internal.extensions.base.Extensions", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.agents.inspector.Extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "load_extensions": {"kind": "alias", "name": "load_extensions", "target_path": "griffe._internal.extensions.base.load_extensions", "runtime": true, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.agents.inspector.load_extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dynamic_import": {"kind": "alias", "name": "dynamic_import", "target_path": "griffe._internal.importer.dynamic_import", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.agents.inspector.dynamic_import", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.agents.inspector.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Parameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.Parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameter": {"kind": "alias", "name": "TypeParameter", "target_path": "griffe._internal.models.TypeParameter", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.TypeParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypeParameters": {"kind": "alias", "name": "TypeParameters", "target_path": "griffe._internal.models.TypeParameters", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 34, "analysis": "static", "path": "griffe._internal.agents.inspector.TypeParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 37, "endlineno": 37, "analysis": "static", "path": "griffe._internal.agents.inspector.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 38, "endlineno": 38, "analysis": "static", "path": "griffe._internal.agents.inspector.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringOptions": {"kind": "alias", "name": "DocstringOptions", "target_path": "griffe._internal.docstrings.parsers.DocstringOptions", "runtime": false, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.agents.inspector.DocstringOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": false, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.agents.inspector.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": false, "inherited": false, "lineno": 41, "endlineno": 41, "analysis": "static", "path": "griffe._internal.agents.inspector.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_TYPING_MODULES": {"kind": "attribute", "name": "_TYPING_MODULES", "runtime": true, "lineno": 49, "endlineno": 49, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector._TYPING_MODULES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L49-L49", "value": {"elements": [{"member": null, "name": "typing", "cls": "ExprName"}, {"member": null, "name": "typing_extensions", "cls": "ExprName"}], "implicit": false, "cls": "ExprTuple"}, "annotation": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"values": [{"member": null, "name": "types", "cls": "ExprName"}, {"member": null, "name": "ModuleType", "cls": "ExprName"}], "cls": "ExprAttribute"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "typing_extensions": {"kind": "alias", "name": "typing_extensions", "target_path": "typing_extensions", "runtime": true, "inherited": false, "lineno": 45, "endlineno": 45, "analysis": "static", "path": "griffe._internal.agents.inspector.typing_extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_empty": {"kind": "attribute", "name": "_empty", "runtime": true, "lineno": 51, "endlineno": 51, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector._empty", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L51-L51", "value": {"values": [{"member": null, "name": "Signature", "cls": "ExprName"}, {"member": null, "name": "empty", "cls": "ExprName"}], "cls": "ExprAttribute"}}, "inspect": {"kind": "function", "name": "inspect", "runtime": true, "lineno": 54, "endlineno": 113, "docstring": {"value": "Inspect a module.\n\nSometimes we cannot get the source code of a module or an object,\ntypically built-in modules like `itertools`.\nThe only way to know what they are made of is to actually import them and inspect their contents.\n\nSometimes, even if the source code is available,\nloading the object is desired because it was created or modified dynamically,\nand our static agent is not powerful enough to infer all these dynamic modifications.\nIn this case, we load the module using introspection.\n\nGriffe therefore provides this function for dynamic analysis.\nIt uses a [`NodeVisitor`][ast.NodeVisitor]-like class, the [`Inspector`][griffe.Inspector],\nto inspect the module with [`inspect.getmembers()`][inspect.getmembers].\n\nThe inspection agent works similarly to the regular [`Visitor`][griffe.Visitor] agent,\nin that it maintains a state with the current object being handled, and recursively handle its members.\n\nImportant:\n    This function is generally not used directly.\n    In most cases, users can rely on the [`GriffeLoader`][griffe.GriffeLoader]\n    and its accompanying [`load`][griffe.load] shortcut and their respective options\n    to load modules using dynamic analysis.\n\nParameters:\n    module_name: The module name (as when importing [from] it).\n    filepath: The module file path.\n    import_paths: Paths to import the module from.\n    extensions: The extensions to use when inspecting the module.\n    parent: The optional parent of this module.\n    docstring_parser: The docstring parser to use. By default, no parsing is done.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.\n\nReturns:\n    The module, with its members populated.", "lineno": 66, "endlineno": 103, "parsed": [{"kind": "text", "value": "Inspect a module.\n\nSometimes we cannot get the source code of a module or an object,\ntypically built-in modules like `itertools`.\nThe only way to know what they are made of is to actually import them and inspect their contents.\n\nSometimes, even if the source code is available,\nloading the object is desired because it was created or modified dynamically,\nand our static agent is not powerful enough to infer all these dynamic modifications.\nIn this case, we load the module using introspection.\n\nGriffe therefore provides this function for dynamic analysis.\nIt uses a [`NodeVisitor`][ast.NodeVisitor]-like class, the [`Inspector`][griffe.Inspector],\nto inspect the module with [`inspect.getmembers()`][inspect.getmembers].\n\nThe inspection agent works similarly to the regular [`Visitor`][griffe.Visitor] agent,\nin that it maintains a state with the current object being handled, and recursively handle its members."}, {"kind": "admonition", "value": {"annotation": "important", "description": "This function is generally not used directly.\nIn most cases, users can rely on the [`GriffeLoader`][griffe.GriffeLoader]\nand its accompanying [`load`][griffe.load] shortcut and their respective options\nto load modules using dynamic analysis."}, "title": "Important"}, {"kind": "parameters", "value": [{"name": "module_name", "annotation": {"member": "inspect", "name": "str", "cls": "ExprName"}, "description": "The module name (as when importing [from] it)."}, {"name": "filepath", "annotation": {"left": {"member": "inspect", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The module file path.", "value": "None"}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "inspect", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "inspect", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "inspect", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Paths to import the module from.", "value": "None"}, {"name": "extensions", "annotation": {"left": {"member": "inspect", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The extensions to use when inspecting the module.", "value": "None"}, {"name": "parent", "annotation": {"left": {"member": "inspect", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The optional parent of this module.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "inspect", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "inspect", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. By default, no parsing is done.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "inspect", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "inspect", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "inspect", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "inspect", "name": "Module", "cls": "ExprName"}, "description": "The module, with its members populated."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.inspect", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L54-L113", "decorators": [], "parameters": [{"name": "module_name", "annotation": {"member": "inspect", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"member": "inspect", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "inspect", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "inspect", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "inspect", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "extensions", "annotation": {"left": {"member": "inspect", "name": "Extensions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "parent", "annotation": {"left": {"member": "inspect", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "inspect", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "inspect", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "inspect", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "inspect", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "inspect", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "inspect", "name": "Module", "cls": "ExprName"}}, "Inspector": {"kind": "class", "name": "Inspector", "runtime": true, "lineno": 116, "endlineno": 589, "docstring": {"value": "This class is used to instantiate an inspector.\n\nInspectors iterate on objects members to extract data from them.", "lineno": 117, "endlineno": 120, "parsed": [{"kind": "text", "value": "This class is used to instantiate an inspector.\n\nInspectors iterate on objects members to extract data from them."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 122, "endlineno": 172, "docstring": {"value": "Initialize the inspector.\n\nParameters:\n    module_name: The module name.\n    filepath: The optional filepath.\n    extensions: Extensions to use when inspecting.\n    parent: The module parent.\n    docstring_parser: The docstring parser to use.\n    docstring_options: Docstring parsing options.\n    lines_collection: A collection of source code lines.\n    modules_collection: A collection of modules.", "lineno": 133, "endlineno": 144, "parsed": [{"kind": "parameters", "value": [{"name": "module_name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The module name."}, {"name": "filepath", "annotation": {"left": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The optional filepath."}, {"name": "extensions", "annotation": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "description": "Extensions to use when inspecting."}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The module parent.", "value": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use.", "value": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Docstring parsing options.", "value": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of source code lines.", "value": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A collection of modules.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L122-L172", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "module_name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"member": "__init__", "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"member": "__init__", "name": "Extensions", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "docstring_parser", "annotation": {"left": {"left": {"member": "__init__", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "docstring_options", "annotation": {"left": {"member": "__init__", "name": "DocstringOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "lines_collection", "annotation": {"left": {"member": "__init__", "name": "LinesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "modules_collection", "annotation": {"left": {"member": "__init__", "name": "ModulesCollection", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "module_name": {"kind": "attribute", "name": "module_name", "runtime": true, "lineno": 147, "endlineno": 147, "docstring": {"value": "The module name.", "lineno": 148, "endlineno": 148, "parsed": [{"kind": "text", "value": "The module name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.module_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L147-L147", "value": {"member": null, "name": "module_name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "filepath": {"kind": "attribute", "name": "filepath", "runtime": true, "lineno": 150, "endlineno": 150, "docstring": {"value": "The module file path.", "lineno": 151, "endlineno": 151, "parsed": [{"kind": "text", "value": "The module file path."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.filepath", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L150-L150", "value": {"member": null, "name": "filepath", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Path", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "extensions": {"kind": "attribute", "name": "extensions", "runtime": true, "lineno": 153, "endlineno": 153, "docstring": {"value": "The extensions to use when inspecting.", "lineno": 154, "endlineno": 154, "parsed": [{"kind": "text", "value": "The extensions to use when inspecting."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L153-L153", "value": {"member": null, "name": "extensions", "cls": "ExprName"}, "annotation": {"member": null, "name": "Extensions", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 156, "endlineno": 156, "docstring": {"value": "An optional parent for the final module object.", "lineno": 157, "endlineno": 157, "parsed": [{"kind": "text", "value": "An optional parent for the final module object."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L156-L156", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "current": {"kind": "attribute", "name": "current", "runtime": true, "lineno": 159, "endlineno": 159, "docstring": {"value": "The current object being inspected.", "lineno": 160, "endlineno": 160, "parsed": [{"kind": "text", "value": "The current object being inspected."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.current", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L159-L159", "value": "None", "annotation": {"left": {"member": null, "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "docstring_parser": {"kind": "attribute", "name": "docstring_parser", "runtime": true, "lineno": 162, "endlineno": 162, "docstring": {"value": "The docstring parser to use.", "lineno": 163, "endlineno": 163, "parsed": [{"kind": "text", "value": "The docstring parser to use."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.docstring_parser", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L162-L162", "value": {"member": null, "name": "docstring_parser", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "docstring_options": {"kind": "attribute", "name": "docstring_options", "runtime": true, "lineno": 165, "endlineno": 165, "docstring": {"value": "The docstring parsing options.", "lineno": 166, "endlineno": 166, "parsed": [{"kind": "text", "value": "The docstring parsing options."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.docstring_options", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L165-L165", "value": {"operator": "or", "values": [{"member": null, "name": "docstring_options", "cls": "ExprName"}, {"keys": [], "values": [], "cls": "ExprDict"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "DocstringOptions", "cls": "ExprName"}}, "lines_collection": {"kind": "attribute", "name": "lines_collection", "runtime": true, "lineno": 168, "endlineno": 168, "docstring": {"value": "A collection of source code lines.", "lineno": 169, "endlineno": 169, "parsed": [{"kind": "text", "value": "A collection of source code lines."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.lines_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L168-L168", "value": {"operator": "or", "values": [{"member": null, "name": "lines_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "LinesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "LinesCollection", "cls": "ExprName"}}, "modules_collection": {"kind": "attribute", "name": "modules_collection", "runtime": true, "lineno": 171, "endlineno": 171, "docstring": {"value": "A collection of modules.", "lineno": 172, "endlineno": 172, "parsed": [{"kind": "text", "value": "A collection of modules."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.modules_collection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L171-L171", "value": {"operator": "or", "values": [{"member": null, "name": "modules_collection", "cls": "ExprName"}, {"arguments": [], "function": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprBoolOp"}, "annotation": {"member": null, "name": "ModulesCollection", "cls": "ExprName"}}, "_get_docstring": {"kind": "function", "name": "_get_docstring", "runtime": true, "lineno": 174, "endlineno": 194, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector._get_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L174-L194", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "_get_docstring", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_docstring", "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_get_linenos": {"kind": "function", "name": "_get_linenos", "runtime": true, "lineno": 196, "endlineno": 204, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector._get_linenos", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L196-L204", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "_get_linenos", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"left": {"member": "_get_linenos", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_get_linenos", "name": "int", "cls": "ExprName"}, {"member": "_get_linenos", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "_get_linenos", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": ["None", "None"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "get_module": {"kind": "function", "name": "get_module", "runtime": true, "lineno": 206, "endlineno": 252, "docstring": {"value": "Build and return the object representing the module attached to this inspector.\n\nThis method triggers a complete inspection of the module members.\n\nParameters:\n    import_paths: Paths replacing `sys.path` to import the module.\n\nReturns:\n    A module instance.", "lineno": 207, "endlineno": 216, "parsed": [{"kind": "text", "value": "Build and return the object representing the module attached to this inspector.\n\nThis method triggers a complete inspection of the module members."}, {"kind": "parameters", "value": [{"name": "import_paths", "annotation": {"left": {"left": {"member": "get_module", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "get_module", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "get_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Paths replacing `sys.path` to import the module.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "get_module", "name": "Module", "cls": "ExprName"}, "description": "A module instance."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.get_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L206-L252", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "import_paths", "annotation": {"left": {"left": {"member": "get_module", "name": "Sequence", "cls": "ExprName"}, "slice": {"left": {"member": "get_module", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "get_module", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"member": "get_module", "name": "Module", "cls": "ExprName"}}, "inspect": {"kind": "function", "name": "inspect", "runtime": true, "lineno": 254, "endlineno": 260, "docstring": {"value": "Extend the base inspection with extensions.\n\nParameters:\n    node: The node to inspect.", "lineno": 255, "endlineno": 259, "parsed": [{"kind": "text", "value": "Extend the base inspection with extensions."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L254-L260", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "generic_inspect": {"kind": "function", "name": "generic_inspect", "runtime": true, "lineno": 262, "endlineno": 297, "docstring": {"value": "Extend the base generic inspection with extensions.\n\nParameters:\n    node: The node to inspect.", "lineno": 263, "endlineno": 267, "parsed": [{"kind": "text", "value": "Extend the base generic inspection with extensions."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "generic_inspect", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.generic_inspect", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L262-L297", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "generic_inspect", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_module": {"kind": "function", "name": "inspect_module", "runtime": true, "lineno": 299, "endlineno": 320, "docstring": {"value": "Inspect a module.\n\nParameters:\n    node: The node to inspect.", "lineno": 300, "endlineno": 304, "parsed": [{"kind": "text", "value": "Inspect a module."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_module", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L299-L320", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_module", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_class": {"kind": "function", "name": "inspect_class", "runtime": true, "lineno": 322, "endlineno": 354, "docstring": {"value": "Inspect a class.\n\nParameters:\n    node: The node to inspect.", "lineno": 323, "endlineno": 327, "parsed": [{"kind": "text", "value": "Inspect a class."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_class", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L322-L354", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_class", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_staticmethod": {"kind": "function", "name": "inspect_staticmethod", "runtime": true, "lineno": 356, "endlineno": 362, "docstring": {"value": "Inspect a static method.\n\nParameters:\n    node: The node to inspect.", "lineno": 357, "endlineno": 361, "parsed": [{"kind": "text", "value": "Inspect a static method."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_staticmethod", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_staticmethod", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L356-L362", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_staticmethod", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_classmethod": {"kind": "function", "name": "inspect_classmethod", "runtime": true, "lineno": 364, "endlineno": 370, "docstring": {"value": "Inspect a class method.\n\nParameters:\n    node: The node to inspect.", "lineno": 365, "endlineno": 369, "parsed": [{"kind": "text", "value": "Inspect a class method."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_classmethod", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_classmethod", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L364-L370", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_classmethod", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_method_descriptor": {"kind": "function", "name": "inspect_method_descriptor", "runtime": true, "lineno": 372, "endlineno": 378, "docstring": {"value": "Inspect a method descriptor.\n\nParameters:\n    node: The node to inspect.", "lineno": 373, "endlineno": 377, "parsed": [{"kind": "text", "value": "Inspect a method descriptor."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_method_descriptor", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_method_descriptor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L372-L378", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_method_descriptor", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_builtin_method": {"kind": "function", "name": "inspect_builtin_method", "runtime": true, "lineno": 380, "endlineno": 386, "docstring": {"value": "Inspect a builtin method.\n\nParameters:\n    node: The node to inspect.", "lineno": 381, "endlineno": 385, "parsed": [{"kind": "text", "value": "Inspect a builtin method."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_builtin_method", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_builtin_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L380-L386", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_builtin_method", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_method": {"kind": "function", "name": "inspect_method", "runtime": true, "lineno": 388, "endlineno": 394, "docstring": {"value": "Inspect a method.\n\nParameters:\n    node: The node to inspect.", "lineno": 389, "endlineno": 393, "parsed": [{"kind": "text", "value": "Inspect a method."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_method", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L388-L394", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_method", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_coroutine": {"kind": "function", "name": "inspect_coroutine", "runtime": true, "lineno": 396, "endlineno": 402, "docstring": {"value": "Inspect a coroutine.\n\nParameters:\n    node: The node to inspect.", "lineno": 397, "endlineno": 401, "parsed": [{"kind": "text", "value": "Inspect a coroutine."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_coroutine", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_coroutine", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L396-L402", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_coroutine", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_builtin_function": {"kind": "function", "name": "inspect_builtin_function", "runtime": true, "lineno": 404, "endlineno": 410, "docstring": {"value": "Inspect a builtin function.\n\nParameters:\n    node: The node to inspect.", "lineno": 405, "endlineno": 409, "parsed": [{"kind": "text", "value": "Inspect a builtin function."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_builtin_function", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_builtin_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L404-L410", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_builtin_function", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_function": {"kind": "function", "name": "inspect_function", "runtime": true, "lineno": 412, "endlineno": 418, "docstring": {"value": "Inspect a function.\n\nParameters:\n    node: The node to inspect.", "lineno": 413, "endlineno": 417, "parsed": [{"kind": "text", "value": "Inspect a function."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_function", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L412-L418", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_function", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_cached_property": {"kind": "function", "name": "inspect_cached_property", "runtime": true, "lineno": 420, "endlineno": 426, "docstring": {"value": "Inspect a cached property.\n\nParameters:\n    node: The node to inspect.", "lineno": 421, "endlineno": 425, "parsed": [{"kind": "text", "value": "Inspect a cached property."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_cached_property", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_cached_property", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L420-L426", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_cached_property", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_property": {"kind": "function", "name": "inspect_property", "runtime": true, "lineno": 428, "endlineno": 434, "docstring": {"value": "Inspect a property.\n\nParameters:\n    node: The node to inspect.", "lineno": 429, "endlineno": 433, "parsed": [{"kind": "text", "value": "Inspect a property."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_property", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_property", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L428-L434", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_property", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_getset_descriptor": {"kind": "function", "name": "inspect_getset_descriptor", "runtime": true, "lineno": 436, "endlineno": 442, "docstring": {"value": "Inspect a get/set descriptor.\n\nParameters:\n    node: The node to inspect.", "lineno": 437, "endlineno": 441, "parsed": [{"kind": "text", "value": "Inspect a get/set descriptor."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_getset_descriptor", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_getset_descriptor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L436-L442", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_getset_descriptor", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "handle_function": {"kind": "function", "name": "handle_function", "runtime": true, "lineno": 444, "endlineno": 508, "docstring": {"value": "Handle a function.\n\nParameters:\n    node: The node to inspect.\n    labels: Labels to add to the data object.", "lineno": 445, "endlineno": 450, "parsed": [{"kind": "text", "value": "Handle a function."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "handle_function", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}, {"name": "labels", "annotation": {"left": {"member": "handle_function", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Labels to add to the data object.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.handle_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L444-L508", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "handle_function", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "labels", "annotation": {"left": {"member": "handle_function", "name": "set", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "inspect_type_alias": {"kind": "function", "name": "inspect_type_alias", "runtime": true, "lineno": 510, "endlineno": 533, "docstring": {"value": "Inspect a type alias.\n\nParameters:\n    node: The node to inspect.", "lineno": 511, "endlineno": 515, "parsed": [{"kind": "text", "value": "Inspect a type alias."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_type_alias", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L510-L533", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_type_alias", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect_attribute": {"kind": "function", "name": "inspect_attribute", "runtime": true, "lineno": 535, "endlineno": 541, "docstring": {"value": "Inspect an attribute.\n\nParameters:\n    node: The node to inspect.", "lineno": 536, "endlineno": 540, "parsed": [{"kind": "text", "value": "Inspect an attribute."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect_attribute", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.inspect_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L535-L541", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect_attribute", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "handle_attribute": {"kind": "function", "name": "handle_attribute", "runtime": true, "lineno": 543, "endlineno": 589, "docstring": {"value": "Handle an attribute.\n\nParameters:\n    node: The node to inspect.\n    annotation: A potential annotation.", "lineno": 544, "endlineno": 549, "parsed": [{"kind": "text", "value": "Handle an attribute."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "handle_attribute", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}, {"name": "annotation", "annotation": {"left": {"left": {"member": "handle_attribute", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "handle_attribute", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "A potential annotation.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector.handle_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L543-L589", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "handle_attribute", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": "handle_attribute", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "handle_attribute", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.agents.inspector.Inspector", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L116-L589", "bases": [], "decorators": []}, "_parameter_kind_map": {"kind": "attribute", "name": "_parameter_kind_map", "runtime": true, "lineno": 592, "endlineno": 598, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector._parameter_kind_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L592-L598", "value": {"keys": [{"values": [{"member": null, "name": "SignatureParameter", "cls": "ExprName"}, {"member": null, "name": "POSITIONAL_ONLY", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "SignatureParameter", "cls": "ExprName"}, {"member": null, "name": "POSITIONAL_OR_KEYWORD", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "SignatureParameter", "cls": "ExprName"}, {"member": null, "name": "VAR_POSITIONAL", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "SignatureParameter", "cls": "ExprName"}, {"member": null, "name": "KEYWORD_ONLY", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "SignatureParameter", "cls": "ExprName"}, {"member": null, "name": "VAR_KEYWORD", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_only", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "positional_or_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "var_positional", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "keyword_only", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"member": null, "name": "var_keyword", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}}, "_convert_parameter": {"kind": "function", "name": "_convert_parameter", "runtime": true, "lineno": 601, "endlineno": 621, "analysis": "static", "path": "griffe._internal.agents.inspector._convert_parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L601-L621", "decorators": [], "parameters": [{"name": "parameter", "annotation": {"member": "_convert_parameter", "name": "SignatureParameter", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_convert_parameter", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_parameter", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "member", "annotation": {"left": {"member": "_convert_parameter", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"member": "_convert_parameter", "name": "Parameter", "cls": "ExprName"}}, "_convert_object_to_annotation": {"kind": "function", "name": "_convert_object_to_annotation", "runtime": true, "lineno": 624, "endlineno": 645, "analysis": "static", "path": "griffe._internal.agents.inspector._convert_object_to_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L624-L645", "decorators": [], "parameters": [{"name": "obj", "annotation": {"member": "_convert_object_to_annotation", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_convert_object_to_annotation", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_object_to_annotation", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "member", "annotation": {"left": {"member": "_convert_object_to_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"left": {"member": "_convert_object_to_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_object_to_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_type_parameter_kind_map": {"kind": "attribute", "name": "_type_parameter_kind_map", "runtime": true, "lineno": 648, "endlineno": 657, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.inspector._type_parameter_kind_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L648-L657", "value": {"generators": [{"conditions": [], "is_async": false, "iterable": {"arguments": [], "function": {"values": [{"keys": ["'TypeVar'", "'TypeVarTuple'", "'ParamSpec'"], "values": [{"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "type_var", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "type_var_tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "TypeParameterKind", "cls": "ExprName"}, {"member": null, "name": "param_spec", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}, {"member": null, "name": "items", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "target": {"elements": [{"member": null, "name": "attr", "cls": "ExprName"}, {"member": null, "name": "value", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprComprehension"}, {"conditions": [{"arguments": [{"member": null, "name": "module", "cls": "ExprName"}, {"member": null, "name": "attr", "cls": "ExprName"}], "function": {"member": null, "name": "hasattr", "cls": "ExprName"}, "cls": "ExprCall"}], "is_async": false, "iterable": {"member": null, "name": "_TYPING_MODULES", "cls": "ExprName"}, "target": {"member": null, "name": "module", "cls": "ExprName"}, "cls": "ExprComprehension"}], "key": {"arguments": [{"member": null, "name": "module", "cls": "ExprName"}, {"member": null, "name": "attr", "cls": "ExprName"}], "function": {"member": null, "name": "getattr", "cls": "ExprName"}, "cls": "ExprCall"}, "value": {"member": null, "name": "value", "cls": "ExprName"}, "cls": "ExprDictComp"}}, "_convert_type_parameters": {"kind": "function", "name": "_convert_type_parameters", "runtime": true, "lineno": 660, "endlineno": 700, "analysis": "static", "path": "griffe._internal.agents.inspector._convert_type_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L660-L700", "decorators": [], "parameters": [{"name": "obj", "annotation": {"member": "_convert_type_parameters", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_convert_type_parameters", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_type_parameters", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "member", "annotation": {"left": {"member": "_convert_type_parameters", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "_convert_type_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_convert_type_parameters", "name": "TypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_convert_type_to_annotation": {"kind": "function", "name": "_convert_type_to_annotation", "runtime": true, "lineno": 703, "endlineno": 720, "analysis": "static", "path": "griffe._internal.agents.inspector._convert_type_to_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/inspector.py#L703-L720", "decorators": [], "parameters": [{"name": "obj", "annotation": {"member": "_convert_type_to_annotation", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "_convert_type_to_annotation", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_type_to_annotation", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "member", "annotation": {"left": {"member": "_convert_type_to_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"left": {"member": "_convert_type_to_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_convert_type_to_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.agents.inspector", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/inspector.py", "relative_package_filepath": "griffe/_internal/agents/inspector.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/inspector.py"}, "nodes": {"kind": "module", "name": "nodes", "runtime": true, "members": {"assignments": {"kind": "module", "name": "assignments", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "Callable": "collections.abc.Callable"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_get_attribute_name": {"kind": "function", "name": "_get_attribute_name", "runtime": true, "lineno": 12, "endlineno": 13, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._get_attribute_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L12-L13", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_get_attribute_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_attribute_name", "name": "str", "cls": "ExprName"}}, "_get_name_name": {"kind": "function", "name": "_get_name_name", "runtime": true, "lineno": 16, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._get_name_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L16-L17", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_get_name_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_get_name_name", "name": "str", "cls": "ExprName"}}, "_node_name_map": {"kind": "attribute", "name": "_node_name_map", "runtime": true, "lineno": 20, "endlineno": 23, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._node_name_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L20-L23", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_get_name_name", "cls": "ExprName"}, {"member": null, "name": "_get_attribute_name", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "type", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Any", "cls": "ExprName"}], "cls": "ExprList"}, {"member": null, "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "get_name": {"kind": "function", "name": "get_name", "runtime": true, "lineno": 26, "endlineno": 35, "docstring": {"value": "Extract name from an assignment node.\n\nParameters:\n    node: The node to extract names from.\n\nReturns:\n    A list of names.", "lineno": 27, "endlineno": 34, "parsed": [{"kind": "text", "value": "Extract name from an assignment node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "get_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to extract names from."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "get_name", "name": "str", "cls": "ExprName"}, "description": "A list of names."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.get_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L26-L35", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "get_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "get_name", "name": "str", "cls": "ExprName"}}, "_get_assign_names": {"kind": "function", "name": "_get_assign_names", "runtime": true, "lineno": 38, "endlineno": 40, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._get_assign_names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L38-L40", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_get_assign_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_assign_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_assign_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_get_annassign_names": {"kind": "function", "name": "_get_annassign_names", "runtime": true, "lineno": 43, "endlineno": 45, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._get_annassign_names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L43-L45", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_get_annassign_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_annassign_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_annassign_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_node_names_map": {"kind": "attribute", "name": "_node_names_map", "runtime": true, "lineno": 48, "endlineno": 51, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.assignments._node_names_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L48-L51", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_get_assign_names", "cls": "ExprName"}, {"member": null, "name": "_get_annassign_names", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "type", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Any", "cls": "ExprName"}], "cls": "ExprList"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "get_names": {"kind": "function", "name": "get_names", "runtime": true, "lineno": 54, "endlineno": 63, "docstring": {"value": "Extract names from an assignment node.\n\nParameters:\n    node: The node to extract names from.\n\nReturns:\n    A list of names.", "lineno": 55, "endlineno": 62, "parsed": [{"kind": "text", "value": "Extract names from an assignment node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "get_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to extract names from."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of names."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.get_names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L54-L63", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "get_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "get_instance_names": {"kind": "function", "name": "get_instance_names", "runtime": true, "lineno": 66, "endlineno": 75, "docstring": {"value": "Extract names from an assignment node, only for instance attributes.\n\nParameters:\n    node: The node to extract names from.\n\nReturns:\n    A list of names.", "lineno": 67, "endlineno": 74, "parsed": [{"kind": "text", "value": "Extract names from an assignment node, only for instance attributes."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "get_instance_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to extract names from."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_instance_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_instance_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of names."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments.get_instance_names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py#L66-L75", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "get_instance_names", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get_instance_names", "name": "list", "cls": "ExprName"}, "slice": {"member": "get_instance_names", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.assignments", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py", "relative_package_filepath": "griffe/_internal/agents/nodes/assignments.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/assignments.py"}, "runtime": {"kind": "module", "name": "runtime", "runtime": true, "imports": {"annotations": "__future__.annotations", "inspect": "inspect", "sys": "sys", "typing": "typing", "cached_property": "functools.cached_property", "GetSetDescriptorType": "types.GetSetDescriptorType", "ModuleType": "types.ModuleType", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "ClassVar": "typing.ClassVar", "ObjectKind": "griffe._internal.enumerations.ObjectKind", "logger": "griffe._internal.logger.logger", "types": "types", "Sequence": "collections.abc.Sequence", "typing_extensions": "typing_extensions"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "inspect": {"kind": "alias", "name": "inspect", "target_path": "inspect", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.inspect", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "typing": {"kind": "alias", "name": "typing", "target_path": "typing", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.typing", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cached_property": {"kind": "alias", "name": "cached_property", "target_path": "functools.cached_property", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.cached_property", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GetSetDescriptorType": {"kind": "alias", "name": "GetSetDescriptorType", "target_path": "types.GetSetDescriptorType", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.GetSetDescriptorType", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ModuleType": {"kind": "alias", "name": "ModuleType", "target_path": "types.ModuleType", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ModuleType", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ClassVar": {"kind": "alias", "name": "ClassVar", "target_path": "typing.ClassVar", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ClassVar", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ObjectKind": {"kind": "alias", "name": "ObjectKind", "target_path": "griffe._internal.enumerations.ObjectKind", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "types": {"kind": "alias", "name": "types", "target_path": "types", "runtime": false, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.types", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_TYPING_MODULES": {"kind": "attribute", "name": "_TYPING_MODULES", "runtime": true, "lineno": 25, "endlineno": 25, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime._TYPING_MODULES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L25-L25", "value": {"elements": [{"member": null, "name": "typing", "cls": "ExprName"}, {"member": null, "name": "typing_extensions", "cls": "ExprName"}], "implicit": false, "cls": "ExprTuple"}, "annotation": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"values": [{"member": null, "name": "types", "cls": "ExprName"}, {"member": null, "name": "ModuleType", "cls": "ExprName"}], "cls": "ExprAttribute"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "typing_extensions": {"kind": "alias", "name": "typing_extensions", "target_path": "typing_extensions", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.typing_extensions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_builtin_module_names": {"kind": "attribute", "name": "_builtin_module_names", "runtime": true, "lineno": 28, "endlineno": 28, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime._builtin_module_names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L28-L28", "value": {"element": {"arguments": ["'_'"], "function": {"values": [{"member": null, "name": "_", "cls": "ExprName"}, {"member": null, "name": "lstrip", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "generators": [{"conditions": [], "is_async": false, "iterable": {"values": [{"member": null, "name": "sys", "cls": "ExprName"}, {"member": null, "name": "builtin_module_names", "cls": "ExprName"}], "cls": "ExprAttribute"}, "target": {"member": null, "name": "_", "cls": "ExprName"}, "cls": "ExprComprehension"}], "cls": "ExprSetComp"}}, "_cyclic_relationships": {"kind": "attribute", "name": "_cyclic_relationships", "runtime": true, "lineno": 29, "endlineno": 33, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime._cyclic_relationships", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L29-L33", "value": {"elements": [{"elements": ["'os'", "'nt'"], "implicit": false, "cls": "ExprTuple"}, {"elements": ["'os'", "'posix'"], "implicit": false, "cls": "ExprTuple"}, {"elements": ["'numpy.core._multiarray_umath'", "'numpy.core.multiarray'"], "implicit": false, "cls": "ExprTuple"}], "cls": "ExprSet"}}, "_same_components": {"kind": "function", "name": "_same_components", "runtime": true, "lineno": 36, "endlineno": 37, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime._same_components", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L36-L37", "decorators": [], "parameters": [{"name": "a", "annotation": {"member": "_same_components", "name": "str", "cls": "ExprName"}, "kind": "positional-only", "default": null}, {"name": "b", "annotation": {"member": "_same_components", "name": "str", "cls": "ExprName"}, "kind": "positional-only", "default": null}], "returns": {"member": "_same_components", "name": "bool", "cls": "ExprName"}}, "ObjectNode": {"kind": "class", "name": "ObjectNode", "runtime": true, "lineno": 40, "endlineno": 341, "docstring": {"value": "Helper class to represent an object tree.\n\nIt's not really a tree but more a backward-linked list:\neach node has a reference to its parent, but not to its child (for simplicity purposes and to avoid bugs).\n\nEach node stores an object, its name, and a reference to its parent node.", "lineno": 41, "endlineno": 47, "parsed": [{"kind": "text", "value": "Helper class to represent an object tree.\n\nIt's not really a tree but more a backward-linked list:\neach node has a reference to its parent, but not to its child (for simplicity purposes and to avoid bugs).\n\nEach node stores an object, its name, and a reference to its parent node."}]}, "members": {"exclude_specials": {"kind": "attribute", "name": "exclude_specials", "runtime": true, "lineno": 49, "endlineno": 49, "docstring": {"value": "Low level attributes known to cause issues when resolving aliases.", "lineno": 50, "endlineno": 50, "parsed": [{"kind": "text", "value": "Low level attributes known to cause issues when resolving aliases."}]}, "labels": ["class-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.exclude_specials", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L49-L49", "value": {"elements": ["'__builtins__'", "'__loader__'", "'__spec__'"], "cls": "ExprSet"}, "annotation": {"left": {"member": null, "name": "set", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 52, "endlineno": 84, "docstring": {"value": "Initialize the object.\n\nParameters:\n    obj: A Python object.\n    name: The object's name.\n    parent: The object's parent node.", "lineno": 53, "endlineno": 59, "parsed": [{"kind": "parameters", "value": [{"name": "obj", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "description": "A Python object."}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The object's name."}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "ObjectNode", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The object's parent node.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L52-L84", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "__init__", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"left": {"member": "__init__", "name": "ObjectNode", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "obj": {"kind": "attribute", "name": "obj", "runtime": true, "lineno": 77, "endlineno": 77, "docstring": {"value": "The actual Python object.", "lineno": 78, "endlineno": 78, "parsed": [{"kind": "text", "value": "The actual Python object."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.obj", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L77-L77", "value": {"member": null, "name": "obj", "cls": "ExprName"}, "annotation": {"member": null, "name": "Any", "cls": "ExprName"}}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 79, "endlineno": 79, "docstring": {"value": "The Python object's name.", "lineno": 80, "endlineno": 80, "parsed": [{"kind": "text", "value": "The Python object's name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L79-L79", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "parent": {"kind": "attribute", "name": "parent", "runtime": true, "lineno": 81, "endlineno": 81, "docstring": {"value": "The parent node.", "lineno": 82, "endlineno": 82, "parsed": [{"kind": "text", "value": "The parent node."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L81-L81", "value": {"member": null, "name": "parent", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "ObjectNode", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "is_cached_property": {"kind": "attribute", "name": "is_cached_property", "runtime": true, "lineno": 83, "endlineno": 83, "docstring": {"value": "Whether this node's object is a cached property.", "lineno": 84, "endlineno": 84, "parsed": [{"kind": "text", "value": "Whether this node's object is a cached property."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_cached_property", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L83-L83", "value": {"member": null, "name": "is_cached_property", "cls": "ExprName"}, "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "__repr__": {"kind": "function", "name": "__repr__", "runtime": true, "lineno": 86, "endlineno": 87, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.__repr__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L86-L87", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__repr__", "name": "str", "cls": "ExprName"}}, "path": {"kind": "attribute", "name": "path", "runtime": true, "lineno": 90, "endlineno": 94, "docstring": {"value": "The object's (Python) path.", "lineno": 91, "endlineno": 91, "parsed": [{"kind": "text", "value": "The object's (Python) path."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L90-L94", "annotation": {"member": "path", "name": "str", "cls": "ExprName"}}, "module": {"kind": "attribute", "name": "module", "runtime": true, "lineno": 97, "endlineno": 103, "docstring": {"value": "The object's module, fetched from the node tree.", "lineno": 98, "endlineno": 98, "parsed": [{"kind": "text", "value": "The object's module, fetched from the node tree."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L97-L103", "annotation": {"member": "module", "name": "ObjectNode", "cls": "ExprName"}}, "module_path": {"kind": "attribute", "name": "module_path", "runtime": true, "lineno": 106, "endlineno": 139, "docstring": {"value": "The object's module path.", "lineno": 107, "endlineno": 107, "parsed": [{"kind": "text", "value": "The object's module path."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.module_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L106-L139", "annotation": {"left": {"member": "module_path", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 142, "endlineno": 172, "docstring": {"value": "The kind of this node.", "lineno": 143, "endlineno": 143, "parsed": [{"kind": "text", "value": "The kind of this node."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L142-L172", "annotation": {"member": "kind", "name": "ObjectKind", "cls": "ExprName"}}, "children": {"kind": "attribute", "name": "children", "runtime": true, "lineno": 175, "endlineno": 181, "docstring": {"value": "The children of this node.", "lineno": 176, "endlineno": 176, "parsed": [{"kind": "text", "value": "The children of this node."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.children", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L175-L181", "annotation": {"left": {"member": "children", "name": "Sequence", "cls": "ExprName"}, "slice": {"member": "children", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "is_module": {"kind": "attribute", "name": "is_module", "runtime": true, "lineno": 184, "endlineno": 186, "docstring": {"value": "Whether this node's object is a module.", "lineno": 185, "endlineno": 185, "parsed": [{"kind": "text", "value": "Whether this node's object is a module."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L184-L186", "annotation": {"member": "is_module", "name": "bool", "cls": "ExprName"}}, "is_class": {"kind": "attribute", "name": "is_class", "runtime": true, "lineno": 189, "endlineno": 191, "docstring": {"value": "Whether this node's object is a class.", "lineno": 190, "endlineno": 190, "parsed": [{"kind": "text", "value": "Whether this node's object is a class."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L189-L191", "annotation": {"member": "is_class", "name": "bool", "cls": "ExprName"}}, "is_function": {"kind": "attribute", "name": "is_function", "runtime": true, "lineno": 194, "endlineno": 197, "docstring": {"value": "Whether this node's object is a function.", "lineno": 195, "endlineno": 195, "parsed": [{"kind": "text", "value": "Whether this node's object is a function."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L194-L197", "annotation": {"member": "is_function", "name": "bool", "cls": "ExprName"}}, "is_type_alias": {"kind": "attribute", "name": "is_type_alias", "runtime": true, "lineno": 200, "endlineno": 205, "docstring": {"value": "Whether this node's object is a type alias.", "lineno": 201, "endlineno": 201, "parsed": [{"kind": "text", "value": "Whether this node's object is a type alias."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L200-L205", "annotation": {"member": "is_type_alias", "name": "bool", "cls": "ExprName"}}, "is_builtin_function": {"kind": "attribute", "name": "is_builtin_function", "runtime": true, "lineno": 208, "endlineno": 210, "docstring": {"value": "Whether this node's object is a builtin function.", "lineno": 209, "endlineno": 209, "parsed": [{"kind": "text", "value": "Whether this node's object is a builtin function."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_builtin_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L208-L210", "annotation": {"member": "is_builtin_function", "name": "bool", "cls": "ExprName"}}, "is_coroutine": {"kind": "attribute", "name": "is_coroutine", "runtime": true, "lineno": 213, "endlineno": 215, "docstring": {"value": "Whether this node's object is a coroutine.", "lineno": 214, "endlineno": 214, "parsed": [{"kind": "text", "value": "Whether this node's object is a coroutine."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_coroutine", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L213-L215", "annotation": {"member": "is_coroutine", "name": "bool", "cls": "ExprName"}}, "is_getset_descriptor": {"kind": "attribute", "name": "is_getset_descriptor", "runtime": true, "lineno": 218, "endlineno": 220, "docstring": {"value": "Whether this node's object is a get/set descriptor.", "lineno": 219, "endlineno": 219, "parsed": [{"kind": "text", "value": "Whether this node's object is a get/set descriptor."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_getset_descriptor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L218-L220", "annotation": {"member": "is_getset_descriptor", "name": "bool", "cls": "ExprName"}}, "is_property": {"kind": "attribute", "name": "is_property", "runtime": true, "lineno": 223, "endlineno": 225, "docstring": {"value": "Whether this node's object is a property.", "lineno": 224, "endlineno": 224, "parsed": [{"kind": "text", "value": "Whether this node's object is a property."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_property", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L223-L225", "annotation": {"member": "is_property", "name": "bool", "cls": "ExprName"}}, "parent_is_class": {"kind": "attribute", "name": "parent_is_class", "runtime": true, "lineno": 228, "endlineno": 230, "docstring": {"value": "Whether the object of this node's parent is a class.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "Whether the object of this node's parent is a class."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.parent_is_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L228-L230", "annotation": {"member": "parent_is_class", "name": "bool", "cls": "ExprName"}}, "is_method": {"kind": "attribute", "name": "is_method", "runtime": true, "lineno": 233, "endlineno": 236, "docstring": {"value": "Whether this node's object is a method.", "lineno": 234, "endlineno": 234, "parsed": [{"kind": "text", "value": "Whether this node's object is a method."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L233-L236", "annotation": {"member": "is_method", "name": "bool", "cls": "ExprName"}}, "is_method_descriptor": {"kind": "attribute", "name": "is_method_descriptor", "runtime": true, "lineno": 239, "endlineno": 245, "docstring": {"value": "Whether this node's object is a method descriptor.\n\nBuilt-in methods (e.g. those implemented in C/Rust) are often\nmethod descriptors, rather than normal methods.", "lineno": 240, "endlineno": 244, "parsed": [{"kind": "text", "value": "Whether this node's object is a method descriptor.\n\nBuilt-in methods (e.g. those implemented in C/Rust) are often\nmethod descriptors, rather than normal methods."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_method_descriptor", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L239-L245", "annotation": {"member": "is_method_descriptor", "name": "bool", "cls": "ExprName"}}, "is_builtin_method": {"kind": "attribute", "name": "is_builtin_method", "runtime": true, "lineno": 248, "endlineno": 250, "docstring": {"value": "Whether this node's object is a builtin method.", "lineno": 249, "endlineno": 249, "parsed": [{"kind": "text", "value": "Whether this node's object is a builtin method."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_builtin_method", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L248-L250", "annotation": {"member": "is_builtin_method", "name": "bool", "cls": "ExprName"}}, "is_staticmethod": {"kind": "attribute", "name": "is_staticmethod", "runtime": true, "lineno": 253, "endlineno": 261, "docstring": {"value": "Whether this node's object is a staticmethod.", "lineno": 254, "endlineno": 254, "parsed": [{"kind": "text", "value": "Whether this node's object is a staticmethod."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_staticmethod", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L253-L261", "annotation": {"member": "is_staticmethod", "name": "bool", "cls": "ExprName"}}, "is_classmethod": {"kind": "attribute", "name": "is_classmethod", "runtime": true, "lineno": 264, "endlineno": 272, "docstring": {"value": "Whether this node's object is a classmethod.", "lineno": 265, "endlineno": 265, "parsed": [{"kind": "text", "value": "Whether this node's object is a classmethod."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_classmethod", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L264-L272", "annotation": {"member": "is_classmethod", "name": "bool", "cls": "ExprName"}}, "is_attribute": {"kind": "attribute", "name": "is_attribute", "runtime": true, "lineno": 275, "endlineno": 277, "docstring": {"value": "Whether this node's object is an attribute.", "lineno": 276, "endlineno": 276, "parsed": [{"kind": "text", "value": "Whether this node's object is an attribute."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.is_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L275-L277", "annotation": {"member": "is_attribute", "name": "bool", "cls": "ExprName"}}, "_ids": {"kind": "attribute", "name": "_ids", "runtime": true, "lineno": 280, "endlineno": 283, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode._ids", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L280-L283", "annotation": {"left": {"member": "_ids", "name": "set", "cls": "ExprName"}, "slice": {"member": "_ids", "name": "int", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_pick_member": {"kind": "function", "name": "_pick_member", "runtime": true, "lineno": 285, "endlineno": 292, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode._pick_member", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L285-L292", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "_pick_member", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "member", "annotation": {"member": "_pick_member", "name": "Any", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_pick_member", "name": "bool", "cls": "ExprName"}}, "alias_target_path": {"kind": "attribute", "name": "alias_target_path", "runtime": true, "lineno": 295, "endlineno": 341, "docstring": {"value": "Alias target path of this node, if the node should be an alias.", "lineno": 296, "endlineno": 296, "parsed": [{"kind": "text", "value": "Alias target path of this node, if the node should be an alias."}]}, "labels": ["cached", "property"], "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode.alias_target_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L295-L341", "annotation": {"left": {"member": "alias_target_path", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime.ObjectNode", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py#L40-L341", "bases": [], "decorators": []}}, "analysis": "static", "path": "griffe._internal.agents.nodes.runtime", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py", "relative_package_filepath": "griffe/_internal/agents/nodes/runtime.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/runtime.py"}, "docstrings": {"kind": "module", "name": "docstrings", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.docstrings.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.docstrings.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_docstring": {"kind": "function", "name": "get_docstring", "runtime": true, "lineno": 8, "endlineno": 31, "docstring": {"value": "Extract a docstring.\n\nParameters:\n    node: The node to extract the docstring from.\n    strict: Whether to skip searching the body (functions).\n\nReturns:\n    A tuple with the value and line numbers of the docstring.", "lineno": 13, "endlineno": 21, "parsed": [{"kind": "text", "value": "Extract a docstring."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "get_docstring", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to extract the docstring from."}, {"name": "strict", "annotation": {"member": "get_docstring", "name": "bool", "cls": "ExprName"}, "description": "Whether to skip searching the body (functions).", "value": "False"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_docstring", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "get_docstring", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"member": "get_docstring", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"member": "get_docstring", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A tuple with the value and line numbers of the docstring."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.docstrings.get_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py", "relative_package_filepath": "griffe/_internal/agents/nodes/docstrings.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py#L8-L31", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "get_docstring", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "strict", "annotation": {"member": "get_docstring", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}], "returns": {"left": {"member": "get_docstring", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "get_docstring", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"member": "get_docstring", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"member": "get_docstring", "name": "int", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.docstrings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py", "relative_package_filepath": "griffe/_internal/agents/nodes/docstrings.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/docstrings.py"}, "imports": {"kind": "module", "name": "imports", "runtime": true, "imports": {"annotations": "__future__.annotations", "TYPE_CHECKING": "typing.TYPE_CHECKING", "ast": "ast", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.imports.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.imports.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": false, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.agents.nodes.imports.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.nodes.imports.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "relative_to_absolute": {"kind": "function", "name": "relative_to_absolute", "runtime": true, "lineno": 13, "endlineno": 32, "docstring": {"value": "Convert a relative import path to an absolute one.\n\nParameters:\n    node: The \"from ... import ...\" AST node.\n    name: The imported name.\n    current_module: The module in which the import happens.\n\nReturns:\n    The absolute import path.", "lineno": 14, "endlineno": 23, "parsed": [{"kind": "text", "value": "Convert a relative import path to an absolute one."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "relative_to_absolute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ImportFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The \"from ... import ...\" AST node."}, {"name": "name", "annotation": {"values": [{"member": "relative_to_absolute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "alias", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The imported name."}, {"name": "current_module", "annotation": {"member": "relative_to_absolute", "name": "Module", "cls": "ExprName"}, "description": "The module in which the import happens."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "relative_to_absolute", "name": "str", "cls": "ExprName"}, "description": "The absolute import path."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.imports.relative_to_absolute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/imports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/imports.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/imports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/imports.py#L13-L32", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "relative_to_absolute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "ImportFrom", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"values": [{"member": "relative_to_absolute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "alias", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "current_module", "annotation": {"member": "relative_to_absolute", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "relative_to_absolute", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.imports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/imports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/imports.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/imports.py"}, "exports": {"kind": "module", "name": "exports", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "get_value": "griffe._internal.agents.nodes.values.get_value", "LogLevel": "griffe._internal.enumerations.LogLevel", "ExprName": "griffe._internal.expressions.ExprName", "logger": "griffe._internal.logger.logger", "Callable": "collections.abc.Callable", "Module": "griffe._internal.models.Module"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "get_value": {"kind": "alias", "name": "get_value", "target_path": "griffe._internal.agents.nodes.values.get_value", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.get_value", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.LogLevel", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.ExprName", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_extract_attribute": {"kind": "function", "name": "_extract_attribute", "runtime": true, "lineno": 20, "endlineno": 21, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L20-L21", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract_attribute", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_attribute", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_attribute", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_attribute", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_attribute", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_extract_binop": {"kind": "function", "name": "_extract_binop", "runtime": true, "lineno": 24, "endlineno": 27, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_binop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L24-L27", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract_binop", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BinOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_binop", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_binop", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_binop", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_binop", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_extract_constant": {"kind": "function", "name": "_extract_constant", "runtime": true, "lineno": 30, "endlineno": 31, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_constant", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L30-L31", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract_constant", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Constant", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_constant", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_constant", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_constant", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_constant", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_extract_name": {"kind": "function", "name": "_extract_name", "runtime": true, "lineno": 34, "endlineno": 35, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L34-L35", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract_name", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_name", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_name", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_name", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_name", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_extract_sequence": {"kind": "function", "name": "_extract_sequence", "runtime": true, "lineno": 38, "endlineno": 42, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_sequence", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L38-L42", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"left": {"values": [{"member": "_extract_sequence", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "List", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "_extract_sequence", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Set", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "_extract_sequence", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_sequence", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_sequence", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_sequence", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_sequence", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_extract_starred": {"kind": "function", "name": "_extract_starred", "runtime": true, "lineno": 45, "endlineno": 46, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract_starred", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L45-L46", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract_starred", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Starred", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract_starred", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract_starred", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract_starred", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract_starred", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "_node_map": {"kind": "attribute", "name": "_node_map", "runtime": true, "lineno": 49, "endlineno": 58, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.exports._node_map", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L49-L58", "value": {"keys": [{"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Attribute", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "BinOp", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Constant", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "List", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Name", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Set", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Starred", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Tuple", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_extract_attribute", "cls": "ExprName"}, {"member": null, "name": "_extract_binop", "cls": "ExprName"}, {"member": null, "name": "_extract_constant", "cls": "ExprName"}, {"member": null, "name": "_extract_sequence", "cls": "ExprName"}, {"member": null, "name": "_extract_name", "cls": "ExprName"}, {"member": null, "name": "_extract_sequence", "cls": "ExprName"}, {"member": null, "name": "_extract_starred", "cls": "ExprName"}, {"member": null, "name": "_extract_sequence", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "type", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Any", "cls": "ExprName"}, {"member": null, "name": "Module", "cls": "ExprName"}], "cls": "ExprList"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_extract": {"kind": "function", "name": "_extract", "runtime": true, "lineno": 61, "endlineno": 62, "analysis": "static", "path": "griffe._internal.agents.nodes.exports._extract", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L61-L62", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "_extract", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "_extract", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_extract", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_extract", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_extract", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "get__all__": {"kind": "function", "name": "get__all__", "runtime": true, "lineno": 65, "endlineno": 77, "docstring": {"value": "Get the values declared in `__all__`.\n\nParameters:\n    node: The assignment node.\n    parent: The parent module.\n\nReturns:\n    A set of names.", "lineno": 66, "endlineno": 74, "parsed": [{"kind": "text", "value": "Get the values declared in `__all__`."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"left": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "description": "The assignment node."}, {"name": "parent", "annotation": {"member": "get__all__", "name": "Module", "cls": "ExprName"}, "description": "The parent module."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get__all__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "get__all__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "get__all__", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "description": "A set of names."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.get__all__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L65-L77", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"left": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "get__all__", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get__all__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "get__all__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "get__all__", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}, "safe_get__all__": {"kind": "function", "name": "safe_get__all__", "runtime": true, "lineno": 80, "endlineno": 106, "docstring": {"value": "Safely (no exception) extract values in `__all__`.\n\nParameters:\n    node: The `__all__` assignment node.\n    parent: The parent used to resolve the names.\n    log_level: Log level to use to log a message.\n\nReturns:\n    A list of strings or resolvable names.", "lineno": 85, "endlineno": 94, "parsed": [{"kind": "text", "value": "Safely (no exception) extract values in `__all__`."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"left": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "description": "The `__all__` assignment node."}, {"name": "parent", "annotation": {"member": "safe_get__all__", "name": "Module", "cls": "ExprName"}, "description": "The parent used to resolve the names."}, {"name": "log_level", "annotation": {"member": "safe_get__all__", "name": "LogLevel", "cls": "ExprName"}, "description": "Log level to use to log a message.", "value": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "debug", "cls": "ExprName"}], "cls": "ExprAttribute"}}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "safe_get__all__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "safe_get__all__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get__all__", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}, "description": "A list of strings or resolvable names."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.exports.safe_get__all__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py#L80-L106", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"left": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "Assign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AnnAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"values": [{"member": "safe_get__all__", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AugAssign", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parent", "annotation": {"member": "safe_get__all__", "name": "Module", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "log_level", "annotation": {"member": "safe_get__all__", "name": "LogLevel", "cls": "ExprName"}, "kind": "positional or keyword", "default": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "debug", "cls": "ExprName"}], "cls": "ExprAttribute"}}], "returns": {"left": {"member": "safe_get__all__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "safe_get__all__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get__all__", "name": "ExprName", "cls": "ExprName"}, "cls": "ExprBinOp"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.exports", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/exports.py", "relative_package_filepath": "griffe/_internal/agents/nodes/exports.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/exports.py"}, "values": {"kind": "module", "name": "values", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "unparse": "ast.unparse", "TYPE_CHECKING": "typing.TYPE_CHECKING", "logger": "griffe._internal.logger.logger", "Path": "pathlib.Path"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.values.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.values.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "unparse": {"kind": "alias", "name": "unparse", "target_path": "ast.unparse", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.values.unparse", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.nodes.values.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.values.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.agents.nodes.values.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "get_value": {"kind": "function", "name": "get_value", "runtime": true, "lineno": 15, "endlineno": 26, "docstring": {"value": "Get the string representation of a node.\n\nParameters:\n    node: The node to represent.\n\nReturns:\n    The representing code for the node.", "lineno": 16, "endlineno": 23, "parsed": [{"kind": "text", "value": "Get the string representation of a node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "get_value", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The node to represent."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The representing code for the node."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.values.get_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/values.py", "relative_package_filepath": "griffe/_internal/agents/nodes/values.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/values.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/values.py#L15-L26", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"values": [{"member": "get_value", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "safe_get_value": {"kind": "function", "name": "safe_get_value", "runtime": true, "lineno": 29, "endlineno": 47, "docstring": {"value": "Safely (no exception) get the string representation of a node.\n\nParameters:\n    node: The node to represent.\n    filepath: An optional filepath from where the node comes.\n\nReturns:\n    The representing code for the node.", "lineno": 30, "endlineno": 38, "parsed": [{"kind": "text", "value": "Safely (no exception) get the string representation of a node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "safe_get_value", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The node to represent."}, {"name": "filepath", "annotation": {"left": {"left": {"member": "safe_get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get_value", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional filepath from where the node comes.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "safe_get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The representing code for the node."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.values.safe_get_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/values.py", "relative_package_filepath": "griffe/_internal/agents/nodes/values.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/values.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/values.py#L29-L47", "decorators": [], "parameters": [{"name": "node", "annotation": {"left": {"values": [{"member": "safe_get_value", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "filepath", "annotation": {"left": {"left": {"member": "safe_get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "safe_get_value", "name": "Path", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": {"left": {"member": "safe_get_value", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.values", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/values.py", "relative_package_filepath": "griffe/_internal/agents/nodes/values.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/values.py"}, "parameters": {"kind": "module", "name": "parameters", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "zip_longest": "itertools.zip_longest", "TYPE_CHECKING": "typing.TYPE_CHECKING", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "Iterable": "collections.abc.Iterable"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "zip_longest": {"kind": "alias", "name": "zip_longest", "target_path": "itertools.zip_longest", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.zip_longest", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterable": {"kind": "alias", "name": "Iterable", "target_path": "collections.abc.Iterable", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.Iterable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ParametersType": {"kind": "attribute", "name": "ParametersType", "runtime": true, "lineno": 14, "endlineno": 14, "docstring": {"value": "Type alias for the list of parameters of a function.", "lineno": 15, "endlineno": 15, "parsed": [{"kind": "text", "value": "Type alias for the list of parameters of a function."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.ParametersType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py", "relative_package_filepath": "griffe/_internal/agents/nodes/parameters.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py#L14-L14", "value": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": null, "name": "ParameterKind", "cls": "ExprName"}, {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"values": [{"member": null, "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}}, "get_parameters": {"kind": "function", "name": "get_parameters", "runtime": true, "lineno": 18, "endlineno": 83, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters.get_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py", "relative_package_filepath": "griffe/_internal/agents/nodes/parameters.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py#L18-L83", "decorators": [], "parameters": [{"name": "node", "annotation": {"values": [{"member": "get_parameters", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "arguments", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "get_parameters", "name": "ParametersType", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py", "relative_package_filepath": "griffe/_internal/agents/nodes/parameters.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/parameters.py"}, "ast": {"kind": "module", "name": "ast", "runtime": true, "imports": {"annotations": "__future__.annotations", "AST": "ast.AST", "TYPE_CHECKING": "typing.TYPE_CHECKING", "LastNodeError": "griffe._internal.exceptions.LastNodeError", "Iterator": "collections.abc.Iterator"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AST": {"kind": "alias", "name": "AST", "target_path": "ast.AST", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.AST", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LastNodeError": {"kind": "alias", "name": "LastNodeError", "target_path": "griffe._internal.exceptions.LastNodeError", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.LastNodeError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ast_kind": {"kind": "function", "name": "ast_kind", "runtime": true, "lineno": 14, "endlineno": 23, "docstring": {"value": "Return the kind of an AST node.\n\nParameters:\n    node: The AST node.\n\nReturns:\n    The node kind.", "lineno": 15, "endlineno": 22, "parsed": [{"kind": "text", "value": "Return the kind of an AST node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_kind", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "ast_kind", "name": "str", "cls": "ExprName"}, "description": "The node kind."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L14-L23", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_kind", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "ast_kind", "name": "str", "cls": "ExprName"}}, "ast_children": {"kind": "function", "name": "ast_children", "runtime": true, "lineno": 26, "endlineno": 47, "docstring": {"value": "Return the children of an AST node.\n\nParameters:\n    node: The AST node.\n\nYields:\n    The node children.", "lineno": 27, "endlineno": 34, "parsed": [{"kind": "text", "value": "Return the children of an AST node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_children", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "ast_children", "name": "AST", "cls": "ExprName"}, "description": "The node children."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_children", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L26-L47", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_children", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "ast_children", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "ast_children", "name": "AST", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "ast_previous_siblings": {"kind": "function", "name": "ast_previous_siblings", "runtime": true, "lineno": 50, "endlineno": 63, "docstring": {"value": "Return the previous siblings of this node, starting from the closest.\n\nParameters:\n    node: The AST node.\n\nYields:\n    The previous siblings.", "lineno": 51, "endlineno": 58, "parsed": [{"kind": "text", "value": "Return the previous siblings of this node, starting from the closest."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_previous_siblings", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "ast_previous_siblings", "name": "AST", "cls": "ExprName"}, "description": "The previous siblings."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_previous_siblings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L50-L63", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_previous_siblings", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "ast_previous_siblings", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "ast_previous_siblings", "name": "AST", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "ast_next_siblings": {"kind": "function", "name": "ast_next_siblings", "runtime": true, "lineno": 66, "endlineno": 79, "docstring": {"value": "Return the next siblings of this node, starting from the closest.\n\nParameters:\n    node: The AST node.\n\nYields:\n    The next siblings.", "lineno": 67, "endlineno": 74, "parsed": [{"kind": "text", "value": "Return the next siblings of this node, starting from the closest."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_next_siblings", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "ast_next_siblings", "name": "AST", "cls": "ExprName"}, "description": "The next siblings."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_next_siblings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L66-L79", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_next_siblings", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "ast_next_siblings", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "ast_next_siblings", "name": "AST", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "ast_siblings": {"kind": "function", "name": "ast_siblings", "runtime": true, "lineno": 82, "endlineno": 97, "docstring": {"value": "Return the siblings of this node.\n\nParameters:\n    node: The AST node.\n\nYields:\n    The siblings.", "lineno": 83, "endlineno": 90, "parsed": [{"kind": "text", "value": "Return the siblings of this node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_siblings", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "yields", "value": [{"name": "", "annotation": {"member": "ast_siblings", "name": "AST", "cls": "ExprName"}, "description": "The siblings."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_siblings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L82-L97", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_siblings", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "ast_siblings", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "ast_siblings", "name": "AST", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "ast_previous": {"kind": "function", "name": "ast_previous", "runtime": true, "lineno": 100, "endlineno": 116, "docstring": {"value": "Return the previous sibling of this node.\n\nParameters:\n    node: The AST node.\n\nRaises:\n    LastNodeError: When the node does not have previous siblings.\n\nReturns:\n    The sibling.", "lineno": 101, "endlineno": 111, "parsed": [{"kind": "text", "value": "Return the previous sibling of this node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_previous", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "LastNodeError", "cls": "ExprName"}, "description": "When the node does not have previous siblings."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "ast_previous", "name": "AST", "cls": "ExprName"}, "description": "The sibling."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_previous", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L100-L116", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_previous", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "ast_previous", "name": "AST", "cls": "ExprName"}}, "ast_next": {"kind": "function", "name": "ast_next", "runtime": true, "lineno": 119, "endlineno": 134, "docstring": {"value": "Return the next sibling of this node.\n\nParameters:\n    node: The AST node.\n\nRaises:\n    LastNodeError: When the node does not have next siblings.\n\nReturns:\n    The sibling.", "lineno": 120, "endlineno": 130, "parsed": [{"kind": "text", "value": "Return the next sibling of this node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_next", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "LastNodeError", "cls": "ExprName"}, "description": "When the node does not have next siblings."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "ast_next", "name": "AST", "cls": "ExprName"}, "description": "The sibling."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_next", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L119-L134", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_next", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "ast_next", "name": "AST", "cls": "ExprName"}}, "ast_first_child": {"kind": "function", "name": "ast_first_child", "runtime": true, "lineno": 137, "endlineno": 152, "docstring": {"value": "Return the first child of this node.\n\nParameters:\n    node: The AST node.\n\nRaises:\n    LastNodeError: When the node does not have children.\n\nReturns:\n    The child.", "lineno": 138, "endlineno": 148, "parsed": [{"kind": "text", "value": "Return the first child of this node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_first_child", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "LastNodeError", "cls": "ExprName"}, "description": "When the node does not have children."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "ast_first_child", "name": "AST", "cls": "ExprName"}, "description": "The child."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_first_child", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L137-L152", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_first_child", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "ast_first_child", "name": "AST", "cls": "ExprName"}}, "ast_last_child": {"kind": "function", "name": "ast_last_child", "runtime": true, "lineno": 155, "endlineno": 171, "docstring": {"value": "Return the lasts child of this node.\n\nParameters:\n    node: The AST node.\n\nRaises:\n    LastNodeError: When the node does not have children.\n\nReturns:\n    The child.", "lineno": 156, "endlineno": 166, "parsed": [{"kind": "text", "value": "Return the lasts child of this node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "ast_last_child", "name": "AST", "cls": "ExprName"}, "description": "The AST node."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "LastNodeError", "cls": "ExprName"}, "description": "When the node does not have children."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "ast_last_child", "name": "AST", "cls": "ExprName"}, "description": "The child."}]}]}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast.ast_last_child", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py#L155-L171", "decorators": [], "parameters": [{"name": "node", "annotation": {"member": "ast_last_child", "name": "AST", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "ast_last_child", "name": "AST", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.agents.nodes.ast", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/ast.py", "relative_package_filepath": "griffe/_internal/agents/nodes/ast.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/ast.py"}}, "analysis": "static", "path": "griffe._internal.agents.nodes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/nodes/__init__.py", "relative_package_filepath": "griffe/_internal/agents/nodes/__init__.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/nodes/__init__.py"}}, "analysis": "static", "path": "griffe._internal.agents", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/agents/__init__.py", "relative_package_filepath": "griffe/_internal/agents/__init__.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/agents/__init__.py"}, "docstrings": {"kind": "module", "name": "docstrings", "runtime": true, "members": {"google": {"kind": "module", "name": "google", "runtime": true, "imports": {"annotations": "__future__.annotations", "re": "re", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "TypedDict": "typing.TypedDict", "DocstringAttribute": "griffe._internal.docstrings.models.DocstringAttribute", "DocstringClass": "griffe._internal.docstrings.models.DocstringClass", "DocstringFunction": "griffe._internal.docstrings.models.DocstringFunction", "DocstringModule": "griffe._internal.docstrings.models.DocstringModule", "DocstringParameter": "griffe._internal.docstrings.models.DocstringParameter", "DocstringRaise": "griffe._internal.docstrings.models.DocstringRaise", "DocstringReceive": "griffe._internal.docstrings.models.DocstringReceive", "DocstringReturn": "griffe._internal.docstrings.models.DocstringReturn", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "DocstringSectionAdmonition": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "DocstringSectionAttributes": "griffe._internal.docstrings.models.DocstringSectionAttributes", "DocstringSectionClasses": "griffe._internal.docstrings.models.DocstringSectionClasses", "DocstringSectionExamples": "griffe._internal.docstrings.models.DocstringSectionExamples", "DocstringSectionFunctions": "griffe._internal.docstrings.models.DocstringSectionFunctions", "DocstringSectionModules": "griffe._internal.docstrings.models.DocstringSectionModules", "DocstringSectionOtherParameters": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "DocstringSectionParameters": "griffe._internal.docstrings.models.DocstringSectionParameters", "DocstringSectionRaises": "griffe._internal.docstrings.models.DocstringSectionRaises", "DocstringSectionReceives": "griffe._internal.docstrings.models.DocstringSectionReceives", "DocstringSectionReturns": "griffe._internal.docstrings.models.DocstringSectionReturns", "DocstringSectionText": "griffe._internal.docstrings.models.DocstringSectionText", "DocstringSectionTypeAliases": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "DocstringSectionTypeParameters": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "DocstringSectionWarns": "griffe._internal.docstrings.models.DocstringSectionWarns", "DocstringSectionYields": "griffe._internal.docstrings.models.DocstringSectionYields", "DocstringTypeAlias": "griffe._internal.docstrings.models.DocstringTypeAlias", "DocstringTypeParameter": "griffe._internal.docstrings.models.DocstringTypeParameter", "DocstringWarn": "griffe._internal.docstrings.models.DocstringWarn", "DocstringYield": "griffe._internal.docstrings.models.DocstringYield", "docstring_warning": "griffe._internal.docstrings.utils.docstring_warning", "parse_docstring_annotation": "griffe._internal.docstrings.utils.parse_docstring_annotation", "DocstringSectionKind": "griffe._internal.enumerations.DocstringSectionKind", "LogLevel": "griffe._internal.enumerations.LogLevel", "Pattern": "re.Pattern", "Any": "typing.Any", "Literal": "typing.Literal", "Expr": "griffe._internal.expressions.Expr", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.docstrings.google.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.docstrings.google.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.google.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.docstrings.google.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypedDict": {"kind": "alias", "name": "TypedDict", "target_path": "typing.TypedDict", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.docstrings.google.TypedDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringAttribute": {"kind": "alias", "name": "DocstringAttribute", "target_path": "griffe._internal.docstrings.models.DocstringAttribute", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringAttribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringClass": {"kind": "alias", "name": "DocstringClass", "target_path": "griffe._internal.docstrings.models.DocstringClass", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringClass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringFunction": {"kind": "alias", "name": "DocstringFunction", "target_path": "griffe._internal.docstrings.models.DocstringFunction", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringFunction", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringModule": {"kind": "alias", "name": "DocstringModule", "target_path": "griffe._internal.docstrings.models.DocstringModule", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringModule", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringParameter": {"kind": "alias", "name": "DocstringParameter", "target_path": "griffe._internal.docstrings.models.DocstringParameter", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringRaise": {"kind": "alias", "name": "DocstringRaise", "target_path": "griffe._internal.docstrings.models.DocstringRaise", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringRaise", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringReceive": {"kind": "alias", "name": "DocstringReceive", "target_path": "griffe._internal.docstrings.models.DocstringReceive", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringReceive", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringReturn": {"kind": "alias", "name": "DocstringReturn", "target_path": "griffe._internal.docstrings.models.DocstringReturn", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringReturn", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionAdmonition": {"kind": "alias", "name": "DocstringSectionAdmonition", "target_path": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionAdmonition", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionAttributes": {"kind": "alias", "name": "DocstringSectionAttributes", "target_path": "griffe._internal.docstrings.models.DocstringSectionAttributes", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionAttributes", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionClasses": {"kind": "alias", "name": "DocstringSectionClasses", "target_path": "griffe._internal.docstrings.models.DocstringSectionClasses", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionClasses", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionExamples": {"kind": "alias", "name": "DocstringSectionExamples", "target_path": "griffe._internal.docstrings.models.DocstringSectionExamples", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionExamples", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionFunctions": {"kind": "alias", "name": "DocstringSectionFunctions", "target_path": "griffe._internal.docstrings.models.DocstringSectionFunctions", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionFunctions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionModules": {"kind": "alias", "name": "DocstringSectionModules", "target_path": "griffe._internal.docstrings.models.DocstringSectionModules", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionModules", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionOtherParameters": {"kind": "alias", "name": "DocstringSectionOtherParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionOtherParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionParameters": {"kind": "alias", "name": "DocstringSectionParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionParameters", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionRaises": {"kind": "alias", "name": "DocstringSectionRaises", "target_path": "griffe._internal.docstrings.models.DocstringSectionRaises", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionRaises", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionReceives": {"kind": "alias", "name": "DocstringSectionReceives", "target_path": "griffe._internal.docstrings.models.DocstringSectionReceives", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionReceives", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionReturns": {"kind": "alias", "name": "DocstringSectionReturns", "target_path": "griffe._internal.docstrings.models.DocstringSectionReturns", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionReturns", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionText": {"kind": "alias", "name": "DocstringSectionText", "target_path": "griffe._internal.docstrings.models.DocstringSectionText", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionText", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionTypeAliases": {"kind": "alias", "name": "DocstringSectionTypeAliases", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionTypeAliases", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionTypeParameters": {"kind": "alias", "name": "DocstringSectionTypeParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionTypeParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionWarns": {"kind": "alias", "name": "DocstringSectionWarns", "target_path": "griffe._internal.docstrings.models.DocstringSectionWarns", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionWarns", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionYields": {"kind": "alias", "name": "DocstringSectionYields", "target_path": "griffe._internal.docstrings.models.DocstringSectionYields", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionYields", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringTypeAlias": {"kind": "alias", "name": "DocstringTypeAlias", "target_path": "griffe._internal.docstrings.models.DocstringTypeAlias", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringTypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringTypeParameter": {"kind": "alias", "name": "DocstringTypeParameter", "target_path": "griffe._internal.docstrings.models.DocstringTypeParameter", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringTypeParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringWarn": {"kind": "alias", "name": "DocstringWarn", "target_path": "griffe._internal.docstrings.models.DocstringWarn", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringWarn", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringYield": {"kind": "alias", "name": "DocstringYield", "target_path": "griffe._internal.docstrings.models.DocstringYield", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 39, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringYield", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "docstring_warning": {"kind": "alias", "name": "docstring_warning", "target_path": "griffe._internal.docstrings.utils.docstring_warning", "runtime": true, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.docstrings.google.docstring_warning", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_docstring_annotation": {"kind": "alias", "name": "parse_docstring_annotation", "target_path": "griffe._internal.docstrings.utils.parse_docstring_annotation", "runtime": true, "inherited": false, "lineno": 40, "endlineno": 40, "analysis": "static", "path": "griffe._internal.docstrings.google.parse_docstring_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionKind": {"kind": "alias", "name": "DocstringSectionKind", "target_path": "griffe._internal.enumerations.DocstringSectionKind", "runtime": true, "inherited": false, "lineno": 41, "endlineno": 41, "analysis": "static", "path": "griffe._internal.docstrings.google.DocstringSectionKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 41, "endlineno": 41, "analysis": "static", "path": "griffe._internal.docstrings.google.LogLevel", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Pattern": {"kind": "alias", "name": "Pattern", "target_path": "re.Pattern", "runtime": false, "inherited": false, "lineno": 44, "endlineno": 44, "analysis": "static", "path": "griffe._internal.docstrings.google.Pattern", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": false, "inherited": false, "lineno": 45, "endlineno": 45, "analysis": "static", "path": "griffe._internal.docstrings.google.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": false, "inherited": false, "lineno": 45, "endlineno": 45, "analysis": "static", "path": "griffe._internal.docstrings.google.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 47, "endlineno": 47, "analysis": "static", "path": "griffe._internal.docstrings.google.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 48, "endlineno": 48, "analysis": "static", "path": "griffe._internal.docstrings.google.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_section_kind": {"kind": "attribute", "name": "_section_kind", "runtime": true, "lineno": 51, "endlineno": 80, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._section_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L51-L80", "value": {"keys": ["'args'", "'arguments'", "'params'", "'parameters'", "'keyword args'", "'keyword arguments'", "'other args'", "'other arguments'", "'other params'", "'other parameters'", "'type args'", "'type arguments'", "'type params'", "'type parameters'", "'raises'", "'exceptions'", "'returns'", "'yields'", "'receives'", "'examples'", "'attributes'", "'functions'", "'methods'", "'classes'", "'type aliases'", "'modules'", "'warns'", "'warnings'"], "values": [{"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "returns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "yields", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "receives", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "attributes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "classes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_aliases", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "modules", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}}, "_BlockItem": {"kind": "attribute", "name": "_BlockItem", "runtime": true, "lineno": 82, "endlineno": 82, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._BlockItem", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L82-L82", "value": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "int", "cls": "ExprName"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_BlockItems": {"kind": "attribute", "name": "_BlockItems", "runtime": true, "lineno": 83, "endlineno": 83, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._BlockItems", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L83-L83", "value": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "_BlockItem", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_ItemsBlock": {"kind": "attribute", "name": "_ItemsBlock", "runtime": true, "lineno": 84, "endlineno": 84, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._ItemsBlock", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L84-L84", "value": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "_BlockItems", "cls": "ExprName"}, {"member": null, "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_RE_ADMONITION": {"kind": "attribute", "name": "_RE_ADMONITION", "runtime": true, "lineno": 86, "endlineno": 86, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._RE_ADMONITION", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L86-L86", "value": {"arguments": ["'^(?P<type>[\\\\w][\\\\s\\\\w-]*):(\\\\s+(?P<title>[^\\\\s].*))?\\\\s*$'", {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "IGNORECASE", "cls": "ExprName"}], "cls": "ExprAttribute"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_NAME_ANNOTATION_DESCRIPTION": {"kind": "attribute", "name": "_RE_NAME_ANNOTATION_DESCRIPTION", "runtime": true, "lineno": 87, "endlineno": 87, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._RE_NAME_ANNOTATION_DESCRIPTION", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L87-L87", "value": {"arguments": ["'^(?:(?P<name>\\\\w+)?\\\\s*(?:\\\\((?P<type>.+)\\\\))?:\\\\s*)?(?P<desc>.*)$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_DOCTEST_BLANKLINE": {"kind": "attribute", "name": "_RE_DOCTEST_BLANKLINE", "runtime": true, "lineno": 88, "endlineno": 88, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._RE_DOCTEST_BLANKLINE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L88-L88", "value": {"arguments": ["'^\\\\s*<BLANKLINE>\\\\s*$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_DOCTEST_FLAGS": {"kind": "attribute", "name": "_RE_DOCTEST_FLAGS", "runtime": true, "lineno": 89, "endlineno": 89, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._RE_DOCTEST_FLAGS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L89-L89", "value": {"arguments": ["'(\\\\s*#\\\\s*doctest:.+)$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_read_block_items": {"kind": "function", "name": "_read_block_items", "runtime": true, "lineno": 92, "endlineno": 153, "analysis": "static", "path": "griffe._internal.docstrings.google._read_block_items", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L92-L153", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_block_items", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_block_items", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_block_items", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_block_items", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_block_items", "name": "_ItemsBlock", "cls": "ExprName"}}, "_read_block": {"kind": "function", "name": "_read_block", "runtime": true, "lineno": 156, "endlineno": 184, "analysis": "static", "path": "griffe._internal.docstrings.google._read_block", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L156-L184", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_block", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_block", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "options", "annotation": {"member": "_read_block", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_block", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_read_block", "name": "str", "cls": "ExprName"}, {"member": "_read_block", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_parameters": {"kind": "function", "name": "_read_parameters", "runtime": true, "lineno": 187, "endlineno": 253, "analysis": "static", "path": "griffe._internal.docstrings.google._read_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L187-L253", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameters", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameters", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_parameters", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_parameters", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_read_parameters", "name": "DocstringParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"member": "_read_parameters", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_parameters_section": {"kind": "function", "name": "_read_parameters_section", "runtime": true, "lineno": 256, "endlineno": 263, "analysis": "static", "path": "griffe._internal.docstrings.google._read_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L256-L263", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "options", "annotation": {"member": "_read_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_parameters_section", "name": "DocstringSectionParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_other_parameters_section": {"kind": "function", "name": "_read_other_parameters_section", "runtime": true, "lineno": 266, "endlineno": 274, "analysis": "static", "path": "griffe._internal.docstrings.google._read_other_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L266-L274", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_other_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_other_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_other_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_other_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_other_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_other_parameters_section", "name": "DocstringSectionOtherParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_other_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_type_parameters_section": {"kind": "function", "name": "_read_type_parameters_section", "runtime": true, "lineno": 277, "endlineno": 343, "analysis": "static", "path": "griffe._internal.docstrings.google._read_type_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L277-L343", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_type_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_type_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_type_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_type_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_type_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_type_parameters_section", "name": "DocstringSectionTypeParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_type_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_attributes_section": {"kind": "function", "name": "_read_attributes_section", "runtime": true, "lineno": 346, "endlineno": 385, "analysis": "static", "path": "griffe._internal.docstrings.google._read_attributes_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L346-L385", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_attributes_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_attributes_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_attributes_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_attributes_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_attributes_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_attributes_section", "name": "DocstringSectionAttributes", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_attributes_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_functions_section": {"kind": "function", "name": "_read_functions_section", "runtime": true, "lineno": 388, "endlineno": 422, "analysis": "static", "path": "griffe._internal.docstrings.google._read_functions_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L388-L422", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_functions_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_functions_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_functions_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_functions_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_functions_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_functions_section", "name": "DocstringSectionFunctions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_functions_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_classes_section": {"kind": "function", "name": "_read_classes_section", "runtime": true, "lineno": 425, "endlineno": 459, "analysis": "static", "path": "griffe._internal.docstrings.google._read_classes_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L425-L459", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_classes_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_classes_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_classes_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_classes_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_classes_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_classes_section", "name": "DocstringSectionClasses", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_classes_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_type_aliases_section": {"kind": "function", "name": "_read_type_aliases_section", "runtime": true, "lineno": 462, "endlineno": 484, "analysis": "static", "path": "griffe._internal.docstrings.google._read_type_aliases_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L462-L484", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_type_aliases_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_type_aliases_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "options", "annotation": {"member": "_read_type_aliases_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_type_aliases_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_type_aliases_section", "name": "DocstringSectionTypeAliases", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_type_aliases_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_modules_section": {"kind": "function", "name": "_read_modules_section", "runtime": true, "lineno": 487, "endlineno": 512, "analysis": "static", "path": "griffe._internal.docstrings.google._read_modules_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L487-L512", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_modules_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_modules_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_modules_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_modules_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_modules_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_modules_section", "name": "DocstringSectionModules", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_modules_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_raises_section": {"kind": "function", "name": "_read_raises_section", "runtime": true, "lineno": 515, "endlineno": 543, "analysis": "static", "path": "griffe._internal.docstrings.google._read_raises_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L515-L543", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_raises_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_raises_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_raises_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_raises_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_raises_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_raises_section", "name": "DocstringSectionRaises", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_raises_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_warns_section": {"kind": "function", "name": "_read_warns_section", "runtime": true, "lineno": 546, "endlineno": 571, "analysis": "static", "path": "griffe._internal.docstrings.google._read_warns_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L546-L571", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_warns_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_warns_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_warns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_warns_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_warns_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_warns_section", "name": "DocstringSectionWarns", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_warns_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_block_items_maybe": {"kind": "function", "name": "_read_block_items_maybe", "runtime": true, "lineno": 574, "endlineno": 584, "analysis": "static", "path": "griffe._internal.docstrings.google._read_block_items_maybe", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L574-L584", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_block_items_maybe", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_block_items_maybe", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "multiple", "annotation": {"member": "_read_block_items_maybe", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_block_items_maybe", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_block_items_maybe", "name": "_ItemsBlock", "cls": "ExprName"}}, "_get_name_annotation_description": {"kind": "function", "name": "_get_name_annotation_description", "runtime": true, "lineno": 587, "endlineno": 615, "analysis": "static", "path": "griffe._internal.docstrings.google._get_name_annotation_description", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L587-L615", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_get_name_annotation_description", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "line_number", "annotation": {"member": "_get_name_annotation_description", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "lines", "annotation": {"left": {"member": "_get_name_annotation_description", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_name_annotation_description", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "named", "annotation": {"member": "_get_name_annotation_description", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_get_name_annotation_description", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "_get_name_annotation_description", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_get_name_annotation_description", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_get_name_annotation_description", "name": "Any", "cls": "ExprName"}, {"member": "_get_name_annotation_description", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_annotation_from_parent": {"kind": "function", "name": "_annotation_from_parent", "runtime": true, "lineno": 618, "endlineno": 634, "analysis": "static", "path": "griffe._internal.docstrings.google._annotation_from_parent", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L618-L634", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_annotation_from_parent", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "gen_index", "annotation": {"left": {"member": "_annotation_from_parent", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["0", "1", "2"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "keyword-only", "default": null}, {"name": "multiple", "annotation": {"member": "_annotation_from_parent", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "index", "annotation": {"member": "_annotation_from_parent", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": "0"}], "returns": {"left": {"left": {"member": "_annotation_from_parent", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_annotation_from_parent", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_read_returns_section": {"kind": "function", "name": "_read_returns_section", "runtime": true, "lineno": 637, "endlineno": 680, "analysis": "static", "path": "griffe._internal.docstrings.google._read_returns_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L637-L680", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_returns_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_returns_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "returns_multiple_items", "annotation": {"member": "_read_returns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "returns_named_value", "annotation": {"member": "_read_returns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "_read_returns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_returns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_returns_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_returns_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_returns_section", "name": "DocstringSectionReturns", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_returns_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_yields_section": {"kind": "function", "name": "_read_yields_section", "runtime": true, "lineno": 683, "endlineno": 726, "analysis": "static", "path": "griffe._internal.docstrings.google._read_yields_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L683-L726", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_yields_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_yields_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "returns_multiple_items", "annotation": {"member": "_read_yields_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "returns_named_value", "annotation": {"member": "_read_yields_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "_read_yields_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_yields_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_yields_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_yields_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_yields_section", "name": "DocstringSectionYields", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_yields_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_receives_section": {"kind": "function", "name": "_read_receives_section", "runtime": true, "lineno": 729, "endlineno": 772, "analysis": "static", "path": "griffe._internal.docstrings.google._read_receives_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L729-L772", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_receives_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_receives_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "receives_multiple_items", "annotation": {"member": "_read_receives_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "receives_named_value", "annotation": {"member": "_read_receives_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "_read_receives_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_receives_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_receives_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_receives_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_receives_section", "name": "DocstringSectionReceives", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_receives_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_examples_section": {"kind": "function", "name": "_read_examples_section", "runtime": true, "lineno": 775, "endlineno": 831, "analysis": "static", "path": "griffe._internal.docstrings.google._read_examples_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L775-L831", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_examples_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_examples_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "trim_doctest_flags", "annotation": {"member": "_read_examples_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_examples_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_examples_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_examples_section", "name": "DocstringSectionExamples", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_examples_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_is_empty_line": {"kind": "function", "name": "_is_empty_line", "runtime": true, "lineno": 834, "endlineno": 835, "analysis": "static", "path": "griffe._internal.docstrings.google._is_empty_line", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L834-L835", "decorators": [], "parameters": [{"name": "line", "annotation": {"member": "_is_empty_line", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_is_empty_line", "name": "bool", "cls": "ExprName"}}, "_section_reader": {"kind": "attribute", "name": "_section_reader", "runtime": true, "lineno": 838, "endlineno": 853, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.google._section_reader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L838-L853", "value": {"keys": [{"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "attributes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "classes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_aliases", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "modules", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "returns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "yields", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "receives", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_read_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_other_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_type_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_raises_section", "cls": "ExprName"}, {"member": null, "name": "_read_warns_section", "cls": "ExprName"}, {"member": null, "name": "_read_examples_section", "cls": "ExprName"}, {"member": null, "name": "_read_attributes_section", "cls": "ExprName"}, {"member": null, "name": "_read_functions_section", "cls": "ExprName"}, {"member": null, "name": "_read_classes_section", "cls": "ExprName"}, {"member": null, "name": "_read_type_aliases_section", "cls": "ExprName"}, {"member": null, "name": "_read_modules_section", "cls": "ExprName"}, {"member": null, "name": "_read_returns_section", "cls": "ExprName"}, {"member": null, "name": "_read_yields_section", "cls": "ExprName"}, {"member": null, "name": "_read_receives_section", "cls": "ExprName"}], "cls": "ExprDict"}}, "GoogleOptions": {"kind": "class", "name": "GoogleOptions", "runtime": true, "lineno": 856, "endlineno": 878, "docstring": {"value": "Options for parsing Google-style docstrings.", "lineno": 857, "endlineno": 857, "parsed": [{"kind": "text", "value": "Options for parsing Google-style docstrings."}]}, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "ignore_init_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to ignore the summary in `__init__` methods' docstrings.", "value": "..."}, {"name": "trim_doctest_flags", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to remove doctest flags from Python example blocks.", "value": "..."}, {"name": "returns_multiple_items", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to parse multiple items in `Yields` and `Returns` sections.", "value": "..."}, {"name": "returns_named_value", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description.", "value": "..."}, {"name": "returns_type_in_property_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to parse the return type of properties at the beginning of their summary.", "value": "..."}, {"name": "receives_multiple_items", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to parse multiple items in `Receives` sections.", "value": "..."}, {"name": "receives_named_value", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to parse `Receives` section items as name and description, rather than type and description.", "value": "..."}, {"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to warn about unknown parameters.", "value": "..."}, {"name": "warn_missing_types", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to warn about missing types/annotations for parameters, return values, etc.", "value": "..."}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to issue warnings for parsing issues.", "value": "..."}]}]}, "path": "griffe._internal.docstrings.google.GoogleOptions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "ignore_init_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to ignore the summary in `__init__` methods' docstrings.", "lineno": 860, "endlineno": 860, "parsed": [{"kind": "text", "value": "Whether to ignore the summary in `__init__` methods' docstrings."}]}}, {"name": "trim_doctest_flags", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to remove doctest flags from Python example blocks.", "lineno": 862, "endlineno": 862, "parsed": [{"kind": "text", "value": "Whether to remove doctest flags from Python example blocks."}]}}, {"name": "returns_multiple_items", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to parse multiple items in `Yields` and `Returns` sections.", "lineno": 864, "endlineno": 864, "parsed": [{"kind": "text", "value": "Whether to parse multiple items in `Yields` and `Returns` sections."}]}}, {"name": "returns_named_value", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description.", "lineno": 866, "endlineno": 866, "parsed": [{"kind": "text", "value": "Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description."}]}}, {"name": "returns_type_in_property_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to parse the return type of properties at the beginning of their summary.", "lineno": 868, "endlineno": 868, "parsed": [{"kind": "text", "value": "Whether to parse the return type of properties at the beginning of their summary."}]}}, {"name": "receives_multiple_items", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to parse multiple items in `Receives` sections.", "lineno": 870, "endlineno": 870, "parsed": [{"kind": "text", "value": "Whether to parse multiple items in `Receives` sections."}]}}, {"name": "receives_named_value", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to parse `Receives` section items as name and description, rather than type and description.", "lineno": 872, "endlineno": 872, "parsed": [{"kind": "text", "value": "Whether to parse `Receives` section items as name and description, rather than type and description."}]}}, {"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to warn about unknown parameters.", "lineno": 874, "endlineno": 874, "parsed": [{"kind": "text", "value": "Whether to warn about unknown parameters."}]}}, {"name": "warn_missing_types", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to warn about missing types/annotations for parameters, return values, etc.", "lineno": 876, "endlineno": 876, "parsed": [{"kind": "text", "value": "Whether to warn about missing types/annotations for parameters, return values, etc."}]}}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to issue warnings for parsing issues.", "lineno": 878, "endlineno": 878, "parsed": [{"kind": "text", "value": "Whether to issue warnings for parsing issues."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.google.GoogleOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L856-L878", "bases": [{"member": "GoogleOptions", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "parse_google": {"kind": "function", "name": "parse_google", "runtime": true, "lineno": 881, "endlineno": 1057, "docstring": {"value": "Parse a Google-style docstring.\n\nThis function iterates on lines of a docstring to build sections.\nIt then returns this list of sections.\n\nParameters:\n    docstring: The docstring to parse.\n    ignore_init_summary: Whether to ignore the summary in `__init__` methods' docstrings.\n    trim_doctest_flags: Whether to remove doctest flags from Python example blocks.\n    returns_multiple_items: Whether to parse multiple items in `Yields` and `Returns` sections.\n        When true, each item's continuation lines must be indented.\n        When false (single item), no further indentation is required.\n    returns_named_value: Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description.\n        When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.\n        When false, parentheses are optional but the items cannot be named: `int: Description`.\n    receives_multiple_items: Whether to parse multiple items in `Receives` sections.\n        When true, each item's continuation lines must be indented.\n        When false (single item), no further indentation is required.\n    receives_named_value: Whether to parse `Receives` section items as name and description, rather than type and description.\n        When true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.\n        When false, parentheses are optional but the items cannot be named: `int: Description`.\n    returns_type_in_property_summary: Whether to parse the return type of properties\n        at the beginning of their summary: `str: Summary of the property`.\n    warn_unknown_params: Warn about documented parameters not appearing in the signature.\n    warn_missing_types: Warn about missing types/annotations for parameters, return values, etc.\n    warnings: Whether to log warnings at all.\n\nReturns:\n    A list of docstring sections.", "lineno": 895, "endlineno": 924, "parsed": [{"kind": "text", "value": "Parse a Google-style docstring.\n\nThis function iterates on lines of a docstring to build sections.\nIt then returns this list of sections."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "parse_google", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "ignore_init_summary", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to ignore the summary in `__init__` methods' docstrings.", "value": "False"}, {"name": "trim_doctest_flags", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to remove doctest flags from Python example blocks.", "value": "True"}, {"name": "returns_multiple_items", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to parse multiple items in `Yields` and `Returns` sections.\nWhen true, each item's continuation lines must be indented.\nWhen false (single item), no further indentation is required.", "value": "True"}, {"name": "returns_named_value", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to parse `Yields` and `Returns` section items as name and description, rather than type and description.\nWhen true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.\nWhen false, parentheses are optional but the items cannot be named: `int: Description`.", "value": "True"}, {"name": "receives_multiple_items", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to parse multiple items in `Receives` sections.\nWhen true, each item's continuation lines must be indented.\nWhen false (single item), no further indentation is required.", "value": "True"}, {"name": "receives_named_value", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to parse `Receives` section items as name and description, rather than type and description.\nWhen true, type must be wrapped in parentheses: `(int): Description.`. Names are optional: `name (int): Description.`.\nWhen false, parentheses are optional but the items cannot be named: `int: Description`.", "value": "True"}, {"name": "returns_type_in_property_summary", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to parse the return type of properties\nat the beginning of their summary: `str: Summary of the property`.", "value": "False"}, {"name": "warn_unknown_params", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Warn about documented parameters not appearing in the signature.", "value": "True"}, {"name": "warn_missing_types", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Warn about missing types/annotations for parameters, return values, etc.", "value": "True"}, {"name": "warnings", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "description": "Whether to log warnings at all.", "value": "True"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse_google", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_google", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of docstring sections."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.google.parse_google", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/google.py#L881-L1057", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "parse_google", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "ignore_init_summary", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "trim_doctest_flags", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "returns_multiple_items", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "returns_named_value", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "returns_type_in_property_summary", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "receives_multiple_items", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "receives_named_value", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_unknown_params", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "parse_google", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "parse_google", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_google", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.google", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/google.py", "relative_package_filepath": "griffe/_internal/docstrings/google.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/google.py"}, "parsers": {"kind": "module", "name": "parsers", "runtime": true, "imports": {"annotations": "__future__.annotations", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "Literal": "typing.Literal", "AutoOptions": "griffe._internal.docstrings.auto.AutoOptions", "parse_auto": "griffe._internal.docstrings.auto.parse_auto", "GoogleOptions": "griffe._internal.docstrings.google.GoogleOptions", "parse_google": "griffe._internal.docstrings.google.parse_google", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "DocstringSectionText": "griffe._internal.docstrings.models.DocstringSectionText", "NumpyOptions": "griffe._internal.docstrings.numpy.NumpyOptions", "parse_numpy": "griffe._internal.docstrings.numpy.parse_numpy", "SphinxOptions": "griffe._internal.docstrings.sphinx.SphinxOptions", "parse_sphinx": "griffe._internal.docstrings.sphinx.parse_sphinx", "Parser": "griffe._internal.enumerations.Parser", "Callable": "collections.abc.Callable", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.docstrings.parsers.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.parsers.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.parsers.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.parsers.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "AutoOptions": {"kind": "alias", "name": "AutoOptions", "target_path": "griffe._internal.docstrings.auto.AutoOptions", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.docstrings.parsers.AutoOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_auto": {"kind": "alias", "name": "parse_auto", "target_path": "griffe._internal.docstrings.auto.parse_auto", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.docstrings.parsers.parse_auto", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GoogleOptions": {"kind": "alias", "name": "GoogleOptions", "target_path": "griffe._internal.docstrings.google.GoogleOptions", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.docstrings.parsers.GoogleOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_google": {"kind": "alias", "name": "parse_google", "target_path": "griffe._internal.docstrings.google.parse_google", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.docstrings.parsers.parse_google", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.docstrings.parsers.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionText": {"kind": "alias", "name": "DocstringSectionText", "target_path": "griffe._internal.docstrings.models.DocstringSectionText", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.docstrings.parsers.DocstringSectionText", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "NumpyOptions": {"kind": "alias", "name": "NumpyOptions", "target_path": "griffe._internal.docstrings.numpy.NumpyOptions", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.parsers.NumpyOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_numpy": {"kind": "alias", "name": "parse_numpy", "target_path": "griffe._internal.docstrings.numpy.parse_numpy", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.parsers.parse_numpy", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "SphinxOptions": {"kind": "alias", "name": "SphinxOptions", "target_path": "griffe._internal.docstrings.sphinx.SphinxOptions", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.parsers.SphinxOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_sphinx": {"kind": "alias", "name": "parse_sphinx", "target_path": "griffe._internal.docstrings.sphinx.parse_sphinx", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.parsers.parse_sphinx", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.docstrings.parsers.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.docstrings.parsers.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.docstrings.parsers.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "attribute", "name": "DocstringStyle", "runtime": true, "lineno": 21, "endlineno": 21, "docstring": {"value": "The supported docstring styles (literal values of the Parser enumeration).", "lineno": 22, "endlineno": 22, "parsed": [{"kind": "text", "value": "The supported docstring styles (literal values of the Parser enumeration)."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.parsers.DocstringStyle", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "relative_package_filepath": "griffe/_internal/docstrings/parsers.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/parsers.py#L21-L21", "value": {"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'google'", "'numpy'", "'sphinx'", "'auto'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "DocstringOptions": {"kind": "attribute", "name": "DocstringOptions", "runtime": true, "lineno": 23, "endlineno": 23, "docstring": {"value": "The options for each docstring style.", "lineno": 24, "endlineno": 24, "parsed": [{"kind": "text", "value": "The options for each docstring style."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.parsers.DocstringOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "relative_package_filepath": "griffe/_internal/docstrings/parsers.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/parsers.py#L23-L23", "value": {"left": {"left": {"left": {"member": null, "name": "GoogleOptions", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "NumpyOptions", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "SphinxOptions", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "AutoOptions", "cls": "ExprName"}, "cls": "ExprBinOp"}}, "parsers": {"kind": "attribute", "name": "parsers", "runtime": true, "lineno": 27, "endlineno": 32, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.parsers.parsers", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "relative_package_filepath": "griffe/_internal/docstrings/parsers.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/parsers.py#L27-L32", "value": {"keys": [{"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "auto", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "google", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "sphinx", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "numpy", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "parse_auto", "cls": "ExprName"}, {"member": null, "name": "parse_google", "cls": "ExprName"}, {"member": null, "name": "parse_sphinx", "cls": "ExprName"}, {"member": null, "name": "parse_numpy", "cls": "ExprName"}], "cls": "ExprDict"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Docstring", "cls": "ExprName"}], "cls": "ExprList"}, {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "parse": {"kind": "function", "name": "parse", "runtime": true, "lineno": 35, "endlineno": 54, "docstring": {"value": "Parse the docstring.\n\nParameters:\n    docstring: The docstring to parse.\n    parser: The docstring parser to use. If None, return a single text section.\n    **options: The options accepted by the parser.\n\nReturns:\n    A list of docstring sections.", "lineno": 40, "endlineno": 49, "parsed": [{"kind": "text", "value": "Parse the docstring."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "parse", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "parser", "annotation": {"left": {"left": {"member": "parse", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The docstring parser to use. If None, return a single text section."}, {"name": "**options", "annotation": {"member": "parse", "name": "Any", "cls": "ExprName"}, "description": "The options accepted by the parser.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of docstring sections."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.parsers.parse", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "relative_package_filepath": "griffe/_internal/docstrings/parsers.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/parsers.py#L35-L54", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "parse", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parser", "annotation": {"left": {"left": {"member": "parse", "name": "DocstringStyle", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse", "name": "Parser", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "options", "annotation": {"member": "parse", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "parse", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.parsers", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/parsers.py", "relative_package_filepath": "griffe/_internal/docstrings/parsers.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/parsers.py"}, "numpy": {"kind": "module", "name": "numpy", "runtime": true, "imports": {"annotations": "__future__.annotations", "re": "re", "suppress": "contextlib.suppress", "dedent": "textwrap.dedent", "TYPE_CHECKING": "typing.TYPE_CHECKING", "TypedDict": "typing.TypedDict", "DocstringAttribute": "griffe._internal.docstrings.models.DocstringAttribute", "DocstringClass": "griffe._internal.docstrings.models.DocstringClass", "DocstringFunction": "griffe._internal.docstrings.models.DocstringFunction", "DocstringModule": "griffe._internal.docstrings.models.DocstringModule", "DocstringParameter": "griffe._internal.docstrings.models.DocstringParameter", "DocstringRaise": "griffe._internal.docstrings.models.DocstringRaise", "DocstringReceive": "griffe._internal.docstrings.models.DocstringReceive", "DocstringReturn": "griffe._internal.docstrings.models.DocstringReturn", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "DocstringSectionAdmonition": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "DocstringSectionAttributes": "griffe._internal.docstrings.models.DocstringSectionAttributes", "DocstringSectionClasses": "griffe._internal.docstrings.models.DocstringSectionClasses", "DocstringSectionDeprecated": "griffe._internal.docstrings.models.DocstringSectionDeprecated", "DocstringSectionExamples": "griffe._internal.docstrings.models.DocstringSectionExamples", "DocstringSectionFunctions": "griffe._internal.docstrings.models.DocstringSectionFunctions", "DocstringSectionModules": "griffe._internal.docstrings.models.DocstringSectionModules", "DocstringSectionOtherParameters": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "DocstringSectionParameters": "griffe._internal.docstrings.models.DocstringSectionParameters", "DocstringSectionRaises": "griffe._internal.docstrings.models.DocstringSectionRaises", "DocstringSectionReceives": "griffe._internal.docstrings.models.DocstringSectionReceives", "DocstringSectionReturns": "griffe._internal.docstrings.models.DocstringSectionReturns", "DocstringSectionText": "griffe._internal.docstrings.models.DocstringSectionText", "DocstringSectionTypeAliases": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "DocstringSectionTypeParameters": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "DocstringSectionWarns": "griffe._internal.docstrings.models.DocstringSectionWarns", "DocstringSectionYields": "griffe._internal.docstrings.models.DocstringSectionYields", "DocstringTypeAlias": "griffe._internal.docstrings.models.DocstringTypeAlias", "DocstringTypeParameter": "griffe._internal.docstrings.models.DocstringTypeParameter", "DocstringWarn": "griffe._internal.docstrings.models.DocstringWarn", "DocstringYield": "griffe._internal.docstrings.models.DocstringYield", "docstring_warning": "griffe._internal.docstrings.utils.docstring_warning", "parse_docstring_annotation": "griffe._internal.docstrings.utils.parse_docstring_annotation", "DocstringSectionKind": "griffe._internal.enumerations.DocstringSectionKind", "LogLevel": "griffe._internal.enumerations.LogLevel", "ExprName": "griffe._internal.expressions.ExprName", "Pattern": "re.Pattern", "Any": "typing.Any", "Literal": "typing.Literal", "Expr": "griffe._internal.expressions.Expr", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.docstrings.numpy.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.docstrings.numpy.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.docstrings.numpy.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dedent": {"kind": "alias", "name": "dedent", "target_path": "textwrap.dedent", "runtime": true, "inherited": false, "lineno": 24, "endlineno": 24, "analysis": "static", "path": "griffe._internal.docstrings.numpy.dedent", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.numpy.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypedDict": {"kind": "alias", "name": "TypedDict", "target_path": "typing.TypedDict", "runtime": true, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.numpy.TypedDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringAttribute": {"kind": "alias", "name": "DocstringAttribute", "target_path": "griffe._internal.docstrings.models.DocstringAttribute", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringAttribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringClass": {"kind": "alias", "name": "DocstringClass", "target_path": "griffe._internal.docstrings.models.DocstringClass", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringClass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringFunction": {"kind": "alias", "name": "DocstringFunction", "target_path": "griffe._internal.docstrings.models.DocstringFunction", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringFunction", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringModule": {"kind": "alias", "name": "DocstringModule", "target_path": "griffe._internal.docstrings.models.DocstringModule", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringModule", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringParameter": {"kind": "alias", "name": "DocstringParameter", "target_path": "griffe._internal.docstrings.models.DocstringParameter", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringRaise": {"kind": "alias", "name": "DocstringRaise", "target_path": "griffe._internal.docstrings.models.DocstringRaise", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringRaise", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringReceive": {"kind": "alias", "name": "DocstringReceive", "target_path": "griffe._internal.docstrings.models.DocstringReceive", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringReceive", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringReturn": {"kind": "alias", "name": "DocstringReturn", "target_path": "griffe._internal.docstrings.models.DocstringReturn", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringReturn", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionAdmonition": {"kind": "alias", "name": "DocstringSectionAdmonition", "target_path": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionAdmonition", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionAttributes": {"kind": "alias", "name": "DocstringSectionAttributes", "target_path": "griffe._internal.docstrings.models.DocstringSectionAttributes", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionAttributes", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionClasses": {"kind": "alias", "name": "DocstringSectionClasses", "target_path": "griffe._internal.docstrings.models.DocstringSectionClasses", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionClasses", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionDeprecated": {"kind": "alias", "name": "DocstringSectionDeprecated", "target_path": "griffe._internal.docstrings.models.DocstringSectionDeprecated", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionDeprecated", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionExamples": {"kind": "alias", "name": "DocstringSectionExamples", "target_path": "griffe._internal.docstrings.models.DocstringSectionExamples", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionExamples", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionFunctions": {"kind": "alias", "name": "DocstringSectionFunctions", "target_path": "griffe._internal.docstrings.models.DocstringSectionFunctions", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionFunctions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionModules": {"kind": "alias", "name": "DocstringSectionModules", "target_path": "griffe._internal.docstrings.models.DocstringSectionModules", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionModules", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionOtherParameters": {"kind": "alias", "name": "DocstringSectionOtherParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionOtherParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionParameters": {"kind": "alias", "name": "DocstringSectionParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionParameters", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionRaises": {"kind": "alias", "name": "DocstringSectionRaises", "target_path": "griffe._internal.docstrings.models.DocstringSectionRaises", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionRaises", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionReceives": {"kind": "alias", "name": "DocstringSectionReceives", "target_path": "griffe._internal.docstrings.models.DocstringSectionReceives", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionReceives", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionReturns": {"kind": "alias", "name": "DocstringSectionReturns", "target_path": "griffe._internal.docstrings.models.DocstringSectionReturns", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionReturns", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionText": {"kind": "alias", "name": "DocstringSectionText", "target_path": "griffe._internal.docstrings.models.DocstringSectionText", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionText", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionTypeAliases": {"kind": "alias", "name": "DocstringSectionTypeAliases", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionTypeAliases", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionTypeParameters": {"kind": "alias", "name": "DocstringSectionTypeParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionTypeParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionWarns": {"kind": "alias", "name": "DocstringSectionWarns", "target_path": "griffe._internal.docstrings.models.DocstringSectionWarns", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionWarns", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionYields": {"kind": "alias", "name": "DocstringSectionYields", "target_path": "griffe._internal.docstrings.models.DocstringSectionYields", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionYields", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringTypeAlias": {"kind": "alias", "name": "DocstringTypeAlias", "target_path": "griffe._internal.docstrings.models.DocstringTypeAlias", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringTypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringTypeParameter": {"kind": "alias", "name": "DocstringTypeParameter", "target_path": "griffe._internal.docstrings.models.DocstringTypeParameter", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringTypeParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringWarn": {"kind": "alias", "name": "DocstringWarn", "target_path": "griffe._internal.docstrings.models.DocstringWarn", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringWarn", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringYield": {"kind": "alias", "name": "DocstringYield", "target_path": "griffe._internal.docstrings.models.DocstringYield", "runtime": true, "inherited": false, "lineno": 27, "endlineno": 58, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringYield", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "docstring_warning": {"kind": "alias", "name": "docstring_warning", "target_path": "griffe._internal.docstrings.utils.docstring_warning", "runtime": true, "inherited": false, "lineno": 59, "endlineno": 59, "analysis": "static", "path": "griffe._internal.docstrings.numpy.docstring_warning", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_docstring_annotation": {"kind": "alias", "name": "parse_docstring_annotation", "target_path": "griffe._internal.docstrings.utils.parse_docstring_annotation", "runtime": true, "inherited": false, "lineno": 59, "endlineno": 59, "analysis": "static", "path": "griffe._internal.docstrings.numpy.parse_docstring_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionKind": {"kind": "alias", "name": "DocstringSectionKind", "target_path": "griffe._internal.enumerations.DocstringSectionKind", "runtime": true, "inherited": false, "lineno": 60, "endlineno": 60, "analysis": "static", "path": "griffe._internal.docstrings.numpy.DocstringSectionKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 60, "endlineno": 60, "analysis": "static", "path": "griffe._internal.docstrings.numpy.LogLevel", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprName": {"kind": "alias", "name": "ExprName", "target_path": "griffe._internal.expressions.ExprName", "runtime": true, "inherited": false, "lineno": 61, "endlineno": 61, "analysis": "static", "path": "griffe._internal.docstrings.numpy.ExprName", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Pattern": {"kind": "alias", "name": "Pattern", "target_path": "re.Pattern", "runtime": false, "inherited": false, "lineno": 64, "endlineno": 64, "analysis": "static", "path": "griffe._internal.docstrings.numpy.Pattern", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": false, "inherited": false, "lineno": 65, "endlineno": 65, "analysis": "static", "path": "griffe._internal.docstrings.numpy.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": false, "inherited": false, "lineno": 65, "endlineno": 65, "analysis": "static", "path": "griffe._internal.docstrings.numpy.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 67, "endlineno": 67, "analysis": "static", "path": "griffe._internal.docstrings.numpy.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 68, "endlineno": 68, "analysis": "static", "path": "griffe._internal.docstrings.numpy.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_section_kind": {"kind": "attribute", "name": "_section_kind", "runtime": true, "lineno": 71, "endlineno": 88, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._section_kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L71-L88", "value": {"keys": ["'deprecated'", "'parameters'", "'other parameters'", "'type parameters'", "'returns'", "'yields'", "'receives'", "'raises'", "'warns'", "'examples'", "'attributes'", "'functions'", "'methods'", "'classes'", "'type aliases'", "'modules'"], "values": [{"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "deprecated", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "returns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "yields", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "receives", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "attributes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "classes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_aliases", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "modules", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprDict"}}, "_is_empty_line": {"kind": "function", "name": "_is_empty_line", "runtime": true, "lineno": 91, "endlineno": 92, "analysis": "static", "path": "griffe._internal.docstrings.numpy._is_empty_line", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L91-L92", "decorators": [], "parameters": [{"name": "line", "annotation": {"member": "_is_empty_line", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_is_empty_line", "name": "bool", "cls": "ExprName"}}, "_is_dash_line": {"kind": "function", "name": "_is_dash_line", "runtime": true, "lineno": 95, "endlineno": 96, "analysis": "static", "path": "griffe._internal.docstrings.numpy._is_dash_line", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L95-L96", "decorators": [], "parameters": [{"name": "line", "annotation": {"member": "_is_dash_line", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_is_dash_line", "name": "bool", "cls": "ExprName"}}, "_read_block_items": {"kind": "function", "name": "_read_block_items", "runtime": true, "lineno": 99, "endlineno": 158, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_block_items", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L99-L158", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_block_items", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_block_items", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_block_items", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_block_items", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_block_items", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_block_items", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "_read_block_items", "name": "list", "cls": "ExprName"}, "slice": {"member": "_read_block_items", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}, {"member": "_read_block_items", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_block": {"kind": "function", "name": "_read_block", "runtime": true, "lineno": 161, "endlineno": 183, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_block", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L161-L183", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_block", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_block", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "options", "annotation": {"member": "_read_block", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_block", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_read_block", "name": "str", "cls": "ExprName"}, {"member": "_read_block", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_RE_OB": {"kind": "attribute", "name": "_RE_OB", "runtime": true, "lineno": 186, "endlineno": 186, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_OB", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L186-L186", "value": "'\\\\{'", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "_RE_CB": {"kind": "attribute", "name": "_RE_CB", "runtime": true, "lineno": 187, "endlineno": 187, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_CB", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L187-L187", "value": "'\\\\}'", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "_RE_NAME": {"kind": "attribute", "name": "_RE_NAME", "runtime": true, "lineno": 188, "endlineno": 188, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_NAME", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L188-L188", "value": "'\\\\*{0,2}[_a-z][_a-z0-9]*'", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "_RE_TYPE": {"kind": "attribute", "name": "_RE_TYPE", "runtime": true, "lineno": 189, "endlineno": 189, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_TYPE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L189-L189", "value": "'.+'", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "_RE_RETURNS": {"kind": "attribute", "name": "_RE_RETURNS", "runtime": true, "lineno": 190, "endlineno": 203, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_RETURNS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L190-L203", "value": {"arguments": [{"values": ["\n    (?:\n        (?P<nt_name>", {"value": {"member": null, "name": "_RE_NAME", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")\\s*:\\s*(?P<nt_type>", {"value": {"member": null, "name": "_RE_TYPE", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")  # name and type\n        |  # or\n        (?P<name>", {"value": {"member": null, "name": "_RE_NAME", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")\\s*:\\s*  # just name\n        |  # or\n        \\s*:\\s*$  # no name, no type\n        |  # or\n        (?::\\s*)?(?P<type>", {"value": {"member": null, "name": "_RE_TYPE", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")\\s*  # just type\n    )\n    "], "cls": "ExprJoinedStr"}, {"left": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "IGNORECASE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "VERBOSE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_YIELDS": {"kind": "attribute", "name": "_RE_YIELDS", "runtime": true, "lineno": 204, "endlineno": 204, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_YIELDS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L204-L204", "value": {"member": null, "name": "_RE_RETURNS", "cls": "ExprName"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_RECEIVES": {"kind": "attribute", "name": "_RE_RECEIVES", "runtime": true, "lineno": 205, "endlineno": 205, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_RECEIVES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L205-L205", "value": {"member": null, "name": "_RE_RETURNS", "cls": "ExprName"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_PARAMETER": {"kind": "attribute", "name": "_RE_PARAMETER", "runtime": true, "lineno": 206, "endlineno": 218, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_PARAMETER", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L206-L218", "value": {"arguments": [{"values": ["\n    (?P<names>", {"value": {"member": null, "name": "_RE_NAME", "cls": "ExprName"}, "cls": "ExprFormatted"}, "(?:,\\s", {"value": {"member": null, "name": "_RE_NAME", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")*)\n    (?:\n        \\s:\\s\n        (?:\n            (?:", {"value": {"member": null, "name": "_RE_OB", "cls": "ExprName"}, "cls": "ExprFormatted"}, "(?P<choices>.+)", {"value": {"member": null, "name": "_RE_CB", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")|\n            (?P<type>", {"value": {"member": null, "name": "_RE_TYPE", "cls": "ExprName"}, "cls": "ExprFormatted"}, ")\n        )?\n    )?\n    "], "cls": "ExprJoinedStr"}, {"left": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "IGNORECASE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "VERBOSE", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprBinOp"}], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_DOCTEST_BLANKLINE": {"kind": "attribute", "name": "_RE_DOCTEST_BLANKLINE", "runtime": true, "lineno": 219, "endlineno": 219, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_DOCTEST_BLANKLINE", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L219-L219", "value": {"arguments": ["'^\\\\s*<BLANKLINE>\\\\s*$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_RE_DOCTEST_FLAGS": {"kind": "attribute", "name": "_RE_DOCTEST_FLAGS", "runtime": true, "lineno": 220, "endlineno": 220, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._RE_DOCTEST_FLAGS", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L220-L220", "value": {"arguments": ["'(\\\\s*#\\\\s*doctest:.+)$'"], "function": {"values": [{"member": null, "name": "re", "cls": "ExprName"}, {"member": null, "name": "compile", "cls": "ExprName"}], "cls": "ExprAttribute"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "Pattern", "cls": "ExprName"}}, "_read_parameters": {"kind": "function", "name": "_read_parameters", "runtime": true, "lineno": 223, "endlineno": 294, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L223-L294", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameters", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameters", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_parameters", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_parameters", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_parameters", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_read_parameters", "name": "DocstringParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"member": "_read_parameters", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_parameters_section": {"kind": "function", "name": "_read_parameters_section", "runtime": true, "lineno": 297, "endlineno": 309, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L297-L309", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_parameters_section", "name": "DocstringSectionParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_other_parameters_section": {"kind": "function", "name": "_read_other_parameters_section", "runtime": true, "lineno": 312, "endlineno": 331, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_other_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L312-L331", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_other_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_other_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_other_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_other_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_other_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_other_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_other_parameters_section", "name": "DocstringSectionOtherParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_other_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_type_parameters_section": {"kind": "function", "name": "_read_type_parameters_section", "runtime": true, "lineno": 334, "endlineno": 401, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_type_parameters_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L334-L401", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_type_parameters_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_type_parameters_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_type_parameters_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_type_parameters_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_type_parameters_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_type_parameters_section", "name": "DocstringSectionTypeParameters", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_type_parameters_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_deprecated_section": {"kind": "function", "name": "_read_deprecated_section", "runtime": true, "lineno": 404, "endlineno": 427, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_deprecated_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L404-L427", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_deprecated_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_deprecated_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_deprecated_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_deprecated_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_deprecated_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_deprecated_section", "name": "DocstringSectionDeprecated", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_deprecated_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_returns_section": {"kind": "function", "name": "_read_returns_section", "runtime": true, "lineno": 430, "endlineno": 486, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_returns_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L430-L486", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_returns_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_returns_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_returns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_returns_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_returns_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_returns_section", "name": "DocstringSectionReturns", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_returns_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_yields_section": {"kind": "function", "name": "_read_yields_section", "runtime": true, "lineno": 489, "endlineno": 537, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_yields_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L489-L537", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_yields_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_yields_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_yields_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_yields_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_yields_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_yields_section", "name": "DocstringSectionYields", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_yields_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_receives_section": {"kind": "function", "name": "_read_receives_section", "runtime": true, "lineno": 540, "endlineno": 584, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_receives_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L540-L584", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_receives_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_receives_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_receives_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_receives_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_receives_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_receives_section", "name": "DocstringSectionReceives", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_receives_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_raises_section": {"kind": "function", "name": "_read_raises_section", "runtime": true, "lineno": 587, "endlineno": 609, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_raises_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L587-L609", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_raises_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_raises_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_raises_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_raises_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_raises_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_raises_section", "name": "DocstringSectionRaises", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_raises_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_warns_section": {"kind": "function", "name": "_read_warns_section", "runtime": true, "lineno": 612, "endlineno": 634, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_warns_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L612-L634", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_warns_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_warns_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_warns_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_warns_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_warns_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_warns_section", "name": "DocstringSectionWarns", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_warns_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_attributes_section": {"kind": "function", "name": "_read_attributes_section", "runtime": true, "lineno": 637, "endlineno": 673, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_attributes_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L637-L673", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_attributes_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_attributes_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_attributes_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_attributes_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_attributes_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_attributes_section", "name": "DocstringSectionAttributes", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_attributes_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_functions_section": {"kind": "function", "name": "_read_functions_section", "runtime": true, "lineno": 676, "endlineno": 705, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_functions_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L676-L705", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_functions_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_functions_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_functions_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_functions_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_functions_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_functions_section", "name": "DocstringSectionFunctions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_functions_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_classes_section": {"kind": "function", "name": "_read_classes_section", "runtime": true, "lineno": 708, "endlineno": 737, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_classes_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L708-L737", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_classes_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_classes_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_classes_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_classes_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_classes_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_classes_section", "name": "DocstringSectionClasses", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_classes_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_type_aliases_section": {"kind": "function", "name": "_read_type_aliases_section", "runtime": true, "lineno": 740, "endlineno": 757, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_type_aliases_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L740-L757", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_type_aliases_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_type_aliases_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "options", "annotation": {"member": "_read_type_aliases_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_type_aliases_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_type_aliases_section", "name": "DocstringSectionTypeAliases", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_type_aliases_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_modules_section": {"kind": "function", "name": "_read_modules_section", "runtime": true, "lineno": 760, "endlineno": 789, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_modules_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L760-L789", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_modules_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_modules_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "warnings", "annotation": {"member": "_read_modules_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_modules_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_modules_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_modules_section", "name": "DocstringSectionModules", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_modules_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_read_examples_section": {"kind": "function", "name": "_read_examples_section", "runtime": true, "lineno": 792, "endlineno": 854, "analysis": "static", "path": "griffe._internal.docstrings.numpy._read_examples_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L792-L854", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_examples_section", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_examples_section", "name": "int", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "trim_doctest_flags", "annotation": {"member": "_read_examples_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_examples_section", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_examples_section", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "_read_examples_section", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_read_examples_section", "name": "DocstringSectionExamples", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_read_examples_section", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_append_section": {"kind": "function", "name": "_append_section", "runtime": true, "lineno": 857, "endlineno": 873, "analysis": "static", "path": "griffe._internal.docstrings.numpy._append_section", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L857-L873", "decorators": [], "parameters": [{"name": "sections", "annotation": {"member": "_append_section", "name": "list", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "current", "annotation": {"left": {"member": "_append_section", "name": "list", "cls": "ExprName"}, "slice": {"member": "_append_section", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "admonition_title", "annotation": {"member": "_append_section", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_section_reader": {"kind": "attribute", "name": "_section_reader", "runtime": true, "lineno": 876, "endlineno": 892, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.numpy._section_reader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L876-L892", "value": {"keys": [{"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "deprecated", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "attributes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "classes", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_aliases", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "modules", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "returns", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "yields", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "receives", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"member": null, "name": "_read_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_other_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_type_parameters_section", "cls": "ExprName"}, {"member": null, "name": "_read_deprecated_section", "cls": "ExprName"}, {"member": null, "name": "_read_raises_section", "cls": "ExprName"}, {"member": null, "name": "_read_warns_section", "cls": "ExprName"}, {"member": null, "name": "_read_examples_section", "cls": "ExprName"}, {"member": null, "name": "_read_attributes_section", "cls": "ExprName"}, {"member": null, "name": "_read_functions_section", "cls": "ExprName"}, {"member": null, "name": "_read_classes_section", "cls": "ExprName"}, {"member": null, "name": "_read_type_aliases_section", "cls": "ExprName"}, {"member": null, "name": "_read_modules_section", "cls": "ExprName"}, {"member": null, "name": "_read_returns_section", "cls": "ExprName"}, {"member": null, "name": "_read_yields_section", "cls": "ExprName"}, {"member": null, "name": "_read_receives_section", "cls": "ExprName"}], "cls": "ExprDict"}}, "NumpyOptions": {"kind": "class", "name": "NumpyOptions", "runtime": true, "lineno": 895, "endlineno": 907, "docstring": {"value": "Options for parsing Numpydoc-style docstrings.", "lineno": 896, "endlineno": 896, "parsed": [{"kind": "text", "value": "Options for parsing Numpydoc-style docstrings."}]}, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "ignore_init_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to ignore the summary in `__init__` methods' docstrings.", "value": "..."}, {"name": "trim_doctest_flags", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to remove doctest flags from Python example blocks.", "value": "..."}, {"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to warn about unknown parameters.", "value": "..."}, {"name": "warn_missing_types", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to warn about missing types/annotations for parameters, return values, etc.", "value": "..."}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to issue warnings for parsing issues.", "value": "..."}]}]}, "path": "griffe._internal.docstrings.numpy.NumpyOptions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "ignore_init_summary", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to ignore the summary in `__init__` methods' docstrings.", "lineno": 899, "endlineno": 899, "parsed": [{"kind": "text", "value": "Whether to ignore the summary in `__init__` methods' docstrings."}]}}, {"name": "trim_doctest_flags", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to remove doctest flags from Python example blocks.", "lineno": 901, "endlineno": 901, "parsed": [{"kind": "text", "value": "Whether to remove doctest flags from Python example blocks."}]}}, {"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to warn about unknown parameters.", "lineno": 903, "endlineno": 903, "parsed": [{"kind": "text", "value": "Whether to warn about unknown parameters."}]}}, {"name": "warn_missing_types", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to warn about missing types/annotations for parameters, return values, etc.", "lineno": 905, "endlineno": 905, "parsed": [{"kind": "text", "value": "Whether to warn about missing types/annotations for parameters, return values, etc."}]}}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to issue warnings for parsing issues.", "lineno": 907, "endlineno": 907, "parsed": [{"kind": "text", "value": "Whether to issue warnings for parsing issues."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.numpy.NumpyOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L895-L907", "bases": [{"member": "NumpyOptions", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "parse_numpy": {"kind": "function", "name": "parse_numpy", "runtime": true, "lineno": 910, "endlineno": 1016, "docstring": {"value": "Parse a Numpydoc-style docstring.\n\nThis function iterates on lines of a docstring to build sections.\nIt then returns this list of sections.\n\nParameters:\n    docstring: The docstring to parse.\n    ignore_init_summary: Whether to ignore the summary in `__init__` methods' docstrings.\n    trim_doctest_flags: Whether to remove doctest flags from Python example blocks.\n    warn_unknown_params: Warn about documented parameters not appearing in the signature.\n    warn_missing_types: Warn about missing types/annotations for parameters, return values, etc.\n    warnings: Whether to log warnings at all.\n\nReturns:\n    A list of docstring sections.", "lineno": 919, "endlineno": 934, "parsed": [{"kind": "text", "value": "Parse a Numpydoc-style docstring.\n\nThis function iterates on lines of a docstring to build sections.\nIt then returns this list of sections."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "parse_numpy", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "ignore_init_summary", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "description": "Whether to ignore the summary in `__init__` methods' docstrings.", "value": "False"}, {"name": "trim_doctest_flags", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "description": "Whether to remove doctest flags from Python example blocks.", "value": "True"}, {"name": "warn_unknown_params", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "description": "Warn about documented parameters not appearing in the signature.", "value": "True"}, {"name": "warn_missing_types", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "description": "Warn about missing types/annotations for parameters, return values, etc.", "value": "True"}, {"name": "warnings", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "description": "Whether to log warnings at all.", "value": "True"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse_numpy", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_numpy", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of docstring sections."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.numpy.parse_numpy", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/numpy.py#L910-L1016", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "parse_numpy", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "ignore_init_summary", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "False"}, {"name": "trim_doctest_flags", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_unknown_params", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warn_missing_types", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "parse_numpy", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "parse_numpy", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_numpy", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.numpy", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/numpy.py", "relative_package_filepath": "griffe/_internal/docstrings/numpy.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/numpy.py"}, "sphinx": {"kind": "module", "name": "sphinx", "runtime": true, "imports": {"annotations": "__future__.annotations", "suppress": "contextlib.suppress", "dataclass": "dataclasses.dataclass", "field": "dataclasses.field", "cleandoc": "inspect.cleandoc", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "TypedDict": "typing.TypedDict", "DocstringAttribute": "griffe._internal.docstrings.models.DocstringAttribute", "DocstringParameter": "griffe._internal.docstrings.models.DocstringParameter", "DocstringRaise": "griffe._internal.docstrings.models.DocstringRaise", "DocstringReturn": "griffe._internal.docstrings.models.DocstringReturn", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "DocstringSectionAttributes": "griffe._internal.docstrings.models.DocstringSectionAttributes", "DocstringSectionParameters": "griffe._internal.docstrings.models.DocstringSectionParameters", "DocstringSectionRaises": "griffe._internal.docstrings.models.DocstringSectionRaises", "DocstringSectionReturns": "griffe._internal.docstrings.models.DocstringSectionReturns", "DocstringSectionText": "griffe._internal.docstrings.models.DocstringSectionText", "docstring_warning": "griffe._internal.docstrings.utils.docstring_warning", "parse_docstring_annotation": "griffe._internal.docstrings.utils.parse_docstring_annotation", "Callable": "collections.abc.Callable", "Expr": "griffe._internal.expressions.Expr", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dataclass": {"kind": "alias", "name": "dataclass", "target_path": "dataclasses.dataclass", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.dataclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "field": {"kind": "alias", "name": "field", "target_path": "dataclasses.field", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.field", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cleandoc": {"kind": "alias", "name": "cleandoc", "target_path": "inspect.cleandoc", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.cleandoc", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypedDict": {"kind": "alias", "name": "TypedDict", "target_path": "typing.TypedDict", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.TypedDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringAttribute": {"kind": "alias", "name": "DocstringAttribute", "target_path": "griffe._internal.docstrings.models.DocstringAttribute", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringAttribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringParameter": {"kind": "alias", "name": "DocstringParameter", "target_path": "griffe._internal.docstrings.models.DocstringParameter", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringRaise": {"kind": "alias", "name": "DocstringRaise", "target_path": "griffe._internal.docstrings.models.DocstringRaise", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringRaise", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringReturn": {"kind": "alias", "name": "DocstringReturn", "target_path": "griffe._internal.docstrings.models.DocstringReturn", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringReturn", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionAttributes": {"kind": "alias", "name": "DocstringSectionAttributes", "target_path": "griffe._internal.docstrings.models.DocstringSectionAttributes", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSectionAttributes", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionParameters": {"kind": "alias", "name": "DocstringSectionParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionParameters", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSectionParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionRaises": {"kind": "alias", "name": "DocstringSectionRaises", "target_path": "griffe._internal.docstrings.models.DocstringSectionRaises", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSectionRaises", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionReturns": {"kind": "alias", "name": "DocstringSectionReturns", "target_path": "griffe._internal.docstrings.models.DocstringSectionReturns", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSectionReturns", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionText": {"kind": "alias", "name": "DocstringSectionText", "target_path": "griffe._internal.docstrings.models.DocstringSectionText", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 25, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.DocstringSectionText", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "docstring_warning": {"kind": "alias", "name": "docstring_warning", "target_path": "griffe._internal.docstrings.utils.docstring_warning", "runtime": true, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.docstring_warning", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "parse_docstring_annotation": {"kind": "alias", "name": "parse_docstring_annotation", "target_path": "griffe._internal.docstrings.utils.parse_docstring_annotation", "runtime": true, "inherited": false, "lineno": 26, "endlineno": 26, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.parse_docstring_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Callable": {"kind": "alias", "name": "Callable", "target_path": "collections.abc.Callable", "runtime": false, "inherited": false, "lineno": 29, "endlineno": 29, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.Callable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 31, "endlineno": 31, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 32, "endlineno": 32, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_PARAM_NAMES": {"kind": "attribute", "name": "_PARAM_NAMES", "runtime": true, "lineno": 36, "endlineno": 36, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._PARAM_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L36-L36", "value": {"arguments": [{"elements": ["'param'", "'parameter'", "'arg'", "'argument'", "'key'", "'keyword'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_PARAM_TYPE_NAMES": {"kind": "attribute", "name": "_PARAM_TYPE_NAMES", "runtime": true, "lineno": 37, "endlineno": 37, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._PARAM_TYPE_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L37-L37", "value": {"arguments": [{"elements": ["'type'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_ATTRIBUTE_NAMES": {"kind": "attribute", "name": "_ATTRIBUTE_NAMES", "runtime": true, "lineno": 38, "endlineno": 38, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ATTRIBUTE_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L38-L38", "value": {"arguments": [{"elements": ["'var'", "'ivar'", "'cvar'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_ATTRIBUTE_TYPE_NAMES": {"kind": "attribute", "name": "_ATTRIBUTE_TYPE_NAMES", "runtime": true, "lineno": 39, "endlineno": 39, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ATTRIBUTE_TYPE_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L39-L39", "value": {"arguments": [{"elements": ["'vartype'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_RETURN_NAMES": {"kind": "attribute", "name": "_RETURN_NAMES", "runtime": true, "lineno": 40, "endlineno": 40, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._RETURN_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L40-L40", "value": {"arguments": [{"elements": ["'returns'", "'return'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_RETURN_TYPE_NAMES": {"kind": "attribute", "name": "_RETURN_TYPE_NAMES", "runtime": true, "lineno": 41, "endlineno": 41, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._RETURN_TYPE_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L41-L41", "value": {"arguments": [{"elements": ["'rtype'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_EXCEPTION_NAMES": {"kind": "attribute", "name": "_EXCEPTION_NAMES", "runtime": true, "lineno": 42, "endlineno": 42, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._EXCEPTION_NAMES", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L42-L42", "value": {"arguments": [{"elements": ["'raises'", "'raise'", "'except'", "'exception'"], "implicit": false, "cls": "ExprTuple"}], "function": {"member": null, "name": "frozenset", "cls": "ExprName"}, "cls": "ExprCall"}}, "_FieldType": {"kind": "class", "name": "_FieldType", "runtime": true, "lineno": 45, "endlineno": 61, "docstring": {"value": "Maps directive names to parser functions.", "lineno": 47, "endlineno": 47, "parsed": [{"kind": "text", "value": "Maps directive names to parser functions."}]}, "labels": ["dataclass"], "members": {"names": {"kind": "attribute", "name": "names", "runtime": true, "lineno": 49, "endlineno": 49, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._FieldType.names", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L49-L49", "annotation": {"left": {"member": null, "name": "frozenset", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "reader": {"kind": "attribute", "name": "reader", "runtime": true, "lineno": 50, "endlineno": 50, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._FieldType.reader", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L50-L50", "annotation": {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Docstring", "cls": "ExprName"}, {"member": null, "name": "int", "cls": "ExprName"}, {"member": null, "name": "_ParsedValues", "cls": "ExprName"}], "cls": "ExprList"}, {"member": null, "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "matches": {"kind": "function", "name": "matches", "runtime": true, "lineno": 52, "endlineno": 61, "docstring": {"value": "Check if a line matches the field type.\n\nParameters:\n    line: Line to check against\n\nReturns:\n    True if the line matches the field type, False otherwise.", "lineno": 53, "endlineno": 60, "parsed": [{"kind": "text", "value": "Check if a line matches the field type."}, {"kind": "parameters", "value": [{"name": "line", "annotation": {"member": "matches", "name": "str", "cls": "ExprName"}, "description": "Line to check against"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "matches", "name": "bool", "cls": "ExprName"}, "description": "True if the line matches the field type, False otherwise."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._FieldType.matches", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L52-L61", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "line", "annotation": {"member": "matches", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "matches", "name": "bool", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.docstrings.sphinx._FieldType.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "names", "annotation": {"left": {"member": null, "name": "frozenset", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "reader", "annotation": {"left": {"member": null, "name": "Callable", "cls": "ExprName"}, "slice": {"elements": [{"elements": [{"member": null, "name": "Docstring", "cls": "ExprName"}, {"member": null, "name": "int", "cls": "ExprName"}, {"member": null, "name": "_ParsedValues", "cls": "ExprName"}], "cls": "ExprList"}, {"member": null, "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._FieldType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L45-L61", "bases": [], "decorators": [{"value": {"arguments": [{"function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "name": "frozen", "value": "True", "cls": "ExprKeyword"}], "function": {"member": null, "name": "dataclass", "cls": "ExprName"}, "cls": "ExprCall"}, "lineno": 45, "endlineno": 45}]}, "_ParsedDirective": {"kind": "class", "name": "_ParsedDirective", "runtime": true, "lineno": 64, "endlineno": 72, "docstring": {"value": "Directive information that has been parsed from a docstring.", "lineno": 66, "endlineno": 66, "parsed": [{"kind": "text", "value": "Directive information that has been parsed from a docstring."}]}, "labels": ["dataclass"], "members": {"line": {"kind": "attribute", "name": "line", "runtime": true, "lineno": 68, "endlineno": 68, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective.line", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L68-L68", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "next_index": {"kind": "attribute", "name": "next_index", "runtime": true, "lineno": 69, "endlineno": 69, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective.next_index", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L69-L69", "annotation": {"member": null, "name": "int", "cls": "ExprName"}}, "directive_parts": {"kind": "attribute", "name": "directive_parts", "runtime": true, "lineno": 70, "endlineno": 70, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective.directive_parts", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L70-L70", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 71, "endlineno": 71, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L71-L71", "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "invalid": {"kind": "attribute", "name": "invalid", "runtime": true, "lineno": 72, "endlineno": 72, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective.invalid", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L72-L72", "value": "False", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.docstrings.sphinx._ParsedDirective.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "line", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "next_index", "annotation": {"member": null, "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "directive_parts", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "invalid", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "positional or keyword", "default": "False"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedDirective", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L64-L72", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 64, "endlineno": 64}]}, "_ParsedValues": {"kind": "class", "name": "_ParsedValues", "runtime": true, "lineno": 75, "endlineno": 86, "docstring": {"value": "Values parsed from the docstring to be used to produce sections.", "lineno": 77, "endlineno": 77, "parsed": [{"kind": "text", "value": "Values parsed from the docstring to be used to produce sections."}]}, "labels": ["dataclass"], "members": {"description": {"kind": "attribute", "name": "description", "runtime": true, "lineno": 79, "endlineno": 79, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.description", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L79-L79", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "parameters": {"kind": "attribute", "name": "parameters", "runtime": true, "lineno": 80, "endlineno": 80, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L80-L80", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "DocstringParameter", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "param_types": {"kind": "attribute", "name": "param_types", "runtime": true, "lineno": 81, "endlineno": 81, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.param_types", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L81-L81", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "attributes": {"kind": "attribute", "name": "attributes", "runtime": true, "lineno": 82, "endlineno": 82, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.attributes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L82-L82", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "DocstringAttribute", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "attribute_types": {"kind": "attribute", "name": "attribute_types", "runtime": true, "lineno": 83, "endlineno": 83, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.attribute_types", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L83-L83", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "exceptions": {"kind": "attribute", "name": "exceptions", "runtime": true, "lineno": 84, "endlineno": 84, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.exceptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L84-L84", "value": {"arguments": [{"function": {"member": null, "name": "field", "cls": "ExprName"}, "name": "default_factory", "value": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "field", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringRaise", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "return_value": {"kind": "attribute", "name": "return_value", "runtime": true, "lineno": 85, "endlineno": 85, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.return_value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L85-L85", "value": "None", "annotation": {"left": {"member": null, "name": "DocstringReturn", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "return_type": {"kind": "attribute", "name": "return_type", "runtime": true, "lineno": 86, "endlineno": 86, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues.return_type", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L86-L86", "value": "None", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 0, "endlineno": 0, "path": "griffe._internal.docstrings.sphinx._ParsedValues.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L0-L0", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "description", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "parameters", "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "DocstringParameter", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "param_types", "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "attributes", "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "DocstringAttribute", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "attribute_types", "annotation": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "dict", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "exceptions", "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringRaise", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": {"arguments": [], "function": {"member": null, "name": "list", "cls": "ExprName"}, "cls": "ExprCall"}}, {"name": "return_value", "annotation": {"left": {"member": null, "name": "DocstringReturn", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}, {"name": "return_type", "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._ParsedValues", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L75-L86", "bases": [], "decorators": [{"value": {"member": null, "name": "dataclass", "cls": "ExprName"}, "lineno": 75, "endlineno": 75}]}, "SphinxOptions": {"kind": "class", "name": "SphinxOptions", "runtime": true, "lineno": 89, "endlineno": 95, "docstring": {"value": "Options for parsing Sphinx-style docstrings.", "lineno": 90, "endlineno": 90, "parsed": [{"kind": "text", "value": "Options for parsing Sphinx-style docstrings."}]}, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to warn about unknown parameters.", "value": "..."}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "description": "Whether to issue warnings for parsing issues.", "value": "..."}]}]}, "path": "griffe._internal.docstrings.sphinx.SphinxOptions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to warn about unknown parameters.", "lineno": 93, "endlineno": 93, "parsed": [{"kind": "text", "value": "Whether to warn about unknown parameters."}]}}, {"name": "warnings", "annotation": {"member": null, "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Whether to issue warnings for parsing issues.", "lineno": 95, "endlineno": 95, "parsed": [{"kind": "text", "value": "Whether to issue warnings for parsing issues."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.SphinxOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L89-L95", "bases": [{"member": "SphinxOptions", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "parse_sphinx": {"kind": "function", "name": "parse_sphinx", "runtime": true, "lineno": 98, "endlineno": 136, "docstring": {"value": "Parse a Sphinx-style docstring.\n\nParameters:\n    docstring: The docstring to parse.\n    warn_unknown_params: Warn about documented parameters not appearing in the signature.\n    warnings: Whether to log warnings at all.\n\nReturns:\n    A list of docstring sections.", "lineno": 104, "endlineno": 113, "parsed": [{"kind": "text", "value": "Parse a Sphinx-style docstring."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "parse_sphinx", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "warn_unknown_params", "annotation": {"member": "parse_sphinx", "name": "bool", "cls": "ExprName"}, "description": "Warn about documented parameters not appearing in the signature.", "value": "True"}, {"name": "warnings", "annotation": {"member": "parse_sphinx", "name": "bool", "cls": "ExprName"}, "description": "Whether to log warnings at all.", "value": "True"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse_sphinx", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_sphinx", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of docstring sections."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx.parse_sphinx", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L98-L136", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "parse_sphinx", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "parse_sphinx", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "parse_sphinx", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"left": {"member": "parse_sphinx", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_sphinx", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_read_parameter": {"kind": "function", "name": "_read_parameter", "runtime": true, "lineno": 139, "endlineno": 199, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_parameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L139-L199", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameter", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameter", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_parameter", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warn_unknown_params", "annotation": {"member": "_read_parameter", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_parameter", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_parameter", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_parameter", "name": "int", "cls": "ExprName"}}, "_determine_param_default": {"kind": "function", "name": "_determine_param_default", "runtime": true, "lineno": 202, "endlineno": 206, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._determine_param_default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L202-L206", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_determine_param_default", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "_determine_param_default", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_determine_param_default", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_determine_param_annotation": {"kind": "function", "name": "_determine_param_annotation", "runtime": true, "lineno": 209, "endlineno": 241, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._determine_param_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L209-L241", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_determine_param_annotation", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "_determine_param_annotation", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "directive_type", "annotation": {"left": {"left": {"member": "_determine_param_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_determine_param_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_determine_param_annotation", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_determine_param_annotation", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_determine_param_annotation", "name": "Any", "cls": "ExprName"}}, "_read_parameter_type": {"kind": "function", "name": "_read_parameter_type", "runtime": true, "lineno": 244, "endlineno": 272, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_parameter_type", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L244-L272", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_parameter_type", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_parameter_type", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_parameter_type", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_read_parameter_type", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_parameter_type", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_parameter_type", "name": "int", "cls": "ExprName"}}, "_read_attribute": {"kind": "function", "name": "_read_attribute", "runtime": true, "lineno": 275, "endlineno": 319, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L275-L319", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_attribute", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_attribute", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_attribute", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_read_attribute", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_attribute", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_attribute", "name": "int", "cls": "ExprName"}}, "_read_attribute_type": {"kind": "function", "name": "_read_attribute_type", "runtime": true, "lineno": 322, "endlineno": 349, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_attribute_type", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L322-L349", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_attribute_type", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_attribute_type", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_attribute_type", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_read_attribute_type", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_attribute_type", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_attribute_type", "name": "int", "cls": "ExprName"}}, "_read_exception": {"kind": "function", "name": "_read_exception", "runtime": true, "lineno": 352, "endlineno": 370, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_exception", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L352-L370", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_exception", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_exception", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_exception", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_read_exception", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_exception", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_exception", "name": "int", "cls": "ExprName"}}, "_read_return": {"kind": "function", "name": "_read_return", "runtime": true, "lineno": 373, "endlineno": 404, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_return", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L373-L404", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_return", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_return", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_return", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warn_missing_types", "annotation": {"member": "_read_return", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "warnings", "annotation": {"member": "_read_return", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_return", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_return", "name": "int", "cls": "ExprName"}}, "_read_return_type": {"kind": "function", "name": "_read_return_type", "runtime": true, "lineno": 407, "endlineno": 425, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._read_return_type", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L407-L425", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_read_return_type", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_read_return_type", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "parsed_values", "annotation": {"member": "_read_return_type", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_read_return_type", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}, {"name": "options", "annotation": {"member": "_read_return_type", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"member": "_read_return_type", "name": "int", "cls": "ExprName"}}, "_parsed_values_to_sections": {"kind": "function", "name": "_parsed_values_to_sections", "runtime": true, "lineno": 428, "endlineno": 441, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._parsed_values_to_sections", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L428-L441", "decorators": [], "parameters": [{"name": "parsed_values", "annotation": {"member": "_parsed_values_to_sections", "name": "_ParsedValues", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_parsed_values_to_sections", "name": "list", "cls": "ExprName"}, "slice": {"member": "_parsed_values_to_sections", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_parse_directive": {"kind": "function", "name": "_parse_directive", "runtime": true, "lineno": 444, "endlineno": 454, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._parse_directive", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L444-L454", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "_parse_directive", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_parse_directive", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "warnings", "annotation": {"member": "_parse_directive", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": "True"}], "returns": {"member": "_parse_directive", "name": "_ParsedDirective", "cls": "ExprName"}}, "_consolidate_continuation_lines": {"kind": "function", "name": "_consolidate_continuation_lines", "runtime": true, "lineno": 457, "endlineno": 467, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._consolidate_continuation_lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L457-L467", "decorators": [], "parameters": [{"name": "lines", "annotation": {"left": {"member": "_consolidate_continuation_lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "_consolidate_continuation_lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "_consolidate_continuation_lines", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_consolidate_continuation_lines", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"member": "_consolidate_continuation_lines", "name": "str", "cls": "ExprName"}, {"member": "_consolidate_continuation_lines", "name": "int", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_consolidate_descriptive_type": {"kind": "function", "name": "_consolidate_descriptive_type", "runtime": true, "lineno": 470, "endlineno": 471, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._consolidate_descriptive_type", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L470-L471", "decorators": [], "parameters": [{"name": "descriptive_type", "annotation": {"member": "_consolidate_descriptive_type", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_consolidate_descriptive_type", "name": "str", "cls": "ExprName"}}, "_strip_blank_lines": {"kind": "function", "name": "_strip_blank_lines", "runtime": true, "lineno": 474, "endlineno": 489, "analysis": "static", "path": "griffe._internal.docstrings.sphinx._strip_blank_lines", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L474-L489", "decorators": [], "parameters": [{"name": "lines", "annotation": {"left": {"member": "_strip_blank_lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "_strip_blank_lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_strip_blank_lines", "name": "list", "cls": "ExprName"}, "slice": {"member": "_strip_blank_lines", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_field_types": {"kind": "attribute", "name": "_field_types", "runtime": true, "lineno": 492, "endlineno": 500, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.sphinx._field_types", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py#L492-L500", "value": {"elements": [{"arguments": [{"member": null, "name": "_PARAM_TYPE_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_parameter_type", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_PARAM_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_parameter", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_ATTRIBUTE_TYPE_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_attribute_type", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_ATTRIBUTE_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_attribute", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_EXCEPTION_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_exception", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_RETURN_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_return", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}, {"arguments": [{"member": null, "name": "_RETURN_TYPE_NAMES", "cls": "ExprName"}, {"member": null, "name": "_read_return_type", "cls": "ExprName"}], "function": {"member": null, "name": "_FieldType", "cls": "ExprName"}, "cls": "ExprCall"}], "cls": "ExprList"}}}, "analysis": "static", "path": "griffe._internal.docstrings.sphinx", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/sphinx.py", "relative_package_filepath": "griffe/_internal/docstrings/sphinx.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/sphinx.py"}, "utils": {"kind": "module", "name": "utils", "runtime": true, "imports": {"annotations": "__future__.annotations", "PyCF_ONLY_AST": "ast.PyCF_ONLY_AST", "suppress": "contextlib.suppress", "TYPE_CHECKING": "typing.TYPE_CHECKING", "LogLevel": "griffe._internal.enumerations.LogLevel", "BuiltinModuleError": "griffe._internal.exceptions.BuiltinModuleError", "safe_get_annotation": "griffe._internal.expressions.safe_get_annotation", "logger": "griffe._internal.logger.logger", "Expr": "griffe._internal.expressions.Expr", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.docstrings.utils.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "PyCF_ONLY_AST": {"kind": "alias", "name": "PyCF_ONLY_AST", "target_path": "ast.PyCF_ONLY_AST", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.docstrings.utils.PyCF_ONLY_AST", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.utils.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.docstrings.utils.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "LogLevel": {"kind": "alias", "name": "LogLevel", "target_path": "griffe._internal.enumerations.LogLevel", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.docstrings.utils.LogLevel", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "BuiltinModuleError": {"kind": "alias", "name": "BuiltinModuleError", "target_path": "griffe._internal.exceptions.BuiltinModuleError", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.docstrings.utils.BuiltinModuleError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "safe_get_annotation": {"kind": "alias", "name": "safe_get_annotation", "target_path": "griffe._internal.expressions.safe_get_annotation", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.utils.safe_get_annotation", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.utils.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.docstrings.utils.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.docstrings.utils.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "docstring_warning": {"kind": "function", "name": "docstring_warning", "runtime": true, "lineno": 19, "endlineno": 48, "docstring": {"value": "Log a warning when parsing a docstring.\n\nThis function logs a warning message by prefixing it with the filepath and line number.\n\nParameters:\n    docstring: The docstring object.\n    offset: The offset in the docstring lines.\n    message: The message to log.\n\nReturns:\n    A function used to log parsing warnings if `name` was passed, else none.", "lineno": 25, "endlineno": 36, "parsed": [{"kind": "text", "value": "Log a warning when parsing a docstring.\n\nThis function logs a warning message by prefixing it with the filepath and line number."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "docstring_warning", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring object."}, {"name": "offset", "annotation": {"member": "docstring_warning", "name": "int", "cls": "ExprName"}, "description": "The offset in the docstring lines."}, {"name": "message", "annotation": {"member": "docstring_warning", "name": "str", "cls": "ExprName"}, "description": "The message to log."}]}, {"kind": "returns", "value": [{"name": "", "annotation": "None", "description": "A function used to log parsing warnings if `name` was passed, else none."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.utils.docstring_warning", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/utils.py", "relative_package_filepath": "griffe/_internal/docstrings/utils.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/utils.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/utils.py#L19-L48", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "docstring_warning", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "offset", "annotation": {"member": "docstring_warning", "name": "int", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "message", "annotation": {"member": "docstring_warning", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "log_level", "annotation": {"member": "docstring_warning", "name": "LogLevel", "cls": "ExprName"}, "kind": "positional or keyword", "default": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "warning", "cls": "ExprName"}], "cls": "ExprAttribute"}}], "returns": "None"}, "parse_docstring_annotation": {"kind": "function", "name": "parse_docstring_annotation", "runtime": true, "lineno": 51, "endlineno": 79, "docstring": {"value": "Parse a string into a true name or expression that can be resolved later.\n\nParameters:\n    annotation: The annotation to parse.\n    docstring: The docstring in which the annotation appears.\n        The docstring's parent is accessed to bind a resolver to the resulting name/expression.\n    log_level: Log level to use to log a message.\n\nReturns:\n    The string unchanged, or a new name or expression.", "lineno": 56, "endlineno": 66, "parsed": [{"kind": "text", "value": "Parse a string into a true name or expression that can be resolved later."}, {"kind": "parameters", "value": [{"name": "annotation", "annotation": {"member": "parse_docstring_annotation", "name": "str", "cls": "ExprName"}, "description": "The annotation to parse."}, {"name": "docstring", "annotation": {"member": "parse_docstring_annotation", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring in which the annotation appears.\nThe docstring's parent is accessed to bind a resolver to the resulting name/expression."}, {"name": "log_level", "annotation": {"member": "parse_docstring_annotation", "name": "LogLevel", "cls": "ExprName"}, "description": "Log level to use to log a message.", "value": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "error", "cls": "ExprName"}], "cls": "ExprAttribute"}}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse_docstring_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse_docstring_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The string unchanged, or a new name or expression."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.utils.parse_docstring_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/utils.py", "relative_package_filepath": "griffe/_internal/docstrings/utils.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/utils.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/utils.py#L51-L79", "decorators": [], "parameters": [{"name": "annotation", "annotation": {"member": "parse_docstring_annotation", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "docstring", "annotation": {"member": "parse_docstring_annotation", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "log_level", "annotation": {"member": "parse_docstring_annotation", "name": "LogLevel", "cls": "ExprName"}, "kind": "positional or keyword", "default": {"values": [{"member": null, "name": "LogLevel", "cls": "ExprName"}, {"member": null, "name": "error", "cls": "ExprName"}], "cls": "ExprAttribute"}}], "returns": {"left": {"member": "parse_docstring_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse_docstring_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.docstrings.utils", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/utils.py", "relative_package_filepath": "griffe/_internal/docstrings/utils.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/utils.py"}, "models": {"kind": "module", "name": "models", "runtime": true, "imports": {"annotations": "__future__.annotations", "TYPE_CHECKING": "typing.TYPE_CHECKING", "DocstringSectionKind": "griffe._internal.enumerations.DocstringSectionKind", "ExprTuple": "griffe._internal.expressions.ExprTuple", "Sequence": "collections.abc.Sequence", "Any": "typing.Any", "Literal": "typing.Literal", "Expr": "griffe._internal.expressions.Expr"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.docstrings.models.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.docstrings.models.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionKind": {"kind": "alias", "name": "DocstringSectionKind", "target_path": "griffe._internal.enumerations.DocstringSectionKind", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprTuple": {"kind": "alias", "name": "ExprTuple", "target_path": "griffe._internal.expressions.ExprTuple", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.docstrings.models.ExprTuple", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Sequence": {"kind": "alias", "name": "Sequence", "target_path": "collections.abc.Sequence", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.models.Sequence", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.models.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.models.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.docstrings.models.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringElement": {"kind": "class", "name": "DocstringElement", "runtime": true, "lineno": 18, "endlineno": 45, "docstring": {"value": "This base class represents annotated, nameless elements.", "lineno": 19, "endlineno": 19, "parsed": [{"kind": "text", "value": "This base class represents annotated, nameless elements."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 21, "endlineno": 31, "docstring": {"value": "Initialize the element.\n\nParameters:\n    annotation: The element annotation, if any.\n    description: The element description.", "lineno": 22, "endlineno": 27, "parsed": [{"kind": "parameters", "value": [{"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The element annotation, if any.", "value": "None"}, {"name": "description", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The element description."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringElement.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L21-L31", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "description", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "description": {"kind": "attribute", "name": "description", "runtime": true, "lineno": 28, "endlineno": 28, "docstring": {"value": "The element description.", "lineno": 29, "endlineno": 29, "parsed": [{"kind": "text", "value": "The element description."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringElement.description", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L28-L28", "value": {"member": null, "name": "description", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "annotation": {"kind": "attribute", "name": "annotation", "runtime": true, "lineno": 30, "endlineno": 30, "docstring": {"value": "The element annotation.", "lineno": 31, "endlineno": 31, "parsed": [{"kind": "text", "value": "The element annotation."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringElement.annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L30-L30", "value": {"member": null, "name": "annotation", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 33, "endlineno": 45, "docstring": {"value": "Return this element's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 34, "endlineno": 41, "parsed": [{"kind": "text", "value": "Return this element's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringElement.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L33-L45", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringElement", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L18-L45", "bases": [], "decorators": []}, "DocstringNamedElement": {"kind": "class", "name": "DocstringNamedElement", "runtime": true, "lineno": 48, "endlineno": 85, "docstring": {"value": "This base class represents annotated, named elements.", "lineno": 49, "endlineno": 49, "parsed": [{"kind": "text", "value": "This base class represents annotated, named elements."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 51, "endlineno": 71, "docstring": {"value": "Initialize the element.\n\nParameters:\n    name: The element name.\n    description: The element description.\n    annotation: The element annotation, if any.\n    value: The element value, as a string.", "lineno": 59, "endlineno": 66, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The element name."}, {"name": "description", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The element description."}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The element annotation, if any.", "value": "None"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The element value, as a string.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringNamedElement.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L51-L71", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "description", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "value", "annotation": {"left": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "__init__", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": "None"}, "name": {"kind": "attribute", "name": "name", "runtime": true, "lineno": 68, "endlineno": 68, "docstring": {"value": "The element name.", "lineno": 69, "endlineno": 69, "parsed": [{"kind": "text", "value": "The element name."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringNamedElement.name", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L68-L68", "value": {"member": null, "name": "name", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 70, "endlineno": 70, "docstring": {"value": "The element value, if any", "lineno": 71, "endlineno": 71, "parsed": [{"kind": "text", "value": "The element value, if any"}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringNamedElement.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L70-L70", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 73, "endlineno": 85, "docstring": {"value": "Return this element's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 74, "endlineno": 81, "parsed": [{"kind": "text", "value": "Return this element's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringNamedElement.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L73-L85", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringNamedElement", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L48-L85", "bases": [{"member": "DocstringNamedElement", "name": "DocstringElement", "cls": "ExprName"}], "decorators": []}, "DocstringAdmonition": {"kind": "class", "name": "DocstringAdmonition", "runtime": true, "lineno": 88, "endlineno": 107, "docstring": {"value": "This class represents an admonition.", "lineno": 89, "endlineno": 89, "parsed": [{"kind": "text", "value": "This class represents an admonition."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 92, "endlineno": 94, "docstring": {"value": "The kind of this admonition.", "lineno": 93, "endlineno": 93, "parsed": [{"kind": "text", "value": "The kind of this admonition."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringAdmonition.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L92-L94", "annotation": {"left": {"left": {"member": "kind", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "kind", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "contents": {"kind": "attribute", "name": "contents", "runtime": true, "lineno": 101, "endlineno": 103, "docstring": {"value": "The contents of this admonition.", "lineno": 102, "endlineno": 102, "parsed": [{"kind": "text", "value": "The contents of this admonition."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringAdmonition.contents", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L101-L103", "annotation": {"member": "contents", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringAdmonition", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L88-L107", "bases": [{"member": "DocstringAdmonition", "name": "DocstringElement", "cls": "ExprName"}], "decorators": []}, "DocstringDeprecated": {"kind": "class", "name": "DocstringDeprecated", "runtime": true, "lineno": 110, "endlineno": 120, "docstring": {"value": "This class represents a documented deprecated item.", "lineno": 111, "endlineno": 111, "parsed": [{"kind": "text", "value": "This class represents a documented deprecated item."}]}, "members": {"version": {"kind": "attribute", "name": "version", "runtime": true, "lineno": 114, "endlineno": 116, "docstring": {"value": "The version of this deprecation.", "lineno": 115, "endlineno": 115, "parsed": [{"kind": "text", "value": "The version of this deprecation."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringDeprecated.version", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L114-L116", "annotation": {"member": "version", "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringDeprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L110-L120", "bases": [{"member": "DocstringDeprecated", "name": "DocstringElement", "cls": "ExprName"}], "decorators": []}, "DocstringRaise": {"kind": "class", "name": "DocstringRaise", "runtime": true, "lineno": 123, "endlineno": 124, "docstring": {"value": "This class represents a documented raise value.", "lineno": 124, "endlineno": 124, "parsed": [{"kind": "text", "value": "This class represents a documented raise value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringRaise", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L123-L124", "bases": [{"member": "DocstringRaise", "name": "DocstringElement", "cls": "ExprName"}], "decorators": []}, "DocstringWarn": {"kind": "class", "name": "DocstringWarn", "runtime": true, "lineno": 127, "endlineno": 128, "docstring": {"value": "This class represents a documented warn value.", "lineno": 128, "endlineno": 128, "parsed": [{"kind": "text", "value": "This class represents a documented warn value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringWarn", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L127-L128", "bases": [{"member": "DocstringWarn", "name": "DocstringElement", "cls": "ExprName"}], "decorators": []}, "DocstringReturn": {"kind": "class", "name": "DocstringReturn", "runtime": true, "lineno": 131, "endlineno": 132, "docstring": {"value": "This class represents a documented return value.", "lineno": 132, "endlineno": 132, "parsed": [{"kind": "text", "value": "This class represents a documented return value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringReturn", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L131-L132", "bases": [{"member": "DocstringReturn", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringYield": {"kind": "class", "name": "DocstringYield", "runtime": true, "lineno": 135, "endlineno": 136, "docstring": {"value": "This class represents a documented yield value.", "lineno": 136, "endlineno": 136, "parsed": [{"kind": "text", "value": "This class represents a documented yield value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringYield", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L135-L136", "bases": [{"member": "DocstringYield", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringReceive": {"kind": "class", "name": "DocstringReceive", "runtime": true, "lineno": 139, "endlineno": 140, "docstring": {"value": "This class represents a documented receive value.", "lineno": 140, "endlineno": 140, "parsed": [{"kind": "text", "value": "This class represents a documented receive value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringReceive", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L139-L140", "bases": [{"member": "DocstringReceive", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringParameter": {"kind": "class", "name": "DocstringParameter", "runtime": true, "lineno": 143, "endlineno": 153, "docstring": {"value": "This class represent a documented function parameter.", "lineno": 144, "endlineno": 144, "parsed": [{"kind": "text", "value": "This class represent a documented function parameter."}]}, "members": {"default": {"kind": "attribute", "name": "default", "runtime": true, "lineno": 147, "endlineno": 149, "docstring": {"value": "The default value of this parameter.", "lineno": 148, "endlineno": 148, "parsed": [{"kind": "text", "value": "The default value of this parameter."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringParameter.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L147-L149", "annotation": {"left": {"left": {"member": "default", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "default", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringParameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L143-L153", "bases": [{"member": "DocstringParameter", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringTypeParameter": {"kind": "class", "name": "DocstringTypeParameter", "runtime": true, "lineno": 156, "endlineno": 191, "docstring": {"value": "This class represent a documented type parameter.", "lineno": 157, "endlineno": 157, "parsed": [{"kind": "text", "value": "This class represent a documented type parameter."}]}, "members": {"default": {"kind": "attribute", "name": "default", "runtime": true, "lineno": 160, "endlineno": 162, "docstring": {"value": "The default value of this type parameter.", "lineno": 161, "endlineno": 161, "parsed": [{"kind": "text", "value": "The default value of this type parameter."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringTypeParameter.default", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L160-L162", "annotation": {"left": {"left": {"member": "default", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "default", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "bound": {"kind": "attribute", "name": "bound", "runtime": true, "lineno": 169, "endlineno": 173, "docstring": {"value": "The bound of this type parameter.", "lineno": 170, "endlineno": 170, "parsed": [{"kind": "text", "value": "The bound of this type parameter."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringTypeParameter.bound", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L169-L173", "annotation": {"left": {"left": {"member": "bound", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "bound", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "constraints": {"kind": "attribute", "name": "constraints", "runtime": true, "lineno": 180, "endlineno": 184, "docstring": {"value": "The constraints of this type parameter.", "lineno": 181, "endlineno": 181, "parsed": [{"kind": "text", "value": "The constraints of this type parameter."}]}, "labels": ["property", "writable"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringTypeParameter.constraints", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L180-L184", "annotation": {"left": {"left": {"member": "constraints", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "constraints", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "constraints", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "..."], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringTypeParameter", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L156-L191", "bases": [{"member": "DocstringTypeParameter", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringAttribute": {"kind": "class", "name": "DocstringAttribute", "runtime": true, "lineno": 194, "endlineno": 195, "docstring": {"value": "This class represents a documented module/class attribute.", "lineno": 195, "endlineno": 195, "parsed": [{"kind": "text", "value": "This class represents a documented module/class attribute."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringAttribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L194-L195", "bases": [{"member": "DocstringAttribute", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringFunction": {"kind": "class", "name": "DocstringFunction", "runtime": true, "lineno": 198, "endlineno": 204, "docstring": {"value": "This class represents a documented function.", "lineno": 199, "endlineno": 199, "parsed": [{"kind": "text", "value": "This class represents a documented function."}]}, "members": {"signature": {"kind": "attribute", "name": "signature", "runtime": true, "lineno": 202, "endlineno": 204, "docstring": {"value": "The function signature.", "lineno": 203, "endlineno": 203, "parsed": [{"kind": "text", "value": "The function signature."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringFunction.signature", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L202-L204", "annotation": {"left": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "signature", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringFunction", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L198-L204", "bases": [{"member": "DocstringFunction", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringClass": {"kind": "class", "name": "DocstringClass", "runtime": true, "lineno": 207, "endlineno": 213, "docstring": {"value": "This class represents a documented class.", "lineno": 208, "endlineno": 208, "parsed": [{"kind": "text", "value": "This class represents a documented class."}]}, "members": {"signature": {"kind": "attribute", "name": "signature", "runtime": true, "lineno": 211, "endlineno": 213, "docstring": {"value": "The class signature.", "lineno": 212, "endlineno": 212, "parsed": [{"kind": "text", "value": "The class signature."}]}, "labels": ["property"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringClass.signature", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L211-L213", "annotation": {"left": {"left": {"member": "signature", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "signature", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringClass", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L207-L213", "bases": [{"member": "DocstringClass", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringTypeAlias": {"kind": "class", "name": "DocstringTypeAlias", "runtime": true, "lineno": 216, "endlineno": 217, "docstring": {"value": "This class represents a documented type alias.", "lineno": 217, "endlineno": 217, "parsed": [{"kind": "text", "value": "This class represents a documented type alias."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringTypeAlias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L216-L217", "bases": [{"member": "DocstringTypeAlias", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringModule": {"kind": "class", "name": "DocstringModule", "runtime": true, "lineno": 220, "endlineno": 221, "docstring": {"value": "This class represents a documented module.", "lineno": 221, "endlineno": 221, "parsed": [{"kind": "text", "value": "This class represents a documented module."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringModule", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L220-L221", "bases": [{"member": "DocstringModule", "name": "DocstringNamedElement", "cls": "ExprName"}], "decorators": []}, "DocstringSection": {"kind": "class", "name": "DocstringSection", "runtime": true, "lineno": 225, "endlineno": 262, "docstring": {"value": "This class represents a docstring section.", "lineno": 226, "endlineno": 226, "parsed": [{"kind": "text", "value": "This class represents a docstring section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 228, "endlineno": 228, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L228-L228", "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 231, "endlineno": 240, "docstring": {"value": "Initialize the section.\n\nParameters:\n    title: An optional title.", "lineno": 232, "endlineno": 236, "parsed": [{"kind": "parameters", "value": [{"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L231-L240", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "title": {"kind": "attribute", "name": "title", "runtime": true, "lineno": 237, "endlineno": 237, "docstring": {"value": "The section title.", "lineno": 238, "endlineno": 238, "parsed": [{"kind": "text", "value": "The section title."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.title", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L237-L237", "value": {"member": null, "name": "title", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 239, "endlineno": 239, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L239-L239", "value": "None", "annotation": {"member": null, "name": "Any", "cls": "ExprName"}}, "__bool__": {"kind": "function", "name": "__bool__", "runtime": true, "lineno": 242, "endlineno": 244, "docstring": {"value": "Whether this section has a true-ish value.", "lineno": 243, "endlineno": 243, "parsed": [{"kind": "text", "value": "Whether this section has a true-ish value."}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.__bool__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L242-L244", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}], "returns": {"member": "__bool__", "name": "bool", "cls": "ExprName"}}, "as_dict": {"kind": "function", "name": "as_dict", "runtime": true, "lineno": 246, "endlineno": 262, "docstring": {"value": "Return this section's data as a dictionary.\n\nParameters:\n    **kwargs: Additional serialization options.\n\nReturns:\n    A dictionary.", "lineno": 247, "endlineno": 254, "parsed": [{"kind": "text", "value": "Return this section's data as a dictionary."}, {"kind": "parameters", "value": [{"name": "**kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "description": "Additional serialization options.", "value": "{}"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "A dictionary."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection.as_dict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L246-L262", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "as_dict", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": {"left": {"member": "as_dict", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "as_dict", "name": "str", "cls": "ExprName"}, {"member": "as_dict", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSection", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L225-L262", "bases": [], "decorators": []}, "DocstringSectionText": {"kind": "class", "name": "DocstringSectionText", "runtime": true, "lineno": 265, "endlineno": 278, "docstring": {"value": "This class represents a text section.", "lineno": 266, "endlineno": 266, "parsed": [{"kind": "text", "value": "This class represents a text section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 268, "endlineno": 268, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionText.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L268-L268", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "text", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 270, "endlineno": 278, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section text.\n    title: An optional title.", "lineno": 271, "endlineno": 276, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The section text."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionText.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L270-L278", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 278, "endlineno": 278, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionText.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L278-L278", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"member": null, "name": "str", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionText", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L265-L278", "bases": [{"member": "DocstringSectionText", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionParameters": {"kind": "class", "name": "DocstringSectionParameters", "runtime": true, "lineno": 281, "endlineno": 294, "docstring": {"value": "This class represents a parameters section.", "lineno": 282, "endlineno": 282, "parsed": [{"kind": "text", "value": "This class represents a parameters section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 284, "endlineno": 284, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionParameters.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L284-L284", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 286, "endlineno": 294, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section parameters.\n    title: An optional title.", "lineno": 287, "endlineno": 292, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section parameters."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionParameters.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L286-L294", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 294, "endlineno": 294, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionParameters.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L294-L294", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionParameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L281-L294", "bases": [{"member": "DocstringSectionParameters", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionOtherParameters": {"kind": "class", "name": "DocstringSectionOtherParameters", "runtime": true, "lineno": 297, "endlineno": 300, "docstring": {"value": "This class represents an other parameters section.", "lineno": 298, "endlineno": 298, "parsed": [{"kind": "text", "value": "This class represents an other parameters section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 300, "endlineno": 300, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionOtherParameters.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L300-L300", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "other_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionOtherParameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L297-L300", "bases": [{"member": "DocstringSectionOtherParameters", "name": "DocstringSectionParameters", "cls": "ExprName"}], "decorators": []}, "DocstringSectionTypeParameters": {"kind": "class", "name": "DocstringSectionTypeParameters", "runtime": true, "lineno": 303, "endlineno": 316, "docstring": {"value": "This class represents a type parameters section.", "lineno": 304, "endlineno": 304, "parsed": [{"kind": "text", "value": "This class represents a type parameters section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 306, "endlineno": 306, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L306-L306", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_parameters", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 308, "endlineno": 316, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section type parameters.\n    title: An optional title.", "lineno": 309, "endlineno": 314, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringTypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section type parameters."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L308-L316", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringTypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 316, "endlineno": 316, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L316-L316", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringTypeParameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeParameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L303-L316", "bases": [{"member": "DocstringSectionTypeParameters", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionRaises": {"kind": "class", "name": "DocstringSectionRaises", "runtime": true, "lineno": 319, "endlineno": 332, "docstring": {"value": "This class represents a raises section.", "lineno": 320, "endlineno": 320, "parsed": [{"kind": "text", "value": "This class represents a raises section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 322, "endlineno": 322, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionRaises.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L322-L322", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "raises", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 324, "endlineno": 332, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section exceptions.\n    title: An optional title.", "lineno": 325, "endlineno": 330, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringRaise", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section exceptions."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionRaises.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L324-L332", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringRaise", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 332, "endlineno": 332, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionRaises.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L332-L332", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringRaise", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionRaises", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L319-L332", "bases": [{"member": "DocstringSectionRaises", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionWarns": {"kind": "class", "name": "DocstringSectionWarns", "runtime": true, "lineno": 335, "endlineno": 348, "docstring": {"value": "This class represents a warns section.", "lineno": 336, "endlineno": 336, "parsed": [{"kind": "text", "value": "This class represents a warns section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 338, "endlineno": 338, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionWarns.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L338-L338", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "warns", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 340, "endlineno": 348, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section warnings.\n    title: An optional title.", "lineno": 341, "endlineno": 346, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringWarn", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section warnings."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionWarns.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L340-L348", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringWarn", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 348, "endlineno": 348, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionWarns.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L348-L348", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringWarn", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionWarns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L335-L348", "bases": [{"member": "DocstringSectionWarns", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionReturns": {"kind": "class", "name": "DocstringSectionReturns", "runtime": true, "lineno": 351, "endlineno": 364, "docstring": {"value": "This class represents a returns section.", "lineno": 352, "endlineno": 352, "parsed": [{"kind": "text", "value": "This class represents a returns section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 354, "endlineno": 354, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReturns.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L354-L354", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "returns", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 356, "endlineno": 364, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section returned items.\n    title: An optional title.", "lineno": 357, "endlineno": 362, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringReturn", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section returned items."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReturns.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L356-L364", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringReturn", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 364, "endlineno": 364, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReturns.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L364-L364", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringReturn", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReturns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L351-L364", "bases": [{"member": "DocstringSectionReturns", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionYields": {"kind": "class", "name": "DocstringSectionYields", "runtime": true, "lineno": 367, "endlineno": 380, "docstring": {"value": "This class represents a yields section.", "lineno": 368, "endlineno": 368, "parsed": [{"kind": "text", "value": "This class represents a yields section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 370, "endlineno": 370, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionYields.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L370-L370", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "yields", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 372, "endlineno": 380, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section yielded items.\n    title: An optional title.", "lineno": 373, "endlineno": 378, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringYield", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section yielded items."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionYields.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L372-L380", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringYield", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 380, "endlineno": 380, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionYields.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L380-L380", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringYield", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionYields", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L367-L380", "bases": [{"member": "DocstringSectionYields", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionReceives": {"kind": "class", "name": "DocstringSectionReceives", "runtime": true, "lineno": 383, "endlineno": 396, "docstring": {"value": "This class represents a receives section.", "lineno": 384, "endlineno": 384, "parsed": [{"kind": "text", "value": "This class represents a receives section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 386, "endlineno": 386, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReceives.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L386-L386", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "receives", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 388, "endlineno": 396, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section received items.\n    title: An optional title.", "lineno": 389, "endlineno": 394, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringReceive", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section received items."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReceives.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L388-L396", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringReceive", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 396, "endlineno": 396, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReceives.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L396-L396", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringReceive", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionReceives", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L383-L396", "bases": [{"member": "DocstringSectionReceives", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionExamples": {"kind": "class", "name": "DocstringSectionExamples", "runtime": true, "lineno": 399, "endlineno": 416, "docstring": {"value": "This class represents an examples section.", "lineno": 400, "endlineno": 400, "parsed": [{"kind": "text", "value": "This class represents an examples section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 402, "endlineno": 402, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionExamples.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L402-L402", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 404, "endlineno": 416, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section examples.\n    title: An optional title.", "lineno": 409, "endlineno": 414, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": [{"values": [{"member": "__init__", "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "text", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": "__init__", "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, {"member": "__init__", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}, "description": "The section examples."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionExamples.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L404-L416", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": "__init__", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "__init__", "name": "Literal", "cls": "ExprName"}, "slice": {"elements": [{"values": [{"member": "__init__", "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "text", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": "__init__", "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, {"member": "__init__", "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 416, "endlineno": 416, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionExamples.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L416-L416", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"left": {"member": null, "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": [{"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "text", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "examples", "cls": "ExprName"}], "cls": "ExprAttribute"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, {"member": null, "name": "str", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionExamples", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L399-L416", "bases": [{"member": "DocstringSectionExamples", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionAttributes": {"kind": "class", "name": "DocstringSectionAttributes", "runtime": true, "lineno": 419, "endlineno": 432, "docstring": {"value": "This class represents an attributes section.", "lineno": 420, "endlineno": 420, "parsed": [{"kind": "text", "value": "This class represents an attributes section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 422, "endlineno": 422, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAttributes.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L422-L422", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "attributes", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 424, "endlineno": 432, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section attributes.\n    title: An optional title.", "lineno": 425, "endlineno": 430, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringAttribute", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section attributes."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAttributes.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L424-L432", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringAttribute", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 432, "endlineno": 432, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAttributes.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L432-L432", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringAttribute", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAttributes", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L419-L432", "bases": [{"member": "DocstringSectionAttributes", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionFunctions": {"kind": "class", "name": "DocstringSectionFunctions", "runtime": true, "lineno": 435, "endlineno": 448, "docstring": {"value": "This class represents a functions/methods section.", "lineno": 436, "endlineno": 436, "parsed": [{"kind": "text", "value": "This class represents a functions/methods section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 438, "endlineno": 438, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionFunctions.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L438-L438", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "functions", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 440, "endlineno": 448, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section functions.\n    title: An optional title.", "lineno": 441, "endlineno": 446, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringFunction", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section functions."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionFunctions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L440-L448", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringFunction", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 448, "endlineno": 448, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionFunctions.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L448-L448", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringFunction", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionFunctions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L435-L448", "bases": [{"member": "DocstringSectionFunctions", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionClasses": {"kind": "class", "name": "DocstringSectionClasses", "runtime": true, "lineno": 451, "endlineno": 464, "docstring": {"value": "This class represents a classes section.", "lineno": 452, "endlineno": 452, "parsed": [{"kind": "text", "value": "This class represents a classes section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 454, "endlineno": 454, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionClasses.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L454-L454", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "classes", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 456, "endlineno": 464, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section classes.\n    title: An optional title.", "lineno": 457, "endlineno": 462, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringClass", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section classes."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionClasses.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L456-L464", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringClass", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 464, "endlineno": 464, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionClasses.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L464-L464", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringClass", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionClasses", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L451-L464", "bases": [{"member": "DocstringSectionClasses", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionTypeAliases": {"kind": "class", "name": "DocstringSectionTypeAliases", "runtime": true, "lineno": 467, "endlineno": 480, "docstring": {"value": "This class represents a type aliases section.", "lineno": 468, "endlineno": 468, "parsed": [{"kind": "text", "value": "This class represents a type aliases section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 470, "endlineno": 470, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L470-L470", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "type_aliases", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 472, "endlineno": 480, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section classes.\n    title: An optional title.", "lineno": 473, "endlineno": 478, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringTypeAlias", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section classes."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L472-L480", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringTypeAlias", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 480, "endlineno": 480, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L480-L480", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringTypeAlias", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionTypeAliases", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L467-L480", "bases": [{"member": "DocstringSectionTypeAliases", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionModules": {"kind": "class", "name": "DocstringSectionModules", "runtime": true, "lineno": 483, "endlineno": 496, "docstring": {"value": "This class represents a modules section.", "lineno": 484, "endlineno": 484, "parsed": [{"kind": "text", "value": "This class represents a modules section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 486, "endlineno": 486, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionModules.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L486-L486", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "modules", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 488, "endlineno": 496, "docstring": {"value": "Initialize the section.\n\nParameters:\n    value: The section modules.\n    title: An optional title.", "lineno": 489, "endlineno": 494, "parsed": [{"kind": "parameters", "value": [{"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringModule", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "The section modules."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionModules.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L488-L496", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "value", "annotation": {"left": {"member": "__init__", "name": "list", "cls": "ExprName"}, "slice": {"member": "__init__", "name": "DocstringModule", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 496, "endlineno": 496, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionModules.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L496-L496", "value": {"member": null, "name": "value", "cls": "ExprName"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringModule", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionModules", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L483-L496", "bases": [{"member": "DocstringSectionModules", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionDeprecated": {"kind": "class", "name": "DocstringSectionDeprecated", "runtime": true, "lineno": 499, "endlineno": 513, "docstring": {"value": "This class represents a deprecated section.", "lineno": 500, "endlineno": 500, "parsed": [{"kind": "text", "value": "This class represents a deprecated section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 502, "endlineno": 502, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionDeprecated.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L502-L502", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "deprecated", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 504, "endlineno": 513, "docstring": {"value": "Initialize the section.\n\nParameters:\n    version: The deprecation version.\n    text: The deprecation text.\n    title: An optional title.", "lineno": 505, "endlineno": 511, "parsed": [{"kind": "parameters", "value": [{"name": "version", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The deprecation version."}, {"name": "text", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The deprecation text."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionDeprecated.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L504-L513", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "version", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "text", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 513, "endlineno": 513, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionDeprecated.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L513-L513", "value": {"arguments": [{"function": {"member": null, "name": "DocstringDeprecated", "cls": "ExprName"}, "name": "annotation", "value": {"member": null, "name": "version", "cls": "ExprName"}, "cls": "ExprKeyword"}, {"function": {"member": null, "name": "DocstringDeprecated", "cls": "ExprName"}, "name": "description", "value": {"member": null, "name": "text", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "DocstringDeprecated", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "DocstringDeprecated", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionDeprecated", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L499-L513", "bases": [{"member": "DocstringSectionDeprecated", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}, "DocstringSectionAdmonition": {"kind": "class", "name": "DocstringSectionAdmonition", "runtime": true, "lineno": 516, "endlineno": 530, "docstring": {"value": "This class represents an admonition section.", "lineno": 517, "endlineno": 517, "parsed": [{"kind": "text", "value": "This class represents an admonition section."}]}, "members": {"kind": {"kind": "attribute", "name": "kind", "runtime": true, "lineno": 519, "endlineno": 519, "docstring": {"value": "The section kind.", "lineno": 229, "endlineno": 229, "parsed": [{"kind": "text", "value": "The section kind."}]}, "labels": ["class-attribute", "instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAdmonition.kind", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L519-L519", "value": {"values": [{"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}, {"member": null, "name": "admonition", "cls": "ExprName"}], "cls": "ExprAttribute"}, "annotation": {"member": null, "name": "DocstringSectionKind", "cls": "ExprName"}}, "__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 521, "endlineno": 530, "docstring": {"value": "Initialize the section.\n\nParameters:\n    kind: The admonition kind.\n    text: The admonition text.\n    title: An optional title.", "lineno": 522, "endlineno": 528, "parsed": [{"kind": "parameters", "value": [{"name": "kind", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The admonition kind."}, {"name": "text", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "description": "The admonition text."}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "An optional title.", "value": "None"}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAdmonition.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L521-L530", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kind", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "text", "annotation": {"member": "__init__", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "title", "annotation": {"left": {"member": "__init__", "name": "str", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "value": {"kind": "attribute", "name": "value", "runtime": true, "lineno": 530, "endlineno": 530, "docstring": {"value": "The section value.", "lineno": 240, "endlineno": 240, "parsed": [{"kind": "text", "value": "The section value."}]}, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAdmonition.value", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L530-L530", "value": {"arguments": [{"function": {"member": null, "name": "DocstringAdmonition", "cls": "ExprName"}, "name": "annotation", "value": {"member": null, "name": "kind", "cls": "ExprName"}, "cls": "ExprKeyword"}, {"function": {"member": null, "name": "DocstringAdmonition", "cls": "ExprName"}, "name": "description", "value": {"member": null, "name": "text", "cls": "ExprName"}, "cls": "ExprKeyword"}], "function": {"member": null, "name": "DocstringAdmonition", "cls": "ExprName"}, "cls": "ExprCall"}, "annotation": {"member": null, "name": "DocstringAdmonition", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.docstrings.models.DocstringSectionAdmonition", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/models.py#L516-L530", "bases": [{"member": "DocstringSectionAdmonition", "name": "DocstringSection", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.docstrings.models", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/models.py", "relative_package_filepath": "griffe/_internal/docstrings/models.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/models.py"}, "auto": {"kind": "module", "name": "auto", "runtime": true, "imports": {"annotations": "__future__.annotations", "re": "re", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Literal": "typing.Literal", "TypedDict": "typing.TypedDict", "Parser": "griffe._internal.enumerations.Parser", "GoogleOptions": "griffe._internal.docstrings.google.GoogleOptions", "DocstringSection": "griffe._internal.docstrings.models.DocstringSection", "NumpyOptions": "griffe._internal.docstrings.numpy.NumpyOptions", "DocstringStyle": "griffe._internal.docstrings.parsers.DocstringStyle", "SphinxOptions": "griffe._internal.docstrings.sphinx.SphinxOptions", "Docstring": "griffe._internal.models.Docstring"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 3, "endlineno": 3, "analysis": "static", "path": "griffe._internal.docstrings.auto.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "re": {"kind": "alias", "name": "re", "target_path": "re", "runtime": true, "inherited": false, "lineno": 5, "endlineno": 5, "analysis": "static", "path": "griffe._internal.docstrings.auto.re", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.auto.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Literal": {"kind": "alias", "name": "Literal", "target_path": "typing.Literal", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.auto.Literal", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypedDict": {"kind": "alias", "name": "TypedDict", "target_path": "typing.TypedDict", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.docstrings.auto.TypedDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parser": {"kind": "alias", "name": "Parser", "target_path": "griffe._internal.enumerations.Parser", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.docstrings.auto.Parser", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "GoogleOptions": {"kind": "alias", "name": "GoogleOptions", "target_path": "griffe._internal.docstrings.google.GoogleOptions", "runtime": false, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.docstrings.auto.GoogleOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringSection": {"kind": "alias", "name": "DocstringSection", "target_path": "griffe._internal.docstrings.models.DocstringSection", "runtime": false, "inherited": false, "lineno": 12, "endlineno": 12, "analysis": "static", "path": "griffe._internal.docstrings.auto.DocstringSection", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "NumpyOptions": {"kind": "alias", "name": "NumpyOptions", "target_path": "griffe._internal.docstrings.numpy.NumpyOptions", "runtime": false, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.docstrings.auto.NumpyOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "DocstringStyle": {"kind": "alias", "name": "DocstringStyle", "target_path": "griffe._internal.docstrings.parsers.DocstringStyle", "runtime": false, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.docstrings.auto.DocstringStyle", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "SphinxOptions": {"kind": "alias", "name": "SphinxOptions", "target_path": "griffe._internal.docstrings.sphinx.SphinxOptions", "runtime": false, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.docstrings.auto.SphinxOptions", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": false, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.docstrings.auto.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_default_style_order": {"kind": "attribute", "name": "_default_style_order", "runtime": true, "lineno": 24, "endlineno": 24, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.auto._default_style_order", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L24-L24", "value": {"elements": [{"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "sphinx", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "google", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "numpy", "cls": "ExprName"}], "cls": "ExprAttribute"}], "cls": "ExprList"}}, "DocstringDetectionMethod": {"kind": "attribute", "name": "DocstringDetectionMethod", "runtime": true, "lineno": 27, "endlineno": 27, "docstring": {"value": "The supported methods to infer docstring styles.", "lineno": 28, "endlineno": 28, "parsed": [{"kind": "text", "value": "The supported methods to infer docstring styles."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.auto.DocstringDetectionMethod", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L27-L27", "value": {"left": {"member": null, "name": "Literal", "cls": "ExprName"}, "slice": {"elements": ["'heuristics'", "'max_sections'"], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_patterns": {"kind": "attribute", "name": "_patterns", "runtime": true, "lineno": 31, "endlineno": 102, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.docstrings.auto._patterns", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L31-L102", "value": {"keys": [{"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "google", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "numpy", "cls": "ExprName"}], "cls": "ExprAttribute"}, {"values": [{"member": null, "name": "Parser", "cls": "ExprName"}, {"member": null, "name": "sphinx", "cls": "ExprName"}], "cls": "ExprAttribute"}], "values": [{"elements": ["'\\\\n[ \\\\t]*{0}:([ \\\\t]+.+)?\\\\n[ \\\\t]+.+'", {"elements": ["'args'", "'arguments'", "'params'", "'parameters'", "'keyword args'", "'keyword arguments'", "'other args'", "'other arguments'", "'other params'", "'other parameters'", "'raises'", "'exceptions'", "'returns'", "'yields'", "'receives'", "'examples'", "'attributes'", "'functions'", "'methods'", "'classes'", "'modules'", "'warns'", "'warnings'"], "cls": "ExprList"}], "implicit": false, "cls": "ExprTuple"}, {"elements": ["'\\\\n[ \\\\t]*{0}\\\\n[ \\\\t]*---+\\\\n'", {"elements": ["'deprecated'", "'parameters'", "'other parameters'", "'returns'", "'yields'", "'receives'", "'raises'", "'warns'", "'attributes'", "'functions'", "'methods'", "'classes'", "'modules'"], "cls": "ExprList"}], "implicit": false, "cls": "ExprTuple"}, {"elements": ["'\\\\n[ \\\\t]*:{0}([ \\\\t]+\\\\w+)*:([ \\\\t]+.+)?\\\\n'", {"elements": ["'param'", "'parameter'", "'arg'", "'argument'", "'key'", "'keyword'", "'type'", "'var'", "'ivar'", "'cvar'", "'vartype'", "'returns'", "'return'", "'rtype'", "'raises'", "'raise'", "'except'", "'exception'"], "cls": "ExprList"}], "implicit": false, "cls": "ExprTuple"}], "cls": "ExprDict"}}, "PerStyleOptions": {"kind": "class", "name": "PerStyleOptions", "runtime": true, "lineno": 105, "endlineno": 113, "docstring": {"value": "Per-style options for docstring parsing.", "lineno": 106, "endlineno": 106, "parsed": [{"kind": "text", "value": "Per-style options for docstring parsing."}]}, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "google", "annotation": {"member": null, "name": "GoogleOptions", "cls": "ExprName"}, "description": "Options for Google-style docstrings.", "value": "..."}, {"name": "numpy", "annotation": {"member": null, "name": "NumpyOptions", "cls": "ExprName"}, "description": "Options for Numpy-style docstrings.", "value": "..."}, {"name": "sphinx", "annotation": {"member": null, "name": "SphinxOptions", "cls": "ExprName"}, "description": "Options for Sphinx-style docstrings.", "value": "..."}]}]}, "path": "griffe._internal.docstrings.auto.PerStyleOptions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "google", "annotation": {"member": null, "name": "GoogleOptions", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Options for Google-style docstrings.", "lineno": 109, "endlineno": 109, "parsed": [{"kind": "text", "value": "Options for Google-style docstrings."}]}}, {"name": "numpy", "annotation": {"member": null, "name": "NumpyOptions", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Options for Numpy-style docstrings.", "lineno": 111, "endlineno": 111, "parsed": [{"kind": "text", "value": "Options for Numpy-style docstrings."}]}}, {"name": "sphinx", "annotation": {"member": null, "name": "SphinxOptions", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Options for Sphinx-style docstrings.", "lineno": 113, "endlineno": 113, "parsed": [{"kind": "text", "value": "Options for Sphinx-style docstrings."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.auto.PerStyleOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L105-L113", "bases": [{"member": "PerStyleOptions", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "infer_docstring_style": {"kind": "function", "name": "infer_docstring_style", "runtime": true, "lineno": 116, "endlineno": 172, "docstring": {"value": "Infer the parser to use for the docstring.\n\nThe 'heuristics' method uses regular expressions. The 'max_sections' method\nparses the docstring with all parsers specified in `style_order` and returns\nthe one who parsed the most sections.\n\nIf heuristics fail, the `default` parser is returned. If multiple parsers\nparsed the same number of sections, `style_order` is used to decide which\none to return. The `default` parser is never used with the 'max_sections' method.\n\nAdditional options are parsed to the detected parser, if any.\n\nParameters:\n    docstring: The docstring to parse.\n    method: The method to use to infer the parser.\n    style_order: The order of the styles to try when inferring the parser.\n    default: The default parser to use if the inference fails.\n    per_style_options: Additional parsing options per style.\n\nReturns:\n    The inferred parser, and optionally parsed sections (when method is 'max_sections').", "lineno": 124, "endlineno": 145, "parsed": [{"kind": "text", "value": "Infer the parser to use for the docstring.\n\nThe 'heuristics' method uses regular expressions. The 'max_sections' method\nparses the docstring with all parsers specified in `style_order` and returns\nthe one who parsed the most sections.\n\nIf heuristics fail, the `default` parser is returned. If multiple parsers\nparsed the same number of sections, `style_order` is used to decide which\none to return. The `default` parser is never used with the 'max_sections' method.\n\nAdditional options are parsed to the detected parser, if any."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "infer_docstring_style", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "method", "annotation": {"member": "infer_docstring_style", "name": "DocstringDetectionMethod", "cls": "ExprName"}, "description": "The method to use to infer the parser.", "value": "'heuristics'"}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The order of the styles to try when inferring the parser.", "value": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": "infer_docstring_style", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The default parser to use if the inference fails.", "value": "None"}, {"name": "per_style_options", "annotation": {"left": {"member": "infer_docstring_style", "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional parsing options per style.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "infer_docstring_style", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "description": "The inferred parser, and optionally parsed sections (when method is 'max_sections')."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.auto.infer_docstring_style", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L116-L172", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "infer_docstring_style", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "method", "annotation": {"member": "infer_docstring_style", "name": "DocstringDetectionMethod", "cls": "ExprName"}, "kind": "keyword-only", "default": "'heuristics'"}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": "infer_docstring_style", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "per_style_options", "annotation": {"left": {"member": "infer_docstring_style", "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "infer_docstring_style", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "infer_docstring_style", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"left": {"left": {"member": "infer_docstring_style", "name": "list", "cls": "ExprName"}, "slice": {"member": "infer_docstring_style", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "AutoOptions": {"kind": "class", "name": "AutoOptions", "runtime": true, "lineno": 175, "endlineno": 185, "docstring": {"value": "Options for Auto-style docstrings.", "lineno": 176, "endlineno": 176, "parsed": [{"kind": "text", "value": "Options for Auto-style docstrings."}]}, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "method", "annotation": {"member": null, "name": "DocstringDetectionMethod", "cls": "ExprName"}, "description": "The method to use to infer the parser.", "value": "..."}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The order of styles to try when inferring the parser.", "value": "..."}, {"name": "default", "annotation": {"left": {"left": {"member": null, "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The default parser to use if the inference fails.", "value": "..."}, {"name": "per_style_options", "annotation": {"left": {"member": null, "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional parsing options per style.", "value": "..."}]}]}, "path": "griffe._internal.docstrings.auto.AutoOptions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "method", "annotation": {"member": null, "name": "DocstringDetectionMethod", "cls": "ExprName"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "The method to use to infer the parser.", "lineno": 179, "endlineno": 179, "parsed": [{"kind": "text", "value": "The method to use to infer the parser."}]}}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "The order of styles to try when inferring the parser.", "lineno": 181, "endlineno": 181, "parsed": [{"kind": "text", "value": "The order of styles to try when inferring the parser."}]}}, {"name": "default", "annotation": {"left": {"left": {"member": null, "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "The default parser to use if the inference fails.", "lineno": 183, "endlineno": 183, "parsed": [{"kind": "text", "value": "The default parser to use if the inference fails."}]}}, {"name": "per_style_options", "annotation": {"left": {"member": null, "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "...", "docstring": {"value": "Additional parsing options per style.", "lineno": 185, "endlineno": 185, "parsed": [{"kind": "text", "value": "Additional parsing options per style."}]}}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.docstrings.auto.AutoOptions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L175-L185", "bases": [{"member": "AutoOptions", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "parse_auto": {"kind": "function", "name": "parse_auto", "runtime": true, "lineno": 188, "endlineno": 224, "docstring": {"value": "Parse a docstring by automatically detecting the style it uses.\n\nSee [`infer_docstring_style`][griffe.infer_docstring_style] for more information\non the available parameters.\n\nParameters:\n    docstring: The docstring to parse.\n    method: The method to use to infer the parser.\n    style_order: The order of the styles to try when inferring the parser.\n    default: The default parser to use if the inference fails.\n    per_style_options: Additional parsing options per style.\n\nReturns:\n    A list of docstring sections.", "lineno": 196, "endlineno": 210, "parsed": [{"kind": "text", "value": "Parse a docstring by automatically detecting the style it uses.\n\nSee [`infer_docstring_style`][griffe.infer_docstring_style] for more information\non the available parameters."}, {"kind": "parameters", "value": [{"name": "docstring", "annotation": {"member": "parse_auto", "name": "Docstring", "cls": "ExprName"}, "description": "The docstring to parse."}, {"name": "method", "annotation": {"member": "parse_auto", "name": "DocstringDetectionMethod", "cls": "ExprName"}, "description": "The method to use to infer the parser.", "value": "'heuristics'"}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The order of the styles to try when inferring the parser.", "value": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "parse_auto", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse_auto", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "The default parser to use if the inference fails.", "value": "None"}, {"name": "per_style_options", "annotation": {"left": {"member": "parse_auto", "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": "Additional parsing options per style.", "value": "None"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}, "description": "A list of docstring sections."}]}]}, "analysis": "static", "path": "griffe._internal.docstrings.auto.parse_auto", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/docstrings/auto.py#L188-L224", "decorators": [], "parameters": [{"name": "docstring", "annotation": {"member": "parse_auto", "name": "Docstring", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "method", "annotation": {"member": "parse_auto", "name": "DocstringDetectionMethod", "cls": "ExprName"}, "kind": "keyword-only", "default": "'heuristics'"}, {"name": "style_order", "annotation": {"left": {"left": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "Parser", "cls": "ExprName"}, "cls": "ExprSubscript"}, "operator": "|", "right": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "default", "annotation": {"left": {"left": {"member": "parse_auto", "name": "Parser", "cls": "ExprName"}, "operator": "|", "right": {"member": "parse_auto", "name": "DocstringStyle", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}, {"name": "per_style_options", "annotation": {"left": {"member": "parse_auto", "name": "PerStyleOptions", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": "None"}], "returns": {"left": {"member": "parse_auto", "name": "list", "cls": "ExprName"}, "slice": {"member": "parse_auto", "name": "DocstringSection", "cls": "ExprName"}, "cls": "ExprSubscript"}}}, "analysis": "static", "path": "griffe._internal.docstrings.auto", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/auto.py", "relative_package_filepath": "griffe/_internal/docstrings/auto.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/auto.py"}}, "analysis": "static", "path": "griffe._internal.docstrings", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/docstrings/__init__.py", "relative_package_filepath": "griffe/_internal/docstrings/__init__.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/docstrings/__init__.py"}, "extensions": {"kind": "module", "name": "extensions", "runtime": true, "members": {"base": {"kind": "module", "name": "base", "runtime": true, "imports": {"annotations": "__future__.annotations", "os": "os", "sys": "sys", "module_from_spec": "importlib.util.module_from_spec", "spec_from_file_location": "importlib.util.spec_from_file_location", "isclass": "inspect.isclass", "Path": "pathlib.Path", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "ast_children": "griffe._internal.agents.nodes.ast.ast_children", "ast_kind": "griffe._internal.agents.nodes.ast.ast_kind", "ExtensionNotLoadedError": "griffe._internal.exceptions.ExtensionNotLoadedError", "dynamic_import": "griffe._internal.importer.dynamic_import", "ast": "ast", "ModuleType": "types.ModuleType", "Inspector": "griffe._internal.agents.inspector.Inspector", "ObjectNode": "griffe._internal.agents.nodes.runtime.ObjectNode", "Visitor": "griffe._internal.agents.visitor.Visitor", "GriffeLoader": "griffe._internal.loader.GriffeLoader", "Alias": "griffe._internal.models.Alias", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Object": "griffe._internal.models.Object", "TypeAlias": "griffe._internal.models.TypeAlias"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.extensions.base.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "os": {"kind": "alias", "name": "os", "target_path": "os", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.extensions.base.os", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "sys": {"kind": "alias", "name": "sys", "target_path": "sys", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.extensions.base.sys", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "module_from_spec": {"kind": "alias", "name": "module_from_spec", "target_path": "importlib.util.module_from_spec", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.base.module_from_spec", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "spec_from_file_location": {"kind": "alias", "name": "spec_from_file_location", "target_path": "importlib.util.spec_from_file_location", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.base.spec_from_file_location", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "isclass": {"kind": "alias", "name": "isclass", "target_path": "inspect.isclass", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.extensions.base.isclass", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Path": {"kind": "alias", "name": "Path", "target_path": "pathlib.Path", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.extensions.base.Path", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.extensions.base.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.extensions.base.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast_children": {"kind": "alias", "name": "ast_children", "target_path": "griffe._internal.agents.nodes.ast.ast_children", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.extensions.base.ast_children", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast_kind": {"kind": "alias", "name": "ast_kind", "target_path": "griffe._internal.agents.nodes.ast.ast_kind", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.extensions.base.ast_kind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExtensionNotLoadedError": {"kind": "alias", "name": "ExtensionNotLoadedError", "target_path": "griffe._internal.exceptions.ExtensionNotLoadedError", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.extensions.base.ExtensionNotLoadedError", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "dynamic_import": {"kind": "alias", "name": "dynamic_import", "target_path": "griffe._internal.importer.dynamic_import", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.extensions.base.dynamic_import", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": false, "inherited": false, "lineno": 18, "endlineno": 18, "analysis": "static", "path": "griffe._internal.extensions.base.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ModuleType": {"kind": "alias", "name": "ModuleType", "target_path": "types.ModuleType", "runtime": false, "inherited": false, "lineno": 19, "endlineno": 19, "analysis": "static", "path": "griffe._internal.extensions.base.ModuleType", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Inspector": {"kind": "alias", "name": "Inspector", "target_path": "griffe._internal.agents.inspector.Inspector", "runtime": false, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.extensions.base.Inspector", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "ObjectNode": {"kind": "alias", "name": "ObjectNode", "target_path": "griffe._internal.agents.nodes.runtime.ObjectNode", "runtime": false, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.base.ObjectNode", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Visitor": {"kind": "alias", "name": "Visitor", "target_path": "griffe._internal.agents.visitor.Visitor", "runtime": false, "inherited": false, "lineno": 23, "endlineno": 23, "analysis": "static", "path": "griffe._internal.extensions.base.Visitor", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "GriffeLoader": {"kind": "alias", "name": "GriffeLoader", "target_path": "griffe._internal.loader.GriffeLoader", "runtime": false, "inherited": false, "lineno": 24, "endlineno": 24, "analysis": "static", "path": "griffe._internal.extensions.base.GriffeLoader", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Alias": {"kind": "alias", "name": "Alias", "target_path": "griffe._internal.models.Alias", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Alias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Object": {"kind": "alias", "name": "Object", "target_path": "griffe._internal.models.Object", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.Object", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "TypeAlias": {"kind": "alias", "name": "TypeAlias", "target_path": "griffe._internal.models.TypeAlias", "runtime": false, "inherited": false, "lineno": 25, "endlineno": 25, "analysis": "static", "path": "griffe._internal.extensions.base.TypeAlias", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Extension": {"kind": "class", "name": "Extension", "runtime": true, "lineno": 28, "endlineno": 435, "docstring": {"value": "Base class for Griffe extensions.", "lineno": 29, "endlineno": 29, "parsed": [{"kind": "text", "value": "Base class for Griffe extensions."}]}, "members": {"visit": {"kind": "function", "name": "visit", "runtime": true, "lineno": 31, "endlineno": 37, "docstring": {"value": "Visit a node.\n\nParameters:\n    node: The node to visit.", "lineno": 32, "endlineno": 36, "parsed": [{"kind": "text", "value": "Visit a node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.visit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L31-L37", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "generic_visit": {"kind": "function", "name": "generic_visit", "runtime": true, "lineno": 39, "endlineno": 46, "docstring": {"value": "Visit children nodes.\n\nParameters:\n    node: The node to visit the children of.", "lineno": 40, "endlineno": 44, "parsed": [{"kind": "text", "value": "Visit children nodes."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"values": [{"member": "generic_visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "description": "The node to visit the children of."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.generic_visit", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L39-L46", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"values": [{"member": "generic_visit", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "inspect": {"kind": "function", "name": "inspect", "runtime": true, "lineno": 48, "endlineno": 54, "docstring": {"value": "Inspect a node.\n\nParameters:\n    node: The node to inspect.", "lineno": 49, "endlineno": 53, "parsed": [{"kind": "text", "value": "Inspect a node."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "inspect", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.inspect", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L48-L54", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "inspect", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "generic_inspect": {"kind": "function", "name": "generic_inspect", "runtime": true, "lineno": 56, "endlineno": 64, "docstring": {"value": "Extend the base generic inspection with extensions.\n\nParameters:\n    node: The node to inspect.", "lineno": 57, "endlineno": 61, "parsed": [{"kind": "text", "value": "Extend the base generic inspection with extensions."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"member": "generic_inspect", "name": "ObjectNode", "cls": "ExprName"}, "description": "The node to inspect."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.generic_inspect", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L56-L64", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"member": "generic_inspect", "name": "ObjectNode", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "on_node": {"kind": "function", "name": "on_node", "runtime": true, "lineno": 66, "endlineno": 71, "docstring": {"value": "Run when visiting a new node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.", "lineno": 67, "endlineno": 71, "parsed": [{"kind": "text", "value": "Run when visiting a new node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L66-L71", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_instance": {"kind": "function", "name": "on_instance", "runtime": true, "lineno": 73, "endlineno": 93, "docstring": {"value": "Run when an Object has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    obj: The object instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 81, "endlineno": 93, "parsed": [{"kind": "text", "value": "Run when an Object has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "obj", "annotation": {"member": "on_instance", "name": "Object", "cls": "ExprName"}, "description": "The object instance."}, {"name": "agent", "annotation": {"left": {"member": "on_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L73-L93", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "obj", "annotation": {"member": "on_instance", "name": "Object", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_object": {"kind": "function", "name": "on_object", "runtime": true, "lineno": 95, "endlineno": 106, "docstring": {"value": "Run on objects (every kind) once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    obj: The object instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 96, "endlineno": 106, "parsed": [{"kind": "text", "value": "Run on objects (every kind) once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "obj", "annotation": {"member": "on_object", "name": "Object", "cls": "ExprName"}, "description": "The object instance."}, {"name": "loader", "annotation": {"member": "on_object", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_object", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_object", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L95-L106", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "obj", "annotation": {"member": "on_object", "name": "Object", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_object", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_object", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_members": {"kind": "function", "name": "on_members", "runtime": true, "lineno": 108, "endlineno": 121, "docstring": {"value": "Run when members of an Object have been loaded.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    obj: The object instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 109, "endlineno": 121, "parsed": [{"kind": "text", "value": "Run when members of an Object have been loaded."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "obj", "annotation": {"member": "on_members", "name": "Object", "cls": "ExprName"}, "description": "The object instance."}, {"name": "agent", "annotation": {"left": {"member": "on_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_members", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L108-L121", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "obj", "annotation": {"member": "on_members", "name": "Object", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_members", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_module_node": {"kind": "function", "name": "on_module_node", "runtime": true, "lineno": 123, "endlineno": 130, "docstring": {"value": "Run when visiting a new module node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 124, "endlineno": 130, "parsed": [{"kind": "text", "value": "Run when visiting a new module node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_module_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "agent", "annotation": {"left": {"member": "on_module_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_module_node", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_module_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L123-L130", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_module_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_module_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_module_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_module_instance": {"kind": "function", "name": "on_module_instance", "runtime": true, "lineno": 132, "endlineno": 152, "docstring": {"value": "Run when a Module has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    mod: The module instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 140, "endlineno": 152, "parsed": [{"kind": "text", "value": "Run when a Module has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_module_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "mod", "annotation": {"member": "on_module_instance", "name": "Module", "cls": "ExprName"}, "description": "The module instance."}, {"name": "agent", "annotation": {"left": {"member": "on_module_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_module_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_module_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L132-L152", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_module_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "mod", "annotation": {"member": "on_module_instance", "name": "Module", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_module_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_module_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_module": {"kind": "function", "name": "on_module", "runtime": true, "lineno": 154, "endlineno": 165, "docstring": {"value": "Run on modules once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    mod: The module instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 155, "endlineno": 165, "parsed": [{"kind": "text", "value": "Run on modules once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "mod", "annotation": {"member": "on_module", "name": "Module", "cls": "ExprName"}, "description": "The module instance."}, {"name": "loader", "annotation": {"member": "on_module", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_module", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_module", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L154-L165", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "mod", "annotation": {"member": "on_module", "name": "Module", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_module", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_module", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_module_members": {"kind": "function", "name": "on_module_members", "runtime": true, "lineno": 167, "endlineno": 187, "docstring": {"value": "Run when members of a Module have been loaded.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    mod: The module instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 175, "endlineno": 187, "parsed": [{"kind": "text", "value": "Run when members of a Module have been loaded."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_module_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "mod", "annotation": {"member": "on_module_members", "name": "Module", "cls": "ExprName"}, "description": "The module instance."}, {"name": "agent", "annotation": {"left": {"member": "on_module_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_module_members", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_module_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L167-L187", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_module_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_module_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "mod", "annotation": {"member": "on_module_members", "name": "Module", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_module_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_module_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_module_members", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_class_node": {"kind": "function", "name": "on_class_node", "runtime": true, "lineno": 189, "endlineno": 196, "docstring": {"value": "Run when visiting a new class node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 190, "endlineno": 196, "parsed": [{"kind": "text", "value": "Run when visiting a new class node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_class_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "agent", "annotation": {"left": {"member": "on_class_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_class_node", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_class_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L189-L196", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_class_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_class_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_class_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_class_instance": {"kind": "function", "name": "on_class_instance", "runtime": true, "lineno": 198, "endlineno": 218, "docstring": {"value": "Run when a Class has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    cls: The class instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 206, "endlineno": 218, "parsed": [{"kind": "text", "value": "Run when a Class has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_class_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "cls", "annotation": {"member": "on_class_instance", "name": "Class", "cls": "ExprName"}, "description": "The class instance."}, {"name": "agent", "annotation": {"left": {"member": "on_class_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_class_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_class_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L198-L218", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_class_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "cls", "annotation": {"member": "on_class_instance", "name": "Class", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_class_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_class_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_class": {"kind": "function", "name": "on_class", "runtime": true, "lineno": 220, "endlineno": 231, "docstring": {"value": "Run on classes once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    cls: The class instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 221, "endlineno": 231, "parsed": [{"kind": "text", "value": "Run on classes once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "cls", "annotation": {"member": "on_class", "name": "Class", "cls": "ExprName"}, "description": "The class instance."}, {"name": "loader", "annotation": {"member": "on_class", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_class", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L220-L231", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "cls", "annotation": {"member": "on_class", "name": "Class", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_class", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_class", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_class_members": {"kind": "function", "name": "on_class_members", "runtime": true, "lineno": 233, "endlineno": 253, "docstring": {"value": "Run when members of a Class have been loaded.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    cls: The class instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 241, "endlineno": 253, "parsed": [{"kind": "text", "value": "Run when members of a Class have been loaded."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_class_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "cls", "annotation": {"member": "on_class_members", "name": "Class", "cls": "ExprName"}, "description": "The class instance."}, {"name": "agent", "annotation": {"left": {"member": "on_class_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_class_members", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_class_members", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L233-L253", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_class_members", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_class_members", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "cls", "annotation": {"member": "on_class_members", "name": "Class", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_class_members", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_class_members", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_class_members", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_function_node": {"kind": "function", "name": "on_function_node", "runtime": true, "lineno": 255, "endlineno": 262, "docstring": {"value": "Run when visiting a new function node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 256, "endlineno": 262, "parsed": [{"kind": "text", "value": "Run when visiting a new function node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_function_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_function_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "agent", "annotation": {"left": {"member": "on_function_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_function_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_function_node", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_function_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L255-L262", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_function_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_function_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_function_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_function_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_function_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_function_instance": {"kind": "function", "name": "on_function_instance", "runtime": true, "lineno": 264, "endlineno": 284, "docstring": {"value": "Run when a Function has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    func: The function instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 272, "endlineno": 284, "parsed": [{"kind": "text", "value": "Run when a Function has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_function_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_function_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "func", "annotation": {"member": "on_function_instance", "name": "Function", "cls": "ExprName"}, "description": "The function instance."}, {"name": "agent", "annotation": {"left": {"member": "on_function_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_function_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_function_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_function_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L264-L284", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_function_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_function_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "func", "annotation": {"member": "on_function_instance", "name": "Function", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_function_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_function_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_function_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_function": {"kind": "function", "name": "on_function", "runtime": true, "lineno": 286, "endlineno": 297, "docstring": {"value": "Run on functions once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    func: The function instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 287, "endlineno": 297, "parsed": [{"kind": "text", "value": "Run on functions once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "func", "annotation": {"member": "on_function", "name": "Function", "cls": "ExprName"}, "description": "The function instance."}, {"name": "loader", "annotation": {"member": "on_function", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_function", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L286-L297", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "func", "annotation": {"member": "on_function", "name": "Function", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_function", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_function", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_attribute_node": {"kind": "function", "name": "on_attribute_node", "runtime": true, "lineno": 299, "endlineno": 306, "docstring": {"value": "Run when visiting a new attribute node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 300, "endlineno": 306, "parsed": [{"kind": "text", "value": "Run when visiting a new attribute node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_attribute_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_attribute_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "agent", "annotation": {"left": {"member": "on_attribute_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_attribute_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_attribute_node", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_attribute_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L299-L306", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_attribute_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_attribute_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_attribute_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_attribute_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_attribute_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_attribute_instance": {"kind": "function", "name": "on_attribute_instance", "runtime": true, "lineno": 308, "endlineno": 328, "docstring": {"value": "Run when an Attribute has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    attr: The attribute instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 316, "endlineno": 328, "parsed": [{"kind": "text", "value": "Run when an Attribute has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_attribute_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_attribute_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "attr", "annotation": {"member": "on_attribute_instance", "name": "Attribute", "cls": "ExprName"}, "description": "The attribute instance."}, {"name": "agent", "annotation": {"left": {"member": "on_attribute_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_attribute_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_attribute_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_attribute_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L308-L328", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_attribute_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_attribute_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "attr", "annotation": {"member": "on_attribute_instance", "name": "Attribute", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_attribute_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_attribute_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_attribute_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_attribute": {"kind": "function", "name": "on_attribute", "runtime": true, "lineno": 330, "endlineno": 341, "docstring": {"value": "Run on attributes once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    attr: The attribute instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 331, "endlineno": 341, "parsed": [{"kind": "text", "value": "Run on attributes once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "attr", "annotation": {"member": "on_attribute", "name": "Attribute", "cls": "ExprName"}, "description": "The attribute instance."}, {"name": "loader", "annotation": {"member": "on_attribute", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_attribute", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_attribute", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L330-L341", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "attr", "annotation": {"member": "on_attribute", "name": "Attribute", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_attribute", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_attribute", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_type_alias_node": {"kind": "function", "name": "on_type_alias_node", "runtime": true, "lineno": 343, "endlineno": 350, "docstring": {"value": "Run when visiting a new type alias node during static/dynamic analysis.\n\nParameters:\n    node: The currently visited node.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 344, "endlineno": 350, "parsed": [{"kind": "text", "value": "Run when visiting a new type alias node during static/dynamic analysis."}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_type_alias_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_type_alias_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "agent", "annotation": {"left": {"member": "on_type_alias_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_type_alias_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_type_alias_node", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_type_alias_node", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L343-L350", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_type_alias_node", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_type_alias_node", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_type_alias_node", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_type_alias_node", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_type_alias_node", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_type_alias_instance": {"kind": "function", "name": "on_type_alias_instance", "runtime": true, "lineno": 352, "endlineno": 372, "docstring": {"value": "Run when a TypeAlias has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    type_alias: The type alias instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 360, "endlineno": 372, "parsed": [{"kind": "text", "value": "Run when a TypeAlias has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_type_alias_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_type_alias_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "type_alias", "annotation": {"member": "on_type_alias_instance", "name": "TypeAlias", "cls": "ExprName"}, "description": "The type alias instance."}, {"name": "agent", "annotation": {"left": {"member": "on_type_alias_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_type_alias_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_type_alias_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_type_alias_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L352-L372", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_type_alias_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_type_alias_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "type_alias", "annotation": {"member": "on_type_alias_instance", "name": "TypeAlias", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_type_alias_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_type_alias_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_type_alias_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_type_alias": {"kind": "function", "name": "on_type_alias", "runtime": true, "lineno": 374, "endlineno": 385, "docstring": {"value": "Run on type aliases once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    type_alias: The type alias instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 375, "endlineno": 385, "parsed": [{"kind": "text", "value": "Run on type aliases once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "type_alias", "annotation": {"member": "on_type_alias", "name": "TypeAlias", "cls": "ExprName"}, "description": "The type alias instance."}, {"name": "loader", "annotation": {"member": "on_type_alias", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_type_alias", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_type_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L374-L385", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "type_alias", "annotation": {"member": "on_type_alias", "name": "TypeAlias", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_type_alias", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_type_alias", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_alias_instance": {"kind": "function", "name": "on_alias_instance", "runtime": true, "lineno": 387, "endlineno": 409, "docstring": {"value": "Run when an Alias has been created.\n\nWarning:\n    This method runs while the object tree is still being constructed:\n    data might be incomplete (class inheritance, alias resolution, etc.).\n    Only hook onto this event if you know what you're doing.\n\nParameters:\n    node: The currently visited node.\n    alias: The alias instance.\n    agent: The analysis agent currently running.\n    **kwargs: For forward-compatibility.", "lineno": 395, "endlineno": 407, "parsed": [{"kind": "text", "value": "Run when an Alias has been created."}, {"kind": "admonition", "value": {"annotation": "warning", "description": "This method runs while the object tree is still being constructed:\ndata might be incomplete (class inheritance, alias resolution, etc.).\nOnly hook onto this event if you know what you're doing."}, "title": "Warning"}, {"kind": "parameters", "value": [{"name": "node", "annotation": {"left": {"values": [{"member": "on_alias_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_alias_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The currently visited node."}, {"name": "alias", "annotation": {"member": "on_alias_instance", "name": "Alias", "cls": "ExprName"}, "description": "The alias instance."}, {"name": "agent", "annotation": {"left": {"member": "on_alias_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_alias_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "description": "The analysis agent currently running."}, {"name": "**kwargs", "annotation": {"member": "on_alias_instance", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_alias_instance", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L387-L409", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "node", "annotation": {"left": {"values": [{"member": "on_alias_instance", "name": "ast", "cls": "ExprName"}, {"member": null, "name": "AST", "cls": "ExprName"}], "cls": "ExprAttribute"}, "operator": "|", "right": {"member": "on_alias_instance", "name": "ObjectNode", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "alias", "annotation": {"member": "on_alias_instance", "name": "Alias", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "agent", "annotation": {"left": {"member": "on_alias_instance", "name": "Visitor", "cls": "ExprName"}, "operator": "|", "right": {"member": "on_alias_instance", "name": "Inspector", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_alias_instance", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_alias": {"kind": "function", "name": "on_alias", "runtime": true, "lineno": 411, "endlineno": 422, "docstring": {"value": "Run on aliases once the object tree has been fully constructed.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    alias: The alias instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 412, "endlineno": 422, "parsed": [{"kind": "text", "value": "Run on aliases once the object tree has been fully constructed."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "alias", "annotation": {"member": "on_alias", "name": "Alias", "cls": "ExprName"}, "description": "The alias instance."}, {"name": "loader", "annotation": {"member": "on_alias", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_alias", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_alias", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L411-L422", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "alias", "annotation": {"member": "on_alias", "name": "Alias", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_alias", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_alias", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_package": {"kind": "function", "name": "on_package", "runtime": true, "lineno": 424, "endlineno": 435, "docstring": {"value": "Run when a package has been completely loaded.\n\nNote:\n    This method runs once the object tree has been fully constructed:\n    data is therefore complete and you can safely hook onto this event.\n\nParameters:\n    pkg: The package (Module) instance.\n    loader: The loader currently in use.\n    **kwargs: For forward-compatibility.", "lineno": 425, "endlineno": 435, "parsed": [{"kind": "text", "value": "Run when a package has been completely loaded."}, {"kind": "admonition", "value": {"annotation": "note", "description": "This method runs once the object tree has been fully constructed:\ndata is therefore complete and you can safely hook onto this event."}, "title": "Note"}, {"kind": "parameters", "value": [{"name": "pkg", "annotation": {"member": "on_package", "name": "Module", "cls": "ExprName"}, "description": "The package (Module) instance."}, {"name": "loader", "annotation": {"member": "on_package", "name": "GriffeLoader", "cls": "ExprName"}, "description": "The loader currently in use."}, {"name": "**kwargs", "annotation": {"member": "on_package", "name": "Any", "cls": "ExprName"}, "description": "For forward-compatibility.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension.on_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L424-L435", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "pkg", "annotation": {"member": "on_package", "name": "Module", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "loader", "annotation": {"member": "on_package", "name": "GriffeLoader", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_package", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.extensions.base.Extension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L28-L435", "bases": [], "decorators": []}, "LoadableExtensionType": {"kind": "attribute", "name": "LoadableExtensionType", "runtime": true, "lineno": 438, "endlineno": 438, "docstring": {"value": "All the types that can be passed to `load_extensions`.", "lineno": 439, "endlineno": 439, "parsed": [{"kind": "text", "value": "All the types that can be passed to `load_extensions`."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.extensions.base.LoadableExtensionType", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L438-L438", "value": {"left": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": null, "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": null, "name": "str", "cls": "ExprName"}, {"member": null, "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": null, "name": "Extension", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": null, "name": "type", "cls": "ExprName"}, "slice": {"member": null, "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "Extensions": {"kind": "class", "name": "Extensions", "runtime": true, "lineno": 442, "endlineno": 474, "docstring": {"value": "This class helps iterating on extensions that should run at different times.", "lineno": 443, "endlineno": 443, "parsed": [{"kind": "text", "value": "This class helps iterating on extensions that should run at different times."}]}, "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "lineno": 445, "endlineno": 452, "docstring": {"value": "Initialize the extensions container.\n\nParameters:\n    *extensions: The extensions to add.", "lineno": 446, "endlineno": 450, "parsed": [{"kind": "parameters", "value": [{"name": "*extensions", "annotation": {"member": "__init__", "name": "Extension", "cls": "ExprName"}, "description": "The extensions to add.", "value": "()"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extensions.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L445-L452", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"member": "__init__", "name": "Extension", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": "None"}, "_extensions": {"kind": "attribute", "name": "_extensions", "runtime": true, "lineno": 451, "endlineno": 451, "labels": ["instance-attribute"], "analysis": "static", "path": "griffe._internal.extensions.base.Extensions._extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L451-L451", "value": {"elements": [], "cls": "ExprList"}, "annotation": {"left": {"member": null, "name": "list", "cls": "ExprName"}, "slice": {"member": null, "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "add": {"kind": "function", "name": "add", "runtime": true, "lineno": 454, "endlineno": 461, "docstring": {"value": "Add extensions to this container.\n\nParameters:\n    *extensions: The extensions to add.", "lineno": 455, "endlineno": 459, "parsed": [{"kind": "text", "value": "Add extensions to this container."}, {"kind": "parameters", "value": [{"name": "*extensions", "annotation": {"member": "add", "name": "Extension", "cls": "ExprName"}, "description": "The extensions to add.", "value": "()"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extensions.add", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L454-L461", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "extensions", "annotation": {"member": "add", "name": "Extension", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": "None"}, "_noop": {"kind": "function", "name": "_noop", "runtime": true, "lineno": 463, "endlineno": 464, "docstring": {"value": "No-op method for extension hooks.", "lineno": 464, "endlineno": 464, "parsed": [{"kind": "text", "value": "No-op method for extension hooks."}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extensions._noop", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L463-L464", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "_noop", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "call": {"kind": "function", "name": "call", "runtime": true, "lineno": 466, "endlineno": 474, "docstring": {"value": "Call the extension hook for the given event.\n\nParameters:\n    event: The triggered event.\n    **kwargs: Arguments passed to the hook.", "lineno": 467, "endlineno": 472, "parsed": [{"kind": "text", "value": "Call the extension hook for the given event."}, {"kind": "parameters", "value": [{"name": "event", "annotation": {"member": "call", "name": "str", "cls": "ExprName"}, "description": "The triggered event."}, {"name": "**kwargs", "annotation": {"member": "call", "name": "Any", "cls": "ExprName"}, "description": "Arguments passed to the hook.", "value": "{}"}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.Extensions.call", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L466-L474", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "event", "annotation": {"member": "call", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "kwargs", "annotation": {"member": "call", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.extensions.base.Extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L442-L474", "bases": [], "decorators": []}, "builtin_extensions": {"kind": "attribute", "name": "builtin_extensions", "runtime": true, "lineno": 477, "endlineno": 480, "docstring": {"value": "The names of built-in Griffe extensions.", "lineno": 481, "endlineno": 481, "parsed": [{"kind": "text", "value": "The names of built-in Griffe extensions."}]}, "labels": ["module-attribute"], "analysis": "static", "path": "griffe._internal.extensions.base.builtin_extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L477-L480", "value": {"elements": ["'dataclasses'", "'unpack_typeddict'"], "cls": "ExprSet"}, "annotation": {"left": {"member": null, "name": "set", "cls": "ExprName"}, "slice": {"member": null, "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_load_extension_path": {"kind": "function", "name": "_load_extension_path", "runtime": true, "lineno": 484, "endlineno": 492, "analysis": "static", "path": "griffe._internal.extensions.base._load_extension_path", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L484-L492", "decorators": [], "parameters": [{"name": "path", "annotation": {"member": "_load_extension_path", "name": "str", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"member": "_load_extension_path", "name": "ModuleType", "cls": "ExprName"}}, "_load_extension": {"kind": "function", "name": "_load_extension", "runtime": true, "lineno": 495, "endlineno": 583, "docstring": {"value": "Load a configured extension.\n\nParameters:\n    extension: An extension, with potential configuration options.\n\nRaises:\n    ExtensionNotLoadedError: When the extension cannot be loaded,\n        either because the module is not found, or because it does not expose\n        the Extension attribute. ImportError will bubble up so users can see\n        the traceback.\n\nReturns:\n    An extension instance.", "lineno": 498, "endlineno": 511, "parsed": [{"kind": "text", "value": "Load a configured extension."}, {"kind": "parameters", "value": [{"name": "extension", "annotation": {"left": {"left": {"left": {"member": "_load_extension", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_extension", "name": "str", "cls": "ExprName"}, {"member": "_load_extension", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "type", "cls": "ExprName"}, "slice": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "An extension, with potential configuration options."}]}, {"kind": "raises", "value": [{"annotation": {"member": null, "name": "ExtensionNotLoadedError", "cls": "ExprName"}, "description": "When the extension cannot be loaded,\neither because the module is not found, or because it does not expose\nthe Extension attribute. ImportError will bubble up so users can see\nthe traceback."}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"left": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "list", "cls": "ExprName"}, "slice": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "description": "An extension instance."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base._load_extension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L495-L583", "decorators": [], "parameters": [{"name": "extension", "annotation": {"left": {"left": {"left": {"member": "_load_extension", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_load_extension", "name": "str", "cls": "ExprName"}, {"member": "_load_extension", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "type", "cls": "ExprName"}, "slice": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "operator": "|", "right": {"left": {"member": "_load_extension", "name": "list", "cls": "ExprName"}, "slice": {"member": "_load_extension", "name": "Extension", "cls": "ExprName"}, "cls": "ExprSubscript"}, "cls": "ExprBinOp"}}, "load_extensions": {"kind": "function", "name": "load_extensions", "runtime": true, "lineno": 586, "endlineno": 614, "docstring": {"value": "Load configured extensions.\n\nParameters:\n    exts: Extensions with potential configuration options.\n\nReturns:\n    An extensions container.", "lineno": 587, "endlineno": 594, "parsed": [{"kind": "text", "value": "Load configured extensions."}, {"kind": "parameters", "value": [{"name": "exts", "annotation": {"member": "load_extensions", "name": "LoadableExtensionType", "cls": "ExprName"}, "description": "Extensions with potential configuration options.", "value": "()"}]}, {"kind": "returns", "value": [{"name": "", "annotation": {"member": "load_extensions", "name": "Extensions", "cls": "ExprName"}, "description": "An extensions container."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.base.load_extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/base.py#L586-L614", "decorators": [], "parameters": [{"name": "exts", "annotation": {"member": "load_extensions", "name": "LoadableExtensionType", "cls": "ExprName"}, "kind": "variadic positional", "default": "()"}], "returns": {"member": "load_extensions", "name": "Extensions", "cls": "ExprName"}}}, "analysis": "static", "path": "griffe._internal.extensions.base", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/base.py", "relative_package_filepath": "griffe/_internal/extensions/base.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/base.py"}, "dataclasses": {"kind": "module", "name": "dataclasses", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "suppress": "contextlib.suppress", "cache": "functools.cache", "Any": "typing.Any", "cast": "typing.cast", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "Expr": "griffe._internal.expressions.Expr", "ExprAttribute": "griffe._internal.expressions.ExprAttribute", "ExprCall": "griffe._internal.expressions.ExprCall", "ExprDict": "griffe._internal.expressions.ExprDict", "Extension": "griffe._internal.extensions.base.Extension", "logger": "griffe._internal.logger.logger", "Attribute": "griffe._internal.models.Attribute", "Class": "griffe._internal.models.Class", "Decorator": "griffe._internal.models.Decorator", "Function": "griffe._internal.models.Function", "Module": "griffe._internal.models.Module", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "suppress": {"kind": "alias", "name": "suppress", "target_path": "contextlib.suppress", "runtime": true, "inherited": false, "lineno": 9, "endlineno": 9, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.suppress", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cache": {"kind": "alias", "name": "cache", "target_path": "functools.cache", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 10, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.cache", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "cast": {"kind": "alias", "name": "cast", "target_path": "typing.cast", "runtime": true, "inherited": false, "lineno": 11, "endlineno": 11, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.cast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 13, "endlineno": 13, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 19, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprAttribute": {"kind": "alias", "name": "ExprAttribute", "target_path": "griffe._internal.expressions.ExprAttribute", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 19, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.ExprAttribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprCall": {"kind": "alias", "name": "ExprCall", "target_path": "griffe._internal.expressions.ExprCall", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 19, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.ExprCall", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprDict": {"kind": "alias", "name": "ExprDict", "target_path": "griffe._internal.expressions.ExprDict", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 19, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.ExprDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Extension": {"kind": "alias", "name": "Extension", "target_path": "griffe._internal.extensions.base.Extension", "runtime": true, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Extension", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "logger": {"kind": "alias", "name": "logger", "target_path": "griffe._internal.logger.logger", "runtime": true, "inherited": false, "lineno": 21, "endlineno": 21, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.logger", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Attribute": {"kind": "alias", "name": "Attribute", "target_path": "griffe._internal.models.Attribute", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Attribute", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Decorator": {"kind": "alias", "name": "Decorator", "target_path": "griffe._internal.models.Decorator", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Decorator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Module": {"kind": "alias", "name": "Module", "target_path": "griffe._internal.models.Module", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Module", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Parameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 22, "endlineno": 22, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.Parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "_dataclass_decorator": {"kind": "function", "name": "_dataclass_decorator", "runtime": true, "lineno": 25, "endlineno": 29, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._dataclass_decorator", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L25-L29", "decorators": [], "parameters": [{"name": "decorators", "annotation": {"left": {"member": "_dataclass_decorator", "name": "list", "cls": "ExprName"}, "slice": {"member": "_dataclass_decorator", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_dataclass_decorator", "name": "Expr", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}}, "_expr_args": {"kind": "function", "name": "_expr_args", "runtime": true, "lineno": 32, "endlineno": 46, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._expr_args", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L32-L46", "decorators": [], "parameters": [{"name": "expr", "annotation": {"member": "_expr_args", "name": "Expr", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_expr_args", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_expr_args", "name": "str", "cls": "ExprName"}, {"left": {"member": "_expr_args", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_expr_args", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_dataclass_arguments": {"kind": "function", "name": "_dataclass_arguments", "runtime": true, "lineno": 49, "endlineno": 52, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._dataclass_arguments", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L49-L52", "decorators": [], "parameters": [{"name": "decorators", "annotation": {"left": {"member": "_dataclass_arguments", "name": "list", "cls": "ExprName"}, "slice": {"member": "_dataclass_arguments", "name": "Decorator", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_dataclass_arguments", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_dataclass_arguments", "name": "str", "cls": "ExprName"}, {"member": "_dataclass_arguments", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_field_arguments": {"kind": "function", "name": "_field_arguments", "runtime": true, "lineno": 55, "endlineno": 62, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._field_arguments", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L55-L62", "decorators": [], "parameters": [{"name": "attribute", "annotation": {"member": "_field_arguments", "name": "Attribute", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_field_arguments", "name": "dict", "cls": "ExprName"}, "slice": {"elements": [{"member": "_field_arguments", "name": "str", "cls": "ExprName"}, {"member": "_field_arguments", "name": "Any", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_dataclass_parameters": {"kind": "function", "name": "_dataclass_parameters", "runtime": true, "lineno": 65, "endlineno": 136, "labels": ["cached"], "analysis": "static", "path": "griffe._internal.extensions.dataclasses._dataclass_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L65-L136", "decorators": [{"value": {"member": null, "name": "cache", "cls": "ExprName"}, "lineno": 65, "endlineno": 65}], "parameters": [{"name": "class_", "annotation": {"member": "_dataclass_parameters", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_dataclass_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_dataclass_parameters", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_reorder_parameters": {"kind": "function", "name": "_reorder_parameters", "runtime": true, "lineno": 139, "endlineno": 154, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._reorder_parameters", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L139-L154", "decorators": [], "parameters": [{"name": "parameters", "annotation": {"left": {"member": "_reorder_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_reorder_parameters", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_reorder_parameters", "name": "list", "cls": "ExprName"}, "slice": {"member": "_reorder_parameters", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "_set_dataclass_init": {"kind": "function", "name": "_set_dataclass_init", "runtime": true, "lineno": 157, "endlineno": 192, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._set_dataclass_init", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L157-L192", "decorators": [], "parameters": [{"name": "class_", "annotation": {"member": "_set_dataclass_init", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_del_members_annotated_as_initvar": {"kind": "function", "name": "_del_members_annotated_as_initvar", "runtime": true, "lineno": 195, "endlineno": 200, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._del_members_annotated_as_initvar", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L195-L200", "decorators": [], "parameters": [{"name": "class_", "annotation": {"member": "_del_members_annotated_as_initvar", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "_apply_recursively": {"kind": "function", "name": "_apply_recursively", "runtime": true, "lineno": 203, "endlineno": 217, "analysis": "static", "path": "griffe._internal.extensions.dataclasses._apply_recursively", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L203-L217", "decorators": [], "parameters": [{"name": "mod_cls", "annotation": {"left": {"member": "_apply_recursively", "name": "Module", "cls": "ExprName"}, "operator": "|", "right": {"member": "_apply_recursively", "name": "Class", "cls": "ExprName"}, "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "processed", "annotation": {"left": {"member": "_apply_recursively", "name": "set", "cls": "ExprName"}, "slice": {"member": "_apply_recursively", "name": "str", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": "None"}, "DataclassesExtension": {"kind": "class", "name": "DataclassesExtension", "runtime": true, "lineno": 220, "endlineno": 233, "docstring": {"value": "Built-in extension adding support for dataclasses.\n\nThis extension creates `__init__` methods of dataclasses\nif they don't already exist.", "lineno": 221, "endlineno": 225, "parsed": [{"kind": "text", "value": "Built-in extension adding support for dataclasses.\n\nThis extension creates `__init__` methods of dataclasses\nif they don't already exist."}]}, "members": {"on_package": {"kind": "function", "name": "on_package", "runtime": true, "lineno": 227, "endlineno": 233, "docstring": {"value": "Hook for loaded packages.\n\nParameters:\n    pkg: The loaded package.", "lineno": 228, "endlineno": 232, "parsed": [{"kind": "text", "value": "Hook for loaded packages."}, {"kind": "parameters", "value": [{"name": "pkg", "annotation": {"member": "on_package", "name": "Module", "cls": "ExprName"}, "description": "The loaded package."}]}]}, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.DataclassesExtension.on_package", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L227-L233", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "pkg", "annotation": {"member": "on_package", "name": "Module", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_package", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.extensions.dataclasses.DataclassesExtension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py#L220-L233", "bases": [{"member": "DataclassesExtension", "name": "Extension", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.extensions.dataclasses", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/dataclasses.py", "relative_package_filepath": "griffe/_internal/extensions/dataclasses.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/dataclasses.py"}, "unpack_typeddict": {"kind": "module", "name": "unpack_typeddict", "runtime": true, "imports": {"annotations": "__future__.annotations", "ast": "ast", "chain": "itertools.chain", "TYPE_CHECKING": "typing.TYPE_CHECKING", "Any": "typing.Any", "TypedDict": "typing.TypedDict", "DocstringParameter": "griffe._internal.docstrings.models.DocstringParameter", "DocstringSectionParameters": "griffe._internal.docstrings.models.DocstringSectionParameters", "DocstringSectionKind": "griffe._internal.enumerations.DocstringSectionKind", "ParameterKind": "griffe._internal.enumerations.ParameterKind", "Expr": "griffe._internal.expressions.Expr", "ExprSubscript": "griffe._internal.expressions.ExprSubscript", "Extension": "griffe._internal.extensions.base.Extension", "Class": "griffe._internal.models.Class", "Docstring": "griffe._internal.models.Docstring", "Function": "griffe._internal.models.Function", "Parameter": "griffe._internal.models.Parameter", "Parameters": "griffe._internal.models.Parameters", "Iterable": "collections.abc.Iterable", "Iterator": "collections.abc.Iterator"}, "members": {"annotations": {"kind": "alias", "name": "annotations", "target_path": "__future__.annotations", "runtime": true, "inherited": false, "lineno": 4, "endlineno": 4, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.annotations", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ast": {"kind": "alias", "name": "ast", "target_path": "ast", "runtime": true, "inherited": false, "lineno": 6, "endlineno": 6, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.ast", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "chain": {"kind": "alias", "name": "chain", "target_path": "itertools.chain", "runtime": true, "inherited": false, "lineno": 7, "endlineno": 7, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.chain", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TYPE_CHECKING": {"kind": "alias", "name": "TYPE_CHECKING", "target_path": "typing.TYPE_CHECKING", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.TYPE_CHECKING", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Any": {"kind": "alias", "name": "Any", "target_path": "typing.Any", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Any", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "TypedDict": {"kind": "alias", "name": "TypedDict", "target_path": "typing.TypedDict", "runtime": true, "inherited": false, "lineno": 8, "endlineno": 8, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.TypedDict", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringParameter": {"kind": "alias", "name": "DocstringParameter", "target_path": "griffe._internal.docstrings.models.DocstringParameter", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 13, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.DocstringParameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionParameters": {"kind": "alias", "name": "DocstringSectionParameters", "target_path": "griffe._internal.docstrings.models.DocstringSectionParameters", "runtime": true, "inherited": false, "lineno": 10, "endlineno": 13, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.DocstringSectionParameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "DocstringSectionKind": {"kind": "alias", "name": "DocstringSectionKind", "target_path": "griffe._internal.enumerations.DocstringSectionKind", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.DocstringSectionKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ParameterKind": {"kind": "alias", "name": "ParameterKind", "target_path": "griffe._internal.enumerations.ParameterKind", "runtime": true, "inherited": false, "lineno": 14, "endlineno": 14, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.ParameterKind", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Expr": {"kind": "alias", "name": "Expr", "target_path": "griffe._internal.expressions.Expr", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Expr", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "ExprSubscript": {"kind": "alias", "name": "ExprSubscript", "target_path": "griffe._internal.expressions.ExprSubscript", "runtime": true, "inherited": false, "lineno": 15, "endlineno": 15, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.ExprSubscript", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Extension": {"kind": "alias", "name": "Extension", "target_path": "griffe._internal.extensions.base.Extension", "runtime": true, "inherited": false, "lineno": 16, "endlineno": 16, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Extension", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Class": {"kind": "alias", "name": "Class", "target_path": "griffe._internal.models.Class", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Class", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Docstring": {"kind": "alias", "name": "Docstring", "target_path": "griffe._internal.models.Docstring", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Docstring", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Function": {"kind": "alias", "name": "Function", "target_path": "griffe._internal.models.Function", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Function", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameter": {"kind": "alias", "name": "Parameter", "target_path": "griffe._internal.models.Parameter", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Parameter", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Parameters": {"kind": "alias", "name": "Parameters", "target_path": "griffe._internal.models.Parameters", "runtime": true, "inherited": false, "lineno": 17, "endlineno": 17, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Parameters", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": true}, "Iterable": {"kind": "alias", "name": "Iterable", "target_path": "collections.abc.Iterable", "runtime": false, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Iterable", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "Iterator": {"kind": "alias", "name": "Iterator", "target_path": "collections.abc.Iterator", "runtime": false, "inherited": false, "lineno": 20, "endlineno": 20, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.Iterator", "is_public": false, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": true, "is_exported": false, "is_wildcard_exposed": false}, "_TypedDictAttr": {"kind": "class", "name": "_TypedDictAttr", "runtime": true, "lineno": 23, "endlineno": 26, "labels": ["typed-dict"], "members": {"__init__": {"kind": "function", "name": "__init__", "runtime": true, "docstring": {"value": "", "lineno": null, "endlineno": null, "parsed": [{"kind": "parameters", "value": [{"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "description": ""}, {"name": "annotation", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": ""}, {"name": "docstring", "annotation": {"left": {"member": null, "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "description": ""}]}]}, "path": "griffe._internal.extensions.unpack_typeddict._TypedDictAttr.__init__", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": true, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "name", "annotation": {"member": null, "name": "str", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "annotation", "annotation": {"left": {"left": {"member": null, "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": null, "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}, {"name": "docstring", "annotation": {"left": {"member": null, "name": "Docstring", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "keyword-only", "default": null}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict._TypedDictAttr", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L23-L26", "bases": [{"member": "_TypedDictAttr", "name": "TypedDict", "cls": "ExprName"}], "decorators": []}, "_unwrap_annotation": {"kind": "function", "name": "_unwrap_annotation", "runtime": true, "lineno": 29, "endlineno": 62, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict._unwrap_annotation", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L29-L62", "decorators": [], "parameters": [{"name": "annotation", "annotation": {"left": {"left": {"member": "_unwrap_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_unwrap_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": null}, {"name": "default_required", "annotation": {"member": "_unwrap_annotation", "name": "bool", "cls": "ExprName"}, "kind": "keyword-only", "default": null}], "returns": {"left": {"member": "_unwrap_annotation", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"left": {"member": "_unwrap_annotation", "name": "str", "cls": "ExprName"}, "operator": "|", "right": {"member": "_unwrap_annotation", "name": "Expr", "cls": "ExprName"}, "cls": "ExprBinOp"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, {"member": "_unwrap_annotation", "name": "bool", "cls": "ExprName"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_get_or_set_attrs": {"kind": "function", "name": "_get_or_set_attrs", "runtime": true, "lineno": 65, "endlineno": 106, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict._get_or_set_attrs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L65-L106", "decorators": [], "parameters": [{"name": "cls", "annotation": {"member": "_get_or_set_attrs", "name": "Class", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_get_or_set_attrs", "name": "tuple", "cls": "ExprName"}, "slice": {"elements": [{"left": {"member": "_get_or_set_attrs", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_or_set_attrs", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}, {"left": {"member": "_get_or_set_attrs", "name": "list", "cls": "ExprName"}, "slice": {"member": "_get_or_set_attrs", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}], "implicit": true, "cls": "ExprTuple"}, "cls": "ExprSubscript"}}, "_update_docstring": {"kind": "function", "name": "_update_docstring", "runtime": true, "lineno": 109, "endlineno": 165, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict._update_docstring", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L109-L165", "decorators": [], "parameters": [{"name": "func", "annotation": {"member": "_update_docstring", "name": "Function", "cls": "ExprName"}, "kind": "positional or keyword", "default": null}, {"name": "required", "annotation": {"left": {"member": "_update_docstring", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_update_docstring", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "optional", "annotation": {"left": {"member": "_update_docstring", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_update_docstring", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "kwparam", "annotation": {"left": {"member": "_update_docstring", "name": "Parameter", "cls": "ExprName"}, "operator": "|", "right": "None", "cls": "ExprBinOp"}, "kind": "positional or keyword", "default": "None"}], "returns": "None"}, "_params_from_attrs": {"kind": "function", "name": "_params_from_attrs", "runtime": true, "lineno": 170, "endlineno": 185, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict._params_from_attrs", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L170-L185", "decorators": [], "parameters": [{"name": "required", "annotation": {"left": {"member": "_params_from_attrs", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_params_from_attrs", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}, {"name": "optional", "annotation": {"left": {"member": "_params_from_attrs", "name": "Iterable", "cls": "ExprName"}, "slice": {"member": "_params_from_attrs", "name": "_TypedDictAttr", "cls": "ExprName"}, "cls": "ExprSubscript"}, "kind": "positional or keyword", "default": null}], "returns": {"left": {"member": "_params_from_attrs", "name": "Iterator", "cls": "ExprName"}, "slice": {"member": "_params_from_attrs", "name": "Parameter", "cls": "ExprName"}, "cls": "ExprSubscript"}}, "UnpackTypedDictExtension": {"kind": "class", "name": "UnpackTypedDictExtension", "runtime": true, "lineno": 188, "endlineno": 255, "docstring": {"value": "An extension to handle `Unpack[TypeDict]`.", "lineno": 189, "endlineno": 189, "parsed": [{"kind": "text", "value": "An extension to handle `Unpack[TypeDict]`."}]}, "members": {"on_class": {"kind": "function", "name": "on_class", "runtime": true, "lineno": 191, "endlineno": 216, "docstring": {"value": "Add an `__init__` method to `TypedDict` classes if missing.", "lineno": 192, "endlineno": 192, "parsed": [{"kind": "text", "value": "Add an `__init__` method to `TypedDict` classes if missing."}]}, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.UnpackTypedDictExtension.on_class", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L191-L216", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "cls", "annotation": {"member": "on_class", "name": "Class", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_class", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}, "on_function": {"kind": "function", "name": "on_function", "runtime": true, "lineno": 218, "endlineno": 255, "docstring": {"value": "Expand `**kwargs: Unpack[TypedDict]` in function signatures.", "lineno": 219, "endlineno": 219, "parsed": [{"kind": "text", "value": "Expand `**kwargs: Unpack[TypedDict]` in function signatures."}]}, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.UnpackTypedDictExtension.on_function", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L218-L255", "decorators": [], "parameters": [{"name": "self", "annotation": null, "kind": "positional or keyword", "default": null}, {"name": "func", "annotation": {"member": "on_function", "name": "Function", "cls": "ExprName"}, "kind": "keyword-only", "default": null}, {"name": "kwargs", "annotation": {"member": "on_function", "name": "Any", "cls": "ExprName"}, "kind": "variadic keyword", "default": "{}"}], "returns": "None"}}, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict.UnpackTypedDictExtension", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": true, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "source_link": "https://github.com/mkdocstrings/griffe/blob/6f30ebb60f11c419c2b0c703faa09163a39552a3/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py#L188-L255", "bases": [{"member": "UnpackTypedDictExtension", "name": "Extension", "cls": "ExprName"}], "decorators": []}}, "analysis": "static", "path": "griffe._internal.extensions.unpack_typeddict", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py", "relative_package_filepath": "griffe/_internal/extensions/unpack_typeddict.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/unpack_typeddict.py"}}, "analysis": "static", "path": "griffe._internal.extensions", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/extensions/__init__.py", "relative_package_filepath": "griffe/_internal/extensions/__init__.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/extensions/__init__.py"}}, "analysis": "static", "path": "griffe._internal", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/_internal/__init__.py", "relative_package_filepath": "griffe/_internal/__init__.py", "is_public": false, "is_deprecated": false, "is_private": true, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/_internal/__init__.py"}}, "analysis": "static", "git_info": {"repository": "/media/data/dev/griffe", "service": "github", "remote_url": "https://github.com/mkdocstrings/griffe", "commit_hash": "6f30ebb60f11c419c2b0c703faa09163a39552a3"}, "path": "griffe", "filepath": "/media/data/dev/griffe/packages/griffelib/src/griffe/__init__.py", "relative_package_filepath": "griffe/__init__.py", "is_public": true, "is_deprecated": false, "is_private": false, "is_class_private": false, "is_special": false, "is_imported": false, "is_exported": false, "is_wildcard_exposed": false, "relative_filepath": "packages/griffelib/src/griffe/__init__.py"}