👨‍💻 Update 2.0.0

DavideGalilei · DavideGalilei · commit ea14253681ad · 2024-12-03T20:18:29.000+01:00
diff --git a/.github/workflows/test-suite.yml b/.github/workflows/test-suite.yml
@@ -14,7 +14,7 @@ jobs:
 
     strategy:
       matrix:
-        version: [ "3.7", "3.8", "3.9", "3.10", "3.11" ]
+        version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
 
     steps:
       - uses: "actions/checkout@v2"
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,5 @@
 /.idea/
 /gpytranslate.egg-info/
 **/__pycache__
+.aider*
+.env
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Davide Galilei
+Copyright (c) 2024 Davide Galilei
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/examples/async/__init__.py b/examples/async/__init__.py
diff --git a/examples/async/example.py b/examples/async/example.py
@@ -2,9 +2,9 @@
 
 from gpytranslate import Translator
 
-
 """Example showing basic translation and language detection."""
 
+
 async def main() -> None:
     """Demonstrate translation from Italian to English and language detection."""
     t = Translator()
diff --git a/examples/async/https_proxy.py b/examples/async/https_proxy.py
@@ -2,9 +2,9 @@
 
 from gpytranslate import Translator
 
-
 """Example showing how to use HTTPS proxy with the translator."""
 
+
 async def main() -> None:
     """Demonstrate translation using an HTTPS proxy."""
     t = Translator(proxies={"https://": "https://{proxy_ip_here}"})
diff --git a/examples/async/socks5_proxy.py b/examples/async/socks5_proxy.py
@@ -2,9 +2,9 @@
 
 from gpytranslate import Translator
 
-
 """Example showing how to use SOCKS5 proxy with the translator."""
 
+
 async def main() -> None:
     """Demonstrate translation using a SOCKS5 proxy."""
     t = Translator(proxies={"socks5": "socks5://user:password@127.0.0.1:1080"})
diff --git a/examples/async/tts.py b/examples/async/tts.py
@@ -4,9 +4,9 @@
 
 from gpytranslate import Translator
 
-
 """Example showing how to use text-to-speech functionality."""
 
+
 async def main() -> None:
     """Demonstrate text-to-speech generation."""
     translator = Translator()
diff --git a/examples/sync/__init__.py b/examples/sync/__init__.py
diff --git a/examples/sync/example.py b/examples/sync/example.py
@@ -1,28 +1,3 @@
-"""
-    gpytranslate - A Python3 library for translating text using Google Translate API.
-    MIT License
-
-    Copyright (c) 2023 Davide Galilei
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE.
-"""
-
 from gpytranslate import SyncTranslator
 
 t = SyncTranslator()
diff --git a/examples/sync/https_proxy.py b/examples/sync/https_proxy.py
@@ -1,28 +1,3 @@
-"""
-    gpytranslate - A Python3 library for translating text using Google Translate API.
-    MIT License
-
-    Copyright (c) 2023 Davide Galilei
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE.
-"""
-
 from gpytranslate import SyncTranslator
 
 t = SyncTranslator(proxies={"https://": "https://{proxy_ip_here}"})
diff --git a/examples/sync/socks5_proxy.py b/examples/sync/socks5_proxy.py
@@ -1,36 +1,7 @@
-"""
-    gpytranslate - A Python3 library for translating text using Google Translate API.
-    MIT License
-
-    Copyright (c) 2023 Davide Galilei
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE.
-"""
-
-from httpx_socks import SyncProxyTransport
-
 from gpytranslate import SyncTranslator
 
-t = SyncTranslator(
-    transport=SyncProxyTransport.from_url("socks5://user:password@127.0.0.1:1080")
-)
+t = SyncTranslator(proxies={"socks5": "socks5://user:password@127.0.0.1:1080"})
 # Check out https://pypi.org/project/httpx-socks/
-translation = await t.translate("Ciao Mondo!", targetlang="en")
+translation = t.translate("Ciao Mondo!", targetlang="en")
 # Hello World!
 print(f"Translation: {translation.text}")
diff --git a/gpytranslate/__init__.py b/gpytranslate/__init__.py
@@ -1,7 +1,7 @@
+from .exceptions import GpytranslateException, TranslationError
 from .gpytranslate import Translator
 from .sync import SyncTranslator
 from .types import TranslatedObject
