gyomu-python-analysis 0.2.0__tar.gz

gyomu_python_analysis-0.2.0/.gitignore

@@ -0,0 +1,19 @@
+venv/
+.idea/
+
+/build/
+/dist/
+/src/gyomu.egg-info/
+/.coverage
+/htmlcov/
+__pycache__/
+*.py[cod]
+
+.env
+.env.*
+!.env.example
+
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+*.egg-info/

gyomu_python_analysis-0.2.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.5
+Name: gyomu-python-analysis
+Version: 0.2.0
+Summary: Gyomu Python Analysis
+Requires-Python: >=3.13
+Requires-Dist: docstring-parser>=0.18.0
+Requires-Dist: griffelib>=2.2.0
+Requires-Dist: gyomu-infra
+Requires-Dist: gyomu-schema
+Requires-Dist: returns>=0.29.0
+Description-Content-Type: text/markdown
+
+# gyomu-python-analysis
+
+python analysis components for Gyomu Python.

gyomu_python_analysis-0.2.0/README.md

@@ -0,0 +1,3 @@
+# gyomu-python-analysis
+
+python analysis components for Gyomu Python.

gyomu_python_analysis-0.2.0/experiments/griffe_analysis.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel, Field
+
+
+class User(BaseModel):
+    """User information."""
+
+    id: int = Field(description="Primary identifier")
+
+    @classmethod
+    def create(cls, name: str) -> "User":
+        """Create a user."""
+        return cls(id=1)

gyomu_python_analysis-0.2.0/experiments/griffe_dump.py

@@ -0,0 +1,96 @@
+from pathlib import Path
+from pprint import pprint
+
+from griffe import Alias, visit
+
+
+def dump_docstring(obj: object, indent: str) -> None:
+    docstring = getattr(obj, "docstring", None)
+
+    if docstring is None:
+        print(f"{indent}docstring: <none>")
+        return
+
+    print(f"{indent}docstring type: {type(docstring)}")
+    print(f"{indent}docstring value: {docstring.value!r}")
+
+    for name in dir(docstring):
+        if (
+            "line" in name.lower()
+            or "column" in name.lower()
+            or "offset" in name.lower()
+            or "position" in name.lower()
+            or "loc" in name.lower()
+        ):
+            try:
+                value = getattr(docstring, name)
+            except Exception:
+                continue
+
+            if not callable(value):
+                print(f"{indent}{name}: {value!r}")
+
+
+def dump_alias(
+    alias: Alias,
+    indent: str,
+) -> None:
+    print(f"{indent}Alias: {alias.name}")
+    print(f"{indent}  target_path: {alias.target_path}")
+    pprint(alias)
+    print(f"{indent}  is_alias: {alias.is_alias}")
+
+
+def dump_object(obj: object, indent: str = "") -> None:
+    if isinstance(obj, Alias):
+        dump_alias(obj, indent)
+        return
+
+    print(f"{indent}{type(obj).__name__}: {getattr(obj, 'name', '<unknown>')}")
+
+    for attr in (
+        "lineno",
+        "endlineno",
+        # "docstring",
+        "members",
+        "bases",
+        "parameters",
+        "returns",
+        "decorators",
+        "annotation",
+        "value",
+        "kind",
+    ):
+        try:
+            value = getattr(obj, attr)
+        except AttributeError:
+            continue
+
+        print(f"{indent}  {attr}: {value!r}")
+
+    dump_docstring(obj, indent + "    ")
+
+    members = getattr(obj, "members", None)
+
+    if members:
+        for member in members.values():
+            print()
+            dump_object(member, indent + "    ")
+
+
+def main() -> None:
+    source_path = Path("sample.py").resolve()
+
+    source = source_path.read_text(encoding="utf-8")
+
+    module = visit(
+        module_name="sample",
+        filepath=source_path,
+        code=source,
+    )
+
+    dump_object(module)
+
+
+if __name__ == "__main__":
+    main()

gyomu_python_analysis-0.2.0/experiments/sample/user.py

@@ -0,0 +1,14 @@
+from pydantic import BaseModel, Field
+
+Version = 1.2
+
+
+class User(BaseModel):
+    """User information."""
+
+    id: int = Field(description="Primary identifier")
+
+    @classmethod
+    def create(cls, name: str) -> "User":
+        """Create a user."""
+        return cls(id=1)

gyomu_python_analysis-0.2.0/experiments/sample.py

@@ -0,0 +1,35 @@
+import asyncio
+import pathlib
+
+from pydantic import BaseModel
+from pydantic import Field as fld
+from pydantic.aliases import AliasChoices as choice
+from pydantic.config import JsonDict
+
+from .griffe_analysis import Field as fld2
+
+VERSION = 0.1
+
+
+async def add(a: int, b: int):
+    await asyncio.sleep(1)
+    return a + b
+
+
+def add2(a: int, b: int) -> int:
+    return a + b
+
+
+class User(BaseModel):
+    """User information."""
+
+    id: int = fld(description="Primary identifier")
+
+    @classmethod
+    def create(cls, name: str) -> "User":
+        """Create a user."""
+        path: pathlib.Path = pathlib.Path("c:\\data")
+        dict: JsonDict = {}
+        ch: choice = {}
+        fld3: fld2 = {}
+        return cls(id=1)

