Release notes
When HttpProxyMiddleware processes a request with metadata, and that proxy metadata includes proxy credentials, sets the
Proxy-Authentication
header, but only if that header is not already set.There are third-party proxy-rotation downloader middlewares that set different proxy metadata every time they process a request.
Because of request retries and redirects, the same request can be processed by downloader middlewares more than once, including both and any third-party proxy-rotation downloader middleware.
These third-party proxy-rotation downloader middlewares could change the proxy metadata of a request to a new value, but fail to remove the
Proxy-Authentication
header from the previous value of the metadata, causing the credentials of one proxy to be sent to a different proxy.To prevent the unintended leaking of proxy credentials, the behavior of HttpProxyMiddleware is now as follows when processing a request:
If the request being processed defines metadata that includes credentials, the
Proxy-Authorization
header is always updated to feature those credentials.If the request being processed defines proxy metadata without credentials, the
Proxy-Authorization
header is removed unless it was originally defined for the same proxy URL.To remove proxy credentials while keeping the same proxy URL, remove the
Proxy-Authorization
header.If the request has no metadata, or that metadata is a falsy value (e.g.
None
), theProxy-Authorization
header is removed.It is no longer possible to set a proxy URL through the proxy metadata but set the credentials through the
Proxy-Authorization
header. Set proxy credentials through the metadata instead.
Also fixes the following regressions introduced in 2.6.0:
CrawlerProcess supports again crawling multiple spiders (, issue 5436)
Installing a Twisted reactor before Scrapy does (e.g. importing somewhere at the module level) no longer prevents Scrapy from starting, as long as a different reactor is not specified in TWISTED_REACTOR (, issue 5528)
Fixed an exception that was being logged after the spider finished under certain conditions (, issue 5440)
The
--output
/-o
command-line parameter supports again a value starting with a hyphen (, issue 5445)The
scrapy parse -h
command no longer throws an error (, issue 5482)
Scrapy 2.6.1 (2022-03-01)
Fixes a regression introduced in 2.6.0 that would unset the request method when following redirects.
Scrapy 2.6.0 (2022-03-01)
Highlights:
Python 3.10 support
asyncio support is no longer considered experimental, and works out-of-the-box on Windows regardless of your Python version
Feed exports now support output paths and per-feed item filtering and
When a Request object with cookies defined gets a redirect response causing a new object to be scheduled, the cookies defined in the original Request object are no longer copied into the new object.
If you manually set the
Cookie
header on a Request object and the domain name of the redirect URL is not an exact match for the domain of the URL of the original object, yourCookie
header is now dropped from the new Request object.The old behavior could be exploited by an attacker to gain access to your cookies. Please, see the for more information.
Note
It is still possible to enable the sharing of cookies between different domains with a shared domain suffix (e.g.
example.com
and any subdomain) by defining the shared domain suffix (e.g.example.com
) as the cookie domain when defining your cookies. See the documentation of the Request class for more information.When the domain of a cookie, either received in the
Set-Cookie
header of a response or defined in a object, is set to a public suffix, the cookie is now ignored unless the cookie domain is the same as the request domain.The old behavior could be exploited by an attacker to inject cookies from a controlled domain into your cookiejar that could be sent to other domains not controlled by the attacker. Please, see the for more information.
Modified requirements
- The dependency is now optional, only needed to enable HTTP/2 support. ()
Backward-incompatible changes
The
formdata
parameter ofFormRequest
, if specified for a non-POST request, now overrides the URL query string, instead of being appended to it. (, issue 3579)When a function is assigned to the setting, now the return value of that function, and not the
params
input parameter, will determine the feed URI parameters, unless that return value isNone
. (issue 4962, )In
scrapy.core.engine.ExecutionEngine
, methodscrawl()
,download()
,schedule()
, andspider_is_idle()
now raise RuntimeError if called beforeopen_spider()
. ()These methods used to assume that
ExecutionEngine.slot
had been defined by a prior call toopen_spider()
, so they were raising AttributeError instead.If the API of the configured does not meet expectations, TypeError is now raised at startup time. Before, other exceptions would be raised at run time. ()
The
_encoding
field of serialized Request objects is now namedencoding
, in line with all other fields ()
Deprecation removals
scrapy.http.TextResponse.body_as_unicode
, deprecated in Scrapy 2.2, has now been removed. ()scrapy.item.BaseItem
, deprecated in Scrapy 2.2, has now been removed. (issue 5398)scrapy.item.DictItem
, deprecated in Scrapy 1.8, has now been removed. ()scrapy.Spider.make_requests_from_url
, deprecated in Scrapy 1.4, has now been removed. (issue 4178, )
Deprecations
When a function is assigned to the setting, returning
None
or modifying theparams
input parameter is now deprecated. Return a new dictionary instead. (issue 4962, )scrapy.utils.reqser
is deprecated. (issue 5130)Instead of
request_to_dict()
, use the new method.Instead of
request_from_dict()
, use the new scrapy.utils.request.request_from_dict() function.
In
scrapy.squeues
, the following queue classes are deprecated:PickleFifoDiskQueueNonRequest
,PickleLifoDiskQueueNonRequest
,MarshalFifoDiskQueueNonRequest
, andMarshalLifoDiskQueueNonRequest
. You should instead use:PickleFifoDiskQueue
,PickleLifoDiskQueue
,MarshalFifoDiskQueue
, andMarshalLifoDiskQueue
. ()Many aspects of
scrapy.core.engine.ExecutionEngine
that come from a time when this class could handle multiple Spider objects at a time have been deprecated. ()The
has_capacity()
method is deprecated.The
schedule()
method is deprecated, usecrawl()
ordownload()
instead.The
open_spiders
attribute is deprecated, usespider
instead.The
spider
parameter is deprecated for the following methods:spider_is_idle()
crawl()
download()
Instead, call
open_spider()
first to set the Spider object.
New features
You can now use item filtering to control which items are exported to each output feed. (, issue 5178, , issue 5203)
You can now apply to feeds, and built-in post-processing plugins are provided for output file compression. (, issue 5168, )
The FEEDS setting now supports objects as keys. (issue 5383, )
Enabling asyncio while using Windows and Python 3.8 or later will automatically switch the asyncio event loop to one that allows Scrapy to work. See . (issue 4976, )
The genspider command now supports a start URL instead of a domain name. ()
scrapy.utils.defer
gained 2 new functions, deferred_to_future() and , to help await on Deferreds when using the asyncio reactor. ()Amazon S3 feed export storage gained support for (AWS_SESSION_TOKEN) and endpoint customization (). (issue 4998, )
New LOG_FILE_APPEND setting to allow truncating the log file. ()
Request.cookies
values that are bool, or int are cast to . (issue 5252, )You may now raise CloseSpider from a handler of the signal to customize the reason why the spider is stopping. (issue 5191)
When using , the proxy URL for non-HTTPS HTTP/1.1 requests no longer needs to include a URL scheme. (issue 4505, )
All built-in queues now expose a
peek
method that returns the next queue object (likepop
) but does not remove the returned object from the queue. (issue 5112)If the underlying queue does not support peeking (e.g. because you are not using
queuelib
1.6.1 or later), thepeek
method raises .Request and now have an
attributes
attribute that makes subclassing easier. For Request, it also allows subclasses to work with . (issue 1877, , issue 5218)The and close() methods of the are now optional. (issue 3559)
HTTP/1.1
TunnelError
exceptions now only truncate response bodies longer than 1000 characters, instead of those longer than 32 characters, making it easier to debug such errors. (, issue 5007)now supports non-text responses. (issue 5145, )
Bug fixes
The and ASYNCIO_EVENT_LOOP settings are no longer ignored if defined in . (issue 4485, )
Removed a module-level Twisted reactor import that could prevent using the asyncio reactor. ()
The startproject command works with existing folders again. (, issue 4676)
The setting now behaves as documented. (issue 4962, )
Request.cb_kwargs
once again allows thecallback
keyword. (issue 5237, , issue 5264)Made
scrapy.utils.response.open_in_browser()
support more complex HTML. (, issue 5320)Fixed being interpreted as the CSV file encoding. (issue 5391, )
Added missing setuptools to the list of dependencies. ()
LinkExtractor now also works as expected with links that have comma-separated
rel
attribute values includingnofollow
. ()Fixed a TypeError that could be raised during parameter parsing. (issue 5359)
Documentation
asyncio support is no longer considered experimental. ()
Included Windows-specific help for asyncio usage. (, issue 5315)
Rewrote with up-to-date best practices. (issue 4484, )
Documented local file naming in media pipelines. (, issue 5152)
now covers spider file name collision issues. (issue 2680, )
Provided better context and instructions to disable the URLLENGTH_LIMIT setting. (, issue 5250)
Documented that does not support Python 3.9+. (issue 5226, )
Documented the scheduler component. (, issue 3559)
Documented the method used by to determine if a file has expired. (, issue 5254)
now features
scrapy.utils.project.get_project_settings()
usage. (issue 5070)now covers what happens when you define different per-spider values for some settings that cannot differ at run time. (issue 4485, )
Extended the documentation of the StatsMailer extension. (, issue 5217)
Added to Settings. (, issue 5224)
Documented
Spider.attribute
. (, issue 5244)Documented . (issue 1582)
Added the
body_length
parameter to the documented signature of the signal. (issue 5270)Clarified usage in the tutorial. ()
The documentation now features the shortest import path of classes with multiple import paths. (issue 2733, )
quotes.toscrape.com
references now use HTTPS instead of HTTP. (issue 5395, )Added a link to our Discord server to . (issue 5421, )
The pronunciation of the project name is now officially /ˈskreɪpaɪ/. (, issue 5281)
Added the Scrapy logo to the README. (, issue 5258)
Fixed issues and implemented minor improvements. (, issue 4335, , issue 5098, , issue 5180, , issue 5239, , issue 5271, , issue 5274, , issue 5347, , issue 5414, , issue 5416, , issue 5420)
Quality Assurance
Added support for Python 3.10. (issue 5212, , issue 5265)
Significantly reduced memory usage by
scrapy.utils.response.response_httprepr()
, used by the downloader middleware, which is enabled by default. (issue 4964, )Removed uses of the deprecated optparse module. (, issue 5374)
Extended typing hints. (, issue 5090, , issue 5108, , issue 5215, )
Improved tests, fixed CI issues, removed unused code. (issue 5094, , issue 5162, , issue 5207, , issue 5229, , issue 5299, , issue 5316, , issue 5388, , issue 5400, , issue 5404, , issue 5407, , issue 5412, , issue 5427)
Implemented improvements for contributors. (, issue 5082, , issue 5200)
Implemented cleanups. (, issue 5106, , issue 5228, , issue 5245, , issue 5292, , issue 5322)
Scrapy 2.5.1 (2021-10-05)
Security bug fix:
If you use HttpAuthMiddleware (i.e. the
http_user
andhttp_pass
spider attributes) for HTTP authentication, any request exposes your credentials to the request target.To prevent unintended exposure of authentication credentials to unintended domains, you must now additionally set a new, additional spider attribute,
http_auth_domain
, and point it to the specific domain to which the authentication credentials must be sent.If the
http_auth_domain
spider attribute is not set, the domain of the first request will be considered the HTTP authentication target, and authentication credentials will only be sent in requests targeting that domain.If you need to send the same HTTP authentication credentials to multiple domains, you can use instead to set the value of the
Authorization
header of your requests.If you really want your spider to send the same HTTP authentication credentials to any domain, set the
http_auth_domain
spider attribute toNone
.Finally, if you are a user of scrapy-splash, know that this version of Scrapy breaks compatibility with scrapy-splash 0.7.2 and earlier. You will need to upgrade scrapy-splash to a greater version for it to continue to work.
Scrapy 2.5.0 (2021-04-06)
Highlights:
Official Python 3.9 support
Experimental HTTP/2 support
New function to retry requests from spider callbacks
New headers_received signal that allows stopping downloads early
New attribute
Deprecation removals
Removed all code that and had not already been removed in 2.4.0. ()
Removed support for the
SCRAPY_PICKLED_SETTINGS_TO_OVERRIDE
environment variable, deprecated in 1.8.0. ()
Deprecations
- The
scrapy.utils.py36
module is now deprecated in favor ofscrapy.utils.asyncgen
. ()
New features
Experimental through a new download handler that can be assigned to the
https
protocol in the DOWNLOAD_HANDLERS setting. (, issue 4769, , issue 5059, )The new scrapy.downloadermiddlewares.retry.get_retry_request() function may be used from spider callbacks or middlewares to handle the retrying of a request beyond the scenarios that supports. (issue 3590, , issue 4902)
The new signal gives early access to response headers and allows stopping downloads. (, issue 4897)
The new attribute gives access to the string that identifies the protocol used to download a response. (issue 4878)
now include the following entries that indicate the number of successes and failures in storing feeds:
Where
<storage type>
is the feed storage backend class name, such asFileFeedStorage
orFTPFeedStorage
.(, issue 4850)
The spider middleware now logs ignored URLs with
INFO
logging level instead ofDEBUG
, and it now includes the following entry into to keep track of the number of ignored URLs:urllength/request_ignored_count
The downloader middleware now logs the number of decompressed responses and the total count of resulting bytes:
httpcompression/response_bytes
httpcompression/response_count
(issue 4797, )
Bug fixes
Fixed installation on PyPy installing PyDispatcher in addition to PyPyDispatcher, which could prevent Scrapy from working depending on which package got imported. (, issue 4814)
When inspecting a callback to check if it is a generator that also returns a value, an exception is no longer raised if the callback has a docstring with lower indentation than the following code. (, issue 4935)
The header is no longer omitted from responses when using the default, HTTP/1.1 download handler (see DOWNLOAD_HANDLERS). (, issue 5034, , issue 5057, )
Setting the handle_httpstatus_all request meta key to
False
now has the same effect as not setting it at all, instead of having the same effect as setting it toTrue
. (, issue 4694)
Documentation
Added instructions to install Scrapy in Windows using pip. (, issue 4736)
Logging documentation now includes . (issue 4216, , issue 4965)
Covered how to deal with long lists of allowed domains in the . (issue 2263, )
Covered scrapy-bench in . (issue 4996, )
Clarified that one extension instance is created per crawler. ()
Fixed some errors in examples. (issue 4829, , issue 4907, , issue 5008)
Fixed some external links, typos, and so on. (, issue 4899, , issue 4942, , issue 5063)
The is now sorted alphabetically. (issue 5061, )
Updated references to Scrapinghub, which is now called Zyte. (issue 4973, )
Added a mention to contributors in the README. (issue 4956)
Reduced the top margin of lists. ()
Quality Assurance
Made Python 3.9 support official (, issue 4759)
Extended typing hints ()
Fixed deprecated uses of the Twisted API. (issue 4940, , issue 5073)
Made our tests run with the new pip resolver. (, issue 4814)
Added tests to ensure that is tested. (issue 4987)
Migrated from Travis CI to GitHub Actions. ()
Fixed CI issues. (issue 4986, , issue 5022, , issue 5052, )
Implemented code refactorings, style fixes and cleanups. (issue 4911, , issue 5001, , issue 5076)
Scrapy 2.4.1 (2020-11-17)
Fixed feed exports overwrite support (, issue 4857, )
Fixed the AsyncIO event loop handling, which could make code hang (issue 4855, )
Fixed the IPv6-capable DNS resolver
CachingHostnameResolver
for download handlers that call reactor.resolve (, issue 4803)Fixed the output of the command showing placeholders instead of the import path of the generated spider module (issue 4874)
Migrated Windows CI from Azure Pipelines to GitHub Actions (, issue 4876)
Scrapy 2.4.0 (2020-10-11)
Highlights:
Python 3.5 support has been dropped.
The
file_path
method of media pipelines can now access the source .This allows you to set a download file path based on item data.
The new
item_export_kwargs
key of the FEEDS setting allows to define keyword parameters to pass toYou can now choose whether feed exports overwrite or append to the output file.
For example, when using the or runspider commands, you can use the
-O
option instead of-o
to overwrite the output file.Zstd-compressed responses are now supported if is installed.
In settings, where the import path of a class is required, it is now possible to pass a class object instead.
Modified requirements
Python 3.6 or greater is now required; support for Python 3.5 has been dropped
As a result:
When using PyPy, PyPy 7.2.0 or greater
For Amazon S3 storage support in feed exports or , botocore 1.4.87 or greater is now required
To use the , Pillow 4.0.0 or greater is now required
(, issue 4732, , issue 4742, , issue 4764)
Backward-incompatible changes
CookiesMiddleware once again discards cookies defined in .
We decided to revert this bug fix, introduced in Scrapy 2.2.0, because it was reported that the current implementation could break existing code.
If you need to set cookies for a request, use the Request.cookies parameter.
A future version of Scrapy will include a new, better implementation of the reverted bug fix.
(, issue 4823)
Deprecation removals
scrapy.extensions.feedexport.S3FeedStorage
no longer reads the values ofaccess_key
andsecret_key
from the running project settings when they are not passed to its__init__
method; you must either pass those parameters to its__init__
method or useS3FeedStorage.from_crawler
(issue 4356, , issue 4688)Rule.process_request
no longer admits callables which expect a singlerequest
parameter, rather than bothrequest
andresponse
()
Deprecations
In custom , signatures that do not accept a keyword-only
item
parameter in any of the methods that now support this parameter are now deprecated (, issue 4686)In custom ,
__init__
method signatures that do not accept a keyword-onlyfeed_options
parameter are now deprecated (issue 547, , issue 4512)The
scrapy.utils.python.WeakKeyCache
class is now deprecated (, issue 4701)The
scrapy.utils.boto.is_botocore()
function is now deprecated, usescrapy.utils.boto.is_botocore_available()
instead (, issue 4776)
New features
The following methods of media pipelines now accept an
item
keyword-only parameter containing the source :In scrapy.pipelines.files.FilesPipeline:
file_downloaded()
media_downloaded()
media_to_download()
In scrapy.pipelines.images.ImagesPipeline:
file_downloaded()
get_images()
image_downloaded()
media_downloaded()
media_to_download()
(issue 4628, )
The new
item_export_kwargs
key of the FEEDS setting allows to define keyword parameters to pass to (issue 4606, )Feed exports gained overwrite support:
When using the or runspider commands, you can use the
-O
option instead of-o
to overwrite the output fileYou can use the
overwrite
key in the setting to configure whether to overwrite the output file (True
) or append to its content (False
)The
__init__
andfrom_crawler
methods of feed storage backend classes now receive a new keyword-only parameter,feed_options
, which is a dictionary of
(issue 547, , issue 4512)
Zstd-compressed responses are now supported if is installed (issue 4831)
In settings, where the import path of a class is required, it is now possible to pass a class object instead (, issue 3873).
This includes also settings where only part of its value is made of an import path, such as or DOWNLOAD_HANDLERS.
can now override response.request.
If a returns a Response object from or process_exception() with a custom object assigned to response.request:
The response is handled by the callback of that custom object, instead of being handled by the callback of the original Request object
That custom object is now sent as the
request
argument to the response_received signal, instead of the original object
(issue 4529, )
When using the FTP feed storage backend:
It is now possible to set the new
overwrite
toFalse
to append to an existing file instead of overwriting itThe FTP password can now be omitted if it is not necessary
(issue 547, , issue 4512)
The
__init__
method of now supports anerrors
parameter to indicate how to handle encoding errors (issue 4755)When , it is now possible to set a custom asyncio loop (, issue 4414)
Serialized requests (see ) now support callbacks that are spider methods that delegate on other callable (issue 4756)
When a response is larger than , the logged message is now a warning, instead of an error (issue 3874, , issue 4752)
Bug fixes
The genspider command no longer overwrites existing files unless the
--force
option is used (, issue 4616, )Cookies with an empty value are no longer considered invalid cookies (issue 4772)
The command now supports files with the
.pyw
file extension (issue 4643, )The HttpProxyMiddleware middleware now simply ignores unsupported proxy values (, issue 4778)
Checks for generator callbacks with a
return
statement no longer warn aboutreturn
statements in nested functions (, issue 4721)The system file mode creation mask no longer affects the permissions of files generated using the command (issue 4722)
scrapy.utils.iterators.xmliter()
now supports namespaced node names (, issue 4746)Request
objects can now haveabout:
URLs, which can work when using a headless browser ()
Documentation
The setting is now documented (issue 4671, )
Improved the documentation of link extractors with an usage example from a spider callback and reference documentation for the class (issue 4751, )
Clarified the impact of CONCURRENT_REQUESTS when using the extension (issue 4836)
Removed references to Python 2’s
unicode
type (, issue 4703)We now have an (issue 4705)
Our now cover usage of Sphinx’s versionadded and directives, and we have removed usages referencing Scrapy 1.4.0 and earlier versions (issue 3971, )
Other documentation cleanups (issue 4090, , issue 4800, , issue 4809, , issue 4825)
Quality assurance
Extended typing hints (issue 4243, )
Added tests for the check command ()
Fixed test failures on Debian (issue 4726, , issue 4735)
Improved Windows test coverage ()
Switched to formatted string literals where possible (, issue 4324, )
Modernized
super()
usage (issue 4707)Other code and test cleanups (, issue 3288, , issue 4564, , issue 4714, , issue 4745, , issue 4761, , issue 4804, , issue 4820, , issue 4839)
Scrapy 2.3.0 (2020-08-04)
Highlights:
Feed exports now support as a storage backend
The new FEED_EXPORT_BATCH_ITEM_COUNT setting allows to deliver output items in batches of up to the specified number of items.
It also serves as a workaround for , which causes Scrapy to only start item delivery after the crawl has finished when using certain storage backends (S3, , and now GCS).
The base implementation of has been moved into a separate library, itemloaders, allowing usage from outside Scrapy and a separate release schedule
Deprecation removals
Removed the following classes and their parent modules from
scrapy.linkextractors
:htmlparser.HtmlParserLinkExtractor
regex.RegexLinkExtractor
sgml.BaseSgmlLinkExtractor
sgml.SgmlLinkExtractor
Use LinkExtractor instead (, issue 4679)
Deprecations
- The
scrapy.utils.python.retry_on_eintr
function is now deprecated (issue 4683)
New features
Feed exports support (issue 685, )
New FEED_EXPORT_BATCH_ITEM_COUNT setting for batch deliveries (, issue 4434)
The command now allows specifying an output file (issue 4317, )
Request.from_curl and now also support
--data-raw
(issue 4612)A
parse
callback may now be used in built-in spider subclasses, such as (issue 712, , issue 781, )
Bug fixes
Fixed the of dataclass items and (issue 4667, )
Request.from_curl and now set the request method to
POST
when a request body is specified and no request method is specified (issue 4612)The processing of ANSI escape sequences in enabled in Windows 10.0.14393 and later, where it is required for colored output (, issue 4403)
Documentation
Updated the OpenSSL cipher list format link in the documentation about the setting (issue 4653)
Simplified the code example in (issue 4652)
Quality assurance
The base implementation of item loaders has been moved into (issue 4005, )
Fixed a silenced error in some scheduler tests (issue 4644, )
Renewed the localhost certificate used for SSL tests (issue 4650)
Removed cookie-handling code specific to Python 2 ()
Stopped using Python 2 unicode literal syntax (issue 4704)
Stopped using a backlash for line continuation ()
Removed unneeded entries from the MyPy exception list (issue 4690)
Automated tests now pass on Windows as part of our continuous integration system ()
Automated tests now pass on the latest PyPy version for supported Python versions in our continuous integration system (issue 4504)
Scrapy 2.2.1 (2020-07-17)
- The startproject command no longer makes unintended changes to the permissions of files in the destination folder, such as removing execution permissions (, issue 4666)
Scrapy 2.2.0 (2020-06-24)
Highlights:
Python 3.5.2+ is required now
dataclass objects and are now valid item types
New method
New bytes_received signal that allows canceling response download
fixes
Backward-incompatible changes
- Support for Python 3.5.0 and 3.5.1 has been dropped; Scrapy now refuses to run with a Python version lower than 3.5.2, which introduced (issue 4615)
Deprecations
TextResponse.body_as_unicode
is now deprecated, use TextResponse.text instead (, issue 4555, )scrapy.item.BaseItem
is now deprecated, usescrapy.item.Item
instead (issue 4534)
New features
dataclass objects and are now valid item types, and a new library makes it easy to write code that supports any item type (, issue 2807, , issue 3881, )
A new TextResponse.json method allows to deserialize JSON responses (, issue 4460, )
A new bytes_received signal allows monitoring response download progress and (issue 4205, )
The dictionaries in the result list of a media pipeline now include a new key,
status
, which indicates if the file was downloaded or, if the file was not downloaded, why it was not downloaded; see for more information (issue 2893, )When using Google Cloud Storage for a , a warning is now logged if the configured credentials do not grant the required permissions (issue 4346, )
Link extractors are now serializable, as long as you do not use for parameters; for example, you can now pass link extractors in Request.cb_kwargs or when persisting scheduled requests ()
Upgraded the pickle protocol that Scrapy uses from protocol 2 to protocol 4, improving serialization capabilities and performance (, issue 4541)
scrapy.utils.misc.create_instance()
now raises a exception if the resulting instance isNone
(issue 4528, )
Bug fixes
no longer discards cookies defined in Request.headers (, issue 2400)
no longer re-encodes cookies defined as bytes in the
cookies
parameter of the__init__
method of (issue 2400, )When FEEDS defines multiple URIs, is
False
and the crawl yields no items, Scrapy no longer stops feed exports after the first URI (issue 4621, )Spider callbacks defined using no longer need to return an iterable, and may instead return a Request object, an , or
None
(issue 4609)The command now ensures that the generated project folders and files have the right permissions (issue 4604)
Fix a exception being sometimes raised from
scrapy.utils.datatypes.LocalWeakReferencedCache
(issue 4597, )When FEEDS defines multiple URIs, log messages about items being stored now contain information from the corresponding feed, instead of always containing information about only one of the feeds (, issue 4629)
Documentation
Added a new section about accessing cb_kwargs from errbacks (, issue 4634)
Covered in Parsing JavaScript code (, issue 4562)
Removed from the warning about the API being experimental (issue 4511, )
Removed references to unsupported versions of Twisted ()
Updated the description of the screenshot pipeline example, which now uses instead of returning a Deferred (, issue 4593)
Removed a misleading import line from the code example (issue 4510, )
The display-on-hover behavior of internal documentation references now also covers links to commands, keys, settings and (issue 4495, )
It is again possible to download the documentation for offline reading (issue 4578, )
Removed backslashes preceding
*args
and**kwargs
in some function and method signatures (issue 4592, )
Quality assurance
Adjusted the code base further to our (issue 4237, , issue 4538, , issue 4540, , issue 4543, , issue 4545, , issue 4558, , issue 4568, )
Removed remnants of Python 2 support (issue 4550, , issue 4568)
Improved code sharing between the and runspider commands (, issue 4552)
Replaced
chain(*iterable)
withchain.from_iterable(iterable)
()You may now run the asyncio tests with Tox on any Python version ()
Updated test requirements to reflect an incompatibility with pytest 5.4 and 5.4.1 (issue 4588)
Improved test coverage for scenarios involving duplicate spider names (issue 4549, )
Configured Travis CI to also run the tests with Python 3.5.2 (issue 4518, )
Added a Pylint job to Travis CI ()
Added a Mypy job to Travis CI ()
Made use of set literals in tests (issue 4573)
Cleaned up the Travis CI configuration (, issue 4519, , issue 4537)
Scrapy 2.1.0 (2020-04-24)
Highlights:
New FEEDS setting to export to multiple feeds
New attribute
Backward-incompatible changes
exceptions triggered by assert statements have been replaced by new exception types, to support running Python in optimized mode (see ) without changing Scrapy’s behavior in any unexpected ways.
If you catch an AssertionError exception from Scrapy, update your code to catch the corresponding new exception.
()
Deprecation removals
The
LOG_UNSERIALIZABLE_REQUESTS
setting is no longer supported, use instead (issue 4385)The
REDIRECT_MAX_METAREFRESH_DELAY
setting is no longer supported, use instead (issue 4385)The
ChunkedTransferMiddleware
middleware has been removed, including the entirescrapy.downloadermiddlewares.chunked
module; chunked transfers work out of the box ()The
spiders
property has been removed from Crawler, useCrawlerRunner.spider_loader
or instantiate with your settings instead (issue 4398)The
MultiValueDict
,MultiValueDictKeyError
, andSiteNode
classes have been removed fromscrapy.utils.datatypes
()
Deprecations
- The
FEED_FORMAT
andFEED_URI
settings have been deprecated in favor of the new setting (issue 1336, , issue 4507)
New features
A new setting, FEEDS, allows configuring multiple output feeds with different settings each (, issue 3858, )
The crawl and commands now support multiple
-o
parameters (issue 1336, , issue 4507)The and runspider commands now support specifying an output format by appending
:<format>
to the output file (, issue 3858, )The new Response.ip_address attribute gives access to the IP address that originated a response (, issue 3940)
A warning is now issued when a value in
allowed_domains
includes a port (, issue 3198, )Zsh completion now excludes used option aliases from the completion list (issue 4438)
Bug fixes
Request serialization no longer breaks for callbacks that are spider attributes which are assigned a function with a different name ()
None
values inallowed_domains
no longer cause a TypeError exception ()Zsh completion no longer allows options after arguments (issue 4438)
zope.interface 5.0.0 and later versions are now supported (, issue 4448)
Spider.make_requests_from_url
, deprecated in Scrapy 1.4.0, now issues a warning when used ()
Documentation
Improved the documentation about signals that allow their handlers to return a (issue 4295, )
Our PyPI entry now includes links for our documentation, our source code repository and our issue tracker (issue 4456)
Covered the service in the documentation (issue 4206, )
Removed references to the Guppy library, which only works in Python 2 (issue 4285, )
Extended use of InterSphinx to link to Python 3 documentation (issue 4444, )
Added support for Sphinx 3.0 and later (issue 4475, , issue 4496, )
Quality assurance
Removed warnings about using old, removed settings ()
Removed a warning about importing StringTransport from
twisted.test.proto_helpers
in Twisted 19.7.0 or newer ()Removed outdated Debian package build files (issue 4384)
Removed usage as a base class (issue 4430)
Removed code that added support for old versions of Twisted that we no longer support ()
Fixed code style issues (issue 4468, , issue 4471, )
Removed twisted.internet.defer.returnValue() calls (, issue 4446, )
Scrapy 2.0.1 (2020-03-18)
now supports an empty URL iterable as input (issue 4408, )
Removed top-level reactor imports to prevent errors about the wrong Twisted reactor being installed when setting a different Twisted reactor using (issue 4401, )
Fixed tests (issue 4422)
Scrapy 2.0.0 (2020-03-03)
Highlights:
Python 2 support has been removed
Partial support and experimental support
New Response.follow_all method
for media pipelines
New Response.certificate attribute
IPv6 support through
Backward-incompatible changes
Python 2 support has been removed, following (issue 4091, , issue 4115, , issue 4138, , issue 4242, , issue 4309, )
Retry gaveups (see RETRY_TIMES) are now logged as errors instead of as debug information (, issue 3566)
File extensions that ignores by default now also include
7z
,7zip
,apk
,bz2
,cdr
,dmg
,ico
,iso
,tar
,tar.gz
,webm
, andxz
(issue 1837, , issue 4066)The setting is now an empty list by default, following web browser behavior (issue 3844, )
The HttpCompressionMiddleware now includes spaces after commas in the value of the
Accept-Encoding
header that it sets, following web browser behavior ()The
__init__
method of custom download handlers (see DOWNLOAD_HANDLERS) or subclasses of the following downloader handlers no longer receives asettings
parameter:scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler
scrapy.core.downloader.handlers.file.FileDownloadHandler
Use the
from_settings
orfrom_crawler
class methods to expose such a parameter to your custom download handlers.()
We have refactored the scrapy.core.scheduler.Scheduler class and related queue classes (see , SCHEDULER_DISK_QUEUE and ) to make it easier to implement custom scheduler queue classes. See Changes to scheduler queue classes below for details.
Overridden settings are now logged in a different format. This is more in line with similar information logged at startup ()
Deprecation removals
The no longer provides a sel proxy object, use
response.selector
instead (issue 4347)LevelDB support has been removed ()
The following functions have been removed from
scrapy.utils.python
:isbinarytext
,is_writable
,setattr_default
,stringify_dict
(issue 4362)
Deprecations
Using environment variables prefixed with
SCRAPY_
to override settings is deprecated (issue 4300, , issue 4375)scrapy.linkextractors.FilteringLinkExtractor
is deprecated, use instead (issue 4045)The
noconnect
query string argument of proxy URLs is deprecated and should be removed from proxy URLs ()The
next
method ofscrapy.utils.python.MutableChain
is deprecated, use the global next() function orMutableChain.__next__
instead ()
New features
Added for Python’s coroutine syntax and for asyncio and -powered libraries (issue 4010, , issue 4269, , issue 4271, , issue 4318)
The new method offers the same functionality as Response.follow but supports an iterable of URLs as input and returns an iterable of requests (, issue 4057, )
Media pipelines now support (issue 3928, )
The new Response.certificate attribute exposes the SSL certificate of the server as a object for HTTPS responses (issue 2726, )
A new DNS_RESOLVER setting allows enabling IPv6 support (, issue 4227)
A new setting allows configuring the existing soft limit that pauses request downloads when the total response data being processed is too high (issue 1410, )
A new TWISTED_REACTOR setting allows customizing the that Scrapy uses, allowing to enable asyncio support or deal with a (issue 2905, )
Scheduler disk and memory queues may now use the class methods
from_crawler
orfrom_settings
(issue 3884)The new attribute serves as a shortcut for Response.request.cb_kwargs ()
Response.follow now supports a
flags
parameter, for consistency with (issue 4277, )Item loader processors can now be regular functions, they no longer need to be methods ()
Rule now accepts an
errback
parameter ()Request no longer requires a
callback
parameter when anerrback
parameter is specified (, issue 4008)now supports some additional methods:
download_error for download errors
for exceptions raised during item processing by item pipelines
for exceptions raised from spider callbacks
(, issue 3986, , issue 4176, )
The
FEED_URI
setting now supports pathlib.Path values (, issue 4074)A new signal is sent when a request leaves the downloader (issue 4303)
Scrapy logs a warning when it detects a request callback or errback that uses
yield
but also returns a value, since the returned value would be lost (, issue 3869)objects now raise an AttributeError exception if they do not have a
start_urls
attribute nor reimplementstart_requests
, but have astart_url
attribute (, issue 4170)subclasses may now use
super().__init__(**kwargs)
instead ofself._configure(kwargs)
in their__init__
method, passingdont_fail=True
to the parent__init__
method if needed, and accessingkwargs
atself._kwargs
after calling their parent__init__
method (issue 4193, )A new
keep_fragments
parameter ofscrapy.utils.request.request_fingerprint()
allows to generate different fingerprints for requests with different fragments in their URL (issue 4104)Download handlers (see ) may now use the
from_settings
andfrom_crawler
class methods that other Scrapy components already supported (issue 4126)scrapy.utils.python.MutableChain.__iter__
now returnsself
, (issue 4153)
Bug fixes
The crawl command now also exits with exit code 1 when an exception happens before the crawling starts (, issue 4207)
no longer re-encodes the query string or URLs from non-UTF-8 responses in UTF-8 (issue 998, , issue 1949, )
The first spider middleware (see SPIDER_MIDDLEWARES) now also processes exceptions raised from callbacks that are generators (, issue 4272)
Redirects to URLs starting with 3 slashes (
///
) are now supported (, issue 4042)no longer accepts strings as
url
simply because they have a colon (issue 2552, )The correct encoding is now used for attach names in MailSender (, issue 4239)
RFPDupeFilter
, the default , no longer writes an extra\r
character on each line in Windows, which made the size of therequests.seen
file unnecessarily large on that platform (issue 4283)Z shell auto-completion now looks for
.html
files, not.http
files, and covers the-h
command-line switch (, issue 4291)Adding items to a
scrapy.utils.datatypes.LocalCache
object without alimit
defined no longer raises a exception (issue 4123)Fixed a typo in the message of the exception raised when
scrapy.utils.misc.create_instance()
gets bothsettings
andcrawler
set toNone
(issue 4128)
API documentation now links to an online, syntax-highlighted view of the corresponding source code ()
Links to unexisting documentation pages now allow access to the sidebar (issue 4152, )
Cross-references within our documentation now display a tooltip when hovered (issue 4173, )
Improved the documentation about LinkExtractor.extract_links and simplified (issue 4045)
Clarified how works (issue 3574, )
Clarified that logging.basicConfig() should not be used when also using (issue 2149, , issue 3146, )
Clarified the requirements for Request objects (issue 4124, )
Clarified how to install a custom image pipeline (, issue 4252)
Fixed the signatures of the
file_path
method in examples (issue 4290)Covered a backward-incompatible change in Scrapy 1.7.0 affecting custom subclasses (issue 4274)
Improved the
README.rst
andCODE_OF_CONDUCT.md
files ()Documentation examples are now checked as part of our test suite and we have fixed some of the issues detected (issue 4142, , issue 4171, , issue 4190)
Fixed logic issues, broken links and typos (, issue 4258, , issue 4288, , issue 4308, , issue 4338, , issue 4361)
Improved consistency when referring to the
__init__
method of an object (, issue 4088)Fixed an inconsistency between code and output in (issue 4213)
Extended usage (issue 4147, , issue 4185, , issue 4197)
We now use a recent version of Python to build the documentation (, issue 4249)
Cleaned up documentation (, issue 4275)
Quality assurance
Re-enabled proxy
CONNECT
tests (issue 2545, )Added Bandit security checks to our test suite (, issue 4181)
Added style checks to our test suite and applied many of the corresponding changes (issue 3944, , issue 4137, , issue 4167, , issue 4186, , issue 4238, , issue 4355, , issue 4365)
Improved test coverage (, issue 4218, )
Started reporting slowest tests, and improved the performance of some of them (issue 4163, )
Fixed broken tests and refactored some tests (issue 4014, , issue 4244, , issue 4372)
Modified the configuration to allow running tests with any Python version, run Bandit and tests by default, and enforce a minimum tox version programmatically (issue 4179)
Cleaned up code (, issue 4208, , issue 4210, , issue 4369, , issue 4378)
Changes to scheduler queue classes
The following changes may impact any custom queue classes of all types:
- The
push
method no longer receives a second positional parameter containingrequest.priority * -1
. If you need that value, get it from the first positional parameter,request
, instead, or use the newpriority()
method inscrapy.core.scheduler.ScrapyPriorityQueue
subclasses.
The following changes may impact custom priority queue classes:
In the
__init__
method or thefrom_crawler
orfrom_settings
class methods:The parameter that used to contain a factory function,
qfactory
, is now passed as a keyword parameter nameddownstream_queue_cls
.A new keyword parameter has been added:
key
. It is a string that is always an empty string for memory queues and indicates theJOB_DIR
value for disk queues.The parameter for disk queues that contains data from the previous crawl,
startprios
orslot_startprios
, is now passed as a keyword parameter namedstartprios
.The
serialize
parameter is no longer passed. The disk queue class must take care of request serialization on its own before writing to disk, using therequest_to_dict()
andrequest_from_dict()
functions from thescrapy.utils.reqser
module.
The following changes may impact custom disk and memory queue classes:
- The signature of the
__init__
method is now__init__(self, crawler, key)
.
The following changes affect specifically the ScrapyPriorityQueue
and DownloaderAwarePriorityQueue
classes from scrapy.core.scheduler and may affect subclasses:
In the
__init__
method, most of the changes described above apply.__init__
may still receive all parameters as positional parameters, however:downstream_queue_cls
, which replacedqfactory
, must be instantiated differently.qfactory
was instantiated with a priority value (integer).Instances of
downstream_queue_cls
should be created using the newScrapyPriorityQueue.qfactory
orDownloaderAwarePriorityQueue.pqfactory
methods.The new
key
parameter displaced thestartprios
parameter 1 position to the right.
The following class attributes have been added:
crawler
downstream_queue_cls
(details above)key
(details above)
The
serialize
attribute has been removed (details above)
The following changes affect specifically the ScrapyPriorityQueue
class and may affect subclasses:
A new
priority()
method has been added which, given a request, returnsrequest.priority * -1
.It is used in
push()
to make up for the removal of itspriority
parameter.The
spider
attribute has been removed. Usecrawler.spider
instead.
The following changes affect specifically the DownloaderAwarePriorityQueue
class and may affect subclasses:
- A new
pqueues
attribute offers a mapping of downloader slot names to the corresponding instances ofdownstream_queue_cls
.
()
Scrapy 1.8.3 (2022-07-25)
Security bug fix:
When processes a request with proxy metadata, and that metadata includes proxy credentials, HttpProxyMiddleware sets the
Proxy-Authentication
header, but only if that header is not already set.There are third-party proxy-rotation downloader middlewares that set different metadata every time they process a request.
Because of request retries and redirects, the same request can be processed by downloader middlewares more than once, including both HttpProxyMiddleware and any third-party proxy-rotation downloader middleware.
These third-party proxy-rotation downloader middlewares could change the metadata of a request to a new value, but fail to remove the
Proxy-Authentication
header from the previous value of the proxy metadata, causing the credentials of one proxy to be sent to a different proxy.To prevent the unintended leaking of proxy credentials, the behavior of is now as follows when processing a request:
If the request being processed defines proxy metadata that includes credentials, the
Proxy-Authorization
header is always updated to feature those credentials.If the request being processed defines metadata without credentials, the
Proxy-Authorization
header is removed unless it was originally defined for the same proxy URL.To remove proxy credentials while keeping the same proxy URL, remove the
Proxy-Authorization
header.If the request has no proxy metadata, or that metadata is a falsy value (e.g.
None
), theProxy-Authorization
header is removed.It is no longer possible to set a proxy URL through the metadata but set the credentials through the
Proxy-Authorization
header. Set proxy credentials through the proxy metadata instead.
Scrapy 1.8.2 (2022-03-01)
Security bug fixes:
When a Request object with cookies defined gets a redirect response causing a new object to be scheduled, the cookies defined in the original Request object are no longer copied into the new object.
If you manually set the
Cookie
header on a Request object and the domain name of the redirect URL is not an exact match for the domain of the URL of the original object, yourCookie
header is now dropped from the new Request object.The old behavior could be exploited by an attacker to gain access to your cookies. Please, see the for more information.
Note
It is still possible to enable the sharing of cookies between different domains with a shared domain suffix (e.g.
example.com
and any subdomain) by defining the shared domain suffix (e.g.example.com
) as the cookie domain when defining your cookies. See the documentation of the Request class for more information.When the domain of a cookie, either received in the
Set-Cookie
header of a response or defined in a object, is set to a public suffix, the cookie is now ignored unless the cookie domain is the same as the request domain.The old behavior could be exploited by an attacker to inject cookies into your requests to some other domains. Please, see the for more information.
Scrapy 1.8.1 (2021-10-05)
Security bug fix:
If you use (i.e. the
http_user
andhttp_pass
spider attributes) for HTTP authentication, any request exposes your credentials to the request target.To prevent unintended exposure of authentication credentials to unintended domains, you must now additionally set a new, additional spider attribute,
http_auth_domain
, and point it to the specific domain to which the authentication credentials must be sent.If the
http_auth_domain
spider attribute is not set, the domain of the first request will be considered the HTTP authentication target, and authentication credentials will only be sent in requests targeting that domain.If you need to send the same HTTP authentication credentials to multiple domains, you can use w3lib.http.basic_auth_header() instead to set the value of the
Authorization
header of your requests.If you really want your spider to send the same HTTP authentication credentials to any domain, set the
http_auth_domain
spider attribute toNone
.Finally, if you are a user of , know that this version of Scrapy breaks compatibility with scrapy-splash 0.7.2 and earlier. You will need to upgrade scrapy-splash to a greater version for it to continue to work.
Scrapy 1.8.0 (2019-10-28)
Highlights:
Dropped Python 3.4 support and updated minimum requirements; made Python 3.8 support official
New class method
New ROBOTSTXT_PARSER and settings
New DOWNLOADER_CLIENT_TLS_CIPHERS and settings
Backward-incompatible changes
Python 3.4 is no longer supported, and some of the minimum requirements of Scrapy have also changed:
0.9.1
cryptography 2.0
3.5.0
pyOpenSSL 16.2.0
1.4.2
service_identity 16.0.0
1.10.0
Twisted 17.9.0 (16.0.0 with Python 2)
()
JSONRequest
is now called JsonRequest for consistency with similar classes (, issue 3982)If you are using a custom context factory (), its
__init__
method must accept two new parameters:tls_verbose_logging
andtls_ciphers
(issue 2111, , issue 3442, )ItemLoader now turns the values of its input item into lists:
>>> item = MyItem()
>>> loader = ItemLoader(item=item)
>>> item['field']
['value1']
This is needed to allow adding values to existing fields (
loader.add_value('field', 'value2')
).(, issue 3819, , issue 3976, , issue 4036)
See also below.
New features
A new class method allows creating a request from a cURL command (, issue 3862)
A new setting allows choosing which robots.txt parser to use. It includes built-in support for , Protego (default), , and Robotexclusionrulesparser, and allows you to (issue 754, , issue 3796, , issue 3969, )
A new ROBOTSTXT_USER_AGENT setting allows defining a separate user agent string to use for parsing (issue 3931, )
Use the new DOWNLOADER_CLIENT_TLS_CIPHERS setting to customize the TLS/SSL ciphers used by the default HTTP/1.1 downloader (, issue 3442)
Set the new setting to
True
to enable debug-level messages about TLS connection parameters after establishing HTTPS connections (issue 2111, )Callbacks that receive keyword arguments (see Request.cb_kwargs) can now be tested using the new spider contract (, issue 3988)
When a spider contract fails, all missing fields are now reported (issue 766, )
Custom log formats can now drop messages by having the corresponding methods of the configured return
None
(issue 3984, )A much improved completion definition is now available for Zsh ()
Bug fixes
no longer makes later calls to ItemLoader.get_output_value() or return empty data (issue 3804, , issue 3897, , issue 3998, )
Fixed DummyStatsCollector raising a exception (issue 4007, )
FilesPipeline.file_path and no longer choose file extensions that are not registered with IANA (, issue 3953, )
When using botocore to persist files in S3, all botocore-supported headers are properly mapped now (, issue 3905)
FTP passwords in
FEED_URI
containing percent-escaped characters are now properly decoded ()A memory-handling and error-handling issue in
scrapy.utils.ssl.get_temp_key_info()
has been fixed (issue 3920)
Documentation
The documentation now covers how to define and configure a custom log format (, issue 3660)
API documentation added for and PythonItemExporter ()
API documentation added for
BaseItem
and ItemMeta ()Minor documentation fixes (issue 2998, , issue 3597, , issue 3934, , issue 3993, , issue 4028, , issue 4046, , issue 4055, , issue 4061, , issue 4071, , issue 4081, , issue 4093)
Deprecation removals
scrapy.xlib
has been removed (issue 4015)
Deprecations
The LevelDB storage backend (
scrapy.extensions.httpcache.LeveldbCacheStorage
) of is deprecated (issue 4085, )Use of the undocumented
SCRAPY_PICKLED_SETTINGS_TO_OVERRIDE
environment variable is deprecated (issue 3910)scrapy.item.DictItem
is deprecated, useItem
instead ()
Other changes
Minimum versions of optional Scrapy requirements that are covered by continuous integration tests have been updated:
1.3.23
Pillow 3.4.2
Lower versions of these optional requirements may work, but it is not guaranteed ()
GitHub templates for bug reports and feature requests (issue 3126, , issue 3749, )
Continuous integration fixes (issue 3923)
Code cleanup (, issue 3907, , issue 3950, , issue 4031)
Scrapy 1.7.4 (2019-10-21)
Revert the fix for issue 3804 (), which has a few undesired side effects (issue 3897, ).
As a result, when an item loader is initialized with an item, ItemLoader.load_item() once again makes later calls to or ItemLoader.load_item() return empty data.
Scrapy 1.7.3 (2019-08-01)
Enforce lxml 4.3.5 or lower for Python 3.4 (issue 3912, ).
Scrapy 1.7.2 (2019-07-23)
Fix Python 2 support (, issue 3893, ).
Scrapy 1.7.1 (2019-07-18)
Re-packaging of Scrapy 1.7.0, which was missing some changes in PyPI.
Scrapy 1.7.0 (2019-07-18)
Note
Make sure you install Scrapy 1.7.1. The Scrapy 1.7.0 package in PyPI is the result of an erroneous commit tagging and does not include all the changes described below.
Highlights:
Improvements for crawls targeting multiple domains
A cleaner way to pass arguments to callbacks
A new class for JSON requests
Improvements for rule-based spiders
New features for feed exports
Backward-incompatible changes
429
is now part of the setting by defaultThis change is backward incompatible. If you don’t want to retry
429
, you must override RETRY_HTTP_CODES accordingly., CrawlerRunner.crawl and no longer accept a Spider subclass instance, they only accept a subclass now.
Spider subclass instances were never meant to work, and they were not working as one would expect: instead of using the passed subclass instance, their
from_crawler
method was called to generate a new instance.Non-default values for the SCHEDULER_PRIORITY_QUEUE setting may stop working. Scheduler priority queue classes now need to handle objects instead of arbitrary Python data structures.
An additional
crawler
parameter has been added to the__init__
method of the Scheduler class. Custom scheduler subclasses which don’t accept arbitrary parameters in their__init__
method might break because of this change.For more information, see .
See also Deprecation removals below.
New features
A new scheduler priority queue,
scrapy.pqueues.DownloaderAwarePriorityQueue
, may be enabled for a significant scheduling improvement on crawls targeting multiple web domains, at the cost of no support (issue 3520)A new attribute provides a cleaner way to pass keyword arguments to callback methods (issue 1138, )
A new JSONRequest class offers a more convenient way to build JSON requests (, issue 3505)
A
process_request
callback passed to the__init__
method now receives the Response object that originated the request as its second argument ()A new
restrict_text
parameter for the LinkExtractor__init__
method allows filtering links by linking text (, issue 3635)A new setting allows defining a custom ACL for feeds exported to Amazon S3 (issue 3607)
A new setting allows using FTP’s active connection mode for feeds exported to FTP servers (issue 3829)
A new setting allows overriding which HTML tags are ignored when searching a response for HTML meta tags that trigger a redirect (issue 1422, )
A new redirect_reasons request meta key exposes the reason (status code, meta refresh) behind every followed redirect (, issue 3687)
The
SCRAPY_CHECK
variable is now set to thetrue
string during runs of the command, which allows detecting contract check runs from code (, issue 3739)A new
Item.deepcopy()
method makes it easier to (issue 1493, )CoreStats also logs
elapsed_time_seconds
now ()Exceptions from ItemLoader are now more verbose (issue 3836, )
Crawler, and CrawlerRunner.create_crawler now fail gracefully if they receive a subclass instance instead of the subclass itself (issue 2283, , issue 3872)
Bug fixes
process_spider_exception() is now also invoked for generators (, issue 2061)
System exceptions like are no longer caught (issue 3726)
no longer makes later calls to ItemLoader.get_output_value() or return empty data (issue 3804, )
The images pipeline (ImagesPipeline) no longer ignores these Amazon S3 settings: , AWS_REGION_NAME, , AWS_VERIFY ()
Fixed a memory leak in
scrapy.pipelines.media.MediaPipeline
affecting, for example, non-200 responses and exceptions from custom middlewares (issue 3813)Requests with private callbacks are now correctly unserialized from disk ()
FormRequest.from_response()
now handles invalid methods like major web browsers (issue 3777, )
Documentation
A new topic, , covers recommended approaches to read dynamically-loaded data (issue 3703)
now features information about memory usage (issue 1264, )
The documentation of Rule now covers how to access the text of a link when using (issue 3711, )
A new section, Writing your own storage backend, covers writing a custom cache storage backend for (issue 3683, )
A new FAQ entry, , explains what to do when you want to split an item into multiple items from an item pipeline (issue 2240, )
Updated the FAQ entry about crawl order to explain why the first few requests rarely follow the desired order (, issue 3621)
The setting (issue 3730), the and ImagesPipeline.file_path methods (, issue 3609) and the method (issue 3842) are now documented
Some parts of the documentation that were confusing or misleading are now clearer (, issue 1789, , issue 3069, , issue 3626, , issue 3670, , issue 3728, , issue 3861, )
Minor documentation fixes (issue 3648, , issue 3662, , issue 3676, , issue 3724, , issue 3767, , issue 3797, , issue 3812)
Deprecation removals
The following deprecated APIs have been removed (issue 3578):
scrapy.conf
(use )From
scrapy.core.downloader.handlers
:http.HttpDownloadHandler
(usehttp10.HTTP10DownloadHandler
)
scrapy.loader.ItemLoader._get_values
(use_get_xpathvalues
)scrapy.loader.XPathItemLoader
(use ItemLoader)scrapy.log
(see )From
scrapy.pipelines
:files.FilesPipeline.file_key
(usefile_path
)images.ImagesPipeline.file_key
(usefile_path
)images.ImagesPipeline.image_key
(usefile_path
)images.ImagesPipeline.thumb_key
(usethumb_path
)
From both
scrapy.selector
andscrapy.selector.lxmlsel
:From
scrapy.selector.csstranslator
:ScrapyGenericTranslator
(use parsel.csstranslator.GenericTranslator)ScrapyHTMLTranslator
(use )ScrapyXPathExpr
(use parsel.csstranslator.XPathExpr)
From :
_root
(both the__init__
method argument and the object property, useroot
)extract_unquoted
(usegetall
)select
(usexpath
)
-
extract_unquoted
(usegetall
)select
(usexpath
)x
(usexpath
)
scrapy.spiders.BaseSpider
(use Spider)From (and subclasses):
DOWNLOAD_DELAY
(use download_delay)set_crawler
(usefrom_crawler()
)
scrapy.spiders.spiders
(use )scrapy.telnet
(use scrapy.extensions.telnet)From
scrapy.utils.python
:str_to_unicode
(useto_unicode
)unicode_to_str
(useto_bytes
)
scrapy.utils.response.body_or_str
The following deprecated settings have also been removed ():
SPIDER_MANAGER_CLASS
(use SPIDER_LOADER_CLASS)
Deprecations
The
queuelib.PriorityQueue
value for the SCHEDULER_PRIORITY_QUEUE setting is deprecated. Usescrapy.pqueues.ScrapyPriorityQueue
instead.process_request
callbacks passed to that do not accept two arguments are deprecated.The following modules are deprecated:
scrapy.utils.http
(use w3lib.http)scrapy.utils.markup
(use )scrapy.utils.multipart
(use urllib3)
The
scrapy.utils.datatypes.MergeDict
class is deprecated for Python 3 code bases. Use instead. (issue 3878)The
scrapy.utils.gz.is_gzipped
function is deprecated. Usescrapy.utils.gz.gzip_magic_number
instead.
Other changes
It is now possible to run all tests from the same tox environment in parallel; the documentation now covers (issue 3707)
It is now possible to generate an API documentation coverage report (, issue 3810, )
The documentation policies now require (issue 3701) that follow (issue 3748)
Internal fixes and cleanup (, issue 3643, , issue 3698, , issue 3735, , issue 3737, , issue 3821, , issue 3827, , issue 3857, )
Scrapy 1.6.0 (2019-01-30)
Highlights:
better Windows support;
Python 3.7 compatibility;
big documentation improvements, including a switch from
.extract_first()
+.extract()
API to.get()
+.getall()
API;feed exports, FilePipeline and MediaPipeline improvements;
better extensibility: and request_reached_downloader signals;
from_crawler
support for feed exporters, feed storages and dupefilters.scrapy.contracts
fixes and new features;telnet console security improvements, first released as a backport in ;
clean-up of the deprecated code;
various bug fixes, small new features and usability improvements across the codebase.
Selector API changes
While these are not changes in Scrapy itself, but rather in the library which Scrapy uses for xpath/css selectors, these changes are worth mentioning here. Scrapy now depends on parsel >= 1.5, and Scrapy documentation is updated to follow recent parsel
API conventions.
Most visible change is that .get()
and .getall()
selector methods are now preferred over .extract_first()
and .extract()
. We feel that these new methods result in a more concise and readable code. See extract() and extract_first() for more details.
Note
There are currently no plans to deprecate .extract()
and .extract_first()
methods.
Another useful new feature is the introduction of Selector.attrib
and SelectorList.attrib
properties, which make it easier to get attributes of HTML elements. See .
CSS selectors are cached in parsel >= 1.5, which makes them faster when the same CSS path is used many times. This is very common in case of Scrapy spiders: callbacks are usually called several times, on different pages.
If you’re using custom Selector
or SelectorList
subclasses, a backward incompatible change in parsel may affect your code. See parsel changelog for a detailed description, as well as for the full list of improvements.
Telnet console
Backward incompatible: Scrapy’s telnet console now requires username and password. See Telnet Console for more details. This change fixes a security issue; see release notes for details.
New extensibility features
from_crawler
support is added to feed exporters and feed storages. This, among other things, allows to access Scrapy settings from custom feed storages and exporters (, issue 3348).from_crawler
support is added to dupefilters (); this allows to access e.g. settings or a spider from a dupefilter.item_error is fired when an error happens in a pipeline ();
request_reached_downloader is fired when Downloader gets a new Request; this signal can be useful e.g. for custom Schedulers ().
new SitemapSpider sitemap_filter() method which allows to select sitemap entries based on their attributes in SitemapSpider subclasses ().
Lazy loading of Downloader Handlers is now optional; this enables better initialization error handling in custom Downloader Handlers (issue 3394).
New FilePipeline and MediaPipeline features
Expose more options for S3FilesStore: AWS_ENDPOINT_URL, , AWS_VERIFY, . For example, this allows to use alternative or self-hosted AWS-compatible providers (issue 2609, ).
ACL support for Google Cloud Storage: FILES_STORE_GCS_ACL and (issue 3199).
scrapy.contracts
improvements
Exceptions in contracts code are handled better (issue 3377);
dont_filter=True
is used for contract requests, which allows to test different callbacks with the same URL ();request_cls
attribute in Contract subclasses allow to use different Request classes in contracts, for example FormRequest (issue 3383).Fixed errback handling in contracts, e.g. for cases where a contract is executed for URL which returns non-200 response ().
Usability improvements
more stats for RobotsTxtMiddleware ()
INFO log level is used to show telnet host/port (issue 3115)
a message is added to IgnoreRequest in RobotsTxtMiddleware ()
better validation of
url
argument inResponse.follow
(issue 3131)non-zero exit code is returned from Scrapy commands when error happens on spider initialization ()
Link extraction improvements: “ftp” is added to scheme list (issue 3152); “flv” is added to common video extensions ()
better error message when an exporter is disabled (issue 3358);
scrapy shell --help
mentions syntax required for local files (./file.html
) - .Referer header value is added to RFPDupeFilter log messages (issue 3588)
Bug fixes
fixed issue with extra blank lines in .csv exports under Windows (issue 3039);
proper handling of pickling errors in Python 3 when serializing objects for disk queues ()
flags are now preserved when copying Requests (issue 3342);
FormRequest.from_response clickdata shouldn’t ignore elements with
input[type=image]
().FormRequest.from_response should preserve duplicate keys (issue 3247)
Documentation improvements
Docs are re-written to suggest .get/.getall API instead of .extract/.extract_first. Also, Selectors docs are updated and re-structured to match latest parsel docs; they now contain more topics, such as or Extensions to CSS Selectors ().
Using your browser’s Developer Tools for scraping is a new tutorial which replaces old Firefox and Firebug tutorials ().
SCRAPY_PROJECT environment variable is documented (issue 3518);
troubleshooting section is added to install instructions ();
improved links to beginner resources in the tutorial (issue 3367, );
fixed RETRY_HTTP_CODES default values in docs ();
remove unused
DEPTH_STATS
option from docs (issue 3245);other cleanups (, issue 3350, , issue 3544, ).
Deprecation removals
Compatibility shims for pre-1.0 Scrapy module names are removed ():
scrapy.command
scrapy.contrib
(with all submodules)scrapy.contrib_exp
(with all submodules)scrapy.dupefilter
scrapy.linkextractor
scrapy.project
scrapy.spider
scrapy.spidermanager
scrapy.squeue
scrapy.stats
scrapy.statscol
scrapy.utils.decorator
See Module Relocations for more information, or use suggestions from Scrapy 1.5.x deprecation warnings to update your code.
Other deprecation removals:
Deprecated scrapy.interfaces.ISpiderManager is removed; please use scrapy.interfaces.ISpiderLoader.
Deprecated
CrawlerSettings
class is removed ().Deprecated
Settings.overrides
andSettings.defaults
attributes are removed (issue 3327, ).
Other improvements, cleanups
All Scrapy tests now pass on Windows; Scrapy testing suite is executed in a Windows environment on CI ().
Python 3.7 support (issue 3326, , issue 3547).
Testing and CI fixes (, issue 3538, , issue 3311, , issue 3305, , issue 3299)
scrapy.http.cookies.CookieJar.clear
accepts “domain”, “path” and “name” optional arguments ().additional files are included to sdist (issue 3495);
code style fixes (, issue 3304);
unneeded .strip() call is removed ();
collections.deque is used to store MiddlewareManager methods instead of a list (issue 3476)
Scrapy 1.5.2 (2019-01-22)
Security bugfix: Telnet console extension can be easily exploited by rogue websites POSTing content to http://localhost:6023, we haven’t found a way to exploit it from Scrapy, but it is very easy to trick a browser to do so and elevates the risk for local development environment.
The fix is backward incompatible, it enables telnet user-password authentication by default with a random generated password. If you can’t upgrade right away, please consider setting out of its default value.
See telnet console documentation for more info
Backport CI build failure under GCE environment due to boto import error.
Scrapy 1.5.1 (2018-07-12)
This is a maintenance release with important bug fixes, but no new features:
O(N^2)
gzip decompression issue which affected Python 3 and PyPy is fixed (issue 3281);skipping of TLS validation errors is improved ();
Ctrl-C handling is fixed in Python 3.5+ (issue 3096);
testing fixes (, issue 3263);
documentation improvements (, issue 3059, , issue 3123, , issue 3189, , issue 3280, , issue 3201, , issue 3284, , issue 3294).
Scrapy 1.5.0 (2017-12-29)
This release brings small new features and improvements across the codebase. Some highlights:
Google Cloud Storage is supported in FilesPipeline and ImagesPipeline.
Crawling with proxy servers becomes more efficient, as connections to proxies can be reused now.
Warnings, exception and logging messages are improved to make debugging easier.
scrapy parse
command now allows to set custom request meta via--meta
argument.Compatibility with Python 3.6, PyPy and PyPy3 is improved; PyPy and PyPy3 are now supported officially, by running tests on CI.
Better default handling of HTTP 308, 522 and 524 status codes.
Documentation is improved, as usual.
Backward Incompatible Changes
Scrapy 1.5 drops support for Python 3.3.
Default Scrapy User-Agent now uses https link to scrapy.org (). This is technically backward-incompatible; override USER_AGENT if you relied on old value.
Logging of settings overridden by
custom_settings
is fixed; this is technically backward-incompatible because the logger changes from[scrapy.utils.log]
to[scrapy.crawler]
. If you’re parsing Scrapy logs, please update your log parsers ().LinkExtractor now ignores
m4v
extension by default, this is change in behavior.522 and 524 status codes are added to
RETRY_HTTP_CODES
(issue 2851)
New features
Support
<link>
tags inResponse.follow
(issue 2785)Support for
ptpython
REPL ()Google Cloud Storage support for FilesPipeline and ImagesPipeline (issue 2923).
New
--meta
option of the “scrapy parse” command allows to pass additional request.meta ()Populate spider variable when using
shell.inspect_response
(issue 2812)Handle HTTP 308 Permanent Redirect ()
Add 522 and 524 to
RETRY_HTTP_CODES
(issue 2851)Log versions information at startup ()
scrapy.mail.MailSender
now works in Python 3 (it requires Twisted 17.9.0)Connections to proxy servers are reused (issue 2743)
Add template for a downloader middleware ()
Explicit message for NotImplementedError when parse callback not defined (issue 2831)
CrawlerProcess got an option to disable installation of root log handler ()
LinkExtractor now ignores
m4v
extension by defaultBetter log messages for responses over DOWNLOAD_WARNSIZE and limits (issue 2927)
Show warning when a URL is put to
Spider.allowed_domains
instead of a domain ().
Bug fixes
Fix logging of settings overridden by
custom_settings
; this is technically backward-incompatible because the logger changes from[scrapy.utils.log]
to[scrapy.crawler]
, so please update your log parsers if needed ()Default Scrapy User-Agent now uses https link to scrapy.org (issue 2983). This is technically backward-incompatible; override if you relied on old value.
Fix PyPy and PyPy3 test failures, support them officially (issue 2793, , issue 2990, , issue 2213, )
Fix DNS resolver when
DNSCACHE_ENABLED=False
(issue 2811)Add
cryptography
for Debian Jessie tox test env ()Add verification to check if Request callback is callable (issue 2766)
Port
extras/qpsclient.py
to Python 3 ()Use getfullargspec under the scenes for Python 3 to stop DeprecationWarning (issue 2862)
Update deprecated test aliases ()
Fix
SitemapSpider
support for alternate links (issue 2853)
Docs
Added missing bullet point for the
AUTOTHROTTLE_TARGET_CONCURRENCY
setting. (issue 2756)Update Contributing docs, document new support channels (, issue:3038)
Include references to Scrapy subreddit in the docs
Fix broken links; use https:// for external links (, issue 2982, )
Document CloseSpider extension better (issue 2759)
Use
pymongo.collection.Collection.insert_one()
in MongoDB example ()Spelling mistake and typos (issue 2828, , issue 2884, )
Clarify
CSVFeedSpider.headers
documentation (issue 2826)Document
DontCloseSpider
exception and clarifyspider_idle
()Update “Releases” section in README (issue 2764)
Fix rst syntax in
DOWNLOAD_FAIL_ON_DATALOSS
docs ()Small fix in description of startproject arguments (issue 2866)
Clarify data types in Response.body docs ()
Add a note about
request.meta['depth']
to DepthMiddleware docs (issue 2374)Add a note about
request.meta['dont_merge_cookies']
to CookiesMiddleware docs ()Up-to-date example of project structure (issue 2964, )
A better example of ItemExporters usage (issue 2989)
Document
from_crawler
methods for spider and downloader middlewares ()
Scrapy 1.4.0 (2017-05-18)
Scrapy 1.4 does not bring that many breathtaking new features but quite a few handy improvements nonetheless.
Scrapy now supports anonymous FTP sessions with customizable user and password via the new and FTP_PASSWORD settings. And if you’re using Twisted version 17.1.0 or above, FTP is now available with Python 3.
There’s a new method for creating requests; it is now a recommended way to create Requests in Scrapy spiders. This method makes it easier to write correct spiders; response.follow
has several advantages over creating scrapy.Request
objects directly:
it handles relative URLs;
it works properly with non-ascii URLs on non-UTF8 pages;
in addition to absolute and relative URLs it supports Selectors; for
<a>
elements it can also extract their href values.
For example, instead of this:
for href in response.css('li.page a::attr(href)').extract():
url = response.urljoin(href)
yield scrapy.Request(url, self.parse, encoding=response.encoding)
One can now write this:
Link extractors are also improved. They work similarly to what a regular modern browser would do: leading and trailing whitespace are removed from attributes (think href=" http://example.com"
) when building Link
objects. This whitespace-stripping also happens for action
attributes with FormRequest
.
Please also note that link extractors do not canonicalize URLs by default anymore. This was puzzling users every now and then, and it’s not what browsers do in fact, so we removed that extra transformation on extracted links.
For those of you wanting more control on the Referer:
header that Scrapy sends when following links, you can set your own Referrer Policy
. Prior to Scrapy 1.4, the default RefererMiddleware
would simply and blindly set it to the URL of the response that generated the HTTP request (which could leak information on your URL seeds). By default, Scrapy now behaves much like your regular browser does. And this policy is fully customizable with W3C standard values (or with something really custom of your own if you wish). See REFERRER_POLICY for details.
To make Scrapy spiders easier to debug, Scrapy logs more stats by default in 1.4: memory usage stats, detailed retry stats, detailed HTTP error code stats. A similar change is that HTTP cache path is also visible in logs now.
Last but not least, Scrapy now has the option to make JSON and XML items more human-readable, with newlines between items and even custom indenting offset, using the new setting.
Enjoy! (Or read on for the rest of changes in this release.)
Deprecations and Backward Incompatible Changes
Default to
canonicalize=False
in (issue 2537, fixes and issue 1982): warning, this is technically backward-incompatibleEnable memusage extension by default (, fixes issue 2187); this is technically backward-incompatible so please check if you have any non-default
MEMUSAGE_***
options set.EDITOR
environment variable now takes precedence overEDITOR
option defined in settings.py (); Scrapy default settings no longer depend on environment variables. This is technically a backward incompatible change.Spider.make_requests_from_url
is deprecated (issue 1728, fixes ).
New Features
Accept proxy credentials in request meta key (issue 2526)
Support -compressed content; requires optional brotlipy ()
New response.follow shortcut for creating requests ()
Added
flags
argument and attribute to Request objects ()Support Anonymous FTP (issue 2342)
Added
retry/count
,retry/max_reached
andretry/reason_count/<reason>
stats to (issue 2543)Added
httperror/response_ignored_count
andhttperror/response_ignored_status_count/<status>
stats to (issue 2566)Customizable in RefererMiddleware ()
New
data:
URI download handler (issue 2334, fixes )Log cache directory when HTTP Cache is used (issue 2611, fixes )
Warn users when project contains duplicate spider names (fixes issue 2181)
scrapy.utils.datatypes.CaselessDict
now acceptsMapping
instances and not only dicts ()Media downloads, with or ImagesPipeline, can now optionally handle HTTP redirects using the new setting (issue 2616, fixes )
Accept non-complete responses from websites using a new DOWNLOAD_FAIL_ON_DATALOSS setting (, fixes issue 2586)
Optional pretty-printing of JSON and XML items via setting (issue 2456, fixes )
Allow dropping fields in
FormRequest.from_response
formdata whenNone
value is passed (issue 667)Per-request retry times with the new meta key (issue 2642)
python -m scrapy
as a more explicit alternative toscrapy
command ()
Bug fixes
LinkExtractor now strips leading and trailing whitespaces from attributes (, fixes issue 1614)
Properly handle whitespaces in action attribute in
FormRequest
()Buffer CONNECT response bytes from proxy until all HTTP headers are received (issue 2495, fixes )
FTP downloader now works on Python 3, provided you use Twisted>=17.1 (issue 2599)
Use body to choose response type after decompressing content (, fixes issue 2145)
Always decompress
Content-Encoding: gzip
at stage (issue 2391)Respect custom log level in
Spider.custom_settings
(, fixes issue 1612)‘make htmlview’ fix for macOS ()
Remove “commands” from the command list (issue 2695)
Fix duplicate Content-Length header for POST requests with empty body ()
Properly cancel large downloads, i.e. above DOWNLOAD_MAXSIZE ()
ImagesPipeline: fixed processing of transparent PNG images with palette (issue 2675)
Cleanups & Refactoring
Tests: remove temp files and folders (issue 2570), fixed ProjectUtilsTest on macOS (), use portable pypy for Linux on Travis CI (issue 2710)
Separate building request from
_requests_to_follow
in CrawlSpider ()Remove “Python 3 progress” badge (issue 2567)
Add a couple more lines to
.gitignore
()Remove bumpversion prerelease configuration (issue 2159)
Add codecov.yml file ()
Set context factory implementation based on Twisted version (issue 2577, fixes )
Add omitted
self
arguments in default project middleware template (issue 2595)Remove redundant
slot.add_request()
call in ExecutionEngine ()Catch more specific
os.error
exception inscrapy.pipelines.files.FSFilesStore
(issue 2644)Change “localhost” test server certificate ()
Remove unused
MEMUSAGE_REPORT
setting (issue 2576)
Documentation
Binary mode is required for exporters (issue 2564, fixes )
Mention issue with
FormRequest.from_response
due to bug in lxml (issue 2572)Use single quotes uniformly in templates ()
Document ftp_user and meta keys (issue 2587)
Removed section on deprecated
contrib/
()Recommend Anaconda when installing Scrapy on Windows (issue 2477, fixes )
FAQ: rewrite note on Python 3 support on Windows (issue 2690)
Rearrange selector sections ()
Remove
__nonzero__
from SelectorList docs ()Mention how to disable request filtering in documentation of DUPEFILTER_CLASS setting ()
Add sphinx_rtd_theme to docs setup readme (issue 2668)
Open file in text mode in JSON item writer example ()
Clarify
allowed_domains
example (issue 2670)
Bug fixes
- Make
SpiderLoader
raiseImportError
again by default for missing dependencies and wrong SPIDER_MODULES. These exceptions were silenced as warnings since 1.3.0. A new setting is introduced to toggle between warning or exception if needed ; see for details.
Scrapy 1.3.2 (2017-02-13)
Bug fixes
Preserve request class when converting to/from dicts (utils.reqser) (issue 2510).
Use consistent selectors for author field in tutorial ().
Fix TLS compatibility in Twisted 17+ (issue 2558)
Scrapy 1.3.1 (2017-02-08)
New features
Support
'True'
and'False'
string values for boolean settings (); you can now do something likescrapy crawl myspider -s REDIRECT_ENABLED=False
.Support kwargs with
response.xpath()
to use XPath variables and ad-hoc namespaces declarations ; this requires at least Parsel v1.1 ().Add support for Python 3.6 (issue 2485).
Run tests on PyPy (warning: some tests still fail, so PyPy is not supported yet).
Bug fixes
Enforce
DNS_TIMEOUT
setting (issue 2496).Fix command ; it was a regression in v1.3.0 (issue 2503).
Fix tests regarding
*_EXPIRES settings
with Files/Images pipelines ().Fix name of generated pipeline class when using basic project template (issue 2466).
Fix compatibility with Twisted 17+ (, issue 2528).
Fix
scrapy.Item
inheritance on Python 3.6 ().Enforce numeric values for components order in
SPIDER_MIDDLEWARES
,DOWNLOADER_MIDDLEWARES
,EXTENSIONS
andSPIDER_CONTRACTS
(issue 2420).
Documentation
Reword Code of Conduct section and upgrade to Contributor Covenant v1.4 (issue 2469).
Clarify that passing spider arguments converts them to spider attributes ().
Document
formid
argument onFormRequest.from_response()
(issue 2497).Add .rst extension to README files ().
Mention LevelDB cache storage backend (issue 2525).
Use
yield
in sample callback code ().Add note about HTML entities decoding with
.re()/.re_first()
(issue 1704).Typos (, issue 2534, ).
Cleanups
Remove redundant check in
MetaRefreshMiddleware
().Faster checks in
LinkExtractor
for allow/deny patterns (issue 2538).Remove dead code supporting old Twisted versions ().
Scrapy 1.3.0 (2016-12-21)
This release comes rather soon after 1.2.2 for one main reason: it was found out that releases since 0.18 up to 1.2.2 (included) use some backported code from Twisted (scrapy.xlib.tx.*
), even if newer Twisted modules are available. Scrapy now uses twisted.web.client
and twisted.internet.endpoints
directly. (See also cleanups below.)
As it is a major change, we wanted to get the bug fix out quickly while not breaking any projects using the 1.2 series.
New Features
MailSender
now accepts single strings as values forto
andcc
arguments (issue 2272)scrapy fetch url
,scrapy shell url
andfetch(url)
inside Scrapy shell now follow HTTP redirections by default (); See fetch and for details.HttpErrorMiddleware
now logs errors withINFO
level instead ofDEBUG
; this is technically backward incompatible so please check your log parsers.By default, logger names now use a long-form path, e.g.
[scrapy.extensions.logstats]
, instead of the shorter “top-level” variant of prior releases (e.g.[scrapy]
); this is backward incompatible if you have log parsers expecting the short logger name part. You can switch back to short logger names using LOG_SHORT_NAMES set toTrue
.
Dependencies & Cleanups
Scrapy now requires Twisted >= 13.1 which is the case for many Linux distributions already.
As a consequence, we got rid of
scrapy.xlib.tx.*
modules, which copied some of Twisted code for users stuck with an “old” Twisted versionChunkedTransferMiddleware
is deprecated and removed from the default downloader middlewares.
Scrapy 1.2.3 (2017-03-03)
- Packaging fix: disallow unsupported Twisted versions in setup.py
Scrapy 1.2.2 (2016-12-06)
Bug fixes
Fix a cryptic traceback when a pipeline fails on
open_spider()
()Fix embedded IPython shell variables (fixing issue 396 that re-appeared in 1.2.0, fixed in )
A couple of patches when dealing with robots.txt:
handle (non-standard) relative sitemap URLs (issue 2390)
handle non-ASCII URLs and User-Agents in Python 2 ()
Documentation
Document
"download_latency"
key inRequest
’smeta
dict ()Remove page on (deprecated & unsupported) Ubuntu packages from ToC (issue 2335)
A few fixed typos (, issue 2369, , issue 2380) and clarifications (, issue 2325, )
Other changes
Advertize as Scrapy’s official conda channel (issue 2387)
More helpful error messages when trying to use
.css()
or.xpath()
on non-Text Responses ()startproject
command now generates a samplemiddlewares.py
file (issue 2335)Add more dependencies’ version info in
scrapy version
verbose output ()Remove all
*.pyc
files from source distribution (issue 2386)
Scrapy 1.2.1 (2016-10-21)
Include OpenSSL’s more permissive default ciphers when establishing TLS/SSL connections (issue 2314).
Fix “Location” HTTP header decoding on non-ASCII URL redirects ().
Documentation
Fix JsonWriterPipeline example ().
Various notes: issue 2330 on spider names, on middleware methods processing order, issue 2327 on getting multi-valued HTTP headers as lists.
Other changes
- Removed
www.
fromstart_urls
in built-in spider templates (issue 2299).
Scrapy 1.2.0 (2016-10-03)
New Features
New setting to customize the encoding used when writing items to a file. This can be used to turn off
\uXXXX
escapes in JSON output. This is also useful for those wanting something else than UTF-8 for XML or CSV output (issue 2034).startproject
command now supports an optional destination directory to override the default one based on the project name ().New SCHEDULER_DEBUG setting to log requests serialization failures ().
JSON encoder now supports serialization of
set
instances (issue 2058).Interpret
application/json-amazonui-streaming
asTextResponse
().scrapy
is imported by default when using shell tools (shell, ) (issue 2248).
Bug fixes
DefaultRequestHeaders middleware now runs before UserAgent middleware (issue 2088). Warning: this is technically backward incompatible, though we consider this a bug fix.
HTTP cache extension and plugins that use the
.scrapy
data directory now work outside projects (). Warning: this is technically backward incompatible, though we consider this a bug fix.Selector
does not allow passing bothresponse
andtext
anymore (issue 2153).Fixed logging of wrong callback name with
scrapy parse
().Fix for an odd gzip decompression bug (issue 1606).
Fix for selected callbacks when using
CrawlSpider
with (issue 2225).Fix for invalid JSON and XML files when spider yields no items ().
Implement
flush()
forStreamLogger
avoiding a warning in logs (issue 2125).
Refactoring
canonicalize_url
has been moved to w3lib.url ().
Tests & Requirements
Scrapy’s new requirements baseline is Debian 8 “Jessie”. It was previously Ubuntu 12.04 Precise. What this means in practice is that we run continuous integration tests with these (main) packages versions at a minimum: Twisted 14.0, pyOpenSSL 0.14, lxml 3.4.
Scrapy may very well work with older versions of these packages (the code base still has switches for older Twisted versions for example) but it is not guaranteed (because it’s not tested anymore).
Documentation
Grammar fixes: issue 2128, .
Download stats badge removed from README (issue 2160).
New Scrapy (issue 2165).
Updated
Response
parameters documentation ().Reworded misleading RANDOMIZE_DOWNLOAD_DELAY description ().
Add StackOverflow as a support channel (issue 2257).
Scrapy 1.1.4 (2017-03-03)
- Packaging fix: disallow unsupported Twisted versions in setup.py
Scrapy 1.1.3 (2016-09-22)
Bug fixes
- Class attributes for subclasses of
ImagesPipeline
andFilesPipeline
work as they did before 1.1.1 (issue 2243, fixes )
Documentation
- and tutorial rewritten to use websites (issue 2236, , issue 2252).
Scrapy 1.1.2 (2016-08-18)
Bug fixes
Introduce a missing setting to override the default ACL policy in
ImagesPipeline
when uploading images to S3 (note that default ACL policy is “private” – instead of “public-read” – since Scrapy 1.1.0)IMAGES_EXPIRES default value set back to 90 (the regression was introduced in 1.1.1)
Scrapy 1.1.1 (2016-07-13)
Bug fixes
Add “Host” header in CONNECT requests to HTTPS proxies ()
Use response
body
when choosing response class (issue 2001, fixes )Do not fail on canonicalizing URLs with wrong netlocs (issue 2038, fixes )
a few fixes for
HttpCompressionMiddleware
(andSitemapSpider
):Do not decode HEAD responses (issue 2008, fixes )
Handle charset parameter in gzip Content-Type header (issue 2050, fixes )
Do not decompress gzip octet-stream responses (issue 2065, fixes )
Catch (and ignore with a warning) exception when verifying certificate against IP-address hosts (issue 2094, fixes )
Make
FilesPipeline
andImagesPipeline
backward compatible again regarding the use of legacy class attributes for customization (issue 1989, fixes )
New features
Enable genspider command outside project folder ()
Retry HTTPS CONNECT
TunnelError
by default (issue 1974)
Documentation
FEED_TEMPDIR
setting at lexicographical position (commit 9b3c72c)Use idiomatic
.extract_first()
in overview ()Update years in copyright notice (commit c2c8036)
Add information and example on errbacks ()
Use “url” variable in downloader middleware example (issue 2015)
Grammar fixes (, issue 2120)
New FAQ entry on using BeautifulSoup in spider callbacks ()
Add notes about Scrapy not working on Windows with Python 3 (issue 2060)
Encourage complete titles in pull requests ()
Tests
- Upgrade py.test requirement on Travis CI and Pin pytest-cov to 2.2.1 ()
Scrapy 1.1.0 (2016-05-11)
This 1.1 release brings a lot of interesting features and bug fixes:
Scrapy 1.1 has beta Python 3 support (requires Twisted >= 15.5). See for more details and some limitations.
Hot new features:
Item loaders now support nested loaders (issue 1467).
FormRequest.from_response
improvements (, issue 1137).Added setting and improved AutoThrottle docs (issue 1324).
Added
response.text
to get body as unicode ().Anonymous S3 connections (issue 1358).
Deferreds in downloader middlewares (). This enables better robots.txt handling (issue 1471).
HTTP caching now follows RFC2616 more closely, added settings and HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS ().
Selectors were extracted to the parsel library (). This means you can use Scrapy Selectors without Scrapy and also upgrade the selectors engine without needing to upgrade Scrapy.
HTTPS downloader now does TLS protocol negotiation by default, instead of forcing TLS 1.0. You can also set the SSL/TLS method using the new DOWNLOADER_CLIENT_TLS_METHOD.
These bug fixes may require your attention:
Don’t retry bad requests (HTTP 400) by default (). If you need the old behavior, add
400
to RETRY_HTTP_CODES.Fix shell files argument handling (, issue 1550). If you try
scrapy shell index.html
it will try to load the URL , usescrapy shell ./index.html
to load a local file.Robots.txt compliance is now enabled by default for newly-created projects (issue 1724). Scrapy will also wait for robots.txt to be downloaded before proceeding with the crawl (). If you want to disable this behavior, update ROBOTSTXT_OBEY in
settings.py
file after creating a new project.Exporters now work on unicode, instead of bytes by default (). If you use PythonItemExporter, you may want to update your code to disable binary mode which is now deprecated.
Accept XML node names containing dots as valid ().
When uploading files or images to S3 (with
FilesPipeline
orImagesPipeline
), the default ACL policy is now “private” instead of “public” Warning: backward incompatible!. You can use FILES_STORE_S3_ACL to change it.We’ve reimplemented
canonicalize_url()
for more correct output, especially for URLs with non-ASCII characters (). This could change link extractors output compared to previous Scrapy versions. This may also invalidate some cache entries you could still have from pre-1.1 runs. Warning: backward incompatible!.
Keep reading for more details on other improvements and bug fixes.
Beta Python 3 Support
We have been . As a result, now you can run spiders on Python 3.3, 3.4 and 3.5 (Twisted >= 15.5 required). Some features are still missing (and some may never be ported).
Almost all builtin extensions/middlewares are expected to work. However, we are aware of some limitations in Python 3:
Scrapy does not work on Windows with Python 3
Sending emails is not supported
FTP download handler is not supported
Telnet console is not supported
Additional New Features and Enhancements
Scrapy now has a (issue 1681).
Command line tool now has completion for zsh ().
Improvements to
scrapy shell
:Support for bpython and configure preferred Python shell via
SCRAPY_PYTHON_SHELL
(issue 1100, ).Support URLs without scheme (issue 1498) Warning: backward incompatible!
Bring back support for relative file path (, issue 1550).
Added setting to change default check interval (issue 1282).
Download handlers are now lazy-loaded on first request using their scheme (, issue 1421).
HTTPS download handlers do not force TLS 1.0 anymore; instead, OpenSSL’s
SSLv23_method()/TLS_method()
is used allowing to try negotiating with the remote hosts the highest TLS protocol version it can (, issue 1629).RedirectMiddleware
now skips the status codes fromhandle_httpstatus_list
on spider attribute or inRequest
’smeta
key (, issue 1364, ).Form submission:
now works with
<button>
elements too (issue 1469).an empty string is now used for submit buttons without a value ()
Dict-like settings now have per-key priorities (issue 1135, and issue 1586).
Sending non-ASCII emails ()
CloseSpider
andSpiderState
extensions now get disabled if no relevant setting is set (issue 1723, ).Added method
ExecutionEngine.close
(issue 1423).Added method
CrawlerRunner.create_crawler
().Scheduler priority queue can now be customized via SCHEDULER_PRIORITY_QUEUE ().
.pps
links are now ignored by default in link extractors (issue 1835).temporary data folder for FTP and S3 feed storages can be customized using a new setting (issue 1847).
FilesPipeline
andImagesPipeline
settings are now instance attributes instead of class attributes, enabling spider-specific behaviors ().JsonItemExporter
now formats opening and closing square brackets on their own line (first and last lines of output file) (issue 1950).If available,
botocore
is used forS3FeedStorage
,S3DownloadHandler
andS3FilesStore
(, issue 1883).Tons of documentation updates and related fixes (, issue 1302, , issue 1683, , issue 1642, , issue 1727, ).
Other refactoring, optimizations and cleanup (issue 1476, , issue 1477, , issue 1290, , issue 1881).
Deprecations and Removals
Added
to_bytes
andto_unicode
, deprecatedstr_to_unicode
andunicode_to_str
functions (issue 778).binary_is_text
is introduced, to replace use ofisbinarytext
(but with inverse return value) ()The
optional_features
set has been removed (issue 1359).The
--lsprof
command line option has been removed (). Warning: backward incompatible, but doesn’t break user code.The following datatypes were deprecated (issue 1720):
scrapy.utils.datatypes.MultiValueDictKeyError
scrapy.utils.datatypes.MultiValueDict
scrapy.utils.datatypes.SiteNode
The previously bundled
scrapy.xlib.pydispatch
library was deprecated and replaced by .
Relocations
telnetconsole
was relocated toextensions/
().- Note: telnet is not enabled on Python 3 (https://github.com/scrapy/scrapy/pull/1524#issuecomment-146985595)
Bugfixes
Scrapy does not retry requests that got a
HTTP 400 Bad Request
response anymore (issue 1289). Warning: backward incompatible!Support empty password for http_proxy config ().
Interpret
application/x-json
asTextResponse
(issue 1333).Support link rel attribute with multiple values ().
Fixed
scrapy.http.FormRequest.from_response
when there is a<base>
tag (issue 1564).Fixed handling (issue 1575).
Various
FormRequest
fixes (, issue 1596, ).Makes
_monkeypatches
more robust (issue 1634).Fixed bug on
XMLItemExporter
with non-string fields in items ().Fixed startproject command in macOS (issue 1635).
Fixed and CSVExporter for non-string item types (issue 1737).
Various logging related fixes (, issue 1419, , issue 1624, , issue 1722, and issue 1303).
Fixed bug in
utils.template.render_templatefile()
().sitemaps extraction from is now case-insensitive (issue 1902).
HTTPS+CONNECT tunnels could get mixed up when using multiple proxies to same remote host ().
Scrapy 1.0.7 (2017-03-03)
- Packaging fix: disallow unsupported Twisted versions in setup.py
Scrapy 1.0.6 (2016-05-04)
FIX: RetryMiddleware is now robust to non-standard HTTP status codes (issue 1857)
FIX: Filestorage HTTP cache was checking wrong modified time ()
DOC: Support for Sphinx 1.4+ (issue 1893)
DOC: Consistency in selectors examples ()
Scrapy 1.0.5 (2016-02-04)
FIX: [Backport] Ignore bogus links in LinkExtractors (fixes , commit 108195e)
TST: Changed buildbot makefile to use ‘pytest’ ()
DOC: Fixed typos in tutorial and media-pipeline (commit 808a9ea and )
DOC: Add AjaxCrawlMiddleware to DOWNLOADER_MIDDLEWARES_BASE in settings docs (commit aa94121)
Scrapy 1.0.4 (2015-12-30)
Ignoring xlib/tx folder, depending on Twisted version. (commit 7dfa979)
Run on new travis-ci infra ()
Spelling fixes (commit 823a1cc)
escape nodename in xmliter regex ()
test xml nodename with dots (commit 4418fc3)
TST don’t use broken Pillow version in tests ()
disable log on version command. closes #1426 (commit 86fc330)
disable log on startproject command ()
Add PyPI download stats badge (commit df2b944)
don’t run tests twice on Travis if a PR is made from a scrapy/scrapy branch ()
Add Python 3 porting status badge to the README (commit 73ac80d)
fixed RFPDupeFilter persistence ()
TST a test to show that dupefilter persistence is not working (commit 97f2fb3)
explicit close file on scheme handler (commit d9b4850)
Disable dupefilter in shell ()
DOC: Add captions to toctrees which appear in sidebar (commit aa239ad)
DOC Removed pywin32 from install instructions as it’s already declared as dependency. ()
Added installation notes about using Conda for Windows and other OSes. (commit 1c3600a)
Fixed minor grammar issues. ()
fixed a typo in the documentation. (commit b71f677)
Version 1 now exists ()
fix another invalid xpath error (commit 0a1366e)
fix ValueError: Invalid XPath: //div/[id=”not-exists”]/text() on selectors.rst ()
Typos corrections (commit 7067117)
fix typos in downloader-middleware.rst and exceptions.rst, middlware -> middleware ()
Add note to Ubuntu install section about Debian compatibility (commit 23fda69)
Replace alternative macOS install workaround with virtualenv ()
Reference Homebrew’s homepage for installation instructions (commit 1925db1)
Add oldest supported tox version to contributing docs ()
Note in install docs about pip being already included in python>=2.7.9 (commit 85c980e)
Add non-python dependencies to Ubuntu install section in the docs ()
Add macOS installation section to docs (commit d8f4cba)
DOC(ENH): specify path to rtd theme explicitly ()
minor: scrapy.Spider docs grammar (commit 1ddcc7b)
Make common practices sample code match the comments ()
nextcall repetitive calls (heartbeats). (commit 55f7104)
Backport fix compatibility with Twisted 15.4.0 ()
pin pytest to 2.7.3 (commit a6535c2)
Merge pull request #1512 from mgedmin/patch-1 ()
Merge pull request #1513 from mgedmin/patch-2 (commit 5d4daf8)
Typo ()
Fix list formatting (commit 5f83a93)
fix Scrapy squeue tests after recent changes to queuelib ()
Merge pull request #1475 from rweindl/patch-1 (commit 2d688cd)
Update tutorial.rst ()
Merge pull request #1449 from rhoekman/patch-1 (commit 7d6538c)
Small grammatical change ()
Add openssl version to version command (commit 13c45ac)
Scrapy 1.0.3 (2015-08-11)
add service_identity to Scrapy install_requires (commit cbc2501)
Workaround for travis#296 ()
Scrapy 1.0.2 (2015-08-06)
Twisted 15.3.0 does not raises PicklingError serializing lambda functions ()
Minor method name fix (commit 6f85c7f)
minor: scrapy.Spider grammar and clarity ()
Put a blurb about support channels in CONTRIBUTING (commit c63882b)
Fixed typos ()
Fix doc reference. (commit 7c8a4fe)
Scrapy 1.0.1 (2015-07-01)
Unquote request path before passing to FTPClient, it already escape paths (commit cc00ad2)
include tests/ to source distribution in MANIFEST.in ()
DOC Fix SelectJmes documentation (commit b8567bc)
DOC Bring Ubuntu and Archlinux outside of Windows subsection ()
DOC remove version suffix from Ubuntu package (commit 5303c66)
DOC Update release date for 1.0 ()
Scrapy 1.0.0 (2015-06-19)
You will find a lot of new features and bugfixes in this major release. Make sure to check our updated to get a glance of some of the changes, along with our brushed tutorial.
Support for returning dictionaries in spiders
Declaring and returning Scrapy Items is no longer necessary to collect the scraped data from your spider, you can now return explicit dictionaries instead.
Classic version
class MyItem(scrapy.Item):
url = scrapy.Field()
class MySpider(scrapy.Spider):
def parse(self, response):
return MyItem(url=response.url)
New version
class MySpider(scrapy.Spider):
def parse(self, response):
return {'url': response.url}
Per-spider settings (GSoC 2014)
Last Google Summer of Code project accomplished an important redesign of the mechanism used for populating settings, introducing explicit priorities to override any given setting. As an extension of that goal, we included a new level of priority for settings that act exclusively for a single spider, allowing them to redefine project settings.
Start using it by defining a custom_settings
class variable in your spider:
class MySpider(scrapy.Spider):
custom_settings = {
"DOWNLOAD_DELAY": 5.0,
"RETRY_ENABLED": False,
}
Read more about settings population:
Python Logging
Scrapy 1.0 has moved away from Twisted logging to support Python built in’s as default logging system. We’re maintaining backward compatibility for most of the old custom interface to call logging functions, but you’ll get warnings to switch to the Python logging API entirely.
Old version
from scrapy import log
log.msg('MESSAGE', log.INFO)
New version
Logging with spiders remains the same, but on top of the log()
method you’ll have access to a custom logger
created for the spider to issue log events:
class MySpider(scrapy.Spider):
def parse(self, response):
self.logger.info('Response received')
Read more in the logging documentation:
Crawler API refactoring (GSoC 2014)
Another milestone for last Google Summer of Code was a refactoring of the internal API, seeking a simpler and easier usage. Check new core interface in:
A common situation where you will face these changes is while running Scrapy from scripts. Here’s a quick example of how to run a Spider manually with the new API:
from scrapy.crawler import CrawlerProcess
process = CrawlerProcess({
'USER_AGENT': 'Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 5.1)'
})
process.crawl(MySpider)
process.start()
Bear in mind this feature is still under development and its API may change until it reaches a stable status.
See more examples for scripts running Scrapy: Common Practices
Module Relocations
There’s been a large rearrangement of modules trying to improve the general structure of Scrapy. Main changes were separating various subpackages into new projects and dissolving both scrapy.contrib
and scrapy.contrib_exp
into top level packages. Backward compatibility was kept among internal relocations, while importing deprecated modules expect warnings indicating their new place.
Full list of relocations
Outsourced packages
Note
These extensions went through some minor changes, e.g. some setting names were changed. Please check the documentation in each new repository to get familiar with the new usage.
scrapy.contrib_exp
and scrapy.contrib
dissolutions
Plural renames and Modules unification
Class renames
Settings renames
Changelog
New Features and Enhancements
Python logging (issue 1060, , issue 1236, , issue 1259, , issue 1286)
FEED_EXPORT_FIELDS option (, issue 1224)
Dns cache size and timeout options ()
support namespace prefix in xmliter_lxml (issue 963)
Reactor threadpool max size setting ()
Allow spiders to return dicts. (issue 1081)
Add Response.urljoin() helper ()
look in ~/.config/scrapy.cfg for user config (issue 1098)
handle TLS SNI ()
Selectorlist extract first (issue 624, )
Added JmesSelect (issue 1016)
add gzip compression to filesystem http cache backend ()
CSS support in link extractors (issue 983)
httpcache dont_cache meta #19 #689 ()
add signal to be sent when request is dropped by the scheduler (issue 961)
avoid download large response ()
Allow to specify the quotechar in CSVFeedSpider (issue 882)
Add referer to “Spider error processing” log message ()
process robots.txt once (issue 896)
GSoC Per-spider settings ()
Add project name validation (issue 817)
GSoC API cleanup (, issue 1128, , issue 1148, , issue 1185, , issue 1258, , issue 1276, , issue 1284)
Be more responsive with IO operations ( and issue 1075)
Do leveldb compaction for httpcache on closing ()
Deprecations and Removals
Deprecate htmlparser link extractor (issue 1205)
remove deprecated code from FeedExporter ()
a leftover for.15 compatibility (issue 925)
drop support for CONCURRENT_REQUESTS_PER_SPIDER ()
Drop old engine code (issue 911)
Deprecate SgmlLinkExtractor ()
Relocations
Move exporters/__init__.py to exporters.py (issue 1242)
Move base classes to their packages (, issue 1233)
Module relocation (, issue 1210)
rename SpiderManager to SpiderLoader ()
Remove djangoitem (issue 1177)
remove scrapy deploy command ()
dissolve contrib_exp (issue 1134)
Deleted bin folder from root, fixes #913 ()
Remove jsonrpc based webservice (issue 859)
Move Test cases under project root dir (, issue 841)
Fix backward incompatibility for relocated paths in settings ()
Documentation
CrawlerProcess documentation (issue 1190)
Favoring web scraping over screen scraping in the descriptions ()
Some improvements for Scrapy tutorial (issue 1180)
Documenting Files Pipeline together with Images Pipeline ()
deployment docs tweaks (issue 1164)
Adding more settings to project template ()
some improvements to overview page (issue 1106)
Updated link in docs/topics/architecture.rst ()
DOC reorder topics (issue 1022)
updating list of Request.meta special keys ()
DOC document download_timeout (issue 898)
DOC simplify extension docs ()
Leaks docs (issue 894)
DOC document from_crawler method for item pipelines ()
Spider_error doesn’t support deferreds (issue 1292)
Corrections & Sphinx related fixes (, issue 1219, , issue 1172, , issue 1169, , issue 1154, , issue 1112, , issue 1041, , issue 1033, , issue 866, , issue 796, , issue 1271, , issue 1298)
Bugfixes
Item multi inheritance fix (, issue 1228)
ItemLoader.load_item: iterate over copy of fields ()
Fix Unhandled error in Deferred (RobotsTxtMiddleware) (issue 1131, )
Force to read DOWNLOAD_TIMEOUT as int (issue 954)
scrapy.utils.misc.load_object should print full traceback ()
Fix for Enabled extensions, middlewares, pipelines info not printed anymore (issue 879)
fix dont_merge_cookies bad behaviour when set to false on meta ()
Python 3 In Progress Support
disable scrapy.telnet if twisted.conch is not available (issue 1161)
fix Python 3 syntax errors in ajaxcrawl.py ()
more python3 compatibility changes for urllib (issue 1121)
assertItemsEqual was renamed to assertCountEqual in Python 3. ()
Import unittest.mock if available. (issue 1066)
updated deprecated cgi.parse_qsl to use six’s parse_qsl ()
Prevent Python 3 port regressions (issue 830)
PY3: use MutableMapping for python 3 ()
PY3: use six.BytesIO and six.moves.cStringIO (issue 803)
PY3: fix xmlrpclib and email imports ()
PY3: use six for robotparser and urlparse (issue 800)
PY3: use six.iterkeys, six.iteritems, and tempfile ()
PY3: fix has_key and use six.moves.configparser (issue 798)
PY3: use six.moves.cPickle ()
PY3 make it possible to run some tests in Python3 (issue 776)
Tests
remove unnecessary lines from py3-ignores ()
Fix remaining warnings from pytest while collecting tests (issue 1206)
Add docs build to travis ()
TST don’t collect tests from deprecated modules. (issue 1165)
install service_identity package in tests to prevent warnings ()
Fix deprecated settings API in tests (issue 1152)
Add test for webclient with POST method and no body given ()
py3-ignores.txt supports comments (issue 1044)
modernize some of the asserts ()
selector.__repr__ test (issue 779)
Code refactoring
CSVFeedSpider cleanup: use iterate_spider_output ()
remove unnecessary check from scrapy.utils.spider.iter_spider_output (issue 1078)
Pydispatch pep8 ()
Removed unused ‘load=False’ parameter from walk_modules() (issue 871)
For consistency, use
job_dir
helper inSpiderState
extension. ()rename “sflo” local variables to less cryptic “log_observer” (issue 775)
Scrapy 0.24.6 (2015-04-20)
encode invalid xpath with unicode_escape under PY2 (commit 07cb3e5)
fix IPython shell scope issue and load IPython user config ()
Fix small typo in the docs (commit d694019)
Fix small typo ()
Converted sel.xpath() calls to response.xpath() in Extracting the data (commit c2c6d15)
Scrapy 0.24.5 (2015-02-25)
Support new _getEndpoint Agent signatures on Twisted 15.0.0 (commit 540b9bc)
DOC a couple more references are fixed ()
DOC fix a reference (commit e3c1260)
t.i.b.ThreadedResolver is now a new-style class ()
S3DownloadHandler: fix auth for requests with quoted paths/query params (commit cdb9a0b)
fixed the variable types in mailsender documentation ()
Reset items_scraped instead of item_count (commit edb07a4)
Tentative attention message about what document to read for contributions ()
mitmproxy 0.10.1 needs netlib 0.10.1 too (commit 874fcdd)
pin mitmproxy 0.10.1 as >0.11 does not work with tests ()
Test the parse command locally instead of against an external url (commit c3a6628)
Patches Twisted issue while closing the connection pool on HTTPDownloadHandler ()
Updates documentation on dynamic item classes. (commit eeb589a)
Merge pull request #943 from Lazar-T/patch-3 ()
typo (commit b0ae199)
pywin32 is required by Twisted. closes #937 ()
Update install.rst (commit 781286b)
Merge pull request #928 from Lazar-T/patch-1 ()
comma instead of fullstop (commit 627b9ba)
Merge pull request #885 from jsma/patch-1 ()
Update request-response.rst (commit 3f3263d)
SgmlLinkExtractor - fix for parsing <area> tag with Unicode present ()
Scrapy 0.24.4 (2014-08-09)
pem file is used by mockserver and required by scrapy bench ()
scrapy bench needs scrapy.tests* (commit d6cb999)
Scrapy 0.24.3 (2014-08-09)
no need to waste travis-ci time on py3 for 0.24 (commit 8e080c1)
Update installation docs ()
There is a trove classifier for Scrapy framework! (commit 4c701d7)
update other places where w3lib version is mentioned ()
Update w3lib requirement to 1.8.0 (commit 39d2ce5)
Use w3lib.html.replace_entities() (remove_entities() is deprecated) ()
set zip_safe=False (commit a51ee8b)
do not ship tests package ()
scrapy.bat is not needed anymore (commit c3861cf)
Modernize setup.py ()
headers can not handle non-string values (commit 94a5c65)
fix ftp test cases ()
The sum up of travis-ci builds are taking like 50min to complete (commit ae1e2cc)
Update shell.rst typo ()
removes weird indentation in the shell results (commit 1ca489d)
improved explanations, clarified blog post as source, added link for XPath string functions in the spec ()
renamed UserTimeoutError and ServerTimeouterror #583 (commit 037f6ab)
adding some xpath tips to selectors docs ()
fix tests to account for https://github.com/scrapy/w3lib/pull/23 ()
get_func_args maximum recursion fix #728 (commit 81344ea)
Updated input/output processor example according to #560. ()
Fixed Python syntax in tutorial. (commit db59ed9)
Add test case for tunneling proxy ()
Bugfix for leaking Proxy-Authorization header to remote host when using tunneling (commit d8793af)
Extract links from XHTML documents with MIME-Type “application/xml” ()
Merge pull request #793 from roysc/patch-1 (commit 91a1106)
Fix typo in commands.rst ()
better testcase for settings.overrides.setdefault (commit e22daaf)
Using CRLF as line marker according to http 1.1 definition ()
Scrapy 0.24.2 (2014-07-08)
Use a mutable mapping to proxy deprecated settings.overrides and settings.defaults attribute ()
there is not support for python3 yet (commit 3cd6146)
Update python compatible version set to Debian packages ()
DOC fix formatting in release notes (commit c6a9e20)
Scrapy 0.24.1 (2014-06-27)
- Fix deprecated CrawlerSettings and increase backward compatibility with .defaults attribute (commit 8e3f20a)
Enhancements
Improve Scrapy top-level namespace (issue 494, )
Add selector shortcuts to responses (issue 554, )
Add new lxml based LinkExtractor to replace unmaintained SgmlLinkExtractor (issue 559, , issue 763)
Cleanup settings API - part of per-spider settings GSoC project ()
Add UTF8 encoding header to templates (issue 688, )
Telnet console now binds to 127.0.0.1 by default (issue 699)
Update Debian/Ubuntu install instructions (, issue 549)
Disable smart strings in lxml XPath evaluations ()
Restore filesystem based cache as default for http cache middleware (issue 541, , issue 571)
Expose current crawler in Scrapy shell ()
Improve testsuite comparing CSV and XML exporters (issue 570)
New
offsite/filtered
andoffsite/domains
stats ()Support process_links as generator in CrawlSpider (issue 555)
Verbose logging and new stats counters for DupeFilter ()
Add a mimetype parameter to
MailSender.send()
(issue 602)Generalize file pipeline log messages ()
Replace unencodeable codepoints with html entities in SGMLLinkExtractor (issue 565)
Converted SEP documents to rst format (, issue 630, , issue 632, , issue 640, , issue 634, , issue 637, , issue 633, , issue 642)
Tests and docs for clickdata’s nr index in FormRequest (, issue 645)
Allow to disable a downloader handler just like any other component ()
Log when a request is discarded after too many redirections (issue 654)
Log error responses if they are not handled by spider callbacks (, issue 656)
Add content-type check to http compression mw (, issue 660)
Run pypy tests using latest pypi from ppa ()
Run test suite using pytest instead of trial (issue 679)
Build docs and check for dead links in tox environment ()
Make scrapy.version_info a tuple of integers (issue 681, )
Infer exporter’s output format from filename extensions (issue 546, , issue 760)
Support case-insensitive domains in
url_is_from_any_domain()
()Remove pep8 warnings in project and spider templates (issue 698)
Tests and docs for
request_fingerprint
function ()Update SEP-19 for GSoC project
per-spider settings
(issue 705)Set exit code to non-zero when contracts fails ()
Add a setting to control what class is instantiated as Downloader component (issue 738)
Pass response in
item_dropped
signal ()Improve
scrapy check
contracts command (issue 733, )Document
spider.closed()
shortcut (issue 719)Document
request_scheduled
signal ()Add a note about reporting security issues (issue 697)
Add LevelDB http cache storage backend (, issue 500)
Sort spider list output of
scrapy list
command ()Multiple documentation enhancements and fixes (issue 575, , issue 590, , issue 610, , issue 618, , issue 613, , issue 654, , issue 663, , issue 714)
Bugfixes
Encode unicode URL value when creating Links in RegexLinkExtractor (issue 561)
Ignore None values in ItemLoader processors ()
Fix link text when there is an inner tag in SGMLLinkExtractor and HtmlParserLinkExtractor (issue 485, )
Fix wrong checks on subclassing of deprecated classes (issue 581, )
Handle errors caused by inspect.stack() failures (issue 582)
Fix a reference to unexistent engine attribute (, issue 594)
Fix dynamic itemclass example usage of type() ()
Use lucasdemarchi/codespell to fix typos (issue 628)
Fix default value of attrs argument in SgmlLinkExtractor to be tuple ()
Fix XXE flaw in sitemap reader (issue 676)
Fix engine to support filtered start requests ()
Fix offsite middleware case on urls with no hostnames (issue 745)
Testsuite doesn’t require PIL anymore ()
Scrapy 0.22.2 (released 2014-02-14)
fix a reference to unexistent engine.slots. closes #593 ()
downloaderMW doc typo (spiderMW doc copy remnant) (commit 8ae11bf)
Correct typos ()
Scrapy 0.22.1 (released 2014-02-08)
localhost666 can resolve under certain circumstances ()
test inspect.stack failure (commit cc3eda3)
Handle cases when inspect.stack() fails ()
Fix wrong checks on subclassing of deprecated classes. closes #581 (commit 46d98d6)
Docs: 4-space indent for final spider example ()
Fix HtmlParserLinkExtractor and tests after #485 merge (commit 368a946)
BaseSgmlLinkExtractor: Fixed the missing space when the link has an inner tag ()
BaseSgmlLinkExtractor: Added unit test of a link with an inner tag (commit c1cb418)
BaseSgmlLinkExtractor: Fixed unknown_endtag() so that it only set current_link=None when the end tag match the opening tag ()
Fix tests for Travis-CI build (commit 76c7e20)
replace unencodable codepoints with html entities. fixes #562 and #285 ()
RegexLinkExtractor: encode URL unicode value when creating Links (commit d0ee545)
Updated the tutorial crawl output with latest output. ()
Updated shell docs with the crawler reference and fixed the actual shell output. (commit 875b9ab)
PEP8 minor edits. ()
Expose current crawler in the Scrapy shell. (commit 5349cec)
Unused re import and PEP8 minor edits. ()
Ignore None’s values when using the ItemLoader. (commit 0632546)
DOC Fixed HTTPCACHE_STORAGE typo in the default value which is now Filesystem instead Dbm. ()
show Ubuntu setup instructions as literal code (commit fb5c9c5)
Update Ubuntu installation instructions ()
Merge pull request #550 from stray-leone/patch-1 (commit 6f70b6a)
modify the version of Scrapy Ubuntu package ()
fix 0.22.0 release date (commit af0219a)
fix typos in news.rst and remove (not released yet) header ()
Scrapy 0.22.0 (released 2014-01-17)
Enhancements
[Backward incompatible] Switched HTTPCacheMiddleware backend to filesystem (issue 541) To restore old backend set
HTTPCACHE_STORAGE
toscrapy.contrib.httpcache.DbmCacheStorage
Proxy https:// urls using CONNECT method (, issue 397)
Add a middleware to crawl ajax crawleable pages as defined by google ()
Rename scrapy.spider.BaseSpider to scrapy.spider.Spider (issue 510, )
Selectors register EXSLT namespaces by default (issue 472)
Unify item loaders similar to selectors renaming ()
Make
RFPDupeFilter
class easily subclassable (issue 533)Improve test coverage and forthcoming Python 3 support ()
Promote startup info on settings and middleware to INFO level (issue 520)
Support partials in
get_func_args
util (, issue:504)Allow running individual tests via tox (issue 503)
Update extensions ignored by link extractors ()
Add middleware methods to get files/images/thumbs paths (issue 490)
Improve offsite middleware tests ()
Add a way to skip default Referer header set by RefererMiddleware (issue 475)
Do not send
x-gzip
in defaultAccept-Encoding
header ()Support defining http error handling using settings (issue 466)
Use modern python idioms wherever you find legacies ()
Improve and correct documentation (issue 527, , issue 521, , issue 512, , issue 502, , issue 465, , issue 425, )
Fixes
Update Selector class imports in CrawlSpider template ()
Fix unexistent reference to
engine.slots
(issue 464)Do not try to call
body_as_unicode()
on a non-TextResponse instance ()Warn when subclassing XPathItemLoader, previously it only warned on instantiation. (issue 523)
Warn when subclassing XPathSelector, previously it only warned on instantiation. ()
Fix overriding url in
FormRequest.from_response()
()Fix tests runner under pip 1.5 (issue 513)
Fix logging error when spider name is unicode ()
Scrapy 0.20.2 (released 2013-12-09)
Update CrawlSpider Template with Selector changes ()
fix method name in tutorial. closes GH-480 (commit b4fc359
Scrapy 0.20.1 (released 2013-11-28)
include_package_data is required to build wheels from published sources (commit 5ba1ad5)
process_parallel was leaking the failures on its internal deferreds. closes #458 ()
Scrapy 0.20.0 (released 2013-11-08)
Enhancements
New Selector’s API including CSS selectors (issue 395 and ),
Request/Response url/body attributes are now immutable (modifying them had been deprecated for a long time)
ITEM_PIPELINES is now defined as a dict (instead of a list)
Sitemap spider can fetch alternate URLs ()
Selector.remove_namespaces()
now remove namespaces from element’s attributes. (issue 416)New item exporter using native python types with nesting support ()
Tune HTTP1.1 pool size so it matches concurrency defined by settings (commit b43b5f575)
scrapy.mail.MailSender now can connect over TLS or upgrade using STARTTLS ()
New FilesPipeline with functionality factored out from ImagesPipeline (issue 370, )
Recommend Pillow instead of PIL for image handling (issue 317)
Added Debian packages for Ubuntu Quantal and Raring ()
Mock server (used for tests) can listen for HTTPS requests (issue 410)
Remove multi spider support from multiple core components (, issue 421, , issue 419, , issue 418)
Travis-CI now tests Scrapy changes against development versions of
w3lib
andqueuelib
python packages.Add pypy 2.1 to continuous integration tests ()
Pylinted, pep8 and removed old-style exceptions from source (issue 430, )
Use importlib for parametric imports (issue 445)
Handle a regression introduced in Python 2.7.5 that affects XmlItemExporter ()
Bugfix crawling shutdown on SIGINT (issue 450)
Do not submit
reset
type inputs in FormRequest.from_response ()Do not silence download errors when request errback raises an exception (commit 684cfc0)
Bugfixes
Fix tests under Django 1.6 (commit b6bed44c)
Lot of bugfixes to retry middleware under disconnections using HTTP 1.1 download handler
Fix inconsistencies among Twisted releases ()
Fix Scrapy shell bugs (issue 418, )
Fix invalid variable name in setup.py (issue 429)
Fix tutorial references ()
Improve request-response docs (issue 391)
Improve django integration docs ()
Document
bindaddress
request meta (commit 37c24e01d7)Improve
Request
class documentation ()
Other
Dropped Python 2.6 support ()
Add cssselect python package as install dependency
Drop libxml2 and multi selector’s backend support, is required from now on.
Minimum Twisted version increased to 10.0.0, dropped Twisted 8.0 support.
Running test suite now requires
mock
python library (issue 390)
Thanks
Thanks to everyone who contribute to this release!
List of contributors sorted by number of commits:
69 Daniel Graña <dangra@...>
37 Pablo Hoffman <pablo@...>
13 Mikhail Korobov <kmike84@...>
9 Alex Cepoi <alex.cepoi@...>
9 alexanderlukanin13 <alexander.lukanin.13@...>
8 Rolando Espinoza La fuente <darkrho@...>
8 Lukasz Biedrycki <lukasz.biedrycki@...>
6 Nicolas Ramirez <nramirez.uy@...>
3 Paul Tremberth <paul.tremberth@...>
2 Martin Olveyra <molveyra@...>
2 Stefan <misc@...>
2 Rolando Espinoza <darkrho@...>
2 Loren Davie <loren@...>
2 irgmedeiros <irgmedeiros@...>
1 Stefan Koch <taikano@...>
1 Stefan <cct@...>
1 scraperdragon <dragon@...>
1 Kumara Tharmalingam <ktharmal@...>
1 Francesco Piccinno <stack.box@...>
1 Marcos Campal <duendex@...>
1 Dragon Dave <dragon@...>
1 Capi Etheriel <barraponto@...>
1 cacovsky <amarquesferraz@...>
1 Berend Iwema <berend@...>
Scrapy 0.18.4 (released 2013-10-10)
IPython refuses to update the namespace. fix #396 ()
Fix AlreadyCalledError replacing a request in shell command. closes #407 (commit b1d8919)
Fix start_requests laziness and early hangs ()
Scrapy 0.18.3 (released 2013-10-03)
fix regression on lazy evaluation of start requests ()
forms: do not submit reset inputs (commit e429f63)
increase unittest timeouts to decrease travis false positive failures ()
backport master fixes to json exporter (commit cfc2d46)
Fix permission and set umask before generating sdist tarball ()
Scrapy 0.18.2 (released 2013-09-03)
- Backport
scrapy check
command fixes and backward compatible multi crawler process()
Scrapy 0.18.1 (released 2013-08-27)
remove extra import added by cherry picked changes ()
fix crawling tests under twisted pre 11.0.0 (commit 1994f38)
py26 can not format zero length fields {} ()
test PotentiaDataLoss errors on unbound responses (commit b15470d)
Treat responses without content-length or Transfer-Encoding as good responses ()
do no include ResponseFailed if http11 handler is not enabled (commit 6cbe684)
New HTTP client wraps connection lost in ResponseFailed exception. fix #373 ()
limit travis-ci build matrix (commit 3b01bb8)
Merge pull request #375 from peterarenot/patch-1 ()
Fixed so it refers to the correct folder (commit 3283809)
added Quantal & Raring to support Ubuntu releases ()
fix retry middleware which didn’t retry certain connection errors after the upgrade to http1 client, closes GH-373 (commit bb35ed0)
fix XmlItemExporter in Python 2.7.4 and 2.7.5 ()
minor updates to 0.18 release notes (commit c45e5f1)
fix contributors list format ()
Scrapy 0.18.0 (released 2013-08-09)
Lot of improvements to testsuite run using Tox, including a way to test on pypi
Handle GET parameters for AJAX crawleable urls ()
Use lxml recover option to parse sitemaps (issue 347)
Bugfix cookie merging by hostname and not by netloc ()
Support disabling
HttpCompressionMiddleware
using a flag setting (issue 359)Support xml namespaces using
iternodes
parser inXMLFeedSpider
()Support
dont_cache
request meta flag (issue 19)Bugfix
scrapy.utils.gz.gunzip
broken by changes in python 2.7.4 ()Bugfix url encoding on
SgmlLinkExtractor
(issue 24)Bugfix
TakeFirst
processor shouldn’t discard zero (0) value ()Support nested items in xml exporter (issue 66)
Improve cookies handling performance ()
Log dupe filtered requests once (issue 105)
Split redirection middleware into status and meta based middlewares ()
Use HTTP1.1 as default downloader handler (issue 109 and )
Support xpath form selection on
FormRequest.from_response
(issue 185)Bugfix unicode decoding error on
SgmlLinkExtractor
()Bugfix signal dispatching on pypi interpreter (issue 205)
Improve request delay and concurrency handling ()
Add RFC2616 cache policy to
HttpCacheMiddleware
(issue 212)Allow customization of messages logged by engine ()
Multiples improvements to
DjangoItem
(issue 217, , issue 221)Extend Scrapy commands using setuptools entry points ()
Allow spider
allowed_domains
value to be set/tuple (issue 261)Support
settings.getdict
()Simplify internal
scrapy.core.scraper
slot handling (issue 271)Added
Item.copy
()Collect idle downloader slots (issue 297)
Add
ftp://
scheme downloader handler ()Added downloader benchmark webserver and spider tools Benchmarking
Moved persistent (on disk) queues to a separate project () which Scrapy now depends on
Add Scrapy commands using external libraries (issue 260)
Added
--pdb
option toscrapy
command line toolAdded which allows to remove all namespaces from XML documents for convenience (to work with namespace-less XPaths). Documented in Selectors.
Several improvements to spider contracts
New default middleware named MetaRefreshMiddldeware that handles meta-refresh html tag redirections,
MetaRefreshMiddldeware and RedirectMiddleware have different priorities to address #62
added from_crawler method to spiders
added system tests with mock server
more improvements to macOS compatibility (thanks Alex Cepoi)
several more cleanups to singletons and multi-spider support (thanks Nicolas Ramirez)
support custom download slots
added –spider option to “shell” command.
log overridden settings when Scrapy starts
Thanks to everyone who contribute to this release. Here is a list of contributors sorted by number of commits:
130 Pablo Hoffman <pablo@...>
97 Daniel Graña <dangra@...>
20 Nicolás Ramírez <nramirez.uy@...>
13 Mikhail Korobov <kmike84@...>
12 Pedro Faustino <pedrobandim@...>
11 Steven Almeroth <sroth77@...>
5 Rolando Espinoza La fuente <darkrho@...>
4 Michal Danilak <mimino.coder@...>
4 Alex Cepoi <alex.cepoi@...>
4 Alexandr N Zamaraev (aka tonal) <tonal@...>
3 paul <paul.tremberth@...>
3 Martin Olveyra <molveyra@...>
3 Jordi Llonch <llonchj@...>
3 arijitchakraborty <myself.arijit@...>
2 Shane Evans <shane.evans@...>
2 joehillen <joehillen@...>
2 Hart <HartSimha@...>
2 Dan <ellisd23@...>
1 Zuhao Wan <wanzuhao@...>
1 whodatninja <blake@...>
1 vkrest <v.krestiannykov@...>
1 tpeng <pengtaoo@...>
1 Tom Mortimer-Jones <tom@...>
1 Rocio Aramberri <roschegel@...>
1 Pedro <pedro@...>
1 notsobad <wangxiaohugg@...>
1 Natan L <kuyanatan.nlao@...>
1 Mark Grey <mark.grey@...>
1 Luan <luanpab@...>
1 Libor Nenadál <libor.nenadal@...>
1 Juan M Uys <opyate@...>
1 Jonas Brunsgaard <jonas.brunsgaard@...>
1 Ilya Baryshev <baryshev@...>
1 Hasnain Lakhani <m.hasnain.lakhani@...>
1 Emanuel Schorsch <emschorsch@...>
1 Chris Tilden <chris.tilden@...>
1 Capi Etheriel <barraponto@...>
1 cacovsky <amarquesferraz@...>
1 Berend Iwema <berend@...>
Scrapy 0.16.5 (released 2013-05-30)
obey request method when Scrapy deploy is redirected to a new endpoint (commit 8c4fcee)
fix inaccurate downloader middleware documentation. refs #280 ()
doc: remove links to diveintopython.org, which is no longer available. closes #246 (commit bd58bfa)
Find form nodes in invalid html5 documents ()
Fix typo labeling attrs type bool instead of list (commit a274276)
Scrapy 0.16.4 (released 2013-01-23)
fixes spelling errors in documentation (commit 6d2b3aa)
add doc about disabling an extension. refs #132 ()
Fixed error message formatting. log.err() doesn’t support cool formatting and when error occurred, the message was: “ERROR: Error processing %(item)s” (commit c16150c)
lint and improve images pipeline error logging ()
fixed doc typos (commit 243be84)
add documentation topics: Broad Crawls & Common Practices ()
fix bug in Scrapy parse command when spider is not specified explicitly. closes #209 (commit c72e682)
Update docs/topics/commands.rst ()
Scrapy 0.16.3 (released 2012-12-07)
Remove concurrency limitation when using download delays and still ensure inter-request delays are enforced ()
add error details when image pipeline fails (commit 8232569)
improve macOS compatibility ()
setup.py: use README.rst to populate long_description (commit 7b5310d)
doc: removed obsolete references to ClientForm ()
correct docs for default storage backend (commit 2aa491b)
doc: removed broken proxyhub link from FAQ ()
Fixed docs typo in SpiderOpenCloseLogging example (commit 7184094)
Scrapy 0.16.2 (released 2012-11-09)
Scrapy contracts: python2.6 compat (commit a4a9199)
Scrapy contracts verbose option ()
proper unittest-like output for Scrapy contracts (commit 86635e4)
added open_in_browser to debugging doc ()
removed reference to global Scrapy stats from settings doc (commit dd55067)
Fix SpiderState bug in Windows platforms ()
Scrapy 0.16.1 (released 2012-10-26)
fixed LogStats extension, which got broken after a wrong merge before the 0.16 release ()
better backward compatibility for scrapy.conf.settings (commit 3403089)
extended documentation on how to access crawler stats from extensions ()
removed .hgtags (no longer needed now that Scrapy uses git) (commit d52c188)
fix dashes under rst headers ()
set release date for 0.16.0 in news (commit e292246)
Scrapy 0.16.0 (released 2012-10-18)
Scrapy changes:
added Spiders Contracts, a mechanism for testing spiders in a formal/reproducible way
added options
-o
and-t
to the commanddocumented AutoThrottle extension and added to extensions installed by default. You still need to enable it with
major Stats Collection refactoring: removed separation of global/per-spider stats, removed stats-related signals (
stats_spider_opened
, etc). Stats are much simpler now, backward compatibility is kept on the Stats Collector API and signals.added process_start_requests() method to spider middlewares
dropped Signals singleton. Signals should now be accessed through the Crawler.signals attribute. See the signals documentation for more info.
dropped Stats Collector singleton. Stats can now be accessed through the Crawler.stats attribute. See the stats collection documentation for more info.
documented
lxml
is now the default selectors backend instead oflibxml2
ported FormRequest.from_response() to use lxml instead of
removed modules:
scrapy.xlib.BeautifulSoup
andscrapy.xlib.ClientForm
SitemapSpider: added support for sitemap urls ending in .xml and .xml.gz, even if they advertise a wrong content type (commit 10ed28b)
StackTraceDump extension: also dump trackref live references ()
nested items now fully supported in JSON and JSONLines exporters
added cookiejar Request meta key to support multiple cookie sessions per spider
decoupled encoding detection code to , and ported Scrapy code to use that module
dropped support for Python 2.5. See https://blog.scrapinghub.com/2012/02/27/scrapy-0-15-dropping-support-for-python-2-5/
dropped support for Twisted 2.5
added setting, to control referer middleware
changed default user agent to:
Scrapy/VERSION (+http://scrapy.org)
removed (undocumented)
HTMLImageLinkExtractor
class fromscrapy.contrib.linkextractors.image
removed per-spider settings (to be replaced by instantiating multiple crawler objects)
USER_AGENT
spider attribute will no longer work, useuser_agent
attribute insteadDOWNLOAD_TIMEOUT
spider attribute will no longer work, usedownload_timeout
attribute insteadremoved
ENCODING_ALIASES
setting, as encoding auto-detection has been moved to the w3lib librarypromoted to main contrib
LogFormatter method now return dicts(instead of strings) to support lazy formatting (issue 164, )
downloader handlers (DOWNLOAD_HANDLERS setting) now receive settings as the first argument of the
__init__
methodreplaced memory usage acounting with (more portable) module, removed
scrapy.utils.memory
moduleremoved signal:
scrapy.mail.mail_sent
removed
TRACK_REFS
setting, now trackrefs is always enabledDBM is now the default storage backend for HTTP cache middleware
number of log messages (per level) are now tracked through Scrapy stats (stat name:
log_count/LEVEL
)number received responses are now tracked through Scrapy stats (stat name:
response_received_count
)removed
scrapy.log.started
attribute
Scrapy 0.14.4
added precise to supported Ubuntu distros (commit b7e46df)
fixed bug in json-rpc webservice reported in . also removed no longer supported ‘run’ command from extras/scrapy-ws.py (commit 340fbdb)
meta tag attributes for content-type http equiv can be in any order. #123 ()
replace “import Image” by more standard “from PIL import Image”. closes #88 (commit 4d17048)
return trial status as bin/runtests.sh exit value. #118 ()
Scrapy 0.14.3
forgot to include pydispatch license. #118 ()
include egg files used by testsuite in source distribution. #118 (commit c897793)
update docstring in project template to avoid confusion with genspider command, which may be considered as an advanced feature. refs #107 ()
added note to docs/topics/firebug.rst about google directory being shut down (commit 668e352)
don’t discard slot when empty, just save in another dict in order to recycle if needed again. ()
do not fail handling unicode xpaths in libxml2 backed selectors (commit b830e95)
fixed minor mistake in Request objects documentation ()
fixed minor defect in link extractors documentation (commit ba14f38)
removed some obsolete remaining code related to sqlite support in Scrapy ()
Scrapy 0.14.2
move buffer pointing to start of file before computing checksum. refs #92 ()
Compute image checksum before persisting images. closes #92 (commit 9817df1)
remove leaking references in cached failures ()
fixed bug in MemoryUsage extension: get_engine_status() takes exactly 1 argument (0 given) (commit 11133e9)
fixed struct.error on http compression middleware. closes #87 ()
ajax crawling wasn’t expanding for unicode urls (commit 0de3fb4)
Catch start_requests iterator errors. refs #83 ()
Speed-up libxml2 XPathSelector (commit 2fbd662)
updated versioning doc according to recent changes ()
scrapyd: fixed documentation link (commit 2b4e4c3)
extras/makedeb.py: no longer obtaining version from git ()
Scrapy 0.14.1
extras/makedeb.py: no longer obtaining version from git ()
bumped version to 0.14.1 (commit 6cb9e1c)
fixed reference to tutorial directory ()
doc: removed duplicated callback argument from Request.replace() (commit 1aeccdd)
fixed formatting of scrapyd doc ()
Dump stacks for all running threads and fix engine status dumped by StackTraceDump extension (commit 14a8e6e)
added comment about why we disable ssl on boto images upload ()
SSL handshaking hangs when doing too many parallel connections to S3 (commit 63d583d)
change tutorial to follow changes on dmoz site ()
Avoid _disconnectedDeferred AttributeError exception in Twisted>=11.1.0 (commit 98f3f87)
allow spider to set autothrottle max concurrency ()
Scrapy 0.14
New features and settings
Support for AJAX crawleable urls
New persistent scheduler that stores requests on disk, allowing to suspend and resume crawls ()
added
-o
option toscrapy crawl
, a shortcut for dumping scraped items into a file (or standard output using-
)Added support for passing custom settings to Scrapyd
schedule.json
api (r2779, )New
ChunkedTransferMiddleware
(enabled by default) to support chunked transfer encoding ()Add boto 2.0 support for S3 downloader handler (r2763)
Added to formats supported by feed exports (r2744)
In request errbacks, offending requests are now received in
failure.request
attribute ()Big downloader refactoring to support per domain/ip concurrency limits (r2732)
CONCURRENT_REQUESTS_PER_SPIDER
setting has been deprecated and replaced by:check the documentation for more details
Added builtin caching DNS resolver (r2728)
Moved Amazon AWS-related components/extensions (SQS spider queue, SimpleDB stats collector) to a separate project: [scaws]() (r2706, )
Moved spider queues to scrapyd:
scrapy.spiderqueue
->scrapyd.spiderqueue
(r2708)Moved sqlite utils to scrapyd:
scrapy.utils.sqlite
->scrapyd.sqlite
()Real support for returning iterators on
start_requests()
method. The iterator is now consumed during the crawl when the spider is getting idle (r2704)Added setting to quickly enable/disable the redirect middleware (r2697)
Added setting to quickly enable/disable the retry middleware (r2694)
Added
CloseSpider
exception to manually close spiders ()Improved encoding detection by adding support for HTML5 meta charset declaration (r2690)
Refactored close spider behavior to wait for all downloads to finish and be processed by spiders, before closing the spider ()
Added
SitemapSpider
(see documentation in Spiders page) (r2658)Added
LogStats
extension for periodically logging basic stats (like crawled pages and scraped items) ()Make handling of gzipped responses more robust (#319, r2643). Now Scrapy will try and decompress as much as possible from a gzipped response, instead of failing with an
IOError
.Simplified !MemoryDebugger extension to use stats for dumping memory debugging info ()
Added new command to edit spiders:
scrapy edit
(r2636) and-e
flag togenspider
command that uses it ()Changed default representation of items to pretty-printed dicts. (r2631). This improves default logging by making log more readable in the default case, for both Scraped and Dropped lines.
Added signal (r2628)
Added setting (r2625)
Stats are now dumped to Scrapy log (default value of setting has been changed to
True
). This is to make Scrapy users more aware of Scrapy stats and the data that is collected there.Added support for dynamically adjusting download delay and maximum concurrent requests (r2599)
Added new DBM HTTP cache storage backend ()
Added
listjobs.json
API to Scrapyd (r2571)CsvItemExporter
: addedjoin_multivalued
parameter ()Added namespace support to
xmliter_lxml
(r2552)Improved cookies middleware by making
COOKIES_DEBUG
nicer and documenting it ()Several improvements to Scrapyd and Link extractors
Code rearranged and removed
Merged item passed and item scraped concepts, as they have often proved confusing in the past. This means: ()
original item_scraped signal was removed
original item_passed signal was renamed to item_scraped
old log lines
Scraped Item...
were removedold log lines
Passed Item...
were renamed toScraped Item...
lines and downgraded toDEBUG
level
Reduced Scrapy codebase by striping part of Scrapy code into two new libraries:
Removed unused function:
scrapy.utils.request.request_info()
(r2577)Removed googledir project from
examples/googledir
. There’s now a new example project calleddirbot
available on GitHub:Removed support for default field values in Scrapy items (r2616)
Removed experimental crawlspider v2 ()
Removed scheduler middleware to simplify architecture. Duplicates filter is now done in the scheduler itself, using the same dupe filtering class as before (
DUPEFILTER_CLASS
setting) (r2640)Removed support for passing urls to
scrapy crawl
command (usescrapy parse
instead) ()Removed deprecated Execution Queue (r2704)
Removed (undocumented) spider context extension (from scrapy.contrib.spidercontext) ()
removed
CONCURRENT_SPIDERS
setting (use scrapyd maxproc instead) (r2789)Renamed attributes of core components: downloader.sites -> downloader.slots, scraper.sites -> scraper.slots (, r2718)
Renamed setting
CLOSESPIDER_ITEMPASSED
to (r2655). Backward compatibility kept.
Scrapy 0.12
The numbers like #NNN reference tickets in the old issue tracker (Trac) which is no longer available.
New features and improvements
Passed item is now sent in the
item
argument of the (#273)Added verbose option to
scrapy version
command, useful for bug reports (#298)HTTP cache now stored by default in the project data dir (#279)
Added project data storage directory (#276, #277)
Documented file structure of Scrapy projects (see command-line tool doc)
New lxml backend for XPath selectors (#147)
Per-spider settings (#245)
Support exit codes to signal errors in Scrapy commands (#248)
Added
-c
argument toscrapy shell
commandMade
libxml2
optional (#260)New
deploy
command (#261)Added CLOSESPIDER_PAGECOUNT setting (#253)
Added setting (#254)
Scrapyd changes
Scrapyd now uses one process per spider
It stores one log file per spider run, and rotate them keeping the latest 5 logs per spider (by default)
A minimal web ui was added, available at by default
There is now a
scrapy server
command to start a Scrapyd server of the current project
Changes to settings
added
HTTPCACHE_ENABLED
setting (False by default) to enable HTTP cache middlewarechanged
HTTPCACHE_EXPIRATION_SECS
semantics: now zero means “never expire”.
Deprecated/obsoleted functionality
Deprecated
runserver
command in favor ofserver
command which starts a Scrapyd server. See also: Scrapyd changesDeprecated
queue
command in favor of using Scrapydschedule.json
API. See also: Scrapyd changesRemoved the !LxmlItemLoader (experimental contrib which never graduated to main contrib)
Scrapy 0.10
The numbers like #NNN reference tickets in the old issue tracker (Trac) which is no longer available.
New features and improvements
New Scrapy service called
scrapyd
for deploying Scrapy crawlers in production (#218) (documentation available)Simplified Images pipeline usage which doesn’t require subclassing your own images pipeline now (#217)
Scrapy shell now shows the Scrapy log by default (#206)
Refactored execution queue in a common base code and pluggable backends called “spider queues” (#220)
New persistent spider queue (based on SQLite) (#198), available by default, which allows to start Scrapy in server mode and then schedule spiders to run.
Added documentation for Scrapy command-line tool and all its available sub-commands. (documentation available)
Feed exporters with pluggable backends (#197) (documentation available)
Deferred signals (#193)
Added two new methods to item pipeline open_spider(), close_spider() with deferred support (#195)
Support for overriding default request headers per spider (#181)
Replaced default Spider Manager with one with similar functionality but not depending on Twisted Plugins (#186)
Split Debian package into two packages - the library and the service (#187)
Scrapy log refactoring (#188)
New extension for keeping persistent spider contexts among different runs (#203)
Added
dont_redirect
request.meta key for avoiding redirects (#233)Added
dont_retry
request.meta key for avoiding retries (#234)
Command-line tool changes
New
scrapy
command which replaces the oldscrapy-ctl.py
(#199) - there is only one globalscrapy
command now, instead of onescrapy-ctl.py
per project - Addedscrapy.bat
script for running more conveniently from WindowsAdded bash completion to command-line tool (#210)
Renamed command
start
torunserver
(#209)
API changes
url
andbody
attributes of Request objects are now read-only (#230)Request.copy()
andRequest.replace()
now also copies theircallback
anderrback
attributes (#231)Removed
UrlFilterMiddleware
fromscrapy.contrib
(already disabled by default)Offsite middleware doesn’t filter out any request coming from a spider that doesn’t have a allowed_domains attribute (#225)
Removed Spider Manager
load()
method. Now spiders are loaded in the__init__
method itself.Changes to Scrapy Manager (now called “Crawler”):
scrapy.core.manager.ScrapyManager
class renamed toscrapy.crawler.Crawler
scrapy.core.manager.scrapymanager
singleton moved toscrapy.project.crawler
Moved module:
scrapy.contrib.spidermanager
toscrapy.spidermanager
Spider Manager singleton moved from
scrapy.spider.spiders
to thespiders` attribute of ``scrapy.project.crawler
singleton.moved Stats Collector classes: (#204)
scrapy.stats.collector.StatsCollector
toscrapy.statscol.StatsCollector
scrapy.stats.collector.SimpledbStatsCollector
toscrapy.contrib.statscol.SimpledbStatsCollector
default per-command settings are now specified in the
default_settings
attribute of command object class (#201)changed arguments of Item pipeline
process_item()
method from(spider, item)
to(item, spider)
- backward compatibility kept (with deprecation warning)
moved
scrapy.core.signals
module toscrapy.signals
- backward compatibility kept (with deprecation warning)
moved
scrapy.core.exceptions
module toscrapy.exceptions
- backward compatibility kept (with deprecation warning)
added
handles_request()
class method toBaseSpider
dropped
scrapy.log.exc()
function (usescrapy.log.err()
instead)dropped
component
argument ofscrapy.log.msg()
functiondropped
scrapy.log.log_level
attributeAdded
from_settings()
class methods to Spider Manager, and Item Pipeline Manager
Changes to settings
Added
HTTPCACHE_IGNORE_SCHEMES
setting to ignore certain schemes on !HttpCacheMiddleware (#225)Added
SPIDER_QUEUE_CLASS
setting which defines the spider queue to use (#220)Added
KEEP_ALIVE
setting (#220)Removed
SERVICE_QUEUE
setting (#220)Removed
COMMANDS_SETTINGS_MODULE
setting (#201)Renamed
REQUEST_HANDLERS
toDOWNLOAD_HANDLERS
and make download handlers classes (instead of functions)
Scrapy 0.9
The numbers like #NNN reference tickets in the old issue tracker (Trac) which is no longer available.
New features and improvements
Added SMTP-AUTH support to scrapy.mail
New settings added:
MAIL_USER
,MAIL_PASS
( | #149)Added new scrapy-ctl view command - To view URL in the browser, as seen by Scrapy (r2039)
Added web service for controlling Scrapy process (this also deprecates the web console. ( | #167)
Support for running Scrapy as a service, for production systems (r1988, , r2055, , r2057 | #168)
Added wrapper induction library (documentation only available in source code for now). ()
Simplified and improved response encoding support (r1961, )
Added
LOG_ENCODING
setting (r1956, documentation available)Added
RANDOMIZE_DOWNLOAD_DELAY
setting (enabled by default) (, doc available)MailSender
is no longer IO-blocking (r1955 | #146)Linkextractors and new Crawlspider now handle relative base tag urls ( | #148)
Several improvements to Item Loaders and processors (r2022, , r2024, , r2026, , r2028, , r2030)
Added support for adding variables to telnet console ( | #165)
Support for requests without callbacks (r2050 | #166)
API changes
Change
Spider.domain_name
toSpider.name
(SEP-012, r1975)Response.encoding
is now the detected encoding ()HttpErrorMiddleware
now returns None or raises an exception (r2006 | #157)scrapy.command
modules relocation (, r2036, )Added
ExecutionQueue
for feeding spiders to scrape (r2034)Removed
ExecutionEngine
singleton ()Ported
S3ImagesStore
(images pipeline) to use boto and threads (r2033)Moved module:
scrapy.management.telnet
toscrapy.telnet
()
Changes to default settings
- Changed default
SCHEDULER_ORDER
toDFO
()
Scrapy 0.8
The numbers like #NNN reference tickets in the old issue tracker (Trac) which is no longer available.
Added DEFAULT_RESPONSE_ENCODING setting ()
Added
dont_click
argument toFormRequest.from_response()
method (r1813, )Added
clickdata
argument toFormRequest.from_response()
method (r1802, )Added support for HTTP proxies (
HttpProxyMiddleware
) (r1781, )Offsite spider middleware now logs messages when filtering out requests (r1841)
Backward-incompatible changes
Changed
scrapy.utils.response.get_meta_refresh()
signature (r1804)Removed deprecated
scrapy.item.ScrapedItem
class - usescrapy.item.Item instead
()Removed deprecated
scrapy.xpath
module - usescrapy.selector
instead. (r1836)Removed deprecated
core.signals.domain_open
signal - usecore.signals.domain_opened
instead ()log.msg()
now receives aspider
argument (r1822)- Old domain argument has been deprecated and will be removed in 0.9. For spiders, you should always use the
spider
argument and pass spider references. If you really want to pass a string, use thecomponent
argument instead.
- Old domain argument has been deprecated and will be removed in 0.9. For spiders, you should always use the
Changed core signals
domain_opened
,domain_closed
,domain_idle
Changed Item pipeline to use spiders instead of domains
The
domain
argument ofprocess_item()
item pipeline method was changed tospider
, the new signature is:process_item(spider, item)
( | #105)To quickly port your code (to work with Scrapy 0.8) just use
spider.domain_name
where you previously useddomain
.
Changed Stats API to use spiders instead of domains (r1849 | #113)
StatsCollector
was changed to receive spider references (instead of domains) in its methods (set_value
,inc_value
, etc).added
StatsCollector.iter_spider_stats()
methodremoved
StatsCollector.list_domains()
methodAlso, Stats signals were renamed and now pass around spider references (instead of domains). Here’s a summary of the changes:
To quickly port your code (to work with Scrapy 0.8) just use
spider.domain_name
where you previously useddomain
.spider_stats
contains exactly the same data asdomain_stats
.
CloseDomain
extension moved toscrapy.contrib.closespider.CloseSpider
()Its settings were also renamed:
CLOSEDOMAIN_TIMEOUT
toCLOSESPIDER_TIMEOUT
CLOSEDOMAIN_ITEMCOUNT
toCLOSESPIDER_ITEMCOUNT
Removed deprecated
SCRAPYSETTINGS_MODULE
environment variable - useSCRAPY_SETTINGS_MODULE
instead (r1840)Renamed setting:
REQUESTS_PER_DOMAIN
toCONCURRENT_REQUESTS_PER_SPIDER
(, r1844)Renamed setting:
CONCURRENT_DOMAINS
toCONCURRENT_SPIDERS
()Refactored HTTP Cache middleware
HTTP Cache middleware has been heavilty refactored, retaining the same functionality except for the domain sectorization which was removed. (r1843 )
Renamed exception:
DontCloseDomain
toDontCloseSpider
( | #120)Removed obsolete
scrapy.utils.markup.remove_escape_chars
function - usescrapy.utils.markup.replace_escape_chars
instead (r1865)