From 5756586cde6ed6da147119113fb5a5fd640d5f83 Mon Sep 17 00:00:00 2001
From: Heiner Lohaus <hlohaus@users.noreply.github.com>
Date: Sun, 14 Jan 2024 07:45:41 +0100
Subject: Refactor code with AI Add doctypes to many functions Add file upload
 for text files Add alternative url to FreeChatgpt Add webp to allowed image
 types

---
 g4f/base_provider.py | 81 +++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 71 insertions(+), 10 deletions(-)

(limited to 'g4f/base_provider.py')

diff --git a/g4f/base_provider.py b/g4f/base_provider.py
index 1863f6bc..03ae64d6 100644
--- a/g4f/base_provider.py
+++ b/g4f/base_provider.py
@@ -1,7 +1,22 @@
 from abc import ABC, abstractmethod
-from .typing import Messages, CreateResult, Union
-    
+from typing import Union, List, Dict, Type
+from .typing import Messages, CreateResult
+
 class BaseProvider(ABC):
+    """
+    Abstract base class for a provider.
+
+    Attributes:
+        url (str): URL of the provider.
+        working (bool): Indicates if the provider is currently working.
+        needs_auth (bool): Indicates if the provider needs authentication.
+        supports_stream (bool): Indicates if the provider supports streaming.
+        supports_gpt_35_turbo (bool): Indicates if the provider supports GPT-3.5 Turbo.
+        supports_gpt_4 (bool): Indicates if the provider supports GPT-4.
+        supports_message_history (bool): Indicates if the provider supports message history.
+        params (str): List parameters for the provider.
+    """
+
     url: str = None
     working: bool = False
     needs_auth: bool = False
@@ -20,6 +35,18 @@ class BaseProvider(ABC):
         stream: bool,
         **kwargs
     ) -> CreateResult:
+        """
+        Create a completion with the given parameters.
+
+        Args:
+            model (str): The model to use.
+            messages (Messages): The messages to process.
+            stream (bool): Whether to use streaming.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            CreateResult: The result of the creation process.
+        """
         raise NotImplementedError()
 
     @classmethod
@@ -30,25 +57,59 @@ class BaseProvider(ABC):
         messages: Messages,
         **kwargs
     ) -> str:
+        """
+        Asynchronously create a completion with the given parameters.
+
+        Args:
+            model (str): The model to use.
+            messages (Messages): The messages to process.
+            **kwargs: Additional keyword arguments.
+
+        Returns:
+            str: The result of the creation process.
+        """
         raise NotImplementedError()
     
     @classmethod
-    def get_dict(cls):
+    def get_dict(cls) -> Dict[str, str]:
+        """
+        Get a dictionary representation of the provider.
+
+        Returns:
+            Dict[str, str]: A dictionary with provider's details.
+        """
         return {'name': cls.__name__, 'url': cls.url} 
     
 class BaseRetryProvider(BaseProvider):
+    """
+    Base class for a provider that implements retry logic.
+
+    Attributes:
+        providers (List[Type[BaseProvider]]): List of providers to use for retries.
+        shuffle (bool): Whether to shuffle the providers list.
+        exceptions (Dict[str, Exception]): Dictionary of exceptions encountered.
+        last_provider (Type[BaseProvider]): The last provider used.
+    """
+
     __name__: str = "RetryProvider"
     supports_stream: bool = True
 
     def __init__(
         self,
-        providers: list[type[BaseProvider]],
+        providers: List[Type[BaseProvider]],
         shuffle: bool = True
     ) -> None:
-        self.providers: list[type[BaseProvider]] = providers
-        self.shuffle: bool = shuffle
-        self.working: bool = True
-        self.exceptions: dict[str, Exception] = {}
-        self.last_provider: type[BaseProvider] = None
+        """
+        Initialize the BaseRetryProvider.
+
+        Args:
+            providers (List[Type[BaseProvider]]): List of providers to use.
+            shuffle (bool): Whether to shuffle the providers list.
+        """
+        self.providers = providers
+        self.shuffle = shuffle
+        self.working = True
+        self.exceptions: Dict[str, Exception] = {}
+        self.last_provider: Type[BaseProvider] = None
         
-ProviderType = Union[type[BaseProvider], BaseRetryProvider]
\ No newline at end of file
+ProviderType = Union[Type[BaseProvider], BaseRetryProvider]
\ No newline at end of file
-- 
cgit v1.2.3