Merge pull request #108 from hand-e-fr/dev

Dev

Author: MerlinDEVILLARD

CHAGELOG.md

@@ -4,6 +4,18 @@ All significant changes to this project will be documented in this file.
 
 ---
 
+## **v1.1rc3**
+
+- **Fixes**
+  - `emulate` now works when emulated function is called inside another one
+  - `emulate` works now with `lru_cache` decorator from `functools` module 
+
+- **Internal**
+  - Added custom Exception classes for request and frame errors.
+  - Added a loop to find the frame in `_extend_scope`
+  - Added a Makefile for cleaning and packaging and tests
+---
+
 ## **v1.1** 13/09/2024
 
 - **Fixes**
@@ -39,6 +51,11 @@ All significant changes to this project will be documented in this file.
 - **Internal**
   - Functional tests have been added for each of the library's features
 
+- **Doc**
+  - Documentation now integrates Google Cobal link
+
+---
+
 ## **v1.0** 29/08/2024:
 
 - **Features**

Makefile

@@ -1,47 +1,117 @@
-PACKAGE_NAME = OpenHosta
-SRC_DIR = src/OpenHosta
-TEST_DIR = tests
-DOC_DIR = doc
+PACKAGE_NAME := OpenHosta
+SRC_DIR := src/OpenHosta
+TEST_DIR := tests
+DOC_DIR := doc
+API_KEY =
+TAG := "-==[OpenHosta]==- \>\>\>"
+
+ifeq ($(OS),Windows_NT)
+    DETECTED_OS := Windows
+    NULL_DEVICE := NUL
+    PYTHON := python
+    PIP := pip
+    L_SHELL := powershell -Command
+    PYTEST := & C:\\Users\\Merlin\\AppData\\Roaming\\Python\\Python312\\Scripts\\pytest.exe
+    ENV := $$env:
+    WRITE := "Write-Host
+	COLOR := -ForegroundColor DarkMagenta"
+	FIND := "Get-ChildItem -Path . -Recurse -Directory -Filter
+	RM := Remove-Item -Recurse -Force"
+	CLEAR := "clear"
+	CLEAR_DATA = type NUL > $(REDIRECT)
+	MKDIR := New-Item -ItemType Directory -Force -Path 
+else
+    DETECTED_OS := Linux
+    NULL_DEVICE := /dev/null
+    PYTHON := python3
+    PIP := pip3
+    L_SHELL :=
+    PYTEST := pytest
+    ENV := export
+    WRITE := echo
+	COLOR :=
+	FIND := find
+	RM := rm -rf
+	CLEAR := clear
+	CLEAR_DATA = > $(REDIRECT)
+	MKDIR := mkdir
+endif
 
 all: help
 
 help:
 	@echo Usage:
 	@echo 	make help             Show this help message
 	@echo  	make package          Package the project for pip installation
-	@echo  	make tests            Run the tests
+	@echo  	make *tests            Run the tests
 	@echo  	make format           Format the code using black
 	@echo  	make lint             Check code quality using flake8
 	@echo  	make clean            Clean not necessary files
 
+install: all
+	@$(L_SHELL) $(WRITE) '$(TAG) [INSTALL]' $(COLOR)
+	@$(L_SHELL) $(WRITE) '$(TAG) Installing dependencies...' $(COLOR)
+	@$(PIP) install requirements.txt > $(NULL_DEVICE)
+	@$(PIP) install requirements-dev.txt > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Installing package: $(PACKAGE_NAME)...' $(COLOR)
+	@$(PIP) install . > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Succesfully installed $(PACKAGE_NAME) !' $(COLOR)
+
 build:
