webscout 8.2.6__py3-none-any.whl → 8.2.8__py3-none-any.whl

webscout/Provider/typefully.py

@@ -4,30 +4,14 @@ from uuid import uuid4
 
 from webscout.AIutel import Optimizers
 from webscout.AIutel import Conversation
-from webscout.AIutel import AwesomePrompts, sanitize_stream # Import sanitize_stream
+from webscout.AIutel import AwesomePrompts, sanitize_stream
 from webscout.AIbase import Provider
 from webscout import exceptions
 from webscout.litagent import LitAgent
-# Replace requests with curl_cffi
-from curl_cffi.requests import Session # Import Session
-from curl_cffi import CurlError # Import CurlError
+from curl_cffi.requests import Session
+from curl_cffi import CurlError
 
 class TypefullyAI(Provider):
-    """
-    A class to interact with the Typefully AI API.
-
-    Attributes:
-        system_prompt (str): The system prompt to define the assistant's role.
-        model (str): The model identifier to use for completions.
-        output_length (int): Maximum length of the generated output.
-
-    Examples:
-        >>> from webscout.Provider.typefully import TypefullyAI
-        >>> ai = TypefullyAI()
-        >>> response = ai.chat("What's the weather today?")
-        >>> print(response)
-        'The weather today is sunny with a high of 75°F.'
-    """
     AVAILABLE_MODELS = ["openai:gpt-4o-mini", "openai:gpt-4o", "anthropic:claude-3-5-haiku-20241022", "groq:llama-3.3-70b-versatile"]
 
     def __init__(
@@ -44,28 +28,6 @@ class TypefullyAI(Provider):
         system_prompt: str = "You're a helpful assistant.",
         model: str = "openai:gpt-4o-mini",
     ):
-        """
-        Initializes the TypefullyAI API with given parameters.
-
-        Args:
-            is_conversation (bool): Whether the provider is in conversation mode.
-            max_tokens (int): Maximum number of tokens to sample.
-            timeout (int): Timeout for API requests.
-            intro (str): Introduction message for the conversation.
-            filepath (str): Filepath for storing conversation history.
-            update_file (bool): Whether to update the conversation history file.
-            proxies (dict): Proxies for the API requests.
-            history_offset (int): Offset for conversation history.
-            act (str): Act for the conversation.
-            system_prompt (str): The system prompt to define the assistant's role.
-            model (str): The model identifier to use.
-
-        Examples:
-            >>> ai = TypefullyAI(system_prompt="You are a friendly assistant.")
-            >>> print(ai.system_prompt)
-            'You are a friendly assistant.'
-        """
-        # Initialize curl_cffi Session
         self.session = Session()
         self.is_conversation = is_conversation
         self.max_tokens_to_sample = max_tokens
@@ -75,10 +37,7 @@ class TypefullyAI(Provider):
         self.system_prompt = system_prompt
         self.model = model
         self.output_length = max_tokens
-
-        # Initialize LitAgent for user agent generation
         self.agent = LitAgent()
-
         self.headers = {
             "authority": "typefully.com",
             "accept": "*/*",
@@ -91,17 +50,15 @@ class TypefullyAI(Provider):
             "sec-ch-ua": '"Microsoft Edge";v="135", "Not-A.Brand";v="8", "Chromium";v="135"',
             "sec-ch-ua-mobile": "?0",
             "sec-ch-ua-platform": '"Windows"',
-            "user-agent": self.agent.random()  # Use LitAgent to generate a random user agent
+            "user-agent": self.agent.random()
         }
-
         self.__available_optimizers = (
             method
             for method in dir(Optimizers)
             if callable(getattr(Optimizers, method)) and not method.startswith("__")
         )
-        # Update curl_cffi session headers and proxies
         self.session.headers.update(self.headers)
