codinsight 0.1.0__tar.gz → 0.3.0__tar.gz

codinsight-0.3.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: codinsight
+Version: 0.3.0
+Summary: Add your description here
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: matplotlib>=3.10.5
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: pycodestyle>=2.14.0
+Requires-Dist: pydantic>=2.11.7
+Requires-Dist: pydocstyle>=6.3.0
+Requires-Dist: pytest>=8.4.1
+Requires-Dist: pytest-cov>=6.2.1
+Requires-Dist: radon>=6.0.1
+Requires-Dist: reportlab>=4.4.3
+Requires-Dist: scikit-learn>=1.7.1
+
+Codinsight - 複数ファイル解析の利用方法
+
+概要
+- 複数のファイルやディレクトリを再帰的に走査し、既存の解析エンジン（Style/Struct/Readability/Redundancy/Algorithm/Complexity/Quality）で一括解析を実行
+- 拡張子のフィルタや除外パターン（node_modules, .git など）に対応
+- 結果をファイル単位と集約統計（平均など）で取得可能
+- Pydantic BaseModel で JSON 化が容易
+
+## API 使用例
+
+```python
+from code_insight.core import CodeAnalysisType
+from code_insight.multi_analysis import MultiFileAnalyzer
+
+analyzer = MultiFileAnalyzer(
+    exts={".py"},
+    excludes={"node_modules", "target", ".git", ".venv", "__pycache__"},
+)
+result = analyzer.analyze(
+    ["src", "tests"],
+    [CodeAnalysisType.STYLE, CodeAnalysisType.STRUCT],
+)
+print(result.model_dump_json())
+```
+
+## 設定のカスタマイズ
+
+```python
+from code_insight.core import CodeAnalysis, AnalysisConfigs, CodeAnalysisType
+from code_insight.code_analysis.quality import QualityAnalysisConfig
+from code_insight.code_analysis.redundancy import RedundancyAnalysisConfig
+from code_insight.code_analysis.style import StyleAnalysisConfig
+
+# カスタム設定の作成
+configs = AnalysisConfigs(
+    quality=QualityAnalysisConfig(
+        long_param_threshold=3,  # デフォルト: 5
+        enabled=True
+    ),
+    redundancy=RedundancyAnalysisConfig(
+        long_function_lines_threshold=30,  # デフォルト: 50
+        long_function_complexity_threshold=8,  # デフォルト: 10
+        ignored_function_names={"main", "__init__", "setup"}
+    ),
+    style=StyleAnalysisConfig(
+        function_name_pattern=r"^[a-z_][a-z0-9_]*$",  # snake_case
+        class_name_pattern=r"^[A-Z][a-zA-Z0-9]*$"     # PascalCase
+    )
+)
+
+# 設定を使用した解析
+analysis = CodeAnalysis(source_code, configs)
+result = analysis.analyze([CodeAnalysisType.QUALITY, CodeAnalysisType.REDUNDANCY])
+
+# 複数ファイル解析での設定使用
+analyzer = MultiFileAnalyzer(configs=configs)
+result = analyzer.analyze(["src"], [CodeAnalysisType.STYLE])
+```
+
+### 設定可能な項目
+
+#### Quality解析
+- `long_param_threshold`: 長引数関数の閾値（デフォルト: 5）
+- `enabled`: 解析の有効/無効（デフォルト: True）
+
+#### Redundancy解析
+- `long_function_lines_threshold`: 長大関数の行数閾値（デフォルト: 50）
+- `long_function_complexity_threshold`: 長大関数の複雑度閾値（デフォルト: 10）
+- `ignored_function_names`: 未使用コード検出で無視する関数名（デフォルト: {"main", "__init__", "__main__"}）
+
+#### Style解析
+- `function_name_pattern`: 関数名の正規表現パターン（デフォルト: snake_case）
+- `class_name_pattern`: クラス名の正規表現パターン（デフォルト: PascalCase）
+
+#### その他の解析エンジン
+- Algorithm, Complexity, Readability, Structの各解析エンジンにも同様の設定項目があります
+
+主なオプション
+- exts: 対象拡張子のセット（デフォルト: {".py"}）
+- excludes: 除外ディレクトリ名のセット（デフォルト: {"node_modules", "target", ".git", ".venv", "__pycache__"}）
+
+返却データの構造
+- files: 各ファイルの解析結果（解析タイプ名 → メトリクス辞書）
+- aggregate:
+  - total_files: 解析対象に収集されたファイル数
+  - analyzed_files: 実際に解析に成功したファイル数
+  - errors: 解析時にエラーとなったファイルパスの一覧
+  - by_type_avg: 解析タイプごとの各数値メトリクスの平均値
+
+注意
+- 現時点では直列処理のみ対応。大規模データや並列化は将来的な拡張予定

codinsight-0.3.0/README.md

