gyomu-python-analysis 0.2.0__py3-none-any.whl

gyomu_python_analysis/analysis/load_file_context.py

@@ -0,0 +1,27 @@
+from gyomu_schema.schemas.python.file_analysis import (
+    FileAnalysisContext,
+)
+from gyomu_schema.schemas.python.types import ProjectRelativePath
+from returns.result import Failure, Result, Success
+
+from gyomu_python_analysis.analysis.get_module import get_module_analysis
+from gyomu_python_analysis.analysis.metadata import create_file_analysis_metadata
+from gyomu_python_analysis.error.analysis import AnalysisError
+from gyomu_python_analysis.project.context import ProjectContext
+
+
+def load_file_analysis_context(
+    context: ProjectContext, file_path: ProjectRelativePath
+) -> Result[FileAnalysisContext, AnalysisError]:
+    module_analysis_result = get_module_analysis(context, file_path)
+    if isinstance(module_analysis_result, Failure):
+        return module_analysis_result
+    module_analysis = module_analysis_result.unwrap()
+    metadata = create_file_analysis_metadata(module_analysis)
+
+    return Success(
+        FileAnalysisContext(
+            metadata=metadata,
+            analysis=module_analysis,
+        )
+    )

gyomu_python_analysis/analysis/load_module.py

@@ -0,0 +1,65 @@
+from gyomu_schema.schemas.python.module import ModuleAnalysis
+from gyomu_schema.schemas.python.types import PythonPath
+from gyomu_schema.utility.returns import from_sync
+from returns.result import Failure, Result
+
+from gyomu_python_analysis.analysis.analyzers.context import initialize_symbol_context
+from gyomu_python_analysis.analysis.analyzers.docstring import analyze_docstring
+from gyomu_python_analysis.analysis.analyzers.internal.common import (
+    build_docstring_common,
+)
+from gyomu_python_analysis.analysis.extract.symbols import extract_symbols
+from gyomu_python_analysis.analysis.load import load_module
+from gyomu_python_analysis.error.analysis import AnalysisError
+from gyomu_python_analysis.project.context import ProjectContext
+
+
+def load_module_analysis(
+    context: ProjectContext, module_path: PythonPath
+) -> Result[ModuleAnalysis, AnalysisError]:
+    source_file_result = load_module(context, module_path)
+
+    if isinstance(source_file_result, Failure):
+        return source_file_result
+
+    source_file = source_file_result.unwrap()
+
+    def analyze_module() -> ModuleAnalysis:
+        source_full_path = context.project_root / context.source_root / source_file.path
+        source_lines = source_full_path.read_text(encoding="utf-8").splitlines(
+            keepends=True
+        )
+
+        symbols = extract_symbols(source_file=source_file, source_lines=source_lines)
+        module_name = PythonPath(source_file.module.path)
+        module_context = initialize_symbol_context(
+            module_name=module_name, name="", source_lines=source_lines
+        )
+        return ModuleAnalysis(
+            path=source_file.path,
+            module_name=module_name,
+            imports=symbols.imported,
+            symbols=symbols.symbols,
+            name=source_file.module.name,
+            docstring=(
+                analyze_docstring(
+                    source_file.module.docstring,
+                    doc_common=build_docstring_common(
+                        source_file.module.docstring, module_context
+                    ),
+                    context=module_context,
+                )
+                if source_file.module.docstring is not None
+                else None
+            ),
+        )
+
+    return from_sync(
+        analyze_module,
+        build_error=lambda e: AnalysisError(
+            message="fail to analyze module",
+            file_path=module_path,
+            phase="symbol-extract",
+            context="gyomu_python_analysis.analysis.load_sourde_file",
+        ).chain(e),
+    )

gyomu_python_analysis/analysis/metadata.py

@@ -0,0 +1,49 @@
+from gyomu_schema.schemas.python.class_analysis import ClassAnalysis, InnerClassAnalysis
+from gyomu_schema.schemas.python.docstring import DocstringAnalysis
+from gyomu_schema.schemas.python.file_analysis import FileAnalysisMetadata
+from gyomu_schema.schemas.python.module import ModuleAnalysis
+from gyomu_schema.schemas.python.symbol import MemberAnalysis, SymbolAnalysis
+from gyomu_schema.schemas.python.types import DeclarationIdentity
+
+
+def create_file_analysis_metadata(
+    module_analysis: ModuleAnalysis,
+) -> FileAnalysisMetadata:
+    parsed_docstring: dict[DeclarationIdentity, DocstringAnalysis] = {}
+    symbols: dict[DeclarationIdentity, SymbolAnalysis | MemberAnalysis] = {}
+
+    for symbol in module_analysis.symbols:
+        symbols[symbol.identity] = symbol
+        if symbol.docstring is not None:
+            parsed_docstring[symbol.identity] = symbol.docstring
+
+        if isinstance(symbol, ClassAnalysis):
+            register_class_metadata(symbol, symbols, parsed_docstring)
+    return FileAnalysisMetadata(parsed_docstring, symbols)
+
+
+def register_class_metadata(
+    cls: ClassAnalysis | InnerClassAnalysis,
+    symbols: dict[DeclarationIdentity, SymbolAnalysis | MemberAnalysis],
+    parsed_docstring: dict[DeclarationIdentity, DocstringAnalysis],
+) -> None:
+    for inner in cls.inner_classes:
+        symbols[inner.identity] = inner
+        if inner.docstring is not None:
+            parsed_docstring[inner.identity] = inner.docstring
+        register_class_metadata(inner, symbols, parsed_docstring)
+
+    for method in cls.methods:
+        symbols[method.identity] = method
+        if method.docstring is not None:
+            parsed_docstring[method.identity] = method.docstring
+
+    for variable in cls.variables:
+        symbols[variable.identity] = variable
+        if variable.docstring is not None:
+            parsed_docstring[variable.identity] = variable.docstring
+
+    for alias in cls.type_aliases:
+        symbols[alias.identity] = alias
+        if alias.docstring is not None:
+            parsed_docstring[alias.identity] = alias.docstring

