feat: Add data to dict/json output

We now add the following attributes to the base output (non-full) of `as_dict()` and therefore `as_json()` methods (serialization):

- `public`
- `imports`
- `exports`
- `runtime`
- `deprecated`

In full mode, we also add the following attributes:

- `is_public`
- `is_deprecated`
- `is_private`
- `is_class_private`
- `is_special`
- `is_imported`
- `is_exported`
- `is_wildcard_exposed`
- `is_inherited`

Author: pawamoy

docs/schema.json

@@ -87,6 +87,44 @@
           "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.relative_package_filepath",
           "type": "string"
         },
+        "public": {
+          "title": "Whether the object was explicitly marked as public.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.public",
+          "type": [
+            "null",
+            "boolean"
+          ]
+        },
+        "exports": {
+          "title": "The exports of the object.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.exports",
+          "type": [
+            "null",
+            "array"
+          ],
+          "items": {
+            "type": "string"
+          }
+        },
+        "imports": {
+          "title": "The imports of the object.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.imports",
+          "type": "object"
+        },
+        "runtime": {
+          "title": "Whether this object exists at runtime.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.runtime",
+          "type": "boolean"
+        },
+        "deprecated": {
+          "title": "Whether the object was explicitly marked as deprecated.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.deprecated",
+          "type": [
+            "null",
+            "string",
+            "boolean"
+          ]
+        },
         "labels": {
           "title": "The labels of the object.",
           "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.labels",
@@ -179,6 +217,51 @@
             "null"
           ]
         },
+        "is_public": {
+          "title": "Whether the object is public.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_public",
+          "type": "boolean"
+        },
+        "is_deprecated": {
+          "title": "Whether the object is deprecated.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_deprecated",
+          "type": "boolean"
+        },
+        "is_private": {
+          "title": "Whether the object is private.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_private",
+          "type": "boolean"
+        },
+        "is_class_private": {
+          "title": "Whether the object is class-private.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_class_private",
+          "type": "boolean"
+        },
+        "is_special": {
+          "title": "Whether the object is special.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_special",
+          "type": "boolean"
+        },
+        "is_imported": {
+          "title": "Whether the object is imported.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_imported",
+          "type": "boolean"
+        },
+        "is_exported": {
+          "title": "Whether the object is exported.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_exported",
+          "type": "boolean"
+        },
+        "is_wildcard_exposed": {
+          "title": "Whether the object is wildcard-exposed.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_wildcard_exposed",
+          "type": "boolean"
+        },
+        "is_inherited": {
+          "title": "Whether the object is inherited.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/api/models/#griffe.Object.is_inherited",
+          "type": "boolean"
+        },
         "bases": true,
         "decorators": true,
         "parameters": true,
@@ -195,6 +278,9 @@
         "filepath",
         "relative_filepath",
         "relative_package_filepath",
+        "public",
+        "runtime",
+        "deprecated",
         "labels",
         "members"
       ],

src/_griffe/encoders.py

@@ -182,7 +182,12 @@ def _attach_parent_to_exprs(obj: Class | Function | Attribute | TypeAlias, paren
 
 
 def _load_module(obj_dict: dict[str, Any]) -> Module:
-    module = Module(name=obj_dict["name"], filepath=Path(obj_dict["filepath"]), docstring=_load_docstring(obj_dict))
+    module = Module(
+        name=obj_dict["name"],
+        filepath=Path(obj_dict["filepath"]),
+        docstring=_load_docstring(obj_dict),
+        runtime=obj_dict.get("runtime", True),
+    )
     # YORE: Bump 2: Replace line with `members = obj_dict.get("members", {}).values()`.
     members = obj_dict.get("members", [])
     # YORE: Bump 2: Remove block.
@@ -193,6 +198,10 @@ def _load_module(obj_dict: dict[str, Any]) -> Module:
         module.set_member(module_member.name, module_member)
         _attach_parent_to_exprs(module_member, module)
     module.labels |= set(obj_dict.get("labels", ()))
+    module.exports = obj_dict.get("exports")
+    module.imports = obj_dict.get("imports", {})
+    module.deprecated = obj_dict.get("deprecated")
+    module.public = obj_dict.get("public")
     return module
 
 
@@ -205,6 +214,7 @@ def _load_class(obj_dict: dict[str, Any]) -> Class:
         decorators=_load_decorators(obj_dict),
         type_parameters=TypeParameters(*obj_dict["type_parameters"]),
         bases=obj_dict["bases"],
+        runtime=obj_dict.get("runtime", True),
     )
     # YORE: Bump 2: Replace line with `members = obj_dict.get("members", {}).values()`.
     members = obj_dict.get("members", [])
@@ -216,6 +226,9 @@ def _load_class(obj_dict: dict[str, Any]) -> Class:
         class_.set_member(class_member.name, class_member)
         _attach_parent_to_exprs(class_member, class_)
     class_.labels |= set(obj_dict.get("labels", ()))
