Added UNIFY_KEY secret to tests.yml and fixed flake8erros

.github/workflows/tests.yml

@@ -63,3 +63,5 @@ jobs:
         poetry install --with dev
     - name: Run unit tests
       run: poetry run python -m unittest discover
+      env:
+        UNIFY_KEY: ${{ secrets.UNIFY_KEY }}

unify/clients.py

@@ -5,7 +5,7 @@
 from unify.exceptions import UnifyError, status_error_map
 
 
-def validate_api_key(api_key: Optional[str]) -> str:
+def _validate_api_key(api_key: Optional[str]) -> str:
     if api_key is None:
         api_key = os.environ.get("UNIFY_KEY")
     if api_key is None:
@@ -21,19 +21,19 @@ class Unify:
     def __init__(
         self,
         api_key: Optional[str] = None,
-    ) -> None:
+    ) -> None:  # noqa: DAR101, DAR401
         """Initialize the Unify client.
 
         Args:
             api_key (str, optional): API key for accessing the Unify API.
-            If None, it attempts to retrieve the API key from the
-            environment variable UNIFY_KEY.
-            Defaults to None.
+                If None, it attempts to retrieve the API key from the
+                environment variable UNIFY_KEY.
+                Defaults to None.
 
         Raises:
             UnifyError: If the API key is missing.
         """
-        self.api_key = validate_api_key(api_key)
+        self.api_key = _validate_api_key(api_key)
         try:
             self.client = openai.OpenAI(
                 base_url="https://api.unify.ai/v0/",
@@ -42,23 +42,23 @@ def __init__(
         except openai.OpenAIError as e:
             raise UnifyError(f"Failed to initialize Unify client: {str(e)}")
 
-    def generate(
+    def generate(  # noqa: WPS234
         self,
         messages: Union[str, List[Dict[str, str]]],
         model: str = "llama-2-13b-chat",
         provider: str = "anyscale",
         stream: bool = False,
-    ) -> Union[Generator[str, None, None], str]:
+    ) -> Union[Generator[str, None, None], str]:  # noqa: DAR101, DAR201
         """Generate content using the Unify API.
 
         Args:
             messages (Union[str, List[Dict[str, str]]]): A single prompt as a
-              string or a dictionary containing the conversation history.
+            string or a dictionary containing the conversation history.
             model (str): The name of the model. Defaults to "llama-2-13b-chat".
             provider (str): The provider of the model. Defaults to "anyscale".
             stream (bool): If True, generates content as a stream.
-              If False, generates content as a single response.
-              Defaults to False.
+            If False, generates content as a single response.
+            Defaults to False.
 
         Returns:
             Union[Generator[str, None, None], str]: If stream is True,
@@ -108,7 +108,7 @@ def _generate_non_stream(
                 messages=messages,  # type: ignore[arg-type]
                 stream=False,
             )
-            return chat_completion.choices[0].message.content.strip(" ")  # type: ignore # noqa: E501
+            return chat_completion.choices[0].message.content.strip(" ")  # type: ignore # noqa: E501, WPS219
         except openai.APIStatusError as e:
             raise status_error_map[e.status_code](e.message) from None
 
@@ -119,7 +119,7 @@ class AsyncUnify:
     def __init__(
         self,
         api_key: Optional[str] = None,
-    ) -> None:
+    ) -> None:  # noqa:DAR101, DAR401
         """Initialize the AsyncUnify client.
 
         Args:
@@ -131,7 +131,7 @@ def __init__(
         Raises:
             UnifyError: If the API key is missing.
         """
-        self.api_key = validate_api_key(api_key)
+        self.api_key = _validate_api_key(api_key)
         try:
             self.client = openai.AsyncOpenAI(
                 base_url="https://api.unify.ai/v0/",
@@ -140,28 +140,28 @@ def __init__(
         except openai.APIStatusError as e:
             raise UnifyError(f"Failed to initialize Unify client: {str(e)}")
 
-    async def generate(
+    async def generate(  # noqa: WPS234
         self,
         messages: Union[str, List[Dict[str, str]]],
         model: str = "llama-2-13b-chat",
         provider: str = "anyscale",
         stream: bool = False,
-    ) -> Union[AsyncGenerator[str, None], str]:
+    ) -> Union[AsyncGenerator[str, None], str]:  # noqa: DAR101, DAR201
         """Generate content asynchronously using the Unify API.
 
         Args:
             messages (Union[str, List[Dict[str, str]]]): A single prompt as a string
-              or a dictionary containing the conversation history.
+            or a dictionary containing the conversation history.
             model (str): The name of the model.
             provider (str): The provider of the model.
             stream (bool): If True, generates content as a stream.
             If False, generates content as a single response.
-             Defaults to False.
+            Defaults to False.
 
         Returns:
             Union[AsyncGenerator[str, None], List[str]]: If stream is True,
             returns an asynchronous generator yielding chunks of content.
-              If stream is False, returns a list of string responses.
+            If stream is False, returns a list of string responses.
 
         Raises:
             UnifyError: If an error occurs during content generation.
@@ -206,6 +206,6 @@ async def _generate_non_stream(
                     messages=messages,  # type: ignore[arg-type]
                     stream=False,
                 )
-            return async_response.choices[0].message.content.strip(" ")  # type: ignore # noqa: E501
+            return async_response.choices[0].message.content.strip(" ")  # type: ignore # noqa: E501, WPS219
         except openai.APIStatusError as e:
             raise status_error_map[e.status_code](e.message) from None

unify/exceptions.py

@@ -1,37 +1,37 @@
 class UnifyError(Exception):
-    pass
+    """Base class for all custom exceptions in the Unify application."""
 
 
 class BadRequestError(UnifyError):
-    pass
+    """Exception raised for HTTP 400 Bad Request errors."""
 
 
 class AuthenticationError(UnifyError):
-    pass
+    """Exception raised for HTTP 401 Unauthorized errors."""
 
 
 class PermissionDeniedError(UnifyError):
-    pass
+    """Exception raised for HTTP 403 Forbidden errors."""
 
 
 class NotFoundError(UnifyError):
-    pass
+    """Exception raised for HTTP 404 Not Found errors."""
 
 
 class ConflictError(UnifyError):
-    pass
+    """Exception raised for HTTP 409 Conflict errors."""
 
 
 class UnprocessableEntityError(UnifyError):
-    pass
+    """Exception raised for HTTP 422 Unprocessable Entity errors."""
 
 
 class RateLimitError(UnifyError):
-    pass
+    """Exception raised for HTTP 429 Too Many Requests errors."""
 
 
 class InternalServerError(UnifyError):
-    pass
+    """Exception raised for HTTP 500 Internal Server Error errors."""
 
 
 status_error_map = {