-        self.session.proxies = proxies # Use proxies directly, not session.proxies.update
+        self.session.proxies = proxies
         Conversation.intro = (
             AwesomePrompts().get_act(
                 act, raise_not_found=True, default=None, case_insensitive=True
@@ -116,13 +73,13 @@ class TypefullyAI(Provider):
 
     @staticmethod
     def _typefully_extractor(chunk: Union[str, Dict[str, Any]]) -> Optional[str]:
-        """Extracts content from the Typefully stream format '0:"..."'."""
         if isinstance(chunk, str):
-            match = re.search(r'0:"(.*?)"(?=,|$)', chunk) # Look for 0:"...", possibly followed by comma or end of string
+            if isinstance(chunk, bytes):
+                chunk = chunk.decode('utf-8', errors='replace')
+            match = re.search(r'0:"(.*?)"', chunk)
             if match:
-                # Decode potential unicode escapes like \u00e9 and handle escaped quotes/backslashes
                 content = match.group(1).encode().decode('unicode_escape')
-                return content.replace('\\\\', '\\').replace('\\"', '"')
+                return content.replace('\\', '\\').replace('\\"', '"')
         return None
 
     def ask(
@@ -133,25 +90,6 @@ class TypefullyAI(Provider):
         optimizer: str = None,
         conversationally: bool = False,
     ) -> Dict[str, Any]:
-        """
-        Sends a prompt to the Typefully AI API and returns the response.
-
-        Args:
-            prompt (str): The prompt to send to the API.
-            stream (bool): Whether to stream the response.
-            raw (bool): Whether to return the raw response.
-            optimizer (str): Optimizer to use for the prompt.
-            conversationally (bool): Whether to generate the prompt conversationally.
-
-        Returns:
-            Dict[str, Any]: The API response.
-
-        Examples:
-            >>> ai = TypefullyAI()
-            >>> response = ai.ask("Tell me a joke!")
-            >>> print(response)
-            {'text': 'Why did the scarecrow win an award? Because he was outstanding in his field!'}
-        """
         conversation_prompt = self.conversation.gen_complete_prompt(prompt)
         if optimizer:
             if optimizer in self.__available_optimizers:
@@ -162,60 +100,49 @@ class TypefullyAI(Provider):
                 raise Exception(
                     f"Optimizer is not one of {self.__available_optimizers}"
                 )
-
         payload = {
             "prompt": conversation_prompt,
             "systemPrompt": self.system_prompt,
             "modelIdentifier": self.model,
             "outputLength": self.output_length
         }
-
         def for_stream():
-            try: # Add try block for CurlError
-                # Use curl_cffi session post with impersonate
+            try:
                 response = self.session.post(
                     self.api_endpoint, 
                     headers=self.headers, 
                     json=payload, 
                     stream=True, 
                     timeout=self.timeout,
-                    impersonate="chrome120" # Add impersonate
+                    impersonate="chrome120"
                 )
                 if not response.ok:
                     raise exceptions.FailedToGenerateResponseError(
                         f"Failed to generate response - ({response.status_code}, {response.reason}) - {response.text}"
                     )
                 streaming_text = ""
-                # Use sanitize_stream with the custom extractor
                 processed_stream = sanitize_stream(
-                    data=response.iter_content(chunk_size=None), # Pass byte iterator
-                    intro_value=None, # No simple prefix
-                    to_json=False,    # Content is not JSON
-                    content_extractor=self._typefully_extractor, # Use the specific extractor
-                    end_marker="e:", # Stop processing if "e:" line is encountered (adjust if needed)
+                    data=response.iter_content(chunk_size=None),
+                    intro_value=None,
+                    to_json=False,
+                    content_extractor=self._typefully_extractor,
                 )
-
                 for content_chunk in processed_stream:
                     if content_chunk and isinstance(content_chunk, str):
                         streaming_text += content_chunk
                         yield content_chunk if raw else dict(text=content_chunk)
-                # Update history and last response after stream finishes
                 self.last_response.update(dict(text=streaming_text))
                 self.conversation.update_chat_history(
                     prompt, self.get_message(self.last_response)
                 )
-            except CurlError as e: # Catch CurlError
+            except CurlError as e:
                 raise exceptions.FailedToGenerateResponseError(f"Request failed (CurlError): {e}")
-            except Exception as e: # Catch other potential exceptions
+            except Exception as e:
                 raise exceptions.FailedToGenerateResponseError(f"An unexpected error occurred ({type(e).__name__}): {e}")
-
         def for_non_stream():
-            # This function implicitly uses the updated for_stream
             for _ in for_stream():
                 pass
-            # Ensure last_response is updated by for_stream before returning
             return self.last_response 
-
         return for_stream() if stream else for_non_stream()
 
     def chat(
@@ -225,31 +152,11 @@ class TypefullyAI(Provider):
         optimizer: str = None,
         conversationally: bool = False,
     ) -> str:
-        """
-        Generates a response from the Typefully AI API.
-
-        Args:
-            prompt (str): The prompt to send to the API.
-            stream (bool): Whether to stream the response.
-            optimizer (str): Optimizer to use for the prompt.
-            conversationally (bool): Whether to generate the prompt conversationally.
-
-        Returns:
-            str: The API response.
-
-        Examples:
-            >>> ai = TypefullyAI()
-            >>> response = ai.chat("What's the weather today?")
-            >>> print(response)
-            'The weather today is sunny with a high of 75°F.'
-        """
-
         def for_stream():
             for response in self.ask(
                 prompt, True, optimizer=optimizer, conversationally=conversationally
             ):
                 yield self.get_message(response)
-
         def for_non_stream():
             return self.get_message(
                 self.ask(
@@ -259,72 +166,37 @@ class TypefullyAI(Provider):
                     conversationally=conversationally,
                 )
             )
-
         return for_stream() if stream else for_non_stream()
 
     def get_message(self, response: dict) -> str:
-        """
-        Extracts the message from the API response.
-
-        Args:
-            response (dict): The API response.
-
-        Returns:
-            str: The message content.
-
-        Examples:
-            >>> ai = TypefullyAI()
-            >>> response = ai.ask("Tell me a joke!")
-            >>> message = ai.get_message(response)
-            >>> print(message)
-            'Why did the scarecrow win an award? Because he was outstanding in his field!'
-        """
         assert isinstance(response, dict), "Response should be of dict data-type only"
-        # Handle potential unicode escapes in the final text
-        # Formatting is now handled by the extractor
         text = response.get("text", "")
         try:
             formatted_text = text.replace('\\n', '\n').replace('\\n\\n', '\n\n')
             return formatted_text
-        except Exception: # Catch potential errors during newline replacement
-             return text # Return original text if formatting fails
-
+        except Exception:
+             return text
 
 if __name__ == "__main__":
-    # Ensure curl_cffi is installed
     print("-" * 80)
     print(f"{'Model':<50} {'Status':<10} {'Response'}")
     print("-" * 80)
-    
-    # Test all available models
     working = 0
     total = len(TypefullyAI.AVAILABLE_MODELS)
-    
     for model in TypefullyAI.AVAILABLE_MODELS:
         try:
             test_ai = TypefullyAI(model=model, timeout=60)
-            # Test stream first
             response_stream = test_ai.chat("Say 'Hello' in one word", stream=True)
             response_text = ""
-            print(f"\r{model:<50} {'Streaming...':<10}", end="", flush=True)
             for chunk in response_stream:
                 response_text += chunk
-            
             if response_text and len(response_text.strip()) > 0:
-                status = "✓"
-                # Clean and truncate response
-                clean_text = response_text.strip() # Already formatted in get_message
+                status = "OK"
+                clean_text = response_text.strip()
                 display_text = clean_text[:50] + "..." if len(clean_text) > 50 else clean_text
             else:
-                status = "✗ (Stream)"
+                status = "FAIL (Stream)"
                 display_text = "Empty or invalid stream response"
             print(f"\r{model:<50} {status:<10} {display_text}")
-            
-            # Optional: Add non-stream test if needed
-            # print(f"\r{model:<50} {'Non-Stream...':<10}", end="", flush=True)
-            # response_non_stream = test_ai.chat("Say 'Hi' again", stream=False)
-            # if not response_non_stream or len(response_non_stream.strip()) == 0:
-            #      print(f"\r{model:<50} {'✗ (Non-Stream)':<10} Empty non-stream response")
-
         except Exception as e:
-            print(f"\r{model:<50} {'✗':<10} {str(e)}")
+            print(f"\r{model:<50} {'FAIL':<10} {str(e)}")

webscout/__init__.py

@@ -26,9 +26,11 @@ __repo__ = "https://github.com/OE-LUCIFER/Webscout"
 # Add update checker
 from .update_checker import check_for_updates
 try:
-    check_for_updates()
+    update_message = check_for_updates()
+    if update_message:
+        print(update_message)
 except Exception:
-    pass  # Silently handle any update check errors
+    pass  # Silently handle any update check errorslently handle any update check errors
 
 import logging
 logging.getLogger("webscout").addHandler(logging.NullHandler())

webscout/cli.py

@@ -1,6 +1,6 @@
 import sys
 from .swiftcli import CLI, option
-from .webscout_search import WEBS
+from .webscout_search import WEBS  # Import the WEBS class from webscout_search
 from .DWEBS import GoogleSearch  # Import GoogleSearch from DWEBS
 from .yep_search import YepSearch  # Import YepSearch from yep_search
 from .version import __version__
@@ -48,32 +48,7 @@ def version():
     """Show the version of webscout."""
     print(f"webscout version: {__version__}")
 
-@app.command()
-@option("--proxy", help="Proxy URL to use for requests")
-@option("--model", "-m", help="AI model to use", default="gpt-4o-mini", type=str)
-@option("--timeout", "-t", help="Timeout value for requests", type=int, default=10)
-def chat(proxy: str = None, model: str = "gpt-4o-mini", timeout: int = 10):
-    """Interactive AI chat using DuckDuckGo's AI."""
-    webs = WEBS(proxy=proxy, timeout=timeout)
-    
-    print(f"Using model: {model}")
-    print("Type your message and press Enter. Press Ctrl+C or type 'exit' to quit.\n")
-    
-    try:
-        while True:
-            try:
-                user_input = input(">>> ").strip()
-                if not user_input or user_input.lower() in ['exit', 'quit']:
-                    break
-                    
-                response = webs.chat(keywords=user_input, model=model)
-                print(f"\nAI: {response}\n")
-                
-            except Exception as e:
-                print(f"Error: {str(e)}\n")
-                
-    except KeyboardInterrupt:
-        print("\nChat session interrupted. Exiting...")
+
 
 @app.command()
 @option("--keywords", "-k", help="Search keywords", required=True)
@@ -546,4 +521,4 @@ def main():
         sys.exit(1)
 
 if __name__ == "__main__":
-    main()
+    main()

webscout/conversation.py

@@ -1,6 +1,24 @@
+"""
+conversation.py
+
+This module provides a modern conversation manager for handling chat-based interactions, message history, tool calls, and robust error handling. It defines the Conversation class and supporting types for managing conversational state, tool integration, and message validation.
+
+Classes:
+    ConversationError: Base exception for conversation-related errors.
+    ToolCallError: Raised when there's an error with tool calls.
+    MessageValidationError: Raised when message validation fails.
+    Message: Represents a single message in the conversation.
+    FunctionCall: TypedDict for a function call.
+    ToolDefinition: TypedDict for a tool definition.
+    FunctionCallData: TypedDict for function call data.
+    Fn: Represents a function (tool) that the agent can call.
+    Conversation: Main conversation manager class.
+
+Functions:
+    tools: Decorator to mark a function as a tool.
+"""
 import os
 import json
-import logging
 from typing import Optional, Dict, List, Any, TypedDict, Callable, TypeVar, Union
 from dataclasses import dataclass
 from datetime import datetime
@@ -59,14 +77,15 @@ def tools(func: Callable[..., T]) -> Callable[..., T]:
     return func
 
 class Conversation:
-    """Modern conversation manager with enhanced features.
-    
+    """
+    Modern conversation manager with enhanced features.
+
     Key Features:
-    - Robust message handling with metadata
-    - Enhanced tool calling support
-    - Efficient history management
-    - Improved error handling
-    - Memory optimization
+        - Robust message handling with metadata
+        - Enhanced tool calling support
+        - Efficient history management
+        - Improved error handling
+        - Memory optimization
     """
 
     intro = (
@@ -95,23 +114,8 @@ class Conversation:
         self.prompt_allowance = 10
         self.tools = tools or []
         self.compression_threshold = compression_threshold
-        self.logger = self._setup_logger()
-        
         if filepath:
-            self.load_conversation(filepath, False)
-
-    def _setup_logger(self) -> logging.Logger:
-        """Set up enhanced logging."""
-        logger = logging.getLogger("conversation")
-        if not logger.handlers:
-            handler = logging.StreamHandler()
-            formatter = logging.Formatter(
-                '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
-            )
-            handler.setFormatter(formatter)
-            logger.addHandler(handler)
-            logger.setLevel(logging.INFO)
-        return logger
+            self.load_conversation(filepath, True)
 
     def load_conversation(self, filepath: str, exists: bool = True) -> None:
         """Load conversation with improved error handling."""
@@ -132,7 +136,6 @@ class Conversation:
                         self.intro = file_contents[0]
                         self._process_history_from_file(file_contents[1:])
         except Exception as e:
-            self.logger.error(f"Error loading conversation: {str(e)}")
             raise ConversationError(f"Failed to load conversation: {str(e)}") from e
 
     def _process_history_from_file(self, lines: List[str]) -> None:
@@ -272,6 +275,7 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
     def add_message(self, role: str, content: str, metadata: Optional[Dict[str, Any]] = None) -> None:
         """Add a message with enhanced validation and metadata support."""
         try:
+            role = role.lower()  # Normalize role to lowercase
             if not self.validate_message(role, content):
                 raise MessageValidationError("Invalid message role or content")
 
@@ -284,7 +288,6 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
             self._compress_history()
             
         except Exception as e:
-            self.logger.error(f"Error adding message: {str(e)}")
             raise ConversationError(f"Failed to add message: {str(e)}") from e
 
     def _append_to_file(self, message: Message) -> None:
@@ -299,17 +302,17 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
                 fh.write(f"\n{role_display}: {message.content}")
                 
         except Exception as e:
-            self.logger.error(f"Error writing to file: {str(e)}")
             raise ConversationError(f"Failed to write to file: {str(e)}") from e
 
     def validate_message(self, role: str, content: str) -> bool:
         """Validate message with enhanced role checking."""
         valid_roles = {'user', 'assistant', 'tool', 'system'}
         if role not in valid_roles:
-            self.logger.error(f"Invalid role: {role}")
             return False
-        if not content or not isinstance(content, str):
-            self.logger.error("Invalid content")
+        if not isinstance(content, str):
+            return False
+        # Allow empty content for assistant (needed for streaming)
+        if not content and role != 'assistant':
             return False
         return True
 
@@ -345,7 +348,6 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
             }
             
         except Exception as e:
-            self.logger.error(f"Error handling tool response: {str(e)}")
             raise ToolCallError(f"Failed to handle tool response: {str(e)}") from e
 
     def _parse_function_call(self, response: str) -> FunctionCallData:
@@ -381,7 +383,6 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
                 raise
 
         except Exception as e:
-            self.logger.error(f"Error parsing function call: {str(e)}")
             return {"error": str(e)}
 
     def execute_function(self, function_call_data: FunctionCallData) -> str:
@@ -405,7 +406,6 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
             return "; ".join(results)
             
         except Exception as e:
-            self.logger.error(f"Error executing function: {str(e)}")
             raise ToolCallError(f"Failed to execute function: {str(e)}") from e
 
     def get_tools_description(self) -> str:
@@ -428,9 +428,9 @@ Your goal is to assist the user effectively. Analyze each query and choose one o
         This method adds both the user's prompt and the assistant's response
         to the conversation history as separate messages.
         """
-        # Add user's message
+        # Add user's message (normalize role)
         self.add_message("user", prompt)
         
-        # Add assistant's response
+        # Add assistant's response (normalize role)
         self.add_message("assistant", response)