diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md index 224426697..85a6f3d15 100644 --- a/docs/reference/api/agents.md +++ b/docs/reference/api/agents.md @@ -74,4 +74,4 @@ Griffe is able to analyze code both statically and dynamically. ## **Deprecated API** -::: griffe.ExportedName + diff --git a/docs/reference/api/git.md b/docs/reference/api/git.md index 7abc81fcf..2123ca401 100644 --- a/docs/reference/api/git.md +++ b/docs/reference/api/git.md @@ -4,6 +4,7 @@ DANGER: **Deprecated utilities.** We have decided to stop exposing Git-related utilities as it's not a core part of the library's functionality. The functions documented on this page will become unavailable in the next major version. + diff --git a/mkdocs.yml b/mkdocs.yml index 0ca192944..c1bc30a82 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,7 +4,7 @@ site_url: "https://mkdocstrings.github.io/griffe" repo_url: "https://github.com/mkdocstrings/griffe" repo_name: "mkdocstrings/griffe" site_dir: "site" -watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src] +watch: [mkdocs.yml, README.md, CONTRIBUTING.md, CHANGELOG.md, src, packages/griffelib/src, packages/griffecli/src] copyright: Copyright © 2021 Timothée Mazzucotelli edit_uri: edit/main/docs/ @@ -218,7 +218,8 @@ plugins: - url: https://docs.python.org/3/objects.inv domains: [std, py] - https://typing-extensions.readthedocs.io/en/latest/objects.inv - paths: [src, scripts, .] + paths: [src, packages/griffelib/src, packages/griffecli/src, scripts, .] + load_external_modules: true options: backlinks: tree docstring_options: diff --git a/scripts/gen_structure_docs.py b/scripts/gen_structure_docs.py index 7f84671ae..3d78f37b9 100644 --- a/scripts/gen_structure_docs.py +++ b/scripts/gen_structure_docs.py @@ -68,8 +68,7 @@ def render_internal_api(heading_level: int = 4) -> None: heading_level: The initial level of Markdown headings. """ root = Path(os.environ["MKDOCS_CONFIG_DIR"]) - src = root / "src" - internal_api = src / "griffe" / "_internal" + internal_api = root / "packages" / "griffelib" / "src" / "griffelib" / "_internal" print(_comment_block(internal_api / "__init__.py")) _render_api(internal_api, internal_api, heading_level) @@ -81,9 +80,8 @@ def render_public_api(heading_level: int = 4) -> None: heading_level: The initial level of Markdown headings. """ root = Path(os.environ["MKDOCS_CONFIG_DIR"]) - src = root / "src" - public_api = src / "griffe" - print(f"{'#' * heading_level} `griffe`\n") + public_api = root / "packages" / "griffelib" / "src" / "griffelib" + print(f"{'#' * heading_level} `griffelib`\n") print(_comment_block(public_api / "__init__.py")) @@ -94,7 +92,6 @@ def render_entrypoint(heading_level: int = 4) -> None: heading_level: The initial level of Markdown headings. """ root = Path(os.environ["MKDOCS_CONFIG_DIR"]) - src = root / "src" - public_api = src / "griffe" - print(f"{'#' * heading_level} `griffelib.__main__`\n") - print(_comment_block(public_api / "__main__.py")) + cli_api = root / "packages" / "griffecli" / "src" / "griffecli" + print(f"{'#' * heading_level} `griffecli.__main__`\n") + print(_comment_block(cli_api / "__main__.py")) diff --git a/src/griffe/__init__.py b/src/griffe/__init__.py index 09ddc836a..5a76a6bc7 100644 --- a/src/griffe/__init__.py +++ b/src/griffe/__init__.py @@ -20,9 +20,457 @@ See the `griffelib` and `griffecli` packages for detailed API documentation. """ -from griffecli import * # noqa: F403 -from griffecli import __all__ as __cli_all__ -from griffelib import * # noqa: F403 -from griffelib import __all__ as __lib_all__ +# Re-export all public symbols from griffelib +from griffelib import ( + 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, + ExprJoinedStr, + ExprKeyword, + ExprLambda, + ExprList, + ExprListComp, + ExprName, + ExprNamedExpr, + ExprParameter, + ExprSet, + ExprSetComp, + ExprSlice, + ExprSubscript, + 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, +) -__all__ = [*__lib_all__, *__cli_all__] # noqa: PLE0604 +# Re-export all public symbols from griffecli +from griffecli import ( + DEFAULT_LOG_LEVEL, + check, + dump, + get_parser, + main, +) + +__all__ = [ + # griffelib 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", + "ExprJoinedStr", + "ExprKeyword", + "ExprLambda", + "ExprList", + "ExprListComp", + "ExprName", + "ExprNamedExpr", + "ExprParameter", + "ExprSet", + "ExprSetComp", + "ExprSlice", + "ExprSubscript", + "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", + # griffecli exports + "DEFAULT_LOG_LEVEL", + "check", + "dump", + "get_parser", + "main", +]