gyomu_python_analysis/analysis/parser/docstring.py

@@ -0,0 +1,7 @@
+from typing import Protocol
+
+from gyomu_schema.schemas.python.docstring import DocstringAnalysis
+
+
+class DocstringParser(Protocol):
+    def parse(self, value: str) -> DocstringAnalysis: ...

gyomu_python_analysis/error/analysis.py

@@ -0,0 +1,36 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from gyomu_schema.error.base import BaseError
+from gyomu_schema.schemas.python.types import PythonPath
+
+type AnalysisPhase = Literal[
+    "project-load",
+    "source-file-load",
+    "export-extract",
+    "symbol-extract",
+    "jsdoc-extract",
+    "analysis",
+    "post-analysis",
+]
+
+
+class AnalysisError(BaseError):
+    """Python Analysis error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        file_path: PythonPath,
+        phase: AnalysisPhase,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.file_path = file_path
+        self.phase = phase

gyomu_python_analysis/error/update.py

@@ -0,0 +1,32 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from gyomu_schema.error.base import BaseError
+from gyomu_schema.schemas.python.types import DeclarationIdentity, PythonPath
+
+type UpdatePhase = Literal[
+    "context-build", "update-plan", "merge-plan", "apply-merge", "update"
+]
+
+
+class UpdateError(BaseError):
+    """Docstring Update error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        file_path: PythonPath,
+        phase: UpdatePhase,
+        identity: DeclarationIdentity | None,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.file_path = file_path
+        self.phase = phase
+        self.identity = identity

gyomu_python_analysis/path/conversion.py

@@ -0,0 +1,25 @@
+from gyomu_schema.schemas.python.types import (
+    ProjectRelativePath,
+    PythonPath,
+    SourceRelativePath,
+)
+
+from gyomu_python_analysis.project.context import ProjectContext
+
+
+def project_relative_path_to_source_relative_path(
+    path: ProjectRelativePath,
+    context: ProjectContext,
+) -> SourceRelativePath:
+    return SourceRelativePath(path.relative_to(context.source_root))
+
+
+def source_relative_path_to_python_path(
+    path: SourceRelativePath,
+) -> PythonPath:
+    if path.name == "__init__.py":
+        path = SourceRelativePath(path.parent)
+    else:
+        path = SourceRelativePath(path.with_suffix(""))
+
+    return PythonPath(".".join(path.parts))

gyomu_python_analysis/project/context.py

@@ -0,0 +1,18 @@
+from dataclasses import dataclass
+
+from griffe import GriffeLoader
+from gyomu_schema.schemas.python.types import ProjectRelativePath
+from gyomu_schema.schemas.types import FullPath
+
+
+@dataclass
+class ProjectContext:
+    def __init__(
+        self, project_root: FullPath, source_root: ProjectRelativePath
+    ) -> None:
+        self.project_root = project_root
+        self.source_root = source_root
+        search_path = project_root / source_root
+        self.loader = GriffeLoader(
+            search_paths=[search_path],
+        )