gyomu_python_analysis-0.2.0/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "gyomu-python-analysis"
+dynamic = ["version"]
+description = "Gyomu Python Analysis"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "gyomu-schema",
+    "gyomu-infra",
+    "returns>=0.29.0",
+    "griffelib>=2.2.0",
+    "docstring-parser>=0.18.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+
+[tool.uv.sources]
+gyomu-schema = { workspace = true }
+gyomu-infra = { workspace = true }
+
+
+[tool.hatch.version]
+path = "../../version/__about__.py"

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/pyproject.toml

@@ -0,0 +1,13 @@
+[project]
+name = "test-fixture"
+dynamic = ["version"]
+description = "Gyomu Test Fixture"
+requires-python = ">=3.13"
+dependencies = [
+    "pydantic"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/01-simple.py

@@ -0,0 +1,12 @@
+def basic(value: str) -> str:
+    """Return the given value.
+
+    This function is simple function
+
+    Args:
+        value: The value to return.
+
+    Returns:
+        The given value.
+    """
+    return "A"

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/02-args.py

@@ -0,0 +1,12 @@
+def multiple_args(
+    name: str,
+    age: int,
+    active: bool = True,
+) -> None:
+    """Create a user.
+
+    Args:
+        name (str): The user's name.
+        age (int): The user's age.
+        active (bool): Whether the user is active.
+    """

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/03-typed-return.py

@@ -0,0 +1,10 @@
+def find_user(user_id: int) -> dict[str, object]:
+    """Find a user by ID.
+
+    Args:
+        user_id (int): The user ID.
+
+    Returns:
+        dict[str, object]: The user information.
+    """
+    return dict()

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/04-raises.py

@@ -0,0 +1,14 @@
+def load_user(user_id: int) -> dict[str, object]:
+    """Load a user.
+
+    Args:
+        user_id: The user ID.
+
+    Raises:
+        ValueError: If the user ID is invalid.
+        LookupError: If the user cannot be found.
+
+    Returns:
+        The user information.
+    """
+    return dict()

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/05-examples.py

@@ -0,0 +1,18 @@
+def add(left: int, right: int) -> int:
+    """Add two numbers.
+
+    Args:
+        left: The left operand.
+        right: The right operand.
+
+    Returns:
+        The sum of the two operands.
+
+    Examples:
+        >>> add(1, 2)
+        3
+
+        >>> add(-1, 5)
+        4
+    """
+    return 1

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/06-notes.py

@@ -0,0 +1,16 @@
+def process(value: str) -> str:
+    """Process a value.
+
+    Args:
+        value: The value to process.
+
+    Notes:
+        The value is normalized before processing.
+        Leading and trailing whitespace is removed.
+
+        This operation does not modify the original value.
+
+    Returns:
+        The processed value.
+    """
+    return "A"

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/07-complex.py

@@ -0,0 +1,31 @@
+def process_user(
+    user_id: int,
+    name: str,
+    *,
+    active: bool = True,
+) -> dict[str, object]:
+    """Process a user.
+
+    This function loads a user and updates its information.
+
+    Args:
+        user_id (int): The user ID.
+        name (str): The user's name.
+        active (bool): Whether the user is active.
+
+    Raises:
+        ValueError: If the user ID is invalid.
+        LookupError: If the user does not exist.
+
+    Returns:
+        dict[str, object]: The updated user information.
+
+    Examples:
+        >>> process_user(1, "Alice")
+        {'id': 1, 'name': 'Alice', 'active': True}
+
+    Notes:
+        The user is loaded from the repository before being updated.
+        The operation is transactional.
+    """
+    return dict()

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/08-gyomu-context.py

@@ -0,0 +1,14 @@
+def process_user(user_id: int) -> dict[str, object]:
+    """Process a user.
+
+    Args:
+        user_id: The user ID.
+
+    Returns:
+        The processed user.
+
+    Gyomu Context:
+        This function is used by the user synchronization workflow.
+        It should only be called from the application service layer.
+    """
+    return dict()

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/09-custom-section.py

@@ -0,0 +1,13 @@
+def custom_section() -> None:
+    """Do something.
+
+    Foo:
+        This is a custom section.
+        dummy
+
+    Returns:
+        The processed user.
+
+    Bar:
+        Another custom section.
+    """

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/10-edge-cases.py

@@ -0,0 +1,17 @@
+def no_sections() -> None:
+    """Do something.
+
+    This function does something without any arguments or return value.
+    """
+
+
+def empty_docstring() -> None:
+    """"""
+
+
+def section_only() -> None:
+    """Do something.
+
+    Notes:
+        This is a note.
+    """

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/11-custom-and-gyomu-context.py

@@ -0,0 +1,12 @@
+def custom_and_gyomu_context() -> None:
+    """Process something.
+
+    Foo:
+        This is a custom section.
+
+        It contains additional information.
+
+    Gyomu Context:
+        This function is used by the application workflow.
+        It should only be called from the service layer.
+    """

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/12-module.py

@@ -0,0 +1,18 @@
+"""User management module.
+
+This module provides operations for creating and updating users.
+
+Notes:
+    User data is managed by the application service layer.
+
+Gyomu Context:
+    This module belongs to the user synchronization workflow.
+    It should only be used by the application service layer.
+"""
+
+from dataclasses import dataclass
+
+
+@dataclass
+class User:
+    name: str

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/13-class.py

@@ -0,0 +1,58 @@
+class User:
+    """User model.
+
+    This class represents a user in the application.
+
+    Notes:
+        User instances are managed by the application service layer.
+
+    Gyomu Context:
+        This class is used by the user synchronization workflow.
+        It should only be created by the application service layer.
+    """
+
+    name: str
+    """The user's name."""
+
+    active: bool
+    """Whether the user is active."""
+
+    def __init__(
+        self,
+        name: str,
+        active: bool = True,
+    ) -> None:
+        """Initialize a user.
+
+        Args:
+            name (str): The user's name.
+            active (bool): Whether the user is active.
+
+        Notes:
+            The user is active by default.
+        """
+        self.name = name
+        self.active = active
+
+    def activate(self) -> None:
+        """Activate the user.
+
+        This method marks the user as active.
+
+        Returns:
+            None.
+
+        Gyomu Context:
+            This method is used during the user synchronization workflow.
+        """
+        self.active = True
+
+    def deactivate(self) -> None:
+        """Deactivate the user.
+
+        This method marks the user as inactive.
+
+        Notes:
+            Deactivated users are not synchronized.
+        """
+        self.active = False

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/docstring/14-variable.py

@@ -0,0 +1,49 @@
+"""Variable analysis fixture.
+
+This module contains various kinds of variables for analysis.
+
+Notes:
+    Variables are used to represent application configuration and state.
+
+Gyomu Context:
+    This module is used by the configuration loading workflow.
+"""
+
+# Simple variable
+name = "Alice"
+
+
+# Annotated variable
+age: int = 30
+
+
+# Variable without an initial value
+active: bool
+
+
+# Constant-like variable
+MAX_RETRY: int = 3
+
+
+# Variable with a generic type
+users: list[str] = []
+
+
+# Variable with a docstring
+description = "A user description."
+"""Description of the user.
+
+This variable contains the human-readable description.
+
+Notes:
+    The description is displayed to users.
+"""
+
+
+# Variable with an annotation and a docstring
+status: str = "active"
+"""Current user status.
+
+Gyomu Context:
+    This value is updated during user synchronization.
+"""

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/import/all.py

@@ -0,0 +1,5 @@
+VAR1 = 1
+VAR2 = 2
+
+
+__all__ = ("VAR1",)

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/import/all2.py

@@ -0,0 +1,2 @@
+VAR11 = 1
+VAR21 = 2

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/import/imports.py

@@ -0,0 +1,10 @@
+import pathlib  # noqa: F401, I001
+import pathlib as path  # noqa: F401
+from pydantic import BaseModel  # noqa: F401
+from pydantic import Field as fld  # noqa: F401
+from pydantic import Field as fld2  # noqa: F401
+
+from .relative import Field as rel1  # noqa: F401
+from ..shared import Value  # noqa: F401
+from .all import *  # noqa: F403
+from .all2 import *  # noqa: F403

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/import/relative.py

@@ -0,0 +1 @@
+Field = "test"

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/shared.py

@@ -0,0 +1 @@
+Value = 1.0

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/symbol/__init__.py

@@ -0,0 +1,7 @@
+VERSION = 5
+
+_internal_value = 10
+
+
+def public_function() -> None:
+    pass

gyomu_python_analysis-0.2.0/python_analysis_test_support/fixtures/src/analysis/symbol/call.py

@@ -0,0 +1,30 @@
+def call_simple():
+    return foo()
+
+
+def call_with_positional_argument():
+    return foo(1)
+
+
+def call_with_multiple_positional_arguments():
+    return foo(1, "value", bar)
+
+
+def call_with_keyword_argument():
+    return foo(name="value")
+
+
+def call_with_multiple_keyword_arguments():
+    return foo(name="value", mode="before")
+
+
+def call_with_mixed_arguments():
+    return foo("name", mode="before")
+
+
+def call_with_nested_call():
+    return foo(bar(value))
+
+
+def call_with_keyword_call_value():
+    return foo(value=bar())