scrapy-rotating-proxies

This package provides a Scrapy middleware to use rotating proxies, check that they are alive and adjust crawling speed.

License is MIT.

Installation

pip install scrapy-rotating-proxies

Usage

Add ROTATING_PROXY_LIST option with a list of proxies to settings.py:

ROTATING_PROXY_LIST = [
    'proxy1.com:8000',
    'proxy2.com:8031',
    # ...
]

As an alternative, you can specify a ROTATING_PROXY_LIST_PATH options with a path to a file with proxies, one per line:

ROTATING_PROXY_LIST_PATH = '/my/path/proxies.txt'

NOTE: ROTATING_PROXY_LIST_PATH takes precedence over ROTATING_PROXY_LIST if both options are present.

Then add rotating_proxies middlewares to your DOWNLOADER_MIDDLEWARES:

DOWNLOADER_MIDDLEWARES = {
    # ...
    'rotating_proxies.middlewares.RotatingProxyMiddleware': 610,
    'rotating_proxies.middlewares.BanDetectionMiddleware': 620,
    # ...
}

After this all requests will be proxied using one of the proxies from the ROTATING_PROXY_LIST / ROTATING_PROXY_LIST_PATH.

Requests with "proxy" set in their meta are not handled by scrapy-rotating-proxies. To disable proxying for a request set request.meta['proxy'] = None; to set proxy explicitly use request.meta['proxy'] = "<my-proxy-address>".

Switch between proxies and priority_proxies

If you want to switch between two sets of proxies, say proxies and priority_proxies OR free_proxies and premium_proxies OR proxies and Tor, you can make use of proxies and priority_proxies setup. After you're done with the above setup, then:

Add ROTATING_PROXY_PRIORITY_LIST option with a list of priority_proxies to settings.py:

ROTATING_PROXY_PRIORITY_LIST = [
    'proxy1.com:8000',
    'proxy2.com:8031',
    # ...
]

As an alternative, you can specify a ROTATING_PROXY_PRIORITY_LIST_PATH option with a path to a file with priority_proxies, one per line:

ROTATING_PROXY_PRIORITY_LIST_PATH = '/my/path/priority_proxies.txt'

NOTE: ROTATING_PROXY_PRIORITY_LIST_PATH takes precedence over ROTATING_PROXY_PRIORITY_LIST if both options are present.

Also, you must specify ROTATING_PROXY_PRIORITY_WEIGHT option defining the weight of priority_proxies vs. proxies. If you want proxies and priority_proxies to work in 50-50 ratio, then you can set it to 0.5, i.e., proxies work half (50%) of the times and priority_proxies work half (50%) too. So, you must set this option: with a path to a file with priority_proxies, one per line:

ROTATING_PROXY_PRIORITY_WEIGHT = 0.5

NOTE: You can set ROTATING_PROXY_PRIORITY_WEIGHT to 0 for giving 0% preference to priority_proxies and 100% weight to proxies OR 1 for giving 100% weight to priority_proxies.

Concurrency

By default, all default Scrapy concurrency options (DOWNLOAD_DELAY, AUTHTHROTTLE_..., CONCURRENT_REQUESTS_PER_DOMAIN, etc) become per-proxy for proxied requests when RotatingProxyMiddleware is enabled. For example, if you set CONCURRENT_REQUESTS_PER_DOMAIN=2 then spider will be making at most 2 concurrent connections to each proxy, regardless of request url domain.

Customization

scrapy-rotating-proxies keeps track of working and non-working proxies, and re-checks non-working from time to time.

Detection of a non-working proxy is site-specific. By default, scrapy-rotating-proxies uses a simple heuristic: if a response status code is not 200, response body is empty or if there was an exception then proxy is considered dead.

You can override ban detection method by passing a path to a custom BanDectionPolicy in ROTATING_PROXY_BAN_POLICY option, e.g.:

# settings.py
ROTATING_PROXY_BAN_POLICY = 'myproject.policy.MyBanPolicy'

