codespector 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

codespector/base.py

@@ -0,0 +1,7 @@
+from abc import ABC, abstractmethod
+
+
+class BasePipe(ABC):
+    @abstractmethod
+    def start(self, *args, **kwargs) -> None:
+        raise NotImplementedError

codespector/codespector.py

@@ -0,0 +1,84 @@
+from codespector.base import BasePipe
+from codespector.local import CodeSpectorDataPreparer
+from codespector.reviewer import CodeSpectorReviewer
+from codespector.types import AgentInfo
+
+
+class CodeSpector:
+    def __init__(
+        self,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        system_content: str,
+        prompt_content: str,
+        data_preparer: CodeSpectorDataPreparer,
+        reviewer: CodeSpectorReviewer,
+        pipeline: list[BasePipe],
+        result_file: str,
+        output_dir: str,
+        chat_model: str | None = None,
+    ):
+        self.chat_token = chat_token
+        self.chat_agent = chat_agent
+        self.compare_branch = compare_branch
+        self.output_dir = output_dir
+        self.system_content = system_content
+        self.prompt_content = prompt_content
+        self.data_preparer = data_preparer
+        self.reviewer = reviewer
+        self.pipeline = pipeline
+        self.result_file = result_file
+        self.chat_model = chat_model
+
+    @classmethod
+    def create(
+        cls,
+        chat_token: str,
+        chat_agent: str,
+        compare_branch: str,
+        system_content: str,
+        prompt_content: str,
+        result_file: str,
+        output_dir: str,
+        chat_model: str | None = None,
+    ) -> 'CodeSpector':
+        agent_info = AgentInfo.create(
+            chat_agent=chat_agent,
+            chat_token=chat_token,
+            chat_model=chat_model,
+        )
+        data_preparer = CodeSpectorDataPreparer(
+            output_dir=output_dir,
+            compare_branch=compare_branch,
+        )
+        reviewer = CodeSpectorReviewer(
+            diff_file=data_preparer.combined_file,
+            chat_token=chat_token,
+            chat_agent=chat_agent,
+            system_content=system_content,
+            output_dir=output_dir,
+            chat_model=chat_model,
+            agent_info=agent_info,
+            prompt_content=prompt_content,
+            result_file=result_file,
+        )
+        pipeline = [data_preparer, reviewer]
+
+        return CodeSpector(
+            chat_token=chat_token,
+            chat_agent=chat_agent,
+            chat_model=chat_model,
+            compare_branch=compare_branch,
+            system_content=system_content,
+            prompt_content=prompt_content,
+            data_preparer=data_preparer,
+            reviewer=reviewer,
+            pipeline=pipeline,
+            output_dir=output_dir,
+            result_file=result_file,
+        )
+
+    def review(self):
+        for pipe in self.pipeline:
+            pipe.start()

codespector/errors.py

@@ -0,0 +1,14 @@
+class NotValidCfgError(Exception):
+    """Exception raised when the configuration is not valid."""
+
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message
+
+
+class AppError(Exception):
+    """Exception raised for application errors."""
+
+    def __init__(self, message):
+        super().__init__(message)
+        self.message = message

codespector/{local/prepare.py → local.py}

@@ -1,9 +1,11 @@
-import ujson
+import json
 import subprocess
 import os
 
+from codespector.base import BasePipe
 