@@ -0,0 +1,91 @@
+Codinsight - 複数ファイル解析の利用方法
+
+概要
+- 複数のファイルやディレクトリを再帰的に走査し、既存の解析エンジン（Style/Struct/Readability/Redundancy/Algorithm/Complexity/Quality）で一括解析を実行
+- 拡張子のフィルタや除外パターン（node_modules, .git など）に対応
+- 結果をファイル単位と集約統計（平均など）で取得可能
+- Pydantic BaseModel で JSON 化が容易
+
+## API 使用例
+
+```python
+from code_insight.core import CodeAnalysisType
+from code_insight.multi_analysis import MultiFileAnalyzer
+
+analyzer = MultiFileAnalyzer(
+    exts={".py"},
+    excludes={"node_modules", "target", ".git", ".venv", "__pycache__"},
+)
+result = analyzer.analyze(
+    ["src", "tests"],
+    [CodeAnalysisType.STYLE, CodeAnalysisType.STRUCT],
+)
+print(result.model_dump_json())
+```
+
+## 設定のカスタマイズ
+
+```python
+from code_insight.core import CodeAnalysis, AnalysisConfigs, CodeAnalysisType
+from code_insight.code_analysis.quality import QualityAnalysisConfig
+from code_insight.code_analysis.redundancy import RedundancyAnalysisConfig
+from code_insight.code_analysis.style import StyleAnalysisConfig
+
+# カスタム設定の作成
+configs = AnalysisConfigs(
+    quality=QualityAnalysisConfig(
+        long_param_threshold=3,  # デフォルト: 5
+        enabled=True
+    ),
+    redundancy=RedundancyAnalysisConfig(
+        long_function_lines_threshold=30,  # デフォルト: 50
+        long_function_complexity_threshold=8,  # デフォルト: 10
+        ignored_function_names={"main", "__init__", "setup"}
+    ),
+    style=StyleAnalysisConfig(
+        function_name_pattern=r"^[a-z_][a-z0-9_]*$",  # snake_case
+        class_name_pattern=r"^[A-Z][a-zA-Z0-9]*$"     # PascalCase
+    )
+)
+
+# 設定を使用した解析
+analysis = CodeAnalysis(source_code, configs)
+result = analysis.analyze([CodeAnalysisType.QUALITY, CodeAnalysisType.REDUNDANCY])
+
+# 複数ファイル解析での設定使用
+analyzer = MultiFileAnalyzer(configs=configs)
+result = analyzer.analyze(["src"], [CodeAnalysisType.STYLE])
+```
+
+### 設定可能な項目
+
+#### Quality解析
+- `long_param_threshold`: 長引数関数の閾値（デフォルト: 5）
+- `enabled`: 解析の有効/無効（デフォルト: True）
+
+#### Redundancy解析
+- `long_function_lines_threshold`: 長大関数の行数閾値（デフォルト: 50）
+- `long_function_complexity_threshold`: 長大関数の複雑度閾値（デフォルト: 10）
+- `ignored_function_names`: 未使用コード検出で無視する関数名（デフォルト: {"main", "__init__", "__main__"}）
+
+#### Style解析
+- `function_name_pattern`: 関数名の正規表現パターン（デフォルト: snake_case）
+- `class_name_pattern`: クラス名の正規表現パターン（デフォルト: PascalCase）
+
+#### その他の解析エンジン
+- Algorithm, Complexity, Readability, Structの各解析エンジンにも同様の設定項目があります
+
+主なオプション
+- exts: 対象拡張子のセット（デフォルト: {".py"}）
+- excludes: 除外ディレクトリ名のセット（デフォルト: {"node_modules", "target", ".git", ".venv", "__pycache__"}）
+
+返却データの構造
+- files: 各ファイルの解析結果（解析タイプ名 → メトリクス辞書）
+- aggregate:
+  - total_files: 解析対象に収集されたファイル数
+  - analyzed_files: 実際に解析に成功したファイル数
+  - errors: 解析時にエラーとなったファイルパスの一覧
+  - by_type_avg: 解析タイプごとの各数値メトリクスの平均値
+
+注意
+- 現時点では直列処理のみ対応。大規模データや並列化は将来的な拡張予定

codinsight-0.3.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "codinsight"
+version = "0.3.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "matplotlib>=3.10.5",
+    "pandas>=2.3.1",
+    "pycodestyle>=2.14.0",
+    "pydantic>=2.11.7",
+    "pydocstyle>=6.3.0",
+    "pytest>=8.4.1",
+    "pytest-cov>=6.2.1",
+    "radon>=6.0.1",
+    "reportlab>=4.4.3",
+    "scikit-learn>=1.7.1",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.isort]
+profile = "black"
+
+[tool.pydocstyle]
+ignore = ["D100", "D104", "D203", "D205", "D212", "D400", "D415"]
+addopts = "--exclude=tests"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/code_insight"]
+include = ["src/code_insight/py.typed"]
+
+[tool.ruff]
+line-length = 88
+include = ["codinsight/**/*.py"]
+
+[tool.ruff.lint]
+select = ["F", "E", "I", "B"]
+
+[tool.ruff.lint.isort]
+# black profileと同等の設定
+split-on-trailing-comma = true
+combine-as-imports = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["src"]