The policy must be a class with response_is_ban and exception_is_ban methods. These methods can return True (ban detected), False (not a ban) or None (unknown). It can be convenient to subclass and modify default BanDetectionPolicy:

# myproject/policy.py
from rotating_proxies.policy import BanDetectionPolicy

class MyPolicy(BanDetectionPolicy):
    def response_is_ban(self, request, response):
        # use default rules, but also consider HTTP 200 responses
        # a ban if there is 'captcha' word in response body.
        ban = super(MyPolicy, self).response_is_ban(request, response)
        ban = ban or b'captcha' in response.body
        return ban

    def exception_is_ban(self, request, exception):
        # override method completely: don't take exceptions in account
        return None

Instead of creating a policy you can also implement response_is_ban and exception_is_ban methods as spider methods, for example:

class MySpider(scrapy.Spider):
    # ...

    def response_is_ban(self, request, response):
        return b'banned' in response.body

    def exception_is_ban(self, request, exception):
        return None

It is important to have these rules correct because action for a failed request and a bad proxy should be different: if it is a proxy to blame it makes sense to retry the request with a different proxy.

Non-working proxies could become alive again after some time. scrapy-rotating-proxies uses a randomized exponential backoff for these checks - first check happens soon, if it still fails then next check is delayed further, etc. Use ROTATING_PROXY_BACKOFF_BASE to adjust the initial delay (by default it is random, from 0 to 5 minutes). The randomized exponential backoff is capped by ROTATING_PROXY_BACKOFF_CAP.

Settings

• ROTATING_PROXY_LIST - a list of proxies to choose from;
• ROTATING_PROXY_LIST_PATH - path to a file with a list of proxies;
• ROTATING_PROXY_PRIORITY_LIST - a list of priority_proxies to choose from (optional);
• ROTATING_PROXY_PRIORITY_LIST_PATH - path to a file with a list of priority_proxies (optional);
• ROTATING_PROXY_PRIORITY_WEIGHT - weight for priority_proxies. Default is 0. If you set ROTATING_PROXY_PRIORITY_LIST or ROTATING_PROXY_PRIORITY_LIST_PATH, then you can set ROTATING_PROXY_PRIORITY_WEIGHT = 0.5 for 50-50 chance of using proxy vs. priority_proxy;
• ROTATING_PROXY_LOGSTATS_INTERVAL - stats logging interval in seconds, 30 by default;
• ROTATING_PROXY_CLOSE_SPIDER - When True, spider is stopped if there are no alive proxies. If False (default), then when there is no alive proxies all dead proxies are re-checked.

• ROTATING_PROXY_PAGE_RETRY_TIMES - a number of times to retry downloading a page using a different proxy. After this amount of retries failure is considered a page failure, not a proxy failure. Think of it this way: every improperly detected ban cost you ROTATING_PROXY_PAGE_RETRY_TIMES alive proxies. Default: 5.

  It is possible to change this option per-request using max_proxies_to_try request.meta key - for example, you can use a higher value for certain pages if you're sure they should work.

• ROTATING_PROXY_BACKOFF_BASE - base backoff time, in seconds. Default is 300 (i.e. 5 min).
• ROTATING_PROXY_BACKOFF_CAP - backoff time cap, in seconds. Default is 3600 (i.e. 60 min).
• ROTATING_PROXY_BAN_POLICY - path to a ban detection policy. Default is 'rotating_proxies.policy.BanDetectionPolicy'.

FAQ

Q: Where to get proxy lists? How to write and maintain ban rules?

A: It is up to you to find proxies and maintain proper ban rules for web sites; scrapy-rotating-proxies doesn't have anything built-in. There are commercial proxy services like https://crawlera.com/ which can integrate with Scrapy (see https://github.com/scrapy-plugins/scrapy-crawlera) and take care of all these details.

Contributing

• source code: https://github.com/TeamHG-Memex/scrapy-rotating-proxies
• bug tracker: https://github.com/TeamHG-Memex/scrapy-rotating-proxies/issues

To run tests, install tox and run tox from the source checkout.

---