swiftshadow 2.2.1__tar.gz → 2.3.0__tar.gz

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: swiftshadow
-Version: 2.2.1
+Version: 2.3.0
 Summary: Free IP Proxy rotator for python
 Author-email: sachin-sankar <mail.sachinsankar@gmail.com>
 License-File: LICENSE

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/docs-src/Getting Started/Using-Proxy-Class.md

@@ -45,6 +45,23 @@ swift = ProxyInterface(protocol='https')
 
 ---
 
+# Selecting Providers
+
+Swiftshadow allows the user to select only specific Providers from a list of available Providers to circumvent trying to fetch proxies from unavailable Providers. If you come across a Provider that is consistently failing please make sure to report it on the GitHub for its removal or remedy.
+
+Providers can be imported as needed from the available ones in `swiftshadow.providers`
+
+```python title="Provider Selection"
+from swiftshadow.classes import ProxyInterface
+from swiftshadow.providers import Monosans
+
+swift = ProxyInterface(selectedProviders=[Monosans])
+print(swift.get())
+```
+
+---
+
+
 # Proxy Rotation
 
 ## Manual Rotation

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "swiftshadow"
-version = "2.2.1"
+version = "2.3.0"
 description = "Free IP Proxy rotator for python"
 readme = "README.md"
 authors = [{ name = "sachin-sankar", email = "mail.sachinsankar@gmail.com" }]

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/swiftshadow/__init__.py

