refactor: Document public objects with __all__

Author: pawamoy

src/griffe/agents/inspector.py

@@ -492,3 +492,6 @@ def _convert_object_to_annotation(obj: Any, parent: Module | Class) -> str | Nam
     except SyntaxError:
         return obj
     return safe_get_annotation(annotation_node.body, parent=parent)  # type: ignore[attr-defined]
+
+
+__all__ = ["inspect", "Inspector"]

src/griffe/agents/nodes/_all.py

@@ -109,3 +109,6 @@ def safe_get__all__(
             message += f": {error}"
         getattr(logger, log_level.value)(message)
         return []
+
+
+__all__ = ["get__all__", "safe_get__all__"]

src/griffe/agents/nodes/_ast.py

@@ -169,3 +169,16 @@ def ast_last_child(node: AST) -> AST:
     except ValueError as error:
         raise LastNodeError("there are no children node") from error
     return last
+
+
+__all__ = [
+    "ast_children",
+    "ast_first_child",
+    "ast_kind",
+    "ast_last_child",
+    "ast_next",
+    "ast_next_siblings",
+    "ast_previous",
+    "ast_previous_siblings",
+    "ast_siblings",
+]

src/griffe/agents/nodes/_docstrings.py

@@ -39,3 +39,6 @@ def get_docstring(
         lineno = doc.lineno
         return doc.s, lineno, doc.end_lineno
     return None, None, None
+
+
+__all__ = ["get_docstring"]

src/griffe/agents/nodes/_expressions.py

@@ -597,3 +597,15 @@ def safe_get_expression(
     parse_strings=False,
     msg_format=_msg_format % "condition",
 )
+
+
+__all__ = [
+    "get_annotation",
+    "get_base_class",
+    "get_condition",
+    "get_expression",
+    "safe_get_annotation",
+    "safe_get_base_class",
+    "safe_get_condition",
+    "safe_get_expression",
+]

src/griffe/agents/nodes/_imports.py

@@ -35,3 +35,6 @@ def relative_to_absolute(node: ast.ImportFrom, name: ast.alias, current_module:
     base = current_module.path + "." if node.level > 0 else ""
     node_module = node.module + "." if node.module else ""
     return base + node_module + name.name
+
+
+__all__ = ["relative_to_absolute"]

src/griffe/agents/nodes/_names.py

@@ -78,3 +78,6 @@ def get_instance_names(node: AST) -> list[str]:
         A list of names.
     """
     return [name.split(".", 1)[1] for name in get_names(node) if name.startswith("self.")]
+
+
+__all__ = ["get_instance_names", "get_name", "get_names"]

src/griffe/agents/nodes/_parameters.py

@@ -26,3 +26,6 @@ def get_call_keyword_arguments(node: Call, parent: Module | Class) -> dict[str,
         The keyword argument names and values.
     """
     return {kw.arg: safe_get_expression(kw.value, parent) for kw in node.keywords if kw.arg}
+
+
+__all__ = ["get_call_keyword_arguments"]

src/griffe/agents/nodes/_runtime.py

@@ -359,3 +359,6 @@ def alias_target_path(self) -> str | None:
             return child_module_path
         child_name = getattr(self.obj, "__name__", self.name)
         return f"{child_module_path}.{child_name}"
+
+
+__all__ = ["ObjectKind", "ObjectNode"]

src/griffe/agents/nodes/_values.py

@@ -473,3 +473,6 @@ def safe_get_value(node: AST | None, filepath: str | Path | None = None) -> str
         message += f": {error}"
         logger.exception(message)
         return None
+
+
+__all__ = ["get_value", "safe_get_value"]