-from .exceptions import GpytranslateException, TranslationError
 
 __version__ = "1.5.1"
 __all__ = [
diff --git a/gpytranslate/gpytranslate.py b/gpytranslate/gpytranslate.py
@@ -32,11 +32,11 @@ def __init__(
         **options: Any,
     ) -> None:
         """Initialize the translator.
-        
+
         Args:
             proxies: Optional proxy configuration dictionary
             url: Translation API endpoint URL
-            tts_url: Text-to-speech API endpoint URL 
+            tts_url: Text-to-speech API endpoint URL
             headers: Custom headers or header generator function
             **options: Additional options passed to httpx.AsyncClient
         """
@@ -215,13 +215,13 @@ async def tts(
         targetlang: str = "en",
         client: str = "at",
         idx: int = 0,
-        prev: str = "input", 
+        prev: str = "input",
         chunk_size: int = 1024,
         textlen: Optional[int] = None,
         **extra: Any,
     ) -> Union[AsyncBufferedIOBase, io.BytesIO]:
         """Generate text-to-speech audio.
-        
+
         Args:
             text: Text to convert to speech
             file: Output file or buffer
@@ -232,10 +232,10 @@ async def tts(
             chunk_size: Download chunk size
             textlen: Override text length
             **extra: Additional TTS parameters
-            
+
         Returns:
             The output file/buffer with audio data
-            
+
         Raises:
             TranslationError: If TTS generation fails
             ValueError: If targetlang is invalid
diff --git a/gpytranslate/py.typed b/gpytranslate/py.typed
diff --git a/gpytranslate/sync/__init__.py b/gpytranslate/sync/__init__.py
@@ -1 +1,3 @@
 from .sync_translator import SyncTranslator
+
+__all__ = ["SyncTranslator"]
diff --git a/gpytranslate/sync/sync_translator.py b/gpytranslate/sync/sync_translator.py
@@ -176,9 +176,7 @@ def translate(
             raise TranslationError(e) from None
 
     def detect(
-        self, 
-        text: Union[str, List[Any], Dict[Any, Any]], 
-        **kwargs: Any
+        self, text: Union[str, List[Any], Dict[Any, Any]], **kwargs: Any
     ) -> Union[str, List[str], Dict[Any, str]]:
         if isinstance(text, str):
             return self(text).lang
diff --git a/gpytranslate/types/__init__.py b/gpytranslate/types/__init__.py
@@ -32,7 +32,7 @@ class Device:
     @classmethod
     def shift(cls) -> str:
         """Get next device string in rotation.
-        
+
         Returns:
             str: Next device user agent string
         """
diff --git a/gpytranslate/types/base_translator.py b/gpytranslate/types/base_translator.py
@@ -33,16 +33,16 @@ def check(
         dt: str,
     ) -> Union[TranslatedObject, Dict[K, TranslatedObject], List[TranslatedObject]]:
         """Check and validate translation API response.
-        
+
         Args:
             text: Original input text
             raw: Raw API response data
             client: API client identifier
             dt: Response data type
-            
+
         Returns:
             Parsed translation result(s)
-            
+
         Raises:
             TranslationError: If response validation fails
         """
diff --git a/gpytranslate/types/translated_object.py b/gpytranslate/types/translated_object.py
@@ -1,21 +1,23 @@
 """Translation result object implementation."""
+
 from dataclasses import dataclass
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, List
 
 
 @dataclass
 class TranslatedObject:
     """A dataclass that holds translation results."""
+
     raw: Dict[str, Any]
     orig: str
-    text: str 
+    text: str
     orig_raw: List[str]
     text_raw: List[str]
     lang: str
-    
+
     def __str__(self) -> str:
         """Get string representation with the translated text.
-        
+
         Returns:
             str: The translated text
         """
@@ -24,10 +26,10 @@ def __str__(self) -> str:
     @classmethod
     def from_raw_response(cls, raw: Dict[str, Any]) -> "TranslatedObject":
         """Create TranslatedObject from raw API response.
-        
+
         Args:
             raw: Raw response dictionary from the translation API
-            
+
         Returns:
             TranslatedObject: Parsed translation result
         """
@@ -37,5 +39,5 @@ def from_raw_response(cls, raw: Dict[str, Any]) -> "TranslatedObject":
             text=" ".join(s["trans"] for s in raw["sentences"] if "trans" in s),
             orig_raw=[s["orig"] for s in raw["sentences"] if "orig" in s],
             text_raw=[s["trans"] for s in raw["sentences"] if "trans" in s],
-            lang=raw["src"]
+            lang=raw["src"],
         )
diff --git a/poetry.lock b/poetry.lock
diff --git a/tests/async/test_detect.py b/tests/async/test_detect.py
diff --git a/tests/async/test_gather.py b/tests/async/test_gather.py
diff --git a/tests/sync/test_sync_detect.py b/tests/sync/test_sync_detect.py
diff --git a/tests/sync/test_sync_tts.py b/tests/sync/test_sync_tts.py
