framework development

pyproject.toml

@@ -13,6 +13,7 @@ importlib-metadata = ">=4.8.0"
 langchain = "^0.1.6"
 poetry-dynamic-versioning = "^1.2.0"
 langchain-openai = "^0.0.5"
+tabulate = "^0.9.0"
 
 [tool.poetry.group.dev.dependencies]
 pytest = {version = ">=7.1.2"}

src/codergpt/cli.py

@@ -1,6 +1,8 @@
 """Command line interface for CoderGPT."""
 
 import logging
+from pathlib import Path
+from typing import TextIO, Union
 
 import click
 
@@ -37,8 +39,8 @@ def main(verbose: int, quiet: bool):
 
 @main.command()
 @click.argument("path", type=click.Path(exists=True))
-def inspect(path: str):
-    """Inspect pckage to show file-language-map."""
+def inspect(path: Union[str, Path, TextIO]):
+    """Inspect package to show file-language-map."""
     coder = CoderGPT()
     coder.inspect_package(path=path)
 

src/codergpt/constants.py

@@ -5,3 +5,5 @@
 SRC = Path(__file__).resolve().parents[1]
 PACKAGE_DIR = SRC / "codergpt"
 EXTENSION_MAP_FILE = PACKAGE_DIR / "extensions.yaml"
+LANGUAGE_MAP_KEY = "language-map"
+INSPECTION_HEADERS = ["File", "Language"]

src/codergpt/explainer/__init__.py

@@ -0,0 +1 @@
+"""Code explanation module."""

src/codergpt/main.py

@@ -2,13 +2,14 @@
 
 import os
 from pathlib import Path
-from typing import Dict, Union
+from typing import Union
 
 import yaml
 from langchain_core.prompts import ChatPromptTemplate
 from langchain_openai import ChatOpenAI
+from tabulate import tabulate
 
-from codergpt.constants import EXTENSION_MAP_FILE
+from codergpt.constants import EXTENSION_MAP_FILE, INSPECTION_HEADERS
 
 
 class CoderGPT:
@@ -37,38 +38,39 @@ def __init__(self):
         #     }
         # )
 
-    def inspect_package(self, path: Union[str, Path]) -> Dict[str, str]:
-        """Inspecting the code and returning a mapping of files to their languages."""
+    def inspect_package(self, path: Union[str, Path]):
+        """Inspecting the code and displaying a mapping of files to their languages in a table."""
         print("Inspecting the code.")
 
         with open(EXTENSION_MAP_FILE, "r") as file:
             extension_to_language = yaml.safe_load(file)
 
-        # Initialize an empty dictionary to store the results
-        file_language_map = {}
-
         # Convert path to Path object if it's a string
         path = Path(path)
 
+        # Initialize an empty list to store the results
+        file_language_list = []
+
         # Check if the path is a directory or a file
         if path.is_dir():
             # Iterate over all files in the directory and subdirectories
-            file_language_map = {
-                str(file): extension_to_language["language-map"].get(file.suffix)
-                for file in path.rglob("*.*")
-                if extension_to_language["language-map"].get(file.suffix) is not None
-            }
+            for file in path.rglob("*.*"):
+                language = extension_to_language["language-map"].get(file.suffix)
+                if language is not None:
+                    file_language_list.append((str(file), language))
 
         elif path.is_file():
             # Get the language for the single file
             language = extension_to_language["language-map"].get(path.suffix)
             if language is not None:
-                file_language_map[str(path)] = language
+                file_language_list.append((str(path), language))
 
         else:
             print(f"The path {path} is neither a file nor a directory.")
-            return file_language_map
-        return file_language_map
+            return
+
+        # Display the results as a table
+        print(tabulate(file_language_list, headers=INSPECTION_HEADERS))
 
 
 if __name__ == "__main__":

src/codergpt/optimizer/__init__.py

@@ -0,0 +1 @@
+"""Code optimization module."""

src/codergpt/test_writer/__init__.py

@@ -0,0 +1 @@
+"""Test writing module."""