Skip to content

References

swiftshadow.Proxy

Source code in swiftshadow/classes.py 
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class Proxy:
    def __init__(
        self,
        countries: list = [],
        protocol: str = "http",
        maxProxies: int = 10,
        autoRotate: bool = False,
        cachePeriod: int = 10,
        cacheFolder: str = "",
        debug: bool = False,
        logToFile: bool = False,
    ):
        """
        The one class for everything.

        Proxy class contains all necessary methods required to use swiftshadow.

        Args:
                countries: ISO 3166-2 Two letter country codes to filter proxies.
                protocol: HTTP/HTTPS protocol to filter proxies.
                maxProxies: Maximum number of proxies to store and rotate from.
                autoRotate: Rotates proxy when `Proxy.proxy()` function is called.
                cachePeriod: Time to cache proxies in minutes.
                cacheFolder: Folder to store cache file.
                debug: Sets Log Level to Debug.
                logToFile: Whether to pipe log to a log file. If cacheFolder is set log file is saved there.

        Returns:
                proxyClass (swiftshadow.Proxy): `swiftshadow.Proxy` class instance

        Examples:
                Simplest way to get a proxy
                >>> from swiftshadow.swiftshadow import Proxy
                >>> swift = Proxy()
                >>> print(swift.proxy())
                {'http':'192.0.0.1:8080'}
        Note:
                Proxies are sourced from **Proxyscrape** and **Scrapingant** websites which are freely available and validated locally.
        """
        self.countries = [i.upper() for i in countries]
        self.protocol = protocol
        self.maxProxies = maxProxies
        self.autoRotate = autoRotate
        self.cachePeriod = cachePeriod
        if cacheFolder == "":
            self.cacheFilePath = ".swiftshadow.json"
        else:
            self.cacheFilePath = f"{cacheFolder}/.swiftshadow.json"
        if debug:
            logger.setLevel(logging.DEBUG)
        if logToFile:
            if cacheFolder == "":
                logFilePath = "swiftshadow.log"
            else:
                logFilePath = f"{cacheFolder}/swiftshadow.log"
            fileHandler = logging.FileHandler(logFilePath)
            fileHandler.setFormatter(logFormat)
            logger.addHandler(fileHandler)
        self.update()

    def update(self):
        try:
            with open(self.cacheFilePath, "r") as file:
                data = load(file)
                self.expiry = data[0]
                expired = cache.checkExpiry(self.expiry)
            if not expired:
                logger.info(
                    "Loaded proxies from cache",
                )
                self.proxies = data[1]
                self.expiry = data[0]
                self.current = self.proxies[0]
                return
            else:
                logger.info(
                    "Cache expired. Updating cache.",
                )
        except FileNotFoundError:
            logger.info("No cache found. Cache will be created after update")

        self.proxies = []
        for providerDict in Providers:
            if self.protocol not in providerDict["protocols"]:
                continue
            if (len(self.countries) != 0) and (not providerDict["countryFilter"]):
                continue
            self.proxies.extend(
                providerDict["provider"](self.maxProxies, self.countries, self.protocol)
            )
            if len(self.proxies) >= self.maxProxies:
                break
        if len(self.proxies) == 0:
            logger.warning(
                "No proxies found for current settings. To prevent runtime error updating the proxy list again.",
            )
            self.update()
        with open(self.cacheFilePath, "w") as file:
            self.expiry = cache.getExpiry(self.cachePeriod).isoformat()
            dump([self.expiry, self.proxies], file)
        self.current = self.proxies[0]

    def rotate(self):
        """
        Rotate the current proxy.

        Sets the current proxy to a random one from available proxies and also validates cache.

        Note:
                Function only for manual rotation. If `autoRotate` is set to `True` then no need to call this function.
        """
        if cache.checkExpiry(self.expiry):
            self.update()
        self.current = choice(self.proxies)

    def proxy(self):
        """
        Returns a proxy dict.

        Returns:
                proxyDict (dict):A proxy dict of format `{protocol:address}`
        """
        if cache.checkExpiry(self.expiry):
            self.update()
        if self.autoRotate == True:
            return choice(self.proxies)
        else:
            return self.current

__init__(countries=[], protocol='http', maxProxies=10, autoRotate=False, cachePeriod=10, cacheFolder='', debug=False, logToFile=False)

The one class for everything.

Proxy class contains all necessary methods required to use swiftshadow.

Parameters:

Name Type Description Default
countries list

ISO 3166-2 Two letter country codes to filter proxies.

 []
protocol str

HTTP/HTTPS protocol to filter proxies.

 'http'
maxProxies int

Maximum number of proxies to store and rotate from.

 10
autoRotate bool

Rotates proxy when Proxy.proxy() function is called.

 False
cachePeriod int

Time to cache proxies in minutes.

 10
cacheFolder str

Folder to store cache file.

 ''