{codinsight-0.1.0 → codinsight-0.3.0}/setup.cfg

@@ -1,4 +1,4 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-
+[egg_info]
+tag_build = 
+tag_date = 0
+

codinsight-0.3.0/src/code_insight/__init__.py

@@ -0,0 +1,57 @@
+from .code_analysis.algorithm import (
+    Algorithm,
+    AlgorithmAnalysisConfig,
+    AlgorithmAnalysisResult,
+)
+from .code_analysis.complexity import (
+    Complexity,
+    ComplexityAnalysisConfig,
+    ComplexityAnalysisResult,
+)
+from .code_analysis.quality import Quality, QualityAnalysisConfig, QualityAnalysisResult
+from .code_analysis.readability import (
+    Readability,
+    ReadabilityAnalysisConfig,
+    ReadabilityAnalysisResult,
+)
+from .code_analysis.redundancy import (
+    Redundancy,
+    RedundancyAnalysisConfig,
+    RedundancyAnalysisResult,
+)
+from .code_analysis.struct import Struct, StructAnalysisConfig, StructAnalysisResult
+from .code_analysis.style import Style, StyleAnalysisConfig, StyleAnalysisResult
+from .core import AnalysisConfigs, CodeAnalysis, CodeAnalysisType
+from .multi_analysis import FileAnalysisResult, MultiAnalysisResult, MultiFileAnalyzer
+from .trend_analysis.trend_analysis import TrendAnalysis
+
+__all__ = [
+    "CodeAnalysis",
+    "CodeAnalysisType",
+    "AnalysisConfigs",
+    "MultiFileAnalyzer",
+    "MultiAnalysisResult",
+    "FileAnalysisResult",
+    "Readability",
+    "ReadabilityAnalysisResult",
+    "ReadabilityAnalysisConfig",
+    "Algorithm",
+    "AlgorithmAnalysisResult",
+    "AlgorithmAnalysisConfig",
+    "Complexity",
+    "ComplexityAnalysisResult",
+    "ComplexityAnalysisConfig",
+    "Quality",
+    "QualityAnalysisResult",
+    "QualityAnalysisConfig",
+    "Redundancy",
+    "RedundancyAnalysisResult",
+    "RedundancyAnalysisConfig",
+    "Struct",
+    "StructAnalysisResult",
+    "StructAnalysisConfig",
+    "Style",
+    "StyleAnalysisResult",
+    "StyleAnalysisConfig",
+    "TrendAnalysis",
+]

codinsight-0.3.0/src/code_insight/code_analysis/abstract.py

@@ -0,0 +1,91 @@
+from abc import ABC, abstractmethod
+from typing import Generic, TypeVar
+
+from pydantic import BaseModel
+
+
+class BaseAnalysisConfig(BaseModel):
+    """
+    解析設定のベースクラス
+
+    Attributes
+    ----------
+    enabled : bool
+        解析の有効/無効フラグ, by default True
+    """
+
+    enabled: bool = True
+
+
+class BaseAnalysisResult(BaseModel):
+    """
+    解析結果のベースモデル
+
+    Notes
+    -----
+    全ての解析結果クラスの基底クラス
+    """
+
+
+R = TypeVar("R", bound=BaseAnalysisResult)
+C = TypeVar("C", bound=BaseAnalysisConfig)
+
+
+class AbstractAnalysis(ABC, Generic[R, C]):
+    """
+    解析抽象クラス
+
+    Parameters
+    ----------
+    R : TypeVar
+        解析結果の型
+    C : TypeVar
+        解析設定の型
+
+    Attributes
+    ----------
+    config : C
+        解析設定
+    """
+
+    config: C
+
+    def __init__(self, config: C | None = None) -> None:
+        """
+        コンストラクタ
+
+        Parameters
+        ----------
+        config : C | None, optional
+            解析設定, by default None
+        """
+        self.config = config or self.get_default_config()
+
+    @abstractmethod
+    def get_default_config(self) -> C:
+        """
+        デフォルト設定を取得
+
+        Returns
+        -------
+        C
+            デフォルト設定
+        """
+        raise NotImplementedError("get_default_config method must be implemented")
+
+    @abstractmethod
+    def analyze(self, source_code: str) -> R:
+        """
+        コードを解析する
+
+        Parameters
+        ----------
+        source_code : str
+            解析対象のソースコード
+
+        Returns
+        -------
+        R
+            解析結果
+        """
+        raise NotImplementedError("analyze method must be implemented")