gyomu_python_analysis-0.2.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,42 @@
+gyomu_python_analysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/get_module.py,sha256=UT7soyl1JLOXgf_OhO53giaLQZn2929-ZQz01GEkbh0,2130
+gyomu_python_analysis/analysis/load.py,sha256=haHAXTlzF0u43aaSaQFCTmPTZ10fmVcd4UnW2dH_KT0,1543
+gyomu_python_analysis/analysis/load_file_context.py,sha256=3IG_zvKXdVADMmRE8Nah3BZjVAWcYJuNQuq2qFFfmyU,1039
+gyomu_python_analysis/analysis/load_module.py,sha256=dt8m9ingFSJNidAMMUYjr84xYvNJ1GlHEKa_BnQjt00,2544
+gyomu_python_analysis/analysis/metadata.py,sha256=tb9r7-sEdymVTuAikxfKFQHINUlFW4WiMNCfGkUiQeQ,2083
+gyomu_python_analysis/analysis/analyzers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/analyzers/cls.py,sha256=bZ2WHT3MOb6wDxQlu-Ql456T3XWiMtUI9YKje-Hdklk,10529
+gyomu_python_analysis/analysis/analyzers/context.py,sha256=YmOSwQEV-C4iTNSLWn9Ojw_e4O3O-uCz1m6jRif0LY4,1716
+gyomu_python_analysis/analysis/analyzers/decorator.py,sha256=dAu7Af8oVjtPOA6iZV0S8Jjn1yx_vcC7_0zQDMgiYq8,3054
+gyomu_python_analysis/analysis/analyzers/dependency.py,sha256=8lU3SaIWC_SL0VOAS3o_qUQ_dmM2MAUb1SNiicuC5y0,3534
+gyomu_python_analysis/analysis/analyzers/docstring.py,sha256=uJEiNNYAo82VqssAaidmrSWyfw9-YLuFaGQBJCySrC0,9387
+gyomu_python_analysis/analysis/analyzers/functions.py,sha256=IevPQpoEY4h5wJEFCI5djR49hHZppIYCgTPLt-Hz0uk,2056
+gyomu_python_analysis/analysis/analyzers/imports.py,sha256=zan5bRTbVmKHm7rFdVoFy5E10m0mHI_L3dM0V9Hv_9Y,703
+gyomu_python_analysis/analysis/analyzers/pydantic.py,sha256=9P0C1rzx_xNEyxwo4ga3jyFVQpIHSWRF7dv0tQALI18,1945
+gyomu_python_analysis/analysis/analyzers/type_alias.py,sha256=MhPKiqRZBKFIrtSjyX5DrRD78765Hm5szyfocFJU7Tw,840
+gyomu_python_analysis/analysis/analyzers/types.py,sha256=-WCNbpLwCb13rmvGe8AFW3QWZsDbT9lx-l6fAsnBZdw,1048
+gyomu_python_analysis/analysis/analyzers/variables.py,sha256=fdRp9phR70XNqr1TXkIBKwCLaRRVcW2WlNx1a7uoBQQ,819
+gyomu_python_analysis/analysis/analyzers/expression/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/analyzers/expression/expr.py,sha256=QVnpKSXcQQWhA-IJOb9SyyGH7Cv7YdGQiE5xMgiQAaA,13307
+gyomu_python_analysis/analysis/analyzers/expression/name.py,sha256=WUtb2Dd3AcXqmeUQDi3h8U3-YqO76ZdEG658TPk9ERA,1322
+gyomu_python_analysis/analysis/analyzers/internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/analyzers/internal/common.py,sha256=dc3woHGnXoNQseR-C0jxxSkf5BG5oW9gV3B52TI5aIU,2921
+gyomu_python_analysis/analysis/analyzers/internal/location.py,sha256=GmJMQxpxC8jwqbEcyOdCvmj0YVgTt_CHz7VNPJCrAZU,2053
+gyomu_python_analysis/analysis/analyzers/internal/visibility.py,sha256=7oaITFrhXobsJbRq-RmLOLBEejekou9w02KkDLUWyzQ,553
+gyomu_python_analysis/analysis/extract/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/extract/symbols.py,sha256=lQ_URwt5CIXYb-26EkZV-e7hmznhabmmkWk8X7pmseY,4238
+gyomu_python_analysis/analysis/file/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/file/source_file_context.py,sha256=wZu2iMIa2g_sWqdByy1upFTeg2t24gLneJMrMjguEn4,225
+gyomu_python_analysis/analysis/parser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/analysis/parser/docstring.py,sha256=kBDLCBFBoFkedAswEuIQKOdMl9uNmyNH9b7AWC9YjfI,190
+gyomu_python_analysis/error/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/error/analysis.py,sha256=V0Lk5fsaQw20S7DXGAlFACDPSJsXBpUtpES_Mp8IJdQ,821
+gyomu_python_analysis/error/update.py,sha256=qWQIW7xKKA_4r25ltytcqlfOMn0QWI9uPMDDCn9JdSA,844
+gyomu_python_analysis/path/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/path/conversion.py,sha256=CH12LJx2X0bly7oHaHm6ivki6jizKLGvo82Vu8sVcEc,671
+gyomu_python_analysis/project/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gyomu_python_analysis/project/context.py,sha256=qMJDpVNCntSfEhU1J3w7kGu_5OFSTDV567-fu9BdgqQ,535
+gyomu_python_analysis-0.2.0.dist-info/METADATA,sha256=-QlVODm3bqtgQ6pKXKbcVZh4bQcvE7N6xLXBUfVQNxI,389
+gyomu_python_analysis-0.2.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+gyomu_python_analysis-0.2.0.dist-info/RECORD,,

gyomu_python_analysis-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any