-	python -m build
-	python -m twine check dist/*
+	$(PYTHON) -m build
+	$(PYTHON) -m twine check dist/*
 
-upload:
-	python -m twine upload dist/*
+upload: build
+	$(PYTHON) -m twine upload dist/*
 
-tests:
-	pip install . 
-	pytest .\tests\functionnalTests\test_mandatory.py -v
-	pip uninstall -y OpenHosta
+ftests: clean
+	@$(L_SHELL) $(WRITE) '$(TAG) Installing package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) install . > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Running functionnal tests...' $(COLOR) 
+	@$(L_SHELL) $(SET_ENV)
+	@-$(L_SHELL) "$(PYTEST) .\\tests\\functionnalTests\\test_mandatory.py $(ARGS)"
+	@$(L_SHELL) $(UNSET_ENV)
+	@$(L_SHELL) $(WRITE) '$(TAG) Uninstalling package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) uninstall -y OpenHosta > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Succesfully ran functionnal tests !' $(COLOR)
 
-format:
-	black $(SRC_DIR)
+utests: clean
+	@$(L_SHELL) $(WRITE) '$(TAG) Installing package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) install . > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Running unit tests...' $(COLOR) 
+	@$(L_SHELL) $(SET_ENV)
+	@-$(L_SHELL) "$(PYTEST) .\\tests\\unitTests\\test_exec.py $(ARGS)"
+	@$(L_SHELL) $(UNSET_ENV)
+	@$(L_SHELL) $(WRITE) '$(TAG) Uninstalling package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) uninstall -y OpenHosta > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Succesfully ran unit tests !' $(COLOR)
 
-lint:
-	flake8 $(SRC_DIR) $(TEST_DIR)
 
 clean:
-	rm -rf build dist *.egg-info
-	find . -name "__pycache__" -exec rm -rf {} +
-	find . -name "__hostacache__" -exec rm -rf {} +
+	@$(L_SHELL) $(WRITE) '$(TAG) [CLEAN]' $(COLOR)
+	@$(L_SHELL) $(WRITE) '$(TAG) Cleaning repository...' $(COLOR)
+	@$(L_SHELL) $(FIND) '__pycache__' | $(RM)
+	@$(L_SHELL) $(FIND) '__hostacache__' | $(RM)
+	@$(L_SHELL) $(FIND) 'build' | $(RM)
+	@$(L_SHELL) $(FIND) 'dist' | $(RM)
+	@$(L_SHELL) $(FIND) 'OpenHosta.egg-info' | $(RM)
+	@$(L_SHELL) $(FIND) '.pytest_cache' | $(RM)
+	@$(L_SHELL) $(WRITE) '$(TAG) Uninstalling package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) uninstall -y OpenHosta > $(NULL_DEVICE)
+	@$(L_SHELL) $(CLEAR)
+	@$(L_SHELL) $(WRITE) '$(TAG) Succesfully cleaned repository !' $(COLOR)
+
+format: clean
+	@black $(SRC_DIR) $(ARGS)
 
-fclean: clean
-	rm -rf .pytest_cache .mypy_cache
+lint: format
+	@flake8 $(SRC_DIR) $(ARGS)
 
-make re:
-	pip uninstall -y OpenHosta
-	pip install ..
+re: clean
+	@$(L_SHELL) $(WRITE) '$(TAG) Uninstalling package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) uninstall -y OpenHosta > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Installing package: $(PACKAGE_NAME)...' $(COLOR) 
+	@$(PIP) install . > $(NULL_DEVICE)
+	@$(L_SHELL) $(WRITE) '$(TAG) Succesfully updated package !' $(COLOR)
 
-.PHONY: all help build tests format lint clean fclean re
+.PHONY: all help build upload ftests utests format lint clean re install

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "OpenHosta"
-version = "1.1.0-rc2"
+version = "1.1.0-rc3"
 description = "Open-Source programming project IA integretion in developement environnement"
 keywords = ["AI", "GPT", "Natural language", "Autommatic", "Easy"]
 authors = [

requirements-dev.txt

@@ -6,6 +6,8 @@
 from pydantic import BaseModel
 from typing import get_origin, get_args
 
+from .errors import ApiKeyError
+
 
 def is_valid_url(url):
     regex = re.compile(
@@ -57,9 +59,9 @@ def __str__(self) -> str:
 
     def api_call(
         self, sys_prompt: str, user_prompt: str, creativity: float, diversity: float
-    ):
+    )->requests.models.Response:
         if self.api_key is None or not self.api_key:
-            raise AttributeError("Empty API key.")
+            raise ApiKeyError("Empty API key.")
 
         l_body = {
             "model": self.model,
@@ -86,11 +88,12 @@ def api_call(
             response = requests.post(self.base_url, json=l_body, headers=headers)
             response.raise_for_status()
         except requests.exceptions.RequestException as e:
-            sys.stderr.write(f"[CALL_ERROR] Request failed: {e}\n")
+            sys.stderr.write(f"\n[CALL_ERROR] Request failed:\n{e}\n\n")
         if response.status_code != 200:
-            sys.stderr.write(
-                f"[CALL_ERROR] API call the request was unsuccessful. Status code: {response.status_code}:\n{response.text}"
-            )
+            if "invalid_api_key" in str(response.text):
+                raise ApiKeyError("Incorrect API key.")
+            else:    
+                sys.stderr.write(f"[CALL_ERROR] API call was unsuccessful.\nStatus code: {response.status_code}:\n{response.text}")
         return response
 
     def request_handler(self, response, return_type, return_caller):

requirements.txt

@@ -1,4 +1,5 @@
 import sys
+import inspect
 
 from .prompt import PromptMananger
 from .config import Model, DefaultManager
@@ -11,12 +12,12 @@
 l_default = DefaultManager.get_default_model()
 
 
-def build_user_prompt(_function_infos: dict = None):
-    function_doc = _function_infos["function_def"]
-    function_call = _function_infos["function_call"]
-    function_return = _function_infos["return_type"]
-    function_example = _function_infos["ho_example"]
-    function_locals = _function_infos["function_locals"]
+def build_user_prompt(_infos: dict = None):
+    function_doc = _infos["function_def"]
+    function_call = _infos["function_call"]
+    function_return = _infos["return_type"]
+    function_example = _infos["ho_example"]
+    function_locals = _infos["function_locals"]
 
     user_prompt = (
         "Here's the function definition:\n"
@@ -50,16 +51,16 @@ def build_user_prompt(_function_infos: dict = None):
 
 
 def _exec_emulate(
-    _function_infos: dict = None,
-    _function_obj: object = None,
+    _infos: dict = None,
+    _obj: object = None,
     model: Model = None,
     l_creativity: float = None,
     l_diversity: float = None,
 ):
     global _emulator_pre_prompt
 
-    _function_return_caller = _function_infos["return_caller"]
-    _function_return = _function_infos["return_type"]
+    _function_return_caller = _infos["return_caller"]
+    _function_return = _infos["return_type"]
 
     if model is None:
         model = DefaultManager.get_default_model()
@@ -75,7 +76,7 @@ def _exec_emulate(
         sys.stderr.write(f"[EMULATE_ERROR]: {v}")
         return None
 
-    l_user_prompt = build_user_prompt(_function_infos)
+    l_user_prompt = build_user_prompt(_infos)
 
     response = model.api_call(
         sys_prompt=_emulator_pre_prompt,
@@ -84,8 +85,8 @@ def _exec_emulate(
         diversity=l_diversity,
     )
 
-    if _function_obj is not None and "bound method" not in str(_function_obj):
-        setattr(_function_obj, "_last_response", response.json())
+    if _obj is not None and inspect.isfunction(_obj):
+        setattr(_obj, "_last_response", response.json())
 
 
     if response.status_code == 200:
@@ -97,7 +98,7 @@ def _exec_emulate(
         sys.stderr.write(f"Error {response.status_code}: {response.text}")
         l_ret = None
 
-    if _function_obj is not None and "bound method" not in str(_function_obj):
-        setattr(_function_obj, "_last_request", f"{_emulator_pre_prompt}\n{l_user_prompt}")
+    if _obj is not None and inspect.isfunction(_obj):
+        setattr(_obj, "_last_request", f"{_emulator_pre_prompt}\n{l_user_prompt}")
 
     return l_ret

src/OpenHosta/config.py

@@ -1,10 +1,30 @@
-class OhCustomError(Exception):
-    """Base class for other customs exceptions"""
+from typing import Literal
 
-    pass
+__all__ = (
+    "RequestError",
+    "ApiKeyError",
+    "FrameError"
+)
 
+OhErrorCodes = Literal[
+    ""
+]
 
-class RequestError(OhCustomError):
-    """Raised when a request to a llm went wrong"""
+class OhErrorMixin(Exception):
+    """ Base class for other customs exceptions """
+    def __init__(self, message:str):
+        super().__init__(message)
+        self.message = message
+        
+    def __str__(self)->str:
+        return f"{self.message}\n"
+    
+class RequestError(OhErrorMixin):
+    """ Raised when a request to a llm went wrong """
 
-    pass
+class ApiKeyError(RequestError):
+    """ Raised when API key is missing or incorrect """
+
+class FrameError(OhErrorMixin):
+    """ Raised when the frame inspection fail """
+