@@ -19,7 +19,7 @@ def QuickProxy(
     Returns:
         proxyObject (Proxy): A working proxy object if found or else None.
     """
-    for provider in Providers:
+    for provider in Providers.values():
         if protocol not in provider.protocols:
             continue
         if (len(countries) != 0) and (not provider.countryFilter):

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/swiftshadow/classes.py

@@ -5,16 +5,17 @@ from pathlib import Path
 from pickle import dump, dumps, load, loads
 from random import choice
 from sys import stdout
-from typing import Literal
+from typing import Literal, Any, Callable, Coroutine
 
 import aiofiles
 from appdirs import user_cache_dir
 
 from swiftshadow.cache import checkExpiry, getExpiry
 from swiftshadow.exceptions import UnsupportedProxyProtocol
-from swiftshadow.models import CacheData
+from swiftshadow.helpers import deduplicateProxies
+from swiftshadow.models import CacheData, Provider
 from swiftshadow.models import Proxy as Proxy
-from swiftshadow.providers import Providers
+from swiftshadow.providers import Providers as ProvidersMap
 
 logger = getLogger("swiftshadow")
 logger.setLevel(INFO)
@@ -34,6 +35,7 @@ class ProxyInterface:
     Attributes:
         countries (list[str]): List of ISO country codes to filter proxies by (e.g., ["US", "CA"]).
         protocol (Literal['https', 'http']): Proxy protocol to use. Defaults to 'http'.
+        selectedProviders (Callable[[list[str], Literal["http", "https"]], Coroutine[Any, Any, list[Proxy]]]]): Selected list of providers to fetch proxies from. Defaults to empty meaning all available Providers.
         maxproxies (int): Maximum number of proxies to collect from providers. Defaults to 10.
         autorotate (bool): Whether to automatically rotate proxy on each get() call. Defaults to False.
         autoUpdate (bool): Whether to automatically update proxies upon class initalisation. Defaults to True.
@@ -62,6 +64,11 @@ class ProxyInterface:
         self,
         countries: list[str] = [],
         protocol: Literal["https", "http"] = "http",
+        selectedProviders: list[
+            Callable[
+                [list[str], Literal["http", "https"]], Coroutine[Any, Any, list[Proxy]]
+            ]
+        ] = [],
         maxProxies: int = 10,
         autoRotate: bool = False,
         autoUpdate: bool = True,
@@ -75,6 +82,7 @@ class ProxyInterface:
         Args:
             countries: List of ISO country codes to filter proxies. Empty list = no filtering.
             protocol: Proxy protocol to retrieve. Choose between 'http' or 'https'.
+            selectedProviders (list[Providers]): Selected list of providers to fetch proxies from. Defaults to empty meaning all available Providers.
             maxProxies: Maximum proxies to collect from all providers combined.
             autoRotate: Enable automatic proxy rotation on every get() call.
             autoUpdate (bool): Whether to automatically update proxies upon class initalisation.
@@ -93,6 +101,18 @@ class ProxyInterface:
                 } is not supported by swiftshadow, please choose between HTTP or HTTPS"
             )
         self.protocol: Literal["https", "http"] = protocol
+        if selectedProviders != []:
+            providers: list[Provider] = []
+            for i in selectedProviders:
+                try:
+                    providers.append(ProvidersMap[i])
+                except KeyError:
+                    raise ValueError(
+                        f"Unkown provider {i.__name__} in the list of Selected Providers."
+                    )
+            self.providers: list[Provider] = providers
+        else:
+            self.providers: list[Provider] = list(ProvidersMap.values())
 
         self.maxproxies: int = maxProxies
         self.autorotate: bool = autoRotate
@@ -161,7 +181,7 @@ class ProxyInterface:
 
         self.proxies = []
 
-        for provider in Providers:
+        for provider in self.providers:
             if self.protocol not in provider.protocols:
                 continue
             if (len(self.countries) != 0) and (not provider.countryFilter):
@@ -184,6 +204,7 @@ class ProxyInterface:
                 raise ValueError("No proxies were found for the current filter settings. Tip: https proxies can be rare; recommend setting protocol to http")
             raise ValueError("No proxies were found for the current filter settings.")
 
+        self.proxies = deduplicateProxies(self.proxies)
         async with aiofiles.open(
             self.cacheFolderPath.joinpath("swiftshadow.pickle"), "wb+"
         ) as cacheFile:
@@ -232,7 +253,7 @@ class ProxyInterface:
 
         self.proxies = []
 
-        for provider in Providers:
+        for provider in self.providers:
             if self.protocol not in provider.protocols:
                 continue
             if (len(self.countries) != 0) and (not provider.countryFilter):
@@ -253,6 +274,7 @@ class ProxyInterface:
         if len(self.proxies) == 0:
             raise ValueError("No proxies were found for the current filter settings.")
 
+        self.proxies = deduplicateProxies(self.proxies)
         with open(
             self.cacheFolderPath.joinpath("swiftshadow.pickle"), "wb+"
         ) as cacheFile:

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/swiftshadow/helpers.py

@@ -46,3 +46,14 @@ async def GenericPlainTextProxyProvider(
     proxies: list[Proxy] = plaintextToProxies(raw, protocol=protocol)
     results = await validate_proxies(proxies)
     return results
+
+
+def deduplicateProxies(proxies: list[Proxy]) -> list[Proxy]:
+    seen: list[str] = []
+    final: list[Proxy] = []
+    for proxy in proxies:
+        proxy_str: str = proxy.as_string()
+        if proxy_str not in seen:
+            final.append(proxy)
+            seen.append(proxy_str)
+    return final

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/swiftshadow/providers.py

@@ -1,4 +1,4 @@
-from typing import Literal
+from typing import Any, Callable, Coroutine, Literal
 import aiohttp
 
 from requests import get
@@ -168,18 +168,37 @@ async def ProxyDB(
     return proxies
 
 
-Providers: list[Provider] = [
-    Provider(providerFunction=ProxyScrape, countryFilter=True, protocols=["http"]),
-    Provider(providerFunction=Monosans, countryFilter=True, protocols=["http"]),
-    Provider(providerFunction=MuRongPIG, countryFilter=False, protocols=["http"]),
-    Provider(providerFunction=Thespeedx, countryFilter=False, protocols=["http"]),
-    Provider(
+Providers: dict[
+    Callable[[list[str], Literal["http", "https"]], Coroutine[Any, Any, list[Proxy]]],
+    Provider,
+] = {
+    ProxyScrape: Provider(
+        providerFunction=ProxyScrape, countryFilter=True, protocols=["http"]
+    ),
+    Monosans: Provider(
+        providerFunction=Monosans, countryFilter=True, protocols=["http"]
+    ),
+    MuRongPIG: Provider(
+        providerFunction=MuRongPIG, countryFilter=False, protocols=["http"]
+    ),
+    Thespeedx: Provider(
+        providerFunction=Thespeedx, countryFilter=False, protocols=["http"]
+    ),
+    Anonym0usWork1221: Provider(
         providerFunction=Anonym0usWork1221,
         countryFilter=False,
         protocols=["http", "https"],
     ),
-    Provider(providerFunction=Mmpx12, countryFilter=False, protocols=["http", "https"]),
-    Provider(providerFunction=GoodProxy, countryFilter=False, protocols=["http"]),
-    Provider(providerFunction=OpenProxyList, countryFilter=False, protocols=["http"]),
-    Provider(providerFunction=ProxyDB, countryFilter=True, protocols=["http", "https"]),
-]
+    Mmpx12: Provider(
+        providerFunction=Mmpx12, countryFilter=False, protocols=["http", "https"]
+    ),
+    GoodProxy: Provider(
+        providerFunction=GoodProxy, countryFilter=False, protocols=["http"]
+    ),
+    OpenProxyList: Provider(
+        providerFunction=OpenProxyList, countryFilter=False, protocols=["http"]
+    ),
+    ProxyDB: Provider(
+        providerFunction=ProxyDB, countryFilter=True, protocols=["http", "https"]
+    ),
+}

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/tests/test_proxy.py

@@ -6,6 +6,7 @@ from appdirs import user_cache_dir
 
 from swiftshadow.classes import ProxyInterface
 from swiftshadow.models import Proxy
+from swiftshadow.providers import Providers
 
 
 def test_basic_proxy():
@@ -61,3 +62,11 @@ def test_async_update_autorotate():
     run(swift.async_update())
     assert isinstance(swift.get(), Proxy)
     assert isinstance(swift.get(), Proxy)
+
+
+def test_provider_selection():
+    selectedProvider = list(Providers.keys())[0]
+    swift = ProxyInterface(selectedProviders=[selectedProvider])
+    proxy = swift.get()
+    assert isinstance(proxy, Proxy)
+    assert swift.providers[0] == Providers[selectedProvider]

{swiftshadow-2.2.1 → swiftshadow-2.3.0}/uv.lock

@@ -837,7 +837,7 @@ wheels = [
 
 [[package]]
 name = "swiftshadow"
-version = "2.2.1"
+version = "2.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "aiofiles" },