-class CodeSpectorDataPreparer:
+
+class CodeSpectorDataPreparer(BasePipe):
     def __init__(
         self,
         output_dir: str,
@@ -38,18 +40,18 @@ class CodeSpectorDataPreparer:
         diff_json = {'diff': '\n'.join(filtered_diff)}
         diff_filepath = os.path.join(self.output_dir, self.diff_file)
         with open(diff_filepath, 'w', encoding='utf-8') as f:
-            ujson.dump(diff_json, f, indent=4, ensure_ascii=False)
+            json.dump(diff_json, f, indent=4, ensure_ascii=False)
 
         with open(os.path.join(self.output_dir, self.original_files_tmp), 'r', encoding='utf-8') as f:
-            original_files_data = ujson.load(f)
+            original_files_data = json.load(f)
 
         with open(diff_filepath, 'r', encoding='utf-8') as f:
-            diff_data = ujson.load(f)
+            diff_data = json.load(f)
 
         combined_data = {**original_files_data, **diff_data}
 
         with open(os.path.join(self.output_dir, self.combined_file), 'w', encoding='utf-8') as f:
-            ujson.dump(combined_data, f, indent=4, ensure_ascii=False)
+            json.dump(combined_data, f, indent=4, ensure_ascii=False)
 
     def _prepare_name_only_file(self):
         changed_files = subprocess.run(
@@ -70,12 +72,9 @@ class CodeSpectorDataPreparer:
         filepath = os.path.join(self.output_dir, self.original_files_tmp)
 
         with open(filepath, 'w', encoding='utf-8') as f:
-            ujson.dump(result, f, indent=4, ensure_ascii=False)
+            json.dump(result, f, indent=4, ensure_ascii=False)
 
-    def prepare_data(self) -> str:
+    def start(self):
         self._prepare_dir()
         self._prepare_name_only_file()
         self._prepare_diff_file()
-
-    def start(self):
-        self.prepare_data()

codespector/main.py

@@ -3,8 +3,7 @@ from pathlib import Path
 import click
 from environs import Env
 
-from .controller import CodeSpectorController
-from loguru import logger
+from codespector.codespector import CodeSpector
 
 BASE_PATH = Path(__file__).parent.parent
 
@@ -12,10 +11,23 @@ env = Env()
 env.read_env(path=str(BASE_PATH / '.env'))
 
 
+@click.option(
+    '--result-file',
+    type=str,
+    help='Set file for saving the result',
+    envvar='CODESPECTOR_RESULT_FILE',
+    show_envvar=True,
+)
+@click.option(
+    '--prompt-content',
+    type=str,
+    help='Prompt content which included to review prompt',
+    envvar='CODESPECTOR_PROMPT_CONTENT',
+    show_envvar=True,
+)
 @click.option(
     '--system-content',
     type=str,
-    default='Ты код ревьювер. Отвечай на русском языке.',
     envvar='CODESPECTOR_SYSTEM_CONTENT',
     show_envvar=True,
     help='Content which used in system field for agent',
@@ -23,8 +35,8 @@ env.read_env(path=str(BASE_PATH / '.env'))
 @click.option(
     '--output-dir',
     type=str,
-    default='codespector',
     envvar='CODESPECTOR_OUTPUT_DIR',
+    default='codespector',
     show_envvar=True,
     help='Select the output directory',
 )
@@ -32,16 +44,13 @@ env.read_env(path=str(BASE_PATH / '.env'))
     '-b',
     '--compare-branch',
     type=str,
-    default='develop',
     help='Select the branch to compare the current one with',
 )
 @click.option(
     '--chat-agent',
-    type=click.Choice(['codestral', 'chatgpt'], case_sensitive=False),
     envvar='CODESPECTOR_CHAT_AGENT',
     show_envvar=True,
-    default='codestral',
-    help='Choose the chat agent to use',
+    help='Choose the chat agent to use you can use one from [codestral, chatgpr, deepseek]. Or set yours chat agent',
 )
 @click.option(
     '--chat-model',
@@ -56,25 +65,11 @@ env.read_env(path=str(BASE_PATH / '.env'))
     envvar='CODESPECTOR_CHAT_TOKEN',
     show_envvar=True,
 )
-@click.option(
-    '--mode',
-    type=click.Choice(['local'], case_sensitive=False),
-    default='local',
-    help='Choose the mode of the application',
-)
 @click.version_option(message='%(version)s')
 @click.command()
 def main(*args, **kwargs):
-    return start(*args, **kwargs)
-
-
-def start(*args, **kwargs):
-    codespector = CodeSpectorController(*args, **kwargs)
-    try:
-        codespector.start()
-        logger.info('Review completed successfully.See result.txt in {} directory', kwargs['output_dir'])
-    except Exception as e:
-        logger.error('Error while review: {}', e)
+    codespector = CodeSpector.create(*args, **kwargs)
+    codespector.review()
 
 
 if __name__ == '__main__':

codespector/reviewer.py

@@ -0,0 +1,84 @@
+import os.path
+
+import json
+from urllib.error import HTTPError
+
+import requests
+
+from loguru import logger
+
+from codespector.errors import AppError
+from codespector.types import AgentInfo
+
+
+class CodeSpectorReviewer:
+    def __init__(
+        self,
+        diff_file: str,
+        chat_token: str,
+        chat_agent: str,
+        chat_model: str,
+        system_content: str,
+        prompt_content: str,
+        output_dir: str,
+        result_file: str,
+        agent_info: AgentInfo,
+    ):
+        self.diff_file = diff_file
+        self.chat_token = chat_token
+        self.chat_agent = chat_agent
+        self.chat_model = chat_model
+        self.system_content = system_content
+        self.prompt_content = prompt_content
+        self.output_dir = output_dir
+        self.result_file = result_file
+        self.agent_info = agent_info
+
+        self.request_file = 'request.json'
+        self.response_file = 'response.json'
+
+    def _request_to_chat_agent(self, prompt: str):
+        request_data = {
+            'model': self.agent_info.model,
+            'messages': [{'role': 'system', 'content': self.system_content}, {'role': 'user', 'content': prompt}],
+        }
+
+        with open(os.path.join(self.output_dir, self.request_file), 'w', encoding='utf-8') as f:
+            json.dump(request_data, f, indent=4, ensure_ascii=False)
+
+        response = requests.post(
+            self.agent_info.url,
+            json=request_data,
+            headers=self.agent_info.headers,
+            timeout=100,
+        )
+        response.raise_for_status()
+        return response
+
+    def send_to_review(self):
+        with open(os.path.join(self.output_dir, self.diff_file), 'r', encoding='utf-8') as f:
+            diff_data = json.load(f)
+
+        diff_content = diff_data.get('diff', '')
+        original_files = diff_data.get('original files', [])
+
+        original_files_str = json.dumps(original_files, indent=4, ensure_ascii=False)
+
+        prompt = f'{self.prompt_content}\n\nDIFF:\n{diff_content}\n\nORIGINAL FILES:\n{original_files_str}'
+        try:
+            response = self._request_to_chat_agent(prompt=prompt)
+        except HTTPError as e:
+            logger.error('Error while send request: {}', e)
+            raise AppError('Error while send request') from e
+
+        with open(os.path.join(self.output_dir, self.response_file), 'w', encoding='utf-8') as f:
+            json.dump(response.json(), f, indent=4, ensure_ascii=False)
+
+        resp = response.json()
+        clear_response = resp['choices'][0]['message']['content']
+
+        with open(os.path.join(self.output_dir, self.result_file), 'w', encoding='utf-8') as f:
+            f.write(clear_response)
+
+    def start(self):
+        self.send_to_review()

codespector/types.py

@@ -0,0 +1,50 @@
+from dataclasses import dataclass
+from loguru import logger
+from codespector.errors import NotValidCfgError
+
+AGENT_URL_MAPPING = {
+    'codestral': 'https://api.mistral.ai/v1/chat/completions',
+    'chatgpt': 'https://api.openai.com/v1/chat/completions',
+    'deepseek': 'https://api.deepseek.com/v1/chat/completions',
+}
+
+DEFAULT_AGENT_MODEL = {
+    'codestral': 'codestral-latest',
+    'chatgpt': 'gpt-4o',
+    'deepseek': 'deepseek-chat',
+}
+
+
+@dataclass
+class AgentInfo:
+    model: str
+    url: str
+    headers: dict
+
+    @classmethod
+    def create(
+        cls,
+        chat_agent: str,
+        chat_token: str,
+        chat_model: str | None = None,
+        completion_url: str | None = None,
+    ) -> 'AgentInfo':
+        if completion_url:
+            url = completion_url
+        else:
+            url = AGENT_URL_MAPPING.get(chat_agent)
+
+        if chat_model:
+            model = chat_model
+        else:
+            model = DEFAULT_AGENT_MODEL.get(chat_agent)
+
+        if model is None or url is None:
+            raise NotValidCfgError('Invalid chat model or completions url')
+
+        headers = {'Authorization': f'Bearer {chat_token}'}
+        return cls(
+            url=url,
+            model=model,
+            headers=headers,
+        )

{codespector-0.1.2.dist-info → codespector-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codespector
-Version: 0.1.2
+Version: 0.2.0
 Summary: Assistant for reviewing your code
 Project-URL: Repository, https://github.com/Vladimir-Titov/codespector
 Project-URL: Issues, https://github.com/Vladimir-Titov/codespector/issues
@@ -15,7 +15,6 @@ Requires-Dist: click>=8.1.8
 Requires-Dist: environs>=14.1.1
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: requests>=2.32.3
-Requires-Dist: ujson>=5.10.0
 Description-Content-Type: text/markdown
 
 # CodeSpector

codespector-0.2.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+codespector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+codespector/base.py,sha256=uPoJ8h0Dlna-eUXyyD9s7uaQ4z0pS6qPdQMeu10muEk,159
+codespector/codespector.py,sha256=qW9G3arSq3VzWxdvPP4uCMNFfWFd7HBqs8M8dQsOAHU,2588
+codespector/errors.py,sha256=Z5W6i7iG_iBj_IfdSZ_f9jij0oPxTZ2Cxs87kzk3oyU,377
+codespector/local.py,sha256=aEq1YBm4fAFywpwmTaAdpM0_C2RHuIFDmAKikUZkmtQ,2800
+codespector/main.py,sha256=dfCds8mEIVb7mHVoczijnceIOd94I9yJc-8ZWaXcllo,1707
+codespector/reviewer.py,sha256=WoKRO-bFFLKNUiWB_TWoK0rRjenHkJ5fej_lhcj_e2Q,2740
+codespector/types.py,sha256=i5PFazyUc5rVq5Fhn4_FsG7R1l617vyjByvnixDUw1Y,1255
+codespector-0.2.0.dist-info/METADATA,sha256=YNuCT3bCxjyw46_gFGQdqwTwTOhswYWMqFRTF7eFXD0,3131
+codespector-0.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+codespector-0.2.0.dist-info/entry_points.txt,sha256=QlHn96KY8vzY1sOweKIuZOAQrSVse6h3v57vkwmHmJg,54
+codespector-0.2.0.dist-info/licenses/LICENSE,sha256=Eta34ENUL_dZWy-prVNucMkoA38WIqiO9pKTUYiuT_A,1070
+codespector-0.2.0.dist-info/RECORD,,

codespector/clients/codestral.py

@@ -1,5 +0,0 @@
-import ujson
-
-
-def chat_completion(diff: str):
-    pass

codespector/controller.py

@@ -1,44 +0,0 @@
-from codespector import local
-from loguru import logger
-
-
-class CodeSpectorController:
-    __slots__ = (
-        'mode',
-        'chat_token',
-        'chat_agent',
-        'compare_branch',
-        'output_dir',
-        'system_content',
-        'chat_model',
-    )
-
-    def __init__(
-        self,
-        mode: str,
-        chat_token: str,
-        chat_agent: str,
-        compare_branch: str,
-        output_dir: str,
-        system_content: str,
-        chat_model: str,
-    ):
-        self.mode = mode
-        self.chat_token = chat_token
-        self.chat_agent = chat_agent
-        self.compare_branch = compare_branch
-        self.output_dir = output_dir
-        self.system_content = system_content
-        self.chat_model = chat_model
-
-    def start(self):
-        codespector = local.LocalCodespector(
-            chat_token=self.chat_token,
-            chat_agent=self.chat_agent,
-            compare_branch=self.compare_branch,
-            output_dir=self.output_dir,
-            system_content=self.system_content,
-            chat_model=self.chat_model,
-        )
-        codespector.review()
-        logger.info('Review completed successfully.See result.txt in {} directory', self.output_dir)

codespector/local/__init__.py

@@ -1 +0,0 @@
-from .main import LocalCodespector

codespector/local/main.py

@@ -1,35 +0,0 @@
-from .prepare import CodeSpectorDataPreparer
-from .reviewer import CodeSpectorReviewer
-
-
-class LocalCodespector:
-    def __init__(
-        self,
-        chat_token: str,
-        chat_agent: str,
-        compare_branch: str,
-        output_dir: str,
-        system_content: str,
-        chat_model: str,
-    ):
-        self.chat_token = chat_token
-        self.chat_agent = chat_agent
-        self.compare_branch = compare_branch
-        self.output_dir = output_dir
-        self.system_content = system_content
-        self.chat_model = chat_model
-
-        self.data_preparer = CodeSpectorDataPreparer(output_dir=self.output_dir, compare_branch=self.compare_branch)
-        self.reviewer = CodeSpectorReviewer(
-            diff_file=self.data_preparer.combined_file,
-            chat_token=self.chat_token,
-            chat_agent=self.chat_agent,
-            system_content=self.system_content,
-            output_dir=self.output_dir,
-            chat_model=self.chat_model,
-        )
-        self.processes = [self.data_preparer, self.reviewer]
-
-    def review(self):
-        for process in self.processes:
-            process.start()

codespector/local/reviewer.py

@@ -1,108 +0,0 @@
-import os.path
-from dataclasses import dataclass
-
-import ujson
-import requests
-
-from loguru import logger
-
-AGENT_URL_MAPPING = {
-    'codestral': 'https://api.mistral.ai/v1/chat/completions',
-    'chatgpt': 'https://api.openai.com/v1/chat/completions',
-}
-
-DEFAULT_AGENT_MODEL = {'codestral': 'codestral-latest', 'chatgpt': 'gpt-4o'}
-
-
-@dataclass
-class AgentInfo:
-    model: str
-    url: str
-    headers: dict
-
-    @classmethod
-    def create(cls, chat_agent: str, chat_token: str, chat_model: str | None = None) -> 'AgentInfo':
-        url = AGENT_URL_MAPPING[chat_agent]
-        model = chat_model if chat_model else DEFAULT_AGENT_MODEL[chat_agent]
-        headers = {'Authorization': f'Bearer {chat_token}'}
-        return cls(
-            url=url,
-            model=model,
-            headers=headers,
-        )
-
-
-class CodeSpectorReviewer:
-    def __init__(
-        self,
-        diff_file: str,
-        chat_token: str,
-        chat_agent: str,
-        chat_model: str | None,
-        system_content: str,
-        output_dir: str,
-    ):
-        self.diff_file = diff_file
-        self.chat_token = chat_token
-        self.chat_agent = chat_agent
-        self.chat_model = chat_model
-        self.system_content = system_content
-        self.output_dir = output_dir
-
-        self.request_file = 'request.json'
-        self.response_file = 'response.json'
-        self.result_file = 'result.md'
-
-    def _request_to_chat_agent(self, prompt: str):
-        agent_info = AgentInfo.create(self.chat_agent, self.chat_token, self.chat_model)
-        request_data = {
-            'model': agent_info.model,
-            'messages': [{'role': 'system', 'content': self.system_content}, {'role': 'user', 'content': prompt}],
-        }
-
-        with open(os.path.join(self.output_dir, self.request_file), 'w', encoding='utf-8') as f:
-            ujson.dump(request_data, f, indent=4, ensure_ascii=False)
-
-        response = requests.post(
-            agent_info.url,
-            json=request_data,
-            headers=agent_info.headers,
-            timeout=100,
-        )
-        response.raise_for_status()
-        return response
-
-    def send_to_review(self):
-        with open(os.path.join(self.output_dir, self.diff_file), 'r', encoding='utf-8') as f:
-            diff_data = ujson.load(f)
-
-        diff_content = diff_data.get('diff', '')
-        original_files = diff_data.get('original files', [])
-
-        original_files_str = ujson.dumps(original_files, indent=4, ensure_ascii=False)
-
-        prompt = (
-            'Пожалуйста, проверь следующие изменения в коде на наличие очевидных проблем с качеством или безопасностью. '
-            'Предоставь краткий отчет в формате markdown:\n\n'
-            'DIFF:\n'
-            f'{diff_content}\n\n'
-            'ORIGINAL FILES:\n'
-            f'{original_files_str}'
-        )
-        try:
-            response = self._request_to_chat_agent(prompt=prompt)
-        except Exception as e:
-            logger.error('Error while send request: {}', e)
-            raise e
-
-        with open(os.path.join(self.output_dir, self.response_file), 'w', encoding='utf-8') as f:
-            ujson.dump(response.json(), f, indent=4, ensure_ascii=False)
-
-        resp = response.json()
-        clear_response = resp['choices'][0]['message']['content']
-
-        with open(os.path.join(self.output_dir, self.result_file), 'w', encoding='utf-8') as f:
-            f.write(clear_response)
-
-    def start(self):
-        self.send_to_review()

codespector-0.1.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-codespector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-codespector/controller.py,sha256=z7TznOY6SBXCirBFpRO4bSh0_XY3gjMjUmnlFDkkc7Q,1211
-codespector/main.py,sha256=y_mij-Tj_LaFQ2DUn8wAKJLKYy60jvb162UBnI1QWGM,1950
-codespector/clients/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-codespector/clients/codestral.py,sha256=MV6_m9IMYzTHX5AS9UoPkhGUNHRoOXgIpTZ8uHfwZgQ,56
-codespector/local/__init__.py,sha256=spdqmAUYVjE-6RJUNUQ63ymwBY3svwC1gQp5QHAZdwg,35
-codespector/local/main.py,sha256=JQb8mBQEjxsjNnjpqCOP84ZF92T2DjTzCslRdHQLqlg,1136
-codespector/local/prepare.py,sha256=uqQft4RDH_5Rms3fGROc_fzCCRVcu-BxDzCAVF16buo,2821
-codespector/local/reviewer.py,sha256=bsbdwXMhkyXMfIp55u5a8JRyndO-kjqzlQBVeoLdgMQ,3593
-codespector-0.1.2.dist-info/METADATA,sha256=BWtpEmWdlrwRRYPVeig0RFtYTNx1dDXqmeGMGRplH2w,3160
-codespector-0.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-codespector-0.1.2.dist-info/entry_points.txt,sha256=QlHn96KY8vzY1sOweKIuZOAQrSVse6h3v57vkwmHmJg,54
-codespector-0.1.2.dist-info/licenses/LICENSE,sha256=Eta34ENUL_dZWy-prVNucMkoA38WIqiO9pKTUYiuT_A,1070
-codespector-0.1.2.dist-info/RECORD,,