debug bool

Sets Log Level to Debug.

 False
logToFile bool

Whether to pipe log to a log file. If cacheFolder is set log file is saved there.

 False

Returns:

Name Type Description
proxyClass Proxy

swiftshadow.Proxy class instance

Examples:

Simplest way to get a proxy

>>> from swiftshadow.swiftshadow import Proxy
>>> swift = Proxy()
>>> print(swift.proxy())
{'http':'192.0.0.1:8080'}

Note: Proxies are sourced from Proxyscrape and Scrapingant websites which are freely available and validated locally.

Source code in swiftshadow/classes.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def __init__(
    self,
    countries: list = [],
    protocol: str = "http",
    maxProxies: int = 10,
    autoRotate: bool = False,
    cachePeriod: int = 10,
    cacheFolder: str = "",
    debug: bool = False,
    logToFile: bool = False,
):
    """
    The one class for everything.

    Proxy class contains all necessary methods required to use swiftshadow.

    Args:
            countries: ISO 3166-2 Two letter country codes to filter proxies.
            protocol: HTTP/HTTPS protocol to filter proxies.
            maxProxies: Maximum number of proxies to store and rotate from.
            autoRotate: Rotates proxy when `Proxy.proxy()` function is called.
            cachePeriod: Time to cache proxies in minutes.
            cacheFolder: Folder to store cache file.
            debug: Sets Log Level to Debug.
            logToFile: Whether to pipe log to a log file. If cacheFolder is set log file is saved there.

    Returns:
            proxyClass (swiftshadow.Proxy): `swiftshadow.Proxy` class instance

    Examples:
            Simplest way to get a proxy
            >>> from swiftshadow.swiftshadow import Proxy
            >>> swift = Proxy()
            >>> print(swift.proxy())
            {'http':'192.0.0.1:8080'}
    Note:
            Proxies are sourced from **Proxyscrape** and **Scrapingant** websites which are freely available and validated locally.
    """
    self.countries = [i.upper() for i in countries]
    self.protocol = protocol
    self.maxProxies = maxProxies
    self.autoRotate = autoRotate
    self.cachePeriod = cachePeriod
    if cacheFolder == "":
        self.cacheFilePath = ".swiftshadow.json"
    else:
        self.cacheFilePath = f"{cacheFolder}/.swiftshadow.json"
    if debug:
        logger.setLevel(logging.DEBUG)
    if logToFile:
        if cacheFolder == "":
            logFilePath = "swiftshadow.log"
        else:
            logFilePath = f"{cacheFolder}/swiftshadow.log"
        fileHandler = logging.FileHandler(logFilePath)
        fileHandler.setFormatter(logFormat)
        logger.addHandler(fileHandler)
    self.update()

proxy()

Returns a proxy dict.

Returns:

Name Type Description
proxyDict dict

A proxy dict of format {protocol:address}
Source code in swiftshadow/classes.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
def proxy(self):
    """
    Returns a proxy dict.

    Returns:
            proxyDict (dict):A proxy dict of format `{protocol:address}`
    """
    if cache.checkExpiry(self.expiry):
        self.update()
    if self.autoRotate == True:
        return choice(self.proxies)
    else:
        return self.current

rotate()

Rotate the current proxy.

Sets the current proxy to a random one from available proxies and also validates cache.

Note

Function only for manual rotation. If autoRotate is set to True then no need to call this function.

Source code in swiftshadow/classes.py 
120
121
122
123
124
125
126
127
128
129
130
131
def rotate(self):
    """
    Rotate the current proxy.

    Sets the current proxy to a random one from available proxies and also validates cache.

    Note:
            Function only for manual rotation. If `autoRotate` is set to `True` then no need to call this function.
    """
    if cache.checkExpiry(self.expiry):
        self.update()
    self.current = choice(self.proxies)

swiftshadow.QuickProxy

This function is a faster alternative to Proxy class. No caching is done.

Parameters:

Name Type Description Default
countries list

ISO 3166-2 Two letter country codes to filter proxies.

 []
protocol str

HTTP/HTTPS protocol to filter proxies.

 'http'

Returns:

Name Type Description
proxyObject dict

A working proxy object.
Source code in swiftshadow/__init__.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
def QuickProxy(countries: list = [], protocol: str = "http"):
    """
    This function is a faster alternative to `Proxy` class.
    No caching is done.

    Args:
     countries: ISO 3166-2 Two letter country codes to filter proxies.
     protocol: HTTP/HTTPS protocol to filter proxies.

    Returns:
                    proxyObject (dict): A working proxy object.
    """
    for providerDict in Providers:
        if protocol not in providerDict["protocols"]:
            continue
        if (len(countries) != 0) and (not providerDict["countryFilter"]):
            continue
        try:
            return providerDict["provider"](1, countries, protocol)[0]
        except:
            continue
    return None