reflex-docgen 0.9.0a1__tar.gz

reflex_docgen-0.9.0a1/.gitignore

@@ -0,0 +1,24 @@
+**/.DS_Store
+**/*.pyc
+assets/external/*
+dist/*
+examples/
+.web
+.states
+.idea
+.vscode
+.coverage
+.coverage.*
+.venv
+venv
+requirements.txt
+.pyi_generator_last_run
+.pyi_generator_diff
+reflex.db
+.codspeed
+.env
+.env.*
+node_modules
+package-lock.json
+*.pyi
+.pre-commit-config.yaml

reflex_docgen-0.9.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/LICENSE-2.0
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023, Pynecone, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

reflex_docgen-0.9.0a1/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: reflex-docgen
+Version: 0.9.0a1
+Summary: Generate documentation for Reflex components.
+Author-email: Khaleel Al-Adhami <khaleel@reflex.dev>
+Maintainer-email: Khaleel Al-Adhami <khaleel@reflex.dev>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: griffelib>=2.0.1
+Requires-Dist: mistletoe>=1.4.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: reflex
+Requires-Dist: typing-extensions
+Requires-Dist: typing-inspection>=0.4.2
+Description-Content-Type: text/markdown
+
+# reflex-docgen
+
+Generate documentation for Reflex components.

reflex_docgen-0.9.0a1/README.md

@@ -0,0 +1,3 @@
+# reflex-docgen
+
+Generate documentation for Reflex components.

reflex_docgen-0.9.0a1/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "reflex-docgen"
+dynamic = ["version"]
+description = "Generate documentation for Reflex components."
+readme = "README.md"
+authors = [{ name = "Khaleel Al-Adhami", email = "khaleel@reflex.dev" }]
+maintainers = [{ name = "Khaleel Al-Adhami", email = "khaleel@reflex.dev" }]
+requires-python = ">=3.10"
+dependencies = [
+    "griffelib>=2.0.1",
+    "mistletoe>=1.4.0",
+    "pyyaml>=6.0",
+    "reflex",
+    "typing-extensions",
+    "typing-inspection>=0.4.2",
+]
+
+[tool.uv.sources]
+reflex = { workspace = true }
+
+[tool.hatch.version]
+source = "uv-dynamic-versioning"
+
+[tool.uv-dynamic-versioning]
+pattern-prefix = "reflex-docgen-"
+fallback-version = "0.0.0dev0"
+
+[build-system]
+requires = ["hatchling", "uv-dynamic-versioning"]
+build-backend = "hatchling.build"

reflex_docgen-0.9.0a1/src/reflex_docgen/__init__.py

@@ -0,0 +1,33 @@
+"""Module for generating documentation for Reflex components and classes."""
+
+from reflex_docgen import markdown as markdown
+from reflex_docgen._class import ClassDocumentation as ClassDocumentation
+from reflex_docgen._class import FieldDocumentation as FieldDocumentation
+from reflex_docgen._class import MethodDocumentation as MethodDocumentation
+from reflex_docgen._class import (
+    generate_class_documentation as generate_class_documentation,
+)
+from reflex_docgen._component import ComponentDocumentation as ComponentDocumentation
+from reflex_docgen._component import (
+    EventHandlerDocumentation as EventHandlerDocumentation,
+)
+from reflex_docgen._component import PropDocumentation as PropDocumentation
+from reflex_docgen._component import generate_documentation as generate_documentation
+from reflex_docgen._component import (
+    get_component_event_handlers as get_component_event_handlers,
+)
+from reflex_docgen._component import get_component_props as get_component_props
+
+__all__ = [
+    "ClassDocumentation",
+    "ComponentDocumentation",
+    "EventHandlerDocumentation",
+    "FieldDocumentation",
+    "MethodDocumentation",
+    "PropDocumentation",
+    "generate_class_documentation",
+    "generate_documentation",
+    "get_component_event_handlers",
+    "get_component_props",
+    "markdown",
+]

reflex_docgen-0.9.0a1/src/reflex_docgen/_class.py

@@ -0,0 +1,345 @@
+"""Generate documentation for arbitrary Python classes."""
+
+import dataclasses
+import inspect
+from dataclasses import dataclass
+from typing import Any, get_args, get_type_hints
+
+from reflex_base.vars.base import BaseStateMeta
+from typing_inspection.introspection import AnnotationSource, inspect_annotation
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class FieldDocumentation:
+    """Hold information about a class field.
+
+    Attributes:
+        name: The name of the field.
+        type: The resolved type of the field.
+        type_display: Human-readable type string (no Var wrapper). Uses __name__ for simple types, str() for generics.
+        description: The description extracted from the class docstring or field.doc.
+        default: The repr() of the default value, or None if no default.
+    """
+
+    name: str
+
+    type: Any
+
+    type_display: str
+
+    description: str | None
+
+    default: str | None
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class MethodDocumentation:
+    """Hold information about a class method.
+
+    Attributes:
+        name: The name of the method.
+        signature: The string representation of the method signature.
+        description: The docstring, truncated before 'Args:' or 'Returns:' sections.
+    """
+
+    name: str
+
+    signature: str
+
+    description: str | None
+
+
+@dataclass(frozen=True, slots=True, kw_only=True)
+class ClassDocumentation:
+    """Documentation for an arbitrary Python class.
+
+    Attributes:
+        name: The fully qualified name (module.qualname) of the class.
+        description: The cleaned docstring of the class.
+        fields: Instance fields (from dataclass fields or rx.State __fields__).
+        class_fields: Class variables (from __class_vars__ on rx.Base subclasses).
+        methods: Public methods that have docstrings.
+    """
+
+    name: str
+
+    description: str | None
+
+    fields: tuple[FieldDocumentation, ...] = ()
+
+    class_fields: tuple[FieldDocumentation, ...] = ()
+
+    methods: tuple[MethodDocumentation, ...] = ()
+
+
+def _parse_docstring_attributes(cls: type) -> dict[str, str]:
+    """Parse an Attributes section from a class docstring using griffe.
+
+    Args:
+        cls: The class whose docstring to parse.
+
+    Returns:
+        A mapping from attribute name to description string.
+    """
+    from griffe import Docstring, Parser  # provided by griffelib
+
+    doc = cls.__doc__
+    if not doc:
+        return {}
+
+    parsed = Docstring(inspect.cleandoc(doc)).parse(Parser.auto)
+    return {
+        attr.name: attr.description
+        for section in parsed
+        if section.kind.value == "attributes"
+        for attr in section.value
+    }
+
+
+def _type_display(type_: Any) -> str:
+    """Return a human-readable type string.
+
+    Args:
+        type_: The type to display.
+
+    Returns:
+        A human-readable type string.
+    """
+    if get_args(type_):
+        return str(type_)
+    return getattr(type_, "__name__", str(type_))
+
+
+def _extract_field_doc(hint: Any, field_doc: str | None) -> tuple[Any, str | None]:
+    """Extract the unwrapped type and description from a type hint.
+
+    Args:
+        hint: The type hint.
+        field_doc: The field.doc attribute value.
+
+    Returns:
+        A tuple of (unwrapped_type, description).
+    """
+    inspected = inspect_annotation(hint, annotation_source=AnnotationSource.ANY)
+    return inspected.type, field_doc
+
+
+def _build_field_documentation(
+    name: str,
+    hint: Any,
+    field_doc: str | None,
+    default_value: str | None,
+    docstring_desc: str | None = None,
+) -> FieldDocumentation | None:
+    """Build a FieldDocumentation from field info, or None if private.
+
+    Args:
+        name: The field name.
+        hint: The type hint.
+        field_doc: The field.doc attribute value.
+        default_value: The repr'd default value, or None.
+        docstring_desc: Description from the class docstring Attributes section (fallback).
+
+    Returns:
+        A FieldDocumentation, or None if the field should be skipped.
+    """
+    if name.startswith("_"):
+        return None
+
+    unwrapped_type, description = _extract_field_doc(hint, field_doc)
+
+    # Fall back to docstring Attributes section if no description found.
+    if description is None and docstring_desc is not None:
+        description = docstring_desc
+
+    if description is not None and "PRIVATE" in description:
+        return None
+
+    return FieldDocumentation(
+        name=name,
+        type=unwrapped_type,
+        type_display=_type_display(unwrapped_type),
+        description=description,
+        default=default_value,
+    )
+
+
+def _get_dataclass_fields(cls: type) -> tuple[FieldDocumentation, ...]:
+    """Extract fields from a dataclass.
+
+    Args:
+        cls: The dataclass to extract fields from.
+
+    Returns:
+        A tuple of FieldDocumentation objects.
+    """
+    hints = get_type_hints(cls, include_extras=True)
+    docstring_attrs = _parse_docstring_attributes(cls)
+    result = []
+    for f in dataclasses.fields(cls):
+        hint = hints.get(f.name, f.type)
+        field_doc = getattr(f, "doc", None)
+
+        if f.default is not dataclasses.MISSING:
+            default_str = repr(f.default)
+        elif f.default_factory is not dataclasses.MISSING:
+            default_str = repr(f.default_factory)
+        else:
+            default_str = None
+
+        doc = _build_field_documentation(
+            f.name, hint, field_doc, default_str, docstring_attrs.get(f.name)
+        )
+        if doc is not None:
+            result.append(doc)
+
+    return tuple(result)
+
+
+def _get_state_fields(cls: BaseStateMeta) -> tuple[FieldDocumentation, ...]:
+    """Extract instance fields from an rx.State subclass via __fields__.
+
+    Args:
+        cls: The class to extract fields from.
+
+    Returns:
+        A tuple of FieldDocumentation objects.
+    """
+    hints = get_type_hints(cls, include_extras=True)
+    docstring_attrs = _parse_docstring_attributes(cls)
+    fields_dict = cls.__fields__
+    result = []
+    for name, field in fields_dict.items():
+        hint = hints.get(name, field.outer_type_)
+
+        if field.default is not dataclasses.MISSING:
+            default_str = repr(field.default)
+        elif field.default_factory is not None:
+            default_str = repr(field.default_factory)
+        else:
+            default_str = None
+
+        doc = _build_field_documentation(
+            name, hint, None, default_str, docstring_attrs.get(name)
+        )
+        if doc is not None:
+            result.append(doc)
+
+    return tuple(result)
+
+
+def _get_class_vars(cls: type) -> tuple[FieldDocumentation, ...]:
+    """Extract class variables from __class_vars__.
+
+    Args:
+        cls: The class to extract class variables from.
+
+    Returns:
+        A tuple of FieldDocumentation objects.
+    """
+    class_vars = getattr(cls, "__class_vars__", None)
+    if not class_vars:
+        return ()
+
+    hints = get_type_hints(cls, include_extras=True)
+    docstring_attrs = _parse_docstring_attributes(cls)
+    result = []
+    for name in class_vars:
+        hint = hints.get(name, type(None))
+        doc = _build_field_documentation(
+            name, hint, None, None, docstring_attrs.get(name)
+        )
+        if doc is not None:
+            result.append(doc)
+
+    return tuple(result)
+
+
+def _get_methods(cls: type) -> tuple[MethodDocumentation, ...]:
+    """Extract public documented methods from a class.
+
+    Args:
+        cls: The class to extract methods from.
+
+    Returns:
+        A tuple of MethodDocumentation objects.
+    """
+    result = []
+    for name, obj in cls.__dict__.items():
+        if name.startswith("_") or name == "Config":
+            continue
+
+        fn = obj
+        if isinstance(obj, (classmethod, staticmethod)):
+            fn = obj.__func__
+
+        if not callable(fn):
+            continue
+
+        docstring = getattr(fn, "__doc__", None)
+        if not docstring:
+            continue
+
+        # Truncate docstring before Args: or Returns:
+        for marker in ("Args:", "Returns:"):
+            idx = docstring.find(marker)
+            if idx != -1:
+                docstring = docstring[:idx]
+                break
+        docstring = docstring.strip() or None
+
+        try:
+            sig = str(inspect.signature(fn))
+        except (ValueError, TypeError):
+            sig = "(...)"
+
+        result.append(
+            MethodDocumentation(
+                name=name,
+                signature=sig,
+                description=docstring,
+            )
+        )
+
+    return tuple(result)
+
+
+def generate_class_documentation(cls: type) -> ClassDocumentation:
+    """Generate documentation for an arbitrary Python class.
+
+    Supports dataclasses, rx.State subclasses, and other classes (methods only).
+
+    Args:
+        cls: The class to generate documentation for.
+
+    Returns:
+        The generated documentation for the class.
+    """
+    try:
+        description = inspect.cleandoc(cls.__doc__) if cls.__doc__ else None
+
+        if dataclasses.is_dataclass(cls):
+            fields = _get_dataclass_fields(cls)
+        elif isinstance(cls, BaseStateMeta):
+            fields = _get_state_fields(cls)
+        else:
+            fields = ()
+
+        class_fields = _get_class_vars(cls)
+        methods = _get_methods(cls)
+
+        return ClassDocumentation(
+            name=f"{cls.__module__}.{cls.__qualname__}",
+            description=description,
+            fields=fields,
+            class_fields=class_fields,
+            methods=methods,
+        )
+    except Exception as e:
+        import sys
+
+        if sys.version_info >= (3, 11):
+            e.add_note(
+                f"Error generating documentation for class {cls.__module__}.{cls.__qualname__}"
+            )
+        raise