codeanalyzer-python 0.1.8__tar.gz → 0.1.10__tar.gz

codeanalyzer_python-0.1.8/README.md → codeanalyzer_python-0.1.10/PKG-INFO

@@ -1,3 +1,24 @@
+Metadata-Version: 2.4
+Name: codeanalyzer-python
+Version: 0.1.10
+Summary: Static Analysis on Python source code using Jedi, CodeQL and Treesitter.
+Author-email: Rahul Krishna <i.m.ralk@gmail.com>
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.9
+Requires-Dist: jedi<0.20.0,>=0.18.0
+Requires-Dist: msgpack<1.0.7,>=1.0.0
+Requires-Dist: networkx<3.2.0,>=2.6.0
+Requires-Dist: numpy<1.24.0,>=1.21.0
+Requires-Dist: pandas<2.0.0,>=1.3.0
+Requires-Dist: pydantic<2.0.0,>=1.8.0
+Requires-Dist: ray<3.0.0,>=2.0.0
+Requires-Dist: requests<3.0.0,>=2.20.0
+Requires-Dist: rich<14.0.0,>=12.6.0
+Requires-Dist: typer<1.0.0,>=0.9.0
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
 ![logo](https://github.com/codellm-devkit/codeanalyzer-python/blob/main/docs/assets/logo.png?raw=true)
 
 # A Python Static Analysis Toolkit (and Library)
@@ -76,17 +97,18 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
  Static Analysis on Python source code using Jedi, CodeQL and Tree sitter.
 
 
-╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ *  --input           -i                  PATH     Path to the project root directory. [default: None] [required]   │
-│    --output          -o                  PATH     Output directory for artifacts. [default: None]                  │
-│    --analysis-level  -a                  INTEGER  1: symbol table, 2: call graph. [default: 1]                     │
-│    --codeql              --no-codeql              Enable CodeQL-based analysis. [default: no-codeql]               │
-│    --eager               --lazy                   Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
-│    --cache-dir       -c                  PATH     Directory to store analysis cache. [default: None]               │
-│    --clear-cache         --keep-cache             Clear cache after analysis. [default: clear-cache]               │
-│                      -v                  INTEGER  Increase verbosity: -v, -vv, -vvv [default: 0]                   │
-│    --help                                         Show this message and exit.                                      │
-╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ *  --input           -i                  PATH            Path to the project root directory. [default: None] [required]   │
+│    --output          -o                  PATH            Output directory for artifacts. [default: None]                  │
+│    --format          -f                  [json|msgpack]  Output format: json or msgpack. [default: json]                  │
+│    --analysis-level  -a                  INTEGER         1: symbol table, 2: call graph. [default: 1]                     │
+│    --codeql              --no-codeql                     Enable CodeQL-based analysis. [default: no-codeql]               │
+│    --eager               --lazy                          Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
+│    --cache-dir       -c                  PATH            Directory to store analysis cache. [default: None]               │
+│    --clear-cache         --keep-cache                    Clear cache after analysis. [default: clear-cache]               │
+│                      -v                  INTEGER         Increase verbosity: -v, -vv, -vvv [default: 0]                   │
+│    --help                                                Show this message and exit.                                      │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
 ### Examples
@@ -104,7 +126,14 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
    Now, you can find the analysis results in `analysis.json` in the specified directory.
 
-2. **Toggle analysis levels with `--analysis-level`:**
+2. **Change output format to msgpack:**
+   ```bash
+   codeanalyzer --input ./my-python-project --output /path/to/analysis-results --format msgpack
+   ```
+
+   This will save the analysis results in `analysis.msgpack` in the specified directory.
+
+3. **Toggle analysis levels with `--analysis-level`:**
    ```bash
    codeanalyzer --input ./my-python-project --analysis-level 1 # Symbol table only
    ```
@@ -114,7 +143,7 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
    ```
    ***Note: The `--analysis-level=2` is not yet implemented in this version.***
 
-3. **Analysis with CodeQL enabled:**
+4. **Analysis with CodeQL enabled:**
    ```bash
    codeanalyzer --input ./my-python-project --codeql
    ```
@@ -122,7 +151,7 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
     ***Note: Not yet fully implemented. Please refrain from using this option until further notice.***
 
-4. **Eager analysis with custom cache directory:**
+5. **Eager analysis with custom cache directory:**
    ```bash
    codeanalyzer --input ./my-python-project --eager --cache-dir /path/to/custom-cache
    ```
@@ -130,14 +159,14 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
     If you provide --cache-dir, the cache will be stored in that directory. If not specified, it defaults to `.codeanalyzer` in the current working directory (`$PWD`).
 
-5. **Quiet mode (minimal output):**
+6. **Quiet mode (minimal output):**
    ```bash
    codeanalyzer --input /path/to/my-python-project --quiet
    ```
 
-### Output
+## Output
 
-By default, analysis results are printed to stdout in JSON format. When using the `--output` option, results are saved to `analysis.json` in the specified directory.
+By default, analysis results are printed to stdout in JSON format. When using the `--output` option, results are saved to `analysis.json` in the specified directory. If you use the `--format=msgpack` option, the results will be saved in `analysis.msgpack`, which is a binary format that can be more efficient for storage and transmission.
 
 ## Development
 

codeanalyzer_python-0.1.8/PKG-INFO → codeanalyzer_python-0.1.10/README.md

@@ -1,22 +1,3 @@
-Metadata-Version: 2.4
-Name: codeanalyzer-python
-Version: 0.1.8
-Summary: Static Analysis on Python source code using Jedi, CodeQL and Treesitter.
-Author-email: Rahul Krishna <i.m.ralk@gmail.com>
-License-File: LICENSE
-License-File: NOTICE
-Requires-Python: >=3.10
-Requires-Dist: jedi>=0.19.2
-Requires-Dist: loguru>=0.7.3
-Requires-Dist: msgpack>=1.1.1
-Requires-Dist: networkx>=3.4.2
-Requires-Dist: pandas>=2.3.1
-Requires-Dist: pydantic>=2.11.7
-Requires-Dist: requests>=2.32.4
-Requires-Dist: rich>=14.0.0
-Requires-Dist: typer>=0.16.0
-Description-Content-Type: text/markdown
-
 ![logo](https://github.com/codellm-devkit/codeanalyzer-python/blob/main/docs/assets/logo.png?raw=true)
 
 # A Python Static Analysis Toolkit (and Library)
@@ -95,17 +76,18 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
  Static Analysis on Python source code using Jedi, CodeQL and Tree sitter.
 
 
-╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│ *  --input           -i                  PATH     Path to the project root directory. [default: None] [required]   │
-│    --output          -o                  PATH     Output directory for artifacts. [default: None]                  │
-│    --analysis-level  -a                  INTEGER  1: symbol table, 2: call graph. [default: 1]                     │
-│    --codeql              --no-codeql              Enable CodeQL-based analysis. [default: no-codeql]               │
-│    --eager               --lazy                   Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
-│    --cache-dir       -c                  PATH     Directory to store analysis cache. [default: None]               │
-│    --clear-cache         --keep-cache             Clear cache after analysis. [default: clear-cache]               │
-│                      -v                  INTEGER  Increase verbosity: -v, -vv, -vvv [default: 0]                   │
-│    --help                                         Show this message and exit.                                      │
-╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ *  --input           -i                  PATH            Path to the project root directory. [default: None] [required]   │
+│    --output          -o                  PATH            Output directory for artifacts. [default: None]                  │
+│    --format          -f                  [json|msgpack]  Output format: json or msgpack. [default: json]                  │
+│    --analysis-level  -a                  INTEGER         1: symbol table, 2: call graph. [default: 1]                     │
+│    --codeql              --no-codeql                     Enable CodeQL-based analysis. [default: no-codeql]               │
+│    --eager               --lazy                          Enable eager or lazy analysis. Defaults to lazy. [default: lazy] │
+│    --cache-dir       -c                  PATH            Directory to store analysis cache. [default: None]               │
+│    --clear-cache         --keep-cache                    Clear cache after analysis. [default: clear-cache]               │
+│                      -v                  INTEGER         Increase verbosity: -v, -vv, -vvv [default: 0]                   │
+│    --help                                                Show this message and exit.                                      │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
 ### Examples
@@ -123,7 +105,14 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
    Now, you can find the analysis results in `analysis.json` in the specified directory.
 
-2. **Toggle analysis levels with `--analysis-level`:**
+2. **Change output format to msgpack:**
+   ```bash
+   codeanalyzer --input ./my-python-project --output /path/to/analysis-results --format msgpack
+   ```
+
+   This will save the analysis results in `analysis.msgpack` in the specified directory.
+
+3. **Toggle analysis levels with `--analysis-level`:**
    ```bash
    codeanalyzer --input ./my-python-project --analysis-level 1 # Symbol table only
    ```
@@ -133,7 +122,7 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
    ```
    ***Note: The `--analysis-level=2` is not yet implemented in this version.***
 
-3. **Analysis with CodeQL enabled:**
+4. **Analysis with CodeQL enabled:**
    ```bash
    codeanalyzer --input ./my-python-project --codeql
    ```
@@ -141,7 +130,7 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
     ***Note: Not yet fully implemented. Please refrain from using this option until further notice.***
 
-4. **Eager analysis with custom cache directory:**
+5. **Eager analysis with custom cache directory:**
    ```bash
    codeanalyzer --input ./my-python-project --eager --cache-dir /path/to/custom-cache
    ```
@@ -149,14 +138,14 @@ To view the available options and commands, run `codeanalyzer --help`. You shoul
 
     If you provide --cache-dir, the cache will be stored in that directory. If not specified, it defaults to `.codeanalyzer` in the current working directory (`$PWD`).
 
-5. **Quiet mode (minimal output):**
+6. **Quiet mode (minimal output):**
    ```bash
    codeanalyzer --input /path/to/my-python-project --quiet
    ```
 
-### Output
+## Output
 
-By default, analysis results are printed to stdout in JSON format. When using the `--output` option, results are saved to `analysis.json` in the specified directory.
+By default, analysis results are printed to stdout in JSON format. When using the `--output` option, results are saved to `analysis.json` in the specified directory. If you use the `--format=msgpack` option, the results will be saved in `analysis.msgpack`, which is a binary format that can be more efficient for storage and transmission.
 
 ## Development
 

{codeanalyzer_python-0.1.8 → codeanalyzer_python-0.1.10}/codeanalyzer/__main__.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Annotated, Optional
+from typing import Optional, Annotated
 
 import typer
 
@@ -7,7 +7,6 @@ from codeanalyzer.core import Codeanalyzer
 from codeanalyzer.utils import _set_log_level, logger
 from codeanalyzer.config import OutputFormat
 
-
 def main(
     input: Annotated[
         Path, typer.Option("-i", "--input", help="Path to the project root directory.")
@@ -32,6 +31,12 @@ def main(
     using_codeql: Annotated[
         bool, typer.Option("--codeql/--no-codeql", help="Enable CodeQL-based analysis.")
     ] = False,
+    using_ray: Annotated[
+        bool,
+        typer.Option(
+            "--ray/--no-ray", help="Enable Ray for distributed analysis."
+        ),
+    ] = False,
     rebuild_analysis: Annotated[
         bool,
         typer.Option(
@@ -39,18 +44,32 @@ def main(
             help="Enable eager or lazy analysis. Defaults to lazy.",
         ),
     ] = False,
+    skip_tests: Annotated[
+        bool,
+        typer.Option(
+            "--skip-tests/--include-tests",
+            help="Skip test files in analysis.",
+        ),
+    ] = True,
+    file_name: Annotated[
+        Optional[Path],
+        typer.Option(
+            "--file-name",
+            help="Analyze only the specified file (relative to input directory).",
+        ),
+    ] = None,
     cache_dir: Annotated[
         Optional[Path],
         typer.Option(
             "-c",
             "--cache-dir",
-            help="Directory to store analysis cache.",
+            help="Directory to store analysis cache. Defaults to '.codeanalyzer' in the input directory.",
         ),
     ] = None,
     clear_cache: Annotated[
         bool,
-        typer.Option("--clear-cache/--keep-cache", help="Clear cache after analysis."),
-    ] = True,
+        typer.Option("--clear-cache/--keep-cache", help="Clear cache after analysis. By default, cache is retained."),
+    ] = False,
     verbosity: Annotated[
         int, typer.Option("-v", count=True, help="Increase verbosity: -v, -vv, -vvv")
     ] = 0,
@@ -62,21 +81,28 @@ def main(
         logger.error(f"Input path '{input}' does not exist.")
         raise typer.Exit(code=1)
 
+    # Validate file_name if provided
+    if file_name is not None:
+        full_file_path = input / file_name
+        if not full_file_path.exists():
+            logger.error(f"Specified file '{file_name}' does not exist in '{input}'.")
+            raise typer.Exit(code=1)
+        if not full_file_path.is_file():
+            logger.error(f"Specified path '{file_name}' is not a file.")
+            raise typer.Exit(code=1)
+        if not str(file_name).endswith('.py'):
+            logger.error(f"Specified file '{file_name}' is not a Python file (.py).")
+            raise typer.Exit(code=1)
+
     with Codeanalyzer(
-        input, analysis_level, using_codeql, rebuild_analysis, cache_dir, clear_cache
+        input, analysis_level, skip_tests, using_codeql, rebuild_analysis, cache_dir, clear_cache, using_ray, file_name
     ) as analyzer:
         artifacts = analyzer.analyze()
 
         # Handle output based on format
         if output is None:
             # Output to stdout (only for JSON)
-            if format == OutputFormat.JSON:
-                print(artifacts.model_dump_json(separators=(",", ":")))
-            else:
-                logger.error(
-                    f"Format '{format.value}' requires an output directory (use -o/--output)"
-                )
-                raise typer.Exit(code=1)
+            print(artifacts.json(separators=(",", ":")))
         else:
             # Output to file
             output.mkdir(parents=True, exist_ok=True)
@@ -88,7 +114,7 @@ def _write_output(artifacts, output_dir: Path, format: OutputFormat):
     if format == OutputFormat.JSON:
         output_file = output_dir / "analysis.json"
         # Use Pydantic's json() with separators for compact output
-        json_str = artifacts.model_dump_json(indent=None)
+        json_str = artifacts.json(indent=None)
         with output_file.open("w") as f:
             f.write(json_str)
         logger.info(f"Analysis saved to {output_file}")

codeanalyzer_python-0.1.10/codeanalyzer/config/config.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class OutputFormat(str, Enum):
+    """String-based enum for output formats to support typer case-insensitive options."""
+
+    JSON = "json"
+    MSGPACK = "msgpack"