+    class_.imports = obj_dict.get("imports", {})
+    class_.deprecated = obj_dict.get("deprecated")
+    class_.public = obj_dict.get("public")
     _attach_parent_to_exprs(class_, class_)
     return class_
 
@@ -230,8 +243,11 @@ def _load_function(obj_dict: dict[str, Any]) -> Function:
         lineno=obj_dict["lineno"],
         endlineno=obj_dict.get("endlineno"),
         docstring=_load_docstring(obj_dict),
+        runtime=obj_dict.get("runtime", True),
     )
     function.labels |= set(obj_dict.get("labels", ()))
+    function.deprecated = obj_dict.get("deprecated")
+    function.public = obj_dict.get("public")
     return function
 
 
@@ -245,6 +261,9 @@ def _load_attribute(obj_dict: dict[str, Any]) -> Attribute:
         annotation=obj_dict.get("annotation"),
     )
     attribute.labels |= set(obj_dict.get("labels", ()))
+    attribute.runtime = obj_dict.get("runtime", True)
+    attribute.deprecated = obj_dict.get("deprecated")
+    attribute.public = obj_dict.get("public")
     return attribute
 
 

src/_griffe/mixins.py

@@ -359,17 +359,23 @@ def is_special(self) -> bool:
     @property
     def is_class_private(self) -> bool:
         """Whether this object/alias is class-private (starts with `__` and is a class member)."""
-        return self.parent and self.parent.is_class and self.name.startswith("__") and not self.name.endswith("__")  # type: ignore[attr-defined]
+        return (
+            bool(self.parent) and self.parent.is_class and self.name.startswith("__") and not self.name.endswith("__")  # type: ignore[attr-defined]
+        )
 
     @property
     def is_imported(self) -> bool:
         """Whether this object/alias was imported from another module."""
-        return self.parent and self.name in self.parent.imports  # type: ignore[attr-defined]
+        return bool(self.parent) and self.name in self.parent.imports  # type: ignore[attr-defined]
 
     @property
     def is_exported(self) -> bool:
         """Whether this object/alias is exported (listed in `__all__`)."""
-        return self.parent.is_module and bool(self.parent.exports and self.name in self.parent.exports)  # type: ignore[attr-defined]
+        return (
+            bool(self.parent)  # type: ignore[attr-defined]
+            and self.parent.is_module  # type: ignore[attr-defined]
+            and bool(self.parent.exports and self.name in self.parent.exports)  # type: ignore[attr-defined]
+        )
 
     @property
     def is_wildcard_exposed(self) -> bool:
@@ -388,7 +394,7 @@ def is_wildcard_exposed(self) -> bool:
             True or False.
         """
         # If the object is not available at runtime or is not defined at the module level, it is not exposed.
-        if not self.runtime or not self.parent.is_module:  # type: ignore[attr-defined]
+        if not self.runtime or not (bool(self.parent) and self.parent.is_module):  # type: ignore[attr-defined]
             return False
 
         # If the parent module defines `__all__`, the object is exposed if it is listed in it.

src/_griffe/models.py

@@ -1190,6 +1190,12 @@ def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:
         base: dict[str, Any] = {
             "kind": self.kind,
             "name": self.name,
+            "public": self.public,
+            "exports": self.exports and [str(export) for export in self.exports],
+            "imports": self.imports,
+            "runtime": self.runtime,
+            "deprecated": self.deprecated,
+            # TODO: Include `self.extra`?
         }
 
         if full:
@@ -1199,6 +1205,30 @@ def as_dict(self, *, full: bool = False, **kwargs: Any) -> dict[str, Any]:
                     "filepath": self.filepath,
                     "relative_filepath": self.relative_filepath,
                     "relative_package_filepath": self.relative_package_filepath,
+                    "is_public": self.is_public,
+                    "is_deprecated": self.is_deprecated,
+                    "is_private": self.is_private,
+                    "is_class_private": self.is_class_private,
+                    "is_special": self.is_special,
+                    "is_imported": self.is_imported,
+                    "is_exported": self.is_exported,
+                    "is_wildcard_exposed": self.is_wildcard_exposed,
+                    "is_inherited": self.inherited,
+                    # TODO: Add these properties?
+                    # "is_alias": self.is_alias,
+                    # "is_collection": self.is_collection,
+                    # "is_module": self.is_module,
+                    # "is_class": self.is_class,
+                    # "is_function": self.is_function,
+                    # "is_attribute": self.is_attribute,
+                    # "is_type_alias": self.is_type_alias,
+                    # "is_init_module": self.is_init_module,
+                    # "is_package": self.is_package,
+                    # "is_subpackage": self.is_subpackage,
+                    # "is_namespace_package": self.is_namespace_package,
+                    # "is_namespace_subpackage": self.is_namespace_subpackage,
+                    # "has_docstring": self.has_docstring,
+                    # "has_docstrings": self.has_docstrings,
                 },
             )