From 8d97f49e5e31955fb972dc63106298032ebe0e59 Mon Sep 17 00:00:00 2001 From: Harrison Gregg Date: Sat, 9 Sep 2017 13:54:48 +0630 Subject: [PATCH 001/532] Re-add SIGINT handler in inspect_response after shell closes --- scrapy/shell.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/scrapy/shell.py b/scrapy/shell.py index 80b625633..af91d6ce0 100644 --- a/scrapy/shell.py +++ b/scrapy/shell.py @@ -164,7 +164,11 @@ class Shell(object): def inspect_response(response, spider): """Open a shell to inspect the given response""" + # Shell.start removes the SIGINT handler, so save it and re-add it after + # the shell has closed + sigint_handler = signal.getsignal(signal.SIGINT) Shell(spider.crawler).start(response=response, spider=spider) + signal.signal(signal.SIGINT, sigint_handler) def _request_deferred(request): From 25e616fa04bf4199b9017553b3e57699c40b0683 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Fri, 15 Mar 2019 18:09:47 +0530 Subject: [PATCH 002/532] do not degrade JPEG files. --- scrapy/pipelines/images.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index a1457c7e9..add606a2e 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -127,7 +127,7 @@ class ImagesPipeline(FilesPipeline): raise ImageException("Image too small (%dx%d < %dx%d)" % (width, height, self.min_width, self.min_height)) - image, buf = self.convert_image(orig_image) + image, buf = self.convert_image(orig_image, BytesIO(response.body)) yield path, image, buf for thumb_id, size in six.iteritems(self.thumbs): @@ -135,7 +135,7 @@ class ImagesPipeline(FilesPipeline): thumb_image, thumb_buf = self.convert_image(image, size) yield thumb_path, thumb_image, thumb_buf - def convert_image(self, image, size=None): + def convert_image(self, image, response_body, size=None): if image.format == 'PNG' and image.mode == 'RGBA': background = Image.new('RGBA', image.size, (255, 255, 255)) background.paste(image, image) @@ -152,6 +152,9 @@ class ImagesPipeline(FilesPipeline): image = image.copy() image.thumbnail(size, Image.ANTIALIAS) + if not size and image.format == 'JPEG': + return image, response_body + buf = BytesIO() image.save(buf, 'JPEG') return image, buf From 07487dd487f7a10fbf0693e378b7b66909a67d6b Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Fri, 15 Mar 2019 23:29:53 +0530 Subject: [PATCH 003/532] make tests work with new convert_image --- tests/test_pipeline_images.py | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index a7c652959..eb3347442 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -79,28 +79,28 @@ class ImagesPipelineTestCase(unittest.TestCase): SIZE = (100, 100) # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) - im = _create_image('JPEG', 'RGB', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im) + im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) + converted, buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) # check that thumbnail keep image ratio - thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25)) + thumbnail, buf = self.pipeline.convert_image(converted, buf, size=(10, 25)) self.assertEqual(thumbnail.mode, 'RGB') self.assertEqual(thumbnail.size, (10, 10)) # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) - im = _create_image('PNG', 'RGBA', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + converted, buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # transparency case with palette: P and PNG COLOUR = (0, 127, 255, 50) - im = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) im = im.convert('P') - converted, _ = self.pipeline.convert_image(im) + converted, buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) @@ -406,7 +406,7 @@ def _create_image(format, *a, **kw): buf = io.BytesIO() Image.new(*a, **kw).save(buf, format) buf.seek(0) - return Image.open(buf) + return Image.open(buf), buf if __name__ == "__main__": From ca882d8d9f094244d9f1d3476fb72fab9c230765 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Wed, 27 Mar 2019 19:10:44 +0530 Subject: [PATCH 004/532] include test --- tests/test_pipeline_images.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index eb3347442..efa96e146 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -80,9 +80,10 @@ class ImagesPipelineTestCase(unittest.TestCase): # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) - converted, buf = self.pipeline.convert_image(im, buf) + converted, converted_buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) + self.assertEqual(converted_buf.read(), buf.read()) # check that thumbnail keep image ratio thumbnail, buf = self.pipeline.convert_image(converted, buf, size=(10, 25)) From 484bd0d22a11a04ab775ac4f72c75f3ec9050d98 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 22 Mar 2019 16:59:29 +0100 Subject: [PATCH 005/532] Allow customizing export column names --- docs/topics/exporters.rst | 35 +++++++++++++++----- docs/topics/feed-exports.rst | 17 +++------- scrapy/exporters.py | 32 +++++++++++++++--- scrapy/extensions/feedexport.py | 3 +- scrapy/settings/__init__.py | 35 +++++++++++++++++++- tests/test_exporters.py | 15 ++++++++- tests/test_feedexport.py | 57 +++++++++++++++++++++++++++++++++ 7 files changed, 165 insertions(+), 29 deletions(-) diff --git a/docs/topics/exporters.rst b/docs/topics/exporters.rst index f5048d2da..42a93e459 100644 --- a/docs/topics/exporters.rst +++ b/docs/topics/exporters.rst @@ -190,14 +190,33 @@ BaseItemExporter .. attribute:: fields_to_export - A list with the name of the fields that will be exported, or None if you - want to export all fields. Defaults to None. + Fields to export, their order [1]_ and their output names. - Some exporters (like :class:`CsvItemExporter`) respect the order of the - fields defined in this attribute. + Possible values are: - Some exporters may require fields_to_export list in order to export the - data properly when spiders return dicts (not :class:`~Item` instances). + - ``None`` (all fields [2]_, default) + + - A list of fields:: + + ['field1', 'field2'] + + - A dict [3]_ where keys are fields and values are output names:: + + {'field1': 'Field 1', 'field2': 'Field 2'} + + .. [1] Not all exporters respect the specified field order. + .. [2] If you yield items as dicts (not :class:`Item` instances), + exporters that need to know the fields to export beforehand, like + :class:`CsvItemExporter`, only export the fields found in the + first item. + .. [3] Dicts preserve insertion order since `Python 3.7`_ + (`CPython 3.6`_, `PyPy 2.5`_). If you are using an older version + of Python, use an OrderedDict_ to enforce a specific field order. + + .. _Python 3.7: https://docs.python.org/whatsnew/3.7.html + .. _CPython 3.6: https://docs.python.org/whatsnew/3.6.html#new-dict-implementation + .. _PyPy 2.5: https://morepypy.blogspot.com/2015/02/pypy-250-released.html + .. _OrderedDict: https://docs.python.org/library/collections.html#collections.OrderedDict .. attribute:: export_empty_fields @@ -286,8 +305,8 @@ CsvItemExporter Exports Items in CSV format to the given file-like object. If the :attr:`fields_to_export` attribute is set, it will be used to define the - CSV columns and their order. The :attr:`export_empty_fields` attribute has - no effect on this exporter. + CSV columns, their order and their column names. The + :attr:`export_empty_fields` attribute has no effect on this exporter. :param file: the file-like object to use for exporting the data. Its ``write`` method should accept ``bytes`` (a disk file opened in binary mode, a ``io.BytesIO`` object, etc) diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index cf70b8aca..968cb8884 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -56,7 +56,7 @@ CSV * :setting:`FEED_FORMAT`: ``csv`` * Exporter used: :class:`~scrapy.exporters.CsvItemExporter` - * To specify columns to export and their order use + * To specify columns to export, their order and their column names, use :setting:`FEED_EXPORT_FIELDS`. Other feed exporters can also use this option, but it is important for CSV because unlike many other export formats CSV uses a fixed header. @@ -259,18 +259,9 @@ FEED_EXPORT_FIELDS Default: ``None`` -A list of fields to export, optional. -Example: ``FEED_EXPORT_FIELDS = ["foo", "bar", "baz"]``. - -Use FEED_EXPORT_FIELDS option to define fields to export and their order. - -When FEED_EXPORT_FIELDS is empty or None (default), Scrapy uses fields -defined in dicts or :class:`~.Item` subclasses a spider is yielding. - -If an exporter requires a fixed set of fields (this is the case for -:ref:`CSV ` export format) and FEED_EXPORT_FIELDS -is empty or None, then Scrapy tries to infer field names from the -exported data - currently it uses field names from the first item. +Use the ``FEED_EXPORT_FIELDS`` setting to define the fields to export, their +order and their output names. See :attr:`BaseItemExporter.fields_to_export +` for more information. .. setting:: FEED_EXPORT_INDENT diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 695c74fec..c05acaca5 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -2,6 +2,7 @@ Item Exporters are used to export/serialize items into different formats. """ +from collections import Mapping import csv import io import sys @@ -64,6 +65,14 @@ class BaseItemExporter(object): field_iter = six.iterkeys(item.fields) else: field_iter = six.iterkeys(item) + elif isinstance(self.fields_to_export, Mapping): + if include_empty: + field_iter = self.fields_to_export.items() + else: + field_iter = ( + (x, y) for x, y in self.fields_to_export.items() + if x in item + ) else: if include_empty: field_iter = self.fields_to_export @@ -71,13 +80,22 @@ class BaseItemExporter(object): field_iter = (x for x in self.fields_to_export if x in item) for field_name in field_iter: - if field_name in item: - field = {} if isinstance(item, dict) else item.fields[field_name] - value = self.serialize_field(field, field_name, item[field_name]) + if isinstance(field_name, six.string_types): + item_field, output_field = field_name, field_name + else: + item_field, output_field = field_name + if item_field in item: + if isinstance(item, dict): + field = {} + else: + field = item.fields[item_field] + value = self.serialize_field( + field, output_field, item[item_field] + ) else: value = default_value - yield field_name, value + yield output_field, value class JsonLinesItemExporter(BaseItemExporter): @@ -259,7 +277,11 @@ class CsvItemExporter(BaseItemExporter): else: # use fields declared in Item self.fields_to_export = list(item.fields.keys()) - row = list(self._build_row(self.fields_to_export)) + if isinstance(self.fields_to_export, Mapping): + fields = self.fields_to_export.values() + else: + fields = self.fields_to_export + row = list(self._build_row(fields)) self.csv_writer.writerow(row) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index b2f7267a2..1ed476d83 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -201,7 +201,8 @@ class FeedExporter(object): raise NotConfigured self.store_empty = settings.getbool('FEED_STORE_EMPTY') self._exporting = False - self.export_fields = settings.getlist('FEED_EXPORT_FIELDS') or None + self.export_fields = settings.getdictorlist('FEED_EXPORT_FIELDS') + self.export_fields = self.export_fields or None self.indent = None if settings.get('FEED_EXPORT_INDENT') is not None: self.indent = settings.getint('FEED_EXPORT_INDENT') diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index 14c93bef2..69b324e84 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -1,7 +1,7 @@ import six import json import copy -from collections import MutableMapping +from collections import MutableMapping, OrderedDict from importlib import import_module from pprint import pformat @@ -198,6 +198,39 @@ class BaseSettings(MutableMapping): value = json.loads(value) return dict(value) + def getdictorlist(self, name, default=None): + """Get a setting value as either an ``OrderedDict`` or a list. + + If the setting is already a dict or a list, a copy of it will be + returned. + + If it is a string it will be evaluated as JSON, or as a comma-separated + list of strings as a fallback. + + For example, settings populated through environment variables will + return: + + - ``OrdetedDict([('key1', 'value1'), ('key2', 'value2')])`` if set to + ``'{"key1": "value1", "key2": "value2"}'`` + + - ``['one', 'two']`` if set to ``'["one", "two"]'`` or ``'one,two'`` + + :param name: the setting name + :type name: string + + :param default: the value to return if no setting is found + :type default: any + """ + value = self.get(name, default) + if value is None: + return {} + if isinstance(value, six.string_types): + try: + return json.loads(value, object_pairs_hook=OrderedDict) + except ValueError: + return value.split(',') + return copy.deepcopy(value) + def getwithbase(self, name): """Get a composition of a dictionary-like setting and its `_BASE` counterpart. diff --git a/tests/test_exporters.py b/tests/test_exporters.py index cd72c661a..1b3dc14a1 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -1,4 +1,7 @@ +# -*- coding:utf-8 -*- + from __future__ import absolute_import +from collections import OrderedDict import re import json import marshal @@ -83,6 +86,14 @@ class BaseItemExporterTest(unittest.TestCase): assert isinstance(name, six.text_type) self.assertEqual(name, u'John\xa3') + ie = self._get_exporter( + fields_to_export=OrderedDict([('name', u'名稱')]) + ) + self.assertEqual( + list(ie._get_serialized_fields(self.i)), + [(u'名稱', u'John\xa3')] + ) + def test_field_custom_serializer(self): def custom_serializer(value): return str(int(value) + 2) @@ -214,6 +225,7 @@ class MarshalItemExporterTest(BaseItemExporterTest): class CsvItemExporterTest(BaseItemExporterTest): def _get_exporter(self, **kwargs): + self.output = tempfile.TemporaryFile() return CsvItemExporter(self.output, **kwargs) def assertCsvEqual(self, first, second, msg=None): @@ -224,7 +236,8 @@ class CsvItemExporterTest(BaseItemExporterTest): return self.assertEqual(csvsplit(first), csvsplit(second), msg) def _check_output(self): - self.assertCsvEqual(to_unicode(self.output.getvalue()), u'age,name\r\n22,John\xa3\r\n') + self.output.seek(0) + self.assertCsvEqual(to_unicode(self.output.read()), u'age,name\r\n22,John\xa3\r\n') def assertExportResult(self, item, expected, **kwargs): fp = BytesIO() diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index eef0384cf..4f72c0ff4 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -1,4 +1,5 @@ from __future__ import absolute_import +from collections import OrderedDict import os import csv import json @@ -578,6 +579,62 @@ class FeedExportTest(unittest.TestCase): yield self.assertExported(items, header, rows, settings=settings, ordered=True) + # fields may be defined as a comma-separated list + header = ["foo", "baz", "hello"] + settings = {'FEED_EXPORT_FIELDS': ",".join(header)} + rows = [ + {'foo': 'bar1', 'baz': '', 'hello': ''}, + {'foo': 'bar2', 'baz': '', 'hello': 'world2'}, + {'foo': 'bar3', 'baz': 'quux3', 'hello': ''}, + {'foo': '', 'baz': '', 'hello': 'world4'}, + ] + yield self.assertExported(items, header, rows, + settings=settings, ordered=True) + + # fields may also be defined as a JSON array + header = ["foo", "baz", "hello"] + settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} + rows = [ + {'foo': 'bar1', 'baz': '', 'hello': ''}, + {'foo': 'bar2', 'baz': '', 'hello': 'world2'}, + {'foo': 'bar3', 'baz': 'quux3', 'hello': ''}, + {'foo': '', 'baz': '', 'hello': 'world4'}, + ] + yield self.assertExported(items, header, rows, + settings=settings, ordered=True) + + # custom output field names can be specified + header = OrderedDict(( + ("foo", "Foo"), + ("baz", "Baz"), + ("hello", "Hello"), + )) + settings = {'FEED_EXPORT_FIELDS': header} + rows = [ + {'Foo': 'bar1', 'Baz': '', 'Hello': ''}, + {'Foo': 'bar2', 'Baz': '', 'Hello': 'world2'}, + {'Foo': 'bar3', 'Baz': 'quux3', 'Hello': ''}, + {'Foo': '', 'Baz': '', 'Hello': 'world4'}, + ] + yield self.assertExported(items, list(header.values()), rows, + settings=settings, ordered=True) + + # custom output field names can be specified as a JSON object + header = OrderedDict(( + ("foo", "Foo"), + ("baz", "Baz"), + ("hello", "Hello"), + )) + settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} + rows = [ + {'Foo': 'bar1', 'Baz': '', 'Hello': ''}, + {'Foo': 'bar2', 'Baz': '', 'Hello': 'world2'}, + {'Foo': 'bar3', 'Baz': 'quux3', 'Hello': ''}, + {'Foo': '', 'Baz': '', 'Hello': 'world4'}, + ] + yield self.assertExported(items, list(header.values()), rows, + settings=settings, ordered=True) + @defer.inlineCallbacks def test_export_dicts(self): # When dicts are used, only keys from the first row are used as From 398639a0bfe749eee07e51249f04b2c6c93eab73 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Mon, 8 Apr 2019 12:27:36 +0530 Subject: [PATCH 006/532] fix test --- scrapy/pipelines/images.py | 5 +++-- tests/test_pipeline_images.py | 41 +++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index add606a2e..746244dab 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -132,7 +132,7 @@ class ImagesPipeline(FilesPipeline): for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) - thumb_image, thumb_buf = self.convert_image(image, size) + thumb_image, thumb_buf = self.convert_image(image, buf, size) yield thumb_path, thumb_image, thumb_buf def convert_image(self, image, response_body, size=None): @@ -153,7 +153,8 @@ class ImagesPipeline(FilesPipeline): image.thumbnail(size, Image.ANTIALIAS) if not size and image.format == 'JPEG': - return image, response_body + buf = BytesIO(response_body.read()) + return image, buf buf = BytesIO() image.save(buf, 'JPEG') diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index efa96e146..dde0fa030 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -83,6 +83,47 @@ class ImagesPipelineTestCase(unittest.TestCase): converted, converted_buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) + + # check that we don't convert JPEGs again + buf = io.BytesIO((b'\xff\xd8\xff\xe0\x00\x10JFIF\x00\x01\x01\x00\x00\x01\x00\x01\x00\x00' + b'\xff\xdb\x00C\x00\x08\x06\x06\x07\x06\x05\x08\x07\x07\x07\t\t\x08\n\x0c' + b'\x14\r\x0c\x0b\x0b\x0c\x19\x12\x13\x0f\x14\x1d\x1a\x1f\x1e\x1d\x1a\x1c\x1c ' + b'$.\' ",#\x1c\x1c(7),01444\x1f\'9=82<.342\xff\xdb\x00C\x01\t\t\t\x0c\x0b\x0c' + b'\x18\r\r\x182!\x1c!222222222222222222222222222222222222222222222222' + b'22\xff\xc0\x00\x11\x08\x00\x14\x00\x14\x03\x01"\x00\x02\x11\x01\x03\x11' + b'\x01\xff\xc4\x00\x1f\x00\x00\x01\x05\x01\x01\x01\x01\x01\x01\x00' + b'\x00\x00\x00\x00\x00\x00\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\xff\xc4' + b'\x00\xb5\x10\x00\x02\x01\x03\x03\x02\x04\x03\x05\x05\x04\x04\x00' + b'\x00\x01}\x01\x02\x03\x00\x04\x11\x05\x12!1A\x06\x13Qa\x07"q\x142\x81' + b"\x91\xa1\x08#B\xb1\xc1\x15R\xd1\xf0$3br\x82\t\n\x16\x17\x18\x19\x1a%&'()*456" + b'789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz\x83\x84\x85\x86\x87\x88\x89\x8a' + b'\x92\x93\x94\x95\x96\x97\x98\x99\x9a\xa2\xa3\xa4\xa5\xa6\xa7\xa8' + b'\xa9\xaa\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xc2\xc3\xc4\xc5\xc6' + b'\xc7\xc8\xc9\xca\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xe1\xe2\xe3' + b'\xe4\xe5\xe6\xe7\xe8\xe9\xea\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9' + b'\xfa\xff\xc4\x00\x1f\x01\x00\x03\x01\x01\x01\x01\x01\x01\x01\x01' + b'\x01\x00\x00\x00\x00\x00\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\xff\xc4' + b'\x00\xb5\x11\x00\x02\x01\x02\x04\x04\x03\x04\x07\x05\x04\x04\x00' + b'\x01\x02w\x00\x01\x02\x03\x11\x04\x05!1\x06\x12AQ\x07aq\x13"2\x81\x08' + b"\x14B\x91\xa1\xb1\xc1\t#3R\xf0\x15br\xd1\n\x16$4\xe1%\xf1\x17\x18\x19\x1a&'" + b'()*56789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz\x82\x83\x84\x85\x86\x87\x88' + b'\x89\x8a\x92\x93\x94\x95\x96\x97\x98\x99\x9a\xa2\xa3\xa4\xa5\xa6' + b'\xa7\xa8\xa9\xaa\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xc2\xc3\xc4' + b'\xc5\xc6\xc7\xc8\xc9\xca\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xe2' + b'\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9' + b'\xfa\xff\xda\x00\x0c\x03\x01\x00\x02\x11\x03\x11\x00?\x00\xbb' + b'\xe2\x1b\xcb\x88\xe4\x90\t\x0e1\xd2\xb9\xab\x1dF\xe6\xda\xe0\xb4l\xd9' + b'5>\xaf\xac\xc7y}$k\x92\x03u\xaaL\xeb\x18VL\x9fZ+\xb9\xb9EBV]Ow\x0f\x8a\xc0' + b'\xac\x14\xbd\xa2NG_\xa5x\x8esg\xfb\xd9\x8e\xed\xc79\xa2\xa1\xd0\xf4\x8bk' + b'\x9d5e\xdeN\xe6=\xa8\xae\xa9V\xc2\xb6|\xdf2\xeep:w\xfc\x84d\x04g\x9e\xf5\xd3' + b'L\xa9\x0c\x1f*/>\xa2\x8a+\xca\x93z\x1c\x15]\xa9\xc6\xc4Q\xea\x97V\xca' + b'c\x85\xc2\xaes\x80(\xa2\x8a\xe3\x92W<\xdb\x9f\xff\xd9')) + im = Image.open(buf) + buf.seek(0) + converted, converted_buf = self.pipeline.convert_image(im, buf) + converted_buf.seek(0) + buf.seek(0) + self.assertEqual(im.format, "JPEG") self.assertEqual(converted_buf.read(), buf.read()) # check that thumbnail keep image ratio From c6769d6887b5c311c9083a5ac0349e81d1a2aea7 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Sat, 13 Apr 2019 10:10:08 +0530 Subject: [PATCH 007/532] make suggested changes --- scrapy/pipelines/images.py | 6 ++--- tests/test_pipeline_images.py | 42 +---------------------------------- 2 files changed, 3 insertions(+), 45 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 746244dab..3450ee721 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -151,10 +151,8 @@ class ImagesPipeline(FilesPipeline): if size: image = image.copy() image.thumbnail(size, Image.ANTIALIAS) - - if not size and image.format == 'JPEG': - buf = BytesIO(response_body.read()) - return image, buf + elif image.format == 'JPEG': + return image, response_body buf = BytesIO() image.save(buf, 'JPEG') diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index dde0fa030..b419039b3 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -83,48 +83,8 @@ class ImagesPipelineTestCase(unittest.TestCase): converted, converted_buf = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) - # check that we don't convert JPEGs again - buf = io.BytesIO((b'\xff\xd8\xff\xe0\x00\x10JFIF\x00\x01\x01\x00\x00\x01\x00\x01\x00\x00' - b'\xff\xdb\x00C\x00\x08\x06\x06\x07\x06\x05\x08\x07\x07\x07\t\t\x08\n\x0c' - b'\x14\r\x0c\x0b\x0b\x0c\x19\x12\x13\x0f\x14\x1d\x1a\x1f\x1e\x1d\x1a\x1c\x1c ' - b'$.\' ",#\x1c\x1c(7),01444\x1f\'9=82<.342\xff\xdb\x00C\x01\t\t\t\x0c\x0b\x0c' - b'\x18\r\r\x182!\x1c!222222222222222222222222222222222222222222222222' - b'22\xff\xc0\x00\x11\x08\x00\x14\x00\x14\x03\x01"\x00\x02\x11\x01\x03\x11' - b'\x01\xff\xc4\x00\x1f\x00\x00\x01\x05\x01\x01\x01\x01\x01\x01\x00' - b'\x00\x00\x00\x00\x00\x00\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\xff\xc4' - b'\x00\xb5\x10\x00\x02\x01\x03\x03\x02\x04\x03\x05\x05\x04\x04\x00' - b'\x00\x01}\x01\x02\x03\x00\x04\x11\x05\x12!1A\x06\x13Qa\x07"q\x142\x81' - b"\x91\xa1\x08#B\xb1\xc1\x15R\xd1\xf0$3br\x82\t\n\x16\x17\x18\x19\x1a%&'()*456" - b'789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz\x83\x84\x85\x86\x87\x88\x89\x8a' - b'\x92\x93\x94\x95\x96\x97\x98\x99\x9a\xa2\xa3\xa4\xa5\xa6\xa7\xa8' - b'\xa9\xaa\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xc2\xc3\xc4\xc5\xc6' - b'\xc7\xc8\xc9\xca\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xe1\xe2\xe3' - b'\xe4\xe5\xe6\xe7\xe8\xe9\xea\xf1\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9' - b'\xfa\xff\xc4\x00\x1f\x01\x00\x03\x01\x01\x01\x01\x01\x01\x01\x01' - b'\x01\x00\x00\x00\x00\x00\x00\x01\x02\x03\x04\x05\x06\x07\x08\t\n\x0b\xff\xc4' - b'\x00\xb5\x11\x00\x02\x01\x02\x04\x04\x03\x04\x07\x05\x04\x04\x00' - b'\x01\x02w\x00\x01\x02\x03\x11\x04\x05!1\x06\x12AQ\x07aq\x13"2\x81\x08' - b"\x14B\x91\xa1\xb1\xc1\t#3R\xf0\x15br\xd1\n\x16$4\xe1%\xf1\x17\x18\x19\x1a&'" - b'()*56789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz\x82\x83\x84\x85\x86\x87\x88' - b'\x89\x8a\x92\x93\x94\x95\x96\x97\x98\x99\x9a\xa2\xa3\xa4\xa5\xa6' - b'\xa7\xa8\xa9\xaa\xb2\xb3\xb4\xb5\xb6\xb7\xb8\xb9\xba\xc2\xc3\xc4' - b'\xc5\xc6\xc7\xc8\xc9\xca\xd2\xd3\xd4\xd5\xd6\xd7\xd8\xd9\xda\xe2' - b'\xe3\xe4\xe5\xe6\xe7\xe8\xe9\xea\xf2\xf3\xf4\xf5\xf6\xf7\xf8\xf9' - b'\xfa\xff\xda\x00\x0c\x03\x01\x00\x02\x11\x03\x11\x00?\x00\xbb' - b'\xe2\x1b\xcb\x88\xe4\x90\t\x0e1\xd2\xb9\xab\x1dF\xe6\xda\xe0\xb4l\xd9' - b'5>\xaf\xac\xc7y}$k\x92\x03u\xaaL\xeb\x18VL\x9fZ+\xb9\xb9EBV]Ow\x0f\x8a\xc0' - b'\xac\x14\xbd\xa2NG_\xa5x\x8esg\xfb\xd9\x8e\xed\xc79\xa2\xa1\xd0\xf4\x8bk' - b'\x9d5e\xdeN\xe6=\xa8\xae\xa9V\xc2\xb6|\xdf2\xeep:w\xfc\x84d\x04g\x9e\xf5\xd3' - b'L\xa9\x0c\x1f*/>\xa2\x8a+\xca\x93z\x1c\x15]\xa9\xc6\xc4Q\xea\x97V\xca' - b'c\x85\xc2\xaes\x80(\xa2\x8a\xe3\x92W<\xdb\x9f\xff\xd9')) - im = Image.open(buf) - buf.seek(0) - converted, converted_buf = self.pipeline.convert_image(im, buf) - converted_buf.seek(0) - buf.seek(0) - self.assertEqual(im.format, "JPEG") - self.assertEqual(converted_buf.read(), buf.read()) + self.assertEqual(converted_buf, buf) # check that thumbnail keep image ratio thumbnail, buf = self.pipeline.convert_image(converted, buf, size=(10, 25)) From 6039b66f42fe2c6e7708febb70939952cedaedd0 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Sat, 13 Apr 2019 10:17:26 +0530 Subject: [PATCH 008/532] aesthetic changes --- tests/test_pipeline_images.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index b419039b3..0a2153ddb 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -87,14 +87,14 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted_buf, buf) # check that thumbnail keep image ratio - thumbnail, buf = self.pipeline.convert_image(converted, buf, size=(10, 25)) + thumbnail, _ = self.pipeline.convert_image(converted, converted_buf, size=(10, 25)) self.assertEqual(thumbnail.mode, 'RGB') self.assertEqual(thumbnail.size, (10, 10)) # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) - converted, buf = self.pipeline.convert_image(im, buf) + converted, _ = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) @@ -102,7 +102,7 @@ class ImagesPipelineTestCase(unittest.TestCase): COLOUR = (0, 127, 255, 50) im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) im = im.convert('P') - converted, buf = self.pipeline.convert_image(im, buf) + converted, _ = self.pipeline.convert_image(im, buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) From 2a6bcdb413da0a4202fe905279d46d581368769d Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Mon, 29 Apr 2019 21:21:02 +0530 Subject: [PATCH 009/532] makes fix backward compatible --- scrapy/pipelines/images.py | 45 ++++++++++++++++++++++++++++++----- tests/test_pipeline_images.py | 8 +++---- 2 files changed, 43 insertions(+), 10 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 3450ee721..ca8ac7b83 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -126,16 +126,42 @@ class ImagesPipeline(FilesPipeline): if width < self.min_width or height < self.min_height: raise ImageException("Image too small (%dx%d < %dx%d)" % (width, height, self.min_width, self.min_height)) + + def _is_convert_image_overriden(): + import inspect + if six.PY2: + convert_image_signature = inspect.getargspec(self.convert_image) + elif six.PY3: + convert_image_signature = inspect.getfullargspec(self.convert_image) + if 'response_body' not in convert_image_signature.args: + return True + return False - image, buf = self.convert_image(orig_image, BytesIO(response.body)) + def _warn(): + from scrapy.exceptions import ScrapyDeprecationWarning + import warnings + warnings.warn('ImagesPipeline.convert_image() method overriden in a incompatible way, ' + 'overriden method does not accept response_body attribute.', + category=ScrapyDeprecationWarning, stacklevel=1) + + convert_image_overriden = _is_convert_image_overriden() + if convert_image_overriden: + _warn() + image, buf = self.convert_image(orig_image) + else: + image, buf = self.convert_image(orig_image, response_body=BytesIO(response.body)) yield path, image, buf for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) - thumb_image, thumb_buf = self.convert_image(image, buf, size) + if convert_image_overriden: + _warn() + thumb_image, thumb_buf = self.convert_image(image, size) + else: + thumb_image, thumb_buf = self.convert_image(image, size, buf) yield thumb_path, thumb_image, thumb_buf - def convert_image(self, image, response_body, size=None): + def convert_image(self, image, size=None, response_body=None): if image.format == 'PNG' and image.mode == 'RGBA': background = Image.new('RGBA', image.size, (255, 255, 255)) background.paste(image, image) @@ -151,9 +177,16 @@ class ImagesPipeline(FilesPipeline): if size: image = image.copy() image.thumbnail(size, Image.ANTIALIAS) - elif image.format == 'JPEG': - return image, response_body - + else: + if not response_body: + from scrapy.exceptions import ScrapyDeprecationWarning + import warnings + warnings.warn('ImagesPipeline.convert_image() method called in a incompatible way, ' + 'method called without response_body attribute.', + category=ScrapyDeprecationWarning, stacklevel=1) + elif image.format == 'JPEG': + return image, response_body + buf = BytesIO() image.save(buf, 'JPEG') return image, buf diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 0a2153ddb..3fe71589d 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -80,21 +80,21 @@ class ImagesPipelineTestCase(unittest.TestCase): # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) - converted, converted_buf = self.pipeline.convert_image(im, buf) + converted, converted_buf = self.pipeline.convert_image(im, response_body=buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) # check that we don't convert JPEGs again self.assertEqual(converted_buf, buf) # check that thumbnail keep image ratio - thumbnail, _ = self.pipeline.convert_image(converted, converted_buf, size=(10, 25)) + thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25), response_body=converted_buf) self.assertEqual(thumbnail.mode, 'RGB') self.assertEqual(thumbnail.size, (10, 10)) # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im, buf) + converted, _ = self.pipeline.convert_image(im, response_body=buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) @@ -102,7 +102,7 @@ class ImagesPipelineTestCase(unittest.TestCase): COLOUR = (0, 127, 255, 50) im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) im = im.convert('P') - converted, _ = self.pipeline.convert_image(im, buf) + converted, _ = self.pipeline.convert_image(im, response_body=buf) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) From 33925a77610293c44a169efd1c274239a75ba968 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Tue, 7 May 2019 15:44:21 +0530 Subject: [PATCH 010/532] test for deprecation warning --- scrapy/pipelines/images.py | 20 +++++------ tests/test_pipeline_images.py | 63 ++++++++++++++++++++--------------- 2 files changed, 47 insertions(+), 36 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index ca8ac7b83..9776817bc 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -141,7 +141,7 @@ class ImagesPipeline(FilesPipeline): from scrapy.exceptions import ScrapyDeprecationWarning import warnings warnings.warn('ImagesPipeline.convert_image() method overriden in a incompatible way, ' - 'overriden method does not accept response_body attribute.', + 'overriden method does not accept response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) convert_image_overriden = _is_convert_image_overriden() @@ -162,6 +162,13 @@ class ImagesPipeline(FilesPipeline): yield thumb_path, thumb_image, thumb_buf def convert_image(self, image, size=None, response_body=None): + if not response_body: + from scrapy.exceptions import ScrapyDeprecationWarning + import warnings + warnings.warn('ImagesPipeline.convert_image() method called in a incompatible way, ' + 'method called without response_body argument.', + category=ScrapyDeprecationWarning, stacklevel=1) + if image.format == 'PNG' and image.mode == 'RGBA': background = Image.new('RGBA', image.size, (255, 255, 255)) background.paste(image, image) @@ -177,15 +184,8 @@ class ImagesPipeline(FilesPipeline): if size: image = image.copy() image.thumbnail(size, Image.ANTIALIAS) - else: - if not response_body: - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings - warnings.warn('ImagesPipeline.convert_image() method called in a incompatible way, ' - 'method called without response_body attribute.', - category=ScrapyDeprecationWarning, stacklevel=1) - elif image.format == 'JPEG': - return image, response_body + elif response_body and image.format == 'JPEG': + return image, response_body buf = BytesIO() image.save(buf, 'JPEG') diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 3fe71589d..651691862 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -76,37 +76,48 @@ class ImagesPipelineTestCase(unittest.TestCase): 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') def test_convert_image(self): - SIZE = (100, 100) - # straigh forward case: RGB and JPEG + # tests for old API + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter('always') + + SIZE = (100, 100) + # straigh forward case: RGB and JPEG + COLOUR = (0, 127, 255) + im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) + converted, converted_buf = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) + + # check that thumbnail keep image ratio + thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25)) + self.assertEqual(thumbnail.mode, 'RGB') + self.assertEqual(thumbnail.size, (10, 10)) + + # transparency case: RGBA and PNG + COLOUR = (0, 127, 255, 50) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + converted, _ = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + + # transparency case with palette: P and PNG + COLOUR = (0, 127, 255, 50) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im = im.convert('P') + converted, _ = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + + # ensure that we recieved deprecation warnings + self.assertTrue(len(w) >= 4) + + # tests for new API + # check that we don't convert JPEGs again COLOUR = (0, 127, 255) im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) converted, converted_buf = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) - # check that we don't convert JPEGs again self.assertEqual(converted_buf, buf) - # check that thumbnail keep image ratio - thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25), response_body=converted_buf) - self.assertEqual(thumbnail.mode, 'RGB') - self.assertEqual(thumbnail.size, (10, 10)) - - # transparency case: RGBA and PNG - COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - - # transparency case with palette: P and PNG - COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) - im = im.convert('P') - converted, _ = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - - class DeprecatedImagesPipeline(ImagesPipeline): def file_key(self, url): return self.image_key(url) From 881bade2c1b2d5842f7d0bdf2648455996f814b7 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Tue, 7 May 2019 16:12:26 +0530 Subject: [PATCH 011/532] tests for new API --- tests/test_pipeline_images.py | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 651691862..1dfca5c11 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -79,12 +79,11 @@ class ImagesPipelineTestCase(unittest.TestCase): # tests for old API with warnings.catch_warnings(record=True) as w: warnings.simplefilter('always') - SIZE = (100, 100) # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) - im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) - converted, converted_buf = self.pipeline.convert_image(im) + im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR) + converted, _ = self.pipeline.convert_image(im) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) @@ -95,14 +94,14 @@ class ImagesPipelineTestCase(unittest.TestCase): # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) converted, _ = self.pipeline.convert_image(im) self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # transparency case with palette: P and PNG COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) im = im.convert('P') converted, _ = self.pipeline.convert_image(im) self.assertEqual(converted.mode, 'RGB') @@ -112,12 +111,36 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertTrue(len(w) >= 4) # tests for new API - # check that we don't convert JPEGs again + SIZE = (100, 100) + # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) converted, converted_buf = self.pipeline.convert_image(im, response_body=buf) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) + # check that we don't convert JPEGs again self.assertEqual(converted_buf, buf) + # check that thumbnail keep image ratio + thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25), response_body=converted_buf) + self.assertEqual(thumbnail.mode, 'RGB') + self.assertEqual(thumbnail.size, (10, 10)) + + # transparency case: RGBA and PNG + COLOUR = (0, 127, 255, 50) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + converted, _ = self.pipeline.convert_image(im, response_body=buf) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + + # transparency case with palette: P and PNG + COLOUR = (0, 127, 255, 50) + im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im = im.convert('P') + converted, _ = self.pipeline.convert_image(im, response_body=buf) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + class DeprecatedImagesPipeline(ImagesPipeline): def file_key(self, url): return self.image_key(url) From 653ac3eebe96bdfff8128cdb1e500728215486a2 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Thu, 16 May 2019 06:20:39 +0000 Subject: [PATCH 012/532] makes suggested changes --- scrapy/pipelines/images.py | 1 - tests/test_pipeline_images.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 9776817bc..b95383b3b 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -155,7 +155,6 @@ class ImagesPipeline(FilesPipeline): for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) if convert_image_overriden: - _warn() thumb_image, thumb_buf = self.convert_image(image, size) else: thumb_image, thumb_buf = self.convert_image(image, size, buf) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 1dfca5c11..ba79dd6bd 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -108,7 +108,7 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # ensure that we recieved deprecation warnings - self.assertTrue(len(w) >= 4) + self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a incompatible way' in str(warning.message)]) == 4) # tests for new API SIZE = (100, 100) From 2994b624e03ec9a2cba2c024eacf549329c056de Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Fri, 17 May 2019 12:14:43 +0000 Subject: [PATCH 013/532] makes suggested changes --- scrapy/pipelines/images.py | 21 +++++---------------- tests/test_pipeline_images.py | 2 +- 2 files changed, 6 insertions(+), 17 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index b95383b3b..fd34c9df6 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -15,7 +15,7 @@ except ImportError: from PIL import Image from scrapy.utils.misc import md5sum -from scrapy.utils.python import to_bytes +from scrapy.utils.python import to_bytes, get_func_args from scrapy.http import Request from scrapy.settings import Settings from scrapy.exceptions import DropItem @@ -127,25 +127,14 @@ class ImagesPipeline(FilesPipeline): raise ImageException("Image too small (%dx%d < %dx%d)" % (width, height, self.min_width, self.min_height)) - def _is_convert_image_overriden(): - import inspect - if six.PY2: - convert_image_signature = inspect.getargspec(self.convert_image) - elif six.PY3: - convert_image_signature = inspect.getfullargspec(self.convert_image) - if 'response_body' not in convert_image_signature.args: - return True - return False - def _warn(): from scrapy.exceptions import ScrapyDeprecationWarning import warnings - warnings.warn('ImagesPipeline.convert_image() method overriden in a incompatible way, ' + warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' 'overriden method does not accept response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) - convert_image_overriden = _is_convert_image_overriden() - if convert_image_overriden: + if 'response_body' not in get_func_args(self.convert_image): _warn() image, buf = self.convert_image(orig_image) else: @@ -154,7 +143,7 @@ class ImagesPipeline(FilesPipeline): for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) - if convert_image_overriden: + if 'response_body' not in get_func_args(self.convert_image): thumb_image, thumb_buf = self.convert_image(image, size) else: thumb_image, thumb_buf = self.convert_image(image, size, buf) @@ -164,7 +153,7 @@ class ImagesPipeline(FilesPipeline): if not response_body: from scrapy.exceptions import ScrapyDeprecationWarning import warnings - warnings.warn('ImagesPipeline.convert_image() method called in a incompatible way, ' + warnings.warn('ImagesPipeline.convert_image() method called in a deprecated way, ' 'method called without response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index ba79dd6bd..ec0c87264 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -108,7 +108,7 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # ensure that we recieved deprecation warnings - self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a incompatible way' in str(warning.message)]) == 4) + self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a deprecated way' in str(warning.message)]) == 4) # tests for new API SIZE = (100, 100) From c8e28ec194b3730e7954a18526ac77cb44138feb Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Thu, 23 May 2019 15:04:21 +0530 Subject: [PATCH 014/532] makes suggested changes --- scrapy/pipelines/images.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index fd34c9df6..a3f5f9292 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -134,7 +134,8 @@ class ImagesPipeline(FilesPipeline): 'overriden method does not accept response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) - if 'response_body' not in get_func_args(self.convert_image): + convert_image_overriden = 'response_body' not in get_func_args(self.convert_image) + if convert_image_overriden: _warn() image, buf = self.convert_image(orig_image) else: @@ -143,7 +144,7 @@ class ImagesPipeline(FilesPipeline): for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) - if 'response_body' not in get_func_args(self.convert_image): + if convert_image_overriden: thumb_image, thumb_buf = self.convert_image(image, size) else: thumb_image, thumb_buf = self.convert_image(image, size, buf) From 90fdefcbca89d0ef2cc81955b9fd8b8af1dff392 Mon Sep 17 00:00:00 2001 From: Anubhav Patel Date: Sat, 25 May 2019 19:11:48 +0530 Subject: [PATCH 015/532] cache if convert_image has deprecated signature --- scrapy/pipelines/images.py | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index a3f5f9292..f709c5057 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -84,6 +84,8 @@ class ImagesPipeline(FilesPipeline): resolve('IMAGES_THUMBS'), self.THUMBS ) + self._deprecated_convert_image = None + @classmethod def from_settings(cls, settings): s3store = cls.STORE_SCHEMES['s3'] @@ -126,17 +128,17 @@ class ImagesPipeline(FilesPipeline): if width < self.min_width or height < self.min_height: raise ImageException("Image too small (%dx%d < %dx%d)" % (width, height, self.min_width, self.min_height)) - - def _warn(): - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings - warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' - 'overriden method does not accept response_body argument.', - category=ScrapyDeprecationWarning, stacklevel=1) - convert_image_overriden = 'response_body' not in get_func_args(self.convert_image) - if convert_image_overriden: - _warn() + if self._deprecated_convert_image is None: + self._deprecated_convert_image = 'response_body' not in get_func_args(self.convert_image) + if self._deprecated_convert_image: + from scrapy.exceptions import ScrapyDeprecationWarning + import warnings + warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' + 'overriden method does not accept response_body argument.', + category=ScrapyDeprecationWarning, stacklevel=1) + + if self._deprecated_convert_image: image, buf = self.convert_image(orig_image) else: image, buf = self.convert_image(orig_image, response_body=BytesIO(response.body)) @@ -144,7 +146,7 @@ class ImagesPipeline(FilesPipeline): for thumb_id, size in six.iteritems(self.thumbs): thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) - if convert_image_overriden: + if self._deprecated_convert_image: thumb_image, thumb_buf = self.convert_image(image, size) else: thumb_image, thumb_buf = self.convert_image(image, size, buf) From 20719bac5cdc4898e9f01fcf4f92aa781a9d0ad1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 17 Dec 2019 15:09:43 +0100 Subject: [PATCH 016/532] Fix import error --- scrapy/settings/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index c1fff4d95..98421be18 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -224,7 +224,7 @@ class BaseSettings(MutableMapping): value = self.get(name, default) if value is None: return {} - if isinstance(value, six.string_types): + if isinstance(value, str): try: return json.loads(value, object_pairs_hook=OrderedDict) except ValueError: From 5834088e670d93b2a63ad8afb258e687af0a9b88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 18 Feb 2020 14:18:15 +0100 Subject: [PATCH 017/532] Apply feedback --- scrapy/settings/__init__.py | 5 +- tests/test_feedexport.py | 109 ++++++++++++++++++------------------ 2 files changed, 56 insertions(+), 58 deletions(-) diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index 98421be18..6f5b1ef97 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -207,8 +207,7 @@ class BaseSettings(MutableMapping): If it is a string it will be evaluated as JSON, or as a comma-separated list of strings as a fallback. - For example, settings populated through environment variables will - return: + For example, settings populated from the command line will return: - ``OrdetedDict([('key1', 'value1'), ('key2', 'value2')])`` if set to ``'{"key1": "value1", "key2": "value2"}'`` @@ -223,7 +222,7 @@ class BaseSettings(MutableMapping): """ value = self.get(name, default) if value is None: - return {} + return OrderedDict() if isinstance(value, str): try: return json.loads(value, object_pairs_hook=OrderedDict) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 291c47702..781cdc543 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -5,6 +5,7 @@ import warnings import tempfile import shutil import string +import sys from collections import OrderedDict from io import BytesIO from pathlib import Path @@ -12,6 +13,7 @@ from unittest import mock from urllib.parse import urljoin, urlparse, quote from urllib.request import pathname2url +import pytest from zope.interface.verify import verifyObject from twisted.trial import unittest from twisted.internet import defer @@ -590,78 +592,75 @@ class FeedExportTest(unittest.TestCase): yield self.assertExportedCsv(items, header, rows_csv, ordered=False) yield self.assertExportedJsonLines(items, rows_jl) - # edge case: FEED_EXPORT_FIELDS==[] means the same as default None + @defer.inlineCallbacks + def test_export_items_empty_field_list(self): + # FEED_EXPORT_FIELDS==[] means the same as default None + items = [{'foo': 'bar'}] + header = ["foo"] + rows = [{'foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': []} - yield self.assertExportedCsv(items, header, rows_csv, ordered=False) - yield self.assertExportedJsonLines(items, rows_jl, settings) + yield self.assertExportedCsv(items, header, rows, ordered=False) + yield self.assertExportedJsonLines(items, rows, settings) - # it is possible to override fields using FEED_EXPORT_FIELDS - header = ["foo", "baz", "hello"] + @defer.inlineCallbacks + def test_export_items_field_list(self): + items = [{'foo': 'bar'}] + header = ["foo", "baz"] + rows = [{'foo': 'bar', 'baz': ''}] settings = {'FEED_EXPORT_FIELDS': header} - rows = [ - {'foo': 'bar1', 'baz': '', 'hello': ''}, - {'foo': 'bar2', 'baz': '', 'hello': 'world2'}, - {'foo': 'bar3', 'baz': 'quux3', 'hello': ''}, - {'foo': '', 'baz': '', 'hello': 'world4'}, - ] - yield self.assertExported(items, header, rows, - settings=settings, ordered=True) + yield self.assertExported(items, header, rows, settings=settings) - # fields may be defined as a comma-separated list - header = ["foo", "baz", "hello"] + @defer.inlineCallbacks + def test_export_items_comma_separated_field_list(self): + items = [{'foo': 'bar'}] + header = ["foo", "baz"] + rows = [{'foo': 'bar', 'baz': ''}] settings = {'FEED_EXPORT_FIELDS': ",".join(header)} - rows = [ - {'foo': 'bar1', 'baz': '', 'hello': ''}, - {'foo': 'bar2', 'baz': '', 'hello': 'world2'}, - {'foo': 'bar3', 'baz': 'quux3', 'hello': ''}, - {'foo': '', 'baz': '', 'hello': 'world4'}, - ] - yield self.assertExported(items, header, rows, - settings=settings, ordered=True) + yield self.assertExported(items, header, rows, settings=settings) - # fields may also be defined as a JSON array - header = ["foo", "baz", "hello"] + @defer.inlineCallbacks + def test_export_items_json_field_list(self): + items = [{'foo': 'bar'}] + header = ["foo", "baz"] + rows = [{'foo': 'bar', 'baz': ''}] settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} - rows = [ - {'foo': 'bar1', 'baz': '', 'hello': ''}, - {'foo': 'bar2', 'baz': '', 'hello': 'world2'}, - {'foo': 'bar3', 'baz': 'quux3', 'hello': ''}, - {'foo': '', 'baz': '', 'hello': 'world4'}, - ] - yield self.assertExported(items, header, rows, - settings=settings, ordered=True) + yield self.assertExported(items, header, rows, settings=settings) - # custom output field names can be specified + @defer.inlineCallbacks + def test_export_items_field_names(self): + items = [{'foo': 'bar'}] header = OrderedDict(( ("foo", "Foo"), - ("baz", "Baz"), - ("hello", "Hello"), )) + rows = [{'Foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': header} - rows = [ - {'Foo': 'bar1', 'Baz': '', 'Hello': ''}, - {'Foo': 'bar2', 'Baz': '', 'Hello': 'world2'}, - {'Foo': 'bar3', 'Baz': 'quux3', 'Hello': ''}, - {'Foo': '', 'Baz': '', 'Hello': 'world4'}, - ] yield self.assertExported(items, list(header.values()), rows, - settings=settings, ordered=True) + settings=settings) - # custom output field names can be specified as a JSON object + @pytest.mark.skipif(sys.version_info < (3, 7), + reason='Only official in Python 3.7+') + @defer.inlineCallbacks + def test_export_items_dict_field_names(self): + items = [{'foo': 'bar'}] + header = { + 'baz': 'Baz', + 'foo': 'Foo', + } + rows = [{'Baz': '', 'Foo': 'bar'}] + settings = {'FEED_EXPORT_FIELDS': header} + yield self.assertExported(items, ['Baz', 'Foo'], rows, + settings=settings) + + @defer.inlineCallbacks + def test_export_items_json_field_names(self): + items = [{'foo': 'bar'}] header = OrderedDict(( ("foo", "Foo"), - ("baz", "Baz"), - ("hello", "Hello"), )) + rows = [{'Foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} - rows = [ - {'Foo': 'bar1', 'Baz': '', 'Hello': ''}, - {'Foo': 'bar2', 'Baz': '', 'Hello': 'world2'}, - {'Foo': 'bar3', 'Baz': 'quux3', 'Hello': ''}, - {'Foo': '', 'Baz': '', 'Hello': 'world4'}, - ] yield self.assertExported(items, list(header.values()), rows, - settings=settings, ordered=True) + settings=settings) @defer.inlineCallbacks def test_export_dicts(self): @@ -697,7 +696,7 @@ class FeedExportTest(unittest.TestCase): {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} ] yield self.assertExported(items, ['foo', 'baz', 'egg'], rows, - settings=settings, ordered=True) + settings=settings) # export a subset of columns settings = {'FEED_EXPORT_FIELDS': 'egg,baz'} @@ -706,7 +705,7 @@ class FeedExportTest(unittest.TestCase): {'egg': 'spam2', 'baz': 'quux2'} ] yield self.assertExported(items, ['egg', 'baz'], rows, - settings=settings, ordered=True) + settings=settings) @defer.inlineCallbacks def test_export_encoding(self): From 4605c66a80dabd64924e397580224a667cd73ec8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 7 May 2020 12:38:51 +0200 Subject: [PATCH 018/532] Fix AttributeError --- scrapy/utils/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 376c1f992..6a6d38a5c 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -114,7 +114,7 @@ def get_sources(use_closest=True): def feed_complete_default_values_from_settings(feed, settings): out = feed.copy() out.setdefault("encoding", settings["FEED_EXPORT_ENCODING"]) - out.setdefault("fields", settings.settings.getdictorlist("FEED_EXPORT_FIELDS") or None) + out.setdefault("fields", settings.getdictorlist("FEED_EXPORT_FIELDS") or None) out.setdefault("store_empty", settings.getbool("FEED_STORE_EMPTY")) out.setdefault("uri_params", settings["FEED_URI_PARAMS"]) if settings["FEED_EXPORT_INDENT"] is None: From 8b84a65a6b2d391fdd9c49426d748751a03351f0 Mon Sep 17 00:00:00 2001 From: drs-11 Date: Tue, 25 Aug 2020 00:30:17 +0530 Subject: [PATCH 019/532] cleaned up code relating to issue #3689 --- scrapy/pipelines/images.py | 14 ++----- tests/test_pipeline_images.py | 72 ++++++++++++++++++----------------- 2 files changed, 41 insertions(+), 45 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index f709c5057..e265685fb 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -6,6 +6,7 @@ See documentation in topics/media-pipeline.rst import functools import hashlib import six +import warnings try: from cStringIO import StringIO as BytesIO @@ -19,6 +20,7 @@ from scrapy.utils.python import to_bytes, get_func_args from scrapy.http import Request from scrapy.settings import Settings from scrapy.exceptions import DropItem +from scrapy.exceptions import ScrapyDeprecationWarning #TODO: from scrapy.pipelines.media import MediaPipeline from scrapy.pipelines.files import FileException, FilesPipeline @@ -132,8 +134,6 @@ class ImagesPipeline(FilesPipeline): if self._deprecated_convert_image is None: self._deprecated_convert_image = 'response_body' not in get_func_args(self.convert_image) if self._deprecated_convert_image: - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' 'overriden method does not accept response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) @@ -153,9 +153,7 @@ class ImagesPipeline(FilesPipeline): yield thumb_path, thumb_image, thumb_buf def convert_image(self, image, size=None, response_body=None): - if not response_body: - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings + if response_body is None: warnings.warn('ImagesPipeline.convert_image() method called in a deprecated way, ' 'method called without response_body argument.', category=ScrapyDeprecationWarning, stacklevel=1) @@ -175,7 +173,7 @@ class ImagesPipeline(FilesPipeline): if size: image = image.copy() image.thumbnail(size, Image.ANTIALIAS) - elif response_body and image.format == 'JPEG': + elif response_body is not None and image.format == 'JPEG': return image, response_body buf = BytesIO() @@ -193,8 +191,6 @@ class ImagesPipeline(FilesPipeline): def file_path(self, request, response=None, info=None): ## start of deprecation warning block (can be removed in the future) def _warn(): - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings warnings.warn('ImagesPipeline.image_key(url) and file_key(url) methods are deprecated, ' 'please use file_path(request, response=None, info=None) instead', category=ScrapyDeprecationWarning, stacklevel=1) @@ -221,8 +217,6 @@ class ImagesPipeline(FilesPipeline): def thumb_path(self, request, thumb_id, response=None, info=None): ## start of deprecation warning block (can be removed in the future) def _warn(): - from scrapy.exceptions import ScrapyDeprecationWarning - import warnings warnings.warn('ImagesPipeline.thumb_key(url) method is deprecated, please use ' 'thumb_path(request, thumb_id, response=None, info=None) instead', category=ScrapyDeprecationWarning, stacklevel=1) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index ec0c87264..915b6a579 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -75,41 +75,7 @@ class ImagesPipelineTestCase(unittest.TestCase): info=object()), 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') - def test_convert_image(self): - # tests for old API - with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - SIZE = (100, 100) - # straigh forward case: RGB and JPEG - COLOUR = (0, 127, 255) - im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) - - # check that thumbnail keep image ratio - thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25)) - self.assertEqual(thumbnail.mode, 'RGB') - self.assertEqual(thumbnail.size, (10, 10)) - - # transparency case: RGBA and PNG - COLOUR = (0, 127, 255, 50) - im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) - converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - - # transparency case with palette: P and PNG - COLOUR = (0, 127, 255, 50) - im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) - im = im.convert('P') - converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') - self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - - # ensure that we recieved deprecation warnings - self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a deprecated way' in str(warning.message)]) == 4) - + def test_convert_image_new(self): # tests for new API SIZE = (100, 100) # straigh forward case: RGB and JPEG @@ -207,6 +173,42 @@ class DeprecatedImagesPipelineTestCase(unittest.TestCase): self.assertEqual(len(w), 1) self.assertTrue('thumb_key(url) method is deprecated' in str(w[-1].message)) + def test_overriden_convert_image_method(self): + self.init_pipeline(ImagesPipeline) + # tests for old API + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter('always') + SIZE = (100, 100) + # straigh forward case: RGB and JPEG + COLOUR = (0, 127, 255) + im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR) + converted, _ = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) + + # check that thumbnail keep image ratio + thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25)) + self.assertEqual(thumbnail.mode, 'RGB') + self.assertEqual(thumbnail.size, (10, 10)) + + # transparency case: RGBA and PNG + COLOUR = (0, 127, 255, 50) + im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) + converted, _ = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + + # transparency case with palette: P and PNG + COLOUR = (0, 127, 255, 50) + im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im = im.convert('P') + converted, _ = self.pipeline.convert_image(im) + self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) + + # ensure that we recieved deprecation warnings + self.assertTrue(len([warning for warning in w if 'ImagesPipeline.convert_image() method called in a deprecated way' in str(warning.message)]) == 4) + def tearDown(self): rmtree(self.tempdir) From ecec5f9e5171568c4ead64336245a1bb3be2ecfe Mon Sep 17 00:00:00 2001 From: drs-11 Date: Tue, 25 Aug 2020 02:46:44 +0530 Subject: [PATCH 020/532] Cleaned up code --- scrapy/pipelines/images.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index d7f437adc..47d688c62 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -12,7 +12,7 @@ from io import BytesIO from itemadapter import ItemAdapter from PIL import Image -from scrapy.exceptions import DropItem,ScrapyDeprecationWarning +from scrapy.exceptions import DropItem, ScrapyDeprecationWarning from scrapy.http import Request from scrapy.pipelines.files import FileException, FilesPipeline # TODO: from scrapy.pipelines.media import MediaPipeline @@ -175,7 +175,7 @@ class ImagesPipeline(FilesPipeline): image.thumbnail(size, Image.ANTIALIAS) elif response_body is not None and image.format == 'JPEG': return image, response_body - + buf = BytesIO() image.save(buf, 'JPEG') return image, buf From 6565adc471360c2f542392befb7bb9448e8f171f Mon Sep 17 00:00:00 2001 From: drs-11 Date: Wed, 2 Sep 2020 20:44:26 +0530 Subject: [PATCH 021/532] added test case for get_images --- scrapy/pipelines/images.py | 6 +-- tests/test_pipeline_images.py | 75 ++++++++++++++++++++++++++++++++++- 2 files changed, 77 insertions(+), 4 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 47d688c62..09194a0fe 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -18,7 +18,7 @@ from scrapy.pipelines.files import FileException, FilesPipeline # TODO: from scrapy.pipelines.media import MediaPipeline from scrapy.settings import Settings from scrapy.utils.misc import md5sum -from scrapy.utils.python import to_bytes, get_func_args +from scrapy.utils.python import get_func_args, to_bytes class NoimagesDrop(DropItem): @@ -136,7 +136,7 @@ class ImagesPipeline(FilesPipeline): if self._deprecated_convert_image: warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' 'overriden method does not accept response_body argument.', - category=ScrapyDeprecationWarning, stacklevel=1) + category=ScrapyDeprecationWarning) if self._deprecated_convert_image: image, buf = self.convert_image(orig_image) @@ -156,7 +156,7 @@ class ImagesPipeline(FilesPipeline): if response_body is None: warnings.warn('ImagesPipeline.convert_image() method called in a deprecated way, ' 'method called without response_body argument.', - category=ScrapyDeprecationWarning, stacklevel=1) + category=ScrapyDeprecationWarning, stacklevel=2) if image.format == 'PNG' and image.mode == 'RGBA': background = Image.new('RGBA', image.size, (255, 255, 255)) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 6b71b64bc..8e98b8734 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -5,6 +5,7 @@ import warnings from shutil import rmtree from tempfile import mkdtemp from unittest import skipIf +from unittest.mock import patch import attr from itemadapter import ItemAdapter @@ -12,7 +13,7 @@ from twisted.trial import unittest from scrapy.http import Request, Response from scrapy.item import Field, Item -from scrapy.pipelines.images import ImagesPipeline +from scrapy.pipelines.images import ImageException, ImagesPipeline from scrapy.settings import Settings from scrapy.utils.python import to_bytes @@ -93,6 +94,78 @@ class ImagesPipelineTestCase(unittest.TestCase): info=object()), 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') + def test_get_images_exception(self): + self.pipeline.min_width = 100 + self.pipeline.min_height = 100 + + _, buf1 = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + _, buf2 = _create_image('JPEG', 'RGB', (150, 50), (0, 0, 0)) + _, buf3 = _create_image('JPEG', 'RGB', (50, 150), (0, 0, 0)) + + resp1 = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf1.getvalue()) + resp2 = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf2.getvalue()) + resp3 = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf3.getvalue()) + req = Request(url="https://dev.mydeco.com/mydeco.gif") + + with self.assertRaises(ImageException): + next(self.pipeline.get_images(response=resp1, request=req, info=object())) + with self.assertRaises(ImageException): + next(self.pipeline.get_images(response=resp2, request=req, info=object())) + with self.assertRaises(ImageException): + next(self.pipeline.get_images(response=resp3, request=req, info=object())) + + def test_get_images_new(self): + self.pipeline.min_width = 0 + self.pipeline.min_height = 0 + self.pipeline.thumbs = {'small': (20, 20)} + + orig_im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + orig_thumb, orig_thumb_buf = _create_image('JPEG', 'RGB', (20, 20), (0, 0, 0)) + resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) + req = Request(url="https://dev.mydeco.com/mydeco.gif") + + get_images_gen = self.pipeline.get_images(response=resp, request=req, info=object()) + + path, new_im, new_buf = next(get_images_gen) + self.assertEqual(path, 'full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual(orig_im, new_im) + self.assertEqual(buf.getvalue(), new_buf.getvalue()) + + thumb_path, thumb_img, thumb_buf = next(get_images_gen) + self.assertEqual(thumb_path, 'thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual(thumb_img, thumb_img) + self.assertEqual(orig_thumb_buf.getvalue(), thumb_buf.getvalue()) + + def test_get_images_old(self): + self.pipeline.thumbs = {'small': (20, 20)} + orig_im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) + req = Request(url="https://dev.mydeco.com/mydeco.gif") + + def overridden_convert_image(image, size=None): + im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + return im, buf + + with patch.object(self.pipeline, 'convert_image', overridden_convert_image): + with warnings.catch_warnings(record=True) as w: + warnings.simplefilter('always') + get_images_gen = self.pipeline.get_images(response=resp, request=req, info=object()) + path, new_im, new_buf = next(get_images_gen) + self.assertEqual(path, 'full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual(orig_im.mode, new_im.mode) + self.assertEqual(orig_im.getcolors(), new_im.getcolors()) + self.assertEqual(buf.getvalue(), new_buf.getvalue()) + + thumb_path, thumb_img, thumb_buf = next(get_images_gen) + self.assertEqual(thumb_path, 'thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual(orig_im.mode, thumb_img.mode) + self.assertEqual(orig_im.getcolors(), thumb_img.getcolors()) + self.assertEqual(buf.getvalue(), thumb_buf.getvalue()) + + expected_warning_msg = ('ImagesPipeline.convert_image() method overriden in a deprecated way, ' + 'overriden method does not accept response_body argument.') + self.assertEqual(len([warning for warning in w if expected_warning_msg in str(warning.message)]), 1) + def test_convert_image_old(self): # tests for old API with warnings.catch_warnings(record=True) as w: From 0c24cdb2573958cc0fb9127c6f195d3174640ff4 Mon Sep 17 00:00:00 2001 From: D R Siddhartha Date: Sun, 4 Oct 2020 02:09:21 +0530 Subject: [PATCH 022/532] Improved warning messages a little --- scrapy/pipelines/images.py | 4 ++-- tests/test_pipeline_images.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index d3254bc20..48e8a7b83 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -135,7 +135,7 @@ class ImagesPipeline(FilesPipeline): if self._deprecated_convert_image is None: self._deprecated_convert_image = 'response_body' not in get_func_args(self.convert_image) if self._deprecated_convert_image: - warnings.warn('ImagesPipeline.convert_image() method overriden in a deprecated way, ' + warnings.warn(f'{self.__class__.__name__}.convert_image() method overriden in a deprecated way, ' 'overriden method does not accept response_body argument.', category=ScrapyDeprecationWarning) @@ -155,7 +155,7 @@ class ImagesPipeline(FilesPipeline): def convert_image(self, image, size=None, response_body=None): if response_body is None: - warnings.warn('ImagesPipeline.convert_image() method called in a deprecated way, ' + warnings.warn(f'{self.__class__.__name__}.convert_image() method called in a deprecated way, ' 'method called without response_body argument.', category=ScrapyDeprecationWarning, stacklevel=2) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 380c775c4..0a294db80 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -162,7 +162,7 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(orig_im.getcolors(), thumb_img.getcolors()) self.assertEqual(buf.getvalue(), thumb_buf.getvalue()) - expected_warning_msg = ('ImagesPipeline.convert_image() method overriden in a deprecated way, ' + expected_warning_msg = ('.convert_image() method overriden in a deprecated way, ' 'overriden method does not accept response_body argument.') self.assertEqual(len([warning for warning in w if expected_warning_msg in str(warning.message)]), 1) @@ -199,7 +199,7 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # ensure that we recieved deprecation warnings - expected_warning_msg = 'ImagesPipeline.convert_image() method called in a deprecated way' + expected_warning_msg = '.convert_image() method called in a deprecated way' self.assertTrue(len([warning for warning in w if expected_warning_msg in str(warning.message)]) == 4) def test_convert_image_new(self): From 76abcedaf4f31a7c76de9e19680dd7499d9eccf4 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 13:36:25 +0500 Subject: [PATCH 023/532] Add as_async_generator. --- scrapy/utils/asyncgen.py | 12 ++++++++++++ tests/test_utils_asyncgen.py | 20 ++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 tests/test_utils_asyncgen.py diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index 7f697af5f..db2173f85 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -1,5 +1,17 @@ +import collections + + async def collect_asyncgen(result): results = [] async for x in result: results.append(x) return results + + +async def as_async_generator(it): + if isinstance(it, collections.abc.AsyncIterator): + async for r in it: + yield r + else: + for r in it: + yield r diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py new file mode 100644 index 000000000..9ae66c57c --- /dev/null +++ b/tests/test_utils_asyncgen.py @@ -0,0 +1,20 @@ +from twisted.trial import unittest + +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen +from scrapy.utils.defer import deferred_f_from_coro_f + + +class AsyncgenUtilsTest(unittest.TestCase): + @deferred_f_from_coro_f + async def test_as_async_generator(self): + ag = as_async_generator(range(42)) + results = [] + async for i in ag: + results.append(i) + self.assertEqual(results, list(range(42))) + + @deferred_f_from_coro_f + async def test_collect_asyncgen(self): + ag = as_async_generator(range(42)) + results = await collect_asyncgen(ag) + self.assertEqual(results, list(range(42))) From acff1eb4960940eb360f3cf00d5b33ed71acc351 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 14:36:38 +0500 Subject: [PATCH 024/532] Add aiter_errback. --- scrapy/utils/defer.py | 14 ++++++++++++++ tests/test_utils_defer.py | 31 +++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 6db9cc117..2d02c0621 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -124,6 +124,20 @@ def iter_errback(iterable, errback, *a, **kw): errback(failure.Failure(), *a, **kw) +async def aiter_errback(aiterable, errback, *a, **kw): + """Wraps an async iterable calling an errback if an error is caught while + iterating it. Similar to scrapy.utils.defer.iter_errback() + """ + it = aiterable.__aiter__() + while True: + try: + yield await it.__anext__() + except StopAsyncIteration: + break + except Exception: + errback(failure.Failure(), *a, **kw) + + def deferred_from_coro(o): """Converts a coroutine into a Deferred, or returns the object as is if it isn't a coroutine""" if isinstance(o, defer.Deferred): diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index e60242a3b..06d91c574 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -2,12 +2,15 @@ from twisted.trial import unittest from twisted.internet import reactor, defer from twisted.python.failure import Failure +from scrapy.utils.asyncgen import collect_asyncgen from scrapy.utils.defer import ( iter_errback, + aiter_errback, mustbe_deferred, process_chain, process_chain_both, process_parallel, + deferred_f_from_coro_f, ) @@ -117,3 +120,31 @@ class IterErrbackTest(unittest.TestCase): self.assertEqual(out, [0, 1, 2, 3, 4]) self.assertEqual(len(errors), 1) self.assertIsInstance(errors[0].value, ZeroDivisionError) + + +class AiterErrbackTest(unittest.TestCase): + + @deferred_f_from_coro_f + async def test_aiter_errback_good(self): + async def itergood(): + for x in range(10): + yield x + + errors = [] + out = await collect_asyncgen(aiter_errback(itergood(), errors.append)) + self.assertEqual(out, list(range(10))) + self.assertFalse(errors) + + @deferred_f_from_coro_f + async def test_iter_errback_bad(self): + async def iterbad(): + for x in range(10): + if x == 5: + 1 / 0 + yield x + + errors = [] + out = await collect_asyncgen(aiter_errback(iterbad(), errors.append)) + self.assertEqual(out, [0, 1, 2, 3, 4]) + self.assertEqual(len(errors), 1) + self.assertIsInstance(errors[0].value, ZeroDivisionError) From 7e9f498e00fd36c76ac139eb285526c9e70b4054 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 14:37:27 +0500 Subject: [PATCH 025/532] Add MutableAsyncChain. --- scrapy/utils/python.py | 25 ++++++++++++++++ tests/test_utils_python.py | 58 ++++++++++++++++++++++++++++++++++++-- 2 files changed, 81 insertions(+), 2 deletions(-) diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 5703fd4c3..0bf9bff70 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -12,6 +12,7 @@ from functools import partial, wraps from itertools import chain from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.utils.asyncgen import as_async_generator from scrapy.utils.decorators import deprecated @@ -355,3 +356,27 @@ class MutableChain: @deprecated("scrapy.utils.python.MutableChain.__next__") def next(self): return self.__next__() + + +async def _async_chain(*iterables): + for it in iterables: + async for o in as_async_generator(it): + yield o + + +class MutableAsyncChain: + """ + Similar to MutableChain but for async iterables + """ + + def __init__(self, *args): + self.data = _async_chain(*args) + + def extend(self, *aiterables): + self.data = _async_chain(self.data, _async_chain(*aiterables)) + + def __aiter__(self): + return self + + async def __anext__(self): + return await self.data.__anext__() diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 3115cc92f..58b384591 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -2,15 +2,18 @@ import functools import gc import operator import platform -import unittest from datetime import datetime from itertools import count from warnings import catch_warnings +from twisted.trial import unittest + +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen +from scrapy.utils.defer import deferred_f_from_coro_f, aiter_errback from scrapy.utils.python import ( memoizemethod_noargs, binary_is_text, equal_attributes, WeakKeyCache, get_func_args, to_bytes, to_unicode, - without_none_values, MutableChain) + without_none_values, MutableChain, MutableAsyncChain) __doctests__ = ['scrapy.utils.python'] @@ -32,6 +35,57 @@ class MutableChainTest(unittest.TestCase): self.assertEqual(list(m), list(range(3, 13))) +class MutableAsyncChainTest(unittest.TestCase): + @staticmethod + async def g1(): + for i in range(3): + yield i + + @staticmethod + async def g2(): + return + yield + + @staticmethod + async def g3(): + for i in range(7, 10): + yield i + + @staticmethod + async def g4(): + for i in range(3, 5): + yield i + 1 / 0 + for i in range(5, 7): + yield i + + @staticmethod + async def collect_asyncgen_exc(asyncgen): + results = [] + async for x in asyncgen: + results.append(x) + return results + + @deferred_f_from_coro_f + async def test_mutableasyncchain(self): + m = MutableAsyncChain(self.g1(), as_async_generator(range(3, 7))) + m.extend(self.g2()) + m.extend(self.g3()) + + self.assertEqual(await m.__anext__(), 0) + results = await collect_asyncgen(m) + self.assertEqual(results, list(range(1, 10))) + + @deferred_f_from_coro_f + async def test_mutableasyncchain_exc(self): + m = MutableAsyncChain(self.g1()) + m.extend(self.g4()) + m.extend(self.g3()) + + results = await collect_asyncgen(aiter_errback(m, lambda _: None)) + self.assertEqual(results, list(range(5))) + + class ToUnicodeTest(unittest.TestCase): def test_converting_an_utf8_encoded_string_to_unicode(self): self.assertEqual(to_unicode(b'lel\xc3\xb1e'), 'lel\xf1e') From d658552f232547cc227e597b0d8489c4762eb9d2 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 15:20:04 +0500 Subject: [PATCH 026/532] Add only_not_asyncio. --- conftest.py | 6 ++++++ pytest.ini | 1 + 2 files changed, 7 insertions(+) diff --git a/conftest.py b/conftest.py index 68b855c08..407bf9e62 100644 --- a/conftest.py +++ b/conftest.py @@ -55,5 +55,11 @@ def only_asyncio(request, reactor_pytest): pytest.skip('This test is only run with --reactor=asyncio') +@pytest.fixture(autouse=True) +def only_not_asyncio(request, reactor_pytest): + if request.node.get_closest_marker('only_not_asyncio') and reactor_pytest == 'asyncio': + pytest.skip('This test is only run without --reactor=asyncio') + + # Generate localhost certificate files, needed by some tests generate_keys() diff --git a/pytest.ini b/pytest.ini index d4deeb57c..416b228f9 100644 --- a/pytest.ini +++ b/pytest.ini @@ -21,6 +21,7 @@ addopts = twisted = 1 markers = only_asyncio: marks tests as only enabled when --reactor=asyncio is passed + only_not_asyncio: marks tests as only enabled when --reactor=asyncio is not passed flake8-max-line-length = 119 flake8-ignore = W503 From d66d52d3ed8aab0b4f126169c2855d00f4053907 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 15:21:12 +0500 Subject: [PATCH 027/532] Add process_iterable_helper. --- scrapy/utils/middlewares.py | 35 +++++++++++++ tests/test_utils_middlewares.py | 87 +++++++++++++++++++++++++++++++++ 2 files changed, 122 insertions(+) create mode 100644 scrapy/utils/middlewares.py create mode 100644 tests/test_utils_middlewares.py diff --git a/scrapy/utils/middlewares.py b/scrapy/utils/middlewares.py new file mode 100644 index 000000000..da28e0ddf --- /dev/null +++ b/scrapy/utils/middlewares.py @@ -0,0 +1,35 @@ +# coding: utf-8 +import inspect + + +def process_normal_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): + for o in it: + if in_predicate and not in_predicate(o): + continue + if processor is not None: + o = processor(o) + if out_predicate and not out_predicate(o): + continue + yield o + + +async def process_async_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): + async for o in it: + if in_predicate and not in_predicate(o): + continue + if processor is not None: + o = processor(o) + if out_predicate and not out_predicate(o): + continue + yield o + + +def process_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): + """ + For each item in the iterable: skips it if in_predicate is False, applies processor, + skips the result if out_predicate is False, else yields it. + """ + if inspect.isasyncgen(it): + return process_async_iterable_helper(it, in_predicate, out_predicate, processor) + else: + return process_normal_iterable_helper(it, in_predicate, out_predicate, processor) diff --git a/tests/test_utils_middlewares.py b/tests/test_utils_middlewares.py new file mode 100644 index 000000000..d395ba1a9 --- /dev/null +++ b/tests/test_utils_middlewares.py @@ -0,0 +1,87 @@ +import collections + +from twisted.trial import unittest + +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen +from scrapy.utils.defer import deferred_f_from_coro_f +from scrapy.utils.middlewares import process_iterable_helper + + +def predicate1(o): + return bool(o % 2) + + +def predicate2(o): + return o < 10 + + +def processor(o): + return o * 2 + + +class ProcessIterableHelperNormalTest(unittest.TestCase): + + def test_normal_in_predicate(self): + iterable1 = iter([1, 2, 3]) + iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1) + self.assertIsInstance(iterable2, collections.abc.Iterable) + list2 = list(iterable2) + self.assertEqual(list2, [1, 3]) + + def test_normal_out_predicate(self): + iterable1 = iter([1, 2, 10, 3, 15]) + iterable2 = process_iterable_helper(iterable1, out_predicate=predicate2) + self.assertIsInstance(iterable2, collections.abc.Iterable) + list2 = list(iterable2) + self.assertEqual(list2, [1, 2, 3]) + + def test_normal_processor(self): + iterable1 = iter([1, 2, 3]) + iterable2 = process_iterable_helper(iterable1, processor=processor) + self.assertIsInstance(iterable2, collections.abc.Iterable) + list2 = list(iterable2) + self.assertEqual(list2, [2, 4, 6]) + + def test_normal_combined(self): + iterable1 = iter([1, 2, 10, 3, 6, 18, 5, 15]) + iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1, + out_predicate=predicate2, processor=processor) + self.assertIsInstance(iterable2, collections.abc.Iterable) + list2 = list(iterable2) + self.assertEqual(list2, [2, 6]) + + +class ProcessIterableHelperAsyncTest(unittest.TestCase): + + @deferred_f_from_coro_f + async def test_async_in_predicate(self): + iterable1 = as_async_generator([1, 2, 3]) + iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1) + self.assertIsInstance(iterable2, collections.abc.AsyncIterable) + list2 = await collect_asyncgen(iterable2) + self.assertEqual(list2, [1, 3]) + + @deferred_f_from_coro_f + async def test_async_out_predicate(self): + iterable1 = as_async_generator([1, 2, 10, 3, 15]) + iterable2 = process_iterable_helper(iterable1, out_predicate=predicate2) + self.assertIsInstance(iterable2, collections.abc.AsyncIterable) + list2 = await collect_asyncgen(iterable2) + self.assertEqual(list2, [1, 2, 3]) + + @deferred_f_from_coro_f + async def test_async_processor(self): + iterable1 = as_async_generator([1, 2, 3]) + iterable2 = process_iterable_helper(iterable1, processor=processor) + self.assertIsInstance(iterable2, collections.abc.AsyncIterable) + list2 = await collect_asyncgen(iterable2) + self.assertEqual(list2, [2, 4, 6]) + + @deferred_f_from_coro_f + async def test_async_combined(self): + iterable1 = as_async_generator([1, 2, 10, 3, 6, 18, 5, 15]) + iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1, + out_predicate=predicate2, processor=processor) + self.assertIsInstance(iterable2, collections.abc.AsyncIterable) + list2 = await collect_asyncgen(iterable2) + self.assertEqual(list2, [2, 6]) From 92f2c9e308a5eda361229a8e74f74a21b9ff770a Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 2 Feb 2021 15:22:20 +0500 Subject: [PATCH 028/532] Move spider middlewares to process_iterable_helper. --- scrapy/spidermiddlewares/depth.py | 4 ++-- scrapy/spidermiddlewares/offsite.py | 32 ++++++++++++++------------- scrapy/spidermiddlewares/referer.py | 3 ++- scrapy/spidermiddlewares/urllength.py | 3 ++- 4 files changed, 23 insertions(+), 19 deletions(-) diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 776a6879a..73079bca9 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -3,10 +3,10 @@ Depth Spider Middleware See documentation in docs/topics/spider-middleware.rst """ - import logging from scrapy.http import Request +from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -55,4 +55,4 @@ class DepthMiddleware: if self.verbose_stats: self.stats.inc_value('request_depth_count/0', spider=spider) - return (r for r in result or () if _filter(r)) + return process_iterable_helper(result or (), in_predicate=_filter) diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index 6e4efda97..e7f481269 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -10,6 +10,7 @@ import warnings from scrapy import signals from scrapy.http import Request from scrapy.utils.httpobj import urlparse_cached +from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -26,21 +27,22 @@ class OffsiteMiddleware: return o def process_spider_output(self, response, result, spider): - for x in result: - if isinstance(x, Request): - if x.dont_filter or self.should_follow(x, spider): - yield x - else: - domain = urlparse_cached(x).hostname - if domain and domain not in self.domains_seen: - self.domains_seen.add(domain) - logger.debug( - "Filtered offsite request to %(domain)r: %(request)s", - {'domain': domain, 'request': x}, extra={'spider': spider}) - self.stats.inc_value('offsite/domains', spider=spider) - self.stats.inc_value('offsite/filtered', spider=spider) - else: - yield x + def in_predicate(x): + if not isinstance(x, Request): + return True + if x.dont_filter or self.should_follow(x, spider): + return True + domain = urlparse_cached(x).hostname + if domain and domain not in self.domains_seen: + self.domains_seen.add(domain) + logger.debug( + "Filtered offsite request to %(domain)r: %(request)s", + {'domain': domain, 'request': x}, extra={'spider': spider}) + self.stats.inc_value('offsite/domains', spider=spider) + self.stats.inc_value('offsite/filtered', spider=spider) + return False + + return process_iterable_helper(result or (), in_predicate=in_predicate) def should_follow(self, request, spider): regex = self.host_regex diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index f81041376..91c8727e1 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -10,6 +10,7 @@ from w3lib.url import safe_url_string from scrapy.http import Request, Response from scrapy.exceptions import NotConfigured from scrapy import signals +from scrapy.utils.middlewares import process_iterable_helper from scrapy.utils.python import to_unicode from scrapy.utils.misc import load_object from scrapy.utils.url import strip_url @@ -337,7 +338,7 @@ class RefererMiddleware: if referrer is not None: r.headers.setdefault('Referer', referrer) return r - return (_set_referer(r) for r in result or ()) + return process_iterable_helper(result or (), processor=_set_referer) def request_scheduled(self, request, spider): # check redirected request to patch "Referer" header if necessary diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 5be1f80cb..c7359fecd 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -8,6 +8,7 @@ import logging from scrapy.http import Request from scrapy.exceptions import NotConfigured +from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -34,4 +35,4 @@ class UrlLengthMiddleware: else: return True - return (r for r in result or () if _filter(r)) + return process_iterable_helper(result or (), in_predicate=_filter) From 2a1e9359caa0e16b336fdb2944ab7f4a69549896 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 5 Feb 2021 16:16:29 +0500 Subject: [PATCH 029/532] Add parallel_async. --- scrapy/core/scraper.py | 24 +++++++-- scrapy/utils/defer.py | 110 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 129 insertions(+), 5 deletions(-) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 0d3e3450f..3eae71af7 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -1,6 +1,6 @@ """This module implements the Scraper component which parses responses and extracts information from them""" - +import collections import logging from collections import deque @@ -12,7 +12,16 @@ from scrapy import signals from scrapy.core.spidermw import SpiderMiddlewareManager from scrapy.exceptions import CloseSpider, DropItem, IgnoreRequest from scrapy.http import Request, Response -from scrapy.utils.defer import defer_fail, defer_succeed, iter_errback, parallel +from scrapy.utils.defer import ( + aiter_errback, + defer_fail, + defer_succeed, + deferred_from_coro, + iter_errback, + parallel, + parallel_async, +) + from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import load_object, warn_on_generator_with_return_value from scrapy.utils.spider import iterate_spider_output @@ -180,9 +189,14 @@ class Scraper: def handle_spider_output(self, result, request, response, spider): if not result: return defer_succeed(None) - it = iter_errback(result, self.handle_spider_error, request, response, spider) - dfd = parallel(it, self.concurrent_items, self._process_spidermw_output, - request, response, spider) + if isinstance(result, collections.abc.AsyncIterable): + it = aiter_errback(result, self.handle_spider_error, request, response, spider) + dfd = deferred_from_coro(parallel_async(it, self.concurrent_items, self._process_spidermw_output, + request, response, spider)) + else: + it = iter_errback(result, self.handle_spider_error, request, response, spider) + dfd = parallel(it, self.concurrent_items, self._process_spidermw_output, + request, response, spider) return dfd def _process_spidermw_output(self, output, request, response, spider): diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 2d02c0621..bd5f9c8fc 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -75,6 +75,116 @@ def parallel(iterable, count, callable, *args, **named): return defer.DeferredList([coop.coiterate(work) for _ in range(count)]) +class _AsyncCooperatorAdapter: + """ A class that wraps an async iterator into a normal iterator suitable + for using in Cooperator.coiterate(). As it's only needed for parallel_async(), + it calls the callable directly in the callback, instead of providing a more + generic interface. + + On the outside, this class behaves as an iterator that yields Deferreds. + Each Deferred is fired with the result of the callable which was called on + the next result from aiterator. It raises StopIteration when aiterator is + exhausted, as expected. + + Cooperator calls __next__() multiple times and waits on the Deferreds + returned from it. As async generators (since Python 3.8) don't support + awaiting on __anext__() several times in parallel, we need to serialize + this. It's done by storing the Deferreds returned from __next__() and + firing the oldest one when a result from __anext__() is available. + + The workflow: + 1. When __next__() is called for the first time, it creates a Deferred, stores it + in self.waiting_deferreds and returns it. It also makes a Deferred that will wait + for self.aiterator.__anext__() and puts it into self.anext_deferred. + 2. If __next__() is called again before self.anext_deferred fires, more Deferreds + are added to self.waiting_deferreds. + 3. When self.anext_deferred fires, it either calls _callback() or _errback(). Both + clear self.anext_deferred. + 3.1. _callback() calls the callable passing the result value that it takes, pops a + Deferred from self.waiting_deferreds, and if the callable result was a Deferred, it + chains those Deferreds so that the waiting Deferred will fire when the result + Deferred does, otherwise it fires it directly. This causes one awaiting task to + receive a result. If self.waiting_deferreds is still not empty, new __anext__() is + called and self.anext_deferred is populated. + 3.2. _errback() checks the exception class. If it's StopAsyncIteration it means + self.aiterator is exhausted and so it sets self.finished and fires all + self.waiting_deferreds. Other exceptions are propagated. + 4. If __next__() is called after __anext__() was handled, then if self.finished is + True, it raises StopIteration, otherwise it acts like in step 2, but if + self.anext_deferred is now empty is also populates it with a new __anext__(). + + Note that CooperativeTask ignores the value returned from the Deferred that it waits + for, so we fire them with None when needed. + + It may be possible to write an async iterator-aware replacement for + Cooperator/CooperativeTask and use it instead of this adapter to achieve the same + goal. + """ + def __init__(self, aiterator, callable, *callable_args, **callable_kwargs): + self.aiterator = aiterator + self.callable = callable + self.callable_args = callable_args + self.callable_kwargs = callable_kwargs + self.finished = False + self.waiting_deferreds = [] + self.anext_deferred = None + + def _callback(self, result): + # This gets called when the result from aiterator.__anext__() is available. + # It calls the callable on it and sends the result to the oldest waiting Deferred + # (by chaining if the result is a Deferred too or by firing if not). + self.anext_deferred = None + result = self.callable(result, *self.callable_args, **self.callable_kwargs) + d = self.waiting_deferreds.pop(0) + if d.called: + raise ValueError('Deferred in waiting_deferreds already called') + if isinstance(result, defer.Deferred): + result.chainDeferred(d) + else: + d.callback(None) + if self.waiting_deferreds: + self._call_anext() + + def _errback(self, failure): + # This gets called on any exceptions in aiterator.__anext__(). + # It handles StopAsyncIteration by stopping the iteration and reraises all others. + self.anext_deferred = None + failure.trap(StopAsyncIteration) + self.finished = True + for d in self.waiting_deferreds: + if d.called: + raise ValueError('Deferred in waiting_deferreds already called') + d.callback(None) + + def _call_anext(self): + # This starts waiting for the next result from aiterator. + # If aiterator is exhausted, _errback will be called. + self.anext_deferred = deferred_from_coro(self.aiterator.__anext__()) + self.anext_deferred.addCallbacks(self._callback, self._errback) + + def __iter__(self): + return self + + def __next__(self): + # This puts a new Deferred into self.waiting_deferreds and returns it. + # It also calls __anext__() if needed. + if self.finished: + raise StopIteration + d = defer.Deferred() + self.waiting_deferreds.append(d) + if not self.anext_deferred: + self._call_anext() + return d + + +def parallel_async(async_iterable, count, callable, *args, **named): + """ Like parallel but for async iterables """ + coop = task.Cooperator() + work = _AsyncCooperatorAdapter(async_iterable, callable, *args, **named) + dl = defer.DeferredList([coop.coiterate(work) for _ in range(count)]) + return dl + + def process_chain(callbacks, input, *a, **kw): """Return a Deferred built by chaining the given callbacks""" d = defer.Deferred() From 2152a2a50898b91a44e6b0c282b69b7bfb8d18f0 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 5 Feb 2021 16:19:52 +0500 Subject: [PATCH 030/532] Add main infrastructure for async callbacks. --- scrapy/core/spidermw.py | 45 ++++++++++++++++----- scrapy/utils/defer.py | 19 +++++++++ scrapy/utils/spider.py | 8 ++-- scrapy/utils/test.py | 7 ++++ tests/spiders.py | 38 ++++++++++++++++- tests/test_crawl.py | 33 +++++++++++++++ tests/test_spidermiddleware_output_chain.py | 27 +++++++++++++ 7 files changed, 161 insertions(+), 16 deletions(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 763e0cdf6..961606f29 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -3,6 +3,7 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ +import inspect from itertools import islice from twisted.python.failure import Failure @@ -11,11 +12,11 @@ from scrapy.exceptions import _InvalidOutput from scrapy.middleware import MiddlewareManager from scrapy.utils.conf import build_component_list from scrapy.utils.defer import mustbe_deferred -from scrapy.utils.python import MutableChain +from scrapy.utils.python import MutableAsyncChain, MutableChain def _isiterable(possible_iterator): - return hasattr(possible_iterator, '__iter__') + return hasattr(possible_iterator, '__iter__') or hasattr(possible_iterator, '__aiter__') def _fname(f): @@ -58,15 +59,31 @@ class SpiderMiddlewareManager(MiddlewareManager): return scrape_func(response, request, spider) def _evaluate_iterable(iterable, exception_processor_index, recover_to): - try: - for r in iterable: - yield r - except Exception as ex: + def _process_exception(ex): exception_result = process_spider_exception(Failure(ex), exception_processor_index) if isinstance(exception_result, Failure): raise recover_to.extend(exception_result) + def _evaluate_normal_iterable(iterable): + try: + for r in iterable: + yield r + except Exception as ex: + _process_exception(ex) + + async def _evaluate_async_iterable(iterable): + try: + async for r in iterable: + yield r + except Exception as ex: + _process_exception(ex) + + if inspect.isasyncgen(iterable): + return _evaluate_async_iterable(iterable) + else: + return _evaluate_normal_iterable(iterable) + def process_spider_exception(_failure, start_index=0): exception = _failure.value # don't handle _InvalidOutput exception @@ -92,7 +109,11 @@ class SpiderMiddlewareManager(MiddlewareManager): def process_spider_output(result, start_index=0): # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - recovered = MutableChain() + if inspect.isasyncgen(result): + iter_class = MutableAsyncChain + else: + iter_class = MutableChain + recovered = iter_class() method_list = islice(self.methods['process_spider_output'], start_index, None) for method_index, method in enumerate(method_list, start=start_index): @@ -113,12 +134,16 @@ class SpiderMiddlewareManager(MiddlewareManager): f"iterable, got {type(result)}") raise _InvalidOutput(msg) - return MutableChain(result, recovered) + return iter_class(result, recovered) def process_callback_output(result): - recovered = MutableChain() + if inspect.isasyncgen(result): + iter_class = MutableAsyncChain + else: + iter_class = MutableChain + recovered = iter_class() result = _evaluate_iterable(result, 0, recovered) - return MutableChain(process_spider_output(result), recovered) + return iter_class(process_spider_output(result), recovered) dfd = mustbe_deferred(process_spider_input, response) dfd.addCallbacks(callback=process_callback_output, errback=process_spider_exception) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index bd5f9c8fc..554edc38c 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -290,3 +290,22 @@ def maybeDeferred_coro(f, *args, **kw): return defer.fail(result) else: return defer.succeed(result) + + +def deferred_to_future(d): + """ Wraps a Deferred into a Future. Requires the asyncio reactor. + """ + return d.asFuture(asyncio.get_event_loop()) + + +def maybe_deferred_to_future(d): + """ Converts a Deferred to something that can be awaited in a callback or other user coroutine. + + If the asyncio reactor is installed, coroutines are wrapped into Futures, and only Futures can be + awaited inside them. Otherwise, coroutines are wrapped into Deferreds and Deferreds can be awaited + directly inside them. + """ + if not is_asyncio_reactor_installed(): + return d + else: + return deferred_to_future(d) diff --git a/scrapy/utils/spider.py b/scrapy/utils/spider.py index 59fc9202f..d0fd1757d 100644 --- a/scrapy/utils/spider.py +++ b/scrapy/utils/spider.py @@ -4,7 +4,6 @@ import logging from scrapy.spiders import Spider from scrapy.utils.defer import deferred_from_coro from scrapy.utils.misc import arg_to_iter -from scrapy.utils.asyncgen import collect_asyncgen logger = logging.getLogger(__name__) @@ -12,14 +11,13 @@ logger = logging.getLogger(__name__) def iterate_spider_output(result): if inspect.isasyncgen(result): - d = deferred_from_coro(collect_asyncgen(result)) - d.addCallback(iterate_spider_output) - return d + return result elif inspect.iscoroutine(result): d = deferred_from_coro(result) d.addCallback(iterate_spider_output) return d - return arg_to_iter(result) + else: + return arg_to_iter(deferred_from_coro(result)) def iter_spider_classes(module): diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 24c38283a..d8fc25094 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -110,3 +110,10 @@ def mock_google_cloud_storage(): bucket_mock.blob.return_value = blob_mock return (client_mock, bucket_mock, blob_mock) + + +def get_web_client_agent_req(url): + from twisted.internet import reactor + from twisted.web.client import Agent # imports twisted.internet.reactor + agent = Agent(reactor) + return agent.request(b'GET', url.encode('utf-8')) diff --git a/tests/spiders.py b/tests/spiders.py index 106392ea6..3e0ec001b 100644 --- a/tests/spiders.py +++ b/tests/spiders.py @@ -14,7 +14,8 @@ from scrapy.item import Item from scrapy.linkextractors import LinkExtractor from scrapy.spiders import Spider from scrapy.spiders.crawl import CrawlSpider, Rule -from scrapy.utils.test import get_from_asyncio_queue +from scrapy.utils.defer import deferred_to_future, maybe_deferred_to_future +from scrapy.utils.test import get_from_asyncio_queue, get_web_client_agent_req class MockServerSpider(Spider): @@ -148,6 +149,41 @@ class AsyncDefAsyncioReqsReturnSpider(SimpleSpider): return reqs +class AsyncDefAsyncioGenExcSpider(SimpleSpider): + name = 'asyncdef_asyncio_gen_exc' + + async def parse(self, response): + for i in range(10): + await asyncio.sleep(0.1) + yield {'foo': i} + if i > 5: + raise ValueError("Stopping the processing") + + +class AsyncDefDeferredDirectSpider(SimpleSpider): + name = 'asyncdef_deferred_direct' + + async def parse(self, response): + resp = await get_web_client_agent_req(self.mockserver.url("/status?n=200")) + yield {'code': resp.code} + + +class AsyncDefDeferredWrappedSpider(SimpleSpider): + name = 'asyncdef_deferred_wrapped' + + async def parse(self, response): + resp = await deferred_to_future(get_web_client_agent_req(self.mockserver.url("/status?n=200"))) + yield {'code': resp.code} + + +class AsyncDefDeferredMaybeWrappedSpider(SimpleSpider): + name = 'asyncdef_deferred_wrapped' + + async def parse(self, response): + resp = await maybe_deferred_to_future(get_web_client_agent_req(self.mockserver.url("/status?n=200"))) + yield {'code': resp.code} + + class AsyncDefAsyncioGenSpider(SimpleSpider): name = 'asyncdef_asyncio_gen' diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 1083c1678..cda52f0d4 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -20,12 +20,16 @@ from scrapy.utils.python import to_unicode from tests.mockserver import MockServer from tests.spiders import ( AsyncDefAsyncioGenComplexSpider, + AsyncDefAsyncioGenExcSpider, AsyncDefAsyncioGenLoopSpider, AsyncDefAsyncioGenSpider, AsyncDefAsyncioReqsReturnSpider, AsyncDefAsyncioReturnSingleElementSpider, AsyncDefAsyncioReturnSpider, AsyncDefAsyncioSpider, + AsyncDefDeferredDirectSpider, + AsyncDefDeferredMaybeWrappedSpider, + AsyncDefDeferredWrappedSpider, AsyncDefSpider, BrokenStartRequestsSpider, BytesReceivedCallbackSpider, @@ -430,6 +434,18 @@ class CrawlSpiderTestCase(TestCase): for i in range(10): self.assertIn({'foo': i}, items) + @mark.only_asyncio() + @defer.inlineCallbacks + def test_async_def_asyncgen_parse_exc(self): + log, items, stats = yield self._run_spider(AsyncDefAsyncioGenExcSpider) + log = str(log) + self.assertIn("Spider error processing", log) + self.assertIn("ValueError", log) + itemcount = stats.get_value('item_scraped_count') + self.assertEqual(itemcount, 7) + for i in range(7): + self.assertIn({'foo': i}, items) + @mark.only_asyncio() @defer.inlineCallbacks def test_async_def_asyncgen_parse_complex(self): @@ -449,6 +465,23 @@ class CrawlSpiderTestCase(TestCase): for req_id in range(3): self.assertIn(f"Got response 200, req_id {req_id}", str(log)) + @mark.only_not_asyncio() + @defer.inlineCallbacks + def test_async_def_deferred_direct(self): + _, items, _ = yield self._run_spider(AsyncDefDeferredDirectSpider) + self.assertEqual(items, [{'code': 200}]) + + @mark.only_asyncio() + @defer.inlineCallbacks + def test_async_def_deferred_wrapped(self): + log, items, _ = yield self._run_spider(AsyncDefDeferredWrappedSpider) + self.assertEqual(items, [{'code': 200}]) + + @defer.inlineCallbacks + def test_async_def_deferred_maybe_wrapped(self): + _, items, _ = yield self._run_spider(AsyncDefDeferredMaybeWrappedSpider) + self.assertEqual(items, [{'code': 200}]) + @defer.inlineCallbacks def test_response_ssl_certificate_none(self): crawler = self.runner.create_crawler(SingleRequestSpider) diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index 029bf8bd6..4d1a7fcb0 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -43,6 +43,23 @@ class RecoverySpider(Spider): raise TabError() +class RecoveryAsyncGenSpider(RecoverySpider): + name = 'RecoveryAsyncGenSpider' + + async def parse(self, response): + for r in super().parse(response): + yield r + + +class RecoveryMiddleware: + def process_spider_exception(self, response, exception, spider): + spider.logger.info('Middleware: %s exception caught', exception.__class__.__name__) + return [ + {'from': 'process_spider_exception'}, + Request(response.url, meta={'dont_fail': True}, dont_filter=True), + ] + + # ================================================================================ # (1) exceptions from a spider middleware's process_spider_input method class FailProcessSpiderInputMiddleware: @@ -307,6 +324,16 @@ class TestSpiderMiddleware(TestCase): self.assertEqual(str(log).count("Middleware: TabError exception caught"), 1) self.assertIn("'item_scraped_count': 3", str(log)) + @defer.inlineCallbacks + def test_recovery_asyncgen(self): + """ + Same as test_recovery but with an async callback. + """ + log = yield self.crawl_log(RecoveryAsyncGenSpider) + self.assertIn("Middleware: TabError exception caught", str(log)) + self.assertEqual(str(log).count("Middleware: TabError exception caught"), 1) + self.assertIn("'item_scraped_count': 3", str(log)) + @defer.inlineCallbacks def test_process_spider_input_without_errback(self): """ From 58f848130145649a0191e98b182977278e2b9b6c Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 5 Feb 2021 16:20:32 +0500 Subject: [PATCH 031/532] Update docs. --- docs/topics/asyncio.rst | 24 ++++++++++++++++++++++++ docs/topics/coroutines.rst | 12 +++--------- 2 files changed, 27 insertions(+), 9 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 91e1cca0d..4addaa178 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -39,4 +39,28 @@ You can also use custom asyncio event loops with the asyncio reactor. Set the use it instead of the default asyncio event loop. +.. _asyncio-await-dfd: +Awaiting on Deferreds +===================== + +When the asyncio reactor isn't installed, you can await on Deferreds in the +coroutines directly. When it is installed, this is not possible anymore, due to +specifics of the Scrapy coroutine integration (the coroutines are wrapped into +asyncio Futures, not into Deferreds directly), and you need to wrap them into +Futures. Scrapy provides two helpers for this: + +.. autofunction:: scrapy.utils.defer.deferred_to_future +.. autofunction:: scrapy.utils.defer.maybe_deferred_to_future + +If you want to write universal code that works on any reactors, +you should use ``maybe_deferred_to_future`` on all Deferreds:: + + from scrapy.utils.defer import maybe_deferred_to_future + + class MySpider(Spider): + # ... + async def parse_with_deferred(self, response): + additional_response = await maybe_deferred_to_future(treq.get('https://additional.url')) + additional_data = await maybe_deferred_to_future(treq.content(additional_response)) + # ... use response and additional_data to yield items and requests diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 3b1549bd3..279632653 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -17,15 +17,6 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :class:`~scrapy.http.Request` callbacks. - .. note:: The callback output is not processed until the whole callback - finishes. - - As a side effect, if the callback raises an exception, none of its - output is processed. - - This is a known caveat of the current implementation that we aim to - address in a future version of Scrapy. - - The :meth:`process_item` method of :ref:`item pipelines `. @@ -92,6 +83,9 @@ This means you can use many useful Python libraries providing such code:: :mod:`asyncio` loop and to use them you need to :doc:`enable asyncio support in Scrapy`. +.. note:: If you want to ``await`` on Deferreds, you may need to + :ref:`wrap them`. + Common use cases for asynchronous code include: * requesting data from websites, databases and other services (in callbacks, From 5cf403295d44bd2531ee3fe2f07057cf155e9804 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 5 Feb 2021 19:40:14 +0500 Subject: [PATCH 032/532] Remove a duplicate definition. --- tests/test_spidermiddleware_output_chain.py | 9 --------- 1 file changed, 9 deletions(-) diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index 4d1a7fcb0..088c14ca8 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -51,15 +51,6 @@ class RecoveryAsyncGenSpider(RecoverySpider): yield r -class RecoveryMiddleware: - def process_spider_exception(self, response, exception, spider): - spider.logger.info('Middleware: %s exception caught', exception.__class__.__name__) - return [ - {'from': 'process_spider_exception'}, - Request(response.url, meta={'dont_fail': True}, dont_filter=True), - ] - - # ================================================================================ # (1) exceptions from a spider middleware's process_spider_input method class FailProcessSpiderInputMiddleware: From 67cff0e8a949a83220ae6d7d2c2ca40e6c8a8207 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 10 Feb 2021 22:44:14 +0500 Subject: [PATCH 033/532] Silence pylint "naked raise" error. --- scrapy/core/spidermw.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 96392aae7..d3d7e5f8c 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -61,7 +61,7 @@ class SpiderMiddlewareManager(MiddlewareManager): exception_result = self._process_spider_exception(response, spider, Failure(ex), exception_processor_index) if isinstance(exception_result, Failure): - raise + raise # pylint: disable=E0704 recover_to.extend(exception_result) def _evaluate_normal_iterable(iterable): From 40eab1d473a78369702490a901b5d304a40baf3b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 18 Feb 2021 19:56:12 +0500 Subject: [PATCH 034/532] Drop a duplicate import. --- tests/test_utils_defer.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index d220f969b..62f6ff194 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -5,14 +5,13 @@ from twisted.python.failure import Failure from scrapy.utils.asyncgen import collect_asyncgen from scrapy.utils.defer import ( + aiter_errback, deferred_f_from_coro_f, iter_errback, - aiter_errback, mustbe_deferred, process_chain, process_chain_both, process_parallel, - deferred_f_from_coro_f, ) From f9a5385146c741825d8c0b089cf8e8318dca9403 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 19 Feb 2021 21:19:21 +0500 Subject: [PATCH 035/532] Revert "Move spider middlewares to process_iterable_helper." This reverts commit 92f2c9e308a5eda361229a8e74f74a21b9ff770a. --- scrapy/spidermiddlewares/depth.py | 4 ++-- scrapy/spidermiddlewares/offsite.py | 32 +++++++++++++-------------- scrapy/spidermiddlewares/referer.py | 3 +-- scrapy/spidermiddlewares/urllength.py | 3 +-- 4 files changed, 19 insertions(+), 23 deletions(-) diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 73079bca9..776a6879a 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -3,10 +3,10 @@ Depth Spider Middleware See documentation in docs/topics/spider-middleware.rst """ + import logging from scrapy.http import Request -from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -55,4 +55,4 @@ class DepthMiddleware: if self.verbose_stats: self.stats.inc_value('request_depth_count/0', spider=spider) - return process_iterable_helper(result or (), in_predicate=_filter) + return (r for r in result or () if _filter(r)) diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index e7f481269..6e4efda97 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -10,7 +10,6 @@ import warnings from scrapy import signals from scrapy.http import Request from scrapy.utils.httpobj import urlparse_cached -from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -27,22 +26,21 @@ class OffsiteMiddleware: return o def process_spider_output(self, response, result, spider): - def in_predicate(x): - if not isinstance(x, Request): - return True - if x.dont_filter or self.should_follow(x, spider): - return True - domain = urlparse_cached(x).hostname - if domain and domain not in self.domains_seen: - self.domains_seen.add(domain) - logger.debug( - "Filtered offsite request to %(domain)r: %(request)s", - {'domain': domain, 'request': x}, extra={'spider': spider}) - self.stats.inc_value('offsite/domains', spider=spider) - self.stats.inc_value('offsite/filtered', spider=spider) - return False - - return process_iterable_helper(result or (), in_predicate=in_predicate) + for x in result: + if isinstance(x, Request): + if x.dont_filter or self.should_follow(x, spider): + yield x + else: + domain = urlparse_cached(x).hostname + if domain and domain not in self.domains_seen: + self.domains_seen.add(domain) + logger.debug( + "Filtered offsite request to %(domain)r: %(request)s", + {'domain': domain, 'request': x}, extra={'spider': spider}) + self.stats.inc_value('offsite/domains', spider=spider) + self.stats.inc_value('offsite/filtered', spider=spider) + else: + yield x def should_follow(self, request, spider): regex = self.host_regex diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index 91c8727e1..f81041376 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -10,7 +10,6 @@ from w3lib.url import safe_url_string from scrapy.http import Request, Response from scrapy.exceptions import NotConfigured from scrapy import signals -from scrapy.utils.middlewares import process_iterable_helper from scrapy.utils.python import to_unicode from scrapy.utils.misc import load_object from scrapy.utils.url import strip_url @@ -338,7 +337,7 @@ class RefererMiddleware: if referrer is not None: r.headers.setdefault('Referer', referrer) return r - return process_iterable_helper(result or (), processor=_set_referer) + return (_set_referer(r) for r in result or ()) def request_scheduled(self, request, spider): # check redirected request to patch "Referer" header if necessary diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index c7359fecd..5be1f80cb 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -8,7 +8,6 @@ import logging from scrapy.http import Request from scrapy.exceptions import NotConfigured -from scrapy.utils.middlewares import process_iterable_helper logger = logging.getLogger(__name__) @@ -35,4 +34,4 @@ class UrlLengthMiddleware: else: return True - return process_iterable_helper(result or (), in_predicate=_filter) + return (r for r in result or () if _filter(r)) From c51ec1ae1cef3fd68fc512f0636b75d0f3a2da13 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 26 Feb 2021 19:32:45 +0500 Subject: [PATCH 036/532] Drop process_iterable_helper, add _process_iterable_universal. --- scrapy/core/spidermw.py | 28 +++------ scrapy/spidermiddlewares/depth.py | 18 ++++-- scrapy/spidermiddlewares/offsite.py | 32 +++++----- scrapy/spidermiddlewares/referer.py | 9 ++- scrapy/spidermiddlewares/urllength.py | 9 ++- scrapy/utils/asyncgen.py | 45 ++++++++++++++ scrapy/utils/middlewares.py | 35 ----------- tests/test_utils_asyncgen.py | 22 ++++++- tests/test_utils_middlewares.py | 87 --------------------------- 9 files changed, 120 insertions(+), 165 deletions(-) delete mode 100644 scrapy/utils/middlewares.py delete mode 100644 tests/test_utils_middlewares.py diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index d3d7e5f8c..33e215971 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -10,6 +10,7 @@ from twisted.python.failure import Failure from scrapy.exceptions import _InvalidOutput from scrapy.middleware import MiddlewareManager +from scrapy.utils.asyncgen import _process_iterable_universal from scrapy.utils.conf import build_component_list from scrapy.utils.defer import mustbe_deferred from scrapy.utils.python import MutableAsyncChain, MutableChain @@ -57,31 +58,18 @@ class SpiderMiddlewareManager(MiddlewareManager): return scrape_func(response, request, spider) def _evaluate_iterable(self, response, spider, iterable, exception_processor_index, recover_to): - def _process_exception(ex): - exception_result = self._process_spider_exception(response, spider, Failure(ex), - exception_processor_index) - if isinstance(exception_result, Failure): - raise # pylint: disable=E0704 - recover_to.extend(exception_result) - - def _evaluate_normal_iterable(iterable): - try: - for r in iterable: - yield r - except Exception as ex: - _process_exception(ex) - + @_process_iterable_universal async def _evaluate_async_iterable(iterable): try: async for r in iterable: yield r except Exception as ex: - _process_exception(ex) - - if inspect.isasyncgen(iterable): - return _evaluate_async_iterable(iterable) - else: - return _evaluate_normal_iterable(iterable) + exception_result = self._process_spider_exception(response, spider, Failure(ex), + exception_processor_index) + if isinstance(exception_result, Failure): + raise + recover_to.extend(exception_result) + return _evaluate_async_iterable(iterable) def _process_spider_exception(self, response, spider, _failure, start_index=0): exception = _failure.value diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 776a6879a..973404b2b 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -7,6 +7,7 @@ See documentation in docs/topics/spider-middleware.rst import logging from scrapy.http import Request +from scrapy.utils.asyncgen import _process_iterable_universal logger = logging.getLogger(__name__) @@ -49,10 +50,15 @@ class DepthMiddleware: spider=spider) return True - # base case (depth=0) - if 'depth' not in response.meta: - response.meta['depth'] = 0 - if self.verbose_stats: - self.stats.inc_value('request_depth_count/0', spider=spider) + @_process_iterable_universal + async def process(result): + # base case (depth=0) + if 'depth' not in response.meta: + response.meta['depth'] = 0 + if self.verbose_stats: + self.stats.inc_value('request_depth_count/0', spider=spider) - return (r for r in result or () if _filter(r)) + async for r in result or (): + if _filter(r): + yield r + return process(result) diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index 6e4efda97..074ec7a4e 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -9,6 +9,7 @@ import warnings from scrapy import signals from scrapy.http import Request +from scrapy.utils.asyncgen import _process_iterable_universal from scrapy.utils.httpobj import urlparse_cached logger = logging.getLogger(__name__) @@ -26,21 +27,24 @@ class OffsiteMiddleware: return o def process_spider_output(self, response, result, spider): - for x in result: - if isinstance(x, Request): - if x.dont_filter or self.should_follow(x, spider): - yield x + @_process_iterable_universal + async def process(result): + async for x in result: + if isinstance(x, Request): + if x.dont_filter or self.should_follow(x, spider): + yield x + else: + domain = urlparse_cached(x).hostname + if domain and domain not in self.domains_seen: + self.domains_seen.add(domain) + logger.debug( + "Filtered offsite request to %(domain)r: %(request)s", + {'domain': domain, 'request': x}, extra={'spider': spider}) + self.stats.inc_value('offsite/domains', spider=spider) + self.stats.inc_value('offsite/filtered', spider=spider) else: - domain = urlparse_cached(x).hostname - if domain and domain not in self.domains_seen: - self.domains_seen.add(domain) - logger.debug( - "Filtered offsite request to %(domain)r: %(request)s", - {'domain': domain, 'request': x}, extra={'spider': spider}) - self.stats.inc_value('offsite/domains', spider=spider) - self.stats.inc_value('offsite/filtered', spider=spider) - else: - yield x + yield x + return process(result) def should_follow(self, request, spider): regex = self.host_regex diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index f81041376..8d862d1d0 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -10,6 +10,7 @@ from w3lib.url import safe_url_string from scrapy.http import Request, Response from scrapy.exceptions import NotConfigured from scrapy import signals +from scrapy.utils.asyncgen import _process_iterable_universal from scrapy.utils.python import to_unicode from scrapy.utils.misc import load_object from scrapy.utils.url import strip_url @@ -337,7 +338,13 @@ class RefererMiddleware: if referrer is not None: r.headers.setdefault('Referer', referrer) return r - return (_set_referer(r) for r in result or ()) + + @_process_iterable_universal + async def process(result): + async for r in result or (): + yield _set_referer(r) + + return process(result) def request_scheduled(self, request, spider): # check redirected request to patch "Referer" header if necessary diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 5be1f80cb..d40d43ff1 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -8,6 +8,7 @@ import logging from scrapy.http import Request from scrapy.exceptions import NotConfigured +from scrapy.utils.asyncgen import _process_iterable_universal logger = logging.getLogger(__name__) @@ -34,4 +35,10 @@ class UrlLengthMiddleware: else: return True - return (r for r in result or () if _filter(r)) + @_process_iterable_universal + async def process(result): + async for r in result or (): + if _filter(r): + yield r + + return process(result) diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index db2173f85..39c94ad8a 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -1,4 +1,6 @@ import collections +import functools +import inspect async def collect_asyncgen(result): @@ -15,3 +17,46 @@ async def as_async_generator(it): else: for r in it: yield r + + +# https://stackoverflow.com/a/66170760/113586 +def _process_iterable_universal(process_async): + """ Takes a function that takes an async iterable, args and kwargs. Returns + a function that takes any iterable, args and kwargs. + + Requires that process_async only awaits on the iterable and synchronous functions, + so it's better to use this only in the Scrapy code itself. + """ + + # If this stops working, all internal uses can be just replaced with manually-written + # process_sync functions. + + def process_sync(iterable, *args, **kwargs): + agen = process_async(as_async_generator(iterable), *args, **kwargs) + if not inspect.isasyncgen(agen): + raise ValueError(f"process_async returned wrong type {type(agen)}") + sent = None + while True: + try: + gen = agen.asend(sent) + gen.send(None) + except StopIteration as e: + sent = yield e.value + except StopAsyncIteration: + return + else: + gen.throw(RuntimeError, + f"Synchronously-called function '{process_async.__name__}' has blocked, " + f"you can't use {_process_iterable_universal.__name__} with it.") + + @functools.wraps(process_async) + def process(iterable, *args, **kwargs): + if inspect.isasyncgen(iterable): + # call process_async directly + return process_async(iterable, *args, **kwargs) + if hasattr(iterable, '__iter__'): + # convert process_async to process_sync + return process_sync(iterable, *args, **kwargs) + raise ValueError(f"Wrong iterable type {type(iterable)}") + + return process diff --git a/scrapy/utils/middlewares.py b/scrapy/utils/middlewares.py deleted file mode 100644 index da28e0ddf..000000000 --- a/scrapy/utils/middlewares.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -import inspect - - -def process_normal_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): - for o in it: - if in_predicate and not in_predicate(o): - continue - if processor is not None: - o = processor(o) - if out_predicate and not out_predicate(o): - continue - yield o - - -async def process_async_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): - async for o in it: - if in_predicate and not in_predicate(o): - continue - if processor is not None: - o = processor(o) - if out_predicate and not out_predicate(o): - continue - yield o - - -def process_iterable_helper(it, in_predicate=None, out_predicate=None, processor=None): - """ - For each item in the iterable: skips it if in_predicate is False, applies processor, - skips the result if out_predicate is False, else yields it. - """ - if inspect.isasyncgen(it): - return process_async_iterable_helper(it, in_predicate, out_predicate, processor) - else: - return process_normal_iterable_helper(it, in_predicate, out_predicate, processor) diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index 9ae66c57c..2f4181d3d 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -1,6 +1,6 @@ from twisted.trial import unittest -from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen, _process_iterable_universal from scrapy.utils.defer import deferred_f_from_coro_f @@ -18,3 +18,23 @@ class AsyncgenUtilsTest(unittest.TestCase): ag = as_async_generator(range(42)) results = await collect_asyncgen(ag) self.assertEqual(results, list(range(42))) + + +@_process_iterable_universal +async def process_iterable(iterable): + async for i in iterable: + yield i * 2 + + +class ProcessIterableUniversalTest(unittest.TestCase): + + def test_normal(self): + iterable = iter([1, 2, 3]) + results = list(process_iterable(iterable)) + self.assertEqual(results, [2, 4, 6]) + + @deferred_f_from_coro_f + async def test_async(self): + iterable = as_async_generator([1, 2, 3]) + results = await collect_asyncgen(process_iterable(iterable)) + self.assertEqual(results, [2, 4, 6]) diff --git a/tests/test_utils_middlewares.py b/tests/test_utils_middlewares.py deleted file mode 100644 index d395ba1a9..000000000 --- a/tests/test_utils_middlewares.py +++ /dev/null @@ -1,87 +0,0 @@ -import collections - -from twisted.trial import unittest - -from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen -from scrapy.utils.defer import deferred_f_from_coro_f -from scrapy.utils.middlewares import process_iterable_helper - - -def predicate1(o): - return bool(o % 2) - - -def predicate2(o): - return o < 10 - - -def processor(o): - return o * 2 - - -class ProcessIterableHelperNormalTest(unittest.TestCase): - - def test_normal_in_predicate(self): - iterable1 = iter([1, 2, 3]) - iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1) - self.assertIsInstance(iterable2, collections.abc.Iterable) - list2 = list(iterable2) - self.assertEqual(list2, [1, 3]) - - def test_normal_out_predicate(self): - iterable1 = iter([1, 2, 10, 3, 15]) - iterable2 = process_iterable_helper(iterable1, out_predicate=predicate2) - self.assertIsInstance(iterable2, collections.abc.Iterable) - list2 = list(iterable2) - self.assertEqual(list2, [1, 2, 3]) - - def test_normal_processor(self): - iterable1 = iter([1, 2, 3]) - iterable2 = process_iterable_helper(iterable1, processor=processor) - self.assertIsInstance(iterable2, collections.abc.Iterable) - list2 = list(iterable2) - self.assertEqual(list2, [2, 4, 6]) - - def test_normal_combined(self): - iterable1 = iter([1, 2, 10, 3, 6, 18, 5, 15]) - iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1, - out_predicate=predicate2, processor=processor) - self.assertIsInstance(iterable2, collections.abc.Iterable) - list2 = list(iterable2) - self.assertEqual(list2, [2, 6]) - - -class ProcessIterableHelperAsyncTest(unittest.TestCase): - - @deferred_f_from_coro_f - async def test_async_in_predicate(self): - iterable1 = as_async_generator([1, 2, 3]) - iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1) - self.assertIsInstance(iterable2, collections.abc.AsyncIterable) - list2 = await collect_asyncgen(iterable2) - self.assertEqual(list2, [1, 3]) - - @deferred_f_from_coro_f - async def test_async_out_predicate(self): - iterable1 = as_async_generator([1, 2, 10, 3, 15]) - iterable2 = process_iterable_helper(iterable1, out_predicate=predicate2) - self.assertIsInstance(iterable2, collections.abc.AsyncIterable) - list2 = await collect_asyncgen(iterable2) - self.assertEqual(list2, [1, 2, 3]) - - @deferred_f_from_coro_f - async def test_async_processor(self): - iterable1 = as_async_generator([1, 2, 3]) - iterable2 = process_iterable_helper(iterable1, processor=processor) - self.assertIsInstance(iterable2, collections.abc.AsyncIterable) - list2 = await collect_asyncgen(iterable2) - self.assertEqual(list2, [2, 4, 6]) - - @deferred_f_from_coro_f - async def test_async_combined(self): - iterable1 = as_async_generator([1, 2, 10, 3, 6, 18, 5, 15]) - iterable2 = process_iterable_helper(iterable1, in_predicate=predicate1, - out_predicate=predicate2, processor=processor) - self.assertIsInstance(iterable2, collections.abc.AsyncIterable) - list2 = await collect_asyncgen(iterable2) - self.assertEqual(list2, [2, 6]) From a6034f942b034946538855cc53644b5a89ba081a Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 22 Mar 2021 22:53:52 +0500 Subject: [PATCH 037/532] Add tests for _AsyncCooperatorAdapter. --- tests/test_utils_defer.py | 68 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index 62f6ff194..543bbee09 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -1,14 +1,18 @@ +import random + from pytest import mark from twisted.trial import unittest from twisted.internet import reactor, defer from twisted.python.failure import Failure -from scrapy.utils.asyncgen import collect_asyncgen +from scrapy.utils.asyncgen import collect_asyncgen, as_async_generator from scrapy.utils.defer import ( aiter_errback, deferred_f_from_coro_f, iter_errback, + maybe_deferred_to_future, mustbe_deferred, + parallel_async, process_chain, process_chain_both, process_parallel, @@ -164,3 +168,65 @@ class AsyncDefTestsuiteTest(unittest.TestCase): @deferred_f_from_coro_f async def test_deferred_f_from_coro_f_xfail(self): raise Exception("This is expected to be raised") + + +class AsyncCooperatorTest(unittest.TestCase): + """ This tests _AsyncCooperatorAdapter by testing parallel_async which is its only usage. + + parallel_async is called with the results of a callback (so an iterable of items, requests and None, + with arbitrary delays between values), and it uses Scraper._process_spidermw_output as the callable + (so a callable that returns a Deferred for an item, which will fire after pipelines process it, and + None for everything else). The concurrent task count is the CONCURRENT_ITEMS setting. + + We want to test different concurrency values compared to the iterable length. + We also want to simulate the real usage, with arbitrary delays between getting the values + from the iterable. We also want to simulate sync and async results from the callable. + """ + CONCURRENT_ITEMS = 50 + + @staticmethod + def callable(o, results): + if random.random() < 0.4: + # simulate async processing + dfd = defer.Deferred() + dfd.addCallback(lambda _: results.append(o)) + delay = random.random() / 8 + reactor.callLater(delay, dfd.callback, None) + return dfd + else: + # simulate trivial sync processing + results.append(o) + + @staticmethod + def get_async_iterable(length): + # simulate a simple callback without delays between results + return as_async_generator(range(length)) + + @staticmethod + async def get_async_iterable_with_delays(length): + # simulate a callback with delays between some of the results + for i in range(length): + if random.random() < 0.1: + dfd = defer.Deferred() + delay = random.random() / 20 + reactor.callLater(delay, dfd.callback, None) + await maybe_deferred_to_future(dfd) + yield i + + @defer.inlineCallbacks + def test_simple(self): + for length in [20, 50, 100]: + results = [] + ait = self.get_async_iterable(length) + dl = parallel_async(ait, self.CONCURRENT_ITEMS, self.callable, results) + yield dl + self.assertEqual(list(range(length)), sorted(results)) + + @defer.inlineCallbacks + def test_delays(self): + for length in [20, 50, 100]: + results = [] + ait = self.get_async_iterable_with_delays(length) + dl = parallel_async(ait, self.CONCURRENT_ITEMS, self.callable, results) + yield dl + self.assertEqual(list(range(length)), sorted(results)) From 0596f2bf6e7fc404333345d1cece01e31fabed8e Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 23 Mar 2021 22:47:48 +0500 Subject: [PATCH 038/532] Remove not needed deferred_from_coro call. --- scrapy/core/scraper.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 3eae71af7..7eedbf33e 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -16,7 +16,6 @@ from scrapy.utils.defer import ( aiter_errback, defer_fail, defer_succeed, - deferred_from_coro, iter_errback, parallel, parallel_async, @@ -191,8 +190,8 @@ class Scraper: return defer_succeed(None) if isinstance(result, collections.abc.AsyncIterable): it = aiter_errback(result, self.handle_spider_error, request, response, spider) - dfd = deferred_from_coro(parallel_async(it, self.concurrent_items, self._process_spidermw_output, - request, response, spider)) + dfd = parallel_async(it, self.concurrent_items, self._process_spidermw_output, + request, response, spider) else: it = iter_errback(result, self.handle_spider_error, request, response, spider) dfd = parallel(it, self.concurrent_items, self._process_spidermw_output, From a97dc55c714d90378dbc8a819cae1a3a40056d6e Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 25 Mar 2021 17:37:32 +0500 Subject: [PATCH 039/532] Add/improve docs. --- docs/topics/asyncio.rst | 1 - docs/topics/coroutines.rst | 13 ++++++++++++- docs/topics/spider-middleware.rst | 17 +++++++++++------ 3 files changed, 23 insertions(+), 8 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 4addaa178..18712c928 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -38,7 +38,6 @@ You can also use custom asyncio event loops with the asyncio reactor. Set the :setting:`ASYNCIO_EVENT_LOOP` setting to the import path of the desired event loop class to use it instead of the default asyncio event loop. - .. _asyncio-await-dfd: Awaiting on Deferreds diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 279632653..9b50d9312 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -17,6 +17,10 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :class:`~scrapy.http.Request` callbacks. + .. versionchanged:: VERSION + Output of async callbacks is now processed asynchronously instead of collecting + all of it first. + - The :meth:`process_item` method of :ref:`item pipelines `. @@ -30,6 +34,13 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :ref:`Signal handlers that support deferreds `. +- The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` + method of :ref:`spider middlewares `. + + .. versionadded:: VERSION + .. note:: This method needs to be an async generator, not just a coroutine that + returns an iterable. + Usage ===== @@ -76,7 +87,7 @@ This means you can use many useful Python libraries providing such code:: async def parse_with_asyncio(self, response): async with aiohttp.ClientSession() as session: async with session.get('https://additional.url') as additional_response: - additional_data = await r.text() + additional_data = await additional_response.text() # ... use response and additional_data to yield items and requests .. note:: Many libraries that use coroutines, such as `aio-libs`_, require the diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index fc114a63f..d09693c16 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -98,20 +98,25 @@ object gives you access, for example, to the :ref:`settings `. .. method:: process_spider_output(response, result, spider) + .. versionchanged:: VERSION + Since VERSION this can take and return an :term:`python:asynchronous + iterable`. + This method is called with the results returned from the Spider, after it has processed the response. - :meth:`process_spider_output` must return an iterable of - :class:`~scrapy.http.Request` objects and :ref:`item object - `. + :meth:`process_spider_output` must return an iterable (normal or + asynchronous) of :class:`~scrapy.http.Request` objects and + :ref:`item objects `. :param response: the response which generated this output from the spider :type response: :class:`~scrapy.http.Response` object :param result: the result returned by the spider - :type result: an iterable of :class:`~scrapy.http.Request` objects and - :ref:`item object ` + :type result: an iterable (normal or asynchronous) of + :class:`~scrapy.http.Request` objects and :ref:`item objects + ` :param spider: the spider whose result is being processed :type spider: :class:`~scrapy.spiders.Spider` object @@ -122,7 +127,7 @@ object gives you access, for example, to the :ref:`settings `. method (from a previous spider middleware) raises an exception. :meth:`process_spider_exception` should return either ``None`` or an - iterable of :class:`~scrapy.http.Request` objects and :ref:`item object + iterable of :class:`~scrapy.http.Request` objects and :ref:`item objects `. If it returns ``None``, Scrapy will continue processing this exception, From f422861ef49e8d0e0c2aa4de937fb77b95e063ca Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 25 Mar 2021 20:47:40 +0500 Subject: [PATCH 040/532] Add more tests for spider middlewares. --- tests/test_spidermiddleware.py | 188 +++++++++++++++++++++++++++++++++ 1 file changed, 188 insertions(+) diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 78e926adc..2584dec21 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -1,11 +1,15 @@ +import collections.abc from unittest import mock +from twisted.internet import defer from twisted.trial.unittest import TestCase from twisted.python.failure import Failure from scrapy.spiders import Spider from scrapy.http import Request, Response from scrapy.exceptions import _InvalidOutput +from scrapy.utils.asyncgen import _process_iterable_universal, as_async_generator, collect_asyncgen +from scrapy.utils.defer import deferred_from_coro from scrapy.utils.test import get_crawler from scrapy.core.spidermw import SpiderMiddlewareManager @@ -101,3 +105,187 @@ class ProcessSpiderExceptionReRaise(SpiderMiddlewareTestCase): result = self._scrape_response() self.assertIsInstance(result, Failure) self.assertIsInstance(result.value, ZeroDivisionError) + + +class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): + """ Helpers for testing sync, async and mixed middlewares. + + Should work for process_spider_output and, when it's supported, process_start_requests. + """ + + RESULT_COUNT = 3 # to simplify checks, let everything return 3 objects + + @defer.inlineCallbacks + def _get_middleware_result(self, *mw_classes): + for mw_cls in mw_classes: + self.mwman._add_middleware(mw_cls()) + result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) + return result + + def assertAsyncGeneratorNotIterable(self, o): + with self.assertRaisesRegex(TypeError, + "'(async_generator|MutableAsyncChain)' object is not iterable"): + list(o) + + @defer.inlineCallbacks + def _test_simple_base(self, *mw_classes): + result = yield self._get_middleware_result(*mw_classes) + self.assertIsInstance(result, collections.abc.Iterable) + result_list = list(result) + self.assertEqual(len(result_list), self.RESULT_COUNT) + self.assertIsInstance(result_list[0], self.ITEM_TYPE) + + @defer.inlineCallbacks + def _test_asyncgen_base(self, *mw_classes): + result = yield self._get_middleware_result(*mw_classes) + self.assertIsInstance(result, collections.abc.AsyncIterator) + result_list = yield deferred_from_coro(collect_asyncgen(result)) + self.assertEqual(len(result_list), self.RESULT_COUNT) + self.assertIsInstance(result_list[0], self.ITEM_TYPE) + + @defer.inlineCallbacks + def _test_asyncgen_fail(self, *mw_classes): + result = yield self._get_middleware_result(*mw_classes) + self.assertIsInstance(result, collections.abc.Iterable) + self.assertAsyncGeneratorNotIterable(result) + + +class ProcessSpiderOutputSimpleMiddleware: + def process_spider_output(self, response, result, spider): + for r in result: + yield r + + +class ProcessSpiderOutputAsyncGenMiddleware: + async def process_spider_output(self, response, result, spider): + async for r in as_async_generator(result): + yield r + + +class ProcessSpiderOutputUniversalMiddleware: + def process_spider_output(self, response, result, spider): + @_process_iterable_universal + async def process(result): + async for r in result: + yield r + return process(result) + + +class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): + """ process_spider_output tests for simple callbacks""" + + ITEM_TYPE = dict + MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware + MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware + MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware + + def _scrape_func(self, *args, **kwargs): + yield {'foo': 1} + yield {'foo': 2} + yield {'foo': 3} + + def test_simple(self): + """ Simple mw """ + return self._test_simple_base(self.MW_SIMPLE) + + def test_asyncgen(self): + """ Asyncgen mw """ + return self._test_asyncgen_base(self.MW_ASYNCGEN) + + def test_simple_asyncgen(self): + """ Simple mw -> asyncgen mw """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, + self.MW_SIMPLE) + + def test_asyncgen_simple(self): + """ Asyncgen mw -> simple mw; cannot work """ + return self._test_asyncgen_fail(self.MW_SIMPLE, + self.MW_ASYNCGEN) + + def test_universal(self): + """ Universal mw """ + return self._test_simple_base(self.MW_UNIVERSAL) + + def test_universal_simple(self): + """ Universal mw -> simple mw """ + return self._test_simple_base(self.MW_SIMPLE, + self.MW_UNIVERSAL) + + def test_simple_universal(self): + """ Simple mw -> universal mw """ + return self._test_simple_base(self.MW_UNIVERSAL, + self.MW_SIMPLE) + + def test_universal_asyncgen(self): + """ Universal mw -> asyncgen mw """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, + self.MW_UNIVERSAL) + + def test_asyncgen_universal(self): + """ Asyncgen mw -> universal mw """ + return self._test_asyncgen_base(self.MW_UNIVERSAL, + self.MW_ASYNCGEN) + + +class ProcessSpiderOutputAsyncGen(ProcessSpiderOutputSimple): + """ process_spider_output tests for async generator callbacks """ + + async def _scrape_func(self, *args, **kwargs): + for item in super()._scrape_func(): + yield item + + def test_simple(self): + """ Simple mw; cannot work """ + return self._test_asyncgen_fail(self.MW_SIMPLE) + + @defer.inlineCallbacks + def test_simple_asyncgen(self): + """ Simple mw -> asyncgen mw; cannot work """ + result = yield self._get_middleware_result( + self.MW_ASYNCGEN, + self.MW_SIMPLE) + self.assertIsInstance(result, collections.abc.AsyncIterable) + self.assertAsyncGeneratorNotIterable(result) + + def test_universal(self): + """ Universal mw """ + return self._test_asyncgen_base(self.MW_UNIVERSAL) + + def test_universal_simple(self): + """ Universal mw -> simple mw; cannot work """ + return self._test_asyncgen_fail(self.MW_SIMPLE, + self.MW_UNIVERSAL) + + def test_simple_universal(self): + """ Simple mw -> universal mw; cannot work """ + return self._test_asyncgen_fail(self.MW_UNIVERSAL, + self.MW_SIMPLE) + + +class ProcessStartRequestsSimpleMiddleware: + def process_start_requests(self, start_requests, spider): + for r in start_requests: + yield r + + +class ProcessStartRequestsSimple(BaseAsyncSpiderMiddlewareTestCase): + """ process_start_requests tests for simple start_requests""" + + ITEM_TYPE = Request + MW_SIMPLE = ProcessStartRequestsSimpleMiddleware + + def _start_requests(self): + for i in range(3): + yield Request(f'https://example.com/{i}', dont_filter=True) + + @defer.inlineCallbacks + def _get_middleware_result(self, *mw_classes): + for mw_cls in mw_classes: + self.mwman._add_middleware(mw_cls()) + start_requests = iter(self._start_requests()) + results = yield self.mwman.process_start_requests(start_requests, self.spider) + return results + + def test_simple(self): + """ Simple mw """ + self._test_simple_base(self.MW_SIMPLE) From 0638d6f01c41f12311b21f06fee5c71f5d08569f Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 25 Mar 2021 21:58:29 +0500 Subject: [PATCH 041/532] Fix handling middlewares that change sync iterables into async. --- scrapy/core/spidermw.py | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 33e215971..230332673 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -3,7 +3,7 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ -import inspect +import collections.abc from itertools import islice from twisted.python.failure import Failure @@ -96,11 +96,10 @@ class SpiderMiddlewareManager(MiddlewareManager): def _process_spider_output(self, response, spider, result, start_index=0): # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - if inspect.isasyncgen(result): - iter_class = MutableAsyncChain + if isinstance(result, collections.abc.AsyncIterator): + recovered = MutableAsyncChain() else: - iter_class = MutableChain - recovered = iter_class() + recovered = MutableChain() method_list = islice(self.methods['process_spider_output'], start_index, None) for method_index, method in enumerate(method_list, start=start_index): @@ -121,16 +120,23 @@ class SpiderMiddlewareManager(MiddlewareManager): f"iterable, got {type(result)}") raise _InvalidOutput(msg) - return iter_class(result, recovered) + # check this again as the middlewares could change "result" from sync to async + if isinstance(result, collections.abc.AsyncIterator): + return MutableAsyncChain(result, recovered) + else: + return MutableChain(result, recovered) def _process_callback_output(self, response, spider, result): - if inspect.isasyncgen(result): - iter_class = MutableAsyncChain + if isinstance(result, collections.abc.AsyncIterator): + recovered = MutableAsyncChain() else: - iter_class = MutableChain - recovered = iter_class() + recovered = MutableChain() result = self._evaluate_iterable(response, spider, result, 0, recovered) - return iter_class(self._process_spider_output(response, spider, result), recovered) + result = self._process_spider_output(response, spider, result) + if isinstance(result, collections.abc.AsyncIterator): + return MutableAsyncChain(result, recovered) + else: + return MutableChain(result, recovered) def scrape_response(self, scrape_func, response, request, spider): def process_callback_output(result): From b5f501df7bc3917af3d144bb6556a763f381cd7e Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 26 Mar 2021 20:17:41 +0500 Subject: [PATCH 042/532] Remove some unneeded code from _AsyncCooperatorAdapter. --- scrapy/utils/defer.py | 7 ------- 1 file changed, 7 deletions(-) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 554edc38c..ca3d79fa6 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -136,8 +136,6 @@ class _AsyncCooperatorAdapter: self.anext_deferred = None result = self.callable(result, *self.callable_args, **self.callable_kwargs) d = self.waiting_deferreds.pop(0) - if d.called: - raise ValueError('Deferred in waiting_deferreds already called') if isinstance(result, defer.Deferred): result.chainDeferred(d) else: @@ -152,8 +150,6 @@ class _AsyncCooperatorAdapter: failure.trap(StopAsyncIteration) self.finished = True for d in self.waiting_deferreds: - if d.called: - raise ValueError('Deferred in waiting_deferreds already called') d.callback(None) def _call_anext(self): @@ -162,9 +158,6 @@ class _AsyncCooperatorAdapter: self.anext_deferred = deferred_from_coro(self.aiterator.__anext__()) self.anext_deferred.addCallbacks(self._callback, self._errback) - def __iter__(self): - return self - def __next__(self): # This puts a new Deferred into self.waiting_deferreds and returns it. # It also calls __anext__() if needed. From 6803779eb7e408b275da62f670aba9deaf3eade9 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 26 Mar 2021 22:29:07 +0500 Subject: [PATCH 043/532] Add more tests for _process_iterable_universal. --- scrapy/utils/asyncgen.py | 2 +- tests/test_utils_asyncgen.py | 27 +++++++++++++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index 39c94ad8a..a79552f76 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -57,6 +57,6 @@ def _process_iterable_universal(process_async): if hasattr(iterable, '__iter__'): # convert process_async to process_sync return process_sync(iterable, *args, **kwargs) - raise ValueError(f"Wrong iterable type {type(iterable)}") + raise TypeError(f"Wrong iterable type {type(iterable)}") return process diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index 2f4181d3d..41993a934 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -2,6 +2,7 @@ from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen, _process_iterable_universal from scrapy.utils.defer import deferred_f_from_coro_f +from scrapy.utils.test import get_web_client_agent_req class AsyncgenUtilsTest(unittest.TestCase): @@ -26,6 +27,13 @@ async def process_iterable(iterable): yield i * 2 +@_process_iterable_universal +async def process_iterable_awaiting(iterable): + async for i in iterable: + yield i * 2 + await get_web_client_agent_req('http://example.com') + + class ProcessIterableUniversalTest(unittest.TestCase): def test_normal(self): @@ -38,3 +46,22 @@ class ProcessIterableUniversalTest(unittest.TestCase): iterable = as_async_generator([1, 2, 3]) results = await collect_asyncgen(process_iterable(iterable)) self.assertEqual(results, [2, 4, 6]) + + @deferred_f_from_coro_f + async def test_blocking(self): + iterable = [1, 2, 3] + with self.assertRaisesRegex(RuntimeError, "Synchronously-called function"): + list(process_iterable_awaiting(iterable)) + + def test_invalid_iterable(self): + with self.assertRaisesRegex(TypeError, "Wrong iterable type"): + process_iterable(None) + + @deferred_f_from_coro_f + async def test_invalid_process(self): + @_process_iterable_universal + def process_iterable_invalid(iterable): + pass + + with self.assertRaisesRegex(ValueError, "process_async returned wrong type"): + list(process_iterable_invalid([])) From 849472535ef9490e8cc2a62cc7f1835b2bc3eaba Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 2 Apr 2021 20:20:35 +0500 Subject: [PATCH 044/532] Update docs. --- docs/topics/coroutines.rst | 65 +++++++++++++++++++++++++++++++ docs/topics/spider-middleware.rst | 14 ++++--- scrapy/utils/asyncgen.py | 1 + 3 files changed, 74 insertions(+), 6 deletions(-) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 9b50d9312..6a39dcb5e 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -108,3 +108,68 @@ Common use cases for asynchronous code include: :ref:`the screenshot pipeline example`). .. _aio-libs: https://github.com/aio-libs + +.. _async-spider-middlewares: + +Asynchronous spider middlewares +=============================== + +.. versionadded:: VERSION +.. note:: This currently applies to + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`. + +Middleware methods discussed here can take and return async iterables. They can +return the same type of iterable or they can take a normal one and return an +async one. If such method needs to return an async iterable it must be an async +generator, not just a coroutine that returns an iterable. + +.. autofunction:: scrapy.utils.asyncgen.as_async_generator + +In the simplest form that supports both sync and async input it can be written +like this:: + + from scrapy.utils.asyncgen import as_async_generator + + class ProcessSpiderOutputAsyncGenMiddleware: + async def process_spider_output(self, response, result, spider): + async for r in as_async_generator(result): + # ... do something with r + yield r + +If the middleware input (the callback result for ``process_spider_output``) is +an async iterable, all middlewares that process it must support it. The +built-in ones do, but the ones in your project and 3rd-party ones will need to +be updated to support it, as the code that expects a normal iterable will break +on an async one. If these middlewares receive an async iterable, they must +return one as well. On the other hand, if they receive a normal iterable, they +shouldn't break and ideally should return a normal iterable too. There can be +several possible implementations of this. + +The simplest one, always converting normal iterables to async ones, is provided +above. Because a result of a middleware method is passed to the same method of +the next middleware, it's only possible to mix middlewares with synchronous and +asynchronous implementations of the same method if all synchronous ones are +called first (which isn't always possible). + +Another option is to make separate methods for normal and async iterables and +choose one at run time:: + + from inspect import isasyncgen + + class ProcessSpiderOutputAsyncGenMiddleware: + def _normal_process_spider_output(self, response, result, spider): + # ... do something with normal result + + async def _async_process_spider_output(self, response, result, spider): + # ... do the same with async result + + def process_spider_output(self, response, result, spider): + if isasyncgen(result): + return self._async_process_spider_output(self, response, result, spider) + else: + return self._normal_process_spider_output(self, response, result, spider) + +If you are writing a middleware that you intend to publish or to use in many +projects, this is likely the best way to implement it. It may be possible to +extract common code from both methods to reduce code duplication, as in the +simplest case the only difference between them will be ``for`` vs ``async for``. diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index d09693c16..d87b89292 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -105,18 +105,20 @@ object gives you access, for example, to the :ref:`settings `. This method is called with the results returned from the Spider, after it has processed the response. - :meth:`process_spider_output` must return an iterable (normal or - asynchronous) of :class:`~scrapy.http.Request` objects and - :ref:`item objects `. + :meth:`process_spider_output` must return an iterable of + :class:`~scrapy.http.Request` objects and :ref:`item objects + `. + + .. note:: When defined as a :ref:`coroutine `, this method needs + to be an async generator, not just return an iterable. :param response: the response which generated this output from the spider :type response: :class:`~scrapy.http.Response` object :param result: the result returned by the spider - :type result: an iterable (normal or asynchronous) of - :class:`~scrapy.http.Request` objects and :ref:`item objects - ` + :type result: an iterable of :class:`~scrapy.http.Request` objects and + :ref:`item objects ` :param spider: the spider whose result is being processed :type spider: :class:`~scrapy.spiders.Spider` object diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index a79552f76..6c0bb1d10 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -11,6 +11,7 @@ async def collect_asyncgen(result): async def as_async_generator(it): + """ Wraps an iterator (sync or async) into an async generator. """ if isinstance(it, collections.abc.AsyncIterator): async for r in it: yield r From 30ed7fa349214ad11b4d13c981cbd2fc63ddaf42 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 2 Apr 2021 22:20:56 +0500 Subject: [PATCH 045/532] Some cleanup, make sync middlewares fail earlier. --- scrapy/core/spidermw.py | 15 +++++++-------- tests/test_spidermiddleware.py | 18 ++++-------------- 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 230332673..b24ccf6ae 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -20,10 +20,6 @@ def _isiterable(possible_iterator): return hasattr(possible_iterator, '__iter__') or hasattr(possible_iterator, '__aiter__') -def _fname(f): - return f"{f.__self__.__class__.__name__}.{f.__func__.__name__}" - - class SpiderMiddlewareManager(MiddlewareManager): component_name = 'spider middleware' @@ -48,7 +44,7 @@ class SpiderMiddlewareManager(MiddlewareManager): try: result = method(response=response, spider=spider) if result is not None: - msg = (f"Middleware {_fname(method)} must return None " + msg = (f"Middleware {method.__qualname__} must return None " f"or raise an exception, got {type(result)}") raise _InvalidOutput(msg) except _InvalidOutput: @@ -88,7 +84,7 @@ class SpiderMiddlewareManager(MiddlewareManager): elif result is None: continue else: - msg = (f"Middleware {_fname(method)} must return None " + msg = (f"Middleware {method.__qualname__} must return None " f"or an iterable, got {type(result)}") raise _InvalidOutput(msg) return _failure @@ -96,7 +92,8 @@ class SpiderMiddlewareManager(MiddlewareManager): def _process_spider_output(self, response, spider, result, start_index=0): # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - if isinstance(result, collections.abc.AsyncIterator): + result_async = isinstance(result, collections.abc.AsyncIterator) + if result_async: recovered = MutableAsyncChain() else: recovered = MutableChain() @@ -116,9 +113,11 @@ class SpiderMiddlewareManager(MiddlewareManager): if _isiterable(result): result = self._evaluate_iterable(response, spider, result, method_index + 1, recovered) else: - msg = (f"Middleware {_fname(method)} must return an " + msg = (f"Middleware {method.__qualname__} must return an " f"iterable, got {type(result)}") raise _InvalidOutput(msg) + if result_async and isinstance(result, collections.abc.Iterator): + raise TypeError(f"Synchronous {method.__qualname__} called with an async iterable") # check this again as the middlewares could change "result" from sync to async if isinstance(result, collections.abc.AsyncIterator): diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 2584dec21..0a6b96c0c 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -122,11 +122,6 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) return result - def assertAsyncGeneratorNotIterable(self, o): - with self.assertRaisesRegex(TypeError, - "'(async_generator|MutableAsyncChain)' object is not iterable"): - list(o) - @defer.inlineCallbacks def _test_simple_base(self, *mw_classes): result = yield self._get_middleware_result(*mw_classes) @@ -145,9 +140,8 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): @defer.inlineCallbacks def _test_asyncgen_fail(self, *mw_classes): - result = yield self._get_middleware_result(*mw_classes) - self.assertIsInstance(result, collections.abc.Iterable) - self.assertAsyncGeneratorNotIterable(result) + with self.assertRaisesRegex(TypeError, "Synchronous .+ called with an async iterable"): + yield self._get_middleware_result(*mw_classes) class ProcessSpiderOutputSimpleMiddleware: @@ -238,14 +232,10 @@ class ProcessSpiderOutputAsyncGen(ProcessSpiderOutputSimple): """ Simple mw; cannot work """ return self._test_asyncgen_fail(self.MW_SIMPLE) - @defer.inlineCallbacks def test_simple_asyncgen(self): """ Simple mw -> asyncgen mw; cannot work """ - result = yield self._get_middleware_result( - self.MW_ASYNCGEN, - self.MW_SIMPLE) - self.assertIsInstance(result, collections.abc.AsyncIterable) - self.assertAsyncGeneratorNotIterable(result) + return self._test_asyncgen_fail(self.MW_ASYNCGEN, + self.MW_SIMPLE) def test_universal(self): """ Universal mw """ From 7bd1d888d49d238622007e659e54af76e82bf1c1 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 2 Apr 2021 23:06:29 +0500 Subject: [PATCH 046/532] More robust sync/async middleware mix checking. --- scrapy/core/spidermw.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index b24ccf6ae..d0d292007 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -92,8 +92,8 @@ class SpiderMiddlewareManager(MiddlewareManager): def _process_spider_output(self, response, spider, result, start_index=0): # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - result_async = isinstance(result, collections.abc.AsyncIterator) - if result_async: + last_result_async = isinstance(result, collections.abc.AsyncIterator) + if last_result_async: recovered = MutableAsyncChain() else: recovered = MutableChain() @@ -116,11 +116,11 @@ class SpiderMiddlewareManager(MiddlewareManager): msg = (f"Middleware {method.__qualname__} must return an " f"iterable, got {type(result)}") raise _InvalidOutput(msg) - if result_async and isinstance(result, collections.abc.Iterator): + if last_result_async and isinstance(result, collections.abc.Iterator): raise TypeError(f"Synchronous {method.__qualname__} called with an async iterable") + last_result_async = isinstance(result, collections.abc.AsyncIterator) - # check this again as the middlewares could change "result" from sync to async - if isinstance(result, collections.abc.AsyncIterator): + if last_result_async: return MutableAsyncChain(result, recovered) else: return MutableChain(result, recovered) From 61197d3dba53cd67c41e5d23e1f0c11a864f539b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 14 Apr 2021 18:21:58 +0500 Subject: [PATCH 047/532] Add/update typing, cleanup iterator/iterable inconsistencies. --- scrapy/core/scraper.py | 7 +++--- scrapy/core/spidermw.py | 36 +++++++++++++++------------- scrapy/utils/asyncgen.py | 19 +++++++-------- scrapy/utils/defer.py | 52 ++++++++++++++++++++++++---------------- scrapy/utils/python.py | 14 +++++------ 5 files changed, 71 insertions(+), 57 deletions(-) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 8ce57af2f..0630ce625 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -1,10 +1,8 @@ """This module implements the Scraper component which parses responses and extracts information from them""" -import collections import logging from collections import deque -from collections.abc import Iterable -from typing import Union +from typing import AsyncGenerator, AsyncIterable, Generator, Iterable, Union from itemadapter import is_item from twisted.internet import defer @@ -188,7 +186,8 @@ class Scraper: def handle_spider_output(self, result: Iterable, request: Request, response: Response, spider: Spider): if not result: return defer_succeed(None) - if isinstance(result, collections.abc.AsyncIterable): + it: Union[Generator, AsyncGenerator] + if isinstance(result, AsyncIterable): it = aiter_errback(result, self.handle_spider_error, request, response, spider) dfd = parallel_async(it, self.concurrent_items, self._process_spidermw_output, request, response, spider) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 6fcbc7492..9dd6c462d 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -3,9 +3,8 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ -import collections.abc from itertools import islice -from typing import Any, Callable, Generator, Iterable, Union, AsyncIterable +from typing import Any, Callable, Generator, Iterable, Union, AsyncIterable, AsyncGenerator from twisted.internet.defer import Deferred from twisted.python.failure import Failure @@ -61,8 +60,9 @@ class SpiderMiddlewareManager(MiddlewareManager): return scrape_func(Failure(), request, spider) return scrape_func(response, request, spider) - def _evaluate_iterable(self, response: Response, spider: Spider, iterable: Iterable, - exception_processor_index: int, recover_to: MutableChain) -> Generator: + def _evaluate_iterable(self, response: Response, spider: Spider, iterable: Union[Iterable, AsyncIterable], + exception_processor_index: int, recover_to: Union[MutableChain, MutableAsyncChain] + ) -> Union[Generator, AsyncGenerator]: @_process_iterable_universal async def _evaluate_async_iterable(iterable): try: @@ -100,11 +100,13 @@ class SpiderMiddlewareManager(MiddlewareManager): return _failure def _process_spider_output(self, response: Response, spider: Spider, - result: Iterable, start_index: int = 0) -> MutableChain: + result: Union[Iterable, AsyncIterable], start_index: int = 0 + ) -> Union[MutableChain, MutableAsyncChain]: # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method - last_result_async = isinstance(result, collections.abc.AsyncIterator) - if last_result_async: + recovered: Union[MutableChain, MutableAsyncChain] + last_result_is_async = isinstance(result, AsyncIterable) + if last_result_is_async: recovered = MutableAsyncChain() else: recovered = MutableChain() @@ -127,30 +129,32 @@ class SpiderMiddlewareManager(MiddlewareManager): msg = (f"Middleware {method.__qualname__} must return an " f"iterable, got {type(result)}") raise _InvalidOutput(msg) - if last_result_async and isinstance(result, collections.abc.Iterator): + if last_result_is_async and isinstance(result, Iterable): raise TypeError(f"Synchronous {method.__qualname__} called with an async iterable") - last_result_async = isinstance(result, collections.abc.AsyncIterator) + last_result_is_async = isinstance(result, AsyncIterable) - if last_result_async: + if last_result_is_async: return MutableAsyncChain(result, recovered) else: - return MutableChain(result, recovered) + return MutableChain(result, recovered) # type: ignore[arg-type] - def _process_callback_output(self, response: Response, spider: Spider, result: Iterable) -> MutableChain: - if isinstance(result, collections.abc.AsyncIterator): + def _process_callback_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] + ) -> Union[MutableChain, MutableAsyncChain]: + recovered: Union[MutableChain, MutableAsyncChain] + if isinstance(result, AsyncIterable): recovered = MutableAsyncChain() else: recovered = MutableChain() result = self._evaluate_iterable(response, spider, result, 0, recovered) result = self._process_spider_output(response, spider, result) - if isinstance(result, collections.abc.AsyncIterator): + if isinstance(result, AsyncIterable): return MutableAsyncChain(result, recovered) else: - return MutableChain(result, recovered) + return MutableChain(result, recovered) # type: ignore[arg-type] def scrape_response(self, scrape_func: ScrapeFunc, response: Response, request: Request, spider: Spider) -> Deferred: - def process_callback_output(result: Iterable) -> MutableChain: + def process_callback_output(result: Union[Iterable, AsyncIterable]) -> Union[MutableChain, MutableAsyncChain]: return self._process_callback_output(response, spider, result) def process_spider_exception(_failure: Failure) -> Union[Failure, MutableChain]: diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index 92118ddb9..ae9a79989 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -1,7 +1,6 @@ -import collections import functools import inspect -from collections.abc import AsyncIterable +from typing import AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Union async def collect_asyncgen(result: AsyncIterable): @@ -11,9 +10,9 @@ async def collect_asyncgen(result: AsyncIterable): return results -async def as_async_generator(it): - """ Wraps an iterator (sync or async) into an async generator. """ - if isinstance(it, collections.abc.AsyncIterator): +async def as_async_generator(it: Union[Iterable, AsyncIterable]) -> AsyncGenerator: + """ Wraps an iterable (sync or async) into an async generator. """ + if isinstance(it, AsyncIterable): async for r in it: yield r else: @@ -22,7 +21,7 @@ async def as_async_generator(it): # https://stackoverflow.com/a/66170760/113586 -def _process_iterable_universal(process_async): +def _process_iterable_universal(process_async: Callable): """ Takes a function that takes an async iterable, args and kwargs. Returns a function that takes any iterable, args and kwargs. @@ -33,7 +32,7 @@ def _process_iterable_universal(process_async): # If this stops working, all internal uses can be just replaced with manually-written # process_sync functions. - def process_sync(iterable, *args, **kwargs): + def process_sync(iterable: Iterable, *args, **kwargs) -> Generator: agen = process_async(as_async_generator(iterable), *args, **kwargs) if not inspect.isasyncgen(agen): raise ValueError(f"process_async returned wrong type {type(agen)}") @@ -52,11 +51,11 @@ def _process_iterable_universal(process_async): f"you can't use {_process_iterable_universal.__name__} with it.") @functools.wraps(process_async) - def process(iterable, *args, **kwargs): - if inspect.isasyncgen(iterable): + def process(iterable: Union[Iterable, AsyncIterable], *args, **kwargs) -> Union[Generator, AsyncGenerator]: + if isinstance(iterable, AsyncIterable): # call process_async directly return process_async(iterable, *args, **kwargs) - if hasattr(iterable, '__iter__'): + if isinstance(iterable, Iterable): # convert process_async to process_sync return process_sync(iterable, *args, **kwargs) raise TypeError(f"Wrong iterable type {type(iterable)}") diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index f81faf6dd..39c8a85e9 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -3,9 +3,21 @@ Helper functions for dealing with Twisted deferreds """ import asyncio import inspect -from collections.abc import Coroutine +from asyncio import Future from functools import wraps -from typing import Any, Callable, Generator, Iterable +from typing import ( + Any, + AsyncGenerator, + AsyncIterable, + Callable, + Coroutine, + Generator, + Iterable, + Iterator, + List, + Optional, + Union +) from twisted.internet import defer from twisted.internet.defer import Deferred, DeferredList, ensureDeferred @@ -80,8 +92,8 @@ def parallel(iterable: Iterable, count: int, callable: Callable, *args, **named) return DeferredList([coop.coiterate(work) for _ in range(count)]) -class _AsyncCooperatorAdapter: - """ A class that wraps an async iterator into a normal iterator suitable +class _AsyncCooperatorAdapter(Iterator): + """ A class that wraps an async iterable into a normal iterator suitable for using in Cooperator.coiterate(). As it's only needed for parallel_async(), it calls the callable directly in the callback, instead of providing a more generic interface. @@ -125,30 +137,30 @@ class _AsyncCooperatorAdapter: Cooperator/CooperativeTask and use it instead of this adapter to achieve the same goal. """ - def __init__(self, aiterator, callable, *callable_args, **callable_kwargs): - self.aiterator = aiterator + def __init__(self, aiterable: AsyncIterable, callable: Callable, *callable_args, **callable_kwargs): + self.aiterator = aiterable.__aiter__() self.callable = callable self.callable_args = callable_args self.callable_kwargs = callable_kwargs self.finished = False - self.waiting_deferreds = [] - self.anext_deferred = None + self.waiting_deferreds: List[Deferred] = [] + self.anext_deferred: Optional[Deferred] = None - def _callback(self, result): + def _callback(self, result: Any) -> None: # This gets called when the result from aiterator.__anext__() is available. # It calls the callable on it and sends the result to the oldest waiting Deferred # (by chaining if the result is a Deferred too or by firing if not). self.anext_deferred = None result = self.callable(result, *self.callable_args, **self.callable_kwargs) d = self.waiting_deferreds.pop(0) - if isinstance(result, defer.Deferred): + if isinstance(result, Deferred): result.chainDeferred(d) else: d.callback(None) if self.waiting_deferreds: self._call_anext() - def _errback(self, failure): + def _errback(self, failure: Failure) -> None: # This gets called on any exceptions in aiterator.__anext__(). # It handles StopAsyncIteration by stopping the iteration and reraises all others. self.anext_deferred = None @@ -157,29 +169,29 @@ class _AsyncCooperatorAdapter: for d in self.waiting_deferreds: d.callback(None) - def _call_anext(self): + def _call_anext(self) -> None: # This starts waiting for the next result from aiterator. # If aiterator is exhausted, _errback will be called. self.anext_deferred = deferred_from_coro(self.aiterator.__anext__()) self.anext_deferred.addCallbacks(self._callback, self._errback) - def __next__(self): + def __next__(self) -> Deferred: # This puts a new Deferred into self.waiting_deferreds and returns it. # It also calls __anext__() if needed. if self.finished: raise StopIteration - d = defer.Deferred() + d = Deferred() self.waiting_deferreds.append(d) if not self.anext_deferred: self._call_anext() return d -def parallel_async(async_iterable, count, callable, *args, **named): - """ Like parallel but for async iterables """ +def parallel_async(async_iterable: AsyncIterable, count: int, callable: Callable, *args, **named) -> DeferredList: + """ Like parallel but for async iterators """ coop = Cooperator() work = _AsyncCooperatorAdapter(async_iterable, callable, *args, **named) - dl = defer.DeferredList([coop.coiterate(work) for _ in range(count)]) + dl = DeferredList([coop.coiterate(work) for _ in range(count)]) return dl @@ -232,7 +244,7 @@ def iter_errback(iterable: Iterable, errback: Callable, *a, **kw) -> Generator: errback(failure.Failure(), *a, **kw) -async def aiter_errback(aiterable, errback, *a, **kw): +async def aiter_errback(aiterable: AsyncIterable, errback: Callable, *a, **kw) -> AsyncGenerator: """Wraps an async iterable calling an errback if an error is caught while iterating it. Similar to scrapy.utils.defer.iter_errback() """ @@ -290,13 +302,13 @@ def maybeDeferred_coro(f: Callable, *args, **kw) -> Deferred: return defer.succeed(result) -def deferred_to_future(d): +def deferred_to_future(d: Deferred) -> Future: """ Wraps a Deferred into a Future. Requires the asyncio reactor. """ return d.asFuture(asyncio.get_event_loop()) -def maybe_deferred_to_future(d): +def maybe_deferred_to_future(d: Deferred) -> Union[Deferred, Future]: """ Converts a Deferred to something that can be awaited in a callback or other user coroutine. If the asyncio reactor is installed, coroutines are wrapped into Futures, and only Futures can be diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 8b823d174..d086347bc 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -8,9 +8,9 @@ import re import sys import warnings import weakref -from collections.abc import Iterable from functools import partial, wraps from itertools import chain +from typing import AsyncIterable, Iterable, Union from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncgen import as_async_generator @@ -345,7 +345,7 @@ class MutableChain(Iterable): def __init__(self, *args: Iterable): self.data = chain.from_iterable(args) - def extend(self, *iterables: Iterable): + def extend(self, *iterables: Iterable) -> None: self.data = chain(self.data, chain.from_iterable(iterables)) def __iter__(self): @@ -359,22 +359,22 @@ class MutableChain(Iterable): return self.__next__() -async def _async_chain(*iterables): +async def _async_chain(*iterables: Union[Iterable, AsyncIterable]): for it in iterables: async for o in as_async_generator(it): yield o -class MutableAsyncChain: +class MutableAsyncChain(AsyncIterable): """ Similar to MutableChain but for async iterables """ - def __init__(self, *args): + def __init__(self, *args: Union[Iterable, AsyncIterable]): self.data = _async_chain(*args) - def extend(self, *aiterables): - self.data = _async_chain(self.data, _async_chain(*aiterables)) + def extend(self, *iterables: Union[Iterable, AsyncIterable]) -> None: + self.data = _async_chain(self.data, _async_chain(*iterables)) def __aiter__(self): return self From 9db01a483c729369b272235bfb6e1c66ff62d1f7 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Wed, 14 Apr 2021 19:02:38 +0500 Subject: [PATCH 048/532] Update scrapy/core/spidermw.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- scrapy/core/spidermw.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 9dd6c462d..d1fedae07 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -4,7 +4,7 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ from itertools import islice -from typing import Any, Callable, Generator, Iterable, Union, AsyncIterable, AsyncGenerator +from typing import Any, AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Union from twisted.internet.defer import Deferred from twisted.python.failure import Failure From 5bacc4822e80a78a2a287a5d1e417c0d3b7ddbdf Mon Sep 17 00:00:00 2001 From: Gustavo Bordin Date: Sun, 16 May 2021 18:40:30 -0300 Subject: [PATCH 049/532] changing dunder-str to dunder-repr --- scrapy/core/http2/stream.py | 6 ++---- scrapy/http/request/__init__.py | 4 +--- scrapy/http/response/__init__.py | 4 +--- scrapy/settings/__init__.py | 4 +--- scrapy/spiders/__init__.py | 4 +--- 5 files changed, 6 insertions(+), 16 deletions(-) diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index c2a4b702f..a3a9e5e1d 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -150,12 +150,10 @@ class Stream: self.close(StreamCloseReason.CANCELLED) self._deferred_response = Deferred(_cancel) - - def __str__(self) -> str: + + def __repr__(self): return f'Stream(id={self.stream_id!r})' - __repr__ = __str__ - @property def _log_warnsize(self) -> bool: """Checks if we have received data which exceeds the download warnsize diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index ad884feac..a1857c604 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -109,11 +109,9 @@ class Request(object_ref): def encoding(self): return self._encoding - def __str__(self): + def __repr__(self): return f"<{self.method} {self.url}>" - __repr__ = __str__ - def copy(self): """Return a copy of this Request""" return self.replace() diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index 185a9bb67..eb80c5214 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -87,11 +87,9 @@ class Response(object_ref): body = property(_get_body, obsolete_setter(_set_body, 'body')) - def __str__(self): + def __repr__(self): return f"<{self.status} {self.url}>" - __repr__ = __str__ - def copy(self): """Return a copy of this Response""" return self.replace() diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index 1fe1e6fd1..69d0476eb 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -51,11 +51,9 @@ class SettingsAttribute: self.value = value self.priority = priority - def __str__(self): + def __repr__(self): return f"" - __repr__ = __str__ - class BaseSettings(MutableMapping): """ diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index c13ba4b3c..1c079ff27 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -106,11 +106,9 @@ class Spider(object_ref): if callable(closed): return closed(reason) - def __str__(self): + def __repr__(self): return f"<{type(self).__name__} {self.name!r} at 0x{id(self):0x}>" - __repr__ = __str__ - # Top-level imports from scrapy.spiders.crawl import CrawlSpider, Rule From 09a07c9b4ad02959e7416c25984fa715df7bd71f Mon Sep 17 00:00:00 2001 From: Gustavo Bordin Date: Tue, 18 May 2021 19:07:28 -0300 Subject: [PATCH 050/532] removed whitespaces --- scrapy/core/http2/stream.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index a3a9e5e1d..780191505 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -150,7 +150,7 @@ class Stream: self.close(StreamCloseReason.CANCELLED) self._deferred_response = Deferred(_cancel) - + def __repr__(self): return f'Stream(id={self.stream_id!r})' From de69d967f90bc70bc07f734b93a4e7b73f2a4aa9 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 11 Jun 2021 16:12:25 +0500 Subject: [PATCH 051/532] Fix async spider examples. --- docs/topics/coroutines.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 6a39dcb5e..67f1a4098 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -77,14 +77,16 @@ coroutines, functions that return Deferreds and functions that return :term:`awaitable objects ` such as :class:`~asyncio.Future`. This means you can use many useful Python libraries providing such code:: - class MySpider(Spider): + class MySpiderDeferred(Spider): # ... - async def parse_with_deferred(self, response): + async def parse(self, response): additional_response = await treq.get('https://additional.url') additional_data = await treq.content(additional_response) # ... use response and additional_data to yield items and requests - async def parse_with_asyncio(self, response): + class MySpiderAsyncio(Spider): + # ... + async def parse(self, response): async with aiohttp.ClientSession() as session: async with session.get('https://additional.url') as additional_response: additional_data = await additional_response.text() From 7306a81188f81964ad85f4936ce29e3aa0084447 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 19 Jul 2021 20:09:11 +0500 Subject: [PATCH 052/532] Disable builtin middlewares in spider middleware tests. --- tests/test_spidermiddleware.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 0a6b96c0c..b0ca2f62e 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -19,7 +19,7 @@ class SpiderMiddlewareTestCase(TestCase): def setUp(self): self.request = Request('http://example.com/index.html') self.response = Response(self.request.url, request=self.request) - self.crawler = get_crawler(Spider) + self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}}) self.spider = self.crawler._create_spider('foo') self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) From e5b057cfd4472e970b9b51757a1b823b2f585b09 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 13 Oct 2021 19:06:51 +0500 Subject: [PATCH 053/532] Don't use a HTTP request in a case that will not be awaited. --- tests/test_utils_asyncgen.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index 41993a934..d9e6bc2eb 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -1,3 +1,4 @@ +from twisted.internet.defer import Deferred from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen, _process_iterable_universal @@ -31,7 +32,10 @@ async def process_iterable(iterable): async def process_iterable_awaiting(iterable): async for i in iterable: yield i * 2 - await get_web_client_agent_req('http://example.com') + d = Deferred() + from twisted.internet import reactor + reactor.callLater(0, d.callback, 42) + await d class ProcessIterableUniversalTest(unittest.TestCase): From a642b73e1a1ba355bae9d5b9d1e87a9da0696293 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 13 Oct 2021 19:21:49 +0500 Subject: [PATCH 054/532] Remove an unused import. --- tests/test_utils_asyncgen.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index d9e6bc2eb..7abe17c22 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -3,7 +3,6 @@ from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen, _process_iterable_universal from scrapy.utils.defer import deferred_f_from_coro_f -from scrapy.utils.test import get_web_client_agent_req class AsyncgenUtilsTest(unittest.TestCase): From eea56c4912ebabf94d366b4ead0d0d0a40a1d682 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Sat, 20 Nov 2021 20:13:54 +0200 Subject: [PATCH 055/532] per slot settings: creation of Downloader.Slot objects from per slot settings added --- scrapy/core/downloader/__init__.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 4f7ab594f..f680b9082 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -83,6 +83,7 @@ class Downloader: self.middleware = DownloaderMiddlewareManager.from_crawler(crawler) self._slot_gc_loop = task.LoopingCall(self._slot_gc) self._slot_gc_loop.start(60) + self.per_slot_settings = self.settings.getdict('PER_SLOT_SETTINGS', {}) def fetch(self, request, spider): def _deactivate(response): @@ -99,9 +100,13 @@ class Downloader: def _get_slot(self, request, spider): key = self._get_slot_key(request, spider) if key not in self.slots: - conc = self.ip_concurrency if self.ip_concurrency else self.domain_concurrency + conc = self.per_slot_settings.get(key,{}).get('concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency) conc, delay = _get_concurrency_delay(conc, spider, self.settings) - self.slots[key] = Slot(conc, delay, self.randomize_delay) + delay = self.per_slot_settings.get(key,{}).get('delay', delay) + randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) + new_slot = Slot(conc, delay, randomize_delay) + self.slots[key] = new_slot + return key, self.slots[key] From d5acf88ca55988a6c92046da5ef2bf065b0b3e72 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Sat, 20 Nov 2021 20:14:28 +0200 Subject: [PATCH 056/532] per slot settings: logging added (create Slot) --- scrapy/core/downloader/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index f680b9082..9aab80171 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -1,3 +1,4 @@ +import logging import random from time import time from datetime import datetime @@ -12,6 +13,7 @@ from scrapy import signals from scrapy.core.downloader.middleware import DownloaderMiddlewareManager from scrapy.core.downloader.handlers import DownloadHandlers +logger = logging.getLogger(__name__) class Slot: """Downloader slot""" @@ -106,7 +108,7 @@ class Downloader: randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot - + logger.debug(f"Downloader slot created {'from per slot settings' if key in self.per_slot_settings.keys() else ''}: {new_slot}") return key, self.slots[key] From 1b7d7ecfcdb6067f3dccd69fc56e25dc1dbf498f Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Sat, 20 Nov 2021 21:05:24 +0200 Subject: [PATCH 057/532] per slot settings: logging updated (create/close Slot) --- scrapy/core/downloader/__init__.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 9aab80171..461b211ab 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -108,7 +108,8 @@ class Downloader: randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot - logger.debug(f"Downloader slot created {'from per slot settings' if key in self.per_slot_settings.keys() else ''}: {new_slot}") + logger.debug( + f"Downloader slot '{key}' - created {'(from per slot settings)' if key in self.per_slot_settings.keys() else ''}: {new_slot}") return key, self.slots[key] @@ -205,4 +206,7 @@ class Downloader: mintime = time() - age for key, slot in list(self.slots.items()): if not slot.active and slot.lastseen + slot.delay < mintime: - self.slots.pop(key).close() + inactive_slot = self.slots.pop(key) + inactive_slot.close() + logger.debug( + f"Downloader slot '{key}' - closed {'(from per slot settings)' if key in self.per_slot_settings.keys() else ''} : {inactive_slot}") From 8185aa5265c663326474897c24aa0691a2ee0e5c Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Sat, 20 Nov 2021 21:06:08 +0200 Subject: [PATCH 058/532] per slot settings: codestyle fix --- scrapy/core/downloader/__init__.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 461b211ab..d5809ffa0 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -15,6 +15,7 @@ from scrapy.core.downloader.handlers import DownloadHandlers logger = logging.getLogger(__name__) + class Slot: """Downloader slot""" @@ -102,9 +103,9 @@ class Downloader: def _get_slot(self, request, spider): key = self._get_slot_key(request, spider) if key not in self.slots: - conc = self.per_slot_settings.get(key,{}).get('concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency) + conc = self.per_slot_settings.get(key, {}).get('concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency) conc, delay = _get_concurrency_delay(conc, spider, self.settings) - delay = self.per_slot_settings.get(key,{}).get('delay', delay) + delay = self.per_slot_settings.get(key, {}).get('delay', delay) randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot From a9dfd85ea6e983f255afc1b5b0f295fccddcbacb Mon Sep 17 00:00:00 2001 From: Burak Can Kahraman Date: Thu, 30 Dec 2021 15:48:53 +0300 Subject: [PATCH 059/532] Document coroutines for signals. --- docs/topics/coroutines.rst | 2 ++ docs/topics/signals.rst | 20 +++++++++----------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 2aef755c7..549552bd1 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -1,3 +1,5 @@ +.. _topics-coroutines: + ========== Coroutines ========== diff --git a/docs/topics/signals.rst b/docs/topics/signals.rst index 63ad3a9ad..328fb88d2 100644 --- a/docs/topics/signals.rst +++ b/docs/topics/signals.rst @@ -51,12 +51,12 @@ Deferred signal handlers ======================== Some signals support returning :class:`~twisted.internet.defer.Deferred` -objects from their handlers, allowing you to run asynchronous code that -does not block Scrapy. If a signal handler returns a -:class:`~twisted.internet.defer.Deferred`, Scrapy waits for that -:class:`~twisted.internet.defer.Deferred` to fire. +or :term:`awaitable objects ` from their handlers, allowing +you to run asynchronous code that does not block Scrapy. If a signal +handler returns one of these objects, Scrapy waits for that asynchronous +operation to finish. -Let's take an example:: +Let's take an example using :ref:`coroutines `:: class SignalSpider(scrapy.Spider): name = 'signals' @@ -68,17 +68,15 @@ Let's take an example:: crawler.signals.connect(spider.item_scraped, signal=signals.item_scraped) return spider - def item_scraped(self, item): + async def item_scraped(self, item): # Send the scraped item to the server - d = treq.post( + response = await treq.post( 'http://example.com/post', json.dumps(item).encode('ascii'), headers={b'Content-Type': [b'application/json']} ) - # The next item will be scraped only after - # deferred (d) is fired - return d + return response def parse(self, response): for quote in response.css('div.quote'): @@ -89,7 +87,7 @@ Let's take an example:: } See the :ref:`topics-signals-ref` below to know which signals support -:class:`~twisted.internet.defer.Deferred`. +:class:`~twisted.internet.defer.Deferred` and :term:`awaitable objects `. .. _topics-signals-ref: From f789547551ae0eb79f41c9de44525bf597a0ffa5 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 11 Jan 2022 18:28:32 +0500 Subject: [PATCH 060/532] Implement spider middleware iterable upgrade/downgrade. --- docs/topics/coroutines.rst | 104 ++++--- docs/topics/spider-middleware.rst | 9 + scrapy/core/scraper.py | 3 +- scrapy/core/spidermw.py | 135 +++++++-- scrapy/middleware.py | 7 +- scrapy/spidermiddlewares/depth.py | 71 ++--- scrapy/spidermiddlewares/offsite.py | 40 +-- scrapy/spidermiddlewares/referer.py | 22 +- scrapy/spidermiddlewares/urllength.py | 33 +-- scrapy/utils/asyncgen.py | 47 +-- scrapy/utils/python.py | 4 +- tests/test_spidermiddleware.py | 302 +++++++++++++++++--- tests/test_spidermiddleware_output_chain.py | 17 ++ tests/test_utils_asyncgen.py | 52 +--- 14 files changed, 553 insertions(+), 293 deletions(-) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index c514fc00a..073b6bd9a 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -35,11 +35,10 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :ref:`Signal handlers that support deferreds `. - The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` - method of :ref:`spider middlewares `. + method of :ref:`spider middlewares `. See + :ref:`async-spider-middlewares`. .. versionadded:: VERSION - .. note:: This method needs to be an async generator, not just a coroutine that - returns an iterable. Usage ===== @@ -106,8 +105,8 @@ Common use cases for asynchronous code include: * storing data in databases (in pipelines and middlewares); * delaying the spider initialization until some external event (in the :signal:`spider_opened` handler); -* calling asynchronous Scrapy methods like ``ExecutionEngine.download`` (see - :ref:`the screenshot pipeline example`). +* calling asynchronous Scrapy methods like :meth:`ExecutionEngine.download` + (see :ref:`the screenshot pipeline example`). .. _aio-libs: https://github.com/aio-libs @@ -119,59 +118,72 @@ Asynchronous spider middlewares .. versionadded:: VERSION .. note:: This currently applies to :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`. + In the future it will also apply to + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start_requests`. Middleware methods discussed here can take and return async iterables. They can return the same type of iterable or they can take a normal one and return an async one. If such method needs to return an async iterable it must be an async generator, not just a coroutine that returns an iterable. -.. autofunction:: scrapy.utils.asyncgen.as_async_generator +As the result of a middleware method is passed to the same method of the next +middleware, it needs to be adapted if the second method expects a different +type. Scrapy will do this transparently: -In the simplest form that supports both sync and async input it can be written -like this:: +* A normal iterable is wrapped into an async one which shouldn't cause any side + effects. +* An async iterable is downgraded to a normal one by waiting until all results + are available and wrapping them in a normal iterable. This is problematic + because it pauses the normal middleware processing for this iterable and + because all results can be skipped if exceptions are raised during + processing. This case emits a warning and will be deprecated and then removed + in a later Scrapy version. +* Async iterables returned from + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_exception` + won't be downgraded, an exception will be raised if that is needed. - from scrapy.utils.asyncgen import as_async_generator +As downgrading is undesirable, here is the proposed way to avoid it. If all +middlewares, including 3rd-party ones, support async iterables as input, no +downgrading will happen. But removing normal iterable support (making the +method a coroutine) from a middleware published as a separate project or used +internally in projects for older Scrapy versions breaks backwards +compatibility. So, as an interim measure (it will be deprecated and then +removed in a later Scrapy version), a middleware can provide both sync and +async methods in the following form:: - class ProcessSpiderOutputAsyncGenMiddleware: - async def process_spider_output(self, response, result, spider): - async for r in as_async_generator(result): + class UniversalSpiderMiddleware: + def process_spider_output(self, response, result, spider): + for r in result: # ... do something with r yield r -If the middleware input (the callback result for ``process_spider_output``) is -an async iterable, all middlewares that process it must support it. The -built-in ones do, but the ones in your project and 3rd-party ones will need to -be updated to support it, as the code that expects a normal iterable will break -on an async one. If these middlewares receive an async iterable, they must -return one as well. On the other hand, if they receive a normal iterable, they -shouldn't break and ideally should return a normal iterable too. There can be -several possible implementations of this. + async def process_spider_output_async(self, response, result, spider): + async for r in result: + # ... do something with r + yield r -The simplest one, always converting normal iterables to async ones, is provided -above. Because a result of a middleware method is passed to the same method of -the next middleware, it's only possible to mix middlewares with synchronous and -asynchronous implementations of the same method if all synchronous ones are -called first (which isn't always possible). +In this case normal and async iterables will be passed to the respective +methods without any wrapping or downgrading, and in older versions of Scrapy +the coroutine method will just be ignored. When the backwards compatibility is +no longer needed the non-coroutine method can be dropped and the coroutine one +renamed to the normal name. It may be possible to extract common code from both +methods to reduce code duplication, as in the simplest case the only difference +between them will be ``for`` vs ``async for``. -Another option is to make separate methods for normal and async iterables and -choose one at run time:: +So, to recap: - from inspect import isasyncgen - - class ProcessSpiderOutputAsyncGenMiddleware: - def _normal_process_spider_output(self, response, result, spider): - # ... do something with normal result - - async def _async_process_spider_output(self, response, result, spider): - # ... do the same with async result - - def process_spider_output(self, response, result, spider): - if isasyncgen(result): - return self._async_process_spider_output(self, response, result, spider) - else: - return self._normal_process_spider_output(self, response, result, spider) - -If you are writing a middleware that you intend to publish or to use in many -projects, this is likely the best way to implement it. It may be possible to -extract common code from both methods to reduce code duplication, as in the -simplest case the only difference between them will be ``for`` vs ``async for``. +* If you don't intend to use async callbacks or middlewares containing async + code in your project, nothing should change for you yet. At some point in the + future some of the 3rd-party middlewares you use may drop backwards + compatibility, which shouldn't lead to immediate problems but may be a sign + to start converting your code to ``async def`` too. +* If you maintain a middleware that can be used with projects you can't control + (e.g. one you published for other people to use, or one that needs to support + some old project that can't be modernized), we recommend adding a + ``process_spider_output_async`` method so that the amount of unnecessary + iterable conversions is reduced but no compatibility is broken. +* If you use async callbacks, try to make sure all middlewares support them. + Note that you can modernize 3rd-party middlewares by subclassing them. +* If you want to write and publish a middleware that requires async code, you + should write in the docs that the minimum support Scrapy version is VERSION + (maybe even check this at the run time, using :attr:`scrapy.__version__`). diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index f8d4a356f..edfc2e4bb 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -123,6 +123,15 @@ object gives you access, for example, to the :ref:`settings `. :param spider: the spider whose result is being processed :type spider: :class:`~scrapy.Spider` object + .. method:: process_spider_output_async(response, result, spider) + + .. versionadded:: VERSION + + If exists, this methid will be called instead of + :meth:`process_spider_output` when ``result`` is an async iterable. + If this method exists, it must be a coroutine while + :meth:`process_spider_output` must not be a coroutine. + .. method:: process_spider_exception(response, exception, spider) This method is called when a spider or :meth:`process_spider_output` diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index e64cfae0a..e1fdd8d13 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -192,7 +192,8 @@ class Scraper: spider=spider ) - def handle_spider_output(self, result: Iterable, request: Request, response: Response, spider: Spider) -> Deferred: + def handle_spider_output(self, result: Union[Iterable, AsyncIterable], request: Request, + response: Response, spider: Spider) -> Deferred: if not result: return defer_succeed(None) it: Union[Generator, AsyncGenerator] diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 009ece06d..6075670b0 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -3,22 +3,27 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ +import logging +from inspect import isasyncgenfunction from itertools import islice -from typing import Any, AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Union, cast +from typing import Any, AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Tuple, Union, cast -from twisted.internet.defer import Deferred +from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure from scrapy import Request, Spider from scrapy.exceptions import _InvalidOutput from scrapy.http import Response from scrapy.middleware import MiddlewareManager -from scrapy.utils.asyncgen import _process_iterable_universal +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.conf import build_component_list -from scrapy.utils.defer import mustbe_deferred +from scrapy.utils.defer import mustbe_deferred, deferred_from_coro, deferred_f_from_coro_f, maybe_deferred_to_future from scrapy.utils.python import MutableAsyncChain, MutableChain +logger = logging.getLogger(__name__) + + ScrapeFunc = Callable[[Union[Response, Failure], Request, Spider], Any] @@ -30,6 +35,10 @@ class SpiderMiddlewareManager(MiddlewareManager): component_name = 'spider middleware' + def __init__(self, *middlewares): + super().__init__(*middlewares) + self.downgrade_warning_done = False + @classmethod def _get_mwlist_from_settings(cls, settings): return build_component_list(settings.getwithbase('SPIDER_MIDDLEWARES')) @@ -40,7 +49,7 @@ class SpiderMiddlewareManager(MiddlewareManager): self.methods['process_spider_input'].append(mw.process_spider_input) if hasattr(mw, 'process_start_requests'): self.methods['process_start_requests'].appendleft(mw.process_start_requests) - process_spider_output = getattr(mw, 'process_spider_output', None) + process_spider_output = self._get_async_method_pair(mw, 'process_spider_output') self.methods['process_spider_output'].appendleft(process_spider_output) process_spider_exception = getattr(mw, 'process_spider_exception', None) self.methods['process_spider_exception'].appendleft(process_spider_exception) @@ -64,8 +73,19 @@ class SpiderMiddlewareManager(MiddlewareManager): def _evaluate_iterable(self, response: Response, spider: Spider, iterable: Union[Iterable, AsyncIterable], exception_processor_index: int, recover_to: Union[MutableChain, MutableAsyncChain] ) -> Union[Generator, AsyncGenerator]: - @_process_iterable_universal - async def _evaluate_async_iterable(iterable): + + def process_sync(iterable: Iterable): + try: + for r in iterable: + yield r + except Exception as ex: + exception_result = self._process_spider_exception(response, spider, Failure(ex), + exception_processor_index) + if isinstance(exception_result, Failure): + raise + recover_to.extend(exception_result) + + async def process_async(iterable: AsyncIterable): try: async for r in iterable: yield r @@ -75,7 +95,10 @@ class SpiderMiddlewareManager(MiddlewareManager): if isinstance(exception_result, Failure): raise recover_to.extend(exception_result) - return _evaluate_async_iterable(iterable) + + if isinstance(iterable, AsyncIterable): + return process_async(iterable) + return process_sync(iterable) def _process_spider_exception(self, response: Response, spider: Spider, _failure: Failure, start_index: int = 0) -> Union[Failure, MutableChain]: @@ -87,11 +110,22 @@ class SpiderMiddlewareManager(MiddlewareManager): for method_index, method in enumerate(method_list, start=start_index): if method is None: continue + method = cast(Callable, method) result = method(response=response, exception=exception, spider=spider) if _isiterable(result): # stop exception handling by handing control over to the # process_spider_output chain if an iterable has been returned - return self._process_spider_output(response, spider, result, method_index + 1) + dfd: Deferred = self._process_spider_output(response, spider, result, method_index + 1) + # _process_spider_output() returns a Deferred only because of downgrading so this can be + # simplified when downgrading is removed. + if dfd.called: + # the result is available immediately if _process_spider_output didn't do downgrading + return dfd.result + else: + # we forbid waiting here because otherwise we would need to return a deferred from + # _process_spider_exception too, which complicates the architecture + msg = f"Async iterable returned from {method.__qualname__} cannot be downgraded" + raise _InvalidOutput(msg) elif result is None: continue else: @@ -100,9 +134,13 @@ class SpiderMiddlewareManager(MiddlewareManager): raise _InvalidOutput(msg) return _failure + # This method cannot be made async def, as _process_spider_exception relies on the Deferred result + # being available immediately which doesn't work when it's a wrapped coroutine. + # It also needs @inlineCallbacks only because of downgrading so it can be removed when downgrading is removed. + @inlineCallbacks def _process_spider_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable], start_index: int = 0 - ) -> Union[MutableChain, MutableAsyncChain]: + ) -> Deferred: # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method recovered: Union[MutableChain, MutableAsyncChain] @@ -112,11 +150,43 @@ class SpiderMiddlewareManager(MiddlewareManager): else: recovered = MutableChain() + # There are three cases for the middleware: def foo, async def foo, def foo + async def foo_async. + # 1. def foo. Sync iterables are passed as is, async ones are downgraded. + # 2. async def foo. Sync iterables are upgraded, async ones are passed as is. + # 3. def foo + async def foo_async. Iterables are passed to the respective method. + # Storing methods and method tuples in the same list is weird but we should be able to roll this back + # when we drop this compatibility feature. + method_list = islice(self.methods['process_spider_output'], start_index, None) - for method_index, method in enumerate(method_list, start=start_index): - if method is None: + for method_index, method_pair in enumerate(method_list, start=start_index): + if method_pair is None: continue + need_upgrade = need_downgrade = False + if isinstance(method_pair, tuple): + # This tuple handling is only needed until _async compatibility methods are removed. + method_sync, method_async = method_pair + method = method_async if last_result_is_async else method_sync + else: + method = method_pair + if not last_result_is_async and isasyncgenfunction(method): + need_upgrade = True + elif last_result_is_async and not isasyncgenfunction(method): + need_downgrade = True try: + if need_upgrade: + # Iterable -> AsyncIterable + result = as_async_generator(result) + elif need_downgrade: + if not self.downgrade_warning_done: + logger.warning(f"Async iterable passed to {method.__qualname__} " + f"was downgraded to a non-async one") + self.downgrade_warning_done = True + assert isinstance(result, AsyncIterable) + # AsyncIterable -> Iterable + result = yield deferred_from_coro(collect_asyncgen(result)) + if isinstance(recovered, AsyncIterable): + recovered_collected = yield deferred_from_coro(collect_asyncgen(recovered)) + recovered = MutableChain(recovered_collected) # might fail directly if the output value is not a generator result = method(response=response, result=result, spider=spider) except Exception as ex: @@ -130,8 +200,6 @@ class SpiderMiddlewareManager(MiddlewareManager): msg = (f"Middleware {method.__qualname__} must return an " f"iterable, got {type(result)}") raise _InvalidOutput(msg) - if last_result_is_async and isinstance(result, Iterable): - raise TypeError(f"Synchronous {method.__qualname__} called with an async iterable") last_result_is_async = isinstance(result, AsyncIterable) if last_result_is_async: @@ -139,31 +207,58 @@ class SpiderMiddlewareManager(MiddlewareManager): else: return MutableChain(result, recovered) # type: ignore[arg-type] - def _process_callback_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] - ) -> Union[MutableChain, MutableAsyncChain]: + async def _process_callback_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] + ) -> Union[MutableChain, MutableAsyncChain]: recovered: Union[MutableChain, MutableAsyncChain] if isinstance(result, AsyncIterable): recovered = MutableAsyncChain() else: recovered = MutableChain() result = self._evaluate_iterable(response, spider, result, 0, recovered) - result = self._process_spider_output(response, spider, result) + result = await maybe_deferred_to_future(self._process_spider_output(response, spider, result)) if isinstance(result, AsyncIterable): return MutableAsyncChain(result, recovered) else: + if isinstance(recovered, AsyncIterable): + recovered_collected = await collect_asyncgen(recovered) + recovered = MutableChain(recovered_collected) return MutableChain(result, recovered) # type: ignore[arg-type] def scrape_response(self, scrape_func: ScrapeFunc, response: Response, request: Request, spider: Spider) -> Deferred: - def process_callback_output(result: Union[Iterable, AsyncIterable]) -> Union[MutableChain, MutableAsyncChain]: - return self._process_callback_output(response, spider, result) + async def process_callback_output(result: Union[Iterable, AsyncIterable] + ) -> Union[MutableChain, MutableAsyncChain]: + return await self._process_callback_output(response, spider, result) def process_spider_exception(_failure: Failure) -> Union[Failure, MutableChain]: return self._process_spider_exception(response, spider, _failure) dfd = mustbe_deferred(self._process_spider_input, scrape_func, response, request, spider) - dfd.addCallbacks(callback=process_callback_output, errback=process_spider_exception) + dfd.addCallbacks(callback=deferred_f_from_coro_f(process_callback_output), errback=process_spider_exception) return dfd def process_start_requests(self, start_requests, spider: Spider) -> Deferred: return self._process_chain('process_start_requests', start_requests, spider) + + # This method is only needed until _async compatibility methods are removed. + @staticmethod + def _get_async_method_pair(mw: Any, methodname: str) -> Union[None, Callable, Tuple[Callable, Callable]]: + normal_method = getattr(mw, methodname, None) + methodname_async = methodname + "_async" + async_method = getattr(mw, methodname_async, None) + if not async_method: + return normal_method + if not normal_method: + logger.error(f"Middleware {mw.__qualname__} has {methodname_async} " + f"without {methodname}, skipping this method.") + return None + if not isasyncgenfunction(async_method): + logger.error(f"{async_method.__qualname__} is not " + f"an async generator function, skipping this method.") + return normal_method + if isasyncgenfunction(normal_method): + logger.error(f"{normal_method.__qualname__} is an async " + f"generator function while {methodname_async} exists, " + f"skipping both methods.") + return None + return normal_method, async_method diff --git a/scrapy/middleware.py b/scrapy/middleware.py index 2eb1d8609..8d7e5a602 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -1,7 +1,7 @@ import logging import pprint from collections import defaultdict, deque -from typing import Callable, Deque, Dict, Optional, cast, Iterable +from typing import Callable, Deque, Dict, Iterable, Tuple, Union, cast from twisted.internet.defer import Deferred @@ -21,8 +21,9 @@ class MiddlewareManager: def __init__(self, *middlewares): self.middlewares = middlewares - # Optional because process_spider_output and process_spider_exception can be None - self.methods: Dict[str, Deque[Optional[Callable]]] = defaultdict(deque) + # Only process_spider_output and process_spider_exception can be None. + # Only process_spider_output can be a tuple, and only until _async compatibility methods are removed. + self.methods: Dict[str, Deque[Union[None, Callable, Tuple[Callable, Callable]]]] = defaultdict(deque) for mw in middlewares: self._add_middleware(mw) diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 973404b2b..29634c3ad 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -7,7 +7,6 @@ See documentation in docs/topics/spider-middleware.rst import logging from scrapy.http import Request -from scrapy.utils.asyncgen import _process_iterable_universal logger = logging.getLogger(__name__) @@ -29,36 +28,42 @@ class DepthMiddleware: return cls(maxdepth, crawler.stats, verbose, prio) def process_spider_output(self, response, result, spider): - def _filter(request): - if isinstance(request, Request): - depth = response.meta['depth'] + 1 - request.meta['depth'] = depth - if self.prio: - request.priority -= depth * self.prio - if self.maxdepth and depth > self.maxdepth: - logger.debug( - "Ignoring link (depth > %(maxdepth)d): %(requrl)s ", - {'maxdepth': self.maxdepth, 'requrl': request.url}, - extra={'spider': spider} - ) - return False - else: - if self.verbose_stats: - self.stats.inc_value(f'request_depth_count/{depth}', - spider=spider) - self.stats.max_value('request_depth_max', depth, - spider=spider) + # base case (depth=0) + if 'depth' not in response.meta: + response.meta['depth'] = 0 + if self.verbose_stats: + self.stats.inc_value('request_depth_count/0', spider=spider) + + return (r for r in result or () if self._filter(r, response, spider)) + + async def process_spider_output_async(self, response, result, spider): + # base case (depth=0) + if 'depth' not in response.meta: + response.meta['depth'] = 0 + if self.verbose_stats: + self.stats.inc_value('request_depth_count/0', spider=spider) + + async for r in result or (): + if self._filter(r, response, spider): + yield r + + def _filter(self, request, response, spider): + if not isinstance(request, Request): return True - - @_process_iterable_universal - async def process(result): - # base case (depth=0) - if 'depth' not in response.meta: - response.meta['depth'] = 0 - if self.verbose_stats: - self.stats.inc_value('request_depth_count/0', spider=spider) - - async for r in result or (): - if _filter(r): - yield r - return process(result) + depth = response.meta['depth'] + 1 + request.meta['depth'] = depth + if self.prio: + request.priority -= depth * self.prio + if self.maxdepth and depth > self.maxdepth: + logger.debug( + "Ignoring link (depth > %(maxdepth)d): %(requrl)s ", + {'maxdepth': self.maxdepth, 'requrl': request.url}, + extra={'spider': spider} + ) + return False + if self.verbose_stats: + self.stats.inc_value(f'request_depth_count/{depth}', + spider=spider) + self.stats.max_value('request_depth_max', depth, + spider=spider) + return True diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index 074ec7a4e..448bc1367 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -9,7 +9,6 @@ import warnings from scrapy import signals from scrapy.http import Request -from scrapy.utils.asyncgen import _process_iterable_universal from scrapy.utils.httpobj import urlparse_cached logger = logging.getLogger(__name__) @@ -27,24 +26,27 @@ class OffsiteMiddleware: return o def process_spider_output(self, response, result, spider): - @_process_iterable_universal - async def process(result): - async for x in result: - if isinstance(x, Request): - if x.dont_filter or self.should_follow(x, spider): - yield x - else: - domain = urlparse_cached(x).hostname - if domain and domain not in self.domains_seen: - self.domains_seen.add(domain) - logger.debug( - "Filtered offsite request to %(domain)r: %(request)s", - {'domain': domain, 'request': x}, extra={'spider': spider}) - self.stats.inc_value('offsite/domains', spider=spider) - self.stats.inc_value('offsite/filtered', spider=spider) - else: - yield x - return process(result) + return (r for r in result or () if self._filter(r, spider)) + + async def process_spider_output_async(self, response, result, spider): + async for r in result or (): + if self._filter(r, spider): + yield r + + def _filter(self, request, spider) -> bool: + if not isinstance(request, Request): + return True + if request.dont_filter or self.should_follow(request, spider): + return True + domain = urlparse_cached(request).hostname + if domain and domain not in self.domains_seen: + self.domains_seen.add(domain) + logger.debug( + "Filtered offsite request to %(domain)r: %(request)s", + {'domain': domain, 'request': request}, extra={'spider': spider}) + self.stats.inc_value('offsite/domains', spider=spider) + self.stats.inc_value('offsite/filtered', spider=spider) + return False def should_follow(self, request, spider): regex = self.host_regex diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index e0a22592f..8027beb92 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -11,7 +11,6 @@ from w3lib.url import safe_url_string from scrapy import signals from scrapy.exceptions import NotConfigured from scrapy.http import Request, Response -from scrapy.utils.asyncgen import _process_iterable_universal from scrapy.utils.misc import load_object from scrapy.utils.python import to_unicode from scrapy.utils.url import strip_url @@ -334,19 +333,18 @@ class RefererMiddleware: return cls() if cls else self.default_policy() def process_spider_output(self, response, result, spider): - def _set_referer(r): - if isinstance(r, Request): - referrer = self.policy(response, r).referrer(response.url, r.url) - if referrer is not None: - r.headers.setdefault('Referer', referrer) - return r + return (self._set_referer(r, response) for r in result or ()) - @_process_iterable_universal - async def process(result): - async for r in result or (): - yield _set_referer(r) + async def process_spider_output_async(self, response, result, spider): + async for r in result or (): + yield self._set_referer(r, response) - return process(result) + def _set_referer(self, r, response): + if isinstance(r, Request): + referrer = self.policy(response, r).referrer(response.url, r.url) + if referrer is not None: + r.headers.setdefault('Referer', referrer) + return r def request_scheduled(self, request, spider): # check redirected request to patch "Referer" header if necessary diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 63b1d36bd..7ad64d2af 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -8,7 +8,6 @@ import logging from scrapy.http import Request from scrapy.exceptions import NotConfigured -from scrapy.utils.asyncgen import _process_iterable_universal logger = logging.getLogger(__name__) @@ -26,22 +25,20 @@ class UrlLengthMiddleware: return cls(maxlength) def process_spider_output(self, response, result, spider): - def _filter(request): - if isinstance(request, Request) and len(request.url) > self.maxlength: - logger.info( - "Ignoring link (url length > %(maxlength)d): %(url)s ", - {'maxlength': self.maxlength, 'url': request.url}, - extra={'spider': spider} - ) - spider.crawler.stats.inc_value('urllength/request_ignored_count', spider=spider) - return False - else: - return True + return (r for r in result or () if self._filter(r, spider)) - @_process_iterable_universal - async def process(result): - async for r in result or (): - if _filter(r): - yield r + async def process_spider_output_async(self, response, result, spider): + async for r in result or (): + if self._filter(r, spider): + yield r - return process(result) + def _filter(self, request, spider): + if isinstance(request, Request) and len(request.url) > self.maxlength: + logger.info( + "Ignoring link (url length > %(maxlength)d): %(url)s ", + {'maxlength': self.maxlength, 'url': request.url}, + extra={'spider': spider} + ) + spider.crawler.stats.inc_value('urllength/request_ignored_count', spider=spider) + return False + return True diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index ae9a79989..9f794de92 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -1,6 +1,4 @@ -import functools -import inspect -from typing import AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Union +from typing import AsyncGenerator, AsyncIterable, Iterable, Union async def collect_asyncgen(result: AsyncIterable): @@ -18,46 +16,3 @@ async def as_async_generator(it: Union[Iterable, AsyncIterable]) -> AsyncGenerat else: for r in it: yield r - - -# https://stackoverflow.com/a/66170760/113586 -def _process_iterable_universal(process_async: Callable): - """ Takes a function that takes an async iterable, args and kwargs. Returns - a function that takes any iterable, args and kwargs. - - Requires that process_async only awaits on the iterable and synchronous functions, - so it's better to use this only in the Scrapy code itself. - """ - - # If this stops working, all internal uses can be just replaced with manually-written - # process_sync functions. - - def process_sync(iterable: Iterable, *args, **kwargs) -> Generator: - agen = process_async(as_async_generator(iterable), *args, **kwargs) - if not inspect.isasyncgen(agen): - raise ValueError(f"process_async returned wrong type {type(agen)}") - sent = None - while True: - try: - gen = agen.asend(sent) - gen.send(None) - except StopIteration as e: - sent = yield e.value - except StopAsyncIteration: - return - else: - gen.throw(RuntimeError, - f"Synchronously-called function '{process_async.__name__}' has blocked, " - f"you can't use {_process_iterable_universal.__name__} with it.") - - @functools.wraps(process_async) - def process(iterable: Union[Iterable, AsyncIterable], *args, **kwargs) -> Union[Generator, AsyncGenerator]: - if isinstance(iterable, AsyncIterable): - # call process_async directly - return process_async(iterable, *args, **kwargs) - if isinstance(iterable, Iterable): - # convert process_async to process_sync - return process_sync(iterable, *args, **kwargs) - raise TypeError(f"Wrong iterable type {type(iterable)}") - - return process diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index d086347bc..11c089ac2 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -10,7 +10,7 @@ import warnings import weakref from functools import partial, wraps from itertools import chain -from typing import AsyncIterable, Iterable, Union +from typing import AsyncGenerator, AsyncIterable, Iterable, Union from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncgen import as_async_generator @@ -359,7 +359,7 @@ class MutableChain(Iterable): return self.__next__() -async def _async_chain(*iterables: Union[Iterable, AsyncIterable]): +async def _async_chain(*iterables: Union[Iterable, AsyncIterable]) -> AsyncGenerator: for it in iterables: async for o in as_async_generator(it): yield o diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index b0ca2f62e..f9f2b6642 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -1,6 +1,8 @@ import collections.abc +from typing import Optional from unittest import mock +from testfixtures import LogCapture from twisted.internet import defer from twisted.trial.unittest import TestCase from twisted.python.failure import Failure @@ -8,8 +10,8 @@ from twisted.python.failure import Failure from scrapy.spiders import Spider from scrapy.http import Request, Response from scrapy.exceptions import _InvalidOutput -from scrapy.utils.asyncgen import _process_iterable_universal, as_async_generator, collect_asyncgen -from scrapy.utils.defer import deferred_from_coro +from scrapy.utils.asyncgen import collect_asyncgen +from scrapy.utils.defer import deferred_from_coro, maybe_deferred_to_future from scrapy.utils.test import get_crawler from scrapy.core.spidermw import SpiderMiddlewareManager @@ -115,33 +117,40 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): RESULT_COUNT = 3 # to simplify checks, let everything return 3 objects + @staticmethod + def _construct_mw_setting(*mw_classes, start_index: Optional[int] = None): + if start_index is None: + start_index = 10 + return {i: c for c, i in enumerate(mw_classes, start=start_index)} + @defer.inlineCallbacks - def _get_middleware_result(self, *mw_classes): - for mw_cls in mw_classes: - self.mwman._add_middleware(mw_cls()) + def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): + setting = self._construct_mw_setting(*mw_classes, start_index=start_index) + self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}, 'SPIDER_MIDDLEWARES': setting}) + self.spider = self.crawler._create_spider('foo') + self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) return result @defer.inlineCallbacks - def _test_simple_base(self, *mw_classes): - result = yield self._get_middleware_result(*mw_classes) + def _test_simple_base(self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None): + with LogCapture() as log: + result = yield self._get_middleware_result(*mw_classes, start_index=start_index) self.assertIsInstance(result, collections.abc.Iterable) result_list = list(result) self.assertEqual(len(result_list), self.RESULT_COUNT) self.assertIsInstance(result_list[0], self.ITEM_TYPE) + self.assertEqual("downgraded to a non-async" in str(log), downgrade) @defer.inlineCallbacks - def _test_asyncgen_base(self, *mw_classes): - result = yield self._get_middleware_result(*mw_classes) + def _test_asyncgen_base(self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None): + with LogCapture() as log: + result = yield self._get_middleware_result(*mw_classes, start_index=start_index) self.assertIsInstance(result, collections.abc.AsyncIterator) result_list = yield deferred_from_coro(collect_asyncgen(result)) self.assertEqual(len(result_list), self.RESULT_COUNT) self.assertIsInstance(result_list[0], self.ITEM_TYPE) - - @defer.inlineCallbacks - def _test_asyncgen_fail(self, *mw_classes): - with self.assertRaisesRegex(TypeError, "Synchronous .+ called with an async iterable"): - yield self._get_middleware_result(*mw_classes) + self.assertEqual("downgraded to a non-async" in str(log), downgrade) class ProcessSpiderOutputSimpleMiddleware: @@ -152,17 +161,36 @@ class ProcessSpiderOutputSimpleMiddleware: class ProcessSpiderOutputAsyncGenMiddleware: async def process_spider_output(self, response, result, spider): - async for r in as_async_generator(result): + async for r in result: yield r class ProcessSpiderOutputUniversalMiddleware: def process_spider_output(self, response, result, spider): - @_process_iterable_universal - async def process(result): - async for r in result: - yield r - return process(result) + for r in result: + yield r + + async def process_spider_output_async(self, response, result, spider): + async for r in result: + yield r + + +class ProcessSpiderExceptionSimpleIterableMiddleware: + def process_spider_exception(self, response, exception, spider): + yield {'foo': 1} + yield {'foo': 2} + yield {'foo': 3} + + +class ProcessSpiderExceptionAsyncIterableMiddleware: + async def process_spider_exception(self, response, exception, spider): + yield {'foo': 1} + d = defer.Deferred() + from twisted.internet import reactor + reactor.callLater(0, d.callback, None) + await maybe_deferred_to_future(d) + yield {'foo': 2} + yield {'foo': 3} class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): @@ -183,18 +211,19 @@ class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): return self._test_simple_base(self.MW_SIMPLE) def test_asyncgen(self): - """ Asyncgen mw """ + """ Asyncgen mw; upgrade """ return self._test_asyncgen_base(self.MW_ASYNCGEN) def test_simple_asyncgen(self): - """ Simple mw -> asyncgen mw """ + """ Simple mw -> asyncgen mw; upgrade """ return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_SIMPLE) def test_asyncgen_simple(self): - """ Asyncgen mw -> simple mw; cannot work """ - return self._test_asyncgen_fail(self.MW_SIMPLE, - self.MW_ASYNCGEN) + """ Asyncgen mw -> simple mw; upgrade then downgrade """ + return self._test_simple_base(self.MW_SIMPLE, + self.MW_ASYNCGEN, + downgrade=True) def test_universal(self): """ Universal mw """ @@ -211,12 +240,12 @@ class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): self.MW_SIMPLE) def test_universal_asyncgen(self): - """ Universal mw -> asyncgen mw """ + """ Universal mw -> asyncgen mw; upgrade """ return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_UNIVERSAL) def test_asyncgen_universal(self): - """ Asyncgen mw -> universal mw """ + """ Asyncgen mw -> universal mw; upgrade """ return self._test_asyncgen_base(self.MW_UNIVERSAL, self.MW_ASYNCGEN) @@ -229,27 +258,31 @@ class ProcessSpiderOutputAsyncGen(ProcessSpiderOutputSimple): yield item def test_simple(self): - """ Simple mw; cannot work """ - return self._test_asyncgen_fail(self.MW_SIMPLE) + """ Simple mw; downgrade """ + return self._test_simple_base(self.MW_SIMPLE, + downgrade=True) def test_simple_asyncgen(self): - """ Simple mw -> asyncgen mw; cannot work """ - return self._test_asyncgen_fail(self.MW_ASYNCGEN, - self.MW_SIMPLE) + """ Simple mw -> asyncgen mw; downgrade then upgrade """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, + self.MW_SIMPLE, + downgrade=True) def test_universal(self): """ Universal mw """ return self._test_asyncgen_base(self.MW_UNIVERSAL) def test_universal_simple(self): - """ Universal mw -> simple mw; cannot work """ - return self._test_asyncgen_fail(self.MW_SIMPLE, - self.MW_UNIVERSAL) + """ Universal mw -> simple mw; downgrade """ + return self._test_simple_base(self.MW_SIMPLE, + self.MW_UNIVERSAL, + downgrade=True) def test_simple_universal(self): - """ Simple mw -> universal mw; cannot work """ - return self._test_asyncgen_fail(self.MW_UNIVERSAL, - self.MW_SIMPLE) + """ Simple mw -> universal mw; downgrade """ + return self._test_simple_base(self.MW_UNIVERSAL, + self.MW_SIMPLE, + downgrade=True) class ProcessStartRequestsSimpleMiddleware: @@ -269,13 +302,198 @@ class ProcessStartRequestsSimple(BaseAsyncSpiderMiddlewareTestCase): yield Request(f'https://example.com/{i}', dont_filter=True) @defer.inlineCallbacks - def _get_middleware_result(self, *mw_classes): - for mw_cls in mw_classes: - self.mwman._add_middleware(mw_cls()) + def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): + setting = self._construct_mw_setting(*mw_classes, start_index=start_index) + self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}, 'SPIDER_MIDDLEWARES': setting}) + self.spider = self.crawler._create_spider('foo') + self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) start_requests = iter(self._start_requests()) results = yield self.mwman.process_start_requests(start_requests, self.spider) return results def test_simple(self): """ Simple mw """ - self._test_simple_base(self.MW_SIMPLE) + return self._test_simple_base(self.MW_SIMPLE) + + +class UniversalMiddlewareNoSync: + async def process_spider_output_async(self, response, result, spider): + yield + + +class UniversalMiddlewareBothSync: + def process_spider_output(self, response, result, spider): + yield + + def process_spider_output_async(self, response, result, spider): + yield + + +class UniversalMiddlewareBothAsync: + async def process_spider_output(self, response, result, spider): + yield + + async def process_spider_output_async(self, response, result, spider): + yield + + +class UniversalMiddlewareManagerTest(TestCase): + def setUp(self): + self.mwman = SpiderMiddlewareManager() + + def test_simple_mw(self): + mw = ProcessSpiderOutputSimpleMiddleware + self.mwman._add_middleware(mw) + self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + + def test_async_mw(self): + mw = ProcessSpiderOutputAsyncGenMiddleware + self.mwman._add_middleware(mw) + self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + + def test_universal_mw(self): + mw = ProcessSpiderOutputUniversalMiddleware + self.mwman._add_middleware(mw) + self.assertEqual(self.mwman.methods['process_spider_output'][0], + (mw.process_spider_output, mw.process_spider_output_async)) + + def test_universal_mw_no_sync(self): + with LogCapture() as log: + self.mwman._add_middleware(UniversalMiddlewareNoSync) + self.assertIn("UniversalMiddlewareNoSync has process_spider_output_async" + " without process_spider_output", str(log)) + self.assertEqual(self.mwman.methods['process_spider_output'][0], None) + + def test_universal_mw_both_sync(self): + mw = UniversalMiddlewareBothSync + with LogCapture() as log: + self.mwman._add_middleware(mw) + self.assertIn("UniversalMiddlewareBothSync.process_spider_output_async " + "is not an async generator function", str(log)) + self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + + def test_universal_mw_both_async(self): + with LogCapture() as log: + self.mwman._add_middleware(UniversalMiddlewareBothAsync) + self.assertIn("UniversalMiddlewareBothAsync.process_spider_output " + "is an async generator function while process_spider_output_async exists", + str(log)) + self.assertEqual(self.mwman.methods['process_spider_output'][0], None) + + +class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): + ITEM_TYPE = dict + MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware + MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware + MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware + + def _scrape_func(self, *args, **kwargs): + yield {'foo': 1} + yield {'foo': 2} + yield {'foo': 3} + + @defer.inlineCallbacks + def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): + setting = self._construct_mw_setting(*mw_classes, start_index=start_index) + self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES': setting}) + self.spider = self.crawler._create_spider('foo') + self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) + result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) + return result + + def test_just_builtin(self): + return self._test_simple_base() + + def test_builtin_simple(self): + return self._test_simple_base(self.MW_SIMPLE, start_index=1000) + + def test_builtin_async(self): + """ Upgrade """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, start_index=1000) + + def test_builtin_universal(self): + return self._test_simple_base(self.MW_UNIVERSAL, start_index=1000) + + def test_simple_builtin(self): + return self._test_simple_base(self.MW_SIMPLE) + + def test_async_builtin(self): + """ Upgrade """ + return self._test_asyncgen_base(self.MW_ASYNCGEN) + + def test_universal_builtin(self): + return self._test_simple_base(self.MW_UNIVERSAL) + + +class BuiltinMiddlewareAsyncGenTest(BuiltinMiddlewareSimpleTest): + async def _scrape_func(self, *args, **kwargs): + for item in super()._scrape_func(): + yield item + + def test_just_builtin(self): + return self._test_asyncgen_base() + + def test_builtin_simple(self): + """ Downgrade """ + return self._test_simple_base(self.MW_SIMPLE, downgrade=True, start_index=1000) + + def test_builtin_async(self): + return self._test_asyncgen_base(self.MW_ASYNCGEN, start_index=1000) + + def test_builtin_universal(self): + return self._test_asyncgen_base(self.MW_UNIVERSAL, start_index=1000) + + def test_simple_builtin(self): + """ Downgrade """ + return self._test_simple_base(self.MW_SIMPLE, downgrade=True) + + def test_async_builtin(self): + return self._test_asyncgen_base(self.MW_ASYNCGEN) + + def test_universal_builtin(self): + return self._test_asyncgen_base(self.MW_UNIVERSAL) + + +class ProcessSpiderExceptionTest(BaseAsyncSpiderMiddlewareTestCase): + ITEM_TYPE = dict + MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware + MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware + MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware + MW_EXC_SIMPLE = ProcessSpiderExceptionSimpleIterableMiddleware + MW_EXC_ASYNCGEN = ProcessSpiderExceptionAsyncIterableMiddleware + + def _scrape_func(self, *args, **kwargs): + 1 / 0 + + @defer.inlineCallbacks + def _test_asyncgen_nodowngrade(self, *mw_classes): + with self.assertRaisesRegex(_InvalidOutput, "Async iterable returned from .+ cannot be downgraded"): + yield self._get_middleware_result(*mw_classes) + + def test_exc_simple(self): + """ Simple exc mw """ + return self._test_simple_base(self.MW_EXC_SIMPLE) + + def test_exc_async(self): + """ Async exc mw """ + return self._test_asyncgen_base(self.MW_EXC_ASYNCGEN) + + def test_exc_simple_simple(self): + """ Simple exc mw -> simple output mw """ + return self._test_simple_base(self.MW_SIMPLE, + self.MW_EXC_SIMPLE) + + def test_exc_async_async(self): + """ Async exc mw -> async output mw """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, + self.MW_EXC_ASYNCGEN) + + def test_exc_simple_async(self): + """ Simple exc mw -> async output mw; upgrade """ + return self._test_asyncgen_base(self.MW_ASYNCGEN, + self.MW_EXC_SIMPLE) + + def test_exc_async_simple(self): + """ Async exc mw -> simple output mw; cannot work as downgrading is not supported """ + return self._test_asyncgen_nodowngrade(self.MW_SIMPLE, + self.MW_EXC_ASYNCGEN) diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index 088c14ca8..dac246fb6 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -28,6 +28,7 @@ class RecoveryMiddleware: class RecoverySpider(Spider): name = 'RecoverySpider' custom_settings = { + 'SPIDER_MIDDLEWARES_BASE': {}, 'SPIDER_MIDDLEWARES': { RecoveryMiddleware: 10, }, @@ -107,6 +108,13 @@ class GeneratorCallbackSpider(Spider): raise ImportError() +class AsyncGeneratorCallbackSpider(GeneratorCallbackSpider): + async def parse(self, response): + yield {'test': 1} + yield {'test': 2} + raise ImportError() + + # ================================================================================ # (2.1) exceptions from a spider callback (generator, middleware right after callback) class GeneratorCallbackSpiderMiddlewareRightAfterSpider(GeneratorCallbackSpider): @@ -360,6 +368,15 @@ class TestSpiderMiddleware(TestCase): self.assertIn("Middleware: ImportError exception caught", str(log2)) self.assertIn("'item_scraped_count': 2", str(log2)) + @defer.inlineCallbacks + def test_async_generator_callback(self): + """ + Same as test_generator_callback but with an async callback. + """ + log2 = yield self.crawl_log(AsyncGeneratorCallbackSpider) + self.assertIn("Middleware: ImportError exception caught", str(log2)) + self.assertIn("'item_scraped_count': 2", str(log2)) + @defer.inlineCallbacks def test_generator_callback_right_after_callback(self): """ diff --git a/tests/test_utils_asyncgen.py b/tests/test_utils_asyncgen.py index 7abe17c22..9ae66c57c 100644 --- a/tests/test_utils_asyncgen.py +++ b/tests/test_utils_asyncgen.py @@ -1,7 +1,6 @@ -from twisted.internet.defer import Deferred from twisted.trial import unittest -from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen, _process_iterable_universal +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.defer import deferred_f_from_coro_f @@ -19,52 +18,3 @@ class AsyncgenUtilsTest(unittest.TestCase): ag = as_async_generator(range(42)) results = await collect_asyncgen(ag) self.assertEqual(results, list(range(42))) - - -@_process_iterable_universal -async def process_iterable(iterable): - async for i in iterable: - yield i * 2 - - -@_process_iterable_universal -async def process_iterable_awaiting(iterable): - async for i in iterable: - yield i * 2 - d = Deferred() - from twisted.internet import reactor - reactor.callLater(0, d.callback, 42) - await d - - -class ProcessIterableUniversalTest(unittest.TestCase): - - def test_normal(self): - iterable = iter([1, 2, 3]) - results = list(process_iterable(iterable)) - self.assertEqual(results, [2, 4, 6]) - - @deferred_f_from_coro_f - async def test_async(self): - iterable = as_async_generator([1, 2, 3]) - results = await collect_asyncgen(process_iterable(iterable)) - self.assertEqual(results, [2, 4, 6]) - - @deferred_f_from_coro_f - async def test_blocking(self): - iterable = [1, 2, 3] - with self.assertRaisesRegex(RuntimeError, "Synchronously-called function"): - list(process_iterable_awaiting(iterable)) - - def test_invalid_iterable(self): - with self.assertRaisesRegex(TypeError, "Wrong iterable type"): - process_iterable(None) - - @deferred_f_from_coro_f - async def test_invalid_process(self): - @_process_iterable_universal - def process_iterable_invalid(iterable): - pass - - with self.assertRaisesRegex(ValueError, "process_async returned wrong type"): - list(process_iterable_invalid([])) From e079bffdab11402d1936103ba453e43e97925079 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 11 Jan 2022 19:21:07 +0500 Subject: [PATCH 061/532] Disable logging-fstring-interpolation in pylint. --- pylintrc | 1 + 1 file changed, 1 insertion(+) diff --git a/pylintrc b/pylintrc index 2cdd6321e..0d29dc709 100644 --- a/pylintrc +++ b/pylintrc @@ -49,6 +49,7 @@ disable=abstract-method, keyword-arg-before-vararg, line-too-long, logging-format-interpolation, + logging-fstring-interpolation, logging-not-lazy, lost-exception, method-hidden, From 115d35270691176e128bd30f6a2a8bcf1289fe5c Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 11 Feb 2022 01:21:31 +0200 Subject: [PATCH 062/532] per slot settings: setting renamed from `PER_SLOT_SETTINGS` to `DOWNLOAD_SLOTS` --- scrapy/core/downloader/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index d5809ffa0..0e32714a8 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -86,7 +86,7 @@ class Downloader: self.middleware = DownloaderMiddlewareManager.from_crawler(crawler) self._slot_gc_loop = task.LoopingCall(self._slot_gc) self._slot_gc_loop.start(60) - self.per_slot_settings = self.settings.getdict('PER_SLOT_SETTINGS', {}) + self.per_slot_settings = self.settings.getdict('DOWNLOAD_SLOTS', {}) def fetch(self, request, spider): def _deactivate(response): From be97402e46c5e4793e23b713728e1777fbe4d49c Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 11 Feb 2022 01:22:27 +0200 Subject: [PATCH 063/532] per slot settings: log notifications (debug) removed --- scrapy/core/downloader/__init__.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 0e32714a8..53dc546de 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -109,8 +109,6 @@ class Downloader: randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot - logger.debug( - f"Downloader slot '{key}' - created {'(from per slot settings)' if key in self.per_slot_settings.keys() else ''}: {new_slot}") return key, self.slots[key] @@ -209,5 +207,3 @@ class Downloader: if not slot.active and slot.lastseen + slot.delay < mintime: inactive_slot = self.slots.pop(key) inactive_slot.close() - logger.debug( - f"Downloader slot '{key}' - closed {'(from per slot settings)' if key in self.per_slot_settings.keys() else ''} : {inactive_slot}") From 3ecbea4b876ed084f30bb4063e1993dd9c3cdb8a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 2 Mar 2022 16:06:49 +0100 Subject: [PATCH 064/532] CrawlerProcess: initiate the reactor only once --- scrapy/crawler.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/scrapy/crawler.py b/scrapy/crawler.py index a638254f1..9939a19eb 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -290,6 +290,7 @@ class CrawlerProcess(CrawlerRunner): super().__init__(settings) configure_logging(self.settings, install_root_handler) log_scrapy_info(self.settings) + self._initiated_reactor = False def _signal_shutdown(self, signum, _): from twisted.internet import reactor @@ -310,7 +311,9 @@ class CrawlerProcess(CrawlerRunner): def _create_crawler(self, spidercls): if isinstance(spidercls, str): spidercls = self.spider_loader.load(spidercls) - return Crawler(spidercls, self.settings, init_reactor=True) + init_reactor = not self._initiated_reactor + self._initiated_reactor = True + return Crawler(spidercls, self.settings, init_reactor=init_reactor) def start(self, stop_after_crawl=True, install_signal_handlers=True): """ From 96fc4dae15181695c58040389fa502857a2b0df8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 2 Mar 2022 16:14:39 +0100 Subject: [PATCH 065/532] CrawlerProcess: test a multi-spider scenario --- tests/CrawlerProcess/multi.py | 16 ++++++++++++++++ tests/test_crawler.py | 6 ++++++ 2 files changed, 22 insertions(+) create mode 100644 tests/CrawlerProcess/multi.py diff --git a/tests/CrawlerProcess/multi.py b/tests/CrawlerProcess/multi.py new file mode 100644 index 000000000..aaa1af5c5 --- /dev/null +++ b/tests/CrawlerProcess/multi.py @@ -0,0 +1,16 @@ +import scrapy +from scrapy.crawler import CrawlerProcess + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={}) + +process.crawl(NoRequestsSpider) +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 8f6227109..957525382 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -302,6 +302,12 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): self.assertIn('Spider closed (finished)', log) self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + def test_multi(self): + log = self.run_script('multi.py') + self.assertIn('Spider closed (finished)', log) + self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertNotIn("ReactorAlreadyInstalledError", log) + def test_asyncio_enabled_no_reactor(self): log = self.run_script('asyncio_enabled_no_reactor.py') self.assertIn('Spider closed (finished)', log) From 3bf6baeaa705ddc2d3417206f3db816dabadf5a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 2 Mar 2022 17:03:41 +0100 Subject: [PATCH 066/532] =?UTF-8?q?initiated=20=E2=86=92=20initialized?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/crawler.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scrapy/crawler.py b/scrapy/crawler.py index 9939a19eb..d669d93a8 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -290,7 +290,7 @@ class CrawlerProcess(CrawlerRunner): super().__init__(settings) configure_logging(self.settings, install_root_handler) log_scrapy_info(self.settings) - self._initiated_reactor = False + self._initialized_reactor = False def _signal_shutdown(self, signum, _): from twisted.internet import reactor @@ -311,8 +311,8 @@ class CrawlerProcess(CrawlerRunner): def _create_crawler(self, spidercls): if isinstance(spidercls, str): spidercls = self.spider_loader.load(spidercls) - init_reactor = not self._initiated_reactor - self._initiated_reactor = True + init_reactor = not self._initialized_reactor + self._initialized_reactor = True return Crawler(spidercls, self.settings, init_reactor=init_reactor) def start(self, stop_after_crawl=True, install_signal_handlers=True): From 62a00812669aa0906aa0d4e9a4c2e87be3b74975 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 7 Mar 2022 12:00:44 +0100 Subject: [PATCH 067/532] engine: prevent slot method call after unsetting the slot --- scrapy/core/engine.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index f9de7ee23..6602f661d 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -136,7 +136,9 @@ class ExecutionEngine: self.paused = False def _next_request(self) -> None: - assert self.slot is not None # typing + if self.slot is None: + return + assert self.spider is not None # typing if self.paused: @@ -184,7 +186,8 @@ class ExecutionEngine: d.addErrback(lambda f: logger.info('Error while removing request from slot', exc_info=failure_to_exc_info(f), extra={'spider': self.spider})) - d.addBoth(lambda _: self.slot.nextcall.schedule()) + slot = self.slot + d.addBoth(lambda _: slot.nextcall.schedule()) d.addErrback(lambda f: logger.info('Error while scheduling new request', exc_info=failure_to_exc_info(f), extra={'spider': self.spider})) From c1d4be8cb5ed610fef4a2af60f9b654faab7a243 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Tue, 15 Mar 2022 07:30:30 -0300 Subject: [PATCH 068/532] =?UTF-8?q?Restore=20=E2=80=98-o=20-=E2=80=99=20su?= =?UTF-8?q?pport=20(#5445)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/cmdline.py | 17 +++++++++++++---- tests/test_commands.py | 15 +++++++++++++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 491c4beab..5ee1f0f44 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -14,6 +14,15 @@ from scrapy.utils.project import inside_project, get_project_settings from scrapy.utils.python import garbage_collect +class ScrapyArgumentParser(argparse.ArgumentParser): + def _parse_optional(self, arg_string): + # if starts with -: it means that is a parameter not a argument + if arg_string[:2] == '-:': + return None + + return super()._parse_optional(arg_string) + + def _iter_command_classes(module_name): # TODO: add `name` attribute to commands and and merge this function with # scrapy.utils.spider.iter_spider_classes @@ -131,10 +140,10 @@ def execute(argv=None, settings=None): sys.exit(2) cmd = cmds[cmdname] - parser = argparse.ArgumentParser(formatter_class=ScrapyHelpFormatter, - usage=f"scrapy {cmdname} {cmd.syntax()}", - conflict_handler='resolve', - description=cmd.long_desc()) + parser = ScrapyArgumentParser(formatter_class=ScrapyHelpFormatter, + usage=f"scrapy {cmdname} {cmd.syntax()}", + conflict_handler='resolve', + description=cmd.long_desc()) settings.setdict(cmd.default_settings, priority='command') cmd.settings = settings cmd.add_options(parser) diff --git a/tests/test_commands.py b/tests/test_commands.py index 7cd19b29a..b5e6c2b8b 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -770,6 +770,21 @@ class MySpider(scrapy.Spider): log = self.get_log(spider_code, args=args) self.assertIn("error: Please use only one of -o/--output and -O/--overwrite-output", log) + def test_output_stdout(self): + spider_code = """ +import scrapy + +class MySpider(scrapy.Spider): + name = 'myspider' + + def start_requests(self): + self.logger.debug('FEEDS: {}'.format(self.settings.getdict('FEEDS'))) + return [] +""" + args = ['-o', '-:json'] + log = self.get_log(spider_code, args=args) + self.assertIn("[myspider] DEBUG: FEEDS: {'stdout:': {'format': 'json'}}", log) + @skipIf(platform.system() != 'Windows', "Windows required for .pyw files") class WindowsRunSpiderCommandTest(RunSpiderCommandTest): From b59a69be1790f138afe89df3dfed17ac48384d8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 15 Mar 2022 12:10:41 +0100 Subject: [PATCH 069/532] Test that a low CLOSEPIDER_TIMEOUT does not raise an exception --- tests/test_engine.py | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/tests/test_engine.py b/tests/test_engine.py index fa7d0c8d4..b8fd341f6 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -12,9 +12,11 @@ module with the ``runserver`` argument:: import os import re +import subprocess import sys import warnings from collections import defaultdict +from threading import Timer from urllib.parse import urlparse import attr @@ -502,6 +504,37 @@ class EngineTest(unittest.TestCase): self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) self.assertEqual(str(warning_list[0].message), "ExecutionEngine.has_capacity is deprecated") + def test_short_timeout(self): + args = ( + sys.executable, + '-m', + 'scrapy.cmdline', + 'fetch', + '-s', + 'CLOSESPIDER_TIMEOUT=0.001', + '-s', + 'LOG_LEVEL=DEBUG', + 'http://toscrape.com', + ) + p = subprocess.Popen( + args, + stderr=subprocess.PIPE, + ) + + def kill_proc(): + p.kill() + p.communicate() + assert False, 'Command took too much time to complete' + + timer = Timer(15, kill_proc) + try: + timer.start() + _, stderr = p.communicate() + finally: + timer.cancel() + + self.assertNotIn(b'Traceback', stderr) + if __name__ == "__main__": if len(sys.argv) > 1 and sys.argv[1] == 'runserver': From 78ba4b033b016be7fbb22bfa9e6d5d389380e6d4 Mon Sep 17 00:00:00 2001 From: Yann Defretin Date: Wed, 16 Mar 2022 15:14:24 +0100 Subject: [PATCH 070/532] fixed detection of extension like ".tar.gz" in URL --- scrapy/utils/url.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index a6a2a9e8b..bae5a9433 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -5,7 +5,6 @@ library. Some of the functions that used to be imported from this module have been moved to the w3lib.url module. Always import those from there instead. """ -import posixpath import re from urllib.parse import ParseResult, urldefrag, urlparse, urlunparse @@ -31,8 +30,8 @@ def url_is_from_spider(url, spider): def url_has_any_extension(url, extensions): - return posixpath.splitext(parse_url(url).path)[1].lower() in extensions - + """Return True if the url ends with one of the extensions provided""" + return any(parse_url(url).path.lower().endswith(ext) for ext in extensions) def parse_url(url, encoding=None): """Return urlparsed url from the given argument (which could be an already From fd08bb6cd99f16c9ce433583d4698801dc7e0ac3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 16 Mar 2022 14:34:57 +0100 Subject: [PATCH 071/532] Refactor the asynchronous process_spider_output documentation --- docs/topics/coroutines.rst | 157 +++++++++++++++++------------- docs/topics/spider-middleware.rst | 22 +++-- 2 files changed, 102 insertions(+), 77 deletions(-) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 073b6bd9a..361cd5e60 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -17,9 +17,12 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :class:`~scrapy.Request` callbacks. + If you are using any custom or third-party :ref:`spider middleware + `, see :ref:`sync-async-spider-middleware`. + .. versionchanged:: VERSION - Output of async callbacks is now processed asynchronously instead of collecting - all of it first. + Output of async callbacks is now processed asynchronously instead of + collecting all of it first. - The :meth:`process_item` method of :ref:`item pipelines `. @@ -34,18 +37,26 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): - :ref:`Signal handlers that support deferreds `. -- The :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` - method of :ref:`spider middlewares `. See - :ref:`async-spider-middlewares`. +- The + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` + method of :ref:`spider middlewares `. + + It must be defined as an :term:`asynchronous generator`. The input + ``result`` parameter is an :term:`asynchronous iterable`. + + See also :ref:`sync-async-spider-middleware` and + :ref:`universal-spider-middleware`. .. versionadded:: VERSION -Usage -===== +General usage +============= -There are several use cases for coroutines in Scrapy. Code that would -return Deferreds when written for previous Scrapy versions, such as downloader -middlewares and signal handlers, can be rewritten to be shorter and cleaner:: +There are several use cases for coroutines in Scrapy. + +Code that would return Deferreds when written for previous Scrapy versions, +such as downloader middlewares and signal handlers, can be rewritten to be +shorter and cleaner:: from itemadapter import ItemAdapter @@ -110,46 +121,73 @@ Common use cases for asynchronous code include: .. _aio-libs: https://github.com/aio-libs -.. _async-spider-middlewares: -Asynchronous spider middlewares -=============================== +.. _sync-async-spider-middleware: + +Mixing synchronous and asynchronous spider middlewares +====================================================== .. versionadded:: VERSION -.. note:: This currently applies to - :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output`. - In the future it will also apply to - :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_start_requests`. -Middleware methods discussed here can take and return async iterables. They can -return the same type of iterable or they can take a normal one and return an -async one. If such method needs to return an async iterable it must be an async -generator, not just a coroutine that returns an iterable. +The output of a :class:`~scrapy.Request` callback is passed as the ``result`` +parameter to the +:meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` method +of the first :ref:`spider middleware ` from the +:ref:`list of active spider middlewares `. +Then the output of that ``process_spider_output`` method is passed to the +``process_spider_output`` method of the next spider middleware, and so on for +every active spider middleware. -As the result of a middleware method is passed to the same method of the next -middleware, it needs to be adapted if the second method expects a different -type. Scrapy will do this transparently: +Scrapy supports mixing :ref:`coroutine methods ` and synchronous methods +in this chain of calls. -* A normal iterable is wrapped into an async one which shouldn't cause any side - effects. -* An async iterable is downgraded to a normal one by waiting until all results - are available and wrapping them in a normal iterable. This is problematic - because it pauses the normal middleware processing for this iterable and - because all results can be skipped if exceptions are raised during - processing. This case emits a warning and will be deprecated and then removed - in a later Scrapy version. -* Async iterables returned from - :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_exception` - won't be downgraded, an exception will be raised if that is needed. +However, if any of the ``process_spider_output`` methods is defined as a +synchronous method, and the previous ``Request`` callback or +``process_spider_output`` method is a coroutine, there are some drawbacks to +the asynchronous-to-synchronous conversion that Scrapy does so that the +synchronous ``process_spider_output`` method gets a synchronous iterable as its +``result`` parameter: -As downgrading is undesirable, here is the proposed way to avoid it. If all -middlewares, including 3rd-party ones, support async iterables as input, no -downgrading will happen. But removing normal iterable support (making the -method a coroutine) from a middleware published as a separate project or used -internally in projects for older Scrapy versions breaks backwards -compatibility. So, as an interim measure (it will be deprecated and then -removed in a later Scrapy version), a middleware can provide both sync and -async methods in the following form:: +- The whole output of the previous ``Request`` callback or + ``process_spider_output`` method is awaited at this point. + +- If an exception raises while awaiting the output of the previous + ``Request`` callback or ``process_spider_output`` method, none of that + output will be processed. + +Asynchronous-to-synchronous conversions are supported for backward +compatibility, but they are deprecated and will stop working in a future +version of Scrapy. + +To avoid asynchronous-to-synchronous conversion, when defining ``Request`` +callbacks as coroutine methods or when using spider middlewares whose +``process_spider_output`` method is an :term:`asynchronous generator`, all +active spider middlewares must either have their ``process_spider_output`` +method defined as an asynchronous generator or :ref:`define a +process_spider_output_async method `. + +.. note:: When using third-party spider middlewares that only define a + synchronous ``process_spider_output`` method, consider + :ref:`making them universal ` through + :ref:`subclassing `. + + +.. _universal-spider-middleware: + +Universal spider middleware +=========================== + +.. versionadded:: VERSION + +To allow writing a spider middleware that supports asynchronous execution of +its ``process_spider_output`` method in Scrapy VERSION and later (avoiding +:ref:`asynchronous-to-synchronous conversions `) +while maintaining support for older Scrapy versions, you may define +``process_spider_output`` as a synchronous method and define an +:term:`asynchronous generator` version of that method with an alternative name: +``process_spider_output_async``. + +For example:: class UniversalSpiderMiddleware: def process_spider_output(self, response, result, spider): @@ -162,28 +200,13 @@ async methods in the following form:: # ... do something with r yield r -In this case normal and async iterables will be passed to the respective -methods without any wrapping or downgrading, and in older versions of Scrapy -the coroutine method will just be ignored. When the backwards compatibility is -no longer needed the non-coroutine method can be dropped and the coroutine one -renamed to the normal name. It may be possible to extract common code from both -methods to reduce code duplication, as in the simplest case the only difference -between them will be ``for`` vs ``async for``. +.. note:: This is an interim measure to allow, for a time, to write code that + works in Scrapy VERSION and later without requiring + asynchronous-to-synchronous conversions, and works in earlier Scrapy + versions as well. -So, to recap: - -* If you don't intend to use async callbacks or middlewares containing async - code in your project, nothing should change for you yet. At some point in the - future some of the 3rd-party middlewares you use may drop backwards - compatibility, which shouldn't lead to immediate problems but may be a sign - to start converting your code to ``async def`` too. -* If you maintain a middleware that can be used with projects you can't control - (e.g. one you published for other people to use, or one that needs to support - some old project that can't be modernized), we recommend adding a - ``process_spider_output_async`` method so that the amount of unnecessary - iterable conversions is reduced but no compatibility is broken. -* If you use async callbacks, try to make sure all middlewares support them. - Note that you can modernize 3rd-party middlewares by subclassing them. -* If you want to write and publish a middleware that requires async code, you - should write in the docs that the minimum support Scrapy version is VERSION - (maybe even check this at the run time, using :attr:`scrapy.__version__`). + In some future version of Scrapy, however, this feature will be + deprecated and, eventually, in a later version of Scrapy, this + feature will be removed, and all spider middlewares will be expected + to define their ``process_spider_output`` method as an asynchronous + generator. diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index edfc2e4bb..787545ed2 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -98,10 +98,6 @@ object gives you access, for example, to the :ref:`settings `. .. method:: process_spider_output(response, result, spider) - .. versionchanged:: VERSION - Since VERSION this can take and return an :term:`python:asynchronous - iterable`. - This method is called with the results returned from the Spider, after it has processed the response. @@ -109,8 +105,15 @@ object gives you access, for example, to the :ref:`settings `. :class:`~scrapy.Request` objects and :ref:`item objects `. - .. note:: When defined as a :ref:`coroutine `, this method needs - to be an async generator, not just return an iterable. + .. versionchanged:: VERSION + This method may be defined as an :term:`asynchronous generator`, in + which case ``result`` is an :term:`asynchronous iterable`. + + Consider defining this method as an :term:`asynchronous generator`, + which will be a requirement in a future version of Scrapy. However, if + you wish your spider middleware to work with Scrapy versions earlier + than Scrapy VERSION, :ref:`make your spider middleware universal + ` instead. :param response: the response which generated this output from the spider @@ -127,10 +130,9 @@ object gives you access, for example, to the :ref:`settings `. .. versionadded:: VERSION - If exists, this methid will be called instead of - :meth:`process_spider_output` when ``result`` is an async iterable. - If this method exists, it must be a coroutine while - :meth:`process_spider_output` must not be a coroutine. + If defined, this method must be an :term:`asynchronous generator`, + which will be called instead of :meth:`process_spider_output` if + ``result`` is an :term:`asynchronous iterable`. .. method:: process_spider_exception(response, exception, spider) From c961438d5d9998344460d930ea502fae40553043 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 16 Mar 2022 18:45:56 +0100 Subject: [PATCH 072/532] tests: cover scenarios of bad results from process_spider_output --- scrapy/core/spidermw.py | 19 ++++++++---- tests/test_spidermiddleware.py | 54 +++++++++++++++++++++++++++------- 2 files changed, 58 insertions(+), 15 deletions(-) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 6075670b0..1aa02f29f 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -4,7 +4,7 @@ Spider Middleware manager See documentation in docs/topics/spider-middleware.rst """ import logging -from inspect import isasyncgenfunction +from inspect import isasyncgenfunction, iscoroutine from itertools import islice from typing import Any, AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Tuple, Union, cast @@ -61,7 +61,7 @@ class SpiderMiddlewareManager(MiddlewareManager): try: result = method(response=response, spider=spider) if result is not None: - msg = (f"Middleware {method.__qualname__} must return None " + msg = (f"{method.__qualname__} must return None " f"or raise an exception, got {type(result)}") raise _InvalidOutput(msg) except _InvalidOutput: @@ -129,7 +129,7 @@ class SpiderMiddlewareManager(MiddlewareManager): elif result is None: continue else: - msg = (f"Middleware {method.__qualname__} must return None " + msg = (f"{method.__qualname__} must return None " f"or an iterable, got {type(result)}") raise _InvalidOutput(msg) return _failure @@ -197,8 +197,17 @@ class SpiderMiddlewareManager(MiddlewareManager): if _isiterable(result): result = self._evaluate_iterable(response, spider, result, method_index + 1, recovered) else: - msg = (f"Middleware {method.__qualname__} must return an " - f"iterable, got {type(result)}") + if iscoroutine(result): + result.close() # Silence warning about not awaiting + msg = ( + f"{method.__qualname__} must be an asynchronous " + f"generator (i.e. use yield)" + ) + else: + msg = ( + f"{method.__qualname__} must return an iterable, got " + f"{type(result)}" + ) raise _InvalidOutput(msg) last_result_is_async = isinstance(result, AsyncIterable) diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index f9f2b6642..ed0912b82 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -123,6 +123,11 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): start_index = 10 return {i: c for c, i in enumerate(mw_classes, start=start_index)} + def _scrape_func(self, *args, **kwargs): + yield {'foo': 1} + yield {'foo': 2} + yield {'foo': 3} + @defer.inlineCallbacks def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): setting = self._construct_mw_setting(*mw_classes, start_index=start_index) @@ -201,11 +206,6 @@ class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware - def _scrape_func(self, *args, **kwargs): - yield {'foo': 1} - yield {'foo': 2} - yield {'foo': 3} - def test_simple(self): """ Simple mw """ return self._test_simple_base(self.MW_SIMPLE) @@ -285,6 +285,45 @@ class ProcessSpiderOutputAsyncGen(ProcessSpiderOutputSimple): downgrade=True) +class ProcessSpiderOutputNonIterableMiddleware: + def process_spider_output(self, response, result, spider): + return + + +class ProcessSpiderOutputCoroutineMiddleware: + async def process_spider_output(self, response, result, spider): + results = [] + for r in result: + results.append(r) + return results + + +class ProcessSpiderOutputInvalidResult(BaseAsyncSpiderMiddlewareTestCase): + + @defer.inlineCallbacks + def test_non_iterable(self): + with self.assertRaisesRegex( + _InvalidOutput, + ( + "\.process_spider_output must return an iterable, got " + ), + ): + yield self._get_middleware_result( + ProcessSpiderOutputNonIterableMiddleware, + ) + + @defer.inlineCallbacks + def test_coroutine(self): + with self.assertRaisesRegex( + _InvalidOutput, + "\.process_spider_output must be an asynchronous generator", + ): + yield self._get_middleware_result( + ProcessSpiderOutputCoroutineMiddleware, + ) + + class ProcessStartRequestsSimpleMiddleware: def process_start_requests(self, start_requests, spider): for r in start_requests: @@ -387,11 +426,6 @@ class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): MW_ASYNCGEN = ProcessSpiderOutputAsyncGenMiddleware MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware - def _scrape_func(self, *args, **kwargs): - yield {'foo': 1} - yield {'foo': 2} - yield {'foo': 3} - @defer.inlineCallbacks def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): setting = self._construct_mw_setting(*mw_classes, start_index=start_index) From b78e6915c6b259b31d3c37cae1529e85e797c964 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 16 Mar 2022 20:17:25 +0100 Subject: [PATCH 073/532] Clarify that without async-to-sync conversions items yielded before an exception are processed --- docs/topics/coroutines.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 361cd5e60..efc4566a0 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -155,6 +155,9 @@ synchronous ``process_spider_output`` method gets a synchronous iterable as its ``Request`` callback or ``process_spider_output`` method, none of that output will be processed. + This contrasts with the regular behavior, where all items yielded before + an exception raises are processed. + Asynchronous-to-synchronous conversions are supported for backward compatibility, but they are deprecated and will stop working in a future version of Scrapy. From 5b4b8b6fb12874d4a0a11c261341639c9af95b10 Mon Sep 17 00:00:00 2001 From: Yann Defretin Date: Wed, 16 Mar 2022 22:32:05 +0100 Subject: [PATCH 074/532] added test for new url_has_any_extension function --- tests/test_utils_url.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/tests/test_utils_url.py b/tests/test_utils_url.py index 144c7bd76..58e2be622 100644 --- a/tests/test_utils_url.py +++ b/tests/test_utils_url.py @@ -1,6 +1,8 @@ import unittest +from scrapy.linkextractors import IGNORED_EXTENSIONS from scrapy.spiders import Spider +from scrapy.utils.misc import arg_to_iter from scrapy.utils.url import ( add_http_if_no_scheme, guess_scheme, @@ -8,9 +10,9 @@ from scrapy.utils.url import ( strip_url, url_is_from_any_domain, url_is_from_spider, + url_has_any_extension, ) - __doctests__ = ['scrapy.utils.url'] @@ -81,6 +83,15 @@ class UrlUtilsTest(unittest.TestCase): self.assertTrue(url_is_from_spider('http://www.example.net/some/page.html', MySpider)) self.assertFalse(url_is_from_spider('http://www.example.us/some/page.html', MySpider)) + def test_url_has_any_extension(self): + deny_extensions = {'.' + e for e in arg_to_iter(IGNORED_EXTENSIONS)} + self.assertTrue(url_has_any_extension("http://www.example.com/archive.tar.gz", deny_extensions)) + self.assertTrue(url_has_any_extension("http://www.example.com/page.doc", deny_extensions)) + self.assertTrue(url_has_any_extension("http://www.example.com/page.pdf", deny_extensions)) + self.assertFalse(url_has_any_extension("http://www.example.com/page.htm", deny_extensions)) + self.assertFalse(url_has_any_extension("http://www.example.com/", deny_extensions)) + self.assertFalse(url_has_any_extension("http://www.example.com/page.doc.html", deny_extensions)) + class AddHttpIfNoScheme(unittest.TestCase): From 0905d42e33871e976760d880316210d4953cd5df Mon Sep 17 00:00:00 2001 From: Yann Defretin Date: Thu, 17 Mar 2022 11:19:09 +0100 Subject: [PATCH 075/532] refactored url_has_any_extension function MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- scrapy/utils/url.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index bae5a9433..4d5e9ae82 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -31,7 +31,8 @@ def url_is_from_spider(url, spider): def url_has_any_extension(url, extensions): """Return True if the url ends with one of the extensions provided""" - return any(parse_url(url).path.lower().endswith(ext) for ext in extensions) + lowercase_path = parse_url(url).path.lower() + return any(lowercase_path.endswith(ext) for ext in extensions) def parse_url(url, encoding=None): """Return urlparsed url from the given argument (which could be an already From 6a3f2ee6876145bd4bd9ee1ff89d94474a1e85a0 Mon Sep 17 00:00:00 2001 From: FJMonteroInformatica Date: Thu, 17 Mar 2022 20:09:56 +0100 Subject: [PATCH 076/532] HTML Conventions --- docs/_static/selectors-sample1.html | 31 +++++++------- .../link_extractor/linkextractor.html | 40 ++++++++++--------- .../link_extractor/linkextractor_latin1.html | 8 ++-- .../link_extractor/linkextractor_no_href.html | 3 +- .../link_extractor/linkextractor_noenc.html | 23 ++++++----- tests/sample_data/test_site/index.html | 31 +++++++------- tests/sample_data/test_site/item1.html | 27 ++++++------- tests/sample_data/test_site/item2.html | 29 ++++++-------- 8 files changed, 96 insertions(+), 96 deletions(-) diff --git a/docs/_static/selectors-sample1.html b/docs/_static/selectors-sample1.html index 8a79a3381..915718832 100644 --- a/docs/_static/selectors-sample1.html +++ b/docs/_static/selectors-sample1.html @@ -1,16 +1,17 @@ - - - - Example website - - - - - + + + + + Example website + + + + + \ No newline at end of file diff --git a/tests/sample_data/link_extractor/linkextractor.html b/tests/sample_data/link_extractor/linkextractor.html index 2307ea865..e3a2a4145 100644 --- a/tests/sample_data/link_extractor/linkextractor.html +++ b/tests/sample_data/link_extractor/linkextractor.html @@ -1,20 +1,22 @@ + + - - -Sample page with links for testing LinkExtractor - - - - - + + + Sample page with links for testing LinkExtractor + + + + + \ No newline at end of file diff --git a/tests/sample_data/link_extractor/linkextractor_latin1.html b/tests/sample_data/link_extractor/linkextractor_latin1.html index e7eee18de..1e05bf0f0 100644 --- a/tests/sample_data/link_extractor/linkextractor_latin1.html +++ b/tests/sample_data/link_extractor/linkextractor_latin1.html @@ -1,3 +1,5 @@ + + @@ -7,11 +9,11 @@ diff --git a/tests/sample_data/link_extractor/linkextractor_no_href.html b/tests/sample_data/link_extractor/linkextractor_no_href.html index 0b01cede8..2d67ec6ff 100644 --- a/tests/sample_data/link_extractor/linkextractor_no_href.html +++ b/tests/sample_data/link_extractor/linkextractor_no_href.html @@ -1,3 +1,5 @@ + + @@ -21,5 +23,4 @@ - \ No newline at end of file diff --git a/tests/sample_data/link_extractor/linkextractor_noenc.html b/tests/sample_data/link_extractor/linkextractor_noenc.html index f9166adbe..6fa137cd9 100644 --- a/tests/sample_data/link_extractor/linkextractor_noenc.html +++ b/tests/sample_data/link_extractor/linkextractor_noenc.html @@ -1,14 +1,17 @@ + + - - -Sample page without encoding for testing LinkExtractor - + + + Sample page without encoding for testing LinkExtractor + + -
-
- -
-sample € text -
+
+
+ sample2 +
+ sample € text +
diff --git a/tests/sample_data/test_site/index.html b/tests/sample_data/test_site/index.html index d268c846a..afe17d8e2 100644 --- a/tests/sample_data/test_site/index.html +++ b/tests/sample_data/test_site/index.html @@ -1,18 +1,15 @@ + + - - -Scrapy test site - - - - -

Scrapy test site

- - - - - + + Scrapy test site + + +

Scrapy test site

+ + + \ No newline at end of file diff --git a/tests/sample_data/test_site/item1.html b/tests/sample_data/test_site/item1.html index ceeb6dc87..ee39f16f3 100644 --- a/tests/sample_data/test_site/item1.html +++ b/tests/sample_data/test_site/item1.html @@ -1,17 +1,14 @@ + + - - -Item 1 - Scrapy test site - - - - -

Item 1 name

- -
    -
  • Price: $100
    • -
  • Stock: 12
    • -
- - + + Item 1 - Scrapy test site + + +

Item 1 name

+
    +
  • Price: $100
    • +
  • Stock: 12
    • +
+ diff --git a/tests/sample_data/test_site/item2.html b/tests/sample_data/test_site/item2.html index a64c92810..f40f70750 100644 --- a/tests/sample_data/test_site/item2.html +++ b/tests/sample_data/test_site/item2.html @@ -1,17 +1,14 @@ + + - - -Item 2 - Scrapy test site - - - - -

Item 2 name

- -
    -
  • Price: $200
    • -
  • Stock: 5
    • -
- - - + + Item 2 - Scrapy test site + + +

Item 2 name

+
    +
  • Price: $200
    • +
  • Stock: 5
    • +
+ + \ No newline at end of file From b95c634b861bacc2b2ee3beeb5fcf64ab8607eea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 17 Mar 2022 22:23:25 +0100 Subject: [PATCH 077/532] Document how to enforce Scrapy versions on Scrapy components --- docs/index.rst | 13 +++-- docs/topics/asyncio.rst | 24 +++++++++ docs/topics/components.rst | 84 +++++++++++++++++++++++++++++++ docs/topics/coroutines.rst | 6 +-- docs/topics/spider-middleware.rst | 8 +-- 5 files changed, 125 insertions(+), 10 deletions(-) create mode 100644 docs/topics/components.rst diff --git a/docs/index.rst b/docs/index.rst index 75e08f537..6e22db884 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -229,10 +229,11 @@ Extending Scrapy topics/downloader-middleware topics/spider-middleware topics/extensions - topics/api topics/signals topics/scheduler topics/exporters + topics/components + topics/api :doc:`topics/architecture` @@ -247,9 +248,6 @@ Extending Scrapy :doc:`topics/extensions` Extend Scrapy with your custom functionality -:doc:`topics/api` - Use it on extensions and middlewares to extend Scrapy functionality - :doc:`topics/signals` See all available signals and how to work with them. @@ -259,6 +257,13 @@ Extending Scrapy :doc:`topics/exporters` Quickly export your scraped items to a file (XML, CSV, etc). +:doc:`topics/components` + Learn the common API and some good practices when building custom Scrapy + components. + +:doc:`topics/api` + Use it on extensions and middlewares to extend Scrapy functionality + All the rest ============ diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 3a6941a2c..dbee7146d 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -96,3 +96,27 @@ Futures. Scrapy provides two helpers for this: down to Scrapy 2.0 (earlier versions do not support :mod:`asyncio`), you can copy the implementation of these functions into your own code. + + +.. _enforce-asyncio-requirement: + +Enforcing asyncio as a requirement +================================== + +If you are writing a :ref:`component ` that requires asyncio +to work, use :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` to +:ref:`enforce it as a requirement `. For +example:: + + from scrapy.utils.reactor import is_asyncio_reactor_installed + + class MyComponent: + + def __init__(self): + if not is_asyncio_reactor_installed(): + raise ValueError( + f"{MyComponent.__qualname__} requires the asyncio Twisted " + f"reactor. Make sure you have it configured in the " + f"TWISTED_REACTOR setting. See the asyncio documentation " + f"of Scrapy for more information." + ) diff --git a/docs/topics/components.rst b/docs/topics/components.rst new file mode 100644 index 000000000..1fff2d61a --- /dev/null +++ b/docs/topics/components.rst @@ -0,0 +1,84 @@ +.. _topics-components: + +========== +Components +========== + +A Scrapy component is any class whose objects are created using +:func:`scrapy.utils.misc.create_instance`. + +That includes the classes that you may assign to the following settings: + +- :setting:`DNS_RESOLVER` + +- :setting:`DOWNLOAD_HANDLERS` + +- :setting:`DOWNLOADER_CLIENTCONTEXTFACTORY` + +- :setting:`DOWNLOADER_MIDDLEWARES` + +- :setting:`DUPEFILTER_CLASS` + +- :setting:`EXTENSIONS` + +- :setting:`FEED_EXPORTERS` + +- :setting:`FEED_STORAGES` + +- :setting:`ITEM_PIPELINES` + +- :setting:`SCHEDULER` + +- :setting:`SCHEDULER_DISK_QUEUE` + +- :setting:`SCHEDULER_MEMORY_QUEUE` + +- :setting:`SCHEDULER_PRIORITY_QUEUE` + +- :setting:`SPIDER_MIDDLEWARES` + +Third-party Scrapy components may also let you define additional Scrapy +components, usually configurable through :ref:`settings `, to +modify their behavior. + +.. _enforce-component-requirements: + +Enforcing component requirements +================================ + +Sometimes, your components may only be intended to work under certain +conditions. For example, the may require a minimum version of Scrapy to work as +intended, or they may require certain settings to have specific values. + +In addition to describing those conditions in the documentation of your +component, it is a good practice to raise an exception from the ``__init__`` +method of your component if those conditions are not met at run time. + +In the case of :ref:`downloader middlewares `, +:ref:`extensions `, :ref:`item pipelines +`, and :ref:`spider middlewares +`, you should raise +:exc:`scrapy.exceptions.NotConfigured`, passing a description of the issue as a +parameter to the exception so that it is printed in the logs, for the user to +see. For other components, feel free to raise whatever other exception feels +right to you; for example, :exc:`RuntimeError` would make sense for a Scrapy +version mismatch, while :exc:`ValueError` may be better if the issue is the +value of a setting. + +If your requirement is a minimum Scrapy version, you may use +:attr:`scrapy.__version__` to enforce your requirement. For example:: + + from pkg_resources import parse_version + + import scrapy + + class MyComponent: + + def __init__(self): + if parse_version(scrapy.__version__) < parse_version('VERSION'): + raise RuntimeError( + f"{MyComponent.__qualname__} requires Scrapy VERSION or " + f"later, which allow defining the process_spider_output " + f"method of spider middlewares as an asynchronous " + f"generator." + ) diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index efc4566a0..55d013c06 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -162,7 +162,7 @@ Asynchronous-to-synchronous conversions are supported for backward compatibility, but they are deprecated and will stop working in a future version of Scrapy. -To avoid asynchronous-to-synchronous conversion, when defining ``Request`` +To avoid asynchronous-to-synchronous conversions, when defining ``Request`` callbacks as coroutine methods or when using spider middlewares whose ``process_spider_output`` method is an :term:`asynchronous generator`, all active spider middlewares must either have their ``process_spider_output`` @@ -177,8 +177,8 @@ process_spider_output_async method `. .. _universal-spider-middleware: -Universal spider middleware -=========================== +Universal spider middlewares +============================ .. versionadded:: VERSION diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index 787545ed2..816cb5e03 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -111,9 +111,11 @@ object gives you access, for example, to the :ref:`settings `. Consider defining this method as an :term:`asynchronous generator`, which will be a requirement in a future version of Scrapy. However, if - you wish your spider middleware to work with Scrapy versions earlier - than Scrapy VERSION, :ref:`make your spider middleware universal - ` instead. + you plan on sharing your spider middleware with other people, consider + either :ref:`enforcing Scrapy VERSION ` + as a minimum requirement of your spider middleware, or :ref:`making + your spider middleware universal ` so that + it works with Scrapy versions earlier than Scrapy VERSION. :param response: the response which generated this output from the spider From 0beed7055cdec3683bf67ec01b573ddf87df723f Mon Sep 17 00:00:00 2001 From: Silvio Pavanetto Date: Wed, 23 Mar 2022 17:28:55 +0100 Subject: [PATCH 078/532] fix: return unique_list only when link_extractor.unique is True --- scrapy/linkextractors/lxmlhtml.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index b5d2585a8..caef504a0 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -161,4 +161,6 @@ class LxmlLinkExtractor(FilteringLinkExtractor): for doc in docs: links = self._extract_links(doc, response.url, response.encoding, base_url) all_links.extend(self._process_links(links)) - return unique_list(all_links) + if self.link_extractor.unique: + return unique_list(all_links) + return all_links From 4af22bf157a5d25703cf5142097ba1c277f0d0d4 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Fri, 8 Apr 2022 14:26:23 +0500 Subject: [PATCH 079/532] Pin mitmproxy to < 8 for now (#5459) --- tox.ini | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index fcd3563b2..aba94d79d 100644 --- a/tox.ini +++ b/tox.ini @@ -12,10 +12,11 @@ deps = -rtests/requirements.txt # mitmproxy does not support PyPy # mitmproxy does not support Windows when running Python < 3.7 - # Python 3.9+ requires https://github.com/mitmproxy/mitmproxy/commit/8e5e43de24c9bc93092b63efc67fbec029a9e7fe + # Python 3.9+ requires mitmproxy >= 5.3.0 # mitmproxy >= 5.3.0 requires h2 >= 4.0, Twisted 21.2 requires h2 < 4.0 #mitmproxy >= 5.3.0; python_version >= '3.9' and implementation_name != 'pypy' - mitmproxy >= 4.0.4; python_version >= '3.7' and python_version < '3.9' and implementation_name != 'pypy' + # The tests hang with mitmproxy 8.0.0: https://github.com/scrapy/scrapy/issues/5454 + mitmproxy >= 4.0.4, < 8; python_version >= '3.7' and python_version < '3.9' and implementation_name != 'pypy' mitmproxy >= 4.0.4, < 5; python_version >= '3.6' and python_version < '3.7' and platform_system != 'Windows' and implementation_name != 'pypy' # newer markupsafe is incompatible with deps of old mitmproxy (which we get on Python 3.7 and lower) markupsafe < 2.1.0; python_version >= '3.6' and python_version < '3.8' and implementation_name != 'pypy' From bae3f8745589b09e0ea75fa463a5423546ca442c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 8 Apr 2022 12:04:02 +0200 Subject: [PATCH 080/532] Cover a backward-incompatible Request serialization change in the 2.6 release notes --- docs/news.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index 5d92067b5..e4e2bce3c 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -113,6 +113,9 @@ Backward-incompatible changes meet expectations, :exc:`TypeError` is now raised at startup time. Before, other exceptions would be raised at run time. (:issue:`3559`) +- The ``_encoding`` field of serialized :class:`~scrapy.http.Request` objects + is now named ``encoding``, in line with all other fields (:issue:`5130`) + Deprecation removals ~~~~~~~~~~~~~~~~~~~~ From aead27bcbdf7c2a4d959dcb357c7f12cc8411739 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 14 Apr 2022 15:06:22 +0200 Subject: [PATCH 081/532] Add release notes for 2.6.2 (#5448) --- docs/news.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index e4e2bce3c..2e0b43455 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,6 +3,23 @@ Release notes ============= +.. _release-2.6.2: + +Scrapy 2.6.2 (2022-03-15) +------------------------- + +Fixes additional regressions introduced in 2.6.0: + +- :class:`~scrapy.crawler.CrawlerProcess` supports again crawling multiple + spiders (:issue:`5435`, :issue:`5436`) + +- Fixed an exception that was being logged after the spider finished under + certain conditions (:issue:`5437`, :issue:`5440`) + +- The ``--output``/``-o`` command-line parameter supports again a value + starting with a hyphen (:issue:`5444`, :issue:`5445`) + + .. _release-2.6.1: Scrapy 2.6.1 (2022-03-01) From 636127ec1ea2b8949438015c2167ab5d009ff1bf Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 17 Apr 2022 12:01:24 -0700 Subject: [PATCH 082/532] tests that all CLI help messages don't throw errors --- tests/test_commands.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tests/test_commands.py b/tests/test_commands.py index b5e6c2b8b..76d5f3935 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -930,3 +930,17 @@ class MySpider(scrapy.Spider): args = ['-o', 'example1.json', '-O', 'example2.json'] log = self.get_log(spider_code, args=args) self.assertIn("error: Please use only one of -o/--output and -O/--overwrite-output", log) + + +class HelpMessageTest(CommandTest): + + def setUp(self): + super().setUp() + self.commands = ["parse", "startproject", "view", "crawl", "edit", + "list", "fetch", "settings", "shell", "runspider", + "version", "genspider", "check", "bench"] + + def test_help_messages(self): + for command in self.commands: + _, out, _ = self.proc(command, "-h") + self.assertIn("Usage", out) From b0f5503cb8d0590aab4d9c91b0ee660d98d1e4a6 Mon Sep 17 00:00:00 2001 From: Alex Date: Sat, 16 Apr 2022 18:17:47 -0700 Subject: [PATCH 083/532] Fixes Issue #5481 --- scrapy/commands/parse.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index a3f6b96f4..6365fbdd0 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -51,7 +51,7 @@ class Command(BaseRunSpiderCommand): parser.add_argument("--cbkwargs", dest="cbkwargs", help="inject extra callback kwargs into the Request, it must be a valid raw json string") parser.add_argument("-d", "--depth", dest="depth", type=int, default=1, - help="maximum depth for parsing requests [default: %default]") + help=f"maximum depth for parsing requests [default: {self.max_level}]") parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", help="print each depth level one by one") From 56c9098d6af2a57cc11927959d47253999cddd46 Mon Sep 17 00:00:00 2001 From: Alex Date: Sat, 16 Apr 2022 18:33:12 -0700 Subject: [PATCH 084/532] changed default depth to 1 --- scrapy/commands/parse.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index 6365fbdd0..a798ef945 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -51,7 +51,7 @@ class Command(BaseRunSpiderCommand): parser.add_argument("--cbkwargs", dest="cbkwargs", help="inject extra callback kwargs into the Request, it must be a valid raw json string") parser.add_argument("-d", "--depth", dest="depth", type=int, default=1, - help=f"maximum depth for parsing requests [default: {self.max_level}]") + help="maximum depth for parsing requests [default: 1]") parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", help="print each depth level one by one") From 915c288205e2b9a0bdbbe18cc67cd23ba5bb4de3 Mon Sep 17 00:00:00 2001 From: Alex Date: Sun, 17 Apr 2022 10:49:50 -0700 Subject: [PATCH 085/532] edit --- scrapy/commands/parse.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index a798ef945..8e52d0d76 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -51,7 +51,7 @@ class Command(BaseRunSpiderCommand): parser.add_argument("--cbkwargs", dest="cbkwargs", help="inject extra callback kwargs into the Request, it must be a valid raw json string") parser.add_argument("-d", "--depth", dest="depth", type=int, default=1, - help="maximum depth for parsing requests [default: 1]") + help="maximum depth for parsing requests [default: %(default)s]") parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", help="print each depth level one by one") From 7de9ed5bd42052f6491c939513adde6f6243ce2f Mon Sep 17 00:00:00 2001 From: PluT00 <314lut00@gmail.com> Date: Sun, 1 May 2022 01:34:35 +0300 Subject: [PATCH 086/532] Deprecate scrapy.pipelines.images.NoimagesDrop --- scrapy/pipelines/images.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 9c99dc69e..df4575a41 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -15,10 +15,12 @@ from scrapy.http import Request from scrapy.pipelines.files import FileException, FilesPipeline # TODO: from scrapy.pipelines.media import MediaPipeline from scrapy.settings import Settings +from scrapy.utils.decorators import deprecated from scrapy.utils.misc import md5sum from scrapy.utils.python import to_bytes +@deprecated() class NoimagesDrop(DropItem): """Product with no images exception""" From 9f659bd63c04656f1c0601d6338f9050d5049fe8 Mon Sep 17 00:00:00 2001 From: PluT00 <314lut00@gmail.com> Date: Sun, 1 May 2022 13:36:15 +0300 Subject: [PATCH 087/532] Fix deprecation of scrapy.pipelines.images.NoimagesDrop --- scrapy/pipelines/images.py | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index df4575a41..c7a04a0cf 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -5,25 +5,28 @@ See documentation in topics/media-pipeline.rst """ import functools import hashlib +import warnings from contextlib import suppress from io import BytesIO from itemadapter import ItemAdapter -from scrapy.exceptions import DropItem, NotConfigured +from scrapy.exceptions import DropItem, NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request from scrapy.pipelines.files import FileException, FilesPipeline # TODO: from scrapy.pipelines.media import MediaPipeline from scrapy.settings import Settings -from scrapy.utils.decorators import deprecated from scrapy.utils.misc import md5sum from scrapy.utils.python import to_bytes -@deprecated() class NoimagesDrop(DropItem): """Product with no images exception""" + def __init__(self, *args, **kwargs): + warnings.warn("The NoimagesDrop class is deprecated", category=ScrapyDeprecationWarning, stacklevel=2) + super().__init__(*args, **kwargs) + class ImageException(FileException): """General image error exception""" From cc16af35af8b20e04b42ca84431820b2b092f379 Mon Sep 17 00:00:00 2001 From: PluT00 <314lut00@gmail.com> Date: Tue, 3 May 2022 11:29:21 +0300 Subject: [PATCH 088/532] Add deprecation warning test for scrapy.pipelines.images.NoimagesDrop --- tests/test_pipeline_images.py | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index c69cd0e4a..613190f9c 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -4,14 +4,16 @@ import random from shutil import rmtree from tempfile import mkdtemp from unittest import skipIf +from warnings import catch_warnings import attr from itemadapter import ItemAdapter from twisted.trial import unittest +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.item import Field, Item -from scrapy.pipelines.images import ImagesPipeline +from scrapy.pipelines.images import ImagesPipeline, NoimagesDrop from scrapy.settings import Settings from scrapy.utils.python import to_bytes @@ -413,6 +415,22 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): expected_value) +class NoimagesDropTestCase(unittest.TestCase): + + def test_deprecation_warning(self): + arg = str() + with catch_warnings(record=True) as warnings: + NoimagesDrop(arg) + self.assertEqual(len(warnings), 1) + self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) + with catch_warnings(record=True) as warnings: + class SubclassedNoimagesDrop(NoimagesDrop): + pass + SubclassedNoimagesDrop(arg) + self.assertEqual(len(warnings), 1) + self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) + + def _create_image(format, *a, **kw): buf = io.BytesIO() Image.new(*a, **kw).save(buf, format) From 83c1939281197242511931c6e9f356f2498eb623 Mon Sep 17 00:00:00 2001 From: Andreas Tziortziortziopoulos Date: Fri, 6 May 2022 03:59:30 +0300 Subject: [PATCH 089/532] Issue #3264, fix error handling when spider is not matched Changes Implementation: - Check whether Spider exists or is None, and if it's None skip execution of start_requests() with non existing Spider Testing: - Add a test case with invalid url inside test_command_parse Test proves that non-matched Spider does not throw an AttributeError --- scrapy/commands/parse.py | 3 ++- tests/test_command_parse.py | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index a3f6b96f4..99fc8f955 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -146,7 +146,8 @@ class Command(BaseRunSpiderCommand): def _start_requests(spider): yield self.prepare_request(spider, Request(url), opts) - self.spidercls.start_requests = _start_requests + if self.spidercls: + self.spidercls.start_requests = _start_requests def start_parsing(self, url, opts): self.crawler_process.crawl(self.spidercls, **opts.spargs) diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index f21ee971d..0622074a3 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -1,6 +1,7 @@ import os import argparse from os.path import join, abspath, isfile, exists + from twisted.internet import defer from scrapy.commands import parse from scrapy.settings import Settings @@ -222,6 +223,10 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") self.assertIn("""Cannot find a rule that matches""", _textmode(stderr)) + status, out, stderr = yield self.execute([self.url('/invalid_url')]) + self.assertEqual(status, 0) + self.assertIn("""""", _textmode(stderr)) + @defer.inlineCallbacks def test_output_flag(self): """Checks if a file was created successfully having From 2006060688976ca469d794cdd3b753a00bfb83c9 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Wed, 11 May 2022 10:29:53 +0300 Subject: [PATCH 090/532] per slot settings: codestyle(flake8) fix, code line length --- scrapy/core/downloader/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 53dc546de..511693830 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -103,7 +103,9 @@ class Downloader: def _get_slot(self, request, spider): key = self._get_slot_key(request, spider) if key not in self.slots: - conc = self.per_slot_settings.get(key, {}).get('concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency) + conc = self.per_slot_settings.get(key, {}).get( + 'concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency + ) conc, delay = _get_concurrency_delay(conc, spider, self.settings) delay = self.per_slot_settings.get(key, {}).get('delay', delay) randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) From 0ffc52a491e6e6c46196b3aa92767856f64a8ebc Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Wed, 11 May 2022 10:40:12 +0300 Subject: [PATCH 091/532] per slot settings: test added (delays for each download slots) --- tests/test_downloaderslotssettings.py | 75 +++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 tests/test_downloaderslotssettings.py diff --git a/tests/test_downloaderslotssettings.py b/tests/test_downloaderslotssettings.py new file mode 100644 index 000000000..6ea03fb78 --- /dev/null +++ b/tests/test_downloaderslotssettings.py @@ -0,0 +1,75 @@ +import time + +from scrapy.crawler import CrawlerRunner +from scrapy.http import Request + +from tests.mockserver import MockServer +from tests.spiders import MetaSpider + +from twisted.internet import defer +from twisted.trial.unittest import TestCase + + +class DownloaderSlotsSettingsTestSpider(MetaSpider): + + name = 'downloader_slots' + + custom_settings = { + "DOWNLOAD_DELAY": 1, + "RANDOMIZE_DOWNLOAD_DELAY": False, + "DOWNLOAD_SLOTS": { + 'quotes.toscrape.com': { + 'concurrency': 1, + 'delay': 1.5, + 'randomize_delay': False + }, + 'books.toscrape.com': { + 'delay': 2, + 'randomize_delay': False + } + } + } + + def start_requests(self): + self.times = {None: []} + + slots = list(self.custom_settings.get('DOWNLOAD_SLOTS', {}).keys()) + [None] + + for slot in slots: + url = self.mockserver.url(f"/?downloader_slot={slot}") + self.times[slot] = [] + yield Request(url, callback=self.parse, meta={'download_slot': slot}) + + def parse(self, response): + slot = response.meta.get('download_slot', None) + self.times[slot].append(time.time()) + url = self.mockserver.url(f"/?downloader_slot={slot}&req=2") + yield Request(url, callback=self.not_parse, meta={'download_slot': slot}) + + def not_parse(self, response): + slot = response.meta.get('download_slot', None) + self.times[slot].append(time.time()) + + +class CrawlTestCase(TestCase): + + def setUp(self): + self.mockserver = MockServer() + self.mockserver.__enter__() + self.runner = CrawlerRunner() + + def tearDown(self): + self.mockserver.__exit__(None, None, None) + + @defer.inlineCallbacks + def test_delay(self): + crawler = CrawlerRunner().create_crawler(DownloaderSlotsSettingsTestSpider) + yield crawler.crawl(mockserver=self.mockserver) + slots = crawler.engine.downloader.slots + times = crawler.spider.times + tolerance = 0.3 + + delays_real = {k: v[1] - v[0] for k, v in times.items()} + error_delta = {k: 1 - delays_real[k] / v.delay for k, v in slots.items()} + + self.assertTrue(max(list(error_delta.values())) < tolerance) From 84c29a286f6b9bc94a5318ca68cd4fc21244443a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 20 May 2022 06:45:38 +0200 Subject: [PATCH 092/532] Unset the release date of still-unreleased 2.6.2 (#5503) --- docs/news.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/news.rst b/docs/news.rst index 2e0b43455..ca9aeb783 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,7 +5,7 @@ Release notes .. _release-2.6.2: -Scrapy 2.6.2 (2022-03-15) +Scrapy 2.6.2 (2022-0?-??) ------------------------- Fixes additional regressions introduced in 2.6.0: From 1c1cd5d8eae48eade88560426499846d217a555f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 20 May 2022 07:05:26 +0200 Subject: [PATCH 093/532] Update the 2.6.2 release notes --- docs/news.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index ca9aeb783..ffeb50390 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -19,6 +19,9 @@ Fixes additional regressions introduced in 2.6.0: - The ``--output``/``-o`` command-line parameter supports again a value starting with a hyphen (:issue:`5444`, :issue:`5445`) +- The ``scrapy parse -h`` command no longer throws an error (:issue:`5481`, + :issue:`5482`) + .. _release-2.6.1: From b5c15d87ff5770220bca31792c89e58804b923bb Mon Sep 17 00:00:00 2001 From: Andreas Tziortziortziopoulos Date: Sun, 22 May 2022 12:19:20 +0300 Subject: [PATCH 094/532] [issue3264] Separate test for not matched spider to a url --- tests/test_command_parse.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 0622074a3..0d992be56 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -223,9 +223,10 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") self.assertIn("""Cannot find a rule that matches""", _textmode(stderr)) + @defer.inlineCallbacks + def test_crawlspider_not_exists_with_not_matched_url(self): status, out, stderr = yield self.execute([self.url('/invalid_url')]) self.assertEqual(status, 0) - self.assertIn("""""", _textmode(stderr)) @defer.inlineCallbacks def test_output_flag(self): From 86331900125dc311223cbd1ebb0e10d09e7c592d Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Tue, 24 May 2022 14:47:00 +0430 Subject: [PATCH 095/532] pass on item to thumb_path function as additional argument resolves #5504 --- scrapy/pipelines/images.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 9c99dc69e..45ac03820 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -141,7 +141,7 @@ class ImagesPipeline(FilesPipeline): yield path, image, buf for thumb_id, size in self.thumbs.items(): - thumb_path = self.thumb_path(request, thumb_id, response=response, info=info) + thumb_path = self.thumb_path(request, thumb_id, response=response, info=info, item=item) thumb_image, thumb_buf = self.convert_image(image, size) yield thumb_path, thumb_image, thumb_buf @@ -179,6 +179,6 @@ class ImagesPipeline(FilesPipeline): image_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() return f'full/{image_guid}.jpg' - def thumb_path(self, request, thumb_id, response=None, info=None): + def thumb_path(self, request, thumb_id, response=None, info=None, item=None): thumb_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() return f'thumbs/{thumb_id}/{thumb_guid}.jpg' From f39def4492f838b2414324e22a12f3b355f5c062 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Wed, 25 May 2022 23:57:38 +0430 Subject: [PATCH 096/532] add docs --- docs/topics/media-pipeline.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/topics/media-pipeline.rst b/docs/topics/media-pipeline.rst index 7dff78390..2513faae2 100644 --- a/docs/topics/media-pipeline.rst +++ b/docs/topics/media-pipeline.rst @@ -656,6 +656,26 @@ See here the methods that you can override in your custom Images Pipeline: .. versionadded:: 2.4 The *item* parameter. + .. method:: ImagesPipeline.thumb_path(self, request, thumb_id, response=None, info=None, *, item=None) + + This method is called for every item of :setting:`IMAGES_THUMBS` per downloaded item. It returns the + thumbnail download path of the image originating from the specified + :class:`response `. + + In addition to ``response``, this method receives the original + :class:`request `, + ``thumb_id``, + :class:`info ` and + :class:`item `. + + You can override this method to customize the thumbnail download path of each image. + You can use the ``item`` to determine the file path based on some item + property. + + By default the :meth:`thumb_path` method returns + ``thumbs//.``. + + .. method:: ImagesPipeline.get_media_requests(item, info) Works the same way as :meth:`FilesPipeline.get_media_requests` method, From 5c586d78f0e1c5b66358ed644bb6e528ad4b062b Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Wed, 25 May 2022 23:58:09 +0430 Subject: [PATCH 097/532] add tests --- tests/test_pipeline_images.py | 16 ++++++++++++++++ tests/test_pipeline_media.py | 28 +++++++++++++++++++++++++--- 2 files changed, 41 insertions(+), 3 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index c69cd0e4a..dd94d296b 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -93,6 +93,22 @@ class ImagesPipelineTestCase(unittest.TestCase): info=object()), 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') + def test_thumbnail_name_from_item(self): + """ + Custom thumbnail name based on item data, overriding default implementation + """ + + class CustomImagesPipeline(ImagesPipeline): + def thumb_path(self, request, thumb_id, response=None, info=None, item=None): + return f"thumb/{thumb_id}/{item.get('path')}" + + thumb_path = CustomImagesPipeline.from_settings(Settings( + {'IMAGES_STORE': self.tempdir} + )).thumb_path + item = dict(path='path-to-store-file') + request = Request("http://example.com") + self.assertEqual(thumb_path(request, 'small', item=item), 'thumb/small/path-to-store-file') + def test_convert_image(self): SIZE = (100, 100) # straigh forward case: RGB and JPEG diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 893d43052..a802c7cf1 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -1,4 +1,5 @@ from typing import Optional +import io from testfixtures import LogCapture from twisted.trial import unittest @@ -355,9 +356,12 @@ class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): def get_media_requests(self, item, info): item_url = item['image_urls'][0] + output_img = io.BytesIO() + img = Image.new('RGB', (60, 30), color='red') + img.save(output_img, format='JPEG') return Request( item_url, - meta={'response': Response(item_url, status=200, body=b'data')} + meta={'response': Response(item_url, status=200, body=output_img.getvalue())} ) def inc_stats(self, *args, **kwargs): @@ -379,9 +383,13 @@ class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): self._mockcalled.append('file_path') return super(MockedMediaPipelineDeprecatedMethods, self).file_path(request, response, info) + def thumb_path(self, request, thumb_id, response=None, info=None): + self._mockcalled.append('thumb_path') + return super(MockedMediaPipelineDeprecatedMethods, self).thumb_path(request, thumb_id, response, info) + def get_images(self, response, request, info): self._mockcalled.append('get_images') - return [] + return super(MockedMediaPipelineDeprecatedMethods, self).get_images(response, request, info) def image_downloaded(self, response, request, info): self._mockcalled.append('image_downloaded') @@ -392,7 +400,11 @@ class MediaPipelineDeprecatedMethodsTestCase(unittest.TestCase): skip = skip_pillow def setUp(self): - self.pipe = MockedMediaPipelineDeprecatedMethods(store_uri='store-uri', download_func=_mocked_download_func) + self.pipe = MockedMediaPipelineDeprecatedMethods( + store_uri='store-uri', + download_func=_mocked_download_func, + settings=Settings({"IMAGES_THUMBS": {'small': (50, 50)}}) + ) self.pipe.open_spider(None) self.item = dict(image_urls=['http://picsum.photos/id/1014/200/300'], images=[]) @@ -444,6 +456,16 @@ class MediaPipelineDeprecatedMethodsTestCase(unittest.TestCase): ) self._assert_method_called_with_warnings('file_path', message, warnings) + @inlineCallbacks + def test_thumb_path_called(self): + yield self.pipe.process_item(self.item, None) + warnings = self.flushWarnings([MediaPipeline._compatible]) + message = ( + 'thumb_path(self, request, thumb_id, response=None, info=None) is deprecated, ' + 'please use thumb_path(self, request, thumb_id, response=None, info=None, *, item=None)' + ) + self._assert_method_called_with_warnings('thumb_path', message, warnings) + @inlineCallbacks def test_get_images_called(self): yield self.pipe.process_item(self.item, None) From 896f16f2def7c276350421352dddf6e7b0145519 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Wed, 25 May 2022 23:59:25 +0430 Subject: [PATCH 098/532] make thumb_path method backwards compatible --- scrapy/pipelines/images.py | 2 +- scrapy/pipelines/media.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 45ac03820..6b97190ee 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -179,6 +179,6 @@ class ImagesPipeline(FilesPipeline): image_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() return f'full/{image_guid}.jpg' - def thumb_path(self, request, thumb_id, response=None, info=None, item=None): + def thumb_path(self, request, thumb_id, response=None, info=None, *, item=None): thumb_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() return f'thumbs/{thumb_id}/{thumb_guid}.jpg' diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index d1bccf323..430c37227 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -121,7 +121,7 @@ class MediaPipeline: def _make_compatible(self): """Make overridable methods of MediaPipeline and subclasses backwards compatible""" methods = [ - "file_path", "media_to_download", "media_downloaded", + "file_path", "thumb_path", "media_to_download", "media_downloaded", "file_downloaded", "image_downloaded", "get_images" ] From c5627af15bcf413c04539aeb47dd07cf8b3e4092 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 7 Jun 2022 18:44:54 +0200 Subject: [PATCH 099/532] Centralize request fingerprints (#4524) Co-authored-by: Mikhail Korobov --- docs/conf.py | 2 + docs/news.rst | 2 +- docs/topics/api.rst | 7 + docs/topics/item-pipeline.rst | 4 +- docs/topics/request-response.rst | 268 +++++++ docs/topics/settings.rst | 8 +- scrapy/crawler.py | 7 + scrapy/dupefilters.py | 49 +- scrapy/extensions/httpcache.py | 14 +- scrapy/pipelines/media.py | 4 +- scrapy/settings/default_settings.py | 3 + .../templates/project/module/settings.py.tmpl | 3 + scrapy/utils/request.py | 235 +++++- scrapy/utils/test.py | 9 +- tests/test_crawler.py | 3 +- tests/test_dupefilters.py | 80 +- tests/test_pipeline_files.py | 5 +- tests/test_pipeline_media.py | 53 +- tests/test_utils_request.py | 699 ++++++++++++++++-- 19 files changed, 1304 insertions(+), 151 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 55aa72d5a..378b01804 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -294,7 +294,9 @@ intersphinx_mapping = { 'tox': ('https://tox.readthedocs.io/en/latest', None), 'twisted': ('https://twistedmatrix.com/documents/current', None), 'twistedapi': ('https://twistedmatrix.com/documents/current/api', None), + 'w3lib': ('https://w3lib.readthedocs.io/en/latest', None), } +intersphinx_disabled_reftypes = [] # Options for sphinx-hoverxref options diff --git a/docs/news.rst b/docs/news.rst index 5d92067b5..2d0ab485e 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -1643,7 +1643,7 @@ New features :issue:`4370`) * A new ``keep_fragments`` parameter of - :func:`scrapy.utils.request.request_fingerprint` allows to generate + ``scrapy.utils.request.request_fingerprint`` allows to generate different fingerprints for requests with different fragments in their URL (:issue:`4104`) diff --git a/docs/topics/api.rst b/docs/topics/api.rst index 900b19c7a..60b5acd10 100644 --- a/docs/topics/api.rst +++ b/docs/topics/api.rst @@ -32,6 +32,13 @@ how you :ref:`configure the downloader middlewares :class:`scrapy.Spider` subclass and a :class:`scrapy.settings.Settings` object. + .. attribute:: request_fingerprinter + + The request fingerprint builder of this crawler. + + This is used from extensions and middlewares to build short, unique + identifiers for requests. See :ref:`request-fingerprints`. + .. attribute:: settings The settings manager of this crawler. diff --git a/docs/topics/item-pipeline.rst b/docs/topics/item-pipeline.rst index 391751364..882ff5661 100644 --- a/docs/topics/item-pipeline.rst +++ b/docs/topics/item-pipeline.rst @@ -60,9 +60,9 @@ Additionally, they may also implement the following methods: :param spider: the spider which was closed :type spider: :class:`~scrapy.Spider` object -.. method:: from_crawler(cls, crawler) +.. classmethod:: from_crawler(cls, crawler) - If present, this classmethod is called to create a pipeline instance + If present, this class method is called to create a pipeline instance from a :class:`~scrapy.crawler.Crawler`. It must return a new instance of the pipeline. Crawler object provides access to all Scrapy core components like settings and signals; it is a way for pipeline to diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index 92a471faf..49cb69f67 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -339,6 +339,7 @@ errors if needed:: request = failure.request self.logger.error('TimeoutError on %s', request.url) + .. _errback-cb_kwargs: Accessing additional data in errback functions @@ -364,6 +365,273 @@ achieve this by using ``Failure.request.cb_kwargs``:: main_url=failure.request.cb_kwargs['main_url'], ) + +.. _request-fingerprints: + +Request fingerprints +-------------------- + +There are some aspects of scraping, such as filtering out duplicate requests +(see :setting:`DUPEFILTER_CLASS`) or caching responses (see +:setting:`HTTPCACHE_POLICY`), where you need the ability to generate a short, +unique identifier from a :class:`~scrapy.http.Request` object: a request +fingerprint. + +You often do not need to worry about request fingerprints, the default request +fingerprinter works for most projects. + +However, there is no universal way to generate a unique identifier from a +request, because different situations require comparing requests differently. +For example, sometimes you may need to compare URLs case-insensitively, include +URL fragments, exclude certain URL query parameters, include some or all +headers, etc. + +To change how request fingerprints are built for your requests, use the +:setting:`REQUEST_FINGERPRINTER_CLASS` setting. + +.. setting:: REQUEST_FINGERPRINTER_CLASS + +REQUEST_FINGERPRINTER_CLASS +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: VERSION + +Default: :class:`scrapy.utils.request.RequestFingerprinter` + +A :ref:`request fingerprinter class ` or its +import path. + +.. autoclass:: scrapy.utils.request.RequestFingerprinter + + +.. setting:: REQUEST_FINGERPRINTER_IMPLEMENTATION + +REQUEST_FINGERPRINTER_IMPLEMENTATION +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +.. versionadded:: VERSION + +Default: ``'PREVIOUS_VERSION'`` + +Determines which request fingerprinting algorithm is used by the default +request fingerprinter class (see :setting:`REQUEST_FINGERPRINTER_CLASS`). + +Possible values are: + +- ``'PREVIOUS_VERSION'`` (default) + + This implementation uses the same request fingerprinting algorithm as + Scrapy PREVIOUS_VERSION and earlier versions. + + Even though this is the default value for backward compatibility reasons, + it is a deprecated value. + +- ``'VERSION'`` + + This implementation was introduced in Scrapy VERSION to fix an issue of the + previous implementation. + + New projects should use this value. The :command:`startproject` command + sets this value in the generated ``settings.py`` file. + +If you are using the default value (``'PREVIOUS_VERSION'``) for this setting, and you are +using Scrapy components where changing the request fingerprinting algorithm +would cause undesired results, you need to carefully decide when to change the +value of this setting, or switch the :setting:`REQUEST_FINGERPRINTER_CLASS` +setting to a custom request fingerprinter class that implements the PREVIOUS_VERSION request +fingerprinting algorithm and does not log this warning ( +:ref:`PREVIOUS_VERSION-request-fingerprinter` includes an example implementation of such a +class). + +Scenarios where changing the request fingerprinting algorithm may cause +undesired results include, for example, using the HTTP cache middleware (see +:class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`). +Changing the request fingerprinting algorithm would invalidade the current +cache, requiring you to redownload all requests again. + +Otherwise, set :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` to ``'VERSION'`` in +your settings to switch already to the request fingerprinting implementation +that will be the only request fingerprinting implementation available in a +future version of Scrapy, and remove the deprecation warning triggered by using +the default value (``'PREVIOUS_VERSION'``). + + +.. _PREVIOUS_VERSION-request-fingerprinter: +.. _custom-request-fingerprinter: + +Writing your own request fingerprinter +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +A request fingerprinter is a class that must implement the following method: + +.. method:: fingerprint(self, request) + + Return a :class:`bytes` object that uniquely identifies *request*. + + See also :ref:`request-fingerprint-restrictions`. + + :param request: request to fingerprint + :type request: scrapy.http.Request + +Additionally, it may also implement the following methods: + +.. classmethod:: from_crawler(cls, crawler) + + If present, this class method is called to create a request fingerprinter + instance from a :class:`~scrapy.crawler.Crawler` object. It must return a + new instance of the request fingerprinter. + + *crawler* provides access to all Scrapy core components like settings and + signals; it is a way for the request fingerprinter to access them and hook + its functionality into Scrapy. + + :param crawler: crawler that uses this request fingerprinter + :type crawler: :class:`~scrapy.crawler.Crawler` object + +.. classmethod:: from_settings(cls, settings) + + If present, and ``from_crawler`` is not defined, this class method is called + to create a request fingerprinter instance from a + :class:`~scrapy.settings.Settings` object. It must return a new instance of + the request fingerprinter. + +The ``fingerprint`` method of the default request fingerprinter, +:class:`scrapy.utils.request.RequestFingerprinter`, uses +:func:`scrapy.utils.request.fingerprint` with its default parameters. For some +common use cases you can use :func:`~scrapy.utils.request.fingerprint` as well +in your ``fingerprint`` method implementation: + +.. autofunction:: scrapy.utils.request.fingerprint + +For example, to take the value of a request header named ``X-ID`` into +account:: + + # my_project/settings.py + REQUEST_FINGERPRINTER_CLASS = 'my_project.utils.RequestFingerprinter' + + # my_project/utils.py + from scrapy.utils.request import fingerprint + + class RequestFingerprinter: + + def fingerprint(self, request): + return fingerprint(request, include_headers=['X-ID']) + +You can also write your own fingerprinting logic from scratch. + +However, if you do not use :func:`~scrapy.utils.request.fingerprint`, make sure +you use :class:`~weakref.WeakKeyDictionary` to cache request fingerprints: + +- Caching saves CPU by ensuring that fingerprints are calculated only once + per request, and not once per Scrapy component that needs the fingerprint + of a request. + +- Using :class:`~weakref.WeakKeyDictionary` saves memory by ensuring that + request objects do not stay in memory forever just because you have + references to them in your cache dictionary. + +For example, to take into account only the URL of a request, without any prior +URL canonicalization or taking the request method or body into account:: + + from hashlib import sha1 + from weakref import WeakKeyDictionary + + from scrapy.utils.python import to_bytes + + class RequestFingerprinter: + + cache = WeakKeyDictionary() + + def fingerprint(self, request): + if request not in self.cache: + fp = sha1() + fp.update(to_bytes(request.url)) + self.cache[request] = fp.digest() + return self.cache[request] + +If you need to be able to override the request fingerprinting for arbitrary +requests from your spider callbacks, you may implement a request fingerprinter +that reads fingerprints from :attr:`request.meta ` +when available, and then falls back to +:func:`~scrapy.utils.request.fingerprint`. For example:: + + from scrapy.utils.request import fingerprint + + class RequestFingerprinter: + + def fingerprint(self, request): + if 'fingerprint' in request.meta: + return request.meta['fingerprint'] + return fingerprint(request) + +If you need to reproduce the same fingerprinting algorithm as Scrapy PREVIOUS_VERSION +without using the deprecated ``'PREVIOUS_VERSION'`` value of the +:setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` setting, use the following +request fingerprinter:: + + from hashlib import sha1 + from weakref import WeakKeyDictionary + + from scrapy.utils.python import to_bytes + from w3lib.url import canonicalize_url + + class RequestFingerprinter: + + cache = WeakKeyDictionary() + + def fingerprint(self, request): + if request not in self.cache: + fp = sha1() + fp.update(to_bytes(request.method)) + fp.update(to_bytes(canonicalize_url(request.url))) + fp.update(request.body or b'') + self.cache[request] = fp.digest() + return self.cache[request] + + +.. _request-fingerprint-restrictions: + +Request fingerprint restrictions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Scrapy components that use request fingerprints may impose additional +restrictions on the format of the fingerprints that your :ref:`request +fingerprinter ` generates. + +The following built-in Scrapy components have such restrictions: + +- :class:`scrapy.extensions.httpcache.FilesystemCacheStorage` (default + value of :setting:`HTTPCACHE_STORAGE`) + + Request fingerprints must be at least 1 byte long. + + Path and filename length limits of the file system of + :setting:`HTTPCACHE_DIR` also apply. Inside :setting:`HTTPCACHE_DIR`, + the following directory structure is created: + + - :attr:`Spider.name ` + + - first byte of a request fingerprint as hexadecimal + + - fingerprint as hexadecimal + + - filenames up to 16 characters long + + For example, if a request fingerprint is made of 20 bytes (default), + :setting:`HTTPCACHE_DIR` is ``'/home/user/project/.scrapy/httpcache'``, + and the name of your spider is ``'my_spider'`` your file system must + support a file path like:: + + /home/user/project/.scrapy/httpcache/my_spider/01/0123456789abcdef0123456789abcdef01234567/response_headers + +- :class:`scrapy.extensions.httpcache.DbmCacheStorage` + + The underlying DBM implementation must support keys as long as twice + the number of bytes of a request fingerprint, plus 5. For example, + if a request fingerprint is made of 20 bytes (default), + 45-character-long keys must be supported. + + .. _topics-request-meta: Request.meta special keys diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 4e105642d..2046c6446 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -825,12 +825,8 @@ Default: ``'scrapy.dupefilters.RFPDupeFilter'`` The class used to detect and filter duplicate requests. -The default (``RFPDupeFilter``) filters based on request fingerprint using -the ``scrapy.utils.request.request_fingerprint`` function. In order to change -the way duplicates are checked you could subclass ``RFPDupeFilter`` and -override its ``request_fingerprint`` method. This method should accept -scrapy :class:`~scrapy.Request` object and return its fingerprint -(a string). +The default (``RFPDupeFilter``) filters based on the +:setting:`REQUEST_FINGERPRINTER_CLASS` setting. You can disable filtering of duplicate requests by setting :setting:`DUPEFILTER_CLASS` to ``'scrapy.dupefilters.BaseDupeFilter'``. diff --git a/scrapy/crawler.py b/scrapy/crawler.py index a638254f1..fdca7b335 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -51,6 +51,7 @@ class Crawler: self.spidercls.update_settings(self.settings) self.signals = SignalManager(self) + self.stats = load_object(self.settings['STATS_CLASS'])(self) handler = LogCounterHandler(self, level=self.settings.get('LOG_LEVEL')) @@ -71,6 +72,12 @@ class Crawler: lf_cls = load_object(self.settings['LOG_FORMATTER']) self.logformatter = lf_cls.from_crawler(self) + self.request_fingerprinter = create_instance( + load_object(self.settings['REQUEST_FINGERPRINTER_CLASS']), + settings=self.settings, + crawler=self, + ) + reactor_class = self.settings.get("TWISTED_REACTOR") if init_reactor: # this needs to be done after the spider settings are merged, diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index 292c68099..d1b0559ef 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -1,14 +1,16 @@ import logging import os from typing import Optional, Set, Type, TypeVar +from warnings import warn from twisted.internet.defer import Deferred from scrapy.http.request import Request from scrapy.settings import BaseSettings from scrapy.spiders import Spider +from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.job import job_dir -from scrapy.utils.request import referer_str, request_fingerprint +from scrapy.utils.request import referer_str, RequestFingerprinter BaseDupeFilterTV = TypeVar("BaseDupeFilterTV", bound="BaseDupeFilter") @@ -39,8 +41,15 @@ RFPDupeFilterTV = TypeVar("RFPDupeFilterTV", bound="RFPDupeFilter") class RFPDupeFilter(BaseDupeFilter): """Request Fingerprint duplicates filter""" - def __init__(self, path: Optional[str] = None, debug: bool = False) -> None: + def __init__( + self, + path: Optional[str] = None, + debug: bool = False, + *, + fingerprinter=None, + ) -> None: self.file = None + self.fingerprinter = fingerprinter or RequestFingerprinter() self.fingerprints: Set[str] = set() self.logdupes = True self.debug = debug @@ -51,9 +60,39 @@ class RFPDupeFilter(BaseDupeFilter): self.fingerprints.update(x.rstrip() for x in self.file) @classmethod - def from_settings(cls: Type[RFPDupeFilterTV], settings: BaseSettings) -> RFPDupeFilterTV: + def from_settings(cls: Type[RFPDupeFilterTV], settings: BaseSettings, *, fingerprinter=None) -> RFPDupeFilterTV: debug = settings.getbool('DUPEFILTER_DEBUG') - return cls(job_dir(settings), debug) + try: + return cls(job_dir(settings), debug, fingerprinter=fingerprinter) + except TypeError: + warn( + "RFPDupeFilter subclasses must either modify their '__init__' " + "method to support a 'fingerprinter' parameter or reimplement " + "the 'from_settings' class method.", + ScrapyDeprecationWarning, + ) + result = cls(job_dir(settings), debug) + result.fingerprinter = fingerprinter + return result + + @classmethod + def from_crawler(cls, crawler): + try: + return cls.from_settings( + crawler.settings, + fingerprinter=crawler.request_fingerprinter, + ) + except TypeError: + warn( + "RFPDupeFilter subclasses must either modify their overridden " + "'__init__' method and 'from_settings' class method to " + "support a 'fingerprinter' parameter, or reimplement the " + "'from_crawler' class method.", + ScrapyDeprecationWarning, + ) + result = cls.from_settings(crawler.settings) + result.fingerprinter = crawler.request_fingerprinter + return result def request_seen(self, request: Request) -> bool: fp = self.request_fingerprint(request) @@ -65,7 +104,7 @@ class RFPDupeFilter(BaseDupeFilter): return False def request_fingerprint(self, request: Request) -> str: - return request_fingerprint(request) + return self.fingerprinter.fingerprint(request).hex() def close(self, reason: str) -> None: if self.file: diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index d0ae29b90..c71484cfa 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -14,7 +14,6 @@ from scrapy.responsetypes import responsetypes from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.project import data_path from scrapy.utils.python import to_bytes, to_unicode -from scrapy.utils.request import request_fingerprint logger = logging.getLogger(__name__) @@ -228,6 +227,8 @@ class DbmCacheStorage: logger.debug("Using DBM cache storage in %(cachepath)s", {'cachepath': dbpath}, extra={'spider': spider}) + self._fingerprinter = spider.crawler.request_fingerprinter + def close_spider(self, spider): self.db.close() @@ -244,7 +245,7 @@ class DbmCacheStorage: return response def store_response(self, spider, request, response): - key = self._request_key(request) + key = self._fingerprinter.fingerprint(request).hex() data = { 'status': response.status, 'url': response.url, @@ -255,7 +256,7 @@ class DbmCacheStorage: self.db[f'{key}_time'] = str(time()) def _read_data(self, spider, request): - key = self._request_key(request) + key = self._fingerprinter.fingerprint(request).hex() db = self.db tkey = f'{key}_time' if tkey not in db: @@ -267,9 +268,6 @@ class DbmCacheStorage: return pickle.loads(db[f'{key}_data']) - def _request_key(self, request): - return request_fingerprint(request) - class FilesystemCacheStorage: @@ -283,6 +281,8 @@ class FilesystemCacheStorage: logger.debug("Using filesystem cache storage in %(cachedir)s", {'cachedir': self.cachedir}, extra={'spider': spider}) + self._fingerprinter = spider.crawler.request_fingerprinter + def close_spider(self, spider): pass @@ -329,7 +329,7 @@ class FilesystemCacheStorage: f.write(request.body) def _get_request_path(self, spider, request): - key = request_fingerprint(request) + key = self._fingerprinter.fingerprint(request).hex() return os.path.join(self.cachedir, spider.name, key[0:2], key) def _read_meta(self, spider, request): diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index 430c37227..5308a9793 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -11,7 +11,6 @@ from scrapy.settings import Settings from scrapy.utils.datatypes import SequenceExclude from scrapy.utils.defer import mustbe_deferred, defer_result from scrapy.utils.deprecate import ScrapyDeprecationWarning -from scrapy.utils.request import request_fingerprint from scrapy.utils.misc import arg_to_iter from scrapy.utils.log import failure_to_exc_info @@ -77,6 +76,7 @@ class MediaPipeline: except AttributeError: pipe = cls() pipe.crawler = crawler + pipe._fingerprinter = crawler.request_fingerprinter return pipe def open_spider(self, spider): @@ -90,7 +90,7 @@ class MediaPipeline: return dfd.addCallback(self.item_completed, item, info) def _process_request(self, request, info, item): - fp = request_fingerprint(request) + fp = self._fingerprinter.fingerprint(request) cb = request.callback or (lambda _: _) eb = request.errback request.callback = None diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index 8389a70cb..f5a3efe69 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -246,6 +246,9 @@ REDIRECT_PRIORITY_ADJUST = +2 REFERER_ENABLED = True REFERRER_POLICY = 'scrapy.spidermiddlewares.referer.DefaultReferrerPolicy' +REQUEST_FINGERPRINTER_CLASS = 'scrapy.utils.request.RequestFingerprinter' +REQUEST_FINGERPRINTER_IMPLEMENTATION = 'PREVIOUS_VERSION' + RETRY_ENABLED = True RETRY_TIMES = 2 # initial response + 2 retries = 3 requests RETRY_HTTP_CODES = [500, 502, 503, 504, 522, 524, 408, 429] diff --git a/scrapy/templates/project/module/settings.py.tmpl b/scrapy/templates/project/module/settings.py.tmpl index a414b5fde..5e541e2c0 100644 --- a/scrapy/templates/project/module/settings.py.tmpl +++ b/scrapy/templates/project/module/settings.py.tmpl @@ -86,3 +86,6 @@ ROBOTSTXT_OBEY = True #HTTPCACHE_DIR = 'httpcache' #HTTPCACHE_IGNORE_HTTP_CODES = [] #HTTPCACHE_STORAGE = 'scrapy.extensions.httpcache.FilesystemCacheStorage' + +# Set settings whose default value is deprecated to a future-proof value +REQUEST_FINGERPRINTER_IMPLEMENTATION = 'VERSION' diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index 70ef3ba2b..cf33317ce 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -4,7 +4,9 @@ scrapy.http.Request objects """ import hashlib -from typing import Dict, Iterable, Optional, Tuple, Union +import json +import warnings +from typing import Dict, Iterable, List, Optional, Tuple, Union from urllib.parse import urlunparse from weakref import WeakKeyDictionary @@ -12,13 +14,22 @@ from w3lib.http import basic_auth_header from w3lib.url import canonicalize_url from scrapy import Request, Spider +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import load_object from scrapy.utils.python import to_bytes, to_unicode -_fingerprint_cache: "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], str]]" -_fingerprint_cache = WeakKeyDictionary() +_deprecated_fingerprint_cache: "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], str]]" +_deprecated_fingerprint_cache = WeakKeyDictionary() + + +def _serialize_headers(headers, request): + for header in headers: + if header in request.headers: + yield header + for value in request.headers.getlist(header): + yield value def request_fingerprint( @@ -26,6 +37,123 @@ def request_fingerprint( include_headers: Optional[Iterable[Union[bytes, str]]] = None, keep_fragments: bool = False, ) -> str: + """ + Return the request fingerprint as an hexadecimal string. + + The request fingerprint is a hash that uniquely identifies the resource the + request points to. For example, take the following two urls: + + http://www.example.com/query?id=111&cat=222 + http://www.example.com/query?cat=222&id=111 + + Even though those are two different URLs both point to the same resource + and are equivalent (i.e. they should return the same response). + + Another example are cookies used to store session ids. Suppose the + following page is only accessible to authenticated users: + + http://www.example.com/members/offers.html + + Lots of sites use a cookie to store the session id, which adds a random + component to the HTTP Request and thus should be ignored when calculating + the fingerprint. + + For this reason, request headers are ignored by default when calculating + the fingerprint. If you want to include specific headers use the + include_headers argument, which is a list of Request headers to include. + + Also, servers usually ignore fragments in urls when handling requests, + so they are also ignored by default when calculating the fingerprint. + If you want to include them, set the keep_fragments argument to True + (for instance when handling requests with a headless browser). + """ + if include_headers or keep_fragments: + message = ( + 'Call to deprecated function ' + 'scrapy.utils.request.request_fingerprint().\n' + '\n' + 'If you are using this function in a Scrapy component because you ' + 'need a non-default fingerprinting algorithm, and you are OK ' + 'with that non-default fingerprinting algorithm being used by ' + 'all Scrapy components and not just the one calling this ' + 'function, use crawler.request_fingerprinter.fingerprint() ' + 'instead in your Scrapy component (you can get the crawler ' + 'object from the \'from_crawler\' class method), and use the ' + '\'REQUEST_FINGERPRINTER_CLASS\' setting to configure your ' + 'non-default fingerprinting algorithm.\n' + '\n' + 'Otherwise, consider using the ' + 'scrapy.utils.request.fingerprint() function instead.\n' + '\n' + 'If you switch to \'fingerprint()\', or assign the ' + '\'REQUEST_FINGERPRINTER_CLASS\' setting a class that uses ' + '\'fingerprint()\', the generated fingerprints will not only be ' + 'bytes instead of a string, but they will also be different from ' + 'those generated by \'request_fingerprint()\'. Before you switch, ' + 'make sure that you understand the consequences of this (e.g. ' + 'cache invalidation) and are OK with them; otherwise, consider ' + 'implementing your own function which returns the same ' + 'fingerprints as the deprecated \'request_fingerprint()\' function.' + ) + else: + message = ( + 'Call to deprecated function ' + 'scrapy.utils.request.request_fingerprint().\n' + '\n' + 'If you are using this function in a Scrapy component, and you ' + 'are OK with users of your component changing the fingerprinting ' + 'algorithm through settings, use ' + 'crawler.request_fingerprinter.fingerprint() instead in your ' + 'Scrapy component (you can get the crawler object from the ' + '\'from_crawler\' class method).\n' + '\n' + 'Otherwise, consider using the ' + 'scrapy.utils.request.fingerprint() function instead.\n' + '\n' + 'Either way, the resulting fingerprints will be returned as ' + 'bytes, not as a string, and they will also be different from ' + 'those generated by \'request_fingerprint()\'. Before you switch, ' + 'make sure that you understand the consequences of this (e.g. ' + 'cache invalidation) and are OK with them; otherwise, consider ' + 'implementing your own function which returns the same ' + 'fingerprints as the deprecated \'request_fingerprint()\' function.' + ) + warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) + processed_include_headers: Optional[Tuple[bytes, ...]] = None + if include_headers: + processed_include_headers = tuple( + to_bytes(h.lower()) for h in sorted(include_headers) + ) + cache = _deprecated_fingerprint_cache.setdefault(request, {}) + cache_key = (processed_include_headers, keep_fragments) + if cache_key not in cache: + fp = hashlib.sha1() + fp.update(to_bytes(request.method)) + fp.update(to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments))) + fp.update(request.body or b'') + if processed_include_headers: + for part in _serialize_headers(processed_include_headers, request): + fp.update(part) + cache[cache_key] = fp.hexdigest() + return cache[cache_key] + + +def _request_fingerprint_as_bytes(*args, **kwargs): + with warnings.catch_warnings(): + warnings.simplefilter("ignore") + return bytes.fromhex(request_fingerprint(*args, **kwargs)) + + +_fingerprint_cache: "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], bytes]]" +_fingerprint_cache = WeakKeyDictionary() + + +def fingerprint( + request: Request, + *, + include_headers: Optional[Iterable[Union[bytes, str]]] = None, + keep_fragments: bool = False, +) -> bytes: """ Return the request fingerprint. @@ -43,7 +171,7 @@ def request_fingerprint( http://www.example.com/members/offers.html - Lot of sites use a cookie to store the session id, which adds a random + Lots of sites use a cookie to store the session id, which adds a random component to the HTTP Request and thus should be ignored when calculating the fingerprint. @@ -55,29 +183,96 @@ def request_fingerprint( so they are also ignored by default when calculating the fingerprint. If you want to include them, set the keep_fragments argument to True (for instance when handling requests with a headless browser). - """ - headers: Optional[Tuple[bytes, ...]] = None + processed_include_headers: Optional[Tuple[bytes, ...]] = None if include_headers: - headers = tuple(to_bytes(h.lower()) for h in sorted(include_headers)) + processed_include_headers = tuple( + to_bytes(h.lower()) for h in sorted(include_headers) + ) cache = _fingerprint_cache.setdefault(request, {}) - cache_key = (headers, keep_fragments) + cache_key = (processed_include_headers, keep_fragments) if cache_key not in cache: - fp = hashlib.sha1() - fp.update(to_bytes(request.method)) - fp.update(to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments))) - fp.update(request.body or b'') - if headers: - for hdr in headers: - if hdr in request.headers: - fp.update(hdr) - for v in request.headers.getlist(hdr): - fp.update(v) - cache[cache_key] = fp.hexdigest() + # To decode bytes reliably (JSON does not support bytes), regardless of + # character encoding, we use bytes.hex() + headers: Dict[str, List[str]] = {} + if processed_include_headers: + for header in processed_include_headers: + if header in request.headers: + headers[header.hex()] = [ + header_value.hex() + for header_value in request.headers.getlist(header) + ] + fingerprint_data = { + 'method': to_unicode(request.method), + 'url': canonicalize_url(request.url, keep_fragments=keep_fragments), + 'body': (request.body or b'').hex(), + 'headers': headers, + } + fingerprint_json = json.dumps(fingerprint_data, sort_keys=True) + cache[cache_key] = hashlib.sha1(fingerprint_json.encode()).digest() return cache[cache_key] -def request_authenticate(request: Request, username: str, password: str) -> None: +class RequestFingerprinter: + """Default fingerprinter. + + It takes into account a canonical version + (:func:`w3lib.url.canonicalize_url`) of :attr:`request.url + ` and the values of :attr:`request.method + ` and :attr:`request.body + `. It then generates an `SHA1 + `_ hash. + + .. seealso:: :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION`. + """ + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + def __init__(self, crawler=None): + if crawler: + implementation = crawler.settings.get( + 'REQUEST_FINGERPRINTER_IMPLEMENTATION' + ) + else: + implementation = 'PREVIOUS_VERSION' + if implementation == 'PREVIOUS_VERSION': + message = ( + '\'PREVIOUS_VERSION\' is a deprecated value for the ' + '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting.\n' + '\n' + 'It is also the default value. In other words, it is normal ' + 'to get this warning if you have not defined a value for the ' + '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting. This is so ' + 'for backward compatibility reasons, but it will change in a ' + 'future version of Scrapy.\n' + '\n' + 'See the documentation of the ' + '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting for ' + 'information on how to handle this deprecation.' + ) + warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) + self._fingerprint = _request_fingerprint_as_bytes + elif implementation == 'VERSION': + self._fingerprint = fingerprint + else: + raise ValueError( + f'Got an invalid value on setting ' + f'\'REQUEST_FINGERPRINTER_IMPLEMENTATION\': ' + f'{implementation!r}. Valid values are \'PREVIOUS_VERSION\' (deprecated) ' + f'and \'VERSION\'.' + ) + + def fingerprint(self, request): + return self._fingerprint(request) + + +def request_authenticate( + request: Request, + username: str, + password: str, +) -> None: """Authenticate the given request (in place) using the HTTP basic access authentication mechanism (RFC 2617) and the given username and password """ diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 24c38283a..b90ea5009 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -54,7 +54,7 @@ def get_ftp_content_and_delete( return "".join(ftp_data) -def get_crawler(spidercls=None, settings_dict=None): +def get_crawler(spidercls=None, settings_dict=None, prevent_warnings=True): """Return an unconfigured Crawler object. If settings_dict is given, it will be used to populate the crawler settings with a project level priority. @@ -62,7 +62,12 @@ def get_crawler(spidercls=None, settings_dict=None): from scrapy.crawler import CrawlerRunner from scrapy.spiders import Spider - runner = CrawlerRunner(settings_dict) + # Set by default settings that prevent deprecation warnings. + settings = {} + if prevent_warnings: + settings['REQUEST_FINGERPRINTER_IMPLEMENTATION'] = 'VERSION' + settings.update(settings_dict or {}) + runner = CrawlerRunner(settings) return runner.create_crawler(spidercls or Spider) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 8f6227109..f7aa769e4 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -104,7 +104,8 @@ class CrawlerLoggingTestCase(unittest.TestCase): custom_settings = { 'LOG_LEVEL': 'INFO', 'LOG_FILE': log_file, - # disable telnet if not available to avoid an extra warning + # settings to avoid extra warnings + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, } diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index 680bb6dc8..b7df2554a 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -15,6 +15,16 @@ from scrapy.utils.test import get_crawler from tests.spiders import SimpleSpider +def _get_dupefilter(*, crawler=None, settings=None, open=True): + if crawler is None: + crawler = get_crawler(settings_dict=settings) + scheduler = Scheduler.from_crawler(crawler) + dupefilter = scheduler.df + if open: + dupefilter.open() + return dupefilter + + class FromCrawlerRFPDupeFilter(RFPDupeFilter): @classmethod @@ -64,9 +74,7 @@ class RFPDupeFilterTest(unittest.TestCase): self.assertEqual(scheduler.df.method, 'n/a') def test_filter(self): - dupefilter = RFPDupeFilter() - dupefilter.open() - + dupefilter = _get_dupefilter() r1 = Request('http://scrapytest.org/1') r2 = Request('http://scrapytest.org/2') r3 = Request('http://scrapytest.org/2') @@ -85,7 +93,7 @@ class RFPDupeFilterTest(unittest.TestCase): path = tempfile.mkdtemp() try: - df = RFPDupeFilter(path) + df = _get_dupefilter(settings={'JOBDIR': path}, open=False) try: df.open() assert not df.request_seen(r1) @@ -93,7 +101,8 @@ class RFPDupeFilterTest(unittest.TestCase): finally: df.close('finished') - df2 = RFPDupeFilter(path) + df2 = _get_dupefilter(settings={'JOBDIR': path}, open=False) + assert df != df2 try: df2.open() assert df2.request_seen(r1) @@ -109,26 +118,24 @@ class RFPDupeFilterTest(unittest.TestCase): output of request_seen. """ + dupefilter = _get_dupefilter() r1 = Request('http://scrapytest.org/index.html') r2 = Request('http://scrapytest.org/INDEX.html') - dupefilter = RFPDupeFilter() - dupefilter.open() - assert not dupefilter.request_seen(r1) assert not dupefilter.request_seen(r2) dupefilter.close('finished') - class CaseInsensitiveRFPDupeFilter(RFPDupeFilter): + class RequestFingerprinter: - def request_fingerprint(self, request): + def fingerprint(self, request): fp = hashlib.sha1() fp.update(to_bytes(request.url.lower())) - return fp.hexdigest() + return fp.digest() - case_insensitive_dupefilter = CaseInsensitiveRFPDupeFilter() - case_insensitive_dupefilter.open() + settings = {'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter} + case_insensitive_dupefilter = _get_dupefilter(settings=settings) assert not case_insensitive_dupefilter.request_seen(r1) assert case_insensitive_dupefilter.request_seen(r2) @@ -142,8 +149,10 @@ class RFPDupeFilterTest(unittest.TestCase): r1 = Request('http://scrapytest.org/1') path = tempfile.mkdtemp() + crawler = get_crawler(settings_dict={'JOBDIR': path}) try: - df = RFPDupeFilter(path) + scheduler = Scheduler.from_crawler(crawler) + df = scheduler.df df.open() df.request_seen(r1) df.close('finished') @@ -164,11 +173,8 @@ class RFPDupeFilterTest(unittest.TestCase): settings = {'DUPEFILTER_DEBUG': False, 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter} crawler = get_crawler(SimpleSpider, settings_dict=settings) - scheduler = Scheduler.from_crawler(crawler) spider = SimpleSpider.from_crawler(crawler) - - dupefilter = scheduler.df - dupefilter.open() + dupefilter = _get_dupefilter(crawler=crawler) r1 = Request('http://scrapytest.org/index.html') r2 = Request('http://scrapytest.org/index.html') @@ -193,11 +199,41 @@ class RFPDupeFilterTest(unittest.TestCase): settings = {'DUPEFILTER_DEBUG': True, 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter} crawler = get_crawler(SimpleSpider, settings_dict=settings) - scheduler = Scheduler.from_crawler(crawler) spider = SimpleSpider.from_crawler(crawler) - - dupefilter = scheduler.df - dupefilter.open() + dupefilter = _get_dupefilter(crawler=crawler) + + r1 = Request('http://scrapytest.org/index.html') + r2 = Request('http://scrapytest.org/index.html', + headers={'Referer': 'http://scrapytest.org/INDEX.html'}) + + dupefilter.log(r1, spider) + dupefilter.log(r2, spider) + + assert crawler.stats.get_value('dupefilter/filtered') == 2 + log.check_present( + ( + 'scrapy.dupefilters', + 'DEBUG', + 'Filtered duplicate request: (referer: None)' + ) + ) + log.check_present( + ( + 'scrapy.dupefilters', + 'DEBUG', + 'Filtered duplicate request: ' + ' (referer: http://scrapytest.org/INDEX.html)' + ) + ) + + dupefilter.close('finished') + + def test_log_debug_default_dupefilter(self): + with LogCapture() as log: + settings = {'DUPEFILTER_DEBUG': True} + crawler = get_crawler(SimpleSpider, settings_dict=settings) + spider = SimpleSpider.from_crawler(crawler) + dupefilter = _get_dupefilter(crawler=crawler) r1 = Request('http://scrapytest.org/index.html') r2 = Request('http://scrapytest.org/index.html', diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 0ff2045ed..4228173ed 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -25,6 +25,7 @@ from scrapy.pipelines.files import ( from scrapy.settings import Settings from scrapy.utils.test import ( assert_gcs_environ, + get_crawler, get_ftp_content_and_delete, get_gcs_content_and_delete, skip_if_no_boto, @@ -47,7 +48,9 @@ class FilesPipelineTestCase(unittest.TestCase): def setUp(self): self.tempdir = mkdtemp() - self.pipeline = FilesPipeline.from_settings(Settings({'FILES_STORE': self.tempdir})) + settings_dict = {'FILES_STORE': self.tempdir} + crawler = get_crawler(spidercls=None, settings_dict=settings_dict) + self.pipeline = FilesPipeline.from_crawler(crawler) self.pipeline.download_func = _mocked_download_func self.pipeline.open_spider(None) diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index a802c7cf1..84e867660 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -7,17 +7,17 @@ from twisted.python.failure import Failure from twisted.internet import reactor from twisted.internet.defer import Deferred, inlineCallbacks +from scrapy import signals from scrapy.http import Request, Response from scrapy.settings import Settings from scrapy.spiders import Spider -from scrapy.utils.deprecate import ScrapyDeprecationWarning -from scrapy.utils.request import request_fingerprint +from scrapy.pipelines.files import FileException from scrapy.pipelines.images import ImagesPipeline from scrapy.pipelines.media import MediaPipeline -from scrapy.pipelines.files import FileException +from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.log import failure_to_exc_info from scrapy.utils.signal import disconnect_all -from scrapy import signals +from scrapy.utils.test import get_crawler try: @@ -39,11 +39,14 @@ class BaseMediaPipelineTestCase(unittest.TestCase): settings = None def setUp(self): - self.spider = Spider('media.com') - self.pipe = self.pipeline_class(download_func=_mocked_download_func, - settings=Settings(self.settings)) + spider_cls = Spider + self.spider = spider_cls('media.com') + crawler = get_crawler(spider_cls, self.settings) + self.pipe = self.pipeline_class.from_crawler(crawler) + self.pipe.download_func = _mocked_download_func self.pipe.open_spider(self.spider) self.info = self.pipe.spiderinfo + self.fingerprint = crawler.request_fingerprinter.fingerprint def tearDown(self): for name, signal in vars(signals).items(): @@ -156,7 +159,7 @@ class BaseMediaPipelineTestCase(unittest.TestCase): self.assertEqual(failure.value.__context__, def_gen_return_exc) # Let's calculate the request fingerprint and fake some runtime data... - fp = request_fingerprint(request) + fp = self.fingerprint(request) info = self.pipe.spiderinfo info.downloading.add(fp) info.waiting[fp] = [] @@ -273,7 +276,7 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): item = dict(requests=req) # pass a single item new_item = yield self.pipe.process_item(item, self.spider) assert new_item is item - assert request_fingerprint(req) in self.info.downloaded + self.assertIn(self.fingerprint(req), self.info.downloaded) # returns iterable of Requests req1 = Request('http://url1') @@ -281,8 +284,8 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): item = dict(requests=iter([req1, req2])) new_item = yield self.pipe.process_item(item, self.spider) assert new_item is item - assert request_fingerprint(req1) in self.info.downloaded - assert request_fingerprint(req2) in self.info.downloaded + assert self.fingerprint(req1) in self.info.downloaded + assert self.fingerprint(req2) in self.info.downloaded @inlineCallbacks def test_results_are_cached_across_multiple_items(self): @@ -298,7 +301,7 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): item = dict(requests=req2) new_item = yield self.pipe.process_item(item, self.spider) self.assertTrue(new_item is item) - self.assertEqual(request_fingerprint(req1), request_fingerprint(req2)) + self.assertEqual(self.fingerprint(req1), self.fingerprint(req2)) self.assertEqual(new_item['results'], [(True, rsp1)]) @inlineCallbacks @@ -314,7 +317,7 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): @inlineCallbacks def test_wait_if_request_is_downloading(self): def _check_downloading(response): - fp = request_fingerprint(req1) + fp = self.fingerprint(req1) self.assertTrue(fp in self.info.downloading) self.assertTrue(fp in self.info.waiting) self.assertTrue(fp not in self.info.downloaded) @@ -351,7 +354,7 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): def __init__(self, *args, **kwargs): - super(MockedMediaPipelineDeprecatedMethods, self).__init__(*args, **kwargs) + super().__init__(*args, **kwargs) self._mockcalled = [] def get_media_requests(self, item, info): @@ -369,19 +372,19 @@ class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): def media_to_download(self, request, info): self._mockcalled.append('media_to_download') - return super(MockedMediaPipelineDeprecatedMethods, self).media_to_download(request, info) + return super().media_to_download(request, info) def media_downloaded(self, response, request, info): self._mockcalled.append('media_downloaded') - return super(MockedMediaPipelineDeprecatedMethods, self).media_downloaded(response, request, info) + return super().media_downloaded(response, request, info) def file_downloaded(self, response, request, info): self._mockcalled.append('file_downloaded') - return super(MockedMediaPipelineDeprecatedMethods, self).file_downloaded(response, request, info) + return super().file_downloaded(response, request, info) def file_path(self, request, response=None, info=None): self._mockcalled.append('file_path') - return super(MockedMediaPipelineDeprecatedMethods, self).file_path(request, response, info) + return super().file_path(request, response, info) def thumb_path(self, request, thumb_id, response=None, info=None): self._mockcalled.append('thumb_path') @@ -393,18 +396,20 @@ class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): def image_downloaded(self, response, request, info): self._mockcalled.append('image_downloaded') - return super(MockedMediaPipelineDeprecatedMethods, self).image_downloaded(response, request, info) + return super().image_downloaded(response, request, info) class MediaPipelineDeprecatedMethodsTestCase(unittest.TestCase): skip = skip_pillow def setUp(self): - self.pipe = MockedMediaPipelineDeprecatedMethods( - store_uri='store-uri', - download_func=_mocked_download_func, - settings=Settings({"IMAGES_THUMBS": {'small': (50, 50)}}) - ) + settings_dict = { + 'IMAGES_STORE': 'store-uri', + 'IMAGES_THUMBS': {'small': (50, 50)}, + } + crawler = get_crawler(spidercls=None, settings_dict=settings_dict) + self.pipe = MockedMediaPipelineDeprecatedMethods.from_crawler(crawler) + self.pipe.download_func = _mocked_download_func self.pipe.open_spider(None) self.item = dict(image_urls=['http://picsum.photos/id/1014/200/300'], images=[]) diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index 7e0049b1d..e9edfee98 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -1,73 +1,29 @@ import unittest +import warnings +from hashlib import sha1 +from typing import Dict, Mapping, Optional, Tuple, Union +from weakref import WeakKeyDictionary + +import pytest +from w3lib.url import canonicalize_url + from scrapy.http import Request +from scrapy.utils.deprecate import ScrapyDeprecationWarning +from scrapy.utils.python import to_bytes from scrapy.utils.request import ( + _deprecated_fingerprint_cache, _fingerprint_cache, + _request_fingerprint_as_bytes, + fingerprint, request_authenticate, request_fingerprint, request_httprepr, ) +from scrapy.utils.test import get_crawler class UtilsRequestTest(unittest.TestCase): - def test_request_fingerprint(self): - r1 = Request("http://www.example.com/query?id=111&cat=222") - r2 = Request("http://www.example.com/query?cat=222&id=111") - self.assertEqual(request_fingerprint(r1), request_fingerprint(r1)) - self.assertEqual(request_fingerprint(r1), request_fingerprint(r2)) - - r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78132,199') - r2 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') - self.assertNotEqual(request_fingerprint(r1), request_fingerprint(r2)) - - # make sure caching is working - self.assertEqual(request_fingerprint(r1), _fingerprint_cache[r1][(None, False)]) - - r1 = Request("http://www.example.com/members/offers.html") - r2 = Request("http://www.example.com/members/offers.html") - r2.headers['SESSIONID'] = b"somehash" - self.assertEqual(request_fingerprint(r1), request_fingerprint(r2)) - - r1 = Request("http://www.example.com/") - r2 = Request("http://www.example.com/") - r2.headers['Accept-Language'] = b'en' - r3 = Request("http://www.example.com/") - r3.headers['Accept-Language'] = b'en' - r3.headers['SESSIONID'] = b"somehash" - - self.assertEqual(request_fingerprint(r1), request_fingerprint(r2), request_fingerprint(r3)) - - self.assertEqual(request_fingerprint(r1), - request_fingerprint(r1, include_headers=['Accept-Language'])) - - self.assertNotEqual( - request_fingerprint(r1), - request_fingerprint(r2, include_headers=['Accept-Language'])) - - self.assertEqual(request_fingerprint(r3, include_headers=['accept-language', 'sessionid']), - request_fingerprint(r3, include_headers=['SESSIONID', 'Accept-Language'])) - - r1 = Request("http://www.example.com/test.html") - r2 = Request("http://www.example.com/test.html#fragment") - self.assertEqual(request_fingerprint(r1), request_fingerprint(r2)) - self.assertEqual(request_fingerprint(r1), request_fingerprint(r1, keep_fragments=True)) - self.assertNotEqual(request_fingerprint(r2), request_fingerprint(r2, keep_fragments=True)) - self.assertNotEqual(request_fingerprint(r1), request_fingerprint(r2, keep_fragments=True)) - - r1 = Request("http://www.example.com") - r2 = Request("http://www.example.com", method='POST') - r3 = Request("http://www.example.com", method='POST', body=b'request body') - - self.assertNotEqual(request_fingerprint(r1), request_fingerprint(r2)) - self.assertNotEqual(request_fingerprint(r2), request_fingerprint(r3)) - - # cached fingerprint must be cleared on request copy - r1 = Request("http://www.example.com") - fp1 = request_fingerprint(r1) - r2 = r1.replace(url="http://www.example.com/other") - fp2 = request_fingerprint(r2) - self.assertNotEqual(fp1, fp2) - def test_request_authenticate(self): r = Request("http://www.example.com") request_authenticate(r, 'someuser', 'somepass') @@ -93,5 +49,632 @@ class UtilsRequestTest(unittest.TestCase): request_httprepr(Request("ftp://localhost/tmp/foo.txt")) +class FingerprintTest(unittest.TestCase): + maxDiff = None + + function = staticmethod(fingerprint) + cache: Union[ + "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], bytes]]", + "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], str]]", + ] = _fingerprint_cache + default_cache_key = (None, False) + known_hashes: Tuple[Tuple[Request, Union[bytes, str], Dict], ...] = ( + ( + Request("http://example.org"), + b'xs\xd7\x0c3uj\x15\xfe\xd7d\x9b\xa9\t\xe0d\xbf\x9cXD', + {}, + ), + ( + Request("https://example.org"), + b'\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l', + {}, + ), + ( + Request("https://example.org?a"), + b'G\xad\xb8Ck\x19\x1c\xed\x838,\x01\xc4\xde;\xee\xa5\x94a\x0c', + {}, + ), + ( + Request("https://example.org?a=b"), + b'\x024MYb\x8a\xc2\x1e\xbc>\xd6\xac*\xda\x9cF\xc1r\x7f\x17', + {}, + ), + ( + Request("https://example.org?a=b&a"), + b't+\xe8*\xfb\x84\xe3v\x1a}\x88p\xc0\xccB\xd7\x9d\xfez\x96', + {}, + ), + ( + Request("https://example.org?a=b&a=c"), + b'\xda\x1ec\xd0\x9c\x08s`\xb4\x9b\xe2\xb6R\xf8k\xef\xeaQG\xef', + {}, + ), + ( + Request("https://example.org", method='POST'), + b'\x9d\xcdA\x0fT\x02:\xca\xa0}\x90\xda\x05B\xded\x8aN7\x1d', + {}, + ), + ( + Request("https://example.org", body=b'a'), + b'\xc34z>\xd8\x99\x8b\xda7\x05r\x99I\xa8\xa0x;\xa41_', + {}, + ), + ( + Request("https://example.org", method='POST', body=b'a'), + b'5`\xe2y4\xd0\x9d\xee\xe0\xbatw\x87Q\xe8O\xd78\xfc\xe7', + {}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + b'\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l', + {}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + b']\xc7\x1f\xf2\xafG2\xbc\xa4\xfa\x99\n33\xda\x18\x94\x81U.', + {'include_headers': ['A']}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + b'<\x1a\xeb\x85y\xdeW\xfb\xdcq\x88\xee\xaf\x17\xdd\x0c\xbfH\x18\x1f', + {'keep_fragments': True}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + b'\xc1\xef~\x94\x9bS\xc1\x83\t\xdcz8\x9f\xdc{\x11\x16I.\x11', + {'include_headers': ['A'], 'keep_fragments': True}, + ), + ( + Request("https://example.org/ab"), + b'N\xe5l\xb8\x12@iw\xe2\xf3\x1bp\xea\xffp!u\xe2\x8a\xc6', + {}, + ), + ( + Request("https://example.org/a", body=b'b'), + b'_NOv\xbco$6\xfcW\x9f\xb24g\x9f\xbb\xdd\xa82\xc5', + {}, + ), + ) + + def test_query_string_key_order(self): + r1 = Request("http://www.example.com/query?id=111&cat=222") + r2 = Request("http://www.example.com/query?cat=222&id=111") + self.assertEqual(self.function(r1), self.function(r1)) + self.assertEqual(self.function(r1), self.function(r2)) + + def test_query_string_key_without_value(self): + r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78132,199') + r2 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') + self.assertNotEqual(self.function(r1), self.function(r2)) + + def test_caching(self): + r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') + self.assertEqual( + self.function(r1), + self.cache[r1][self.default_cache_key] + ) + + def test_header(self): + r1 = Request("http://www.example.com/members/offers.html") + r2 = Request("http://www.example.com/members/offers.html") + r2.headers['SESSIONID'] = b"somehash" + self.assertEqual(self.function(r1), self.function(r2)) + + def test_headers(self): + r1 = Request("http://www.example.com/") + r2 = Request("http://www.example.com/") + r2.headers['Accept-Language'] = b'en' + r3 = Request("http://www.example.com/") + r3.headers['Accept-Language'] = b'en' + r3.headers['SESSIONID'] = b"somehash" + + self.assertEqual(self.function(r1), self.function(r2), self.function(r3)) + + self.assertEqual(self.function(r1), + self.function(r1, include_headers=['Accept-Language'])) + + self.assertNotEqual( + self.function(r1), + self.function(r2, include_headers=['Accept-Language'])) + + self.assertEqual(self.function(r3, include_headers=['accept-language', 'sessionid']), + self.function(r3, include_headers=['SESSIONID', 'Accept-Language'])) + + def test_fragment(self): + r1 = Request("http://www.example.com/test.html") + r2 = Request("http://www.example.com/test.html#fragment") + self.assertEqual(self.function(r1), self.function(r2)) + self.assertEqual(self.function(r1), self.function(r1, keep_fragments=True)) + self.assertNotEqual(self.function(r2), self.function(r2, keep_fragments=True)) + self.assertNotEqual(self.function(r1), self.function(r2, keep_fragments=True)) + + def test_method_and_body(self): + r1 = Request("http://www.example.com") + r2 = Request("http://www.example.com", method='POST') + r3 = Request("http://www.example.com", method='POST', body=b'request body') + + self.assertNotEqual(self.function(r1), self.function(r2)) + self.assertNotEqual(self.function(r2), self.function(r3)) + + def test_request_replace(self): + # cached fingerprint must be cleared on request copy + r1 = Request("http://www.example.com") + fp1 = self.function(r1) + r2 = r1.replace(url="http://www.example.com/other") + fp2 = self.function(r2) + self.assertNotEqual(fp1, fp2) + + def test_part_separation(self): + # An old implementation used to serialize request data in a way that + # would put the body right after the URL. + r1 = Request("http://www.example.com/foo") + fp1 = self.function(r1) + r2 = Request("http://www.example.com/f", body=b'oo') + fp2 = self.function(r2) + self.assertNotEqual(fp1, fp2) + + def test_hashes(self): + """Test hardcoded hashes, to make sure future changes to not introduce + backward incompatibilities.""" + actual = [ + self.function(request, **kwargs) + for request, _, kwargs in self.known_hashes + ] + expected = [ + _fingerprint + for _, _fingerprint, _ in self.known_hashes + ] + self.assertEqual(actual, expected) + + +class RequestFingerprintTest(FingerprintTest): + function = staticmethod(request_fingerprint) + cache = _deprecated_fingerprint_cache + known_hashes: Tuple[Tuple[Request, Union[bytes, str], Dict], ...] = ( + ( + Request("http://example.org"), + 'b2e5245ef826fd9576c93bd6e392fce3133fab62', + {}, + ), + ( + Request("https://example.org"), + 'bd10a0a89ea32cdee77917320f1309b0da87e892', + {}, + ), + ( + Request("https://example.org?a"), + '2fb7d48ae02f04b749f40caa969c0bc3c43204ce', + {}, + ), + ( + Request("https://example.org?a=b"), + '42e5fe149b147476e3f67ad0670c57b4cc57856a', + {}, + ), + ( + Request("https://example.org?a=b&a"), + 'd23a9787cb56c6375c2cae4453c5a8c634526942', + {}, + ), + ( + Request("https://example.org?a=b&a=c"), + '9a18a7a8552a9182b7f1e05d33876409e421e5c5', + {}, + ), + ( + Request("https://example.org", method='POST'), + 'ba20a80cb5c5ca460021ceefb3c2467b2bfd1bc6', + {}, + ), + ( + Request("https://example.org", body=b'a'), + '4bb136e54e715a4ea7a9dd1101831765d33f2d60', + {}, + ), + ( + Request("https://example.org", method='POST', body=b'a'), + '6c6595374a304b293be762f7b7be3f54e9947c65', + {}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + 'bd10a0a89ea32cdee77917320f1309b0da87e892', + {}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + '515b633cb3ca502a33a9d8c890e889ec1e425e65', + {'include_headers': ['A']}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + '505c96e7da675920dfef58725e8c957dfdb38f47', + {'keep_fragments': True}, + ), + ( + Request("https://example.org#a", headers={'A': b'B'}), + 'd6f673cdcb661b7970c2b9a00ee63e87d1e2e5da', + {'include_headers': ['A'], 'keep_fragments': True}, + ), + ( + Request("https://example.org/ab"), + '4e2870fee58582d6f81755e9b8fdefe3cba0c951', + {}, + ), + ( + Request("https://example.org/a", body=b'b'), + '4e2870fee58582d6f81755e9b8fdefe3cba0c951', + {}, + ), + ) + + @pytest.mark.xfail(reason='known bug kept for backward compatibility', strict=True) + def test_part_separation(self): + super().test_part_separation() + + def test_deprecation_default_parameters(self): + with pytest.warns(ScrapyDeprecationWarning) as warnings: + self.function(Request("http://www.example.com")) + messages = [str(warning.message) for warning in warnings] + self.assertTrue( + any( + 'Call to deprecated function' in message + for message in messages + ) + ) + self.assertFalse(any('non-default' in message for message in messages)) + + def test_deprecation_non_default_parameters(self): + with pytest.warns(ScrapyDeprecationWarning) as warnings: + self.function(Request("http://www.example.com"), keep_fragments=True) + messages = [str(warning.message) for warning in warnings] + self.assertTrue( + any( + 'Call to deprecated function' in message + for message in messages + ) + ) + self.assertTrue(any('non-default' in message for message in messages)) + + +class RequestFingerprintAsBytesTest(FingerprintTest): + function = staticmethod(_request_fingerprint_as_bytes) + cache = _deprecated_fingerprint_cache + known_hashes = RequestFingerprintTest.known_hashes + + def test_caching(self): + r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') + self.assertEqual( + self.function(r1), + bytes.fromhex(self.cache[r1][self.default_cache_key]) + ) + + @pytest.mark.xfail(reason='known bug kept for backward compatibility', strict=True) + def test_part_separation(self): + super().test_part_separation() + + def test_hashes(self): + actual = [ + self.function(request, **kwargs) + for request, _, kwargs in self.known_hashes + ] + expected = [ + bytes.fromhex(_fingerprint) + for _, _fingerprint, _ in self.known_hashes + ] + self.assertEqual(actual, expected) + + +_fingerprint_cache_2_6: Mapping[Request, Tuple[None, bool]] = WeakKeyDictionary() + + +def request_fingerprint_2_6(request, include_headers=None, keep_fragments=False): + if include_headers: + include_headers = tuple(to_bytes(h.lower()) for h in sorted(include_headers)) + cache = _fingerprint_cache_2_6.setdefault(request, {}) + cache_key = (include_headers, keep_fragments) + if cache_key not in cache: + fp = sha1() + fp.update(to_bytes(request.method)) + fp.update(to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments))) + fp.update(request.body or b'') + if include_headers: + for hdr in include_headers: + if hdr in request.headers: + fp.update(hdr) + for v in request.headers.getlist(hdr): + fp.update(v) + cache[cache_key] = fp.hexdigest() + return cache[cache_key] + + +REQUEST_OBJECTS_TO_TEST = ( + Request("http://www.example.com/"), + Request("http://www.example.com/query?id=111&cat=222"), + Request("http://www.example.com/query?cat=222&id=111"), + Request('http://www.example.com/hnnoticiaj1.aspx?78132,199'), + Request('http://www.example.com/hnnoticiaj1.aspx?78160,199'), + Request("http://www.example.com/members/offers.html"), + Request( + "http://www.example.com/members/offers.html", + headers={'SESSIONID': b"somehash"}, + ), + Request( + "http://www.example.com/", + headers={'Accept-Language': b"en"}, + ), + Request( + "http://www.example.com/", + headers={ + 'Accept-Language': b"en", + 'SESSIONID': b"somehash", + }, + ), + Request("http://www.example.com/test.html"), + Request("http://www.example.com/test.html#fragment"), + Request("http://www.example.com", method='POST'), + Request("http://www.example.com", method='POST', body=b'request body'), +) + + +class BackwardCompatibilityTestCase(unittest.TestCase): + + def test_function_backward_compatibility(self): + include_headers_to_test = ( + None, + ['Accept-Language'], + ['accept-language', 'sessionid'], + ['SESSIONID', 'Accept-Language'], + ) + for request_object in REQUEST_OBJECTS_TO_TEST: + for include_headers in include_headers_to_test: + for keep_fragments in (False, True): + with warnings.catch_warnings(): + warnings.simplefilter("ignore") + fp = request_fingerprint( + request_object, + include_headers=include_headers, + keep_fragments=keep_fragments, + ) + old_fp = request_fingerprint_2_6( + request_object, + include_headers=include_headers, + keep_fragments=keep_fragments, + ) + self.assertEqual(fp, old_fp) + + def test_component_backward_compatibility(self): + for request_object in REQUEST_OBJECTS_TO_TEST: + with warnings.catch_warnings(): + warnings.simplefilter("ignore") + crawler = get_crawler(prevent_warnings=False) + fp = crawler.request_fingerprinter.fingerprint(request_object) + old_fp = request_fingerprint_2_6(request_object) + self.assertEqual(fp.hex(), old_fp) + + def test_custom_component_backward_compatibility(self): + """Tests that the backward-compatible request fingerprinting class featured + in the documentation is indeed backward compatible and does not cause a + warning to be logged.""" + + class RequestFingerprinter: + + cache = WeakKeyDictionary() + + def fingerprint(self, request): + if request not in self.cache: + fp = sha1() + fp.update(to_bytes(request.method)) + fp.update(to_bytes(canonicalize_url(request.url))) + fp.update(request.body or b'') + self.cache[request] = fp.digest() + return self.cache[request] + + for request_object in REQUEST_OBJECTS_TO_TEST: + with warnings.catch_warnings() as logged_warnings: + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + } + crawler = get_crawler(settings_dict=settings) + fp = crawler.request_fingerprinter.fingerprint(request_object) + old_fp = request_fingerprint_2_6(request_object) + self.assertEqual(fp.hex(), old_fp) + self.assertFalse(logged_warnings) + + +class RequestFingerprinterTestCase(unittest.TestCase): + + def test_default_implementation(self): + with warnings.catch_warnings(record=True) as logged_warnings: + crawler = get_crawler(prevent_warnings=False) + request = Request('https://example.com') + self.assertEqual( + crawler.request_fingerprinter.fingerprint(request), + _request_fingerprint_as_bytes(request), + ) + self.assertTrue(logged_warnings) + + def test_deprecated_implementation(self): + settings = { + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'PREVIOUS_VERSION', + } + with warnings.catch_warnings(record=True) as logged_warnings: + crawler = get_crawler(settings_dict=settings) + request = Request('https://example.com') + self.assertEqual( + crawler.request_fingerprinter.fingerprint(request), + _request_fingerprint_as_bytes(request), + ) + self.assertTrue(logged_warnings) + + def test_recommended_implementation(self): + settings = { + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + } + with warnings.catch_warnings(record=True) as logged_warnings: + crawler = get_crawler(settings_dict=settings) + request = Request('https://example.com') + self.assertEqual( + crawler.request_fingerprinter.fingerprint(request), + fingerprint(request), + ) + self.assertFalse(logged_warnings) + + def test_unknown_implementation(self): + settings = { + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.5', + } + with self.assertRaises(ValueError): + get_crawler(settings_dict=settings) + + +class CustomRequestFingerprinterTestCase(unittest.TestCase): + + def test_include_headers(self): + + class RequestFingerprinter: + + def fingerprint(self, request): + return fingerprint(request, include_headers=['X-ID']) + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + } + crawler = get_crawler(settings_dict=settings) + + r1 = Request("http://www.example.com", headers={'X-ID': '1'}) + fp1 = crawler.request_fingerprinter.fingerprint(r1) + r2 = Request("http://www.example.com", headers={'X-ID': '2'}) + fp2 = crawler.request_fingerprinter.fingerprint(r2) + self.assertNotEqual(fp1, fp2) + + def test_dont_canonicalize(self): + + class RequestFingerprinter: + cache = WeakKeyDictionary() + + def fingerprint(self, request): + if request not in self.cache: + fp = sha1() + fp.update(to_bytes(request.url)) + self.cache[request] = fp.digest() + return self.cache[request] + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + } + crawler = get_crawler(settings_dict=settings) + + r1 = Request("http://www.example.com?a=1&a=2") + fp1 = crawler.request_fingerprinter.fingerprint(r1) + r2 = Request("http://www.example.com?a=2&a=1") + fp2 = crawler.request_fingerprinter.fingerprint(r2) + self.assertNotEqual(fp1, fp2) + + def test_meta(self): + + class RequestFingerprinter: + + def fingerprint(self, request): + if 'fingerprint' in request.meta: + return request.meta['fingerprint'] + return fingerprint(request) + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + } + crawler = get_crawler(settings_dict=settings) + + r1 = Request("http://www.example.com") + fp1 = crawler.request_fingerprinter.fingerprint(r1) + r2 = Request("http://www.example.com", meta={'fingerprint': 'a'}) + fp2 = crawler.request_fingerprinter.fingerprint(r2) + r3 = Request("http://www.example.com", meta={'fingerprint': 'a'}) + fp3 = crawler.request_fingerprinter.fingerprint(r3) + r4 = Request("http://www.example.com", meta={'fingerprint': 'b'}) + fp4 = crawler.request_fingerprinter.fingerprint(r4) + self.assertNotEqual(fp1, fp2) + self.assertNotEqual(fp1, fp4) + self.assertNotEqual(fp2, fp4) + self.assertEqual(fp2, fp3) + + def test_from_crawler(self): + + class RequestFingerprinter: + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + def __init__(self, crawler): + self._fingerprint = crawler.settings['FINGERPRINT'] + + def fingerprint(self, request): + return self._fingerprint + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + 'FINGERPRINT': b'fingerprint', + } + crawler = get_crawler(settings_dict=settings) + + request = Request("http://www.example.com") + fingerprint = crawler.request_fingerprinter.fingerprint(request) + self.assertEqual(fingerprint, settings['FINGERPRINT']) + + def test_from_settings(self): + + class RequestFingerprinter: + + @classmethod + def from_settings(cls, settings): + return cls(settings) + + def __init__(self, settings): + self._fingerprint = settings['FINGERPRINT'] + + def fingerprint(self, request): + return self._fingerprint + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + 'FINGERPRINT': b'fingerprint', + } + crawler = get_crawler(settings_dict=settings) + + request = Request("http://www.example.com") + fingerprint = crawler.request_fingerprinter.fingerprint(request) + self.assertEqual(fingerprint, settings['FINGERPRINT']) + + def test_from_crawler_and_settings(self): + + class RequestFingerprinter: + + # This method is ignored due to the presence of from_crawler + @classmethod + def from_settings(cls, settings): + return cls(settings) + + @classmethod + def from_crawler(cls, crawler): + return cls(crawler) + + def __init__(self, crawler): + self._fingerprint = crawler.settings['FINGERPRINT'] + + def fingerprint(self, request): + return self._fingerprint + + settings = { + 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + 'FINGERPRINT': b'fingerprint', + } + crawler = get_crawler(settings_dict=settings) + + request = Request("http://www.example.com") + fingerprint = crawler.request_fingerprinter.fingerprint(request) + self.assertEqual(fingerprint, settings['FINGERPRINT']) + + if __name__ == "__main__": unittest.main() From 407562b38b6ab375ae650c8799bdd511025527f4 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Thu, 9 Jun 2022 00:25:03 -0300 Subject: [PATCH 100/532] Drop Python 3.6 support (#5514) * chore: Drop Python 3.6 support * Attend PR comments * Tweak versions * Update dependencies version * fix: Ubuntu workflow * fix windows workflow * chore: Remove comment * update `install_requires` dependencies versions * move lxml to main pinned requirements * Attend code-review comments * remove non-pinned 3.7 from windows workflow * simplify condition * lint * remove paragraph * refactor * remove leftover --- .github/workflows/checks.yml | 2 +- .github/workflows/tests-macos.yml | 2 +- .github/workflows/tests-ubuntu.yml | 11 ++++------- .github/workflows/tests-windows.yml | 5 +---- README.rst | 2 +- docs/contributing.rst | 10 +++++----- docs/intro/install.rst | 4 ++-- docs/topics/items.rst | 5 ----- docs/topics/media-pipeline.rst | 2 +- scrapy/__init__.py | 4 ++-- scrapy/utils/py36.py | 11 ----------- setup.py | 19 ++++++------------- tests/requirements.txt | 4 +--- tests/test_utils_python.py | 8 +------- tox.ini | 23 ++++++++--------------- 15 files changed, 34 insertions(+), 78 deletions(-) delete mode 100644 scrapy/utils/py36.py diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 98fa44c7f..b26f344ff 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -19,7 +19,7 @@ jobs: - python-version: 3.8 env: TOXENV: pylint - - python-version: 3.6 + - python-version: 3.7 env: TOXENV: typing - python-version: "3.10" # Keep in sync with .readthedocs.yml diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index 3aaf688c7..7819a4e12 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -7,7 +7,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"] + python-version: ["3.7", "3.8", "3.9", "3.10"] steps: - uses: actions/checkout@v2 diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 1fc8d914b..be40c7c71 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -8,9 +8,6 @@ jobs: fail-fast: false matrix: include: - - python-version: 3.7 - env: - TOXENV: py - python-version: 3.8 env: TOXENV: py @@ -26,19 +23,19 @@ jobs: - python-version: pypy3 env: TOXENV: pypy3 - PYPY_VERSION: 3.6-v7.3.3 + PYPY_VERSION: 3.9-v7.3.9 # pinned deps - - python-version: 3.6.12 + - python-version: 3.7.13 env: TOXENV: pinned - - python-version: 3.6.12 + - python-version: 3.7.13 env: TOXENV: asyncio-pinned - python-version: pypy3 env: TOXENV: pypy3-pinned - PYPY_VERSION: 3.6-v7.2.0 + PYPY_VERSION: 3.7-v7.3.5 # extras # extra-deps includes reppy, which does not support Python 3.9 diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index ab7385118..955b9b449 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -8,12 +8,9 @@ jobs: fail-fast: false matrix: include: - - python-version: 3.6 - env: - TOXENV: windows-pinned - python-version: 3.7 env: - TOXENV: py + TOXENV: windows-pinned - python-version: 3.8 env: TOXENV: py diff --git a/README.rst b/README.rst index 6b563d638..b543a30f4 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ including a list of features. Requirements ============ -* Python 3.6+ +* Python 3.7+ * Works on Linux, Windows, macOS, BSD Install diff --git a/docs/contributing.rst b/docs/contributing.rst index 4d2580a6c..946bdc23e 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -232,15 +232,15 @@ To run a specific test (say ``tests/test_loader.py``) use: To run the tests on a specific :doc:`tox ` environment, use ``-e `` with an environment name from ``tox.ini``. For example, to run -the tests with Python 3.6 use:: +the tests with Python 3.7 use:: - tox -e py36 + tox -e py37 You can also specify a comma-separated list of environments, and use :ref:`tox’s parallel mode ` to run the tests on multiple environments in parallel:: - tox -e py36,py38 -p auto + tox -e py37,py38 -p auto To pass command-line options to :doc:`pytest `, add them after ``--`` in your call to :doc:`tox `. Using ``--`` overrides the @@ -250,9 +250,9 @@ default positional arguments (``scrapy tests``) after ``--`` as well:: tox -- scrapy tests -x # stop after first failure You can also use the `pytest-xdist`_ plugin. For example, to run all tests on -the Python 3.6 :doc:`tox ` environment using all your CPU cores:: +the Python 3.7 :doc:`tox ` environment using all your CPU cores:: - tox -e py36 -- scrapy tests -n auto + tox -e py37 -- scrapy tests -n auto To see coverage report install :doc:`coverage ` (``pip install coverage``) and run: diff --git a/docs/intro/install.rst b/docs/intro/install.rst index b8d3a16bc..1f01c068d 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -9,8 +9,8 @@ Installation guide Supported Python versions ========================= -Scrapy requires Python 3.6+, either the CPython implementation (default) or -the PyPy 7.2.0+ implementation (see :ref:`python:implementations`). +Scrapy requires Python 3.7+, either the CPython implementation (default) or +the PyPy 7.3.5+ implementation (see :ref:`python:implementations`). .. _intro-install-scrapy: diff --git a/docs/topics/items.rst b/docs/topics/items.rst index 7cd482d07..167014381 100644 --- a/docs/topics/items.rst +++ b/docs/topics/items.rst @@ -102,11 +102,6 @@ Additionally, ``dataclass`` items also allow to: * define custom field metadata through :func:`dataclasses.field`, which can be used to :ref:`customize serialization `. -They work natively in Python 3.7 or later, or using the `dataclasses -backport`_ in Python 3.6. - -.. _dataclasses backport: https://pypi.org/project/dataclasses/ - Example:: from dataclasses import dataclass diff --git a/docs/topics/media-pipeline.rst b/docs/topics/media-pipeline.rst index 2513faae2..0925e6bb5 100644 --- a/docs/topics/media-pipeline.rst +++ b/docs/topics/media-pipeline.rst @@ -70,7 +70,7 @@ The advantage of using the :class:`ImagesPipeline` for image files is that you can configure some extra functions like generating thumbnails and filtering the images based on their size. -The Images Pipeline requires Pillow_ 4.0.0 or greater. It is used for +The Images Pipeline requires Pillow_ 7.1.0 or greater. It is used for thumbnailing and normalizing images to JPEG/RGB format. .. _Pillow: https://github.com/python-pillow/Pillow diff --git a/scrapy/__init__.py b/scrapy/__init__.py index 396f98219..86e584396 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -28,8 +28,8 @@ twisted_version = (_txv.major, _txv.minor, _txv.micro) # Check minimum required Python version -if sys.version_info < (3, 6): - print(f"Scrapy {__version__} requires Python 3.6+") +if sys.version_info < (3, 7): + print(f"Scrapy {__version__} requires Python 3.7+") sys.exit(1) diff --git a/scrapy/utils/py36.py b/scrapy/utils/py36.py deleted file mode 100644 index 653e2bbbb..000000000 --- a/scrapy/utils/py36.py +++ /dev/null @@ -1,11 +0,0 @@ -import warnings - -from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.utils.asyncgen import collect_asyncgen # noqa: F401 - - -warnings.warn( - "Module `scrapy.utils.py36` is deprecated, please import from `scrapy.utils.asyncgen` instead.", - category=ScrapyDeprecationWarning, - stacklevel=2, -) diff --git a/setup.py b/setup.py index d86c0f285..ed197273f 100644 --- a/setup.py +++ b/setup.py @@ -19,35 +19,29 @@ def has_environment_marker_platform_impl_support(): install_requires = [ - 'Twisted>=17.9.0', - 'cryptography>=2.0', + 'Twisted>=18.9.0', + 'cryptography>=2.8', 'cssselect>=0.9.1', 'itemloaders>=1.0.1', 'parsel>=1.5.0', - 'pyOpenSSL>=16.2.0', + 'pyOpenSSL>=19.1.0', 'queuelib>=1.4.2', 'service_identity>=16.0.0', 'w3lib>=1.17.0', - 'zope.interface>=4.1.3', + 'zope.interface>=5.1.0', 'protego>=0.1.15', 'itemadapter>=0.1.0', 'setuptools', 'tldextract', + 'lxml>=4.3.0', ] extras_require = {} cpython_dependencies = [ - 'lxml>=3.5.0', 'PyDispatcher>=2.0.5', ] if has_environment_marker_platform_impl_support(): extras_require[':platform_python_implementation == "CPython"'] = cpython_dependencies extras_require[':platform_python_implementation == "PyPy"'] = [ - # Earlier lxml versions are affected by - # https://foss.heptapod.net/pypy/pypy/-/issues/2498, - # which was fixed in Cython 0.26, released on 2017-06-19, and used to - # generate the C headers of lxml release tarballs published since then, the - # first of which was: - 'lxml>=4.0.0', 'PyPyDispatcher>=2.1.0', ] else: @@ -84,7 +78,6 @@ setup( 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.6', 'Programming Language :: Python :: 3.7', 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', @@ -95,7 +88,7 @@ setup( 'Topic :: Software Development :: Libraries :: Application Frameworks', 'Topic :: Software Development :: Libraries :: Python Modules', ], - python_requires='>=3.6', + python_requires='>=3.7', install_requires=install_requires, extras_require=extras_require, ) diff --git a/tests/requirements.txt b/tests/requirements.txt index d2a8aae1b..d9373dfa8 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -1,14 +1,12 @@ # Tests requirements attrs -dataclasses; python_version == '3.6' pyftpdlib pytest pytest-cov==3.0.0 pytest-xdist sybil >= 1.3.0 # https://github.com/cjw296/sybil/issues/20#issuecomment-605433422 testfixtures -uvloop < 0.15.0; platform_system != "Windows" and python_version == '3.6' -uvloop; platform_system != "Windows" and python_version > '3.6' +uvloop; platform_system != "Windows" # optional for shell wrapper tests bpython diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 4b3964154..7dec5624a 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -3,7 +3,6 @@ import gc import operator import platform import unittest -from datetime import datetime from itertools import count from warnings import catch_warnings, filterwarnings @@ -224,12 +223,7 @@ class UtilsPythonTestCase(unittest.TestCase): elif platform.python_implementation() == 'PyPy': self.assertEqual(get_func_args(str.split, stripself=True), ['sep', 'maxsplit']) self.assertEqual(get_func_args(operator.itemgetter(2), stripself=True), ['obj']) - - build_date = datetime.strptime(platform.python_build()[1], '%b %d %Y') - if build_date >= datetime(2020, 4, 7): # PyPy 3.6-v7.3.1 - self.assertEqual(get_func_args(" ".join, stripself=True), ['iterable']) - else: - self.assertEqual(get_func_args(" ".join, stripself=True), ['list']) + self.assertEqual(get_func_args(" ".join, stripself=True), ['iterable']) def test_without_none_values(self): self.assertEqual(without_none_values([1, None, 3, 4]), [1, 3, 4]) diff --git a/tox.ini b/tox.ini index 6951b6d16..ab8a715c2 100644 --- a/tox.ini +++ b/tox.ini @@ -11,15 +11,13 @@ minversion = 1.7.0 deps = -rtests/requirements.txt # mitmproxy does not support PyPy - # mitmproxy does not support Windows when running Python < 3.7 # Python 3.9+ requires mitmproxy >= 5.3.0 # mitmproxy >= 5.3.0 requires h2 >= 4.0, Twisted 21.2 requires h2 < 4.0 #mitmproxy >= 5.3.0; python_version >= '3.9' and implementation_name != 'pypy' # The tests hang with mitmproxy 8.0.0: https://github.com/scrapy/scrapy/issues/5454 - mitmproxy >= 4.0.4, < 8; python_version >= '3.7' and python_version < '3.9' and implementation_name != 'pypy' - mitmproxy >= 4.0.4, < 5; python_version >= '3.6' and python_version < '3.7' and platform_system != 'Windows' and implementation_name != 'pypy' + mitmproxy >= 4.0.4, < 8; python_version < '3.9' and implementation_name != 'pypy' # newer markupsafe is incompatible with deps of old mitmproxy (which we get on Python 3.7 and lower) - markupsafe < 2.1.0; python_version >= '3.6' and python_version < '3.8' and implementation_name != 'pypy' + markupsafe < 2.1.0; python_version < '3.8' and implementation_name != 'pypy' # Extras botocore>=1.4.87 passenv = @@ -44,7 +42,6 @@ deps = types-pyOpenSSL==20.0.3 types-setuptools==57.0.0 commands = - pip install types-dataclasses # remove once py36 support is dropped mypy --show-error-codes {posargs: scrapy tests} [testenv:security] @@ -75,18 +72,19 @@ commands = [pinned] deps = - cryptography==2.0 + cryptography==2.8 cssselect==0.9.1 h2==3.0 itemadapter==0.1.0 parsel==1.5.0 Protego==0.1.15 - pyOpenSSL==16.2.0 + pyOpenSSL==19.1.0 queuelib==1.4.2 service_identity==16.0.0 - Twisted[http2]==17.9.0 + Twisted[http2]==18.9.0 w3lib==1.17.0 - zope.interface==4.1.3 + zope.interface==5.1.0 + lxml==4.3.0 -rtests/requirements.txt # mitmproxy 4.0.4+ requires upgrading some of the pinned dependencies @@ -95,7 +93,7 @@ deps = # Extras botocore==1.4.87 google-cloud-storage==1.29.0 - Pillow==4.0.0 + Pillow==7.1.0 setenv = _SCRAPY_PINNED=true install_command = @@ -104,7 +102,6 @@ install_command = [testenv:pinned] deps = {[pinned]deps} - lxml==3.5.0 PyDispatcher==2.0.5 install_command = {[pinned]install_command} setenv = @@ -114,9 +111,6 @@ setenv = basepython = python3 deps = {[pinned]deps} - # First lxml version that includes a Windows wheel for Python 3.6, so we do - # not need to build lxml from sources in a CI Windows job: - lxml==3.8.0 PyDispatcher==2.0.5 install_command = {[pinned]install_command} setenv = @@ -155,7 +149,6 @@ commands = basepython = {[testenv:pypy3]basepython} deps = {[pinned]deps} - lxml==4.0.0 PyPyDispatcher==2.1.0 commands = {[testenv:pypy3]commands} install_command = {[pinned]install_command} From 2e6721fd86e3bd00301f8cd3ceb4175b2f395017 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Thu, 9 Jun 2022 08:37:01 -0300 Subject: [PATCH 101/532] docs: Update minimal versions that Scrapy is tested against --- docs/intro/install.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 1f01c068d..23c3af74b 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -54,9 +54,9 @@ Scrapy is written in pure Python and depends on a few key Python packages (among The minimal versions which Scrapy is tested against are: -* Twisted 14.0 -* lxml 3.4 -* pyOpenSSL 0.14 +* Twisted 18.9.0 +* lxml 4.3.0 +* pyOpenSSL 19.1.0 Scrapy may work with older versions of these packages but it is not guaranteed it will continue working From 6770d1ec62012fcfe8a36fdebeeb89cb5157c2df Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 9 Jun 2022 09:08:09 -0300 Subject: [PATCH 102/532] chore(tests): Remove validations for unsupported modules versions --- tests/test_downloadermiddleware.py | 20 +------------------- tests/test_utils_signal.py | 20 -------------------- tests/test_webclient.py | 5 ----- 3 files changed, 1 insertion(+), 44 deletions(-) diff --git a/tests/test_downloadermiddleware.py b/tests/test_downloadermiddleware.py index b538a0ed3..38be915f2 100644 --- a/tests/test_downloadermiddleware.py +++ b/tests/test_downloadermiddleware.py @@ -1,13 +1,11 @@ import asyncio -from unittest import mock, SkipTest +from unittest import mock from pytest import mark -from twisted import version as twisted_version from twisted.internet import defer from twisted.internet.defer import Deferred from twisted.trial.unittest import TestCase from twisted.python.failure import Failure -from twisted.python.versions import Version from scrapy.http import Request, Response from scrapy.spiders import Spider @@ -218,16 +216,6 @@ class MiddlewareUsingCoro(ManagerTestCase): """Middlewares using asyncio coroutines should work""" def test_asyncdef(self): - if ( - self.reactor_pytest == 'asyncio' - and twisted_version < Version('twisted', 18, 4, 0) - ): - raise SkipTest( - 'Due to https://twistedmatrix.com/trac/ticket/9390, this test ' - 'hangs when using AsyncIO and Twisted versions lower than ' - '18.4.0' - ) - resp = Response('http://example.com/index.html') class CoroMiddleware: @@ -248,12 +236,6 @@ class MiddlewareUsingCoro(ManagerTestCase): @mark.only_asyncio() def test_asyncdef_asyncio(self): - if twisted_version < Version('twisted', 18, 4, 0): - raise SkipTest( - 'Due to https://twistedmatrix.com/trac/ticket/9390, this test ' - 'hangs when using Twisted versions lower than 18.4.0' - ) - resp = Response('http://example.com/index.html') class CoroMiddleware: diff --git a/tests/test_utils_signal.py b/tests/test_utils_signal.py index ad7394232..a36e7bc97 100644 --- a/tests/test_utils_signal.py +++ b/tests/test_utils_signal.py @@ -1,13 +1,10 @@ import asyncio -from unittest import SkipTest from pydispatch import dispatcher from pytest import mark from testfixtures import LogCapture -from twisted import version as twisted_version from twisted.internet import defer, reactor from twisted.python.failure import Failure -from twisted.python.versions import Version from twisted.trial import unittest from scrapy.utils.signal import send_catch_log, send_catch_log_deferred @@ -81,16 +78,6 @@ class SendCatchLogDeferredAsyncDefTest(SendCatchLogDeferredTest): return "OK" def test_send_catch_log(self): - if ( - self.reactor_pytest == 'asyncio' - and twisted_version < Version('twisted', 18, 4, 0) - ): - raise SkipTest( - 'Due to https://twistedmatrix.com/trac/ticket/9390, this test ' - 'fails due to a timeout when using AsyncIO and Twisted ' - 'versions lower than 18.4.0' - ) - return super().test_send_catch_log() @@ -104,13 +91,6 @@ class SendCatchLogDeferredAsyncioTest(SendCatchLogDeferredTest): return await get_from_asyncio_queue("OK") def test_send_catch_log(self): - if twisted_version < Version('twisted', 18, 4, 0): - raise SkipTest( - 'Due to https://twistedmatrix.com/trac/ticket/9390, this test ' - 'fails due to a timeout when using Twisted versions lower ' - 'than 18.4.0' - ) - return super().test_send_catch_log() diff --git a/tests/test_webclient.py b/tests/test_webclient.py index a6d55cb38..0d5827339 100644 --- a/tests/test_webclient.py +++ b/tests/test_webclient.py @@ -4,10 +4,7 @@ Tests borrowed from the twisted.web.client tests. """ import os import shutil -import sys -from pkg_resources import parse_version -import cryptography import OpenSSL.SSL from twisted.trial import unittest from twisted.web import server, static, util, resource @@ -417,8 +414,6 @@ class WebClientCustomCiphersSSLTestCase(WebClientSSLTestCase): ).addCallback(self.assertEqual, to_bytes(s)) def testPayloadDisabledCipher(self): - if sys.implementation.name == "pypy" and parse_version(cryptography.__version__) <= parse_version("2.3.1"): - self.skipTest("This test expects a failure, but the code does work in PyPy with cryptography<=2.3.1") s = "0123456789" * 10 settings = Settings({'DOWNLOADER_CLIENT_TLS_CIPHERS': 'ECDHE-RSA-AES256-GCM-SHA384'}) client_context_factory = create_instance(ScrapyClientContextFactory, settings=settings, crawler=None) From c4c5c9f25841a783aab2c682125f3200d6c6e446 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 9 Jun 2022 10:00:44 -0300 Subject: [PATCH 103/532] docs: Remove minimal versions paragraphs --- docs/intro/install.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 23c3af74b..c1fd6d522 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -52,12 +52,6 @@ Scrapy is written in pure Python and depends on a few key Python packages (among * `twisted`_, an asynchronous networking framework * `cryptography`_ and `pyOpenSSL`_, to deal with various network-level security needs -The minimal versions which Scrapy is tested against are: - -* Twisted 18.9.0 -* lxml 4.3.0 -* pyOpenSSL 19.1.0 - Scrapy may work with older versions of these packages but it is not guaranteed it will continue working because it’s not being tested against them. From 197aca2c94201f9944404f30fc4a002309cad99b Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 9 Jun 2022 10:11:49 -0300 Subject: [PATCH 104/532] docs: Remove leftover --- docs/intro/install.rst | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index c1fd6d522..80a9c16d6 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -52,10 +52,6 @@ Scrapy is written in pure Python and depends on a few key Python packages (among * `twisted`_, an asynchronous networking framework * `cryptography`_ and `pyOpenSSL`_, to deal with various network-level security needs -Scrapy may work with older versions of these packages -but it is not guaranteed it will continue working -because it’s not being tested against them. - Some of these packages themselves depends on non-Python packages that might require additional installation steps depending on your platform. Please check :ref:`platform-specific guides below `. From ddfd192b704dddfefe2dd78345de239995a40159 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Sat, 11 Jun 2022 23:51:34 +0430 Subject: [PATCH 105/532] add tests for multiple headers with same name --- tests/test_http_headers.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tests/test_http_headers.py b/tests/test_http_headers.py index 64ff7a73d..0c51fd701 100644 --- a/tests/test_http_headers.py +++ b/tests/test_http_headers.py @@ -38,6 +38,13 @@ class HeadersTest(unittest.TestCase): self.assertEqual(h.getlist('X-Forwarded-For'), [b'ip1', b'ip2']) assert h.getlist('X-Forwarded-For') is not hlist + def test_multivalue_for_one_header(self): + h = Headers((("a", "b"), ("a", "c"))) + self.assertEqual(h["a"], b"c") + self.assertEqual(h.get("a"), b"c") + self.assertEqual(h.getlist("a"), [b"b", b"c"]) + assert h.getlist("a") is not ["b", "c"] + def test_encode_utf8(self): h = Headers({'key': '\xa3'}, encoding='utf-8') key, val = dict(h).popitem() From 6a0bcf97cc6016cb966b92170709bc7518cf62c2 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Sat, 11 Jun 2022 23:52:21 +0430 Subject: [PATCH 106/532] Merge values of multiple headers with same name (#5515) --- scrapy/http/headers.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index 1a2b99b0a..a9471d721 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -1,6 +1,7 @@ from w3lib.http import headers_dict_to_raw from scrapy.utils.datatypes import CaselessDict from scrapy.utils.python import to_unicode +from collections.abc import Mapping class Headers(CaselessDict): @@ -10,6 +11,13 @@ class Headers(CaselessDict): self.encoding = encoding super().__init__(seq) + def update(self, seq): + seq = seq.items() if isinstance(seq, Mapping) else seq + iseq = {} + for k, v in seq: + iseq.setdefault(self.normkey(k), []).extend(self.normvalue(v)) + super().update(iseq) + def normkey(self, key): """Normalize key to bytes""" return self._tobytes(key.title()) @@ -86,4 +94,5 @@ class Headers(CaselessDict): def __copy__(self): return self.__class__(self) + copy = __copy__ From a135d6caf050f4b7b5af28d4cccc5d5ef51dbaf6 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Mon, 13 Jun 2022 15:24:30 +0430 Subject: [PATCH 107/532] Move Mapping import line up MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- scrapy/http/headers.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index a9471d721..9c03fe54f 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -1,7 +1,8 @@ +from collections.abc import Mapping + from w3lib.http import headers_dict_to_raw from scrapy.utils.datatypes import CaselessDict from scrapy.utils.python import to_unicode -from collections.abc import Mapping class Headers(CaselessDict): From 892c2a46554bdf80d49d3f28cc012c49cd1e19ca Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Mon, 13 Jun 2022 23:46:42 +0430 Subject: [PATCH 108/532] delete unnecessary test --- tests/test_http_headers.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_http_headers.py b/tests/test_http_headers.py index 0c51fd701..1ca936247 100644 --- a/tests/test_http_headers.py +++ b/tests/test_http_headers.py @@ -43,7 +43,6 @@ class HeadersTest(unittest.TestCase): self.assertEqual(h["a"], b"c") self.assertEqual(h.get("a"), b"c") self.assertEqual(h.getlist("a"), [b"b", b"c"]) - assert h.getlist("a") is not ["b", "c"] def test_encode_utf8(self): h = Headers({'key': '\xa3'}, encoding='utf-8') From 9e265a2c1f6bccb551e8292785e09462594b8402 Mon Sep 17 00:00:00 2001 From: Kromitvs <74136201+Kromitvs@users.noreply.github.com> Date: Thu, 16 Jun 2022 19:52:19 +0100 Subject: [PATCH 109/532] Mind body to choose response class in cache, FTP and HTTP/1.0 (#4873) --- scrapy/core/downloader/handlers/ftp.py | 6 +-- scrapy/core/downloader/webclient.py | 2 +- scrapy/extensions/httpcache.py | 4 +- scrapy/responsetypes.py | 10 ++-- tests/test_downloader_handlers.py | 54 ++++++++++++++++++-- tests/test_downloadermiddleware_httpcache.py | 15 ++++++ tests/test_responsetypes.py | 2 + 7 files changed, 78 insertions(+), 15 deletions(-) diff --git a/scrapy/core/downloader/handlers/ftp.py b/scrapy/core/downloader/handlers/ftp.py index 3ef129587..a495874bd 100644 --- a/scrapy/core/downloader/handlers/ftp.py +++ b/scrapy/core/downloader/handlers/ftp.py @@ -102,11 +102,11 @@ class FTPDownloadHandler: def _build_response(self, result, request, protocol): self.result = result - respcls = responsetypes.from_args(url=request.url) protocol.close() - body = protocol.filename or protocol.body.read() headers = {"local filename": protocol.filename or '', "size": protocol.size} - return respcls(url=request.url, status=200, body=to_bytes(body), headers=headers) + body = to_bytes(protocol.filename or protocol.body.read()) + respcls = responsetypes.from_args(url=request.url, body=body) + return respcls(url=request.url, status=200, body=body, headers=headers) def _failed(self, result, request): message = result.getErrorMessage() diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index 06cb96489..7d048c1e4 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -112,7 +112,7 @@ class ScrapyHTTPClientFactory(ClientFactory): request.meta['download_latency'] = self.headers_time - self.start_time status = int(self.status) headers = Headers(self.response_headers) - respcls = responsetypes.from_args(headers=headers, url=self._url) + respcls = responsetypes.from_args(headers=headers, url=self._url, body=body) return respcls(url=self._url, status=status, headers=headers, body=body, protocol=to_unicode(self.version)) def _set_connection_attributes(self, request): diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index c71484cfa..843e14812 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -240,7 +240,7 @@ class DbmCacheStorage: status = data['status'] headers = Headers(data['headers']) body = data['body'] - respcls = responsetypes.from_args(headers=headers, url=url) + respcls = responsetypes.from_args(headers=headers, url=url, body=body) response = respcls(url=url, headers=headers, status=status, body=body) return response @@ -299,7 +299,7 @@ class FilesystemCacheStorage: url = metadata.get('response_url') status = metadata['status'] headers = Headers(headers_raw_to_dict(rawheaders)) - respcls = responsetypes.from_args(headers=headers, url=url) + respcls = responsetypes.from_args(headers=headers, url=url, body=body) response = respcls(url=url, headers=headers, status=status, body=body) return response diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index 6ed9f8b8f..3efd4d2fd 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -95,12 +95,14 @@ class ResponseTypes: chunk = to_bytes(chunk) if not binary_is_text(chunk): return self.from_mimetype('application/octet-stream') - elif b"" in chunk.lower(): + lowercase_chunk = chunk.lower() + if b"" in lowercase_chunk: return self.from_mimetype('text/html') - elif b"' in lowercase_chunk: + return self.from_mimetype('text/html') + return self.from_mimetype('text') def from_args(self, headers=None, url=None, filename=None, body=None): """Guess the most appropriate Response class based on diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 2bb53950d..72f52121e 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -25,7 +25,7 @@ from scrapy.core.downloader.handlers.http10 import HTTP10DownloadHandler from scrapy.core.downloader.handlers.http11 import HTTP11DownloadHandler from scrapy.core.downloader.handlers.s3 import S3DownloadHandler from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning -from scrapy.http import Headers, Request +from scrapy.http import Headers, HtmlResponse, Request from scrapy.http.response.text import TextResponse from scrapy.responsetypes import responsetypes from scrapy.spiders import Spider @@ -389,6 +389,23 @@ class HttpTestCase(unittest.TestCase): d.addCallback(self.assertEqual, b'159') return d + def _test_response_class(self, filename, body, response_class): + def _test(response): + self.assertEqual(type(response), response_class) + + request = Request(self.getURL(filename), body=body) + return self.download_request(request, Spider('foo')).addCallback(_test) + + def test_response_class_from_url(self): + return self._test_response_class('foo.html', b'', HtmlResponse) + + def test_response_class_from_body(self): + return self._test_response_class( + 'foo', + b"\n.", + HtmlResponse, + ) + class Http10TestCase(HttpTestCase): """HTTP 1.0 test case""" @@ -971,6 +988,12 @@ class BaseFTPTestCase(unittest.TestCase): password = "passwd" req_meta = {"ftp_user": username, "ftp_password": password} + test_files = ( + ('file.txt', b"I have the power!"), + ('file with spaces.txt', b"Moooooooooo power!"), + ('html-file-without-extension', b"\n."), + ) + def setUp(self): from twisted.protocols.ftp import FTPRealm, FTPFactory from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler @@ -981,8 +1004,8 @@ class BaseFTPTestCase(unittest.TestCase): userdir = os.path.join(self.directory, self.username) os.mkdir(userdir) fp = FilePath(userdir) - fp.child('file.txt').setContent(b"I have the power!") - fp.child('file with spaces.txt').setContent(b"Moooooooooo power!") + for filename, content in self.test_files: + fp.child(filename).setContent(content) # setup server realm = FTPRealm(anonymousRoot=self.directory, userHome=self.directory) @@ -1069,6 +1092,27 @@ class BaseFTPTestCase(unittest.TestCase): return self._add_test_callbacks(d, _test) + def _test_response_class(self, filename, response_class): + f, local_fname = tempfile.mkstemp() + local_fname = to_bytes(local_fname) + os.close(f) + meta = {} + meta.update(self.req_meta) + request = Request(url=f"ftp://127.0.0.1:{self.portNum}/{filename}", + meta=meta) + d = self.download_handler.download_request(request, None) + + def _test(r): + self.assertEqual(type(r), response_class) + os.remove(local_fname) + return self._add_test_callbacks(d, _test) + + def test_response_class_from_url(self): + return self._test_response_class('file.txt', TextResponse) + + def test_response_class_from_body(self): + return self._test_response_class('html-file-without-extension', HtmlResponse) + class FTPTestCase(BaseFTPTestCase): @@ -1104,8 +1148,8 @@ class AnonymousFTPTestCase(BaseFTPTestCase): os.mkdir(self.directory) fp = FilePath(self.directory) - fp.child('file.txt').setContent(b"I have the power!") - fp.child('file with spaces.txt').setContent(b"Moooooooooo power!") + for filename, content in self.test_files: + fp.child(filename).setContent(content) # setup server for anonymous access realm = FTPRealm(anonymousRoot=self.directory) diff --git a/tests/test_downloadermiddleware_httpcache.py b/tests/test_downloadermiddleware_httpcache.py index 0c6dcf2aa..928c007f5 100644 --- a/tests/test_downloadermiddleware_httpcache.py +++ b/tests/test_downloadermiddleware_httpcache.py @@ -122,6 +122,21 @@ class DefaultStorageTest(_BaseTest): time.sleep(0.5) # give the chance to expire assert storage.retrieve_response(self.spider, self.request) + def test_storage_no_content_type_header(self): + """Test that the response body is used to get the right response class + even if there is no Content-Type header""" + with self._storage() as storage: + assert storage.retrieve_response(self.spider, self.request) is None + response = Response( + 'http://www.example.com', + body=b'\n.', + status=202, + ) + storage.store_response(self.spider, self.request, response) + cached_response = storage.retrieve_response(self.spider, self.request) + self.assertIsInstance(cached_response, HtmlResponse) + self.assertEqualResponse(response, cached_response) + class DbmStorageTest(DefaultStorageTest): diff --git a/tests/test_responsetypes.py b/tests/test_responsetypes.py index c07d3a99c..4b4095fb0 100644 --- a/tests/test_responsetypes.py +++ b/tests/test_responsetypes.py @@ -54,6 +54,8 @@ class ResponseTypesTest(unittest.TestCase): (b'\x03\x02\xdf\xdd\x23', Response), (b'Some plain text\ndata with tabs\t and null bytes\0', TextResponse), (b'Hello', HtmlResponse), + # https://codersblock.com/blog/the-smallest-valid-html5-page/ + (b'\n.', HtmlResponse), (b' Date: Thu, 16 Jun 2022 20:53:14 +0200 Subject: [PATCH 110/532] Update for Python 3.7+ --- docs/topics/exporters.rst | 10 +--------- scrapy/exporters.py | 2 +- scrapy/settings/__init__.py | 9 ++++----- tests/test_exporters.py | 5 ++--- tests/test_feedexport.py | 10 +++------- 5 files changed, 11 insertions(+), 25 deletions(-) diff --git a/docs/topics/exporters.rst b/docs/topics/exporters.rst index 7580011ac..3c36ef002 100644 --- a/docs/topics/exporters.rst +++ b/docs/topics/exporters.rst @@ -205,7 +205,7 @@ BaseItemExporter ['field1', 'field2'] - - A dict [3]_ where keys are fields and values are output names:: + - A dict where keys are fields and values are output names:: {'field1': 'Field 1', 'field2': 'Field 2'} @@ -214,14 +214,6 @@ BaseItemExporter all their possible fields, exporters that do not support exporting a different subset of fields per item will only export the fields found in the first item exported. - .. [3] Dicts preserve insertion order since `Python 3.7`_ - (`CPython 3.6`_, `PyPy 2.5`_). If you are using an older version - of Python, use an OrderedDict_ to enforce a specific field order. - - .. _Python 3.7: https://docs.python.org/whatsnew/3.7.html - .. _CPython 3.6: https://docs.python.org/whatsnew/3.6.html#new-dict-implementation - .. _PyPy 2.5: https://morepypy.blogspot.com/2015/02/pypy-250-released.html - .. _OrderedDict: https://docs.python.org/library/collections.html#collections.OrderedDict .. attribute:: export_empty_fields diff --git a/scrapy/exporters.py b/scrapy/exporters.py index ad12f26d6..76cbe4d4b 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -2,13 +2,13 @@ Item Exporters are used to export/serialize items into different formats. """ -from collections import Mapping import csv import io import marshal import pickle import pprint import warnings +from collections.abc import Mapping from xml.sax.saxutils import XMLGenerator from itemadapter import is_item, ItemAdapter diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index 2bbe38481..6cacc63e1 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -1,6 +1,5 @@ import json import copy -from collections import OrderedDict from collections.abc import MutableMapping from importlib import import_module from pprint import pformat @@ -199,7 +198,7 @@ class BaseSettings(MutableMapping): return dict(value) def getdictorlist(self, name, default=None): - """Get a setting value as either an ``OrderedDict`` or a list. + """Get a setting value as either a :class:`dict` or a :class:`list`. If the setting is already a dict or a list, a copy of it will be returned. @@ -209,7 +208,7 @@ class BaseSettings(MutableMapping): For example, settings populated from the command line will return: - - ``OrdetedDict([('key1', 'value1'), ('key2', 'value2')])`` if set to + - ``{'key1': 'value1', 'key2': 'value2'}`` if set to ``'{"key1": "value1", "key2": "value2"}'`` - ``['one', 'two']`` if set to ``'["one", "two"]'`` or ``'one,two'`` @@ -222,10 +221,10 @@ class BaseSettings(MutableMapping): """ value = self.get(name, default) if value is None: - return OrderedDict() + return {} if isinstance(value, str): try: - return json.loads(value, object_pairs_hook=OrderedDict) + return json.loads(value) except ValueError: return value.split(',') return copy.deepcopy(value) diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 6ba7428f6..096cd3116 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -4,7 +4,6 @@ import marshal import pickle import tempfile import unittest -from collections import OrderedDict from io import BytesIO from datetime import datetime from warnings import catch_warnings, filterwarnings @@ -114,11 +113,11 @@ class BaseItemExporterTest(unittest.TestCase): self.assertEqual(name, 'John\xa3') ie = self._get_exporter( - fields_to_export=OrderedDict([('name', u'名稱')]) + fields_to_export={'name': '名稱'} ) self.assertEqual( list(ie._get_serialized_fields(self.i)), - [(u'名稱', u'John\xa3')] + [('名稱', 'John\xa3')] ) def test_field_custom_serializer(self): diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 83aabbdc7..9098e035d 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -11,7 +11,7 @@ import sys import tempfile import warnings from abc import ABC, abstractmethod -from collections import defaultdict, OrderedDict +from collections import defaultdict from contextlib import ExitStack from io import BytesIO from logging import getLogger @@ -998,9 +998,7 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_items_field_names(self): items = [{'foo': 'bar'}] - header = OrderedDict(( - ("foo", "Foo"), - )) + header = {'foo': 'Foo'} rows = [{'Foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': header} yield self.assertExported(items, list(header.values()), rows, @@ -1023,9 +1021,7 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_items_json_field_names(self): items = [{'foo': 'bar'}] - header = OrderedDict(( - ("foo", "Foo"), - )) + header = {'foo': 'Foo'} rows = [{'Foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} yield self.assertExported(items, list(header.values()), rows, From 1b9ed22becf03311ec014dc9b7e0c09ce87b612c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 08:27:17 +0200 Subject: [PATCH 111/532] Remove Python < 3.7 leftover --- tests/test_feedexport.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 9098e035d..946c94bd4 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -1004,8 +1004,6 @@ class FeedExportTest(FeedExportTestBase): yield self.assertExported(items, list(header.values()), rows, settings=settings) - @pytest.mark.skipif(sys.version_info < (3, 7), - reason='Only official in Python 3.7+') @defer.inlineCallbacks def test_export_items_dict_field_names(self): items = [{'foo': 'bar'}] From 24f382fa459434cccfa4c0a8884a48d09d75e243 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 08:31:45 +0200 Subject: [PATCH 112/532] test_feedexport: remove ordered=False --- tests/test_feedexport.py | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 946c94bd4..4006b5957 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -657,8 +657,8 @@ class FeedExportTestBase(ABC, unittest.TestCase): return data @defer.inlineCallbacks - def assertExported(self, items, header, rows, settings=None, ordered=True): - yield self.assertExportedCsv(items, header, rows, settings, ordered) + def assertExported(self, items, header, rows, settings=None): + yield self.assertExportedCsv(items, header, rows, settings) yield self.assertExportedJsonLines(items, rows, settings) yield self.assertExportedXml(items, rows, settings) yield self.assertExportedPickle(items, rows, settings) @@ -719,7 +719,7 @@ class FeedExportTest(FeedExportTestBase): return content @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): + def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} settings.update({ 'FEEDS': { @@ -730,10 +730,7 @@ class FeedExportTest(FeedExportTestBase): reader = csv.DictReader(to_unicode(data['csv']).splitlines()) got_rows = list(reader) - if ordered: - self.assertEqual(reader.fieldnames, header) - else: - self.assertEqual(set(reader.fieldnames), set(header)) + self.assertEqual(reader.fieldnames, header) self.assertEqual(rows, got_rows) @@ -886,7 +883,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} ] header = self.MyItem.fields.keys() - yield self.assertExported(items, header, rows, ordered=False) + yield self.assertExported(items, header, rows) @defer.inlineCallbacks def test_export_no_items_not_store_empty(self): @@ -958,7 +955,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam4', 'foo': '', 'baz': ''}, ] rows_jl = [dict(row) for row in items] - yield self.assertExportedCsv(items, header, rows_csv, ordered=False) + yield self.assertExportedCsv(items, header, rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -968,7 +965,7 @@ class FeedExportTest(FeedExportTestBase): header = ["foo"] rows = [{'foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': []} - yield self.assertExportedCsv(items, header, rows, ordered=False) + yield self.assertExportedCsv(items, header, rows) yield self.assertExportedJsonLines(items, rows, settings) @defer.inlineCallbacks @@ -1146,7 +1143,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam', 'foo': 'bar'} ] rows_jl = items - yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv, ordered=False) + yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -2065,7 +2062,7 @@ class BatchDeliveriesTest(FeedExportTestBase): self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): + def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} settings.update({ 'FEEDS': { From 3729c6d26698ae6b8a7ef297606a1c7630d82619 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 08:33:34 +0200 Subject: [PATCH 113/532] Remove unused import and redundant import --- tests/test_feedexport.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 4006b5957..8ef221b70 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -21,7 +21,6 @@ from unittest import mock from urllib.parse import urljoin, quote from urllib.request import pathname2url -import pytest import lxml.etree from testfixtures import LogCapture from twisted.internet import defer @@ -731,7 +730,6 @@ class FeedExportTest(FeedExportTestBase): reader = csv.DictReader(to_unicode(data['csv']).splitlines()) got_rows = list(reader) self.assertEqual(reader.fieldnames, header) - self.assertEqual(rows, got_rows) @defer.inlineCallbacks @@ -1815,7 +1813,6 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_lzma_plugin_filters(self): - import sys if "PyPy" in sys.version: # https://foss.heptapod.net/pypy/pypy/-/issues/3527 raise unittest.SkipTest("lzma filters doesn't work in PyPy") From 6e878490e823a8105276b71ca5f6dc789465d330 Mon Sep 17 00:00:00 2001 From: Michel Ace Date: Fri, 17 Jun 2022 08:37:14 +0200 Subject: [PATCH 114/532] Support and prefer the .jsonl file extension (#4848) --- docs/intro/overview.rst | 4 ++-- docs/intro/tutorial.rst | 2 +- docs/topics/feed-exports.rst | 3 ++- docs/topics/item-pipeline.rst | 8 ++++---- scrapy/settings/default_settings.py | 1 + 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/intro/overview.rst b/docs/intro/overview.rst index f3d652621..cfa6bfa83 100644 --- a/docs/intro/overview.rst +++ b/docs/intro/overview.rst @@ -45,9 +45,9 @@ https://quotes.toscrape.com, following the pagination:: Put this in a text file, name it to something like ``quotes_spider.py`` and run the spider using the :command:`runspider` command:: - scrapy runspider quotes_spider.py -o quotes.jl + scrapy runspider quotes_spider.py -o quotes.jsonl -When this finishes you will have in the ``quotes.jl`` file a list of the +When this finishes you will have in the ``quotes.jsonl`` file a list of the quotes in JSON Lines format, containing text and author, looking like this:: {"author": "Jane Austen", "text": "\u201cThe person, be it gentleman or lady, who has not pleasure in a good novel, must be intolerably stupid.\u201d"} diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index cde1b1ef4..75928077e 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -482,7 +482,7 @@ to append new content to any existing file. However, appending to a JSON file makes the file contents invalid JSON. When appending to a file, consider using a different serialization format, such as `JSON Lines`_:: - scrapy crawl quotes -o quotes.jl + scrapy crawl quotes -o quotes.jsonl The `JSON Lines`_ format is useful because it's stream-like, you can easily append new records to it. It doesn't have the same problem of JSON when you run diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index 9a13eb82f..398f80633 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -638,6 +638,7 @@ Default:: { 'json': 'scrapy.exporters.JsonItemExporter', 'jsonlines': 'scrapy.exporters.JsonLinesItemExporter', + 'jsonl': 'scrapy.exporters.JsonLinesItemExporter', 'jl': 'scrapy.exporters.JsonLinesItemExporter', 'csv': 'scrapy.exporters.CsvItemExporter', 'xml': 'scrapy.exporters.XmlItemExporter', @@ -763,7 +764,7 @@ source spider in the feed URI: #. Use ``%(spider_name)s`` in your feed URI:: - scrapy crawl -o "%(spider_name)s.jl" + scrapy crawl -o "%(spider_name)s.jsonl" .. _URIs: https://en.wikipedia.org/wiki/Uniform_Resource_Identifier diff --git a/docs/topics/item-pipeline.rst b/docs/topics/item-pipeline.rst index 882ff5661..af294f52c 100644 --- a/docs/topics/item-pipeline.rst +++ b/docs/topics/item-pipeline.rst @@ -99,11 +99,11 @@ contain a price:: raise DropItem(f"Missing price in {item}") -Write items to a JSON file --------------------------- +Write items to a JSON lines file +-------------------------------- The following pipeline stores all scraped items (from all spiders) into a -single ``items.jl`` file, containing one item per line serialized in JSON +single ``items.jsonl`` file, containing one item per line serialized in JSON format:: import json @@ -113,7 +113,7 @@ format:: class JsonWriterPipeline: def open_spider(self, spider): - self.file = open('items.jl', 'w') + self.file = open('items.jsonl', 'w') def close_spider(self, spider): self.file.close() diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index f5a3efe69..ff86af125 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -154,6 +154,7 @@ FEED_EXPORTERS = {} FEED_EXPORTERS_BASE = { 'json': 'scrapy.exporters.JsonItemExporter', 'jsonlines': 'scrapy.exporters.JsonLinesItemExporter', + 'jsonl': 'scrapy.exporters.JsonLinesItemExporter', 'jl': 'scrapy.exporters.JsonLinesItemExporter', 'csv': 'scrapy.exporters.CsvItemExporter', 'xml': 'scrapy.exporters.XmlItemExporter', From 516e2d6ec0da77b8e0c01eb5188311b5fbeaa22e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 08:55:45 +0200 Subject: [PATCH 115/532] Revert "test_feedexport: remove ordered=False" This reverts commit 24f382fa459434cccfa4c0a8884a48d09d75e243. --- tests/test_feedexport.py | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 8ef221b70..fe90501fb 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -656,8 +656,8 @@ class FeedExportTestBase(ABC, unittest.TestCase): return data @defer.inlineCallbacks - def assertExported(self, items, header, rows, settings=None): - yield self.assertExportedCsv(items, header, rows, settings) + def assertExported(self, items, header, rows, settings=None, ordered=True): + yield self.assertExportedCsv(items, header, rows, settings, ordered) yield self.assertExportedJsonLines(items, rows, settings) yield self.assertExportedXml(items, rows, settings) yield self.assertExportedPickle(items, rows, settings) @@ -718,7 +718,7 @@ class FeedExportTest(FeedExportTestBase): return content @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None): + def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): settings = settings or {} settings.update({ 'FEEDS': { @@ -729,7 +729,11 @@ class FeedExportTest(FeedExportTestBase): reader = csv.DictReader(to_unicode(data['csv']).splitlines()) got_rows = list(reader) - self.assertEqual(reader.fieldnames, header) + if ordered: + self.assertEqual(reader.fieldnames, header) + else: + self.assertEqual(set(reader.fieldnames), set(header)) + self.assertEqual(rows, got_rows) @defer.inlineCallbacks @@ -881,7 +885,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} ] header = self.MyItem.fields.keys() - yield self.assertExported(items, header, rows) + yield self.assertExported(items, header, rows, ordered=False) @defer.inlineCallbacks def test_export_no_items_not_store_empty(self): @@ -953,7 +957,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam4', 'foo': '', 'baz': ''}, ] rows_jl = [dict(row) for row in items] - yield self.assertExportedCsv(items, header, rows_csv) + yield self.assertExportedCsv(items, header, rows_csv, ordered=False) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -963,7 +967,7 @@ class FeedExportTest(FeedExportTestBase): header = ["foo"] rows = [{'foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': []} - yield self.assertExportedCsv(items, header, rows) + yield self.assertExportedCsv(items, header, rows, ordered=False) yield self.assertExportedJsonLines(items, rows, settings) @defer.inlineCallbacks @@ -1141,7 +1145,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam', 'foo': 'bar'} ] rows_jl = items - yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv) + yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv, ordered=False) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -2059,7 +2063,7 @@ class BatchDeliveriesTest(FeedExportTestBase): self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None): + def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): settings = settings or {} settings.update({ 'FEEDS': { From bc285f393ca8ff33ef715f98ef3367c973d23ab3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 09:00:39 +0200 Subject: [PATCH 116/532] Revert "Revert "test_feedexport: remove ordered=False"" This reverts commit 516e2d6ec0da77b8e0c01eb5188311b5fbeaa22e. --- tests/test_feedexport.py | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index fe90501fb..8ef221b70 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -656,8 +656,8 @@ class FeedExportTestBase(ABC, unittest.TestCase): return data @defer.inlineCallbacks - def assertExported(self, items, header, rows, settings=None, ordered=True): - yield self.assertExportedCsv(items, header, rows, settings, ordered) + def assertExported(self, items, header, rows, settings=None): + yield self.assertExportedCsv(items, header, rows, settings) yield self.assertExportedJsonLines(items, rows, settings) yield self.assertExportedXml(items, rows, settings) yield self.assertExportedPickle(items, rows, settings) @@ -718,7 +718,7 @@ class FeedExportTest(FeedExportTestBase): return content @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): + def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} settings.update({ 'FEEDS': { @@ -729,11 +729,7 @@ class FeedExportTest(FeedExportTestBase): reader = csv.DictReader(to_unicode(data['csv']).splitlines()) got_rows = list(reader) - if ordered: - self.assertEqual(reader.fieldnames, header) - else: - self.assertEqual(set(reader.fieldnames), set(header)) - + self.assertEqual(reader.fieldnames, header) self.assertEqual(rows, got_rows) @defer.inlineCallbacks @@ -885,7 +881,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} ] header = self.MyItem.fields.keys() - yield self.assertExported(items, header, rows, ordered=False) + yield self.assertExported(items, header, rows) @defer.inlineCallbacks def test_export_no_items_not_store_empty(self): @@ -957,7 +953,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam4', 'foo': '', 'baz': ''}, ] rows_jl = [dict(row) for row in items] - yield self.assertExportedCsv(items, header, rows_csv, ordered=False) + yield self.assertExportedCsv(items, header, rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -967,7 +963,7 @@ class FeedExportTest(FeedExportTestBase): header = ["foo"] rows = [{'foo': 'bar'}] settings = {'FEED_EXPORT_FIELDS': []} - yield self.assertExportedCsv(items, header, rows, ordered=False) + yield self.assertExportedCsv(items, header, rows) yield self.assertExportedJsonLines(items, rows, settings) @defer.inlineCallbacks @@ -1145,7 +1141,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam', 'foo': 'bar'} ] rows_jl = items - yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv, ordered=False) + yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -2063,7 +2059,7 @@ class BatchDeliveriesTest(FeedExportTestBase): self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks - def assertExportedCsv(self, items, header, rows, settings=None, ordered=True): + def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} settings.update({ 'FEEDS': { From ec5cf3e9cea3c66aca4cf1aad576f33edca3ad1e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 09:10:18 +0200 Subject: [PATCH 117/532] test_feedexport: solve ordered comparison issues --- tests/test_feedexport.py | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 8ef221b70..ec48f8d4a 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -726,11 +726,9 @@ class FeedExportTest(FeedExportTestBase): }, }) data = yield self.exported_data(items, settings) - reader = csv.DictReader(to_unicode(data['csv']).splitlines()) - got_rows = list(reader) - self.assertEqual(reader.fieldnames, header) - self.assertEqual(rows, got_rows) + self.assertEqual(reader.fieldnames, list(header)) + self.assertEqual(rows, list(reader)) @defer.inlineCallbacks def assertExportedJsonLines(self, items, rows, settings=None): @@ -1141,7 +1139,7 @@ class FeedExportTest(FeedExportTestBase): {'egg': 'spam', 'foo': 'bar'} ] rows_jl = items - yield self.assertExportedCsv(items, ['egg', 'foo'], rows_csv) + yield self.assertExportedCsv(items, ['foo', 'egg'], rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks From 4ef71829b22b7362d08d6897090595138107852f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 10:37:27 +0200 Subject: [PATCH 118/532] If TWISTED_REACTOR is None, reuse any pre-installed reactor (#5528) --- docs/topics/settings.rst | 7 ++- scrapy/crawler.py | 3 +- scrapy/utils/reactor.py | 2 +- tests/CrawlerProcess/reactor_default.py | 17 +++++ .../reactor_default_twisted_reactor_select.py | 20 ++++++ tests/CrawlerProcess/reactor_select.py | 19 ++++++ ..._select_subclass_twisted_reactor_select.py | 31 +++++++++ .../reactor_select_twisted_reactor_select.py | 22 +++++++ tests/test_crawler.py | 63 +++++++++++++++++-- 9 files changed, 172 insertions(+), 12 deletions(-) create mode 100644 tests/CrawlerProcess/reactor_default.py create mode 100644 tests/CrawlerProcess/reactor_default_twisted_reactor_select.py create mode 100644 tests/CrawlerProcess/reactor_select.py create mode 100644 tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py create mode 100644 tests/CrawlerProcess/reactor_select_twisted_reactor_select.py diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 4e105642d..f3b28c4c4 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -1638,9 +1638,10 @@ which raises :exc:`Exception`, becomes:: The default value of the :setting:`TWISTED_REACTOR` setting is ``None``, which -means that Scrapy will install the default reactor defined by Twisted for the -current platform. This is to maintain backward compatibility and avoid possible -problems caused by using a non-default reactor. +means that Scrapy will use the existing reactor if one is already installed, or +install the default reactor defined by Twisted for the current platform. This +is to maintain backward compatibility and avoid possible problems caused by +using a non-default reactor. For additional information, see :doc:`core/howto/choosing-reactor`. diff --git a/scrapy/crawler.py b/scrapy/crawler.py index d669d93a8..dcf0c2146 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -78,8 +78,7 @@ class Crawler: if reactor_class: install_reactor(reactor_class, self.settings["ASYNCIO_EVENT_LOOP"]) else: - from twisted.internet import default - default.install() + from twisted.internet import reactor # noqa: F401 log_reactor_info() if reactor_class: verify_installed_reactor(reactor_class) diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index 96395543c..bc543b230 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -83,7 +83,7 @@ def verify_installed_reactor(reactor_path): path.""" from twisted.internet import reactor reactor_class = load_object(reactor_path) - if not isinstance(reactor, reactor_class): + if not reactor.__class__ == reactor_class: msg = ("The installed reactor " f"({reactor.__module__}.{reactor.__class__.__name__}) does not " f"match the requested one ({reactor_path})") diff --git a/tests/CrawlerProcess/reactor_default.py b/tests/CrawlerProcess/reactor_default.py new file mode 100644 index 000000000..5a21a3717 --- /dev/null +++ b/tests/CrawlerProcess/reactor_default.py @@ -0,0 +1,17 @@ +import scrapy +from scrapy.crawler import CrawlerProcess +from twisted.internet import reactor + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={}) + +process.crawl(NoRequestsSpider) +process.start() + diff --git a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py new file mode 100644 index 000000000..c476722ef --- /dev/null +++ b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py @@ -0,0 +1,20 @@ +import scrapy +from scrapy.crawler import CrawlerProcess +from twisted.internet import reactor + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", +}) + +process.crawl(NoRequestsSpider) +process.start() + + diff --git a/tests/CrawlerProcess/reactor_select.py b/tests/CrawlerProcess/reactor_select.py new file mode 100644 index 000000000..eac6e2f89 --- /dev/null +++ b/tests/CrawlerProcess/reactor_select.py @@ -0,0 +1,19 @@ +import scrapy +from scrapy.crawler import CrawlerProcess +from twisted.internet import selectreactor +selectreactor.install() + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={}) + +process.crawl(NoRequestsSpider) +process.start() + + diff --git a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py new file mode 100644 index 000000000..47f480605 --- /dev/null +++ b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py @@ -0,0 +1,31 @@ +import scrapy +from scrapy.crawler import CrawlerProcess +from twisted.internet.main import installReactor +from twisted.internet.selectreactor import SelectReactor + + +class SelectReactorSubclass(SelectReactor): + pass + + +reactor = SelectReactorSubclass() +installReactor(reactor) + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", +}) + +process.crawl(NoRequestsSpider) +process.start() + + + + diff --git a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py new file mode 100644 index 000000000..e0d2dab26 --- /dev/null +++ b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py @@ -0,0 +1,22 @@ +import scrapy +from scrapy.crawler import CrawlerProcess +from twisted.internet import selectreactor +selectreactor.install() + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", +}) + +process.crawl(NoRequestsSpider) +process.start() + + + diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 957525382..1ff2e8a67 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -308,6 +308,57 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) self.assertNotIn("ReactorAlreadyInstalledError", log) + def test_reactor_default(self): + log = self.run_script('reactor_default.py') + self.assertIn('Spider closed (finished)', log) + self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertNotIn("ReactorAlreadyInstalledError", log) + + def test_reactor_default_twisted_reactor_select(self): + log = self.run_script('reactor_default_twisted_reactor_select.py') + if platform.system() == 'Windows': + # The goal of this test function is to test that, when a reactor is + # installed (the default one here) and a different reactor is + # configured (select here), an error raises. + # + # In Windows the default reactor is the select reactor, so that + # error does not raise. + # + # If that ever becomes the case on more platforms (i.e. if Linux + # also starts using the select reactor by default in a future + # version of Twisted), then we will need to rethink this test. + self.assertIn('Spider closed (finished)', log) + else: + self.assertNotIn('Spider closed (finished)', log) + self.assertIn( + ( + "does not match the requested one " + "(twisted.internet.selectreactor.SelectReactor)" + ), + log, + ) + + def test_reactor_select(self): + log = self.run_script('reactor_select.py') + self.assertIn('Spider closed (finished)', log) + self.assertNotIn("ReactorAlreadyInstalledError", log) + + def test_reactor_select_twisted_reactor_select(self): + log = self.run_script('reactor_select_twisted_reactor_select.py') + self.assertIn('Spider closed (finished)', log) + self.assertNotIn("ReactorAlreadyInstalledError", log) + + def test_reactor_select_subclass_twisted_reactor_select(self): + log = self.run_script('reactor_select_subclass_twisted_reactor_select.py') + self.assertNotIn('Spider closed (finished)', log) + self.assertIn( + ( + "does not match the requested one " + "(twisted.internet.selectreactor.SelectReactor)" + ), + log, + ) + def test_asyncio_enabled_no_reactor(self): log = self.run_script('asyncio_enabled_no_reactor.py') self.assertIn('Spider closed (finished)', log) @@ -340,33 +391,33 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): self.assertNotIn("TimeoutError", log) self.assertNotIn("twisted.internet.error.DNSLookupError", log) - def test_reactor_select(self): + def test_twisted_reactor_select(self): log = self.run_script("twisted_reactor_select.py") self.assertIn("Spider closed (finished)", log) self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) @mark.skipif(platform.system() == 'Windows', reason="PollReactor is not supported on Windows") - def test_reactor_poll(self): + def test_twisted_reactor_poll(self): log = self.run_script("twisted_reactor_poll.py") self.assertIn("Spider closed (finished)", log) self.assertIn("Using reactor: twisted.internet.pollreactor.PollReactor", log) - def test_reactor_asyncio(self): + def test_twisted_reactor_asyncio(self): log = self.run_script("twisted_reactor_asyncio.py") self.assertIn("Spider closed (finished)", log) self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) - def test_reactor_asyncio_custom_settings(self): + def test_twisted_reactor_asyncio_custom_settings(self): log = self.run_script("twisted_reactor_custom_settings.py") self.assertIn("Spider closed (finished)", log) self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) - def test_reactor_asyncio_custom_settings_same(self): + def test_twisted_reactor_asyncio_custom_settings_same(self): log = self.run_script("twisted_reactor_custom_settings_same.py") self.assertIn("Spider closed (finished)", log) self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) - def test_reactor_asyncio_custom_settings_conflict(self): + def test_twisted_reactor_asyncio_custom_settings_conflict(self): log = self.run_script("twisted_reactor_custom_settings_conflict.py") self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) self.assertIn("(twisted.internet.selectreactor.SelectReactor) does not match the requested one", log) From 54bfb9649bdec565f9798cc41643ed1bae25bd67 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 17 Jun 2022 11:51:02 +0200 Subject: [PATCH 119/532] Cover #5525 in the 2.6.2 release notes (#5535) --- docs/conf.py | 1 + docs/news.rst | 9 +++++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 55aa72d5a..9a0afe73e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -295,6 +295,7 @@ intersphinx_mapping = { 'twisted': ('https://twistedmatrix.com/documents/current', None), 'twistedapi': ('https://twistedmatrix.com/documents/current/api', None), } +intersphinx_disabled_reftypes = [] # Options for sphinx-hoverxref options diff --git a/docs/news.rst b/docs/news.rst index ffeb50390..7993b4b4f 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,14 +5,19 @@ Release notes .. _release-2.6.2: -Scrapy 2.6.2 (2022-0?-??) -------------------------- +Scrapy 2.6.2 (to be determined) +------------------------------- Fixes additional regressions introduced in 2.6.0: - :class:`~scrapy.crawler.CrawlerProcess` supports again crawling multiple spiders (:issue:`5435`, :issue:`5436`) +- Installing a Twisted reactor before Scrapy does (e.g. importing + :mod:`twisted.internet.reactor` somewhere at the module level) no longer + prevents Scrapy from starting, as long as a different reactor is not + specified in :setting:`TWISTED_REACTOR` (:issue:`5525`, :issue:`5528`) + - Fixed an exception that was being logged after the spider finished under certain conditions (:issue:`5437`, :issue:`5440`) From e3e69d1209407c72a6478936bdbfd32cc22e9432 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 20 Jun 2022 11:46:13 +0200 Subject: [PATCH 120/532] Pin documentation requirements (#5536) --- docs/requirements.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index a0930ba1e..9f9aef711 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,4 @@ -Sphinx>=3.0 -sphinx-hoverxref>=0.2b1 -sphinx-notfound-page>=0.4 -sphinx-rtd-theme>=0.5.2 \ No newline at end of file +sphinx==5.0.2 +sphinx-hoverxref==1.1.1 +sphinx-notfound-page==0.8 +sphinx-rtd-theme==1.0.0 From d8223adfacc7e0ae684e5f9463474707bfcb008d Mon Sep 17 00:00:00 2001 From: Emanuele Date: Mon, 20 Jun 2022 11:54:05 +0200 Subject: [PATCH 121/532] =?UTF-8?q?Typo:=20cleanup=20(verb)=20=E2=86=92=20?= =?UTF-8?q?clean=20up=20(#5538)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.rst b/docs/README.rst index 0b7afa548..36dd5aea4 100644 --- a/docs/README.rst +++ b/docs/README.rst @@ -43,7 +43,7 @@ This command will fire up your default browser and open the main page of your Start over ---------- -To cleanup all generated documentation files and start from scratch run:: +To clean up all generated documentation files and start from scratch run:: make clean From 34e4ed72ea87601ce17c8d248d6a54d3e8b73194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 21 Jun 2022 12:46:54 +0200 Subject: [PATCH 122/532] Document how DOWNLOAD_DELAY affects per-domain concurrency --- docs/topics/settings.rst | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 2046c6446..468975d6a 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -633,25 +633,41 @@ DOWNLOAD_DELAY Default: ``0`` -The amount of time (in secs) that the downloader should wait before downloading -consecutive pages from the same website. This can be used to throttle the -crawling speed to avoid hitting servers too hard. Decimal numbers are -supported. Example:: +Minimum seconds to wait between 2 consecutive requests to the same domain. - DOWNLOAD_DELAY = 0.25 # 250 ms of delay +Use :setting:`DOWNLOAD_DELAY` to throttle your crawling speed, to avoid hitting +servers too hard. + +Decimal numbers are supported. For example, to send a maximum of 4 requests +every 10 seconds:: + + DOWNLOAD_DELAY = 2.5 This setting is also affected by the :setting:`RANDOMIZE_DOWNLOAD_DELAY` -setting (which is enabled by default). By default, Scrapy doesn't wait a fixed -amount of time between requests, but uses a random interval between 0.5 * :setting:`DOWNLOAD_DELAY` and 1.5 * :setting:`DOWNLOAD_DELAY`. +setting, which is enabled by default. When :setting:`CONCURRENT_REQUESTS_PER_IP` is non-zero, delays are enforced -per ip address instead of per domain. +per IP address instead of per domain. + +Note that :setting:`DOWNLOAD_DELAY` can lower the effective per-domain +concurrency below :setting:`CONCURRENT_REQUESTS_PER_DOMAIN`. If the response +time of a domain is lower than :setting:`DOWNLOAD_DELAY`, the effective +concurrency for that domain is 1. When testing throttling configurations, it +usually makes sense to lower :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` first, +and only increase :setting:`DOWNLOAD_DELAY` once +:setting:`CONCURRENT_REQUESTS_PER_DOMAIN` is 1 but a higher throttling is +desired. .. _spider-download_delay-attribute: -You can also change this setting per spider by setting ``download_delay`` +You can change this setting per spider by setting the ``download_delay`` spider attribute. +It is also possible to change this setting per domain, although it requires +non-trivial code. See the implementation of the :ref:`AutoThrottle +` extension for an example. + + .. setting:: DOWNLOAD_HANDLERS DOWNLOAD_HANDLERS From 387326fad42c4709933851108f2370d3105b8dd1 Mon Sep 17 00:00:00 2001 From: Vardhaman <83634399+cyai@users.noreply.github.com> Date: Thu, 23 Jun 2022 14:40:49 +0530 Subject: [PATCH 123/532] MAINT: Updated f-string format Updated the code with the f-string method for better and cleaner understanding. --- scrapy/downloadermiddlewares/cookies.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/downloadermiddlewares/cookies.py b/scrapy/downloadermiddlewares/cookies.py index 3afa06077..c592acb57 100644 --- a/scrapy/downloadermiddlewares/cookies.py +++ b/scrapy/downloadermiddlewares/cookies.py @@ -104,8 +104,8 @@ class CookiesMiddleware: for key in ("name", "value", "path", "domain"): if cookie.get(key) is None: if key in ("name", "value"): - msg = "Invalid cookie found in request {}: {} ('{}' is missing)" - logger.warning(msg.format(request, cookie, key)) + msg = f"Invalid cookie found in request {request}: {cookie} ('{key}' is missing)" + logger.warning(msg) return continue if isinstance(cookie[key], (bool, float, int, str)): From c4c816624fc4fd5fbc1866c507b661e92704136a Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 30 Jun 2022 10:42:01 -0300 Subject: [PATCH 124/532] chore: Deprecate the `scrapy.downloadermiddlewares.decompression` module --- scrapy/downloadermiddlewares/decompression.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/scrapy/downloadermiddlewares/decompression.py b/scrapy/downloadermiddlewares/decompression.py index 0fcf8fb8c..98f18a836 100644 --- a/scrapy/downloadermiddlewares/decompression.py +++ b/scrapy/downloadermiddlewares/decompression.py @@ -9,10 +9,19 @@ import tarfile import zipfile from io import BytesIO from tempfile import mktemp +import warnings +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.responsetypes import responsetypes +warnings.warn( + 'scrapy.downloadermiddlewares.decompression is deprecated', + ScrapyDeprecationWarning, + stacklevel=2, +) + + logger = logging.getLogger(__name__) From fe08a119d965b2291e44801901e15b58a1f959ad Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 30 Jun 2022 10:46:00 -0300 Subject: [PATCH 125/532] chore: import only used function --- scrapy/downloadermiddlewares/decompression.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/downloadermiddlewares/decompression.py b/scrapy/downloadermiddlewares/decompression.py index 98f18a836..e01e9cc76 100644 --- a/scrapy/downloadermiddlewares/decompression.py +++ b/scrapy/downloadermiddlewares/decompression.py @@ -9,13 +9,13 @@ import tarfile import zipfile from io import BytesIO from tempfile import mktemp -import warnings +from warnings import warn from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.responsetypes import responsetypes -warnings.warn( +warn( 'scrapy.downloadermiddlewares.decompression is deprecated', ScrapyDeprecationWarning, stacklevel=2, From 09c3a4ad082dd6fc431be65975292d2eba369ad6 Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Tue, 12 Jul 2022 12:41:46 +0200 Subject: [PATCH 126/532] Fix doc: `scrapy.exporter` to `scrapy.exporters` --- docs/topics/exporters.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/exporters.rst b/docs/topics/exporters.rst index 3c36ef002..9360ecf37 100644 --- a/docs/topics/exporters.rst +++ b/docs/topics/exporters.rst @@ -117,7 +117,7 @@ after your custom code. Example:: - from scrapy.exporter import XmlItemExporter + from scrapy.exporters import XmlItemExporter class ProductXmlExporter(XmlItemExporter): From 1c7ed4f2e59a94651d6d9d136cab78821cd3e80e Mon Sep 17 00:00:00 2001 From: Rotzbua Date: Thu, 6 Jan 2022 22:21:56 +0100 Subject: [PATCH 127/532] [doc] Remove incompatible web service project * Abandoned since 2017 * Not compatible with Python3 --- docs/index.rst | 4 ---- docs/topics/webservice.rst | 11 ----------- 2 files changed, 15 deletions(-) delete mode 100644 docs/topics/webservice.rst diff --git a/docs/index.rst b/docs/index.rst index 75e08f537..40c6cb485 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -130,7 +130,6 @@ Built-in services topics/stats topics/email topics/telnetconsole - topics/webservice :doc:`topics/logging` Learn how to use Python's builtin logging on Scrapy. @@ -144,9 +143,6 @@ Built-in services :doc:`topics/telnetconsole` Inspect a running crawler using a built-in Python console. -:doc:`topics/webservice` - Monitor and control a crawler using a web service. - Solving specific problems ========================= diff --git a/docs/topics/webservice.rst b/docs/topics/webservice.rst deleted file mode 100644 index 2c4052c04..000000000 --- a/docs/topics/webservice.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _topics-webservice: - -=========== -Web Service -=========== - -webservice has been moved into a separate project. - -It is hosted at: - - https://github.com/scrapy-plugins/scrapy-jsonrpc From 2f13f23d927900de0a89197ded0ee7aed387e351 Mon Sep 17 00:00:00 2001 From: Ikko Ashimine Date: Fri, 15 Jul 2022 18:16:23 +0900 Subject: [PATCH 128/532] Fix typo in sep-014.rst requets -> requests --- sep/sep-014.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sep/sep-014.rst b/sep/sep-014.rst index 0859e3f7c..2521aa0e5 100644 --- a/sep/sep-014.rst +++ b/sep/sep-014.rst @@ -590,11 +590,11 @@ Request Generator def generate_requests(self, response): """ - Extract and process new requets from response + Extract and process new requests from response """ requests = [] for ext in self._request_extractors: - requets.extend(ext.extract_requests(response)) + requests.extend(ext.extract_requests(response)) for proc in self._request_processors: requests = proc(requests) From 9b33b82a8b802c3906c2f1eaf1b88efee9b2fb09 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Sun, 17 Jul 2022 15:50:40 +0500 Subject: [PATCH 129/532] Fixed intersphinx references --- docs/conf.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 378b01804..3241295af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -291,9 +291,9 @@ intersphinx_mapping = { 'pytest': ('https://docs.pytest.org/en/latest', None), 'python': ('https://docs.python.org/3', None), 'sphinx': ('https://www.sphinx-doc.org/en/master', None), - 'tox': ('https://tox.readthedocs.io/en/latest', None), - 'twisted': ('https://twistedmatrix.com/documents/current', None), - 'twistedapi': ('https://twistedmatrix.com/documents/current/api', None), + 'tox': ('https://tox.wiki/en/latest/', None), + 'twisted': ('https://docs.twisted.org/en/stable/', None), + 'twistedapi': ('https://docs.twisted.org/en/stable/api/', None), 'w3lib': ('https://w3lib.readthedocs.io/en/latest', None), } intersphinx_disabled_reftypes = [] From 26c70318cb14806a07ee09d0283e9d5d306490e9 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Sun, 17 Jul 2022 16:47:20 +0500 Subject: [PATCH 130/532] make Scrapy testing suite more robust in environments where non-existing hosts are resolvable --- tests/__init__.py | 10 ++++++++++ tests/test_command_shell.py | 4 +++- tests/test_crawl.py | 4 ++++ tests/test_downloader_handlers.py | 5 ++++- 4 files changed, 21 insertions(+), 2 deletions(-) diff --git a/tests/__init__.py b/tests/__init__.py index 12ce79fa9..bb62851dc 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -5,6 +5,7 @@ see https://docs.scrapy.org/en/latest/contributing.html#running-tests """ import os +import socket # ignore system-wide proxies for tests # which would send requests to a totally unsuspecting server @@ -25,6 +26,15 @@ tests_datadir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'sample_data') +# In some environments accessing a non-existing host doesn't raise an +# error. In such cases we're going to skip tests which rely on it. +try: + socket.getaddrinfo('non-existing-host', 80) + NON_EXISTING_RESOLVABLE = True +except socket.gaierror: + NON_EXISTING_RESOLVABLE = False + + def get_testdata(*paths): """Return test data""" path = os.path.join(tests_datadir, *paths) diff --git a/tests/test_command_shell.py b/tests/test_command_shell.py index 16c9559b5..33189e9be 100644 --- a/tests/test_command_shell.py +++ b/tests/test_command_shell.py @@ -6,7 +6,7 @@ from twisted.internet import defer from scrapy.utils.testsite import SiteTest from scrapy.utils.testproc import ProcessTest -from tests import tests_datadir +from tests import tests_datadir, NON_EXISTING_RESOLVABLE class ShellTest(ProcessTest, SiteTest, unittest.TestCase): @@ -109,6 +109,8 @@ class ShellTest(ProcessTest, SiteTest, unittest.TestCase): @defer.inlineCallbacks def test_dns_failures(self): + if NON_EXISTING_RESOLVABLE: + raise unittest.SkipTest("Non-existing hosts are resolvable") url = 'www.somedomainthatdoesntexi.st' errcode, out, err = yield self.execute([url, '-c', 'item'], check_code=False) self.assertEqual(errcode, 1, out or err) diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 7bda3bef2..f9ffcd6bb 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -3,6 +3,7 @@ import logging from ipaddress import IPv4Address from socket import gethostbyname from urllib.parse import urlparse +import unittest from pytest import mark from testfixtures import LogCapture @@ -17,6 +18,7 @@ from scrapy.exceptions import StopDownload from scrapy.http import Request from scrapy.http.response import Response from scrapy.utils.python import to_unicode +from tests import NON_EXISTING_RESOLVABLE from tests.mockserver import MockServer from tests.spiders import ( AsyncDefAsyncioGenComplexSpider, @@ -137,6 +139,8 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_retry_dns_error(self): + if NON_EXISTING_RESOLVABLE: + raise unittest.SkipTest("Non-existing hosts are resolvable") crawler = self.runner.create_crawler(SimpleSpider) with LogCapture() as log: # try to fetch the homepage of a non-existent domain diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 72f52121e..883960084 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -4,7 +4,7 @@ import shutil import sys import tempfile from typing import Optional, Type -from unittest import mock +from unittest import mock, SkipTest from testfixtures import LogCapture from twisted.cred import checkers, credentials, portal @@ -32,6 +32,7 @@ from scrapy.spiders import Spider from scrapy.utils.misc import create_instance from scrapy.utils.python import to_bytes from scrapy.utils.test import get_crawler, skip_if_no_boto +from tests import NON_EXISTING_RESOLVABLE from tests.mockserver import ( Echo, ForeverTakingResource, @@ -791,6 +792,8 @@ class Http11ProxyTestCase(HttpProxyTestCase): @defer.inlineCallbacks def test_download_with_proxy_https_timeout(self): """ Test TunnelingTCP4ClientEndpoint """ + if NON_EXISTING_RESOLVABLE: + raise SkipTest("Non-existing hosts are resolvable") http_proxy = self.getURL('') domain = 'https://no-such-domain.nosuch' request = Request( From e248360e6e3dbb36fab185caf131707195fa6a26 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Mon, 18 Jul 2022 23:49:08 +0500 Subject: [PATCH 131/532] remove compatibility code from tests for the case dataclasses module is not available It was Python 3.6 compat code, and Python 3.6 support is dropped. --- tests/test_exporters.py | 32 ++++++++++++++--------------- tests/test_loader.py | 23 +++++++-------------- tests/test_pipeline_files.py | 37 ++++++++++++---------------------- tests/test_pipeline_images.py | 38 ++++++++++++----------------------- tests/test_utils_serialize.py | 18 +++++++---------- 5 files changed, 55 insertions(+), 93 deletions(-) diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 096cd3116..69ac928c3 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -4,6 +4,7 @@ import marshal import pickle import tempfile import unittest +import dataclasses from io import BytesIO from datetime import datetime from warnings import catch_warnings, filterwarnings @@ -21,31 +22,30 @@ from scrapy.exporters import ( ) +def custom_serializer(value): + return str(int(value) + 2) + + class TestItem(Item): name = Field() age = Field() -def custom_serializer(value): - return str(int(value) + 2) - - class CustomFieldItem(Item): name = Field() age = Field(serializer=custom_serializer) -try: - from dataclasses import make_dataclass, field -except ImportError: - TestDataClass = None - CustomFieldDataclass = None -else: - TestDataClass = make_dataclass("TestDataClass", [("name", str), ("age", int)]) - CustomFieldDataclass = make_dataclass( - "CustomFieldDataclass", - [("name", str), ("age", int, field(metadata={"serializer": custom_serializer}))] - ) +@dataclasses.dataclass +class TestDataClass: + name: str + age: int + + +@dataclasses.dataclass +class CustomFieldDataclass: + name: str + age: int = dataclasses.field(metadata={"serializer": custom_serializer}) class BaseItemExporterTest(unittest.TestCase): @@ -54,8 +54,6 @@ class BaseItemExporterTest(unittest.TestCase): custom_field_item_class = CustomFieldItem def setUp(self): - if self.item_class is None: - raise unittest.SkipTest("item class is None") self.i = self.item_class(name='John\xa3', age='22') self.output = BytesIO() self.ie = self._get_exporter() diff --git a/tests/test_loader.py b/tests/test_loader.py index f7ab1f236..c0937b349 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -1,4 +1,5 @@ import unittest +import dataclasses import attr from itemadapter import ItemAdapter @@ -10,13 +11,6 @@ from scrapy.loader import ItemLoader from scrapy.selector import Selector -try: - from dataclasses import make_dataclass, field as dataclass_field -except ImportError: - make_dataclass = None - dataclass_field = None - - # test items class NameItem(Item): name = Field() @@ -41,6 +35,11 @@ class AttrsNameItem: name = attr.ib(default="") +@dataclasses.dataclass +class TestDataClass: + name: list = dataclasses.field(default_factory=list) + + # test item loaders class NameItemLoader(ItemLoader): default_item_class = TestItem @@ -187,16 +186,8 @@ class InitializationFromAttrsItemTest(InitializationTestMixin, unittest.TestCase item_class = AttrsNameItem -@unittest.skipIf(not make_dataclass, "dataclasses module is not available") class InitializationFromDataClassTest(InitializationTestMixin, unittest.TestCase): - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - if make_dataclass: - self.item_class = make_dataclass( - "TestDataClass", - [("name", list, dataclass_field(default_factory=list))], - ) + item_class = TestDataClass class BaseNoInputReprocessingLoader(ItemLoader): diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 4228173ed..5d381c018 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -7,6 +7,7 @@ from shutil import rmtree from tempfile import mkdtemp from unittest import mock, skipIf from urllib.parse import urlparse +import dataclasses import attr from itemadapter import ItemAdapter @@ -32,13 +33,6 @@ from scrapy.utils.test import ( ) -try: - from dataclasses import make_dataclass, field as dataclass_field -except ImportError: - make_dataclass = None - dataclass_field = None - - def _mocked_download_func(request, info): response = request.meta.get('response') return response() if callable(response) else response @@ -226,24 +220,19 @@ class FilesPipelineTestCaseFieldsItem(FilesPipelineTestCaseFieldsMixin, unittest item_class = FilesPipelineTestItem -@skipIf(not make_dataclass, "dataclasses module is not available") -class FilesPipelineTestCaseFieldsDataClass(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): +@dataclasses.dataclass +class FilesPipelineTestDataClass: + name: str + # default fields + file_urls: list = dataclasses.field(default_factory=list) + files: list = dataclasses.field(default_factory=list) + # overridden fields + custom_file_urls: list = dataclasses.field(default_factory=list) + custom_files: list = dataclasses.field(default_factory=list) - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - if make_dataclass: - self.item_class = make_dataclass( - "FilesPipelineTestDataClass", - [ - ("name", str), - # default fields - ("file_urls", list, dataclass_field(default_factory=list)), - ("files", list, dataclass_field(default_factory=list)), - # overridden fields - ("custom_file_urls", list, dataclass_field(default_factory=list)), - ("custom_files", list, dataclass_field(default_factory=list)), - ], - ) + +class FilesPipelineTestCaseFieldsDataClass(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): + item_class = FilesPipelineTestDataClass @attr.s diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index dd94d296b..e6f5bea21 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -4,6 +4,7 @@ import random from shutil import rmtree from tempfile import mkdtemp from unittest import skipIf +import dataclasses import attr from itemadapter import ItemAdapter @@ -16,13 +17,6 @@ from scrapy.settings import Settings from scrapy.utils.python import to_bytes -try: - from dataclasses import make_dataclass, field as dataclass_field -except ImportError: - make_dataclass = None - dataclass_field = None - - try: from PIL import Image except ImportError: @@ -203,25 +197,19 @@ class ImagesPipelineTestCaseFieldsItem(ImagesPipelineTestCaseFieldsMixin, unitte item_class = ImagesPipelineTestItem -@skipIf(not make_dataclass, "dataclasses module is not available") -class ImagesPipelineTestCaseFieldsDataClass(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): - item_class = None +@dataclasses.dataclass +class ImagesPipelineTestDataClass: + name: str + # default fields + image_urls: list = dataclasses.field(default_factory=list) + images: list = dataclasses.field(default_factory=list) + # overridden fields + custom_image_urls: list = dataclasses.field(default_factory=list) + custom_images: list = dataclasses.field(default_factory=list) - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - if make_dataclass: - self.item_class = make_dataclass( - "FilesPipelineTestDataClass", - [ - ("name", str), - # default fields - ("image_urls", list, dataclass_field(default_factory=list)), - ("images", list, dataclass_field(default_factory=list)), - # overridden fields - ("custom_image_urls", list, dataclass_field(default_factory=list)), - ("custom_images", list, dataclass_field(default_factory=list)), - ], - ) + +class ImagesPipelineTestCaseFieldsDataClass(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): + item_class = ImagesPipelineTestDataClass @attr.s diff --git a/tests/test_utils_serialize.py b/tests/test_utils_serialize.py index daf022aee..a51de1877 100644 --- a/tests/test_utils_serialize.py +++ b/tests/test_utils_serialize.py @@ -1,6 +1,7 @@ import datetime import json import unittest +import dataclasses from decimal import Decimal import attr @@ -10,12 +11,6 @@ from scrapy.http import Request, Response from scrapy.utils.serialize import ScrapyJSONEncoder -try: - from dataclasses import make_dataclass -except ImportError: - make_dataclass = None - - class JsonEncoderTestCase(unittest.TestCase): def setUp(self): @@ -56,12 +51,13 @@ class JsonEncoderTestCase(unittest.TestCase): self.assertIn(r.url, rs) self.assertIn(str(r.status), rs) - @unittest.skipIf(not make_dataclass, "No dataclass support") def test_encode_dataclass_item(self): - TestDataClass = make_dataclass( - "TestDataClass", - [("name", str), ("url", str), ("price", int)], - ) + @dataclasses.dataclass + class TestDataClass: + name: str + url: str + price: int + item = TestDataClass(name="Product", url="http://product.org", price=1) encoded = self.encoder.encode(item) self.assertEqual( From 105468959363ee50b597038ac30fd32d3ea1b1f2 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Mon, 18 Jul 2022 23:53:30 +0500 Subject: [PATCH 132/532] remove unused imports thanks flake8! --- tests/test_pipeline_files.py | 2 +- tests/test_pipeline_images.py | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 5d381c018..d641e7a43 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -5,7 +5,7 @@ from datetime import datetime from io import BytesIO from shutil import rmtree from tempfile import mkdtemp -from unittest import mock, skipIf +from unittest import mock from urllib.parse import urlparse import dataclasses diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index e6f5bea21..0082e7a4e 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -3,7 +3,6 @@ import io import random from shutil import rmtree from tempfile import mkdtemp -from unittest import skipIf import dataclasses import attr From b103664bf45b079e5488b13a0737866de1b7dc50 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Tue, 19 Jul 2022 20:39:26 +0500 Subject: [PATCH 133/532] Address 2/3 of warnings from tests (#5561) --- pytest.ini | 3 + tests/test_contracts.py | 4 +- tests/test_crawl.py | 100 +++---- tests/test_crawler.py | 36 ++- tests/test_downloadermiddleware_httpauth.py | 14 +- tests/test_downloadermiddleware_httpproxy.py | 12 +- tests/test_downloadermiddleware_stats.py | 7 +- tests/test_dupefilters.py | 27 +- tests/test_engine.py | 228 ++++++++-------- tests/test_engine_stop_download_bytes.py | 32 ++- tests/test_engine_stop_download_headers.py | 32 ++- tests/test_feedexport.py | 269 +++++++------------ tests/test_logformatter.py | 6 +- tests/test_pipeline_crawl.py | 12 +- tests/test_request_attribute_binding.py | 21 +- tests/test_request_cb_kwargs.py | 5 +- tests/test_scheduler.py | 3 +- tests/test_scheduler_base.py | 15 +- tests/test_spiderloader/__init__.py | 5 +- tests/test_utils_project.py | 27 +- tests/test_utils_request.py | 13 +- tests/test_utils_response.py | 21 +- 22 files changed, 424 insertions(+), 468 deletions(-) diff --git a/pytest.ini b/pytest.ini index ae2ed2029..af0f2fb6e 100644 --- a/pytest.ini +++ b/pytest.ini @@ -21,3 +21,6 @@ addopts = markers = only_asyncio: marks tests as only enabled when --reactor=asyncio is passed only_not_asyncio: marks tests as only enabled when --reactor=asyncio is not passed +filterwarnings = + ignore:scrapy.downloadermiddlewares.decompression is deprecated + ignore:Module scrapy.utils.reqser is deprecated diff --git a/tests/test_contracts.py b/tests/test_contracts.py index d0f4a68c2..136056f50 100644 --- a/tests/test_contracts.py +++ b/tests/test_contracts.py @@ -5,11 +5,11 @@ from twisted.python import failure from twisted.trial import unittest from scrapy import FormRequest -from scrapy.crawler import CrawlerRunner from scrapy.spidermiddlewares.httperror import HttpError from scrapy.spiders import Spider from scrapy.http import Request from scrapy.item import Item, Field +from scrapy.utils.test import get_crawler from scrapy.contracts import ContractsManager, Contract from scrapy.contracts.default import ( UrlContract, @@ -398,7 +398,7 @@ class ContractsManagerTest(unittest.TestCase): TestSameUrlSpider.parse_first.__doc__ = contract_doc TestSameUrlSpider.parse_second.__doc__ = contract_doc - crawler = CrawlerRunner().create_crawler(TestSameUrlSpider) + crawler = get_crawler(TestSameUrlSpider) yield crawler.crawl() self.assertEqual(crawler.spider.visited, 2) diff --git a/tests/test_crawl.py b/tests/test_crawl.py index f9ffcd6bb..59c271868 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -18,6 +18,7 @@ from scrapy.exceptions import StopDownload from scrapy.http import Request from scrapy.http.response import Response from scrapy.utils.python import to_unicode +from scrapy.utils.test import get_crawler from tests import NON_EXISTING_RESOLVABLE from tests.mockserver import MockServer from tests.spiders import ( @@ -49,14 +50,13 @@ class CrawlTestCase(TestCase): def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() - self.runner = CrawlerRunner() def tearDown(self): self.mockserver.__exit__(None, None, None) @defer.inlineCallbacks def test_follow_all(self): - crawler = self.runner.create_crawler(FollowAllSpider) + crawler = get_crawler(FollowAllSpider) yield crawler.crawl(mockserver=self.mockserver) self.assertEqual(len(crawler.spider.urls_visited), 11) # 10 + start_url @@ -79,7 +79,7 @@ class CrawlTestCase(TestCase): settings = {"DOWNLOAD_DELAY": delay, 'RANDOMIZE_DOWNLOAD_DELAY': randomize} - crawler = CrawlerRunner(settings).create_crawler(FollowAllSpider) + crawler = get_crawler(FollowAllSpider, settings) yield crawler.crawl(**crawl_kwargs) times = crawler.spider.times total_time = times[-1] - times[0] @@ -92,7 +92,7 @@ class CrawlTestCase(TestCase): # of ``total`` and ``delay`` values that are too small for the test # code above to have any meaning. settings["DOWNLOAD_DELAY"] = 0 - crawler = CrawlerRunner(settings).create_crawler(FollowAllSpider) + crawler = get_crawler(FollowAllSpider, settings) yield crawler.crawl(**crawl_kwargs) times = crawler.spider.times total_time = times[-1] - times[0] @@ -102,7 +102,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_timeout_success(self): - crawler = self.runner.create_crawler(DelaySpider) + crawler = get_crawler(DelaySpider) yield crawler.crawl(n=0.5, mockserver=self.mockserver) self.assertTrue(crawler.spider.t1 > 0) self.assertTrue(crawler.spider.t2 > 0) @@ -110,7 +110,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_timeout_failure(self): - crawler = CrawlerRunner({"DOWNLOAD_TIMEOUT": 0.35}).create_crawler(DelaySpider) + crawler = get_crawler(DelaySpider, {"DOWNLOAD_TIMEOUT": 0.35}) yield crawler.crawl(n=0.5, mockserver=self.mockserver) self.assertTrue(crawler.spider.t1 > 0) self.assertTrue(crawler.spider.t2 == 0) @@ -125,14 +125,14 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_retry_503(self): - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/status?n=503"), mockserver=self.mockserver) self._assert_retried(log) @defer.inlineCallbacks def test_retry_conn_failed(self): - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl("http://localhost:65432/status?n=503", mockserver=self.mockserver) self._assert_retried(log) @@ -141,7 +141,7 @@ class CrawlTestCase(TestCase): def test_retry_dns_error(self): if NON_EXISTING_RESOLVABLE: raise unittest.SkipTest("Non-existing hosts are resolvable") - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: # try to fetch the homepage of a non-existent domain yield crawler.crawl("http://dns.resolution.invalid./", mockserver=self.mockserver) @@ -150,7 +150,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_start_requests_bug_before_yield(self): with LogCapture('scrapy', level=logging.ERROR) as log: - crawler = self.runner.create_crawler(BrokenStartRequestsSpider) + crawler = get_crawler(BrokenStartRequestsSpider) yield crawler.crawl(fail_before_yield=1, mockserver=self.mockserver) self.assertEqual(len(log.records), 1) @@ -161,7 +161,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_start_requests_bug_yielding(self): with LogCapture('scrapy', level=logging.ERROR) as log: - crawler = self.runner.create_crawler(BrokenStartRequestsSpider) + crawler = get_crawler(BrokenStartRequestsSpider) yield crawler.crawl(fail_yielding=1, mockserver=self.mockserver) self.assertEqual(len(log.records), 1) @@ -172,7 +172,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_start_requests_lazyness(self): settings = {"CONCURRENT_REQUESTS": 1} - crawler = CrawlerRunner(settings).create_crawler(BrokenStartRequestsSpider) + crawler = get_crawler(BrokenStartRequestsSpider, settings) yield crawler.crawl(mockserver=self.mockserver) self.assertTrue( crawler.spider.seedsseen.index(None) < crawler.spider.seedsseen.index(99), @@ -181,7 +181,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_start_requests_dupes(self): settings = {"CONCURRENT_REQUESTS": 1} - crawler = CrawlerRunner(settings).create_crawler(DuplicateStartRequestsSpider) + crawler = get_crawler(DuplicateStartRequestsSpider, settings) yield crawler.crawl(dont_filter=True, distinct_urls=2, dupe_factor=3, mockserver=self.mockserver) self.assertEqual(crawler.spider.visited, 6) @@ -210,7 +210,7 @@ Connection: close foo body with multiples lines '''}) - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl(self.mockserver.url(f"/raw?{query}"), mockserver=self.mockserver) self.assertEqual(str(log).count("Got response 200"), 1) @@ -218,7 +218,7 @@ with multiples lines @defer.inlineCallbacks def test_retry_conn_lost(self): # connection lost after receiving data - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/drop?abort=0"), mockserver=self.mockserver) self._assert_retried(log) @@ -226,7 +226,7 @@ with multiples lines @defer.inlineCallbacks def test_retry_conn_aborted(self): # connection lost before receiving data - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/drop?abort=1"), mockserver=self.mockserver) self._assert_retried(log) @@ -245,7 +245,7 @@ with multiples lines req0.meta['next'] = req1 req1.meta['next'] = req2 req2.meta['next'] = req3 - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=req0, mockserver=self.mockserver) # basic asserts in case of weird communication errors self.assertIn('responses', crawler.spider.meta) @@ -271,7 +271,7 @@ with multiples lines def cb(response): est.append(get_engine_status(crawler.engine)) - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=self.mockserver.url('/'), callback_func=cb, mockserver=self.mockserver) self.assertEqual(len(est), 1, est) s = dict(est[0]) @@ -286,7 +286,7 @@ with multiples lines def cb(response): est.append(format_engine_status(crawler.engine)) - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=self.mockserver.url('/'), callback_func=cb, mockserver=self.mockserver) self.assertEqual(len(est), 1, est) est = est[0].split("\n")[2:-2] # remove header & footer @@ -317,7 +317,7 @@ with multiples lines def start_requests(self): raise TestError - crawler = self.runner.create_crawler(FaultySpider) + crawler = get_crawler(FaultySpider) yield self.assertFailure(crawler.crawl(mockserver=self.mockserver), TestError) self.assertFalse(crawler.crawling) @@ -328,26 +328,28 @@ with multiples lines "tests.pipelines.ZeroDivisionErrorPipeline": 300, } } - crawler = CrawlerRunner(settings).create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider, settings) yield self.assertFailure( - self.runner.crawl(crawler, self.mockserver.url("/status?n=200"), mockserver=self.mockserver), + crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver), ZeroDivisionError) self.assertFalse(crawler.crawling) @defer.inlineCallbacks def test_crawlerrunner_accepts_crawler(self): - crawler = self.runner.create_crawler(SimpleSpider) + crawler = get_crawler(SimpleSpider) + runner = CrawlerRunner() with LogCapture() as log: - yield self.runner.crawl(crawler, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield runner.crawl(crawler, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) self.assertIn("Got response 200", str(log)) @defer.inlineCallbacks def test_crawl_multiple(self): - self.runner.crawl(SimpleSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) - self.runner.crawl(SimpleSpider, self.mockserver.url("/status?n=503"), mockserver=self.mockserver) + runner = CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'}) + runner.crawl(SimpleSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + runner.crawl(SimpleSpider, self.mockserver.url("/status?n=503"), mockserver=self.mockserver) with LogCapture() as log: - yield self.runner.join() + yield runner.join() self._assert_retried(log) self.assertIn("Got response 200", str(log)) @@ -358,7 +360,6 @@ class CrawlSpiderTestCase(TestCase): def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() - self.runner = CrawlerRunner() def tearDown(self): self.mockserver.__exit__(None, None, None) @@ -370,7 +371,7 @@ class CrawlSpiderTestCase(TestCase): def _on_item_scraped(item): items.append(item) - crawler = self.runner.create_crawler(spider_cls) + crawler = get_crawler(spider_cls) crawler.signals.connect(_on_item_scraped, signals.item_scraped) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) @@ -378,10 +379,9 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_crawlspider_with_parse(self): - self.runner.crawl(CrawlSpiderWithParseMethod, mockserver=self.mockserver) - + crawler = get_crawler(CrawlSpiderWithParseMethod) with LogCapture() as log: - yield self.runner.join() + yield crawler.crawl(mockserver=self.mockserver) self.assertIn("[parse] status 200 (foo: None)", str(log)) self.assertIn("[parse] status 201 (foo: None)", str(log)) @@ -389,10 +389,9 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_crawlspider_with_errback(self): - self.runner.crawl(CrawlSpiderWithErrback, mockserver=self.mockserver) - + crawler = get_crawler(CrawlSpiderWithErrback) with LogCapture() as log: - yield self.runner.join() + yield crawler.crawl(mockserver=self.mockserver) self.assertIn("[parse] status 200 (foo: None)", str(log)) self.assertIn("[parse] status 201 (foo: None)", str(log)) @@ -403,18 +402,19 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_async_def_parse(self): - self.runner.crawl(AsyncDefSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + crawler = get_crawler(AsyncDefSpider) with LogCapture() as log: - yield self.runner.join() + yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) self.assertIn("Got response 200", str(log)) @mark.only_asyncio() @defer.inlineCallbacks def test_async_def_asyncio_parse(self): - runner = CrawlerRunner({"TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor"}) - runner.crawl(AsyncDefAsyncioSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + crawler = get_crawler(AsyncDefAsyncioSpider, { + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor" + }) with LogCapture() as log: - yield runner.join() + yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) self.assertIn("Got response 200", str(log)) @mark.only_asyncio() @@ -433,7 +433,7 @@ class CrawlSpiderTestCase(TestCase): def _on_item_scraped(item): items.append(item) - crawler = self.runner.create_crawler(AsyncDefAsyncioReturnSingleElementSpider) + crawler = get_crawler(AsyncDefAsyncioReturnSingleElementSpider) crawler.signals.connect(_on_item_scraped, signals.item_scraped) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) @@ -479,14 +479,14 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_response_ssl_certificate_none(self): - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/echo?body=test", is_secure=False) yield crawler.crawl(seed=url, mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta['responses'][0].certificate) @defer.inlineCallbacks def test_response_ssl_certificate(self): - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/echo?body=test", is_secure=True) yield crawler.crawl(seed=url, mockserver=self.mockserver) cert = crawler.spider.meta['responses'][0].certificate @@ -497,7 +497,7 @@ class CrawlSpiderTestCase(TestCase): @mark.xfail(reason="Responses with no body return early and contain no certificate") @defer.inlineCallbacks def test_response_ssl_certificate_empty_response(self): - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/status?n=200", is_secure=True) yield crawler.crawl(seed=url, mockserver=self.mockserver) cert = crawler.spider.meta['responses'][0].certificate @@ -507,7 +507,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_dns_server_ip_address_none(self): - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url('/status?n=200') yield crawler.crawl(seed=url, mockserver=self.mockserver) ip_address = crawler.spider.meta['responses'][0].ip_address @@ -515,7 +515,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_dns_server_ip_address(self): - crawler = self.runner.create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url('/echo?body=test') expected_netloc, _ = urlparse(url).netloc.split(':') yield crawler.crawl(seed=url, mockserver=self.mockserver) @@ -525,7 +525,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_bytes_received_stop_download_callback(self): - crawler = self.runner.create_crawler(BytesReceivedCallbackSpider) + crawler = get_crawler(BytesReceivedCallbackSpider) yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("failure")) self.assertIsInstance(crawler.spider.meta["response"], Response) @@ -534,7 +534,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_bytes_received_stop_download_errback(self): - crawler = self.runner.create_crawler(BytesReceivedErrbackSpider) + crawler = get_crawler(BytesReceivedErrbackSpider) yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("response")) self.assertIsInstance(crawler.spider.meta["failure"], Failure) @@ -549,7 +549,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_headers_received_stop_download_callback(self): - crawler = self.runner.create_crawler(HeadersReceivedCallbackSpider) + crawler = get_crawler(HeadersReceivedCallbackSpider) yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("failure")) self.assertIsInstance(crawler.spider.meta["response"], Response) @@ -557,7 +557,7 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_headers_received_stop_download_errback(self): - crawler = self.runner.create_crawler(HeadersReceivedErrbackSpider) + crawler = get_crawler(HeadersReceivedErrbackSpider) yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("response")) self.assertIsInstance(crawler.spider.meta["failure"], Failure) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index f7aa769e4..d67abed7c 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -13,11 +13,13 @@ from twisted.trial import unittest import scrapy from scrapy.crawler import Crawler, CrawlerRunner, CrawlerProcess +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings import Settings, default_settings from scrapy.spiderloader import SpiderLoader from scrapy.utils.log import configure_logging, get_scrapy_root_handler from scrapy.utils.spider import DefaultSpider from scrapy.utils.misc import load_object +from scrapy.utils.test import get_crawler from scrapy.extensions.throttle import AutoThrottle from scrapy.extensions import telnet from scrapy.utils.test import get_testenv @@ -34,9 +36,6 @@ class BaseCrawlerTest(unittest.TestCase): class CrawlerTestCase(BaseCrawlerTest): - def setUp(self): - self.crawler = Crawler(DefaultSpider, Settings()) - def test_populate_spidercls_settings(self): spider_settings = {'TEST1': 'spider', 'TEST2': 'spider'} project_settings = {'TEST1': 'project', 'TEST3': 'project'} @@ -46,7 +45,9 @@ class CrawlerTestCase(BaseCrawlerTest): settings = Settings() settings.setdict(project_settings, priority='project') - crawler = Crawler(CustomSettingsSpider, settings) + with warnings.catch_warnings(): + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + crawler = Crawler(CustomSettingsSpider, settings) self.assertEqual(crawler.settings.get('TEST1'), 'spider') self.assertEqual(crawler.settings.get('TEST2'), 'spider') @@ -56,12 +57,14 @@ class CrawlerTestCase(BaseCrawlerTest): self.assertTrue(crawler.settings.frozen) def test_crawler_accepts_dict(self): - crawler = Crawler(DefaultSpider, {'foo': 'bar'}) + crawler = get_crawler(DefaultSpider, {'foo': 'bar'}) self.assertEqual(crawler.settings['foo'], 'bar') self.assertOptionIsDefault(crawler.settings, 'RETRY_ENABLED') def test_crawler_accepts_None(self): - crawler = Crawler(DefaultSpider) + with warnings.catch_warnings(): + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + crawler = Crawler(DefaultSpider) self.assertOptionIsDefault(crawler.settings, 'RETRY_ENABLED') def test_crawler_rejects_spider_objects(self): @@ -77,7 +80,7 @@ class SpiderSettingsTestCase(unittest.TestCase): 'AUTOTHROTTLE_ENABLED': True } - crawler = Crawler(MySpider, {}) + crawler = get_crawler(MySpider) enabled_exts = [e.__class__ for e in crawler.extensions.middlewares] self.assertIn(AutoThrottle, enabled_exts) @@ -91,7 +94,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): class MySpider(scrapy.Spider): name = 'spider' - Crawler(MySpider, {}) + get_crawler(MySpider) assert get_scrapy_root_handler() is None def test_spider_custom_settings_log_level(self): @@ -111,7 +114,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): configure_logging() self.assertEqual(get_scrapy_root_handler().level, logging.DEBUG) - crawler = Crawler(MySpider, {}) + crawler = get_crawler(MySpider) self.assertEqual(get_scrapy_root_handler().level, logging.INFO) info_count = crawler.stats.get_value('log_count/INFO') logging.debug('debug message') @@ -148,7 +151,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): } configure_logging() - Crawler(MySpider, {}) + get_crawler(MySpider) logging.debug('debug message') with open(log_file, 'rb') as fo: @@ -229,22 +232,25 @@ class NoRequestsSpider(scrapy.Spider): @mark.usefixtures('reactor_pytest') class CrawlerRunnerHasSpider(unittest.TestCase): + def _runner(self): + return CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'}) + @defer.inlineCallbacks def test_crawler_runner_bootstrap_successful(self): - runner = CrawlerRunner() + runner = self._runner() yield runner.crawl(NoRequestsSpider) self.assertEqual(runner.bootstrap_failed, False) @defer.inlineCallbacks def test_crawler_runner_bootstrap_successful_for_several(self): - runner = CrawlerRunner() + runner = self._runner() yield runner.crawl(NoRequestsSpider) yield runner.crawl(NoRequestsSpider) self.assertEqual(runner.bootstrap_failed, False) @defer.inlineCallbacks def test_crawler_runner_bootstrap_failed(self): - runner = CrawlerRunner() + runner = self._runner() try: yield runner.crawl(ExceptionSpider) @@ -257,7 +263,7 @@ class CrawlerRunnerHasSpider(unittest.TestCase): @defer.inlineCallbacks def test_crawler_runner_bootstrap_failed_for_several(self): - runner = CrawlerRunner() + runner = self._runner() try: yield runner.crawl(ExceptionSpider) @@ -275,12 +281,14 @@ class CrawlerRunnerHasSpider(unittest.TestCase): if self.reactor_pytest == 'asyncio': CrawlerRunner(settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "VERSION", }) else: msg = r"The installed reactor \(.*?\) does not match the requested one \(.*?\)" with self.assertRaisesRegex(Exception, msg): runner = CrawlerRunner(settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "VERSION", }) yield runner.crawl(NoRequestsSpider) diff --git a/tests/test_downloadermiddleware_httpauth.py b/tests/test_downloadermiddleware_httpauth.py index 0362e2018..b9f3e24a4 100644 --- a/tests/test_downloadermiddleware_httpauth.py +++ b/tests/test_downloadermiddleware_httpauth.py @@ -1,7 +1,9 @@ import unittest +import pytest from w3lib.http import basic_auth_header +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request from scrapy.downloadermiddlewares.httpauth import HttpAuthMiddleware from scrapy.spiders import Spider @@ -30,8 +32,10 @@ class HttpAuthMiddlewareLegacyTest(unittest.TestCase): self.spider = TestSpiderLegacy('foo') def test_auth(self): - mw = HttpAuthMiddleware() - mw.spider_opened(self.spider) + with pytest.warns(ScrapyDeprecationWarning, + match="Using HttpAuthMiddleware without http_auth_domain is deprecated"): + mw = HttpAuthMiddleware() + mw.spider_opened(self.spider) # initial request, sets the domain and sends the header req = Request('http://example.com/') @@ -49,8 +53,10 @@ class HttpAuthMiddlewareLegacyTest(unittest.TestCase): self.assertNotIn('Authorization', req.headers) def test_auth_already_set(self): - mw = HttpAuthMiddleware() - mw.spider_opened(self.spider) + with pytest.warns(ScrapyDeprecationWarning, + match="Using HttpAuthMiddleware without http_auth_domain is deprecated"): + mw = HttpAuthMiddleware() + mw.spider_opened(self.spider) req = Request('http://example.com/', headers=dict(Authorization='Digest 123')) assert mw.process_request(req, self.spider) is None diff --git a/tests/test_downloadermiddleware_httpproxy.py b/tests/test_downloadermiddleware_httpproxy.py index 7c97bf32a..4ac85c1ec 100644 --- a/tests/test_downloadermiddleware_httpproxy.py +++ b/tests/test_downloadermiddleware_httpproxy.py @@ -1,13 +1,13 @@ import os -from functools import partial + +import pytest from twisted.trial.unittest import TestCase from scrapy.downloadermiddlewares.httpproxy import HttpProxyMiddleware from scrapy.exceptions import NotConfigured from scrapy.http import Request from scrapy.spiders import Spider -from scrapy.crawler import Crawler -from scrapy.settings import Settings +from scrapy.utils.test import get_crawler spider = Spider('foo') @@ -23,9 +23,9 @@ class TestHttpProxyMiddleware(TestCase): os.environ = self._oldenv def test_not_enabled(self): - settings = Settings({'HTTPPROXY_ENABLED': False}) - crawler = Crawler(Spider, settings) - self.assertRaises(NotConfigured, partial(HttpProxyMiddleware.from_crawler, crawler)) + crawler = get_crawler(Spider, {'HTTPPROXY_ENABLED': False}) + with pytest.raises(NotConfigured): + HttpProxyMiddleware.from_crawler(crawler) def test_no_environment_proxies(self): os.environ = {'dummy_proxy': 'reset_env_and_do_not_raise'} diff --git a/tests/test_downloadermiddleware_stats.py b/tests/test_downloadermiddleware_stats.py index 9e75f0a50..7d88ba4d2 100644 --- a/tests/test_downloadermiddleware_stats.py +++ b/tests/test_downloadermiddleware_stats.py @@ -1,7 +1,9 @@ +import warnings from itertools import product from unittest import TestCase from scrapy.downloadermiddlewares.stats import DownloaderStats +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request, Response from scrapy.spiders import Spider from scrapy.utils.response import response_httprepr @@ -54,7 +56,10 @@ class TestDownloaderStats(TestCase): for test_response in test_responses: self.crawler.stats.set_value('downloader/response_bytes', 0) self.mw.process_response(self.req, test_response, self.spider) - self.assertStatsEqual('downloader/response_bytes', len(response_httprepr(test_response))) + with warnings.catch_warnings(): + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + resp_size = len(response_httprepr(test_response)) + self.assertStatsEqual('downloader/response_bytes', resp_size) def test_process_exception(self): self.mw.process_exception(self.req, MyException(), self.spider) diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index b7df2554a..8a37a8ebe 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -10,7 +10,6 @@ from scrapy.dupefilters import RFPDupeFilter from scrapy.http import Request from scrapy.core.scheduler import Scheduler from scrapy.utils.python import to_bytes -from scrapy.utils.job import job_dir from scrapy.utils.test import get_crawler from tests.spiders import SimpleSpider @@ -29,8 +28,7 @@ class FromCrawlerRFPDupeFilter(RFPDupeFilter): @classmethod def from_crawler(cls, crawler): - debug = crawler.settings.getbool('DUPEFILTER_DEBUG') - df = cls(job_dir(crawler.settings), debug) + df = super().from_crawler(crawler) df.method = 'from_crawler' return df @@ -38,9 +36,8 @@ class FromCrawlerRFPDupeFilter(RFPDupeFilter): class FromSettingsRFPDupeFilter(RFPDupeFilter): @classmethod - def from_settings(cls, settings): - debug = settings.getbool('DUPEFILTER_DEBUG') - df = cls(job_dir(settings), debug) + def from_settings(cls, settings, *, fingerprinter=None): + df = super().from_settings(settings, fingerprinter=fingerprinter) df.method = 'from_settings' return df @@ -53,7 +50,8 @@ class RFPDupeFilterTest(unittest.TestCase): def test_df_from_crawler_scheduler(self): settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter} + 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) @@ -61,14 +59,16 @@ class RFPDupeFilterTest(unittest.TestCase): def test_df_from_settings_scheduler(self): settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromSettingsRFPDupeFilter} + 'DUPEFILTER_CLASS': FromSettingsRFPDupeFilter, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) self.assertEqual(scheduler.df.method, 'from_settings') def test_df_direct_scheduler(self): - settings = {'DUPEFILTER_CLASS': DirectDupeFilter} + settings = {'DUPEFILTER_CLASS': DirectDupeFilter, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertEqual(scheduler.df.method, 'n/a') @@ -171,7 +171,8 @@ class RFPDupeFilterTest(unittest.TestCase): def test_log(self): with LogCapture() as log: settings = {'DUPEFILTER_DEBUG': False, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter} + 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) @@ -197,7 +198,8 @@ class RFPDupeFilterTest(unittest.TestCase): def test_log_debug(self): with LogCapture() as log: settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter} + 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) @@ -230,7 +232,8 @@ class RFPDupeFilterTest(unittest.TestCase): def test_log_debug_default_dupefilter(self): with LogCapture() as log: - settings = {'DUPEFILTER_DEBUG': True} + settings = {'DUPEFILTER_DEBUG': True, + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) diff --git a/tests/test_engine.py b/tests/test_engine.py index fa7d0c8d4..1bd802bcf 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -13,10 +13,11 @@ module with the ``runserver`` argument:: import os import re import sys -import warnings from collections import defaultdict from urllib.parse import urlparse +from dataclasses import dataclass +import pytest import attr from itemadapter import ItemAdapter from pydispatch import dispatcher @@ -50,6 +51,13 @@ class AttrsItem: price = attr.ib(default=0) +@dataclass +class DataClassItem: + name: str = "" + url: str = "" + price: int = 0 + + class TestSpider(Spider): name = "scrapytest.org" allowed_domains = ["scrapytest.org", "localhost"] @@ -92,17 +100,8 @@ class AttrsItemsSpider(TestSpider): item_cls = AttrsItem -try: - from dataclasses import make_dataclass -except ImportError: - DataClassItemsSpider = None -else: - TestDataClass = make_dataclass("TestDataClass", [("name", str), ("url", str), ("price", int)]) - - class DataClassItemsSpider(DictItemsSpider): # type: ignore[no-redef] - def parse_item(self, response): - item = super().parse_item(response) - return TestDataClass(**item) +class DataClassItemsSpider(TestSpider): + item_cls = DataClassItem class ItemZeroDivisionErrorSpider(TestSpider): @@ -188,7 +187,7 @@ class CrawlerRun: return self.deferred def stop(self): - self.port.stopListening() + self.port.stopListening() # FIXME: wait for this Deferred for name, signal in vars(signals).items(): if not name.startswith('_'): disconnect_all(signal) @@ -239,79 +238,77 @@ class EngineTest(unittest.TestCase): def test_crawler(self): for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): - if spider is None: - continue - self.run = CrawlerRun(spider) - yield self.run.run() - self._assert_visited_urls() - self._assert_scheduled_requests(count=9) - self._assert_downloaded_responses(count=9) - self._assert_scraped_items() - self._assert_signals_caught() - self._assert_bytes_received() + run = CrawlerRun(spider) + yield run.run() + self._assert_visited_urls(run) + self._assert_scheduled_requests(run, count=9) + self._assert_downloaded_responses(run, count=9) + self._assert_scraped_items(run) + self._assert_signals_caught(run) + self._assert_bytes_received(run) @defer.inlineCallbacks def test_crawler_dupefilter(self): - self.run = CrawlerRun(TestDupeFilterSpider) - yield self.run.run() - self._assert_scheduled_requests(count=8) - self._assert_dropped_requests() + run = CrawlerRun(TestDupeFilterSpider) + yield run.run() + self._assert_scheduled_requests(run, count=8) + self._assert_dropped_requests(run) @defer.inlineCallbacks def test_crawler_itemerror(self): - self.run = CrawlerRun(ItemZeroDivisionErrorSpider) - yield self.run.run() - self._assert_items_error() + run = CrawlerRun(ItemZeroDivisionErrorSpider) + yield run.run() + self._assert_items_error(run) @defer.inlineCallbacks def test_crawler_change_close_reason_on_idle(self): - self.run = CrawlerRun(ChangeCloseReasonSpider) - yield self.run.run() - self.assertEqual({'spider': self.run.spider, 'reason': 'custom_reason'}, - self.run.signals_caught[signals.spider_closed]) + run = CrawlerRun(ChangeCloseReasonSpider) + yield run.run() + self.assertEqual({'spider': run.spider, 'reason': 'custom_reason'}, + run.signals_caught[signals.spider_closed]) - def _assert_visited_urls(self): + def _assert_visited_urls(self, run: CrawlerRun): must_be_visited = ["/", "/redirect", "/redirected", "/item1.html", "/item2.html", "/item999.html"] - urls_visited = {rp[0].url for rp in self.run.respplug} - urls_expected = {self.run.geturl(p) for p in must_be_visited} + urls_visited = {rp[0].url for rp in run.respplug} + urls_expected = {run.geturl(p) for p in must_be_visited} assert urls_expected <= urls_visited, f"URLs not visited: {list(urls_expected - urls_visited)}" - def _assert_scheduled_requests(self, count=None): - self.assertEqual(count, len(self.run.reqplug)) + def _assert_scheduled_requests(self, run: CrawlerRun, count=None): + self.assertEqual(count, len(run.reqplug)) paths_expected = ['/item999.html', '/item2.html', '/item1.html'] - urls_requested = {rq[0].url for rq in self.run.reqplug} - urls_expected = {self.run.geturl(p) for p in paths_expected} + urls_requested = {rq[0].url for rq in run.reqplug} + urls_expected = {run.geturl(p) for p in paths_expected} assert urls_expected <= urls_requested - scheduled_requests_count = len(self.run.reqplug) - dropped_requests_count = len(self.run.reqdropped) - responses_count = len(self.run.respplug) + scheduled_requests_count = len(run.reqplug) + dropped_requests_count = len(run.reqdropped) + responses_count = len(run.respplug) self.assertEqual(scheduled_requests_count, dropped_requests_count + responses_count) - self.assertEqual(len(self.run.reqreached), + self.assertEqual(len(run.reqreached), responses_count) - def _assert_dropped_requests(self): - self.assertEqual(len(self.run.reqdropped), 1) + def _assert_dropped_requests(self, run: CrawlerRun): + self.assertEqual(len(run.reqdropped), 1) - def _assert_downloaded_responses(self, count): + def _assert_downloaded_responses(self, run: CrawlerRun, count): # response tests - self.assertEqual(count, len(self.run.respplug)) - self.assertEqual(count, len(self.run.reqreached)) + self.assertEqual(count, len(run.respplug)) + self.assertEqual(count, len(run.reqreached)) - for response, _ in self.run.respplug: - if self.run.getpath(response.url) == '/item999.html': + for response, _ in run.respplug: + if run.getpath(response.url) == '/item999.html': self.assertEqual(404, response.status) - if self.run.getpath(response.url) == '/redirect': + if run.getpath(response.url) == '/redirect': self.assertEqual(302, response.status) - def _assert_items_error(self): - self.assertEqual(2, len(self.run.itemerror)) - for item, response, spider, failure in self.run.itemerror: + def _assert_items_error(self, run: CrawlerRun): + self.assertEqual(2, len(run.itemerror)) + for item, response, spider, failure in run.itemerror: self.assertEqual(failure.value.__class__, ZeroDivisionError) - self.assertEqual(spider, self.run.spider) + self.assertEqual(spider, run.spider) self.assertEqual(item['url'], response.url) if 'item1.html' in item['url']: @@ -321,9 +318,9 @@ class EngineTest(unittest.TestCase): self.assertEqual('Item 2 name', item['name']) self.assertEqual('200', item['price']) - def _assert_scraped_items(self): - self.assertEqual(2, len(self.run.itemresp)) - for item, response in self.run.itemresp: + def _assert_scraped_items(self, run: CrawlerRun): + self.assertEqual(2, len(run.itemresp)) + for item, response in run.itemresp: item = ItemAdapter(item) self.assertEqual(item['url'], response.url) if 'item1.html' in item['url']: @@ -333,26 +330,26 @@ class EngineTest(unittest.TestCase): self.assertEqual('Item 2 name', item['name']) self.assertEqual('200', item['price']) - def _assert_headers_received(self): - for headers in self.run.headers.values(): + def _assert_headers_received(self, run: CrawlerRun): + for headers in run.headers.values(): self.assertIn(b"Server", headers) self.assertIn(b"TwistedWeb", headers[b"Server"]) self.assertIn(b"Date", headers) self.assertIn(b"Content-Type", headers) - def _assert_bytes_received(self): - self.assertEqual(9, len(self.run.bytes)) - for request, data in self.run.bytes.items(): + def _assert_bytes_received(self, run: CrawlerRun): + self.assertEqual(9, len(run.bytes)) + for request, data in run.bytes.items(): joined_data = b"".join(data) - if self.run.getpath(request.url) == "/": + if run.getpath(request.url) == "/": self.assertEqual(joined_data, get_testdata("test_site", "index.html")) - elif self.run.getpath(request.url) == "/item1.html": + elif run.getpath(request.url) == "/item1.html": self.assertEqual(joined_data, get_testdata("test_site", "item1.html")) - elif self.run.getpath(request.url) == "/item2.html": + elif run.getpath(request.url) == "/item2.html": self.assertEqual(joined_data, get_testdata("test_site", "item2.html")) - elif self.run.getpath(request.url) == "/redirected": + elif run.getpath(request.url) == "/redirected": self.assertEqual(joined_data, b"Redirected here") - elif self.run.getpath(request.url) == '/redirect': + elif run.getpath(request.url) == '/redirect': self.assertEqual( joined_data, b"\n\n" @@ -364,7 +361,7 @@ class EngineTest(unittest.TestCase): b" \n" b"\n" ) - elif self.run.getpath(request.url) == "/tem999.html": + elif run.getpath(request.url) == "/tem999.html": self.assertEqual( joined_data, b"\n\n" @@ -375,27 +372,27 @@ class EngineTest(unittest.TestCase): b" \n" b"\n" ) - elif self.run.getpath(request.url) == "/numbers": + elif run.getpath(request.url) == "/numbers": # signal was fired multiple times self.assertTrue(len(data) > 1) # bytes were received in order numbers = [str(x).encode("utf8") for x in range(2**18)] self.assertEqual(joined_data, b"".join(numbers)) - def _assert_signals_caught(self): - assert signals.engine_started in self.run.signals_caught - assert signals.engine_stopped in self.run.signals_caught - assert signals.spider_opened in self.run.signals_caught - assert signals.spider_idle in self.run.signals_caught - assert signals.spider_closed in self.run.signals_caught - assert signals.headers_received in self.run.signals_caught + def _assert_signals_caught(self, run: CrawlerRun): + assert signals.engine_started in run.signals_caught + assert signals.engine_stopped in run.signals_caught + assert signals.spider_opened in run.signals_caught + assert signals.spider_idle in run.signals_caught + assert signals.spider_closed in run.signals_caught + assert signals.headers_received in run.signals_caught - self.assertEqual({'spider': self.run.spider}, - self.run.signals_caught[signals.spider_opened]) - self.assertEqual({'spider': self.run.spider}, - self.run.signals_caught[signals.spider_idle]) - self.assertEqual({'spider': self.run.spider, 'reason': 'finished'}, - self.run.signals_caught[signals.spider_closed]) + self.assertEqual({'spider': run.spider}, + run.signals_caught[signals.spider_opened]) + self.assertEqual({'spider': run.spider}, + run.signals_caught[signals.spider_idle]) + self.assertEqual({'spider': run.spider, 'reason': 'finished'}, + run.signals_caught[signals.spider_closed]) @defer.inlineCallbacks def test_close_downloader(self): @@ -407,28 +404,29 @@ class EngineTest(unittest.TestCase): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) yield e.open_spider(TestSpider(), []) e.start() - yield self.assertFailure(e.start(), RuntimeError).addBoth( - lambda exc: self.assertEqual(str(exc), "Engine already running") - ) - yield e.stop() + try: + yield self.assertFailure(e.start(), RuntimeError).addBoth( + lambda exc: self.assertEqual(str(exc), "Engine already running") + ) + finally: + yield e.stop() @defer.inlineCallbacks def test_close_spiders_downloader(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="ExecutionEngine.open_spiders is deprecated, " + "please use ExecutionEngine.spider instead"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) yield e.open_spider(TestSpider(), []) self.assertEqual(len(e.open_spiders), 1) yield e.close() self.assertEqual(len(e.open_spiders), 0) - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual( - str(warning_list[0].message), - "ExecutionEngine.open_spiders is deprecated, please use ExecutionEngine.spider instead", - ) @defer.inlineCallbacks def test_close_engine_spiders_downloader(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="ExecutionEngine.open_spiders is deprecated, " + "please use ExecutionEngine.spider instead"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) yield e.open_spider(TestSpider(), []) e.start() @@ -436,61 +434,47 @@ class EngineTest(unittest.TestCase): yield e.close() self.assertFalse(e.running) self.assertEqual(len(e.open_spiders), 0) - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual( - str(warning_list[0].message), - "ExecutionEngine.open_spiders is deprecated, please use ExecutionEngine.spider instead", - ) @defer.inlineCallbacks def test_crawl_deprecated_spider_arg(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="Passing a 'spider' argument to " + "ExecutionEngine.crawl is deprecated"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) e.start() e.crawl(Request("data:,"), spider) yield e.close() - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual( - str(warning_list[0].message), - "Passing a 'spider' argument to ExecutionEngine.crawl is deprecated", - ) @defer.inlineCallbacks def test_download_deprecated_spider_arg(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="Passing a 'spider' argument to " + "ExecutionEngine.download is deprecated"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) e.start() e.download(Request("data:,"), spider) yield e.close() - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual( - str(warning_list[0].message), - "Passing a 'spider' argument to ExecutionEngine.download is deprecated", - ) @defer.inlineCallbacks def test_deprecated_schedule(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="ExecutionEngine.schedule is deprecated, please use " + "ExecutionEngine.crawl or ExecutionEngine.download instead"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) e.start() e.schedule(Request("data:,"), spider) yield e.close() - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual( - str(warning_list[0].message), - "ExecutionEngine.schedule is deprecated, please use " - "ExecutionEngine.crawl or ExecutionEngine.download instead", - ) @defer.inlineCallbacks def test_deprecated_has_capacity(self): - with warnings.catch_warnings(record=True) as warning_list: + with pytest.warns(ScrapyDeprecationWarning, + match="ExecutionEngine.has_capacity is deprecated"): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) self.assertTrue(e.has_capacity()) spider = TestSpider() @@ -499,8 +483,6 @@ class EngineTest(unittest.TestCase): e.start() yield e.close() self.assertTrue(e.has_capacity()) - self.assertEqual(warning_list[0].category, ScrapyDeprecationWarning) - self.assertEqual(str(warning_list[0].message), "ExecutionEngine.has_capacity is deprecated") if __name__ == "__main__": diff --git a/tests/test_engine_stop_download_bytes.py b/tests/test_engine_stop_download_bytes.py index 0ba69e096..933e4067d 100644 --- a/tests/test_engine_stop_download_bytes.py +++ b/tests/test_engine_stop_download_bytes.py @@ -23,36 +23,34 @@ class BytesReceivedEngineTest(EngineTest): @defer.inlineCallbacks def test_crawler(self): for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): - if spider is None: - continue - self.run = BytesReceivedCrawlerRun(spider) + run = BytesReceivedCrawlerRun(spider) with LogCapture() as log: - yield self.run.run() + yield run.run() log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for " + f"Download stopped for " "from signal handler BytesReceivedCrawlerRun.bytes_received")) log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for " + f"Download stopped for " "from signal handler BytesReceivedCrawlerRun.bytes_received")) log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for " + f"Download stopped for " "from signal handler BytesReceivedCrawlerRun.bytes_received")) - self._assert_visited_urls() - self._assert_scheduled_requests(count=9) - self._assert_downloaded_responses(count=9) - self._assert_signals_caught() - self._assert_headers_received() - self._assert_bytes_received() + self._assert_visited_urls(run) + self._assert_scheduled_requests(run, count=9) + self._assert_downloaded_responses(run, count=9) + self._assert_signals_caught(run) + self._assert_headers_received(run) + self._assert_bytes_received(run) - def _assert_bytes_received(self): - self.assertEqual(9, len(self.run.bytes)) - for request, data in self.run.bytes.items(): + def _assert_bytes_received(self, run: CrawlerRun): + self.assertEqual(9, len(run.bytes)) + for request, data in run.bytes.items(): joined_data = b"".join(data) self.assertTrue(len(data) == 1) # signal was fired only once - if self.run.getpath(request.url) == "/numbers": + if run.getpath(request.url) == "/numbers": # Received bytes are not the complete response. The exact amount depends # on the buffer size, which can vary, so we only check that the amount # of received bytes is strictly less than the full response. diff --git a/tests/test_engine_stop_download_headers.py b/tests/test_engine_stop_download_headers.py index fad6643ad..8975d0e3f 100644 --- a/tests/test_engine_stop_download_headers.py +++ b/tests/test_engine_stop_download_headers.py @@ -23,34 +23,32 @@ class HeadersReceivedEngineTest(EngineTest): @defer.inlineCallbacks def test_crawler(self): for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): - if spider is None: - continue - self.run = HeadersReceivedCrawlerRun(spider) + run = HeadersReceivedCrawlerRun(spider) with LogCapture() as log: - yield self.run.run() + yield run.run() log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for from" + f"Download stopped for from" " signal handler HeadersReceivedCrawlerRun.headers_received")) log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for from signal" + f"Download stopped for from signal" " handler HeadersReceivedCrawlerRun.headers_received")) log.check_present(("scrapy.core.downloader.handlers.http11", "DEBUG", - f"Download stopped for from" + f"Download stopped for from" " signal handler HeadersReceivedCrawlerRun.headers_received")) - self._assert_visited_urls() - self._assert_downloaded_responses(count=6) - self._assert_signals_caught() - self._assert_bytes_received() - self._assert_headers_received() + self._assert_visited_urls(run) + self._assert_downloaded_responses(run, count=6) + self._assert_signals_caught(run) + self._assert_bytes_received(run) + self._assert_headers_received(run) - def _assert_bytes_received(self): - self.assertEqual(0, len(self.run.bytes)) + def _assert_bytes_received(self, run: CrawlerRun): + self.assertEqual(0, len(run.bytes)) - def _assert_visited_urls(self): + def _assert_visited_urls(self, run: CrawlerRun): must_be_visited = ["/", "/redirect", "/redirected"] - urls_visited = {rp[0].url for rp in self.run.respplug} - urls_expected = {self.run.geturl(p) for p in must_be_visited} + urls_visited = {rp[0].url for rp in run.respplug} + urls_expected = {run.geturl(p) for p in must_be_visited} assert urls_expected <= urls_visited, f"URLs not visited: {list(urls_expected - urls_visited)}" diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index ec48f8d4a..ecd1b59d3 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -22,6 +22,7 @@ from urllib.parse import urljoin, quote from urllib.request import pathname2url import lxml.etree +import pytest from testfixtures import LogCapture from twisted.internet import defer from twisted.trial import unittest @@ -30,7 +31,6 @@ from zope.interface import implementer from zope.interface.verify import verifyObject import scrapy -from scrapy.crawler import CrawlerRunner from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.exporters import CsvItemExporter from scrapy.extensions.feedexport import ( @@ -697,9 +697,9 @@ class FeedExportTest(FeedExportTestBase): content = {} try: with MockServer() as s: - runner = CrawlerRunner(Settings(settings)) spider_cls.start_urls = [s.url('/')] - yield runner.crawl(spider_cls) + crawler = get_crawler(spider_cls, settings) + yield crawler.crawl() for file_path, feed_options in FEEDS.items(): if not os.path.exists(str(file_path)): @@ -1554,9 +1554,9 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): content = {} try: with MockServer() as s: - runner = CrawlerRunner(Settings(settings)) spider_cls.start_urls = [s.url('/')] - yield runner.crawl(spider_cls) + crawler = get_crawler(spider_cls, settings) + yield crawler.crawl() for file_path, feed_options in FEEDS.items(): if not os.path.exists(str(file_path)): @@ -2026,9 +2026,9 @@ class BatchDeliveriesTest(FeedExportTestBase): content = defaultdict(list) try: with MockServer() as s: - runner = CrawlerRunner(Settings(settings)) spider_cls.start_urls = [s.url('/')] - yield runner.crawl(spider_cls) + crawler = get_crawler(spider_cls, settings) + yield crawler.crawl() for path, feed in FEEDS.items(): dir_name = os.path.dirname(path) @@ -2048,7 +2048,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'jl', self._file_mark): {'format': 'jl'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) for batch in data['jl']: @@ -2064,7 +2064,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'csv', self._file_mark): {'format': 'csv'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') data = yield self.exported_data(items, settings) for batch in data['csv']: got_batch = csv.DictReader(to_unicode(batch).splitlines()) @@ -2080,7 +2080,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'xml', self._file_mark): {'format': 'xml'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) for batch in data['xml']: @@ -2098,7 +2098,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'json', self._file_mark): {'format': 'json'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) # XML @@ -2123,7 +2123,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'pickle', self._file_mark): {'format': 'pickle'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) import pickle @@ -2140,7 +2140,7 @@ class BatchDeliveriesTest(FeedExportTestBase): os.path.join(self._random_temp_filename(), 'marshal', self._file_mark): {'format': 'marshal'}, }, }) - batch_size = settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT') + batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) import marshal @@ -2166,7 +2166,7 @@ class BatchDeliveriesTest(FeedExportTestBase): 'FEED_EXPORT_BATCH_ITEM_COUNT': 2 } header = self.MyItem.fields.keys() - yield self.assertExported(items, header, rows, settings=Settings(settings)) + yield self.assertExported(items, header, rows, settings=settings) def test_wrong_path(self): """ If path is without %(batch_time)s and %(batch_id) an exception must be raised """ @@ -2382,9 +2382,9 @@ class BatchDeliveriesTest(FeedExportTestBase): yield item with MockServer() as server: - runner = CrawlerRunner(Settings(settings)) TestSpider.start_urls = [server.url('/')] - yield runner.crawl(TestSpider) + crawler = get_crawler(TestSpider, settings) + yield crawler.crawl() self.assertEqual(len(CustomS3FeedStorage.stubs), len(items) + 1) for stub in CustomS3FeedStorage.stubs[:-1]: @@ -2434,25 +2434,16 @@ class StdoutFeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': StdoutFeedStorageWithoutFeedOptions }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") - with warnings.catch_warnings(record=True) as w: + with pytest.warns(ScrapyDeprecationWarning, + match="StdoutFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "StdoutFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) class FileFeedStorageWithoutFeedOptions(FileFeedStorage): @@ -2476,25 +2467,16 @@ class FileFeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': FileFeedStorageWithoutFeedOptions }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="FileFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "FileFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) class S3FeedStorageWithoutFeedOptions(S3FeedStorage): @@ -2524,26 +2506,18 @@ class S3FeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': S3FeedStorageWithoutFeedOptions }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="S3FeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "S3FeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) def test_from_crawler(self): settings_dict = { @@ -2552,26 +2526,18 @@ class S3FeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': S3FeedStorageWithoutFeedOptionsWithFromCrawler }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="S3FeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "S3FeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler " - "does not support the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) class FTPFeedStorageWithoutFeedOptions(FTPFeedStorage): @@ -2601,26 +2567,18 @@ class FTPFeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': FTPFeedStorageWithoutFeedOptions }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="FTPFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "FTPFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) def test_from_crawler(self): settings_dict = { @@ -2629,50 +2587,50 @@ class FTPFeedStoragePreFeedOptionsTest(unittest.TestCase): 'file': FTPFeedStorageWithoutFeedOptionsWithFromCrawler }, } - crawler = get_crawler(settings_dict=settings_dict) - feed_exporter = FeedExporter.from_crawler(crawler) + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings_dict) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="FTPFeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " + "the 'feed_options' keyword argument."): feed_exporter.open_spider(spider) - messages = tuple(str(item.message) for item in w - if item.category is ScrapyDeprecationWarning) - self.assertEqual( - messages, - ( - ( - "FTPFeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler " - "does not support the 'feed_options' keyword argument. Add a " - "'feed_options' parameter to its signature to remove " - "this warning. This parameter will become mandatory " - "in a future version of Scrapy." - ), - ) - ) class URIParamsTest: spider_name = "uri_params_spider" + deprecated_options = False def build_settings(self, uri='file:///tmp/foobar', uri_params=None): raise NotImplementedError + def _crawler_feed_exporter(self, settings): + if self.deprecated_options: + with pytest.warns(ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + crawler = get_crawler(settings_dict=settings) + feed_exporter = FeedExporter.from_crawler(crawler) + else: + crawler = get_crawler(settings_dict=settings) + feed_exporter = FeedExporter.from_crawler(crawler) + return crawler, feed_exporter + def test_default(self): settings = self.build_settings( uri='file:///tmp/%(name)s', ) - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) + crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - messages = tuple( - str(item.message) for item in w - if item.category is ScrapyDeprecationWarning - ) - self.assertEqual(messages, tuple()) self.assertEqual( feed_exporter.slots[0].uri, @@ -2687,28 +2645,13 @@ class URIParamsTest: uri='file:///tmp/%(name)s', uri_params=uri_params, ) - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) + crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with pytest.warns(ScrapyDeprecationWarning, + match="Modifying the params dictionary in-place"): feed_exporter.open_spider(spider) - messages = tuple( - str(item.message) for item in w - if item.category is ScrapyDeprecationWarning - ) - self.assertEqual( - messages, - ( - ( - 'Modifying the params dictionary in-place in the ' - 'function defined in the FEED_URI_PARAMS setting or ' - 'in the uri_params key of the FEEDS setting is ' - 'deprecated. The function must return a new ' - 'dictionary instead.' - ), - ) - ) self.assertEqual( feed_exporter.slots[0].uri, @@ -2723,18 +2666,14 @@ class URIParamsTest: uri='file:///tmp/%(name)s', uri_params=uri_params, ) - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) + crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) with self.assertRaises(KeyError): feed_exporter.open_spider(spider) - messages = tuple( - str(item.message) for item in w - if item.category is ScrapyDeprecationWarning - ) - self.assertEqual(messages, tuple()) def test_params_as_is(self): def uri_params(params, spider): @@ -2744,17 +2683,12 @@ class URIParamsTest: uri='file:///tmp/%(name)s', uri_params=uri_params, ) - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) + crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - messages = tuple( - str(item.message) for item in w - if item.category is ScrapyDeprecationWarning - ) - self.assertEqual(messages, tuple()) self.assertEqual( feed_exporter.slots[0].uri, @@ -2769,17 +2703,12 @@ class URIParamsTest: uri='file:///tmp/%(foo)s', uri_params=uri_params, ) - crawler = get_crawler(settings_dict=settings) - feed_exporter = FeedExporter.from_crawler(crawler) + crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with warnings.catch_warnings(record=True) as w: + with warnings.catch_warnings(): + warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - messages = tuple( - str(item.message) for item in w - if item.category is ScrapyDeprecationWarning - ) - self.assertEqual(messages, tuple()) self.assertEqual( feed_exporter.slots[0].uri, @@ -2788,6 +2717,7 @@ class URIParamsTest: class URIParamsSettingTest(URIParamsTest, unittest.TestCase): + deprecated_options = True def build_settings(self, uri='file:///tmp/foobar', uri_params=None): extra_settings = {} @@ -2800,6 +2730,7 @@ class URIParamsSettingTest(URIParamsTest, unittest.TestCase): class URIParamsFeedOptionTest(URIParamsTest, unittest.TestCase): + deprecated_options = False def build_settings(self, uri='file:///tmp/foobar', uri_params=None): options = { diff --git a/tests/test_logformatter.py b/tests/test_logformatter.py index 6381f895b..f3bb23bda 100644 --- a/tests/test_logformatter.py +++ b/tests/test_logformatter.py @@ -5,8 +5,8 @@ from twisted.internet import defer from twisted.python.failure import Failure from twisted.trial.unittest import TestCase as TwistedTestCase -from scrapy.crawler import CrawlerRunner from scrapy.exceptions import DropItem +from scrapy.utils.test import get_crawler from scrapy.http import Request, Response from scrapy.item import Item, Field from scrapy.logformatter import LogFormatter @@ -202,7 +202,7 @@ class ShowOrSkipMessagesTestCase(TwistedTestCase): @defer.inlineCallbacks def test_show_messages(self): - crawler = CrawlerRunner(self.base_settings).create_crawler(ItemSpider) + crawler = get_crawler(ItemSpider, self.base_settings) with LogCapture() as lc: yield crawler.crawl(mockserver=self.mockserver) self.assertIn("Scraped from <200 http://127.0.0.1:", str(lc)) @@ -213,7 +213,7 @@ class ShowOrSkipMessagesTestCase(TwistedTestCase): def test_skip_messages(self): settings = self.base_settings.copy() settings['LOG_FORMATTER'] = SkipMessagesLogFormatter - crawler = CrawlerRunner(settings).create_crawler(ItemSpider) + crawler = get_crawler(ItemSpider, settings) with LogCapture() as lc: yield crawler.crawl(mockserver=self.mockserver) self.assertNotIn("Scraped from <200 http://127.0.0.1:", str(lc)) diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index f49fda701..e46532a1c 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -64,6 +64,7 @@ class FileDownloadCrawlTestCase(TestCase): self.tmpmediastore = self.mktemp() os.mkdir(self.tmpmediastore) self.settings = { + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', 'ITEM_PIPELINES': {self.pipeline_class: 1}, self.store_setting_key: self.tmpmediastore, } @@ -78,8 +79,10 @@ class FileDownloadCrawlTestCase(TestCase): def _on_item_scraped(self, item): self.items.append(item) - def _create_crawler(self, spider_class, **kwargs): - crawler = self.runner.create_crawler(spider_class, **kwargs) + def _create_crawler(self, spider_class, runner=None, **kwargs): + if runner is None: + runner = self.runner + crawler = runner.create_crawler(spider_class, **kwargs) crawler.signals.connect(self._on_item_scraped, signals.item_scraped) return crawler @@ -167,9 +170,8 @@ class FileDownloadCrawlTestCase(TestCase): def test_download_media_redirected_allowed(self): settings = dict(self.settings) settings.update({'MEDIA_ALLOW_REDIRECTS': True}) - self.runner = CrawlerRunner(settings) - - crawler = self._create_crawler(RedirectedMediaDownloadSpider) + runner = CrawlerRunner(settings) + crawler = self._create_crawler(RedirectedMediaDownloadSpider, runner=runner) with LogCapture() as log: yield crawler.crawl( self.mockserver.url("/files/images/"), diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index 25d9657d5..0406d906f 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -2,8 +2,8 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase from scrapy import Request, signals -from scrapy.crawler import CrawlerRunner from scrapy.http.response import Response +from scrapy.utils.test import get_crawler from testfixtures import LogCapture @@ -71,7 +71,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_response_200(self): url = self.mockserver.url("/status?n=200") - crawler = CrawlerRunner().create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.request.url, url) @@ -80,7 +80,7 @@ class CrawlTestCase(TestCase): def test_response_error(self): for status in ("404", "500"): url = self.mockserver.url(f"/status?n={status}") - crawler = CrawlerRunner().create_crawler(SingleRequestSpider) + crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=url, mockserver=self.mockserver) failure = crawler.spider.meta["failure"] response = failure.value.response @@ -90,12 +90,11 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_downloader_middleware_raise_exception(self): url = self.mockserver.url("/status?n=200") - runner = CrawlerRunner(settings={ + crawler = get_crawler(SingleRequestSpider, { "DOWNLOADER_MIDDLEWARES": { RaiseExceptionRequestMiddleware: 590, }, }) - crawler = runner.create_crawler(SingleRequestSpider) yield crawler.crawl(seed=url, mockserver=self.mockserver) failure = crawler.spider.meta["failure"] self.assertEqual(failure.request.url, url) @@ -117,12 +116,11 @@ class CrawlTestCase(TestCase): signal_params["request"] = request url = self.mockserver.url("/status?n=200") - runner = CrawlerRunner(settings={ + crawler = get_crawler(SingleRequestSpider, { "DOWNLOADER_MIDDLEWARES": { ProcessResponseMiddleware: 595, } }) - crawler = runner.create_crawler(SingleRequestSpider) crawler.signals.connect(signal_handler, signal=signals.response_received) with LogCapture() as log: @@ -147,13 +145,12 @@ class CrawlTestCase(TestCase): The spider callback should receive the overridden response.request """ url = self.mockserver.url("/status?n=200") - runner = CrawlerRunner(settings={ + crawler = get_crawler(SingleRequestSpider, { "DOWNLOADER_MIDDLEWARES": { RaiseExceptionRequestMiddleware: 590, CatchExceptionOverrideRequestMiddleware: 595, }, }) - crawler = runner.create_crawler(SingleRequestSpider) yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.body, b"Caught ZeroDivisionError") @@ -168,13 +165,12 @@ class CrawlTestCase(TestCase): The spider callback should receive the original response.request """ url = self.mockserver.url("/status?n=200") - runner = CrawlerRunner(settings={ + crawler = get_crawler(SingleRequestSpider, { "DOWNLOADER_MIDDLEWARES": { RaiseExceptionRequestMiddleware: 590, CatchExceptionDoNotOverrideRequestMiddleware: 595, }, }) - crawler = runner.create_crawler(SingleRequestSpider) yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.body, b"Caught ZeroDivisionError") @@ -186,12 +182,11 @@ class CrawlTestCase(TestCase): Downloader middleware which returns a response with a specific 'request' attribute, with an alternative callback """ - runner = CrawlerRunner(settings={ + crawler = get_crawler(AlternativeCallbacksSpider, { "DOWNLOADER_MIDDLEWARES": { AlternativeCallbacksMiddleware: 595, } }) - crawler = runner.create_crawler(AlternativeCallbacksSpider) with LogCapture() as log: url = self.mockserver.url("/status?n=200") diff --git a/tests/test_request_cb_kwargs.py b/tests/test_request_cb_kwargs.py index 473a93e69..002a04358 100644 --- a/tests/test_request_cb_kwargs.py +++ b/tests/test_request_cb_kwargs.py @@ -3,7 +3,7 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase from scrapy.http import Request -from scrapy.crawler import CrawlerRunner +from scrapy.utils.test import get_crawler from tests.spiders import MockServerSpider from tests.mockserver import MockServer @@ -140,14 +140,13 @@ class CallbackKeywordArgumentsTestCase(TestCase): def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() - self.runner = CrawlerRunner() def tearDown(self): self.mockserver.__exit__(None, None, None) @defer.inlineCallbacks def test_callback_kwargs(self): - crawler = self.runner.create_crawler(KeywordArgumentsSpider) + crawler = get_crawler(KeywordArgumentsSpider) with LogCapture() as log: yield crawler.crawl(mockserver=self.mockserver) self.assertTrue(all(crawler.spider.checks)) diff --git a/tests/test_scheduler.py b/tests/test_scheduler.py index 2d4bfa165..ac66056ba 100644 --- a/tests/test_scheduler.py +++ b/tests/test_scheduler.py @@ -52,6 +52,7 @@ class MockCrawler(Crawler): SCHEDULER_PRIORITY_QUEUE=priority_queue_cls, JOBDIR=jobdir, DUPEFILTER_CLASS='scrapy.dupefilters.BaseDupeFilter', + REQUEST_FINGERPRINTER_IMPLEMENTATION='VERSION', ) super().__init__(Spider, settings) self.engine = MockEngine(downloader=MockDownloader()) @@ -334,7 +335,7 @@ class TestIncompatibility(unittest.TestCase): SCHEDULER_PRIORITY_QUEUE='scrapy.pqueues.DownloaderAwarePriorityQueue', CONCURRENT_REQUESTS_PER_IP=1, ) - crawler = Crawler(Spider, settings) + crawler = get_crawler(Spider, settings) scheduler = Scheduler.from_crawler(crawler) spider = Spider(name='spider') scheduler.open(spider) diff --git a/tests/test_scheduler_base.py b/tests/test_scheduler_base.py index bf90b4320..fc234a83d 100644 --- a/tests/test_scheduler_base.py +++ b/tests/test_scheduler_base.py @@ -7,10 +7,10 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase as TwistedTestCase from scrapy.core.scheduler import BaseScheduler -from scrapy.crawler import CrawlerRunner from scrapy.http import Request from scrapy.spiders import Spider -from scrapy.utils.request import request_fingerprint +from scrapy.utils.request import fingerprint +from scrapy.utils.test import get_crawler from tests.mockserver import MockServer @@ -21,13 +21,13 @@ URLS = [urljoin("https://example.org", p) for p in PATHS] class MinimalScheduler: def __init__(self) -> None: - self.requests: Dict[str, Request] = {} + self.requests: Dict[bytes, Request] = {} def has_pending_requests(self) -> bool: return bool(self.requests) def enqueue_request(self, request: Request) -> bool: - fp = request_fingerprint(request) + fp = fingerprint(request) if fp not in self.requests: self.requests[fp] = request return True @@ -147,9 +147,12 @@ class MinimalSchedulerCrawlTest(TwistedTestCase): @defer.inlineCallbacks def test_crawl(self): with MockServer() as mockserver: - settings = {"SCHEDULER": self.scheduler_cls} + settings = { + "SCHEDULER": self.scheduler_cls, + } with LogCapture() as log: - yield CrawlerRunner(settings).crawl(TestSpider, mockserver) + crawler = get_crawler(TestSpider, settings) + yield crawler.crawl(mockserver) for path in PATHS: self.assertIn(f"{{'path': '{path}'}}", str(log)) self.assertIn(f"'item_scraped_count': {len(PATHS)}", str(log)) diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 8a35e9fd7..3719c7c9f 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -96,7 +96,10 @@ class SpiderLoaderTest(unittest.TestCase): def test_crawler_runner_loading(self): module = 'tests.test_spiderloader.test_spiders.spider1' - runner = CrawlerRunner({'SPIDER_MODULES': [module]}) + runner = CrawlerRunner({ + 'SPIDER_MODULES': [module], + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + }) self.assertRaisesRegex(KeyError, 'Spider not found', runner.create_crawler, 'spider2') diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index 1ef4eeb14..46452415a 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -3,6 +3,7 @@ import os import tempfile import shutil import contextlib +import warnings from pytest import warns @@ -68,20 +69,21 @@ class GetProjectSettingsTestCase(unittest.TestCase): envvars = { 'SCRAPY_SETTINGS_MODULE': value, } - with set_env(**envvars), warns(None) as warnings: - settings = get_project_settings() - assert not warnings + with warnings.catch_warnings(): + warnings.simplefilter("error") + with set_env(**envvars): + settings = get_project_settings() + assert settings.get('SETTINGS_MODULE') == value def test_invalid_envvar(self): envvars = { 'SCRAPY_FOO': 'bar', } - with set_env(**envvars), warns(None) as warnings: - get_project_settings() - assert len(warnings) == 1 - assert warnings[0].category == ScrapyDeprecationWarning - assert str(warnings[0].message).endswith(': FOO') + with warns(ScrapyDeprecationWarning, match=': FOO') as record: + with set_env(**envvars): + get_project_settings() + assert len(record) == 1 def test_valid_and_invalid_envvars(self): value = 'tests.test_cmdline.settings' @@ -89,9 +91,8 @@ class GetProjectSettingsTestCase(unittest.TestCase): 'SCRAPY_FOO': 'bar', 'SCRAPY_SETTINGS_MODULE': value, } - with set_env(**envvars), warns(None) as warnings: - settings = get_project_settings() - assert len(warnings) == 1 - assert warnings[0].category == ScrapyDeprecationWarning - assert str(warnings[0].message).endswith(': FOO') + with warns(ScrapyDeprecationWarning, match=': FOO') as record: + with set_env(**envvars): + settings = get_project_settings() + assert len(record) == 1 assert settings.get('SETTINGS_MODULE') == value diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index e9edfee98..5ee772c0b 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -308,13 +308,22 @@ class RequestFingerprintTest(FingerprintTest): ), ) + def setUp(self) -> None: + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + + def tearDown(self) -> None: + warnings.simplefilter("default", ScrapyDeprecationWarning) + @pytest.mark.xfail(reason='known bug kept for backward compatibility', strict=True) def test_part_separation(self): super().test_part_separation() + +class RequestFingerprintDeprecationTest(unittest.TestCase): + def test_deprecation_default_parameters(self): with pytest.warns(ScrapyDeprecationWarning) as warnings: - self.function(Request("http://www.example.com")) + request_fingerprint(Request("http://www.example.com")) messages = [str(warning.message) for warning in warnings] self.assertTrue( any( @@ -326,7 +335,7 @@ class RequestFingerprintTest(FingerprintTest): def test_deprecation_non_default_parameters(self): with pytest.warns(ScrapyDeprecationWarning) as warnings: - self.function(Request("http://www.example.com"), keep_fragments=True) + request_fingerprint(Request("http://www.example.com"), keep_fragments=True) messages = [str(warning.message) for warning in warnings] self.assertTrue( any( diff --git a/tests/test_utils_response.py b/tests/test_utils_response.py index 0a09f6109..d20852e62 100644 --- a/tests/test_utils_response.py +++ b/tests/test_utils_response.py @@ -1,7 +1,9 @@ import os import unittest +import warnings from urllib.parse import urlparse +from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Response, TextResponse, HtmlResponse from scrapy.utils.python import to_bytes from scrapy.utils.response import (response_httprepr, open_in_browser, @@ -15,14 +17,21 @@ class ResponseUtilsTest(unittest.TestCase): dummy_response = TextResponse(url='http://example.org/', body=b'dummy_response') def test_response_httprepr(self): - r1 = Response("http://www.example.com") - self.assertEqual(response_httprepr(r1), b'HTTP/1.1 200 OK\r\n\r\n') + with warnings.catch_warnings(): + warnings.simplefilter("ignore", ScrapyDeprecationWarning) - r1 = Response("http://www.example.com", status=404, headers={"Content-type": "text/html"}, body=b"Some body") - self.assertEqual(response_httprepr(r1), b'HTTP/1.1 404 Not Found\r\nContent-Type: text/html\r\n\r\nSome body') + r1 = Response("http://www.example.com") + self.assertEqual(response_httprepr(r1), b'HTTP/1.1 200 OK\r\n\r\n') - r1 = Response("http://www.example.com", status=6666, headers={"Content-type": "text/html"}, body=b"Some body") - self.assertEqual(response_httprepr(r1), b'HTTP/1.1 6666 \r\nContent-Type: text/html\r\n\r\nSome body') + r1 = Response("http://www.example.com", status=404, + headers={"Content-type": "text/html"}, body=b"Some body") + self.assertEqual(response_httprepr(r1), + b'HTTP/1.1 404 Not Found\r\nContent-Type: text/html\r\n\r\nSome body') + + r1 = Response("http://www.example.com", status=6666, + headers={"Content-type": "text/html"}, body=b"Some body") + self.assertEqual(response_httprepr(r1), + b'HTTP/1.1 6666 \r\nContent-Type: text/html\r\n\r\nSome body') def test_open_in_browser(self): url = "http:///www.example.com/some/page.html" From f60c7ae768fa2f238ea6d7646098fe99ef8ad461 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Wed, 20 Jul 2022 14:01:22 +0500 Subject: [PATCH 134/532] Fixed heading levels in downloader middleware docs (#5567) --- docs/topics/downloader-middleware.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/downloader-middleware.rst b/docs/topics/downloader-middleware.rst index 29e350651..986da0476 100644 --- a/docs/topics/downloader-middleware.rst +++ b/docs/topics/downloader-middleware.rst @@ -955,7 +955,7 @@ default because HTTP specs say so. .. setting:: RETRY_PRIORITY_ADJUST RETRY_PRIORITY_ADJUST ---------------------- +^^^^^^^^^^^^^^^^^^^^^ Default: ``-1`` @@ -1119,7 +1119,7 @@ In order to use this parser: .. _support-for-new-robots-parser: Implementing support for a new parser -------------------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can implement support for a new robots.txt_ parser by subclassing the abstract base class :class:`~scrapy.robotstxt.RobotParser` and From 42056090516bb0cc5d349e232298c711ec452bc5 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Sun, 17 Jul 2022 15:50:40 +0500 Subject: [PATCH 135/532] Fixed intersphinx references --- docs/conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9a0afe73e..3241295af 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -291,9 +291,10 @@ intersphinx_mapping = { 'pytest': ('https://docs.pytest.org/en/latest', None), 'python': ('https://docs.python.org/3', None), 'sphinx': ('https://www.sphinx-doc.org/en/master', None), - 'tox': ('https://tox.readthedocs.io/en/latest', None), - 'twisted': ('https://twistedmatrix.com/documents/current', None), - 'twistedapi': ('https://twistedmatrix.com/documents/current/api', None), + 'tox': ('https://tox.wiki/en/latest/', None), + 'twisted': ('https://docs.twisted.org/en/stable/', None), + 'twistedapi': ('https://docs.twisted.org/en/stable/api/', None), + 'w3lib': ('https://w3lib.readthedocs.io/en/latest', None), } intersphinx_disabled_reftypes = [] From b21c16099ed0acb0589677afd98c0ae3b78cd17d Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 22 Jul 2022 19:18:33 +0500 Subject: [PATCH 136/532] Fix flake8 issues. --- tests/test_spidermiddleware.py | 6 +++--- tests/test_utils_python.py | 2 -- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index ed0912b82..edde6f682 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -305,8 +305,8 @@ class ProcessSpiderOutputInvalidResult(BaseAsyncSpiderMiddlewareTestCase): with self.assertRaisesRegex( _InvalidOutput, ( - "\.process_spider_output must return an iterable, got " + r"\.process_spider_output must return an iterable, got " ), ): yield self._get_middleware_result( @@ -317,7 +317,7 @@ class ProcessSpiderOutputInvalidResult(BaseAsyncSpiderMiddlewareTestCase): def test_coroutine(self): with self.assertRaisesRegex( _InvalidOutput, - "\.process_spider_output must be an asynchronous generator", + r"\.process_spider_output must be an asynchronous generator", ): yield self._get_middleware_result( ProcessSpiderOutputCoroutineMiddleware, diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 00b06b839..b1a8fdc04 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -2,8 +2,6 @@ import functools import gc import operator import platform -import unittest -from datetime import datetime from itertools import count from warnings import catch_warnings, filterwarnings From af7dd16d8ded3e6cb2946603688f4f4a5212e80f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 25 Jul 2022 13:15:17 +0200 Subject: [PATCH 137/532] Merge pull request from GHSA-9x8m-2xpf-crp3 * Enforce matching proxy request meta and Proxy-Authorization header * Cover proxy credential security fix in the release notes * Remove extra empty line * Reword the security issue description * Address scenario where Proxy-Authorization is unexpectedly removed by a prior middleware * Set the release date of Scrapy 2.6.2 and 1.8.3 --- docs/news.rst | 106 ++++++- scrapy/downloadermiddlewares/httpproxy.py | 56 ++-- tests/test_downloadermiddleware_httpproxy.py | 313 ++++++++++++++++++- 3 files changed, 439 insertions(+), 36 deletions(-) diff --git a/docs/news.rst b/docs/news.rst index 7993b4b4f..5bd9ca059 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,10 +5,57 @@ Release notes .. _release-2.6.2: -Scrapy 2.6.2 (to be determined) -------------------------------- +Scrapy 2.6.2 (2022-07-25) +------------------------- -Fixes additional regressions introduced in 2.6.0: +**Security bug fix:** + +- When :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` + processes a request with :reqmeta:`proxy` metadata, and that + :reqmeta:`proxy` metadata includes proxy credentials, + :class:`~scrapy.downloadermiddlewares.httpproxy.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 :reqmeta:`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 + :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` and + any third-party proxy-rotation downloader middleware. + + These third-party proxy-rotation downloader middlewares could change the + :reqmeta:`proxy` metadata of a request to a new value, but fail to remove + the ``Proxy-Authentication`` header from the previous value of the + :reqmeta:`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 + :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` is now + as follows when processing a request: + + - If the request being processed defines :reqmeta:`proxy` metadata that + includes credentials, the ``Proxy-Authorization`` header is always + updated to feature those credentials. + + - If the request being processed defines :reqmeta:`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 :reqmeta:`proxy` metadata, or that metadata is a + falsy value (e.g. ``None``), the ``Proxy-Authorization`` header is + removed. + + It is no longer possible to set a proxy URL through the + :reqmeta:`proxy` metadata but set the credentials through the + ``Proxy-Authorization`` header. Set proxy credentials through the + :reqmeta:`proxy` metadata instead. + +Also fixes the following regressions introduced in 2.6.0: - :class:`~scrapy.crawler.CrawlerProcess` supports again crawling multiple spiders (:issue:`5435`, :issue:`5436`) @@ -1925,6 +1972,59 @@ affect subclasses: (:issue:`3884`) +.. _release-1.8.3: + +Scrapy 1.8.3 (2022-07-25) +------------------------- + +**Security bug fix:** + +- When :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` + processes a request with :reqmeta:`proxy` metadata, and that + :reqmeta:`proxy` metadata includes proxy credentials, + :class:`~scrapy.downloadermiddlewares.httpproxy.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 :reqmeta:`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 + :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` and + any third-party proxy-rotation downloader middleware. + + These third-party proxy-rotation downloader middlewares could change the + :reqmeta:`proxy` metadata of a request to a new value, but fail to remove + the ``Proxy-Authentication`` header from the previous value of the + :reqmeta:`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 + :class:`~scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware` is now + as follows when processing a request: + + - If the request being processed defines :reqmeta:`proxy` metadata that + includes credentials, the ``Proxy-Authorization`` header is always + updated to feature those credentials. + + - If the request being processed defines :reqmeta:`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 :reqmeta:`proxy` metadata, or that metadata is a + falsy value (e.g. ``None``), the ``Proxy-Authorization`` header is + removed. + + It is no longer possible to set a proxy URL through the + :reqmeta:`proxy` metadata but set the credentials through the + ``Proxy-Authorization`` header. Set proxy credentials through the + :reqmeta:`proxy` metadata instead. + + .. _release-1.8.2: Scrapy 1.8.2 (2022-03-01) diff --git a/scrapy/downloadermiddlewares/httpproxy.py b/scrapy/downloadermiddlewares/httpproxy.py index d2665b655..1deda42bd 100644 --- a/scrapy/downloadermiddlewares/httpproxy.py +++ b/scrapy/downloadermiddlewares/httpproxy.py @@ -45,31 +45,37 @@ class HttpProxyMiddleware: return creds, proxy_url def process_request(self, request, spider): - # ignore if proxy is already set + creds, proxy_url = None, None if 'proxy' in request.meta: - if request.meta['proxy'] is None: - return - # extract credentials if present - creds, proxy_url = self._get_proxy(request.meta['proxy'], '') + if request.meta['proxy'] is not None: + creds, proxy_url = self._get_proxy(request.meta['proxy'], '') + elif self.proxies: + parsed = urlparse_cached(request) + scheme = parsed.scheme + if ( + ( + # 'no_proxy' is only supported by http schemes + scheme not in ('http', 'https') + or not proxy_bypass(parsed.hostname) + ) + and scheme in self.proxies + ): + creds, proxy_url = self.proxies[scheme] + + self._set_proxy_and_creds(request, proxy_url, creds) + + def _set_proxy_and_creds(self, request, proxy_url, creds): + if proxy_url: request.meta['proxy'] = proxy_url - if creds and not request.headers.get('Proxy-Authorization'): - request.headers['Proxy-Authorization'] = b'Basic ' + creds - return - elif not self.proxies: - return - - parsed = urlparse_cached(request) - scheme = parsed.scheme - - # 'no_proxy' is only supported by http schemes - if scheme in ('http', 'https') and proxy_bypass(parsed.hostname): - return - - if scheme in self.proxies: - self._set_proxy(request, scheme) - - def _set_proxy(self, request, scheme): - creds, proxy = self.proxies[scheme] - request.meta['proxy'] = proxy + elif request.meta.get('proxy') is not None: + request.meta['proxy'] = None if creds: - request.headers['Proxy-Authorization'] = b'Basic ' + creds + request.headers[b'Proxy-Authorization'] = b'Basic ' + creds + request.meta['_auth_proxy'] = proxy_url + elif '_auth_proxy' in request.meta: + if proxy_url != request.meta['_auth_proxy']: + if b'Proxy-Authorization' in request.headers: + del request.headers[b'Proxy-Authorization'] + del request.meta['_auth_proxy'] + elif b'Proxy-Authorization' in request.headers: + del request.headers[b'Proxy-Authorization'] diff --git a/tests/test_downloadermiddleware_httpproxy.py b/tests/test_downloadermiddleware_httpproxy.py index 7c97bf32a..67134cf93 100644 --- a/tests/test_downloadermiddleware_httpproxy.py +++ b/tests/test_downloadermiddleware_httpproxy.py @@ -65,12 +65,12 @@ class TestHttpProxyMiddleware(TestCase): mw = HttpProxyMiddleware() req = Request('http://scrapytest.org') assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcjpwYXNz') # proxy from request.meta req = Request('http://scrapytest.org', meta={'proxy': 'https://username:password@proxy:3128'}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcm5hbWU6cGFzc3dvcmQ=') def test_proxy_auth_empty_passwd(self): @@ -78,12 +78,12 @@ class TestHttpProxyMiddleware(TestCase): mw = HttpProxyMiddleware() req = Request('http://scrapytest.org') assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcjo=') # proxy from request.meta req = Request('http://scrapytest.org', meta={'proxy': 'https://username:@proxy:3128'}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcm5hbWU6') def test_proxy_auth_encoding(self): @@ -92,26 +92,26 @@ class TestHttpProxyMiddleware(TestCase): mw = HttpProxyMiddleware(auth_encoding='utf-8') req = Request('http://scrapytest.org') assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic bcOhbjpwYXNz') # proxy from request.meta req = Request('http://scrapytest.org', meta={'proxy': 'https://\u00FCser:pass@proxy:3128'}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic w7xzZXI6cGFzcw==') # default latin-1 encoding mw = HttpProxyMiddleware(auth_encoding='latin-1') req = Request('http://scrapytest.org') assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic beFuOnBhc3M=') # proxy from request.meta, latin-1 encoding req = Request('http://scrapytest.org', meta={'proxy': 'https://\u00FCser:pass@proxy:3128'}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://proxy:3128'}) + self.assertEqual(req.meta['proxy'], 'https://proxy:3128') self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic /HNlcjpwYXNz') def test_proxy_already_seted(self): @@ -152,3 +152,300 @@ class TestHttpProxyMiddleware(TestCase): # '/var/run/docker.sock' may be used by the user for # no_proxy value but is not parseable and should be skipped assert 'no' not in mw.proxies + + def test_add_proxy_without_credentials(self): + middleware = HttpProxyMiddleware() + request = Request('https://example.com') + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = 'https://example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_add_proxy_with_credentials(self): + middleware = HttpProxyMiddleware() + request = Request('https://example.com') + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = 'https://user1:password1@example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_remove_proxy_without_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://example.com'}, + ) + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = None + assert middleware.process_request(request, spider) is None + self.assertIsNone(request.meta['proxy']) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_remove_proxy_with_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = None + assert middleware.process_request(request, spider) is None + self.assertIsNone(request.meta['proxy']) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_add_credentials(self): + """If the proxy request meta switches to a proxy URL with the same + proxy and adds credentials (there were no credentials before), the new + credentials must be used.""" + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://example.com'}, + ) + assert middleware.process_request(request, spider) is None + + request.meta['proxy'] = 'https://user1:password1@example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_change_credentials(self): + """If the proxy request meta switches to a proxy URL with different + credentials, those new credentials must be used.""" + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = 'https://user2:password2@example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + encoded_credentials = middleware._basic_auth_header( + 'user2', + 'password2', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_remove_credentials(self): + """If the proxy request meta switches to a proxy URL with the same + proxy but no credentials, the original credentials must be still + used. + + To remove credentials while keeping the same proxy URL, users must + delete the Proxy-Authorization header. + """ + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + + request.meta['proxy'] = 'https://example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + request.meta['proxy'] = 'https://example.com' + del request.headers[b'Proxy-Authorization'] + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_change_proxy_add_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://example.com'}, + ) + assert middleware.process_request(request, spider) is None + + request.meta['proxy'] = 'https://user1:password1@example.org' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.org') + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_change_proxy_keep_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + + request.meta['proxy'] = 'https://user1:password1@example.org' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.org') + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + # Make sure, indirectly, that _auth_proxy is updated. + request.meta['proxy'] = 'https://example.com' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_change_proxy_change_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + + request.meta['proxy'] = 'https://user2:password2@example.org' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.org') + encoded_credentials = middleware._basic_auth_header( + 'user2', + 'password2', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_change_proxy_remove_credentials(self): + """If the proxy request meta switches to a proxy URL with a different + proxy and no credentials, no credentials must be used.""" + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = 'https://example.org' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta, {'proxy': 'https://example.org'}) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_change_proxy_remove_credentials_preremoved_header(self): + """Corner case of proxy switch with credentials removal where the + credentials have been removed beforehand. + + It ensures that our implementation does not assume that the credentials + header exists when trying to remove it. + """ + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + request.meta['proxy'] = 'https://example.org' + del request.headers[b'Proxy-Authorization'] + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta, {'proxy': 'https://example.org'}) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_proxy_authentication_header_undefined_proxy(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + headers={'Proxy-Authorization': 'Basic foo'}, + ) + assert middleware.process_request(request, spider) is None + self.assertNotIn('proxy', request.meta) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_proxy_authentication_header_disabled_proxy(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + headers={'Proxy-Authorization': 'Basic foo'}, + meta={'proxy': None}, + ) + assert middleware.process_request(request, spider) is None + self.assertIsNone(request.meta['proxy']) + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_proxy_authentication_header_proxy_without_credentials(self): + middleware = HttpProxyMiddleware() + request = Request( + 'https://example.com', + headers={'Proxy-Authorization': 'Basic foo'}, + meta={'proxy': 'https://example.com'}, + ) + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertNotIn(b'Proxy-Authorization', request.headers) + + def test_proxy_authentication_header_proxy_with_same_credentials(self): + middleware = HttpProxyMiddleware() + encoded_credentials = middleware._basic_auth_header( + 'user1', + 'password1', + ) + request = Request( + 'https://example.com', + headers={'Proxy-Authorization': b'Basic ' + encoded_credentials}, + meta={'proxy': 'https://user1:password1@example.com'}, + ) + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials, + ) + + def test_proxy_authentication_header_proxy_with_different_credentials(self): + middleware = HttpProxyMiddleware() + encoded_credentials1 = middleware._basic_auth_header( + 'user1', + 'password1', + ) + request = Request( + 'https://example.com', + headers={'Proxy-Authorization': b'Basic ' + encoded_credentials1}, + meta={'proxy': 'https://user2:password2@example.com'}, + ) + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + encoded_credentials2 = middleware._basic_auth_header( + 'user2', + 'password2', + ) + self.assertEqual( + request.headers['Proxy-Authorization'], + b'Basic ' + encoded_credentials2, + ) From aecbccbaa567b07694141a4503e9abf1bb2c919f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 25 Jul 2022 13:33:23 +0200 Subject: [PATCH 138/532] =?UTF-8?q?Bump=20version:=202.6.1=20=E2=86=92=202?= =?UTF-8?q?.6.2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- scrapy/VERSION | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 1d9b9c02f..2e2f7949a 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.6.1 +current_version = 2.6.2 commit = True tag = True tag_name = {new_version} diff --git a/scrapy/VERSION b/scrapy/VERSION index 6a6a3d8e3..097a15a2a 100644 --- a/scrapy/VERSION +++ b/scrapy/VERSION @@ -1 +1 @@ -2.6.1 +2.6.2 From 5862f6b8e1cd9e240c4b3e79f2eddd0b9f33ef8c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 25 Jul 2022 17:25:10 +0200 Subject: [PATCH 139/532] Update frozen CI packages (#5574) --- pylintrc | 6 +----- tox.ini | 13 ++++++++----- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/pylintrc b/pylintrc index 2cdd6321e..d8e47dc11 100644 --- a/pylintrc +++ b/pylintrc @@ -9,11 +9,9 @@ disable=abstract-method, arguments-renamed, attribute-defined-outside-init, bad-classmethod-argument, - bad-continuation, bad-indentation, bad-mcs-classmethod-argument, bad-super-call, - bad-whitespace, bare-except, blacklisted-name, broad-except, @@ -52,7 +50,6 @@ disable=abstract-method, logging-not-lazy, lost-exception, method-hidden, - misplaced-comparison-constant, missing-docstring, missing-final-newline, multiple-imports, @@ -60,12 +57,10 @@ disable=abstract-method, no-else-continue, no-else-raise, no-else-return, - no-init, no-member, no-method-argument, no-name-in-module, no-self-argument, - no-self-use, no-value-for-parameter, not-an-iterable, not-callable, @@ -102,6 +97,7 @@ disable=abstract-method, ungrouped-imports, unidiomatic-typecheck, unnecessary-comprehension, + unnecessary-dunder-call, unnecessary-lambda, unnecessary-pass, unreachable, diff --git a/tox.ini b/tox.ini index ab8a715c2..4d1bb574d 100644 --- a/tox.ini +++ b/tox.ini @@ -47,7 +47,7 @@ commands = [testenv:security] basepython = python3 deps = - bandit==1.7.3 + bandit==1.7.4 commands = bandit -r -c .bandit.yml {posargs:scrapy} @@ -57,16 +57,17 @@ deps = {[testenv]deps} # Twisted[http2] is required to import some files Twisted[http2]>=17.9.0 - pytest-flake8 - flake8==3.9.2 # https://github.com/tholo/pytest-flake8/issues/81 + pytest-flake8==1.1.1 + flake8==4.0.1 commands = pytest --flake8 {posargs:docs scrapy tests} [testenv:pylint] -basepython = python3 +# reppy does not support Python 3.9+ +basepython = python3.8 deps = {[testenv:extra-deps]deps} - pylint==2.12.2 + pylint==2.14.5 commands = pylint conftest.py docs extras scrapy setup.py tests @@ -117,6 +118,8 @@ setenv = {[pinned]setenv} [testenv:extra-deps] +# reppy does not support Python 3.9+ +basepython = python3.8 deps = {[testenv]deps} boto From 56e2eeac1066cd2d3c710b76a3d6210b3ac257f5 Mon Sep 17 00:00:00 2001 From: Mikhail Korobov Date: Wed, 27 Jul 2022 09:41:12 +0500 Subject: [PATCH 140/532] fix typing issues by upgrading mypy --- tests/test_utils_request.py | 2 +- tox.ini | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index 5ee772c0b..8bc7922b6 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -52,7 +52,7 @@ class UtilsRequestTest(unittest.TestCase): class FingerprintTest(unittest.TestCase): maxDiff = None - function = staticmethod(fingerprint) + function: staticmethod = staticmethod(fingerprint) cache: Union[ "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], bytes]]", "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], str]]", diff --git a/tox.ini b/tox.ini index 4d1bb574d..2110e1020 100644 --- a/tox.ini +++ b/tox.ini @@ -38,7 +38,7 @@ install_command = basepython = python3 deps = lxml-stubs==0.2.0 - mypy==0.910 + mypy==0.971 types-pyOpenSSL==20.0.3 types-setuptools==57.0.0 commands = From 67011cd9576b02d696c7e0c0dc7f76074e30901b Mon Sep 17 00:00:00 2001 From: Aftab Alam <88653530+itsAftabAlam@users.noreply.github.com> Date: Wed, 27 Jul 2022 10:20:26 +0530 Subject: [PATCH 141/532] updated README.rst , added hyperlink to banner (#5284) Co-authored-by: Mikhail Korobov --- README.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/README.rst b/README.rst index b543a30f4..358302c76 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,5 @@ .. image:: https://scrapy.org/img/scrapylogo.png + :target: https://scrapy.org/ ====== Scrapy From 83ecdf1bcab310be5f2c59e5c005b8968d72a72c Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Wed, 27 Jul 2022 23:12:31 +0500 Subject: [PATCH 142/532] Update docs/topics/components.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- docs/topics/components.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/components.rst b/docs/topics/components.rst index 1fff2d61a..c44f3def2 100644 --- a/docs/topics/components.rst +++ b/docs/topics/components.rst @@ -47,7 +47,7 @@ Enforcing component requirements ================================ Sometimes, your components may only be intended to work under certain -conditions. For example, the may require a minimum version of Scrapy to work as +conditions. For example, they may require a minimum version of Scrapy to work as intended, or they may require certain settings to have specific values. In addition to describing those conditions in the documentation of your From 0f1112f3e22d91e505f736fc78fae94eda07c72d Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Wed, 27 Jul 2022 23:12:43 +0500 Subject: [PATCH 143/532] Update docs/index.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index ea4950e4c..5404969e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -258,7 +258,7 @@ Extending Scrapy components. :doc:`topics/api` - Use it on extensions and middlewares to extend Scrapy functionality + Use it on extensions and middlewares to extend Scrapy functionality. All the rest From c7b90c6e1e3de20256d8bf6fc5d18da44d562b0d Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 28 Jul 2022 13:44:36 +0500 Subject: [PATCH 144/532] Extract more common code. --- scrapy/spidermiddlewares/depth.py | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 29634c3ad..4c923b1b3 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -28,25 +28,22 @@ class DepthMiddleware: return cls(maxdepth, crawler.stats, verbose, prio) def process_spider_output(self, response, result, spider): - # base case (depth=0) - if 'depth' not in response.meta: - response.meta['depth'] = 0 - if self.verbose_stats: - self.stats.inc_value('request_depth_count/0', spider=spider) - + self._init_depth(response, spider) return (r for r in result or () if self._filter(r, response, spider)) async def process_spider_output_async(self, response, result, spider): + self._init_depth(response, spider) + async for r in result or (): + if self._filter(r, response, spider): + yield r + + def _init_depth(self, response, spider): # base case (depth=0) if 'depth' not in response.meta: response.meta['depth'] = 0 if self.verbose_stats: self.stats.inc_value('request_depth_count/0', spider=spider) - async for r in result or (): - if self._filter(r, response, spider): - yield r - def _filter(self, request, response, spider): if not isinstance(request, Request): return True From 5735e93541d26ad3aef5e4fc45fa3d1c4dc0fa2a Mon Sep 17 00:00:00 2001 From: felipeboffnunes Date: Thu, 28 Jul 2022 18:37:21 -0300 Subject: [PATCH 145/532] fix_post_processing_feed_export --- scrapy/extensions/feedexport.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index e7097b7a1..3e98a5a0b 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -350,13 +350,19 @@ class FeedExporter: return defer.DeferredList(deferred_list) if deferred_list else None def _close_slot(self, slot, spider): + + def get_file(slot_): + if isinstance(slot_.file, PostProcessingManager): + return slot_.file.file + return slot_.file + if not slot.itemcount and not slot.store_empty: # We need to call slot.storage.store nonetheless to get the file # properly closed. - return defer.maybeDeferred(slot.storage.store, slot.file) + return defer.maybeDeferred(slot.storage.store, get_file(slot)) slot.finish_exporting() logmsg = f"{slot.format} feed ({slot.itemcount} items) in: {slot.uri}" - d = defer.maybeDeferred(slot.storage.store, slot.file) + d = defer.maybeDeferred(slot.storage.store, get_file(slot)) d.addCallback( self._handle_store_success, logmsg, spider, type(slot.storage).__name__ From 4be9c969fd4bdc3206bdabfb5c22e524d9e355ac Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 29 Jul 2022 12:15:39 +0300 Subject: [PATCH 146/532] per slot settings: logger deleted as not used --- scrapy/core/downloader/__init__.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 511693830..fa8ac01e5 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -1,4 +1,3 @@ -import logging import random from time import time from datetime import datetime @@ -13,8 +12,6 @@ from scrapy import signals from scrapy.core.downloader.middleware import DownloaderMiddlewareManager from scrapy.core.downloader.handlers import DownloadHandlers -logger = logging.getLogger(__name__) - class Slot: """Downloader slot""" From d599fff2b97ff96c3face707b980926b6eb48a2b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 29 Jul 2022 19:10:28 +0200 Subject: [PATCH 147/532] Test the life cycle of a storage file --- tests/test_feedexport.py | 55 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index ecd1b59d3..a5fd1e467 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -1517,6 +1517,61 @@ class FeedExportTest(FeedExportTestBase): data = yield self.exported_data(items, settings) self.assertEqual(row['expected'], data[feed_options['format']]) + @defer.inlineCallbacks + def test_storage_file_no_postprocessing(self): + + @implementer(IFeedStorage) + class Storage: + + def __init__(self, uri, *, feed_options=None): + pass + + def open(self, spider): + Storage.open_file = tempfile.NamedTemporaryFile(prefix='feed-') + return Storage.open_file + + def store(self, file): + Storage.store_file = file + file.close() + + settings = { + 'FEEDS': {self._random_temp_filename(): {'format': 'jsonlines'}}, + 'FEED_STORAGES': {'file': Storage}, + } + yield self.exported_no_data(settings) + self.assertIs(Storage.open_file, Storage.store_file) + + @defer.inlineCallbacks + def test_storage_file_postprocessing(self): + + @implementer(IFeedStorage) + class Storage: + + def __init__(self, uri, *, feed_options=None): + pass + + def open(self, spider): + Storage.open_file = tempfile.NamedTemporaryFile(prefix='feed-') + return Storage.open_file + + def store(self, file): + Storage.store_file = file + file.close() + + settings = { + 'FEEDS': { + self._random_temp_filename(): { + 'format': 'jsonlines', + 'postprocessing': [ + 'scrapy.extensions.postprocessing.GzipPlugin', + ], + }, + }, + 'FEED_STORAGES': {'file': Storage}, + } + yield self.exported_no_data(settings) + self.assertIs(Storage.open_file, Storage.store_file) + class FeedPostProcessedExportsTest(FeedExportTestBase): __test__ = True From aabdd0b657e1b4398a5a1aad79044401e9dbf909 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 12 Aug 2022 15:34:48 +0300 Subject: [PATCH 148/532] per slot settings: logger deleted as not used (step 2) --- scrapy/core/downloader/__init__.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index fa8ac01e5..d908f4d7e 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -204,5 +204,4 @@ class Downloader: mintime = time() - age for key, slot in list(self.slots.items()): if not slot.active and slot.lastseen + slot.delay < mintime: - inactive_slot = self.slots.pop(key) - inactive_slot.close() + self.slots.pop(key).close() From 13c5ad7e688271ae47f2a489bf665cb15387b3a3 Mon Sep 17 00:00:00 2001 From: "Alexandr N. Zamaraev" Date: Tue, 16 Aug 2022 11:03:37 +0700 Subject: [PATCH 149/532] Partial in is_generator_with_return_value See path in #5592 --- scrapy/utils/misc.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index 1221b39b2..2e25f6421 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -9,6 +9,7 @@ from collections import deque from contextlib import contextmanager from importlib import import_module from pkgutil import iter_modules +from functools import partial from w3lib.html import replace_entities @@ -226,7 +227,11 @@ def is_generator_with_return_value(callable): return value is None or isinstance(value, ast.NameConstant) and value.value is None if inspect.isgeneratorfunction(callable): - code = re.sub(r"^[\t ]+", "", inspect.getsource(callable)) + func = callable + while isinstance(func, partial): + func = func.func + + code = re.sub(r"^[\t ]+", "", inspect.getsource(func)) tree = ast.parse(code) for node in walk_callable(tree): if isinstance(node, ast.Return) and not returns_none(node): From c49b5aaf77a668e44bffb54c52310084e4068162 Mon Sep 17 00:00:00 2001 From: zaid-ismail031 Date: Thu, 25 Aug 2022 02:17:03 +0200 Subject: [PATCH 150/532] Changed incorrect information regarding the return type of parse/request callback method. --- docs/topics/spiders.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/topics/spiders.rst b/docs/topics/spiders.rst index ece02ae47..ffe41cf3e 100644 --- a/docs/topics/spiders.rst +++ b/docs/topics/spiders.rst @@ -181,9 +181,10 @@ scrapy.Spider scraped data and/or more URLs to follow. Other Requests callbacks have the same requirements as the :class:`Spider` class. - This method, as well as any other Request callback, must return an - iterable of :class:`~scrapy.Request` and/or :ref:`item objects - `. + This method, as well as any other Request callback, must return a + :class:`~scrapy.Request` object, an :ref:`item object `, an + iterable of :class:`~scrapy.Request` objects and/or :ref:`item objects + `, or ``None``. :param response: the response to parse :type response: :class:`~scrapy.http.Response` From e411ea94eb853eedeee111469c6442d275864a09 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Sun, 28 Aug 2022 20:28:13 +0430 Subject: [PATCH 151/532] BOM should take precedence over Content-Type header when detecting the encoding closes #5601 --- scrapy/http/response/text.py | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 89516b9b6..bfcde878d 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -11,8 +11,13 @@ from typing import Generator, Tuple from urllib.parse import urljoin import parsel -from w3lib.encoding import (html_body_declared_encoding, html_to_unicode, - http_content_type_encoding, resolve_encoding) +from w3lib.encoding import ( + html_body_declared_encoding, + html_to_unicode, + http_content_type_encoding, + resolve_encoding, + read_bom, +) from w3lib.html import strip_html5_whitespace from scrapy.http import Request @@ -60,6 +65,7 @@ class TextResponse(Response): def _declared_encoding(self): return ( self._encoding + or self._bom_encoding() or self._headers_encoding() or self._body_declared_encoding() ) @@ -117,6 +123,10 @@ class TextResponse(Response): def _body_declared_encoding(self): return html_body_declared_encoding(self.body) + @memoizemethod_noargs + def _bom_encoding(self): + return read_bom(self.body)[0] + @property def selector(self): from scrapy.selector import Selector From a988c4b78b9ca104b74cff60c46c1842e3f25652 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Mon, 29 Aug 2022 17:08:30 +0430 Subject: [PATCH 152/532] add test --- tests/test_http_response.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tests/test_http_response.py b/tests/test_http_response.py index 2986f884f..5d67a5e74 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -1,3 +1,4 @@ +import codecs import unittest from unittest import mock @@ -358,6 +359,8 @@ class TextResponseTest(BaseResponseTest): headers={"Content-type": ["text/html; charset=gb2312"]}) r7 = self.response_class("http://www.example.com", body=b"\xa8D", headers={"Content-type": ["text/html; charset=gbk"]}) + r8 = self.response_class("http://www.example.com", body=codecs.BOM_UTF8 + b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=cp1251"]}) self.assertEqual(r1._headers_encoding(), "utf-8") self.assertEqual(r2._headers_encoding(), None) @@ -367,7 +370,10 @@ class TextResponseTest(BaseResponseTest): self.assertEqual(r3._declared_encoding(), "cp1252") self.assertEqual(r4._headers_encoding(), None) self.assertEqual(r5._headers_encoding(), None) + self.assertEqual(r8._headers_encoding(), "cp1251") + self.assertEqual(r8._declared_encoding(), "utf-8") self._assert_response_encoding(r5, "utf-8") + self._assert_response_encoding(r8, "utf-8") assert r4._body_inferred_encoding() is not None and r4._body_inferred_encoding() != 'ascii' self._assert_response_values(r1, 'utf-8', "\xa3") self._assert_response_values(r2, 'utf-8', "\xa3") From f4bcc3e67de0896999be48d1b0fcede0be0d69e4 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 6 Sep 2022 01:15:41 -0300 Subject: [PATCH 153/532] fix: failed tests --- tests/test_crawler.py | 13 +++++++++---- tests/test_spider.py | 12 ++++++++---- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 4e9ef7740..4e599d69c 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -23,6 +23,8 @@ from scrapy.utils.test import get_crawler from scrapy.extensions.throttle import AutoThrottle from scrapy.extensions import telnet from scrapy.utils.test import get_testenv +from pkg_resources import parse_version +from w3lib import __version__ as w3lib_version from tests.mockserver import MockServer @@ -381,10 +383,13 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): def test_ipv6_default_name_resolver(self): log = self.run_script('default_name_resolver.py') self.assertIn('Spider closed (finished)', log) - self.assertIn("'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", log) - self.assertIn( - "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1.", - log) + if parse_version(w3lib_version) < parse_version("2.0.0"): + self.assertIn("'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", log) + self.assertIn( + "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1.", + log) + else: + self.assertIn("ValueError: invalid hostname:", log) def test_caching_hostname_resolver_ipv6(self): log = self.run_script("caching_hostname_resolver_ipv6.py") diff --git a/tests/test_spider.py b/tests/test_spider.py index 689349999..7b36304b1 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -22,6 +22,8 @@ from scrapy.spiders import ( from scrapy.linkextractors import LinkExtractor from scrapy.utils.test import get_crawler from tests import get_testdata +from pkg_resources import parse_version +from w3lib import __version__ as w3lib_version class SpiderTest(unittest.TestCase): @@ -360,10 +362,12 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML', - 'http://EXAMPLE.ORG/ABOUT.HTML', - 'http://EXAMPLE.ORG/NOFOLLOW.HTML']) + urls = ['http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML', + 'http://EXAMPLE.ORG/ABOUT.HTML', + 'http://EXAMPLE.ORG/NOFOLLOW.HTML'] + if parse_version(w3lib_version) >= parse_version('2.0.0'): + urls = list(map(lambda u: u.replace("EXAMPLE.ORG", "example.org"), urls)) + self.assertEqual([r.url for r in output], urls) def test_process_request_instance_method_with_response(self): From 1289422284991c09cbee8cea17bef837b3efc31b Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 6 Sep 2022 08:17:58 -0300 Subject: [PATCH 154/532] chore: Skip `test_ipv6_default_name_resolver` test if w3lib version >= 2.0.0 --- tests/test_crawler.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 4e599d69c..e2a14be55 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -380,16 +380,15 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): self.assertIn('Spider closed (finished)', log) self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + @mark.skipif(parse_version(w3lib_version) >= parse_version("2.0.0"), + reason='w3lib 2.0.0 and later do not allow invalid domains.') def test_ipv6_default_name_resolver(self): log = self.run_script('default_name_resolver.py') self.assertIn('Spider closed (finished)', log) - if parse_version(w3lib_version) < parse_version("2.0.0"): - self.assertIn("'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", log) - self.assertIn( - "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1.", - log) - else: - self.assertIn("ValueError: invalid hostname:", log) + self.assertIn("'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", log) + self.assertIn( + "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1.", + log) def test_caching_hostname_resolver_ipv6(self): log = self.run_script("caching_hostname_resolver_ipv6.py") From 582a6bf6dbcb01da40cbec6b51269add2db39cf1 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 6 Sep 2022 10:03:18 -0300 Subject: [PATCH 155/532] refactor: Use `safe_url_string` to standardize url output --- tests/test_spider.py | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/tests/test_spider.py b/tests/test_spider.py index 7b36304b1..e1527620f 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -22,8 +22,7 @@ from scrapy.spiders import ( from scrapy.linkextractors import LinkExtractor from scrapy.utils.test import get_crawler from tests import get_testdata -from pkg_resources import parse_version -from w3lib import __version__ as w3lib_version +from w3lib.url import safe_url_string class SpiderTest(unittest.TestCase): @@ -362,12 +361,10 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - urls = ['http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML', - 'http://EXAMPLE.ORG/ABOUT.HTML', - 'http://EXAMPLE.ORG/NOFOLLOW.HTML'] - if parse_version(w3lib_version) >= parse_version('2.0.0'): - urls = list(map(lambda u: u.replace("EXAMPLE.ORG", "example.org"), urls)) - self.assertEqual([r.url for r in output], urls) + self.assertEqual([r.url for r in output], + [safe_url_string('http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML'), + safe_url_string('http://EXAMPLE.ORG/ABOUT.HTML'), + safe_url_string('http://EXAMPLE.ORG/NOFOLLOW.HTML')]) def test_process_request_instance_method_with_response(self): From ce0ca51485545aed8eb33a285bc3d2fbf8a8e407 Mon Sep 17 00:00:00 2001 From: "Magsen (CD)" Date: Tue, 13 Sep 2022 12:07:58 +0200 Subject: [PATCH 156/532] fix: typo in tutorial fix: typo in tutorial --- docs/intro/tutorial.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index 75928077e..092123d1d 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -379,7 +379,7 @@ like this: Let's open up scrapy shell and play a bit to find out how to extract the data we want:: - $ scrapy shell 'https://quotes.toscrape.com' + scrapy shell 'https://quotes.toscrape.com' We get a list of selectors for the quote HTML elements with: From 77c055ee28a767b2c8222274cc7556ab9cc56edc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 14 Sep 2022 14:47:14 +0200 Subject: [PATCH 157/532] Relax Proxy-Authorization restrictions --- scrapy/downloadermiddlewares/httpproxy.py | 5 ++++- tests/test_downloadermiddleware_httpproxy.py | 14 +++++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/scrapy/downloadermiddlewares/httpproxy.py b/scrapy/downloadermiddlewares/httpproxy.py index 1deda42bd..dd8a7e797 100644 --- a/scrapy/downloadermiddlewares/httpproxy.py +++ b/scrapy/downloadermiddlewares/httpproxy.py @@ -78,4 +78,7 @@ class HttpProxyMiddleware: del request.headers[b'Proxy-Authorization'] del request.meta['_auth_proxy'] elif b'Proxy-Authorization' in request.headers: - del request.headers[b'Proxy-Authorization'] + if proxy_url: + request.meta['_auth_proxy'] = proxy_url + else: + del request.headers[b'Proxy-Authorization'] diff --git a/tests/test_downloadermiddleware_httpproxy.py b/tests/test_downloadermiddleware_httpproxy.py index 70eb94d77..44434f90e 100644 --- a/tests/test_downloadermiddleware_httpproxy.py +++ b/tests/test_downloadermiddleware_httpproxy.py @@ -400,6 +400,9 @@ class TestHttpProxyMiddleware(TestCase): self.assertNotIn(b'Proxy-Authorization', request.headers) def test_proxy_authentication_header_proxy_without_credentials(self): + """As long as the proxy URL in request metadata remains the same, the + Proxy-Authorization header is used and kept, and may even be + changed.""" middleware = HttpProxyMiddleware() request = Request( 'https://example.com', @@ -408,7 +411,16 @@ class TestHttpProxyMiddleware(TestCase): ) assert middleware.process_request(request, spider) is None self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.headers['Proxy-Authorization'], b'Basic foo') + + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.headers['Proxy-Authorization'], b'Basic foo') + + request.headers['Proxy-Authorization'] = b'Basic bar' + assert middleware.process_request(request, spider) is None + self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.headers['Proxy-Authorization'], b'Basic bar') def test_proxy_authentication_header_proxy_with_same_credentials(self): middleware = HttpProxyMiddleware() From 1429aa011ce2a7a43691fc359c88bf40e512176c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Tue, 20 Sep 2022 12:47:20 -0400 Subject: [PATCH 158/532] Update test-standard link in contributing docs (#5631) --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 946bdc23e..9cfe10012 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -214,7 +214,7 @@ Tests ===== Tests are implemented using the :doc:`Twisted unit-testing framework -`. Running tests requires +`. Running tests requires :doc:`tox `. .. _running-tests: From 5f194202114fd38530c78299d51b6966b4802f59 Mon Sep 17 00:00:00 2001 From: Tim B Date: Wed, 21 Sep 2022 07:27:27 +0100 Subject: [PATCH 159/532] Documented how settings must be picklable (#5629) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves Co-authored-by: Laerte Pereira <5853172+Laerte@users.noreply.github.com> --- docs/topics/settings.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 6722ce9ed..90f13f3ef 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -98,6 +98,10 @@ class. The global defaults are located in the ``scrapy.settings.default_settings`` module and documented in the :ref:`topics-settings-ref` section. +Compatibility with pickle +========================= + +Setting values must be :ref:`picklable `. Import paths and classes ======================== From 385acd5598fb06a126ac485087b58a4581096876 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Sat, 24 Sep 2022 14:58:14 -0400 Subject: [PATCH 160/532] Match pyOpenSSL and service_identity to Twisted MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gábor Lipták --- setup.py | 6 +++--- tests/test_crawler.py | 2 +- tox.ini | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/setup.py b/setup.py index ed197273f..fcc902c62 100644 --- a/setup.py +++ b/setup.py @@ -20,13 +20,13 @@ def has_environment_marker_platform_impl_support(): install_requires = [ 'Twisted>=18.9.0', - 'cryptography>=2.8', + 'cryptography>=3.3', 'cssselect>=0.9.1', 'itemloaders>=1.0.1', 'parsel>=1.5.0', - 'pyOpenSSL>=19.1.0', + 'pyOpenSSL>=21.0.0', 'queuelib>=1.4.2', - 'service_identity>=16.0.0', + 'service_identity>=18.1.0', 'w3lib>=1.17.0', 'zope.interface>=5.1.0', 'protego>=0.1.15', diff --git a/tests/test_crawler.py b/tests/test_crawler.py index e2a14be55..cf15ba9b9 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -327,7 +327,7 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): def test_reactor_default_twisted_reactor_select(self): log = self.run_script('reactor_default_twisted_reactor_select.py') - if platform.system() == 'Windows': + if platform.system() in ['Windows', 'Darwin']: # The goal of this test function is to test that, when a reactor is # installed (the default one here) and a different reactor is # configured (select here), an error raises. diff --git a/tox.ini b/tox.ini index 2110e1020..2bf9454d0 100644 --- a/tox.ini +++ b/tox.ini @@ -73,15 +73,15 @@ commands = [pinned] deps = - cryptography==2.8 + cryptography==3.3 cssselect==0.9.1 h2==3.0 itemadapter==0.1.0 parsel==1.5.0 Protego==0.1.15 - pyOpenSSL==19.1.0 + pyOpenSSL==21.0.0 queuelib==1.4.2 - service_identity==16.0.0 + service_identity==18.1.0 Twisted[http2]==18.9.0 w3lib==1.17.0 zope.interface==5.1.0 From 79a4bc3da02bfe2b07c596f6b677760b2c04f96f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Sun, 25 Sep 2022 14:17:57 -0400 Subject: [PATCH 161/532] Cleanup METHOD_SSLv3 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gábor Lipták --- docs/topics/settings.rst | 1 - scrapy/core/downloader/contextfactory.py | 2 +- scrapy/core/downloader/tls.py | 2 -- 3 files changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 90f13f3ef..a711fd197 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -564,7 +564,6 @@ This setting must be one of these string values: set this if you want the behavior of Scrapy<1.1 - ``'TLSv1.1'``: forces TLS version 1.1 - ``'TLSv1.2'``: forces TLS version 1.2 -- ``'SSLv3'``: forces SSL version 3 (**not recommended**) .. setting:: DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index b5318c7bb..4abde2238 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -21,7 +21,7 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): which allows TLS protocol negotiation 'A TLS/SSL connection established with [this method] may - understand the SSLv3, TLSv1, TLSv1.1 and TLSv1.2 protocols.' + understand the TLSv1, TLSv1.1 and TLSv1.2 protocols.' """ def __init__(self, method=SSL.SSLv23_METHOD, tls_verbose_logging=False, tls_ciphers=None, *args, **kwargs): diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 19a56d9b6..698a1c85c 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -11,7 +11,6 @@ from scrapy.utils.ssl import x509name_to_string, get_temp_key_info logger = logging.getLogger(__name__) -METHOD_SSLv3 = 'SSLv3' METHOD_TLS = 'TLS' METHOD_TLSv10 = 'TLSv1.0' METHOD_TLSv11 = 'TLSv1.1' @@ -20,7 +19,6 @@ METHOD_TLSv12 = 'TLSv1.2' openssl_methods = { METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) - METHOD_SSLv3: SSL.SSLv3_METHOD, # SSL 3 (NOT recommended) METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only METHOD_TLSv11: getattr(SSL, 'TLSv1_1_METHOD', 5), # TLS 1.1 only METHOD_TLSv12: getattr(SSL, 'TLSv1_2_METHOD', 6), # TLS 1.2 only From 1d79994dccf396caca93f53cd50646281fee1def Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 27 Sep 2022 17:01:33 +0200 Subject: [PATCH 162/532] Copy 2.6.3 release notes from the 2.6 branch --- docs/news.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index d27c105a5..9469d0fe5 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,6 +3,32 @@ Release notes ============= +.. _release-2.6.3: + +Scrapy 2.6.3 (2022-09-27) +------------------------- + +- Added support for pyOpenSSL_ 22.1.0, removing support for SSLv3 + (:issue:`5634`, :issue:`5635`, :issue:`5636`). + +- Upgraded the minimum versions of the following dependencies: + + - cryptography_: 2.0 → 3.3 + + - pyOpenSSL_: 16.2.0 → 21.0.0 + + - service_identity_: 16.0.0 → 18.1.0 + + - Twisted_: 17.9.0 → 18.9.0 + + - zope.interface_: 4.1.3 → 5.0.0 + + (:issue:`5621`, :issue:`5632`) + +- Fixes test and documentation issues (:issue:`5612`, :issue:`5617`, + :issue:`5631`). + + .. _release-2.6.2: Scrapy 2.6.2 (2022-07-25) From 3ca7877781fdae5415c57a9a0f348b1797795209 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 29 Sep 2022 11:51:11 -0300 Subject: [PATCH 163/532] chore: Skip `batch_path_differ` test on Windows --- tests/test_feedexport.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index ecd1b59d3..ad2383018 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -2285,6 +2285,7 @@ class BatchDeliveriesTest(FeedExportTestBase): for expected_batch, got_batch in zip(expected, data[fmt]): self.assertEqual(expected_batch, got_batch) + @pytest.mark.skipif(sys.platform == 'win32', reason='Odd behaviour on file creation/output') @defer.inlineCallbacks def test_batch_path_differ(self): """ @@ -2305,7 +2306,7 @@ class BatchDeliveriesTest(FeedExportTestBase): 'FEED_EXPORT_BATCH_ITEM_COUNT': 1, } data = yield self.exported_data(items, settings) - self.assertEqual(len(items) + 1, len(data['json'])) + self.assertEqual(len(items), len([_ for _ in data['json'] if _])) @defer.inlineCallbacks def test_stats_batch_file_success(self): From 9f006e3aa595acc6499f08a90696d7cd0dc0bca7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Sun, 25 Sep 2022 13:48:51 -0400 Subject: [PATCH 164/532] Match pyOpenSSL and types-pyOpenSSL versions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gábor Lipták --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 2bf9454d0..0a47a1c0b 100644 --- a/tox.ini +++ b/tox.ini @@ -39,7 +39,7 @@ basepython = python3 deps = lxml-stubs==0.2.0 mypy==0.971 - types-pyOpenSSL==20.0.3 + types-pyOpenSSL==21.0.0 types-setuptools==57.0.0 commands = mypy --show-error-codes {posargs: scrapy tests} From 116d9a97481f5ee4028a1f3f8e72ca34b35a0be9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Fri, 30 Sep 2022 22:58:14 -0400 Subject: [PATCH 165/532] Correct distutils deprecation warning MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Gábor Lipták --- scrapy/utils/display.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/utils/display.py b/scrapy/utils/display.py index f4d17224b..d28df40c7 100644 --- a/scrapy/utils/display.py +++ b/scrapy/utils/display.py @@ -5,7 +5,7 @@ pprint and pformat wrappers with colorization support import ctypes import platform import sys -from distutils.version import LooseVersion as parse_version +from packaging.version import Version as parse_version from pprint import pformat as pformat_ From c3f35d2ad79d19e7e000b8ba0df7d1d9f10658b2 Mon Sep 17 00:00:00 2001 From: Oscar Dominguez Date: Sat, 1 Oct 2022 19:37:51 +0200 Subject: [PATCH 166/532] ci(tests-windows): upgrade actions/setup-python to v4 --- .github/workflows/tests-windows.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index 955b9b449..0d85a8e09 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -28,7 +28,7 @@ jobs: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} From 9fcbf3bcbc8b8d09bb7d8b246dae9156d6848a5b Mon Sep 17 00:00:00 2001 From: Oscar Dominguez Date: Sat, 1 Oct 2022 19:38:16 +0200 Subject: [PATCH 167/532] ci(tests-windows): upgrade actions/checkout to v3 --- .github/workflows/tests-windows.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index 955b9b449..2d8c140af 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -25,7 +25,7 @@ jobs: TOXENV: asyncio steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 From 1a2cb61e22506c47e78bc800739d9cb2a8bf0144 Mon Sep 17 00:00:00 2001 From: Oscar Dominguez Date: Sat, 1 Oct 2022 20:27:10 +0200 Subject: [PATCH 168/532] ci(test-macos): upgrade actions/checkout to v3 --- .github/workflows/tests-macos.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index 7819a4e12..8c9ef5c2f 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -10,7 +10,7 @@ jobs: python-version: ["3.7", "3.8", "3.9", "3.10"] steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v2 From af95331296a91444947095af19f8244d8bc915e1 Mon Sep 17 00:00:00 2001 From: Oscar Dominguez Date: Sat, 1 Oct 2022 20:27:23 +0200 Subject: [PATCH 169/532] ci(test-macos): upgrade actions/setup-python to v4 --- .github/workflows/tests-macos.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index 7819a4e12..d49272fbf 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/checkout@v2 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} From 759ad5dee4120dc2197ea6fa1559c92f77472abf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Lipt=C3=A1k?= Date: Sun, 2 Oct 2022 09:09:04 -0400 Subject: [PATCH 170/532] Require packaging --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index fcc902c62..8b9c43738 100644 --- a/setup.py +++ b/setup.py @@ -32,6 +32,7 @@ install_requires = [ 'protego>=0.1.15', 'itemadapter>=0.1.0', 'setuptools', + 'packaging', 'tldextract', 'lxml>=4.3.0', ] From c7d800ab229df50c2767ad67460e90f6213fc293 Mon Sep 17 00:00:00 2001 From: Abdul Rauf Date: Sun, 2 Oct 2022 19:12:48 +0500 Subject: [PATCH 171/532] CI: add Twine check in check workflow --- .github/workflows/checks.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index b26f344ff..a708474ef 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -39,3 +39,8 @@ jobs: run: | pip install -U tox tox + - name: Twine check + run: | + pip install twine + python setup.py sdist + twine check dist/* From 69bf5c662555db64979a90c5c284b1faa4f24992 Mon Sep 17 00:00:00 2001 From: Abdul Rauf Date: Sun, 2 Oct 2022 20:27:24 +0500 Subject: [PATCH 172/532] CI: move twinecheck to tox env --- .github/workflows/checks.yml | 8 +++----- tox.ini | 8 ++++++++ 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index a708474ef..e515959ad 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -25,6 +25,9 @@ jobs: - python-version: "3.10" # Keep in sync with .readthedocs.yml env: TOXENV: docs + - python-version: "3.10" + env: + TOXENV: twinecheck steps: - uses: actions/checkout@v2 @@ -39,8 +42,3 @@ jobs: run: | pip install -U tox tox - - name: Twine check - run: | - pip install twine - python setup.py sdist - twine check dist/* diff --git a/tox.ini b/tox.ini index 2bf9454d0..2d94ba78f 100644 --- a/tox.ini +++ b/tox.ini @@ -71,6 +71,14 @@ deps = commands = pylint conftest.py docs extras scrapy setup.py tests +[testenv:twinecheck] +basepython = python3 +deps = + twine==4.0.1 +commands = + python setup.py sdist + twine check dist/* + [pinned] deps = cryptography==3.3 From 80194f1c0374b2aa429de4c7ea70a683c946db95 Mon Sep 17 00:00:00 2001 From: Eugenio Lacuesta Date: Sun, 2 Oct 2022 15:22:06 -0300 Subject: [PATCH 173/532] CrawlSpider: add support for async def callbacks --- scrapy/spiders/crawl.py | 6 ++++-- tests/spiders.py | 12 ++++++++++++ tests/test_crawl.py | 11 +++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index 1dcf2e6ab..d860ae0b4 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -6,7 +6,7 @@ See documentation in docs/topics/spiders.rst """ import copy -from typing import Sequence +from typing import Awaitable, Sequence from scrapy.http import Request, HtmlResponse from scrapy.linkextractors import LinkExtractor @@ -109,9 +109,11 @@ class CrawlSpider(Spider): rule = self._rules[failure.request.meta['rule']] return self._handle_failure(failure, rule.errback) - def _parse_response(self, response, callback, cb_kwargs, follow=True): + async def _parse_response(self, response, callback, cb_kwargs, follow=True): if callback: cb_res = callback(response, **cb_kwargs) or () + if isinstance(cb_res, Awaitable): + cb_res = await cb_res cb_res = self.process_results(response, cb_res) for request_or_item in iterate_spider_output(cb_res): yield request_or_item diff --git a/tests/spiders.py b/tests/spiders.py index 3b69aa7ae..2b78e1f7c 100644 --- a/tests/spiders.py +++ b/tests/spiders.py @@ -369,6 +369,18 @@ class CrawlSpiderWithParseMethod(MockServerSpider, CrawlSpider): yield Request(self.mockserver.url("/status?n=202"), self.parse, cb_kwargs={"foo": "bar"}) +class CrawlSpiderWithAsyncCallback(CrawlSpiderWithParseMethod): + """A CrawlSpider with an async def callback""" + name = 'crawl_spider_with_async_callback' + rules = ( + Rule(LinkExtractor(), callback='parse_async', follow=True), + ) + + async def parse_async(self, response, foo=None): + self.logger.info('[parse_async] status %i (foo: %s)', response.status, foo) + return Request(self.mockserver.url("/status?n=202"), self.parse_async, cb_kwargs={"foo": "bar"}) + + class CrawlSpiderWithErrback(CrawlSpiderWithParseMethod): name = 'crawl_spider_with_errback' rules = ( diff --git a/tests/test_crawl.py b/tests/test_crawl.py index c11871745..d14021319 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -37,6 +37,7 @@ from tests.spiders import ( BrokenStartRequestsSpider, BytesReceivedCallbackSpider, BytesReceivedErrbackSpider, + CrawlSpiderWithAsyncCallback, CrawlSpiderWithErrback, CrawlSpiderWithParseMethod, DelaySpider, @@ -391,6 +392,16 @@ class CrawlSpiderTestCase(TestCase): self.assertIn("[parse] status 201 (foo: None)", str(log)) self.assertIn("[parse] status 202 (foo: bar)", str(log)) + @defer.inlineCallbacks + def test_crawlspider_with_async_callback(self): + crawler = get_crawler(CrawlSpiderWithAsyncCallback) + with LogCapture() as log: + yield crawler.crawl(mockserver=self.mockserver) + + self.assertIn("[parse_async] status 200 (foo: None)", str(log)) + self.assertIn("[parse_async] status 201 (foo: None)", str(log)) + self.assertIn("[parse_async] status 202 (foo: bar)", str(log)) + @defer.inlineCallbacks def test_crawlspider_with_errback(self): crawler = get_crawler(CrawlSpiderWithErrback) From da8f915091a769b3c3aca0f60d2370c2240213a1 Mon Sep 17 00:00:00 2001 From: Eugenio Lacuesta Date: Sun, 2 Oct 2022 17:37:10 -0300 Subject: [PATCH 174/532] Adapt for asyng generator callbacks --- scrapy/spiders/crawl.py | 11 +++++++---- scrapy/utils/asyncgen.py | 2 +- tests/spiders.py | 12 ++++++++++++ tests/test_crawl.py | 11 +++++++++++ 4 files changed, 31 insertions(+), 5 deletions(-) diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index d860ae0b4..edac082d0 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -6,11 +6,12 @@ See documentation in docs/topics/spiders.rst """ import copy -from typing import Awaitable, Sequence +from typing import AsyncIterable, Awaitable, Sequence -from scrapy.http import Request, HtmlResponse +from scrapy.http import Request, Response, HtmlResponse from scrapy.linkextractors import LinkExtractor from scrapy.spiders import Spider +from scrapy.utils.asyncgen import collect_asyncgen from scrapy.utils.spider import iterate_spider_output @@ -78,7 +79,7 @@ class CrawlSpider(Spider): def parse_start_url(self, response, **kwargs): return [] - def process_results(self, response, results): + def process_results(self, response: Response, results: list): return results def _build_request(self, rule_index, link): @@ -112,7 +113,9 @@ class CrawlSpider(Spider): async def _parse_response(self, response, callback, cb_kwargs, follow=True): if callback: cb_res = callback(response, **cb_kwargs) or () - if isinstance(cb_res, Awaitable): + if isinstance(cb_res, AsyncIterable): + cb_res = await collect_asyncgen(cb_res) + elif isinstance(cb_res, Awaitable): cb_res = await cb_res cb_res = self.process_results(response, cb_res) for request_or_item in iterate_spider_output(cb_res): diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index 9f794de92..c84b51e8c 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -1,7 +1,7 @@ from typing import AsyncGenerator, AsyncIterable, Iterable, Union -async def collect_asyncgen(result: AsyncIterable): +async def collect_asyncgen(result: AsyncIterable) -> list: results = [] async for x in result: results.append(x) diff --git a/tests/spiders.py b/tests/spiders.py index 2b78e1f7c..5ea8a4a21 100644 --- a/tests/spiders.py +++ b/tests/spiders.py @@ -381,6 +381,18 @@ class CrawlSpiderWithAsyncCallback(CrawlSpiderWithParseMethod): return Request(self.mockserver.url("/status?n=202"), self.parse_async, cb_kwargs={"foo": "bar"}) +class CrawlSpiderWithAsyncGeneratorCallback(CrawlSpiderWithParseMethod): + """A CrawlSpider with an async generator callback""" + name = 'crawl_spider_with_async_generator_callback' + rules = ( + Rule(LinkExtractor(), callback='parse_async_gen', follow=True), + ) + + async def parse_async_gen(self, response, foo=None): + self.logger.info('[parse_async_gen] status %i (foo: %s)', response.status, foo) + yield Request(self.mockserver.url("/status?n=202"), self.parse_async_gen, cb_kwargs={"foo": "bar"}) + + class CrawlSpiderWithErrback(CrawlSpiderWithParseMethod): name = 'crawl_spider_with_errback' rules = ( diff --git a/tests/test_crawl.py b/tests/test_crawl.py index d14021319..8be4b6fe1 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -38,6 +38,7 @@ from tests.spiders import ( BytesReceivedCallbackSpider, BytesReceivedErrbackSpider, CrawlSpiderWithAsyncCallback, + CrawlSpiderWithAsyncGeneratorCallback, CrawlSpiderWithErrback, CrawlSpiderWithParseMethod, DelaySpider, @@ -402,6 +403,16 @@ class CrawlSpiderTestCase(TestCase): self.assertIn("[parse_async] status 201 (foo: None)", str(log)) self.assertIn("[parse_async] status 202 (foo: bar)", str(log)) + @defer.inlineCallbacks + def test_crawlspider_with_async_generator_callback(self): + crawler = get_crawler(CrawlSpiderWithAsyncGeneratorCallback) + with LogCapture() as log: + yield crawler.crawl(mockserver=self.mockserver) + + self.assertIn("[parse_async_gen] status 200 (foo: None)", str(log)) + self.assertIn("[parse_async_gen] status 201 (foo: None)", str(log)) + self.assertIn("[parse_async_gen] status 202 (foo: bar)", str(log)) + @defer.inlineCallbacks def test_crawlspider_with_errback(self): crawler = get_crawler(CrawlSpiderWithErrback) From 41041ae740260c4bddda06ab7f4d8e4351e6e0e4 Mon Sep 17 00:00:00 2001 From: Felipe A Date: Mon, 3 Oct 2022 00:48:12 -0300 Subject: [PATCH 175/532] refact: add Osx DS_Store file to gitignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index d77d24624..6c5c50e08 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,6 @@ test-output.* # Windows Thumbs.db + +# OSX miscellaneous +.DS_Store \ No newline at end of file From 82d10f09145186fbd3a2c445287a7bf3e1e54263 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 6 Oct 2022 20:27:06 +0600 Subject: [PATCH 176/532] Add Ubuntu tests for Python 3.11rc2. --- .github/workflows/tests-ubuntu.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index be40c7c71..9e62b8e23 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -20,6 +20,12 @@ jobs: - python-version: "3.10" env: TOXENV: asyncio + - python-version: "3.11.0-rc.2" + env: + TOXENV: py + - python-version: "3.11.0-rc.2" + env: + TOXENV: asyncio - python-version: pypy3 env: TOXENV: pypy3 @@ -53,7 +59,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install system libraries - if: matrix.python-version == 'pypy3' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.10.0-beta.4' + if: matrix.python-version == 'pypy3' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.11.0-rc.2' run: | sudo apt-get update # libxml2 2.9.12 from ondrej/php PPA breaks lxml so we pin it to the bionic-updates repo version From fa58ab21e4670db1b11b6097d809cd18dd2ca667 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 6 Oct 2022 20:59:06 +0600 Subject: [PATCH 177/532] Replace _getargspec_py23() with inspect.getfullargspec(). --- scrapy/utils/python.py | 21 ++------------------- 1 file changed, 2 insertions(+), 19 deletions(-) diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 11c089ac2..8ce030d9d 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -180,23 +180,6 @@ def binary_is_text(data): return all(c not in _BINARYCHARS for c in data) -def _getargspec_py23(func): - """_getargspec_py23(function) -> named tuple ArgSpec(args, varargs, keywords, - defaults) - - Was identical to inspect.getargspec() in python2, but uses - inspect.getfullargspec() for python3 behind the scenes to avoid - DeprecationWarning. - - >>> def f(a, b=2, *ar, **kw): - ... pass - - >>> _getargspec_py23(f) - ArgSpec(args=['a', 'b'], varargs='ar', keywords='kw', defaults=(2,)) - """ - return inspect.ArgSpec(*inspect.getfullargspec(func)[:4]) - - def get_func_args(func, stripself=False): """Return the argument name list of a callable""" if inspect.isfunction(func): @@ -248,9 +231,9 @@ def get_spec(func): """ if inspect.isfunction(func) or inspect.ismethod(func): - spec = _getargspec_py23(func) + spec = inspect.getfullargspec(func) elif hasattr(func, '__call__'): - spec = _getargspec_py23(func.__call__) + spec = inspect.getfullargspec(func.__call__) else: raise TypeError(f'{type(func)} is not callable') From e60e8224a23ddd4fd98c54318d128f6744f40a6a Mon Sep 17 00:00:00 2001 From: Abinash Satapathy Date: Thu, 6 Oct 2022 19:58:48 +0200 Subject: [PATCH 178/532] Update and rename INSTALL to INSTALL.md --- INSTALL | 4 ---- INSTALL.md | 4 ++++ 2 files changed, 4 insertions(+), 4 deletions(-) delete mode 100644 INSTALL create mode 100644 INSTALL.md diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 06e812936..000000000 --- a/INSTALL +++ /dev/null @@ -1,4 +0,0 @@ -For information about installing Scrapy see: - -* docs/intro/install.rst (local file) -* https://docs.scrapy.org/en/latest/intro/install.html (online version) diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 000000000..495413f97 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,4 @@ +For information about installing Scrapy see: + +* [Local docs](docs/intro/install.rst) +* [Online docs](https://docs.scrapy.org/en/latest/intro/install.html) From 300c42bfdf0afe0809b03cf571ebe5da7352301e Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 7 Oct 2022 14:53:19 +0600 Subject: [PATCH 179/532] Install PyPy using actions/setup-python. --- .github/workflows/tests-ubuntu.yml | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 9e62b8e23..633e01c95 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -26,10 +26,9 @@ jobs: - python-version: "3.11.0-rc.2" env: TOXENV: asyncio - - python-version: pypy3 + - python-version: pypy3.9 env: TOXENV: pypy3 - PYPY_VERSION: 3.9-v7.3.9 # pinned deps - python-version: 3.7.13 @@ -38,10 +37,9 @@ jobs: - python-version: 3.7.13 env: TOXENV: asyncio-pinned - - python-version: pypy3 + - python-version: pypy3.7 env: TOXENV: pypy3-pinned - PYPY_VERSION: 3.7-v7.3.5 # extras # extra-deps includes reppy, which does not support Python 3.9 @@ -59,7 +57,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install system libraries - if: matrix.python-version == 'pypy3' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.11.0-rc.2' + if: matrix.python-version == 'pypy3.9' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.11.0-rc.2' run: | sudo apt-get update # libxml2 2.9.12 from ondrej/php PPA breaks lxml so we pin it to the bionic-updates repo version @@ -68,13 +66,6 @@ jobs: - name: Run tests env: ${{ matrix.env }} run: | - if [[ ! -z "$PYPY_VERSION" ]]; then - export PYPY_VERSION="pypy$PYPY_VERSION-linux64" - wget "https://downloads.python.org/pypy/${PYPY_VERSION}.tar.bz2" - tar -jxf ${PYPY_VERSION}.tar.bz2 - $PYPY_VERSION/bin/pypy3 -m venv "$HOME/virtualenvs/$PYPY_VERSION" - source "$HOME/virtualenvs/$PYPY_VERSION/bin/activate" - fi pip install -U tox tox From 4aea925714f7c9beb68d3d478ad528f00d488942 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 7 Oct 2022 15:01:50 +0600 Subject: [PATCH 180/532] Update action versions. --- .github/workflows/tests-ubuntu.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 633e01c95..9cd0df468 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -49,10 +49,10 @@ jobs: TOXENV: extra-deps steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} From 424849b27582d3a74fab0c43d842576722b48e25 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 7 Oct 2022 15:17:55 +0600 Subject: [PATCH 181/532] Update mypy. --- tox.ini | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 2804ebe95..12a4516ce 100644 --- a/tox.ini +++ b/tox.ini @@ -38,7 +38,8 @@ install_command = basepython = python3 deps = lxml-stubs==0.2.0 - mypy==0.971 + mypy==0.982 + types-attrs==19.1.0 types-pyOpenSSL==21.0.0 types-setuptools==57.0.0 commands = From ccb6a8c098501c0f4322faeac17f9b97dad0c5e3 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 7 Oct 2022 15:27:14 +0600 Subject: [PATCH 182/532] Add a note about flake8. --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index 12a4516ce..7002c2f18 100644 --- a/tox.ini +++ b/tox.ini @@ -59,6 +59,7 @@ deps = # Twisted[http2] is required to import some files Twisted[http2]>=17.9.0 pytest-flake8==1.1.1 + # newer ones don't work: https://github.com/tholo/pytest-flake8/issues/87 flake8==4.0.1 commands = pytest --flake8 {posargs:docs scrapy tests} From d1515cc0755ae1d587ffbe4171544442fa10ef8d Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 7 Oct 2022 15:30:44 +0600 Subject: [PATCH 183/532] Update pylint. --- tox.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 7002c2f18..463828e7c 100644 --- a/tox.ini +++ b/tox.ini @@ -69,7 +69,7 @@ commands = basepython = python3.8 deps = {[testenv:extra-deps]deps} - pylint==2.14.5 + pylint==2.15.3 commands = pylint conftest.py docs extras scrapy setup.py tests From ed9bc84d551c7302cd075aa52f30d38465749f05 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sat, 8 Oct 2022 19:11:16 +0600 Subject: [PATCH 184/532] Remove a pin on libxml2-dev. --- .github/workflows/tests-ubuntu.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 9cd0df468..7915a9aab 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -60,8 +60,7 @@ jobs: if: matrix.python-version == 'pypy3.9' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.11.0-rc.2' run: | sudo apt-get update - # libxml2 2.9.12 from ondrej/php PPA breaks lxml so we pin it to the bionic-updates repo version - sudo apt-get install libxml2-dev/bionic-updates libxslt-dev + sudo apt-get install libxml2-dev libxslt-dev - name: Run tests env: ${{ matrix.env }} From 92f2d75ed39e4d75f6cca23b8d3aaf934677f4f3 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sat, 8 Oct 2022 19:12:32 +0600 Subject: [PATCH 185/532] Add a classifier for Python 3.11. --- setup.py | 1 + 1 file changed, 1 insertion(+) diff --git a/setup.py b/setup.py index 8b9c43738..a43cf08c8 100644 --- a/setup.py +++ b/setup.py @@ -83,6 +83,7 @@ setup( 'Programming Language :: Python :: 3.8', 'Programming Language :: Python :: 3.9', 'Programming Language :: Python :: 3.10', + 'Programming Language :: Python :: 3.11', 'Programming Language :: Python :: Implementation :: CPython', 'Programming Language :: Python :: Implementation :: PyPy', 'Topic :: Internet :: WWW/HTTP', From 5fa613b419f0d94b7dca8ae4ba2782ca268a9d7c Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 10 Oct 2022 11:02:57 +0600 Subject: [PATCH 186/532] Run flake8 directly. --- conftest.py | 10 ---------- tox.ini | 3 +-- 2 files changed, 1 insertion(+), 12 deletions(-) diff --git a/conftest.py b/conftest.py index 117087790..d7fe80321 100644 --- a/conftest.py +++ b/conftest.py @@ -42,16 +42,6 @@ def chdir(tmpdir): tmpdir.chdir() -def pytest_collection_modifyitems(session, config, items): - # Avoid executing tests when executing `--flake8` flag (pytest-flake8) - try: - from pytest_flake8 import Flake8Item - if config.getoption('--flake8'): - items[:] = [item for item in items if isinstance(item, Flake8Item)] - except ImportError: - pass - - def pytest_addoption(parser): parser.addoption( "--reactor", diff --git a/tox.ini b/tox.ini index 463828e7c..822e96fde 100644 --- a/tox.ini +++ b/tox.ini @@ -58,11 +58,10 @@ deps = {[testenv]deps} # Twisted[http2] is required to import some files Twisted[http2]>=17.9.0 - pytest-flake8==1.1.1 # newer ones don't work: https://github.com/tholo/pytest-flake8/issues/87 flake8==4.0.1 commands = - pytest --flake8 {posargs:docs scrapy tests} + flake8 {posargs:docs scrapy tests} [testenv:pylint] # reppy does not support Python 3.9+ From eeb199adda2d7b56c78879df79c7294148ca15f1 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 10 Oct 2022 11:10:59 +0600 Subject: [PATCH 187/532] Fix flake8 issues in previously ignored files. --- .flake8 | 2 ++ docs/_ext/scrapydocs.py | 24 +++++++++---------- scrapy/utils/testsite.py | 2 +- .../CrawlerProcess/asyncio_deferred_signal.py | 1 - .../CrawlerProcess/asyncio_enabled_reactor.py | 4 ++-- tests/CrawlerProcess/reactor_default.py | 3 +-- .../reactor_default_twisted_reactor_select.py | 4 +--- tests/CrawlerProcess/reactor_select.py | 2 -- ..._select_subclass_twisted_reactor_select.py | 4 ---- .../reactor_select_twisted_reactor_select.py | 3 --- 10 files changed, 19 insertions(+), 30 deletions(-) diff --git a/.flake8 b/.flake8 index 1c503fb0b..d7aebc24b 100644 --- a/.flake8 +++ b/.flake8 @@ -4,6 +4,8 @@ max-line-length = 119 ignore = W503 exclude = + docs/conf.py + # Exclude files that are meant to provide top-level imports # E402: Module level import not at top of file # F401: Module imported but unused diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index 640660943..d02a2e17b 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -80,24 +80,24 @@ def replace_settingslist_nodes(app, doctree, fromdocname): def setup(app): app.add_crossref_type( - directivename = "setting", - rolename = "setting", - indextemplate = "pair: %s; setting", + directivename="setting", + rolename="setting", + indextemplate="pair: %s; setting", ) app.add_crossref_type( - directivename = "signal", - rolename = "signal", - indextemplate = "pair: %s; signal", + directivename="signal", + rolename="signal", + indextemplate="pair: %s; signal", ) app.add_crossref_type( - directivename = "command", - rolename = "command", - indextemplate = "pair: %s; command", + directivename="command", + rolename="command", + indextemplate="pair: %s; command", ) app.add_crossref_type( - directivename = "reqmeta", - rolename = "reqmeta", - indextemplate = "pair: %s; reqmeta", + directivename="reqmeta", + rolename="reqmeta", + indextemplate="pair: %s; reqmeta", ) app.add_role('source', source_role) app.add_role('commit', commit_role) diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py index fce77be32..5d3710391 100644 --- a/scrapy/utils/testsite.py +++ b/scrapy/utils/testsite.py @@ -23,7 +23,7 @@ class NoMetaRefreshRedirect(util.Redirect): def render(self, request): content = util.Redirect.render(self, request) return content.replace(b'http-equiv=\"refresh\"', - b'http-no-equiv=\"do-not-refresh-me\"') + b'http-no-equiv=\"do-not-refresh-me\"') def test_site(): diff --git a/tests/CrawlerProcess/asyncio_deferred_signal.py b/tests/CrawlerProcess/asyncio_deferred_signal.py index bdd3c1fef..b83f6a585 100644 --- a/tests/CrawlerProcess/asyncio_deferred_signal.py +++ b/tests/CrawlerProcess/asyncio_deferred_signal.py @@ -5,7 +5,6 @@ from typing import Optional from scrapy import Spider from scrapy.crawler import CrawlerProcess from scrapy.utils.defer import deferred_from_coro -from twisted.internet.defer import Deferred class UppercasePipeline: diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor.py b/tests/CrawlerProcess/asyncio_enabled_reactor.py index f2a93074b..e561d63c7 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor.py @@ -6,8 +6,8 @@ if sys.version_info >= (3, 8) and sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) asyncioreactor.install(asyncio.get_event_loop()) -import scrapy -from scrapy.crawler import CrawlerProcess +import scrapy # noqa: E402 +from scrapy.crawler import CrawlerProcess # noqa: E402 class NoRequestsSpider(scrapy.Spider): diff --git a/tests/CrawlerProcess/reactor_default.py b/tests/CrawlerProcess/reactor_default.py index 5a21a3717..2c867df61 100644 --- a/tests/CrawlerProcess/reactor_default.py +++ b/tests/CrawlerProcess/reactor_default.py @@ -1,6 +1,6 @@ import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import reactor +from twisted.internet import reactor # noqa: F401 class NoRequestsSpider(scrapy.Spider): @@ -14,4 +14,3 @@ process = CrawlerProcess(settings={}) process.crawl(NoRequestsSpider) process.start() - diff --git a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py index c476722ef..c2b30b044 100644 --- a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py @@ -1,6 +1,6 @@ import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import reactor +from twisted.internet import reactor # noqa: F401 class NoRequestsSpider(scrapy.Spider): @@ -16,5 +16,3 @@ process = CrawlerProcess(settings={ process.crawl(NoRequestsSpider) process.start() - - diff --git a/tests/CrawlerProcess/reactor_select.py b/tests/CrawlerProcess/reactor_select.py index eac6e2f89..ca70c06a0 100644 --- a/tests/CrawlerProcess/reactor_select.py +++ b/tests/CrawlerProcess/reactor_select.py @@ -15,5 +15,3 @@ process = CrawlerProcess(settings={}) process.crawl(NoRequestsSpider) process.start() - - diff --git a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py index 47f480605..0035daf1e 100644 --- a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py @@ -25,7 +25,3 @@ process = CrawlerProcess(settings={ process.crawl(NoRequestsSpider) process.start() - - - - diff --git a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py index e0d2dab26..4f8394edb 100644 --- a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py @@ -17,6 +17,3 @@ process = CrawlerProcess(settings={ process.crawl(NoRequestsSpider) process.start() - - - From 5bf42606792c69268cc34da287293e9406e25883 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 10 Oct 2022 11:14:20 +0600 Subject: [PATCH 188/532] Update flake8. --- tests/test_http_response.py | 6 ++++-- tox.ini | 3 +-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/tests/test_http_response.py b/tests/test_http_response.py index 5d67a5e74..b42c95045 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -705,7 +705,8 @@ class HtmlResponseTest(TextResponseTest): def test_html_encoding(self): - body = b"""Some page + body = b"""Some page + Price: \xa3100' """ r1 = self.response_class("http://www.example.com", body=body) @@ -719,7 +720,8 @@ class HtmlResponseTest(TextResponseTest): self._assert_response_values(r2, 'iso-8859-1', body) # for conflicting declarations headers must take precedence - body = b"""Some page + body = b"""Some page + Price: \xa3100' """ r3 = self.response_class("http://www.example.com", body=body, diff --git a/tox.ini b/tox.ini index 822e96fde..eee99cb2d 100644 --- a/tox.ini +++ b/tox.ini @@ -58,8 +58,7 @@ deps = {[testenv]deps} # Twisted[http2] is required to import some files Twisted[http2]>=17.9.0 - # newer ones don't work: https://github.com/tholo/pytest-flake8/issues/87 - flake8==4.0.1 + flake8==5.0.4 commands = flake8 {posargs:docs scrapy tests} From b792632046093504b1df8bcb0b92d4cb52ebf436 Mon Sep 17 00:00:00 2001 From: Nirjas Jakilim Date: Mon, 10 Oct 2022 11:47:02 +0600 Subject: [PATCH 189/532] updated setup-python and checkout workflow --- .github/workflows/checks.yml | 4 ++-- .github/workflows/publish.yml | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index e515959ad..cc8f20f44 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -30,10 +30,10 @@ jobs: TOXENV: twinecheck steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: ${{ matrix.python-version }} diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 44b682830..8e307189d 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -7,10 +7,10 @@ jobs: if: startsWith(github.event.ref, 'refs/tags/') steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: Set up Python - uses: actions/setup-python@v2 + uses: actions/setup-python@v4 with: python-version: "3.10" From d12fcc555b57dbd62c90212bd1d918d39e1ba45d Mon Sep 17 00:00:00 2001 From: Derek Date: Tue, 11 Oct 2022 10:32:45 -0700 Subject: [PATCH 190/532] Link to the Code of Conduct (#5659) --- README.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 358302c76..d416ced3c 100644 --- a/README.rst +++ b/README.rst @@ -95,8 +95,7 @@ See https://docs.scrapy.org/en/master/contributing.html for details. Code of Conduct --------------- -Please note that this project is released with a Contributor Code of Conduct -(see https://github.com/scrapy/scrapy/blob/master/CODE_OF_CONDUCT.md). +Please note that this project is released with a Contributor `Code of Conduct `_. By participating in this project you agree to abide by its terms. Please report unacceptable behavior to opensource@zyte.com. From 96fb663ae1a95286b0634bc51bc17b42eb29bd0f Mon Sep 17 00:00:00 2001 From: Abdul Rauf Date: Tue, 11 Oct 2022 10:34:18 -0700 Subject: [PATCH 191/532] README: set Bash highlighting for pip install (#5648) --- README.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index d416ced3c..970bf2c35 100644 --- a/README.rst +++ b/README.rst @@ -64,7 +64,9 @@ Requirements Install ======= -The quick way:: +The quick way: + +.. code:: bash pip install scrapy From da9a2f8a946d6341be1cdd8cad0616a18bba6dbe Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Wed, 12 Oct 2022 11:10:39 -0300 Subject: [PATCH 192/532] Remove mention of minimum PyPy versions from the documentation (#5678) --- docs/intro/install.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 80a9c16d6..f28f5216a 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -10,7 +10,7 @@ Supported Python versions ========================= Scrapy requires Python 3.7+, either the CPython implementation (default) or -the PyPy 7.3.5+ implementation (see :ref:`python:implementations`). +the PyPy implementation (see :ref:`python:implementations`). .. _intro-install-scrapy: @@ -219,7 +219,7 @@ After any of these workarounds you should be able to install Scrapy:: PyPy ---- -We recommend using the latest PyPy version. The version tested is 5.9.0. +We recommend using the latest PyPy version. For PyPy3, only Linux installation was tested. Most Scrapy dependencies now have binary wheels for CPython, but not for PyPy. From 715c05d504d22e87935ae42cee55ee35b12c2ebd Mon Sep 17 00:00:00 2001 From: gabrielztk <38334108+gabrielztk@users.noreply.github.com> Date: Thu, 13 Oct 2022 07:22:10 -0300 Subject: [PATCH 193/532] =?UTF-8?q?transport.producer.loseConnection()=20?= =?UTF-8?q?=E2=86=92=20transport.loseConnection()=20(#4995)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/core/downloader/handlers/http11.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index 38935667d..6b8a18f1a 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -384,8 +384,7 @@ class ScrapyAgent: logger.debug("Download stopped for %(request)s from signal handler %(handler)s", {"request": request, "handler": handler.__qualname__}) txresponse._transport.stopProducing() - with suppress(AttributeError): - txresponse._transport._producer.loseConnection() + txresponse._transport.loseConnection() return { "txresponse": txresponse, "body": b"", @@ -417,7 +416,7 @@ class ScrapyAgent: logger.warning(warning_msg, warning_args) - txresponse._transport._producer.loseConnection() + txresponse._transport.loseConnection() raise defer.CancelledError(warning_msg % warning_args) if warnsize and expected_size > warnsize: @@ -543,7 +542,7 @@ class _ResponseReader(protocol.Protocol): logger.debug("Download stopped for %(request)s from signal handler %(handler)s", {"request": self._request, "handler": handler.__qualname__}) self.transport.stopProducing() - self.transport._producer.loseConnection() + self.transport.loseConnection() failure = result if result.value.fail else None self._finish_response(flags=["download_stopped"], failure=failure) From 62cc26e209b66ce5941f15736f669c75dcac9a59 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 14 Oct 2022 22:03:54 +0600 Subject: [PATCH 194/532] Change TWISTED_REACTOR in the default template. --- docs/topics/settings.rst | 5 +++++ scrapy/templates/project/module/settings.py.tmpl | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index a711fd197..0b1ef71cf 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -1642,6 +1642,11 @@ install the default reactor defined by Twisted for the current platform. This is to maintain backward compatibility and avoid possible problems caused by using a non-default reactor. +.. versionchanged:: VERSION + The :command:`startproject` command now sets this setting to + ``twisted.internet.asyncioreactor.AsyncioSelectorReactor`` in the generated + ``settings.py`` file. + For additional information, see :doc:`core/howto/choosing-reactor`. diff --git a/scrapy/templates/project/module/settings.py.tmpl b/scrapy/templates/project/module/settings.py.tmpl index 5e541e2c0..c0c34e986 100644 --- a/scrapy/templates/project/module/settings.py.tmpl +++ b/scrapy/templates/project/module/settings.py.tmpl @@ -89,3 +89,4 @@ ROBOTSTXT_OBEY = True # Set settings whose default value is deprecated to a future-proof value REQUEST_FINGERPRINTER_IMPLEMENTATION = 'VERSION' +TWISTED_REACTOR = 'twisted.internet.asyncioreactor.AsyncioSelectorReactor' From 22a59d0005c03d866ce98d352024974a9e48e7d1 Mon Sep 17 00:00:00 2001 From: Nirjas Jakilim Date: Fri, 14 Oct 2022 23:41:50 +0600 Subject: [PATCH 195/532] CI: use the latest version of Ubuntu (#5675) --- .github/workflows/checks.yml | 2 +- .github/workflows/publish.yml | 2 +- .github/workflows/tests-ubuntu.yml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index cc8f20f44..439dfee51 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -3,7 +3,7 @@ on: [push, pull_request] jobs: checks: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest strategy: fail-fast: false matrix: diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 8e307189d..f6b098b80 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -3,7 +3,7 @@ on: [push] jobs: publish: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest if: startsWith(github.event.ref, 'refs/tags/') steps: diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 7915a9aab..d2bfe4a5f 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -3,7 +3,7 @@ on: [push, pull_request] jobs: tests: - runs-on: ubuntu-18.04 + runs-on: ubuntu-latest strategy: fail-fast: false matrix: From 043575123c57db9f055c3668a3d80485989df0b2 Mon Sep 17 00:00:00 2001 From: Mohammadtaher Abbasi Date: Sat, 15 Oct 2022 11:41:05 +0330 Subject: [PATCH 196/532] Add async callback support to the parse command (#5577) --- scrapy/commands/parse.py | 55 ++++++++++++++++++++++--------------- tests/test_command_parse.py | 15 ++++++++++ 2 files changed, 48 insertions(+), 22 deletions(-) diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index 9b4fb0ed6..d93ab2ac5 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -5,6 +5,8 @@ from typing import Dict from itemadapter import is_item, ItemAdapter from w3lib.url import is_url +from twisted.internet.defer import maybeDeferred + from scrapy.commands import BaseRunSpiderCommand from scrapy.http import Request from scrapy.utils import display @@ -110,16 +112,19 @@ class Command(BaseRunSpiderCommand): if not opts.nolinks: self.print_requests(colour=colour) - def run_callback(self, response, callback, cb_kwargs=None): - cb_kwargs = cb_kwargs or {} + def _get_items_and_requests(self, spider_output, opts, depth, spider, callback): items, requests = [], [] - - for x in iterate_spider_output(callback(response, **cb_kwargs)): + for x in spider_output: if is_item(x): items.append(x) elif isinstance(x, Request): requests.append(x) - return items, requests + return items, requests, opts, depth, spider, callback + + def run_callback(self, response, callback, cb_kwargs=None): + cb_kwargs = cb_kwargs or {} + d = maybeDeferred(iterate_spider_output, callback(response, **cb_kwargs)) + return d def get_callback_from_rules(self, spider, response): if getattr(spider, 'rules', None): @@ -158,6 +163,25 @@ class Command(BaseRunSpiderCommand): logger.error('No response downloaded for: %(url)s', {'url': url}) + def scraped_data(self, args): + items, requests, opts, depth, spider, callback = args + if opts.pipelines: + itemproc = self.pcrawler.engine.scraper.itemproc + for item in items: + itemproc.process_item(item, spider) + self.add_items(depth, items) + self.add_requests(depth, requests) + + scraped_data = items if opts.output else [] + if depth < opts.depth: + for req in requests: + req.meta['_depth'] = depth + 1 + req.meta['_callback'] = req.callback + req.callback = callback + scraped_data += requests + + return scraped_data + def prepare_request(self, spider, request, opts): def callback(response, **cb_kwargs): # memorize first request @@ -191,23 +215,10 @@ class Command(BaseRunSpiderCommand): # parse items and requests depth = response.meta['_depth'] - items, requests = self.run_callback(response, cb, cb_kwargs) - if opts.pipelines: - itemproc = self.pcrawler.engine.scraper.itemproc - for item in items: - itemproc.process_item(item, spider) - self.add_items(depth, items) - self.add_requests(depth, requests) - - scraped_data = items if opts.output else [] - if depth < opts.depth: - for req in requests: - req.meta['_depth'] = depth + 1 - req.meta['_callback'] = req.callback - req.callback = callback - scraped_data += requests - - return scraped_data + d = self.run_callback(response, cb, cb_kwargs) + d.addCallback(self._get_items_and_requests, opts, depth, spider, callback) + d.addCallback(self.scraped_data) + return d # update request meta if any extra meta was passed through the --meta/-m opts. if opts.meta: diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 0d992be56..8368356e2 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -29,7 +29,15 @@ class ParseCommandTest(ProcessTest, SiteTest, CommandTest): import scrapy from scrapy.linkextractors import LinkExtractor from scrapy.spiders import CrawlSpider, Rule +from scrapy.utils.test import get_from_asyncio_queue +class AsyncDefAsyncioSpider(scrapy.Spider): + + name = 'asyncdef{self.spider_name}' + + async def parse(self, response): + status = await get_from_asyncio_queue(response.status) + return [scrapy.Item(), dict(foo='bar')] class MySpider(scrapy.Spider): name = '{self.spider_name}' @@ -160,6 +168,13 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} self.url('/html')]) self.assertIn("INFO: It Works!", _textmode(stderr)) + @defer.inlineCallbacks + def test_asyncio_parse_items(self): + status, out, stderr = yield self.execute( + ['--spider', 'asyncdef' + self.spider_name, '-c', 'parse', self.url('/html')] + ) + self.assertIn("""[{}, {'foo': 'bar'}]""", _textmode(out)) + @defer.inlineCallbacks def test_parse_items(self): status, out, stderr = yield self.execute( From 75bb516edbc39f9a657e71e75f05f0fd6a33d60d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Sat, 15 Oct 2022 10:26:38 +0200 Subject: [PATCH 197/532] Adapt tests to the new value of TWISTED_REACTOR for new projects --- tests/test_commands.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/tests/test_commands.py b/tests/test_commands.py index 76d5f3935..eaca41102 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -689,8 +689,15 @@ class MySpider(scrapy.Spider): ]) self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) - def test_asyncio_enabled_false(self): + def test_asyncio_enabled_default(self): log = self.get_log(self.debug_log_spider, args=[]) + self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + + def test_asyncio_enabled_false(self): + log = self.get_log(self.debug_log_spider, args=[ + '-s', 'TWISTED_REACTOR=twisted.internet.selectreactor.SelectReactor' + ]) + self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') From 960a7f68f6939744b39d528e28f8f925a2e12ad0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Sat, 15 Oct 2022 11:27:00 +0200 Subject: [PATCH 198/532] Verify that the installed asyncio event loop matches ASYNCIO_EVENT_LOOP (#5529) Co-authored-by: Laerte Pereira <5853172+Laerte@users.noreply.github.com> --- scrapy/crawler.py | 14 ++++++++-- scrapy/utils/reactor.py | 18 ++++++++++++ .../asyncio_enabled_reactor_different_loop.py | 25 +++++++++++++++++ .../asyncio_enabled_reactor_same_loop.py | 28 +++++++++++++++++++ tests/test_crawler.py | 23 +++++++++++++++ 5 files changed, 105 insertions(+), 3 deletions(-) create mode 100644 tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py create mode 100644 tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py diff --git a/scrapy/crawler.py b/scrapy/crawler.py index e768bca12..65174d846 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -31,7 +31,12 @@ from scrapy.utils.log import ( ) from scrapy.utils.misc import create_instance, load_object from scrapy.utils.ossignal import install_shutdown_handlers, signal_names -from scrapy.utils.reactor import install_reactor, verify_installed_reactor +from scrapy.utils.reactor import ( + install_reactor, + is_asyncio_reactor_installed, + verify_installed_asyncio_event_loop, + verify_installed_reactor, +) logger = logging.getLogger(__name__) @@ -78,17 +83,20 @@ class Crawler: crawler=self, ) - reactor_class = self.settings.get("TWISTED_REACTOR") + reactor_class = self.settings["TWISTED_REACTOR"] + event_loop = self.settings["ASYNCIO_EVENT_LOOP"] if init_reactor: # this needs to be done after the spider settings are merged, # but before something imports twisted.internet.reactor if reactor_class: - install_reactor(reactor_class, self.settings["ASYNCIO_EVENT_LOOP"]) + install_reactor(reactor_class, event_loop) else: from twisted.internet import reactor # noqa: F401 log_reactor_info() if reactor_class: verify_installed_reactor(reactor_class) + if is_asyncio_reactor_installed() and event_loop: + verify_installed_asyncio_event_loop(event_loop) self.extensions = ExtensionManager.from_crawler(self) diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index bc543b230..652733ce8 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -90,6 +90,24 @@ def verify_installed_reactor(reactor_path): raise Exception(msg) +def verify_installed_asyncio_event_loop(loop_path): + from twisted.internet import reactor + loop_class = load_object(loop_path) + if isinstance(reactor._asyncioEventloop, loop_class): + return + installed = ( + f"{reactor._asyncioEventloop.__class__.__module__}" + f".{reactor._asyncioEventloop.__class__.__qualname__}" + ) + specified = f"{loop_class.__module__}.{loop_class.__qualname__}" + raise Exception( + "Scrapy found an asyncio Twisted reactor already " + f"installed, and its event loop class ({installed}) does " + "not match the one specified in the ASYNCIO_EVENT_LOOP " + f"setting ({specified})" + ) + + def is_asyncio_reactor_installed(): from twisted.internet import reactor return isinstance(reactor, asyncioreactor.AsyncioSelectorReactor) diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py new file mode 100644 index 000000000..ea8242f67 --- /dev/null +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py @@ -0,0 +1,25 @@ +import asyncio +import sys + +from twisted.internet import asyncioreactor +if sys.version_info >= (3, 8) and sys.platform == "win32": + asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) +asyncioreactor.install(asyncio.get_event_loop()) + +import scrapy # noqa: E402 +from scrapy.crawler import CrawlerProcess # noqa: E402 + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": "uvloop.Loop", +}) +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py new file mode 100644 index 000000000..d24bf3031 --- /dev/null +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py @@ -0,0 +1,28 @@ +import asyncio +import sys + +from uvloop import Loop + +from twisted.internet import asyncioreactor +if sys.version_info >= (3, 8) and sys.platform == "win32": + asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) +asyncio.set_event_loop(Loop()) +asyncioreactor.install(asyncio.get_event_loop()) + +import scrapy # noqa: E402 +from scrapy.crawler import CrawlerProcess # noqa: E402 + + +class NoRequestsSpider(scrapy.Spider): + name = 'no_request' + + def start_requests(self): + return [] + + +process = CrawlerProcess(settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": "uvloop.Loop", +}) +process.crawl(NoRequestsSpider) +process.start() diff --git a/tests/test_crawler.py b/tests/test_crawler.py index cf15ba9b9..c61d461f7 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -454,6 +454,29 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): self.assertIn("Using asyncio event loop: uvloop.Loop", log) self.assertIn("async pipeline opened!", log) + @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') + @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') + @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + def test_asyncio_enabled_reactor_same_loop(self): + log = self.run_script("asyncio_enabled_reactor_same_loop.py") + self.assertIn("Spider closed (finished)", log) + self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn("Using asyncio event loop: uvloop.Loop", log) + + @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') + @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') + @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + def test_asyncio_enabled_reactor_different_loop(self): + log = self.run_script("asyncio_enabled_reactor_different_loop.py") + self.assertNotIn("Spider closed (finished)", log) + self.assertIn( + ( + "does not match the one specified in the ASYNCIO_EVENT_LOOP " + "setting (uvloop.Loop)" + ), + log, + ) + def test_default_loop_asyncio_deferred_signal(self): log = self.run_script("asyncio_deferred_signal.py") self.assertIn("Spider closed (finished)", log) From c49764ffd7111d8a465a0d077d0df38bd40449fa Mon Sep 17 00:00:00 2001 From: mattkohl-flex Date: Mon, 17 Oct 2022 11:15:17 +0100 Subject: [PATCH 199/532] typo fixes --- docs/intro/install.rst | 2 +- docs/topics/contracts.rst | 2 +- docs/topics/extensions.rst | 2 +- docs/topics/leaks.rst | 2 +- docs/topics/request-response.rst | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index f28f5216a..9ab479edd 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -187,7 +187,7 @@ solutions: * Install `homebrew`_ following the instructions in https://brew.sh/ * Update your ``PATH`` variable to state that homebrew packages should be - used before system packages (Change ``.bashrc`` to ``.zshrc`` accordantly + used before system packages (Change ``.bashrc`` to ``.zshrc`` accordingly if you're using `zsh`_ as default shell):: echo "export PATH=/usr/local/bin:/usr/local/sbin:$PATH" >> ~/.bashrc diff --git a/docs/topics/contracts.rst b/docs/topics/contracts.rst index ef296dc9e..c29a3a410 100644 --- a/docs/topics/contracts.rst +++ b/docs/topics/contracts.rst @@ -102,7 +102,7 @@ override three methods: .. method:: Contract.post_process(output) This allows processing the output of the callback. Iterators are - converted listified before being passed to this hook. + converted to lists before being passed to this hook. Raise :class:`~scrapy.exceptions.ContractFail` from :class:`~scrapy.contracts.Contract.pre_process` or diff --git a/docs/topics/extensions.rst b/docs/topics/extensions.rst index 297e1fdc5..130657b0b 100644 --- a/docs/topics/extensions.rst +++ b/docs/topics/extensions.rst @@ -17,7 +17,7 @@ settings, just like any other Scrapy code. It is customary for extensions to prefix their settings with their own name, to avoid collision with existing (and future) extensions. For example, a -hypothetic extension to handle `Google Sitemaps`_ would use settings like +hypothetical extension to handle `Google Sitemaps`_ would use settings like ``GOOGLESITEMAP_ENABLED``, ``GOOGLESITEMAP_DEPTH``, and so on. .. _Google Sitemaps: https://en.wikipedia.org/wiki/Sitemaps diff --git a/docs/topics/leaks.rst b/docs/topics/leaks.rst index 477652704..33441838a 100644 --- a/docs/topics/leaks.rst +++ b/docs/topics/leaks.rst @@ -154,7 +154,7 @@ Too many spiders? If your project has too many spiders executed in parallel, the output of :func:`prefs()` can be difficult to read. For this reason, that function has a ``ignore`` argument which can be used to -ignore a particular class (and all its subclases). For +ignore a particular class (and all its subclasses). For example, this won't show any live references to spiders: >>> from scrapy.spiders import Spider diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index 49cb69f67..7eb6942ac 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -446,7 +446,7 @@ class). Scenarios where changing the request fingerprinting algorithm may cause undesired results include, for example, using the HTTP cache middleware (see :class:`~scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware`). -Changing the request fingerprinting algorithm would invalidade the current +Changing the request fingerprinting algorithm would invalidate the current cache, requiring you to redownload all requests again. Otherwise, set :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` to ``'VERSION'`` in From 06c8f673afe9af08784e62d67930a8cbc9887ced Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 17 Oct 2022 15:04:29 +0200 Subject: [PATCH 200/532] 2.7 release notes (#5680) * Fix the display name of documented fingerprinter class methods * Initial draft for the Scrapy 2.7 release notes * Update VERSION and PREVIOUS_VERSION references * Clarify the restrictions lifted for item field output names * Fix the description of the BOM bug fix * Fix the note about changes in MIME sniffing * Fix typo * Extend highlights * Fyx typo --- docs/_ext/scrapydocs.py | 2 +- docs/news.rst | 193 +++++++++++++++++- docs/topics/components.rst | 4 +- docs/topics/coroutines.rst | 12 +- docs/topics/request-response.rst | 45 ++-- docs/topics/settings.rst | 10 +- docs/topics/spider-middleware.rst | 8 +- scrapy/settings/default_settings.py | 2 +- .../templates/project/module/settings.py.tmpl | 2 +- scrapy/utils/request.py | 12 +- scrapy/utils/test.py | 2 +- tests/test_crawl.py | 2 +- tests/test_crawler.py | 8 +- tests/test_dupefilters.py | 12 +- tests/test_pipeline_crawl.py | 2 +- tests/test_scheduler.py | 2 +- tests/test_spiderloader/__init__.py | 2 +- tests/test_utils_request.py | 4 +- 18 files changed, 259 insertions(+), 65 deletions(-) diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index d02a2e17b..f0f382da3 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -15,7 +15,7 @@ class SettingsListDirective(Directive): def is_setting_index(node): - if node.tagname == 'index': + if node.tagname == 'index' and node['entries']: # index entries for setting directives look like: # [('pair', 'SETTING_NAME; setting', 'std:setting-SETTING_NAME', '')] entry_type, info, refid = node['entries'][0][:3] diff --git a/docs/news.rst b/docs/news.rst index 9469d0fe5..d8b9fcd1e 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,6 +3,195 @@ Release notes ============= +.. _release-2.7.0: + +Scrapy 2.7.0 (to be released) +----------------------------- + +Highlights: + +- Added Python 3.11 support, dropped Python 3.6 support +- Improved support for :ref:`asynchronous callbacks ` +- :ref:`Asyncio support ` is enabled by default on new + projects +- Output names of item fields can now be arbitrary strings +- Centralized :ref:`request fingerprinting ` + configuration is now possible + +Modified requirements +~~~~~~~~~~~~~~~~~~~~~ + +Python 3.7 or greater is now required; support for Python 3.6 has been dropped. +Support for the upcoming Python 3.11 has been added. + +The minimum required version of some dependencies has changed as well: + +- lxml_: 3.5.0 → 4.3.0 + +- Pillow_ (:ref:`images pipeline `): 4.0.0 → 7.1.0 + +- zope.interface_: 5.0.0 → 5.1.0 + +(:issue:`5512`, :issue:`5514`, :issue:`5524`, :issue:`5563`, :issue:`5664`, +:issue:`5670`, :issue:`5678`) + + +Deprecations +~~~~~~~~~~~~ + +- :meth:`ImagesPipeline.thumb_path + ` must now accept an + ``item`` parameter (:issue:`5504`, :issue:`5508`). + +- The ``scrapy.downloadermiddlewares.decompression`` module is now + deprecated (:issue:`5546`, :issue:`5547`). + + +New features +~~~~~~~~~~~~ + +- The + :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` + method of :ref:`spider middlewares ` can now be + defined as an :term:`asynchronous generator` (:issue:`4978`). + +- The output of :class:`~scrapy.Request` callbacks defined as + :ref:`coroutines ` is now processed asynchronously + (:issue:`4978`). + +- :class:`~scrapy.spiders.crawl.CrawlSpider` now supports :ref:`asynchronous + callbacks ` (:issue:`5657`). + +- New projects created with the :command:`startproject` command have + :ref:`asyncio support ` enabled by default (:issue:`5590`, + :issue:`5679`). + +- The :setting:`FEED_EXPORT_FIELDS` setting can now be defined as a + dictionary to customize the output name of item fields, lifting the + restriction that required output names to be valid Python identifiers, e.g. + preventing them to have whitespace (:issue:`1008`, :issue:`3266`, + :issue:`3696`). + +- You can now customize :ref:`request fingerprinting ` + through the new :setting:`REQUEST_FINGERPRINTER_CLASS` setting, instead of + having to change it on every Scrapy component that relies on request + fingerprinting (:issue:`900`, :issue:`3420`, :issue:`4113`, :issue:`4762`, + :issue:`4524`). + +- ``jsonl`` is now supported and encouraged as a file extension for `JSON + Lines`_ files (:issue:`4848`). + + .. _JSON Lines: https://jsonlines.org/ + +- :meth:`ImagesPipeline.thumb_path + ` now receives the + source :ref:`item ` (:issue:`5504`, :issue:`5508`). + + +Bug fixes +~~~~~~~~~ + +- When using Google Cloud Storage with a :ref:`media pipeline + `, :setting:`FILES_EXPIRES` now also works when + :setting:`FILES_STORE` does not point at the root of your Google Cloud + Storage bucket (:issue:`5317`, :issue:`5318`). + +- The :command:`parse` command now supports :ref:`asynchronous callbacks + ` (:issue:`5424`, :issue:`5577`). + +- When using the :command:`parse` command with a URL for which there is no + available spider, an exception is no longer raised (:issue:`3264`, + :issue:`3265`, :issue:`5375`, :issue:`5376`, :issue:`5497`). + +- :class:`~scrapy.http.TextResponse` now gives higher priority to the `byte + order mark`_ when determining the text encoding of the response body, + following the `HTML living standard`_ (:issue:`5601`, :issue:`5611`). + + .. _byte order mark: https://en.wikipedia.org/wiki/Byte_order_mark + .. _HTML living standard: https://html.spec.whatwg.org/multipage/parsing.html#determining-the-character-encoding + +- MIME sniffing takes the response body into account in FTP and HTTP/1.0 + requests, as well as in cached requests (:issue:`4873`). + +- MIME sniffing now detects valid HTML 5 documents even if the ``html`` tag + is missing (:issue:`4873`). + +- An exception is now raised if :setting:`ASYNCIO_EVENT_LOOP` has a value + that does not match the asyncio event loop actually installed + (:issue:`5529`). + +- Fixed :meth:`Headers.getlist ` + returning only the last header (:issue:`5515`, :issue:`5526`). + +- Fixed :class:`LinkExtractor + ` not ignoring the + ``tar.gz`` file extension by default (:issue:`1837`, :issue:`2067`, + :issue:`4066`) + + +Documentation +~~~~~~~~~~~~~ + +- Clarified the return type of :meth:`Spider.parse ` + (:issue:`5602`, :issue:`5608`). + +- To enable + :class:`~scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware` + to do `brotli compression`_, installing brotli_ is now recommended instead + of installing brotlipy_, as the former provides a more recent version of + brotli. + + .. _brotli: https://github.com/google/brotli + .. _brotli compression: https://www.ietf.org/rfc/rfc7932.txt + +- :ref:`Signal documentation ` now mentions :ref:`coroutine + support ` and uses it in code examples (:issue:`4852`, + :issue:`5358`). + +- :ref:`bans` now recommends `Common Crawl`_ instead of `Google cache`_ + (:issue:`3582`, :issue:`5432`). + + .. _Common Crawl: https://commoncrawl.org/ + .. _Google cache: http://www.googleguide.com/cached_pages.html + +- The new :ref:`topics-components` topic covers enforcing requirements on + Scrapy components, like :ref:`downloader middlewares + `, :ref:`extensions `, + :ref:`item pipelines `, :ref:`spider middlewares + `, and more; :ref:`enforce-asyncio-requirement` + has also been added (:issue:`4978`). + +- :ref:`topics-settings` now indicates that setting values must be + :ref:`picklable ` (:issue:`5607`, :issue:`5629`). + +- Removed outdated documentation (:issue:`5446`, :issue:`5373`, + :issue:`5369`, :issue:`5370`, :issue:`5554`). + +- Fixed typos (:issue:`5442`, :issue:`5455`, :issue:`5457`, :issue:`5461`, + :issue:`5538`, :issue:`5553`, :issue:`5558`, :issue:`5624`, :issue:`5631`). + +- Fixed other issues (:issue:`5283`, :issue:`5284`, :issue:`5559`, + :issue:`5567`, :issue:`5648`, :issue:`5659`, :issue:`5665`). + + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Added a continuous integration job to run `twine check`_ (:issue:`5655`, + :issue:`5656`). + + .. _twine check: https://twine.readthedocs.io/en/stable/#twine-check + +- Addressed test issues and warnings (:issue:`5560`, :issue:`5561`, + :issue:`5612`, :issue:`5617`, :issue:`5639`, :issue:`5645`, :issue:`5662`, + :issue:`5671`, :issue:`5675`). + +- Cleaned up code (:issue:`4991`, :issue:`4995`, :issue:`5451`, + :issue:`5487`, :issue:`5542`, :issue:`5667`, :issue:`5668`, :issue:`5672`). + +- Applied minor code improvements (:issue:`5661`). + + .. _release-2.6.3: Scrapy 2.6.3 (2022-09-27) @@ -3139,7 +3328,7 @@ New Features ~~~~~~~~~~~~ - Accept proxy credentials in :reqmeta:`proxy` request meta key (:issue:`2526`) -- Support `brotli`_-compressed content; requires optional `brotlipy`_ +- Support `brotli-compressed`_ content; requires optional `brotlipy`_ (:issue:`2535`) - New :ref:`response.follow ` shortcut for creating requests (:issue:`1940`) @@ -3176,7 +3365,7 @@ New Features - ``python -m scrapy`` as a more explicit alternative to ``scrapy`` command (:issue:`2740`) -.. _brotli: https://github.com/google/brotli +.. _brotli-compressed: https://www.ietf.org/rfc/rfc7932.txt .. _brotlipy: https://github.com/python-hyper/brotlipy/ Bug fixes diff --git a/docs/topics/components.rst b/docs/topics/components.rst index c44f3def2..ca301b827 100644 --- a/docs/topics/components.rst +++ b/docs/topics/components.rst @@ -75,9 +75,9 @@ If your requirement is a minimum Scrapy version, you may use class MyComponent: def __init__(self): - if parse_version(scrapy.__version__) < parse_version('VERSION'): + if parse_version(scrapy.__version__) < parse_version('2.7'): raise RuntimeError( - f"{MyComponent.__qualname__} requires Scrapy VERSION or " + f"{MyComponent.__qualname__} requires Scrapy 2.7 or " f"later, which allow defining the process_spider_output " f"method of spider middlewares as an asynchronous " f"generator." diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 750263385..a1ba4ba5c 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -22,7 +22,7 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): If you are using any custom or third-party :ref:`spider middleware `, see :ref:`sync-async-spider-middleware`. - .. versionchanged:: VERSION + .. versionchanged:: 2.7 Output of async callbacks is now processed asynchronously instead of collecting all of it first. @@ -49,7 +49,7 @@ hence use coroutine syntax (e.g. ``await``, ``async for``, ``async with``): See also :ref:`sync-async-spider-middleware` and :ref:`universal-spider-middleware`. - .. versionadded:: VERSION + .. versionadded:: 2.7 General usage ============= @@ -129,7 +129,7 @@ Common use cases for asynchronous code include: Mixing synchronous and asynchronous spider middlewares ====================================================== -.. versionadded:: VERSION +.. versionadded:: 2.7 The output of a :class:`~scrapy.Request` callback is passed as the ``result`` parameter to the @@ -182,10 +182,10 @@ process_spider_output_async method `. Universal spider middlewares ============================ -.. versionadded:: VERSION +.. versionadded:: 2.7 To allow writing a spider middleware that supports asynchronous execution of -its ``process_spider_output`` method in Scrapy VERSION and later (avoiding +its ``process_spider_output`` method in Scrapy 2.7 and later (avoiding :ref:`asynchronous-to-synchronous conversions `) while maintaining support for older Scrapy versions, you may define ``process_spider_output`` as a synchronous method and define an @@ -206,7 +206,7 @@ For example:: yield r .. note:: This is an interim measure to allow, for a time, to write code that - works in Scrapy VERSION and later without requiring + works in Scrapy 2.7 and later without requiring asynchronous-to-synchronous conversions, and works in earlier Scrapy versions as well. diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index 49cb69f67..4393e1c68 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -394,7 +394,7 @@ To change how request fingerprints are built for your requests, use the REQUEST_FINGERPRINTER_CLASS ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. versionadded:: VERSION +.. versionadded:: 2.7 Default: :class:`scrapy.utils.request.RequestFingerprinter` @@ -409,38 +409,38 @@ import path. REQUEST_FINGERPRINTER_IMPLEMENTATION ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. versionadded:: VERSION +.. versionadded:: 2.7 -Default: ``'PREVIOUS_VERSION'`` +Default: ``'2.6'`` Determines which request fingerprinting algorithm is used by the default request fingerprinter class (see :setting:`REQUEST_FINGERPRINTER_CLASS`). Possible values are: -- ``'PREVIOUS_VERSION'`` (default) +- ``'2.6'`` (default) This implementation uses the same request fingerprinting algorithm as - Scrapy PREVIOUS_VERSION and earlier versions. + Scrapy 2.6 and earlier versions. Even though this is the default value for backward compatibility reasons, it is a deprecated value. -- ``'VERSION'`` +- ``'2.7'`` - This implementation was introduced in Scrapy VERSION to fix an issue of the + This implementation was introduced in Scrapy 2.7 to fix an issue of the previous implementation. New projects should use this value. The :command:`startproject` command sets this value in the generated ``settings.py`` file. -If you are using the default value (``'PREVIOUS_VERSION'``) for this setting, and you are +If you are using the default value (``'2.6'``) for this setting, and you are using Scrapy components where changing the request fingerprinting algorithm would cause undesired results, you need to carefully decide when to change the value of this setting, or switch the :setting:`REQUEST_FINGERPRINTER_CLASS` -setting to a custom request fingerprinter class that implements the PREVIOUS_VERSION request +setting to a custom request fingerprinter class that implements the 2.6 request fingerprinting algorithm and does not log this warning ( -:ref:`PREVIOUS_VERSION-request-fingerprinter` includes an example implementation of such a +:ref:`2.6-request-fingerprinter` includes an example implementation of such a class). Scenarios where changing the request fingerprinting algorithm may cause @@ -449,14 +449,14 @@ undesired results include, for example, using the HTTP cache middleware (see Changing the request fingerprinting algorithm would invalidade the current cache, requiring you to redownload all requests again. -Otherwise, set :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` to ``'VERSION'`` in +Otherwise, set :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` to ``'2.7'`` in your settings to switch already to the request fingerprinting implementation that will be the only request fingerprinting implementation available in a future version of Scrapy, and remove the deprecation warning triggered by using -the default value (``'PREVIOUS_VERSION'``). +the default value (``'2.6'``). -.. _PREVIOUS_VERSION-request-fingerprinter: +.. _2.6-request-fingerprinter: .. _custom-request-fingerprinter: Writing your own request fingerprinter @@ -464,6 +464,8 @@ Writing your own request fingerprinter A request fingerprinter is a class that must implement the following method: +.. currentmodule:: None + .. method:: fingerprint(self, request) Return a :class:`bytes` object that uniquely identifies *request*. @@ -476,6 +478,7 @@ A request fingerprinter is a class that must implement the following method: Additionally, it may also implement the following methods: .. classmethod:: from_crawler(cls, crawler) + :noindex: If present, this class method is called to create a request fingerprinter instance from a :class:`~scrapy.crawler.Crawler` object. It must return a @@ -495,11 +498,13 @@ Additionally, it may also implement the following methods: :class:`~scrapy.settings.Settings` object. It must return a new instance of the request fingerprinter. -The ``fingerprint`` method of the default request fingerprinter, +.. currentmodule:: scrapy.http + +The :meth:`fingerprint` method of the default request fingerprinter, :class:`scrapy.utils.request.RequestFingerprinter`, uses :func:`scrapy.utils.request.fingerprint` with its default parameters. For some -common use cases you can use :func:`~scrapy.utils.request.fingerprint` as well -in your ``fingerprint`` method implementation: +common use cases you can use :func:`scrapy.utils.request.fingerprint` as well +in your :meth:`fingerprint` method implementation: .. autofunction:: scrapy.utils.request.fingerprint @@ -519,7 +524,7 @@ account:: You can also write your own fingerprinting logic from scratch. -However, if you do not use :func:`~scrapy.utils.request.fingerprint`, make sure +However, if you do not use :func:`scrapy.utils.request.fingerprint`, make sure you use :class:`~weakref.WeakKeyDictionary` to cache request fingerprints: - Caching saves CPU by ensuring that fingerprints are calculated only once @@ -553,7 +558,7 @@ If you need to be able to override the request fingerprinting for arbitrary requests from your spider callbacks, you may implement a request fingerprinter that reads fingerprints from :attr:`request.meta ` when available, and then falls back to -:func:`~scrapy.utils.request.fingerprint`. For example:: +:func:`scrapy.utils.request.fingerprint`. For example:: from scrapy.utils.request import fingerprint @@ -564,8 +569,8 @@ when available, and then falls back to return request.meta['fingerprint'] return fingerprint(request) -If you need to reproduce the same fingerprinting algorithm as Scrapy PREVIOUS_VERSION -without using the deprecated ``'PREVIOUS_VERSION'`` value of the +If you need to reproduce the same fingerprinting algorithm as Scrapy 2.6 +without using the deprecated ``'2.6'`` value of the :setting:`REQUEST_FINGERPRINTER_IMPLEMENTATION` setting, use the following request fingerprinter:: diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 0b1ef71cf..40bcda288 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -1642,7 +1642,7 @@ install the default reactor defined by Twisted for the current platform. This is to maintain backward compatibility and avoid possible problems caused by using a non-default reactor. -.. versionchanged:: VERSION +.. versionchanged:: 2.7 The :command:`startproject` command now sets this setting to ``twisted.internet.asyncioreactor.AsyncioSelectorReactor`` in the generated ``settings.py`` file. @@ -1661,14 +1661,14 @@ Scope: ``spidermiddlewares.urllength`` The maximum URL length to allow for crawled URLs. -This setting can act as a stopping condition in case of URLs of ever-increasing -length, which may be caused for example by a programming error either in the -target server or in your code. See also :setting:`REDIRECT_MAX_TIMES` and +This setting can act as a stopping condition in case of URLs of ever-increasing +length, which may be caused for example by a programming error either in the +target server or in your code. See also :setting:`REDIRECT_MAX_TIMES` and :setting:`DEPTH_LIMIT`. Use ``0`` to allow URLs of any length. -The default value is copied from the `Microsoft Internet Explorer maximum URL +The default value is copied from the `Microsoft Internet Explorer maximum URL length`_, even though this setting exists for different reasons. .. _Microsoft Internet Explorer maximum URL length: https://support.microsoft.com/en-us/topic/maximum-url-length-is-2-083-characters-in-internet-explorer-174e7c8a-6666-f4e0-6fd6-908b53c12246 diff --git a/docs/topics/spider-middleware.rst b/docs/topics/spider-middleware.rst index 816cb5e03..303401a3c 100644 --- a/docs/topics/spider-middleware.rst +++ b/docs/topics/spider-middleware.rst @@ -105,17 +105,17 @@ object gives you access, for example, to the :ref:`settings `. :class:`~scrapy.Request` objects and :ref:`item objects `. - .. versionchanged:: VERSION + .. versionchanged:: 2.7 This method may be defined as an :term:`asynchronous generator`, in which case ``result`` is an :term:`asynchronous iterable`. Consider defining this method as an :term:`asynchronous generator`, which will be a requirement in a future version of Scrapy. However, if you plan on sharing your spider middleware with other people, consider - either :ref:`enforcing Scrapy VERSION ` + either :ref:`enforcing Scrapy 2.7 ` as a minimum requirement of your spider middleware, or :ref:`making your spider middleware universal ` so that - it works with Scrapy versions earlier than Scrapy VERSION. + it works with Scrapy versions earlier than Scrapy 2.7. :param response: the response which generated this output from the spider @@ -130,7 +130,7 @@ object gives you access, for example, to the :ref:`settings `. .. method:: process_spider_output_async(response, result, spider) - .. versionadded:: VERSION + .. versionadded:: 2.7 If defined, this method must be an :term:`asynchronous generator`, which will be called instead of :meth:`process_spider_output` if diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index ff86af125..29ff028be 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -248,7 +248,7 @@ REFERER_ENABLED = True REFERRER_POLICY = 'scrapy.spidermiddlewares.referer.DefaultReferrerPolicy' REQUEST_FINGERPRINTER_CLASS = 'scrapy.utils.request.RequestFingerprinter' -REQUEST_FINGERPRINTER_IMPLEMENTATION = 'PREVIOUS_VERSION' +REQUEST_FINGERPRINTER_IMPLEMENTATION = '2.6' RETRY_ENABLED = True RETRY_TIMES = 2 # initial response + 2 retries = 3 requests diff --git a/scrapy/templates/project/module/settings.py.tmpl b/scrapy/templates/project/module/settings.py.tmpl index c0c34e986..bbf60982c 100644 --- a/scrapy/templates/project/module/settings.py.tmpl +++ b/scrapy/templates/project/module/settings.py.tmpl @@ -88,5 +88,5 @@ ROBOTSTXT_OBEY = True #HTTPCACHE_STORAGE = 'scrapy.extensions.httpcache.FilesystemCacheStorage' # Set settings whose default value is deprecated to a future-proof value -REQUEST_FINGERPRINTER_IMPLEMENTATION = 'VERSION' +REQUEST_FINGERPRINTER_IMPLEMENTATION = '2.7' TWISTED_REACTOR = 'twisted.internet.asyncioreactor.AsyncioSelectorReactor' diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index cf33317ce..fbddc41fb 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -236,10 +236,10 @@ class RequestFingerprinter: 'REQUEST_FINGERPRINTER_IMPLEMENTATION' ) else: - implementation = 'PREVIOUS_VERSION' - if implementation == 'PREVIOUS_VERSION': + implementation = '2.6' + if implementation == '2.6': message = ( - '\'PREVIOUS_VERSION\' is a deprecated value for the ' + '\'2.6\' is a deprecated value for the ' '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting.\n' '\n' 'It is also the default value. In other words, it is normal ' @@ -254,14 +254,14 @@ class RequestFingerprinter: ) warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) self._fingerprint = _request_fingerprint_as_bytes - elif implementation == 'VERSION': + elif implementation == '2.7': self._fingerprint = fingerprint else: raise ValueError( f'Got an invalid value on setting ' f'\'REQUEST_FINGERPRINTER_IMPLEMENTATION\': ' - f'{implementation!r}. Valid values are \'PREVIOUS_VERSION\' (deprecated) ' - f'and \'VERSION\'.' + f'{implementation!r}. Valid values are \'2.6\' (deprecated) ' + f'and \'2.7\'.' ) def fingerprint(self, request): diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 0b828f7c0..445cd2e3a 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -65,7 +65,7 @@ def get_crawler(spidercls=None, settings_dict=None, prevent_warnings=True): # Set by default settings that prevent deprecation warnings. settings = {} if prevent_warnings: - settings['REQUEST_FINGERPRINTER_IMPLEMENTATION'] = 'VERSION' + settings['REQUEST_FINGERPRINTER_IMPLEMENTATION'] = '2.7' settings.update(settings_dict or {}) runner = CrawlerRunner(settings) return runner.create_crawler(spidercls or Spider) diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 8be4b6fe1..5383ec652 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -350,7 +350,7 @@ with multiples lines @defer.inlineCallbacks def test_crawl_multiple(self): - runner = CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'}) + runner = CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'}) runner.crawl(SimpleSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) runner.crawl(SimpleSpider, self.mockserver.url("/status?n=503"), mockserver=self.mockserver) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index c61d461f7..da6024c2b 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -110,7 +110,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): 'LOG_LEVEL': 'INFO', 'LOG_FILE': log_file, # settings to avoid extra warnings - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, } @@ -235,7 +235,7 @@ class NoRequestsSpider(scrapy.Spider): class CrawlerRunnerHasSpider(unittest.TestCase): def _runner(self): - return CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'}) + return CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'}) @defer.inlineCallbacks def test_crawler_runner_bootstrap_successful(self): @@ -283,14 +283,14 @@ class CrawlerRunnerHasSpider(unittest.TestCase): if self.reactor_pytest == 'asyncio': CrawlerRunner(settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "REQUEST_FINGERPRINTER_IMPLEMENTATION": "VERSION", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", }) else: msg = r"The installed reactor \(.*?\) does not match the requested one \(.*?\)" with self.assertRaisesRegex(Exception, msg): runner = CrawlerRunner(settings={ "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "REQUEST_FINGERPRINTER_IMPLEMENTATION": "VERSION", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", }) yield runner.crawl(NoRequestsSpider) diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index 8a37a8ebe..6ebb716b0 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -51,7 +51,7 @@ class RFPDupeFilterTest(unittest.TestCase): def test_df_from_crawler_scheduler(self): settings = {'DUPEFILTER_DEBUG': True, 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) @@ -60,7 +60,7 @@ class RFPDupeFilterTest(unittest.TestCase): def test_df_from_settings_scheduler(self): settings = {'DUPEFILTER_DEBUG': True, 'DUPEFILTER_CLASS': FromSettingsRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) @@ -68,7 +68,7 @@ class RFPDupeFilterTest(unittest.TestCase): def test_df_direct_scheduler(self): settings = {'DUPEFILTER_CLASS': DirectDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertEqual(scheduler.df.method, 'n/a') @@ -172,7 +172,7 @@ class RFPDupeFilterTest(unittest.TestCase): with LogCapture() as log: settings = {'DUPEFILTER_DEBUG': False, 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) @@ -199,7 +199,7 @@ class RFPDupeFilterTest(unittest.TestCase): with LogCapture() as log: settings = {'DUPEFILTER_DEBUG': True, 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) @@ -233,7 +233,7 @@ class RFPDupeFilterTest(unittest.TestCase): def test_log_debug_default_dupefilter(self): with LogCapture() as log: settings = {'DUPEFILTER_DEBUG': True, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION'} + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index e46532a1c..0e174cd34 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -64,7 +64,7 @@ class FileDownloadCrawlTestCase(TestCase): self.tmpmediastore = self.mktemp() os.mkdir(self.tmpmediastore) self.settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', 'ITEM_PIPELINES': {self.pipeline_class: 1}, self.store_setting_key: self.tmpmediastore, } diff --git a/tests/test_scheduler.py b/tests/test_scheduler.py index ac66056ba..50a7755c1 100644 --- a/tests/test_scheduler.py +++ b/tests/test_scheduler.py @@ -52,7 +52,7 @@ class MockCrawler(Crawler): SCHEDULER_PRIORITY_QUEUE=priority_queue_cls, JOBDIR=jobdir, DUPEFILTER_CLASS='scrapy.dupefilters.BaseDupeFilter', - REQUEST_FINGERPRINTER_IMPLEMENTATION='VERSION', + REQUEST_FINGERPRINTER_IMPLEMENTATION='2.7', ) super().__init__(Spider, settings) self.engine = MockEngine(downloader=MockDownloader()) diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 3719c7c9f..7a590f96c 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -98,7 +98,7 @@ class SpiderLoaderTest(unittest.TestCase): module = 'tests.test_spiderloader.test_spiders.spider1' runner = CrawlerRunner({ 'SPIDER_MODULES': [module], - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', }) self.assertRaisesRegex(KeyError, 'Spider not found', diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index 8bc7922b6..a92d9a0ac 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -505,7 +505,7 @@ class RequestFingerprinterTestCase(unittest.TestCase): def test_deprecated_implementation(self): settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'PREVIOUS_VERSION', + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.6', } with warnings.catch_warnings(record=True) as logged_warnings: crawler = get_crawler(settings_dict=settings) @@ -518,7 +518,7 @@ class RequestFingerprinterTestCase(unittest.TestCase): def test_recommended_implementation(self): settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', + 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', } with warnings.catch_warnings(record=True) as logged_warnings: crawler = get_crawler(settings_dict=settings) From 20b79a0f2e47800bf4648c7f890c8170fc8f5ede Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 17 Oct 2022 19:09:22 +0600 Subject: [PATCH 201/532] =?UTF-8?q?Bump=20version:=202.6.2=20=E2=86=92=202?= =?UTF-8?q?.7.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- docs/news.rst | 2 +- scrapy/VERSION | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 2e2f7949a..f88071685 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.6.2 +current_version = 2.7.0 commit = True tag = True tag_name = {new_version} diff --git a/docs/news.rst b/docs/news.rst index d8b9fcd1e..1ec183a1d 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,7 +5,7 @@ Release notes .. _release-2.7.0: -Scrapy 2.7.0 (to be released) +Scrapy 2.7.0 (2022-10-17) ----------------------------- Highlights: diff --git a/scrapy/VERSION b/scrapy/VERSION index 097a15a2a..24ba9a38d 100644 --- a/scrapy/VERSION +++ b/scrapy/VERSION @@ -1 +1 @@ -2.6.2 +2.7.0 From 40d9ca3bdd6fd50438295f91cff275fcac57e0fa Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Mon, 17 Oct 2022 17:40:10 -0400 Subject: [PATCH 202/532] use pathlib --- conftest.py | 2 +- docs/Makefile | 4 +- docs/conf.py | 9 +- docs/conftest.py | 9 +- docs/intro/tutorial.rst | 10 +- docs/topics/item-pipeline.rst | 4 +- docs/topics/media-pipeline.rst | 9 +- docs/utils/linkfix.py | 9 +- scrapy/commands/__init__.py | 4 +- scrapy/commands/genspider.py | 48 +++-- scrapy/commands/runspider.py | 21 +- scrapy/commands/startproject.py | 44 ++-- scrapy/core/downloader/handlers/file.py | 5 +- scrapy/core/scheduler.py | 19 +- scrapy/crawler.py | 8 +- scrapy/dupefilters.py | 4 +- scrapy/extensions/feedexport.py | 16 +- scrapy/extensions/httpcache.py | 48 +++-- scrapy/extensions/spiderstate.py | 12 +- scrapy/http/response/__init__.py | 4 +- scrapy/pipelines/files.py | 41 ++-- scrapy/settings/default_settings.py | 4 +- scrapy/spiders/__init__.py | 9 +- scrapy/squeues.py | 11 +- scrapy/utils/conf.py | 32 +-- scrapy/utils/job.py | 6 +- scrapy/utils/project.py | 29 +-- scrapy/utils/request.py | 2 +- scrapy/utils/template.py | 12 +- scrapy/utils/test.py | 5 +- setup.py | 5 +- tests/__init__.py | 17 +- tests/keys/__init__.py | 22 +- tests/mockserver.py | 7 +- tests/test_cmdline/__init__.py | 14 +- .../__init__.py | 4 +- tests/test_command_check.py | 9 +- tests/test_command_parse.py | 22 +- tests/test_command_shell.py | 6 +- tests/test_commands.py | 199 +++++++++--------- tests/test_crawler.py | 32 ++- tests/test_dependencies.py | 7 +- tests/test_downloader_handlers.py | 69 +++--- ...st_downloadermiddleware_httpcompression.py | 7 +- tests/test_dupefilters.py | 4 +- tests/test_engine.py | 6 +- tests/test_feedexport.py | 155 +++++++------- tests/test_http2_client_protocol.py | 15 +- tests/test_pipeline_crawl.py | 14 +- tests/test_pipeline_files.py | 3 +- tests/test_proxy_connect.py | 6 +- tests/test_spiderloader/__init__.py | 40 ++-- tests/test_spiderstate.py | 4 +- tests/test_utils_gz.py | 44 ++-- tests/test_utils_iterators.py | 7 - tests/test_utils_misc/__init__.py | 3 +- tests/test_utils_project.py | 17 +- tests/test_utils_response.py | 12 +- tests/test_utils_template.py | 22 +- tests/test_webclient.py | 19 +- 60 files changed, 595 insertions(+), 636 deletions(-) diff --git a/conftest.py b/conftest.py index d7fe80321..7c1da3556 100644 --- a/conftest.py +++ b/conftest.py @@ -21,7 +21,7 @@ collect_ignore = [ *_py_files("tests/CrawlerRunner"), ] -with open('tests/ignores.txt') as reader: +with Path('tests/ignores.txt').open() as reader: for line in reader: file_path = line.strip() if file_path and file_path[0] != '#': diff --git a/docs/Makefile b/docs/Makefile index 87d5d3047..596cb6cef 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -86,8 +86,8 @@ coverage: BUILDER = coverage coverage: build htmlview: html - $(PYTHON) -c "import webbrowser, os; webbrowser.open('file://' + \ - os.path.realpath('build/html/index.html'))" + $(PYTHON) -c "import webbrowser; from pathlib import Path; \ + webbrowser.open('file://' + Path('build/html/index.html').resolve())" clean: -rm -rf build/* diff --git a/docs/conf.py b/docs/conf.py index 3241295af..d2a77003e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -11,13 +11,12 @@ import sys from datetime import datetime -from os import path +from pathlib import Path # If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -sys.path.append(path.join(path.dirname(__file__), "_ext")) -sys.path.insert(0, path.dirname(path.dirname(__file__))) +# is relative to the documentation root, use Path.absolute to make it absolute. +sys.path.append(str(Path(__file__).parent / "_ext")) +sys.path.insert(0, str(Path(__file__).parent.parent)) # General configuration diff --git a/docs/conftest.py b/docs/conftest.py index a0636f8ac..24a72a4b6 100644 --- a/docs/conftest.py +++ b/docs/conftest.py @@ -1,5 +1,5 @@ -import os from doctest import ELLIPSIS, NORMALIZE_WHITESPACE +from pathlib import Path from scrapy.http.response.html import HtmlResponse from sybil import Sybil @@ -12,10 +12,9 @@ from sybil.parsers.doctest import DocTestParser from sybil.parsers.skip import skip -def load_response(url, filename): - input_path = os.path.join(os.path.dirname(__file__), '_tests', filename) - with open(input_path, 'rb') as input_file: - return HtmlResponse(url, body=input_file.read()) +def load_response(url: str, filename: str) -> HtmlResponse: + input_path = Path(__file__).parent / '_tests' / filename + return HtmlResponse(url, body=input_path.read_bytes()) def setup(namespace): diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index 092123d1d..901a170b4 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -85,6 +85,8 @@ page content to extract data. This is the code for our first Spider. Save it in a file named ``quotes_spider.py`` under the ``tutorial/spiders`` directory in your project:: + from pathlib import Path + import scrapy @@ -102,8 +104,7 @@ This is the code for our first Spider. Save it in a file named def parse(self, response): page = response.url.split("/")[-2] filename = f'quotes-{page}.html' - with open(filename, 'wb') as f: - f.write(response.body) + Path(filename).write_bytes(response.body) self.log(f'Saved file {filename}') @@ -178,6 +179,8 @@ with a list of URLs. This list will then be used by the default implementation of :meth:`~scrapy.Spider.start_requests` to create the initial requests for your spider:: + from pathlib import Path + import scrapy @@ -191,8 +194,7 @@ for your spider:: def parse(self, response): page = response.url.split("/")[-2] filename = f'quotes-{page}.html' - with open(filename, 'wb') as f: - f.write(response.body) + Path(filename).write_bytes(response.body) The :meth:`~scrapy.Spider.parse` method will be called to handle each of the requests for those URLs, even though we haven't explicitly told Scrapy diff --git a/docs/topics/item-pipeline.rst b/docs/topics/item-pipeline.rst index af294f52c..1672ccbcc 100644 --- a/docs/topics/item-pipeline.rst +++ b/docs/topics/item-pipeline.rst @@ -186,6 +186,7 @@ item. :: import hashlib + from pathlib import Path from urllib.parse import quote import scrapy @@ -214,8 +215,7 @@ item. url = adapter["url"] url_hash = hashlib.md5(url.encode("utf8")).hexdigest() filename = f"{url_hash}.png" - with open(filename, "wb") as f: - f.write(response.body) + Path(filename).write_bytes(response.body) # Store filename in item. adapter["screenshot_filename"] = filename diff --git a/docs/topics/media-pipeline.rst b/docs/topics/media-pipeline.rst index 0925e6bb5..a528746b0 100644 --- a/docs/topics/media-pipeline.rst +++ b/docs/topics/media-pipeline.rst @@ -156,7 +156,6 @@ By overriding ``file_path`` like this: .. code-block:: python import hashlib - from os.path import splitext def file_path(self, request, response=None, info=None, *, item=None): image_url_hash = hashlib.shake_256(request.url.encode()).hexdigest(5) @@ -498,7 +497,7 @@ See here the methods that you can override in your custom Files Pipeline: approach to download all files into the ``files`` folder with their original filenames (e.g. ``files/foo.png``):: - import os + from pathlib import PurePosixPath from urllib.parse import urlparse from scrapy.pipelines.files import FilesPipeline @@ -506,7 +505,7 @@ See here the methods that you can override in your custom Files Pipeline: class MyFilesPipeline(FilesPipeline): def file_path(self, request, response=None, info=None, *, item=None): - return 'files/' + os.path.basename(urlparse(request.url).path) + return 'files/' + PurePosixPath(urlparse(request.url).path).name Similarly, you can use the ``item`` to determine the file path based on some item property. @@ -637,7 +636,7 @@ See here the methods that you can override in your custom Images Pipeline: approach to download all files into the ``files`` folder with their original filenames (e.g. ``files/foo.png``):: - import os + from pathlib import PurePosixPath from urllib.parse import urlparse from scrapy.pipelines.images import ImagesPipeline @@ -645,7 +644,7 @@ See here the methods that you can override in your custom Images Pipeline: class MyImagesPipeline(ImagesPipeline): def file_path(self, request, response=None, info=None, *, item=None): - return 'files/' + os.path.basename(urlparse(request.url).path) + return 'files/' + PurePosixPath(urlparse(request.url).path).name Similarly, you can use the ``item`` to determine the file path based on some item property. diff --git a/docs/utils/linkfix.py b/docs/utils/linkfix.py index 95a3f17d5..7a0c5288c 100755 --- a/docs/utils/linkfix.py +++ b/docs/utils/linkfix.py @@ -13,6 +13,7 @@ Author: dufferzafar """ import re +from pathlib import Path def main(): @@ -27,7 +28,7 @@ def main(): # Read lines from the linkcheck output file try: - with open("build/linkcheck/output.txt") as out: + with Path("build/linkcheck/output.txt").open() as out: output_lines = out.readlines() except IOError: print("linkcheck output not found; please run linkcheck first.") @@ -51,14 +52,12 @@ def main(): # Update the previous file if _filename: - with open(_filename, "w") as _file: - _file.write(_contents) + Path(_filename).write_text(_contents) _filename = newfilename # Read the new file to memory - with open(_filename) as _file: - _contents = _file.read() + _contents = Path(_filename).read_text() _contents = _contents.replace(match.group(3), match.group(4)) else: diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index fb304b8c0..8570d90bd 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -3,6 +3,7 @@ Base class for Scrapy commands """ import os import argparse +from pathlib import Path from typing import Any, Dict from twisted.python import failure @@ -93,8 +94,7 @@ class ScrapyCommand: self.settings.set('LOG_ENABLED', False, priority='cmdline') if opts.pidfile: - with open(opts.pidfile, "w") as f: - f.write(str(os.getpid()) + os.linesep) + Path(opts.pidfile).write_text(str(os.getpid()) + os.linesep) if opts.pdb: failure.startDebugMode() diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index ed5f588e9..01b4a0dbd 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -2,8 +2,9 @@ import os import shutil import string +from pathlib import Path from importlib import import_module -from os.path import join, dirname, abspath, exists, splitext +from typing import Optional from urllib.parse import urlparse import scrapy @@ -62,8 +63,7 @@ class Command(ScrapyCommand): if opts.dump: template_file = self._find_template(opts.dump) if template_file: - with open(template_file, "r") as f: - print(f.read()) + print(template_file.read_text()) return if len(args) != 2: raise UsageError() @@ -98,11 +98,11 @@ class Command(ScrapyCommand): } if self.settings.get('NEWSPIDER_MODULE'): spiders_module = import_module(self.settings['NEWSPIDER_MODULE']) - spiders_dir = abspath(dirname(spiders_module.__file__)) + spiders_dir = Path(spiders_module.__file__).parent.resolve() else: spiders_module = None - spiders_dir = "." - spider_file = f"{join(spiders_dir, module)}.py" + spiders_dir = Path(".") + spider_file = f"{spiders_dir / module}.py" shutil.copyfile(template_file, spider_file) render_templatefile(spider_file, **tvars) print(f"Created spider {name!r} using template {template_name!r} ", @@ -110,24 +110,25 @@ class Command(ScrapyCommand): if spiders_module: print(f"in module:\n {spiders_module.__name__}.{module}") - def _find_template(self, template): - template_file = join(self.templates_dir, f'{template}.tmpl') - if exists(template_file): + def _find_template(self, template: str) -> Optional[Path]: + template_file = Path(self.templates_dir, f'{template}.tmpl') + if template_file.exists(): return template_file print(f"Unable to find template: {template}\n") print('Use "scrapy genspider --list" to see all available templates.') def _list_templates(self): print("Available templates:") - for filename in sorted(os.listdir(self.templates_dir)): - if filename.endswith('.tmpl'): - print(f" {splitext(filename)[0]}") + for file in sorted(Path(self.templates_dir).iterdir()): + if file.suffix == '.tmpl': + print(f" {file.stem}") - def _spider_exists(self, name): + def _spider_exists(self, name: str) -> bool: if not self.settings.get('NEWSPIDER_MODULE'): # if run as a standalone command and file with same filename already exists - if exists(name + ".py"): - print(f"{abspath(name + '.py')} already exists") + path = Path(name + ".py") + if path.exists(): + print(f"{path.resolve()} already exists") return True return False @@ -143,17 +144,18 @@ class Command(ScrapyCommand): # a file with the same name exists in the target directory spiders_module = import_module(self.settings['NEWSPIDER_MODULE']) - spiders_dir = dirname(spiders_module.__file__) - spiders_dir_abs = abspath(spiders_dir) - if exists(join(spiders_dir_abs, name + ".py")): - print(f"{join(spiders_dir_abs, (name + '.py'))} already exists") + spiders_dir = Path(spiders_module.__file__).parent + spiders_dir_abs = spiders_dir.resolve() + path = spiders_dir_abs / (name + ".py") + if path.exists(): + print(f"{path} already exists") return True return False @property - def templates_dir(self): - return join( - self.settings['TEMPLATES_DIR'] or join(scrapy.__path__[0], 'templates'), + def templates_dir(self) -> str: + return str(Path( + self.settings['TEMPLATES_DIR'] or Path(scrapy.__path__[0], 'templates'), 'spiders' - ) + )) diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index b957c29fb..c41135508 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -1,22 +1,23 @@ import sys -import os +from os import PathLike +from pathlib import Path from importlib import import_module +from types import ModuleType from scrapy.utils.spider import iter_spider_classes from scrapy.exceptions import UsageError from scrapy.commands import BaseRunSpiderCommand -def _import_file(filepath): - abspath = os.path.abspath(filepath) - dirname, file = os.path.split(abspath) - fname, fext = os.path.splitext(file) - if fext not in ('.py', '.pyw'): +def _import_file(filepath: str | PathLike[str]) -> ModuleType: + abspath = Path(filepath).resolve() + dirname = str(abspath.parent) + if abspath.suffix not in ('.py', '.pyw'): raise ValueError(f"Not a Python source file: {abspath}") if dirname: sys.path = [dirname] + sys.path try: - module = import_module(fname) + module = import_module(abspath.stem) finally: if dirname: sys.path.pop(0) @@ -40,13 +41,13 @@ class Command(BaseRunSpiderCommand): def run(self, args, opts): if len(args) != 1: raise UsageError() - filename = args[0] - if not os.path.exists(filename): + filename = Path(args[0]) + if not filename.exists(): raise UsageError(f"File not found: {filename}\n") try: module = _import_file(filename) except (ImportError, ValueError) as e: - raise UsageError(f"Unable to load {filename!r}: {e}\n") + raise UsageError(f"Unable to load {str(filename)!r}: {e}\n") spclasses = list(iter_spider_classes(module)) if not spclasses: raise UsageError(f"No spider found in file: {filename}\n") diff --git a/scrapy/commands/startproject.py b/scrapy/commands/startproject.py index 1b6374c39..4323cdb53 100644 --- a/scrapy/commands/startproject.py +++ b/scrapy/commands/startproject.py @@ -2,7 +2,7 @@ import re import os import string from importlib.util import find_spec -from os.path import join, exists, abspath +from pathlib import Path from shutil import ignore_patterns, move, copy2, copystat from stat import S_IWUSR as OWNER_WRITE_PERMISSION @@ -54,7 +54,7 @@ class Command(ScrapyCommand): return True return False - def _copytree(self, src, dst): + def _copytree(self, src: Path, dst: Path): """ Since the original function always creates the directory, to resolve the issue a new function had to be created. It's a simple copy and @@ -64,19 +64,19 @@ class Command(ScrapyCommand): https://github.com/scrapy/scrapy/pull/2005 """ ignore = IGNORE - names = os.listdir(src) + names = [x.name for x in src.iterdir()] ignored_names = ignore(src, names) - if not os.path.exists(dst): - os.makedirs(dst) + if not dst.exists(): + dst.mkdir(parents=True) for name in names: if name in ignored_names: continue - srcname = os.path.join(src, name) - dstname = os.path.join(dst, name) - if os.path.isdir(srcname): + srcname = src / name + dstname = dst / name + if srcname.is_dir(): self._copytree(srcname, dstname) else: copy2(srcname, dstname) @@ -90,36 +90,36 @@ class Command(ScrapyCommand): raise UsageError() project_name = args[0] - project_dir = args[0] if len(args) == 2: - project_dir = args[1] + project_dir = Path(args[1]) + else: + project_dir = Path(args[0]) - if exists(join(project_dir, 'scrapy.cfg')): + if (project_dir / 'scrapy.cfg').exists(): self.exitcode = 1 - print(f'Error: scrapy.cfg already exists in {abspath(project_dir)}') + print(f'Error: scrapy.cfg already exists in {project_dir.resolve()}') return if not self._is_valid_name(project_name): self.exitcode = 1 return - self._copytree(self.templates_dir, abspath(project_dir)) - move(join(project_dir, 'module'), join(project_dir, project_name)) + self._copytree(Path(self.templates_dir), project_dir.resolve()) + move(project_dir / 'module', project_dir / project_name) for paths in TEMPLATES_TO_RENDER: - path = join(*paths) - tplfile = join(project_dir, string.Template(path).substitute(project_name=project_name)) - render_templatefile(tplfile, project_name=project_name, ProjectName=string_camelcase(project_name)) + tplfile = Path(project_dir, *(string.Template(s).substitute(project_name=project_name) for s in paths)) + render_templatefile(str(tplfile), project_name=project_name, ProjectName=string_camelcase(project_name)) print(f"New Scrapy project '{project_name}', using template directory " f"'{self.templates_dir}', created in:") - print(f" {abspath(project_dir)}\n") + print(f" {project_dir.resolve()}\n") print("You can start your first spider with:") print(f" cd {project_dir}") print(" scrapy genspider example example.com") @property - def templates_dir(self): - return join( - self.settings['TEMPLATES_DIR'] or join(scrapy.__path__[0], 'templates'), + def templates_dir(self) -> str: + return str(Path( + self.settings['TEMPLATES_DIR'] or Path(scrapy.__path__[0], 'templates'), 'project' - ) + )) diff --git a/scrapy/core/downloader/handlers/file.py b/scrapy/core/downloader/handlers/file.py index 0d94e3df0..4824167da 100644 --- a/scrapy/core/downloader/handlers/file.py +++ b/scrapy/core/downloader/handlers/file.py @@ -1,3 +1,5 @@ +from pathlib import Path + from w3lib.url import file_uri_to_path from scrapy.responsetypes import responsetypes @@ -10,7 +12,6 @@ class FileDownloadHandler: @defers def download_request(self, request, spider): filepath = file_uri_to_path(request.url) - with open(filepath, 'rb') as fo: - body = fo.read() + body = Path(filepath).read_bytes() respcls = responsetypes.from_args(filename=filepath, body=body) return respcls(url=request.url, body=body) diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 5ba0fb63b..366449f51 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -1,8 +1,7 @@ import json import logging -import os from abc import abstractmethod -from os.path import exists, join +from pathlib import Path from typing import Optional, Type, TypeVar from twisted.internet.defer import Deferred @@ -324,19 +323,19 @@ class Scheduler(BaseScheduler): def _dqdir(self, jobdir: Optional[str]) -> Optional[str]: """ Return a folder name to keep disk queue state at """ if jobdir is not None: - dqdir = join(jobdir, 'requests.queue') - if not exists(dqdir): - os.makedirs(dqdir) - return dqdir + dqdir = Path(jobdir, 'requests.queue') + if not dqdir.exists(): + dqdir.mkdir(parents=True) + return str(dqdir) return None def _read_dqs_state(self, dqdir: str) -> list: - path = join(dqdir, 'active.json') - if not exists(path): + path = Path(dqdir, 'active.json') + if not path.exists(): return [] - with open(path) as f: + with path.open() as f: return json.load(f) def _write_dqs_state(self, dqdir: str, state: list) -> None: - with open(join(dqdir, 'active.json'), 'w') as f: + with Path(dqdir, 'active.json').open('w') as f: json.dump(state, f) diff --git a/scrapy/crawler.py b/scrapy/crawler.py index e768bca12..b7108cdcc 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -1,7 +1,10 @@ +from __future__ import annotations + import logging import pprint import signal import warnings +from typing import TYPE_CHECKING from twisted.internet import defer from zope.interface.exceptions import DoesNotImplement @@ -33,6 +36,9 @@ from scrapy.utils.misc import create_instance, load_object from scrapy.utils.ossignal import install_shutdown_handlers, signal_names from scrapy.utils.reactor import install_reactor, verify_installed_reactor +if TYPE_CHECKING: + from scrapy.utils.request import RequestFingerprinter + logger = logging.getLogger(__name__) @@ -72,7 +78,7 @@ class Crawler: lf_cls = load_object(self.settings['LOG_FORMATTER']) self.logformatter = lf_cls.from_crawler(self) - self.request_fingerprinter = create_instance( + self.request_fingerprinter: RequestFingerprinter = create_instance( load_object(self.settings['REQUEST_FINGERPRINTER_CLASS']), settings=self.settings, crawler=self, diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index d1b0559ef..2b8b09614 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -1,5 +1,5 @@ import logging -import os +from pathlib import Path from typing import Optional, Set, Type, TypeVar from warnings import warn @@ -55,7 +55,7 @@ class RFPDupeFilter(BaseDupeFilter): self.debug = debug self.logger = logging.getLogger(__name__) if path: - self.file = open(os.path.join(path, 'requests.seen'), 'a+') + self.file = Path(path, 'requests.seen').open('a+') self.file.seek(0) self.fingerprints.update(x.rstrip() for x in self.file) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index e7097b7a1..0aa27e417 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -5,13 +5,13 @@ See documentation in docs/topics/feed-exports.rst """ import logging -import os import re import sys import warnings from datetime import datetime +from pathlib import Path from tempfile import NamedTemporaryFile -from typing import Any, Callable, Optional, Tuple, Union +from typing import IO, Any, Callable, Optional, Tuple, Union from urllib.parse import unquote, urlparse from twisted.internet import defer, threads @@ -101,7 +101,7 @@ class BlockingFeedStorage: def open(self, spider): path = spider.crawler.settings['FEED_TEMPDIR'] - if path and not os.path.isdir(path): + if path and not Path(path).is_dir(): raise OSError('Not a Directory: ' + str(path)) return NamedTemporaryFile(prefix='feed-', dir=path) @@ -141,11 +141,11 @@ class FileFeedStorage: feed_options = feed_options or {} self.write_mode = 'wb' if feed_options.get('overwrite', False) else 'ab' - def open(self, spider): - dirname = os.path.dirname(self.path) - if dirname and not os.path.exists(dirname): - os.makedirs(dirname) - return open(self.path, self.write_mode) + def open(self, spider) -> IO[Any]: + dirname = Path(self.path).parent + if dirname and not dirname.exists(): + dirname.mkdir(parents=True) + return Path(self.path).open(self.write_mode) def store(self, file): file.close() diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 843e14812..3057bf157 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -1,16 +1,18 @@ import gzip import logging -import os import pickle from email.utils import mktime_tz, parsedate_tz from importlib import import_module +from pathlib import Path from time import time from weakref import WeakKeyDictionary from w3lib.http import headers_raw_to_dict, headers_dict_to_raw from scrapy.http import Headers, Response +from scrapy.http.request import Request from scrapy.responsetypes import responsetypes +from scrapy.spiders import Spider from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.project import data_path from scrapy.utils.python import to_bytes, to_unicode @@ -221,9 +223,9 @@ class DbmCacheStorage: self.dbmodule = import_module(settings['HTTPCACHE_DBM_MODULE']) self.db = None - def open_spider(self, spider): - dbpath = os.path.join(self.cachedir, f'{spider.name}.db') - self.db = self.dbmodule.open(dbpath, 'c') + def open_spider(self, spider: Spider): + dbpath = Path(self.cachedir, f'{spider.name}.db') + self.db = self.dbmodule.open(str(dbpath), 'c') logger.debug("Using DBM cache storage in %(cachepath)s", {'cachepath': dbpath}, extra={'spider': spider}) @@ -277,7 +279,7 @@ class FilesystemCacheStorage: self.use_gzip = settings.getbool('HTTPCACHE_GZIP') self._open = gzip.open if self.use_gzip else open - def open_spider(self, spider): + def open_spider(self, spider: Spider): logger.debug("Using filesystem cache storage in %(cachedir)s", {'cachedir': self.cachedir}, extra={'spider': spider}) @@ -286,15 +288,15 @@ class FilesystemCacheStorage: def close_spider(self, spider): pass - def retrieve_response(self, spider, request): + def retrieve_response(self, spider: Spider, request: Request): """Return response if present in cache, or None otherwise.""" metadata = self._read_meta(spider, request) if metadata is None: return # not cached rpath = self._get_request_path(spider, request) - with self._open(os.path.join(rpath, 'response_body'), 'rb') as f: + with self._open(rpath / 'response_body', 'rb') as f: body = f.read() - with self._open(os.path.join(rpath, 'response_headers'), 'rb') as f: + with self._open(rpath / 'response_headers', 'rb') as f: rawheaders = f.read() url = metadata.get('response_url') status = metadata['status'] @@ -303,11 +305,11 @@ class FilesystemCacheStorage: response = respcls(url=url, headers=headers, status=status, body=body) return response - def store_response(self, spider, request, response): + def store_response(self, spider: Spider, request: Request, response): """Store the given response in the cache.""" rpath = self._get_request_path(spider, request) - if not os.path.exists(rpath): - os.makedirs(rpath) + if not rpath.exists(): + rpath.mkdir(parents=True) metadata = { 'url': request.url, 'method': request.method, @@ -315,29 +317,29 @@ class FilesystemCacheStorage: 'response_url': response.url, 'timestamp': time(), } - with self._open(os.path.join(rpath, 'meta'), 'wb') as f: + with self._open(rpath / 'meta', 'wb') as f: f.write(to_bytes(repr(metadata))) - with self._open(os.path.join(rpath, 'pickled_meta'), 'wb') as f: + with self._open(rpath / 'pickled_meta', 'wb') as f: pickle.dump(metadata, f, protocol=4) - with self._open(os.path.join(rpath, 'response_headers'), 'wb') as f: + with self._open(rpath / 'response_headers', 'wb') as f: f.write(headers_dict_to_raw(response.headers)) - with self._open(os.path.join(rpath, 'response_body'), 'wb') as f: + with self._open(rpath / 'response_body', 'wb') as f: f.write(response.body) - with self._open(os.path.join(rpath, 'request_headers'), 'wb') as f: + with self._open(rpath / 'request_headers', 'wb') as f: f.write(headers_dict_to_raw(request.headers)) - with self._open(os.path.join(rpath, 'request_body'), 'wb') as f: + with self._open(rpath / 'request_body', 'wb') as f: f.write(request.body) - def _get_request_path(self, spider, request): + def _get_request_path(self, spider: Spider, request: Request) -> Path: key = self._fingerprinter.fingerprint(request).hex() - return os.path.join(self.cachedir, spider.name, key[0:2], key) + return Path(self.cachedir, spider.name, key[0:2], key) - def _read_meta(self, spider, request): + def _read_meta(self, spider: Spider, request: Request): rpath = self._get_request_path(spider, request) - metapath = os.path.join(rpath, 'pickled_meta') - if not os.path.exists(metapath): + metapath = rpath / 'pickled_meta' + if not metapath.exists(): return # not found - mtime = os.stat(metapath).st_mtime + mtime = metapath.stat().st_mtime if 0 < self.expiration_secs < time() - mtime: return # expired with self._open(metapath, 'rb') as f: diff --git a/scrapy/extensions/spiderstate.py b/scrapy/extensions/spiderstate.py index bea00596e..e9c8b1d6a 100644 --- a/scrapy/extensions/spiderstate.py +++ b/scrapy/extensions/spiderstate.py @@ -1,5 +1,5 @@ -import os import pickle +from pathlib import Path from scrapy import signals from scrapy.exceptions import NotConfigured @@ -25,16 +25,16 @@ class SpiderState: def spider_closed(self, spider): if self.jobdir: - with open(self.statefn, 'wb') as f: + with Path(self.statefn).open('wb') as f: pickle.dump(spider.state, f, protocol=4) def spider_opened(self, spider): - if self.jobdir and os.path.exists(self.statefn): - with open(self.statefn, 'rb') as f: + if self.jobdir and Path(self.statefn).exists(): + with Path(self.statefn).open('rb') as f: spider.state = pickle.load(f) else: spider.state = {} @property - def statefn(self): - return os.path.join(self.jobdir, 'spider.state') + def statefn(self) -> str: + return str(Path(self.jobdir, 'spider.state')) diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index 4de6c9b5b..9359cc7c8 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -32,7 +32,7 @@ class Response(object_ref): def __init__( self, - url, + url: str, status=200, headers=None, body=b"", @@ -75,7 +75,7 @@ class Response(object_ref): def _get_url(self): return self._url - def _set_url(self, url): + def _set_url(self, url: str): if isinstance(url, str): self._url = url else: diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 906e7eb24..ffb12d910 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -13,6 +13,8 @@ from collections import defaultdict from contextlib import suppress from ftplib import FTP from io import BytesIO +from pathlib import Path +from typing import Optional from urllib.parse import urlparse from itemadapter import ItemAdapter @@ -39,41 +41,40 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir): + def __init__(self, basedir: str): if '://' in basedir: basedir = basedir.split('://', 1)[1] self.basedir = basedir - self._mkdir(self.basedir) - self.created_directories = defaultdict(set) + self._mkdir(Path(self.basedir)) + self.created_directories: defaultdict[str, set[str]] = defaultdict(set) - def persist_file(self, path, buf, info, meta=None, headers=None): + def persist_file(self, path: str, buf, info, meta=None, headers=None): absolute_path = self._get_filesystem_path(path) - self._mkdir(os.path.dirname(absolute_path), info) - with open(absolute_path, 'wb') as f: - f.write(buf.getvalue()) + self._mkdir(absolute_path.parent, info) + absolute_path.write_bytes(buf.getvalue()) - def stat_file(self, path, info): + def stat_file(self, path: str, info): absolute_path = self._get_filesystem_path(path) try: - last_modified = os.path.getmtime(absolute_path) + last_modified = absolute_path.stat().st_mtime except os.error: return {} - with open(absolute_path, 'rb') as f: + with absolute_path.open('rb') as f: checksum = md5sum(f) return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path): + def _get_filesystem_path(self, path: str) -> Path: path_comps = path.split('/') - return os.path.join(self.basedir, *path_comps) + return Path(self.basedir, *path_comps) - def _mkdir(self, dirname, domain=None): + def _mkdir(self, dirname: Path, domain: Optional[str] = None): seen = self.created_directories[domain] if domain else set() - if dirname not in seen: - if not os.path.exists(dirname): - os.makedirs(dirname) - seen.add(dirname) + if str(dirname) not in seen: + if not dirname.exists(): + dirname.mkdir(parents=True) + seen.add(str(dirname)) class S3FilesStore: @@ -374,8 +375,8 @@ class FilesPipeline(MediaPipeline): store_uri = settings['FILES_STORE'] return cls(store_uri, settings=settings) - def _get_store(self, uri): - if os.path.isabs(uri): # to support win32 paths like: C:\\some\dir + def _get_store(self, uri: str): + if Path(uri).is_absolute(): # to support win32 paths like: C:\\some\dir scheme = 'file' else: scheme = urlparse(uri).scheme @@ -510,7 +511,7 @@ class FilesPipeline(MediaPipeline): def file_path(self, request, response=None, info=None, *, item=None): media_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() - media_ext = os.path.splitext(request.url)[1] + media_ext = Path(request.url).suffix # Handles empty and wild extensions by trying to guess the # mime type then extension or default to empty string otherwise if media_ext not in mimetypes.types_map: diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index ff86af125..84e0a94d2 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -15,7 +15,7 @@ Scrapy developers, if you add a setting here remember to: import sys from importlib import import_module -from os.path import join, abspath, dirname +from pathlib import Path AJAXCRAWL_ENABLED = False @@ -288,7 +288,7 @@ STATS_DUMP = True STATSMAILER_RCPTS = [] -TEMPLATES_DIR = abspath(join(dirname(__file__), '..', 'templates')) +TEMPLATES_DIR = str((Path(__file__).parent / '..' / 'templates').resolve()) URLLENGTH_LIMIT = 2083 diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index d8248c606..9a97e7801 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -3,14 +3,19 @@ Base class for Scrapy spiders See documentation in docs/topics/spiders.rst """ +from __future__ import annotations + import logging -from typing import Optional +from typing import TYPE_CHECKING, Optional from scrapy import signals from scrapy.http import Request from scrapy.utils.trackref import object_ref from scrapy.utils.url import url_is_from_spider +if TYPE_CHECKING: + from scrapy.crawler import Crawler + class Spider(object_ref): """Base class for scrapy spiders. All spiders must inherit from this @@ -49,7 +54,7 @@ class Spider(object_ref): spider._set_crawler(crawler) return spider - def _set_crawler(self, crawler): + def _set_crawler(self, crawler: Crawler): self.crawler = crawler self.settings = crawler.settings crawler.signals.connect(self.close, signals.spider_closed) diff --git a/scrapy/squeues.py b/scrapy/squeues.py index dff9b1350..1f2dee55f 100644 --- a/scrapy/squeues.py +++ b/scrapy/squeues.py @@ -3,8 +3,9 @@ Scheduler queues """ import marshal -import os import pickle +from os import PathLike +from pathlib import Path from queuelib import queue @@ -16,10 +17,10 @@ def _with_mkdir(queue_class): class DirectoriesCreated(queue_class): - def __init__(self, path, *args, **kwargs): - dirname = os.path.dirname(path) - if not os.path.exists(dirname): - os.makedirs(dirname, exist_ok=True) + def __init__(self, path: str | PathLike[str], *args, **kwargs): + dirname = Path(path).parent + if not dirname.exists(): + dirname.mkdir(parents=True, exist_ok=True) super().__init__(path, *args, **kwargs) return DirectoriesCreated diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 00cc53725..e247f5999 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -4,6 +4,8 @@ import sys import warnings from configparser import ConfigParser from operator import itemgetter +from pathlib import Path +from typing import Optional from scrapy.exceptions import ScrapyDeprecationWarning, UsageError @@ -65,17 +67,17 @@ def arglist_to_dict(arglist): return dict(x.split('=', 1) for x in arglist) -def closest_scrapy_cfg(path='.', prevpath=None): +def closest_scrapy_cfg(path: str | os.PathLike[str] = '.', prevpath: Optional[str | os.PathLike] = None) -> str: """Return the path to the closest scrapy.cfg file by traversing the current directory and its parents """ - if path == prevpath: + if prevpath is not None and str(path) == str(prevpath): return '' - path = os.path.abspath(path) - cfgfile = os.path.join(path, 'scrapy.cfg') - if os.path.exists(cfgfile): - return cfgfile - return closest_scrapy_cfg(os.path.dirname(path), path) + path = Path(path).resolve() + cfgfile = path / 'scrapy.cfg' + if cfgfile.exists(): + return str(cfgfile) + return closest_scrapy_cfg(path.parent, path) def init_env(project='default', set_syspath=True): @@ -88,7 +90,7 @@ def init_env(project='default', set_syspath=True): os.environ['SCRAPY_SETTINGS_MODULE'] = cfg.get('settings', project) closest = closest_scrapy_cfg() if closest: - projdir = os.path.dirname(closest) + projdir = str(Path(closest).parent) if set_syspath and projdir not in sys.path: sys.path.append(projdir) @@ -101,13 +103,13 @@ def get_config(use_closest=True): return cfg -def get_sources(use_closest=True): - xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or os.path.expanduser('~/.config') +def get_sources(use_closest=True) -> list[str]: + xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or Path('~/.config').expanduser() sources = [ '/etc/scrapy.cfg', r'c:\scrapy\scrapy.cfg', - xdg_config_home + '/scrapy.cfg', - os.path.expanduser('~/.scrapy.cfg'), + str(Path(xdg_config_home) / 'scrapy.cfg'), + str(Path('~/.scrapy.cfg').expanduser()), ] if use_closest: sources.append(closest_scrapy_cfg()) @@ -129,8 +131,8 @@ def feed_complete_default_values_from_settings(feed, settings): return out -def feed_process_params_from_cli(settings, output, output_format=None, - overwrite_output=None): +def feed_process_params_from_cli(settings, output: list[str], output_format=None, + overwrite_output: Optional[list[str]] = None): """ Receives feed export params (from the 'crawl' or 'runspider' commands), checks for inconsistencies in their quantities and returns a dictionary @@ -180,7 +182,7 @@ def feed_process_params_from_cli(settings, output, output_format=None, feed_uri, feed_format = element.rsplit(':', 1) except ValueError: feed_uri = element - feed_format = os.path.splitext(element)[1].replace('.', '') + feed_format = Path(element).suffix.replace('.', '') else: if feed_uri == '-': feed_uri = 'stdout:' diff --git a/scrapy/utils/job.py b/scrapy/utils/job.py index c92ef36f5..a65f92e95 100644 --- a/scrapy/utils/job.py +++ b/scrapy/utils/job.py @@ -1,4 +1,4 @@ -import os +from pathlib import Path from typing import Optional from scrapy.settings import BaseSettings @@ -6,6 +6,6 @@ from scrapy.settings import BaseSettings def job_dir(settings: BaseSettings) -> Optional[str]: path = settings['JOBDIR'] - if path and not os.path.exists(path): - os.makedirs(path) + if path and not Path(path).exists(): + Path(path).mkdir(parents=True) return path diff --git a/scrapy/utils/project.py b/scrapy/utils/project.py index c66af497e..e54b71d45 100644 --- a/scrapy/utils/project.py +++ b/scrapy/utils/project.py @@ -2,7 +2,7 @@ import os import warnings from importlib import import_module -from os.path import join, dirname, abspath, isabs, exists +from pathlib import Path from scrapy.utils.conf import closest_scrapy_cfg, get_config, init_env from scrapy.settings import Settings @@ -25,36 +25,37 @@ def inside_project(): return bool(closest_scrapy_cfg()) -def project_data_dir(project='default'): +def project_data_dir(project='default') -> str: """Return the current project data dir, creating it if it doesn't exist""" if not inside_project(): raise NotConfigured("Not inside a project") cfg = get_config() if cfg.has_option(DATADIR_CFG_SECTION, project): - d = cfg.get(DATADIR_CFG_SECTION, project) + d = Path(cfg.get(DATADIR_CFG_SECTION, project)) else: scrapy_cfg = closest_scrapy_cfg() if not scrapy_cfg: raise NotConfigured("Unable to find scrapy.cfg file to infer project data dir") - d = abspath(join(dirname(scrapy_cfg), '.scrapy')) - if not exists(d): - os.makedirs(d) - return d + d = (Path(scrapy_cfg).parent / '.scrapy').resolve() + if not d.exists(): + d.mkdir(parents=True) + return str(d) -def data_path(path, createdir=False): +def data_path(path: str, createdir=False) -> str: """ Return the given path joined with the .scrapy data directory. If given an absolute path, return it unmodified. """ - if not isabs(path): + path_obj = Path(path) + if not path_obj.is_absolute(): if inside_project(): - path = join(project_data_dir(), path) + path_obj = Path(project_data_dir(), path) else: - path = join('.scrapy', path) - if createdir and not exists(path): - os.makedirs(path) - return path + path_obj = Path('.scrapy', path) + if createdir and not path_obj.exists(): + path_obj.mkdir(parents=True) + return str(path_obj) def get_project_settings(): diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index cf33317ce..545d489be 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -264,7 +264,7 @@ class RequestFingerprinter: f'and \'VERSION\'.' ) - def fingerprint(self, request): + def fingerprint(self, request: Request): return self._fingerprint(request) diff --git a/scrapy/utils/template.py b/scrapy/utils/template.py index f068be737..8075902b3 100644 --- a/scrapy/utils/template.py +++ b/scrapy/utils/template.py @@ -1,23 +1,21 @@ """Helper functions for working with templates""" -import os import re import string +from pathlib import Path -def render_templatefile(path, **kwargs): - with open(path, 'rb') as fp: - raw = fp.read().decode('utf8') +def render_templatefile(path: str, **kwargs): + raw = Path(path).read_text('utf8') content = string.Template(raw).substitute(**kwargs) render_path = path[:-len('.tmpl')] if path.endswith('.tmpl') else path if path.endswith('.tmpl'): - os.rename(path, render_path) + Path(path).rename(render_path) - with open(render_path, 'wb') as fp: - fp.write(content.encode('utf8')) + Path(render_path).write_text(content, 'utf8') CAMELCASE_INVALID_CHARS = re.compile(r'[^a-zA-Z\d]') diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 0b828f7c0..4d01f1ef1 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -4,6 +4,7 @@ This module contains some assorted functions used in tests import asyncio import os +from pathlib import Path from posixpath import split from unittest import mock @@ -71,11 +72,11 @@ def get_crawler(spidercls=None, settings_dict=None, prevent_warnings=True): return runner.create_crawler(spidercls or Spider) -def get_pythonpath(): +def get_pythonpath() -> str: """Return a PYTHONPATH suitable to use in processes so that they find this installation of Scrapy""" scrapy_path = import_module('scrapy').__path__[0] - return os.path.dirname(scrapy_path) + os.pathsep + os.environ.get('PYTHONPATH', '') + return str(Path(scrapy_path).parent) + os.pathsep + os.environ.get('PYTHONPATH', '') def get_testenv(): diff --git a/setup.py b/setup.py index a43cf08c8..e413ea6e4 100644 --- a/setup.py +++ b/setup.py @@ -1,10 +1,9 @@ -from os.path import dirname, join +from pathlib import Path from pkg_resources import parse_version from setuptools import setup, find_packages, __version__ as setuptools_version -with open(join(dirname(__file__), 'scrapy/VERSION'), 'rb') as f: - version = f.read().decode('ascii').strip() +version = (Path(__file__).parent / 'scrapy/VERSION').read_text('ascii').strip() def has_environment_marker_platform_impl_support(): diff --git a/tests/__init__.py b/tests/__init__.py index bb62851dc..be263fa16 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -6,6 +6,7 @@ see https://docs.scrapy.org/en/latest/contributing.html#running-tests import os import socket +from pathlib import Path # ignore system-wide proxies for tests # which would send requests to a totally unsuspecting server @@ -16,14 +17,12 @@ os.environ['ftp_proxy'] = '' # Absolutize paths to coverage config and output file because tests that # spawn subprocesses also changes current working directory. -_sourceroot = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) +_sourceroot = Path(__file__).resolve().parent.parent if 'COV_CORE_CONFIG' in os.environ: - os.environ['COVERAGE_FILE'] = os.path.join(_sourceroot, '.coverage') - os.environ['COV_CORE_CONFIG'] = os.path.join(_sourceroot, - os.environ['COV_CORE_CONFIG']) + os.environ['COVERAGE_FILE'] = str(_sourceroot / '.coverage') + os.environ['COV_CORE_CONFIG'] = str(_sourceroot / os.environ['COV_CORE_CONFIG']) -tests_datadir = os.path.join(os.path.abspath(os.path.dirname(__file__)), - 'sample_data') +tests_datadir = str(Path(__file__).parent.resolve() / 'sample_data') # In some environments accessing a non-existing host doesn't raise an @@ -35,8 +34,6 @@ except socket.gaierror: NON_EXISTING_RESOLVABLE = False -def get_testdata(*paths): +def get_testdata(*paths: str) -> bytes: """Return test data""" - path = os.path.join(tests_datadir, *paths) - with open(path, 'rb') as f: - return f.read() + return Path(tests_datadir, *paths).read_bytes() diff --git a/tests/keys/__init__.py b/tests/keys/__init__.py index bb4a8e5af..3a41b3a3e 100644 --- a/tests/keys/__init__.py +++ b/tests/keys/__init__.py @@ -1,5 +1,5 @@ -import os from datetime import datetime, timedelta +from pathlib import Path from cryptography.hazmat.backends import default_backend from cryptography.hazmat.primitives.asymmetric import rsa @@ -22,21 +22,20 @@ from cryptography.x509.oid import NameOID # https://cryptography.io/en/latest/x509/tutorial/#creating-a-self-signed-certificate def generate_keys(): - folder = os.path.dirname(__file__) + folder = Path(__file__).parent key = rsa.generate_private_key( public_exponent=65537, key_size=2048, backend=default_backend(), ) - with open(os.path.join(folder, 'localhost.key'), "wb") as f: - f.write( - key.private_bytes( - encoding=Encoding.PEM, - format=PrivateFormat.TraditionalOpenSSL, - encryption_algorithm=NoEncryption(), - ) - ) + (folder / 'localhost.key').write_bytes( + key.private_bytes( + encoding=Encoding.PEM, + format=PrivateFormat.TraditionalOpenSSL, + encryption_algorithm=NoEncryption(), + ), + ) subject = issuer = Name( [ @@ -59,5 +58,4 @@ def generate_keys(): ) .sign(key, SHA256(), default_backend()) ) - with open(os.path.join(folder, 'localhost.crt'), "wb") as f: - f.write(cert.public_bytes(Encoding.PEM)) + (folder / 'localhost.crt').write_bytes(cert.public_bytes(Encoding.PEM)) diff --git a/tests/mockserver.py b/tests/mockserver.py index 72d7e0241..7916798f7 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -1,6 +1,5 @@ import argparse import json -import os import random import sys from pathlib import Path @@ -253,7 +252,7 @@ class Root(resource.Resource): self.putChild(b"alpayload", ArbitraryLengthPayloadResource()) try: from tests import tests_datadir - self.putChild(b"files", File(os.path.join(tests_datadir, 'test_site/files/'))) + self.putChild(b"files", File(str(Path(tests_datadir, 'test_site/files/')))) except Exception: pass self.putChild(b"redirect-to", RedirectTo()) @@ -346,8 +345,8 @@ class MockFTPServer: def ssl_context_factory(keyfile='keys/localhost.key', certfile='keys/localhost.crt', cipher_string=None): factory = ssl.DefaultOpenSSLContextFactory( - os.path.join(os.path.dirname(__file__), keyfile), - os.path.join(os.path.dirname(__file__), certfile), + str(Path(__file__).parent / keyfile), + str(Path(__file__).parent / certfile), ) if cipher_string: ctx = factory.getContext() diff --git a/tests/test_cmdline/__init__.py b/tests/test_cmdline/__init__.py index 8233e0101..da73a4c45 100644 --- a/tests/test_cmdline/__init__.py +++ b/tests/test_cmdline/__init__.py @@ -1,11 +1,11 @@ import json -import os import pstats import shutil import sys import tempfile import unittest from io import StringIO +from pathlib import Path from subprocess import Popen, PIPE from scrapy.utils.test import get_testenv @@ -36,17 +36,17 @@ class CmdlineTest(unittest.TestCase): self.assertEqual(self._execute('settings', '--get', 'TEST1'), 'override') def test_profiling(self): - path = tempfile.mkdtemp() - filename = os.path.join(path, 'res.prof') + path = Path(tempfile.mkdtemp()) + filename = path / 'res.prof' try: - self._execute('version', '--profile', filename) - self.assertTrue(os.path.exists(filename)) + self._execute('version', '--profile', str(filename)) + self.assertTrue(filename.exists()) out = StringIO() - stats = pstats.Stats(filename, stream=out) + stats = pstats.Stats(str(filename), stream=out) stats.print_stats() out.seek(0) stats = out.read() - self.assertIn(os.path.join('scrapy', 'commands', 'version.py'), + self.assertIn(str(Path('scrapy', 'commands', 'version.py')), stats) self.assertIn('tottime', stats) finally: diff --git a/tests/test_cmdline_crawl_with_pipeline/__init__.py b/tests/test_cmdline_crawl_with_pipeline/__init__.py index d341888d3..fcafcef68 100644 --- a/tests/test_cmdline_crawl_with_pipeline/__init__.py +++ b/tests/test_cmdline_crawl_with_pipeline/__init__.py @@ -1,6 +1,6 @@ -import os import sys import unittest +from pathlib import Path from subprocess import Popen, PIPE @@ -8,7 +8,7 @@ class CmdlineCrawlPipelineTest(unittest.TestCase): def _execute(self, spname): args = (sys.executable, '-m', 'scrapy.cmdline', 'crawl', spname) - cwd = os.path.dirname(os.path.abspath(__file__)) + cwd = Path(__file__).resolve().parent proc = Popen(args, stdout=PIPE, stderr=PIPE, cwd=cwd) proc.communicate() return proc.returncode diff --git a/tests/test_command_check.py b/tests/test_command_check.py index c3d705194..4077a9bce 100644 --- a/tests/test_command_check.py +++ b/tests/test_command_check.py @@ -1,5 +1,3 @@ -from os.path import join, abspath - from tests.test_commands import CommandTest @@ -10,11 +8,10 @@ class CheckCommandTest(CommandTest): def setUp(self): super(CheckCommandTest, self).setUp() self.spider_name = 'check_spider' - self.spider = abspath(join(self.proj_mod_path, 'spiders', 'checkspider.py')) + self.spider = (self.proj_mod_path / 'spiders' / 'checkspider.py').resolve() def _write_contract(self, contracts, parse_def): - with open(self.spider, 'w') as file: - file.write(f""" + self.spider.write_text(f""" import scrapy class CheckSpider(scrapy.Spider): @@ -27,7 +24,7 @@ class CheckSpider(scrapy.Spider): {contracts} \"\"\" {parse_def} - """) + """) def _test_contract(self, contracts='', parse_def='pass'): self._write_contract(contracts, parse_def) diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 0d992be56..154287d74 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -1,6 +1,6 @@ import os import argparse -from os.path import join, abspath, isfile, exists +from pathlib import Path from twisted.internet import defer from scrapy.commands import parse @@ -23,9 +23,7 @@ class ParseCommandTest(ProcessTest, SiteTest, CommandTest): def setUp(self): super().setUp() self.spider_name = 'parse_spider' - fname = abspath(join(self.proj_mod_path, 'spiders', 'myspider.py')) - with open(fname, 'w') as f: - f.write(f""" + (self.proj_mod_path / 'spiders' / 'myspider.py').write_text(f""" import scrapy from scrapy.linkextractors import LinkExtractor from scrapy.spiders import CrawlSpider, Rule @@ -88,9 +86,7 @@ class MyBadCrawlSpider(CrawlSpider): return [scrapy.Item(), dict(foo='bar')] """) - fname = abspath(join(self.proj_mod_path, 'pipelines.py')) - with open(fname, 'w') as f: - f.write(""" + (self.proj_mod_path / 'pipelines.py').write_text(""" import logging class MyPipeline: @@ -101,8 +97,7 @@ class MyPipeline: return item """) - fname = abspath(join(self.proj_mod_path, 'settings.py')) - with open(fname, 'a') as f: + with (self.proj_mod_path / 'settings.py').open("a") as f: f.write(f""" ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} """) @@ -234,7 +229,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} correct format containing correct data in it. """ file_name = 'data.json' - file_path = join(self.proj_path, file_name) + file_path = Path(self.proj_path, file_name) yield self.execute([ '--spider', self.spider_name, '-c', 'parse', @@ -242,12 +237,11 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} self.url('/html') ]) - self.assertTrue(exists(file_path)) - self.assertTrue(isfile(file_path)) + self.assertTrue(file_path.exists()) + self.assertTrue(file_path.is_file()) content = '[\n{},\n{"foo": "bar"}\n]' - with open(file_path, 'r') as f: - self.assertEqual(f.read(), content) + self.assertEqual(file_path.read_text(), content) def test_parse_add_options(self): command = parse.Command() diff --git a/tests/test_command_shell.py b/tests/test_command_shell.py index 33189e9be..33c98ad69 100644 --- a/tests/test_command_shell.py +++ b/tests/test_command_shell.py @@ -1,4 +1,4 @@ -from os.path import join +from pathlib import Path from twisted.trial import unittest from twisted.internet import defer @@ -96,8 +96,8 @@ class ShellTest(ProcessTest, SiteTest, unittest.TestCase): @defer.inlineCallbacks def test_local_file(self): - filepath = join(tests_datadir, 'test_site', 'index.html') - _, out, _ = yield self.execute([filepath, '-c', 'item']) + filepath = Path(tests_datadir, 'test_site', 'index.html') + _, out, _ = yield self.execute([str(filepath), '-c', 'item']) assert b'{}' in out @defer.inlineCallbacks diff --git a/tests/test_commands.py b/tests/test_commands.py index 76d5f3935..39f718cce 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -9,12 +9,12 @@ import sys import tempfile from contextlib import contextmanager from itertools import chain -from os.path import exists, join, abspath, getmtime from pathlib import Path from shutil import rmtree, copytree from stat import S_IWRITE as ANYONE_WRITE_PERMISSION from tempfile import mkdtemp from threading import Timer +from typing import Generator, Optional from unittest import skipIf from pytest import mark @@ -66,8 +66,8 @@ class ProjectTest(unittest.TestCase): def setUp(self): self.temp_path = mkdtemp() self.cwd = self.temp_path - self.proj_path = join(self.temp_path, self.project_name) - self.proj_mod_path = join(self.proj_path, self.project_name) + self.proj_path = Path(self.temp_path, self.project_name) + self.proj_mod_path = self.proj_path / self.project_name self.env = get_testenv() def tearDown(self): @@ -104,10 +104,10 @@ class ProjectTest(unittest.TestCase): return p, to_unicode(stdout), to_unicode(stderr) - def find_in_file(self, filename, regex): + def find_in_file(self, filename: str | os.PathLike[str], regex) -> Optional[re.Match]: """Find first pattern occurrence in file""" pattern = re.compile(regex) - with open(filename, "r") as f: + with Path(filename).open("r") as f: for line in f: match = pattern.search(line) if match is not None: @@ -122,13 +122,13 @@ class StartprojectTest(ProjectTest): print(err, file=sys.stderr) self.assertEqual(p.returncode, 0) - assert exists(join(self.proj_path, 'scrapy.cfg')) - assert exists(join(self.proj_path, 'testproject')) - assert exists(join(self.proj_mod_path, '__init__.py')) - assert exists(join(self.proj_mod_path, 'items.py')) - assert exists(join(self.proj_mod_path, 'pipelines.py')) - assert exists(join(self.proj_mod_path, 'settings.py')) - assert exists(join(self.proj_mod_path, 'spiders', '__init__.py')) + assert Path(self.proj_path, 'scrapy.cfg').exists() + assert Path(self.proj_path, 'testproject').exists() + assert Path(self.proj_mod_path, '__init__.py').exists() + assert Path(self.proj_mod_path, 'items.py').exists() + assert Path(self.proj_mod_path, 'pipelines.py').exists() + assert Path(self.proj_mod_path, 'settings.py').exists() + assert Path(self.proj_mod_path, 'spiders', '__init__.py').exists() self.assertEqual(1, self.call('startproject', self.project_name)) self.assertEqual(1, self.call('startproject', 'wrong---project---name')) @@ -138,13 +138,13 @@ class StartprojectTest(ProjectTest): project_dir = mkdtemp() self.assertEqual(0, self.call('startproject', self.project_name, project_dir)) - assert exists(join(abspath(project_dir), 'scrapy.cfg')) - assert exists(join(abspath(project_dir), 'testproject')) - assert exists(join(join(abspath(project_dir), self.project_name), '__init__.py')) - assert exists(join(join(abspath(project_dir), self.project_name), 'items.py')) - assert exists(join(join(abspath(project_dir), self.project_name), 'pipelines.py')) - assert exists(join(join(abspath(project_dir), self.project_name), 'settings.py')) - assert exists(join(join(abspath(project_dir), self.project_name), 'spiders', '__init__.py')) + assert Path(project_dir, 'scrapy.cfg').exists() + assert Path(project_dir, 'testproject').exists() + assert Path(project_dir, self.project_name, '__init__.py').exists() + assert Path(project_dir, self.project_name, 'items.py').exists() + assert Path(project_dir, self.project_name, 'pipelines.py').exists() + assert Path(project_dir, self.project_name, 'settings.py').exists() + assert Path(project_dir, self.project_name, 'spiders', '__init__.py').exists() self.assertEqual(0, self.call('startproject', self.project_name, project_dir + '2')) @@ -158,40 +158,42 @@ class StartprojectTest(ProjectTest): def test_existing_project_dir(self): project_dir = mkdtemp() project_name = self.project_name + '_existing' - project_path = os.path.join(project_dir, project_name) - os.mkdir(project_path) + project_path = Path(project_dir, project_name) + project_path.mkdir() p, out, err = self.proc('startproject', project_name, cwd=project_dir) print(out) print(err, file=sys.stderr) self.assertEqual(p.returncode, 0) - assert exists(join(abspath(project_path), 'scrapy.cfg')) - assert exists(join(abspath(project_path), project_name)) - assert exists(join(join(abspath(project_path), project_name), '__init__.py')) - assert exists(join(join(abspath(project_path), project_name), 'items.py')) - assert exists(join(join(abspath(project_path), project_name), 'pipelines.py')) - assert exists(join(join(abspath(project_path), project_name), 'settings.py')) - assert exists(join(join(abspath(project_path), project_name), 'spiders', '__init__.py')) + assert Path(project_path, 'scrapy.cfg').exists() + assert Path(project_path, project_name).exists() + assert Path(project_path, project_name, '__init__.py').exists() + assert Path(project_path, project_name, 'items.py').exists() + assert Path(project_path, project_name, 'pipelines.py').exists() + assert Path(project_path, project_name, 'settings.py').exists() + assert Path(project_path, project_name, 'spiders', '__init__.py').exists() -def get_permissions_dict(path, renamings=None, ignore=None): +def get_permissions_dict(path: str | os.PathLike[str], renamings=None, ignore=None) -> dict[str, str]: - def get_permissions(path): - return oct(os.stat(path).st_mode) + def get_permissions(path: Path) -> str: + return oct(path.stat().st_mode) + + path_obj = Path(path) renamings = renamings or tuple() permissions_dict = { - '.': get_permissions(path), + '.': get_permissions(path_obj), } - for root, dirs, files in os.walk(path): + for root, dirs, files in os.walk(path_obj): nodes = list(chain(dirs, files)) if ignore: ignored_names = ignore(root, nodes) nodes = [node for node in nodes if node not in ignored_names] for node in nodes: - absolute_path = os.path.join(root, node) - relative_path = os.path.relpath(absolute_path, path) + absolute_path = Path(root, node) + relative_path = str(absolute_path.relative_to(path)) for search_string, replacement in renamings: relative_path = relative_path.replace( search_string, @@ -208,28 +210,27 @@ class StartprojectTemplatesTest(ProjectTest): def setUp(self): super().setUp() - self.tmpl = join(self.temp_path, 'templates') - self.tmpl_proj = join(self.tmpl, 'project') + self.tmpl = str(Path(self.temp_path, 'templates')) + self.tmpl_proj = str(Path(self.tmpl, 'project')) def test_startproject_template_override(self): - copytree(join(scrapy.__path__[0], 'templates'), self.tmpl) - with open(join(self.tmpl_proj, 'root_template'), 'w'): - pass - assert exists(join(self.tmpl_proj, 'root_template')) + copytree(Path(scrapy.__path__[0], 'templates'), self.tmpl) + Path(self.tmpl_proj, 'root_template').write_bytes(b"") + assert Path(self.tmpl_proj, 'root_template').exists() args = ['--set', f'TEMPLATES_DIR={self.tmpl}'] p, out, err = self.proc('startproject', self.project_name, *args) self.assertIn(f"New Scrapy project '{self.project_name}', " "using template directory", out) self.assertIn(self.tmpl_proj, out) - assert exists(join(self.proj_path, 'root_template')) + assert Path(self.proj_path, 'root_template').exists() def test_startproject_permissions_from_writable(self): """Check that generated files have the right permissions when the template folder has the same permissions as in the project, i.e. everything is writable.""" scrapy_path = scrapy.__path__[0] - project_template = os.path.join(scrapy_path, 'templates', 'project') + project_template = Path(scrapy_path, 'templates', 'project') project_name = 'startproject1' renamings = ( ('module', project_name), @@ -255,7 +256,7 @@ class StartprojectTemplatesTest(ProjectTest): ) process.wait() - project_dir = os.path.join(destination, project_name) + project_dir = Path(destination, project_name) actual_permissions = get_permissions_dict(project_dir) self.assertEqual(actual_permissions, expected_permissions) @@ -268,8 +269,8 @@ class StartprojectTemplatesTest(ProjectTest): See https://github.com/scrapy/scrapy/pull/4604 """ scrapy_path = scrapy.__path__[0] - templates_dir = os.path.join(scrapy_path, 'templates') - project_template = os.path.join(templates_dir, 'project') + templates_dir = Path(scrapy_path, 'templates') + project_template = Path(templates_dir, 'project') project_name = 'startproject2' renamings = ( ('module', project_name), @@ -281,16 +282,16 @@ class StartprojectTemplatesTest(ProjectTest): IGNORE, ) - def _make_read_only(path): - current_permissions = os.stat(path).st_mode - os.chmod(path, current_permissions & ~ANYONE_WRITE_PERMISSION) + def _make_read_only(path: Path): + current_permissions = path.stat().st_mode + path.chmod(current_permissions & ~ANYONE_WRITE_PERMISSION) read_only_templates_dir = str(Path(mkdtemp()) / 'templates') copytree(templates_dir, read_only_templates_dir) for root, dirs, files in os.walk(read_only_templates_dir): for node in chain(dirs, files): - _make_read_only(os.path.join(root, node)) + _make_read_only(Path(root, node)) destination = mkdtemp() process = subprocess.Popen( @@ -308,7 +309,7 @@ class StartprojectTemplatesTest(ProjectTest): ) process.wait() - project_dir = os.path.join(destination, project_name) + project_dir = Path(destination, project_name) actual_permissions = get_permissions_dict(project_dir) self.assertEqual(actual_permissions, expected_permissions) @@ -317,7 +318,7 @@ class StartprojectTemplatesTest(ProjectTest): """Check that pre-existing folders and files in the destination folder do not see their permissions modified.""" scrapy_path = scrapy.__path__[0] - project_template = os.path.join(scrapy_path, 'templates', 'project') + project_template = Path(scrapy_path, 'templates', 'project') project_name = 'startproject3' renamings = ( ('module', project_name), @@ -330,7 +331,7 @@ class StartprojectTemplatesTest(ProjectTest): ) destination = mkdtemp() - project_dir = os.path.join(destination, project_name) + project_dir = Path(destination, project_name) existing_nodes = { oct(permissions)[2:] + extension: permissions @@ -339,10 +340,9 @@ class StartprojectTemplatesTest(ProjectTest): 0o444, 0o555, 0o644, 0o666, 0o755, 0o777, ) } - os.mkdir(project_dir) - project_dir_path = Path(project_dir) + project_dir.mkdir() for node, permissions in existing_nodes.items(): - path = project_dir_path / node + path = project_dir / node if node.endswith('.d'): path.mkdir(mode=permissions) else: @@ -378,7 +378,7 @@ class StartprojectTemplatesTest(ProjectTest): os.umask(cur_mask) scrapy_path = scrapy.__path__[0] - project_template = os.path.join( + project_template = Path( scrapy_path, 'templates', 'project' @@ -409,7 +409,7 @@ class StartprojectTemplatesTest(ProjectTest): ) process.wait() - project_dir = os.path.join(destination, project_name) + project_dir = Path(destination, project_name) actual_permissions = get_permissions_dict(project_dir) self.assertEqual(actual_permissions, expected_permissions) @@ -420,7 +420,7 @@ class CommandTest(ProjectTest): def setUp(self): super().setUp() self.call('startproject', self.project_name) - self.cwd = join(self.temp_path, self.project_name) + self.cwd = Path(self.temp_path, self.project_name) self.env['SCRAPY_SETTINGS_MODULE'] = f'{self.project_name}.settings' @@ -429,10 +429,10 @@ class GenspiderCommandTest(CommandTest): def test_arguments(self): # only pass one argument. spider script shouldn't be created self.assertEqual(2, self.call('genspider', 'test_name')) - assert not exists(join(self.proj_mod_path, 'spiders', 'test_name.py')) + assert not Path(self.proj_mod_path, 'spiders', 'test_name.py').exists() # pass two arguments . spider script should be created self.assertEqual(0, self.call('genspider', 'test_name', 'test.com')) - assert exists(join(self.proj_mod_path, 'spiders', 'test_name.py')) + assert Path(self.proj_mod_path, 'spiders', 'test_name.py').exists() def test_template(self, tplname='crawl'): args = [f'--template={tplname}'] if tplname else [] @@ -440,11 +440,11 @@ class GenspiderCommandTest(CommandTest): spmodule = f"{self.project_name}.spiders.{spname}" p, out, err = self.proc('genspider', spname, 'test.com', *args) self.assertIn(f"Created spider {spname!r} using template {tplname!r} in module:{os.linesep} {spmodule}", out) - self.assertTrue(exists(join(self.proj_mod_path, 'spiders', 'test_spider.py'))) - modify_time_before = getmtime(join(self.proj_mod_path, 'spiders', 'test_spider.py')) + self.assertTrue(Path(self.proj_mod_path, 'spiders', 'test_spider.py').exists()) + modify_time_before = Path(self.proj_mod_path, 'spiders', 'test_spider.py').stat().st_mtime p, out, err = self.proc('genspider', spname, 'test.com', *args) self.assertIn(f"Spider {spname!r} already exists in module", out) - modify_time_after = getmtime(join(self.proj_mod_path, 'spiders', 'test_spider.py')) + modify_time_after = Path(self.proj_mod_path, 'spiders', 'test_spider.py').stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) def test_template_basic(self): @@ -465,37 +465,37 @@ class GenspiderCommandTest(CommandTest): def test_same_name_as_project(self): self.assertEqual(2, self.call('genspider', self.project_name)) - assert not exists(join(self.proj_mod_path, 'spiders', f'{self.project_name}.py')) + assert not Path(self.proj_mod_path, 'spiders', f'{self.project_name}.py').exists() def test_same_filename_as_existing_spider(self, force=False): file_name = 'example' - file_path = join(self.proj_mod_path, 'spiders', f'{file_name}.py') + file_path = Path(self.proj_mod_path, 'spiders', f'{file_name}.py') self.assertEqual(0, self.call('genspider', file_name, 'example.com')) - assert exists(file_path) + assert file_path.exists() # change name of spider but not its file name - with open(file_path, 'r+') as spider_file: + with file_path.open('r+') as spider_file: file_data = spider_file.read() file_data = file_data.replace("name = \'example\'", "name = \'renamed\'") spider_file.seek(0) spider_file.write(file_data) spider_file.truncate() - modify_time_before = getmtime(file_path) + modify_time_before = file_path.stat().st_mtime file_contents_before = file_data if force: p, out, err = self.proc('genspider', '--force', file_name, 'example.com') self.assertIn(f"Created spider {file_name!r} using template \'basic\' in module", out) - modify_time_after = getmtime(file_path) + modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) - file_contents_after = open(file_path, 'r').read() + file_contents_after = file_path.read_text() self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') self.assertIn(f"{file_path} already exists", out) - modify_time_after = getmtime(file_path) + modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) - file_contents_after = open(file_path, 'r').read() + file_contents_after = file_path.read_text() self.assertEqual(file_contents_after, file_contents_before) def test_same_filename_as_existing_spider_force(self): @@ -504,11 +504,11 @@ class GenspiderCommandTest(CommandTest): def test_url(self, url='test.com', domain="test.com"): self.assertEqual(0, self.call('genspider', '--force', 'test_name', url)) self.assertEqual(domain, - self.find_in_file(join(self.proj_mod_path, + self.find_in_file(Path(self.proj_mod_path, 'spiders', 'test_name.py'), r'allowed_domains\s*=\s*\[\'(.+)\'\]').group(1)) self.assertEqual(f'http://{domain}/', - self.find_in_file(join(self.proj_mod_path, + self.find_in_file(Path(self.proj_mod_path, 'spiders', 'test_name.py'), r'start_urls\s*=\s*\[\'(.+)\'\]').group(1)) @@ -526,31 +526,31 @@ class GenspiderStandaloneCommandTest(ProjectTest): def test_generate_standalone_spider(self): self.call('genspider', 'example', 'example.com') - assert exists(join(self.temp_path, 'example.py')) + assert Path(self.temp_path, 'example.py').exists() def test_same_name_as_existing_file(self, force=False): file_name = 'example' - file_path = join(self.temp_path, file_name + '.py') + file_path = Path(self.temp_path, file_name + '.py') p, out, err = self.proc('genspider', file_name, 'example.com') self.assertIn(f"Created spider {file_name!r} using template \'basic\' ", out) - assert exists(file_path) - modify_time_before = getmtime(file_path) - file_contents_before = open(file_path, 'r').read() + assert file_path.exists() + modify_time_before = file_path.stat().st_mtime + file_contents_before = file_path.read_text() if force: # use different template to ensure contents were changed p, out, err = self.proc('genspider', '--force', '-t', 'crawl', file_name, 'example.com') self.assertIn(f"Created spider {file_name!r} using template \'crawl\' ", out) - modify_time_after = getmtime(file_path) + modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) - file_contents_after = open(file_path, 'r').read() + file_contents_after = file_path.read_text() self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') - self.assertIn(f"{join(self.temp_path, file_name + '.py')} already exists", out) - modify_time_after = getmtime(file_path) + self.assertIn(f"{Path(self.temp_path, file_name + '.py')} already exists", out) + modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) - file_contents_after = open(file_path, 'r').read() + file_contents_after = file_path.read_text() self.assertEqual(file_contents_after, file_contents_before) def test_same_name_as_existing_file_force(self): @@ -588,17 +588,16 @@ class BadSpider(scrapy.Spider): """ @contextmanager - def _create_file(self, content, name=None): - tmpdir = self.mktemp() - os.mkdir(tmpdir) + def _create_file(self, content, name=None) -> Generator[str, None, None]: + tmpdir = Path(self.mktemp()) + tmpdir.mkdir() if name: - fname = abspath(join(tmpdir, name)) + fname = (tmpdir / name).resolve() else: - fname = abspath(join(tmpdir, self.spider_filename)) - with open(fname, 'w') as f: - f.write(content) + fname = (tmpdir / self.spider_filename).resolve() + fname.write_text(content) try: - yield fname + yield str(fname) finally: rmtree(tmpdir) @@ -747,12 +746,11 @@ class MySpider(scrapy.Spider): ) return [] """ - with open(os.path.join(self.cwd, "example.json"), "w") as f1: - f1.write("not empty") + Path(self.cwd, "example.json").write_text("not empty") args = ['-O', 'example.json'] log = self.get_log(spider_code, args=args) self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) - with open(os.path.join(self.cwd, "example.json")) as f2: + with Path(self.cwd, "example.json").open() as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") @@ -854,9 +852,7 @@ class ViewCommandTest(CommandTest): class CrawlCommandTest(CommandTest): def crawl(self, code, args=()): - fname = abspath(join(self.proj_mod_path, 'spiders', 'myspider.py')) - with open(fname, 'w') as f: - f.write(code) + Path(self.proj_mod_path, 'spiders', 'myspider.py').write_text(code) return self.proc('crawl', 'myspider', *args) def get_log(self, code, args=()): @@ -908,12 +904,11 @@ class MySpider(scrapy.Spider): ) return [] """ - with open(os.path.join(self.cwd, "example.json"), "w") as f1: - f1.write("not empty") + Path(self.cwd, "example.json").write_text("not empty") args = ['-O', 'example.json'] log = self.get_log(spider_code, args=args) self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) - with open(os.path.join(self.cwd, "example.json")) as f2: + with Path(self.cwd, "example.json").open() as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") diff --git a/tests/test_crawler.py b/tests/test_crawler.py index cf15ba9b9..19f4229a3 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -1,9 +1,9 @@ import logging -import os import platform import subprocess import sys import warnings +from pathlib import Path from pytest import raises, mark from twisted import version as twisted_version @@ -100,15 +100,14 @@ class CrawlerLoggingTestCase(unittest.TestCase): assert get_scrapy_root_handler() is None def test_spider_custom_settings_log_level(self): - log_file = self.mktemp() - with open(log_file, 'wb') as fo: - fo.write('previous message\n'.encode('utf-8')) + log_file = Path(self.mktemp()) + log_file.write_text('previous message\n', encoding='utf-8') class MySpider(scrapy.Spider): name = 'spider' custom_settings = { 'LOG_LEVEL': 'INFO', - 'LOG_FILE': log_file, + 'LOG_FILE': str(log_file), # settings to avoid extra warnings 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, @@ -124,8 +123,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): logging.warning('warning message') logging.error('error message') - with open(log_file, 'rb') as fo: - logged = fo.read().decode('utf-8') + logged = log_file.read_text(encoding='utf-8') self.assertIn('previous message', logged) self.assertNotIn('debug message', logged) @@ -139,14 +137,13 @@ class CrawlerLoggingTestCase(unittest.TestCase): self.assertEqual(crawler.stats.get_value('log_count/DEBUG', 0), 0) def test_spider_custom_settings_log_append(self): - log_file = self.mktemp() - with open(log_file, 'wb') as fo: - fo.write('previous message\n'.encode('utf-8')) + log_file = Path(self.mktemp()) + log_file.write_text('previous message\n', encoding='utf-8') class MySpider(scrapy.Spider): name = 'spider' custom_settings = { - 'LOG_FILE': log_file, + 'LOG_FILE': str(log_file), 'LOG_FILE_APPEND': False, # disable telnet if not available to avoid an extra warning 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, @@ -156,8 +153,7 @@ class CrawlerLoggingTestCase(unittest.TestCase): get_crawler(MySpider) logging.debug('debug message') - with open(log_file, 'rb') as fo: - logged = fo.read().decode('utf-8') + logged = log_file.read_text(encoding='utf-8') self.assertNotIn('previous message', logged) self.assertIn('debug message', logged) @@ -296,9 +292,9 @@ class CrawlerRunnerHasSpider(unittest.TestCase): class ScriptRunnerMixin: - def run_script(self, script_name, *script_args): - script_path = os.path.join(self.script_dir, script_name) - args = [sys.executable, script_path] + list(script_args) + def run_script(self, script_name: str, *script_args): + script_path = self.script_dir / script_name + args = [sys.executable, str(script_path)] + list(script_args) p = subprocess.Popen(args, env=get_testenv(), stdout=subprocess.PIPE, stderr=subprocess.PIPE) stdout, stderr = p.communicate() @@ -306,7 +302,7 @@ class ScriptRunnerMixin: class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): - script_dir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'CrawlerProcess') + script_dir = Path(__file__).parent.resolve() / 'CrawlerProcess' def test_simple(self): log = self.run_script('simple.py') @@ -463,7 +459,7 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): class CrawlerRunnerSubprocess(ScriptRunnerMixin, unittest.TestCase): - script_dir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'CrawlerRunner') + script_dir = Path(__file__).parent.resolve() / 'CrawlerRunner' def test_response_ip_address(self): log = self.run_script("ip_address.py") diff --git a/tests/test_dependencies.py b/tests/test_dependencies.py index 5e63ebffb..2558e4f91 100644 --- a/tests/test_dependencies.py +++ b/tests/test_dependencies.py @@ -2,6 +2,7 @@ import os import re from configparser import ConfigParser from importlib import import_module +from pathlib import Path from twisted import version as twisted_version from twisted.trial import unittest @@ -29,11 +30,7 @@ class ScrapyUtilsTest(unittest.TestCase): if not os.environ.get('_SCRAPY_PINNED', None): self.skipTest('Not in a pinned environment') - tox_config_file_path = os.path.join( - os.path.dirname(__file__), - '..', - 'tox.ini', - ) + tox_config_file_path = Path(__file__) / '..' / 'tox.ini' config_parser = ConfigParser() config_parser.read(tox_config_file_path) pattern = r'Twisted\[http2\]==([\d.]+)' diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 883960084..29ff8c2dc 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -3,6 +3,7 @@ import os import shutil import sys import tempfile +from pathlib import Path from typing import Optional, Type from unittest import mock, SkipTest @@ -10,7 +11,6 @@ from testfixtures import LogCapture from twisted.cred import checkers, credentials, portal from twisted.internet import defer, error, reactor from twisted.protocols.policies import WrappingFactory -from twisted.python.filepath import FilePath from twisted.trial import unittest from twisted.web import resource, server, static, util from twisted.web._newclient import ResponseFailed @@ -108,14 +108,13 @@ class LoadTestCase(unittest.TestCase): class FileTestCase(unittest.TestCase): def setUp(self): - self.tmpname = self.mktemp() - with open(self.tmpname + '^', 'w') as f: - f.write('0123456789') + self.tmpname = Path(self.mktemp() + '^') + Path(self.tmpname).write_text('0123456789') handler = create_instance(FileDownloadHandler, None, get_crawler()) self.download_request = handler.download_request def tearDown(self): - os.unlink(self.tmpname + '^') + self.tmpname.unlink() def test_download(self): def _test(response): @@ -124,7 +123,7 @@ class FileTestCase(unittest.TestCase): self.assertEqual(response.body, b'0123456789') self.assertEqual(response.protocol, None) - request = Request(path_to_file_uri(self.tmpname + '^')) + request = Request(path_to_file_uri(str(self.tmpname))) assert request.url.upper().endswith('%5E') return self.download_request(request, Spider('foo')).addCallback(_test) @@ -223,10 +222,10 @@ class HttpTestCase(unittest.TestCase): certfile = 'keys/localhost.crt' def setUp(self): - self.tmpname = self.mktemp() - os.mkdir(self.tmpname) - FilePath(self.tmpname).child("file").setContent(b"0123456789") - r = static.File(self.tmpname) + self.tmpname = Path(self.mktemp()) + self.tmpname.mkdir() + (self.tmpname / "file").write_bytes(b"0123456789") + r = static.File(str(self.tmpname)) r.putChild(b"redirect", util.Redirect(b"/file")) r.putChild(b"wait", ForeverTakingResource()) r.putChild(b"hang-after-headers", ForeverTakingResource(write=True)) @@ -626,10 +625,10 @@ class Https11CustomCiphers(unittest.TestCase): certfile = 'keys/localhost.crt' def setUp(self): - self.tmpname = self.mktemp() - os.mkdir(self.tmpname) - FilePath(self.tmpname).child("file").setContent(b"0123456789") - r = static.File(self.tmpname) + self.tmpname = Path(self.mktemp()) + self.tmpname.mkdir() + (self.tmpname / "file").write_bytes(b"0123456789") + r = static.File(str(self.tmpname)) self.site = server.Site(r, timeout=None) self.host = 'localhost' self.port = reactor.listenSSL( @@ -1002,16 +1001,15 @@ class BaseFTPTestCase(unittest.TestCase): from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler # setup dirs and test file - self.directory = self.mktemp() - os.mkdir(self.directory) - userdir = os.path.join(self.directory, self.username) - os.mkdir(userdir) - fp = FilePath(userdir) + self.directory = Path(self.mktemp()) + self.directory.mkdir() + userdir = self.directory / self.username + userdir.mkdir() for filename, content in self.test_files: - fp.child(filename).setContent(content) + (userdir / filename).write_bytes(content) # setup server - realm = FTPRealm(anonymousRoot=self.directory, userHome=self.directory) + realm = FTPRealm(anonymousRoot=str(self.directory), userHome=str(self.directory)) p = portal.Portal(realm) users_checker = checkers.InMemoryUsernamePasswordDatabaseDontUse() users_checker.addUser(self.username, self.password) @@ -1076,28 +1074,28 @@ class BaseFTPTestCase(unittest.TestCase): def test_ftp_local_filename(self): f, local_fname = tempfile.mkstemp() - local_fname = to_bytes(local_fname) + fname_bytes = to_bytes(local_fname) + local_fname = Path(local_fname) os.close(f) - meta = {"ftp_local_filename": local_fname} + meta = {"ftp_local_filename": fname_bytes} meta.update(self.req_meta) request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=meta) d = self.download_handler.download_request(request, None) def _test(r): - self.assertEqual(r.body, local_fname) - self.assertEqual(r.headers, {b'Local Filename': [local_fname], + self.assertEqual(r.body, fname_bytes) + self.assertEqual(r.headers, {b'Local Filename': [fname_bytes], b'Size': [b'17']}) - self.assertTrue(os.path.exists(local_fname)) - with open(local_fname, "rb") as f: - self.assertEqual(f.read(), b"I have the power!") - os.remove(local_fname) + self.assertTrue(local_fname.exists()) + self.assertEqual(local_fname.read_bytes(), b"I have the power!") + local_fname.unlink() return self._add_test_callbacks(d, _test) def _test_response_class(self, filename, response_class): f, local_fname = tempfile.mkstemp() - local_fname = to_bytes(local_fname) + local_fname = Path(local_fname) os.close(f) meta = {} meta.update(self.req_meta) @@ -1107,7 +1105,7 @@ class BaseFTPTestCase(unittest.TestCase): def _test(r): self.assertEqual(type(r), response_class) - os.remove(local_fname) + local_fname.unlink() return self._add_test_callbacks(d, _test) def test_response_class_from_url(self): @@ -1147,15 +1145,14 @@ class AnonymousFTPTestCase(BaseFTPTestCase): from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler # setup dir and test file - self.directory = self.mktemp() - os.mkdir(self.directory) + self.directory = Path(self.mktemp()) + self.directory.mkdir() - fp = FilePath(self.directory) for filename, content in self.test_files: - fp.child(filename).setContent(content) + (self.directory / filename).write_bytes(content) # setup server for anonymous access - realm = FTPRealm(anonymousRoot=self.directory) + realm = FTPRealm(anonymousRoot=str(self.directory)) p = portal.Portal(realm) p.registerChecker(checkers.AllowAnonymousAccess(), credentials.IAnonymous) diff --git a/tests/test_downloadermiddleware_httpcompression.py b/tests/test_downloadermiddleware_httpcompression.py index 40e9f3a96..6f4e217e6 100644 --- a/tests/test_downloadermiddleware_httpcompression.py +++ b/tests/test_downloadermiddleware_httpcompression.py @@ -1,6 +1,6 @@ from gzip import GzipFile from io import BytesIO -from os.path import join +from pathlib import Path from unittest import TestCase, SkipTest from warnings import catch_warnings @@ -15,7 +15,7 @@ from tests import tests_datadir from w3lib.encoding import resolve_encoding -SAMPLEDIR = join(tests_datadir, 'compressed') +SAMPLEDIR = Path(tests_datadir, 'compressed') FORMAT = { 'gzip': ('html-gzip.bin', 'gzip'), @@ -46,8 +46,7 @@ class HttpCompressionTest(TestCase): samplefile, contentencoding = FORMAT[coding] - with open(join(SAMPLEDIR, samplefile), 'rb') as sample: - body = sample.read() + body = (SAMPLEDIR / samplefile).read_bytes() headers = { 'Server': 'Yaws/1.49 Yet Another Web Server', diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index 8a37a8ebe..911d23069 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -2,8 +2,8 @@ import hashlib import tempfile import unittest import shutil -import os import sys +from pathlib import Path from testfixtures import LogCapture from scrapy.dupefilters import RFPDupeFilter @@ -157,7 +157,7 @@ class RFPDupeFilterTest(unittest.TestCase): df.request_seen(r1) df.close('finished') - with open(os.path.join(path, 'requests.seen'), 'rb') as seen_file: + with Path(path, 'requests.seen').open('rb') as seen_file: line = next(seen_file).decode() assert not line.endswith('\r\r\n') if sys.platform == 'win32': diff --git a/tests/test_engine.py b/tests/test_engine.py index 5677052f6..aa3313659 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -10,11 +10,11 @@ module with the ``runserver`` argument:: python test_engine.py runserver """ -import os import re import subprocess import sys from collections import defaultdict +from pathlib import Path from threading import Timer from urllib.parse import urlparse from dataclasses import dataclass @@ -127,8 +127,8 @@ class ChangeCloseReasonSpider(TestSpider): def start_test_site(debug=False): - root_dir = os.path.join(tests_datadir, "test_site") - r = static.File(root_dir) + root_dir = Path(tests_datadir, "test_site") + r = static.File(str(root_dir)) r.putChild(b"redirect", util.Redirect(b"/redirected")) r.putChild(b"redirected", static.Data(b"Redirected here", "text/plain")) numbers = [str(x).encode("utf8") for x in range(2**18)] diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index ad2383018..98905d2c0 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -3,7 +3,6 @@ import csv import gzip import json import lzma -import os import random import shutil import string @@ -15,6 +14,7 @@ from collections import defaultdict from contextlib import ExitStack from io import BytesIO from logging import getLogger +from os import PathLike from pathlib import Path from string import ascii_letters, digits from unittest import mock @@ -63,41 +63,41 @@ def printf_escape(string): return string.replace('%', '%%') -def build_url(path): - if path[0] != '/': - path = '/' + path - return urljoin('file:', path) +def build_url(path: str | PathLike[str]) -> str: + path_str = str(path) + if path_str[0] != '/': + path_str = '/' + path_str + return urljoin('file:', path_str) class FileFeedStorageTest(unittest.TestCase): def test_store_file_uri(self): - path = os.path.abspath(self.mktemp()) - uri = path_to_file_uri(path) + path = Path(self.mktemp()).resolve() + uri = path_to_file_uri(str(path)) return self._assert_stores(FileFeedStorage(uri), path) def test_store_file_uri_makedirs(self): - path = os.path.abspath(self.mktemp()) - path = os.path.join(path, 'more', 'paths', 'file.txt') - uri = path_to_file_uri(path) + path = Path(self.mktemp()).resolve() / 'more' / 'paths' / 'file.txt' + uri = path_to_file_uri(str(path)) return self._assert_stores(FileFeedStorage(uri), path) def test_store_direct_path(self): - path = os.path.abspath(self.mktemp()) - return self._assert_stores(FileFeedStorage(path), path) + path = Path(self.mktemp()).resolve() + return self._assert_stores(FileFeedStorage(str(path)), path) def test_store_direct_path_relative(self): - path = self.mktemp() - return self._assert_stores(FileFeedStorage(path), path) + path = Path(self.mktemp()) + return self._assert_stores(FileFeedStorage(str(path)), path) def test_interface(self): path = self.mktemp() st = FileFeedStorage(path) verifyObject(IFeedStorage, st) - def _store(self, feed_options=None): - path = os.path.abspath(self.mktemp()) - storage = FileFeedStorage(path, feed_options=feed_options) + def _store(self, feed_options=None) -> Path: + path = Path(self.mktemp()).resolve() + storage = FileFeedStorage(str(path), feed_options=feed_options) spider = scrapy.Spider("default") file = storage.open(spider) file.write(b"content") @@ -106,27 +106,26 @@ class FileFeedStorageTest(unittest.TestCase): def test_append(self): path = self._store() - return self._assert_stores(FileFeedStorage(path), path, b"contentcontent") + return self._assert_stores(FileFeedStorage(str(path)), path, b"contentcontent") def test_overwrite(self): path = self._store({"overwrite": True}) return self._assert_stores( - FileFeedStorage(path, feed_options={"overwrite": True}), + FileFeedStorage(str(path), feed_options={"overwrite": True}), path ) @defer.inlineCallbacks - def _assert_stores(self, storage, path, expected_content=b"content"): + def _assert_stores(self, storage, path: Path, expected_content=b"content"): spider = scrapy.Spider("default") file = storage.open(spider) file.write(b"content") yield storage.store(file) - self.assertTrue(os.path.exists(path)) + self.assertTrue(path.exists()) try: - with open(path, 'rb') as fp: - self.assertEqual(fp.read(), expected_content) + self.assertEqual(path.read_bytes(), expected_content) finally: - os.unlink(path) + path.unlink() class FTPFeedStorageTest(unittest.TestCase): @@ -152,13 +151,12 @@ class FTPFeedStorageTest(unittest.TestCase): file.write(content) return storage.store(file) - def _assert_stored(self, path, content): + def _assert_stored(self, path: Path, content): self.assertTrue(path.exists()) try: - with path.open('rb') as fp: - self.assertEqual(fp.read(), content) + self.assertEqual(path.read_bytes(), content) finally: - os.unlink(str(path)) + path.unlink() @defer.inlineCallbacks def test_append(self): @@ -221,24 +219,24 @@ class BlockingFeedStorageTest(unittest.TestCase): b = BlockingFeedStorage() tmp = b.open(self.get_test_spider()) - tmp_path = os.path.dirname(tmp.name) - self.assertEqual(tmp_path, tempfile.gettempdir()) + tmp_path = Path(tmp.name).parent + self.assertEqual(str(tmp_path), tempfile.gettempdir()) def test_temp_file(self): b = BlockingFeedStorage() - tests_path = os.path.dirname(os.path.abspath(__file__)) - spider = self.get_test_spider({'FEED_TEMPDIR': tests_path}) + tests_path = Path(__file__).resolve().parent + spider = self.get_test_spider({'FEED_TEMPDIR': str(tests_path)}) tmp = b.open(spider) - tmp_path = os.path.dirname(tmp.name) + tmp_path = Path(tmp.name).parent self.assertEqual(tmp_path, tests_path) def test_invalid_folder(self): b = BlockingFeedStorage() - tests_path = os.path.dirname(os.path.abspath(__file__)) - invalid_path = os.path.join(tests_path, 'invalid_path') - spider = self.get_test_spider({'FEED_TEMPDIR': invalid_path}) + tests_path = Path(__file__).resolve().parent + invalid_path = tests_path / 'invalid_path' + spider = self.get_test_spider({'FEED_TEMPDIR': str(invalid_path)}) self.assertRaises(OSError, b.open, spider=spider) @@ -564,13 +562,13 @@ class FromCrawlerFileFeedStorage(FileFeedStorage, FromCrawlerMixin): class DummyBlockingFeedStorage(BlockingFeedStorage): def __init__(self, uri, *args, feed_options=None): - self.path = file_uri_to_path(uri) + self.path = Path(file_uri_to_path(uri)) def _store_in_thread(self, file): - dirname = os.path.dirname(self.path) - if dirname and not os.path.exists(dirname): - os.makedirs(dirname) - with open(self.path, 'ab') as output_file: + dirname = self.path.parent + if dirname and not dirname.exists(): + dirname.mkdir(parents=True) + with self.path.open('ab') as output_file: output_file.write(file.read()) file.close() @@ -613,10 +611,10 @@ class FeedExportTestBase(ABC, unittest.TestCase): foo = scrapy.Field() hello = scrapy.Field() - def _random_temp_filename(self, inter_dir=''): + def _random_temp_filename(self, inter_dir='') -> Path: chars = [random.choice(ascii_letters + digits) for _ in range(15)] filename = ''.join(chars) - return os.path.join(self.temp_dir, inter_dir, filename) + return Path(self.temp_dir, inter_dir, filename) def setUp(self): self.temp_dir = tempfile.mkdtemp() @@ -702,18 +700,17 @@ class FeedExportTest(FeedExportTestBase): yield crawler.crawl() for file_path, feed_options in FEEDS.items(): - if not os.path.exists(str(file_path)): + if not Path(file_path).exists(): continue - with open(str(file_path), 'rb') as f: - content[feed_options['format']] = f.read() + content[feed_options['format']] = Path(file_path).read_bytes() finally: for file_path in FEEDS.keys(): - if not os.path.exists(str(file_path)): + if not Path(file_path).exists(): continue - os.remove(str(file_path)) + Path(file_path).unlink() return content @@ -808,7 +805,7 @@ class FeedExportTest(FeedExportTestBase): def test_stats_file_success(self): settings = { "FEEDS": { - printf_escape(path_to_url(self._random_temp_filename())): { + printf_escape(path_to_url(str(self._random_temp_filename()))): { "format": "json", } }, @@ -823,7 +820,7 @@ class FeedExportTest(FeedExportTestBase): def test_stats_file_failed(self): settings = { "FEEDS": { - printf_escape(path_to_url(self._random_temp_filename())): { + printf_escape(path_to_url(str(self._random_temp_filename()))): { "format": "json", } }, @@ -846,7 +843,7 @@ class FeedExportTest(FeedExportTestBase): 'AWS_ACCESS_KEY_ID': 'access_key', 'AWS_SECRET_ACCESS_KEY': 'secret_key', "FEEDS": { - printf_escape(path_to_url(self._random_temp_filename())): { + printf_escape(path_to_url(str(self._random_temp_filename()))): { "format": "json", }, "s3://bucket/key/foo.csv": { @@ -1427,12 +1424,11 @@ class FeedExportTest(FeedExportTestBase): self.assertTrue(FromCrawlerFileFeedStorage.init_with_crawler) @defer.inlineCallbacks - def test_pathlib_uri(self): - feed_path = Path(self._random_temp_filename()) + def test_str_uri(self): settings = { 'FEED_STORE_EMPTY': True, 'FEEDS': { - feed_path: {'format': 'csv'} + str(self._random_temp_filename()): {'format': 'csv'} }, } data = yield self.exported_no_data(settings) @@ -1538,8 +1534,8 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def close(self): self.file.close() - def _named_tempfile(self, name): - return os.path.join(self.temp_dir, name) + def _named_tempfile(self, name) -> str: + return str(Path(self.temp_dir, name)) @defer.inlineCallbacks def run_and_export(self, spider_cls, settings): @@ -1559,18 +1555,17 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): yield crawler.crawl() for file_path, feed_options in FEEDS.items(): - if not os.path.exists(str(file_path)): + if not Path(file_path).exists(): continue - with open(str(file_path), 'rb') as f: - content[str(file_path)] = f.read() + content[str(file_path)] = Path(file_path).read_bytes() finally: for file_path in FEEDS.keys(): - if not os.path.exists(str(file_path)): + if not Path(file_path).exists(): continue - os.remove(str(file_path)) + Path(file_path).unlink() return content @@ -2031,11 +2026,9 @@ class BatchDeliveriesTest(FeedExportTestBase): yield crawler.crawl() for path, feed in FEEDS.items(): - dir_name = os.path.dirname(path) - for file in sorted(os.listdir(dir_name)): - with open(os.path.join(dir_name, file), 'rb') as f: - data = f.read() - content[feed['format']].append(data) + dir_name = Path(path).parent + for file in sorted(dir_name.iterdir()): + content[feed['format']].append(file.read_bytes()) finally: self.tearDown() defer.returnValue(content) @@ -2045,7 +2038,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'jl', self._file_mark): {'format': 'jl'}, + self._random_temp_filename() / 'jl' / self._file_mark: {'format': 'jl'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2061,7 +2054,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'csv', self._file_mark): {'format': 'csv'}, + self._random_temp_filename() / 'csv' / self._file_mark: {'format': 'csv'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2077,7 +2070,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'xml', self._file_mark): {'format': 'xml'}, + self._random_temp_filename() / 'xml' / self._file_mark: {'format': 'xml'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2094,8 +2087,8 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'xml', self._file_mark): {'format': 'xml'}, - os.path.join(self._random_temp_filename(), 'json', self._file_mark): {'format': 'json'}, + self._random_temp_filename() / 'xml' / self._file_mark: {'format': 'xml'}, + self._random_temp_filename() / 'json' / self._file_mark: {'format': 'json'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2120,7 +2113,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'pickle', self._file_mark): {'format': 'pickle'}, + self._random_temp_filename() / 'pickle' / self._file_mark: {'format': 'pickle'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2137,7 +2130,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = settings or {} settings.update({ 'FEEDS': { - os.path.join(self._random_temp_filename(), 'marshal', self._file_mark): {'format': 'marshal'}, + self._random_temp_filename() / 'marshal' / self._file_mark: {'format': 'marshal'}, }, }) batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') @@ -2184,7 +2177,7 @@ class BatchDeliveriesTest(FeedExportTestBase): for fmt in ('json', 'jsonlines', 'xml', 'csv'): settings = { 'FEEDS': { - os.path.join(self._random_temp_filename(), fmt, self._file_mark): {'format': fmt}, + self._random_temp_filename() / fmt / self._file_mark: {'format': fmt}, }, 'FEED_EXPORT_BATCH_ITEM_COUNT': 1 } @@ -2204,7 +2197,7 @@ class BatchDeliveriesTest(FeedExportTestBase): for fmt, expctd in formats: settings = { 'FEEDS': { - os.path.join(self._random_temp_filename(), fmt, self._file_mark): {'format': fmt}, + self._random_temp_filename() / fmt / self._file_mark: {'format': fmt}, }, 'FEED_STORE_EMPTY': True, 'FEED_EXPORT_INDENT': None, @@ -2237,19 +2230,19 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = { 'FEEDS': { - os.path.join(self._random_temp_filename(), 'json', self._file_mark): { + self._random_temp_filename() / 'json' / self._file_mark: { 'format': 'json', 'indent': 0, 'fields': ['bar'], 'encoding': 'utf-8', }, - os.path.join(self._random_temp_filename(), 'xml', self._file_mark): { + self._random_temp_filename() / 'xml' / self._file_mark: { 'format': 'xml', 'indent': 2, 'fields': ['foo'], 'encoding': 'latin-1', }, - os.path.join(self._random_temp_filename(), 'csv', self._file_mark): { + self._random_temp_filename() / 'csv' / self._file_mark: { 'format': 'csv', 'indent': None, 'fields': ['foo', 'bar'], @@ -2272,7 +2265,7 @@ class BatchDeliveriesTest(FeedExportTestBase): } settings = { 'FEEDS': { - os.path.join(self._random_temp_filename(), 'json', self._file_mark): { + self._random_temp_filename() / 'json' / self._file_mark: { 'format': 'json', 'indent': None, 'encoding': 'utf-8', @@ -2299,7 +2292,7 @@ class BatchDeliveriesTest(FeedExportTestBase): ] settings = { 'FEEDS': { - os.path.join(self._random_temp_filename(), '%(batch_time)s'): { + self._random_temp_filename() / '%(batch_time)s': { 'format': 'json', }, }, @@ -2312,7 +2305,7 @@ class BatchDeliveriesTest(FeedExportTestBase): def test_stats_batch_file_success(self): settings = { "FEEDS": { - build_url(os.path.join(self._random_temp_filename(), "json", self._file_mark)): { + build_url(str(self._random_temp_filename() / "json" / self._file_mark)): { "format": "json", } }, diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index 49c83132f..402348cf9 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -1,10 +1,10 @@ import json -import os import random import re import shutil import string from ipaddress import IPv4Address +from pathlib import Path from unittest import mock, skipIf from urllib.parse import urlencode @@ -163,9 +163,8 @@ class RequestHeaders(LeafResource): return bytes(json.dumps(headers), 'utf-8') -def get_client_certificate(key_file, certificate_file) -> PrivateCertificate: - with open(key_file, 'r') as key, open(certificate_file, 'r') as certificate: - pem = ''.join(key.readlines()) + ''.join(certificate.readlines()) +def get_client_certificate(key_file: Path, certificate_file: Path) -> PrivateCertificate: + pem = key_file.read_text() + certificate_file.read_text() return PrivateCertificate.loadPEM(pem) @@ -173,12 +172,12 @@ def get_client_certificate(key_file, certificate_file) -> PrivateCertificate: @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") class Https2ClientProtocolTestCase(TestCase): scheme = 'https' - key_file = os.path.join(os.path.dirname(__file__), 'keys', 'localhost.key') - certificate_file = os.path.join(os.path.dirname(__file__), 'keys', 'localhost.crt') + key_file = Path(__file__).parent / 'keys' / 'localhost.key' + certificate_file = Path(__file__).parent / 'keys' / 'localhost.crt' def _init_resource(self): self.temp_directory = self.mktemp() - os.mkdir(self.temp_directory) + Path(self.temp_directory).mkdir() r = File(self.temp_directory) r.putChild(b'get-data-html-small', GetDataHtmlSmall()) r.putChild(b'get-data-html-large', GetDataHtmlLarge()) @@ -202,7 +201,7 @@ class Https2ClientProtocolTestCase(TestCase): # Start server for testing self.hostname = 'localhost' - context_factory = ssl_context_factory(self.key_file, self.certificate_file) + context_factory = ssl_context_factory(str(self.key_file), str(self.certificate_file)) server_endpoint = SSL4ServerEndpoint(reactor, 0, context_factory, interface=self.hostname) self.server = yield server_endpoint.listen(self.site) diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index e46532a1c..5d6547279 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -1,5 +1,5 @@ -import os import shutil +from pathlib import Path from testfixtures import LogCapture from twisted.internet import defer @@ -61,12 +61,12 @@ class FileDownloadCrawlTestCase(TestCase): self.mockserver.__enter__() # prepare a directory for storing files - self.tmpmediastore = self.mktemp() - os.mkdir(self.tmpmediastore) + self.tmpmediastore = Path(self.mktemp()) + self.tmpmediastore.mkdir() self.settings = { 'REQUEST_FINGERPRINTER_IMPLEMENTATION': 'VERSION', 'ITEM_PIPELINES': {self.pipeline_class: 1}, - self.store_setting_key: self.tmpmediastore, + self.store_setting_key: str(self.tmpmediastore), } self.runner = CrawlerRunner(self.settings) self.items = [] @@ -111,9 +111,7 @@ class FileDownloadCrawlTestCase(TestCase): # check that the image files where actually written to the media store for item in items: for i in item[self.media_key]: - self.assertTrue( - os.path.exists( - os.path.join(self.tmpmediastore, i['path']))) + self.assertTrue((self.tmpmediastore / i['path']).exists()) def _assert_files_download_failure(self, crawler, items, code, logs): @@ -133,7 +131,7 @@ class FileDownloadCrawlTestCase(TestCase): self.assertEqual(logs.count(file_dl_failure), 3) # check that no files were written to the media store - self.assertEqual(os.listdir(self.tmpmediastore), []) + self.assertEqual([x for x in self.tmpmediastore.iterdir()], []) @defer.inlineCallbacks def test_download_media(self): diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index d641e7a43..4acd29bf7 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -3,6 +3,7 @@ import random import time from datetime import datetime from io import BytesIO +from pathlib import Path from shutil import rmtree from tempfile import mkdtemp from unittest import mock @@ -89,7 +90,7 @@ class FilesPipelineTestCase(unittest.TestCase): self.assertEqual(self.pipeline.store.basedir, self.tempdir) path = 'some/image/key.jpg' - fullpath = os.path.join(self.tempdir, 'some', 'image', 'key.jpg') + fullpath = Path(self.tempdir, 'some', 'image', 'key.jpg') self.assertEqual(self.pipeline.store._get_filesystem_path(path), fullpath) @defer.inlineCallbacks diff --git a/tests/test_proxy_connect.py b/tests/test_proxy_connect.py index afdfb2578..ea7701b5d 100644 --- a/tests/test_proxy_connect.py +++ b/tests/test_proxy_connect.py @@ -2,6 +2,7 @@ import json import os import re import sys +from pathlib import Path from subprocess import Popen, PIPE from urllib.parse import urlsplit, urlunsplit from testfixtures import LogCapture @@ -27,14 +28,13 @@ from mitmproxy.tools.main import mitmdump sys.argv[0] = "mitmdump" sys.exit(mitmdump()) """ - cert_path = os.path.join(os.path.abspath(os.path.dirname(__file__)), - 'keys', 'mitmproxy-ca.pem') + cert_path = Path(__file__).parent.resolve() / 'keys' / 'mitmproxy-ca.pem' self.proc = Popen([sys.executable, '-c', script, '--listen-host', '127.0.0.1', '--listen-port', '0', '--proxyauth', f'{self.auth_user}:{self.auth_pass}', - '--certs', cert_path, + '--certs', str(cert_path), '--ssl-insecure', ], stdout=PIPE, env=get_testenv()) diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 3719c7c9f..b9025cc14 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -1,7 +1,7 @@ import sys -import os import shutil import warnings +from pathlib import Path from zope.interface.verify import verifyObject from twisted.trial import unittest @@ -17,10 +17,10 @@ from scrapy.settings import Settings from scrapy.http import Request from scrapy.crawler import CrawlerRunner -module_dir = os.path.dirname(os.path.abspath(__file__)) +module_dir = Path(__file__).resolve().parent -def _copytree(source, target): +def _copytree(source: Path, target: Path): try: shutil.copytree(source, target) except shutil.Error: @@ -30,18 +30,18 @@ def _copytree(source, target): class SpiderLoaderTest(unittest.TestCase): def setUp(self): - orig_spiders_dir = os.path.join(module_dir, 'test_spiders') - self.tmpdir = tempfile.mkdtemp() - self.spiders_dir = os.path.join(self.tmpdir, 'test_spiders_xxx') + orig_spiders_dir = module_dir / 'test_spiders' + self.tmpdir = Path(tempfile.mkdtemp()) + self.spiders_dir = self.tmpdir / 'test_spiders_xxx' _copytree(orig_spiders_dir, self.spiders_dir) - sys.path.append(self.tmpdir) + sys.path.append(str(self.tmpdir)) settings = Settings({'SPIDER_MODULES': ['test_spiders_xxx']}) self.spider_loader = SpiderLoader.from_settings(settings) def tearDown(self): del self.spider_loader del sys.modules['test_spiders_xxx'] - sys.path.remove(self.tmpdir) + sys.path.remove(str(self.tmpdir)) def test_interface(self): verifyObject(ISpiderLoader, self.spider_loader) @@ -135,22 +135,22 @@ class SpiderLoaderTest(unittest.TestCase): class DuplicateSpiderNameLoaderTest(unittest.TestCase): def setUp(self): - orig_spiders_dir = os.path.join(module_dir, 'test_spiders') - self.tmpdir = self.mktemp() - os.mkdir(self.tmpdir) - self.spiders_dir = os.path.join(self.tmpdir, 'test_spiders_xxx') + orig_spiders_dir = module_dir / 'test_spiders' + self.tmpdir = Path(self.mktemp()) + self.tmpdir.mkdir() + self.spiders_dir = self.tmpdir / 'test_spiders_xxx' _copytree(orig_spiders_dir, self.spiders_dir) - sys.path.append(self.tmpdir) + sys.path.append(str(self.tmpdir)) self.settings = Settings({'SPIDER_MODULES': ['test_spiders_xxx']}) def tearDown(self): del sys.modules['test_spiders_xxx'] - sys.path.remove(self.tmpdir) + sys.path.remove(str(self.tmpdir)) def test_dupename_warning(self): # copy 1 spider module so as to have duplicate spider name - shutil.copyfile(os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider3.py'), - os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider3dupe.py')) + shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider3.py', + self.tmpdir / 'test_spiders_xxx' / 'spider3dupe.py') with warnings.catch_warnings(record=True) as w: spider_loader = SpiderLoader.from_settings(self.settings) @@ -171,10 +171,10 @@ class DuplicateSpiderNameLoaderTest(unittest.TestCase): def test_multiple_dupename_warning(self): # copy 2 spider modules so as to have duplicate spider name # This should issue 2 warning, 1 for each duplicate spider name - shutil.copyfile(os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider1.py'), - os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider1dupe.py')) - shutil.copyfile(os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider2.py'), - os.path.join(self.tmpdir, 'test_spiders_xxx', 'spider2dupe.py')) + shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider1.py', + self.tmpdir / 'test_spiders_xxx' / 'spider1dupe.py') + shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider2.py', + self.tmpdir / 'test_spiders_xxx' / 'spider2dupe.py') with warnings.catch_warnings(record=True) as w: spider_loader = SpiderLoader.from_settings(self.settings) diff --git a/tests/test_spiderstate.py b/tests/test_spiderstate.py index 383fadfeb..ab215576e 100644 --- a/tests/test_spiderstate.py +++ b/tests/test_spiderstate.py @@ -1,5 +1,5 @@ -import os from datetime import datetime +from pathlib import Path import shutil from twisted.trial import unittest @@ -13,7 +13,7 @@ class SpiderStateTest(unittest.TestCase): def test_store_load(self): jobdir = self.mktemp() - os.mkdir(jobdir) + Path(jobdir).mkdir() try: spider = Spider(name='default') dt = datetime.now() diff --git a/tests/test_utils_gz.py b/tests/test_utils_gz.py index 4943731cb..ca98bff21 100644 --- a/tests/test_utils_gz.py +++ b/tests/test_utils_gz.py @@ -1,5 +1,5 @@ import unittest -from os.path import join +from pathlib import Path from w3lib.encoding import html_to_unicode @@ -8,46 +8,40 @@ from scrapy.http import Response from tests import tests_datadir -SAMPLEDIR = join(tests_datadir, 'compressed') +SAMPLEDIR = Path(tests_datadir, 'compressed') class GunzipTest(unittest.TestCase): def test_gunzip_basic(self): - with open(join(SAMPLEDIR, 'feed-sample1.xml.gz'), 'rb') as f: - r1 = Response("http://www.example.com", body=f.read()) - self.assertTrue(gzip_magic_number(r1)) + r1 = Response("http://www.example.com", body=(SAMPLEDIR / 'feed-sample1.xml.gz').read_bytes()) + self.assertTrue(gzip_magic_number(r1)) - r2 = Response("http://www.example.com", body=gunzip(r1.body)) - self.assertFalse(gzip_magic_number(r2)) - self.assertEqual(len(r2.body), 9950) + r2 = Response("http://www.example.com", body=gunzip(r1.body)) + self.assertFalse(gzip_magic_number(r2)) + self.assertEqual(len(r2.body), 9950) def test_gunzip_truncated(self): - with open(join(SAMPLEDIR, 'truncated-crc-error.gz'), 'rb') as f: - text = gunzip(f.read()) - assert text.endswith(b'') - self.assertFalse(gzip_magic_number(r2)) + r2 = Response("http://www.example.com", body=gunzip(r1.body)) + assert r2.body.endswith(b'') + self.assertFalse(gzip_magic_number(r2)) def test_is_gzipped_empty(self): r1 = Response("http://www.example.com") self.assertFalse(gzip_magic_number(r1)) def test_gunzip_illegal_eof(self): - with open(join(SAMPLEDIR, 'unexpected-eof.gz'), 'rb') as f: - text = html_to_unicode('charset=cp1252', gunzip(f.read()))[1] - with open(join(SAMPLEDIR, 'unexpected-eof-output.txt'), 'rb') as o: - expected_text = o.read().decode("utf-8") - self.assertEqual(len(text), len(expected_text)) - self.assertEqual(text, expected_text) + text = html_to_unicode('charset=cp1252', gunzip((SAMPLEDIR / 'unexpected-eof.gz').read_bytes()))[1] + expected_text = (SAMPLEDIR / 'unexpected-eof-output.txt').read_text(encoding="utf-8") + self.assertEqual(len(text), len(expected_text)) + self.assertEqual(text, expected_text) diff --git a/tests/test_utils_iterators.py b/tests/test_utils_iterators.py index f84cb2956..ba3136b96 100644 --- a/tests/test_utils_iterators.py +++ b/tests/test_utils_iterators.py @@ -1,5 +1,3 @@ -import os - from pytest import mark from twisted.trial import unittest @@ -303,11 +301,6 @@ class LxmlXmliterTestCase(XmliterTestCase): class UtilsCsvTestCase(unittest.TestCase): - sample_feeds_dir = os.path.join(os.path.abspath(os.path.dirname(__file__)), 'sample_data', 'feeds') - sample_feed_path = os.path.join(sample_feeds_dir, 'feed-sample3.csv') - sample_feed2_path = os.path.join(sample_feeds_dir, 'feed-sample4.csv') - sample_feed3_path = os.path.join(sample_feeds_dir, 'feed-sample5.csv') - def test_csviter_defaults(self): body = get_testdata('feeds', 'feed-sample3.csv') response = TextResponse(url="http://example.com/", body=body) diff --git a/tests/test_utils_misc/__init__.py b/tests/test_utils_misc/__init__.py index b83c1d6f0..dc5b9e123 100644 --- a/tests/test_utils_misc/__init__.py +++ b/tests/test_utils_misc/__init__.py @@ -1,6 +1,7 @@ import sys import os import unittest +from pathlib import Path from unittest import mock from scrapy.item import Item, Field @@ -55,7 +56,7 @@ class UtilsMiscTestCase(unittest.TestCase): self.assertRaises(ImportError, walk_modules, 'nomodule999') def test_walk_modules_egg(self): - egg = os.path.join(os.path.dirname(__file__), 'test.egg') + egg = str(Path(__file__).parent / 'test.egg') sys.path.append(egg) try: mods = walk_modules('testegg') diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index 46452415a..f35f039a9 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -4,6 +4,7 @@ import tempfile import shutil import contextlib import warnings +from pathlib import Path from pytest import warns @@ -18,9 +19,7 @@ def inside_a_project(): try: os.chdir(project_dir) - with open('scrapy.cfg', 'w') as f: - # create an empty scrapy.cfg - f.close() + Path('scrapy.cfg').touch() yield project_dir finally: @@ -31,20 +30,20 @@ def inside_a_project(): class ProjectUtilsTest(unittest.TestCase): def test_data_path_outside_project(self): self.assertEqual( - os.path.join('.scrapy', 'somepath'), + str(Path('.scrapy', 'somepath')), data_path('somepath') ) - abspath = os.path.join(os.path.sep, 'absolute', 'path') + abspath = str(Path(os.path.sep, 'absolute', 'path')) self.assertEqual(abspath, data_path(abspath)) def test_data_path_inside_project(self): with inside_a_project() as proj_path: - expected = os.path.join(proj_path, '.scrapy', 'somepath') + expected = Path(proj_path, '.scrapy', 'somepath') self.assertEqual( - os.path.realpath(expected), - os.path.realpath(data_path('somepath')) + expected.resolve(), + Path(data_path('somepath')).resolve() ) - abspath = os.path.join(os.path.sep, 'absolute', 'path') + abspath = str(Path(os.path.sep, 'absolute', 'path').resolve()) self.assertEqual(abspath, data_path(abspath)) diff --git a/tests/test_utils_response.py b/tests/test_utils_response.py index d20852e62..cdf972933 100644 --- a/tests/test_utils_response.py +++ b/tests/test_utils_response.py @@ -1,6 +1,6 @@ -import os import unittest import warnings +from pathlib import Path from urllib.parse import urlparse from scrapy.exceptions import ScrapyDeprecationWarning @@ -39,10 +39,9 @@ class ResponseUtilsTest(unittest.TestCase): def browser_open(burl): path = urlparse(burl).path - if not os.path.exists(path): + if not path or not Path(path).exists(): path = burl.replace('file://', '') - with open(path, "rb") as f: - bbody = f.read() + bbody = Path(path).read_bytes() self.assertIn(b'', bbody) return True response = HtmlResponse(url, body=body) @@ -98,10 +97,9 @@ class ResponseUtilsTest(unittest.TestCase): def check_base_url(burl): path = urlparse(burl).path - if not os.path.exists(path): + if not path or not Path(path).exists(): path = burl.replace('file://', '') - with open(path, "rb") as f: - bbody = f.read() + bbody = Path(path).read_bytes() self.assertEqual(bbody.count(b''), 1) return True diff --git a/tests/test_utils_template.py b/tests/test_utils_template.py index 1d5e63363..b1aca5ed3 100644 --- a/tests/test_utils_template.py +++ b/tests/test_utils_template.py @@ -1,4 +1,4 @@ -import os +from pathlib import Path from shutil import rmtree from tempfile import mkdtemp import unittest @@ -22,21 +22,19 @@ class UtilsRenderTemplateFileTestCase(unittest.TestCase): template = 'from ${project_name}.spiders.${name} import ${classname}' rendered = 'from proj.spiders.spi import TheSpider' - template_path = os.path.join(self.tmp_path, 'templ.py.tmpl') - render_path = os.path.join(self.tmp_path, 'templ.py') + template_path = Path(self.tmp_path, 'templ.py.tmpl') + render_path = Path(self.tmp_path, 'templ.py') - with open(template_path, 'wb') as tmpl_file: - tmpl_file.write(template.encode('utf8')) - assert os.path.isfile(template_path) # Failure of test itself + template_path.write_text(template, encoding='utf8') + assert template_path.is_file() # Failure of test itself - render_templatefile(template_path, **context) + render_templatefile(str(template_path), **context) - self.assertFalse(os.path.exists(template_path)) - with open(render_path, 'rb') as result: - self.assertEqual(result.read().decode('utf8'), rendered) + self.assertFalse(template_path.exists()) + self.assertEqual(render_path.read_text(encoding='utf8'), rendered) - os.remove(render_path) - assert not os.path.exists(render_path) # Failure of test itself + render_path.unlink() + assert not render_path.exists() # Failure of test itself if '__main__' == __name__: diff --git a/tests/test_webclient.py b/tests/test_webclient.py index 0d5827339..69d9a9e3a 100644 --- a/tests/test_webclient.py +++ b/tests/test_webclient.py @@ -2,8 +2,8 @@ from twisted.internet import defer Tests borrowed from the twisted.web.client tests. """ -import os import shutil +from pathlib import Path import OpenSSL.SSL from twisted.trial import unittest @@ -15,7 +15,6 @@ except ImportError: # deprecated in Twisted 19.7.0 # (remove once we bump our requirement past that version) from twisted.test.proto_helpers import StringTransport -from twisted.python.filepath import FilePath from twisted.protocols.policies import WrappingFactory from twisted.internet.defer import inlineCallbacks @@ -230,10 +229,10 @@ class WebClientTestCase(unittest.TestCase): return reactor.listenTCP(0, site, interface="127.0.0.1") def setUp(self): - self.tmpname = self.mktemp() - os.mkdir(self.tmpname) - FilePath(self.tmpname).child("file").setContent(b"0123456789") - r = static.File(self.tmpname) + self.tmpname = Path(self.mktemp()) + self.tmpname.mkdir() + (self.tmpname / "file").write_bytes(b"0123456789") + r = static.File(str(self.tmpname)) r.putChild(b"redirect", util.Redirect(b"/file")) r.putChild(b"wait", ForeverTakingResource()) r.putChild(b"error", ErrorResource()) @@ -379,10 +378,10 @@ class WebClientSSLTestCase(unittest.TestCase): return f"https://127.0.0.1:{self.portno}/{path}" def setUp(self): - self.tmpname = self.mktemp() - os.mkdir(self.tmpname) - FilePath(self.tmpname).child("file").setContent(b"0123456789") - r = static.File(self.tmpname) + self.tmpname = Path(self.mktemp()) + self.tmpname.mkdir() + (self.tmpname / "file").write_bytes(b"0123456789") + r = static.File(str(self.tmpname)) r.putChild(b"payload", PayloadResource()) self.site = server.Site(r, timeout=None) self.wrapper = WrappingFactory(self.site) From 7daf735f45ab9f3d8760d7a59e5f72c277d0687d Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Tue, 18 Oct 2022 20:07:29 -0400 Subject: [PATCH 203/532] downgrade type hint syntax --- scrapy/commands/runspider.py | 3 ++- scrapy/squeues.py | 3 ++- scrapy/utils/conf.py | 10 +++++----- tests/test_commands.py | 6 +++--- tests/test_feedexport.py | 3 ++- 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index c41135508..a8db1cd86 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -3,13 +3,14 @@ from os import PathLike from pathlib import Path from importlib import import_module from types import ModuleType +from typing import Union from scrapy.utils.spider import iter_spider_classes from scrapy.exceptions import UsageError from scrapy.commands import BaseRunSpiderCommand -def _import_file(filepath: str | PathLike[str]) -> ModuleType: +def _import_file(filepath: Union[str, PathLike]) -> ModuleType: abspath = Path(filepath).resolve() dirname = str(abspath.parent) if abspath.suffix not in ('.py', '.pyw'): diff --git a/scrapy/squeues.py b/scrapy/squeues.py index 1f2dee55f..2fa84fc00 100644 --- a/scrapy/squeues.py +++ b/scrapy/squeues.py @@ -6,6 +6,7 @@ import marshal import pickle from os import PathLike from pathlib import Path +from typing import Union from queuelib import queue @@ -17,7 +18,7 @@ def _with_mkdir(queue_class): class DirectoriesCreated(queue_class): - def __init__(self, path: str | PathLike[str], *args, **kwargs): + def __init__(self, path: Union[str, PathLike], *args, **kwargs): dirname = Path(path).parent if not dirname.exists(): dirname.mkdir(parents=True, exist_ok=True) diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index e247f5999..0dfa714e8 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -5,7 +5,7 @@ import warnings from configparser import ConfigParser from operator import itemgetter from pathlib import Path -from typing import Optional +from typing import List, Optional, Union from scrapy.exceptions import ScrapyDeprecationWarning, UsageError @@ -67,7 +67,7 @@ def arglist_to_dict(arglist): return dict(x.split('=', 1) for x in arglist) -def closest_scrapy_cfg(path: str | os.PathLike[str] = '.', prevpath: Optional[str | os.PathLike] = None) -> str: +def closest_scrapy_cfg(path: Union[str, os.PathLike] = '.', prevpath: Optional[Union[str, os.PathLike]] = None) -> str: """Return the path to the closest scrapy.cfg file by traversing the current directory and its parents """ @@ -103,7 +103,7 @@ def get_config(use_closest=True): return cfg -def get_sources(use_closest=True) -> list[str]: +def get_sources(use_closest=True) -> List[str]: xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or Path('~/.config').expanduser() sources = [ '/etc/scrapy.cfg', @@ -131,8 +131,8 @@ def feed_complete_default_values_from_settings(feed, settings): return out -def feed_process_params_from_cli(settings, output: list[str], output_format=None, - overwrite_output: Optional[list[str]] = None): +def feed_process_params_from_cli(settings, output: List[str], output_format=None, + overwrite_output: Optional[List[str]] = None): """ Receives feed export params (from the 'crawl' or 'runspider' commands), checks for inconsistencies in their quantities and returns a dictionary diff --git a/tests/test_commands.py b/tests/test_commands.py index 39f718cce..71ae85094 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -14,7 +14,7 @@ from shutil import rmtree, copytree from stat import S_IWRITE as ANYONE_WRITE_PERMISSION from tempfile import mkdtemp from threading import Timer -from typing import Generator, Optional +from typing import Dict, Generator, Optional, Union from unittest import skipIf from pytest import mark @@ -104,7 +104,7 @@ class ProjectTest(unittest.TestCase): return p, to_unicode(stdout), to_unicode(stderr) - def find_in_file(self, filename: str | os.PathLike[str], regex) -> Optional[re.Match]: + def find_in_file(self, filename: Union[str, os.PathLike], regex) -> Optional[re.Match]: """Find first pattern occurrence in file""" pattern = re.compile(regex) with Path(filename).open("r") as f: @@ -175,7 +175,7 @@ class StartprojectTest(ProjectTest): assert Path(project_path, project_name, 'spiders', '__init__.py').exists() -def get_permissions_dict(path: str | os.PathLike[str], renamings=None, ignore=None) -> dict[str, str]: +def get_permissions_dict(path: Union[str, os.PathLike], renamings=None, ignore=None) -> Dict[str, str]: def get_permissions(path: Path) -> str: return oct(path.stat().st_mode) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 98905d2c0..97c3a74b3 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -17,6 +17,7 @@ from logging import getLogger from os import PathLike from pathlib import Path from string import ascii_letters, digits +from typing import Union from unittest import mock from urllib.parse import urljoin, quote from urllib.request import pathname2url @@ -63,7 +64,7 @@ def printf_escape(string): return string.replace('%', '%%') -def build_url(path: str | PathLike[str]) -> str: +def build_url(path: Union[str, PathLike]) -> str: path_str = str(path) if path_str[0] != '/': path_str = '/' + path_str From fb26e6b650005e63c7017b55ff7b9755938a6c11 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Tue, 18 Oct 2022 20:21:11 -0400 Subject: [PATCH 204/532] resolve path to search in error --- tests/test_commands.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_commands.py b/tests/test_commands.py index 71ae85094..c7284b6c3 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -547,7 +547,7 @@ class GenspiderStandaloneCommandTest(ProjectTest): self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') - self.assertIn(f"{Path(self.temp_path, file_name + '.py')} already exists", out) + self.assertIn(f"{Path(self.temp_path, file_name + '.py').resolve()} already exists", out) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) file_contents_after = file_path.read_text() From 93d82648e59a1a211c114d0b8be2d76e0d79b582 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Wed, 19 Oct 2022 08:08:21 -0400 Subject: [PATCH 205/532] resolve this path too --- tests/test_commands.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_commands.py b/tests/test_commands.py index c7284b6c3..b61f314ec 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -492,7 +492,7 @@ class GenspiderCommandTest(CommandTest): self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') - self.assertIn(f"{file_path} already exists", out) + self.assertIn(f"{file_path.resolve()} already exists", out) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) file_contents_after = file_path.read_text() From 065db7b56688ce5cbdc1508cfda9603d33b17a87 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Wed, 19 Oct 2022 08:28:26 -0400 Subject: [PATCH 206/532] fix some mypy issues --- scrapy/commands/__init__.py | 4 ++-- scrapy/commands/genspider.py | 5 +++-- scrapy/spiders/__init__.py | 2 +- scrapy/utils/conf.py | 4 ++-- tests/test_commands.py | 1 + tests/test_crawler.py | 2 ++ 6 files changed, 11 insertions(+), 7 deletions(-) diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index 8570d90bd..2c205a712 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -15,7 +15,7 @@ from scrapy.exceptions import UsageError class ScrapyCommand: requires_project = False - crawler_process = None + crawler_process: Any = None # default settings to be used for this command instead of global defaults default_settings: Dict[str, Any] = {} @@ -23,7 +23,7 @@ class ScrapyCommand: exitcode = 0 def __init__(self): - self.settings = None # set in scrapy.cmdline + self.settings: Any = None # set in scrapy.cmdline def set_crawler(self, crawler): if hasattr(self, '_crawler'): diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index 01b4a0dbd..facb593da 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -4,7 +4,7 @@ import string from pathlib import Path from importlib import import_module -from typing import Optional +from typing import Optional, cast from urllib.parse import urlparse import scrapy @@ -116,6 +116,7 @@ class Command(ScrapyCommand): return template_file print(f"Unable to find template: {template}\n") print('Use "scrapy genspider --list" to see all available templates.') + return None def _list_templates(self): print("Available templates:") @@ -144,7 +145,7 @@ class Command(ScrapyCommand): # a file with the same name exists in the target directory spiders_module = import_module(self.settings['NEWSPIDER_MODULE']) - spiders_dir = Path(spiders_module.__file__).parent + spiders_dir = Path(cast(str, spiders_module.__file__)).parent spiders_dir_abs = spiders_dir.resolve() path = spiders_dir_abs / (name + ".py") if path.exists(): diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index 9a97e7801..0a9b124b9 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -22,7 +22,7 @@ class Spider(object_ref): class. """ - name: Optional[str] = None + name: str custom_settings: Optional[dict] = None def __init__(self, name=None, **kwargs): diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 0dfa714e8..82defa033 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -5,7 +5,7 @@ import warnings from configparser import ConfigParser from operator import itemgetter from pathlib import Path -from typing import List, Optional, Union +from typing import Any, Dict, List, Optional, Union from scrapy.exceptions import ScrapyDeprecationWarning, UsageError @@ -176,7 +176,7 @@ def feed_process_params_from_cli(settings, output: List[str], output_format=None 'URIs are specified' ) - result = {} + result: Dict[str, Dict[str, Any]] = {} for element in output: try: feed_uri, feed_format = element.rsplit(':', 1) diff --git a/tests/test_commands.py b/tests/test_commands.py index b61f314ec..f8081f450 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -112,6 +112,7 @@ class ProjectTest(unittest.TestCase): match = pattern.search(line) if match is not None: return match + return None class StartprojectTest(ProjectTest): diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 19f4229a3..a0703ad47 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -292,6 +292,8 @@ class CrawlerRunnerHasSpider(unittest.TestCase): class ScriptRunnerMixin: + script_dir: Path + def run_script(self, script_name: str, *script_args): script_path = self.script_dir / script_name args = [sys.executable, str(script_path)] + list(script_args) From c85de908193a534c60140492d5f793ab32ef3b48 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Thu, 20 Oct 2022 19:44:35 -0400 Subject: [PATCH 207/532] fix path to tox.ini --- tests/test_dependencies.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_dependencies.py b/tests/test_dependencies.py index 2558e4f91..74fdd966b 100644 --- a/tests/test_dependencies.py +++ b/tests/test_dependencies.py @@ -30,7 +30,7 @@ class ScrapyUtilsTest(unittest.TestCase): if not os.environ.get('_SCRAPY_PINNED', None): self.skipTest('Not in a pinned environment') - tox_config_file_path = Path(__file__) / '..' / 'tox.ini' + tox_config_file_path = Path(__file__).parent / '..' / 'tox.ini' config_parser = ConfigParser() config_parser.read(tox_config_file_path) pattern = r'Twisted\[http2\]==([\d.]+)' From 24d6ac1f529e1e2ea5b04cff30cf9015311ef420 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Thu, 20 Oct 2022 20:03:38 -0400 Subject: [PATCH 208/532] downgrade the last 3.9 type hints --- scrapy/pipelines/files.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index ffb12d910..4e0211d1b 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -14,7 +14,7 @@ from contextlib import suppress from ftplib import FTP from io import BytesIO from pathlib import Path -from typing import Optional +from typing import DefaultDict, Optional, Set from urllib.parse import urlparse from itemadapter import ItemAdapter @@ -46,7 +46,7 @@ class FSFilesStore: basedir = basedir.split('://', 1)[1] self.basedir = basedir self._mkdir(Path(self.basedir)) - self.created_directories: defaultdict[str, set[str]] = defaultdict(set) + self.created_directories: DefaultDict[str, Set[str]] = defaultdict(set) def persist_file(self, path: str, buf, info, meta=None, headers=None): absolute_path = self._get_filesystem_path(path) From 12a26755ae601c9b3244a4a6b55d0e880fc21864 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Thu, 20 Oct 2022 20:14:43 -0400 Subject: [PATCH 209/532] improve render_templatefile --- scrapy/commands/startproject.py | 2 +- scrapy/utils/template.py | 15 +++++++++------ tests/test_utils_template.py | 2 +- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/scrapy/commands/startproject.py b/scrapy/commands/startproject.py index 4323cdb53..9e1e95ab1 100644 --- a/scrapy/commands/startproject.py +++ b/scrapy/commands/startproject.py @@ -109,7 +109,7 @@ class Command(ScrapyCommand): move(project_dir / 'module', project_dir / project_name) for paths in TEMPLATES_TO_RENDER: tplfile = Path(project_dir, *(string.Template(s).substitute(project_name=project_name) for s in paths)) - render_templatefile(str(tplfile), project_name=project_name, ProjectName=string_camelcase(project_name)) + render_templatefile(tplfile, project_name=project_name, ProjectName=string_camelcase(project_name)) print(f"New Scrapy project '{project_name}', using template directory " f"'{self.templates_dir}', created in:") print(f" {project_dir.resolve()}\n") diff --git a/scrapy/utils/template.py b/scrapy/utils/template.py index 8075902b3..2177817d9 100644 --- a/scrapy/utils/template.py +++ b/scrapy/utils/template.py @@ -1,21 +1,24 @@ """Helper functions for working with templates""" +from os import PathLike import re import string from pathlib import Path +from typing import Union -def render_templatefile(path: str, **kwargs): - raw = Path(path).read_text('utf8') +def render_templatefile(path: Union[str, PathLike], **kwargs): + path_obj = Path(path) + raw = path_obj.read_text('utf8') content = string.Template(raw).substitute(**kwargs) - render_path = path[:-len('.tmpl')] if path.endswith('.tmpl') else path + render_path = path_obj.with_suffix('') if path_obj.suffix == '.tmpl' else path_obj - if path.endswith('.tmpl'): - Path(path).rename(render_path) + if path_obj.suffix == '.tmpl': + path_obj.rename(render_path) - Path(render_path).write_text(content, 'utf8') + render_path.write_text(content, 'utf8') CAMELCASE_INVALID_CHARS = re.compile(r'[^a-zA-Z\d]') diff --git a/tests/test_utils_template.py b/tests/test_utils_template.py index b1aca5ed3..4f1e8772b 100644 --- a/tests/test_utils_template.py +++ b/tests/test_utils_template.py @@ -28,7 +28,7 @@ class UtilsRenderTemplateFileTestCase(unittest.TestCase): template_path.write_text(template, encoding='utf8') assert template_path.is_file() # Failure of test itself - render_templatefile(str(template_path), **context) + render_templatefile(template_path, **context) self.assertFalse(template_path.exists()) self.assertEqual(render_path.read_text(encoding='utf8'), rendered) From 607eece72a91beb0e9a598a987e51a56bcffb434 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Thu, 20 Oct 2022 20:18:06 -0400 Subject: [PATCH 210/532] move to after check --- scrapy/commands/runspider.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index a8db1cd86..ed16c3fb6 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -12,9 +12,9 @@ from scrapy.commands import BaseRunSpiderCommand def _import_file(filepath: Union[str, PathLike]) -> ModuleType: abspath = Path(filepath).resolve() - dirname = str(abspath.parent) if abspath.suffix not in ('.py', '.pyw'): raise ValueError(f"Not a Python source file: {abspath}") + dirname = str(abspath.parent) if dirname: sys.path = [dirname] + sys.path try: From b33244e2f0d877b8911f949308222db0b076d665 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Fri, 21 Oct 2022 19:17:04 +0500 Subject: [PATCH 211/532] Fix the flake8 per-file ignore syntax (#5688) --- .flake8 | 17 +++++++++-------- scrapy/utils/url.py | 1 + tests/test_loader.py | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.flake8 b/.flake8 index d7aebc24b..0c64d009e 100644 --- a/.flake8 +++ b/.flake8 @@ -6,16 +6,17 @@ ignore = W503 exclude = docs/conf.py +per-file-ignores = # Exclude files that are meant to provide top-level imports # E402: Module level import not at top of file # F401: Module imported but unused - scrapy/__init__.py E402 - scrapy/core/downloader/handlers/http.py F401 - scrapy/http/__init__.py F401 - scrapy/linkextractors/__init__.py E402 F401 - scrapy/selector/__init__.py F401 - scrapy/spiders/__init__.py E402 F401 + scrapy/__init__.py:E402 + scrapy/core/downloader/handlers/http.py:F401 + scrapy/http/__init__.py:F401 + scrapy/linkextractors/__init__.py:E402,F401 + scrapy/selector/__init__.py:F401 + scrapy/spiders/__init__.py:E402,F401 # Issues pending a review: - scrapy/utils/url.py F403 F405 - tests/test_loader.py E741 + scrapy/utils/url.py:F403,F405 + tests/test_loader.py:E741 diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index 4d5e9ae82..21201ace5 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -34,6 +34,7 @@ def url_has_any_extension(url, extensions): lowercase_path = parse_url(url).path.lower() return any(lowercase_path.endswith(ext) for ext in extensions) + def parse_url(url, encoding=None): """Return urlparsed url from the given argument (which could be an already parsed url) diff --git a/tests/test_loader.py b/tests/test_loader.py index c0937b349..b3e44d36b 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -295,7 +295,7 @@ class SelectortemLoaderTest(unittest.TestCase): l.add_css('name', 'div::text') self.assertEqual(l.get_output_value('name'), ['Marta']) - + def test_init_method_with_base_response(self): """Selector should be None after initialization""" response = Response("https://scrapy.org") From 69d1b8fc0832f1cf00727c73eff6fbde11824c20 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Fri, 21 Oct 2022 20:21:08 -0400 Subject: [PATCH 212/532] dirname cannot be falsey --- scrapy/commands/runspider.py | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index ed16c3fb6..22fa6a53d 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -15,13 +15,11 @@ def _import_file(filepath: Union[str, PathLike]) -> ModuleType: if abspath.suffix not in ('.py', '.pyw'): raise ValueError(f"Not a Python source file: {abspath}") dirname = str(abspath.parent) - if dirname: - sys.path = [dirname] + sys.path + sys.path = [dirname] + sys.path try: module = import_module(abspath.stem) finally: - if dirname: - sys.path.pop(0) + sys.path.pop(0) return module From 28396c34977535ca59ed5d8481b50dd1e8171e49 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Fri, 21 Oct 2022 20:23:07 -0400 Subject: [PATCH 213/532] convert _get_request_path back to str --- scrapy/extensions/httpcache.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 3057bf157..58c4e644e 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -293,7 +293,7 @@ class FilesystemCacheStorage: metadata = self._read_meta(spider, request) if metadata is None: return # not cached - rpath = self._get_request_path(spider, request) + rpath = Path(self._get_request_path(spider, request)) with self._open(rpath / 'response_body', 'rb') as f: body = f.read() with self._open(rpath / 'response_headers', 'rb') as f: @@ -307,7 +307,7 @@ class FilesystemCacheStorage: def store_response(self, spider: Spider, request: Request, response): """Store the given response in the cache.""" - rpath = self._get_request_path(spider, request) + rpath = Path(self._get_request_path(spider, request)) if not rpath.exists(): rpath.mkdir(parents=True) metadata = { @@ -330,12 +330,12 @@ class FilesystemCacheStorage: with self._open(rpath / 'request_body', 'wb') as f: f.write(request.body) - def _get_request_path(self, spider: Spider, request: Request) -> Path: + def _get_request_path(self, spider: Spider, request: Request) -> str: key = self._fingerprinter.fingerprint(request).hex() - return Path(self.cachedir, spider.name, key[0:2], key) + return str(Path(self.cachedir, spider.name, key[0:2], key)) def _read_meta(self, spider: Spider, request: Request): - rpath = self._get_request_path(spider, request) + rpath = Path(self._get_request_path(spider, request)) metapath = rpath / 'pickled_meta' if not metapath.exists(): return # not found From 726680c7125ab3a6622b12e25d45dbfedc5a39b3 Mon Sep 17 00:00:00 2001 From: Matthew Donoughe Date: Fri, 21 Oct 2022 20:32:13 -0400 Subject: [PATCH 214/532] change crawler_process to optional --- scrapy/commands/__init__.py | 5 +++-- scrapy/commands/genspider.py | 4 ++++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index 2c205a712..1f088041c 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -4,9 +4,10 @@ Base class for Scrapy commands import os import argparse from pathlib import Path -from typing import Any, Dict +from typing import Any, Dict, Optional from twisted.python import failure +from scrapy.crawler import CrawlerProcess from scrapy.utils.conf import arglist_to_dict, feed_process_params_from_cli from scrapy.exceptions import UsageError @@ -15,7 +16,7 @@ from scrapy.exceptions import UsageError class ScrapyCommand: requires_project = False - crawler_process: Any = None + crawler_process: Optional[CrawlerProcess] = None # default settings to be used for this command instead of global defaults default_settings: Dict[str, Any] = {} diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index facb593da..ed9660252 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -133,6 +133,10 @@ class Command(ScrapyCommand): return True return False + assert ( + self.crawler_process is not None + ), "crawler_process must be set before calling run" + try: spidercls = self.crawler_process.spider_loader.load(name) except KeyError: From b61b71c6f015d45f6e98a4280bf4993517180045 Mon Sep 17 00:00:00 2001 From: Godson-Gnanaraj Date: Tue, 25 Oct 2022 08:44:43 +0530 Subject: [PATCH 215/532] Replace indentation of source before parsing with ast. closes #5323 --- scrapy/utils/misc.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index 1221b39b2..c0258c8d9 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -226,7 +226,14 @@ def is_generator_with_return_value(callable): return value is None or isinstance(value, ast.NameConstant) and value.value is None if inspect.isgeneratorfunction(callable): - code = re.sub(r"^[\t ]+", "", inspect.getsource(callable)) + pattern = r"(^[\t ]+)" + src = inspect.getsource(callable) + match = re.match(pattern, src) # Find indentation + code = re.sub(pattern, "", src) + if match: + # Remove indentation + code = re.sub(f"\n{match.group(0)}", "\n", code) + tree = ast.parse(code) for node in walk_callable(tree): if isinstance(node, ast.Return) and not returns_none(node): From f4e2a10ed6a44300738bd3701ea62b432c9c1a06 Mon Sep 17 00:00:00 2001 From: Kaushal Sharma Date: Tue, 25 Oct 2022 02:45:46 -0700 Subject: [PATCH 216/532] =?UTF-8?q?Image.ANTIALIAS=20=E2=86=92=20Image.Res?= =?UTF-8?q?ampling.LANCZOS=20(#5692)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/pipelines/images.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 6b97190ee..67b3224b3 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -160,7 +160,14 @@ class ImagesPipeline(FilesPipeline): if size: image = image.copy() - image.thumbnail(size, self._Image.ANTIALIAS) + try: + # Image.Resampling.LANCZOS was added in Pillow 9.1.0 + # remove this try except block, + # when updating the minimum requirements for Pillow. + resampling_filter = self._Image.Resampling.LANCZOS + except AttributeError: + resampling_filter = self._Image.ANTIALIAS + image.thumbnail(size, resampling_filter) buf = BytesIO() image.save(buf, 'JPEG') From 830e1c5dd85618a27749bbe41d35b11fb2bdd348 Mon Sep 17 00:00:00 2001 From: Godson-Gnanaraj Date: Wed, 26 Oct 2022 01:26:54 +0530 Subject: [PATCH 217/532] Add test for parsing decorated methods --- ...t_return_with_argument_inside_generator.py | 83 +++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/tests/test_utils_misc/test_return_with_argument_inside_generator.py b/tests/test_utils_misc/test_return_with_argument_inside_generator.py index 1c85ca353..72277d701 100644 --- a/tests/test_utils_misc/test_return_with_argument_inside_generator.py +++ b/tests/test_utils_misc/test_return_with_argument_inside_generator.py @@ -165,6 +165,89 @@ https://example.org warn_on_generator_with_return_value(None, l2) self.assertEqual(len(w), 0) + def test_generators_return_none_with_decorator(self): + def decorator(func): + def inner_func(): + func() + return inner_func + + @decorator + def f3(): + yield 1 + return None + + @decorator + def g3(): + yield 1 + return + + @decorator + def h3(): + yield 1 + + @decorator + def i3(): + yield 1 + yield from generator_that_returns_stuff() + + @decorator + def j3(): + yield 1 + + def helper(): + return 0 + + yield helper() + + @decorator + def k3(): + """ +docstring + """ + url = """ +https://example.org + """ + yield url + return + + @decorator + def l3(): + return + + assert not is_generator_with_return_value(top_level_return_none) + assert not is_generator_with_return_value(f3) + assert not is_generator_with_return_value(g3) + assert not is_generator_with_return_value(h3) + assert not is_generator_with_return_value(i3) + assert not is_generator_with_return_value(j3) # not recursive + assert not is_generator_with_return_value(k3) # not recursive + assert not is_generator_with_return_value(l3) + + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, top_level_return_none) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, f3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, g3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, h3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, i3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, j3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, k3) + self.assertEqual(len(w), 0) + with warnings.catch_warnings(record=True) as w: + warn_on_generator_with_return_value(None, l3) + self.assertEqual(len(w), 0) + @mock.patch("scrapy.utils.misc.is_generator_with_return_value", new=_indentation_error) def test_indentation_error(self): with warnings.catch_warnings(record=True) as w: From b0ddffc47b9cee5e6146497b42de3787da76d2ad Mon Sep 17 00:00:00 2001 From: Godson-Gnanaraj Date: Wed, 26 Oct 2022 06:53:43 +0530 Subject: [PATCH 218/532] Misc. changes: - compile regex - readability improvements --- scrapy/utils/misc.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index c0258c8d9..4d4fb9600 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -226,13 +226,13 @@ def is_generator_with_return_value(callable): return value is None or isinstance(value, ast.NameConstant) and value.value is None if inspect.isgeneratorfunction(callable): - pattern = r"(^[\t ]+)" src = inspect.getsource(callable) - match = re.match(pattern, src) # Find indentation - code = re.sub(pattern, "", src) + pattern = re.compile(r"(^[\t ]+)") + code = pattern.sub("", src) + + match = pattern.match(src) # finds indentation if match: - # Remove indentation - code = re.sub(f"\n{match.group(0)}", "\n", code) + code = re.sub(f"\n{match.group(0)}", "\n", code) # remove indentation tree = ast.parse(code) for node in walk_callable(tree): From 2464939b7ee8381f904f7b0625aee6de0989b6c8 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Wed, 26 Oct 2022 15:58:20 -0300 Subject: [PATCH 219/532] Fixed deprecation warning in scrapy.core.engine (#5589) * Change `download` function logic * Fix CI error in 3.7 checks * Make `spider` parameter optional in `_download` function, assign spider value from self if `None` --- scrapy/core/engine.py | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index 6602f661d..1228e78da 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -257,9 +257,7 @@ class ExecutionEngine: def download(self, request: Request, spider: Optional[Spider] = None) -> Deferred: """Return a Deferred which fires with a Response as result, only downloader middlewares are applied""" - if spider is None: - spider = self.spider - else: + if spider is not None: warnings.warn( "Passing a 'spider' argument to ExecutionEngine.download is deprecated", category=ScrapyDeprecationWarning, @@ -267,7 +265,7 @@ class ExecutionEngine: ) if spider is not self.spider: logger.warning("The spider '%s' does not match the open spider", spider.name) - if spider is None: + if self.spider is None: raise RuntimeError(f"No open spider to crawl: {request}") return self._download(request, spider).addBoth(self._downloaded, request, spider) @@ -278,11 +276,14 @@ class ExecutionEngine: self.slot.remove_request(request) return self.download(result, spider) if isinstance(result, Request) else result - def _download(self, request: Request, spider: Spider) -> Deferred: + def _download(self, request: Request, spider: Optional[Spider]) -> Deferred: assert self.slot is not None # typing self.slot.add_request(request) + if spider is None: + spider = self.spider + def _on_success(result: Union[Response, Request]) -> Union[Response, Request]: if not isinstance(result, (Response, Request)): raise TypeError(f"Incorrect type: expected Response or Request, got {type(result)}: {result!r}") From b394f2165acd662e55762d524b916f146291e422 Mon Sep 17 00:00:00 2001 From: Andrei Andrukhovich Date: Wed, 26 Oct 2022 23:11:28 +0300 Subject: [PATCH 220/532] =?UTF-8?q?Fix=20typo:=20[they]=20depends=20?= =?UTF-8?q?=E2=86=92=20depend=20(#5694)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/intro/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 9ab479edd..2c2079f68 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -52,7 +52,7 @@ Scrapy is written in pure Python and depends on a few key Python packages (among * `twisted`_, an asynchronous networking framework * `cryptography`_ and `pyOpenSSL`_, to deal with various network-level security needs -Some of these packages themselves depends on non-Python packages +Some of these packages themselves depend on non-Python packages that might require additional installation steps depending on your platform. Please check :ref:`platform-specific guides below `. From a214147359b8840abbb67bbe2a4a4066b271d2a5 Mon Sep 17 00:00:00 2001 From: Johanan Idicula Date: Wed, 26 Oct 2022 21:43:35 -0400 Subject: [PATCH 221/532] ci: Update macos runner The GitHub Actions macos-10.15 runner image is now deprecated, and GitHub Actions has begun to temporarily fail jobs referencing it during brownout periods. The image will be fully unsupported by 2022-12-01, which is just about a month away. This change updates the macOS runner image to the latest generally-available version, to help reduce spurious CI failures during the brownout periods, and to stay abreast of the sunsetting of the macos-10.15 image. See also: actions/runner-images#5583 --- .github/workflows/tests-macos.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index fdb9f4980..61f1857f8 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -3,7 +3,7 @@ on: [push, pull_request] jobs: tests: - runs-on: macos-10.15 + runs-on: macos-11 strategy: fail-fast: false matrix: From ca50af645390e38299082d9ef4682c4be482ae70 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 27 Oct 2022 17:12:26 +0600 Subject: [PATCH 222/532] Remove an unused import. --- tests/test_pipeline_images.py | 1 - 1 file changed, 1 deletion(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index c4ce2736f..c189d08bf 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -4,7 +4,6 @@ import io import random from shutil import rmtree from tempfile import mkdtemp -from unittest import skipIf from warnings import catch_warnings import attr From b6541830849a6edd41da6b539d272790a4661d7d Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Thu, 27 Oct 2022 17:00:36 +0500 Subject: [PATCH 223/532] Use Python 3.11 as the default in CI (#5696) --- .github/workflows/checks.yml | 8 ++++---- .github/workflows/publish.yml | 2 +- .github/workflows/tests-macos.yml | 2 +- .github/workflows/tests-ubuntu.yml | 9 +++------ .github/workflows/tests-windows.yml | 7 +++++++ .readthedocs.yml | 2 +- 6 files changed, 17 insertions(+), 13 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 439dfee51..8c1ae4bd3 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -8,10 +8,10 @@ jobs: fail-fast: false matrix: include: - - python-version: "3.10" + - python-version: "3.11" env: TOXENV: security - - python-version: "3.10" + - python-version: "3.11" env: TOXENV: flake8 # Pylint requires installing reppy, which does not support Python 3.9 @@ -22,10 +22,10 @@ jobs: - python-version: 3.7 env: TOXENV: typing - - python-version: "3.10" # Keep in sync with .readthedocs.yml + - python-version: "3.11" # Keep in sync with .readthedocs.yml env: TOXENV: docs - - python-version: "3.10" + - python-version: "3.11" env: TOXENV: twinecheck diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index f6b098b80..991b0b6e8 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -12,7 +12,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v4 with: - python-version: "3.10" + python-version: "3.11" - name: Check Tag id: check-release-tag diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index 61f1857f8..174d245ca 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -7,7 +7,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7", "3.8", "3.9", "3.10"] + python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] steps: - uses: actions/checkout@v3 diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index d2bfe4a5f..9c3ce8115 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -17,13 +17,10 @@ jobs: - python-version: "3.10" env: TOXENV: py - - python-version: "3.10" - env: - TOXENV: asyncio - - python-version: "3.11.0-rc.2" + - python-version: "3.11" env: TOXENV: py - - python-version: "3.11.0-rc.2" + - python-version: "3.11" env: TOXENV: asyncio - python-version: pypy3.9 @@ -57,7 +54,7 @@ jobs: python-version: ${{ matrix.python-version }} - name: Install system libraries - if: matrix.python-version == 'pypy3.9' || contains(matrix.env.TOXENV, 'pinned') || matrix.python-version == '3.11.0-rc.2' + if: matrix.python-version == 'pypy3.9' || contains(matrix.env.TOXENV, 'pinned') run: | sudo apt-get update sudo apt-get install libxml2-dev libxslt-dev diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index 14683fd53..f60c48841 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -23,6 +23,13 @@ jobs: - python-version: "3.10" env: TOXENV: asyncio +# no binary package for lxml for 3.11 yet +# - python-version: "3.11" +# env: +# TOXENV: py +# - python-version: "3.11" +# env: +# TOXENV: asyncio steps: - uses: actions/checkout@v3 diff --git a/.readthedocs.yml b/.readthedocs.yml index 390be3749..e71d34f3a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,7 +9,7 @@ build: tools: # For available versions, see: # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-tools-python - python: "3.10" # Keep in sync with .github/workflows/checks.yml + python: "3.11" # Keep in sync with .github/workflows/checks.yml python: install: From 3a34fa839938d7640e56f3ce12ba60aed31a6ecf Mon Sep 17 00:00:00 2001 From: Godson <30664729+Godson-Gnanaraj@users.noreply.github.com> Date: Thu, 27 Oct 2022 17:32:12 +0530 Subject: [PATCH 224/532] Get the event loop from event_loop_policy to avoid a deprecation warning (#5689) --- scrapy/utils/defer.py | 8 +++++--- scrapy/utils/reactor.py | 21 ++++++++++++++++----- tests/test_utils_asyncio.py | 6 ++++-- 3 files changed, 25 insertions(+), 10 deletions(-) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 8fcf31cab..38aefd6d0 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -26,7 +26,7 @@ from twisted.python import failure from twisted.python.failure import Failure from scrapy.exceptions import IgnoreRequest -from scrapy.utils.reactor import is_asyncio_reactor_installed +from scrapy.utils.reactor import is_asyncio_reactor_installed, get_asyncio_event_loop_policy def defer_fail(_failure: Failure) -> Deferred: @@ -269,7 +269,8 @@ def deferred_from_coro(o) -> Any: return ensureDeferred(o) else: # wrapping the coroutine into a Future and then into a Deferred, this requires AsyncioSelectorReactor - return Deferred.fromFuture(asyncio.ensure_future(o)) + event_loop = get_asyncio_event_loop_policy().get_event_loop() + return Deferred.fromFuture(asyncio.ensure_future(o, loop=event_loop)) return o @@ -320,7 +321,8 @@ def deferred_to_future(d: Deferred) -> Future: d = treq.get('https://example.com/additional') additional_response = await deferred_to_future(d) """ - return d.asFuture(asyncio.get_event_loop()) + policy = get_asyncio_event_loop_policy() + return d.asFuture(policy.get_event_loop()) def maybe_deferred_to_future(d: Deferred) -> Union[Deferred, Future]: diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index 652733ce8..ddf354d88 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -51,6 +51,19 @@ class CallLaterOnce: return self._func(*self._a, **self._kw) +def get_asyncio_event_loop_policy(): + policy = asyncio.get_event_loop_policy() + if ( + sys.version_info >= (3, 8) + and sys.platform == "win32" + and not isinstance(policy, asyncio.WindowsSelectorEventLoopPolicy) + ): + policy = asyncio.WindowsSelectorEventLoopPolicy() + asyncio.set_event_loop_policy(policy) + + return policy + + def install_reactor(reactor_path, event_loop_path=None): """Installs the :mod:`~twisted.internet.reactor` with the specified import path. Also installs the asyncio event loop with the specified import @@ -58,16 +71,14 @@ def install_reactor(reactor_path, event_loop_path=None): reactor_class = load_object(reactor_path) if reactor_class is asyncioreactor.AsyncioSelectorReactor: with suppress(error.ReactorAlreadyInstalledError): - if sys.version_info >= (3, 8) and sys.platform == "win32": - policy = asyncio.get_event_loop_policy() - if not isinstance(policy, asyncio.WindowsSelectorEventLoopPolicy): - asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) + policy = get_asyncio_event_loop_policy() if event_loop_path is not None: event_loop_class = load_object(event_loop_path) event_loop = event_loop_class() asyncio.set_event_loop(event_loop) else: - event_loop = asyncio.get_event_loop() + event_loop = policy.get_event_loop() + asyncioreactor.install(eventloop=event_loop) else: *module, _ = reactor_path.split(".") diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index 295323e4d..741c6a505 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -1,3 +1,4 @@ +import warnings from unittest import TestCase from pytest import mark @@ -13,5 +14,6 @@ class AsyncioTest(TestCase): self.assertEqual(is_asyncio_reactor_installed(), self.reactor_pytest == 'asyncio') def test_install_asyncio_reactor(self): - # this should do nothing - install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") + with warnings.catch_warnings(record=True) as w: + install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") + self.assertEqual(len(w), 0) From b71d0292d5ff85d652e2943ee1a727a128b55594 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 27 Oct 2022 18:13:47 +0600 Subject: [PATCH 225/532] Add a test for processing partial callbacks. --- .../test_return_with_argument_inside_generator.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/test_utils_misc/test_return_with_argument_inside_generator.py b/tests/test_utils_misc/test_return_with_argument_inside_generator.py index 72277d701..562f72fee 100644 --- a/tests/test_utils_misc/test_return_with_argument_inside_generator.py +++ b/tests/test_utils_misc/test_return_with_argument_inside_generator.py @@ -1,5 +1,6 @@ import unittest import warnings +from functools import partial from unittest import mock from scrapy.utils.misc import is_generator_with_return_value, warn_on_generator_with_return_value @@ -254,3 +255,10 @@ https://example.org warn_on_generator_with_return_value(None, top_level_return_none) self.assertEqual(len(w), 1) self.assertIn('Unable to determine', str(w[0].message)) + + def test_partial(self): + def cb(arg1, arg2): + yield {} + + partial_cb = partial(cb, arg1=42) + assert not is_generator_with_return_value(partial_cb) From fd692f309105d917f5f46bd00a88c550d6cc7da3 Mon Sep 17 00:00:00 2001 From: Magnus Offermanns Date: Thu, 27 Oct 2022 14:43:31 +0200 Subject: [PATCH 226/532] Prevent running the -O and -t command-line options together (#5605) Co-authored-by: Andrey Rakhmatullin --- docs/topics/commands.rst | 20 ++++++++++++++++++++ scrapy/commands/__init__.py | 6 ++++-- scrapy/utils/conf.py | 19 ++++++++++++++++--- 3 files changed, 40 insertions(+), 5 deletions(-) diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index 8c0b8e55f..362190116 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -271,11 +271,31 @@ crawl Start crawling using a spider. +Supported options: + +* ``-h, --help``: show a help message and exit + +* ``-a NAME=VALUE``: set a spider argument (may be repeated) + +* ``--output FILE`` or ``-o FILE``: append scraped items to the end of FILE (use - for stdout), to define format set a colon at the end of the output URI (i.e. ``-o FILE:FORMAT``) + +* ``--overwrite-output FILE`` or ``-O FILE``: dump scraped items into FILE, overwriting any existing file, to define format set a colon at the end of the output URI (i.e. ``-O FILE:FORMAT``) + +* ``--output-format FORMAT`` or ``-t FORMAT``: deprecated way to define format to use for dumping items, does not work in combination with ``-O`` + Usage examples:: $ scrapy crawl myspider [ ... myspider starts crawling ... ] + $ scrapy -o myfile:csv myspider + [ ... myspider starts crawling and appends the result to the file myfile in csv format ... ] + + $ scrapy -O myfile:json myspider + [ ... myspider starts crawling and saves the result in myfile in json format overwriting the original content... ] + + $ scrapy -o myfile -t csv myspider + [ ... myspider starts crawling and appends the result to the file myfile in csv format ... ] .. command:: check diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index fb304b8c0..49c4e2f42 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -115,9 +115,11 @@ class BaseRunSpiderCommand(ScrapyCommand): parser.add_argument("-a", dest="spargs", action="append", default=[], metavar="NAME=VALUE", help="set spider argument (may be repeated)") parser.add_argument("-o", "--output", metavar="FILE", action="append", - help="append scraped items to the end of FILE (use - for stdout)") + help="append scraped items to the end of FILE (use - for stdout)," + " to define format set a colon at the end of the output URI (i.e. -o FILE:FORMAT)") parser.add_argument("-O", "--overwrite-output", metavar="FILE", action="append", - help="dump scraped items into FILE, overwriting any existing file") + help="dump scraped items into FILE, overwriting any existing file," + " to define format set a colon at the end of the output URI (i.e. -O FILE:FORMAT)") parser.add_argument("-t", "--output-format", metavar="FORMAT", help="format to use for dumping items") diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 00cc53725..6404edda6 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -155,6 +155,15 @@ def feed_process_params_from_cli(settings, output, output_format=None, raise UsageError( "Please use only one of -o/--output and -O/--overwrite-output" ) + if output_format: + raise UsageError( + "-t/--output-format is a deprecated command line option" + " and does not work in combination with -O/--overwrite-output." + " To specify a format please specify it after a colon at the end of the" + " output URI (i.e. -O :)." + " Example working in the tutorial: " + "scrapy crawl quotes -O quotes.json:json" + ) output = overwrite_output overwrite = True @@ -162,9 +171,13 @@ def feed_process_params_from_cli(settings, output, output_format=None, if len(output) == 1: check_valid_format(output_format) message = ( - 'The -t command line option is deprecated in favor of ' - 'specifying the output format within the output URI. See the ' - 'documentation of the -o and -O options for more information.' + "The -t/--output-format command line option is deprecated in favor of " + "specifying the output format within the output URI using the -o/--output or the" + " -O/--overwrite-output option (i.e. -o/-O :). See the documentation" + " of the -o or -O option or the following examples for more information. " + "Examples working in the tutorial: " + "scrapy crawl quotes -o quotes.csv:csv or " + "scrapy crawl quotes -O quotes.json:json" ) warnings.warn(message, ScrapyDeprecationWarning, stacklevel=2) return {output[0]: {'format': output_format}} From bd9e482c2f0db92065708c8291be6e8bc1f05218 Mon Sep 17 00:00:00 2001 From: iamkaushal Date: Thu, 27 Oct 2022 23:21:55 +0530 Subject: [PATCH 227/532] added typing.io and typing.re in pytest warning filter to ignore --- pytest.ini | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pytest.ini b/pytest.ini index af0f2fb6e..f5fbf2529 100644 --- a/pytest.ini +++ b/pytest.ini @@ -24,3 +24,5 @@ markers = filterwarnings = ignore:scrapy.downloadermiddlewares.decompression is deprecated ignore:Module scrapy.utils.reqser is deprecated + ignore:typing.re is deprecated + ignore:typing.io is deprecated From 9f45be439de8a3b9a6d201c33e98b408a73c02bb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E0=B4=8E=E0=B4=A4=E0=B4=BF=E0=B4=B0=E0=B4=BE=E0=B4=B3?= =?UTF-8?q?=E0=B4=BF=E0=B4=95=E0=B5=8D=E0=B4=95=E0=B5=8A=E0=B4=B0=E0=B5=81?= =?UTF-8?q?=20=E0=B4=AA=E0=B5=8B=E0=B4=B0=E0=B4=BE=E0=B4=B3=E0=B4=BF?= <108031802+pankali@users.noreply.github.com> Date: Fri, 28 Oct 2022 02:13:37 +0200 Subject: [PATCH 228/532] Update Code of Conduct to Contributor Covenant v2.1 --- CODE_OF_CONDUCT.md | 152 +++++++++++++++++++++++++++++++-------------- 1 file changed, 104 insertions(+), 48 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 902cd523e..3c8e4d1b5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,77 +1,133 @@ + # Contributor Covenant Code of Conduct ## Our Pledge -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to make participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. ## Our Standards -Examples of behavior that contributes to creating a positive environment -include: +Examples of behavior that contributes to a positive environment for our +community include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community -Examples of unacceptable behavior by participants include: +Examples of unacceptable behavior include: -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks * Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission +* Publishing others' private information, such as a physical or email address, + without their explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting -## Our Responsibilities +## Enforcement Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. ## Scope -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at opensource@zyte.com. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. +reported to the community leaders responsible for enforcement at +opensource@zyte.com. +All complaints will be reviewed and investigated promptly and fairly. -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. ## Attribution -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at [http://contributor-covenant.org/version/1/4][version]. +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. -[homepage]: http://contributor-covenant.org -[version]: http://contributor-covenant.org/version/1/4/ +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations From 3259a4252566f4130f14ce2acd03531a735dae90 Mon Sep 17 00:00:00 2001 From: Eugenio Lacuesta Date: Sun, 30 Oct 2022 13:17:37 -0300 Subject: [PATCH 229/532] CrawlSpider: pass cb_kwargs from process_request --- scrapy/spiders/crawl.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index edac082d0..2d9328633 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -102,9 +102,9 @@ class CrawlSpider(Spider): request = self._build_request(rule_index, link) yield rule.process_request(request, response) - def _callback(self, response): + def _callback(self, response, **cb_kwargs): rule = self._rules[response.meta['rule']] - return self._parse_response(response, rule.callback, rule.cb_kwargs, rule.follow) + return self._parse_response(response, rule.callback, {**rule.cb_kwargs, **cb_kwargs}, rule.follow) def _errback(self, failure): rule = self._rules[failure.request.meta['rule']] From b18560315bda057610ecda165694f9c0f7445c1f Mon Sep 17 00:00:00 2001 From: Eugenio Lacuesta Date: Sun, 30 Oct 2022 18:28:16 -0300 Subject: [PATCH 230/532] Add tests --- tests/spiders.py | 11 +++++++++++ tests/test_crawl.py | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/tests/spiders.py b/tests/spiders.py index 5ea8a4a21..7952e3d47 100644 --- a/tests/spiders.py +++ b/tests/spiders.py @@ -419,6 +419,17 @@ class CrawlSpiderWithErrback(CrawlSpiderWithParseMethod): self.logger.info('[errback] status %i', failure.value.response.status) +class CrawlSpiderWithProcessRequestCallbackKeywordArguments(CrawlSpiderWithParseMethod): + name = 'crawl_spider_with_process_request_cb_kwargs' + rules = ( + Rule(LinkExtractor(), callback='parse', follow=True, process_request="process_request"), + ) + + def process_request(self, request, response): + request.cb_kwargs["foo"] = "process_request" + return request + + class BytesReceivedCallbackSpider(MetaSpider): full_response_length = 2**18 diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 5383ec652..5ec96e4a7 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -41,6 +41,7 @@ from tests.spiders import ( CrawlSpiderWithAsyncGeneratorCallback, CrawlSpiderWithErrback, CrawlSpiderWithParseMethod, + CrawlSpiderWithProcessRequestCallbackKeywordArguments, DelaySpider, DuplicateStartRequestsSpider, FollowAllSpider, @@ -426,6 +427,16 @@ class CrawlSpiderTestCase(TestCase): self.assertIn("[errback] status 500", str(log)) self.assertIn("[errback] status 501", str(log)) + @defer.inlineCallbacks + def test_crawlspider_process_request_cb_kwargs(self): + crawler = get_crawler(CrawlSpiderWithProcessRequestCallbackKeywordArguments) + with LogCapture() as log: + yield crawler.crawl(mockserver=self.mockserver) + + self.assertIn("[parse] status 200 (foo: process_request)", str(log)) + self.assertIn("[parse] status 201 (foo: process_request)", str(log)) + self.assertIn("[parse] status 202 (foo: bar)", str(log)) + @defer.inlineCallbacks def test_async_def_parse(self): crawler = get_crawler(AsyncDefSpider) From 940a73863bf7dcb16b3f2d9f5efb83efe4599712 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 1 Nov 2022 19:00:33 +0600 Subject: [PATCH 231/532] Release notes for 2.7.1. --- docs/news.rst | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index 1ec183a1d..b7c8c85b5 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,6 +3,57 @@ Release notes ============= +.. _release-2.7.1: + +Scrapy 2.7.1 (Not relased yet) +------------------------------ + +New features +~~~~~~~~~~~~ + +- Relaxed the restriction introduced in 2.6.2 so that the + ``Proxy-Authentication`` header can again be set explicitly, as long as the + proxy URL in the :reqmeta:`proxy` metadata has no other credentials, and + for as long as that proxy URL remains the same (:issue:`5626`). + +Bug fixes +~~~~~~~~~ + +- Using ``-O``/``--overwrite-output`` and ``-t``/``--output-format`` options + together now produces an error instead of ignoring the former option + (:issue:`5516`, :issue:`5605`). + +- Replaced deprecated :mod:`asyncio` APIs that implicitly use the current + event loop with code that explicitly requests a loop from the event loop + policy (:issue:`5685`, :issue:`5689`). + +- Fixed uses of deprecated Scrapy APIs in the Scrapy itself (:issue:`5588`, + :issue:`5589`). + +- Fixed uses of a deprecated Pillow API (:issue:`5684`, :issue:`5692`). + +- Improved code that checks if generators return values, so that it no longer + fails on decorated methods and partial methods (:issue:`5323`, + :issue:`5592`, :issue:`5599`, :issue:`5691`). + +Documentation +~~~~~~~~~~~~~ + +- Upgraded the Code of Conduct to Contributor Covenant v2.1 (:issue:`5698`). + +- Fixed typos (:issue:`5681`, :issue:`5694`). + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Re-enabled some erroneously disabled flake8 checks (:issue:`5688`). + +- Ignored harmless deprecation warnings from :mod:`typing` in tests + (:issue:`5686`, :issue:`5697`). + +- Modernized CI configuration (:issue:`5695`, :issue:`5696`). + + .. _release-2.7.0: Scrapy 2.7.0 (2022-10-17) From 5ec175b8bb08f93c431d7d64d2389b90ec7a1f37 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 2 Nov 2022 13:54:00 +0600 Subject: [PATCH 232/532] Small relnotes fixes. --- docs/news.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/news.rst b/docs/news.rst index b7c8c85b5..257626526 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -14,7 +14,8 @@ New features - Relaxed the restriction introduced in 2.6.2 so that the ``Proxy-Authentication`` header can again be set explicitly, as long as the proxy URL in the :reqmeta:`proxy` metadata has no other credentials, and - for as long as that proxy URL remains the same (:issue:`5626`). + for as long as that proxy URL remains the same; this restores compatibility + with scrapy-zyte-smartproxy 2.1.0 and older (:issue:`5626`). Bug fixes ~~~~~~~~~ @@ -27,7 +28,7 @@ Bug fixes event loop with code that explicitly requests a loop from the event loop policy (:issue:`5685`, :issue:`5689`). -- Fixed uses of deprecated Scrapy APIs in the Scrapy itself (:issue:`5588`, +- Fixed uses of deprecated Scrapy APIs in Scrapy itself (:issue:`5588`, :issue:`5589`). - Fixed uses of a deprecated Pillow API (:issue:`5684`, :issue:`5692`). @@ -51,7 +52,7 @@ Quality assurance - Ignored harmless deprecation warnings from :mod:`typing` in tests (:issue:`5686`, :issue:`5697`). -- Modernized CI configuration (:issue:`5695`, :issue:`5696`). +- Modernized our CI configuration (:issue:`5695`, :issue:`5696`). .. _release-2.7.0: From 6ded3cf4cd134b615239babe28bb28c3ff524b05 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 2 Nov 2022 17:00:47 +0600 Subject: [PATCH 233/532] =?UTF-8?q?Bump=20version:=202.7.0=20=E2=86=92=202?= =?UTF-8?q?.7.1?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- docs/news.rst | 4 ++-- scrapy/VERSION | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index f88071685..b949d81c4 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.7.0 +current_version = 2.7.1 commit = True tag = True tag_name = {new_version} diff --git a/docs/news.rst b/docs/news.rst index 257626526..e5fc2971a 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,8 +5,8 @@ Release notes .. _release-2.7.1: -Scrapy 2.7.1 (Not relased yet) ------------------------------- +Scrapy 2.7.1 (2022-11-02) +------------------------- New features ~~~~~~~~~~~~ diff --git a/scrapy/VERSION b/scrapy/VERSION index 24ba9a38d..860487ca1 100644 --- a/scrapy/VERSION +++ b/scrapy/VERSION @@ -1 +1 @@ -2.7.0 +2.7.1 From a34b929a40c12933f75db4665b71348444a5d603 Mon Sep 17 00:00:00 2001 From: srki24 Date: Fri, 4 Nov 2022 18:00:17 +0100 Subject: [PATCH 234/532] issues/5043 Detaching the stream --- scrapy/exporters.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 76cbe4d4b..243ec4fe1 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -247,6 +247,12 @@ class CsvItemExporter(BaseItemExporter): values = list(self._build_row(x for _, x in fields)) self.csv_writer.writerow(values) + def finish_exporting(self): + # Detaching stream in order to avoid file closing. + # The file will be closed with slot.storage.store + # https://github.com/scrapy/scrapy/issues/5043 + self.stream.detach() + def _build_row(self, values): for s in values: try: From 6c0890ff54a8d49237415e5b7d7dfbf216e88577 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Mon, 7 Nov 2022 16:36:54 +0500 Subject: [PATCH 235/532] Simplify the changes after the merge --- tests/test_pipeline_images.py | 37 +++++++++++++++++------------------ 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 81c9a027a..0c9a5733f 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -7,7 +7,6 @@ from shutil import rmtree from tempfile import mkdtemp from unittest import skipIf from unittest.mock import patch -from warnings import catch_warnings import attr from itemadapter import ItemAdapter @@ -91,6 +90,22 @@ class ImagesPipelineTestCase(unittest.TestCase): info=object()), 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') + def test_thumbnail_name_from_item(self): + """ + Custom thumbnail name based on item data, overriding default implementation + """ + + class CustomImagesPipeline(ImagesPipeline): + def thumb_path(self, request, thumb_id, response=None, info=None, item=None): + return f"thumb/{thumb_id}/{item.get('path')}" + + thumb_path = CustomImagesPipeline.from_settings(Settings( + {'IMAGES_STORE': self.tempdir} + )).thumb_path + item = dict(path='path-to-store-file') + request = Request("http://example.com") + self.assertEqual(thumb_path(request, 'small', item=item), 'thumb/small/path-to-store-file') + def test_get_images_exception(self): self.pipeline.min_width = 100 self.pipeline.min_height = 100 @@ -231,22 +246,6 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted.mode, 'RGB') self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - def test_thumbnail_name_from_item(self): - """ - Custom thumbnail name based on item data, overriding default implementation - """ - - class CustomImagesPipeline(ImagesPipeline): - def thumb_path(self, request, thumb_id, response=None, info=None, item=None): - return f"thumb/{thumb_id}/{item.get('path')}" - - thumb_path = CustomImagesPipeline.from_settings(Settings( - {'IMAGES_STORE': self.tempdir} - )).thumb_path - item = dict(path='path-to-store-file') - request = Request("http://example.com") - self.assertEqual(thumb_path(request, 'small', item=item), 'thumb/small/path-to-store-file') - class DeprecatedImagesPipeline(ImagesPipeline): def file_key(self, url): @@ -536,11 +535,11 @@ class NoimagesDropTestCase(unittest.TestCase): def test_deprecation_warning(self): arg = str() - with catch_warnings(record=True) as warnings: + with warnings.catch_warnings(record=True) as warnings: NoimagesDrop(arg) self.assertEqual(len(warnings), 1) self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) - with catch_warnings(record=True) as warnings: + with warnings.catch_warnings(record=True) as warnings: class SubclassedNoimagesDrop(NoimagesDrop): pass SubclassedNoimagesDrop(arg) From bbe24d79a5ee6a2afc8cd50bff4ac0e6df26886c Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Mon, 7 Nov 2022 17:08:54 +0500 Subject: [PATCH 236/532] Fix test issues --- tests/test_pipeline_images.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 0c9a5733f..f98d40fda 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -5,7 +5,6 @@ import random import warnings from shutil import rmtree from tempfile import mkdtemp -from unittest import skipIf from unittest.mock import patch import attr @@ -535,16 +534,16 @@ class NoimagesDropTestCase(unittest.TestCase): def test_deprecation_warning(self): arg = str() - with warnings.catch_warnings(record=True) as warnings: + with warnings.catch_warnings(record=True) as w: NoimagesDrop(arg) - self.assertEqual(len(warnings), 1) - self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) - with warnings.catch_warnings(record=True) as warnings: + self.assertEqual(len(w), 1) + self.assertEqual(w[0].category, ScrapyDeprecationWarning) + with warnings.catch_warnings(record=True) as w: class SubclassedNoimagesDrop(NoimagesDrop): pass SubclassedNoimagesDrop(arg) - self.assertEqual(len(warnings), 1) - self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) + self.assertEqual(len(w), 1) + self.assertEqual(w[0].category, ScrapyDeprecationWarning) def _create_image(format, *a, **kw): From ae3fd0172972f672c3cf3291bcf9f28073e8d4d0 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Thu, 10 Nov 2022 11:38:46 -0300 Subject: [PATCH 237/532] =?UTF-8?q?Fix=20stray=20=E2=80=9Ccommands?= =?UTF-8?q?=E2=80=9D=20(#5712)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/cmdline.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 5ee1f0f44..68267fb74 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -7,7 +7,7 @@ import pkg_resources import scrapy from scrapy.crawler import CrawlerProcess -from scrapy.commands import ScrapyCommand, ScrapyHelpFormatter +from scrapy.commands import ScrapyCommand, ScrapyHelpFormatter, BaseRunSpiderCommand from scrapy.exceptions import UsageError from scrapy.utils.misc import walk_modules from scrapy.utils.project import inside_project, get_project_settings @@ -32,7 +32,7 @@ def _iter_command_classes(module_name): inspect.isclass(obj) and issubclass(obj, ScrapyCommand) and obj.__module__ == module.__name__ - and not obj == ScrapyCommand + and obj not in (ScrapyCommand, BaseRunSpiderCommand) ): yield obj From 29bf7f5a6c8460e030e465351d2e6d38acf22f3d Mon Sep 17 00:00:00 2001 From: Hassan Shoayb <79839316+Hassan-Shoayb@users.noreply.github.com> Date: Mon, 14 Nov 2022 14:15:00 +0530 Subject: [PATCH 238/532] broad-crawls.rst: fix a typo (#5714) --- docs/topics/broad-crawls.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/broad-crawls.rst b/docs/topics/broad-crawls.rst index 63b60312e..0927ac2d2 100644 --- a/docs/topics/broad-crawls.rst +++ b/docs/topics/broad-crawls.rst @@ -68,7 +68,7 @@ IP (:setting:`CONCURRENT_REQUESTS_PER_IP`). The default global concurrency limit in Scrapy is not suitable for crawling many different domains in parallel, so you will want to increase it. How much -to increase it will depend on how much CPU and memory you crawler will have +to increase it will depend on how much CPU and memory your crawler will have available. A good starting point is ``100``:: From 1200a545439677942085f392d7477ee37b62691e Mon Sep 17 00:00:00 2001 From: islem-esi Date: Tue, 15 Nov 2022 16:28:45 +0100 Subject: [PATCH 239/532] minor fix for readability --- scrapy/cmdline.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 68267fb74..8218a51c8 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -78,7 +78,8 @@ def _pop_command_name(argv): def _print_header(settings, inproject): version = scrapy.__version__ if inproject: - print(f"Scrapy {version} - project: {settings['BOT_NAME']}\n") + print(f"Scrapy {version} - active project: {settings['BOT_NAME']}\n") + else: print(f"Scrapy {version} - no active project\n") From 12d52a4f089798f266cbc6f86df3cc9c1cd58257 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 18 Nov 2022 14:16:18 +0200 Subject: [PATCH 240/532] per slot settings: code optimized --- scrapy/core/downloader/__init__.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index d908f4d7e..f16afe99b 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -100,12 +100,13 @@ class Downloader: def _get_slot(self, request, spider): key = self._get_slot_key(request, spider) if key not in self.slots: - conc = self.per_slot_settings.get(key, {}).get( + slot_settings = self.per_slot_settings.get(key, {}) + conc = slot_settings.get( 'concurrency', self.ip_concurrency if self.ip_concurrency else self.domain_concurrency ) conc, delay = _get_concurrency_delay(conc, spider, self.settings) - delay = self.per_slot_settings.get(key, {}).get('delay', delay) - randomize_delay = self.per_slot_settings.get(key, {}).get('randomize_delay', self.randomize_delay) + delay = slot_settings.get('delay', delay) + randomize_delay = slot_settings.get('randomize_delay', self.randomize_delay) new_slot = Slot(conc, delay, randomize_delay) self.slots[key] = new_slot From 042012f6bdaf4fbd5b978ff7cc9b6796286ac7c4 Mon Sep 17 00:00:00 2001 From: GeorgeA92 Date: Fri, 18 Nov 2022 14:56:29 +0200 Subject: [PATCH 241/532] per slot settings: error calculation metho updated --- tests/test_downloaderslotssettings.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_downloaderslotssettings.py b/tests/test_downloaderslotssettings.py index 6ea03fb78..a092d01bf 100644 --- a/tests/test_downloaderslotssettings.py +++ b/tests/test_downloaderslotssettings.py @@ -70,6 +70,6 @@ class CrawlTestCase(TestCase): tolerance = 0.3 delays_real = {k: v[1] - v[0] for k, v in times.items()} - error_delta = {k: 1 - delays_real[k] / v.delay for k, v in slots.items()} + error_delta = {k: 1 - min(delays_real[k], v.delay) / max(delays_real[k], v.delay) for k, v in slots.items()} self.assertTrue(max(list(error_delta.values())) < tolerance) From d5b6c236a90aac37b7942793e4943347ebaa65b8 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Mon, 21 Nov 2022 05:32:26 -0300 Subject: [PATCH 242/532] Remove deprecated code (#5719) --- scrapy/utils/boto.py | 23 ----------------------- scrapy/utils/gz.py | 11 ----------- scrapy/utils/python.py | 38 -------------------------------------- tests/test_utils_python.py | 34 ++-------------------------------- 4 files changed, 2 insertions(+), 104 deletions(-) diff --git a/scrapy/utils/boto.py b/scrapy/utils/boto.py index 3374c57c7..39a681001 100644 --- a/scrapy/utils/boto.py +++ b/scrapy/utils/boto.py @@ -1,27 +1,4 @@ """Boto/botocore helpers""" -import warnings - -from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning - - -def is_botocore(): - """ Returns True if botocore is available, otherwise raises NotConfigured. Never returns False. - - Previously, when boto was supported in addition to botocore, this returned False if boto was available - but botocore wasn't. - """ - message = ( - 'is_botocore() is deprecated and always returns True or raises an Exception, ' - 'so it cannot be used for checking if boto is available instead of botocore. ' - 'You can use scrapy.utils.boto.is_botocore_available() to check if botocore ' - 'is available.' - ) - warnings.warn(message, ScrapyDeprecationWarning, stacklevel=2) - try: - import botocore # noqa: F401 - return True - except ImportError: - raise NotConfigured('missing botocore library') def is_botocore_available(): diff --git a/scrapy/utils/gz.py b/scrapy/utils/gz.py index 76156a4b8..0810e1f1d 100644 --- a/scrapy/utils/gz.py +++ b/scrapy/utils/gz.py @@ -2,17 +2,6 @@ import struct from gzip import GzipFile from io import BytesIO -from scrapy.utils.decorators import deprecated - - -# - GzipFile's read() has issues returning leftover uncompressed data when -# input is corrupted -# - read1(), which fetches data before raising EOFError on next call -# works here -@deprecated('GzipFile.read1') -def read1(gzf, size=-1): - return gzf.read1(size) - def gunzip(data): """Gunzip the given data and return as much data as possible. diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 8ce030d9d..0d9fdbf23 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -1,20 +1,16 @@ """ This module contains essential stuff that should've come with Python itself ;) """ -import errno import gc import inspect import re import sys -import warnings import weakref from functools import partial, wraps from itertools import chain from typing import AsyncGenerator, AsyncIterable, Iterable, Union -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncgen import as_async_generator -from scrapy.utils.decorators import deprecated def flatten(x): @@ -112,12 +108,6 @@ def to_bytes(text, encoding=None, errors='strict'): return text.encode(encoding, errors) -@deprecated('to_unicode') -def to_native_str(text, encoding=None, errors='strict'): - """ Return str representation of ``text``. """ - return to_unicode(text, encoding, errors) - - def re_rsearch(pattern, text, chunk_size=1024): """ This function does a reverse search in a text using a regular expression @@ -263,30 +253,6 @@ def equal_attributes(obj1, obj2, attributes): return True -class WeakKeyCache: - - def __init__(self, default_factory): - warnings.warn("The WeakKeyCache class is deprecated", category=ScrapyDeprecationWarning, stacklevel=2) - self.default_factory = default_factory - self._weakdict = weakref.WeakKeyDictionary() - - def __getitem__(self, key): - if key not in self._weakdict: - self._weakdict[key] = self.default_factory(key) - return self._weakdict[key] - - -@deprecated -def retry_on_eintr(function, *args, **kw): - """Run a function and retry it while getting EINTR errors""" - while True: - try: - return function(*args, **kw) - except IOError as e: - if e.errno != errno.EINTR: - raise - - def without_none_values(iterable): """Return a copy of ``iterable`` with all ``None`` entries removed. @@ -337,10 +303,6 @@ class MutableChain(Iterable): def __next__(self): return next(self.data) - @deprecated("scrapy.utils.python.MutableChain.__next__") - def next(self): - return self.__next__() - async def _async_chain(*iterables: Union[Iterable, AsyncIterable]) -> AsyncGenerator: for it in iterables: diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index b1a8fdc04..403e4f8fe 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -1,18 +1,14 @@ import functools -import gc import operator import platform -from itertools import count -from warnings import catch_warnings, filterwarnings from twisted.trial import unittest -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.defer import deferred_f_from_coro_f, aiter_errback from scrapy.utils.python import ( memoizemethod_noargs, binary_is_text, equal_attributes, - WeakKeyCache, get_func_args, to_bytes, to_unicode, + get_func_args, to_bytes, to_unicode, without_none_values, MutableChain, MutableAsyncChain) @@ -27,12 +23,7 @@ class MutableChainTest(unittest.TestCase): m.extend([9, 10], (11, 12)) self.assertEqual(next(m), 0) self.assertEqual(m.__next__(), 1) - with catch_warnings(record=True) as warnings: - self.assertEqual(m.next(), 2) - self.assertEqual(len(warnings), 1) - self.assertIn('scrapy.utils.python.MutableChain.__next__', - str(warnings[0].message)) - self.assertEqual(list(m), list(range(3, 13))) + self.assertEqual(list(m), list(range(2, 13))) class MutableAsyncChainTest(unittest.TestCase): @@ -209,27 +200,6 @@ class UtilsPythonTestCase(unittest.TestCase): a.meta['z'] = 2 self.assertFalse(equal_attributes(a, b, [compare_z, 'x'])) - def test_weakkeycache(self): - class _Weakme: - pass - - _values = count() - - with catch_warnings(): - filterwarnings("ignore", category=ScrapyDeprecationWarning) - wk = WeakKeyCache(lambda k: next(_values)) - - k = _Weakme() - v = wk[k] - self.assertEqual(v, wk[k]) - self.assertNotEqual(v, wk[_Weakme()]) - self.assertEqual(v, wk[k]) - del k - for _ in range(100): - if wk._weakdict: - gc.collect() - self.assertFalse(len(wk._weakdict)) - def test_get_func_args(self): def f1(a, b, c): pass From 1a6408c3faadbd2b8b7622b8aee230b112620fad Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Mon, 21 Nov 2022 07:30:20 -0300 Subject: [PATCH 243/532] Remove `FilteringLinkExtractor` --- scrapy/linkextractors/__init__.py | 89 ------------------------------- scrapy/linkextractors/lxmlhtml.py | 83 ++++++++++++++++++++++------ tests/test_linkextractors.py | 32 ----------- 3 files changed, 66 insertions(+), 138 deletions(-) diff --git a/scrapy/linkextractors/__init__.py b/scrapy/linkextractors/__init__.py index 08a6ca1e8..b3b1eea55 100644 --- a/scrapy/linkextractors/__init__.py +++ b/scrapy/linkextractors/__init__.py @@ -6,18 +6,6 @@ This package contains a collection of Link Extractors. For more info see docs/topics/link-extractors.rst """ import re -from urllib.parse import urlparse -from warnings import warn - -from parsel.csstranslator import HTMLTranslator -from w3lib.url import canonicalize_url - -from scrapy.utils.deprecate import ScrapyDeprecationWarning -from scrapy.utils.misc import arg_to_iter -from scrapy.utils.url import ( - url_is_from_any_domain, url_has_any_extension, -) - # common file extensions that are not followed if they occur in links IGNORED_EXTENSIONS = [ @@ -55,82 +43,5 @@ def _is_valid_url(url): return url.split('://', 1)[0] in {'http', 'https', 'file', 'ftp'} -class FilteringLinkExtractor: - - _csstranslator = HTMLTranslator() - - def __new__(cls, *args, **kwargs): - from scrapy.linkextractors.lxmlhtml import LxmlLinkExtractor - if issubclass(cls, FilteringLinkExtractor) and not issubclass(cls, LxmlLinkExtractor): - warn('scrapy.linkextractors.FilteringLinkExtractor is deprecated, ' - 'please use scrapy.linkextractors.LinkExtractor instead', - ScrapyDeprecationWarning, stacklevel=2) - return super().__new__(cls) - - def __init__(self, link_extractor, allow, deny, allow_domains, deny_domains, - restrict_xpaths, canonicalize, deny_extensions, restrict_css, restrict_text): - - self.link_extractor = link_extractor - - self.allow_res = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(allow)] - self.deny_res = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(deny)] - - self.allow_domains = set(arg_to_iter(allow_domains)) - self.deny_domains = set(arg_to_iter(deny_domains)) - - self.restrict_xpaths = tuple(arg_to_iter(restrict_xpaths)) - self.restrict_xpaths += tuple(map(self._csstranslator.css_to_xpath, - arg_to_iter(restrict_css))) - - self.canonicalize = canonicalize - if deny_extensions is None: - deny_extensions = IGNORED_EXTENSIONS - self.deny_extensions = {'.' + e for e in arg_to_iter(deny_extensions)} - self.restrict_text = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(restrict_text)] - - def _link_allowed(self, link): - if not _is_valid_url(link.url): - return False - if self.allow_res and not _matches(link.url, self.allow_res): - return False - if self.deny_res and _matches(link.url, self.deny_res): - return False - parsed_url = urlparse(link.url) - if self.allow_domains and not url_is_from_any_domain(parsed_url, self.allow_domains): - return False - if self.deny_domains and url_is_from_any_domain(parsed_url, self.deny_domains): - return False - if self.deny_extensions and url_has_any_extension(parsed_url, self.deny_extensions): - return False - if self.restrict_text and not _matches(link.text, self.restrict_text): - return False - return True - - def matches(self, url): - - if self.allow_domains and not url_is_from_any_domain(url, self.allow_domains): - return False - if self.deny_domains and url_is_from_any_domain(url, self.deny_domains): - return False - - allowed = (regex.search(url) for regex in self.allow_res) if self.allow_res else [True] - denied = (regex.search(url) for regex in self.deny_res) if self.deny_res else [] - return any(allowed) and not any(denied) - - def _process_links(self, links): - links = [x for x in links if self._link_allowed(x)] - if self.canonicalize: - for link in links: - link.url = canonicalize_url(link.url) - links = self.link_extractor._process_links(links) - return links - - def _extract_links(self, *args, **kwargs): - return self.link_extractor._extract_links(*args, **kwargs) - - # Top-level imports from scrapy.linkextractors.lxmlhtml import LxmlLinkExtractor as LinkExtractor diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index b5d2585a8..55639f504 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -3,18 +3,20 @@ Link extractor based on lxml.html """ import operator from functools import partial -from urllib.parse import urljoin +from urllib.parse import urljoin, urlparse import lxml.etree as etree +from parsel.csstranslator import HTMLTranslator from w3lib.html import strip_html5_whitespace from w3lib.url import canonicalize_url, safe_url_string from scrapy.link import Link -from scrapy.linkextractors import FilteringLinkExtractor +from scrapy.linkextractors import (IGNORED_EXTENSIONS, _is_valid_url, _matches, + _re_type, re) from scrapy.utils.misc import arg_to_iter, rel_has_nofollow from scrapy.utils.python import unique as unique_list from scrapy.utils.response import get_base_url - +from scrapy.utils.url import url_has_any_extension, url_is_from_any_domain # from lxml/src/lxml/html/__init__.py XHTML_NAMESPACE = "http://www.w3.org/1999/xhtml" @@ -98,7 +100,8 @@ class LxmlParserLinkExtractor: return links -class LxmlLinkExtractor(FilteringLinkExtractor): +class LxmlLinkExtractor: + _csstranslator = HTMLTranslator() def __init__( self, @@ -118,7 +121,7 @@ class LxmlLinkExtractor(FilteringLinkExtractor): restrict_text=None, ): tags, attrs = set(arg_to_iter(tags)), set(arg_to_iter(attrs)) - lx = LxmlParserLinkExtractor( + self.link_extractor = LxmlParserLinkExtractor( tag=partial(operator.contains, tags), attr=partial(operator.contains, attrs), unique=unique, @@ -126,18 +129,64 @@ class LxmlLinkExtractor(FilteringLinkExtractor): strip=strip, canonicalized=canonicalize ) - super().__init__( - link_extractor=lx, - allow=allow, - deny=deny, - allow_domains=allow_domains, - deny_domains=deny_domains, - restrict_xpaths=restrict_xpaths, - restrict_css=restrict_css, - canonicalize=canonicalize, - deny_extensions=deny_extensions, - restrict_text=restrict_text, - ) + self.allow_res = [x if isinstance(x, _re_type) else re.compile(x) + for x in arg_to_iter(allow)] + self.deny_res = [x if isinstance(x, _re_type) else re.compile(x) + for x in arg_to_iter(deny)] + + self.allow_domains = set(arg_to_iter(allow_domains)) + self.deny_domains = set(arg_to_iter(deny_domains)) + + self.restrict_xpaths = tuple(arg_to_iter(restrict_xpaths)) + self.restrict_xpaths += tuple(map(self._csstranslator.css_to_xpath, + arg_to_iter(restrict_css))) + + if deny_extensions is None: + deny_extensions = IGNORED_EXTENSIONS + self.canonicalize = canonicalize + self.deny_extensions = {'.' + e for e in arg_to_iter(deny_extensions)} + self.restrict_text = [x if isinstance(x, _re_type) else re.compile(x) + for x in arg_to_iter(restrict_text)] + + def _link_allowed(self, link): + if not _is_valid_url(link.url): + return False + if self.allow_res and not _matches(link.url, self.allow_res): + return False + if self.deny_res and _matches(link.url, self.deny_res): + return False + parsed_url = urlparse(link.url) + if self.allow_domains and not url_is_from_any_domain(parsed_url, self.allow_domains): + return False + if self.deny_domains and url_is_from_any_domain(parsed_url, self.deny_domains): + return False + if self.deny_extensions and url_has_any_extension(parsed_url, self.deny_extensions): + return False + if self.restrict_text and not _matches(link.text, self.restrict_text): + return False + return True + + def matches(self, url): + + if self.allow_domains and not url_is_from_any_domain(url, self.allow_domains): + return False + if self.deny_domains and url_is_from_any_domain(url, self.deny_domains): + return False + + allowed = (regex.search(url) for regex in self.allow_res) if self.allow_res else [True] + denied = (regex.search(url) for regex in self.deny_res) if self.deny_res else [] + return any(allowed) and not any(denied) + + def _process_links(self, links): + links = [x for x in links if self._link_allowed(x)] + if self.canonicalize: + for link in links: + link.url = canonicalize_url(link.url) + links = self.link_extractor._process_links(links) + return links + + def _extract_links(self, *args, **kwargs): + return self.link_extractor._extract_links(*args, **kwargs) def extract_links(self, response): """Returns a list of :class:`~scrapy.link.Link` objects from the diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 6f133d77a..e28dc9bdb 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -1,12 +1,9 @@ import pickle import re import unittest -from warnings import catch_warnings -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import HtmlResponse, XmlResponse from scrapy.link import Link -from scrapy.linkextractors import FilteringLinkExtractor from scrapy.linkextractors.lxmlhtml import LxmlLinkExtractor from tests import get_testdata @@ -517,32 +514,3 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): def test_restrict_xpaths_with_html_entities(self): super().test_restrict_xpaths_with_html_entities() - - def test_filteringlinkextractor_deprecation_warning(self): - """Make sure the FilteringLinkExtractor deprecation warning is not - issued for LxmlLinkExtractor""" - with catch_warnings(record=True) as warnings: - LxmlLinkExtractor() - self.assertEqual(len(warnings), 0) - - class SubclassedLxmlLinkExtractor(LxmlLinkExtractor): - pass - - SubclassedLxmlLinkExtractor() - self.assertEqual(len(warnings), 0) - - -class FilteringLinkExtractorTest(unittest.TestCase): - - def test_deprecation_warning(self): - args = [None] * 10 - with catch_warnings(record=True) as warnings: - FilteringLinkExtractor(*args) - self.assertEqual(len(warnings), 1) - self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) - with catch_warnings(record=True) as warnings: - class SubclassedFilteringLinkExtractor(FilteringLinkExtractor): - pass - SubclassedFilteringLinkExtractor(*args) - self.assertEqual(len(warnings), 1) - self.assertEqual(warnings[0].category, ScrapyDeprecationWarning) From c04ccbceb91b99976b674f6a57e15ed5ad5b7565 Mon Sep 17 00:00:00 2001 From: Pablo Hoffman Date: Mon, 21 Nov 2022 15:49:33 +0100 Subject: [PATCH 244/532] doc: add instructions to debug Scrapy spiders in Visual Studio Code --- docs/topics/debug.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/docs/topics/debug.rst b/docs/topics/debug.rst index 4d452b4df..edbcaf432 100644 --- a/docs/topics/debug.rst +++ b/docs/topics/debug.rst @@ -150,3 +150,31 @@ available in all future runs should they be necessary again:: For more information, check the :ref:`topics-logging` section. .. _base tag: https://www.w3schools.com/tags/tag_base.asp + +Visual Studio Code +================== + +.. highlight:: json + +To debug spiders with Visual Studio Code you can use the following ``launch.json``:: + + { + "version": "0.1.0", + "configurations": [ + { + "name": "Python: Launch Scrapy Spider", + "type": "python", + "request": "launch", + "module": "scrapy", + "args": [ + "runspider", + "${file}" + ], + "console": "integratedTerminal" + } + ] + } + + +Also, make sure you enable "User Uncaught Exceptions", to catch exceptions in +your Scrapy spider. From 24a18e9af13a482c1dd6036046226cf57318477b Mon Sep 17 00:00:00 2001 From: Christopher Gambrell Date: Mon, 21 Nov 2022 17:41:06 -0500 Subject: [PATCH 245/532] Adds virtualsize property to _check_limit error log. --- scrapy/extensions/memusage.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index f5081a7d7..aba0c8d7e 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -79,7 +79,7 @@ class MemoryUsage: self.crawler.stats.set_value('memusage/limit_reached', 1) mem = self.limit / 1024 / 1024 logger.error("Memory usage exceeded %(memusage)dM. Shutting down Scrapy...", - {'memusage': mem}, extra={'crawler': self.crawler}) + {'memusage': mem, 'virtualsize': self.get_virtual_size()}, extra={'crawler': self.crawler}) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} terminated: " From 8f2adad7a7f2d858acd082afd6e9a6835bfddcd7 Mon Sep 17 00:00:00 2001 From: Christopher Gambrell Date: Tue, 22 Nov 2022 00:48:24 -0500 Subject: [PATCH 246/532] Log self.get_virtual_size() on every call of _check_limit --- scrapy/extensions/memusage.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index aba0c8d7e..c94899e0f 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -79,7 +79,7 @@ class MemoryUsage: self.crawler.stats.set_value('memusage/limit_reached', 1) mem = self.limit / 1024 / 1024 logger.error("Memory usage exceeded %(memusage)dM. Shutting down Scrapy...", - {'memusage': mem, 'virtualsize': self.get_virtual_size()}, extra={'crawler': self.crawler}) + {'memusage': mem}, extra={'crawler': self.crawler}) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} terminated: " @@ -92,6 +92,8 @@ class MemoryUsage: self.crawler.engine.close_spider(self.crawler.engine.spider, 'memusage_exceeded') else: self.crawler.stop() + else: + logger.info("Current memory usage is %(virtualsize)dM", {'virtualsize': self.get_virtual_size()}) def _check_warning(self): if self.warned: # warn only once From eb159c78f10f546e38e62a9230608269ac13acdd Mon Sep 17 00:00:00 2001 From: Christopher Gambrell Date: Tue, 22 Nov 2022 03:36:00 -0500 Subject: [PATCH 247/532] Use variable and convert to megabytes. --- scrapy/extensions/memusage.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index c94899e0f..bf2ee4e6d 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -75,7 +75,8 @@ class MemoryUsage: self.crawler.stats.max_value('memusage/max', self.get_virtual_size()) def _check_limit(self): - if self.get_virtual_size() > self.limit: + current_mem_usage = self.get_virtual_size() + if current_mem_usage > self.limit: self.crawler.stats.set_value('memusage/limit_reached', 1) mem = self.limit / 1024 / 1024 logger.error("Memory usage exceeded %(memusage)dM. Shutting down Scrapy...", @@ -93,7 +94,7 @@ class MemoryUsage: else: self.crawler.stop() else: - logger.info("Current memory usage is %(virtualsize)dM", {'virtualsize': self.get_virtual_size()}) + logger.info("Current memory usage is %(virtualsize)dM", {'virtualsize': current_mem_usage / 1024 / 1024}) def _check_warning(self): if self.warned: # warn only once From 8e0025f53dc724d986855b572b6237d0a96fd821 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 22 Nov 2022 09:38:45 -0300 Subject: [PATCH 248/532] Remove support for override settings with `SCRAPY_` environment variables --- scrapy/utils/project.py | 17 +++++------------ tests/test_utils_project.py | 18 +++++++----------- 2 files changed, 12 insertions(+), 23 deletions(-) diff --git a/scrapy/utils/project.py b/scrapy/utils/project.py index c66af497e..fce198db4 100644 --- a/scrapy/utils/project.py +++ b/scrapy/utils/project.py @@ -6,7 +6,7 @@ from os.path import join, dirname, abspath, isabs, exists from scrapy.utils.conf import closest_scrapy_cfg, get_config, init_env from scrapy.settings import Settings -from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.exceptions import NotConfigured ENVVAR = 'SCRAPY_SETTINGS_MODULE' @@ -67,23 +67,16 @@ def get_project_settings(): if settings_module_path: settings.setmodule(settings_module_path, priority='project') - scrapy_envvars = {k[7:]: v for k, v in os.environ.items() if - k.startswith('SCRAPY_')} valid_envvars = { 'CHECK', 'PROJECT', 'PYTHON_SHELL', 'SETTINGS_MODULE', } - setting_envvars = {k for k in scrapy_envvars if k not in valid_envvars} - if setting_envvars: - setting_envvar_list = ', '.join(sorted(setting_envvars)) - warnings.warn( - 'Use of environment variables prefixed with SCRAPY_ to override ' - 'settings is deprecated. The following environment variables are ' - f'currently defined: {setting_envvar_list}', - ScrapyDeprecationWarning - ) + + scrapy_envvars = {k[7:]: v for k, v in os.environ.items() if + k.startswith('SCRAPY_') and k.replace('SCRAPY_', '') in valid_envvars} + settings.setdict(scrapy_envvars, priority='project') return settings diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index 46452415a..e77ffa18b 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -5,9 +5,6 @@ import shutil import contextlib import warnings -from pytest import warns - -from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.project import data_path, get_project_settings @@ -80,10 +77,10 @@ class GetProjectSettingsTestCase(unittest.TestCase): envvars = { 'SCRAPY_FOO': 'bar', } - with warns(ScrapyDeprecationWarning, match=': FOO') as record: - with set_env(**envvars): - get_project_settings() - assert len(record) == 1 + with set_env(**envvars): + settings = get_project_settings() + + assert settings.get("SCRAPY_FOO") is None def test_valid_and_invalid_envvars(self): value = 'tests.test_cmdline.settings' @@ -91,8 +88,7 @@ class GetProjectSettingsTestCase(unittest.TestCase): 'SCRAPY_FOO': 'bar', 'SCRAPY_SETTINGS_MODULE': value, } - with warns(ScrapyDeprecationWarning, match=': FOO') as record: - with set_env(**envvars): - settings = get_project_settings() - assert len(record) == 1 + with set_env(**envvars): + settings = get_project_settings() assert settings.get('SETTINGS_MODULE') == value + assert settings.get('SCRAPY_FOO') is None From 1506479672ee54adc2d7d1ecffc0b224f2fcf7aa Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 22 Nov 2022 10:07:32 -0300 Subject: [PATCH 249/532] Remove deprecated test --- tests/test_cmdline/__init__.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/tests/test_cmdline/__init__.py b/tests/test_cmdline/__init__.py index 8233e0101..802f5c198 100644 --- a/tests/test_cmdline/__init__.py +++ b/tests/test_cmdline/__init__.py @@ -31,10 +31,6 @@ class CmdlineTest(unittest.TestCase): self.assertEqual(self._execute('settings', '--get', 'TEST1', '-s', 'TEST1=override'), 'override') - def test_override_settings_using_envvar(self): - self.env['SCRAPY_TEST1'] = 'override' - self.assertEqual(self._execute('settings', '--get', 'TEST1'), 'override') - def test_profiling(self): path = tempfile.mkdtemp() filename = os.path.join(path, 'res.prof') From fc8968672a5cc699f0103aeb2da1ebea7ed3c235 Mon Sep 17 00:00:00 2001 From: Christopher Gambrell Date: Tue, 22 Nov 2022 11:49:28 -0500 Subject: [PATCH 250/532] renamed variables to clarify that we are using peak memory and not current memory utilization. --- scrapy/extensions/memusage.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index bf2ee4e6d..7bc6564e7 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -75,8 +75,8 @@ class MemoryUsage: self.crawler.stats.max_value('memusage/max', self.get_virtual_size()) def _check_limit(self): - current_mem_usage = self.get_virtual_size() - if current_mem_usage > self.limit: + peak_mem_usage = self.get_virtual_size() + if peak_mem_usage > self.limit: self.crawler.stats.set_value('memusage/limit_reached', 1) mem = self.limit / 1024 / 1024 logger.error("Memory usage exceeded %(memusage)dM. Shutting down Scrapy...", @@ -94,7 +94,7 @@ class MemoryUsage: else: self.crawler.stop() else: - logger.info("Current memory usage is %(virtualsize)dM", {'virtualsize': current_mem_usage / 1024 / 1024}) + logger.info("Peak memory usage is %(virtualsize)dM", {'virtualsize': peak_mem_usage / 1024 / 1024}) def _check_warning(self): if self.warned: # warn only once From bdc0bca5b1aab15873b82f93a4bdf8fb3ce82824 Mon Sep 17 00:00:00 2001 From: Christopher Gambrell Date: Tue, 22 Nov 2022 12:10:49 -0500 Subject: [PATCH 251/532] Replace M occurrences with MiB for accuracy. --- scrapy/extensions/memusage.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index 7bc6564e7..4fdf86479 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -79,12 +79,12 @@ class MemoryUsage: if peak_mem_usage > self.limit: self.crawler.stats.set_value('memusage/limit_reached', 1) mem = self.limit / 1024 / 1024 - logger.error("Memory usage exceeded %(memusage)dM. Shutting down Scrapy...", + logger.error("Memory usage exceeded %(memusage)dMiB. Shutting down Scrapy...", {'memusage': mem}, extra={'crawler': self.crawler}) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} terminated: " - f"memory usage exceeded {mem}M at {socket.gethostname()}" + f"memory usage exceeded {mem}MiB at {socket.gethostname()}" ) self._send_report(self.notify_mails, subj) self.crawler.stats.set_value('memusage/limit_notified', 1) @@ -94,7 +94,7 @@ class MemoryUsage: else: self.crawler.stop() else: - logger.info("Peak memory usage is %(virtualsize)dM", {'virtualsize': peak_mem_usage / 1024 / 1024}) + logger.info("Peak memory usage is %(virtualsize)dMiB", {'virtualsize': peak_mem_usage / 1024 / 1024}) def _check_warning(self): if self.warned: # warn only once @@ -102,12 +102,12 @@ class MemoryUsage: if self.get_virtual_size() > self.warning: self.crawler.stats.set_value('memusage/warning_reached', 1) mem = self.warning / 1024 / 1024 - logger.warning("Memory usage reached %(memusage)dM", + logger.warning("Memory usage reached %(memusage)dMiB", {'memusage': mem}, extra={'crawler': self.crawler}) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} warning: " - f"memory usage reached {mem}M at {socket.gethostname()}" + f"memory usage reached {mem}MiB at {socket.gethostname()}" ) self._send_report(self.notify_mails, subj) self.crawler.stats.set_value('memusage/warning_notified', 1) From 1fdd0a70a0d56bc7829aa3028c191c062cd9f935 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Wed, 23 Nov 2022 12:16:48 +0500 Subject: [PATCH 252/532] Restore lost typing --- scrapy/core/http2/stream.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index 780191505..14bf4c5fe 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -151,7 +151,7 @@ class Stream: self._deferred_response = Deferred(_cancel) - def __repr__(self): + def __repr__(self) -> str: return f'Stream(id={self.stream_id!r})' @property From c3b1700774bd16623622963e98fd3ec759b8a88f Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Wed, 23 Nov 2022 12:17:30 +0500 Subject: [PATCH 253/532] Restore lost typing --- scrapy/http/request/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 305eef918..1ececaf1d 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -121,7 +121,7 @@ class Request(object_ref): def encoding(self) -> str: return self._encoding - def __repr__(self): + def __repr__(self) -> str: return f"<{self.method} {self.url}>" def copy(self) -> "Request": From e769532644e1176c7984dd513249285c7f64c7d0 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Wed, 23 Nov 2022 08:30:11 -0300 Subject: [PATCH 254/532] Remove `noconnect` deprecate code --- scrapy/core/downloader/handlers/http11.py | 17 ++--------------- scrapy/core/downloader/handlers/http2.py | 14 +------------- tests/test_downloader_handlers.py | 14 +------------- tests/test_downloader_handlers_http2.py | 15 --------------- 4 files changed, 4 insertions(+), 56 deletions(-) diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index 6b8a18f1a..f07f0780e 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -3,7 +3,6 @@ import ipaddress import logging import re -import warnings from contextlib import suppress from io import BytesIO from time import time @@ -22,7 +21,7 @@ from zope.interface import implementer from scrapy import signals from scrapy.core.downloader.contextfactory import load_context_factory_from_settings from scrapy.core.downloader.webclient import _parse -from scrapy.exceptions import ScrapyDeprecationWarning, StopDownload +from scrapy.exceptions import StopDownload from scrapy.http import Headers from scrapy.responsetypes import responsetypes from scrapy.utils.python import to_bytes, to_unicode @@ -279,17 +278,7 @@ class ScrapyAgent: proxyScheme, proxyNetloc, proxyHost, proxyPort, proxyParams = _parse(proxy) scheme = _parse(request.url)[0] proxyHost = to_unicode(proxyHost) - omitConnectTunnel = b'noconnect' in proxyParams - if omitConnectTunnel: - warnings.warn( - "Using HTTPS proxies in the noconnect mode is deprecated. " - "If you use Zyte Smart Proxy Manager, it doesn't require " - "this mode anymore, so you should update scrapy-crawlera " - "to scrapy-zyte-smartproxy and remove '?noconnect' " - "from the Zyte Smart Proxy Manager URL.", - ScrapyDeprecationWarning, - ) - if scheme == b'https' and not omitConnectTunnel: + if scheme == b'https': proxyAuth = request.headers.get(b'Proxy-Authorization', None) proxyConf = (proxyHost, proxyPort, proxyAuth) return self._TunnelingAgent( @@ -302,8 +291,6 @@ class ScrapyAgent: ) else: proxyScheme = proxyScheme or b'http' - proxyHost = to_bytes(proxyHost, encoding='ascii') - proxyPort = to_bytes(str(proxyPort), encoding='ascii') proxyURI = urlunparse((proxyScheme, proxyNetloc, proxyParams, '', '', '')) return self._ProxyAgent( reactor=reactor, diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index 7bb88a193..3f1b36e92 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -1,4 +1,3 @@ -import warnings from time import time from typing import Optional, Type, TypeVar from urllib.parse import urldefrag @@ -69,19 +68,8 @@ class ScrapyH2Agent: if proxy: _, _, proxy_host, proxy_port, proxy_params = _parse(proxy) scheme = _parse(request.url)[0] - proxy_host = proxy_host.decode() - omit_connect_tunnel = b'noconnect' in proxy_params - if omit_connect_tunnel: - warnings.warn( - "Using HTTPS proxies in the noconnect mode is not " - "supported by the downloader handler. If you use Zyte " - "Smart Proxy Manager, it doesn't require this mode " - "anymore, so you should update scrapy-crawlera to " - "scrapy-zyte-smartproxy and remove '?noconnect' from the " - "Zyte Smart Proxy Manager URL." - ) - if scheme == b'https' and not omit_connect_tunnel: + if scheme == b'https': # ToDo raise NotImplementedError('Tunneling via CONNECT method using HTTP/2.0 is not yet supported') return self._ProxyAgent( diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 883960084..c69bd3da1 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -24,7 +24,7 @@ from scrapy.core.downloader.handlers.http import HTTPDownloadHandler from scrapy.core.downloader.handlers.http10 import HTTP10DownloadHandler from scrapy.core.downloader.handlers.http11 import HTTP11DownloadHandler from scrapy.core.downloader.handlers.s3 import S3DownloadHandler -from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.exceptions import NotConfigured from scrapy.http import Headers, HtmlResponse, Request from scrapy.http.response.text import TextResponse from scrapy.responsetypes import responsetypes @@ -757,18 +757,6 @@ class HttpProxyTestCase(unittest.TestCase): request = Request('http://example.com', meta={'proxy': http_proxy}) return self.download_request(request, Spider('foo')).addCallback(_test) - def test_download_with_proxy_https_noconnect(self): - def _test(response): - self.assertEqual(response.status, 200) - self.assertEqual(response.url, request.url) - self.assertEqual(response.body, b'https://example.com') - - http_proxy = f'{self.getURL("")}?noconnect' - request = Request('https://example.com', meta={'proxy': http_proxy}) - with self.assertWarnsRegex(ScrapyDeprecationWarning, - r'Using HTTPS proxies in the noconnect mode is deprecated'): - return self.download_request(request, Spider('foo')).addCallback(_test) - def test_download_without_proxy(self): def _test(response): self.assertEqual(response.status, 200) diff --git a/tests/test_downloader_handlers_http2.py b/tests/test_downloader_handlers_http2.py index 3a9db3ee5..079267535 100644 --- a/tests/test_downloader_handlers_http2.py +++ b/tests/test_downloader_handlers_http2.py @@ -242,21 +242,6 @@ class Https2ProxyTestCase(Http11ProxyTestCase): def getURL(self, path): return f"{self.scheme}://{self.host}:{self.portno}/{path}" - def test_download_with_proxy_https_noconnect(self): - def _test(response): - self.assertEqual(response.status, 200) - self.assertEqual(response.url, request.url) - self.assertEqual(response.body, b'/') - - http_proxy = f"{self.getURL('')}?noconnect" - request = Request('https://example.com', meta={'proxy': http_proxy}) - with self.assertWarnsRegex( - Warning, - r'Using HTTPS proxies in the noconnect mode is not supported by the ' - r'downloader handler.' - ): - return self.download_request(request, Spider('foo')).addCallback(_test) - @defer.inlineCallbacks def test_download_with_proxy_https_timeout(self): with self.assertRaises(NotImplementedError): From f6e9e6592a28a11517295847b177b14f41cb8a26 Mon Sep 17 00:00:00 2001 From: Hanzallah Burney Date: Wed, 23 Nov 2022 19:48:34 +0500 Subject: [PATCH 255/532] Cleanup settings._DictProxy and scrapy.telnet (#5730) --- scrapy/settings/__init__.py | 24 ------------------------ scrapy/utils/deprecate.py | 5 ++--- 2 files changed, 2 insertions(+), 27 deletions(-) diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index b4e12ffdc..43ee433d1 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -435,30 +435,6 @@ class BaseSettings(MutableMapping): p.text(pformat(self.copy_to_dict())) -class _DictProxy(MutableMapping): - - def __init__(self, settings, priority): - self.o = {} - self.settings = settings - self.priority = priority - - def __len__(self): - return len(self.o) - - def __getitem__(self, k): - return self.o[k] - - def __setitem__(self, k, v): - self.settings.set(k, v, priority=self.priority) - self.o[k] = v - - def __delitem__(self, k): - del self.o[k] - - def __iter__(self, k, v): - return iter(self.o) - - class Settings(BaseSettings): """ This object stores Scrapy settings for the configuration of internal diff --git a/scrapy/utils/deprecate.py b/scrapy/utils/deprecate.py index ae727464c..a0c83f9f1 100644 --- a/scrapy/utils/deprecate.py +++ b/scrapy/utils/deprecate.py @@ -2,6 +2,7 @@ import warnings import inspect +from typing import List, Tuple from scrapy.exceptions import ScrapyDeprecationWarning @@ -126,9 +127,7 @@ def _clspath(cls, forced=None): return f'{cls.__module__}.{cls.__name__}' -DEPRECATION_RULES = [ - ('scrapy.telnet.', 'scrapy.extensions.telnet.'), -] +DEPRECATION_RULES: List[Tuple[str, str]] = [] def update_classpath(path): From b6e98ce6b6c766ee735f45f25f78d957327f54e9 Mon Sep 17 00:00:00 2001 From: Hanzallah Burney Date: Thu, 24 Nov 2022 15:01:15 +0100 Subject: [PATCH 256/532] Remove unnecessary backwards compatibility comments (#5732) --- scrapy/utils/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 6404edda6..7a5f8f065 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -44,14 +44,12 @@ def build_component_list(compdict, custom=None, convert=update_classpath): raise ValueError(f'Invalid value {value} for component {name}, ' 'please provide a real number or None instead') - # BEGIN Backward compatibility for old (base, custom) call signature if isinstance(custom, (list, tuple)): _check_components(custom) return type(custom)(convert(c) for c in custom) if custom is not None: compdict.update(custom) - # END Backward compatibility _validate_values(compdict) compdict = without_none_values(_map_keys(compdict)) From f85c3f3d68b03b12c0af3b3aa09ab5faad19bc37 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 25 Nov 2022 18:46:14 +0600 Subject: [PATCH 257/532] Add a comment about `tmpname + '^'`. --- tests/test_downloader_handlers.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index c69bd3da1..8835267fe 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -109,6 +109,7 @@ class FileTestCase(unittest.TestCase): def setUp(self): self.tmpname = self.mktemp() + # add a special char to check that they are handled correctly with open(self.tmpname + '^', 'w') as f: f.write('0123456789') handler = create_instance(FileDownloadHandler, None, get_crawler()) From f9a29f03d9a0eb9173a91f225177b7bee7d382c9 Mon Sep 17 00:00:00 2001 From: Mark Mayo Date: Sun, 27 Nov 2022 23:00:13 +1300 Subject: [PATCH 258/532] Address some issues reported by Pylint (#5677) Co-authored-by: Felipe Boff Nunes <51033921+felipeboffnunes@users.noreply.github.com> Co-authored-by: Andrey Rahmatullin --- conftest.py | 2 +- docs/_ext/scrapydocs.py | 2 +- docs/conftest.py | 8 +++-- docs/utils/linkfix.py | 9 +++--- pylintrc | 27 +---------------- scrapy/commands/__init__.py | 2 +- scrapy/commands/genspider.py | 2 +- scrapy/commands/parse.py | 2 -- scrapy/core/downloader/handlers/http10.py | 3 +- scrapy/core/downloader/handlers/http11.py | 22 +++++++------- scrapy/core/downloader/tls.py | 1 - scrapy/core/downloader/webclient.py | 4 +-- scrapy/core/http2/agent.py | 2 +- scrapy/core/http2/protocol.py | 2 +- scrapy/core/scheduler.py | 4 +-- scrapy/core/scraper.py | 30 +++++++++---------- scrapy/core/spidermw.py | 21 ++++++------- scrapy/downloadermiddlewares/cookies.py | 3 +- .../downloadermiddlewares/httpcompression.py | 1 - scrapy/downloadermiddlewares/redirect.py | 8 ++--- scrapy/downloadermiddlewares/retry.py | 17 +++++------ scrapy/downloadermiddlewares/robotstxt.py | 3 +- scrapy/downloadermiddlewares/stats.py | 4 +-- scrapy/dupefilters.py | 2 +- scrapy/exporters.py | 4 +-- scrapy/extensions/httpcache.py | 14 ++++----- scrapy/extensions/telnet.py | 2 +- scrapy/extensions/throttle.py | 2 +- scrapy/http/headers.py | 7 ++--- scrapy/http/request/__init__.py | 2 +- scrapy/http/request/form.py | 4 +-- scrapy/linkextractors/lxmlhtml.py | 2 +- scrapy/pipelines/__init__.py | 2 +- scrapy/pipelines/files.py | 6 ++-- scrapy/responsetypes.py | 10 +++---- scrapy/robotstxt.py | 1 - scrapy/settings/__init__.py | 6 ++-- scrapy/spidermiddlewares/offsite.py | 2 +- scrapy/spidermiddlewares/referer.py | 5 ++-- scrapy/spiders/crawl.py | 2 +- scrapy/spiders/sitemap.py | 4 +-- scrapy/utils/conf.py | 14 ++++----- scrapy/utils/defer.py | 22 ++++++-------- scrapy/utils/display.py | 2 +- scrapy/utils/ftp.py | 1 - scrapy/utils/iterators.py | 13 ++++---- scrapy/utils/misc.py | 15 ++++------ scrapy/utils/python.py | 5 ++-- scrapy/utils/response.py | 6 ++-- scrapy/utils/serialize.py | 19 ++++++------ scrapy/utils/spider.py | 5 ++-- setup.py | 2 +- tests/CrawlerProcess/reactor_default.py | 3 +- .../reactor_default_twisted_reactor_select.py | 3 +- tests/CrawlerProcess/reactor_select.py | 4 ++- ..._select_subclass_twisted_reactor_select.py | 4 +-- .../reactor_select_twisted_reactor_select.py | 4 ++- tests/CrawlerRunner/ip_address.py | 8 ++--- tests/mockserver.py | 3 +- tests/test_command_check.py | 4 +-- tests/test_command_parse.py | 8 ++--- tests/test_commands.py | 28 ++++++++--------- tests/test_crawler.py | 5 ++-- tests/test_downloader_handlers.py | 5 ++-- tests/test_downloader_handlers_http2.py | 6 ++-- tests/test_downloadermiddleware_cookies.py | 2 +- ...test_downloadermiddleware_decompression.py | 2 +- tests/test_downloadermiddleware_httpcache.py | 7 ++--- ...st_downloadermiddleware_httpcompression.py | 3 +- tests/test_exporters.py | 6 ++-- tests/test_http2_client_protocol.py | 2 +- tests/test_http_request.py | 2 +- tests/test_http_response.py | 2 +- tests/test_loader_deprecated.py | 5 ++-- tests/test_pipeline_media.py | 4 +-- tests/test_request_attribute_binding.py | 4 +-- tests/test_request_cb_kwargs.py | 2 +- tests/test_scheduler_base.py | 2 -- tests/test_spider.py | 2 +- tests/test_spiderloader/__init__.py | 2 +- tests/test_spidermiddleware_httperror.py | 2 +- tests/test_spidermiddleware_output_chain.py | 1 - tests/test_spidermiddleware_referer.py | 4 +-- tests/test_squeues_request.py | 1 - tests/test_utils_defer.py | 5 ++-- tests/test_utils_deprecate.py | 1 + tests/test_webclient.py | 2 +- 87 files changed, 219 insertions(+), 289 deletions(-) mode change 100755 => 100644 docs/utils/linkfix.py diff --git a/conftest.py b/conftest.py index 7c1da3556..2a5d55083 100644 --- a/conftest.py +++ b/conftest.py @@ -21,7 +21,7 @@ collect_ignore = [ *_py_files("tests/CrawlerRunner"), ] -with Path('tests/ignores.txt').open() as reader: +with Path('tests/ignores.txt').open(encoding="utf-8") as reader: for line in reader: file_path = line.strip() if file_path and file_path[0] != '#': diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index f0f382da3..337604cf1 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -1,8 +1,8 @@ +from operator import itemgetter from docutils.parsers.rst.roles import set_classes from docutils import nodes from docutils.parsers.rst import Directive from sphinx.util.nodes import make_refnode -from operator import itemgetter class settingslist_node(nodes.General, nodes.Element): diff --git a/docs/conftest.py b/docs/conftest.py index 24a72a4b6..a6dacd265 100644 --- a/docs/conftest.py +++ b/docs/conftest.py @@ -1,15 +1,17 @@ from doctest import ELLIPSIS, NORMALIZE_WHITESPACE from pathlib import Path -from scrapy.http.response.html import HtmlResponse from sybil import Sybil +from sybil.parsers.doctest import DocTestParser +from sybil.parsers.skip import skip + try: # >2.0.1 from sybil.parsers.codeblock import PythonCodeBlockParser except ImportError: from sybil.parsers.codeblock import CodeBlockParser as PythonCodeBlockParser -from sybil.parsers.doctest import DocTestParser -from sybil.parsers.skip import skip + +from scrapy.http.response.html import HtmlResponse def load_response(url: str, filename: str) -> HtmlResponse: diff --git a/docs/utils/linkfix.py b/docs/utils/linkfix.py old mode 100755 new mode 100644 index 7a0c5288c..a0d9a1cbd --- a/docs/utils/linkfix.py +++ b/docs/utils/linkfix.py @@ -13,6 +13,7 @@ Author: dufferzafar """ import re +import sys from pathlib import Path @@ -28,11 +29,11 @@ def main(): # Read lines from the linkcheck output file try: - with Path("build/linkcheck/output.txt").open() as out: + with Path("build/linkcheck/output.txt").open(encoding="utf-8") as out: output_lines = out.readlines() except IOError: print("linkcheck output not found; please run linkcheck first.") - exit(1) + sys.exit(1) # For every line, fix the respective file for line in output_lines: @@ -52,12 +53,12 @@ def main(): # Update the previous file if _filename: - Path(_filename).write_text(_contents) + Path(_filename).write_text(_contents, encoding="utf-8") _filename = newfilename # Read the new file to memory - _contents = Path(_filename).read_text() + _contents = Path(_filename).read_text(encoding="utf-8") _contents = _contents.replace(match.group(3), match.group(4)) else: diff --git a/pylintrc b/pylintrc index 18819feba..0a2276fb8 100644 --- a/pylintrc +++ b/pylintrc @@ -9,27 +9,19 @@ disable=abstract-method, arguments-renamed, attribute-defined-outside-init, bad-classmethod-argument, - bad-indentation, bad-mcs-classmethod-argument, - bad-super-call, bare-except, - blacklisted-name, broad-except, c-extension-no-member, catching-non-exception, cell-var-from-loop, comparison-with-callable, - consider-iterating-dictionary, consider-using-dict-items, - consider-using-from-import, consider-using-in, - consider-using-set-comprehension, - consider-using-sys-exit, consider-using-with, cyclic-import, dangerous-default-value, - deprecated-method, - deprecated-module, + disallowed-name, duplicate-code, # https://github.com/PyCQA/pylint/issues/214 eval-used, expression-not-assigned, @@ -52,18 +44,12 @@ disable=abstract-method, lost-exception, method-hidden, missing-docstring, - missing-final-newline, - multiple-imports, - multiple-statements, - no-else-continue, no-else-raise, - no-else-return, no-member, no-method-argument, no-name-in-module, no-self-argument, no-value-for-parameter, - not-an-iterable, not-callable, pointless-statement, pointless-string-statement, @@ -74,10 +60,7 @@ disable=abstract-method, redefined-outer-name, reimported, signature-differs, - singleton-comparison, super-init-not-called, - super-with-arguments, - superfluous-parens, too-few-public-methods, too-many-ancestors, too-many-arguments, @@ -89,31 +72,23 @@ disable=abstract-method, too-many-locals, too-many-public-methods, too-many-return-statements, - trailing-newlines, - trailing-whitespace, unbalanced-tuple-unpacking, undefined-variable, undefined-loop-variable, unexpected-special-method-signature, - ungrouped-imports, - unidiomatic-typecheck, unnecessary-comprehension, unnecessary-dunder-call, - unnecessary-lambda, unnecessary-pass, unreachable, - unspecified-encoding, unsubscriptable-object, unused-argument, unused-import, unused-private-member, unused-variable, unused-wildcard-import, - use-implicit-booleaness-not-comparison, used-before-assignment, useless-object-inheritance, # Required for Python 2 support useless-return, useless-super-delegation, wildcard-import, - wrong-import-order, wrong-import-position diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index c4d4bebb2..d0fb4efd8 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -95,7 +95,7 @@ class ScrapyCommand: self.settings.set('LOG_ENABLED', False, priority='cmdline') if opts.pidfile: - Path(opts.pidfile).write_text(str(os.getpid()) + os.linesep) + Path(opts.pidfile).write_text(str(os.getpid()) + os.linesep, encoding="utf-8") if opts.pdb: failure.startDebugMode() diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index ed9660252..b7c2f85fb 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -63,7 +63,7 @@ class Command(ScrapyCommand): if opts.dump: template_file = self._find_template(opts.dump) if template_file: - print(template_file.read_text()) + print(template_file.read_text(encoding="utf-8")) return if len(args) != 2: raise UsageError() diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index d93ab2ac5..c2df7f8a5 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -6,14 +6,12 @@ from itemadapter import is_item, ItemAdapter from w3lib.url import is_url from twisted.internet.defer import maybeDeferred - from scrapy.commands import BaseRunSpiderCommand from scrapy.http import Request from scrapy.utils import display from scrapy.utils.spider import iterate_spider_output, spidercls_for_request from scrapy.exceptions import UsageError - logger = logging.getLogger(__name__) diff --git a/scrapy/core/downloader/handlers/http10.py b/scrapy/core/downloader/handlers/http10.py index c0146a0a6..a75532d2a 100644 --- a/scrapy/core/downloader/handlers/http10.py +++ b/scrapy/core/downloader/handlers/http10.py @@ -33,5 +33,4 @@ class HTTP10DownloadHandler: crawler=self._crawler, ) return reactor.connectSSL(host, port, factory, client_context_factory) - else: - return reactor.connectTCP(host, port, factory) + return reactor.connectTCP(host, port, factory) diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index f07f0780e..1c98e60e1 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -26,7 +26,6 @@ from scrapy.http import Headers from scrapy.responsetypes import responsetypes from scrapy.utils.python import to_bytes, to_unicode - logger = logging.getLogger(__name__) @@ -289,16 +288,15 @@ class ScrapyAgent: bindAddress=bindaddress, pool=self._pool, ) - else: - proxyScheme = proxyScheme or b'http' - proxyURI = urlunparse((proxyScheme, proxyNetloc, proxyParams, '', '', '')) - return self._ProxyAgent( - reactor=reactor, - proxyURI=to_bytes(proxyURI, encoding='ascii'), - connectTimeout=timeout, - bindAddress=bindaddress, - pool=self._pool, - ) + proxyScheme = proxyScheme or b'http' + proxyURI = urlunparse((proxyScheme, proxyNetloc, proxyParams, '', '', '')) + return self._ProxyAgent( + reactor=reactor, + proxyURI=to_bytes(proxyURI, encoding='ascii'), + connectTimeout=timeout, + bindAddress=bindaddress, + pool=self._pool, + ) return self._Agent( reactor=reactor, @@ -567,7 +565,7 @@ class _ResponseReader(protocol.Protocol): self._finish_response(flags=["dataloss"]) return - elif not self._fail_on_dataloss_warned: + if not self._fail_on_dataloss_warned: logger.warning("Got data loss in %s. If you want to process broken " "responses set the setting DOWNLOAD_FAIL_ON_DATALOSS = False" " -- This message won't be shown in further requests", diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 698a1c85c..7d67a426f 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -7,7 +7,6 @@ from twisted.internet.ssl import AcceptableCiphers from scrapy.utils.ssl import x509name_to_string, get_temp_key_info - logger = logging.getLogger(__name__) diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index 7d048c1e4..255ca62e6 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -1,8 +1,8 @@ import re from time import time from urllib.parse import urlparse, urlunparse, urldefrag - from twisted.web.http import HTTPClient + from twisted.internet import defer from twisted.internet.protocol import ClientFactory @@ -185,7 +185,7 @@ class ScrapyHTTPClientFactory(ClientFactory): @param version: The HTTP version. @type version: L{bytes} @param status: The HTTP status code, an integer represented as a - bytestring. + bytestring. @type status: L{bytes} @param message: The HTTP status message. @type message: L{bytes} diff --git a/scrapy/core/http2/agent.py b/scrapy/core/http2/agent.py index f7b0c3f99..c6b357be3 100644 --- a/scrapy/core/http2/agent.py +++ b/scrapy/core/http2/agent.py @@ -140,7 +140,7 @@ class ScrapyProxyH2Agent(H2Agent): connect_timeout: Optional[float] = None, bind_address: Optional[bytes] = None, ) -> None: - super(ScrapyProxyH2Agent, self).__init__( + super().__init__( reactor=reactor, pool=pool, context_factory=context_factory, diff --git a/scrapy/core/http2/protocol.py b/scrapy/core/http2/protocol.py index 1d150b7ce..6047f9ca8 100644 --- a/scrapy/core/http2/protocol.py +++ b/scrapy/core/http2/protocol.py @@ -42,7 +42,7 @@ class InvalidNegotiatedProtocol(H2Error): self.negotiated_protocol = negotiated_protocol def __str__(self) -> str: - return (f"Expected {PROTOCOL_NAME!r}, received {self.negotiated_protocol!r}") + return f"Expected {PROTOCOL_NAME!r}, received {self.negotiated_protocol!r}" class RemoteTerminatedConnection(H2Error): diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 366449f51..6dd5d51a8 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -333,9 +333,9 @@ class Scheduler(BaseScheduler): path = Path(dqdir, 'active.json') if not path.exists(): return [] - with path.open() as f: + with path.open(encoding="utf-8") as f: return json.load(f) def _write_dqs_state(self, dqdir: str, state: list) -> None: - with Path(dqdir, 'active.json').open('w') as f: + with Path(dqdir, 'active.json').open('w', encoding="utf-8") as f: json.dump(state, f) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index e1fdd8d13..7225e0743 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -152,9 +152,9 @@ class Scraper: """ if isinstance(result, Response): return self.spidermw.scrape_response(self.call_spider, result, request, spider) - else: # result is a Failure - dfd = self.call_spider(result, request, spider) - return dfd.addErrback(self._log_download_errors, result, request, spider) + # else result is a Failure + dfd = self.call_spider(result, request, spider) + return dfd.addErrback(self._log_download_errors, result, request, spider) def call_spider(self, result: Union[Response, Failure], request: Request, spider: Spider) -> Deferred: if isinstance(result, Response): @@ -276,17 +276,15 @@ class Scraper: return self.signals.send_catch_log_deferred( signal=signals.item_dropped, item=item, response=response, spider=spider, exception=output.value) - else: - logkws = self.logformatter.item_error(item, ex, response, spider) - logger.log(*logformatter_adapter(logkws), extra={'spider': spider}, - exc_info=failure_to_exc_info(output)) - return self.signals.send_catch_log_deferred( - signal=signals.item_error, item=item, response=response, - spider=spider, failure=output) - else: - logkws = self.logformatter.scraped(output, response, spider) - if logkws is not None: - logger.log(*logformatter_adapter(logkws), extra={'spider': spider}) + logkws = self.logformatter.item_error(item, ex, response, spider) + logger.log(*logformatter_adapter(logkws), extra={'spider': spider}, + exc_info=failure_to_exc_info(output)) return self.signals.send_catch_log_deferred( - signal=signals.item_scraped, item=output, response=response, - spider=spider) + signal=signals.item_error, item=item, response=response, + spider=spider, failure=output) + logkws = self.logformatter.scraped(output, response, spider) + if logkws is not None: + logger.log(*logformatter_adapter(logkws), extra={'spider': spider}) + return self.signals.send_catch_log_deferred( + signal=signals.item_scraped, item=output, response=response, + spider=spider) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 1aa02f29f..91e4b9cb4 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -121,11 +121,10 @@ class SpiderMiddlewareManager(MiddlewareManager): if dfd.called: # the result is available immediately if _process_spider_output didn't do downgrading return dfd.result - else: - # we forbid waiting here because otherwise we would need to return a deferred from - # _process_spider_exception too, which complicates the architecture - msg = f"Async iterable returned from {method.__qualname__} cannot be downgraded" - raise _InvalidOutput(msg) + # we forbid waiting here because otherwise we would need to return a deferred from + # _process_spider_exception too, which complicates the architecture + msg = f"Async iterable returned from {method.__qualname__} cannot be downgraded" + raise _InvalidOutput(msg) elif result is None: continue else: @@ -213,8 +212,7 @@ class SpiderMiddlewareManager(MiddlewareManager): if last_result_is_async: return MutableAsyncChain(result, recovered) - else: - return MutableChain(result, recovered) # type: ignore[arg-type] + return MutableChain(result, recovered) # type: ignore[arg-type] async def _process_callback_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] ) -> Union[MutableChain, MutableAsyncChain]: @@ -227,11 +225,10 @@ class SpiderMiddlewareManager(MiddlewareManager): result = await maybe_deferred_to_future(self._process_spider_output(response, spider, result)) if isinstance(result, AsyncIterable): return MutableAsyncChain(result, recovered) - else: - if isinstance(recovered, AsyncIterable): - recovered_collected = await collect_asyncgen(recovered) - recovered = MutableChain(recovered_collected) - return MutableChain(result, recovered) # type: ignore[arg-type] + if isinstance(recovered, AsyncIterable): + recovered_collected = await collect_asyncgen(recovered) + recovered = MutableChain(recovered_collected) + return MutableChain(result, recovered) # type: ignore[arg-type] def scrape_response(self, scrape_func: ScrapeFunc, response: Response, request: Request, spider: Spider) -> Deferred: diff --git a/scrapy/downloadermiddlewares/cookies.py b/scrapy/downloadermiddlewares/cookies.py index c592acb57..3cba269f1 100644 --- a/scrapy/downloadermiddlewares/cookies.py +++ b/scrapy/downloadermiddlewares/cookies.py @@ -9,7 +9,6 @@ from scrapy.http.cookies import CookieJar from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_unicode - logger = logging.getLogger(__name__) @@ -129,7 +128,7 @@ class CookiesMiddleware: """ if not request.cookies: return [] - elif isinstance(request.cookies, dict): + if isinstance(request.cookies, dict): cookies = ({"name": k, "value": v} for k, v in request.cookies.items()) else: cookies = request.cookies diff --git a/scrapy/downloadermiddlewares/httpcompression.py b/scrapy/downloadermiddlewares/httpcompression.py index 4e7feeeaf..e57f6fcf8 100644 --- a/scrapy/downloadermiddlewares/httpcompression.py +++ b/scrapy/downloadermiddlewares/httpcompression.py @@ -8,7 +8,6 @@ from scrapy.responsetypes import responsetypes from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.gz import gunzip - ACCEPTED_ENCODINGS = [b'gzip', b'deflate'] try: diff --git a/scrapy/downloadermiddlewares/redirect.py b/scrapy/downloadermiddlewares/redirect.py index c8c84ffb2..fba825947 100644 --- a/scrapy/downloadermiddlewares/redirect.py +++ b/scrapy/downloadermiddlewares/redirect.py @@ -8,7 +8,6 @@ from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.response import get_meta_refresh from scrapy.exceptions import IgnoreRequest, NotConfigured - logger = logging.getLogger(__name__) @@ -56,10 +55,9 @@ class BaseRedirectMiddleware: {'reason': reason, 'redirected': redirected, 'request': request}, extra={'spider': spider}) return redirected - else: - logger.debug("Discarding %(request)s: max redirections reached", - {'request': request}, extra={'spider': spider}) - raise IgnoreRequest("max redirections reached") + logger.debug("Discarding %(request)s: max redirections reached", + {'request': request}, extra={'spider': spider}) + raise IgnoreRequest("max redirections reached") def _redirect_request_using_get(self, request, redirect_url): redirect_request = _build_redirect_request( diff --git a/scrapy/downloadermiddlewares/retry.py b/scrapy/downloadermiddlewares/retry.py index c6cc7c56d..2de610e86 100644 --- a/scrapy/downloadermiddlewares/retry.py +++ b/scrapy/downloadermiddlewares/retry.py @@ -113,15 +113,14 @@ def get_retry_request( stats.inc_value(f'{stats_base_key}/count') stats.inc_value(f'{stats_base_key}/reason_count/{reason}') return new_request - else: - stats.inc_value(f'{stats_base_key}/max_reached') - logger.error( - "Gave up retrying %(request)s (failed %(retry_times)d times): " - "%(reason)s", - {'request': request, 'retry_times': retry_times, 'reason': reason}, - extra={'spider': spider}, - ) - return None + stats.inc_value(f'{stats_base_key}/max_reached') + logger.error( + "Gave up retrying %(request)s (failed %(retry_times)d times): " + "%(reason)s", + {'request': request, 'retry_times': retry_times, 'reason': reason}, + extra={'spider': spider}, + ) + return None class RetryMiddleware: diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index e66bf177e..7bd39aa43 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -81,8 +81,7 @@ class RobotsTxtMiddleware: return result self._parsers[netloc].addCallback(cb) return d - else: - return self._parsers[netloc] + return self._parsers[netloc] def _logerror(self, failure, request, spider): if failure.type is not IgnoreRequest: diff --git a/scrapy/downloadermiddlewares/stats.py b/scrapy/downloadermiddlewares/stats.py index 25fb1ed9d..2bb022c16 100644 --- a/scrapy/downloadermiddlewares/stats.py +++ b/scrapy/downloadermiddlewares/stats.py @@ -1,9 +1,9 @@ +from twisted.web import http + from scrapy.exceptions import NotConfigured from scrapy.utils.python import global_object_name, to_bytes from scrapy.utils.request import request_httprepr -from twisted.web import http - def get_header_size(headers): size = 0 diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index 2b8b09614..6dca11d31 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -55,7 +55,7 @@ class RFPDupeFilter(BaseDupeFilter): self.debug = debug self.logger = logging.getLogger(__name__) if path: - self.file = Path(path, 'requests.seen').open('a+') + self.file = Path(path, 'requests.seen').open('a+', encoding="utf-8") self.file.seek(0) self.fingerprints.update(x.rstrip() for x in self.file) diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 76cbe4d4b..2135c3bbc 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -334,9 +334,9 @@ class PythonItemExporter(BaseItemExporter): def _serialize_value(self, value): if isinstance(value, Item): return self.export_item(value) - elif is_item(value): + if is_item(value): return dict(self._serialize_item(value)) - elif is_listlike(value): + if is_listlike(value): return [self._serialize_value(v) for v in value] encode_func = to_bytes if self.binary else to_unicode if isinstance(value, (str, bytes)): diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 58c4e644e..4e76fe5e5 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -17,7 +17,6 @@ from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.project import data_path from scrapy.utils.python import to_bytes, to_unicode - logger = logging.getLogger(__name__) @@ -81,25 +80,24 @@ class RFC2616Policy: if b'no-store' in cc: return False # Never cache 304 (Not Modified) responses - elif response.status == 304: + if response.status == 304: return False # Cache unconditionally if configured to do so - elif self.always_store: + if self.always_store: return True # Any hint on response expiration is good - elif b'max-age' in cc or b'Expires' in response.headers: + if b'max-age' in cc or b'Expires' in response.headers: return True # Firefox fallbacks this statuses to one year expiration if none is set - elif response.status in (300, 301, 308): + if response.status in (300, 301, 308): return True # Other statuses without expiration requires at least one validator - elif response.status in (200, 203, 401): + if response.status in (200, 203, 401): return b'Last-Modified' in response.headers or b'ETag' in response.headers # Any other is probably not eligible for caching # Makes no sense to cache responses that does not contain expiration # info and can not be revalidated - else: - return False + return False def is_cached_response_fresh(self, cachedresponse, request): cc = self._parse_cachecontrol(cachedresponse) diff --git a/scrapy/extensions/telnet.py b/scrapy/extensions/telnet.py index 1663604e7..054350e4a 100644 --- a/scrapy/extensions/telnet.py +++ b/scrapy/extensions/telnet.py @@ -11,6 +11,7 @@ import binascii import os from twisted.internet import protocol + try: from twisted.conch import manhole, telnet from twisted.conch.insults import insults @@ -26,7 +27,6 @@ from scrapy.utils.engine import print_engine_status from scrapy.utils.reactor import listen_tcp from scrapy.utils.decorators import defers - logger = logging.getLogger(__name__) # signal to update telnet variables diff --git a/scrapy/extensions/throttle.py b/scrapy/extensions/throttle.py index 56e5ad2d2..eb21e426e 100644 --- a/scrapy/extensions/throttle.py +++ b/scrapy/extensions/throttle.py @@ -56,7 +56,7 @@ class AutoThrottle: { 'slot': key, 'concurrency': conc, 'delay': slot.delay * 1000, 'delaydiff': diff * 1000, - 'latency': latency * 1000, 'size': size + 'latency': latency * 1000, 'size': size, }, extra={'spider': spider} ) diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index 9c03fe54f..2e0020890 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -37,12 +37,11 @@ class Headers(CaselessDict): def _tobytes(self, x): if isinstance(x, bytes): return x - elif isinstance(x, str): + if isinstance(x, str): return x.encode(self.encoding) - elif isinstance(x, int): + if isinstance(x, int): return str(x).encode(self.encoding) - else: - raise TypeError(f'Unsupported value type: {type(x)}') + raise TypeError(f'Unsupported value type: {type(x)}') def __getitem__(self, key): try: diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 1ececaf1d..a1001fc4a 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -185,7 +185,7 @@ class Request(object_ref): } for attr in self.attributes: d.setdefault(attr, getattr(self, attr)) - if type(self) is not Request: + if type(self) is not Request: # pylint: disable=unidiomatic-typecheck d["_class"] = self.__module__ + '.' + self.__class__.__name__ return d diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index 0c947565a..8e0a7fae2 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -190,7 +190,7 @@ def _select_value(ele: SelectElement, n: str, v: str): # And for select tags without options o = ele.value_options return (n, o[0]) if o else (None, None) - elif v is not None and multiple: + if v is not None and multiple: # This is a workround to bug in lxml fixed 2.3.1 # fix https://github.com/lxml/lxml/commit/57f49eed82068a20da3db8f1b18ae00c1bab8b12#L1L1139 selected_options = ele.xpath('.//option[@selected]') @@ -236,7 +236,7 @@ def _get_clickable(clickdata: Optional[dict], form: FormElement) -> Optional[Tup el = form.xpath(xpath) if len(el) == 1: return (el[0].get('name'), el[0].get('value') or '') - elif len(el) > 1: + if len(el) > 1: raise ValueError(f"Multiple elements found ({el!r}) matching the " f"criteria in clickdata: {clickdata!r}") else: diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 55639f504..1e6ab984a 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -5,7 +5,7 @@ import operator from functools import partial from urllib.parse import urljoin, urlparse -import lxml.etree as etree +from lxml import etree from parsel.csstranslator import HTMLTranslator from w3lib.html import strip_html5_whitespace from w3lib.url import canonicalize_url, safe_url_string diff --git a/scrapy/pipelines/__init__.py b/scrapy/pipelines/__init__.py index b5725a8ee..c42dd423e 100644 --- a/scrapy/pipelines/__init__.py +++ b/scrapy/pipelines/__init__.py @@ -18,7 +18,7 @@ class ItemPipelineManager(MiddlewareManager): return build_component_list(settings.getwithbase('ITEM_PIPELINES')) def _add_middleware(self, pipe): - super(ItemPipelineManager, self)._add_middleware(pipe) + super()._add_middleware(pipe) if hasattr(pipe, 'process_item'): self.methods['process_item'].append(deferred_f_from_coro_f(pipe.process_item)) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 4e0211d1b..51aedafe8 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -221,16 +221,14 @@ class GCSFilesStore: checksum = blob.md5_hash last_modified = time.mktime(blob.updated.timetuple()) return {'checksum': checksum, 'last_modified': last_modified} - else: - return {} + return {} blob_path = self._get_blob_path(path) return threads.deferToThread(self.bucket.get_blob, blob_path).addCallback(_onsuccess) def _get_content_type(self, headers): if headers and 'Content-Type' in headers: return headers['Content-Type'] - else: - return 'application/octet-stream' + return 'application/octet-stream' def _get_blob_path(self, path): return self.prefix + path diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index 3efd4d2fd..a34d7d25f 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -42,11 +42,10 @@ class ResponseTypes: """Return the most appropriate Response class for the given mimetype""" if mimetype is None: return Response - elif mimetype in self.classes: + if mimetype in self.classes: return self.classes[mimetype] - else: - basetype = f"{mimetype.split('/')[0]}/*" - return self.classes.get(basetype, Response) + basetype = f"{mimetype.split('/')[0]}/*" + return self.classes.get(basetype, Response) def from_content_type(self, content_type, content_encoding=None): """Return the most appropriate Response class from an HTTP Content-Type @@ -83,8 +82,7 @@ class ResponseTypes: mimetype, encoding = self.mimetypes.guess_type(filename) if mimetype and not encoding: return self.from_mimetype(mimetype) - else: - return Response + return Response def from_body(self, body): """Try to guess the appropriate response based on the body content. diff --git a/scrapy/robotstxt.py b/scrapy/robotstxt.py index f8649e56b..1d40f0484 100644 --- a/scrapy/robotstxt.py +++ b/scrapy/robotstxt.py @@ -4,7 +4,6 @@ from abc import ABCMeta, abstractmethod from scrapy.utils.python import to_unicode - logger = logging.getLogger(__name__) diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index 43ee433d1..b540e6182 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -24,8 +24,7 @@ def get_settings_priority(priority): """ if isinstance(priority, str): return SETTINGS_PRIORITIES[priority] - else: - return priority + return priority class SettingsAttribute: @@ -260,8 +259,7 @@ class BaseSettings(MutableMapping): """ if len(self) > 0: return max(self.getpriority(name) for name in self) - else: - return get_settings_priority('default') + return get_settings_priority('default') def __setitem__(self, name, value): self.set(name, value) diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index 448bc1367..98a186510 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -65,7 +65,7 @@ class OffsiteMiddleware: for domain in allowed_domains: if domain is None: continue - elif url_pattern.match(domain): + if url_pattern.match(domain): message = ("allowed_domains accepts only domains, not URLs. " f"Ignoring URL entry {domain} in allowed_domains.") warnings.warn(message, URLWarning) diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index 8027beb92..4a6c4de5e 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -189,8 +189,7 @@ class OriginWhenCrossOriginPolicy(ReferrerPolicy): origin = self.origin(response_url) if origin == self.origin(request_url): return self.stripped_referrer(response_url) - else: - return origin + return origin class StrictOriginWhenCrossOriginPolicy(ReferrerPolicy): @@ -216,7 +215,7 @@ class StrictOriginWhenCrossOriginPolicy(ReferrerPolicy): origin = self.origin(response_url) if origin == self.origin(request_url): return self.stripped_referrer(response_url) - elif ( + if ( self.tls_protected(response_url) and self.potentially_trustworthy(request_url) or not self.tls_protected(response_url) ): diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index 2d9328633..b514ed9ce 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -26,7 +26,7 @@ def _identity_process_request(request, response): def _get_method(method, spider): if callable(method): return method - elif isinstance(method, str): + if isinstance(method, str): return getattr(spider, method, None) diff --git a/scrapy/spiders/sitemap.py b/scrapy/spiders/sitemap.py index 1f72e76b7..43d138753 100644 --- a/scrapy/spiders/sitemap.py +++ b/scrapy/spiders/sitemap.py @@ -69,7 +69,7 @@ class SitemapSpider(Spider): """ if isinstance(response, XmlResponse): return response.body - elif gzip_magic_number(response): + if gzip_magic_number(response): return gunzip(response.body) # actual gzipped sitemap files are decompressed above ; # if we are here (response body is not gzipped) @@ -80,7 +80,7 @@ class SitemapSpider(Spider): # without actually being a .xml.gz file in the first place, # merely XML gzip-compressed on the fly, # in other word, here, we have plain XML - elif response.url.endswith('.xml') or response.url.endswith('.xml.gz'): + if response.url.endswith('.xml') or response.url.endswith('.xml.gz'): return response.body diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 126ead020..8ea42ce75 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -35,9 +35,8 @@ def build_component_list(compdict, custom=None, convert=update_classpath): else: compbs.set(convert(k), v, priority=prio) return compbs - else: - _check_components(compdict) - return {convert(k): v for k, v in compdict.items()} + _check_components(compdict) + return {convert(k): v for k, v in compdict.items()} def _validate_values(compdict): """Fail if a value in the components dict is not a real number or None.""" @@ -181,11 +180,10 @@ def feed_process_params_from_cli(settings, output: List[str], output_format=None ) warnings.warn(message, ScrapyDeprecationWarning, stacklevel=2) return {output[0]: {'format': output_format}} - else: - raise UsageError( - 'The -t command-line option cannot be used if multiple output ' - 'URIs are specified' - ) + raise UsageError( + 'The -t command-line option cannot be used if multiple output ' + 'URIs are specified' + ) result: Dict[str, Dict[str, Any]] = {} for element in output: diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 38aefd6d0..ddacfaa49 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -58,10 +58,9 @@ def defer_succeed(result) -> Deferred: def defer_result(result) -> Deferred: if isinstance(result, Deferred): return result - elif isinstance(result, failure.Failure): + if isinstance(result, failure.Failure): return defer_fail(result) - else: - return defer_succeed(result) + return defer_succeed(result) def mustbe_deferred(f: Callable, *args, **kw) -> Deferred: @@ -267,10 +266,9 @@ def deferred_from_coro(o) -> Any: # wrapping the coroutine directly into a Deferred, this doesn't work correctly with coroutines # that use asyncio, e.g. "await asyncio.sleep(1)" return ensureDeferred(o) - else: - # wrapping the coroutine into a Future and then into a Deferred, this requires AsyncioSelectorReactor - event_loop = get_asyncio_event_loop_policy().get_event_loop() - return Deferred.fromFuture(asyncio.ensure_future(o, loop=event_loop)) + # wrapping the coroutine into a Future and then into a Deferred, this requires AsyncioSelectorReactor + event_loop = get_asyncio_event_loop_policy().get_event_loop() + return Deferred.fromFuture(asyncio.ensure_future(o, loop=event_loop)) return o @@ -295,12 +293,11 @@ def maybeDeferred_coro(f: Callable, *args, **kw) -> Deferred: if isinstance(result, Deferred): return result - elif asyncio.isfuture(result) or inspect.isawaitable(result): + if asyncio.isfuture(result) or inspect.isawaitable(result): return deferred_from_coro(result) - elif isinstance(result, failure.Failure): + if isinstance(result, failure.Failure): return defer.fail(result) - else: - return defer.succeed(result) + return defer.succeed(result) def deferred_to_future(d: Deferred) -> Future: @@ -352,5 +349,4 @@ def maybe_deferred_to_future(d: Deferred) -> Union[Deferred, Future]: """ if not is_asyncio_reactor_installed(): return d - else: - return deferred_to_future(d) + return deferred_to_future(d) diff --git a/scrapy/utils/display.py b/scrapy/utils/display.py index d28df40c7..64969cb13 100644 --- a/scrapy/utils/display.py +++ b/scrapy/utils/display.py @@ -5,8 +5,8 @@ pprint and pformat wrappers with colorization support import ctypes import platform import sys -from packaging.version import Version as parse_version from pprint import pformat as pformat_ +from packaging.version import Version as parse_version def _enable_windows_terminal_processing(): diff --git a/scrapy/utils/ftp.py b/scrapy/utils/ftp.py index 6cace4f07..775b25ea8 100644 --- a/scrapy/utils/ftp.py +++ b/scrapy/utils/ftp.py @@ -1,5 +1,4 @@ import posixpath - from ftplib import error_perm, FTP from posixpath import dirname diff --git a/scrapy/utils/iterators.py b/scrapy/utils/iterators.py index 3b504e56a..da77ca46f 100644 --- a/scrapy/utils/iterators.py +++ b/scrapy/utils/iterators.py @@ -138,8 +138,7 @@ def csviter(obj, delimiter=None, headers=None, encoding=None, quotechar=None): {'csvlnum': csv_r.line_num, 'csvrow': len(row), 'csvheader': len(headers)}) continue - else: - yield dict(zip(headers, row)) + yield dict(zip(headers, row)) def _body_or_str(obj, unicode=True): @@ -152,11 +151,9 @@ def _body_or_str(obj, unicode=True): if isinstance(obj, Response): if not unicode: return obj.body - elif isinstance(obj, TextResponse): + if isinstance(obj, TextResponse): return obj.text - else: - return obj.body.decode('utf-8') - elif isinstance(obj, str): + return obj.body.decode('utf-8') + if isinstance(obj, str): return obj if unicode else obj.encode('utf-8') - else: - return obj.decode('utf-8') if unicode else obj + return obj.decode('utf-8') if unicode else obj diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index e0f7ca9e5..1e0342ace 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -30,10 +30,9 @@ def arg_to_iter(arg): """ if arg is None: return [] - elif not isinstance(arg, _ITERABLE_SINGLE_VALUES) and hasattr(arg, '__iter__'): + if not isinstance(arg, _ITERABLE_SINGLE_VALUES) and hasattr(arg, '__iter__'): return arg - else: - return [arg] + return [arg] def load_object(path): @@ -49,9 +48,8 @@ def load_object(path): if not isinstance(path, str): if callable(path): return path - else: - raise TypeError("Unexpected argument type, expected string " - f"or object, got: {type(path)}") + raise TypeError("Unexpected argument type, expected string " + f"or object, got: {type(path)}") try: dot = path.rindex('.') @@ -115,9 +113,8 @@ def extract_regex(regex, text, encoding='utf-8'): if isinstance(text, str): return [replace_entities(s, keep=['lt', 'amp']) for s in strings] - else: - return [replace_entities(to_unicode(s, encoding), keep=['lt', 'amp']) - for s in strings] + return [replace_entities(to_unicode(s, encoding), keep=['lt', 'amp']) + for s in strings] def md5sum(file): diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 0d9fdbf23..9df1c91de 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -187,10 +187,9 @@ def get_func_args(func, stripself=False): elif hasattr(func, '__call__'): if inspect.isroutine(func): return [] - elif getattr(func, '__name__', None) == '__call__': + if getattr(func, '__name__', None) == '__call__': return [] - else: - return get_func_args(func.__call__, True) + return get_func_args(func.__call__, True) else: raise TypeError(f'{type(func)} is not callable') if stripself: diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index 741dce350..23bd2da65 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -9,14 +9,14 @@ import webbrowser from typing import Any, Callable, Iterable, Optional, Tuple, Union from weakref import WeakKeyDictionary +from twisted.web import http +from w3lib import html import scrapy from scrapy.http.response import Response -from twisted.web import http + from scrapy.utils.python import to_bytes, to_unicode from scrapy.utils.decorators import deprecated -from w3lib import html - _baseurl_cache: "WeakKeyDictionary[Response, str]" = WeakKeyDictionary() diff --git a/scrapy/utils/serialize.py b/scrapy/utils/serialize.py index a73cf03c5..3602043f3 100644 --- a/scrapy/utils/serialize.py +++ b/scrapy/utils/serialize.py @@ -16,24 +16,23 @@ class ScrapyJSONEncoder(json.JSONEncoder): def default(self, o): if isinstance(o, set): return list(o) - elif isinstance(o, datetime.datetime): + if isinstance(o, datetime.datetime): return o.strftime(f"{self.DATE_FORMAT} {self.TIME_FORMAT}") - elif isinstance(o, datetime.date): + if isinstance(o, datetime.date): return o.strftime(self.DATE_FORMAT) - elif isinstance(o, datetime.time): + if isinstance(o, datetime.time): return o.strftime(self.TIME_FORMAT) - elif isinstance(o, decimal.Decimal): + if isinstance(o, decimal.Decimal): return str(o) - elif isinstance(o, defer.Deferred): + if isinstance(o, defer.Deferred): return str(o) - elif is_item(o): + if is_item(o): return ItemAdapter(o).asdict() - elif isinstance(o, Request): + if isinstance(o, Request): return f"<{type(o).__name__} {o.method} {o.url}>" - elif isinstance(o, Response): + if isinstance(o, Response): return f"<{type(o).__name__} {o.status} {o.url}>" - else: - return super().default(o) + return super().default(o) class ScrapyJSONDecoder(json.JSONDecoder): diff --git a/scrapy/utils/spider.py b/scrapy/utils/spider.py index d0fd1757d..b2da69404 100644 --- a/scrapy/utils/spider.py +++ b/scrapy/utils/spider.py @@ -12,12 +12,11 @@ logger = logging.getLogger(__name__) def iterate_spider_output(result): if inspect.isasyncgen(result): return result - elif inspect.iscoroutine(result): + if inspect.iscoroutine(result): d = deferred_from_coro(result) d.addCallback(iterate_spider_output) return d - else: - return arg_to_iter(deferred_from_coro(result)) + return arg_to_iter(deferred_from_coro(result)) def iter_spider_classes(module): diff --git a/setup.py b/setup.py index e413ea6e4..82ac86cdd 100644 --- a/setup.py +++ b/setup.py @@ -58,7 +58,7 @@ setup( 'Tracker': 'https://github.com/scrapy/scrapy/issues', }, description='A high-level Web Crawling and Web Scraping framework', - long_description=open('README.rst').read(), + long_description=open('README.rst', encoding="utf-8").read(), author='Scrapy developers', maintainer='Pablo Hoffman', maintainer_email='pablo@pablohoffman.com', diff --git a/tests/CrawlerProcess/reactor_default.py b/tests/CrawlerProcess/reactor_default.py index 2c867df61..06b849de3 100644 --- a/tests/CrawlerProcess/reactor_default.py +++ b/tests/CrawlerProcess/reactor_default.py @@ -1,6 +1,7 @@ +from twisted.internet import reactor # noqa: F401 + import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import reactor # noqa: F401 class NoRequestsSpider(scrapy.Spider): diff --git a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py index c2b30b044..a6dff0e05 100644 --- a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py @@ -1,6 +1,7 @@ +from twisted.internet import reactor # noqa: F401 + import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import reactor # noqa: F401 class NoRequestsSpider(scrapy.Spider): diff --git a/tests/CrawlerProcess/reactor_select.py b/tests/CrawlerProcess/reactor_select.py index ca70c06a0..907f50784 100644 --- a/tests/CrawlerProcess/reactor_select.py +++ b/tests/CrawlerProcess/reactor_select.py @@ -1,6 +1,8 @@ +from twisted.internet import selectreactor + import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import selectreactor + selectreactor.install() diff --git a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py index 0035daf1e..6f48da691 100644 --- a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py @@ -1,7 +1,7 @@ -import scrapy -from scrapy.crawler import CrawlerProcess from twisted.internet.main import installReactor from twisted.internet.selectreactor import SelectReactor +import scrapy +from scrapy.crawler import CrawlerProcess class SelectReactorSubclass(SelectReactor): diff --git a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py index 4f8394edb..c422b13ff 100644 --- a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py @@ -1,6 +1,8 @@ +from twisted.internet import selectreactor + import scrapy from scrapy.crawler import CrawlerProcess -from twisted.internet import selectreactor + selectreactor.install() diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index f545de39f..417294447 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -8,7 +8,6 @@ from twisted.python.runtime import platform from scrapy import Spider, Request from scrapy.crawler import CrawlerRunner from scrapy.utils.log import configure_logging - from tests.mockserver import MockServer, MockDNSServer @@ -30,9 +29,10 @@ class LocalhostSpider(Spider): def parse(self, response): netloc = urlparse(response.url).netloc - self.logger.info("Host: %s" % netloc.split(":")[0]) - self.logger.info("Type: %s" % type(response.ip_address)) - self.logger.info("IP address: %s" % response.ip_address) + host = netloc.split(":")[0] + self.logger.info(f"Host: {host}") + self.logger.info(f"Type: {type(response.ip_address)}") + self.logger.info(f"IP address: {response.ip_address}") if __name__ == "__main__": diff --git a/tests/mockserver.py b/tests/mockserver.py index 7916798f7..6d2d95692 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -29,8 +29,7 @@ def getarg(request, name, default=None, type=None): if type is not None: value = type(value) return value - else: - return default + return default # most of the following resources are copied from twisted.web.test.test_webclient diff --git a/tests/test_command_check.py b/tests/test_command_check.py index 4077a9bce..049076e5c 100644 --- a/tests/test_command_check.py +++ b/tests/test_command_check.py @@ -6,7 +6,7 @@ class CheckCommandTest(CommandTest): command = 'check' def setUp(self): - super(CheckCommandTest, self).setUp() + super().setUp() self.spider_name = 'check_spider' self.spider = (self.proj_mod_path / 'spiders' / 'checkspider.py').resolve() @@ -24,7 +24,7 @@ class CheckSpider(scrapy.Spider): {contracts} \"\"\" {parse_def} - """) + """, encoding="utf-8") def _test_contract(self, contracts='', parse_def='pass'): self._write_contract(contracts, parse_def) diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 4053c95d5..368b80513 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -92,7 +92,7 @@ class MyBadCrawlSpider(CrawlSpider): def parse(self, response): return [scrapy.Item(), dict(foo='bar')] -""") +""", encoding="utf-8") (self.proj_mod_path / 'pipelines.py').write_text(""" import logging @@ -103,9 +103,9 @@ class MyPipeline: def process_item(self, item, spider): logging.info('It Works!') return item -""") +""", encoding="utf-8") - with (self.proj_mod_path / 'settings.py').open("a") as f: + with (self.proj_mod_path / 'settings.py').open("a", encoding="utf-8") as f: f.write(f""" ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} """) @@ -256,7 +256,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} self.assertTrue(file_path.is_file()) content = '[\n{},\n{"foo": "bar"}\n]' - self.assertEqual(file_path.read_text(), content) + self.assertEqual(file_path.read_text(encoding="utf-8"), content) def test_parse_add_options(self): command = parse.Command() diff --git a/tests/test_commands.py b/tests/test_commands.py index ea4cde363..91476abf8 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -107,7 +107,7 @@ class ProjectTest(unittest.TestCase): def find_in_file(self, filename: Union[str, os.PathLike], regex) -> Optional[re.Match]: """Find first pattern occurrence in file""" pattern = re.compile(regex) - with Path(filename).open("r") as f: + with Path(filename).open("r", encoding="utf-8") as f: for line in f: match = pattern.search(line) if match is not None: @@ -475,7 +475,7 @@ class GenspiderCommandTest(CommandTest): assert file_path.exists() # change name of spider but not its file name - with file_path.open('r+') as spider_file: + with file_path.open('r+', encoding="utf-8") as spider_file: file_data = spider_file.read() file_data = file_data.replace("name = \'example\'", "name = \'renamed\'") spider_file.seek(0) @@ -489,14 +489,14 @@ class GenspiderCommandTest(CommandTest): self.assertIn(f"Created spider {file_name!r} using template \'basic\' in module", out) modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) - file_contents_after = file_path.read_text() + file_contents_after = file_path.read_text(encoding="utf-8") self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') self.assertIn(f"{file_path.resolve()} already exists", out) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) - file_contents_after = file_path.read_text() + file_contents_after = file_path.read_text(encoding="utf-8") self.assertEqual(file_contents_after, file_contents_before) def test_same_filename_as_existing_spider_force(self): @@ -536,7 +536,7 @@ class GenspiderStandaloneCommandTest(ProjectTest): self.assertIn(f"Created spider {file_name!r} using template \'basic\' ", out) assert file_path.exists() modify_time_before = file_path.stat().st_mtime - file_contents_before = file_path.read_text() + file_contents_before = file_path.read_text(encoding="utf-8") if force: # use different template to ensure contents were changed @@ -544,14 +544,14 @@ class GenspiderStandaloneCommandTest(ProjectTest): self.assertIn(f"Created spider {file_name!r} using template \'crawl\' ", out) modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) - file_contents_after = file_path.read_text() + file_contents_after = file_path.read_text(encoding="utf-8") self.assertNotEqual(file_contents_after, file_contents_before) else: p, out, err = self.proc('genspider', file_name, 'example.com') self.assertIn(f"{Path(self.temp_path, file_name + '.py').resolve()} already exists", out) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) - file_contents_after = file_path.read_text() + file_contents_after = file_path.read_text(encoding="utf-8") self.assertEqual(file_contents_after, file_contents_before) def test_same_name_as_existing_file_force(self): @@ -596,7 +596,7 @@ class BadSpider(scrapy.Spider): fname = (tmpdir / name).resolve() else: fname = (tmpdir / self.spider_filename).resolve() - fname.write_text(content) + fname.write_text(content, encoding="utf-8") try: yield str(fname) finally: @@ -754,11 +754,11 @@ class MySpider(scrapy.Spider): ) return [] """ - Path(self.cwd, "example.json").write_text("not empty") + Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") args = ['-O', 'example.json'] log = self.get_log(spider_code, args=args) self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) - with Path(self.cwd, "example.json").open() as f2: + with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") @@ -798,7 +798,7 @@ class WindowsRunSpiderCommandTest(RunSpiderCommandTest): spider_filename = 'myspider.pyw' def setUp(self): - super(WindowsRunSpiderCommandTest, self).setUp() + super().setUp() def test_start_requests_errors(self): log = self.get_log(self.badspider, name='badspider.pyw') @@ -860,7 +860,7 @@ class ViewCommandTest(CommandTest): class CrawlCommandTest(CommandTest): def crawl(self, code, args=()): - Path(self.proj_mod_path, 'spiders', 'myspider.py').write_text(code) + Path(self.proj_mod_path, 'spiders', 'myspider.py').write_text(code, encoding="utf-8") return self.proc('crawl', 'myspider', *args) def get_log(self, code, args=()): @@ -912,11 +912,11 @@ class MySpider(scrapy.Spider): ) return [] """ - Path(self.cwd, "example.json").write_text("not empty") + Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") args = ['-O', 'example.json'] log = self.get_log(spider_code, args=args) self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) - with Path(self.cwd, "example.json").open() as f2: + with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") diff --git a/tests/test_crawler.py b/tests/test_crawler.py index c09f1a6f2..e0902fdbe 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -11,6 +11,9 @@ from twisted.internet import defer from twisted.python.versions import Version from twisted.trial import unittest +from pkg_resources import parse_version +from w3lib import __version__ as w3lib_version + import scrapy from scrapy.crawler import Crawler, CrawlerRunner, CrawlerProcess from scrapy.exceptions import ScrapyDeprecationWarning @@ -23,8 +26,6 @@ from scrapy.utils.test import get_crawler from scrapy.extensions.throttle import AutoThrottle from scrapy.extensions import telnet from scrapy.utils.test import get_testenv -from pkg_resources import parse_version -from w3lib import __version__ as w3lib_version from tests.mockserver import MockServer diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 0334be743..3dc2745a0 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -110,7 +110,7 @@ class FileTestCase(unittest.TestCase): def setUp(self): # add a special char to check that they are handled correctly self.tmpname = Path(self.mktemp() + '^') - Path(self.tmpname).write_text('0123456789') + Path(self.tmpname).write_text("0123456789", encoding="utf-8") handler = create_instance(FileDownloadHandler, None, get_crawler()) self.download_request = handler.download_request @@ -722,8 +722,7 @@ class UriResource(resource.Resource): # ToDo: implement proper HTTPS proxy tests, not faking them. if request.method != b'CONNECT': return request.uri - else: - return b'' + return b'' class HttpProxyTestCase(unittest.TestCase): diff --git a/tests/test_downloader_handlers_http2.py b/tests/test_downloader_handlers_http2.py index 079267535..c2fa3ec57 100644 --- a/tests/test_downloader_handlers_http2.py +++ b/tests/test_downloader_handlers_http2.py @@ -171,7 +171,7 @@ class Https2InvalidDNSId(Https2TestCase): """Connect to HTTPS hosts with IP while certificate uses domain names IDs.""" def setUp(self): - super(Https2InvalidDNSId, self).setUp() + super().setUp() self.host = '127.0.0.1' @@ -190,7 +190,7 @@ class Https2InvalidDNSPattern(Https2TestCase): 'SSL connection certificate: issuer "/C=IE/O=Scrapy/CN=127.0.0.1", ' 'subject "/C=IE/O=Scrapy/CN=127.0.0.1"' ) - super(Https2InvalidDNSPattern, self).setUp() + super().setUp() @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") @@ -245,4 +245,4 @@ class Https2ProxyTestCase(Http11ProxyTestCase): @defer.inlineCallbacks def test_download_with_proxy_https_timeout(self): with self.assertRaises(NotImplementedError): - yield super(Https2ProxyTestCase, self).test_download_with_proxy_https_timeout() + yield super().test_download_with_proxy_https_timeout() diff --git a/tests/test_downloadermiddleware_cookies.py b/tests/test_downloadermiddleware_cookies.py index ba7453255..dd835b9c9 100644 --- a/tests/test_downloadermiddleware_cookies.py +++ b/tests/test_downloadermiddleware_cookies.py @@ -1,6 +1,6 @@ import logging -from testfixtures import LogCapture from unittest import TestCase +from testfixtures import LogCapture import pytest diff --git a/tests/test_downloadermiddleware_decompression.py b/tests/test_downloadermiddleware_decompression.py index b2b5ce77d..1c4cae6d1 100644 --- a/tests/test_downloadermiddleware_decompression.py +++ b/tests/test_downloadermiddleware_decompression.py @@ -2,8 +2,8 @@ from unittest import TestCase, main from scrapy.http import Response, XmlResponse from scrapy.downloadermiddlewares.decompression import DecompressionMiddleware from scrapy.spiders import Spider -from tests import get_testdata from scrapy.utils.test import assert_samelines +from tests import get_testdata def _test_data(formats): diff --git a/tests/test_downloadermiddleware_httpcache.py b/tests/test_downloadermiddleware_httpcache.py index 928c007f5..b3d8264ba 100644 --- a/tests/test_downloadermiddleware_httpcache.py +++ b/tests/test_downloadermiddleware_httpcache.py @@ -272,10 +272,9 @@ class RFC2616PolicyTest(DefaultStorageTest): if result: assert isinstance(result, (Request, Response)) return result - else: - result = mw.process_response(request, response, self.spider) - assert isinstance(result, Response) - return result + result = mw.process_response(request, response, self.spider) + assert isinstance(result, Response) + return result except Exception: print('Request', request) print('Response', response) diff --git a/tests/test_downloadermiddleware_httpcompression.py b/tests/test_downloadermiddleware_httpcompression.py index 6f4e217e6..b0272143d 100644 --- a/tests/test_downloadermiddleware_httpcompression.py +++ b/tests/test_downloadermiddleware_httpcompression.py @@ -4,6 +4,7 @@ from pathlib import Path from unittest import TestCase, SkipTest from warnings import catch_warnings +from w3lib.encoding import resolve_encoding from scrapy.spiders import Spider from scrapy.http import Response, Request, HtmlResponse from scrapy.downloadermiddlewares.httpcompression import HttpCompressionMiddleware, ACCEPTED_ENCODINGS @@ -12,8 +13,6 @@ from scrapy.responsetypes import responsetypes from scrapy.utils.gz import gunzip from scrapy.utils.test import get_crawler from tests import tests_datadir -from w3lib.encoding import resolve_encoding - SAMPLEDIR = Path(tests_datadir, 'compressed') diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 69ac928c3..86c5d8b5e 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -400,8 +400,7 @@ class XmlItemExporterTest(BaseItemExporterTest): children = list(elem.iterchildren()) if children: return [(child.tag, sorted(xmltuple(child))) for child in children] - else: - return [(elem.tag, [(elem.text, ())])] + return [(elem.tag, [(elem.text, ())])] def xmlsplit(xmlcontent): doc = lxml.etree.fromstring(xmlcontent) @@ -621,8 +620,7 @@ class CustomExporterItemTest(unittest.TestCase): def serialize_field(self, field, name, value): if name == 'age': return str(int(value) + 1) - else: - return super().serialize_field(field, name, value) + return super().serialize_field(field, name, value) i = self.item_class(name='John', age='22') a = ItemAdapter(i) diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index 402348cf9..e461bcf2c 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -164,7 +164,7 @@ class RequestHeaders(LeafResource): def get_client_certificate(key_file: Path, certificate_file: Path) -> PrivateCertificate: - pem = key_file.read_text() + certificate_file.read_text() + pem = key_file.read_text(encoding="utf-8") + certificate_file.read_text(encoding="utf-8") return PrivateCertificate.loadPEM(pem) diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 579ef9fa2..9f7f1854f 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -223,7 +223,7 @@ class RequestTest(unittest.TestCase): r1 = CustomRequest('http://www.example.com') r2 = r1.copy() - assert type(r2) is CustomRequest + assert isinstance(r2, CustomRequest) def test_replace(self): """Test Request.replace() method""" diff --git a/tests/test_http_response.py b/tests/test_http_response.py index b42c95045..f51f3d988 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -102,7 +102,7 @@ class BaseResponseTest(unittest.TestCase): r1 = CustomResponse('http://www.example.com') r2 = r1.copy() - assert type(r2) is CustomResponse + assert isinstance(r2, CustomResponse) def test_replace(self): """Test Response.replace() method""" diff --git a/tests/test_loader_deprecated.py b/tests/test_loader_deprecated.py index 0fd52da5f..14b3b5568 100644 --- a/tests/test_loader_deprecated.py +++ b/tests/test_loader_deprecated.py @@ -391,10 +391,9 @@ class BasicItemLoaderTest(unittest.TestCase): def join(values, sep=None, loader_context=None, ignored=None): if sep is not None: return sep.join(values) - elif loader_context and 'sep' in loader_context: + if loader_context and 'sep' in loader_context: return loader_context['sep'].join(values) - else: - return ''.join(values) + return ''.join(values) class TestItemLoader(NameItemLoader): name_out = Compose(partial(join, sep='+')) diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 84e867660..0a94ae699 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -388,11 +388,11 @@ class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): def thumb_path(self, request, thumb_id, response=None, info=None): self._mockcalled.append('thumb_path') - return super(MockedMediaPipelineDeprecatedMethods, self).thumb_path(request, thumb_id, response, info) + return super().thumb_path(request, thumb_id, response, info) def get_images(self, response, request, info): self._mockcalled.append('get_images') - return super(MockedMediaPipelineDeprecatedMethods, self).get_images(response, request, info) + return super().get_images(response, request, info) def image_downloaded(self, response, request, info): self._mockcalled.append('image_downloaded') diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index 0406d906f..15e400327 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -1,12 +1,12 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase +from testfixtures import LogCapture + from scrapy import Request, signals from scrapy.http.response import Response from scrapy.utils.test import get_crawler -from testfixtures import LogCapture - from tests.mockserver import MockServer from tests.spiders import SingleRequestSpider diff --git a/tests/test_request_cb_kwargs.py b/tests/test_request_cb_kwargs.py index 002a04358..63e3aac00 100644 --- a/tests/test_request_cb_kwargs.py +++ b/tests/test_request_cb_kwargs.py @@ -91,7 +91,7 @@ class KeywordArgumentsSpider(MockServerSpider): self.checks.append(kwargs['callback'] == 'some_callback') self.crawler.stats.inc_value('boolean_checks', 3) elif response.url.endswith('/general_without'): - self.checks.append(kwargs == {}) + self.checks.append(kwargs == {}) # pylint: disable=use-implicit-booleaness-not-comparison self.crawler.stats.inc_value('boolean_checks') def parse_no_kwargs(self, response): diff --git a/tests/test_scheduler_base.py b/tests/test_scheduler_base.py index fc234a83d..6602b626d 100644 --- a/tests/test_scheduler_base.py +++ b/tests/test_scheduler_base.py @@ -11,10 +11,8 @@ from scrapy.http import Request from scrapy.spiders import Spider from scrapy.utils.request import fingerprint from scrapy.utils.test import get_crawler - from tests.mockserver import MockServer - PATHS = ["/a", "/b", "/c"] URLS = [urljoin("https://example.org", p) for p in PATHS] diff --git a/tests/test_spider.py b/tests/test_spider.py index e1527620f..cb66066b0 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -7,6 +7,7 @@ from unittest import mock from testfixtures import LogCapture from twisted.trial import unittest +from w3lib.url import safe_url_string from scrapy import signals from scrapy.settings import Settings from scrapy.http import Request, Response, TextResponse, XmlResponse, HtmlResponse @@ -22,7 +23,6 @@ from scrapy.spiders import ( from scrapy.linkextractors import LinkExtractor from scrapy.utils.test import get_crawler from tests import get_testdata -from w3lib.url import safe_url_string class SpiderTest(unittest.TestCase): diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 697105967..0b6b51a5b 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -3,6 +3,7 @@ import shutil import warnings from pathlib import Path +import tempfile from zope.interface.verify import verifyObject from twisted.trial import unittest @@ -10,7 +11,6 @@ from twisted.trial import unittest # ugly hack to avoid cyclic imports of scrapy.spiders when running this test # alone import scrapy -import tempfile from scrapy.interfaces import ISpiderLoader from scrapy.spiderloader import SpiderLoader from scrapy.settings import Settings diff --git a/tests/test_spidermiddleware_httperror.py b/tests/test_spidermiddleware_httperror.py index 46f74ae52..ee11ee492 100644 --- a/tests/test_spidermiddleware_httperror.py +++ b/tests/test_spidermiddleware_httperror.py @@ -6,11 +6,11 @@ from twisted.trial.unittest import TestCase as TrialTestCase from twisted.internet import defer from scrapy.utils.test import get_crawler -from tests.mockserver import MockServer from scrapy.http import Response, Request from scrapy.spiders import Spider from scrapy.spidermiddlewares.httperror import HttpErrorMiddleware, HttpError from scrapy.settings import Settings +from tests.mockserver import MockServer from tests.spiders import MockServerSpider diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index dac246fb6..8dd1def17 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -4,7 +4,6 @@ from twisted.trial.unittest import TestCase from scrapy import Request, Spider from scrapy.utils.test import get_crawler - from tests.mockserver import MockServer diff --git a/tests/test_spidermiddleware_referer.py b/tests/test_spidermiddleware_referer.py index 9456b01d4..63daf0b8a 100644 --- a/tests/test_spidermiddleware_referer.py +++ b/tests/test_spidermiddleware_referer.py @@ -1,8 +1,8 @@ from urllib.parse import urlparse from unittest import TestCase import warnings - from scrapy.http import Response, Request + from scrapy.settings import Settings from scrapy.spiders import Spider from scrapy.downloadermiddlewares.redirect import RedirectMiddleware @@ -380,7 +380,7 @@ class CustomPythonOrgPolicy(ReferrerPolicy): scheme = urlparse(request).scheme if scheme == 'https': return b'https://python.org/' - elif scheme == 'http': + if scheme == 'http': return b'http://python.org/' diff --git a/tests/test_squeues_request.py b/tests/test_squeues_request.py index c5fcc1853..22dafb2d2 100644 --- a/tests/test_squeues_request.py +++ b/tests/test_squeues_request.py @@ -16,7 +16,6 @@ from scrapy.http import Request from scrapy.spiders import Spider from scrapy.utils.test import get_crawler - """ Queues that handle requests """ diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index d39de7430..97c1c60d1 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -193,9 +193,8 @@ class AsyncCooperatorTest(unittest.TestCase): delay = random.random() / 8 reactor.callLater(delay, dfd.callback, None) return dfd - else: - # simulate trivial sync processing - results.append(o) + # simulate trivial sync processing + results.append(o) @staticmethod def get_async_iterable(length): diff --git a/tests/test_utils_deprecate.py b/tests/test_utils_deprecate.py index e47afa266..50c63dfab 100644 --- a/tests/test_utils_deprecate.py +++ b/tests/test_utils_deprecate.py @@ -2,6 +2,7 @@ import inspect import unittest from unittest import mock import warnings + from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.deprecate import create_deprecated_class, update_classpath diff --git a/tests/test_webclient.py b/tests/test_webclient.py index 69d9a9e3a..3dcaf71dd 100644 --- a/tests/test_webclient.py +++ b/tests/test_webclient.py @@ -47,7 +47,7 @@ def getPage(url, contextFactory=None, response_transform=None, *args, **kwargs): from twisted.web.client import _makeGetterFactory return _makeGetterFactory( - to_bytes(url), _clientfactory, contextFactory=contextFactory, *args, **kwargs + to_bytes(url), _clientfactory, contextFactory=contextFactory, *args, **kwargs, ).deferred From 5bd27191a2fd9ec50936c05a377f76bd14aa8266 Mon Sep 17 00:00:00 2001 From: Andrey Rahmatullin Date: Mon, 28 Nov 2022 23:37:57 +0500 Subject: [PATCH 259/532] Bump mypy, flake8, and pylint (#5738) --- scrapy/commands/__init__.py | 2 +- scrapy/core/scraper.py | 24 ++++++++++++++++++++++-- scrapy/crawler.py | 4 ++-- scrapy/http/response/__init__.py | 7 +++---- scrapy/http/response/text.py | 6 ++---- scrapy/middleware.py | 4 ++-- tox.ini | 6 +++--- 7 files changed, 35 insertions(+), 18 deletions(-) diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index d0fb4efd8..b9ba3335e 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -23,7 +23,7 @@ class ScrapyCommand: exitcode = 0 - def __init__(self): + def __init__(self) -> None: self.settings: Any = None # set in scrapy.cmdline def set_crawler(self, crawler): diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 7225e0743..69ac1cdaf 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -1,8 +1,22 @@ """This module implements the Scraper component which parses responses and extracts information from them""" +from __future__ import annotations + import logging from collections import deque -from typing import Any, AsyncGenerator, AsyncIterable, Deque, Generator, Iterable, Optional, Set, Tuple, Union +from typing import ( + Any, + AsyncGenerator, + AsyncIterable, + Deque, + Generator, + Iterable, + Optional, + Set, + TYPE_CHECKING, + Tuple, + Union, +) from itemadapter import is_item from twisted.internet.defer import Deferred, inlineCallbacks @@ -26,6 +40,10 @@ from scrapy.utils.misc import load_object, warn_on_generator_with_return_value from scrapy.utils.spider import iterate_spider_output +if TYPE_CHECKING: + from scrapy.crawler import Crawler + + QueueTuple = Tuple[Union[Response, Failure], Request, Deferred] @@ -75,7 +93,7 @@ class Slot: class Scraper: - def __init__(self, crawler): + def __init__(self, crawler: Crawler) -> None: self.slot: Optional[Slot] = None self.spidermw = SpiderMiddlewareManager.from_crawler(crawler) itemproc_cls = load_object(crawler.settings['ITEM_PROCESSOR']) @@ -174,6 +192,7 @@ class Scraper: def handle_spider_error(self, _failure: Failure, request: Request, response: Response, spider: Spider) -> None: exc = _failure.value if isinstance(exc, CloseSpider): + assert self.crawler.engine is not None # typing self.crawler.engine.close_spider(spider, exc.reason or 'cancelled') return logkws = self.logformatter.spider_error(_failure, request, response, spider) @@ -214,6 +233,7 @@ class Scraper: """ assert self.slot is not None # typing if isinstance(output, Request): + assert self.crawler.engine is not None # typing self.crawler.engine.crawl(request=output) elif is_item(output): self.slot.itemproc_size += 1 diff --git a/scrapy/crawler.py b/scrapy/crawler.py index 04c6891e3..4700a30ab 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -4,7 +4,7 @@ import logging import pprint import signal import warnings -from typing import TYPE_CHECKING +from typing import TYPE_CHECKING, Optional from twisted.internet import defer from zope.interface.exceptions import DoesNotImplement @@ -109,7 +109,7 @@ class Crawler: self.settings.freeze() self.crawling = False self.spider = None - self.engine = None + self.engine: Optional[ExecutionEngine] = None @defer.inlineCallbacks def crawl(self, *args, **kwargs): diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index fb2d0f165..7626946ec 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -140,8 +140,7 @@ class Response(object_ref): def follow(self, url, callback=None, method='GET', headers=None, body=None, cookies=None, meta=None, encoding='utf-8', priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None): - # type: (...) -> Request + dont_filter=False, errback=None, cb_kwargs=None, flags=None) -> Request: """ Return a :class:`~.Request` instance to follow a link ``url``. It accepts the same arguments as ``Request.__init__`` method, @@ -179,8 +178,8 @@ class Response(object_ref): def follow_all(self, urls, callback=None, method='GET', headers=None, body=None, cookies=None, meta=None, encoding='utf-8', priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None): - # type: (...) -> Generator[Request, None, None] + dont_filter=False, errback=None, cb_kwargs=None, + flags=None) -> Generator[Request, None, None]: """ .. versionadded:: 2.0 diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index bfcde878d..da81d0a4a 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -142,8 +142,7 @@ class TextResponse(Response): def follow(self, url, callback=None, method='GET', headers=None, body=None, cookies=None, meta=None, encoding=None, priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None): - # type: (...) -> Request + dont_filter=False, errback=None, cb_kwargs=None, flags=None) -> Request: """ Return a :class:`~.Request` instance to follow a link ``url``. It accepts the same arguments as ``Request.__init__`` method, @@ -184,8 +183,7 @@ class TextResponse(Response): def follow_all(self, urls=None, callback=None, method='GET', headers=None, body=None, cookies=None, meta=None, encoding=None, priority=0, dont_filter=False, errback=None, cb_kwargs=None, flags=None, - css=None, xpath=None): - # type: (...) -> Generator[Request, None, None] + css=None, xpath=None) -> Generator[Request, None, None]: """ A generator that produces :class:`~.Request` instances to follow all links in ``urls``. It accepts the same arguments as the :class:`~.Request`'s diff --git a/scrapy/middleware.py b/scrapy/middleware.py index 8d7e5a602..431bd76dc 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -1,7 +1,7 @@ import logging import pprint from collections import defaultdict, deque -from typing import Callable, Deque, Dict, Iterable, Tuple, Union, cast +from typing import Any, Callable, Deque, Dict, Iterable, Tuple, Union, cast from twisted.internet.defer import Deferred @@ -19,7 +19,7 @@ class MiddlewareManager: component_name = 'foo middleware' - def __init__(self, *middlewares): + def __init__(self, *middlewares: Any) -> None: self.middlewares = middlewares # Only process_spider_output and process_spider_exception can be None. # Only process_spider_output can be a tuple, and only until _async compatibility methods are removed. diff --git a/tox.ini b/tox.ini index eee99cb2d..4d0f0291b 100644 --- a/tox.ini +++ b/tox.ini @@ -38,7 +38,7 @@ install_command = basepython = python3 deps = lxml-stubs==0.2.0 - mypy==0.982 + mypy==0.991 types-attrs==19.1.0 types-pyOpenSSL==21.0.0 types-setuptools==57.0.0 @@ -58,7 +58,7 @@ deps = {[testenv]deps} # Twisted[http2] is required to import some files Twisted[http2]>=17.9.0 - flake8==5.0.4 + flake8==6.0.0 commands = flake8 {posargs:docs scrapy tests} @@ -67,7 +67,7 @@ commands = basepython = python3.8 deps = {[testenv:extra-deps]deps} - pylint==2.15.3 + pylint==2.15.6 commands = pylint conftest.py docs extras scrapy setup.py tests From e211ec0aa26ecae0da8ae55d064ea60e1efe4d0d Mon Sep 17 00:00:00 2001 From: Emmanuel Rondan Date: Tue, 29 Nov 2022 11:30:46 -0300 Subject: [PATCH 260/532] adding black formatter to all the code --- conftest.py | 21 +- docs/_ext/scrapydocs.py | 76 +- docs/conf.py | 175 +- docs/conftest.py | 8 +- docs/utils/linkfix.py | 4 +- extras/qps-bench-server.py | 15 +- extras/qpsclient.py | 10 +- scrapy/__init__.py | 15 +- scrapy/__main__.py | 2 +- scrapy/cmdline.py | 32 +- scrapy/commands/__init__.py | 123 +- scrapy/commands/bench.py | 22 +- scrapy/commands/check.py | 27 +- scrapy/commands/crawl.py | 11 +- scrapy/commands/edit.py | 12 +- scrapy/commands/fetch.py | 39 +- scrapy/commands/genspider.py | 94 +- scrapy/commands/list.py | 2 +- scrapy/commands/parse.py | 153 +- scrapy/commands/runspider.py | 4 +- scrapy/commands/settings.py | 40 +- scrapy/commands/shell.py | 42 +- scrapy/commands/startproject.py | 61 +- scrapy/commands/version.py | 12 +- scrapy/commands/view.py | 7 +- scrapy/contracts/__init__.py | 35 +- scrapy/contracts/default.py | 60 +- scrapy/core/downloader/__init__.py | 58 +- scrapy/core/downloader/contextfactory.py | 49 +- scrapy/core/downloader/handlers/__init__.py | 23 +- scrapy/core/downloader/handlers/datauri.py | 7 +- scrapy/core/downloader/handlers/ftp.py | 22 +- scrapy/core/downloader/handlers/http10.py | 9 +- scrapy/core/downloader/handlers/http11.py | 259 ++- scrapy/core/downloader/handlers/http2.py | 38 +- scrapy/core/downloader/handlers/s3.py | 60 +- scrapy/core/downloader/middleware.py | 43 +- scrapy/core/downloader/tls.py | 56 +- scrapy/core/downloader/webclient.py | 56 +- scrapy/core/engine.py | 154 +- scrapy/core/http2/agent.py | 14 +- scrapy/core/http2/protocol.py | 118 +- scrapy/core/http2/stream.py | 234 +- scrapy/core/scheduler.py | 96 +- scrapy/core/scraper.py | 180 +- scrapy/core/spidermw.py | 189 +- scrapy/crawler.py | 75 +- scrapy/downloadermiddlewares/ajaxcrawl.py | 32 +- scrapy/downloadermiddlewares/cookies.py | 35 +- scrapy/downloadermiddlewares/decompression.py | 21 +- .../downloadermiddlewares/defaultheaders.py | 3 +- .../downloadermiddlewares/downloadtimeout.py | 7 +- scrapy/downloadermiddlewares/httpauth.py | 24 +- scrapy/downloadermiddlewares/httpcache.py | 82 +- .../downloadermiddlewares/httpcompression.py | 40 +- scrapy/downloadermiddlewares/httpproxy.py | 56 +- scrapy/downloadermiddlewares/redirect.py | 82 +- scrapy/downloadermiddlewares/retry.py | 69 +- scrapy/downloadermiddlewares/robotstxt.py | 46 +- scrapy/downloadermiddlewares/stats.py | 36 +- scrapy/downloadermiddlewares/useragent.py | 8 +- scrapy/dupefilters.py | 30 +- scrapy/exceptions.py | 11 +- scrapy/exporters.py | 94 +- scrapy/extension.py | 4 +- scrapy/extensions/closespider.py | 47 +- scrapy/extensions/corestats.py | 19 +- scrapy/extensions/debug.py | 22 +- scrapy/extensions/feedexport.py | 295 +-- scrapy/extensions/httpcache.py | 157 +- scrapy/extensions/logstats.py | 22 +- scrapy/extensions/memdebug.py | 11 +- scrapy/extensions/memusage.py | 56 +- scrapy/extensions/postprocessing.py | 27 +- scrapy/extensions/spiderstate.py | 6 +- scrapy/extensions/statsmailer.py | 1 - scrapy/extensions/telnet.py | 69 +- scrapy/extensions/throttle.py | 34 +- scrapy/http/common.py | 1 + scrapy/http/cookies.py | 27 +- scrapy/http/headers.py | 17 +- scrapy/http/request/__init__.py | 53 +- scrapy/http/request/form.py | 101 +- scrapy/http/request/json_request.py | 30 +- scrapy/http/request/rpc.py | 13 +- scrapy/http/response/__init__.py | 67 +- scrapy/http/response/text.py | 84 +- scrapy/interfaces.py | 1 - scrapy/item.py | 19 +- scrapy/link.py | 12 +- scrapy/linkextractors/__init__.py | 86 +- scrapy/linkextractors/lxmlhtml.py | 85 +- scrapy/loader/common.py | 2 +- scrapy/loader/processors.py | 12 +- scrapy/logformatter.py | 80 +- scrapy/mail.py | 123 +- scrapy/middleware.py | 40 +- scrapy/pipelines/__init__.py | 12 +- scrapy/pipelines/files.py | 321 +-- scrapy/pipelines/images.py | 150 +- scrapy/pipelines/media.py | 69 +- scrapy/pqueues.py | 37 +- scrapy/resolver.py | 24 +- scrapy/responsetypes.py | 65 +- scrapy/robotstxt.py | 16 +- scrapy/selector/unified.py | 19 +- scrapy/settings/__init__.py | 57 +- scrapy/settings/default_settings.py | 220 +- scrapy/shell.py | 63 +- scrapy/signalmanager.py | 11 +- scrapy/spiderloader.py | 19 +- scrapy/spidermiddlewares/depth.py | 27 +- scrapy/spidermiddlewares/httperror.py | 24 +- scrapy/spidermiddlewares/offsite.py | 29 +- scrapy/spidermiddlewares/referer.py | 92 +- scrapy/spidermiddlewares/urllength.py | 11 +- scrapy/spiders/__init__.py | 19 +- scrapy/spiders/crawl.py | 20 +- scrapy/spiders/feed.py | 46 +- scrapy/spiders/init.py | 2 +- scrapy/spiders/sitemap.py | 25 +- scrapy/squeues.py | 31 +- scrapy/statscollectors.py | 11 +- scrapy/utils/asyncgen.py | 2 +- scrapy/utils/benchserver.py | 17 +- scrapy/utils/boto.py | 1 + scrapy/utils/conf.py | 82 +- scrapy/utils/console.py | 41 +- scrapy/utils/curl.py | 50 +- scrapy/utils/datatypes.py | 2 + scrapy/utils/decorators.py | 5 + scrapy/utils/defer.py | 53 +- scrapy/utils/deprecate.py | 36 +- scrapy/utils/display.py | 3 +- scrapy/utils/ftp.py | 8 +- scrapy/utils/gz.py | 10 +- scrapy/utils/httpobj.py | 4 +- scrapy/utils/iterators.py | 67 +- scrapy/utils/job.py | 2 +- scrapy/utils/log.py | 91 +- scrapy/utils/misc.py | 54 +- scrapy/utils/ossignal.py | 5 +- scrapy/utils/project.py | 41 +- scrapy/utils/python.py | 43 +- scrapy/utils/reactor.py | 15 +- scrapy/utils/reqser.py | 14 +- scrapy/utils/request.py | 156 +- scrapy/utils/response.py | 37 +- scrapy/utils/signal.py | 59 +- scrapy/utils/sitemap.py | 22 +- scrapy/utils/spider.py | 20 +- scrapy/utils/ssl.py | 32 +- scrapy/utils/template.py | 14 +- scrapy/utils/test.py | 27 +- scrapy/utils/testproc.py | 10 +- scrapy/utils/testsite.py | 23 +- scrapy/utils/trackref.py | 3 +- scrapy/utils/url.py | 60 +- setup.py | 110 +- tests/CrawlerProcess/asyncio_custom_loop.py | 12 +- .../CrawlerProcess/asyncio_deferred_signal.py | 10 +- .../asyncio_enabled_no_reactor.py | 10 +- .../CrawlerProcess/asyncio_enabled_reactor.py | 11 +- .../asyncio_enabled_reactor_different_loop.py | 13 +- .../asyncio_enabled_reactor_same_loop.py | 13 +- .../caching_hostname_resolver.py | 15 +- .../caching_hostname_resolver_ipv6.py | 11 +- tests/CrawlerProcess/default_name_resolver.py | 1 + tests/CrawlerProcess/multi.py | 2 +- tests/CrawlerProcess/reactor_default.py | 2 +- .../reactor_default_twisted_reactor_select.py | 10 +- tests/CrawlerProcess/reactor_select.py | 2 +- ..._select_subclass_twisted_reactor_select.py | 10 +- .../reactor_select_twisted_reactor_select.py | 10 +- tests/CrawlerProcess/simple.py | 2 +- .../CrawlerProcess/twisted_reactor_asyncio.py | 10 +- .../twisted_reactor_custom_settings.py | 2 +- ...wisted_reactor_custom_settings_conflict.py | 4 +- .../twisted_reactor_custom_settings_same.py | 4 +- tests/CrawlerProcess/twisted_reactor_poll.py | 10 +- .../CrawlerProcess/twisted_reactor_select.py | 10 +- tests/CrawlerRunner/ip_address.py | 2 +- tests/__init__.py | 16 +- tests/ftpserver.py | 8 +- tests/keys/__init__.py | 4 +- tests/mocks/dummydbm.py | 3 +- tests/mockserver.py | 90 +- tests/pipelines.py | 2 - tests/spiders.py | 175 +- tests/test_closespider.py | 33 +- tests/test_cmdline/__init__.py | 39 +- tests/test_cmdline/extensions.py | 3 +- tests/test_cmdline/settings.py | 10 +- .../__init__.py | 7 +- .../test_spider/pipelines.py | 4 +- .../test_spider/settings.py | 4 +- .../test_spider/spiders/exception.py | 6 +- .../test_spider/spiders/normal.py | 6 +- tests/test_command_check.py | 21 +- tests/test_command_fetch.py | 26 +- tests/test_command_parse.py | 179 +- tests/test_command_shell.py | 91 +- tests/test_command_version.py | 28 +- tests/test_commands.py | 594 +++--- tests/test_contracts.py | 122 +- tests/test_core_downloader.py | 5 +- tests/test_crawl.py | 236 ++- tests/test_crawler.py | 346 +-- tests/test_dependencies.py | 22 +- tests/test_downloader_handlers.py | 659 +++--- tests/test_downloader_handlers_http2.py | 111 +- tests/test_downloadermiddleware.py | 82 +- ...test_downloadermiddleware_ajaxcrawlable.py | 32 +- tests/test_downloadermiddleware_cookies.py | 475 +++-- ...test_downloadermiddleware_decompression.py | 18 +- ...est_downloadermiddleware_defaultheaders.py | 13 +- ...st_downloadermiddleware_downloadtimeout.py | 17 +- tests/test_downloadermiddleware_httpauth.py | 78 +- tests/test_downloadermiddleware_httpcache.py | 358 ++-- ...st_downloadermiddleware_httpcompression.py | 279 +-- tests/test_downloadermiddleware_httpproxy.py | 383 ++-- tests/test_downloadermiddleware_redirect.py | 324 +-- tests/test_downloadermiddleware_retry.py | 194 +- tests/test_downloadermiddleware_robotstxt.py | 153 +- tests/test_downloadermiddleware_stats.py | 40 +- tests/test_downloadermiddleware_useragent.py | 40 +- tests/test_dupefilters.py | 178 +- tests/test_engine.py | 192 +- tests/test_engine_stop_download_bytes.py | 43 +- tests/test_engine_stop_download_headers.py | 47 +- tests/test_exporters.py | 243 ++- tests/test_extension_telnet.py | 11 +- tests/test_feedexport.py | 1884 +++++++++-------- tests/test_http2_client_protocol.py | 360 ++-- tests/test_http_cookies.py | 33 +- tests/test_http_headers.py | 185 +- tests/test_http_request.py | 1056 +++++---- tests/test_http_response.py | 649 +++--- tests/test_item.py | 193 +- tests/test_link.py | 21 +- tests/test_linkextractors.py | 763 +++++-- tests/test_loader.py | 400 ++-- tests/test_loader_deprecated.py | 497 +++-- tests/test_logformatter.py | 109 +- tests/test_mail.py | 144 +- tests/test_middleware.py | 32 +- tests/test_pipeline_crawl.py | 90 +- tests/test_pipeline_files.py | 353 +-- tests/test_pipeline_images.py | 320 ++- tests/test_pipeline_media.py | 304 +-- tests/test_pipelines.py | 23 +- tests/test_pqueues.py | 26 +- tests/test_proxy_connect.py | 59 +- tests/test_request_attribute_binding.py | 76 +- tests/test_request_cb_kwargs.py | 134 +- tests/test_request_dict.py | 85 +- tests/test_request_left.py | 11 +- tests/test_responsetypes.py | 97 +- tests/test_robotstxt_interface.py | 98 +- tests/test_scheduler.py | 105 +- tests/test_scheduler_base.py | 6 +- tests/test_selector.py | 95 +- tests/test_settings/__init__.py | 477 +++-- tests/test_settings/default_settings.py | 5 +- tests/test_signals.py | 11 +- tests/test_spider.py | 436 ++-- tests/test_spiderloader/__init__.py | 120 +- .../test_spiders/nested/spider4.py | 4 +- .../test_spiderloader/test_spiders/spider3.py | 4 +- tests/test_spidermiddleware.py | 231 +- tests/test_spidermiddleware_depth.py | 17 +- tests/test_spidermiddleware_httperror.py | 112 +- tests/test_spidermiddleware_offsite.py | 69 +- tests/test_spidermiddleware_output_chain.py | 217 +- tests/test_spidermiddleware_referer.py | 1161 ++++++---- tests/test_spidermiddleware_urllength.py | 21 +- tests/test_spiderstate.py | 13 +- tests/test_squeues.py | 44 +- tests/test_squeues_request.py | 23 +- tests/test_stats.py | 94 +- tests/test_toplevel.py | 5 +- tests/test_urlparse_monkeypatches.py | 11 +- tests/test_utils_asyncio.py | 7 +- tests/test_utils_conf.py | 242 ++- tests/test_utils_console.py | 20 +- tests/test_utils_curl.py | 53 +- tests/test_utils_datatypes.py | 161 +- tests/test_utils_defer.py | 24 +- tests/test_utils_deprecate.py | 132 +- tests/test_utils_display.py | 37 +- tests/test_utils_gz.py | 31 +- tests/test_utils_httpobj.py | 1 - tests/test_utils_iterators.py | 339 +-- tests/test_utils_log.py | 70 +- tests/test_utils_misc/__init__.py | 145 +- ...t_return_with_argument_inside_generator.py | 28 +- tests/test_utils_project.py | 37 +- tests/test_utils_python.py | 105 +- tests/test_utils_request.py | 311 ++- tests/test_utils_response.py | 140 +- tests/test_utils_serialize.py | 31 +- tests/test_utils_signal.py | 26 +- tests/test_utils_sitemap.py | 170 +- tests/test_utils_spider.py | 8 +- tests/test_utils_template.py | 19 +- tests/test_utils_trackref.py | 34 +- tests/test_utils_url.py | 642 +++--- tests/test_webclient.py | 306 +-- 308 files changed, 16487 insertions(+), 11921 deletions(-) diff --git a/conftest.py b/conftest.py index 2a5d55083..585356a3e 100644 --- a/conftest.py +++ b/conftest.py @@ -9,7 +9,7 @@ from tests.keys import generate_keys def _py_files(folder): - return (str(p) for p in Path(folder).rglob('*.py')) + return (str(p) for p in Path(folder).rglob("*.py")) collect_ignore = [ @@ -21,16 +21,16 @@ collect_ignore = [ *_py_files("tests/CrawlerRunner"), ] -with Path('tests/ignores.txt').open(encoding="utf-8") as reader: +with Path("tests/ignores.txt").open(encoding="utf-8") as reader: for line in reader: file_path = line.strip() - if file_path and file_path[0] != '#': + if file_path and file_path[0] != "#": collect_ignore.append(file_path) if not H2_ENABLED: collect_ignore.extend( ( - 'scrapy/core/downloader/handlers/http2.py', + "scrapy/core/downloader/handlers/http2.py", *_py_files("scrapy/core/http2"), ) ) @@ -50,7 +50,7 @@ def pytest_addoption(parser): ) -@pytest.fixture(scope='class') +@pytest.fixture(scope="class") def reactor_pytest(request): if not request.cls: # doctests @@ -61,14 +61,17 @@ def reactor_pytest(request): @pytest.fixture(autouse=True) def only_asyncio(request, reactor_pytest): - if request.node.get_closest_marker('only_asyncio') and reactor_pytest != 'asyncio': - pytest.skip('This test is only run with --reactor=asyncio') + if request.node.get_closest_marker("only_asyncio") and reactor_pytest != "asyncio": + pytest.skip("This test is only run with --reactor=asyncio") @pytest.fixture(autouse=True) def only_not_asyncio(request, reactor_pytest): - if request.node.get_closest_marker('only_not_asyncio') and reactor_pytest == 'asyncio': - pytest.skip('This test is only run without --reactor=asyncio') + if ( + request.node.get_closest_marker("only_not_asyncio") + and reactor_pytest == "asyncio" + ): + pytest.skip("This test is only run without --reactor=asyncio") def pytest_configure(config): diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index 337604cf1..1419792fc 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -11,15 +11,15 @@ class settingslist_node(nodes.General, nodes.Element): class SettingsListDirective(Directive): def run(self): - return [settingslist_node('')] + return [settingslist_node("")] def is_setting_index(node): - if node.tagname == 'index' and node['entries']: + if node.tagname == "index" and node["entries"]: # index entries for setting directives look like: # [('pair', 'SETTING_NAME; setting', 'std:setting-SETTING_NAME', '')] - entry_type, info, refid = node['entries'][0][:3] - return entry_type == 'pair' and info.endswith('; setting') + entry_type, info, refid = node["entries"][0][:3] + return entry_type == "pair" and info.endswith("; setting") return False @@ -30,14 +30,14 @@ def get_setting_target(node): def get_setting_name_and_refid(node): """Extract setting name from directive index node""" - entry_type, info, refid = node['entries'][0][:3] - return info.replace('; setting', ''), refid + entry_type, info, refid = node["entries"][0][:3] + return info.replace("; setting", ""), refid def collect_scrapy_settings_refs(app, doctree): env = app.builder.env - if not hasattr(env, 'scrapy_all_settings'): + if not hasattr(env, "scrapy_all_settings"): env.scrapy_all_settings = [] for node in doctree.traverse(is_setting_index): @@ -46,18 +46,23 @@ def collect_scrapy_settings_refs(app, doctree): setting_name, refid = get_setting_name_and_refid(node) - env.scrapy_all_settings.append({ - 'docname': env.docname, - 'setting_name': setting_name, - 'refid': refid, - }) + env.scrapy_all_settings.append( + { + "docname": env.docname, + "setting_name": setting_name, + "refid": refid, + } + ) def make_setting_element(setting_data, app, fromdocname): - refnode = make_refnode(app.builder, fromdocname, - todocname=setting_data['docname'], - targetid=setting_data['refid'], - child=nodes.Text(setting_data['setting_name'])) + refnode = make_refnode( + app.builder, + fromdocname, + todocname=setting_data["docname"], + targetid=setting_data["refid"], + child=nodes.Text(setting_data["setting_name"]), + ) p = nodes.paragraph() p += refnode @@ -71,10 +76,13 @@ def replace_settingslist_nodes(app, doctree, fromdocname): for node in doctree.traverse(settingslist_node): settings_list = nodes.bullet_list() - settings_list.extend([make_setting_element(d, app, fromdocname) - for d in sorted(env.scrapy_all_settings, - key=itemgetter('setting_name')) - if fromdocname != d['docname']]) + settings_list.extend( + [ + make_setting_element(d, app, fromdocname) + for d in sorted(env.scrapy_all_settings, key=itemgetter("setting_name")) + if fromdocname != d["docname"] + ] + ) node.replace_self(settings_list) @@ -99,41 +107,41 @@ def setup(app): rolename="reqmeta", indextemplate="pair: %s; reqmeta", ) - app.add_role('source', source_role) - app.add_role('commit', commit_role) - app.add_role('issue', issue_role) - app.add_role('rev', rev_role) + app.add_role("source", source_role) + app.add_role("commit", commit_role) + app.add_role("issue", issue_role) + app.add_role("rev", rev_role) app.add_node(settingslist_node) - app.add_directive('settingslist', SettingsListDirective) + app.add_directive("settingslist", SettingsListDirective) - app.connect('doctree-read', collect_scrapy_settings_refs) - app.connect('doctree-resolved', replace_settingslist_nodes) + app.connect("doctree-read", collect_scrapy_settings_refs) + app.connect("doctree-resolved", replace_settingslist_nodes) def source_role(name, rawtext, text, lineno, inliner, options={}, content=[]): - ref = 'https://github.com/scrapy/scrapy/blob/master/' + text + ref = "https://github.com/scrapy/scrapy/blob/master/" + text set_classes(options) node = nodes.reference(rawtext, text, refuri=ref, **options) return [node], [] def issue_role(name, rawtext, text, lineno, inliner, options={}, content=[]): - ref = 'https://github.com/scrapy/scrapy/issues/' + text + ref = "https://github.com/scrapy/scrapy/issues/" + text set_classes(options) - node = nodes.reference(rawtext, 'issue ' + text, refuri=ref, **options) + node = nodes.reference(rawtext, "issue " + text, refuri=ref, **options) return [node], [] def commit_role(name, rawtext, text, lineno, inliner, options={}, content=[]): - ref = 'https://github.com/scrapy/scrapy/commit/' + text + ref = "https://github.com/scrapy/scrapy/commit/" + text set_classes(options) - node = nodes.reference(rawtext, 'commit ' + text, refuri=ref, **options) + node = nodes.reference(rawtext, "commit " + text, refuri=ref, **options) return [node], [] def rev_role(name, rawtext, text, lineno, inliner, options={}, content=[]): - ref = 'http://hg.scrapy.org/scrapy/changeset/' + text + ref = "http://hg.scrapy.org/scrapy/changeset/" + text set_classes(options) - node = nodes.reference(rawtext, 'r' + text, refuri=ref, **options) + node = nodes.reference(rawtext, "r" + text, refuri=ref, **options) return [node], [] diff --git a/docs/conf.py b/docs/conf.py index d2a77003e..38ca81932 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -25,30 +25,30 @@ sys.path.insert(0, str(Path(__file__).parent.parent)) # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ - 'hoverxref.extension', - 'notfound.extension', - 'scrapydocs', - 'sphinx.ext.autodoc', - 'sphinx.ext.coverage', - 'sphinx.ext.intersphinx', - 'sphinx.ext.viewcode', + "hoverxref.extension", + "notfound.extension", + "scrapydocs", + "sphinx.ext.autodoc", + "sphinx.ext.coverage", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", ] # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = ".rst" # The encoding of source files. -#source_encoding = 'utf-8' +# source_encoding = 'utf-8' # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = 'Scrapy' -copyright = f'2008–{datetime.now().year}, Scrapy developers' +project = "Scrapy" +copyright = f"2008–{datetime.now().year}, Scrapy developers" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -57,50 +57,51 @@ copyright = f'2008–{datetime.now().year}, Scrapy developers' # The short X.Y version. try: import scrapy - version = '.'.join(map(str, scrapy.version_info[:2])) + + version = ".".join(map(str, scrapy.version_info[:2])) release = scrapy.__version__ except ImportError: - version = '' - release = '' + version = "" + release = "" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -language = 'en' +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +# today = '' # Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' +# today_fmt = '%B %d, %Y' # List of documents that shouldn't be included in the build. -#unused_docs = [] +# unused_docs = [] -exclude_patterns = ['build'] +exclude_patterns = ["build"] # List of directories, relative to source directory, that shouldn't be searched # for source files. -exclude_trees = ['.build'] +exclude_trees = [".build"] # The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +# add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -#show_authors = False +# show_authors = False # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # List of Sphinx warnings that will not be raised -suppress_warnings = ['epub.unknown_project_files'] +suppress_warnings = ["epub.unknown_project_files"] # Options for HTML output @@ -108,17 +109,18 @@ suppress_warnings = ['epub.unknown_project_files'] # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # Add path to the RTD explicitly to robustify builds (otherwise might # fail in a clean Debian build env) import sphinx_rtd_theme + html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The style sheet to use for HTML and HTML Help pages. A file of that name @@ -128,44 +130,44 @@ html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -#html_title = None +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None +# html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +# html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. -html_last_updated_fmt = '%b %d, %Y' +html_last_updated_fmt = "%b %d, %Y" # Custom sidebar templates, maps document names to template names. -#html_sidebars = {} +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -#html_additional_pages = {} +# html_additional_pages = {} # If false, no module index is generated. -#html_use_modindex = True +# html_use_modindex = True # If false, no index is generated. -#html_use_index = True +# html_use_index = True # If true, the index is split into individual pages for each letter. -#html_split_index = False +# html_split_index = False # If true, the reST sources are included in the HTML build as _sources/. html_copy_source = True @@ -173,16 +175,16 @@ html_copy_source = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -#html_use_opensearch = '' +# html_use_opensearch = '' # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' +# html_file_suffix = '' # Output file base name for HTML help builder. -htmlhelp_basename = 'Scrapydoc' +htmlhelp_basename = "Scrapydoc" html_css_files = [ - 'custom.css', + "custom.css", ] @@ -190,34 +192,33 @@ html_css_files = [ # ------------------------ # The paper size ('letter' or 'a4'). -#latex_paper_size = 'letter' +# latex_paper_size = 'letter' # The font size ('10pt', '11pt' or '12pt'). -#latex_font_size = '10pt' +# latex_font_size = '10pt' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, document class [howto/manual]). latex_documents = [ - ('index', 'Scrapy.tex', 'Scrapy Documentation', - 'Scrapy developers', 'manual'), + ("index", "Scrapy.tex", "Scrapy Documentation", "Scrapy developers", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. -#latex_logo = None +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -#latex_use_parts = False +# latex_use_parts = False # Additional stuff for the LaTeX preamble. -#latex_preamble = '' +# latex_preamble = '' # Documents to append as an appendix to all manuals. -#latex_appendices = [] +# latex_appendices = [] # If false, no module index is generated. -#latex_use_modindex = True +# latex_use_modindex = True # Options for the linkcheck builder @@ -226,8 +227,9 @@ latex_documents = [ # A list of regular expressions that match URIs that should not be checked when # doing a linkcheck build. linkcheck_ignore = [ - 'http://localhost:\d+', 'http://hg.scrapy.org', - 'http://directory.google.com/' + "http://localhost:\d+", + "http://hg.scrapy.org", + "http://directory.google.com/", ] @@ -237,44 +239,35 @@ coverage_ignore_pyobjects = [ # Contract’s add_pre_hook and add_post_hook are not documented because # they should be transparent to contract developers, for whom pre_hook and # post_hook should be the actual concern. - r'\bContract\.add_(pre|post)_hook$', - + r"\bContract\.add_(pre|post)_hook$", # ContractsManager is an internal class, developers are not expected to # interact with it directly in any way. - r'\bContractsManager\b$', - + r"\bContractsManager\b$", # For default contracts we only want to document their general purpose in # their __init__ method, the methods they reimplement to achieve that purpose # should be irrelevant to developers using those contracts. - r'\w+Contract\.(adjust_request_args|(pre|post)_process)$', - + r"\w+Contract\.(adjust_request_args|(pre|post)_process)$", # Methods of downloader middlewares are not documented, only the classes # themselves, since downloader middlewares are controlled through Scrapy # settings. - r'^scrapy\.downloadermiddlewares\.\w*?\.(\w*?Middleware|DownloaderStats)\.', - + r"^scrapy\.downloadermiddlewares\.\w*?\.(\w*?Middleware|DownloaderStats)\.", # Base classes of downloader middlewares are implementation details that # are not meant for users. - r'^scrapy\.downloadermiddlewares\.\w*?\.Base\w*?Middleware', - + r"^scrapy\.downloadermiddlewares\.\w*?\.Base\w*?Middleware", # Private exception used by the command-line interface implementation. - r'^scrapy\.exceptions\.UsageError', - + r"^scrapy\.exceptions\.UsageError", # Methods of BaseItemExporter subclasses are only documented in # BaseItemExporter. - r'^scrapy\.exporters\.(?!BaseItemExporter\b)\w*?\.', - + r"^scrapy\.exporters\.(?!BaseItemExporter\b)\w*?\.", # Extension behavior is only modified through settings. Methods of # extension classes, as well as helper functions, are implementation # details that are not documented. - r'^scrapy\.extensions\.[a-z]\w*?\.[A-Z]\w*?\.', # methods - r'^scrapy\.extensions\.[a-z]\w*?\.[a-z]', # helper functions - + r"^scrapy\.extensions\.[a-z]\w*?\.[A-Z]\w*?\.", # methods + r"^scrapy\.extensions\.[a-z]\w*?\.[a-z]", # helper functions # Never documented before, and deprecated now. - r'^scrapy\.linkextractors\.FilteringLinkExtractor$', - + r"^scrapy\.linkextractors\.FilteringLinkExtractor$", # Implementation detail of LxmlLinkExtractor - r'^scrapy\.linkextractors\.lxmlhtml\.LxmlParserLinkExtractor', + r"^scrapy\.linkextractors\.lxmlhtml\.LxmlParserLinkExtractor", ] @@ -282,18 +275,18 @@ coverage_ignore_pyobjects = [ # ------------------------------------- intersphinx_mapping = { - 'attrs': ('https://www.attrs.org/en/stable/', None), - 'coverage': ('https://coverage.readthedocs.io/en/stable', None), - 'cryptography' : ('https://cryptography.io/en/latest/', None), - 'cssselect': ('https://cssselect.readthedocs.io/en/latest', None), - 'itemloaders': ('https://itemloaders.readthedocs.io/en/latest/', None), - 'pytest': ('https://docs.pytest.org/en/latest', None), - 'python': ('https://docs.python.org/3', None), - 'sphinx': ('https://www.sphinx-doc.org/en/master', None), - 'tox': ('https://tox.wiki/en/latest/', None), - 'twisted': ('https://docs.twisted.org/en/stable/', None), - 'twistedapi': ('https://docs.twisted.org/en/stable/api/', None), - 'w3lib': ('https://w3lib.readthedocs.io/en/latest', None), + "attrs": ("https://www.attrs.org/en/stable/", None), + "coverage": ("https://coverage.readthedocs.io/en/stable", None), + "cryptography": ("https://cryptography.io/en/latest/", None), + "cssselect": ("https://cssselect.readthedocs.io/en/latest", None), + "itemloaders": ("https://itemloaders.readthedocs.io/en/latest/", None), + "pytest": ("https://docs.pytest.org/en/latest", None), + "python": ("https://docs.python.org/3", None), + "sphinx": ("https://www.sphinx-doc.org/en/master", None), + "tox": ("https://tox.wiki/en/latest/", None), + "twisted": ("https://docs.twisted.org/en/stable/", None), + "twistedapi": ("https://docs.twisted.org/en/stable/api/", None), + "w3lib": ("https://w3lib.readthedocs.io/en/latest", None), } intersphinx_disabled_reftypes = [] @@ -313,16 +306,16 @@ hoverxref_role_types = { "setting": "tooltip", "signal": "tooltip", } -hoverxref_roles = ['command', 'reqmeta', 'setting', 'signal'] +hoverxref_roles = ["command", "reqmeta", "setting", "signal"] def setup(app): - app.connect('autodoc-skip-member', maybe_skip_member) + app.connect("autodoc-skip-member", maybe_skip_member) def maybe_skip_member(app, what, name, obj, skip, options): if not skip: # autodocs was generating a text "alias of" for the following members # https://github.com/sphinx-doc/sphinx/issues/4422 - return name in {'default_item_class', 'default_selector_class'} + return name in {"default_item_class", "default_selector_class"} return skip diff --git a/docs/conftest.py b/docs/conftest.py index a6dacd265..32f849a36 100644 --- a/docs/conftest.py +++ b/docs/conftest.py @@ -15,20 +15,20 @@ from scrapy.http.response.html import HtmlResponse def load_response(url: str, filename: str) -> HtmlResponse: - input_path = Path(__file__).parent / '_tests' / filename + input_path = Path(__file__).parent / "_tests" / filename return HtmlResponse(url, body=input_path.read_bytes()) def setup(namespace): - namespace['load_response'] = load_response + namespace["load_response"] = load_response pytest_collect_file = Sybil( parsers=[ DocTestParser(optionflags=ELLIPSIS | NORMALIZE_WHITESPACE), - PythonCodeBlockParser(future_imports=['print_function']), + PythonCodeBlockParser(future_imports=["print_function"]), skip, ], - pattern='*.rst', + pattern="*.rst", setup=setup, ).pytest() diff --git a/docs/utils/linkfix.py b/docs/utils/linkfix.py index a0d9a1cbd..efb4c202e 100644 --- a/docs/utils/linkfix.py +++ b/docs/utils/linkfix.py @@ -25,7 +25,7 @@ def main(): _contents = None # A regex that matches standard linkcheck output lines - line_re = re.compile(r'(.*)\:\d+\:\s\[(.*)\]\s(?:(.*)\sto\s(.*)|(.*))') + line_re = re.compile(r"(.*)\:\d+\:\s\[(.*)\]\s(?:(.*)\sto\s(.*)|(.*))") # Read lines from the linkcheck output file try: @@ -66,5 +66,5 @@ def main(): print("Not Understood: " + line) -if __name__ == '__main__': +if __name__ == "__main__": main() diff --git a/extras/qps-bench-server.py b/extras/qps-bench-server.py index a6472b1ba..622164c75 100755 --- a/extras/qps-bench-server.py +++ b/extras/qps-bench-server.py @@ -7,7 +7,6 @@ from twisted.internet import reactor class Root(Resource): - def __init__(self): Resource.__init__(self) self.concurrent = 0 @@ -26,9 +25,9 @@ class Root(Resource): delta = now - self.lasttime # reset stats on high iter-request times caused by client restarts - if delta > 3: # seconds + if delta > 3: # seconds self._reset_stats() - return '' + return "" self.tail.appendleft(delta) self.lasttime = now @@ -37,15 +36,17 @@ class Root(Resource): if now - self.lastmark >= 3: self.lastmark = now qps = len(self.tail) / sum(self.tail) - print(f'samplesize={len(self.tail)} concurrent={self.concurrent} qps={qps:0.2f}') + print( + f"samplesize={len(self.tail)} concurrent={self.concurrent} qps={qps:0.2f}" + ) - if 'latency' in request.args: - latency = float(request.args['latency'][0]) + if "latency" in request.args: + latency = float(request.args["latency"][0]) reactor.callLater(latency, self._finish, request) return NOT_DONE_YET self.concurrent -= 1 - return '' + return "" def _finish(self, request): self.concurrent -= 1 diff --git a/extras/qpsclient.py b/extras/qpsclient.py index 28703650d..83bb08561 100644 --- a/extras/qpsclient.py +++ b/extras/qpsclient.py @@ -13,13 +13,13 @@ from scrapy.http import Request class QPSSpider(Spider): - name = 'qps' - benchurl = 'http://localhost:8880/' + name = "qps" + benchurl = "http://localhost:8880/" # Max concurrency is limited by global CONCURRENT_REQUESTS setting max_concurrent_requests = 8 # Requests per second goal - qps = None # same as: 1 / download_delay + qps = None # same as: 1 / download_delay download_delay = None # time in seconds to delay server responses latency = None @@ -37,11 +37,11 @@ class QPSSpider(Spider): def start_requests(self): url = self.benchurl if self.latency is not None: - url += f'?latency={self.latency}' + url += f"?latency={self.latency}" slots = int(self.slots) if slots > 1: - urls = [url.replace('localhost', f'127.0.0.{x + 1}') for x in range(slots)] + urls = [url.replace("localhost", f"127.0.0.{x + 1}") for x in range(slots)] else: urls = [url] diff --git a/scrapy/__init__.py b/scrapy/__init__.py index 86e584396..f0d85198d 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -16,14 +16,21 @@ from scrapy.item import Item, Field __all__ = [ - '__version__', 'version_info', 'twisted_version', 'Spider', - 'Request', 'FormRequest', 'Selector', 'Item', 'Field', + "__version__", + "version_info", + "twisted_version", + "Spider", + "Request", + "FormRequest", + "Selector", + "Item", + "Field", ] # Scrapy and Twisted versions __version__ = (pkgutil.get_data(__package__, "VERSION") or b"").decode("ascii").strip() -version_info = tuple(int(v) if v.isdigit() else v for v in __version__.split('.')) +version_info = tuple(int(v) if v.isdigit() else v for v in __version__.split(".")) twisted_version = (_txv.major, _txv.minor, _txv.micro) @@ -34,7 +41,7 @@ if sys.version_info < (3, 7): # Ignore noisy twisted deprecation warnings -warnings.filterwarnings('ignore', category=DeprecationWarning, module='twisted') +warnings.filterwarnings("ignore", category=DeprecationWarning, module="twisted") del pkgutil diff --git a/scrapy/__main__.py b/scrapy/__main__.py index e467e057f..697b9b1e9 100644 --- a/scrapy/__main__.py +++ b/scrapy/__main__.py @@ -1,4 +1,4 @@ from scrapy.cmdline import execute -if __name__ == '__main__': +if __name__ == "__main__": execute() diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 8218a51c8..1d74923a9 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -17,7 +17,7 @@ from scrapy.utils.python import garbage_collect class ScrapyArgumentParser(argparse.ArgumentParser): def _parse_optional(self, arg_string): # if starts with -: it means that is a parameter not a argument - if arg_string[:2] == '-:': + if arg_string[:2] == "-:": return None return super()._parse_optional(arg_string) @@ -41,12 +41,12 @@ def _get_commands_from_module(module, inproject): d = {} for cmd in _iter_command_classes(module): if inproject or not cmd.requires_project: - cmdname = cmd.__module__.split('.')[-1] + cmdname = cmd.__module__.split(".")[-1] d[cmdname] = cmd() return d -def _get_commands_from_entry_points(inproject, group='scrapy.commands'): +def _get_commands_from_entry_points(inproject, group="scrapy.commands"): cmds = {} for entry_point in pkg_resources.iter_entry_points(group): obj = entry_point.load() @@ -58,9 +58,9 @@ def _get_commands_from_entry_points(inproject, group='scrapy.commands'): def _get_commands_dict(settings, inproject): - cmds = _get_commands_from_module('scrapy.commands', inproject) + cmds = _get_commands_from_module("scrapy.commands", inproject) cmds.update(_get_commands_from_entry_points(inproject)) - cmds_module = settings['COMMANDS_MODULE'] + cmds_module = settings["COMMANDS_MODULE"] if cmds_module: cmds.update(_get_commands_from_module(cmds_module, inproject)) return cmds @@ -69,7 +69,7 @@ def _get_commands_dict(settings, inproject): def _pop_command_name(argv): i = 0 for arg in argv[1:]: - if not arg.startswith('-'): + if not arg.startswith("-"): del argv[i] return arg i += 1 @@ -124,11 +124,11 @@ def execute(argv=None, settings=None): settings = get_project_settings() # set EDITOR from environment if available try: - editor = os.environ['EDITOR'] + editor = os.environ["EDITOR"] except KeyError: pass else: - settings['EDITOR'] = editor + settings["EDITOR"] = editor inproject = inside_project() cmds = _get_commands_dict(settings, inproject) @@ -141,11 +141,13 @@ def execute(argv=None, settings=None): sys.exit(2) cmd = cmds[cmdname] - parser = ScrapyArgumentParser(formatter_class=ScrapyHelpFormatter, - usage=f"scrapy {cmdname} {cmd.syntax()}", - conflict_handler='resolve', - description=cmd.long_desc()) - settings.setdict(cmd.default_settings, priority='command') + parser = ScrapyArgumentParser( + formatter_class=ScrapyHelpFormatter, + usage=f"scrapy {cmdname} {cmd.syntax()}", + conflict_handler="resolve", + description=cmd.long_desc(), + ) + settings.setdict(cmd.default_settings, priority="command") cmd.settings = settings cmd.add_options(parser) opts, args = parser.parse_known_args(args=argv[1:]) @@ -168,12 +170,12 @@ def _run_command_profiled(cmd, args, opts): sys.stderr.write(f"scrapy: writing cProfile stats to {opts.profile!r}\n") loc = locals() p = cProfile.Profile() - p.runctx('cmd.run(args, opts)', globals(), loc) + p.runctx("cmd.run(args, opts)", globals(), loc) if opts.profile: p.dump_stats(opts.profile) -if __name__ == '__main__': +if __name__ == "__main__": try: execute() finally: diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index b9ba3335e..f37d61321 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -27,7 +27,7 @@ class ScrapyCommand: self.settings: Any = None # set in scrapy.cmdline def set_crawler(self, crawler): - if hasattr(self, '_crawler'): + if hasattr(self, "_crawler"): raise RuntimeError("crawler already set") self._crawler = crawler @@ -61,41 +61,58 @@ class ScrapyCommand: """ Populate option parse with options available for this command """ - group = parser.add_argument_group(title='Global Options') - group.add_argument("--logfile", metavar="FILE", - help="log file. if omitted stderr will be used") - group.add_argument("-L", "--loglevel", metavar="LEVEL", default=None, - help=f"log level (default: {self.settings['LOG_LEVEL']})") - group.add_argument("--nolog", action="store_true", - help="disable logging completely") - group.add_argument("--profile", metavar="FILE", default=None, - help="write python cProfile stats to FILE") - group.add_argument("--pidfile", metavar="FILE", - help="write process ID to FILE") - group.add_argument("-s", "--set", action="append", default=[], metavar="NAME=VALUE", - help="set/override setting (may be repeated)") + group = parser.add_argument_group(title="Global Options") + group.add_argument( + "--logfile", metavar="FILE", help="log file. if omitted stderr will be used" + ) + group.add_argument( + "-L", + "--loglevel", + metavar="LEVEL", + default=None, + help=f"log level (default: {self.settings['LOG_LEVEL']})", + ) + group.add_argument( + "--nolog", action="store_true", help="disable logging completely" + ) + group.add_argument( + "--profile", + metavar="FILE", + default=None, + help="write python cProfile stats to FILE", + ) + group.add_argument("--pidfile", metavar="FILE", help="write process ID to FILE") + group.add_argument( + "-s", + "--set", + action="append", + default=[], + metavar="NAME=VALUE", + help="set/override setting (may be repeated)", + ) group.add_argument("--pdb", action="store_true", help="enable pdb on failure") def process_options(self, args, opts): try: - self.settings.setdict(arglist_to_dict(opts.set), - priority='cmdline') + self.settings.setdict(arglist_to_dict(opts.set), priority="cmdline") except ValueError: raise UsageError("Invalid -s value, use -s NAME=VALUE", print_help=False) if opts.logfile: - self.settings.set('LOG_ENABLED', True, priority='cmdline') - self.settings.set('LOG_FILE', opts.logfile, priority='cmdline') + self.settings.set("LOG_ENABLED", True, priority="cmdline") + self.settings.set("LOG_FILE", opts.logfile, priority="cmdline") if opts.loglevel: - self.settings.set('LOG_ENABLED', True, priority='cmdline') - self.settings.set('LOG_LEVEL', opts.loglevel, priority='cmdline') + self.settings.set("LOG_ENABLED", True, priority="cmdline") + self.settings.set("LOG_LEVEL", opts.loglevel, priority="cmdline") if opts.nolog: - self.settings.set('LOG_ENABLED', False, priority='cmdline') + self.settings.set("LOG_ENABLED", False, priority="cmdline") if opts.pidfile: - Path(opts.pidfile).write_text(str(os.getpid()) + os.linesep, encoding="utf-8") + Path(opts.pidfile).write_text( + str(os.getpid()) + os.linesep, encoding="utf-8" + ) if opts.pdb: failure.startDebugMode() @@ -111,18 +128,39 @@ class BaseRunSpiderCommand(ScrapyCommand): """ Common class used to share functionality between the crawl, parse and runspider commands """ + def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("-a", dest="spargs", action="append", default=[], metavar="NAME=VALUE", - help="set spider argument (may be repeated)") - parser.add_argument("-o", "--output", metavar="FILE", action="append", - help="append scraped items to the end of FILE (use - for stdout)," - " to define format set a colon at the end of the output URI (i.e. -o FILE:FORMAT)") - parser.add_argument("-O", "--overwrite-output", metavar="FILE", action="append", - help="dump scraped items into FILE, overwriting any existing file," - " to define format set a colon at the end of the output URI (i.e. -O FILE:FORMAT)") - parser.add_argument("-t", "--output-format", metavar="FORMAT", - help="format to use for dumping items") + parser.add_argument( + "-a", + dest="spargs", + action="append", + default=[], + metavar="NAME=VALUE", + help="set spider argument (may be repeated)", + ) + parser.add_argument( + "-o", + "--output", + metavar="FILE", + action="append", + help="append scraped items to the end of FILE (use - for stdout)," + " to define format set a colon at the end of the output URI (i.e. -o FILE:FORMAT)", + ) + parser.add_argument( + "-O", + "--overwrite-output", + metavar="FILE", + action="append", + help="dump scraped items into FILE, overwriting any existing file," + " to define format set a colon at the end of the output URI (i.e. -O FILE:FORMAT)", + ) + parser.add_argument( + "-t", + "--output-format", + metavar="FORMAT", + help="format to use for dumping items", + ) def process_options(self, args, opts): ScrapyCommand.process_options(self, args, opts) @@ -137,16 +175,21 @@ class BaseRunSpiderCommand(ScrapyCommand): opts.output_format, opts.overwrite_output, ) - self.settings.set('FEEDS', feeds, priority='cmdline') + self.settings.set("FEEDS", feeds, priority="cmdline") class ScrapyHelpFormatter(argparse.HelpFormatter): """ Help Formatter for scrapy command line help messages. """ + def __init__(self, prog, indent_increment=2, max_help_position=24, width=None): - super().__init__(prog, indent_increment=indent_increment, - max_help_position=max_help_position, width=width) + super().__init__( + prog, + indent_increment=indent_increment, + max_help_position=max_help_position, + width=width, + ) def _join_parts(self, part_strings): parts = self.format_part_strings(part_strings) @@ -157,11 +200,13 @@ class ScrapyHelpFormatter(argparse.HelpFormatter): Underline and title case command line help message headers. """ if part_strings and part_strings[0].startswith("usage: "): - part_strings[0] = "Usage\n=====\n " + part_strings[0][len('usage: '):] - headings = [i for i in range(len(part_strings)) if part_strings[i].endswith(':\n')] + part_strings[0] = "Usage\n=====\n " + part_strings[0][len("usage: ") :] + headings = [ + i for i in range(len(part_strings)) if part_strings[i].endswith(":\n") + ] for index in headings[::-1]: - char = '-' if "Global Options" in part_strings[index] else '=' + char = "-" if "Global Options" in part_strings[index] else "=" part_strings[index] = part_strings[index][:-2].title() - underline = ''.join(["\n", (char * len(part_strings[index])), "\n"]) + underline = "".join(["\n", (char * len(part_strings[index])), "\n"]) part_strings.insert(index + 1, underline) return part_strings diff --git a/scrapy/commands/bench.py b/scrapy/commands/bench.py index 6bdf9eae0..2e2a21f00 100644 --- a/scrapy/commands/bench.py +++ b/scrapy/commands/bench.py @@ -11,9 +11,9 @@ from scrapy.linkextractors import LinkExtractor class Command(ScrapyCommand): default_settings = { - 'LOG_LEVEL': 'INFO', - 'LOGSTATS_INTERVAL': 1, - 'CLOSESPIDER_TIMEOUT': 10, + "LOG_LEVEL": "INFO", + "LOGSTATS_INTERVAL": 1, + "CLOSESPIDER_TIMEOUT": 10, } def short_desc(self): @@ -26,12 +26,11 @@ class Command(ScrapyCommand): class _BenchServer: - def __enter__(self): from scrapy.utils.test import get_testenv - pargs = [sys.executable, '-u', '-m', 'scrapy.utils.benchserver'] - self.proc = subprocess.Popen(pargs, stdout=subprocess.PIPE, - env=get_testenv()) + + pargs = [sys.executable, "-u", "-m", "scrapy.utils.benchserver"] + self.proc = subprocess.Popen(pargs, stdout=subprocess.PIPE, env=get_testenv()) self.proc.stdout.readline() def __exit__(self, exc_type, exc_value, traceback): @@ -42,15 +41,16 @@ class _BenchServer: class _BenchSpider(scrapy.Spider): """A spider that follows all links""" - name = 'follow' + + name = "follow" total = 10000 show = 20 - baseurl = 'http://localhost:8998' + baseurl = "http://localhost:8998" link_extractor = LinkExtractor() def start_requests(self): - qargs = {'total': self.total, 'show': self.show} - url = f'{self.baseurl}?{urlencode(qargs, doseq=True)}' + qargs = {"total": self.total, "show": self.show} + url = f"{self.baseurl}?{urlencode(qargs, doseq=True)}" return [scrapy.Request(url, dont_filter=True)] def parse(self, response): diff --git a/scrapy/commands/check.py b/scrapy/commands/check.py index a16f4beb7..efc7a46ed 100644 --- a/scrapy/commands/check.py +++ b/scrapy/commands/check.py @@ -39,7 +39,7 @@ class TextTestResult(_TextTestResult): class Command(ScrapyCommand): requires_project = True - default_settings = {'LOG_ENABLED': False} + default_settings = {"LOG_ENABLED": False} def syntax(self): return "[options] " @@ -49,14 +49,25 @@ class Command(ScrapyCommand): def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("-l", "--list", dest="list", action="store_true", - help="only list contracts, without checking them") - parser.add_argument("-v", "--verbose", dest="verbose", default=False, action='store_true', - help="print contract tests for all spiders") + parser.add_argument( + "-l", + "--list", + dest="list", + action="store_true", + help="only list contracts, without checking them", + ) + parser.add_argument( + "-v", + "--verbose", + dest="verbose", + default=False, + action="store_true", + help="print contract tests for all spiders", + ) def run(self, args, opts): # load contracts - contracts = build_component_list(self.settings.getwithbase('SPIDER_CONTRACTS')) + contracts = build_component_list(self.settings.getwithbase("SPIDER_CONTRACTS")) conman = ContractsManager(load_object(c) for c in contracts) runner = TextTestRunner(verbosity=2 if opts.verbose else 1) result = TextTestResult(runner.stream, runner.descriptions, runner.verbosity) @@ -66,7 +77,7 @@ class Command(ScrapyCommand): spider_loader = self.crawler_process.spider_loader - with set_environ(SCRAPY_CHECK='true'): + with set_environ(SCRAPY_CHECK="true"): for spidername in args or spider_loader.list(): spidercls = spider_loader.load(spidername) spidercls.start_requests = lambda s: conman.from_spider(s, result) @@ -85,7 +96,7 @@ class Command(ScrapyCommand): continue print(spider) for method in sorted(methods): - print(f' * {method}') + print(f" * {method}") else: start = time.time() self.crawler_process.start() diff --git a/scrapy/commands/crawl.py b/scrapy/commands/crawl.py index 0f2a21b85..df8006f36 100644 --- a/scrapy/commands/crawl.py +++ b/scrapy/commands/crawl.py @@ -16,18 +16,23 @@ class Command(BaseRunSpiderCommand): if len(args) < 1: raise UsageError() elif len(args) > 1: - raise UsageError("running 'scrapy crawl' with more than one spider is not supported") + raise UsageError( + "running 'scrapy crawl' with more than one spider is not supported" + ) spname = args[0] crawl_defer = self.crawler_process.crawl(spname, **opts.spargs) - if getattr(crawl_defer, 'result', None) is not None and issubclass(crawl_defer.result.type, Exception): + if getattr(crawl_defer, "result", None) is not None and issubclass( + crawl_defer.result.type, Exception + ): self.exitcode = 1 else: self.crawler_process.start() if ( self.crawler_process.bootstrap_failed - or hasattr(self.crawler_process, 'has_exception') and self.crawler_process.has_exception + or hasattr(self.crawler_process, "has_exception") + and self.crawler_process.has_exception ): self.exitcode = 1 diff --git a/scrapy/commands/edit.py b/scrapy/commands/edit.py index 177b20143..537b2013c 100644 --- a/scrapy/commands/edit.py +++ b/scrapy/commands/edit.py @@ -8,7 +8,7 @@ from scrapy.exceptions import UsageError class Command(ScrapyCommand): requires_project = True - default_settings = {'LOG_ENABLED': False} + default_settings = {"LOG_ENABLED": False} def syntax(self): return "" @@ -17,8 +17,10 @@ class Command(ScrapyCommand): return "Edit spider" def long_desc(self): - return ("Edit a spider using the editor defined in the EDITOR environment" - " variable or else the EDITOR setting") + return ( + "Edit a spider using the editor defined in the EDITOR environment" + " variable or else the EDITOR setting" + ) def _err(self, msg): sys.stderr.write(msg + os.linesep) @@ -28,12 +30,12 @@ class Command(ScrapyCommand): if len(args) != 1: raise UsageError() - editor = self.settings['EDITOR'] + editor = self.settings["EDITOR"] try: spidercls = self.crawler_process.spider_loader.load(args[0]) except KeyError: return self._err(f"Spider not found: {args[0]}") sfile = sys.modules[spidercls.__module__].__file__ - sfile = sfile.replace('.pyc', '.py') + sfile = sfile.replace(".pyc", ".py") self.exitcode = os.system(f'{editor} "{sfile}"') diff --git a/scrapy/commands/fetch.py b/scrapy/commands/fetch.py index 9b2ebb37f..918db55c6 100644 --- a/scrapy/commands/fetch.py +++ b/scrapy/commands/fetch.py @@ -27,38 +27,51 @@ class Command(ScrapyCommand): def add_options(self, parser): ScrapyCommand.add_options(self, parser) parser.add_argument("--spider", dest="spider", help="use this spider") - parser.add_argument("--headers", dest="headers", action="store_true", - help="print response HTTP headers instead of body") - parser.add_argument("--no-redirect", dest="no_redirect", action="store_true", default=False, - help="do not handle HTTP 3xx status codes and print response as-is") + parser.add_argument( + "--headers", + dest="headers", + action="store_true", + help="print response HTTP headers instead of body", + ) + parser.add_argument( + "--no-redirect", + dest="no_redirect", + action="store_true", + default=False, + help="do not handle HTTP 3xx status codes and print response as-is", + ) def _print_headers(self, headers, prefix): for key, values in headers.items(): for value in values: - self._print_bytes(prefix + b' ' + key + b': ' + value) + self._print_bytes(prefix + b" " + key + b": " + value) def _print_response(self, response, opts): if opts.headers: - self._print_headers(response.request.headers, b'>') - print('>') - self._print_headers(response.headers, b'<') + self._print_headers(response.request.headers, b">") + print(">") + self._print_headers(response.headers, b"<") else: self._print_bytes(response.body) def _print_bytes(self, bytes_): - sys.stdout.buffer.write(bytes_ + b'\n') + sys.stdout.buffer.write(bytes_ + b"\n") def run(self, args, opts): if len(args) != 1 or not is_url(args[0]): raise UsageError() - request = Request(args[0], callback=self._print_response, - cb_kwargs={"opts": opts}, dont_filter=True) + request = Request( + args[0], + callback=self._print_response, + cb_kwargs={"opts": opts}, + dont_filter=True, + ) # by default, let the framework handle redirects, # i.e. command handles all codes expect 3xx if not opts.no_redirect: - request.meta['handle_httpstatus_list'] = SequenceExclude(range(300, 400)) + request.meta["handle_httpstatus_list"] = SequenceExclude(range(300, 400)) else: - request.meta['handle_httpstatus_all'] = True + request.meta["handle_httpstatus_all"] = True spidercls = DefaultSpider spider_loader = self.crawler_process.spider_loader diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index b7c2f85fb..e880e44a9 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -18,7 +18,7 @@ def sanitize_module_name(module_name): with underscores and prefixing it with a letter if it doesn't start with one """ - module_name = module_name.replace('-', '_').replace('.', '_') + module_name = module_name.replace("-", "_").replace(".", "_") if module_name[0] not in string.ascii_letters: module_name = "a" + module_name return module_name @@ -27,7 +27,7 @@ def sanitize_module_name(module_name): def extract_domain(url): """Extract domain name from URL string""" o = urlparse(url) - if o.scheme == '' and o.netloc == '': + if o.scheme == "" and o.netloc == "": o = urlparse("//" + url.lstrip("/")) return o.netloc @@ -35,7 +35,7 @@ def extract_domain(url): class Command(ScrapyCommand): requires_project = False - default_settings = {'LOG_ENABLED': False} + default_settings = {"LOG_ENABLED": False} def syntax(self): return "[options] " @@ -45,16 +45,40 @@ class Command(ScrapyCommand): def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("-l", "--list", dest="list", action="store_true", - help="List available templates") - parser.add_argument("-e", "--edit", dest="edit", action="store_true", - help="Edit spider after creating it") - parser.add_argument("-d", "--dump", dest="dump", metavar="TEMPLATE", - help="Dump template to standard output") - parser.add_argument("-t", "--template", dest="template", default="basic", - help="Uses a custom template.") - parser.add_argument("--force", dest="force", action="store_true", - help="If the spider already exists, overwrite it with the template") + parser.add_argument( + "-l", + "--list", + dest="list", + action="store_true", + help="List available templates", + ) + parser.add_argument( + "-e", + "--edit", + dest="edit", + action="store_true", + help="Edit spider after creating it", + ) + parser.add_argument( + "-d", + "--dump", + dest="dump", + metavar="TEMPLATE", + help="Dump template to standard output", + ) + parser.add_argument( + "-t", + "--template", + dest="template", + default="basic", + help="Uses a custom template.", + ) + parser.add_argument( + "--force", + dest="force", + action="store_true", + help="If the spider already exists, overwrite it with the template", + ) def run(self, args, opts): if opts.list: @@ -72,7 +96,7 @@ class Command(ScrapyCommand): domain = extract_domain(url) module = sanitize_module_name(name) - if self.settings.get('BOT_NAME') == module: + if self.settings.get("BOT_NAME") == module: print("Cannot create a spider with the same name as your project") return @@ -87,17 +111,17 @@ class Command(ScrapyCommand): def _genspider(self, module, name, domain, template_name, template_file): """Generate the spider module, based on the given template""" - capitalized_module = ''.join(s.capitalize() for s in module.split('_')) + capitalized_module = "".join(s.capitalize() for s in module.split("_")) tvars = { - 'project_name': self.settings.get('BOT_NAME'), - 'ProjectName': string_camelcase(self.settings.get('BOT_NAME')), - 'module': module, - 'name': name, - 'domain': domain, - 'classname': f'{capitalized_module}Spider' + "project_name": self.settings.get("BOT_NAME"), + "ProjectName": string_camelcase(self.settings.get("BOT_NAME")), + "module": module, + "name": name, + "domain": domain, + "classname": f"{capitalized_module}Spider", } - if self.settings.get('NEWSPIDER_MODULE'): - spiders_module = import_module(self.settings['NEWSPIDER_MODULE']) + if self.settings.get("NEWSPIDER_MODULE"): + spiders_module = import_module(self.settings["NEWSPIDER_MODULE"]) spiders_dir = Path(spiders_module.__file__).parent.resolve() else: spiders_module = None @@ -105,13 +129,15 @@ class Command(ScrapyCommand): spider_file = f"{spiders_dir / module}.py" shutil.copyfile(template_file, spider_file) render_templatefile(spider_file, **tvars) - print(f"Created spider {name!r} using template {template_name!r} ", - end=('' if spiders_module else '\n')) + print( + f"Created spider {name!r} using template {template_name!r} ", + end=("" if spiders_module else "\n"), + ) if spiders_module: print(f"in module:\n {spiders_module.__name__}.{module}") def _find_template(self, template: str) -> Optional[Path]: - template_file = Path(self.templates_dir, f'{template}.tmpl') + template_file = Path(self.templates_dir, f"{template}.tmpl") if template_file.exists(): return template_file print(f"Unable to find template: {template}\n") @@ -121,11 +147,11 @@ class Command(ScrapyCommand): def _list_templates(self): print("Available templates:") for file in sorted(Path(self.templates_dir).iterdir()): - if file.suffix == '.tmpl': + if file.suffix == ".tmpl": print(f" {file.stem}") def _spider_exists(self, name: str) -> bool: - if not self.settings.get('NEWSPIDER_MODULE'): + if not self.settings.get("NEWSPIDER_MODULE"): # if run as a standalone command and file with same filename already exists path = Path(name + ".py") if path.exists(): @@ -148,7 +174,7 @@ class Command(ScrapyCommand): return True # a file with the same name exists in the target directory - spiders_module = import_module(self.settings['NEWSPIDER_MODULE']) + spiders_module = import_module(self.settings["NEWSPIDER_MODULE"]) spiders_dir = Path(cast(str, spiders_module.__file__)).parent spiders_dir_abs = spiders_dir.resolve() path = spiders_dir_abs / (name + ".py") @@ -160,7 +186,9 @@ class Command(ScrapyCommand): @property def templates_dir(self) -> str: - return str(Path( - self.settings['TEMPLATES_DIR'] or Path(scrapy.__path__[0], 'templates'), - 'spiders' - )) + return str( + Path( + self.settings["TEMPLATES_DIR"] or Path(scrapy.__path__[0], "templates"), + "spiders", + ) + ) diff --git a/scrapy/commands/list.py b/scrapy/commands/list.py index 54d7bb228..2a81bd182 100644 --- a/scrapy/commands/list.py +++ b/scrapy/commands/list.py @@ -4,7 +4,7 @@ from scrapy.commands import ScrapyCommand class Command(ScrapyCommand): requires_project = True - default_settings = {'LOG_ENABLED': False} + default_settings = {"LOG_ENABLED": False} def short_desc(self): return "List available spiders" diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index c2df7f8a5..ac97b6193 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -32,28 +32,72 @@ class Command(BaseRunSpiderCommand): def add_options(self, parser): BaseRunSpiderCommand.add_options(self, parser) - parser.add_argument("--spider", dest="spider", default=None, - help="use this spider without looking for one") - parser.add_argument("--pipelines", action="store_true", - help="process items through pipelines") - parser.add_argument("--nolinks", dest="nolinks", action="store_true", - help="don't show links to follow (extracted requests)") - parser.add_argument("--noitems", dest="noitems", action="store_true", - help="don't show scraped items") - parser.add_argument("--nocolour", dest="nocolour", action="store_true", - help="avoid using pygments to colorize the output") - parser.add_argument("-r", "--rules", dest="rules", action="store_true", - help="use CrawlSpider rules to discover the callback") - parser.add_argument("-c", "--callback", dest="callback", - help="use this callback for parsing, instead looking for a callback") - parser.add_argument("-m", "--meta", dest="meta", - help="inject extra meta into the Request, it must be a valid raw json string") - parser.add_argument("--cbkwargs", dest="cbkwargs", - help="inject extra callback kwargs into the Request, it must be a valid raw json string") - parser.add_argument("-d", "--depth", dest="depth", type=int, default=1, - help="maximum depth for parsing requests [default: %(default)s]") - parser.add_argument("-v", "--verbose", dest="verbose", action="store_true", - help="print each depth level one by one") + parser.add_argument( + "--spider", + dest="spider", + default=None, + help="use this spider without looking for one", + ) + parser.add_argument( + "--pipelines", action="store_true", help="process items through pipelines" + ) + parser.add_argument( + "--nolinks", + dest="nolinks", + action="store_true", + help="don't show links to follow (extracted requests)", + ) + parser.add_argument( + "--noitems", + dest="noitems", + action="store_true", + help="don't show scraped items", + ) + parser.add_argument( + "--nocolour", + dest="nocolour", + action="store_true", + help="avoid using pygments to colorize the output", + ) + parser.add_argument( + "-r", + "--rules", + dest="rules", + action="store_true", + help="use CrawlSpider rules to discover the callback", + ) + parser.add_argument( + "-c", + "--callback", + dest="callback", + help="use this callback for parsing, instead looking for a callback", + ) + parser.add_argument( + "-m", + "--meta", + dest="meta", + help="inject extra meta into the Request, it must be a valid raw json string", + ) + parser.add_argument( + "--cbkwargs", + dest="cbkwargs", + help="inject extra callback kwargs into the Request, it must be a valid raw json string", + ) + parser.add_argument( + "-d", + "--depth", + dest="depth", + type=int, + default=1, + help="maximum depth for parsing requests [default: %(default)s]", + ) + parser.add_argument( + "-v", + "--verbose", + dest="verbose", + action="store_true", + help="print each depth level one by one", + ) @property def max_level(self): @@ -98,13 +142,13 @@ class Command(BaseRunSpiderCommand): if opts.verbose: for level in range(1, self.max_level + 1): - print(f'\n>>> DEPTH LEVEL: {level} <<<') + print(f"\n>>> DEPTH LEVEL: {level} <<<") if not opts.noitems: self.print_items(level, colour) if not opts.nolinks: self.print_requests(level, colour) else: - print(f'\n>>> STATUS DEPTH LEVEL {self.max_level} <<<') + print(f"\n>>> STATUS DEPTH LEVEL {self.max_level} <<<") if not opts.noitems: self.print_items(colour=colour) if not opts.nolinks: @@ -125,14 +169,16 @@ class Command(BaseRunSpiderCommand): return d def get_callback_from_rules(self, spider, response): - if getattr(spider, 'rules', None): + if getattr(spider, "rules", None): for rule in spider.rules: if rule.link_extractor.matches(response.url): return rule.callback or "parse" else: - logger.error('No CrawlSpider rules found in spider %(spider)r, ' - 'please specify a callback to use for parsing', - {'spider': spider.name}) + logger.error( + "No CrawlSpider rules found in spider %(spider)r, " + "please specify a callback to use for parsing", + {"spider": spider.name}, + ) def set_spidercls(self, url, opts): spider_loader = self.crawler_process.spider_loader @@ -140,15 +186,17 @@ class Command(BaseRunSpiderCommand): try: self.spidercls = spider_loader.load(opts.spider) except KeyError: - logger.error('Unable to find spider: %(spider)s', - {'spider': opts.spider}) + logger.error( + "Unable to find spider: %(spider)s", {"spider": opts.spider} + ) else: self.spidercls = spidercls_for_request(spider_loader, Request(url)) if not self.spidercls: - logger.error('Unable to find spider for: %(url)s', {'url': url}) + logger.error("Unable to find spider for: %(url)s", {"url": url}) def _start_requests(spider): yield self.prepare_request(spider, Request(url), opts) + if self.spidercls: self.spidercls.start_requests = _start_requests @@ -158,8 +206,7 @@ class Command(BaseRunSpiderCommand): self.crawler_process.start() if not self.first_response: - logger.error('No response downloaded for: %(url)s', - {'url': url}) + logger.error("No response downloaded for: %(url)s", {"url": url}) def scraped_data(self, args): items, requests, opts, depth, spider, callback = args @@ -173,8 +220,8 @@ class Command(BaseRunSpiderCommand): scraped_data = items if opts.output else [] if depth < opts.depth: for req in requests: - req.meta['_depth'] = depth + 1 - req.meta['_callback'] = req.callback + req.meta["_depth"] = depth + 1 + req.meta["_callback"] = req.callback req.callback = callback scraped_data += requests @@ -187,7 +234,7 @@ class Command(BaseRunSpiderCommand): self.first_response = response # determine real callback - cb = response.meta['_callback'] + cb = response.meta["_callback"] if not cb: if opts.callback: cb = opts.callback @@ -195,23 +242,27 @@ class Command(BaseRunSpiderCommand): cb = self.get_callback_from_rules(spider, response) if not cb: - logger.error('Cannot find a rule that matches %(url)r in spider: %(spider)s', - {'url': response.url, 'spider': spider.name}) + logger.error( + "Cannot find a rule that matches %(url)r in spider: %(spider)s", + {"url": response.url, "spider": spider.name}, + ) return else: - cb = 'parse' + cb = "parse" if not callable(cb): cb_method = getattr(spider, cb, None) if callable(cb_method): cb = cb_method else: - logger.error('Cannot find callback %(callback)r in spider: %(spider)s', - {'callback': cb, 'spider': spider.name}) + logger.error( + "Cannot find callback %(callback)r in spider: %(spider)s", + {"callback": cb, "spider": spider.name}, + ) return # parse items and requests - depth = response.meta['_depth'] + depth = response.meta["_depth"] d = self.run_callback(response, cb, cb_kwargs) d.addCallback(self._get_items_and_requests, opts, depth, spider, callback) @@ -226,8 +277,8 @@ class Command(BaseRunSpiderCommand): if opts.cbkwargs: request.cb_kwargs.update(opts.cbkwargs) - request.meta['_depth'] = 1 - request.meta['_callback'] = request.callback + request.meta["_depth"] = 1 + request.meta["_callback"] = request.callback request.callback = callback return request @@ -242,16 +293,22 @@ class Command(BaseRunSpiderCommand): try: opts.meta = json.loads(opts.meta) except ValueError: - raise UsageError("Invalid -m/--meta value, pass a valid json string to -m or --meta. " - "Example: --meta='{\"foo\" : \"bar\"}'", print_help=False) + raise UsageError( + "Invalid -m/--meta value, pass a valid json string to -m or --meta. " + 'Example: --meta=\'{"foo" : "bar"}\'', + print_help=False, + ) def process_request_cb_kwargs(self, opts): if opts.cbkwargs: try: opts.cbkwargs = json.loads(opts.cbkwargs) except ValueError: - raise UsageError("Invalid --cbkwargs value, pass a valid json string to --cbkwargs. " - "Example: --cbkwargs='{\"foo\" : \"bar\"}'", print_help=False) + raise UsageError( + "Invalid --cbkwargs value, pass a valid json string to --cbkwargs. " + 'Example: --cbkwargs=\'{"foo" : "bar"}\'', + print_help=False, + ) def run(self, args, opts): # parse arguments diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index 22fa6a53d..9751c6c30 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -12,7 +12,7 @@ from scrapy.commands import BaseRunSpiderCommand def _import_file(filepath: Union[str, PathLike]) -> ModuleType: abspath = Path(filepath).resolve() - if abspath.suffix not in ('.py', '.pyw'): + if abspath.suffix not in (".py", ".pyw"): raise ValueError(f"Not a Python source file: {abspath}") dirname = str(abspath.parent) sys.path = [dirname] + sys.path @@ -26,7 +26,7 @@ def _import_file(filepath: Union[str, PathLike]) -> ModuleType: class Command(BaseRunSpiderCommand): requires_project = False - default_settings = {'SPIDER_LOADER_WARN_ONLY': True} + default_settings = {"SPIDER_LOADER_WARN_ONLY": True} def syntax(self): return "[options] " diff --git a/scrapy/commands/settings.py b/scrapy/commands/settings.py index 1b2e2601e..c43298ac7 100644 --- a/scrapy/commands/settings.py +++ b/scrapy/commands/settings.py @@ -7,8 +7,7 @@ from scrapy.settings import BaseSettings class Command(ScrapyCommand): requires_project = False - default_settings = {'LOG_ENABLED': False, - 'SPIDER_LOADER_WARN_ONLY': True} + default_settings = {"LOG_ENABLED": False, "SPIDER_LOADER_WARN_ONLY": True} def syntax(self): return "[options]" @@ -18,16 +17,33 @@ class Command(ScrapyCommand): def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("--get", dest="get", metavar="SETTING", - help="print raw setting value") - parser.add_argument("--getbool", dest="getbool", metavar="SETTING", - help="print setting value, interpreted as a boolean") - parser.add_argument("--getint", dest="getint", metavar="SETTING", - help="print setting value, interpreted as an integer") - parser.add_argument("--getfloat", dest="getfloat", metavar="SETTING", - help="print setting value, interpreted as a float") - parser.add_argument("--getlist", dest="getlist", metavar="SETTING", - help="print setting value, interpreted as a list") + parser.add_argument( + "--get", dest="get", metavar="SETTING", help="print raw setting value" + ) + parser.add_argument( + "--getbool", + dest="getbool", + metavar="SETTING", + help="print setting value, interpreted as a boolean", + ) + parser.add_argument( + "--getint", + dest="getint", + metavar="SETTING", + help="print setting value, interpreted as an integer", + ) + parser.add_argument( + "--getfloat", + dest="getfloat", + metavar="SETTING", + help="print setting value, interpreted as a float", + ) + parser.add_argument( + "--getlist", + dest="getlist", + metavar="SETTING", + help="print setting value, interpreted as a list", + ) def run(self, args, opts): settings = self.crawler_process.settings diff --git a/scrapy/commands/shell.py b/scrapy/commands/shell.py index f67a5886a..1fad8f328 100644 --- a/scrapy/commands/shell.py +++ b/scrapy/commands/shell.py @@ -16,9 +16,9 @@ class Command(ScrapyCommand): requires_project = False default_settings = { - 'KEEP_ALIVE': True, - 'LOGSTATS_INTERVAL': 0, - 'DUPEFILTER_CLASS': 'scrapy.dupefilters.BaseDupeFilter', + "KEEP_ALIVE": True, + "LOGSTATS_INTERVAL": 0, + "DUPEFILTER_CLASS": "scrapy.dupefilters.BaseDupeFilter", } def syntax(self): @@ -28,17 +28,26 @@ class Command(ScrapyCommand): return "Interactive scraping console" def long_desc(self): - return ("Interactive console for scraping the given url or file. " - "Use ./file.html syntax or full path for local file.") + return ( + "Interactive console for scraping the given url or file. " + "Use ./file.html syntax or full path for local file." + ) def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("-c", dest="code", - help="evaluate the code in the shell, print the result and exit") - parser.add_argument("--spider", dest="spider", - help="use this spider") - parser.add_argument("--no-redirect", dest="no_redirect", action="store_true", default=False, - help="do not handle HTTP 3xx status codes and print response as-is") + parser.add_argument( + "-c", + dest="code", + help="evaluate the code in the shell, print the result and exit", + ) + parser.add_argument("--spider", dest="spider", help="use this spider") + parser.add_argument( + "--no-redirect", + dest="no_redirect", + action="store_true", + default=False, + help="do not handle HTTP 3xx status codes and print response as-is", + ) def update_vars(self, vars): """You can use this function to update the Scrapy objects that will be @@ -58,8 +67,9 @@ class Command(ScrapyCommand): if opts.spider: spidercls = spider_loader.load(opts.spider) elif url: - spidercls = spidercls_for_request(spider_loader, Request(url), - spidercls, log_multiple=True) + spidercls = spidercls_for_request( + spider_loader, Request(url), spidercls, log_multiple=True + ) # The crawler is created this way since the Shell manually handles the # crawling engine, so the set up in the crawl method won't work @@ -74,7 +84,9 @@ class Command(ScrapyCommand): shell.start(url=url, redirect=not opts.no_redirect) def _start_crawler_thread(self): - t = Thread(target=self.crawler_process.start, - kwargs={'stop_after_crawl': False, 'install_signal_handlers': False}) + t = Thread( + target=self.crawler_process.start, + kwargs={"stop_after_crawl": False, "install_signal_handlers": False}, + ) t.daemon = True t.start() diff --git a/scrapy/commands/startproject.py b/scrapy/commands/startproject.py index 9e1e95ab1..3ed1f5dbc 100644 --- a/scrapy/commands/startproject.py +++ b/scrapy/commands/startproject.py @@ -13,14 +13,14 @@ from scrapy.exceptions import UsageError TEMPLATES_TO_RENDER = ( - ('scrapy.cfg',), - ('${project_name}', 'settings.py.tmpl'), - ('${project_name}', 'items.py.tmpl'), - ('${project_name}', 'pipelines.py.tmpl'), - ('${project_name}', 'middlewares.py.tmpl'), + ("scrapy.cfg",), + ("${project_name}", "settings.py.tmpl"), + ("${project_name}", "items.py.tmpl"), + ("${project_name}", "pipelines.py.tmpl"), + ("${project_name}", "middlewares.py.tmpl"), ) -IGNORE = ignore_patterns('*.pyc', '__pycache__', '.svn') +IGNORE = ignore_patterns("*.pyc", "__pycache__", ".svn") def _make_writable(path): @@ -31,8 +31,7 @@ def _make_writable(path): class Command(ScrapyCommand): requires_project = False - default_settings = {'LOG_ENABLED': False, - 'SPIDER_LOADER_WARN_ONLY': True} + default_settings = {"LOG_ENABLED": False, "SPIDER_LOADER_WARN_ONLY": True} def syntax(self): return " [project_dir]" @@ -45,11 +44,13 @@ class Command(ScrapyCommand): spec = find_spec(module_name) return spec is not None and spec.loader is not None - if not re.search(r'^[_a-zA-Z]\w*$', project_name): - print('Error: Project names must begin with a letter and contain' - ' only\nletters, numbers and underscores') + if not re.search(r"^[_a-zA-Z]\w*$", project_name): + print( + "Error: Project names must begin with a letter and contain" + " only\nletters, numbers and underscores" + ) elif _module_exists(project_name): - print(f'Error: Module {project_name!r} already exists') + print(f"Error: Module {project_name!r} already exists") else: return True return False @@ -96,9 +97,9 @@ class Command(ScrapyCommand): else: project_dir = Path(args[0]) - if (project_dir / 'scrapy.cfg').exists(): + if (project_dir / "scrapy.cfg").exists(): self.exitcode = 1 - print(f'Error: scrapy.cfg already exists in {project_dir.resolve()}') + print(f"Error: scrapy.cfg already exists in {project_dir.resolve()}") return if not self._is_valid_name(project_name): @@ -106,12 +107,24 @@ class Command(ScrapyCommand): return self._copytree(Path(self.templates_dir), project_dir.resolve()) - move(project_dir / 'module', project_dir / project_name) + move(project_dir / "module", project_dir / project_name) for paths in TEMPLATES_TO_RENDER: - tplfile = Path(project_dir, *(string.Template(s).substitute(project_name=project_name) for s in paths)) - render_templatefile(tplfile, project_name=project_name, ProjectName=string_camelcase(project_name)) - print(f"New Scrapy project '{project_name}', using template directory " - f"'{self.templates_dir}', created in:") + tplfile = Path( + project_dir, + *( + string.Template(s).substitute(project_name=project_name) + for s in paths + ), + ) + render_templatefile( + tplfile, + project_name=project_name, + ProjectName=string_camelcase(project_name), + ) + print( + f"New Scrapy project '{project_name}', using template directory " + f"'{self.templates_dir}', created in:" + ) print(f" {project_dir.resolve()}\n") print("You can start your first spider with:") print(f" cd {project_dir}") @@ -119,7 +132,9 @@ class Command(ScrapyCommand): @property def templates_dir(self) -> str: - return str(Path( - self.settings['TEMPLATES_DIR'] or Path(scrapy.__path__[0], 'templates'), - 'project' - )) + return str( + Path( + self.settings["TEMPLATES_DIR"] or Path(scrapy.__path__[0], "templates"), + "project", + ) + ) diff --git a/scrapy/commands/version.py b/scrapy/commands/version.py index c6a3c273a..faa0e242c 100644 --- a/scrapy/commands/version.py +++ b/scrapy/commands/version.py @@ -5,8 +5,7 @@ from scrapy.utils.versions import scrapy_components_versions class Command(ScrapyCommand): - default_settings = {'LOG_ENABLED': False, - 'SPIDER_LOADER_WARN_ONLY': True} + default_settings = {"LOG_ENABLED": False, "SPIDER_LOADER_WARN_ONLY": True} def syntax(self): return "[-v]" @@ -16,8 +15,13 @@ class Command(ScrapyCommand): def add_options(self, parser): ScrapyCommand.add_options(self, parser) - parser.add_argument("--verbose", "-v", dest="verbose", action="store_true", - help="also display twisted/python/platform info (useful for bug reports)") + parser.add_argument( + "--verbose", + "-v", + dest="verbose", + action="store_true", + help="also display twisted/python/platform info (useful for bug reports)", + ) def run(self, args, opts): if opts.verbose: diff --git a/scrapy/commands/view.py b/scrapy/commands/view.py index b1f52abe2..a81af7565 100644 --- a/scrapy/commands/view.py +++ b/scrapy/commands/view.py @@ -4,16 +4,17 @@ from scrapy.utils.response import open_in_browser class Command(fetch.Command): - def short_desc(self): return "Open URL in browser, as seen by Scrapy" def long_desc(self): - return "Fetch a URL using the Scrapy downloader and show its contents in a browser" + return ( + "Fetch a URL using the Scrapy downloader and show its contents in a browser" + ) def add_options(self, parser): super().add_options(parser) - parser.add_argument('--headers', help=argparse.SUPPRESS) + parser.add_argument("--headers", help=argparse.SUPPRESS) def _print_response(self, response, opts): open_in_browser(response) diff --git a/scrapy/contracts/__init__.py b/scrapy/contracts/__init__.py index b47e55092..86098edca 100644 --- a/scrapy/contracts/__init__.py +++ b/scrapy/contracts/__init__.py @@ -11,16 +11,17 @@ from scrapy.utils.spider import iterate_spider_output class Contract: - """ Abstract class for contracts """ + """Abstract class for contracts""" + request_cls = None def __init__(self, method, *args): - self.testcase_pre = _create_testcase(method, f'@{self.name} pre-hook') - self.testcase_post = _create_testcase(method, f'@{self.name} post-hook') + self.testcase_pre = _create_testcase(method, f"@{self.name} pre-hook") + self.testcase_post = _create_testcase(method, f"@{self.name} post-hook") self.args = args def add_pre_hook(self, request, results): - if hasattr(self, 'pre_process'): + if hasattr(self, "pre_process"): cb = request.callback @wraps(cb) @@ -43,7 +44,7 @@ class Contract: return request def add_post_hook(self, request, results): - if hasattr(self, 'post_process'): + if hasattr(self, "post_process"): cb = request.callback @wraps(cb) @@ -88,12 +89,12 @@ class ContractsManager: def extract_contracts(self, method): contracts = [] - for line in method.__doc__.split('\n'): + for line in method.__doc__.split("\n"): line = line.strip() - if line.startswith('@'): - name, args = re.match(r'@(\w+)\s*(.*)', line).groups() - args = re.split(r'\s+', args) + if line.startswith("@"): + name, args = re.match(r"@(\w+)\s*(.*)", line).groups() + args = re.split(r"\s+", args) contracts.append(self.contracts[name](method, *args)) @@ -106,7 +107,7 @@ class ContractsManager: try: requests.append(self.from_method(bound_method, results)) except Exception: - case = _create_testcase(bound_method, 'contract') + case = _create_testcase(bound_method, "contract") results.addError(case, sys.exc_info()) return requests @@ -124,13 +125,13 @@ class ContractsManager: # Don't filter requests to allow # testing different callbacks on the same URL. - kwargs['dont_filter'] = True - kwargs['callback'] = method + kwargs["dont_filter"] = True + kwargs["callback"] = method for contract in contracts: kwargs = contract.adjust_request_args(kwargs) - args.remove('self') + args.remove("self") # check if all positional arguments are defined in kwargs if set(args).issubset(set(kwargs)): @@ -146,7 +147,7 @@ class ContractsManager: return request def _clean_req(self, request, method, results): - """ stop the request from returning objects and records any errors """ + """stop the request from returning objects and records any errors""" cb = request.callback @@ -156,11 +157,11 @@ class ContractsManager: output = cb(response, **cb_kwargs) output = list(iterate_spider_output(output)) except Exception: - case = _create_testcase(method, 'callback') + case = _create_testcase(method, "callback") results.addError(case, sys.exc_info()) def eb_wrapper(failure): - case = _create_testcase(method, 'errback') + case = _create_testcase(method, "errback") exc_info = failure.type, failure.value, failure.getTracebackObject() results.addError(case, exc_info) @@ -175,6 +176,6 @@ def _create_testcase(method, desc): def __str__(_self): return f"[{spider}] {method.__name__} ({desc})" - name = f'{spider}_{method.__name__}' + name = f"{spider}_{method.__name__}" setattr(ContractTestCase, name, lambda x: x) return ContractTestCase(name) diff --git a/scrapy/contracts/default.py b/scrapy/contracts/default.py index 9704f5253..e41d83960 100644 --- a/scrapy/contracts/default.py +++ b/scrapy/contracts/default.py @@ -9,50 +9,50 @@ from scrapy.http import Request # contracts class UrlContract(Contract): - """ Contract to set the url of the request (mandatory) - @url http://scrapy.org + """Contract to set the url of the request (mandatory) + @url http://scrapy.org """ - name = 'url' + name = "url" def adjust_request_args(self, args): - args['url'] = self.args[0] + args["url"] = self.args[0] return args class CallbackKeywordArgumentsContract(Contract): - """ Contract to set the keyword arguments for the request. - The value should be a JSON-encoded dictionary, e.g.: + """Contract to set the keyword arguments for the request. + The value should be a JSON-encoded dictionary, e.g.: - @cb_kwargs {"arg1": "some value"} + @cb_kwargs {"arg1": "some value"} """ - name = 'cb_kwargs' + name = "cb_kwargs" def adjust_request_args(self, args): - args['cb_kwargs'] = json.loads(' '.join(self.args)) + args["cb_kwargs"] = json.loads(" ".join(self.args)) return args class ReturnsContract(Contract): - """ Contract to check the output of a callback + """Contract to check the output of a callback - general form: - @returns request(s)/item(s) [min=1 [max]] + general form: + @returns request(s)/item(s) [min=1 [max]] - e.g.: - @returns request - @returns request 2 - @returns request 2 10 - @returns request 0 10 + e.g.: + @returns request + @returns request 2 + @returns request 2 10 + @returns request 0 10 """ - name = 'returns' + name = "returns" object_type_verifiers = { - 'request': lambda x: isinstance(x, Request), - 'requests': lambda x: isinstance(x, Request), - 'item': is_item, - 'items': is_item, + "request": lambda x: isinstance(x, Request), + "requests": lambda x: isinstance(x, Request), + "item": is_item, + "items": is_item, } def __init__(self, *args, **kwargs): @@ -73,7 +73,7 @@ class ReturnsContract(Contract): try: self.max_bound = int(self.args[2]) except IndexError: - self.max_bound = float('inf') + self.max_bound = float("inf") def post_process(self, output): occurrences = 0 @@ -81,23 +81,25 @@ class ReturnsContract(Contract): if self.obj_type_verifier(x): occurrences += 1 - assertion = (self.min_bound <= occurrences <= self.max_bound) + assertion = self.min_bound <= occurrences <= self.max_bound if not assertion: if self.min_bound == self.max_bound: expected = self.min_bound else: - expected = f'{self.min_bound}..{self.max_bound}' + expected = f"{self.min_bound}..{self.max_bound}" - raise ContractFail(f"Returned {occurrences} {self.obj_name}, expected {expected}") + raise ContractFail( + f"Returned {occurrences} {self.obj_name}, expected {expected}" + ) class ScrapesContract(Contract): - """ Contract to check presence of fields in scraped items - @scrapes page_name page_body + """Contract to check presence of fields in scraped items + @scrapes page_name page_body """ - name = 'scrapes' + name = "scrapes" def post_process(self, output): for x in output: diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 4f7ab594f..3a7de8072 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -41,9 +41,11 @@ class Slot: def __repr__(self): cls_name = self.__class__.__name__ - return (f"{cls_name}(concurrency={self.concurrency!r}, " - f"delay={self.delay:.2f}, " - f"randomize_delay={self.randomize_delay!r})") + return ( + f"{cls_name}(concurrency={self.concurrency!r}, " + f"delay={self.delay:.2f}, " + f"randomize_delay={self.randomize_delay!r})" + ) def __str__(self): return ( @@ -56,11 +58,11 @@ class Slot: def _get_concurrency_delay(concurrency, spider, settings): - delay = settings.getfloat('DOWNLOAD_DELAY') - if hasattr(spider, 'download_delay'): + delay = settings.getfloat("DOWNLOAD_DELAY") + if hasattr(spider, "download_delay"): delay = spider.download_delay - if hasattr(spider, 'max_concurrent_requests'): + if hasattr(spider, "max_concurrent_requests"): concurrency = spider.max_concurrent_requests return concurrency, delay @@ -68,7 +70,7 @@ def _get_concurrency_delay(concurrency, spider, settings): class Downloader: - DOWNLOAD_SLOT = 'download_slot' + DOWNLOAD_SLOT = "download_slot" def __init__(self, crawler): self.settings = crawler.settings @@ -76,10 +78,10 @@ class Downloader: self.slots = {} self.active = set() self.handlers = DownloadHandlers(crawler) - self.total_concurrency = self.settings.getint('CONCURRENT_REQUESTS') - self.domain_concurrency = self.settings.getint('CONCURRENT_REQUESTS_PER_DOMAIN') - self.ip_concurrency = self.settings.getint('CONCURRENT_REQUESTS_PER_IP') - self.randomize_delay = self.settings.getbool('RANDOMIZE_DOWNLOAD_DELAY') + self.total_concurrency = self.settings.getint("CONCURRENT_REQUESTS") + self.domain_concurrency = self.settings.getint("CONCURRENT_REQUESTS_PER_DOMAIN") + self.ip_concurrency = self.settings.getint("CONCURRENT_REQUESTS_PER_IP") + self.randomize_delay = self.settings.getbool("RANDOMIZE_DOWNLOAD_DELAY") self.middleware = DownloaderMiddlewareManager.from_crawler(crawler) self._slot_gc_loop = task.LoopingCall(self._slot_gc) self._slot_gc_loop.start(60) @@ -99,7 +101,9 @@ class Downloader: def _get_slot(self, request, spider): key = self._get_slot_key(request, spider) if key not in self.slots: - conc = self.ip_concurrency if self.ip_concurrency else self.domain_concurrency + conc = ( + self.ip_concurrency if self.ip_concurrency else self.domain_concurrency + ) conc, delay = _get_concurrency_delay(conc, spider, self.settings) self.slots[key] = Slot(conc, delay, self.randomize_delay) @@ -109,7 +113,7 @@ class Downloader: if self.DOWNLOAD_SLOT in request.meta: return request.meta[self.DOWNLOAD_SLOT] - key = urlparse_cached(request).hostname or '' + key = urlparse_cached(request).hostname or "" if self.ip_concurrency: key = dnscache.get(key, key) @@ -124,9 +128,9 @@ class Downloader: return response slot.active.add(request) - self.signals.send_catch_log(signal=signals.request_reached_downloader, - request=request, - spider=spider) + self.signals.send_catch_log( + signal=signals.request_reached_downloader, request=request, spider=spider + ) deferred = defer.Deferred().addBoth(_deactivate) slot.queue.append((request, deferred)) self._process_queue(spider, slot) @@ -134,6 +138,7 @@ class Downloader: def _process_queue(self, spider, slot): from twisted.internet import reactor + if slot.latercall and slot.latercall.active(): return @@ -143,7 +148,9 @@ class Downloader: if delay: penalty = delay - now + slot.lastseen if penalty > 0: - slot.latercall = reactor.callLater(penalty, self._process_queue, spider, slot) + slot.latercall = reactor.callLater( + penalty, self._process_queue, spider, slot + ) return # Process enqueued requests if there are free slots to transfer for this slot @@ -166,11 +173,14 @@ class Downloader: # 2. Notify response_downloaded listeners about the recent download # before querying queue for next request def _downloaded(response): - self.signals.send_catch_log(signal=signals.response_downloaded, - response=response, - request=request, - spider=spider) + self.signals.send_catch_log( + signal=signals.response_downloaded, + response=response, + request=request, + spider=spider, + ) return response + dfd.addCallback(_downloaded) # 3. After response arrives, remove the request from transferring @@ -182,9 +192,9 @@ class Downloader: def finish_transferring(_): slot.transferring.remove(request) self._process_queue(spider, slot) - self.signals.send_catch_log(signal=signals.request_left_downloader, - request=request, - spider=spider) + self.signals.send_catch_log( + signal=signals.request_left_downloader, request=request, spider=spider + ) return _ return dfd.addBoth(finish_transferring) diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index 4abde2238..9dd2df638 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -2,13 +2,22 @@ import warnings from OpenSSL import SSL from twisted.internet._sslverify import _setAcceptableProtocols -from twisted.internet.ssl import optionsForClientTLS, CertificateOptions, platformTrust, AcceptableCiphers +from twisted.internet.ssl import ( + optionsForClientTLS, + CertificateOptions, + platformTrust, + AcceptableCiphers, +) from twisted.web.client import BrowserLikePolicyForHTTPS from twisted.web.iweb import IPolicyForHTTPS from zope.interface.declarations import implementer from zope.interface.verify import verifyObject -from scrapy.core.downloader.tls import DEFAULT_CIPHERS, openssl_methods, ScrapyClientTLSOptions +from scrapy.core.downloader.tls import ( + DEFAULT_CIPHERS, + openssl_methods, + ScrapyClientTLSOptions, +) from scrapy.utils.misc import create_instance, load_object @@ -24,7 +33,14 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): understand the TLSv1, TLSv1.1 and TLSv1.2 protocols.' """ - def __init__(self, method=SSL.SSLv23_METHOD, tls_verbose_logging=False, tls_ciphers=None, *args, **kwargs): + def __init__( + self, + method=SSL.SSLv23_METHOD, + tls_verbose_logging=False, + tls_ciphers=None, + *args, + **kwargs, + ): super().__init__(*args, **kwargs) self._ssl_method = method self.tls_verbose_logging = tls_verbose_logging @@ -35,9 +51,15 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): @classmethod def from_settings(cls, settings, method=SSL.SSLv23_METHOD, *args, **kwargs): - tls_verbose_logging = settings.getbool('DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING') - tls_ciphers = settings['DOWNLOADER_CLIENT_TLS_CIPHERS'] - return cls(method=method, tls_verbose_logging=tls_verbose_logging, tls_ciphers=tls_ciphers, *args, **kwargs) + tls_verbose_logging = settings.getbool("DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING") + tls_ciphers = settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] + return cls( + method=method, + tls_verbose_logging=tls_verbose_logging, + tls_ciphers=tls_ciphers, + *args, + **kwargs, + ) def getCertificateOptions(self): # setting verify=True will require you to provide CAs @@ -53,7 +75,7 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): # not calling super().__init__ return CertificateOptions( verify=False, - method=getattr(self, 'method', getattr(self, '_ssl_method', None)), + method=getattr(self, "method", getattr(self, "_ssl_method", None)), fixBrokenPeers=True, acceptableCiphers=self.tls_ciphers, ) @@ -64,8 +86,11 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): return self.getCertificateOptions().getContext() def creatorForNetloc(self, hostname, port): - return ScrapyClientTLSOptions(hostname.decode("ascii"), self.getContext(), - verbose_logging=self.tls_verbose_logging) + return ScrapyClientTLSOptions( + hostname.decode("ascii"), + self.getContext(), + verbose_logging=self.tls_verbose_logging, + ) @implementer(IPolicyForHTTPS) @@ -95,7 +120,7 @@ class BrowserLikeContextFactory(ScrapyClientContextFactory): return optionsForClientTLS( hostname=hostname.decode("ascii"), trustRoot=platformTrust(), - extraCertificateOptions={'method': self._ssl_method}, + extraCertificateOptions={"method": self._ssl_method}, ) @@ -118,8 +143,8 @@ class AcceptableProtocolsContextFactory: def load_context_factory_from_settings(settings, crawler): - ssl_method = openssl_methods[settings.get('DOWNLOADER_CLIENT_TLS_METHOD')] - context_factory_cls = load_object(settings['DOWNLOADER_CLIENTCONTEXTFACTORY']) + ssl_method = openssl_methods[settings.get("DOWNLOADER_CLIENT_TLS_METHOD")] + context_factory_cls = load_object(settings["DOWNLOADER_CLIENTCONTEXTFACTORY"]) # try method-aware context factory try: context_factory = create_instance( diff --git a/scrapy/core/downloader/handlers/__init__.py b/scrapy/core/downloader/handlers/__init__.py index 73aeb2352..bb2141d28 100644 --- a/scrapy/core/downloader/handlers/__init__.py +++ b/scrapy/core/downloader/handlers/__init__.py @@ -15,14 +15,14 @@ logger = logging.getLogger(__name__) class DownloadHandlers: - def __init__(self, crawler): self._crawler = crawler self._schemes = {} # stores acceptable schemes on instancing self._handlers = {} # stores instanced handlers for schemes self._notconfigured = {} # remembers failed handlers handlers = without_none_values( - crawler.settings.getwithbase('DOWNLOAD_HANDLERS')) + crawler.settings.getwithbase("DOWNLOAD_HANDLERS") + ) for scheme, clspath in handlers.items(): self._schemes[scheme] = clspath self._load_handler(scheme, skip_lazy=True) @@ -38,7 +38,7 @@ class DownloadHandlers: if scheme in self._notconfigured: return None if scheme not in self._schemes: - self._notconfigured[scheme] = 'no handler available for that scheme' + self._notconfigured[scheme] = "no handler available for that scheme" return None return self._load_handler(scheme) @@ -47,7 +47,7 @@ class DownloadHandlers: path = self._schemes[scheme] try: dhcls = load_object(path) - if skip_lazy and getattr(dhcls, 'lazy', True): + if skip_lazy and getattr(dhcls, "lazy", True): return None dh = create_instance( objcls=dhcls, @@ -58,9 +58,12 @@ class DownloadHandlers: self._notconfigured[scheme] = str(ex) return None except Exception as ex: - logger.error('Loading "%(clspath)s" for scheme "%(scheme)s"', - {"clspath": path, "scheme": scheme}, - exc_info=True, extra={'crawler': self._crawler}) + logger.error( + 'Loading "%(clspath)s" for scheme "%(scheme)s"', + {"clspath": path, "scheme": scheme}, + exc_info=True, + extra={"crawler": self._crawler}, + ) self._notconfigured[scheme] = str(ex) return None else: @@ -71,11 +74,13 @@ class DownloadHandlers: scheme = urlparse_cached(request).scheme handler = self._get_handler(scheme) if not handler: - raise NotSupported(f"Unsupported URL scheme '{scheme}': {self._notconfigured[scheme]}") + raise NotSupported( + f"Unsupported URL scheme '{scheme}': {self._notconfigured[scheme]}" + ) return handler.download_request(request, spider) @defer.inlineCallbacks def _close(self, *_a, **_kw): for dh in self._handlers.values(): - if hasattr(dh, 'close'): + if hasattr(dh, "close"): yield dh.close() diff --git a/scrapy/core/downloader/handlers/datauri.py b/scrapy/core/downloader/handlers/datauri.py index a45b4ff3c..8b78c53c1 100644 --- a/scrapy/core/downloader/handlers/datauri.py +++ b/scrapy/core/downloader/handlers/datauri.py @@ -14,9 +14,8 @@ class DataURIDownloadHandler: respcls = responsetypes.from_mimetype(uri.media_type) resp_kwargs = {} - if (issubclass(respcls, TextResponse) - and uri.media_type.split('/')[0] == 'text'): - charset = uri.media_type_parameters.get('charset') - resp_kwargs['encoding'] = charset + if issubclass(respcls, TextResponse) and uri.media_type.split("/")[0] == "text": + charset = uri.media_type_parameters.get("charset") + resp_kwargs["encoding"] = charset return respcls(url=request.url, body=uri.data, **resp_kwargs) diff --git a/scrapy/core/downloader/handlers/ftp.py b/scrapy/core/downloader/handlers/ftp.py index a495874bd..4081545ce 100644 --- a/scrapy/core/downloader/handlers/ftp.py +++ b/scrapy/core/downloader/handlers/ftp.py @@ -71,9 +71,9 @@ class FTPDownloadHandler: } def __init__(self, settings): - self.default_user = settings['FTP_USER'] - self.default_password = settings['FTP_PASSWORD'] - self.passive_mode = settings['FTP_PASSIVE_MODE'] + self.default_user = settings["FTP_USER"] + self.default_password = settings["FTP_PASSWORD"] + self.passive_mode = settings["FTP_PASSIVE_MODE"] @classmethod def from_crawler(cls, crawler): @@ -81,12 +81,16 @@ class FTPDownloadHandler: def download_request(self, request, spider): from twisted.internet import reactor + parsed_url = urlparse_cached(request) user = request.meta.get("ftp_user", self.default_user) password = request.meta.get("ftp_password", self.default_password) - passive_mode = 1 if bool(request.meta.get("ftp_passive", - self.passive_mode)) else 0 - creator = ClientCreator(reactor, FTPClient, user, password, passive=passive_mode) + passive_mode = ( + 1 if bool(request.meta.get("ftp_passive", self.passive_mode)) else 0 + ) + creator = ClientCreator( + reactor, FTPClient, user, password, passive=passive_mode + ) dfd = creator.connectTCP(parsed_url.hostname, parsed_url.port or 21) return dfd.addCallback(self.gotClient, request, unquote(parsed_url.path)) @@ -103,7 +107,7 @@ class FTPDownloadHandler: def _build_response(self, result, request, protocol): self.result = result protocol.close() - headers = {"local filename": protocol.filename or '', "size": protocol.size} + headers = {"local filename": protocol.filename or "", "size": protocol.size} body = to_bytes(protocol.filename or protocol.body.read()) respcls = responsetypes.from_args(url=request.url, body=body) return respcls(url=request.url, status=200, body=body, headers=headers) @@ -115,5 +119,7 @@ class FTPDownloadHandler: if m: ftpcode = m.group() httpcode = self.CODE_MAPPING.get(ftpcode, self.CODE_MAPPING["default"]) - return Response(url=request.url, status=httpcode, body=to_bytes(message)) + return Response( + url=request.url, status=httpcode, body=to_bytes(message) + ) raise result.type(result.value) diff --git a/scrapy/core/downloader/handlers/http10.py b/scrapy/core/downloader/handlers/http10.py index a75532d2a..6c1dac4a5 100644 --- a/scrapy/core/downloader/handlers/http10.py +++ b/scrapy/core/downloader/handlers/http10.py @@ -8,8 +8,10 @@ class HTTP10DownloadHandler: lazy = False def __init__(self, settings, crawler=None): - self.HTTPClientFactory = load_object(settings['DOWNLOADER_HTTPCLIENTFACTORY']) - self.ClientContextFactory = load_object(settings['DOWNLOADER_CLIENTCONTEXTFACTORY']) + self.HTTPClientFactory = load_object(settings["DOWNLOADER_HTTPCLIENTFACTORY"]) + self.ClientContextFactory = load_object( + settings["DOWNLOADER_CLIENTCONTEXTFACTORY"] + ) self._settings = settings self._crawler = crawler @@ -25,8 +27,9 @@ class HTTP10DownloadHandler: def _connect(self, factory): from twisted.internet import reactor + host, port = to_unicode(factory.host), factory.port - if factory.scheme == b'https': + if factory.scheme == b"https": client_context_factory = create_instance( objcls=self.ClientContextFactory, settings=self._settings, diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index 1c98e60e1..201c84ff8 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -12,7 +12,13 @@ from twisted.internet import defer, protocol, ssl from twisted.internet.endpoints import TCP4ClientEndpoint from twisted.internet.error import TimeoutError from twisted.python.failure import Failure -from twisted.web.client import Agent, HTTPConnectionPool, ResponseDone, ResponseFailed, URI +from twisted.web.client import ( + Agent, + HTTPConnectionPool, + ResponseDone, + ResponseFailed, + URI, +) from twisted.web.http import _DataLoss, PotentialDataLoss from twisted.web.http_headers import Headers as TxHeaders from twisted.web.iweb import IBodyProducer, UNKNOWN_LENGTH @@ -36,14 +42,17 @@ class HTTP11DownloadHandler: self._crawler = crawler from twisted.internet import reactor + self._pool = HTTPConnectionPool(reactor, persistent=True) - self._pool.maxPersistentPerHost = settings.getint('CONCURRENT_REQUESTS_PER_DOMAIN') + self._pool.maxPersistentPerHost = settings.getint( + "CONCURRENT_REQUESTS_PER_DOMAIN" + ) self._pool._factory.noisy = False self._contextFactory = load_context_factory_from_settings(settings, crawler) - self._default_maxsize = settings.getint('DOWNLOAD_MAXSIZE') - self._default_warnsize = settings.getint('DOWNLOAD_WARNSIZE') - self._fail_on_dataloss = settings.getbool('DOWNLOAD_FAIL_ON_DATALOSS') + self._default_maxsize = settings.getint("DOWNLOAD_MAXSIZE") + self._default_warnsize = settings.getint("DOWNLOAD_WARNSIZE") + self._fail_on_dataloss = settings.getbool("DOWNLOAD_FAIL_ON_DATALOSS") self._disconnect_timeout = 1 @classmethod @@ -55,8 +64,8 @@ class HTTP11DownloadHandler: agent = ScrapyAgent( contextFactory=self._contextFactory, pool=self._pool, - maxsize=getattr(spider, 'download_maxsize', self._default_maxsize), - warnsize=getattr(spider, 'download_warnsize', self._default_warnsize), + maxsize=getattr(spider, "download_maxsize", self._default_maxsize), + warnsize=getattr(spider, "download_warnsize", self._default_warnsize), fail_on_dataloss=self._fail_on_dataloss, crawler=self._crawler, ) @@ -64,6 +73,7 @@ class HTTP11DownloadHandler: def close(self): from twisted.internet import reactor + d = self._pool.closeCachedConnections() # closeCachedConnections will hang on network or server issues, so # we'll manually timeout the deferred. @@ -96,11 +106,23 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): with this endpoint comes from the pool and a CONNECT has already been issued for it. """ + _truncatedLength = 1000 - _responseAnswer = r'HTTP/1\.. (?P\d{3})(?P.{,' + str(_truncatedLength) + r'})' + _responseAnswer = ( + r"HTTP/1\.. (?P\d{3})(?P.{," + str(_truncatedLength) + r"})" + ) _responseMatcher = re.compile(_responseAnswer.encode()) - def __init__(self, reactor, host, port, proxyConf, contextFactory, timeout=30, bindAddress=None): + def __init__( + self, + reactor, + host, + port, + proxyConf, + contextFactory, + timeout=30, + bindAddress=None, + ): proxyHost, proxyPort, self._proxyAuthHeader = proxyConf super().__init__(reactor, proxyHost, proxyPort, timeout, bindAddress) self._tunnelReadyDeferred = defer.Deferred() @@ -111,7 +133,9 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): def requestTunnel(self, protocol): """Asks the proxy to open a tunnel.""" - tunnelReq = tunnel_request_data(self._tunneledHost, self._tunneledPort, self._proxyAuthHeader) + tunnelReq = tunnel_request_data( + self._tunneledHost, self._tunneledPort, self._proxyAuthHeader + ) protocol.transport.write(tunnelReq) self._protocolDataReceived = protocol.dataReceived protocol.dataReceived = self.processProxyResponse @@ -129,24 +153,30 @@ class TunnelingTCP4ClientEndpoint(TCP4ClientEndpoint): # from the proxy so that we don't send those bytes to the TLS layer # # see https://github.com/scrapy/scrapy/issues/2491 - if b'\r\n\r\n' not in self._connectBuffer: + if b"\r\n\r\n" not in self._connectBuffer: return self._protocol.dataReceived = self._protocolDataReceived respm = TunnelingTCP4ClientEndpoint._responseMatcher.match(self._connectBuffer) - if respm and int(respm.group('status')) == 200: + if respm and int(respm.group("status")) == 200: # set proper Server Name Indication extension - sslOptions = self._contextFactory.creatorForNetloc(self._tunneledHost, self._tunneledPort) + sslOptions = self._contextFactory.creatorForNetloc( + self._tunneledHost, self._tunneledPort + ) self._protocol.transport.startTLS(sslOptions, self._protocolFactory) self._tunnelReadyDeferred.callback(self._protocol) else: if respm: - extra = {'status': int(respm.group('status')), - 'reason': respm.group('reason').strip()} + extra = { + "status": int(respm.group("status")), + "reason": respm.group("reason").strip(), + } else: - extra = rcvd_bytes[:self._truncatedLength] + extra = rcvd_bytes[: self._truncatedLength] self._tunnelReadyDeferred.errback( - TunnelError('Could not open CONNECT tunnel with proxy ' - f'{self._host}:{self._port} [{extra!r}]') + TunnelError( + "Could not open CONNECT tunnel with proxy " + f"{self._host}:{self._port} [{extra!r}]" + ) ) def connectFailed(self, reason): @@ -173,12 +203,12 @@ def tunnel_request_data(host, port, proxy_auth_header=None): >>> s(tunnel_request_data(b"example.com", "8090")) 'CONNECT example.com:8090 HTTP/1.1\r\nHost: example.com:8090\r\n\r\n' """ - host_value = to_bytes(host, encoding='ascii') + b':' + to_bytes(str(port)) - tunnel_req = b'CONNECT ' + host_value + b' HTTP/1.1\r\n' - tunnel_req += b'Host: ' + host_value + b'\r\n' + host_value = to_bytes(host, encoding="ascii") + b":" + to_bytes(str(port)) + tunnel_req = b"CONNECT " + host_value + b" HTTP/1.1\r\n" + tunnel_req += b"Host: " + host_value + b"\r\n" if proxy_auth_header: - tunnel_req += b'Proxy-Authorization: ' + proxy_auth_header + b'\r\n' - tunnel_req += b'\r\n' + tunnel_req += b"Proxy-Authorization: " + proxy_auth_header + b"\r\n" + tunnel_req += b"\r\n" return tunnel_req @@ -190,8 +220,15 @@ class TunnelingAgent(Agent): proxy involved. """ - def __init__(self, reactor, proxyConf, contextFactory=None, - connectTimeout=None, bindAddress=None, pool=None): + def __init__( + self, + reactor, + proxyConf, + contextFactory=None, + connectTimeout=None, + bindAddress=None, + pool=None, + ): super().__init__(reactor, contextFactory, connectTimeout, bindAddress, pool) self._proxyConf = proxyConf self._contextFactory = contextFactory @@ -207,7 +244,9 @@ class TunnelingAgent(Agent): bindAddress=self._endpointFactory._bindAddress, ) - def _requestWithEndpoint(self, key, endpoint, method, parsedURI, headers, bodyProducer, requestPath): + def _requestWithEndpoint( + self, key, endpoint, method, parsedURI, headers, bodyProducer, requestPath + ): # proxy host and port are required for HTTP pool `key` # otherwise, same remote host connection request could reuse # a cached tunneled connection to a different proxy @@ -224,8 +263,9 @@ class TunnelingAgent(Agent): class ScrapyProxyAgent(Agent): - - def __init__(self, reactor, proxyURI, connectTimeout=None, bindAddress=None, pool=None): + def __init__( + self, reactor, proxyURI, connectTimeout=None, bindAddress=None, pool=None + ): super().__init__( reactor=reactor, connectTimeout=connectTimeout, @@ -257,8 +297,17 @@ class ScrapyAgent: _ProxyAgent = ScrapyProxyAgent _TunnelingAgent = TunnelingAgent - def __init__(self, contextFactory=None, connectTimeout=10, bindAddress=None, pool=None, - maxsize=0, warnsize=0, fail_on_dataloss=True, crawler=None): + def __init__( + self, + contextFactory=None, + connectTimeout=10, + bindAddress=None, + pool=None, + maxsize=0, + warnsize=0, + fail_on_dataloss=True, + crawler=None, + ): self._contextFactory = contextFactory self._connectTimeout = connectTimeout self._bindAddress = bindAddress @@ -271,14 +320,15 @@ class ScrapyAgent: def _get_agent(self, request, timeout): from twisted.internet import reactor - bindaddress = request.meta.get('bindaddress') or self._bindAddress - proxy = request.meta.get('proxy') + + bindaddress = request.meta.get("bindaddress") or self._bindAddress + proxy = request.meta.get("proxy") if proxy: proxyScheme, proxyNetloc, proxyHost, proxyPort, proxyParams = _parse(proxy) scheme = _parse(request.url)[0] proxyHost = to_unicode(proxyHost) - if scheme == b'https': - proxyAuth = request.headers.get(b'Proxy-Authorization', None) + if scheme == b"https": + proxyAuth = request.headers.get(b"Proxy-Authorization", None) proxyConf = (proxyHost, proxyPort, proxyAuth) return self._TunnelingAgent( reactor=reactor, @@ -288,11 +338,11 @@ class ScrapyAgent: bindAddress=bindaddress, pool=self._pool, ) - proxyScheme = proxyScheme or b'http' - proxyURI = urlunparse((proxyScheme, proxyNetloc, proxyParams, '', '', '')) + proxyScheme = proxyScheme or b"http" + proxyURI = urlunparse((proxyScheme, proxyNetloc, proxyParams, "", "", "")) return self._ProxyAgent( reactor=reactor, - proxyURI=to_bytes(proxyURI, encoding='ascii'), + proxyURI=to_bytes(proxyURI, encoding="ascii"), connectTimeout=timeout, bindAddress=bindaddress, pool=self._pool, @@ -308,7 +358,8 @@ class ScrapyAgent: def download_request(self, request): from twisted.internet import reactor - timeout = request.meta.get('download_timeout') or self._connectTimeout + + timeout = request.meta.get("download_timeout") or self._connectTimeout agent = self._get_agent(request, timeout) # request details @@ -316,13 +367,15 @@ class ScrapyAgent: method = to_bytes(request.method) headers = TxHeaders(request.headers) if isinstance(agent, self._TunnelingAgent): - headers.removeHeader(b'Proxy-Authorization') + headers.removeHeader(b"Proxy-Authorization") if request.body: bodyproducer = _RequestBodyProducer(request.body) else: bodyproducer = None start_time = time() - d = agent.request(method, to_bytes(url, encoding='ascii'), headers, bodyproducer) + d = agent.request( + method, to_bytes(url, encoding="ascii"), headers, bodyproducer + ) # set download latency d.addCallback(self._cb_latency, request, start_time) # response body is ready to be consumed @@ -345,14 +398,14 @@ class ScrapyAgent: raise TimeoutError(f"Getting {url} took longer than {timeout} seconds.") def _cb_latency(self, result, request, start_time): - request.meta['download_latency'] = time() - start_time + request.meta["download_latency"] = time() - start_time return result @staticmethod def _headers_from_twisted_response(response): headers = Headers() if response.length != UNKNOWN_LENGTH: - headers[b'Content-Length'] = str(response.length).encode() + headers[b"Content-Length"] = str(response.length).encode() headers.update(response.headers.getAllRawHeaders()) return headers @@ -366,8 +419,10 @@ class ScrapyAgent: ) for handler, result in headers_received_result: if isinstance(result, Failure) and isinstance(result.value, StopDownload): - logger.debug("Download stopped for %(request)s from signal handler %(handler)s", - {"request": request, "handler": handler.__qualname__}) + logger.debug( + "Download stopped for %(request)s from signal handler %(handler)s", + {"request": request, "handler": handler.__qualname__}, + ) txresponse._transport.stopProducing() txresponse._transport.loseConnection() return { @@ -389,15 +444,23 @@ class ScrapyAgent: "ip_address": None, } - maxsize = request.meta.get('download_maxsize', self._maxsize) - warnsize = request.meta.get('download_warnsize', self._warnsize) + maxsize = request.meta.get("download_maxsize", self._maxsize) + warnsize = request.meta.get("download_warnsize", self._warnsize) expected_size = txresponse.length if txresponse.length != UNKNOWN_LENGTH else -1 - fail_on_dataloss = request.meta.get('download_fail_on_dataloss', self._fail_on_dataloss) + fail_on_dataloss = request.meta.get( + "download_fail_on_dataloss", self._fail_on_dataloss + ) if maxsize and expected_size > maxsize: - warning_msg = ("Cancelling download of %(url)s: expected response " - "size (%(size)s) larger than download max size (%(maxsize)s).") - warning_args = {'url': request.url, 'size': expected_size, 'maxsize': maxsize} + warning_msg = ( + "Cancelling download of %(url)s: expected response " + "size (%(size)s) larger than download max size (%(maxsize)s)." + ) + warning_args = { + "url": request.url, + "size": expected_size, + "maxsize": maxsize, + } logger.warning(warning_msg, warning_args) @@ -405,9 +468,11 @@ class ScrapyAgent: raise defer.CancelledError(warning_msg % warning_args) if warnsize and expected_size > warnsize: - logger.warning("Expected response size (%(size)s) larger than " - "download warn size (%(warnsize)s) in request %(request)s.", - {'size': expected_size, 'warnsize': warnsize, 'request': request}) + logger.warning( + "Expected response size (%(size)s) larger than " + "download warn size (%(warnsize)s) in request %(request)s.", + {"size": expected_size, "warnsize": warnsize, "request": request}, + ) def _cancel(_): # Abort connection immediately. @@ -457,7 +522,6 @@ class ScrapyAgent: @implementer(IBodyProducer) class _RequestBodyProducer: - def __init__(self, body): self.body = body self.length = len(body) @@ -474,8 +538,16 @@ class _RequestBodyProducer: class _ResponseReader(protocol.Protocol): - - def __init__(self, finished, txresponse, request, maxsize, warnsize, fail_on_dataloss, crawler): + def __init__( + self, + finished, + txresponse, + request, + maxsize, + warnsize, + fail_on_dataloss, + crawler, + ): self._finished = finished self._txresponse = txresponse self._request = request @@ -491,22 +563,28 @@ class _ResponseReader(protocol.Protocol): self._crawler = crawler def _finish_response(self, flags=None, failure=None): - self._finished.callback({ - "txresponse": self._txresponse, - "body": self._bodybuf.getvalue(), - "flags": flags, - "certificate": self._certificate, - "ip_address": self._ip_address, - "failure": failure, - }) + self._finished.callback( + { + "txresponse": self._txresponse, + "body": self._bodybuf.getvalue(), + "flags": flags, + "certificate": self._certificate, + "ip_address": self._ip_address, + "failure": failure, + } + ) def connectionMade(self): if self._certificate is None: with suppress(AttributeError): - self._certificate = ssl.Certificate(self.transport._producer.getPeerCertificate()) + self._certificate = ssl.Certificate( + self.transport._producer.getPeerCertificate() + ) if self._ip_address is None: - self._ip_address = ipaddress.ip_address(self.transport._producer.getPeer().host) + self._ip_address = ipaddress.ip_address( + self.transport._producer.getPeer().host + ) def dataReceived(self, bodyBytes): # This maybe called several times after cancel was called with buffered data. @@ -524,29 +602,40 @@ class _ResponseReader(protocol.Protocol): ) for handler, result in bytes_received_result: if isinstance(result, Failure) and isinstance(result.value, StopDownload): - logger.debug("Download stopped for %(request)s from signal handler %(handler)s", - {"request": self._request, "handler": handler.__qualname__}) + logger.debug( + "Download stopped for %(request)s from signal handler %(handler)s", + {"request": self._request, "handler": handler.__qualname__}, + ) self.transport.stopProducing() self.transport.loseConnection() failure = result if result.value.fail else None self._finish_response(flags=["download_stopped"], failure=failure) if self._maxsize and self._bytes_received > self._maxsize: - logger.warning("Received (%(bytes)s) bytes larger than download " - "max size (%(maxsize)s) in request %(request)s.", - {'bytes': self._bytes_received, - 'maxsize': self._maxsize, - 'request': self._request}) + logger.warning( + "Received (%(bytes)s) bytes larger than download " + "max size (%(maxsize)s) in request %(request)s.", + { + "bytes": self._bytes_received, + "maxsize": self._maxsize, + "request": self._request, + }, + ) # Clear buffer earlier to avoid keeping data in memory for a long time. self._bodybuf.truncate(0) self._finished.cancel() - if self._warnsize and self._bytes_received > self._warnsize and not self._reached_warnsize: + if ( + self._warnsize + and self._bytes_received > self._warnsize + and not self._reached_warnsize + ): self._reached_warnsize = True - logger.warning("Received more bytes than download " - "warn size (%(warnsize)s) in request %(request)s.", - {'warnsize': self._warnsize, - 'request': self._request}) + logger.warning( + "Received more bytes than download " + "warn size (%(warnsize)s) in request %(request)s.", + {"warnsize": self._warnsize, "request": self._request}, + ) def connectionLost(self, reason): if self._finished.called: @@ -560,16 +649,20 @@ class _ResponseReader(protocol.Protocol): self._finish_response(flags=["partial"]) return - if reason.check(ResponseFailed) and any(r.check(_DataLoss) for r in reason.value.reasons): + if reason.check(ResponseFailed) and any( + r.check(_DataLoss) for r in reason.value.reasons + ): if not self._fail_on_dataloss: self._finish_response(flags=["dataloss"]) return if not self._fail_on_dataloss_warned: - logger.warning("Got data loss in %s. If you want to process broken " - "responses set the setting DOWNLOAD_FAIL_ON_DATALOSS = False" - " -- This message won't be shown in further requests", - self._txresponse.request.absoluteURI.decode()) + logger.warning( + "Got data loss in %s. If you want to process broken " + "responses set the setting DOWNLOAD_FAIL_ON_DATALOSS = False" + " -- This message won't be shown in further requests", + self._txresponse.request.absoluteURI.decode(), + ) self._fail_on_dataloss_warned = True self._finished.errback(reason) diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index 3f1b36e92..25ac0307b 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -17,7 +17,9 @@ from scrapy.spiders import Spider from scrapy.utils.python import to_bytes -H2DownloadHandlerOrSubclass = TypeVar("H2DownloadHandlerOrSubclass", bound="H2DownloadHandler") +H2DownloadHandlerOrSubclass = TypeVar( + "H2DownloadHandlerOrSubclass", bound="H2DownloadHandler" +) class H2DownloadHandler: @@ -25,11 +27,14 @@ class H2DownloadHandler: self._crawler = crawler from twisted.internet import reactor + self._pool = H2ConnectionPool(reactor, settings) self._context_factory = load_context_factory_from_settings(settings, crawler) @classmethod - def from_crawler(cls: Type[H2DownloadHandlerOrSubclass], crawler: Crawler) -> H2DownloadHandlerOrSubclass: + def from_crawler( + cls: Type[H2DownloadHandlerOrSubclass], crawler: Crawler + ) -> H2DownloadHandlerOrSubclass: return cls(crawler.settings, crawler) def download_request(self, request: Request, spider: Spider) -> Deferred: @@ -49,7 +54,8 @@ class ScrapyH2Agent: _ProxyAgent = ScrapyProxyH2Agent def __init__( - self, context_factory, + self, + context_factory, pool: H2ConnectionPool, connect_timeout: int = 10, bind_address: Optional[bytes] = None, @@ -63,19 +69,22 @@ class ScrapyH2Agent: def _get_agent(self, request: Request, timeout: Optional[float]) -> H2Agent: from twisted.internet import reactor - bind_address = request.meta.get('bindaddress') or self._bind_address - proxy = request.meta.get('proxy') + + bind_address = request.meta.get("bindaddress") or self._bind_address + proxy = request.meta.get("proxy") if proxy: _, _, proxy_host, proxy_port, proxy_params = _parse(proxy) scheme = _parse(request.url)[0] - if scheme == b'https': + if scheme == b"https": # ToDo - raise NotImplementedError('Tunneling via CONNECT method using HTTP/2.0 is not yet supported') + raise NotImplementedError( + "Tunneling via CONNECT method using HTTP/2.0 is not yet supported" + ) return self._ProxyAgent( reactor=reactor, context_factory=self._context_factory, - proxy_uri=URI.fromBytes(to_bytes(proxy, encoding='ascii')), + proxy_uri=URI.fromBytes(to_bytes(proxy, encoding="ascii")), connect_timeout=timeout, bind_address=bind_address, pool=self._pool, @@ -91,7 +100,8 @@ class ScrapyH2Agent: def download_request(self, request: Request, spider: Spider) -> Deferred: from twisted.internet import reactor - timeout = request.meta.get('download_timeout') or self._connect_timeout + + timeout = request.meta.get("download_timeout") or self._connect_timeout agent = self._get_agent(request, timeout) start_time = time() @@ -103,12 +113,16 @@ class ScrapyH2Agent: return d @staticmethod - def _cb_latency(response: Response, request: Request, start_time: float) -> Response: - request.meta['download_latency'] = time() - start_time + def _cb_latency( + response: Response, request: Request, start_time: float + ) -> Response: + request.meta["download_latency"] = time() - start_time return response @staticmethod - def _cb_timeout(response: Response, request: Request, timeout: float, timeout_cl: DelayedCall) -> Response: + def _cb_timeout( + response: Response, request: Request, timeout: float, timeout_cl: DelayedCall + ) -> Response: if timeout_cl.active(): timeout_cl.cancel() return response diff --git a/scrapy/core/downloader/handlers/s3.py b/scrapy/core/downloader/handlers/s3.py index 51ca1ed5e..81d8e8115 100644 --- a/scrapy/core/downloader/handlers/s3.py +++ b/scrapy/core/downloader/handlers/s3.py @@ -6,40 +6,49 @@ from scrapy.utils.misc import create_instance class S3DownloadHandler: - - def __init__(self, settings, *, - crawler=None, - aws_access_key_id=None, aws_secret_access_key=None, - aws_session_token=None, - httpdownloadhandler=HTTPDownloadHandler, **kw): + def __init__( + self, + settings, + *, + crawler=None, + aws_access_key_id=None, + aws_secret_access_key=None, + aws_session_token=None, + httpdownloadhandler=HTTPDownloadHandler, + **kw, + ): if not is_botocore_available(): - raise NotConfigured('missing botocore library') + raise NotConfigured("missing botocore library") if not aws_access_key_id: - aws_access_key_id = settings['AWS_ACCESS_KEY_ID'] + aws_access_key_id = settings["AWS_ACCESS_KEY_ID"] if not aws_secret_access_key: - aws_secret_access_key = settings['AWS_SECRET_ACCESS_KEY'] + aws_secret_access_key = settings["AWS_SECRET_ACCESS_KEY"] if not aws_session_token: - aws_session_token = settings['AWS_SESSION_TOKEN'] + aws_session_token = settings["AWS_SESSION_TOKEN"] # If no credentials could be found anywhere, # consider this an anonymous connection request by default; # unless 'anon' was set explicitly (True/False). - anon = kw.get('anon') + anon = kw.get("anon") if anon is None and not aws_access_key_id and not aws_secret_access_key: - kw['anon'] = True - self.anon = kw.get('anon') + kw["anon"] = True + self.anon = kw.get("anon") self._signer = None import botocore.auth import botocore.credentials - kw.pop('anon', None) + + kw.pop("anon", None) if kw: - raise TypeError(f'Unexpected keyword arguments: {kw}') + raise TypeError(f"Unexpected keyword arguments: {kw}") if not self.anon: - SignerCls = botocore.auth.AUTH_TYPE_MAPS['s3'] - self._signer = SignerCls(botocore.credentials.Credentials( - aws_access_key_id, aws_secret_access_key, aws_session_token)) + SignerCls = botocore.auth.AUTH_TYPE_MAPS["s3"] + self._signer = SignerCls( + botocore.credentials.Credentials( + aws_access_key_id, aws_secret_access_key, aws_session_token + ) + ) _http_handler = create_instance( objcls=httpdownloadhandler, @@ -54,20 +63,21 @@ class S3DownloadHandler: def download_request(self, request, spider): p = urlparse_cached(request) - scheme = 'https' if request.meta.get('is_secure') else 'http' + scheme = "https" if request.meta.get("is_secure") else "http" bucket = p.hostname - path = p.path + '?' + p.query if p.query else p.path - url = f'{scheme}://{bucket}.s3.amazonaws.com{path}' + path = p.path + "?" + p.query if p.query else p.path + url = f"{scheme}://{bucket}.s3.amazonaws.com{path}" if self.anon: request = request.replace(url=url) else: import botocore.awsrequest + awsrequest = botocore.awsrequest.AWSRequest( method=request.method, - url=f'{scheme}://s3.amazonaws.com/{bucket}{path}', + url=f"{scheme}://s3.amazonaws.com/{bucket}{path}", headers=request.headers.to_unicode_dict(), - data=request.body) + data=request.body, + ) self._signer.add_auth(awsrequest) - request = request.replace( - url=url, headers=awsrequest.headers.items()) + request = request.replace(url=url, headers=awsrequest.headers.items()) return self._download_http(request, spider) diff --git a/scrapy/core/downloader/middleware.py b/scrapy/core/downloader/middleware.py index 289147466..3410b4255 100644 --- a/scrapy/core/downloader/middleware.py +++ b/scrapy/core/downloader/middleware.py @@ -18,28 +18,31 @@ from scrapy.utils.conf import build_component_list class DownloaderMiddlewareManager(MiddlewareManager): - component_name = 'downloader middleware' + component_name = "downloader middleware" @classmethod def _get_mwlist_from_settings(cls, settings): - return build_component_list( - settings.getwithbase('DOWNLOADER_MIDDLEWARES')) + return build_component_list(settings.getwithbase("DOWNLOADER_MIDDLEWARES")) def _add_middleware(self, mw): - if hasattr(mw, 'process_request'): - self.methods['process_request'].append(mw.process_request) - if hasattr(mw, 'process_response'): - self.methods['process_response'].appendleft(mw.process_response) - if hasattr(mw, 'process_exception'): - self.methods['process_exception'].appendleft(mw.process_exception) + if hasattr(mw, "process_request"): + self.methods["process_request"].append(mw.process_request) + if hasattr(mw, "process_response"): + self.methods["process_response"].appendleft(mw.process_response) + if hasattr(mw, "process_exception"): + self.methods["process_exception"].appendleft(mw.process_exception) def download(self, download_func: Callable, request: Request, spider: Spider): @defer.inlineCallbacks def process_request(request: Request): - for method in self.methods['process_request']: + for method in self.methods["process_request"]: method = cast(Callable, method) - response = yield deferred_from_coro(method(request=request, spider=spider)) - if response is not None and not isinstance(response, (Response, Request)): + response = yield deferred_from_coro( + method(request=request, spider=spider) + ) + if response is not None and not isinstance( + response, (Response, Request) + ): raise _InvalidOutput( f"Middleware {method.__qualname__} must return None, Response or " f"Request, got {response.__class__.__name__}" @@ -55,9 +58,11 @@ class DownloaderMiddlewareManager(MiddlewareManager): elif isinstance(response, Request): return response - for method in self.methods['process_response']: + for method in self.methods["process_response"]: method = cast(Callable, method) - response = yield deferred_from_coro(method(request=request, response=response, spider=spider)) + response = yield deferred_from_coro( + method(request=request, response=response, spider=spider) + ) if not isinstance(response, (Response, Request)): raise _InvalidOutput( f"Middleware {method.__qualname__} must return Response or Request, " @@ -70,10 +75,14 @@ class DownloaderMiddlewareManager(MiddlewareManager): @defer.inlineCallbacks def process_exception(failure: Failure): exception = failure.value - for method in self.methods['process_exception']: + for method in self.methods["process_exception"]: method = cast(Callable, method) - response = yield deferred_from_coro(method(request=request, exception=exception, spider=spider)) - if response is not None and not isinstance(response, (Response, Request)): + response = yield deferred_from_coro( + method(request=request, exception=exception, spider=spider) + ) + if response is not None and not isinstance( + response, (Response, Request) + ): raise _InvalidOutput( f"Middleware {method.__qualname__} must return None, Response or " f"Request, got {type(response)}" diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 7d67a426f..db2639a75 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -2,7 +2,11 @@ import logging from OpenSSL import SSL from service_identity.exceptions import CertificateError -from twisted.internet._sslverify import ClientTLSOptions, verifyHostname, VerificationError +from twisted.internet._sslverify import ( + ClientTLSOptions, + verifyHostname, + VerificationError, +) from twisted.internet.ssl import AcceptableCiphers from scrapy.utils.ssl import x509name_to_string, get_temp_key_info @@ -10,17 +14,17 @@ from scrapy.utils.ssl import x509name_to_string, get_temp_key_info logger = logging.getLogger(__name__) -METHOD_TLS = 'TLS' -METHOD_TLSv10 = 'TLSv1.0' -METHOD_TLSv11 = 'TLSv1.1' -METHOD_TLSv12 = 'TLSv1.2' +METHOD_TLS = "TLS" +METHOD_TLSv10 = "TLSv1.0" +METHOD_TLSv11 = "TLSv1.1" +METHOD_TLSv12 = "TLSv1.2" openssl_methods = { - METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) - METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only - METHOD_TLSv11: getattr(SSL, 'TLSv1_1_METHOD', 5), # TLS 1.1 only - METHOD_TLSv12: getattr(SSL, 'TLSv1_2_METHOD', 6), # TLS 1.2 only + METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) + METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only + METHOD_TLSv11: getattr(SSL, "TLSv1_1_METHOD", 5), # TLS 1.1 only + METHOD_TLSv12: getattr(SSL, "TLSv1_2_METHOD", 6), # TLS 1.2 only } @@ -44,32 +48,38 @@ class ScrapyClientTLSOptions(ClientTLSOptions): connection.set_tlsext_host_name(self._hostnameBytes) elif where & SSL.SSL_CB_HANDSHAKE_DONE: if self.verbose_logging: - logger.debug('SSL connection to %s using protocol %s, cipher %s', - self._hostnameASCII, - connection.get_protocol_version_name(), - connection.get_cipher_name(), - ) + logger.debug( + "SSL connection to %s using protocol %s, cipher %s", + self._hostnameASCII, + connection.get_protocol_version_name(), + connection.get_cipher_name(), + ) server_cert = connection.get_peer_certificate() - logger.debug('SSL connection certificate: issuer "%s", subject "%s"', - x509name_to_string(server_cert.get_issuer()), - x509name_to_string(server_cert.get_subject()), - ) + logger.debug( + 'SSL connection certificate: issuer "%s", subject "%s"', + x509name_to_string(server_cert.get_issuer()), + x509name_to_string(server_cert.get_subject()), + ) key_info = get_temp_key_info(connection._ssl) if key_info: - logger.debug('SSL temp key: %s', key_info) + logger.debug("SSL temp key: %s", key_info) try: verifyHostname(connection, self._hostnameASCII) except (CertificateError, VerificationError) as e: logger.warning( 'Remote certificate is not valid for hostname "%s"; %s', - self._hostnameASCII, e) + self._hostnameASCII, + e, + ) except ValueError as e: logger.warning( - 'Ignoring error while verifying certificate ' + "Ignoring error while verifying certificate " 'from host "%s" (exception: %r)', - self._hostnameASCII, e) + self._hostnameASCII, + e, + ) -DEFAULT_CIPHERS = AcceptableCiphers.fromOpenSSLCipherString('DEFAULT') +DEFAULT_CIPHERS = AcceptableCiphers.fromOpenSSLCipherString("DEFAULT") diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index 255ca62e6..a00afb7af 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -15,33 +15,33 @@ from scrapy.responsetypes import responsetypes def _parsed_url_args(parsed): # Assume parsed is urlparse-d from Request.url, # which was passed via safe_url_string and is ascii-only. - path = urlunparse(('', '', parsed.path or '/', parsed.params, parsed.query, '')) + path = urlunparse(("", "", parsed.path or "/", parsed.params, parsed.query, "")) path = to_bytes(path, encoding="ascii") host = to_bytes(parsed.hostname, encoding="ascii") port = parsed.port scheme = to_bytes(parsed.scheme, encoding="ascii") netloc = to_bytes(parsed.netloc, encoding="ascii") if port is None: - port = 443 if scheme == b'https' else 80 + port = 443 if scheme == b"https" else 80 return scheme, netloc, host, port, path def _parse(url): - """ Return tuple of (scheme, netloc, host, port, path), + """Return tuple of (scheme, netloc, host, port, path), all in bytes except for port which is int. Assume url is from Request.url, which was passed via safe_url_string and is ascii-only. """ url = url.strip() - if not re.match(r'^\w+://', url): - url = '//' + url + if not re.match(r"^\w+://", url): + url = "//" + url parsed = urlparse(url) return _parsed_url_args(parsed) class ScrapyHTTPPageGetter(HTTPClient): - delimiter = b'\n' + delimiter = b"\n" def connectionMade(self): self.headers = Headers() # bucket for response headers @@ -75,8 +75,8 @@ class ScrapyHTTPPageGetter(HTTPClient): self.factory.noPage(reason) def handleResponse(self, response): - if self.factory.method.upper() == b'HEAD': - self.factory.page(b'') + if self.factory.method.upper() == b"HEAD": + self.factory.page(b"") elif self.length is not None and self.length > 0: self.factory.noPage(self._connection_lost_reason) else: @@ -87,12 +87,15 @@ class ScrapyHTTPPageGetter(HTTPClient): self.transport.loseConnection() # transport cleanup needed for HTTPS connections - if self.factory.url.startswith(b'https'): + if self.factory.url.startswith(b"https"): self.transport.stopProducing() self.factory.noPage( - defer.TimeoutError(f"Getting {self.factory.url} took longer " - f"than {self.factory.timeout} seconds.")) + defer.TimeoutError( + f"Getting {self.factory.url} took longer " + f"than {self.factory.timeout} seconds." + ) + ) # This class used to inherit from Twisted’s @@ -109,16 +112,24 @@ class ScrapyHTTPClientFactory(ClientFactory): afterFoundGet = False def _build_response(self, body, request): - request.meta['download_latency'] = self.headers_time - self.start_time + request.meta["download_latency"] = self.headers_time - self.start_time status = int(self.status) headers = Headers(self.response_headers) respcls = responsetypes.from_args(headers=headers, url=self._url, body=body) - return respcls(url=self._url, status=status, headers=headers, body=body, protocol=to_unicode(self.version)) + return respcls( + url=self._url, + status=status, + headers=headers, + body=body, + protocol=to_unicode(self.version), + ) def _set_connection_attributes(self, request): parsed = urlparse_cached(request) - self.scheme, self.netloc, self.host, self.port, self.path = _parsed_url_args(parsed) - proxy = request.meta.get('proxy') + self.scheme, self.netloc, self.host, self.port, self.path = _parsed_url_args( + parsed + ) + proxy = request.meta.get("proxy") if proxy: self.scheme, _, self.host, self.port, _ = _parse(proxy) self.path = self.url @@ -126,12 +137,12 @@ class ScrapyHTTPClientFactory(ClientFactory): def __init__(self, request, timeout=180): self._url = urldefrag(request.url)[0] # converting to bytes to comply to Twisted interface - self.url = to_bytes(self._url, encoding='ascii') - self.method = to_bytes(request.method, encoding='ascii') + self.url = to_bytes(self._url, encoding="ascii") + self.method = to_bytes(request.method, encoding="ascii") self.body = request.body or None self.headers = Headers(request.headers) self.response_headers = None - self.timeout = request.meta.get('download_timeout') or timeout + self.timeout = request.meta.get("download_timeout") or timeout self.start_time = time() self.deferred = defer.Deferred().addCallback(self._build_response, request) @@ -146,16 +157,16 @@ class ScrapyHTTPClientFactory(ClientFactory): self._set_connection_attributes(request) # set Host header based on url - self.headers.setdefault('Host', self.netloc) + self.headers.setdefault("Host", self.netloc) # set Content-Length based len of body if self.body is not None: - self.headers['Content-Length'] = len(self.body) + self.headers["Content-Length"] = len(self.body) # just in case a broken http/1.1 decides to keep connection alive self.headers.setdefault("Connection", "close") # Content-Length must be specified in POST method even with no body - elif self.method == b'POST': - self.headers['Content-Length'] = 0 + elif self.method == b"POST": + self.headers["Content-Length"] = 0 def __repr__(self): return f"<{self.__class__.__name__}: {self.url}>" @@ -171,6 +182,7 @@ class ScrapyHTTPClientFactory(ClientFactory): p.afterFoundGet = self.afterFoundGet if self.timeout: from twisted.internet import reactor + timeoutCall = reactor.callLater(self.timeout, p.timeout) self.deferred.addBoth(self._cancelTimeout, timeoutCall) return p diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index 1228e78da..19696415b 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -79,13 +79,14 @@ class ExecutionEngine: self.running = False self.paused = False self.scheduler_cls = self._get_scheduler_class(crawler.settings) - downloader_cls = load_object(self.settings['DOWNLOADER']) + downloader_cls = load_object(self.settings["DOWNLOADER"]) self.downloader = downloader_cls(crawler) self.scraper = Scraper(crawler) self._spider_closed_callback = spider_closed_callback def _get_scheduler_class(self, settings: BaseSettings) -> type: from scrapy.core.scheduler import BaseScheduler + scheduler_cls = load_object(settings["SCHEDULER"]) if not issubclass(scheduler_cls, BaseScheduler): raise TypeError( @@ -106,6 +107,7 @@ class ExecutionEngine: def stop(self) -> Deferred: """Gracefully stop the execution engine""" + @inlineCallbacks def _finish_stopping_engine(_) -> Deferred: yield self.signals.send_catch_log_deferred(signal=signals.engine_stopped) @@ -115,7 +117,11 @@ class ExecutionEngine: raise RuntimeError("Engine not running") self.running = False - dfd = self.close_spider(self.spider, reason="shutdown") if self.spider is not None else succeed(None) + dfd = ( + self.close_spider(self.spider, reason="shutdown") + if self.spider is not None + else succeed(None) + ) return dfd.addBoth(_finish_stopping_engine) def close(self) -> Deferred: @@ -126,7 +132,9 @@ class ExecutionEngine: if self.running: return self.stop() # will also close spider and downloader if self.spider is not None: - return self.close_spider(self.spider, reason="shutdown") # will also close downloader + return self.close_spider( + self.spider, reason="shutdown" + ) # will also close downloader return succeed(self.downloader.close()) def pause(self) -> None: @@ -144,7 +152,10 @@ class ExecutionEngine: if self.paused: return None - while not self._needs_backout() and self._next_request_from_scheduler() is not None: + while ( + not self._needs_backout() + and self._next_request_from_scheduler() is not None + ): pass if self.slot.start_requests is not None and not self._needs_backout(): @@ -154,7 +165,11 @@ class ExecutionEngine: self.slot.start_requests = None except Exception: self.slot.start_requests = None - logger.error('Error while obtaining start requests', exc_info=True, extra={'spider': self.spider}) + logger.error( + "Error while obtaining start requests", + exc_info=True, + extra={"spider": self.spider}, + ) else: self.crawl(request) @@ -179,18 +194,30 @@ class ExecutionEngine: d = self._download(request, self.spider) d.addBoth(self._handle_downloader_output, request) - d.addErrback(lambda f: logger.info('Error while handling downloader output', - exc_info=failure_to_exc_info(f), - extra={'spider': self.spider})) + d.addErrback( + lambda f: logger.info( + "Error while handling downloader output", + exc_info=failure_to_exc_info(f), + extra={"spider": self.spider}, + ) + ) d.addBoth(lambda _: self.slot.remove_request(request)) - d.addErrback(lambda f: logger.info('Error while removing request from slot', - exc_info=failure_to_exc_info(f), - extra={'spider': self.spider})) + d.addErrback( + lambda f: logger.info( + "Error while removing request from slot", + exc_info=failure_to_exc_info(f), + extra={"spider": self.spider}, + ) + ) slot = self.slot d.addBoth(lambda _: slot.nextcall.schedule()) - d.addErrback(lambda f: logger.info('Error while scheduling new request', - exc_info=failure_to_exc_info(f), - extra={'spider': self.spider})) + d.addErrback( + lambda f: logger.info( + "Error while scheduling new request", + exc_info=failure_to_exc_info(f), + extra={"spider": self.spider}, + ) + ) return d def _handle_downloader_output( @@ -199,7 +226,9 @@ class ExecutionEngine: assert self.spider is not None # typing if not isinstance(result, (Request, Response, Failure)): - raise TypeError(f"Incorrect type: expected Request, Response or Failure, got {type(result)}: {result!r}") + raise TypeError( + f"Incorrect type: expected Request, Response or Failure, got {type(result)}: {result!r}" + ) # downloader middleware can return requests (for example, redirects) if isinstance(result, Request): @@ -211,7 +240,7 @@ class ExecutionEngine: lambda f: logger.error( "Error while enqueuing downloader output", exc_info=failure_to_exc_info(f), - extra={'spider': self.spider}, + extra={"spider": self.spider}, ) ) return d @@ -244,16 +273,22 @@ class ExecutionEngine: stacklevel=2, ) if spider is not self.spider: - raise RuntimeError(f"The spider {spider.name!r} does not match the open spider") + raise RuntimeError( + f"The spider {spider.name!r} does not match the open spider" + ) if self.spider is None: raise RuntimeError(f"No open spider to crawl: {request}") self._schedule_request(request, self.spider) self.slot.nextcall.schedule() # type: ignore[union-attr] def _schedule_request(self, request: Request, spider: Spider) -> None: - self.signals.send_catch_log(signals.request_scheduled, request=request, spider=spider) + self.signals.send_catch_log( + signals.request_scheduled, request=request, spider=spider + ) if not self.slot.scheduler.enqueue_request(request): # type: ignore[union-attr] - self.signals.send_catch_log(signals.request_dropped, request=request, spider=spider) + self.signals.send_catch_log( + signals.request_dropped, request=request, spider=spider + ) def download(self, request: Request, spider: Optional[Spider] = None) -> Deferred: """Return a Deferred which fires with a Response as result, only downloader middlewares are applied""" @@ -264,10 +299,14 @@ class ExecutionEngine: stacklevel=2, ) if spider is not self.spider: - logger.warning("The spider '%s' does not match the open spider", spider.name) + logger.warning( + "The spider '%s' does not match the open spider", spider.name + ) if self.spider is None: raise RuntimeError(f"No open spider to crawl: {request}") - return self._download(request, spider).addBoth(self._downloaded, request, spider) + return self._download(request, spider).addBoth( + self._downloaded, request, spider + ) def _downloaded( self, result: Union[Response, Request], request: Request, spider: Spider @@ -286,7 +325,9 @@ class ExecutionEngine: def _on_success(result: Union[Response, Request]) -> Union[Response, Request]: if not isinstance(result, (Response, Request)): - raise TypeError(f"Incorrect type: expected Response or Request, got {type(result)}: {result!r}") + raise TypeError( + f"Incorrect type: expected Response or Request, got {type(result)}: {result!r}" + ) if isinstance(result, Response): if result.request is None: result.request = request @@ -311,13 +352,19 @@ class ExecutionEngine: return dwld @inlineCallbacks - def open_spider(self, spider: Spider, start_requests: Iterable = (), close_if_idle: bool = True): + def open_spider( + self, spider: Spider, start_requests: Iterable = (), close_if_idle: bool = True + ): if self.slot is not None: raise RuntimeError(f"No free spider slot when opening {spider.name!r}") - logger.info("Spider opened", extra={'spider': spider}) + logger.info("Spider opened", extra={"spider": spider}) nextcall = CallLaterOnce(self._next_request) - scheduler = create_instance(self.scheduler_cls, settings=None, crawler=self.crawler) - start_requests = yield self.scraper.spidermw.process_start_requests(start_requests, spider) + scheduler = create_instance( + self.scheduler_cls, settings=None, crawler=self.crawler + ) + start_requests = yield self.scraper.spidermw.process_start_requests( + start_requests, spider + ) self.slot = Slot(start_requests, close_if_idle, nextcall, scheduler) self.spider = spider if hasattr(scheduler, "open"): @@ -337,7 +384,9 @@ class ExecutionEngine: """ assert self.spider is not None # typing expected_ex = (DontCloseSpider, CloseSpider) - res = self.signals.send_catch_log(signals.spider_idle, spider=self.spider, dont_log=expected_ex) + res = self.signals.send_catch_log( + signals.spider_idle, spider=self.spider, dont_log=expected_ex + ) detected_ex = { ex: x.value for _, x in res @@ -347,7 +396,7 @@ class ExecutionEngine: if DontCloseSpider in detected_ex: return None if self.spider_is_idle(): - ex = detected_ex.get(CloseSpider, CloseSpider(reason='finished')) + ex = detected_ex.get(CloseSpider, CloseSpider(reason="finished")) assert isinstance(ex, CloseSpider) # typing self.close_spider(self.spider, reason=ex.reason) @@ -359,40 +408,55 @@ class ExecutionEngine: if self.slot.closing is not None: return self.slot.closing - logger.info("Closing spider (%(reason)s)", {'reason': reason}, extra={'spider': spider}) + logger.info( + "Closing spider (%(reason)s)", {"reason": reason}, extra={"spider": spider} + ) dfd = self.slot.close() def log_failure(msg: str) -> Callable: def errback(failure: Failure) -> None: - logger.error(msg, exc_info=failure_to_exc_info(failure), extra={'spider': spider}) + logger.error( + msg, exc_info=failure_to_exc_info(failure), extra={"spider": spider} + ) + return errback dfd.addBoth(lambda _: self.downloader.close()) - dfd.addErrback(log_failure('Downloader close failure')) + dfd.addErrback(log_failure("Downloader close failure")) dfd.addBoth(lambda _: self.scraper.close_spider(spider)) - dfd.addErrback(log_failure('Scraper close failure')) + dfd.addErrback(log_failure("Scraper close failure")) if hasattr(self.slot.scheduler, "close"): dfd.addBoth(lambda _: self.slot.scheduler.close(reason)) dfd.addErrback(log_failure("Scheduler close failure")) - dfd.addBoth(lambda _: self.signals.send_catch_log_deferred( - signal=signals.spider_closed, spider=spider, reason=reason, - )) - dfd.addErrback(log_failure('Error while sending spider_close signal')) + dfd.addBoth( + lambda _: self.signals.send_catch_log_deferred( + signal=signals.spider_closed, + spider=spider, + reason=reason, + ) + ) + dfd.addErrback(log_failure("Error while sending spider_close signal")) dfd.addBoth(lambda _: self.crawler.stats.close_spider(spider, reason=reason)) - dfd.addErrback(log_failure('Stats close failure')) + dfd.addErrback(log_failure("Stats close failure")) - dfd.addBoth(lambda _: logger.info("Spider closed (%(reason)s)", {'reason': reason}, extra={'spider': spider})) + dfd.addBoth( + lambda _: logger.info( + "Spider closed (%(reason)s)", + {"reason": reason}, + extra={"spider": spider}, + ) + ) - dfd.addBoth(lambda _: setattr(self, 'slot', None)) - dfd.addErrback(log_failure('Error while unassigning slot')) + dfd.addBoth(lambda _: setattr(self, "slot", None)) + dfd.addErrback(log_failure("Error while unassigning slot")) - dfd.addBoth(lambda _: setattr(self, 'spider', None)) - dfd.addErrback(log_failure('Error while unassigning spider')) + dfd.addBoth(lambda _: setattr(self, "spider", None)) + dfd.addErrback(log_failure("Error while unassigning spider")) dfd.addBoth(lambda _: self._spider_closed_callback(spider)) @@ -408,7 +472,11 @@ class ExecutionEngine: return [self.spider] if self.spider is not None else [] def has_capacity(self) -> bool: - warnings.warn("ExecutionEngine.has_capacity is deprecated", ScrapyDeprecationWarning, stacklevel=2) + warnings.warn( + "ExecutionEngine.has_capacity is deprecated", + ScrapyDeprecationWarning, + stacklevel=2, + ) return not bool(self.slot) def schedule(self, request: Request, spider: Spider) -> None: diff --git a/scrapy/core/http2/agent.py b/scrapy/core/http2/agent.py index c6b357be3..119443c80 100644 --- a/scrapy/core/http2/agent.py +++ b/scrapy/core/http2/agent.py @@ -28,7 +28,9 @@ class H2ConnectionPool: # Save all requests that arrive before the connection is established self._pending_requests: Dict[Tuple, Deque[Deferred]] = {} - def get_connection(self, key: Tuple, uri: URI, endpoint: HostnameEndpoint) -> Deferred: + def get_connection( + self, key: Tuple, uri: URI, endpoint: HostnameEndpoint + ) -> Deferred: if key in self._pending_requests: # Received a request while connecting to remote # Create a deferred which will fire with the H2ClientProtocol @@ -46,7 +48,9 @@ class H2ConnectionPool: # No connection is established for the given URI return self._new_connection(key, uri, endpoint) - def _new_connection(self, key: Tuple, uri: URI, endpoint: HostnameEndpoint) -> Deferred: + def _new_connection( + self, key: Tuple, uri: URI, endpoint: HostnameEndpoint + ) -> Deferred: self._pending_requests[key] = deque() conn_lost_deferred = Deferred() @@ -102,7 +106,9 @@ class H2Agent: ) -> None: self._reactor = reactor self._pool = pool - self._context_factory = AcceptableProtocolsContextFactory(context_factory, acceptable_protocols=[b'h2']) + self._context_factory = AcceptableProtocolsContextFactory( + context_factory, acceptable_protocols=[b"h2"] + ) self.endpoint_factory = _StandardEndpointFactory( self._reactor, self._context_factory, connect_timeout, bind_address ) @@ -118,7 +124,7 @@ class H2Agent: return uri.scheme, uri.host, uri.port def request(self, request: Request, spider: Spider) -> Deferred: - uri = URI.fromBytes(bytes(request.url, encoding='utf-8')) + uri = URI.fromBytes(bytes(request.url, encoding="utf-8")) try: endpoint = self.get_endpoint(uri) except SchemeNotSupported: diff --git a/scrapy/core/http2/protocol.py b/scrapy/core/http2/protocol.py index 6047f9ca8..214deeed0 100644 --- a/scrapy/core/http2/protocol.py +++ b/scrapy/core/http2/protocol.py @@ -9,9 +9,15 @@ from h2.config import H2Configuration from h2.connection import H2Connection from h2.errors import ErrorCodes from h2.events import ( - Event, ConnectionTerminated, DataReceived, ResponseReceived, - SettingsAcknowledged, StreamEnded, StreamReset, UnknownFrameReceived, - WindowUpdated + Event, + ConnectionTerminated, + DataReceived, + ResponseReceived, + SettingsAcknowledged, + StreamEnded, + StreamReset, + UnknownFrameReceived, + WindowUpdated, ) from h2.exceptions import FrameTooLargeError, H2Error from twisted.internet.defer import Deferred @@ -37,7 +43,6 @@ PROTOCOL_NAME = b"h2" class InvalidNegotiatedProtocol(H2Error): - def __init__(self, negotiated_protocol: bytes) -> None: self.negotiated_protocol = negotiated_protocol @@ -55,11 +60,13 @@ class RemoteTerminatedConnection(H2Error): self.terminate_event = event def __str__(self) -> str: - return f'Received GOAWAY frame from {self.remote_ip_address!r}' + return f"Received GOAWAY frame from {self.remote_ip_address!r}" class MethodNotAllowed405(H2Error): - def __init__(self, remote_ip_address: Optional[Union[IPv4Address, IPv6Address]]) -> None: + def __init__( + self, remote_ip_address: Optional[Union[IPv4Address, IPv6Address]] + ) -> None: self.remote_ip_address = remote_ip_address def __str__(self) -> str: @@ -70,7 +77,9 @@ class MethodNotAllowed405(H2Error): class H2ClientProtocol(Protocol, TimeoutMixin): IDLE_TIMEOUT = 240 - def __init__(self, uri: URI, settings: Settings, conn_lost_deferred: Deferred) -> None: + def __init__( + self, uri: URI, settings: Settings, conn_lost_deferred: Deferred + ) -> None: """ Arguments: uri -- URI of the base url to which HTTP/2 Connection will be made. @@ -82,7 +91,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """ self._conn_lost_deferred = conn_lost_deferred - config = H2Configuration(client_side=True, header_encoding='utf-8') + config = H2Configuration(client_side=True, header_encoding="utf-8") self.conn = H2Connection(config=config) # ID of the next request stream @@ -105,31 +114,25 @@ class H2ClientProtocol(Protocol, TimeoutMixin): # initialized when connection is successfully made self.metadata: Dict = { # Peer certificate instance - 'certificate': None, - + "certificate": None, # Address of the server we are connected to which # is updated when HTTP/2 connection is made successfully - 'ip_address': None, - + "ip_address": None, # URI of the peer HTTP/2 connection is made - 'uri': uri, - + "uri": uri, # Both ip_address and uri are used by the Stream before # initiating the request to verify that the base address - # Variables taken from Project Settings - 'default_download_maxsize': settings.getint('DOWNLOAD_MAXSIZE'), - 'default_download_warnsize': settings.getint('DOWNLOAD_WARNSIZE'), - + "default_download_maxsize": settings.getint("DOWNLOAD_MAXSIZE"), + "default_download_warnsize": settings.getint("DOWNLOAD_WARNSIZE"), # Counter to keep track of opened streams. This counter # is used to make sure that not more than MAX_CONCURRENT_STREAMS # streams are opened which leads to ProtocolError # We use simple FIFO policy to handle pending requests - 'active_streams': 0, - + "active_streams": 0, # Flag to keep track if settings were acknowledged by the remote # This ensures that we have established a HTTP/2 connection - 'settings_acknowledged': False, + "settings_acknowledged": False, } @property @@ -138,7 +141,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): This is used while initiating pending streams to make sure that we initiate stream only during active HTTP/2 Connection """ - return bool(self.transport.connected) and self.metadata['settings_acknowledged'] + return bool(self.transport.connected) and self.metadata["settings_acknowledged"] @property def allowed_max_concurrent_streams(self) -> int: @@ -149,7 +152,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """ return min( self.conn.local_settings.max_concurrent_streams, - self.conn.remote_settings.max_concurrent_streams + self.conn.remote_settings.max_concurrent_streams, ) def _send_pending_requests(self) -> None: @@ -159,37 +162,39 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """ while ( self._pending_request_stream_pool - and self.metadata['active_streams'] < self.allowed_max_concurrent_streams + and self.metadata["active_streams"] < self.allowed_max_concurrent_streams and self.h2_connected ): - self.metadata['active_streams'] += 1 + self.metadata["active_streams"] += 1 stream = self._pending_request_stream_pool.popleft() stream.initiate_request() self._write_to_transport() def pop_stream(self, stream_id: int) -> Stream: - """Perform cleanup when a stream is closed - """ + """Perform cleanup when a stream is closed""" stream = self.streams.pop(stream_id) - self.metadata['active_streams'] -= 1 + self.metadata["active_streams"] -= 1 self._send_pending_requests() return stream def _new_stream(self, request: Request, spider: Spider) -> Stream: - """Instantiates a new Stream object - """ + """Instantiates a new Stream object""" stream = Stream( stream_id=next(self._stream_id_generator), request=request, protocol=self, - download_maxsize=getattr(spider, 'download_maxsize', self.metadata['default_download_maxsize']), - download_warnsize=getattr(spider, 'download_warnsize', self.metadata['default_download_warnsize']), + download_maxsize=getattr( + spider, "download_maxsize", self.metadata["default_download_maxsize"] + ), + download_warnsize=getattr( + spider, "download_warnsize", self.metadata["default_download_warnsize"] + ), ) self.streams[stream.stream_id] = stream return stream def _write_to_transport(self) -> None: - """ Write data to the underlying transport connection + """Write data to the underlying transport connection from the HTTP2 connection instance if any """ # Reset the idle timeout as connection is still actively sending data @@ -200,7 +205,9 @@ class H2ClientProtocol(Protocol, TimeoutMixin): def request(self, request: Request, spider: Spider) -> Deferred: if not isinstance(request, Request): - raise TypeError(f'Expected scrapy.http.Request, received {request.__class__.__qualname__}') + raise TypeError( + f"Expected scrapy.http.Request, received {request.__class__.__qualname__}" + ) stream = self._new_stream(request, spider) d = stream.get_response() @@ -221,7 +228,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): self.setTimeout(self.IDLE_TIMEOUT) destination = self.transport.getPeer() - self.metadata['ip_address'] = ipaddress.ip_address(destination.host) + self.metadata["ip_address"] = ipaddress.ip_address(destination.host) # Initiate H2 Connection self.conn.initiate_connection() @@ -237,9 +244,14 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """ Close the connection if it's not made via the expected protocol """ - if self.transport.negotiatedProtocol is not None and self.transport.negotiatedProtocol != PROTOCOL_NAME: + if ( + self.transport.negotiatedProtocol is not None + and self.transport.negotiatedProtocol != PROTOCOL_NAME + ): # we have not initiated the connection yet, no need to send a GOAWAY frame to the remote peer - self._lose_connection_with_error([InvalidNegotiatedProtocol(self.transport.negotiatedProtocol)]) + self._lose_connection_with_error( + [InvalidNegotiatedProtocol(self.transport.negotiatedProtocol)] + ) def _check_received_data(self, data: bytes) -> None: """Checks for edge cases where the connection to remote fails @@ -248,8 +260,8 @@ class H2ClientProtocol(Protocol, TimeoutMixin): Arguments: data -- Data received from the remote """ - if data.startswith(b'HTTP/2.0 405 Method Not Allowed'): - raise MethodNotAllowed405(self.metadata['ip_address']) + if data.startswith(b"HTTP/2.0 405 Method Not Allowed"): + raise MethodNotAllowed405(self.metadata["ip_address"]) def dataReceived(self, data: bytes) -> None: # Reset the idle timeout as connection is still actively receiving data @@ -284,7 +296,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): if ( self.conn.open_outbound_streams > 0 or self.conn.open_inbound_streams > 0 - or self.metadata['active_streams'] > 0 + or self.metadata["active_streams"] > 0 ): error_code = ErrorCodes.PROTOCOL_ERROR else: @@ -292,9 +304,9 @@ class H2ClientProtocol(Protocol, TimeoutMixin): self.conn.close_connection(error_code=error_code) self._write_to_transport() - self._lose_connection_with_error([ - TimeoutError(f"Connection was IDLE for more than {self.IDLE_TIMEOUT}s") - ]) + self._lose_connection_with_error( + [TimeoutError(f"Connection was IDLE for more than {self.IDLE_TIMEOUT}s")] + ) def connectionLost(self, reason: Failure = connectionDone) -> None: """Called by Twisted when the transport connection is lost. @@ -311,13 +323,13 @@ class H2ClientProtocol(Protocol, TimeoutMixin): self._conn_lost_deferred.callback(self._conn_lost_errors) for stream in self.streams.values(): - if stream.metadata['request_sent']: + if stream.metadata["request_sent"]: close_reason = StreamCloseReason.CONNECTION_LOST else: close_reason = StreamCloseReason.INACTIVE stream.close(close_reason, self._conn_lost_errors, from_protocol=True) - self.metadata['active_streams'] -= len(self.streams) + self.metadata["active_streams"] -= len(self.streams) self.streams.clear() self._pending_request_stream_pool.clear() self.conn.close_connection() @@ -345,13 +357,13 @@ class H2ClientProtocol(Protocol, TimeoutMixin): elif isinstance(event, SettingsAcknowledged): self.settings_acknowledged(event) elif isinstance(event, UnknownFrameReceived): - logger.warning('Unknown frame received: %s', event.frame) + logger.warning("Unknown frame received: %s", event.frame) # Event handler functions starts here def connection_terminated(self, event: ConnectionTerminated) -> None: - self._lose_connection_with_error([ - RemoteTerminatedConnection(self.metadata['ip_address'], event) - ]) + self._lose_connection_with_error( + [RemoteTerminatedConnection(self.metadata["ip_address"], event)] + ) def data_received(self, event: DataReceived) -> None: try: @@ -370,14 +382,14 @@ class H2ClientProtocol(Protocol, TimeoutMixin): stream.receive_headers(event.headers) def settings_acknowledged(self, event: SettingsAcknowledged) -> None: - self.metadata['settings_acknowledged'] = True + self.metadata["settings_acknowledged"] = True # Send off all the pending requests as now we have # established a proper HTTP/2 connection self._send_pending_requests() # Update certificate when our HTTP/2 connection is established - self.metadata['certificate'] = Certificate(self.transport.getPeerCertificate()) + self.metadata["certificate"] = Certificate(self.transport.getPeerCertificate()) def stream_ended(self, event: StreamEnded) -> None: try: @@ -406,7 +418,9 @@ class H2ClientProtocol(Protocol, TimeoutMixin): @implementer(IProtocolNegotiationFactory) class H2ClientFactory(Factory): - def __init__(self, uri: URI, settings: Settings, conn_lost_deferred: Deferred) -> None: + def __init__( + self, uri: URI, settings: Settings, conn_lost_deferred: Deferred + ) -> None: self.uri = uri self.settings = settings self.conn_lost_deferred = conn_lost_deferred diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index e197790f7..1b185cd8c 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -32,18 +32,19 @@ class InactiveStreamClosed(ConnectionClosed): self.request = request def __str__(self) -> str: - return f'InactiveStreamClosed: Connection was closed without sending the request {self.request!r}' + return f"InactiveStreamClosed: Connection was closed without sending the request {self.request!r}" class InvalidHostname(H2Error): - - def __init__(self, request: Request, expected_hostname: str, expected_netloc: str) -> None: + def __init__( + self, request: Request, expected_hostname: str, expected_netloc: str + ) -> None: self.request = request self.expected_hostname = expected_hostname self.expected_netloc = expected_netloc def __str__(self) -> str: - return f'InvalidHostname: Expected {self.expected_hostname} or {self.expected_netloc} in {self.request}' + return f"InvalidHostname: Expected {self.expected_hostname} or {self.expected_netloc} in {self.request}" class StreamCloseReason(Enum): @@ -100,28 +101,31 @@ class Stream: self._request: Request = request self._protocol: "H2ClientProtocol" = protocol - self._download_maxsize = self._request.meta.get('download_maxsize', download_maxsize) - self._download_warnsize = self._request.meta.get('download_warnsize', download_warnsize) + self._download_maxsize = self._request.meta.get( + "download_maxsize", download_maxsize + ) + self._download_warnsize = self._request.meta.get( + "download_warnsize", download_warnsize + ) # Metadata of an HTTP/2 connection stream # initialized when stream is instantiated self.metadata: Dict = { - 'request_content_length': 0 if self._request.body is None else len(self._request.body), - + "request_content_length": 0 + if self._request.body is None + else len(self._request.body), # Flag to keep track whether the stream has initiated the request - 'request_sent': False, - + "request_sent": False, # Flag to track whether we have logged about exceeding download warnsize - 'reached_warnsize': False, - + "reached_warnsize": False, # Each time we send a data frame, we will decrease value by the amount send. - 'remaining_content_length': 0 if self._request.body is None else len(self._request.body), - + "remaining_content_length": 0 + if self._request.body is None + else len(self._request.body), # Flag to keep track whether client (self) have closed this stream - 'stream_closed_local': False, - + "stream_closed_local": False, # Flag to keep track whether the server has closed the stream - 'stream_closed_server': False, + "stream_closed_server": False, } # Private variable used to build the response @@ -130,21 +134,19 @@ class Stream: self._response: Dict = { # Data received frame by frame from the server is appended # and passed to the response Deferred when completely received. - 'body': BytesIO(), - + "body": BytesIO(), # The amount of data received that counts against the # flow control window - 'flow_controlled_size': 0, - + "flow_controlled_size": 0, # Headers received after sending the request - 'headers': Headers({}), + "headers": Headers({}), } def _cancel(_) -> None: # Close this stream as gracefully as possible # If the associated request is initiated we reset this stream # else we directly call close() method - if self.metadata['request_sent']: + if self.metadata["request_sent"]: self.reset_stream(StreamCloseReason.CANCELLED) else: self.close(StreamCloseReason.CANCELLED) @@ -152,7 +154,7 @@ class Stream: self._deferred_response = Deferred(_cancel) def __repr__(self) -> str: - return f'Stream(id={self.stream_id!r})' + return f"Stream(id={self.stream_id!r})" @property def _log_warnsize(self) -> bool: @@ -163,14 +165,16 @@ class Stream: True if both the above conditions hold true False if any of the conditions is false """ - content_length_header = int(self._response['headers'].get(b'Content-Length', -1)) + content_length_header = int( + self._response["headers"].get(b"Content-Length", -1) + ) return ( self._download_warnsize and ( - self._response['flow_controlled_size'] > self._download_warnsize + self._response["flow_controlled_size"] > self._download_warnsize or content_length_header > self._download_warnsize ) - and not self.metadata['reached_warnsize'] + and not self.metadata["reached_warnsize"] ) def get_response(self) -> Deferred: @@ -183,9 +187,10 @@ class Stream: # Make sure that we are sending the request to the correct URL url = urlparse(self._request.url) return ( - url.netloc == str(self._protocol.metadata['uri'].host, 'utf-8') - or url.netloc == str(self._protocol.metadata['uri'].netloc, 'utf-8') - or url.netloc == f'{self._protocol.metadata["ip_address"]}:{self._protocol.metadata["uri"].port}' + url.netloc == str(self._protocol.metadata["uri"].host, "utf-8") + or url.netloc == str(self._protocol.metadata["uri"].netloc, "utf-8") + or url.netloc + == f'{self._protocol.metadata["ip_address"]}:{self._protocol.metadata["uri"].port}' ) def _get_request_headers(self) -> List[Tuple[str, str]]: @@ -193,7 +198,7 @@ class Stream: path = url.path if url.query: - path += '?' + url.query + path += "?" + url.query # This pseudo-header field MUST NOT be empty for "http" or "https" # URIs; "http" or "https" URIs that do not contain a path component @@ -202,40 +207,40 @@ class Stream: # a path component; these MUST include a ":path" pseudo-header field # with a value of '*' (refer RFC 7540 - Section 8.1.2.3) if not path: - path = '*' if self._request.method == 'OPTIONS' else '/' + path = "*" if self._request.method == "OPTIONS" else "/" # Make sure pseudo-headers comes before all the other headers headers = [ - (':method', self._request.method), - (':authority', url.netloc), + (":method", self._request.method), + (":authority", url.netloc), ] # The ":scheme" and ":path" pseudo-header fields MUST # be omitted for CONNECT method (refer RFC 7540 - Section 8.3) - if self._request.method != 'CONNECT': + if self._request.method != "CONNECT": headers += [ - (':scheme', self._protocol.metadata['uri'].scheme), - (':path', path), + (":scheme", self._protocol.metadata["uri"].scheme), + (":path", path), ] content_length = str(len(self._request.body)) - headers.append(('Content-Length', content_length)) + headers.append(("Content-Length", content_length)) - content_length_name = self._request.headers.normkey(b'Content-Length') + content_length_name = self._request.headers.normkey(b"Content-Length") for name, values in self._request.headers.items(): for value in values: - value = str(value, 'utf-8') + value = str(value, "utf-8") if name == content_length_name: if value != content_length: logger.warning( - 'Ignoring bad Content-Length header %r of request %r, ' - 'sending %r instead', + "Ignoring bad Content-Length header %r of request %r, " + "sending %r instead", value, self._request, content_length, ) continue - headers.append((str(name, 'utf-8'), value)) + headers.append((str(name, "utf-8"), value)) return headers @@ -243,7 +248,7 @@ class Stream: if self.check_request_url(): headers = self._get_request_headers() self._protocol.conn.send_headers(self.stream_id, headers, end_stream=False) - self.metadata['request_sent'] = True + self.metadata["request_sent"] = True self.send_data() else: # Close this stream calling the response errback @@ -252,44 +257,53 @@ class Stream: def send_data(self) -> None: """Called immediately after the headers are sent. Here we send all the - data as part of the request. + data as part of the request. - If the content length is 0 initially then we end the stream immediately and - wait for response data. + If the content length is 0 initially then we end the stream immediately and + wait for response data. - Warning: Only call this method when stream not closed from client side - and has initiated request already by sending HEADER frame. If not then - stream will raise ProtocolError (raise by h2 state machine). - """ - if self.metadata['stream_closed_local']: + Warning: Only call this method when stream not closed from client side + and has initiated request already by sending HEADER frame. If not then + stream will raise ProtocolError (raise by h2 state machine). + """ + if self.metadata["stream_closed_local"]: raise StreamClosedError(self.stream_id) # Firstly, check what the flow control window is for current stream. - window_size = self._protocol.conn.local_flow_control_window(stream_id=self.stream_id) + window_size = self._protocol.conn.local_flow_control_window( + stream_id=self.stream_id + ) # Next, check what the maximum frame size is. max_frame_size = self._protocol.conn.max_outbound_frame_size # We will send no more than the window size or the remaining file size # of data in this call, whichever is smaller. - bytes_to_send_size = min(window_size, self.metadata['remaining_content_length']) + bytes_to_send_size = min(window_size, self.metadata["remaining_content_length"]) # We now need to send a number of data frames. while bytes_to_send_size > 0: chunk_size = min(bytes_to_send_size, max_frame_size) - data_chunk_start_id = self.metadata['request_content_length'] - self.metadata['remaining_content_length'] - data_chunk = self._request.body[data_chunk_start_id:data_chunk_start_id + chunk_size] + data_chunk_start_id = ( + self.metadata["request_content_length"] + - self.metadata["remaining_content_length"] + ) + data_chunk = self._request.body[ + data_chunk_start_id : data_chunk_start_id + chunk_size + ] self._protocol.conn.send_data(self.stream_id, data_chunk, end_stream=False) bytes_to_send_size -= chunk_size - self.metadata['remaining_content_length'] -= chunk_size + self.metadata["remaining_content_length"] -= chunk_size - self.metadata['remaining_content_length'] = max(0, self.metadata['remaining_content_length']) + self.metadata["remaining_content_length"] = max( + 0, self.metadata["remaining_content_length"] + ) # End the stream if no more data needs to be send - if self.metadata['remaining_content_length'] == 0: + if self.metadata["remaining_content_length"] == 0: self._protocol.conn.end_stream(self.stream_id) # Q. What about the rest of the data? @@ -301,62 +315,64 @@ class Stream: blocked behind the flow control. """ if ( - self.metadata['remaining_content_length'] - and not self.metadata['stream_closed_server'] - and self.metadata['request_sent'] + self.metadata["remaining_content_length"] + and not self.metadata["stream_closed_server"] + and self.metadata["request_sent"] ): self.send_data() def receive_data(self, data: bytes, flow_controlled_length: int) -> None: - self._response['body'].write(data) - self._response['flow_controlled_size'] += flow_controlled_length + self._response["body"].write(data) + self._response["flow_controlled_size"] += flow_controlled_length # We check maxsize here in case the Content-Length header was not received - if self._download_maxsize and self._response['flow_controlled_size'] > self._download_maxsize: + if ( + self._download_maxsize + and self._response["flow_controlled_size"] > self._download_maxsize + ): self.reset_stream(StreamCloseReason.MAXSIZE_EXCEEDED) return if self._log_warnsize: - self.metadata['reached_warnsize'] = True + self.metadata["reached_warnsize"] = True warning_msg = ( f'Received more ({self._response["flow_controlled_size"]}) bytes than download ' - f'warn size ({self._download_warnsize}) in request {self._request}' + f"warn size ({self._download_warnsize}) in request {self._request}" ) logger.warning(warning_msg) # Acknowledge the data received self._protocol.conn.acknowledge_received_data( - self._response['flow_controlled_size'], - self.stream_id + self._response["flow_controlled_size"], self.stream_id ) def receive_headers(self, headers: List[HeaderTuple]) -> None: for name, value in headers: - self._response['headers'][name] = value + self._response["headers"][name] = value # Check if we exceed the allowed max data size which can be received - expected_size = int(self._response['headers'].get(b'Content-Length', -1)) + expected_size = int(self._response["headers"].get(b"Content-Length", -1)) if self._download_maxsize and expected_size > self._download_maxsize: self.reset_stream(StreamCloseReason.MAXSIZE_EXCEEDED) return if self._log_warnsize: - self.metadata['reached_warnsize'] = True + self.metadata["reached_warnsize"] = True warning_msg = ( - f'Expected response size ({expected_size}) larger than ' - f'download warn size ({self._download_warnsize}) in request {self._request}' + f"Expected response size ({expected_size}) larger than " + f"download warn size ({self._download_warnsize}) in request {self._request}" ) logger.warning(warning_msg) def reset_stream(self, reason: StreamCloseReason = StreamCloseReason.RESET) -> None: """Close this stream by sending a RST_FRAME to the remote peer""" - if self.metadata['stream_closed_local']: + if self.metadata["stream_closed_local"]: raise StreamClosedError(self.stream_id) # Clear buffer earlier to avoid keeping data in memory for a long time - self._response['body'].truncate(0) + self._response["body"].truncate(0) - self.metadata['stream_closed_local'] = True + self.metadata["stream_closed_local"] = True self._protocol.conn.reset_stream(self.stream_id, ErrorCodes.REFUSED_STREAM) self.close(reason) @@ -366,13 +382,14 @@ class Stream: errors: Optional[List[BaseException]] = None, from_protocol: bool = False, ) -> None: - """Based on the reason sent we will handle each case. - """ - if self.metadata['stream_closed_server']: + """Based on the reason sent we will handle each case.""" + if self.metadata["stream_closed_server"]: raise StreamClosedError(self.stream_id) if not isinstance(reason, StreamCloseReason): - raise TypeError(f'Expected StreamCloseReason, received {reason.__class__.__qualname__}') + raise TypeError( + f"Expected StreamCloseReason, received {reason.__class__.__qualname__}" + ) # Have default value of errors as an empty list as # some cases can add a list of exceptions @@ -381,7 +398,7 @@ class Stream: if not from_protocol: self._protocol.pop_stream(self.stream_id) - self.metadata['stream_closed_server'] = True + self.metadata["stream_closed_server"] = True # We do not check for Content-Length or Transfer-Encoding in response headers # and add `partial` flag as in HTTP/1.1 as 'A request or response that includes @@ -392,13 +409,14 @@ class Stream: # receiving DATA_FRAME's when we have received the headers (not # having Content-Length) if reason is StreamCloseReason.MAXSIZE_EXCEEDED: - expected_size = int(self._response['headers'].get( - b'Content-Length', - self._response['flow_controlled_size']) + expected_size = int( + self._response["headers"].get( + b"Content-Length", self._response["flow_controlled_size"] + ) ) error_msg = ( - f'Cancelling download of {self._request.url}: received response ' - f'size ({expected_size}) larger than download max size ({self._download_maxsize})' + f"Cancelling download of {self._request.url}: received response " + f"size ({expected_size}) larger than download max size ({self._download_maxsize})" ) logger.error(error_msg) self._deferred_response.errback(CancelledError(error_msg)) @@ -416,16 +434,20 @@ class Stream: # There maybe no :status in headers, we make # HTTP Status Code: 499 - Client Closed Request - self._response['headers'][':status'] = '499' + self._response["headers"][":status"] = "499" self._fire_response_deferred() elif reason is StreamCloseReason.RESET: - self._deferred_response.errback(ResponseFailed([ - Failure( - f'Remote peer {self._protocol.metadata["ip_address"]} sent RST_STREAM', - ProtocolError + self._deferred_response.errback( + ResponseFailed( + [ + Failure( + f'Remote peer {self._protocol.metadata["ip_address"]} sent RST_STREAM', + ProtocolError, + ) + ] ) - ])) + ) elif reason is StreamCloseReason.CONNECTION_LOST: self._deferred_response.errback(ResponseFailed(errors)) @@ -436,33 +458,35 @@ class Stream: else: assert reason is StreamCloseReason.INVALID_HOSTNAME - self._deferred_response.errback(InvalidHostname( - self._request, - str(self._protocol.metadata['uri'].host, 'utf-8'), - f'{self._protocol.metadata["ip_address"]}:{self._protocol.metadata["uri"].port}' - )) + self._deferred_response.errback( + InvalidHostname( + self._request, + str(self._protocol.metadata["uri"].host, "utf-8"), + f'{self._protocol.metadata["ip_address"]}:{self._protocol.metadata["uri"].port}', + ) + ) def _fire_response_deferred(self) -> None: """Builds response from the self._response dict and fires the response deferred callback with the generated response instance""" - body = self._response['body'].getvalue() + body = self._response["body"].getvalue() response_cls = responsetypes.from_args( - headers=self._response['headers'], + headers=self._response["headers"], url=self._request.url, body=body, ) response = response_cls( url=self._request.url, - status=int(self._response['headers'][':status']), - headers=self._response['headers'], + status=int(self._response["headers"][":status"]), + headers=self._response["headers"], body=body, request=self._request, - certificate=self._protocol.metadata['certificate'], - ip_address=self._protocol.metadata['ip_address'], - protocol='h2', + certificate=self._protocol.metadata["certificate"], + ip_address=self._protocol.metadata["ip_address"], + protocol="h2", ) self._deferred_response.callback(response) diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 6dd5d51a8..1e6fc69e1 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -20,14 +20,18 @@ class BaseSchedulerMeta(type): """ Metaclass to check scheduler classes against the necessary interface """ + def __instancecheck__(cls, instance): return cls.__subclasscheck__(type(instance)) def __subclasscheck__(cls, subclass): return ( - hasattr(subclass, "has_pending_requests") and callable(subclass.has_pending_requests) - and hasattr(subclass, "enqueue_request") and callable(subclass.enqueue_request) - and hasattr(subclass, "next_request") and callable(subclass.next_request) + hasattr(subclass, "has_pending_requests") + and callable(subclass.has_pending_requests) + and hasattr(subclass, "enqueue_request") + and callable(subclass.enqueue_request) + and hasattr(subclass, "next_request") + and callable(subclass.next_request) ) @@ -162,6 +166,7 @@ class Scheduler(BaseScheduler): :param crawler: The crawler object corresponding to the current crawl. :type crawler: :class:`scrapy.crawler.Crawler` """ + def __init__( self, dupefilter, @@ -187,15 +192,15 @@ class Scheduler(BaseScheduler): """ Factory method, initializes the scheduler with arguments taken from the crawl settings """ - dupefilter_cls = load_object(crawler.settings['DUPEFILTER_CLASS']) + dupefilter_cls = load_object(crawler.settings["DUPEFILTER_CLASS"]) return cls( dupefilter=create_instance(dupefilter_cls, crawler.settings, crawler), jobdir=job_dir(crawler.settings), - dqclass=load_object(crawler.settings['SCHEDULER_DISK_QUEUE']), - mqclass=load_object(crawler.settings['SCHEDULER_MEMORY_QUEUE']), - logunser=crawler.settings.getbool('SCHEDULER_DEBUG'), + dqclass=load_object(crawler.settings["SCHEDULER_DISK_QUEUE"]), + mqclass=load_object(crawler.settings["SCHEDULER_MEMORY_QUEUE"]), + logunser=crawler.settings.getbool("SCHEDULER_DEBUG"), stats=crawler.stats, - pqclass=load_object(crawler.settings['SCHEDULER_PRIORITY_QUEUE']), + pqclass=load_object(crawler.settings["SCHEDULER_PRIORITY_QUEUE"]), crawler=crawler, ) @@ -239,11 +244,11 @@ class Scheduler(BaseScheduler): return False dqok = self._dqpush(request) if dqok: - self.stats.inc_value('scheduler/enqueued/disk', spider=self.spider) + self.stats.inc_value("scheduler/enqueued/disk", spider=self.spider) else: self._mqpush(request) - self.stats.inc_value('scheduler/enqueued/memory', spider=self.spider) - self.stats.inc_value('scheduler/enqueued', spider=self.spider) + self.stats.inc_value("scheduler/enqueued/memory", spider=self.spider) + self.stats.inc_value("scheduler/enqueued", spider=self.spider) return True def next_request(self) -> Optional[Request]: @@ -257,13 +262,13 @@ class Scheduler(BaseScheduler): """ request = self.mqs.pop() if request is not None: - self.stats.inc_value('scheduler/dequeued/memory', spider=self.spider) + self.stats.inc_value("scheduler/dequeued/memory", spider=self.spider) else: request = self._dqpop() if request is not None: - self.stats.inc_value('scheduler/dequeued/disk', spider=self.spider) + self.stats.inc_value("scheduler/dequeued/disk", spider=self.spider) if request is not None: - self.stats.inc_value('scheduler/dequeued', spider=self.spider) + self.stats.inc_value("scheduler/dequeued", spider=self.spider) return request def __len__(self) -> int: @@ -279,13 +284,19 @@ class Scheduler(BaseScheduler): self.dqs.push(request) except ValueError as e: # non serializable request if self.logunser: - msg = ("Unable to serialize request: %(request)s - reason:" - " %(reason)s - no more unserializable requests will be" - " logged (stats being collected)") - logger.warning(msg, {'request': request, 'reason': e}, - exc_info=True, extra={'spider': self.spider}) + msg = ( + "Unable to serialize request: %(request)s - reason:" + " %(reason)s - no more unserializable requests will be" + " logged (stats being collected)" + ) + logger.warning( + msg, + {"request": request, "reason": e}, + exc_info=True, + extra={"spider": self.spider}, + ) self.logunser = False - self.stats.inc_value('scheduler/unserializable', spider=self.spider) + self.stats.inc_value("scheduler/unserializable", spider=self.spider) return False else: return True @@ -299,43 +310,50 @@ class Scheduler(BaseScheduler): return None def _mq(self): - """ Create a new priority queue instance, with in-memory storage """ - return create_instance(self.pqclass, - settings=None, - crawler=self.crawler, - downstream_queue_cls=self.mqclass, - key='') + """Create a new priority queue instance, with in-memory storage""" + return create_instance( + self.pqclass, + settings=None, + crawler=self.crawler, + downstream_queue_cls=self.mqclass, + key="", + ) def _dq(self): - """ Create a new priority queue instance, with disk storage """ + """Create a new priority queue instance, with disk storage""" state = self._read_dqs_state(self.dqdir) - q = create_instance(self.pqclass, - settings=None, - crawler=self.crawler, - downstream_queue_cls=self.dqclass, - key=self.dqdir, - startprios=state) + q = create_instance( + self.pqclass, + settings=None, + crawler=self.crawler, + downstream_queue_cls=self.dqclass, + key=self.dqdir, + startprios=state, + ) if q: - logger.info("Resuming crawl (%(queuesize)d requests scheduled)", - {'queuesize': len(q)}, extra={'spider': self.spider}) + logger.info( + "Resuming crawl (%(queuesize)d requests scheduled)", + {"queuesize": len(q)}, + extra={"spider": self.spider}, + ) return q def _dqdir(self, jobdir: Optional[str]) -> Optional[str]: - """ Return a folder name to keep disk queue state at """ + """Return a folder name to keep disk queue state at""" if jobdir is not None: - dqdir = Path(jobdir, 'requests.queue') + dqdir = Path(jobdir, "requests.queue") if not dqdir.exists(): dqdir.mkdir(parents=True) return str(dqdir) return None def _read_dqs_state(self, dqdir: str) -> list: - path = Path(dqdir, 'active.json') + path = Path(dqdir, "active.json") if not path.exists(): return [] with path.open(encoding="utf-8") as f: return json.load(f) def _write_dqs_state(self, dqdir: str, state: list) -> None: - with Path(dqdir, 'active.json').open('w', encoding="utf-8") as f: + with Path(dqdir, "active.json").open("w", encoding="utf-8") as f: json.dump(state, f) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 69ac1cdaf..7c2eefbe6 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -63,7 +63,9 @@ class Slot: self.itemproc_size: int = 0 self.closing: Optional[Deferred] = None - def add_response_request(self, result: Union[Response, Failure], request: Request) -> Deferred: + def add_response_request( + self, result: Union[Response, Failure], request: Request + ) -> Deferred: deferred = Deferred() self.queue.append((result, request, deferred)) if isinstance(result, Response): @@ -77,7 +79,9 @@ class Slot: self.active.add(request) return response, request, deferred - def finish_response(self, result: Union[Response, Failure], request: Request) -> None: + def finish_response( + self, result: Union[Response, Failure], request: Request + ) -> None: self.active.remove(request) if isinstance(result, Response): self.active_size -= max(len(result.body), self.MIN_RESPONSE_SIZE) @@ -92,13 +96,12 @@ class Slot: class Scraper: - def __init__(self, crawler: Crawler) -> None: self.slot: Optional[Slot] = None self.spidermw = SpiderMiddlewareManager.from_crawler(crawler) - itemproc_cls = load_object(crawler.settings['ITEM_PROCESSOR']) + itemproc_cls = load_object(crawler.settings["ITEM_PROCESSOR"]) self.itemproc = itemproc_cls.from_crawler(crawler) - self.concurrent_items = crawler.settings.getint('CONCURRENT_ITEMS') + self.concurrent_items = crawler.settings.getint("CONCURRENT_ITEMS") self.crawler = crawler self.signals = crawler.signals self.logformatter = crawler.logformatter @@ -106,7 +109,7 @@ class Scraper: @inlineCallbacks def open_spider(self, spider: Spider): """Open the given spider for scraping and allocate resources for it""" - self.slot = Slot(self.crawler.settings.getint('SCRAPER_SLOT_MAX_ACTIVE_SIZE')) + self.slot = Slot(self.crawler.settings.getint("SCRAPER_SLOT_MAX_ACTIVE_SIZE")) yield self.itemproc.open_spider(spider) def close_spider(self, spider: Spider) -> Deferred: @@ -127,7 +130,9 @@ class Scraper: if self.slot.closing and self.slot.is_idle(): self.slot.closing.callback(spider) - def enqueue_scrape(self, result: Union[Response, Failure], request: Request, spider: Spider) -> Deferred: + def enqueue_scrape( + self, result: Union[Response, Failure], request: Request, spider: Spider + ) -> Deferred: if self.slot is None: raise RuntimeError("Scraper slot not assigned") dfd = self.slot.add_response_request(result, request) @@ -140,10 +145,13 @@ class Scraper: dfd.addBoth(finish_scraping) dfd.addErrback( - lambda f: logger.error('Scraper bug processing %(request)s', - {'request': request}, - exc_info=failure_to_exc_info(f), - extra={'spider': spider})) + lambda f: logger.error( + "Scraper bug processing %(request)s", + {"request": request}, + exc_info=failure_to_exc_info(f), + extra={"spider": spider}, + ) + ) self._scrape_next(spider) return dfd @@ -153,35 +161,49 @@ class Scraper: response, request, deferred = self.slot.next_response_request_deferred() self._scrape(response, request, spider).chainDeferred(deferred) - def _scrape(self, result: Union[Response, Failure], request: Request, spider: Spider) -> Deferred: + def _scrape( + self, result: Union[Response, Failure], request: Request, spider: Spider + ) -> Deferred: """ Handle the downloaded response or failure through the spider callback/errback """ if not isinstance(result, (Response, Failure)): - raise TypeError(f"Incorrect type: expected Response or Failure, got {type(result)}: {result!r}") - dfd = self._scrape2(result, request, spider) # returns spider's processed output + raise TypeError( + f"Incorrect type: expected Response or Failure, got {type(result)}: {result!r}" + ) + dfd = self._scrape2( + result, request, spider + ) # returns spider's processed output dfd.addErrback(self.handle_spider_error, request, result, spider) dfd.addCallback(self.handle_spider_output, request, result, spider) return dfd - def _scrape2(self, result: Union[Response, Failure], request: Request, spider: Spider) -> Deferred: + def _scrape2( + self, result: Union[Response, Failure], request: Request, spider: Spider + ) -> Deferred: """ Handle the different cases of request's result been a Response or a Failure """ if isinstance(result, Response): - return self.spidermw.scrape_response(self.call_spider, result, request, spider) + return self.spidermw.scrape_response( + self.call_spider, result, request, spider + ) # else result is a Failure dfd = self.call_spider(result, request, spider) return dfd.addErrback(self._log_download_errors, result, request, spider) - def call_spider(self, result: Union[Response, Failure], request: Request, spider: Spider) -> Deferred: + def call_spider( + self, result: Union[Response, Failure], request: Request, spider: Spider + ) -> Deferred: if isinstance(result, Response): if getattr(result, "request", None) is None: result.request = request callback = result.request.callback or spider._parse warn_on_generator_with_return_value(spider, callback) dfd = defer_succeed(result) - dfd.addCallbacks(callback=callback, callbackKeywords=result.request.cb_kwargs) + dfd.addCallbacks( + callback=callback, callbackKeywords=result.request.cb_kwargs + ) else: # result is a Failure result.request = request warn_on_generator_with_return_value(spider, request.errback) @@ -189,45 +211,69 @@ class Scraper: dfd.addErrback(request.errback) return dfd.addCallback(iterate_spider_output) - def handle_spider_error(self, _failure: Failure, request: Request, response: Response, spider: Spider) -> None: + def handle_spider_error( + self, _failure: Failure, request: Request, response: Response, spider: Spider + ) -> None: exc = _failure.value if isinstance(exc, CloseSpider): assert self.crawler.engine is not None # typing - self.crawler.engine.close_spider(spider, exc.reason or 'cancelled') + self.crawler.engine.close_spider(spider, exc.reason or "cancelled") return logkws = self.logformatter.spider_error(_failure, request, response, spider) logger.log( *logformatter_adapter(logkws), exc_info=failure_to_exc_info(_failure), - extra={'spider': spider} + extra={"spider": spider}, ) self.signals.send_catch_log( signal=signals.spider_error, - failure=_failure, response=response, - spider=spider + failure=_failure, + response=response, + spider=spider, ) self.crawler.stats.inc_value( - f"spider_exceptions/{_failure.value.__class__.__name__}", - spider=spider + f"spider_exceptions/{_failure.value.__class__.__name__}", spider=spider ) - def handle_spider_output(self, result: Union[Iterable, AsyncIterable], request: Request, - response: Response, spider: Spider) -> Deferred: + def handle_spider_output( + self, + result: Union[Iterable, AsyncIterable], + request: Request, + response: Response, + spider: Spider, + ) -> Deferred: if not result: return defer_succeed(None) it: Union[Generator, AsyncGenerator] if isinstance(result, AsyncIterable): - it = aiter_errback(result, self.handle_spider_error, request, response, spider) - dfd = parallel_async(it, self.concurrent_items, self._process_spidermw_output, - request, response, spider) + it = aiter_errback( + result, self.handle_spider_error, request, response, spider + ) + dfd = parallel_async( + it, + self.concurrent_items, + self._process_spidermw_output, + request, + response, + spider, + ) else: - it = iter_errback(result, self.handle_spider_error, request, response, spider) - dfd = parallel(it, self.concurrent_items, self._process_spidermw_output, - request, response, spider) + it = iter_errback( + result, self.handle_spider_error, request, response, spider + ) + dfd = parallel( + it, + self.concurrent_items, + self._process_spidermw_output, + request, + response, + spider, + ) return dfd - def _process_spidermw_output(self, output: Any, request: Request, response: Response, - spider: Spider) -> Optional[Deferred]: + def _process_spidermw_output( + self, output: Any, request: Request, response: Response, spider: Spider + ) -> Optional[Deferred]: """Process each Request/Item (given in the output parameter) returned from the given spider """ @@ -245,14 +291,19 @@ class Scraper: else: typename = type(output).__name__ logger.error( - 'Spider must return request, item, or None, got %(typename)r in %(request)s', - {'request': request, 'typename': typename}, - extra={'spider': spider}, + "Spider must return request, item, or None, got %(typename)r in %(request)s", + {"request": request, "typename": typename}, + extra={"spider": spider}, ) return None - def _log_download_errors(self, spider_failure: Failure, download_failure: Failure, request: Request, - spider: Spider) -> Union[Failure, None]: + def _log_download_errors( + self, + spider_failure: Failure, + download_failure: Failure, + request: Request, + spider: Spider, + ) -> Union[Failure, None]: """Log and silence errors that come from the engine (typically download errors that got propagated thru here). @@ -262,29 +313,33 @@ class Scraper: """ if not download_failure.check(IgnoreRequest): if download_failure.frames: - logkws = self.logformatter.download_error(download_failure, request, spider) + logkws = self.logformatter.download_error( + download_failure, request, spider + ) logger.log( *logformatter_adapter(logkws), - extra={'spider': spider}, + extra={"spider": spider}, exc_info=failure_to_exc_info(download_failure), ) else: errmsg = download_failure.getErrorMessage() if errmsg: logkws = self.logformatter.download_error( - download_failure, request, spider, errmsg) + download_failure, request, spider, errmsg + ) logger.log( *logformatter_adapter(logkws), - extra={'spider': spider}, + extra={"spider": spider}, ) if spider_failure is not download_failure: return spider_failure return None - def _itemproc_finished(self, output: Any, item: Any, response: Response, spider: Spider) -> None: - """ItemProcessor finished for the given ``item`` and returned ``output`` - """ + def _itemproc_finished( + self, output: Any, item: Any, response: Response, spider: Spider + ) -> None: + """ItemProcessor finished for the given ``item`` and returned ``output``""" assert self.slot is not None # typing self.slot.itemproc_size -= 1 if isinstance(output, Failure): @@ -292,19 +347,30 @@ class Scraper: if isinstance(ex, DropItem): logkws = self.logformatter.dropped(item, ex, response, spider) if logkws is not None: - logger.log(*logformatter_adapter(logkws), extra={'spider': spider}) + logger.log(*logformatter_adapter(logkws), extra={"spider": spider}) return self.signals.send_catch_log_deferred( - signal=signals.item_dropped, item=item, response=response, - spider=spider, exception=output.value) + signal=signals.item_dropped, + item=item, + response=response, + spider=spider, + exception=output.value, + ) logkws = self.logformatter.item_error(item, ex, response, spider) - logger.log(*logformatter_adapter(logkws), extra={'spider': spider}, - exc_info=failure_to_exc_info(output)) + logger.log( + *logformatter_adapter(logkws), + extra={"spider": spider}, + exc_info=failure_to_exc_info(output), + ) return self.signals.send_catch_log_deferred( - signal=signals.item_error, item=item, response=response, - spider=spider, failure=output) + signal=signals.item_error, + item=item, + response=response, + spider=spider, + failure=output, + ) logkws = self.logformatter.scraped(output, response, spider) if logkws is not None: - logger.log(*logformatter_adapter(logkws), extra={'spider': spider}) + logger.log(*logformatter_adapter(logkws), extra={"spider": spider}) return self.signals.send_catch_log_deferred( - signal=signals.item_scraped, item=output, response=response, - spider=spider) + signal=signals.item_scraped, item=output, response=response, spider=spider + ) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 91e4b9cb4..1aaed5865 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -6,7 +6,17 @@ See documentation in docs/topics/spider-middleware.rst import logging from inspect import isasyncgenfunction, iscoroutine from itertools import islice -from typing import Any, AsyncGenerator, AsyncIterable, Callable, Generator, Iterable, Tuple, Union, cast +from typing import ( + Any, + AsyncGenerator, + AsyncIterable, + Callable, + Generator, + Iterable, + Tuple, + Union, + cast, +) from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure @@ -17,7 +27,12 @@ from scrapy.http import Response from scrapy.middleware import MiddlewareManager from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.conf import build_component_list -from scrapy.utils.defer import mustbe_deferred, deferred_from_coro, deferred_f_from_coro_f, maybe_deferred_to_future +from scrapy.utils.defer import ( + mustbe_deferred, + deferred_from_coro, + deferred_f_from_coro_f, + maybe_deferred_to_future, +) from scrapy.utils.python import MutableAsyncChain, MutableChain @@ -33,7 +48,7 @@ def _isiterable(o) -> bool: class SpiderMiddlewareManager(MiddlewareManager): - component_name = 'spider middleware' + component_name = "spider middleware" def __init__(self, *middlewares): super().__init__(*middlewares) @@ -41,28 +56,35 @@ class SpiderMiddlewareManager(MiddlewareManager): @classmethod def _get_mwlist_from_settings(cls, settings): - return build_component_list(settings.getwithbase('SPIDER_MIDDLEWARES')) + return build_component_list(settings.getwithbase("SPIDER_MIDDLEWARES")) def _add_middleware(self, mw): super()._add_middleware(mw) - if hasattr(mw, 'process_spider_input'): - self.methods['process_spider_input'].append(mw.process_spider_input) - if hasattr(mw, 'process_start_requests'): - self.methods['process_start_requests'].appendleft(mw.process_start_requests) - process_spider_output = self._get_async_method_pair(mw, 'process_spider_output') - self.methods['process_spider_output'].appendleft(process_spider_output) - process_spider_exception = getattr(mw, 'process_spider_exception', None) - self.methods['process_spider_exception'].appendleft(process_spider_exception) + if hasattr(mw, "process_spider_input"): + self.methods["process_spider_input"].append(mw.process_spider_input) + if hasattr(mw, "process_start_requests"): + self.methods["process_start_requests"].appendleft(mw.process_start_requests) + process_spider_output = self._get_async_method_pair(mw, "process_spider_output") + self.methods["process_spider_output"].appendleft(process_spider_output) + process_spider_exception = getattr(mw, "process_spider_exception", None) + self.methods["process_spider_exception"].appendleft(process_spider_exception) - def _process_spider_input(self, scrape_func: ScrapeFunc, response: Response, request: Request, - spider: Spider) -> Any: - for method in self.methods['process_spider_input']: + def _process_spider_input( + self, + scrape_func: ScrapeFunc, + response: Response, + request: Request, + spider: Spider, + ) -> Any: + for method in self.methods["process_spider_input"]: method = cast(Callable, method) try: result = method(response=response, spider=spider) if result is not None: - msg = (f"{method.__qualname__} must return None " - f"or raise an exception, got {type(result)}") + msg = ( + f"{method.__qualname__} must return None " + f"or raise an exception, got {type(result)}" + ) raise _InvalidOutput(msg) except _InvalidOutput: raise @@ -70,17 +92,22 @@ class SpiderMiddlewareManager(MiddlewareManager): return scrape_func(Failure(), request, spider) return scrape_func(response, request, spider) - def _evaluate_iterable(self, response: Response, spider: Spider, iterable: Union[Iterable, AsyncIterable], - exception_processor_index: int, recover_to: Union[MutableChain, MutableAsyncChain] - ) -> Union[Generator, AsyncGenerator]: - + def _evaluate_iterable( + self, + response: Response, + spider: Spider, + iterable: Union[Iterable, AsyncIterable], + exception_processor_index: int, + recover_to: Union[MutableChain, MutableAsyncChain], + ) -> Union[Generator, AsyncGenerator]: def process_sync(iterable: Iterable): try: for r in iterable: yield r except Exception as ex: - exception_result = self._process_spider_exception(response, spider, Failure(ex), - exception_processor_index) + exception_result = self._process_spider_exception( + response, spider, Failure(ex), exception_processor_index + ) if isinstance(exception_result, Failure): raise recover_to.extend(exception_result) @@ -90,8 +117,9 @@ class SpiderMiddlewareManager(MiddlewareManager): async for r in iterable: yield r except Exception as ex: - exception_result = self._process_spider_exception(response, spider, Failure(ex), - exception_processor_index) + exception_result = self._process_spider_exception( + response, spider, Failure(ex), exception_processor_index + ) if isinstance(exception_result, Failure): raise recover_to.extend(exception_result) @@ -100,13 +128,20 @@ class SpiderMiddlewareManager(MiddlewareManager): return process_async(iterable) return process_sync(iterable) - def _process_spider_exception(self, response: Response, spider: Spider, _failure: Failure, - start_index: int = 0) -> Union[Failure, MutableChain]: + def _process_spider_exception( + self, + response: Response, + spider: Spider, + _failure: Failure, + start_index: int = 0, + ) -> Union[Failure, MutableChain]: exception = _failure.value # don't handle _InvalidOutput exception if isinstance(exception, _InvalidOutput): return _failure - method_list = islice(self.methods['process_spider_exception'], start_index, None) + method_list = islice( + self.methods["process_spider_exception"], start_index, None + ) for method_index, method in enumerate(method_list, start=start_index): if method is None: continue @@ -115,7 +150,9 @@ class SpiderMiddlewareManager(MiddlewareManager): if _isiterable(result): # stop exception handling by handing control over to the # process_spider_output chain if an iterable has been returned - dfd: Deferred = self._process_spider_output(response, spider, result, method_index + 1) + dfd: Deferred = self._process_spider_output( + response, spider, result, method_index + 1 + ) # _process_spider_output() returns a Deferred only because of downgrading so this can be # simplified when downgrading is removed. if dfd.called: @@ -128,8 +165,10 @@ class SpiderMiddlewareManager(MiddlewareManager): elif result is None: continue else: - msg = (f"{method.__qualname__} must return None " - f"or an iterable, got {type(result)}") + msg = ( + f"{method.__qualname__} must return None " + f"or an iterable, got {type(result)}" + ) raise _InvalidOutput(msg) return _failure @@ -137,9 +176,13 @@ class SpiderMiddlewareManager(MiddlewareManager): # being available immediately which doesn't work when it's a wrapped coroutine. # It also needs @inlineCallbacks only because of downgrading so it can be removed when downgrading is removed. @inlineCallbacks - def _process_spider_output(self, response: Response, spider: Spider, - result: Union[Iterable, AsyncIterable], start_index: int = 0 - ) -> Deferred: + def _process_spider_output( + self, + response: Response, + spider: Spider, + result: Union[Iterable, AsyncIterable], + start_index: int = 0, + ) -> Deferred: # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method recovered: Union[MutableChain, MutableAsyncChain] @@ -156,7 +199,7 @@ class SpiderMiddlewareManager(MiddlewareManager): # Storing methods and method tuples in the same list is weird but we should be able to roll this back # when we drop this compatibility feature. - method_list = islice(self.methods['process_spider_output'], start_index, None) + method_list = islice(self.methods["process_spider_output"], start_index, None) for method_index, method_pair in enumerate(method_list, start=start_index): if method_pair is None: continue @@ -177,24 +220,32 @@ class SpiderMiddlewareManager(MiddlewareManager): result = as_async_generator(result) elif need_downgrade: if not self.downgrade_warning_done: - logger.warning(f"Async iterable passed to {method.__qualname__} " - f"was downgraded to a non-async one") + logger.warning( + f"Async iterable passed to {method.__qualname__} " + f"was downgraded to a non-async one" + ) self.downgrade_warning_done = True assert isinstance(result, AsyncIterable) # AsyncIterable -> Iterable result = yield deferred_from_coro(collect_asyncgen(result)) if isinstance(recovered, AsyncIterable): - recovered_collected = yield deferred_from_coro(collect_asyncgen(recovered)) + recovered_collected = yield deferred_from_coro( + collect_asyncgen(recovered) + ) recovered = MutableChain(recovered_collected) # might fail directly if the output value is not a generator result = method(response=response, result=result, spider=spider) except Exception as ex: - exception_result = self._process_spider_exception(response, spider, Failure(ex), method_index + 1) + exception_result = self._process_spider_exception( + response, spider, Failure(ex), method_index + 1 + ) if isinstance(exception_result, Failure): raise return exception_result if _isiterable(result): - result = self._evaluate_iterable(response, spider, result, method_index + 1, recovered) + result = self._evaluate_iterable( + response, spider, result, method_index + 1, recovered + ) else: if iscoroutine(result): result.close() # Silence warning about not awaiting @@ -214,15 +265,18 @@ class SpiderMiddlewareManager(MiddlewareManager): return MutableAsyncChain(result, recovered) return MutableChain(result, recovered) # type: ignore[arg-type] - async def _process_callback_output(self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] - ) -> Union[MutableChain, MutableAsyncChain]: + async def _process_callback_output( + self, response: Response, spider: Spider, result: Union[Iterable, AsyncIterable] + ) -> Union[MutableChain, MutableAsyncChain]: recovered: Union[MutableChain, MutableAsyncChain] if isinstance(result, AsyncIterable): recovered = MutableAsyncChain() else: recovered = MutableChain() result = self._evaluate_iterable(response, spider, result, 0, recovered) - result = await maybe_deferred_to_future(self._process_spider_output(response, spider, result)) + result = await maybe_deferred_to_future( + self._process_spider_output(response, spider, result) + ) if isinstance(result, AsyncIterable): return MutableAsyncChain(result, recovered) if isinstance(recovered, AsyncIterable): @@ -230,41 +284,60 @@ class SpiderMiddlewareManager(MiddlewareManager): recovered = MutableChain(recovered_collected) return MutableChain(result, recovered) # type: ignore[arg-type] - def scrape_response(self, scrape_func: ScrapeFunc, response: Response, request: Request, - spider: Spider) -> Deferred: - async def process_callback_output(result: Union[Iterable, AsyncIterable] - ) -> Union[MutableChain, MutableAsyncChain]: + def scrape_response( + self, + scrape_func: ScrapeFunc, + response: Response, + request: Request, + spider: Spider, + ) -> Deferred: + async def process_callback_output( + result: Union[Iterable, AsyncIterable] + ) -> Union[MutableChain, MutableAsyncChain]: return await self._process_callback_output(response, spider, result) def process_spider_exception(_failure: Failure) -> Union[Failure, MutableChain]: return self._process_spider_exception(response, spider, _failure) - dfd = mustbe_deferred(self._process_spider_input, scrape_func, response, request, spider) - dfd.addCallbacks(callback=deferred_f_from_coro_f(process_callback_output), errback=process_spider_exception) + dfd = mustbe_deferred( + self._process_spider_input, scrape_func, response, request, spider + ) + dfd.addCallbacks( + callback=deferred_f_from_coro_f(process_callback_output), + errback=process_spider_exception, + ) return dfd def process_start_requests(self, start_requests, spider: Spider) -> Deferred: - return self._process_chain('process_start_requests', start_requests, spider) + return self._process_chain("process_start_requests", start_requests, spider) # This method is only needed until _async compatibility methods are removed. @staticmethod - def _get_async_method_pair(mw: Any, methodname: str) -> Union[None, Callable, Tuple[Callable, Callable]]: + def _get_async_method_pair( + mw: Any, methodname: str + ) -> Union[None, Callable, Tuple[Callable, Callable]]: normal_method = getattr(mw, methodname, None) methodname_async = methodname + "_async" async_method = getattr(mw, methodname_async, None) if not async_method: return normal_method if not normal_method: - logger.error(f"Middleware {mw.__qualname__} has {methodname_async} " - f"without {methodname}, skipping this method.") + logger.error( + f"Middleware {mw.__qualname__} has {methodname_async} " + f"without {methodname}, skipping this method." + ) return None if not isasyncgenfunction(async_method): - logger.error(f"{async_method.__qualname__} is not " - f"an async generator function, skipping this method.") + logger.error( + f"{async_method.__qualname__} is not " + f"an async generator function, skipping this method." + ) return normal_method if isasyncgenfunction(normal_method): - logger.error(f"{normal_method.__qualname__} is an async " - f"generator function while {methodname_async} exists, " - f"skipping both methods.") + logger.error( + f"{normal_method.__qualname__} is an async " + f"generator function while {methodname_async} exists, " + f"skipping both methods." + ) return None return normal_method, async_method diff --git a/scrapy/crawler.py b/scrapy/crawler.py index 4700a30ab..f58cd73d3 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -49,10 +49,9 @@ logger = logging.getLogger(__name__) class Crawler: - def __init__(self, spidercls, settings=None, init_reactor: bool = False): if isinstance(spidercls, Spider): - raise ValueError('The spidercls argument must be a class, not an object') + raise ValueError("The spidercls argument must be a class, not an object") if isinstance(settings, dict) or settings is None: settings = Settings(settings) @@ -63,14 +62,15 @@ class Crawler: self.signals = SignalManager(self) - self.stats = load_object(self.settings['STATS_CLASS'])(self) + self.stats = load_object(self.settings["STATS_CLASS"])(self) - handler = LogCounterHandler(self, level=self.settings.get('LOG_LEVEL')) + handler = LogCounterHandler(self, level=self.settings.get("LOG_LEVEL")) logging.root.addHandler(handler) d = dict(overridden_settings(self.settings)) - logger.info("Overridden settings:\n%(settings)s", - {'settings': pprint.pformat(d)}) + logger.info( + "Overridden settings:\n%(settings)s", {"settings": pprint.pformat(d)} + ) if get_scrapy_root_handler() is not None: # scrapy root handler already installed: update it with new settings @@ -80,11 +80,11 @@ class Crawler: self.__remove_handler = lambda: logging.root.removeHandler(handler) self.signals.connect(self.__remove_handler, signals.engine_stopped) - lf_cls = load_object(self.settings['LOG_FORMATTER']) + lf_cls = load_object(self.settings["LOG_FORMATTER"]) self.logformatter = lf_cls.from_crawler(self) self.request_fingerprinter: RequestFingerprinter = create_instance( - load_object(self.settings['REQUEST_FINGERPRINTER_CLASS']), + load_object(self.settings["REQUEST_FINGERPRINTER_CLASS"]), settings=self.settings, crawler=self, ) @@ -160,23 +160,26 @@ class CrawlerRunner: crawlers = property( lambda self: self._crawlers, doc="Set of :class:`crawlers ` started by " - ":meth:`crawl` and managed by this class." + ":meth:`crawl` and managed by this class.", ) @staticmethod def _get_spider_loader(settings): - """ Get SpiderLoader instance from settings """ - cls_path = settings.get('SPIDER_LOADER_CLASS') + """Get SpiderLoader instance from settings""" + cls_path = settings.get("SPIDER_LOADER_CLASS") loader_cls = load_object(cls_path) - excs = (DoesNotImplement, MultipleInvalid) if MultipleInvalid else DoesNotImplement + excs = ( + (DoesNotImplement, MultipleInvalid) if MultipleInvalid else DoesNotImplement + ) try: verifyClass(ISpiderLoader, loader_cls) except excs: warnings.warn( - 'SPIDER_LOADER_CLASS (previously named SPIDER_MANAGER_CLASS) does ' - 'not fully implement scrapy.interfaces.ISpiderLoader interface. ' - 'Please add all missing methods to avoid unexpected runtime errors.', - category=ScrapyDeprecationWarning, stacklevel=2 + "SPIDER_LOADER_CLASS (previously named SPIDER_MANAGER_CLASS) does " + "not fully implement scrapy.interfaces.ISpiderLoader interface. " + "Please add all missing methods to avoid unexpected runtime errors.", + category=ScrapyDeprecationWarning, + stacklevel=2, ) return loader_cls.from_settings(settings.frozencopy()) @@ -191,9 +194,12 @@ class CrawlerRunner: @property def spiders(self): - warnings.warn("CrawlerRunner.spiders attribute is renamed to " - "CrawlerRunner.spider_loader.", - category=ScrapyDeprecationWarning, stacklevel=2) + warnings.warn( + "CrawlerRunner.spiders attribute is renamed to " + "CrawlerRunner.spider_loader.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) return self.spider_loader def crawl(self, crawler_or_spidercls, *args, **kwargs): @@ -220,8 +226,9 @@ class CrawlerRunner: """ if isinstance(crawler_or_spidercls, Spider): raise ValueError( - 'The crawler_or_spidercls argument cannot be a spider object, ' - 'it must be a spider class (or a Crawler object)') + "The crawler_or_spidercls argument cannot be a spider object, " + "it must be a spider class (or a Crawler object)" + ) crawler = self.create_crawler(crawler_or_spidercls) return self._crawl(crawler, *args, **kwargs) @@ -233,7 +240,7 @@ class CrawlerRunner: def _done(result): self.crawlers.discard(crawler) self._active.discard(d) - self.bootstrap_failed |= not getattr(crawler, 'spider', None) + self.bootstrap_failed |= not getattr(crawler, "spider", None) return result return d.addBoth(_done) @@ -251,8 +258,9 @@ class CrawlerRunner: """ if isinstance(crawler_or_spidercls, Spider): raise ValueError( - 'The crawler_or_spidercls argument cannot be a spider object, ' - 'it must be a spider class (or a Crawler object)') + "The crawler_or_spidercls argument cannot be a spider object, " + "it must be a spider class (or a Crawler object)" + ) if isinstance(crawler_or_spidercls, Crawler): return crawler_or_spidercls return self._create_crawler(crawler_or_spidercls) @@ -314,18 +322,23 @@ class CrawlerProcess(CrawlerRunner): def _signal_shutdown(self, signum, _): from twisted.internet import reactor + install_shutdown_handlers(self._signal_kill) signame = signal_names[signum] - logger.info("Received %(signame)s, shutting down gracefully. Send again to force ", - {'signame': signame}) + logger.info( + "Received %(signame)s, shutting down gracefully. Send again to force ", + {"signame": signame}, + ) reactor.callFromThread(self._graceful_stop_reactor) def _signal_kill(self, signum, _): from twisted.internet import reactor + install_shutdown_handlers(signal.SIG_IGN) signame = signal_names[signum] - logger.info('Received %(signame)s twice, forcing unclean shutdown', - {'signame': signame}) + logger.info( + "Received %(signame)s twice, forcing unclean shutdown", {"signame": signame} + ) reactor.callFromThread(self._stop_reactor) def _create_crawler(self, spidercls): @@ -351,6 +364,7 @@ class CrawlerProcess(CrawlerRunner): handlers (default: True) """ from twisted.internet import reactor + if stop_after_crawl: d = self.join() # Don't start the reactor if the deferreds are already fired @@ -364,8 +378,8 @@ class CrawlerProcess(CrawlerRunner): resolver = create_instance(resolver_class, self.settings, self, reactor=reactor) resolver.install_on_reactor() tp = reactor.getThreadPool() - tp.adjustPoolsize(maxthreads=self.settings.getint('REACTOR_THREADPOOL_MAXSIZE')) - reactor.addSystemEventTrigger('before', 'shutdown', self.stop) + tp.adjustPoolsize(maxthreads=self.settings.getint("REACTOR_THREADPOOL_MAXSIZE")) + reactor.addSystemEventTrigger("before", "shutdown", self.stop) reactor.run(installSignalHandlers=False) # blocking call def _graceful_stop_reactor(self): @@ -375,6 +389,7 @@ class CrawlerProcess(CrawlerRunner): def _stop_reactor(self, _=None): from twisted.internet import reactor + try: reactor.stop() except RuntimeError: # raised if already stopped or in shutdown stage diff --git a/scrapy/downloadermiddlewares/ajaxcrawl.py b/scrapy/downloadermiddlewares/ajaxcrawl.py index 4e12a5044..86ff7b9fe 100644 --- a/scrapy/downloadermiddlewares/ajaxcrawl.py +++ b/scrapy/downloadermiddlewares/ajaxcrawl.py @@ -17,14 +17,14 @@ class AjaxCrawlMiddleware: """ def __init__(self, settings): - if not settings.getbool('AJAXCRAWL_ENABLED'): + if not settings.getbool("AJAXCRAWL_ENABLED"): raise NotConfigured # XXX: Google parses at least first 100k bytes; scrapy's redirect # middleware parses first 4k. 4k turns out to be insufficient # for this middleware, and parsing 100k could be slow. # We use something in between (32K) by default. - self.lookup_bytes = settings.getint('AJAXCRAWL_MAXSIZE', 32768) + self.lookup_bytes = settings.getint("AJAXCRAWL_MAXSIZE", 32768) @classmethod def from_crawler(cls, crawler): @@ -35,23 +35,25 @@ class AjaxCrawlMiddleware: if not isinstance(response, HtmlResponse) or response.status != 200: return response - if request.method != 'GET': + if request.method != "GET": # other HTTP methods are either not safe or don't have a body return response - if 'ajax_crawlable' in request.meta: # prevent loops + if "ajax_crawlable" in request.meta: # prevent loops return response if not self._has_ajax_crawlable_variant(response): return response # scrapy already handles #! links properly - ajax_crawl_request = request.replace(url=request.url + '#!') - logger.debug("Downloading AJAX crawlable %(ajax_crawl_request)s instead of %(request)s", - {'ajax_crawl_request': ajax_crawl_request, 'request': request}, - extra={'spider': spider}) + ajax_crawl_request = request.replace(url=request.url + "#!") + logger.debug( + "Downloading AJAX crawlable %(ajax_crawl_request)s instead of %(request)s", + {"ajax_crawl_request": ajax_crawl_request, "request": request}, + extra={"spider": spider}, + ) - ajax_crawl_request.meta['ajax_crawlable'] = True + ajax_crawl_request.meta["ajax_crawlable"] = True return ajax_crawl_request def _has_ajax_crawlable_variant(self, response): @@ -59,12 +61,14 @@ class AjaxCrawlMiddleware: Return True if a page without hash fragment could be "AJAX crawlable" according to https://developers.google.com/webmasters/ajax-crawling/docs/getting-started. """ - body = response.text[:self.lookup_bytes] + body = response.text[: self.lookup_bytes] return _has_ajaxcrawlable_meta(body) # XXX: move it to w3lib? -_ajax_crawlable_re = re.compile(r'') +_ajax_crawlable_re = re.compile( + r'' +) def _has_ajaxcrawlable_meta(text): @@ -82,12 +86,12 @@ def _has_ajaxcrawlable_meta(text): # Stripping scripts and comments is slow (about 20x slower than # just checking if a string is in text); this is a quick fail-fast # path that should work for most pages. - if 'fragment' not in text: + if "fragment" not in text: return False - if 'content' not in text: + if "content" not in text: return False - text = html.remove_tags_with_content(text, ('script', 'noscript')) + text = html.remove_tags_with_content(text, ("script", "noscript")) text = html.replace_entities(text) text = html.remove_comments(text) return _ajax_crawlable_re.search(text) is not None diff --git a/scrapy/downloadermiddlewares/cookies.py b/scrapy/downloadermiddlewares/cookies.py index 3cba269f1..6495157d7 100644 --- a/scrapy/downloadermiddlewares/cookies.py +++ b/scrapy/downloadermiddlewares/cookies.py @@ -29,14 +29,14 @@ class CookiesMiddleware: @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('COOKIES_ENABLED'): + if not crawler.settings.getbool("COOKIES_ENABLED"): raise NotConfigured - return cls(crawler.settings.getbool('COOKIES_DEBUG')) + return cls(crawler.settings.getbool("COOKIES_DEBUG")) def _process_cookies(self, cookies, *, jar, request): for cookie in cookies: cookie_domain = cookie.domain - if cookie_domain.startswith('.'): + if cookie_domain.startswith("."): cookie_domain = cookie_domain[1:] request_domain = urlparse_cached(request).hostname.lower() @@ -49,7 +49,7 @@ class CookiesMiddleware: jar.set_cookie_if_ok(cookie, request) def process_request(self, request, spider): - if request.meta.get('dont_merge_cookies', False): + if request.meta.get("dont_merge_cookies", False): return cookiejarkey = request.meta.get("cookiejar") @@ -58,12 +58,12 @@ class CookiesMiddleware: self._process_cookies(cookies, jar=jar, request=request) # set Cookie header - request.headers.pop('Cookie', None) + request.headers.pop("Cookie", None) jar.add_cookie_header(request) self._debug_cookie(request, spider) def process_response(self, request, response, spider): - if request.meta.get('dont_merge_cookies', False): + if request.meta.get("dont_merge_cookies", False): return response # extract cookies from Set-Cookie and drop invalid/expired cookies @@ -78,21 +78,25 @@ class CookiesMiddleware: def _debug_cookie(self, request, spider): if self.debug: - cl = [to_unicode(c, errors='replace') - for c in request.headers.getlist('Cookie')] + cl = [ + to_unicode(c, errors="replace") + for c in request.headers.getlist("Cookie") + ] if cl: cookies = "\n".join(f"Cookie: {c}\n" for c in cl) msg = f"Sending cookies to: {request}\n{cookies}" - logger.debug(msg, extra={'spider': spider}) + logger.debug(msg, extra={"spider": spider}) def _debug_set_cookie(self, response, spider): if self.debug: - cl = [to_unicode(c, errors='replace') - for c in response.headers.getlist('Set-Cookie')] + cl = [ + to_unicode(c, errors="replace") + for c in response.headers.getlist("Set-Cookie") + ] if cl: cookies = "\n".join(f"Set-Cookie: {c}\n" for c in cl) msg = f"Received cookies from: {response}\n{cookies}" - logger.debug(msg, extra={'spider': spider}) + logger.debug(msg, extra={"spider": spider}) def _format_cookie(self, cookie, request): """ @@ -113,8 +117,11 @@ class CookiesMiddleware: try: decoded[key] = cookie[key].decode("utf8") except UnicodeDecodeError: - logger.warning("Non UTF-8 encoded cookie found in request %s: %s", - request, cookie) + logger.warning( + "Non UTF-8 encoded cookie found in request %s: %s", + request, + cookie, + ) decoded[key] = cookie[key].decode("latin1", errors="replace") cookie_str = f"{decoded.pop('name')}={decoded.pop('value')}" diff --git a/scrapy/downloadermiddlewares/decompression.py b/scrapy/downloadermiddlewares/decompression.py index e01e9cc76..410015281 100644 --- a/scrapy/downloadermiddlewares/decompression.py +++ b/scrapy/downloadermiddlewares/decompression.py @@ -16,7 +16,7 @@ from scrapy.responsetypes import responsetypes warn( - 'scrapy.downloadermiddlewares.decompression is deprecated', + "scrapy.downloadermiddlewares.decompression is deprecated", ScrapyDeprecationWarning, stacklevel=2, ) @@ -26,15 +26,15 @@ logger = logging.getLogger(__name__) class DecompressionMiddleware: - """ This middleware tries to recognise and extract the possibly compressed - responses that may arrive. """ + """This middleware tries to recognise and extract the possibly compressed + responses that may arrive.""" def __init__(self): self._formats = { - 'tar': self._is_tar, - 'zip': self._is_zip, - 'gz': self._is_gzip, - 'bz2': self._is_bzip2 + "tar": self._is_tar, + "zip": self._is_zip, + "gz": self._is_gzip, + "bz2": self._is_bzip2, } def _is_tar(self, response): @@ -86,7 +86,10 @@ class DecompressionMiddleware: for fmt, func in self._formats.items(): new_response = func(response) if new_response: - logger.debug('Decompressed response with format: %(responsefmt)s', - {'responsefmt': fmt}, extra={'spider': spider}) + logger.debug( + "Decompressed response with format: %(responsefmt)s", + {"responsefmt": fmt}, + extra={"spider": spider}, + ) return new_response return response diff --git a/scrapy/downloadermiddlewares/defaultheaders.py b/scrapy/downloadermiddlewares/defaultheaders.py index f67961881..cdacc7368 100644 --- a/scrapy/downloadermiddlewares/defaultheaders.py +++ b/scrapy/downloadermiddlewares/defaultheaders.py @@ -8,13 +8,12 @@ from scrapy.utils.python import without_none_values class DefaultHeadersMiddleware: - def __init__(self, headers): self._headers = headers @classmethod def from_crawler(cls, crawler): - headers = without_none_values(crawler.settings['DEFAULT_REQUEST_HEADERS']) + headers = without_none_values(crawler.settings["DEFAULT_REQUEST_HEADERS"]) return cls(headers.items()) def process_request(self, request, spider): diff --git a/scrapy/downloadermiddlewares/downloadtimeout.py b/scrapy/downloadermiddlewares/downloadtimeout.py index d373a22df..a926ecf56 100644 --- a/scrapy/downloadermiddlewares/downloadtimeout.py +++ b/scrapy/downloadermiddlewares/downloadtimeout.py @@ -8,19 +8,18 @@ from scrapy import signals class DownloadTimeoutMiddleware: - def __init__(self, timeout=180): self._timeout = timeout @classmethod def from_crawler(cls, crawler): - o = cls(crawler.settings.getfloat('DOWNLOAD_TIMEOUT')) + o = cls(crawler.settings.getfloat("DOWNLOAD_TIMEOUT")) crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) return o def spider_opened(self, spider): - self._timeout = getattr(spider, 'download_timeout', self._timeout) + self._timeout = getattr(spider, "download_timeout", self._timeout) def process_request(self, request, spider): if self._timeout: - request.meta.setdefault('download_timeout', self._timeout) + request.meta.setdefault("download_timeout", self._timeout) diff --git a/scrapy/downloadermiddlewares/httpauth.py b/scrapy/downloadermiddlewares/httpauth.py index 1bee3e279..de5a81388 100644 --- a/scrapy/downloadermiddlewares/httpauth.py +++ b/scrapy/downloadermiddlewares/httpauth.py @@ -24,27 +24,29 @@ class HttpAuthMiddleware: return o def spider_opened(self, spider): - usr = getattr(spider, 'http_user', '') - pwd = getattr(spider, 'http_pass', '') + usr = getattr(spider, "http_user", "") + pwd = getattr(spider, "http_pass", "") if usr or pwd: self.auth = basic_auth_header(usr, pwd) - if not hasattr(spider, 'http_auth_domain'): - warnings.warn('Using HttpAuthMiddleware without http_auth_domain is deprecated and can cause security ' - 'problems if the spider makes requests to several different domains. http_auth_domain ' - 'will be set to the domain of the first request, please set it to the correct value ' - 'explicitly.', - category=ScrapyDeprecationWarning) + if not hasattr(spider, "http_auth_domain"): + warnings.warn( + "Using HttpAuthMiddleware without http_auth_domain is deprecated and can cause security " + "problems if the spider makes requests to several different domains. http_auth_domain " + "will be set to the domain of the first request, please set it to the correct value " + "explicitly.", + category=ScrapyDeprecationWarning, + ) self.domain_unset = True else: self.domain = spider.http_auth_domain self.domain_unset = False def process_request(self, request, spider): - auth = getattr(self, 'auth', None) - if auth and b'Authorization' not in request.headers: + auth = getattr(self, "auth", None) + if auth and b"Authorization" not in request.headers: domain = urlparse_cached(request).hostname if self.domain_unset: self.domain = domain self.domain_unset = False if not self.domain or url_is_from_any_domain(request.url, [self.domain]): - request.headers[b'Authorization'] = auth + request.headers[b"Authorization"] = auth diff --git a/scrapy/downloadermiddlewares/httpcache.py b/scrapy/downloadermiddlewares/httpcache.py index 80ed7ac75..eb2754f1d 100644 --- a/scrapy/downloadermiddlewares/httpcache.py +++ b/scrapy/downloadermiddlewares/httpcache.py @@ -29,21 +29,31 @@ HttpCacheMiddlewareTV = TypeVar("HttpCacheMiddlewareTV", bound="HttpCacheMiddlew class HttpCacheMiddleware: - DOWNLOAD_EXCEPTIONS = (defer.TimeoutError, TimeoutError, DNSLookupError, - ConnectionRefusedError, ConnectionDone, ConnectError, - ConnectionLost, TCPTimedOutError, ResponseFailed, - IOError) + DOWNLOAD_EXCEPTIONS = ( + defer.TimeoutError, + TimeoutError, + DNSLookupError, + ConnectionRefusedError, + ConnectionDone, + ConnectError, + ConnectionLost, + TCPTimedOutError, + ResponseFailed, + IOError, + ) def __init__(self, settings: Settings, stats: StatsCollector) -> None: - if not settings.getbool('HTTPCACHE_ENABLED'): + if not settings.getbool("HTTPCACHE_ENABLED"): raise NotConfigured - self.policy = load_object(settings['HTTPCACHE_POLICY'])(settings) - self.storage = load_object(settings['HTTPCACHE_STORAGE'])(settings) - self.ignore_missing = settings.getbool('HTTPCACHE_IGNORE_MISSING') + self.policy = load_object(settings["HTTPCACHE_POLICY"])(settings) + self.storage = load_object(settings["HTTPCACHE_STORAGE"])(settings) + self.ignore_missing = settings.getbool("HTTPCACHE_IGNORE_MISSING") self.stats = stats @classmethod - def from_crawler(cls: Type[HttpCacheMiddlewareTV], crawler: Crawler) -> HttpCacheMiddlewareTV: + def from_crawler( + cls: Type[HttpCacheMiddlewareTV], crawler: Crawler + ) -> HttpCacheMiddlewareTV: o = cls(crawler.settings, crawler.stats) crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) crawler.signals.connect(o.spider_closed, signal=signals.spider_closed) @@ -56,78 +66,86 @@ class HttpCacheMiddleware: self.storage.close_spider(spider) def process_request(self, request: Request, spider: Spider) -> Optional[Response]: - if request.meta.get('dont_cache', False): + if request.meta.get("dont_cache", False): return None # Skip uncacheable requests if not self.policy.should_cache_request(request): - request.meta['_dont_cache'] = True # flag as uncacheable + request.meta["_dont_cache"] = True # flag as uncacheable return None # Look for cached response and check if expired cachedresponse = self.storage.retrieve_response(spider, request) if cachedresponse is None: - self.stats.inc_value('httpcache/miss', spider=spider) + self.stats.inc_value("httpcache/miss", spider=spider) if self.ignore_missing: - self.stats.inc_value('httpcache/ignore', spider=spider) + self.stats.inc_value("httpcache/ignore", spider=spider) raise IgnoreRequest(f"Ignored request not in cache: {request}") return None # first time request # Return cached response only if not expired - cachedresponse.flags.append('cached') + cachedresponse.flags.append("cached") if self.policy.is_cached_response_fresh(cachedresponse, request): - self.stats.inc_value('httpcache/hit', spider=spider) + self.stats.inc_value("httpcache/hit", spider=spider) return cachedresponse # Keep a reference to cached response to avoid a second cache lookup on # process_response hook - request.meta['cached_response'] = cachedresponse + request.meta["cached_response"] = cachedresponse return None - def process_response(self, request: Request, response: Response, spider: Spider) -> Response: - if request.meta.get('dont_cache', False): + def process_response( + self, request: Request, response: Response, spider: Spider + ) -> Response: + if request.meta.get("dont_cache", False): return response # Skip cached responses and uncacheable requests - if 'cached' in response.flags or '_dont_cache' in request.meta: - request.meta.pop('_dont_cache', None) + if "cached" in response.flags or "_dont_cache" in request.meta: + request.meta.pop("_dont_cache", None) return response # RFC2616 requires origin server to set Date header, # https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.18 - if 'Date' not in response.headers: - response.headers['Date'] = formatdate(usegmt=True) + if "Date" not in response.headers: + response.headers["Date"] = formatdate(usegmt=True) # Do not validate first-hand responses - cachedresponse = request.meta.pop('cached_response', None) + cachedresponse = request.meta.pop("cached_response", None) if cachedresponse is None: - self.stats.inc_value('httpcache/firsthand', spider=spider) + self.stats.inc_value("httpcache/firsthand", spider=spider) self._cache_response(spider, response, request, cachedresponse) return response if self.policy.is_cached_response_valid(cachedresponse, response, request): - self.stats.inc_value('httpcache/revalidate', spider=spider) + self.stats.inc_value("httpcache/revalidate", spider=spider) return cachedresponse - self.stats.inc_value('httpcache/invalidate', spider=spider) + self.stats.inc_value("httpcache/invalidate", spider=spider) self._cache_response(spider, response, request, cachedresponse) return response def process_exception( self, request: Request, exception: Exception, spider: Spider ) -> Optional[Response]: - cachedresponse = request.meta.pop('cached_response', None) - if cachedresponse is not None and isinstance(exception, self.DOWNLOAD_EXCEPTIONS): - self.stats.inc_value('httpcache/errorrecovery', spider=spider) + cachedresponse = request.meta.pop("cached_response", None) + if cachedresponse is not None and isinstance( + exception, self.DOWNLOAD_EXCEPTIONS + ): + self.stats.inc_value("httpcache/errorrecovery", spider=spider) return cachedresponse return None def _cache_response( - self, spider: Spider, response: Response, request: Request, cachedresponse: Optional[Response] + self, + spider: Spider, + response: Response, + request: Request, + cachedresponse: Optional[Response], ) -> None: if self.policy.should_cache_response(response, request): - self.stats.inc_value('httpcache/store', spider=spider) + self.stats.inc_value("httpcache/store", spider=spider) self.storage.store_response(spider, request, response) else: - self.stats.inc_value('httpcache/uncacheable', spider=spider) + self.stats.inc_value("httpcache/uncacheable", spider=spider) diff --git a/scrapy/downloadermiddlewares/httpcompression.py b/scrapy/downloadermiddlewares/httpcompression.py index e57f6fcf8..7b5f4824a 100644 --- a/scrapy/downloadermiddlewares/httpcompression.py +++ b/scrapy/downloadermiddlewares/httpcompression.py @@ -8,17 +8,19 @@ from scrapy.responsetypes import responsetypes from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.gz import gunzip -ACCEPTED_ENCODINGS = [b'gzip', b'deflate'] +ACCEPTED_ENCODINGS = [b"gzip", b"deflate"] try: import brotli - ACCEPTED_ENCODINGS.append(b'br') + + ACCEPTED_ENCODINGS.append(b"br") except ImportError: pass try: import zstandard - ACCEPTED_ENCODINGS.append(b'zstd') + + ACCEPTED_ENCODINGS.append(b"zstd") except ImportError: pass @@ -26,12 +28,13 @@ except ImportError: class HttpCompressionMiddleware: """This middleware allows compressed (gzip, deflate) traffic to be sent/received from web sites""" + def __init__(self, stats=None): self.stats = stats @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('COMPRESSION_ENABLED'): + if not crawler.settings.getbool("COMPRESSION_ENABLED"): raise NotConfigured try: return cls(stats=crawler.stats) @@ -47,21 +50,26 @@ class HttpCompressionMiddleware: return result def process_request(self, request, spider): - request.headers.setdefault('Accept-Encoding', - b", ".join(ACCEPTED_ENCODINGS)) + request.headers.setdefault("Accept-Encoding", b", ".join(ACCEPTED_ENCODINGS)) def process_response(self, request, response, spider): - if request.method == 'HEAD': + if request.method == "HEAD": return response if isinstance(response, Response): - content_encoding = response.headers.getlist('Content-Encoding') + content_encoding = response.headers.getlist("Content-Encoding") if content_encoding: encoding = content_encoding.pop() decoded_body = self._decode(response.body, encoding.lower()) if self.stats: - self.stats.inc_value('httpcompression/response_bytes', len(decoded_body), spider=spider) - self.stats.inc_value('httpcompression/response_count', spider=spider) + self.stats.inc_value( + "httpcompression/response_bytes", + len(decoded_body), + spider=spider, + ) + self.stats.inc_value( + "httpcompression/response_count", spider=spider + ) respcls = responsetypes.from_args( headers=response.headers, url=response.url, body=decoded_body ) @@ -69,18 +77,18 @@ class HttpCompressionMiddleware: if issubclass(respcls, TextResponse): # force recalculating the encoding until we make sure the # responsetypes guessing is reliable - kwargs['encoding'] = None + kwargs["encoding"] = None response = response.replace(**kwargs) if not content_encoding: - del response.headers['Content-Encoding'] + del response.headers["Content-Encoding"] return response def _decode(self, body, encoding): - if encoding == b'gzip' or encoding == b'x-gzip': + if encoding == b"gzip" or encoding == b"x-gzip": body = gunzip(body) - if encoding == b'deflate': + if encoding == b"deflate": try: body = zlib.decompress(body) except zlib.error: @@ -90,9 +98,9 @@ class HttpCompressionMiddleware: # http://www.port80software.com/200ok/archive/2005/10/31/868.aspx # http://www.gzip.org/zlib/zlib_faq.html#faq38 body = zlib.decompress(body, -15) - if encoding == b'br' and b'br' in ACCEPTED_ENCODINGS: + if encoding == b"br" and b"br" in ACCEPTED_ENCODINGS: body = brotli.decompress(body) - if encoding == b'zstd' and b'zstd' in ACCEPTED_ENCODINGS: + if encoding == b"zstd" and b"zstd" in ACCEPTED_ENCODINGS: # Using its streaming API since its simple API could handle only cases # where there is content size data embedded in the frame reader = zstandard.ZstdDecompressor().stream_reader(io.BytesIO(body)) diff --git a/scrapy/downloadermiddlewares/httpproxy.py b/scrapy/downloadermiddlewares/httpproxy.py index dd8a7e797..489867918 100644 --- a/scrapy/downloadermiddlewares/httpproxy.py +++ b/scrapy/downloadermiddlewares/httpproxy.py @@ -8,8 +8,7 @@ from scrapy.utils.python import to_bytes class HttpProxyMiddleware: - - def __init__(self, auth_encoding='latin-1'): + def __init__(self, auth_encoding="latin-1"): self.auth_encoding = auth_encoding self.proxies = {} for type_, url in getproxies().items(): @@ -22,20 +21,20 @@ class HttpProxyMiddleware: @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('HTTPPROXY_ENABLED'): + if not crawler.settings.getbool("HTTPPROXY_ENABLED"): raise NotConfigured - auth_encoding = crawler.settings.get('HTTPPROXY_AUTH_ENCODING') + auth_encoding = crawler.settings.get("HTTPPROXY_AUTH_ENCODING") return cls(auth_encoding) def _basic_auth_header(self, username, password): user_pass = to_bytes( - f'{unquote(username)}:{unquote(password)}', - encoding=self.auth_encoding) + f"{unquote(username)}:{unquote(password)}", encoding=self.auth_encoding + ) return base64.b64encode(user_pass) def _get_proxy(self, url, orig_type): proxy_type, user, password, hostport = _parse_proxy(url) - proxy_url = urlunparse((proxy_type or orig_type, hostport, '', '', '', '')) + proxy_url = urlunparse((proxy_type or orig_type, hostport, "", "", "", "")) if user: creds = self._basic_auth_header(user, password) @@ -46,39 +45,36 @@ class HttpProxyMiddleware: def process_request(self, request, spider): creds, proxy_url = None, None - if 'proxy' in request.meta: - if request.meta['proxy'] is not None: - creds, proxy_url = self._get_proxy(request.meta['proxy'], '') + if "proxy" in request.meta: + if request.meta["proxy"] is not None: + creds, proxy_url = self._get_proxy(request.meta["proxy"], "") elif self.proxies: parsed = urlparse_cached(request) scheme = parsed.scheme if ( - ( - # 'no_proxy' is only supported by http schemes - scheme not in ('http', 'https') - or not proxy_bypass(parsed.hostname) - ) - and scheme in self.proxies - ): + # 'no_proxy' is only supported by http schemes + scheme not in ("http", "https") + or not proxy_bypass(parsed.hostname) + ) and scheme in self.proxies: creds, proxy_url = self.proxies[scheme] self._set_proxy_and_creds(request, proxy_url, creds) def _set_proxy_and_creds(self, request, proxy_url, creds): if proxy_url: - request.meta['proxy'] = proxy_url - elif request.meta.get('proxy') is not None: - request.meta['proxy'] = None + request.meta["proxy"] = proxy_url + elif request.meta.get("proxy") is not None: + request.meta["proxy"] = None if creds: - request.headers[b'Proxy-Authorization'] = b'Basic ' + creds - request.meta['_auth_proxy'] = proxy_url - elif '_auth_proxy' in request.meta: - if proxy_url != request.meta['_auth_proxy']: - if b'Proxy-Authorization' in request.headers: - del request.headers[b'Proxy-Authorization'] - del request.meta['_auth_proxy'] - elif b'Proxy-Authorization' in request.headers: + request.headers[b"Proxy-Authorization"] = b"Basic " + creds + request.meta["_auth_proxy"] = proxy_url + elif "_auth_proxy" in request.meta: + if proxy_url != request.meta["_auth_proxy"]: + if b"Proxy-Authorization" in request.headers: + del request.headers[b"Proxy-Authorization"] + del request.meta["_auth_proxy"] + elif b"Proxy-Authorization" in request.headers: if proxy_url: - request.meta['_auth_proxy'] = proxy_url + request.meta["_auth_proxy"] = proxy_url else: - del request.headers[b'Proxy-Authorization'] + del request.headers[b"Proxy-Authorization"] diff --git a/scrapy/downloadermiddlewares/redirect.py b/scrapy/downloadermiddlewares/redirect.py index fba825947..003c59fc4 100644 --- a/scrapy/downloadermiddlewares/redirect.py +++ b/scrapy/downloadermiddlewares/redirect.py @@ -17,57 +17,66 @@ def _build_redirect_request(source_request, *, url, **kwargs): **kwargs, cookies=None, ) - if 'Cookie' in redirect_request.headers: + if "Cookie" in redirect_request.headers: source_request_netloc = urlparse_cached(source_request).netloc redirect_request_netloc = urlparse_cached(redirect_request).netloc if source_request_netloc != redirect_request_netloc: - del redirect_request.headers['Cookie'] + del redirect_request.headers["Cookie"] return redirect_request class BaseRedirectMiddleware: - enabled_setting = 'REDIRECT_ENABLED' + enabled_setting = "REDIRECT_ENABLED" def __init__(self, settings): if not settings.getbool(self.enabled_setting): raise NotConfigured - self.max_redirect_times = settings.getint('REDIRECT_MAX_TIMES') - self.priority_adjust = settings.getint('REDIRECT_PRIORITY_ADJUST') + self.max_redirect_times = settings.getint("REDIRECT_MAX_TIMES") + self.priority_adjust = settings.getint("REDIRECT_PRIORITY_ADJUST") @classmethod def from_crawler(cls, crawler): return cls(crawler.settings) def _redirect(self, redirected, request, spider, reason): - ttl = request.meta.setdefault('redirect_ttl', self.max_redirect_times) - redirects = request.meta.get('redirect_times', 0) + 1 + ttl = request.meta.setdefault("redirect_ttl", self.max_redirect_times) + redirects = request.meta.get("redirect_times", 0) + 1 if ttl and redirects <= self.max_redirect_times: - redirected.meta['redirect_times'] = redirects - redirected.meta['redirect_ttl'] = ttl - 1 - redirected.meta['redirect_urls'] = request.meta.get('redirect_urls', []) + [request.url] - redirected.meta['redirect_reasons'] = request.meta.get('redirect_reasons', []) + [reason] + redirected.meta["redirect_times"] = redirects + redirected.meta["redirect_ttl"] = ttl - 1 + redirected.meta["redirect_urls"] = request.meta.get("redirect_urls", []) + [ + request.url + ] + redirected.meta["redirect_reasons"] = request.meta.get( + "redirect_reasons", [] + ) + [reason] redirected.dont_filter = request.dont_filter redirected.priority = request.priority + self.priority_adjust - logger.debug("Redirecting (%(reason)s) to %(redirected)s from %(request)s", - {'reason': reason, 'redirected': redirected, 'request': request}, - extra={'spider': spider}) + logger.debug( + "Redirecting (%(reason)s) to %(redirected)s from %(request)s", + {"reason": reason, "redirected": redirected, "request": request}, + extra={"spider": spider}, + ) return redirected - logger.debug("Discarding %(request)s: max redirections reached", - {'request': request}, extra={'spider': spider}) + logger.debug( + "Discarding %(request)s: max redirections reached", + {"request": request}, + extra={"spider": spider}, + ) raise IgnoreRequest("max redirections reached") def _redirect_request_using_get(self, request, redirect_url): redirect_request = _build_redirect_request( request, url=redirect_url, - method='GET', - body='', + method="GET", + body="", ) - redirect_request.headers.pop('Content-Type', None) - redirect_request.headers.pop('Content-Length', None) + redirect_request.headers.pop("Content-Type", None) + redirect_request.headers.pop("Content-Length", None) return redirect_request @@ -79,25 +88,25 @@ class RedirectMiddleware(BaseRedirectMiddleware): def process_response(self, request, response, spider): if ( - request.meta.get('dont_redirect', False) - or response.status in getattr(spider, 'handle_httpstatus_list', []) - or response.status in request.meta.get('handle_httpstatus_list', []) - or request.meta.get('handle_httpstatus_all', False) + request.meta.get("dont_redirect", False) + or response.status in getattr(spider, "handle_httpstatus_list", []) + or response.status in request.meta.get("handle_httpstatus_list", []) + or request.meta.get("handle_httpstatus_all", False) ): return response allowed_status = (301, 302, 303, 307, 308) - if 'Location' not in response.headers or response.status not in allowed_status: + if "Location" not in response.headers or response.status not in allowed_status: return response - location = safe_url_string(response.headers['Location']) - if response.headers['Location'].startswith(b'//'): + location = safe_url_string(response.headers["Location"]) + if response.headers["Location"].startswith(b"//"): request_scheme = urlparse(request.url).scheme - location = request_scheme + '://' + location.lstrip('/') + location = request_scheme + "://" + location.lstrip("/") redirected_url = urljoin(request.url, location) - if response.status in (301, 307, 308) or request.method == 'HEAD': + if response.status in (301, 307, 308) or request.method == "HEAD": redirected = _build_redirect_request(request, url=redirected_url) return self._redirect(redirected, request, spider, response.status) @@ -107,25 +116,24 @@ class RedirectMiddleware(BaseRedirectMiddleware): class MetaRefreshMiddleware(BaseRedirectMiddleware): - enabled_setting = 'METAREFRESH_ENABLED' + enabled_setting = "METAREFRESH_ENABLED" def __init__(self, settings): super().__init__(settings) - self._ignore_tags = settings.getlist('METAREFRESH_IGNORE_TAGS') - self._maxdelay = settings.getint('METAREFRESH_MAXDELAY') + self._ignore_tags = settings.getlist("METAREFRESH_IGNORE_TAGS") + self._maxdelay = settings.getint("METAREFRESH_MAXDELAY") def process_response(self, request, response, spider): if ( - request.meta.get('dont_redirect', False) - or request.method == 'HEAD' + request.meta.get("dont_redirect", False) + or request.method == "HEAD" or not isinstance(response, HtmlResponse) ): return response - interval, url = get_meta_refresh(response, - ignore_tags=self._ignore_tags) + interval, url = get_meta_refresh(response, ignore_tags=self._ignore_tags) if url and interval < self._maxdelay: redirected = self._redirect_request_using_get(request, url) - return self._redirect(redirected, request, spider, 'meta refresh') + return self._redirect(redirected, request, spider, "meta refresh") return response diff --git a/scrapy/downloadermiddlewares/retry.py b/scrapy/downloadermiddlewares/retry.py index 2de610e86..8a8f15f9a 100644 --- a/scrapy/downloadermiddlewares/retry.py +++ b/scrapy/downloadermiddlewares/retry.py @@ -39,11 +39,11 @@ def get_retry_request( request: Request, *, spider: Spider, - reason: Union[str, Exception] = 'unspecified', + reason: Union[str, Exception] = "unspecified", max_retry_times: Optional[int] = None, priority_adjust: Optional[int] = None, logger: Logger = retry_logger, - stats_base_key: str = 'retry', + stats_base_key: str = "retry", ): """ Returns a new :class:`~scrapy.Request` object to retry the specified @@ -87,22 +87,22 @@ def get_retry_request( """ settings = spider.crawler.settings stats = spider.crawler.stats - retry_times = request.meta.get('retry_times', 0) + 1 + retry_times = request.meta.get("retry_times", 0) + 1 if max_retry_times is None: - max_retry_times = request.meta.get('max_retry_times') + max_retry_times = request.meta.get("max_retry_times") if max_retry_times is None: - max_retry_times = settings.getint('RETRY_TIMES') + max_retry_times = settings.getint("RETRY_TIMES") if retry_times <= max_retry_times: logger.debug( "Retrying %(request)s (failed %(retry_times)d times): %(reason)s", - {'request': request, 'retry_times': retry_times, 'reason': reason}, - extra={'spider': spider} + {"request": request, "retry_times": retry_times, "reason": reason}, + extra={"spider": spider}, ) new_request: Request = request.copy() - new_request.meta['retry_times'] = retry_times + new_request.meta["retry_times"] = retry_times new_request.dont_filter = True if priority_adjust is None: - priority_adjust = settings.getint('RETRY_PRIORITY_ADJUST') + priority_adjust = settings.getint("RETRY_PRIORITY_ADJUST") new_request.priority = request.priority + priority_adjust if callable(reason): @@ -110,15 +110,14 @@ def get_retry_request( if isinstance(reason, Exception): reason = global_object_name(reason.__class__) - stats.inc_value(f'{stats_base_key}/count') - stats.inc_value(f'{stats_base_key}/reason_count/{reason}') + stats.inc_value(f"{stats_base_key}/count") + stats.inc_value(f"{stats_base_key}/reason_count/{reason}") return new_request - stats.inc_value(f'{stats_base_key}/max_reached') + stats.inc_value(f"{stats_base_key}/max_reached") logger.error( - "Gave up retrying %(request)s (failed %(retry_times)d times): " - "%(reason)s", - {'request': request, 'retry_times': retry_times, 'reason': reason}, - extra={'spider': spider}, + "Gave up retrying %(request)s (failed %(retry_times)d times): " "%(reason)s", + {"request": request, "retry_times": retry_times, "reason": reason}, + extra={"spider": spider}, ) return None @@ -127,24 +126,35 @@ class RetryMiddleware: # IOError is raised by the HttpCompression middleware when trying to # decompress an empty response - EXCEPTIONS_TO_RETRY = (defer.TimeoutError, TimeoutError, DNSLookupError, - ConnectionRefusedError, ConnectionDone, ConnectError, - ConnectionLost, TCPTimedOutError, ResponseFailed, - IOError, TunnelError) + EXCEPTIONS_TO_RETRY = ( + defer.TimeoutError, + TimeoutError, + DNSLookupError, + ConnectionRefusedError, + ConnectionDone, + ConnectError, + ConnectionLost, + TCPTimedOutError, + ResponseFailed, + IOError, + TunnelError, + ) def __init__(self, settings): - if not settings.getbool('RETRY_ENABLED'): + if not settings.getbool("RETRY_ENABLED"): raise NotConfigured - self.max_retry_times = settings.getint('RETRY_TIMES') - self.retry_http_codes = set(int(x) for x in settings.getlist('RETRY_HTTP_CODES')) - self.priority_adjust = settings.getint('RETRY_PRIORITY_ADJUST') + self.max_retry_times = settings.getint("RETRY_TIMES") + self.retry_http_codes = set( + int(x) for x in settings.getlist("RETRY_HTTP_CODES") + ) + self.priority_adjust = settings.getint("RETRY_PRIORITY_ADJUST") @classmethod def from_crawler(cls, crawler): return cls(crawler.settings) def process_response(self, request, response, spider): - if request.meta.get('dont_retry', False): + if request.meta.get("dont_retry", False): return response if response.status in self.retry_http_codes: reason = response_status_message(response.status) @@ -152,15 +162,14 @@ class RetryMiddleware: return response def process_exception(self, request, exception, spider): - if ( - isinstance(exception, self.EXCEPTIONS_TO_RETRY) - and not request.meta.get('dont_retry', False) + if isinstance(exception, self.EXCEPTIONS_TO_RETRY) and not request.meta.get( + "dont_retry", False ): return self._retry(request, exception, spider) def _retry(self, request, reason, spider): - max_retry_times = request.meta.get('max_retry_times', self.max_retry_times) - priority_adjust = request.meta.get('priority_adjust', self.priority_adjust) + max_retry_times = request.meta.get("max_retry_times", self.max_retry_times) + priority_adjust = request.meta.get("priority_adjust", self.priority_adjust) return get_retry_request( request, reason=reason, diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index 7bd39aa43..326c35290 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -20,23 +20,23 @@ class RobotsTxtMiddleware: DOWNLOAD_PRIORITY = 1000 def __init__(self, crawler): - if not crawler.settings.getbool('ROBOTSTXT_OBEY'): + if not crawler.settings.getbool("ROBOTSTXT_OBEY"): raise NotConfigured - self._default_useragent = crawler.settings.get('USER_AGENT', 'Scrapy') - self._robotstxt_useragent = crawler.settings.get('ROBOTSTXT_USER_AGENT', None) + self._default_useragent = crawler.settings.get("USER_AGENT", "Scrapy") + self._robotstxt_useragent = crawler.settings.get("ROBOTSTXT_USER_AGENT", None) self.crawler = crawler self._parsers = {} - self._parserimpl = load_object(crawler.settings.get('ROBOTSTXT_PARSER')) + self._parserimpl = load_object(crawler.settings.get("ROBOTSTXT_PARSER")) # check if parser dependencies are met, this should throw an error otherwise. - self._parserimpl.from_crawler(self.crawler, b'') + self._parserimpl.from_crawler(self.crawler, b"") @classmethod def from_crawler(cls, crawler): return cls(crawler) def process_request(self, request, spider): - if request.meta.get('dont_obey_robotstxt'): + if request.meta.get("dont_obey_robotstxt"): return d = maybeDeferred(self.robot_parser, request, spider) d.addCallback(self.process_request_2, request, spider) @@ -48,11 +48,14 @@ class RobotsTxtMiddleware: useragent = self._robotstxt_useragent if not useragent: - useragent = request.headers.get(b'User-Agent', self._default_useragent) + useragent = request.headers.get(b"User-Agent", self._default_useragent) if not rp.allowed(request.url, useragent): - logger.debug("Forbidden by robots.txt: %(request)s", - {'request': request}, extra={'spider': spider}) - self.crawler.stats.inc_value('robotstxt/forbidden') + logger.debug( + "Forbidden by robots.txt: %(request)s", + {"request": request}, + extra={"spider": spider}, + ) + self.crawler.stats.inc_value("robotstxt/forbidden") raise IgnoreRequest("Forbidden by robots.txt") def robot_parser(self, request, spider): @@ -65,13 +68,13 @@ class RobotsTxtMiddleware: robotsreq = Request( robotsurl, priority=self.DOWNLOAD_PRIORITY, - meta={'dont_obey_robotstxt': True} + meta={"dont_obey_robotstxt": True}, ) dfd = self.crawler.engine.download(robotsreq) dfd.addCallback(self._parse_robots, netloc, spider) dfd.addErrback(self._logerror, robotsreq, spider) dfd.addErrback(self._robots_error, netloc) - self.crawler.stats.inc_value('robotstxt/request_count') + self.crawler.stats.inc_value("robotstxt/request_count") if isinstance(self._parsers[netloc], Deferred): d = Deferred() @@ -79,21 +82,26 @@ class RobotsTxtMiddleware: def cb(result): d.callback(result) return result + self._parsers[netloc].addCallback(cb) return d return self._parsers[netloc] def _logerror(self, failure, request, spider): if failure.type is not IgnoreRequest: - logger.error("Error downloading %(request)s: %(f_exception)s", - {'request': request, 'f_exception': failure.value}, - exc_info=failure_to_exc_info(failure), - extra={'spider': spider}) + logger.error( + "Error downloading %(request)s: %(f_exception)s", + {"request": request, "f_exception": failure.value}, + exc_info=failure_to_exc_info(failure), + extra={"spider": spider}, + ) return failure def _parse_robots(self, response, netloc, spider): - self.crawler.stats.inc_value('robotstxt/response_count') - self.crawler.stats.inc_value(f'robotstxt/response_status_count/{response.status}') + self.crawler.stats.inc_value("robotstxt/response_count") + self.crawler.stats.inc_value( + f"robotstxt/response_status_count/{response.status}" + ) rp = self._parserimpl.from_crawler(self.crawler, response.body) rp_dfd = self._parsers[netloc] self._parsers[netloc] = rp @@ -101,7 +109,7 @@ class RobotsTxtMiddleware: def _robots_error(self, failure, netloc): if failure.type is not IgnoreRequest: - key = f'robotstxt/exception_count/{failure.type}' + key = f"robotstxt/exception_count/{failure.type}" self.crawler.stats.inc_value(key) rp_dfd = self._parsers[netloc] self._parsers[netloc] = None diff --git a/scrapy/downloadermiddlewares/stats.py b/scrapy/downloadermiddlewares/stats.py index 2bb022c16..a0f62e262 100644 --- a/scrapy/downloadermiddlewares/stats.py +++ b/scrapy/downloadermiddlewares/stats.py @@ -11,40 +11,50 @@ def get_header_size(headers): if isinstance(value, (list, tuple)): for v in value: size += len(b": ") + len(key) + len(v) - return size + len(b'\r\n') * (len(headers.keys()) - 1) + return size + len(b"\r\n") * (len(headers.keys()) - 1) def get_status_size(response_status): - return len(to_bytes(http.RESPONSES.get(response_status, b''))) + 15 + return len(to_bytes(http.RESPONSES.get(response_status, b""))) + 15 # resp.status + b"\r\n" + b"HTTP/1.1 <100-599> " class DownloaderStats: - def __init__(self, stats): self.stats = stats @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('DOWNLOADER_STATS'): + if not crawler.settings.getbool("DOWNLOADER_STATS"): raise NotConfigured return cls(crawler.stats) def process_request(self, request, spider): - self.stats.inc_value('downloader/request_count', spider=spider) - self.stats.inc_value(f'downloader/request_method_count/{request.method}', spider=spider) + self.stats.inc_value("downloader/request_count", spider=spider) + self.stats.inc_value( + f"downloader/request_method_count/{request.method}", spider=spider + ) reqlen = len(request_httprepr(request)) - self.stats.inc_value('downloader/request_bytes', reqlen, spider=spider) + self.stats.inc_value("downloader/request_bytes", reqlen, spider=spider) def process_response(self, request, response, spider): - self.stats.inc_value('downloader/response_count', spider=spider) - self.stats.inc_value(f'downloader/response_status_count/{response.status}', spider=spider) - reslen = len(response.body) + get_header_size(response.headers) + get_status_size(response.status) + 4 + self.stats.inc_value("downloader/response_count", spider=spider) + self.stats.inc_value( + f"downloader/response_status_count/{response.status}", spider=spider + ) + reslen = ( + len(response.body) + + get_header_size(response.headers) + + get_status_size(response.status) + + 4 + ) # response.body + b"\r\n"+ response.header + b"\r\n" + response.status - self.stats.inc_value('downloader/response_bytes', reslen, spider=spider) + self.stats.inc_value("downloader/response_bytes", reslen, spider=spider) return response def process_exception(self, request, exception, spider): ex_class = global_object_name(exception.__class__) - self.stats.inc_value('downloader/exception_count', spider=spider) - self.stats.inc_value(f'downloader/exception_type_count/{ex_class}', spider=spider) + self.stats.inc_value("downloader/exception_count", spider=spider) + self.stats.inc_value( + f"downloader/exception_type_count/{ex_class}", spider=spider + ) diff --git a/scrapy/downloadermiddlewares/useragent.py b/scrapy/downloadermiddlewares/useragent.py index 3ee7bd129..856a275ab 100644 --- a/scrapy/downloadermiddlewares/useragent.py +++ b/scrapy/downloadermiddlewares/useragent.py @@ -6,18 +6,18 @@ from scrapy import signals class UserAgentMiddleware: """This middleware allows spiders to override the user_agent""" - def __init__(self, user_agent='Scrapy'): + def __init__(self, user_agent="Scrapy"): self.user_agent = user_agent @classmethod def from_crawler(cls, crawler): - o = cls(crawler.settings['USER_AGENT']) + o = cls(crawler.settings["USER_AGENT"]) crawler.signals.connect(o.spider_opened, signal=signals.spider_opened) return o def spider_opened(self, spider): - self.user_agent = getattr(spider, 'user_agent', self.user_agent) + self.user_agent = getattr(spider, "user_agent", self.user_agent) def process_request(self, request, spider): if self.user_agent: - request.headers.setdefault(b'User-Agent', self.user_agent) + request.headers.setdefault(b"User-Agent", self.user_agent) diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index 6dca11d31..fa0f8f846 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -18,7 +18,9 @@ BaseDupeFilterTV = TypeVar("BaseDupeFilterTV", bound="BaseDupeFilter") class BaseDupeFilter: @classmethod - def from_settings(cls: Type[BaseDupeFilterTV], settings: BaseSettings) -> BaseDupeFilterTV: + def from_settings( + cls: Type[BaseDupeFilterTV], settings: BaseSettings + ) -> BaseDupeFilterTV: return cls() def request_seen(self, request: Request) -> bool: @@ -55,13 +57,15 @@ class RFPDupeFilter(BaseDupeFilter): self.debug = debug self.logger = logging.getLogger(__name__) if path: - self.file = Path(path, 'requests.seen').open('a+', encoding="utf-8") + self.file = Path(path, "requests.seen").open("a+", encoding="utf-8") self.file.seek(0) self.fingerprints.update(x.rstrip() for x in self.file) @classmethod - def from_settings(cls: Type[RFPDupeFilterTV], settings: BaseSettings, *, fingerprinter=None) -> RFPDupeFilterTV: - debug = settings.getbool('DUPEFILTER_DEBUG') + def from_settings( + cls: Type[RFPDupeFilterTV], settings: BaseSettings, *, fingerprinter=None + ) -> RFPDupeFilterTV: + debug = settings.getbool("DUPEFILTER_DEBUG") try: return cls(job_dir(settings), debug, fingerprinter=fingerprinter) except TypeError: @@ -100,7 +104,7 @@ class RFPDupeFilter(BaseDupeFilter): return True self.fingerprints.add(fp) if self.file: - self.file.write(fp + '\n') + self.file.write(fp + "\n") return False def request_fingerprint(self, request: Request) -> str: @@ -113,13 +117,15 @@ class RFPDupeFilter(BaseDupeFilter): def log(self, request: Request, spider: Spider) -> None: if self.debug: msg = "Filtered duplicate request: %(request)s (referer: %(referer)s)" - args = {'request': request, 'referer': referer_str(request)} - self.logger.debug(msg, args, extra={'spider': spider}) + args = {"request": request, "referer": referer_str(request)} + self.logger.debug(msg, args, extra={"spider": spider}) elif self.logdupes: - msg = ("Filtered duplicate request: %(request)s" - " - no more duplicates will be shown" - " (see DUPEFILTER_DEBUG to show all duplicates)") - self.logger.debug(msg, {'request': request}, extra={'spider': spider}) + msg = ( + "Filtered duplicate request: %(request)s" + " - no more duplicates will be shown" + " (see DUPEFILTER_DEBUG to show all duplicates)" + ) + self.logger.debug(msg, {"request": request}, extra={"spider": spider}) self.logdupes = False - spider.crawler.stats.inc_value('dupefilter/filtered', spider=spider) + spider.crawler.stats.inc_value("dupefilter/filtered", spider=spider) diff --git a/scrapy/exceptions.py b/scrapy/exceptions.py index 0c410f035..7f202b8b8 100644 --- a/scrapy/exceptions.py +++ b/scrapy/exceptions.py @@ -10,6 +10,7 @@ new exceptions here without documenting them there. class NotConfigured(Exception): """Indicates a missing configuration situation""" + pass @@ -18,6 +19,7 @@ class _InvalidOutput(TypeError): Indicates an invalid value has been returned by a middleware's processing method. Internal and undocumented, it should not be raised or caught by user code. """ + pass @@ -30,13 +32,14 @@ class IgnoreRequest(Exception): class DontCloseSpider(Exception): """Request the spider not to be closed yet""" + pass class CloseSpider(Exception): """Raise this from callbacks to request the spider to be closed""" - def __init__(self, reason='cancelled'): + def __init__(self, reason="cancelled"): super().__init__() self.reason = reason @@ -58,11 +61,13 @@ class StopDownload(Exception): class DropItem(Exception): """Drop item from the item pipeline""" + pass class NotSupported(Exception): """Indicates a feature or method is not supported""" + pass @@ -73,7 +78,7 @@ class UsageError(Exception): """To indicate a command-line usage error""" def __init__(self, *a, **kw): - self.print_help = kw.pop('print_help', True) + self.print_help = kw.pop("print_help", True) super().__init__(*a, **kw) @@ -81,9 +86,11 @@ class ScrapyDeprecationWarning(Warning): """Warning category for deprecated features, since the default DeprecationWarning is silenced on Python 2.7+ """ + pass class ContractFail(AssertionError): """Error raised in case of a failing contract""" + pass diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 2135c3bbc..7d9a9b6ff 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -19,13 +19,19 @@ from scrapy.utils.python import is_listlike, to_bytes, to_unicode from scrapy.utils.serialize import ScrapyJSONEncoder -__all__ = ['BaseItemExporter', 'PprintItemExporter', 'PickleItemExporter', - 'CsvItemExporter', 'XmlItemExporter', 'JsonLinesItemExporter', - 'JsonItemExporter', 'MarshalItemExporter'] +__all__ = [ + "BaseItemExporter", + "PprintItemExporter", + "PickleItemExporter", + "CsvItemExporter", + "XmlItemExporter", + "JsonLinesItemExporter", + "JsonItemExporter", + "MarshalItemExporter", +] class BaseItemExporter: - def __init__(self, *, dont_fail=False, **kwargs): self._kwargs = kwargs self._configure(kwargs, dont_fail=dont_fail) @@ -35,10 +41,10 @@ class BaseItemExporter: If dont_fail is set, it won't raise an exception on unexpected options (useful for using with keyword arguments in subclasses ``__init__`` methods) """ - self.encoding = options.pop('encoding', None) - self.fields_to_export = options.pop('fields_to_export', None) - self.export_empty_fields = options.pop('export_empty_fields', False) - self.indent = options.pop('indent', None) + self.encoding = options.pop("encoding", None) + self.fields_to_export = options.pop("fields_to_export", None) + self.export_empty_fields = options.pop("export_empty_fields", False) + self.indent = options.pop("indent", None) if not dont_fail and options: raise TypeError(f"Unexpected options: {', '.join(options.keys())}") @@ -46,7 +52,7 @@ class BaseItemExporter: raise NotImplementedError def serialize_field(self, field, name, value): - serializer = field.get('serializer', lambda x: x) + serializer = field.get("serializer", lambda x: x) return serializer(value) def start_exporting(self): @@ -74,8 +80,7 @@ class BaseItemExporter: field_iter = self.fields_to_export.items() else: field_iter = ( - (x, y) for x, y in self.fields_to_export.items() - if x in item + (x, y) for x, y in self.fields_to_export.items() if x in item ) else: if include_empty: @@ -98,36 +103,36 @@ class BaseItemExporter: class JsonLinesItemExporter(BaseItemExporter): - def __init__(self, file, **kwargs): super().__init__(dont_fail=True, **kwargs) self.file = file - self._kwargs.setdefault('ensure_ascii', not self.encoding) + self._kwargs.setdefault("ensure_ascii", not self.encoding) self.encoder = ScrapyJSONEncoder(**self._kwargs) def export_item(self, item): itemdict = dict(self._get_serialized_fields(item)) - data = self.encoder.encode(itemdict) + '\n' + data = self.encoder.encode(itemdict) + "\n" self.file.write(to_bytes(data, self.encoding)) class JsonItemExporter(BaseItemExporter): - def __init__(self, file, **kwargs): super().__init__(dont_fail=True, **kwargs) self.file = file # there is a small difference between the behaviour or JsonItemExporter.indent # and ScrapyJSONEncoder.indent. ScrapyJSONEncoder.indent=None is needed to prevent # the addition of newlines everywhere - json_indent = self.indent if self.indent is not None and self.indent > 0 else None - self._kwargs.setdefault('indent', json_indent) - self._kwargs.setdefault('ensure_ascii', not self.encoding) + json_indent = ( + self.indent if self.indent is not None and self.indent > 0 else None + ) + self._kwargs.setdefault("indent", json_indent) + self._kwargs.setdefault("ensure_ascii", not self.encoding) self.encoder = ScrapyJSONEncoder(**self._kwargs) self.first_item = True def _beautify_newline(self): if self.indent is not None: - self.file.write(b'\n') + self.file.write(b"\n") def start_exporting(self): self.file.write(b"[") @@ -141,7 +146,7 @@ class JsonItemExporter(BaseItemExporter): if self.first_item: self.first_item = False else: - self.file.write(b',') + self.file.write(b",") self._beautify_newline() itemdict = dict(self._get_serialized_fields(item)) data = self.encoder.encode(itemdict) @@ -149,22 +154,21 @@ class JsonItemExporter(BaseItemExporter): class XmlItemExporter(BaseItemExporter): - def __init__(self, file, **kwargs): - self.item_element = kwargs.pop('item_element', 'item') - self.root_element = kwargs.pop('root_element', 'items') + self.item_element = kwargs.pop("item_element", "item") + self.root_element = kwargs.pop("root_element", "items") super().__init__(**kwargs) if not self.encoding: - self.encoding = 'utf-8' + self.encoding = "utf-8" self.xg = XMLGenerator(file, encoding=self.encoding) def _beautify_newline(self, new_item=False): if self.indent is not None and (self.indent > 0 or new_item): - self.xg.characters('\n') + self.xg.characters("\n") def _beautify_indent(self, depth=1): if self.indent: - self.xg.characters(' ' * self.indent * depth) + self.xg.characters(" " * self.indent * depth) def start_exporting(self): self.xg.startDocument() @@ -175,7 +179,7 @@ class XmlItemExporter(BaseItemExporter): self._beautify_indent(depth=1) self.xg.startElement(self.item_element, {}) self._beautify_newline() - for name, value in self._get_serialized_fields(item, default_value=''): + for name, value in self._get_serialized_fields(item, default_value=""): self._export_xml_field(name, value, depth=2) self._beautify_indent(depth=1) self.xg.endElement(self.item_element) @@ -188,7 +192,7 @@ class XmlItemExporter(BaseItemExporter): def _export_xml_field(self, name, serialized_value, depth): self._beautify_indent(depth=depth) self.xg.startElement(name, {}) - if hasattr(serialized_value, 'items'): + if hasattr(serialized_value, "items"): self._beautify_newline() for subname, value in serialized_value.items(): self._export_xml_field(subname, value, depth=depth + 1) @@ -196,7 +200,7 @@ class XmlItemExporter(BaseItemExporter): elif is_listlike(serialized_value): self._beautify_newline() for value in serialized_value: - self._export_xml_field('value', value, depth=depth + 1) + self._export_xml_field("value", value, depth=depth + 1) self._beautify_indent(depth=depth) elif isinstance(serialized_value, str): self.xg.characters(serialized_value) @@ -207,18 +211,24 @@ class XmlItemExporter(BaseItemExporter): class CsvItemExporter(BaseItemExporter): - - def __init__(self, file, include_headers_line=True, join_multivalued=',', errors=None, **kwargs): + def __init__( + self, + file, + include_headers_line=True, + join_multivalued=",", + errors=None, + **kwargs, + ): super().__init__(dont_fail=True, **kwargs) if not self.encoding: - self.encoding = 'utf-8' + self.encoding = "utf-8" self.include_headers_line = include_headers_line self.stream = io.TextIOWrapper( file, line_buffering=False, write_through=True, encoding=self.encoding, - newline='', # Windows needs this https://github.com/scrapy/scrapy/issues/3034 + newline="", # Windows needs this https://github.com/scrapy/scrapy/issues/3034 errors=errors, ) self.csv_writer = csv.writer(self.stream, **self._kwargs) @@ -226,7 +236,7 @@ class CsvItemExporter(BaseItemExporter): self._join_multivalued = join_multivalued def serialize_field(self, field, name, value): - serializer = field.get('serializer', self._join_if_needed) + serializer = field.get("serializer", self._join_if_needed) return serializer(value) def _join_if_needed(self, value): @@ -242,8 +252,7 @@ class CsvItemExporter(BaseItemExporter): self._headers_not_written = False self._write_headers_and_set_fields_to_export(item) - fields = self._get_serialized_fields(item, default_value='', - include_empty=True) + fields = self._get_serialized_fields(item, default_value="", include_empty=True) values = list(self._build_row(x for _, x in fields)) self.csv_writer.writerow(values) @@ -268,7 +277,6 @@ class CsvItemExporter(BaseItemExporter): class PickleItemExporter(BaseItemExporter): - def __init__(self, file, protocol=4, **kwargs): super().__init__(**kwargs) self.file = file @@ -297,14 +305,13 @@ class MarshalItemExporter(BaseItemExporter): class PprintItemExporter(BaseItemExporter): - def __init__(self, file, **kwargs): super().__init__(**kwargs) self.file = file def export_item(self, item): itemdict = dict(self._get_serialized_fields(item)) - self.file.write(to_bytes(pprint.pformat(itemdict) + '\n')) + self.file.write(to_bytes(pprint.pformat(itemdict) + "\n")) class PythonItemExporter(BaseItemExporter): @@ -318,17 +325,18 @@ class PythonItemExporter(BaseItemExporter): """ def _configure(self, options, dont_fail=False): - self.binary = options.pop('binary', True) + self.binary = options.pop("binary", True) super()._configure(options, dont_fail) if self.binary: warnings.warn( "PythonItemExporter will drop support for binary export in the future", - ScrapyDeprecationWarning) + ScrapyDeprecationWarning, + ) if not self.encoding: - self.encoding = 'utf-8' + self.encoding = "utf-8" def serialize_field(self, field, name, value): - serializer = field.get('serializer', self._serialize_value) + serializer = field.get("serializer", self._serialize_value) return serializer(value) def _serialize_value(self, value): diff --git a/scrapy/extension.py b/scrapy/extension.py index 050b87e5f..89f6a694d 100644 --- a/scrapy/extension.py +++ b/scrapy/extension.py @@ -9,8 +9,8 @@ from scrapy.utils.conf import build_component_list class ExtensionManager(MiddlewareManager): - component_name = 'extension' + component_name = "extension" @classmethod def _get_mwlist_from_settings(cls, settings): - return build_component_list(settings.getwithbase('EXTENSIONS')) + return build_component_list(settings.getwithbase("EXTENSIONS")) diff --git a/scrapy/extensions/closespider.py b/scrapy/extensions/closespider.py index 812844c0a..bb6f832f2 100644 --- a/scrapy/extensions/closespider.py +++ b/scrapy/extensions/closespider.py @@ -11,15 +11,14 @@ from scrapy.exceptions import NotConfigured class CloseSpider: - def __init__(self, crawler): self.crawler = crawler self.close_on = { - 'timeout': crawler.settings.getfloat('CLOSESPIDER_TIMEOUT'), - 'itemcount': crawler.settings.getint('CLOSESPIDER_ITEMCOUNT'), - 'pagecount': crawler.settings.getint('CLOSESPIDER_PAGECOUNT'), - 'errorcount': crawler.settings.getint('CLOSESPIDER_ERRORCOUNT'), + "timeout": crawler.settings.getfloat("CLOSESPIDER_TIMEOUT"), + "itemcount": crawler.settings.getint("CLOSESPIDER_ITEMCOUNT"), + "pagecount": crawler.settings.getint("CLOSESPIDER_PAGECOUNT"), + "errorcount": crawler.settings.getint("CLOSESPIDER_ERRORCOUNT"), } if not any(self.close_on.values()): @@ -27,13 +26,13 @@ class CloseSpider: self.counter = defaultdict(int) - if self.close_on.get('errorcount'): + if self.close_on.get("errorcount"): crawler.signals.connect(self.error_count, signal=signals.spider_error) - if self.close_on.get('pagecount'): + if self.close_on.get("pagecount"): crawler.signals.connect(self.page_count, signal=signals.response_received) - if self.close_on.get('timeout'): + if self.close_on.get("timeout"): crawler.signals.connect(self.spider_opened, signal=signals.spider_opened) - if self.close_on.get('itemcount'): + if self.close_on.get("itemcount"): crawler.signals.connect(self.item_scraped, signal=signals.item_scraped) crawler.signals.connect(self.spider_closed, signal=signals.spider_closed) @@ -42,27 +41,31 @@ class CloseSpider: return cls(crawler) def error_count(self, failure, response, spider): - self.counter['errorcount'] += 1 - if self.counter['errorcount'] == self.close_on['errorcount']: - self.crawler.engine.close_spider(spider, 'closespider_errorcount') + self.counter["errorcount"] += 1 + if self.counter["errorcount"] == self.close_on["errorcount"]: + self.crawler.engine.close_spider(spider, "closespider_errorcount") def page_count(self, response, request, spider): - self.counter['pagecount'] += 1 - if self.counter['pagecount'] == self.close_on['pagecount']: - self.crawler.engine.close_spider(spider, 'closespider_pagecount') + self.counter["pagecount"] += 1 + if self.counter["pagecount"] == self.close_on["pagecount"]: + self.crawler.engine.close_spider(spider, "closespider_pagecount") def spider_opened(self, spider): from twisted.internet import reactor - self.task = reactor.callLater(self.close_on['timeout'], - self.crawler.engine.close_spider, spider, - reason='closespider_timeout') + + self.task = reactor.callLater( + self.close_on["timeout"], + self.crawler.engine.close_spider, + spider, + reason="closespider_timeout", + ) def item_scraped(self, item, spider): - self.counter['itemcount'] += 1 - if self.counter['itemcount'] == self.close_on['itemcount']: - self.crawler.engine.close_spider(spider, 'closespider_itemcount') + self.counter["itemcount"] += 1 + if self.counter["itemcount"] == self.close_on["itemcount"]: + self.crawler.engine.close_spider(spider, "closespider_itemcount") def spider_closed(self, spider): - task = getattr(self, 'task', False) + task = getattr(self, "task", False) if task and task.active(): task.cancel() diff --git a/scrapy/extensions/corestats.py b/scrapy/extensions/corestats.py index 675f8276f..30c987253 100644 --- a/scrapy/extensions/corestats.py +++ b/scrapy/extensions/corestats.py @@ -7,7 +7,6 @@ from scrapy import signals class CoreStats: - def __init__(self, stats): self.stats = stats self.start_time = None @@ -24,23 +23,25 @@ class CoreStats: def spider_opened(self, spider): self.start_time = datetime.utcnow() - self.stats.set_value('start_time', self.start_time, spider=spider) + self.stats.set_value("start_time", self.start_time, spider=spider) def spider_closed(self, spider, reason): finish_time = datetime.utcnow() elapsed_time = finish_time - self.start_time elapsed_time_seconds = elapsed_time.total_seconds() - self.stats.set_value('elapsed_time_seconds', elapsed_time_seconds, spider=spider) - self.stats.set_value('finish_time', finish_time, spider=spider) - self.stats.set_value('finish_reason', reason, spider=spider) + self.stats.set_value( + "elapsed_time_seconds", elapsed_time_seconds, spider=spider + ) + self.stats.set_value("finish_time", finish_time, spider=spider) + self.stats.set_value("finish_reason", reason, spider=spider) def item_scraped(self, item, spider): - self.stats.inc_value('item_scraped_count', spider=spider) + self.stats.inc_value("item_scraped_count", spider=spider) def response_received(self, spider): - self.stats.inc_value('response_received_count', spider=spider) + self.stats.inc_value("response_received_count", spider=spider) def item_dropped(self, item, spider, exception): reason = exception.__class__.__name__ - self.stats.inc_value('item_dropped_count', spider=spider) - self.stats.inc_value(f'item_dropped_reasons_count/{reason}', spider=spider) + self.stats.inc_value("item_dropped_count", spider=spider) + self.stats.inc_value(f"item_dropped_reasons_count/{reason}", spider=spider) diff --git a/scrapy/extensions/debug.py b/scrapy/extensions/debug.py index fd2a02d8d..8628b4a1e 100644 --- a/scrapy/extensions/debug.py +++ b/scrapy/extensions/debug.py @@ -18,7 +18,6 @@ logger = logging.getLogger(__name__) class StackTraceDump: - def __init__(self, crawler=None): self.crawler = crawler try: @@ -34,20 +33,23 @@ class StackTraceDump: def dump_stacktrace(self, signum, frame): log_args = { - 'stackdumps': self._thread_stacks(), - 'enginestatus': format_engine_status(self.crawler.engine), - 'liverefs': format_live_refs(), + "stackdumps": self._thread_stacks(), + "enginestatus": format_engine_status(self.crawler.engine), + "liverefs": format_live_refs(), } - logger.info("Dumping stack trace and engine status\n" - "%(enginestatus)s\n%(liverefs)s\n%(stackdumps)s", - log_args, extra={'crawler': self.crawler}) + logger.info( + "Dumping stack trace and engine status\n" + "%(enginestatus)s\n%(liverefs)s\n%(stackdumps)s", + log_args, + extra={"crawler": self.crawler}, + ) def _thread_stacks(self): id2name = dict((th.ident, th.name) for th in threading.enumerate()) - dumps = '' + dumps = "" for id_, frame in sys._current_frames().items(): - name = id2name.get(id_, '') - dump = ''.join(traceback.format_stack(frame)) + name = id2name.get(id_, "") + dump = "".join(traceback.format_stack(frame)) dumps += f"# Thread: {name}({id_})\n{dump}\n" return dumps diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index 0aa27e417..ca4d77a35 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -34,15 +34,15 @@ logger = logging.getLogger(__name__) def build_storage(builder, uri, *args, feed_options=None, preargs=(), **kwargs): argument_names = get_func_args(builder) - if 'feed_options' in argument_names: - kwargs['feed_options'] = feed_options + if "feed_options" in argument_names: + kwargs["feed_options"] = feed_options else: warnings.warn( f"{builder.__qualname__} does not support the 'feed_options' keyword argument. Add a " "'feed_options' parameter to its signature to remove this " "warning. This parameter will become mandatory in a future " "version of Scrapy.", - category=ScrapyDeprecationWarning + category=ScrapyDeprecationWarning, ) return builder(*preargs, uri, *args, **kwargs) @@ -55,6 +55,7 @@ class ItemFilter: :param feed_options: feed specific options passed from FeedExporter :type feed_options: dict """ + feed_options: Optional[dict] item_classes: Tuple @@ -62,7 +63,8 @@ class ItemFilter: self.feed_options = feed_options if feed_options is not None: self.item_classes = tuple( - load_object(item_class) for item_class in feed_options.get("item_classes") or () + load_object(item_class) + for item_class in feed_options.get("item_classes") or () ) else: self.item_classes = tuple() @@ -98,13 +100,12 @@ class IFeedStorage(Interface): @implementer(IFeedStorage) class BlockingFeedStorage: - def open(self, spider): - path = spider.crawler.settings['FEED_TEMPDIR'] + path = spider.crawler.settings["FEED_TEMPDIR"] if path and not Path(path).is_dir(): - raise OSError('Not a Directory: ' + str(path)) + raise OSError("Not a Directory: " + str(path)) - return NamedTemporaryFile(prefix='feed-', dir=path) + return NamedTemporaryFile(prefix="feed-", dir=path) def store(self, file): return threads.deferToThread(self._store_in_thread, file) @@ -115,16 +116,17 @@ class BlockingFeedStorage: @implementer(IFeedStorage) class StdoutFeedStorage: - def __init__(self, uri, _stdout=None, *, feed_options=None): if not _stdout: _stdout = sys.stdout.buffer self._stdout = _stdout - if feed_options and feed_options.get('overwrite', False) is True: - logger.warning('Standard output (stdout) storage does not support ' - 'overwriting. To suppress this warning, remove the ' - 'overwrite option from your FEEDS setting, or set ' - 'it to False.') + if feed_options and feed_options.get("overwrite", False) is True: + logger.warning( + "Standard output (stdout) storage does not support " + "overwriting. To suppress this warning, remove the " + "overwrite option from your FEEDS setting, or set " + "it to False." + ) def open(self, spider): return self._stdout @@ -135,11 +137,10 @@ class StdoutFeedStorage: @implementer(IFeedStorage) class FileFeedStorage: - def __init__(self, uri, *, feed_options=None): self.path = file_uri_to_path(uri) feed_options = feed_options or {} - self.write_mode = 'wb' if feed_options.get('overwrite', False) else 'ab' + self.write_mode = "wb" if feed_options.get("overwrite", False) else "ab" def open(self, spider) -> IO[Any]: dirname = Path(self.path).parent @@ -152,11 +153,19 @@ class FileFeedStorage: class S3FeedStorage(BlockingFeedStorage): - - def __init__(self, uri, access_key=None, secret_key=None, acl=None, endpoint_url=None, *, - feed_options=None, session_token=None): + def __init__( + self, + uri, + access_key=None, + secret_key=None, + acl=None, + endpoint_url=None, + *, + feed_options=None, + session_token=None, + ): if not is_botocore_available(): - raise NotConfigured('missing botocore library') + raise NotConfigured("missing botocore library") u = urlparse(uri) self.bucketname = u.hostname self.access_key = u.username or access_key @@ -166,41 +175,45 @@ class S3FeedStorage(BlockingFeedStorage): self.acl = acl self.endpoint_url = endpoint_url import botocore.session + session = botocore.session.get_session() self.s3_client = session.create_client( - 's3', aws_access_key_id=self.access_key, + "s3", + aws_access_key_id=self.access_key, aws_secret_access_key=self.secret_key, aws_session_token=self.session_token, - endpoint_url=self.endpoint_url) - if feed_options and feed_options.get('overwrite', True) is False: - logger.warning('S3 does not support appending to files. To ' - 'suppress this warning, remove the overwrite ' - 'option from your FEEDS setting or set it to True.') + endpoint_url=self.endpoint_url, + ) + if feed_options and feed_options.get("overwrite", True) is False: + logger.warning( + "S3 does not support appending to files. To " + "suppress this warning, remove the overwrite " + "option from your FEEDS setting or set it to True." + ) @classmethod def from_crawler(cls, crawler, uri, *, feed_options=None): return build_storage( cls, uri, - access_key=crawler.settings['AWS_ACCESS_KEY_ID'], - secret_key=crawler.settings['AWS_SECRET_ACCESS_KEY'], - session_token=crawler.settings['AWS_SESSION_TOKEN'], - acl=crawler.settings['FEED_STORAGE_S3_ACL'] or None, - endpoint_url=crawler.settings['AWS_ENDPOINT_URL'] or None, + access_key=crawler.settings["AWS_ACCESS_KEY_ID"], + secret_key=crawler.settings["AWS_SECRET_ACCESS_KEY"], + session_token=crawler.settings["AWS_SESSION_TOKEN"], + acl=crawler.settings["FEED_STORAGE_S3_ACL"] or None, + endpoint_url=crawler.settings["AWS_ENDPOINT_URL"] or None, feed_options=feed_options, ) def _store_in_thread(self, file): file.seek(0) - kwargs = {'ACL': self.acl} if self.acl else {} + kwargs = {"ACL": self.acl} if self.acl else {} self.s3_client.put_object( - Bucket=self.bucketname, Key=self.keyname, Body=file, - **kwargs) + Bucket=self.bucketname, Key=self.keyname, Body=file, **kwargs + ) file.close() class GCSFeedStorage(BlockingFeedStorage): - def __init__(self, uri, project_id, acl): self.project_id = project_id self.acl = acl @@ -212,13 +225,14 @@ class GCSFeedStorage(BlockingFeedStorage): def from_crawler(cls, crawler, uri): return cls( uri, - crawler.settings['GCS_PROJECT_ID'], - crawler.settings['FEED_STORAGE_GCS_ACL'] or None + crawler.settings["GCS_PROJECT_ID"], + crawler.settings["FEED_STORAGE_GCS_ACL"] or None, ) def _store_in_thread(self, file): file.seek(0) from google.cloud.storage import Client + client = Client(project=self.project_id) bucket = client.get_bucket(self.bucket_name) blob = bucket.blob(self.blob_name) @@ -226,37 +240,51 @@ class GCSFeedStorage(BlockingFeedStorage): class FTPFeedStorage(BlockingFeedStorage): - def __init__(self, uri, use_active_mode=False, *, feed_options=None): u = urlparse(uri) self.host = u.hostname - self.port = int(u.port or '21') + self.port = int(u.port or "21") self.username = u.username - self.password = unquote(u.password or '') + self.password = unquote(u.password or "") self.path = u.path self.use_active_mode = use_active_mode - self.overwrite = not feed_options or feed_options.get('overwrite', True) + self.overwrite = not feed_options or feed_options.get("overwrite", True) @classmethod def from_crawler(cls, crawler, uri, *, feed_options=None): return build_storage( cls, uri, - crawler.settings.getbool('FEED_STORAGE_FTP_ACTIVE'), + crawler.settings.getbool("FEED_STORAGE_FTP_ACTIVE"), feed_options=feed_options, ) def _store_in_thread(self, file): ftp_store_file( - path=self.path, file=file, host=self.host, - port=self.port, username=self.username, - password=self.password, use_active_mode=self.use_active_mode, + path=self.path, + file=file, + host=self.host, + port=self.port, + username=self.username, + password=self.password, + use_active_mode=self.use_active_mode, overwrite=self.overwrite, ) class _FeedSlot: - def __init__(self, file, exporter, storage, uri, format, store_empty, batch_id, uri_template, filter): + def __init__( + self, + file, + exporter, + storage, + uri, + format, + store_empty, + batch_id, + uri_template, + filter, + ): self.file = file self.exporter = exporter self.storage = storage @@ -283,7 +311,6 @@ class _FeedSlot: class FeedExporter: - @classmethod def from_crawler(cls, crawler): exporter = cls(crawler) @@ -299,48 +326,55 @@ class FeedExporter: self.slots = [] self.filters = {} - if not self.settings['FEEDS'] and not self.settings['FEED_URI']: + if not self.settings["FEEDS"] and not self.settings["FEED_URI"]: raise NotConfigured # Begin: Backward compatibility for FEED_URI and FEED_FORMAT settings - if self.settings['FEED_URI']: + if self.settings["FEED_URI"]: warnings.warn( - 'The `FEED_URI` and `FEED_FORMAT` settings have been deprecated in favor of ' - 'the `FEEDS` setting. Please see the `FEEDS` setting docs for more details', - category=ScrapyDeprecationWarning, stacklevel=2, + "The `FEED_URI` and `FEED_FORMAT` settings have been deprecated in favor of " + "the `FEEDS` setting. Please see the `FEEDS` setting docs for more details", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) + uri = str(self.settings["FEED_URI"]) # handle pathlib.Path objects + feed_options = {"format": self.settings.get("FEED_FORMAT", "jsonlines")} + self.feeds[uri] = feed_complete_default_values_from_settings( + feed_options, self.settings ) - uri = str(self.settings['FEED_URI']) # handle pathlib.Path objects - feed_options = {'format': self.settings.get('FEED_FORMAT', 'jsonlines')} - self.feeds[uri] = feed_complete_default_values_from_settings(feed_options, self.settings) self.filters[uri] = self._load_filter(feed_options) # End: Backward compatibility for FEED_URI and FEED_FORMAT settings # 'FEEDS' setting takes precedence over 'FEED_URI' - for uri, feed_options in self.settings.getdict('FEEDS').items(): + for uri, feed_options in self.settings.getdict("FEEDS").items(): uri = str(uri) # handle pathlib.Path objects - self.feeds[uri] = feed_complete_default_values_from_settings(feed_options, self.settings) + self.feeds[uri] = feed_complete_default_values_from_settings( + feed_options, self.settings + ) self.filters[uri] = self._load_filter(feed_options) - self.storages = self._load_components('FEED_STORAGES') - self.exporters = self._load_components('FEED_EXPORTERS') + self.storages = self._load_components("FEED_STORAGES") + self.exporters = self._load_components("FEED_EXPORTERS") for uri, feed_options in self.feeds.items(): if not self._storage_supported(uri, feed_options): raise NotConfigured if not self._settings_are_valid(): raise NotConfigured - if not self._exporter_supported(feed_options['format']): + if not self._exporter_supported(feed_options["format"]): raise NotConfigured def open_spider(self, spider): for uri, feed_options in self.feeds.items(): - uri_params = self._get_uri_params(spider, feed_options['uri_params']) - self.slots.append(self._start_new_batch( - batch_id=1, - uri=uri % uri_params, - feed_options=feed_options, - spider=spider, - uri_template=uri, - )) + uri_params = self._get_uri_params(spider, feed_options["uri_params"]) + self.slots.append( + self._start_new_batch( + batch_id=1, + uri=uri % uri_params, + feed_options=feed_options, + spider=spider, + uri_template=uri, + ) + ) def close_spider(self, spider): deferred_list = [] @@ -368,16 +402,15 @@ class FeedExporter: def _handle_store_error(self, f, logmsg, spider, slot_type): logger.error( - "Error storing %s", logmsg, - exc_info=failure_to_exc_info(f), extra={'spider': spider} + "Error storing %s", + logmsg, + exc_info=failure_to_exc_info(f), + extra={"spider": spider}, ) self.crawler.stats.inc_value(f"feedexport/failed_count/{slot_type}") def _handle_store_success(self, f, logmsg, spider, slot_type): - logger.info( - "Stored %s", logmsg, - extra={'spider': spider} - ) + logger.info("Stored %s", logmsg, extra={"spider": spider}) self.crawler.stats.inc_value(f"feedexport/success_count/{slot_type}") def _start_new_batch(self, batch_id, uri, feed_options, spider, uri_template): @@ -393,26 +426,28 @@ class FeedExporter: storage = self._get_storage(uri, feed_options) file = storage.open(spider) if "postprocessing" in feed_options: - file = PostProcessingManager(feed_options["postprocessing"], file, feed_options) + file = PostProcessingManager( + feed_options["postprocessing"], file, feed_options + ) exporter = self._get_exporter( file=file, - format=feed_options['format'], - fields_to_export=feed_options['fields'], - encoding=feed_options['encoding'], - indent=feed_options['indent'], - **feed_options['item_export_kwargs'], + format=feed_options["format"], + fields_to_export=feed_options["fields"], + encoding=feed_options["encoding"], + indent=feed_options["indent"], + **feed_options["item_export_kwargs"], ) slot = _FeedSlot( file=file, exporter=exporter, storage=storage, uri=uri, - format=feed_options['format'], - store_empty=feed_options['store_empty'], + format=feed_options["format"], + store_empty=feed_options["store_empty"], batch_id=batch_id, uri_template=uri_template, - filter=self.filters[uri_template] + filter=self.filters[uri_template], ) if slot.store_empty: slot.start_exporting() @@ -422,7 +457,9 @@ class FeedExporter: slots = [] for slot in self.slots: if not slot.filter.accepts(item): - slots.append(slot) # if slot doesn't accept item, continue with next slot + slots.append( + slot + ) # if slot doesn't accept item, continue with next slot continue slot.start_exporting() @@ -430,18 +467,22 @@ class FeedExporter: slot.itemcount += 1 # create new slot for each slot with itemcount == FEED_EXPORT_BATCH_ITEM_COUNT and close the old one if ( - self.feeds[slot.uri_template]['batch_item_count'] - and slot.itemcount >= self.feeds[slot.uri_template]['batch_item_count'] + self.feeds[slot.uri_template]["batch_item_count"] + and slot.itemcount >= self.feeds[slot.uri_template]["batch_item_count"] ): - uri_params = self._get_uri_params(spider, self.feeds[slot.uri_template]['uri_params'], slot) + uri_params = self._get_uri_params( + spider, self.feeds[slot.uri_template]["uri_params"], slot + ) self._close_slot(slot, spider) - slots.append(self._start_new_batch( - batch_id=slot.batch_id + 1, - uri=slot.uri_template % uri_params, - feed_options=self.feeds[slot.uri_template], - spider=spider, - uri_template=slot.uri_template, - )) + slots.append( + self._start_new_batch( + batch_id=slot.batch_id + 1, + uri=slot.uri_template % uri_params, + feed_options=self.feeds[slot.uri_template], + spider=spider, + uri_template=slot.uri_template, + ) + ) else: slots.append(slot) self.slots = slots @@ -459,7 +500,7 @@ class FeedExporter: def _exporter_supported(self, format): if format in self.exporters: return True - logger.error("Unknown feed format: %(format)s", {'format': format}) + logger.error("Unknown feed format: %(format)s", {"format": format}) def _settings_are_valid(self): """ @@ -467,12 +508,14 @@ class FeedExporter: %(batch_time)s or %(batch_id)d to distinguish different files of partial output """ for uri_template, values in self.feeds.items(): - if values['batch_item_count'] and not re.search(r'%\(batch_time\)s|%\(batch_id\)', uri_template): + if values["batch_item_count"] and not re.search( + r"%\(batch_time\)s|%\(batch_id\)", uri_template + ): logger.error( - '%%(batch_time)s or %%(batch_id)d must be in the feed URI (%s) if FEED_EXPORT_BATCH_ITEM_COUNT ' - 'setting or FEEDS.batch_item_count is specified and greater than 0. For more info see: ' - 'https://docs.scrapy.org/en/latest/topics/feed-exports.html#feed-export-batch-item-count', - uri_template + "%%(batch_time)s or %%(batch_id)d must be in the feed URI (%s) if FEED_EXPORT_BATCH_ITEM_COUNT " + "setting or FEEDS.batch_item_count is specified and greater than 0. For more info see: " + "https://docs.scrapy.org/en/latest/topics/feed-exports.html#feed-export-batch-item-count", + uri_template, ) return False return True @@ -484,17 +527,17 @@ class FeedExporter: self._get_storage(uri, feed_options) return True except NotConfigured as e: - logger.error("Disabled feed storage scheme: %(scheme)s. " - "Reason: %(reason)s", - {'scheme': scheme, 'reason': str(e)}) + logger.error( + "Disabled feed storage scheme: %(scheme)s. " "Reason: %(reason)s", + {"scheme": scheme, "reason": str(e)}, + ) else: - logger.error("Unknown feed storage scheme: %(scheme)s", - {'scheme': scheme}) + logger.error("Unknown feed storage scheme: %(scheme)s", {"scheme": scheme}) def _get_instance(self, objcls, *args, **kwargs): return create_instance( - objcls, self.settings, getattr(self, 'crawler', None), - *args, **kwargs) + objcls, self.settings, getattr(self, "crawler", None), *args, **kwargs + ) def _get_exporter(self, file, format, *args, **kwargs): return self._get_instance(self.exporters[format], file, *args, **kwargs) @@ -506,20 +549,22 @@ class FeedExporter: do not support it, and issuing a deprecation warning instead. """ feedcls = self.storages[urlparse(uri).scheme] - crawler = getattr(self, 'crawler', None) + crawler = getattr(self, "crawler", None) def build_instance(builder, *preargs): - return build_storage(builder, uri, feed_options=feed_options, preargs=preargs) + return build_storage( + builder, uri, feed_options=feed_options, preargs=preargs + ) - if crawler and hasattr(feedcls, 'from_crawler'): + if crawler and hasattr(feedcls, "from_crawler"): instance = build_instance(feedcls.from_crawler, crawler) - method_name = 'from_crawler' - elif hasattr(feedcls, 'from_settings'): + method_name = "from_crawler" + elif hasattr(feedcls, "from_settings"): instance = build_instance(feedcls.from_settings, self.settings) - method_name = 'from_settings' + method_name = "from_settings" else: instance = build_instance(feedcls) - method_name = '__new__' + method_name = "__new__" if instance is None: raise TypeError(f"{feedcls.__qualname__}.{method_name} returned None") return instance @@ -534,19 +579,23 @@ class FeedExporter: for k in dir(spider): params[k] = getattr(spider, k) utc_now = datetime.utcnow() - params['time'] = utc_now.replace(microsecond=0).isoformat().replace(':', '-') - params['batch_time'] = utc_now.isoformat().replace(':', '-') - params['batch_id'] = slot.batch_id + 1 if slot is not None else 1 + params["time"] = utc_now.replace(microsecond=0).isoformat().replace(":", "-") + params["batch_time"] = utc_now.isoformat().replace(":", "-") + params["batch_id"] = slot.batch_id + 1 if slot is not None else 1 original_params = params.copy() - uripar_function = load_object(uri_params_function) if uri_params_function else lambda params, _: params + uripar_function = ( + load_object(uri_params_function) + if uri_params_function + else lambda params, _: params + ) new_params = uripar_function(params, spider) if new_params is None or original_params != params: warnings.warn( - 'Modifying the params dictionary in-place in the function defined in ' - 'the FEED_URI_PARAMS setting or in the uri_params key of the FEEDS ' - 'setting is deprecated. The function must return a new dictionary ' - 'instead.', - category=ScrapyDeprecationWarning + "Modifying the params dictionary in-place in the function defined in " + "the FEED_URI_PARAMS setting or in the uri_params key of the FEEDS " + "setting is deprecated. The function must return a new dictionary " + "instead.", + category=ScrapyDeprecationWarning, ) return new_params if new_params is not None else params diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 4e76fe5e5..3bfbddc54 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -21,10 +21,11 @@ logger = logging.getLogger(__name__) class DummyPolicy: - def __init__(self, settings): - self.ignore_schemes = settings.getlist('HTTPCACHE_IGNORE_SCHEMES') - self.ignore_http_codes = [int(x) for x in settings.getlist('HTTPCACHE_IGNORE_HTTP_CODES')] + self.ignore_schemes = settings.getlist("HTTPCACHE_IGNORE_SCHEMES") + self.ignore_http_codes = [ + int(x) for x in settings.getlist("HTTPCACHE_IGNORE_HTTP_CODES") + ] def should_cache_request(self, request): return urlparse_cached(request).scheme not in self.ignore_schemes @@ -44,16 +45,17 @@ class RFC2616Policy: MAXAGE = 3600 * 24 * 365 # one year def __init__(self, settings): - self.always_store = settings.getbool('HTTPCACHE_ALWAYS_STORE') - self.ignore_schemes = settings.getlist('HTTPCACHE_IGNORE_SCHEMES') + self.always_store = settings.getbool("HTTPCACHE_ALWAYS_STORE") + self.ignore_schemes = settings.getlist("HTTPCACHE_IGNORE_SCHEMES") self._cc_parsed = WeakKeyDictionary() self.ignore_response_cache_controls = [ - to_bytes(cc) for cc in settings.getlist('HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS') + to_bytes(cc) + for cc in settings.getlist("HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS") ] def _parse_cachecontrol(self, r): if r not in self._cc_parsed: - cch = r.headers.get(b'Cache-Control', b'') + cch = r.headers.get(b"Cache-Control", b"") parsed = parse_cachecontrol(cch) if isinstance(r, Response): for key in self.ignore_response_cache_controls: @@ -66,7 +68,7 @@ class RFC2616Policy: return False cc = self._parse_cachecontrol(request) # obey user-agent directive "Cache-Control: no-store" - if b'no-store' in cc: + if b"no-store" in cc: return False # Any other is eligible for caching return True @@ -77,7 +79,7 @@ class RFC2616Policy: # Status code 206 is not included because cache can not deal with partial contents cc = self._parse_cachecontrol(response) # obey directive "Cache-Control: no-store" - if b'no-store' in cc: + if b"no-store" in cc: return False # Never cache 304 (Not Modified) responses if response.status == 304: @@ -86,14 +88,14 @@ class RFC2616Policy: if self.always_store: return True # Any hint on response expiration is good - if b'max-age' in cc or b'Expires' in response.headers: + if b"max-age" in cc or b"Expires" in response.headers: return True # Firefox fallbacks this statuses to one year expiration if none is set if response.status in (300, 301, 308): return True # Other statuses without expiration requires at least one validator if response.status in (200, 203, 401): - return b'Last-Modified' in response.headers or b'ETag' in response.headers + return b"Last-Modified" in response.headers or b"ETag" in response.headers # Any other is probably not eligible for caching # Makes no sense to cache responses that does not contain expiration # info and can not be revalidated @@ -102,11 +104,13 @@ class RFC2616Policy: def is_cached_response_fresh(self, cachedresponse, request): cc = self._parse_cachecontrol(cachedresponse) ccreq = self._parse_cachecontrol(request) - if b'no-cache' in cc or b'no-cache' in ccreq: + if b"no-cache" in cc or b"no-cache" in ccreq: return False now = time() - freshnesslifetime = self._compute_freshness_lifetime(cachedresponse, request, now) + freshnesslifetime = self._compute_freshness_lifetime( + cachedresponse, request, now + ) currentage = self._compute_current_age(cachedresponse, request, now) reqmaxage = self._get_max_age(ccreq) @@ -116,7 +120,7 @@ class RFC2616Policy: if currentage < freshnesslifetime: return True - if b'max-stale' in ccreq and b'must-revalidate' not in cc: + if b"max-stale" in ccreq and b"must-revalidate" not in cc: # From RFC2616: "Indicates that the client is willing to # accept a response that has exceeded its expiration time. # If max-stale is assigned a value, then the client is @@ -124,7 +128,7 @@ class RFC2616Policy: # expiration time by no more than the specified number of # seconds. If no value is assigned to max-stale, then the # client is willing to accept a stale response of any age." - staleage = ccreq[b'max-stale'] + staleage = ccreq[b"max-stale"] if staleage is None: return True @@ -143,22 +147,24 @@ class RFC2616Policy: # as long as the old response didn't specify must-revalidate. if response.status >= 500: cc = self._parse_cachecontrol(cachedresponse) - if b'must-revalidate' not in cc: + if b"must-revalidate" not in cc: return True # Use the cached response if the server says it hasn't changed. return response.status == 304 def _set_conditional_validators(self, request, cachedresponse): - if b'Last-Modified' in cachedresponse.headers: - request.headers[b'If-Modified-Since'] = cachedresponse.headers[b'Last-Modified'] + if b"Last-Modified" in cachedresponse.headers: + request.headers[b"If-Modified-Since"] = cachedresponse.headers[ + b"Last-Modified" + ] - if b'ETag' in cachedresponse.headers: - request.headers[b'If-None-Match'] = cachedresponse.headers[b'ETag'] + if b"ETag" in cachedresponse.headers: + request.headers[b"If-None-Match"] = cachedresponse.headers[b"ETag"] def _get_max_age(self, cc): try: - return max(0, int(cc[b'max-age'])) + return max(0, int(cc[b"max-age"])) except (KeyError, ValueError): return None @@ -171,18 +177,18 @@ class RFC2616Policy: return maxage # Parse date header or synthesize it if none exists - date = rfc1123_to_epoch(response.headers.get(b'Date')) or now + date = rfc1123_to_epoch(response.headers.get(b"Date")) or now # Try HTTP/1.0 Expires header - if b'Expires' in response.headers: - expires = rfc1123_to_epoch(response.headers[b'Expires']) + if b"Expires" in response.headers: + expires = rfc1123_to_epoch(response.headers[b"Expires"]) # When parsing Expires header fails RFC 2616 section 14.21 says we # should treat this as an expiration time in the past. return max(0, expires - date) if expires else 0 # Fallback to heuristic using last-modified header # This is not in RFC but on Firefox caching implementation - lastmodified = rfc1123_to_epoch(response.headers.get(b'Last-Modified')) + lastmodified = rfc1123_to_epoch(response.headers.get(b"Last-Modified")) if lastmodified and lastmodified <= date: return (date - lastmodified) / 10 @@ -199,13 +205,13 @@ class RFC2616Policy: currentage = 0 # If Date header is not set we assume it is a fast connection, and # clock is in sync with the server - date = rfc1123_to_epoch(response.headers.get(b'Date')) or now + date = rfc1123_to_epoch(response.headers.get(b"Date")) or now if now > date: currentage = now - date - if b'Age' in response.headers: + if b"Age" in response.headers: try: - age = int(response.headers[b'Age']) + age = int(response.headers[b"Age"]) currentage = max(currentage, age) except ValueError: pass @@ -214,18 +220,21 @@ class RFC2616Policy: class DbmCacheStorage: - def __init__(self, settings): - self.cachedir = data_path(settings['HTTPCACHE_DIR'], createdir=True) - self.expiration_secs = settings.getint('HTTPCACHE_EXPIRATION_SECS') - self.dbmodule = import_module(settings['HTTPCACHE_DBM_MODULE']) + self.cachedir = data_path(settings["HTTPCACHE_DIR"], createdir=True) + self.expiration_secs = settings.getint("HTTPCACHE_EXPIRATION_SECS") + self.dbmodule = import_module(settings["HTTPCACHE_DBM_MODULE"]) self.db = None def open_spider(self, spider: Spider): - dbpath = Path(self.cachedir, f'{spider.name}.db') - self.db = self.dbmodule.open(str(dbpath), 'c') + dbpath = Path(self.cachedir, f"{spider.name}.db") + self.db = self.dbmodule.open(str(dbpath), "c") - logger.debug("Using DBM cache storage in %(cachepath)s", {'cachepath': dbpath}, extra={'spider': spider}) + logger.debug( + "Using DBM cache storage in %(cachepath)s", + {"cachepath": dbpath}, + extra={"spider": spider}, + ) self._fingerprinter = spider.crawler.request_fingerprinter @@ -236,10 +245,10 @@ class DbmCacheStorage: data = self._read_data(spider, request) if data is None: return # not cached - url = data['url'] - status = data['status'] - headers = Headers(data['headers']) - body = data['body'] + url = data["url"] + status = data["status"] + headers = Headers(data["headers"]) + body = data["body"] respcls = responsetypes.from_args(headers=headers, url=url, body=body) response = respcls(url=url, headers=headers, status=status, body=body) return response @@ -247,18 +256,18 @@ class DbmCacheStorage: def store_response(self, spider, request, response): key = self._fingerprinter.fingerprint(request).hex() data = { - 'status': response.status, - 'url': response.url, - 'headers': dict(response.headers), - 'body': response.body, + "status": response.status, + "url": response.url, + "headers": dict(response.headers), + "body": response.body, } - self.db[f'{key}_data'] = pickle.dumps(data, protocol=4) - self.db[f'{key}_time'] = str(time()) + self.db[f"{key}_data"] = pickle.dumps(data, protocol=4) + self.db[f"{key}_time"] = str(time()) def _read_data(self, spider, request): key = self._fingerprinter.fingerprint(request).hex() db = self.db - tkey = f'{key}_time' + tkey = f"{key}_time" if tkey not in db: return # not found @@ -266,20 +275,22 @@ class DbmCacheStorage: if 0 < self.expiration_secs < time() - float(ts): return # expired - return pickle.loads(db[f'{key}_data']) + return pickle.loads(db[f"{key}_data"]) class FilesystemCacheStorage: - def __init__(self, settings): - self.cachedir = data_path(settings['HTTPCACHE_DIR']) - self.expiration_secs = settings.getint('HTTPCACHE_EXPIRATION_SECS') - self.use_gzip = settings.getbool('HTTPCACHE_GZIP') + self.cachedir = data_path(settings["HTTPCACHE_DIR"]) + self.expiration_secs = settings.getint("HTTPCACHE_EXPIRATION_SECS") + self.use_gzip = settings.getbool("HTTPCACHE_GZIP") self._open = gzip.open if self.use_gzip else open def open_spider(self, spider: Spider): - logger.debug("Using filesystem cache storage in %(cachedir)s", {'cachedir': self.cachedir}, - extra={'spider': spider}) + logger.debug( + "Using filesystem cache storage in %(cachedir)s", + {"cachedir": self.cachedir}, + extra={"spider": spider}, + ) self._fingerprinter = spider.crawler.request_fingerprinter @@ -292,12 +303,12 @@ class FilesystemCacheStorage: if metadata is None: return # not cached rpath = Path(self._get_request_path(spider, request)) - with self._open(rpath / 'response_body', 'rb') as f: + with self._open(rpath / "response_body", "rb") as f: body = f.read() - with self._open(rpath / 'response_headers', 'rb') as f: + with self._open(rpath / "response_headers", "rb") as f: rawheaders = f.read() - url = metadata.get('response_url') - status = metadata['status'] + url = metadata.get("response_url") + status = metadata["status"] headers = Headers(headers_raw_to_dict(rawheaders)) respcls = responsetypes.from_args(headers=headers, url=url, body=body) response = respcls(url=url, headers=headers, status=status, body=body) @@ -309,23 +320,23 @@ class FilesystemCacheStorage: if not rpath.exists(): rpath.mkdir(parents=True) metadata = { - 'url': request.url, - 'method': request.method, - 'status': response.status, - 'response_url': response.url, - 'timestamp': time(), + "url": request.url, + "method": request.method, + "status": response.status, + "response_url": response.url, + "timestamp": time(), } - with self._open(rpath / 'meta', 'wb') as f: + with self._open(rpath / "meta", "wb") as f: f.write(to_bytes(repr(metadata))) - with self._open(rpath / 'pickled_meta', 'wb') as f: + with self._open(rpath / "pickled_meta", "wb") as f: pickle.dump(metadata, f, protocol=4) - with self._open(rpath / 'response_headers', 'wb') as f: + with self._open(rpath / "response_headers", "wb") as f: f.write(headers_dict_to_raw(response.headers)) - with self._open(rpath / 'response_body', 'wb') as f: + with self._open(rpath / "response_body", "wb") as f: f.write(response.body) - with self._open(rpath / 'request_headers', 'wb') as f: + with self._open(rpath / "request_headers", "wb") as f: f.write(headers_dict_to_raw(request.headers)) - with self._open(rpath / 'request_body', 'wb') as f: + with self._open(rpath / "request_body", "wb") as f: f.write(request.body) def _get_request_path(self, spider: Spider, request: Request) -> str: @@ -334,13 +345,13 @@ class FilesystemCacheStorage: def _read_meta(self, spider: Spider, request: Request): rpath = Path(self._get_request_path(spider, request)) - metapath = rpath / 'pickled_meta' + metapath = rpath / "pickled_meta" if not metapath.exists(): return # not found mtime = metapath.stat().st_mtime if 0 < self.expiration_secs < time() - mtime: return # expired - with self._open(metapath, 'rb') as f: + with self._open(metapath, "rb") as f: return pickle.load(f) @@ -357,8 +368,8 @@ def parse_cachecontrol(header): """ directives = {} - for directive in header.split(b','): - key, sep, val = directive.strip().partition(b'=') + for directive in header.split(b","): + key, sep, val = directive.strip().partition(b"=") if key: directives[key.lower()] = val if sep else None return directives @@ -366,7 +377,7 @@ def parse_cachecontrol(header): def rfc1123_to_epoch(date_str): try: - date_str = to_unicode(date_str, encoding='ascii') + date_str = to_unicode(date_str, encoding="ascii") return mktime_tz(parsedate_tz(date_str)) except Exception: return None diff --git a/scrapy/extensions/logstats.py b/scrapy/extensions/logstats.py index 0be2831a1..6295dcdb7 100644 --- a/scrapy/extensions/logstats.py +++ b/scrapy/extensions/logstats.py @@ -19,7 +19,7 @@ class LogStats: @classmethod def from_crawler(cls, crawler): - interval = crawler.settings.getfloat('LOGSTATS_INTERVAL') + interval = crawler.settings.getfloat("LOGSTATS_INTERVAL") if not interval: raise NotConfigured o = cls(crawler.stats, interval) @@ -35,17 +35,23 @@ class LogStats: self.task.start(self.interval) def log(self, spider): - items = self.stats.get_value('item_scraped_count', 0) - pages = self.stats.get_value('response_received_count', 0) + items = self.stats.get_value("item_scraped_count", 0) + pages = self.stats.get_value("response_received_count", 0) irate = (items - self.itemsprev) * self.multiplier prate = (pages - self.pagesprev) * self.multiplier self.pagesprev, self.itemsprev = pages, items - msg = ("Crawled %(pages)d pages (at %(pagerate)d pages/min), " - "scraped %(items)d items (at %(itemrate)d items/min)") - log_args = {'pages': pages, 'pagerate': prate, - 'items': items, 'itemrate': irate} - logger.info(msg, log_args, extra={'spider': spider}) + msg = ( + "Crawled %(pages)d pages (at %(pagerate)d pages/min), " + "scraped %(items)d items (at %(itemrate)d items/min)" + ) + log_args = { + "pages": pages, + "pagerate": prate, + "items": items, + "itemrate": irate, + } + logger.info(msg, log_args, extra={"spider": spider}) def spider_closed(self, spider, reason): if self.task and self.task.running: diff --git a/scrapy/extensions/memdebug.py b/scrapy/extensions/memdebug.py index cee44ea62..03ede0681 100644 --- a/scrapy/extensions/memdebug.py +++ b/scrapy/extensions/memdebug.py @@ -12,13 +12,12 @@ from scrapy.utils.trackref import live_refs class MemoryDebugger: - def __init__(self, stats): self.stats = stats @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('MEMDEBUG_ENABLED'): + if not crawler.settings.getbool("MEMDEBUG_ENABLED"): raise NotConfigured o = cls(crawler.stats) crawler.signals.connect(o.spider_closed, signal=signals.spider_closed) @@ -26,8 +25,12 @@ class MemoryDebugger: def spider_closed(self, spider, reason): gc.collect() - self.stats.set_value('memdebug/gc_garbage_count', len(gc.garbage), spider=spider) + self.stats.set_value( + "memdebug/gc_garbage_count", len(gc.garbage), spider=spider + ) for cls, wdict in live_refs.items(): if not wdict: continue - self.stats.set_value(f'memdebug/live_refs/{cls.__name__}', len(wdict), spider=spider) + self.stats.set_value( + f"memdebug/live_refs/{cls.__name__}", len(wdict), spider=spider + ) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index 4fdf86479..2bba71972 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -20,22 +20,23 @@ logger = logging.getLogger(__name__) class MemoryUsage: - def __init__(self, crawler): - if not crawler.settings.getbool('MEMUSAGE_ENABLED'): + if not crawler.settings.getbool("MEMUSAGE_ENABLED"): raise NotConfigured try: # stdlib's resource module is only available on unix platforms. - self.resource = import_module('resource') + self.resource = import_module("resource") except ImportError: raise NotConfigured self.crawler = crawler self.warned = False - self.notify_mails = crawler.settings.getlist('MEMUSAGE_NOTIFY_MAIL') - self.limit = crawler.settings.getint('MEMUSAGE_LIMIT_MB') * 1024 * 1024 - self.warning = crawler.settings.getint('MEMUSAGE_WARNING_MB') * 1024 * 1024 - self.check_interval = crawler.settings.getfloat('MEMUSAGE_CHECK_INTERVAL_SECONDS') + self.notify_mails = crawler.settings.getlist("MEMUSAGE_NOTIFY_MAIL") + self.limit = crawler.settings.getint("MEMUSAGE_LIMIT_MB") * 1024 * 1024 + self.warning = crawler.settings.getint("MEMUSAGE_WARNING_MB") * 1024 * 1024 + self.check_interval = crawler.settings.getfloat( + "MEMUSAGE_CHECK_INTERVAL_SECONDS" + ) self.mail = MailSender.from_settings(crawler.settings) crawler.signals.connect(self.engine_started, signal=signals.engine_started) crawler.signals.connect(self.engine_stopped, signal=signals.engine_stopped) @@ -46,13 +47,13 @@ class MemoryUsage: def get_virtual_size(self): size = self.resource.getrusage(self.resource.RUSAGE_SELF).ru_maxrss - if sys.platform != 'darwin': + if sys.platform != "darwin": # on macOS ru_maxrss is in bytes, on Linux it is in KB size *= 1024 return size def engine_started(self): - self.crawler.stats.set_value('memusage/startup', self.get_virtual_size()) + self.crawler.stats.set_value("memusage/startup", self.get_virtual_size()) self.tasks = [] tsk = task.LoopingCall(self.update) self.tasks.append(tsk) @@ -72,45 +73,56 @@ class MemoryUsage: tsk.stop() def update(self): - self.crawler.stats.max_value('memusage/max', self.get_virtual_size()) + self.crawler.stats.max_value("memusage/max", self.get_virtual_size()) def _check_limit(self): peak_mem_usage = self.get_virtual_size() if peak_mem_usage > self.limit: - self.crawler.stats.set_value('memusage/limit_reached', 1) + self.crawler.stats.set_value("memusage/limit_reached", 1) mem = self.limit / 1024 / 1024 - logger.error("Memory usage exceeded %(memusage)dMiB. Shutting down Scrapy...", - {'memusage': mem}, extra={'crawler': self.crawler}) + logger.error( + "Memory usage exceeded %(memusage)dMiB. Shutting down Scrapy...", + {"memusage": mem}, + extra={"crawler": self.crawler}, + ) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} terminated: " f"memory usage exceeded {mem}MiB at {socket.gethostname()}" ) self._send_report(self.notify_mails, subj) - self.crawler.stats.set_value('memusage/limit_notified', 1) + self.crawler.stats.set_value("memusage/limit_notified", 1) if self.crawler.engine.spider is not None: - self.crawler.engine.close_spider(self.crawler.engine.spider, 'memusage_exceeded') + self.crawler.engine.close_spider( + self.crawler.engine.spider, "memusage_exceeded" + ) else: self.crawler.stop() else: - logger.info("Peak memory usage is %(virtualsize)dMiB", {'virtualsize': peak_mem_usage / 1024 / 1024}) + logger.info( + "Peak memory usage is %(virtualsize)dMiB", + {"virtualsize": peak_mem_usage / 1024 / 1024}, + ) def _check_warning(self): if self.warned: # warn only once return if self.get_virtual_size() > self.warning: - self.crawler.stats.set_value('memusage/warning_reached', 1) + self.crawler.stats.set_value("memusage/warning_reached", 1) mem = self.warning / 1024 / 1024 - logger.warning("Memory usage reached %(memusage)dMiB", - {'memusage': mem}, extra={'crawler': self.crawler}) + logger.warning( + "Memory usage reached %(memusage)dMiB", + {"memusage": mem}, + extra={"crawler": self.crawler}, + ) if self.notify_mails: subj = ( f"{self.crawler.settings['BOT_NAME']} warning: " f"memory usage reached {mem}MiB at {socket.gethostname()}" ) self._send_report(self.notify_mails, subj) - self.crawler.stats.set_value('memusage/warning_notified', 1) + self.crawler.stats.set_value("memusage/warning_notified", 1) self.warned = True def _send_report(self, rcpts, subject): @@ -120,7 +132,9 @@ class MemoryUsage: s += f"Maximum memory usage : {stats.get_value('memusage/max')/1024/1024}M\r\n" s += f"Current memory usage : {self.get_virtual_size()/1024/1024}M\r\n" - s += "ENGINE STATUS ------------------------------------------------------- \r\n" + s += ( + "ENGINE STATUS ------------------------------------------------------- \r\n" + ) s += "\r\n" s += pformat(get_engine_status(self.crawler.engine)) s += "\r\n" diff --git a/scrapy/extensions/postprocessing.py b/scrapy/extensions/postprocessing.py index 413c2e55e..79e3b1656 100644 --- a/scrapy/extensions/postprocessing.py +++ b/scrapy/extensions/postprocessing.py @@ -29,8 +29,13 @@ class GzipPlugin: compress_level = self.feed_options.get("gzip_compresslevel", 9) mtime = self.feed_options.get("gzip_mtime") filename = self.feed_options.get("gzip_filename") - self.gzipfile = GzipFile(fileobj=self.file, mode="wb", compresslevel=compress_level, - mtime=mtime, filename=filename) + self.gzipfile = GzipFile( + fileobj=self.file, + mode="wb", + compresslevel=compress_level, + mtime=mtime, + filename=filename, + ) def write(self, data: bytes) -> int: return self.gzipfile.write(data) @@ -55,7 +60,9 @@ class Bz2Plugin: self.file = file self.feed_options = feed_options compress_level = self.feed_options.get("bz2_compresslevel", 9) - self.bz2file = BZ2File(filename=self.file, mode="wb", compresslevel=compress_level) + self.bz2file = BZ2File( + filename=self.file, mode="wb", compresslevel=compress_level + ) def write(self, data: bytes) -> int: return self.bz2file.write(data) @@ -90,8 +97,14 @@ class LZMAPlugin: check = self.feed_options.get("lzma_check", -1) preset = self.feed_options.get("lzma_preset") filters = self.feed_options.get("lzma_filters") - self.lzmafile = LZMAFile(filename=self.file, mode="wb", format=format, - check=check, preset=preset, filters=filters) + self.lzmafile = LZMAFile( + filename=self.file, + mode="wb", + format=format, + check=check, + preset=preset, + filters=filters, + ) def write(self, data: bytes) -> int: return self.lzmafile.write(data) @@ -114,7 +127,9 @@ class PostProcessingManager(IOBase): :type file: file like object """ - def __init__(self, plugins: List[Any], file: BinaryIO, feed_options: Dict[str, Any]) -> None: + def __init__( + self, plugins: List[Any], file: BinaryIO, feed_options: Dict[str, Any] + ) -> None: self.plugins = self._load_plugins(plugins) self.file = file self.feed_options = feed_options diff --git a/scrapy/extensions/spiderstate.py b/scrapy/extensions/spiderstate.py index e9c8b1d6a..929a3be70 100644 --- a/scrapy/extensions/spiderstate.py +++ b/scrapy/extensions/spiderstate.py @@ -25,16 +25,16 @@ class SpiderState: def spider_closed(self, spider): if self.jobdir: - with Path(self.statefn).open('wb') as f: + with Path(self.statefn).open("wb") as f: pickle.dump(spider.state, f, protocol=4) def spider_opened(self, spider): if self.jobdir and Path(self.statefn).exists(): - with Path(self.statefn).open('rb') as f: + with Path(self.statefn).open("rb") as f: spider.state = pickle.load(f) else: spider.state = {} @property def statefn(self) -> str: - return str(Path(self.jobdir, 'spider.state')) + return str(Path(self.jobdir, "spider.state")) diff --git a/scrapy/extensions/statsmailer.py b/scrapy/extensions/statsmailer.py index 739e6b958..8733ad22b 100644 --- a/scrapy/extensions/statsmailer.py +++ b/scrapy/extensions/statsmailer.py @@ -10,7 +10,6 @@ from scrapy.exceptions import NotConfigured class StatsMailer: - def __init__(self, stats, recipients, mail): self.stats = stats self.recipients = recipients diff --git a/scrapy/extensions/telnet.py b/scrapy/extensions/telnet.py index 054350e4a..271f22428 100644 --- a/scrapy/extensions/telnet.py +++ b/scrapy/extensions/telnet.py @@ -15,6 +15,7 @@ from twisted.internet import protocol try: from twisted.conch import manhole, telnet from twisted.conch.insults import insults + TWISTED_CONCH_AVAILABLE = True except (ImportError, SyntaxError): _TWISTED_CONCH_TRACEBACK = traceback.format_exc() @@ -35,24 +36,26 @@ update_telnet_vars = object() class TelnetConsole(protocol.ServerFactory): - def __init__(self, crawler): - if not crawler.settings.getbool('TELNETCONSOLE_ENABLED'): + if not crawler.settings.getbool("TELNETCONSOLE_ENABLED"): raise NotConfigured if not TWISTED_CONCH_AVAILABLE: raise NotConfigured( - 'TELNETCONSOLE_ENABLED setting is True but required twisted ' - 'modules failed to import:\n' + _TWISTED_CONCH_TRACEBACK) + "TELNETCONSOLE_ENABLED setting is True but required twisted " + "modules failed to import:\n" + _TWISTED_CONCH_TRACEBACK + ) self.crawler = crawler self.noisy = False - self.portrange = [int(x) for x in crawler.settings.getlist('TELNETCONSOLE_PORT')] - self.host = crawler.settings['TELNETCONSOLE_HOST'] - self.username = crawler.settings['TELNETCONSOLE_USERNAME'] - self.password = crawler.settings['TELNETCONSOLE_PASSWORD'] + self.portrange = [ + int(x) for x in crawler.settings.getlist("TELNETCONSOLE_PORT") + ] + self.host = crawler.settings["TELNETCONSOLE_HOST"] + self.username = crawler.settings["TELNETCONSOLE_USERNAME"] + self.password = crawler.settings["TELNETCONSOLE_PASSWORD"] if not self.password: - self.password = binascii.hexlify(os.urandom(8)).decode('utf8') - logger.info('Telnet Password: %s', self.password) + self.password = binascii.hexlify(os.urandom(8)).decode("utf8") + logger.info("Telnet Password: %s", self.password) self.crawler.signals.connect(self.start_listening, signals.engine_started) self.crawler.signals.connect(self.stop_listening, signals.engine_stopped) @@ -64,9 +67,11 @@ class TelnetConsole(protocol.ServerFactory): def start_listening(self): self.port = listen_tcp(self.portrange, self.host, self) h = self.port.getHost() - logger.info("Telnet console listening on %(host)s:%(port)d", - {'host': h.host, 'port': h.port}, - extra={'crawler': self.crawler}) + logger.info( + "Telnet console listening on %(host)s:%(port)d", + {"host": h.host, "port": h.port}, + extra={"crawler": self.crawler}, + ) def stop_listening(self): self.port.stopListening() @@ -74,41 +79,37 @@ class TelnetConsole(protocol.ServerFactory): def protocol(self): class Portal: """An implementation of IPortal""" + @defers def login(self_, credentials, mind, *interfaces): if not ( - credentials.username == self.username.encode('utf8') - and credentials.checkPassword(self.password.encode('utf8')) + credentials.username == self.username.encode("utf8") + and credentials.checkPassword(self.password.encode("utf8")) ): raise ValueError("Invalid credentials") protocol = telnet.TelnetBootstrapProtocol( - insults.ServerProtocol, - manhole.Manhole, - self._get_telnet_vars() + insults.ServerProtocol, manhole.Manhole, self._get_telnet_vars() ) return (interfaces[0], protocol, lambda: None) - return telnet.TelnetTransport( - telnet.AuthenticatingTelnetProtocol, - Portal() - ) + return telnet.TelnetTransport(telnet.AuthenticatingTelnetProtocol, Portal()) def _get_telnet_vars(self): # Note: if you add entries here also update topics/telnetconsole.rst telnet_vars = { - 'engine': self.crawler.engine, - 'spider': self.crawler.engine.spider, - 'slot': self.crawler.engine.slot, - 'crawler': self.crawler, - 'extensions': self.crawler.extensions, - 'stats': self.crawler.stats, - 'settings': self.crawler.settings, - 'est': lambda: print_engine_status(self.crawler.engine), - 'p': pprint.pprint, - 'prefs': print_live_refs, - 'help': "This is Scrapy telnet console. For more info see: " - "https://docs.scrapy.org/en/latest/topics/telnetconsole.html", + "engine": self.crawler.engine, + "spider": self.crawler.engine.spider, + "slot": self.crawler.engine.slot, + "crawler": self.crawler, + "extensions": self.crawler.extensions, + "stats": self.crawler.stats, + "settings": self.crawler.settings, + "est": lambda: print_engine_status(self.crawler.engine), + "p": pprint.pprint, + "prefs": print_live_refs, + "help": "This is Scrapy telnet console. For more info see: " + "https://docs.scrapy.org/en/latest/topics/telnetconsole.html", } self.crawler.signals.send_catch_log(update_telnet_vars, telnet_vars=telnet_vars) return telnet_vars diff --git a/scrapy/extensions/throttle.py b/scrapy/extensions/throttle.py index eb21e426e..79e20de2a 100644 --- a/scrapy/extensions/throttle.py +++ b/scrapy/extensions/throttle.py @@ -7,16 +7,19 @@ logger = logging.getLogger(__name__) class AutoThrottle: - def __init__(self, crawler): self.crawler = crawler - if not crawler.settings.getbool('AUTOTHROTTLE_ENABLED'): + if not crawler.settings.getbool("AUTOTHROTTLE_ENABLED"): raise NotConfigured self.debug = crawler.settings.getbool("AUTOTHROTTLE_DEBUG") - self.target_concurrency = crawler.settings.getfloat("AUTOTHROTTLE_TARGET_CONCURRENCY") + self.target_concurrency = crawler.settings.getfloat( + "AUTOTHROTTLE_TARGET_CONCURRENCY" + ) crawler.signals.connect(self._spider_opened, signal=signals.spider_opened) - crawler.signals.connect(self._response_downloaded, signal=signals.response_downloaded) + crawler.signals.connect( + self._response_downloaded, signal=signals.response_downloaded + ) @classmethod def from_crawler(cls, crawler): @@ -29,17 +32,19 @@ class AutoThrottle: def _min_delay(self, spider): s = self.crawler.settings - return getattr(spider, 'download_delay', s.getfloat('DOWNLOAD_DELAY')) + return getattr(spider, "download_delay", s.getfloat("DOWNLOAD_DELAY")) def _max_delay(self, spider): - return self.crawler.settings.getfloat('AUTOTHROTTLE_MAX_DELAY') + return self.crawler.settings.getfloat("AUTOTHROTTLE_MAX_DELAY") def _start_delay(self, spider): - return max(self.mindelay, self.crawler.settings.getfloat('AUTOTHROTTLE_START_DELAY')) + return max( + self.mindelay, self.crawler.settings.getfloat("AUTOTHROTTLE_START_DELAY") + ) def _response_downloaded(self, response, request, spider): key, slot = self._get_slot(request, spider) - latency = request.meta.get('download_latency') + latency = request.meta.get("download_latency") if latency is None or slot is None: return @@ -54,15 +59,18 @@ class AutoThrottle: "delay:%(delay)5d ms (%(delaydiff)+d) | " "latency:%(latency)5d ms | size:%(size)6d bytes", { - 'slot': key, 'concurrency': conc, - 'delay': slot.delay * 1000, 'delaydiff': diff * 1000, - 'latency': latency * 1000, 'size': size, + "slot": key, + "concurrency": conc, + "delay": slot.delay * 1000, + "delaydiff": diff * 1000, + "latency": latency * 1000, + "size": size, }, - extra={'spider': spider} + extra={"spider": spider}, ) def _get_slot(self, request, spider): - key = request.meta.get('download_slot') + key = request.meta.get("download_slot") return key, self.crawler.engine.downloader.slots.get(key) def _adjust_delay(self, slot, latency, response): diff --git a/scrapy/http/common.py b/scrapy/http/common.py index 98699d7fd..bc8861574 100644 --- a/scrapy/http/common.py +++ b/scrapy/http/common.py @@ -3,4 +3,5 @@ def obsolete_setter(setter, attrname): c = self.__class__.__name__ msg = f"{c}.{attrname} is not modifiable, use {c}.replace() instead" raise AttributeError(msg) + return newsetter diff --git a/scrapy/http/cookies.py b/scrapy/http/cookies.py index b43c383fe..94afedb08 100644 --- a/scrapy/http/cookies.py +++ b/scrapy/http/cookies.py @@ -36,7 +36,7 @@ class CookieJar: if not IPV4_RE.search(req_host): hosts = potential_domain_matches(req_host) - if '.' not in req_host: + if "." not in req_host: hosts += [req_host + ".local"] else: hosts = [req_host] @@ -96,14 +96,14 @@ def potential_domain_matches(domain): """ matches = [domain] try: - start = domain.index('.') + 1 - end = domain.rindex('.') + start = domain.index(".") + 1 + end = domain.rindex(".") while start < end: matches.append(domain[start:]) - start = domain.index('.', start) + 1 + start = domain.index(".", start) + 1 except ValueError: pass - return matches + ['.' + d for d in matches] + return matches + ["." + d for d in matches] class _DummyLock: @@ -140,7 +140,7 @@ class WrappedRequest: HTML document, and the user had no option to approve the automatic fetching of the image, this should be true. """ - return self.request.meta.get('is_unverifiable', False) + return self.request.meta.get("is_unverifiable", False) @property def full_url(self): @@ -166,13 +166,14 @@ class WrappedRequest: return name in self.request.headers def get_header(self, name, default=None): - return to_unicode(self.request.headers.get(name, default), - errors='replace') + return to_unicode(self.request.headers.get(name, default), errors="replace") def header_items(self): return [ - (to_unicode(k, errors='replace'), - [to_unicode(x, errors='replace') for x in v]) + ( + to_unicode(k, errors="replace"), + [to_unicode(x, errors="replace") for x in v], + ) for k, v in self.request.headers.items() ] @@ -181,7 +182,6 @@ class WrappedRequest: class WrappedResponse: - def __init__(self, response): self.response = response @@ -189,5 +189,6 @@ class WrappedResponse: return self def get_all(self, name, default=None): - return [to_unicode(v, errors='replace') - for v in self.response.headers.getlist(name)] + return [ + to_unicode(v, errors="replace") for v in self.response.headers.getlist(name) + ] diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index 2e0020890..a5db30d6f 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -8,7 +8,7 @@ from scrapy.utils.python import to_unicode class Headers(CaselessDict): """Case insensitive http headers dictionary""" - def __init__(self, seq=None, encoding='utf-8'): + def __init__(self, seq=None, encoding="utf-8"): self.encoding = encoding super().__init__(seq) @@ -29,7 +29,7 @@ class Headers(CaselessDict): value = [] elif isinstance(value, (str, bytes)): value = [value] - elif not hasattr(value, '__iter__'): + elif not hasattr(value, "__iter__"): value = [value] return [self._tobytes(x) for x in value] @@ -41,7 +41,7 @@ class Headers(CaselessDict): return x.encode(self.encoding) if isinstance(x, int): return str(x).encode(self.encoding) - raise TypeError(f'Unsupported value type: {type(x)}') + raise TypeError(f"Unsupported value type: {type(x)}") def __getitem__(self, key): try: @@ -84,13 +84,16 @@ class Headers(CaselessDict): return headers_dict_to_raw(self) def to_unicode_dict(self): - """ Return headers as a CaselessDict with unicode keys + """Return headers as a CaselessDict with unicode keys and unicode values. Multiple values are joined with ','. """ return CaselessDict( - (to_unicode(key, encoding=self.encoding), - to_unicode(b','.join(value), encoding=self.encoding)) - for key, value in self.items()) + ( + to_unicode(key, encoding=self.encoding), + to_unicode(b",".join(value), encoding=self.encoding), + ) + for key, value in self.items() + ) def __copy__(self): return self.__class__(self) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index a1001fc4a..e290f2143 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -27,9 +27,19 @@ class Request(object_ref): """ attributes: Tuple[str, ...] = ( - "url", "callback", "method", "headers", "body", - "cookies", "meta", "encoding", "priority", - "dont_filter", "errback", "flags", "cb_kwargs", + "url", + "callback", + "method", + "headers", + "body", + "cookies", + "meta", + "encoding", + "priority", + "dont_filter", + "errback", + "flags", + "cb_kwargs", ) """A tuple of :class:`str` objects containing the name of all public attributes of the class that are also keyword parameters of the @@ -64,9 +74,11 @@ class Request(object_ref): self.priority = priority if callback is not None and not callable(callback): - raise TypeError(f'callback must be a callable, got {type(callback).__name__}') + raise TypeError( + f"callback must be a callable, got {type(callback).__name__}" + ) if errback is not None and not callable(errback): - raise TypeError(f'errback must be a callable, got {type(errback).__name__}') + raise TypeError(f"errback must be a callable, got {type(errback).__name__}") self.callback = callback self.errback = errback @@ -101,13 +113,13 @@ class Request(object_ref): self._url = escape_ajax(s) if ( - '://' not in self._url - and not self._url.startswith('about:') - and not self._url.startswith('data:') + "://" not in self._url + and not self._url.startswith("about:") + and not self._url.startswith("data:") ): - raise ValueError(f'Missing scheme in request url: {self._url}') + raise ValueError(f"Missing scheme in request url: {self._url}") - url = property(_get_url, obsolete_setter(_set_url, 'url')) + url = property(_get_url, obsolete_setter(_set_url, "url")) def _get_body(self) -> bytes: return self._body @@ -115,7 +127,7 @@ class Request(object_ref): def _set_body(self, body: Optional[Union[str, bytes]]) -> None: self._body = b"" if body is None else to_bytes(body, self.encoding) - body = property(_get_body, obsolete_setter(_set_body, 'body')) + body = property(_get_body, obsolete_setter(_set_body, "body")) @property def encoding(self) -> str: @@ -131,12 +143,15 @@ class Request(object_ref): """Create a new Request with the same attributes except for those given new values""" for x in self.attributes: kwargs.setdefault(x, getattr(self, x)) - cls = kwargs.pop('cls', self.__class__) + cls = kwargs.pop("cls", self.__class__) return cls(*args, **kwargs) @classmethod def from_curl( - cls: Type[RequestTypeVar], curl_command: str, ignore_unknown_options: bool = True, **kwargs + cls: Type[RequestTypeVar], + curl_command: str, + ignore_unknown_options: bool = True, + **kwargs, ) -> RequestTypeVar: """Create a Request object from a string containing a `cURL `_ command. It populates the HTTP method, the @@ -179,21 +194,25 @@ class Request(object_ref): """ d = { "url": self.url, # urls are safe (safe_string_url) - "callback": _find_method(spider, self.callback) if callable(self.callback) else self.callback, - "errback": _find_method(spider, self.errback) if callable(self.errback) else self.errback, + "callback": _find_method(spider, self.callback) + if callable(self.callback) + else self.callback, + "errback": _find_method(spider, self.errback) + if callable(self.errback) + else self.errback, "headers": dict(self.headers), } for attr in self.attributes: d.setdefault(attr, getattr(self, attr)) if type(self) is not Request: # pylint: disable=unidiomatic-typecheck - d["_class"] = self.__module__ + '.' + self.__class__.__name__ + d["_class"] = self.__module__ + "." + self.__class__.__name__ return d def _find_method(obj, func): """Helper function for Request.to_dict""" # Only instance methods contain ``__func__`` - if obj and hasattr(func, '__func__'): + if obj and hasattr(func, "__func__"): members = inspect.getmembers(obj, predicate=inspect.ismethod) for name, obj_func in members: # We need to use __func__ to access the original function object because instance diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index 8e0a7fae2..ea519fb19 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -24,22 +24,26 @@ FormdataType = Optional[Union[dict, List[Tuple[str, str]]]] class FormRequest(Request): - valid_form_methods = ['GET', 'POST'] + valid_form_methods = ["GET", "POST"] def __init__(self, *args, formdata: FormdataType = None, **kwargs) -> None: - if formdata and kwargs.get('method') is None: - kwargs['method'] = 'POST' + if formdata and kwargs.get("method") is None: + kwargs["method"] = "POST" super().__init__(*args, **kwargs) if formdata: items = formdata.items() if isinstance(formdata, dict) else formdata form_query_str = _urlencode(items, self.encoding) - if self.method == 'POST': - self.headers.setdefault(b'Content-Type', b'application/x-www-form-urlencoded') + if self.method == "POST": + self.headers.setdefault( + b"Content-Type", b"application/x-www-form-urlencoded" + ) self._set_body(form_query_str) else: - self._set_url(urlunsplit(urlsplit(self.url)._replace(query=form_query_str))) + self._set_url( + urlunsplit(urlsplit(self.url)._replace(query=form_query_str)) + ) @classmethod def from_response( @@ -55,28 +59,29 @@ class FormRequest(Request): formcss: Optional[str] = None, **kwargs, ) -> FormRequestTypeVar: - kwargs.setdefault('encoding', response.encoding) + kwargs.setdefault("encoding", response.encoding) if formcss is not None: from parsel.csstranslator import HTMLTranslator + formxpath = HTMLTranslator().css_to_xpath(formcss) form = _get_form(response, formname, formid, formnumber, formxpath) formdata = _get_inputs(form, formdata, dont_click, clickdata) - url = _get_form_url(form, kwargs.pop('url', None)) + url = _get_form_url(form, kwargs.pop("url", None)) - method = kwargs.pop('method', form.method) + method = kwargs.pop("method", form.method) if method is not None: method = method.upper() if method not in cls.valid_form_methods: - method = 'GET' + method = "GET" return cls(url=url, method=method, formdata=formdata, **kwargs) def _get_form_url(form: FormElement, url: Optional[str]) -> str: if url is None: - action = form.get('action') + action = form.get("action") if action is None: return form.base_url return urljoin(form.base_url, strip_html5_whitespace(action)) @@ -84,9 +89,11 @@ def _get_form_url(form: FormElement, url: Optional[str]) -> str: def _urlencode(seq: Iterable, enc: str) -> str: - values = [(to_bytes(k, enc), to_bytes(v, enc)) - for k, vs in seq - for v in (vs if is_listlike(vs) else [vs])] + values = [ + (to_bytes(k, enc), to_bytes(v, enc)) + for k, vs in seq + for v in (vs if is_listlike(vs) else [vs]) + ] return urlencode(values, doseq=True) @@ -99,7 +106,7 @@ def _get_form( ) -> FormElement: """Find the wanted form element within the given response.""" root = create_root_node(response.text, HTMLParser, base_url=get_base_url(response)) - forms = root.xpath('//form') + forms = root.xpath("//form") if not forms: raise ValueError(f"No
element found in {response}") @@ -119,12 +126,12 @@ def _get_form( if nodes: el = nodes[0] while True: - if el.tag == 'form': + if el.tag == "form": return el el = el.getparent() if el is None: break - raise ValueError(f'No element found with {formxpath}') + raise ValueError(f"No element found with {formxpath}") # If we get here, it means that either formname was None or invalid if formnumber is not None: @@ -146,19 +153,21 @@ def _get_inputs( try: formdata_keys = dict(formdata or ()).keys() except (ValueError, TypeError): - raise ValueError('formdata should be a dict or iterable of tuples') + raise ValueError("formdata should be a dict or iterable of tuples") if not formdata: formdata = [] - inputs = form.xpath('descendant::textarea' - '|descendant::select' - '|descendant::input[not(@type) or @type[' - ' not(re:test(., "^(?:submit|image|reset)$", "i"))' - ' and (../@checked or' - ' not(re:test(., "^(?:checkbox|radio)$", "i")))]]', - namespaces={"re": "http://exslt.org/regular-expressions"}) + inputs = form.xpath( + "descendant::textarea" + "|descendant::select" + "|descendant::input[not(@type) or @type[" + ' not(re:test(., "^(?:submit|image|reset)$", "i"))' + " and (../@checked or" + ' not(re:test(., "^(?:checkbox|radio)$", "i")))]]', + namespaces={"re": "http://exslt.org/regular-expressions"}, + ) values = [ - (k, '' if v is None else v) + (k, "" if v is None else v) for k, v in (_value(e) for e in inputs) if k and k not in formdata_keys ] @@ -178,7 +187,7 @@ def _get_inputs( def _value(ele: HtmlElement): n = ele.name v = ele.value - if ele.tag == 'select': + if ele.tag == "select": return _select_value(ele, n, v) return n, v @@ -193,51 +202,57 @@ def _select_value(ele: SelectElement, n: str, v: str): if v is not None and multiple: # This is a workround to bug in lxml fixed 2.3.1 # fix https://github.com/lxml/lxml/commit/57f49eed82068a20da3db8f1b18ae00c1bab8b12#L1L1139 - selected_options = ele.xpath('.//option[@selected]') - values = [(o.get('value') or o.text or '').strip() for o in selected_options] + selected_options = ele.xpath(".//option[@selected]") + values = [(o.get("value") or o.text or "").strip() for o in selected_options] return n, values return n, v -def _get_clickable(clickdata: Optional[dict], form: FormElement) -> Optional[Tuple[str, str]]: +def _get_clickable( + clickdata: Optional[dict], form: FormElement +) -> Optional[Tuple[str, str]]: """ Returns the clickable element specified in clickdata, if the latter is given. If not, it returns the first clickable element found """ - clickables = list(form.xpath( - 'descendant::input[re:test(@type, "^(submit|image)$", "i")]' - '|descendant::button[not(@type) or re:test(@type, "^submit$", "i")]', - namespaces={"re": "http://exslt.org/regular-expressions"} - )) + clickables = list( + form.xpath( + 'descendant::input[re:test(@type, "^(submit|image)$", "i")]' + '|descendant::button[not(@type) or re:test(@type, "^submit$", "i")]', + namespaces={"re": "http://exslt.org/regular-expressions"}, + ) + ) if not clickables: return None # If we don't have clickdata, we just use the first clickable element if clickdata is None: el = clickables[0] - return (el.get('name'), el.get('value') or '') + return (el.get("name"), el.get("value") or "") # If clickdata is given, we compare it to the clickable elements to find a # match. We first look to see if the number is specified in clickdata, # because that uniquely identifies the element - nr = clickdata.get('nr', None) + nr = clickdata.get("nr", None) if nr is not None: try: el = list(form.inputs)[nr] except IndexError: pass else: - return (el.get('name'), el.get('value') or '') + return (el.get("name"), el.get("value") or "") # We didn't find it, so now we build an XPath expression out of the other # arguments, because they can be used as such - xpath = './/*' + ''.join(f'[@{k}="{v}"]' for k, v in clickdata.items()) + xpath = ".//*" + "".join(f'[@{k}="{v}"]' for k, v in clickdata.items()) el = form.xpath(xpath) if len(el) == 1: - return (el[0].get('name'), el[0].get('value') or '') + return (el[0].get("name"), el[0].get("value") or "") if len(el) > 1: - raise ValueError(f"Multiple elements found ({el!r}) matching the " - f"criteria in clickdata: {clickdata!r}") + raise ValueError( + f"Multiple elements found ({el!r}) matching the " + f"criteria in clickdata: {clickdata!r}" + ) else: - raise ValueError(f'No clickable element matching clickdata: {clickdata!r}') + raise ValueError(f"No clickable element matching clickdata: {clickdata!r}") diff --git a/scrapy/http/request/json_request.py b/scrapy/http/request/json_request.py index 728a2a104..35e2808c2 100644 --- a/scrapy/http/request/json_request.py +++ b/scrapy/http/request/json_request.py @@ -20,42 +20,44 @@ class JsonRequest(Request): def __init__(self, *args, dumps_kwargs: Optional[dict] = None, **kwargs) -> None: dumps_kwargs = copy.deepcopy(dumps_kwargs) if dumps_kwargs is not None else {} - dumps_kwargs.setdefault('sort_keys', True) + dumps_kwargs.setdefault("sort_keys", True) self._dumps_kwargs = dumps_kwargs - body_passed = kwargs.get('body', None) is not None - data = kwargs.pop('data', None) + body_passed = kwargs.get("body", None) is not None + data = kwargs.pop("data", None) data_passed = data is not None if body_passed and data_passed: - warnings.warn('Both body and data passed. data will be ignored') + warnings.warn("Both body and data passed. data will be ignored") elif not body_passed and data_passed: - kwargs['body'] = self._dumps(data) - if 'method' not in kwargs: - kwargs['method'] = 'POST' + kwargs["body"] = self._dumps(data) + if "method" not in kwargs: + kwargs["method"] = "POST" super().__init__(*args, **kwargs) - self.headers.setdefault('Content-Type', 'application/json') - self.headers.setdefault('Accept', 'application/json, text/javascript, */*; q=0.01') + self.headers.setdefault("Content-Type", "application/json") + self.headers.setdefault( + "Accept", "application/json, text/javascript, */*; q=0.01" + ) @property def dumps_kwargs(self) -> dict: return self._dumps_kwargs def replace(self, *args, **kwargs) -> Request: - body_passed = kwargs.get('body', None) is not None - data = kwargs.pop('data', None) + body_passed = kwargs.get("body", None) is not None + data = kwargs.pop("data", None) data_passed = data is not None if body_passed and data_passed: - warnings.warn('Both body and data passed. data will be ignored') + warnings.warn("Both body and data passed. data will be ignored") elif not body_passed and data_passed: - kwargs['body'] = self._dumps(data) + kwargs["body"] = self._dumps(data) return super().replace(*args, **kwargs) def _dumps(self, data: dict) -> str: - """Convert to JSON """ + """Convert to JSON""" return json.dumps(data, **self._dumps_kwargs) diff --git a/scrapy/http/request/rpc.py b/scrapy/http/request/rpc.py index 06d98cea5..c0a6e86c1 100644 --- a/scrapy/http/request/rpc.py +++ b/scrapy/http/request/rpc.py @@ -15,21 +15,20 @@ DUMPS_ARGS = get_func_args(xmlrpclib.dumps) class XmlRpcRequest(Request): - def __init__(self, *args, encoding: Optional[str] = None, **kwargs): - if 'body' not in kwargs and 'params' in kwargs: + if "body" not in kwargs and "params" in kwargs: kw = dict((k, kwargs.pop(k)) for k in DUMPS_ARGS if k in kwargs) - kwargs['body'] = xmlrpclib.dumps(**kw) + kwargs["body"] = xmlrpclib.dumps(**kw) # spec defines that requests must use POST method - kwargs.setdefault('method', 'POST') + kwargs.setdefault("method", "POST") # xmlrpc query multiples times over the same url - kwargs.setdefault('dont_filter', True) + kwargs.setdefault("dont_filter", True) # restore encoding if encoding is not None: - kwargs['encoding'] = encoding + kwargs["encoding"] = encoding super().__init__(*args, **kwargs) - self.headers.setdefault('Content-Type', 'text/xml') + self.headers.setdefault("Content-Type", "text/xml") diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index 7626946ec..4213d491d 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -21,7 +21,15 @@ class Response(object_ref): """ attributes: Tuple[str, ...] = ( - "url", "status", "headers", "body", "flags", "request", "certificate", "ip_address", "protocol", + "url", + "status", + "headers", + "body", + "flags", + "request", + "certificate", + "ip_address", + "protocol", ) """A tuple of :class:`str` objects containing the name of all public attributes of the class that are also keyword parameters of the @@ -79,26 +87,28 @@ class Response(object_ref): if isinstance(url, str): self._url = url else: - raise TypeError(f'{type(self).__name__} url must be str, ' - f'got {type(url).__name__}') + raise TypeError( + f"{type(self).__name__} url must be str, " f"got {type(url).__name__}" + ) - url = property(_get_url, obsolete_setter(_set_url, 'url')) + url = property(_get_url, obsolete_setter(_set_url, "url")) def _get_body(self): return self._body def _set_body(self, body): if body is None: - self._body = b'' + self._body = b"" elif not isinstance(body, bytes): raise TypeError( "Response body must be bytes. " "If you want to pass unicode body use TextResponse " - "or HtmlResponse.") + "or HtmlResponse." + ) else: self._body = body - body = property(_get_body, obsolete_setter(_set_body, 'body')) + body = property(_get_body, obsolete_setter(_set_body, "body")) def __repr__(self): return f"<{self.status} {self.url}>" @@ -111,7 +121,7 @@ class Response(object_ref): """Create a new Response with the same attributes except for those given new values""" for x in self.attributes: kwargs.setdefault(x, getattr(self, x)) - cls = kwargs.pop('cls', self.__class__) + cls = kwargs.pop("cls", self.__class__) return cls(*args, **kwargs) def urljoin(self, url): @@ -138,9 +148,22 @@ class Response(object_ref): """ raise NotSupported("Response content isn't text") - def follow(self, url, callback=None, method='GET', headers=None, body=None, - cookies=None, meta=None, encoding='utf-8', priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None) -> Request: + def follow( + self, + url, + callback=None, + method="GET", + headers=None, + body=None, + cookies=None, + meta=None, + encoding="utf-8", + priority=0, + dont_filter=False, + errback=None, + cb_kwargs=None, + flags=None, + ) -> Request: """ Return a :class:`~.Request` instance to follow a link ``url``. It accepts the same arguments as ``Request.__init__`` method, @@ -176,10 +199,22 @@ class Response(object_ref): flags=flags, ) - def follow_all(self, urls, callback=None, method='GET', headers=None, body=None, - cookies=None, meta=None, encoding='utf-8', priority=0, - dont_filter=False, errback=None, cb_kwargs=None, - flags=None) -> Generator[Request, None, None]: + def follow_all( + self, + urls, + callback=None, + method="GET", + headers=None, + body=None, + cookies=None, + meta=None, + encoding="utf-8", + priority=0, + dont_filter=False, + errback=None, + cb_kwargs=None, + flags=None, + ) -> Generator[Request, None, None]: """ .. versionadded:: 2.0 @@ -192,7 +227,7 @@ class Response(object_ref): method which supports selectors in addition to absolute/relative URLs and Link objects. """ - if not hasattr(urls, '__iter__'): + if not hasattr(urls, "__iter__"): raise TypeError("'urls' argument must be an iterable") return ( self.follow( diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index da81d0a4a..f9df4e1b0 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -30,13 +30,13 @@ _NONE = object() class TextResponse(Response): - _DEFAULT_ENCODING = 'ascii' + _DEFAULT_ENCODING = "ascii" _cached_decoded_json = _NONE attributes: Tuple[str, ...] = Response.attributes + ("encoding",) def __init__(self, *args, **kwargs): - self._encoding = kwargs.pop('encoding', None) + self._encoding = kwargs.pop("encoding", None) self._cached_benc = None self._cached_ubody = None self._cached_selector = None @@ -49,11 +49,13 @@ class TextResponse(Response): super()._set_url(url) def _set_body(self, body): - self._body = b'' # used by encoding detection + self._body = b"" # used by encoding detection if isinstance(body, str): if self._encoding is None: - raise TypeError('Cannot convert unicode body - ' - f'{type(self).__name__} has no encoding') + raise TypeError( + "Cannot convert unicode body - " + f"{type(self).__name__} has no encoding" + ) self._body = body.encode(self._encoding) else: super()._set_body(body) @@ -82,12 +84,12 @@ class TextResponse(Response): @property def text(self): - """ Body as unicode """ + """Body as unicode""" # access self.encoding before _cached_ubody to make sure # _body_inferred_encoding is called benc = self.encoding if self._cached_ubody is None: - charset = f'charset={benc}' + charset = f"charset={benc}" self._cached_ubody = html_to_unicode(charset, self.body)[1] return self._cached_ubody @@ -98,21 +100,24 @@ class TextResponse(Response): @memoizemethod_noargs def _headers_encoding(self): - content_type = self.headers.get(b'Content-Type', b'') + content_type = self.headers.get(b"Content-Type", b"") return http_content_type_encoding(to_unicode(content_type)) def _body_inferred_encoding(self): if self._cached_benc is None: - content_type = to_unicode(self.headers.get(b'Content-Type', b'')) - benc, ubody = html_to_unicode(content_type, self.body, - auto_detect_fun=self._auto_detect_fun, - default_encoding=self._DEFAULT_ENCODING) + content_type = to_unicode(self.headers.get(b"Content-Type", b"")) + benc, ubody = html_to_unicode( + content_type, + self.body, + auto_detect_fun=self._auto_detect_fun, + default_encoding=self._DEFAULT_ENCODING, + ) self._cached_benc = benc self._cached_ubody = ubody return self._cached_benc def _auto_detect_fun(self, text): - for enc in (self._DEFAULT_ENCODING, 'utf-8', 'cp1252'): + for enc in (self._DEFAULT_ENCODING, "utf-8", "cp1252"): try: text.decode(enc) except UnicodeError: @@ -130,6 +135,7 @@ class TextResponse(Response): @property def selector(self): from scrapy.selector import Selector + if self._cached_selector is None: self._cached_selector = Selector(self) return self._cached_selector @@ -140,9 +146,22 @@ class TextResponse(Response): def css(self, query): return self.selector.css(query) - def follow(self, url, callback=None, method='GET', headers=None, body=None, - cookies=None, meta=None, encoding=None, priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None) -> Request: + def follow( + self, + url, + callback=None, + method="GET", + headers=None, + body=None, + cookies=None, + meta=None, + encoding=None, + priority=0, + dont_filter=False, + errback=None, + cb_kwargs=None, + flags=None, + ) -> Request: """ Return a :class:`~.Request` instance to follow a link ``url``. It accepts the same arguments as ``Request.__init__`` method, @@ -180,10 +199,24 @@ class TextResponse(Response): flags=flags, ) - def follow_all(self, urls=None, callback=None, method='GET', headers=None, body=None, - cookies=None, meta=None, encoding=None, priority=0, - dont_filter=False, errback=None, cb_kwargs=None, flags=None, - css=None, xpath=None) -> Generator[Request, None, None]: + def follow_all( + self, + urls=None, + callback=None, + method="GET", + headers=None, + body=None, + cookies=None, + meta=None, + encoding=None, + priority=0, + dont_filter=False, + errback=None, + cb_kwargs=None, + flags=None, + css=None, + xpath=None, + ) -> Generator[Request, None, None]: """ A generator that produces :class:`~.Request` instances to follow all links in ``urls``. It accepts the same arguments as the :class:`~.Request`'s @@ -251,12 +284,13 @@ def _url_from_selector(sel): if isinstance(sel.root, str): # e.g. ::attr(href) result return strip_html5_whitespace(sel.root) - if not hasattr(sel.root, 'tag'): + if not hasattr(sel.root, "tag"): raise _InvalidSelector(f"Unsupported selector: {sel}") - if sel.root.tag not in ('a', 'link'): - raise _InvalidSelector("Only and elements are supported; " - f"got <{sel.root.tag}>") - href = sel.root.get('href') + if sel.root.tag not in ("a", "link"): + raise _InvalidSelector( + "Only and elements are supported; " f"got <{sel.root.tag}>" + ) + href = sel.root.get("href") if href is None: raise _InvalidSelector(f"<{sel.root.tag}> element has no href attribute: {sel}") return strip_html5_whitespace(href) diff --git a/scrapy/interfaces.py b/scrapy/interfaces.py index 1896ec31e..9a2c5f170 100644 --- a/scrapy/interfaces.py +++ b/scrapy/interfaces.py @@ -2,7 +2,6 @@ from zope.interface import Interface class ISpiderLoader(Interface): - def from_settings(settings): """Return an instance of the class for the given settings""" diff --git a/scrapy/item.py b/scrapy/item.py index 2521ac829..d3eb90b7b 100644 --- a/scrapy/item.py +++ b/scrapy/item.py @@ -24,11 +24,11 @@ class ItemMeta(ABCMeta): """ def __new__(mcs, class_name, bases, attrs): - classcell = attrs.pop('__classcell__', None) - new_bases = tuple(base._class for base in bases if hasattr(base, '_class')) - _class = super().__new__(mcs, 'x_' + class_name, new_bases, attrs) + classcell = attrs.pop("__classcell__", None) + new_bases = tuple(base._class for base in bases if hasattr(base, "_class")) + _class = super().__new__(mcs, "x_" + class_name, new_bases, attrs) - fields = getattr(_class, 'fields', {}) + fields = getattr(_class, "fields", {}) new_attrs = {} for n in dir(_class): v = getattr(_class, n) @@ -37,10 +37,10 @@ class ItemMeta(ABCMeta): elif n in attrs: new_attrs[n] = attrs[n] - new_attrs['fields'] = fields - new_attrs['_class'] = _class + new_attrs["fields"] = fields + new_attrs["_class"] = _class if classcell is not None: - new_attrs['__classcell__'] = classcell + new_attrs["__classcell__"] = classcell return super().__new__(mcs, class_name, bases, new_attrs) @@ -93,7 +93,7 @@ class Item(MutableMapping, object_ref, metaclass=ItemMeta): raise AttributeError(name) def __setattr__(self, name, value): - if not name.startswith('_'): + if not name.startswith("_"): raise AttributeError(f"Use item[{name!r}] = {value!r} to set field value") super().__setattr__(name, value) @@ -115,6 +115,5 @@ class Item(MutableMapping, object_ref, metaclass=ItemMeta): return self.__class__(self) def deepcopy(self): - """Return a :func:`~copy.deepcopy` of this item. - """ + """Return a :func:`~copy.deepcopy` of this item.""" return deepcopy(self) diff --git a/scrapy/link.py b/scrapy/link.py index e70667361..704649731 100644 --- a/scrapy/link.py +++ b/scrapy/link.py @@ -24,9 +24,9 @@ class Link: of the anchor tag. """ - __slots__ = ['url', 'text', 'fragment', 'nofollow'] + __slots__ = ["url", "text", "fragment", "nofollow"] - def __init__(self, url, text='', fragment='', nofollow=False): + def __init__(self, url, text="", fragment="", nofollow=False): if not isinstance(url, str): got = url.__class__.__name__ raise TypeError(f"Link urls must be str objects, got {got}") @@ -44,10 +44,12 @@ class Link: ) def __hash__(self): - return hash(self.url) ^ hash(self.text) ^ hash(self.fragment) ^ hash(self.nofollow) + return ( + hash(self.url) ^ hash(self.text) ^ hash(self.fragment) ^ hash(self.nofollow) + ) def __repr__(self): return ( - f'Link(url={self.url!r}, text={self.text!r}, ' - f'fragment={self.fragment!r}, nofollow={self.nofollow!r})' + f"Link(url={self.url!r}, text={self.text!r}, " + f"fragment={self.fragment!r}, nofollow={self.nofollow!r})" ) diff --git a/scrapy/linkextractors/__init__.py b/scrapy/linkextractors/__init__.py index b3b1eea55..ae2948d73 100644 --- a/scrapy/linkextractors/__init__.py +++ b/scrapy/linkextractors/__init__.py @@ -10,25 +10,81 @@ import re # common file extensions that are not followed if they occur in links IGNORED_EXTENSIONS = [ # archives - '7z', '7zip', 'bz2', 'rar', 'tar', 'tar.gz', 'xz', 'zip', - + "7z", + "7zip", + "bz2", + "rar", + "tar", + "tar.gz", + "xz", + "zip", # images - 'mng', 'pct', 'bmp', 'gif', 'jpg', 'jpeg', 'png', 'pst', 'psp', 'tif', - 'tiff', 'ai', 'drw', 'dxf', 'eps', 'ps', 'svg', 'cdr', 'ico', - + "mng", + "pct", + "bmp", + "gif", + "jpg", + "jpeg", + "png", + "pst", + "psp", + "tif", + "tiff", + "ai", + "drw", + "dxf", + "eps", + "ps", + "svg", + "cdr", + "ico", # audio - 'mp3', 'wma', 'ogg', 'wav', 'ra', 'aac', 'mid', 'au', 'aiff', - + "mp3", + "wma", + "ogg", + "wav", + "ra", + "aac", + "mid", + "au", + "aiff", # video - '3gp', 'asf', 'asx', 'avi', 'mov', 'mp4', 'mpg', 'qt', 'rm', 'swf', 'wmv', - 'm4a', 'm4v', 'flv', 'webm', - + "3gp", + "asf", + "asx", + "avi", + "mov", + "mp4", + "mpg", + "qt", + "rm", + "swf", + "wmv", + "m4a", + "m4v", + "flv", + "webm", # office suites - 'xls', 'xlsx', 'ppt', 'pptx', 'pps', 'doc', 'docx', 'odt', 'ods', 'odg', - 'odp', - + "xls", + "xlsx", + "ppt", + "pptx", + "pps", + "doc", + "docx", + "odt", + "ods", + "odg", + "odp", # other - 'css', 'pdf', 'exe', 'bin', 'rss', 'dmg', 'iso', 'apk' + "css", + "pdf", + "exe", + "bin", + "rss", + "dmg", + "iso", + "apk", ] @@ -40,7 +96,7 @@ def _matches(url, regexs): def _is_valid_url(url): - return url.split('://', 1)[0] in {'http', 'https', 'file', 'ftp'} + return url.split("://", 1)[0] in {"http", "https", "file", "ftp"} # Top-level imports diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 1e6ab984a..0bd28a882 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -11,8 +11,13 @@ from w3lib.html import strip_html5_whitespace from w3lib.url import canonicalize_url, safe_url_string from scrapy.link import Link -from scrapy.linkextractors import (IGNORED_EXTENSIONS, _is_valid_url, _matches, - _re_type, re) +from scrapy.linkextractors import ( + IGNORED_EXTENSIONS, + _is_valid_url, + _matches, + _re_type, + re, +) from scrapy.utils.misc import arg_to_iter, rel_has_nofollow from scrapy.utils.python import unique as unique_list from scrapy.utils.response import get_base_url @@ -26,8 +31,8 @@ _collect_string_content = etree.XPath("string()") def _nons(tag): if isinstance(tag, str): - if tag[0] == '{' and tag[1:len(XHTML_NAMESPACE) + 1] == XHTML_NAMESPACE: - return tag.split('}')[-1] + if tag[0] == "{" and tag[1 : len(XHTML_NAMESPACE) + 1] == XHTML_NAMESPACE: + return tag.split("}")[-1] return tag @@ -41,14 +46,22 @@ def _canonicalize_link_url(link): class LxmlParserLinkExtractor: def __init__( - self, tag="a", attr="href", process=None, unique=False, strip=True, canonicalized=False + self, + tag="a", + attr="href", + process=None, + unique=False, + strip=True, + canonicalized=False, ): self.scan_tag = tag if callable(tag) else partial(operator.eq, tag) self.scan_attr = attr if callable(attr) else partial(operator.eq, attr) self.process_attr = process if callable(process) else _identity self.unique = unique self.strip = strip - self.link_key = operator.attrgetter("url") if canonicalized else _canonicalize_link_url + self.link_key = ( + operator.attrgetter("url") if canonicalized else _canonicalize_link_url + ) def _iter_links(self, document): for el in document.iter(etree.Element): @@ -78,17 +91,22 @@ class LxmlParserLinkExtractor: url = safe_url_string(url, encoding=response_encoding) # to fix relative links after process_value url = urljoin(response_url, url) - link = Link(url, _collect_string_content(el) or '', - nofollow=rel_has_nofollow(el.get('rel'))) + link = Link( + url, + _collect_string_content(el) or "", + nofollow=rel_has_nofollow(el.get("rel")), + ) links.append(link) return self._deduplicate_if_needed(links) def extract_links(self, response): base_url = get_base_url(response) - return self._extract_links(response.selector, response.url, response.encoding, base_url) + return self._extract_links( + response.selector, response.url, response.encoding, base_url + ) def _process_links(self, links): - """ Normalize and filter extracted links + """Normalize and filter extracted links The subclass should override it if necessary """ @@ -110,8 +128,8 @@ class LxmlLinkExtractor: allow_domains=(), deny_domains=(), restrict_xpaths=(), - tags=('a', 'area'), - attrs=('href',), + tags=("a", "area"), + attrs=("href",), canonicalize=False, unique=True, process_value=None, @@ -127,26 +145,31 @@ class LxmlLinkExtractor: unique=unique, process=process_value, strip=strip, - canonicalized=canonicalize + canonicalized=canonicalize, ) - self.allow_res = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(allow)] - self.deny_res = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(deny)] + self.allow_res = [ + x if isinstance(x, _re_type) else re.compile(x) for x in arg_to_iter(allow) + ] + self.deny_res = [ + x if isinstance(x, _re_type) else re.compile(x) for x in arg_to_iter(deny) + ] self.allow_domains = set(arg_to_iter(allow_domains)) self.deny_domains = set(arg_to_iter(deny_domains)) self.restrict_xpaths = tuple(arg_to_iter(restrict_xpaths)) - self.restrict_xpaths += tuple(map(self._csstranslator.css_to_xpath, - arg_to_iter(restrict_css))) + self.restrict_xpaths += tuple( + map(self._csstranslator.css_to_xpath, arg_to_iter(restrict_css)) + ) if deny_extensions is None: deny_extensions = IGNORED_EXTENSIONS self.canonicalize = canonicalize - self.deny_extensions = {'.' + e for e in arg_to_iter(deny_extensions)} - self.restrict_text = [x if isinstance(x, _re_type) else re.compile(x) - for x in arg_to_iter(restrict_text)] + self.deny_extensions = {"." + e for e in arg_to_iter(deny_extensions)} + self.restrict_text = [ + x if isinstance(x, _re_type) else re.compile(x) + for x in arg_to_iter(restrict_text) + ] def _link_allowed(self, link): if not _is_valid_url(link.url): @@ -156,11 +179,15 @@ class LxmlLinkExtractor: if self.deny_res and _matches(link.url, self.deny_res): return False parsed_url = urlparse(link.url) - if self.allow_domains and not url_is_from_any_domain(parsed_url, self.allow_domains): + if self.allow_domains and not url_is_from_any_domain( + parsed_url, self.allow_domains + ): return False if self.deny_domains and url_is_from_any_domain(parsed_url, self.deny_domains): return False - if self.deny_extensions and url_has_any_extension(parsed_url, self.deny_extensions): + if self.deny_extensions and url_has_any_extension( + parsed_url, self.deny_extensions + ): return False if self.restrict_text and not _matches(link.text, self.restrict_text): return False @@ -173,7 +200,11 @@ class LxmlLinkExtractor: if self.deny_domains and url_is_from_any_domain(url, self.deny_domains): return False - allowed = (regex.search(url) for regex in self.allow_res) if self.allow_res else [True] + allowed = ( + (regex.search(url) for regex in self.allow_res) + if self.allow_res + else [True] + ) denied = (regex.search(url) for regex in self.deny_res) if self.deny_res else [] return any(allowed) and not any(denied) @@ -200,9 +231,7 @@ class LxmlLinkExtractor: base_url = get_base_url(response) if self.restrict_xpaths: docs = [ - subdoc - for x in self.restrict_xpaths - for subdoc in response.xpath(x) + subdoc for x in self.restrict_xpaths for subdoc in response.xpath(x) ] else: docs = [response.selector] diff --git a/scrapy/loader/common.py b/scrapy/loader/common.py index 3b8a6ee94..3e8644e0c 100644 --- a/scrapy/loader/common.py +++ b/scrapy/loader/common.py @@ -15,7 +15,7 @@ def wrap_loader_context(function, context): "scrapy.loader.common.wrap_loader_context has moved to a new library." "Please update your reference to itemloaders.common.wrap_loader_context", ScrapyDeprecationWarning, - stacklevel=2 + stacklevel=2, ) return common.wrap_loader_context(function, context) diff --git a/scrapy/loader/processors.py b/scrapy/loader/processors.py index 51fbd19eb..f27a669d6 100644 --- a/scrapy/loader/processors.py +++ b/scrapy/loader/processors.py @@ -8,14 +8,14 @@ from itemloaders import processors from scrapy.utils.deprecate import create_deprecated_class -MapCompose = create_deprecated_class('MapCompose', processors.MapCompose) +MapCompose = create_deprecated_class("MapCompose", processors.MapCompose) -Compose = create_deprecated_class('Compose', processors.Compose) +Compose = create_deprecated_class("Compose", processors.Compose) -TakeFirst = create_deprecated_class('TakeFirst', processors.TakeFirst) +TakeFirst = create_deprecated_class("TakeFirst", processors.TakeFirst) -Identity = create_deprecated_class('Identity', processors.Identity) +Identity = create_deprecated_class("Identity", processors.Identity) -SelectJmes = create_deprecated_class('SelectJmes', processors.SelectJmes) +SelectJmes = create_deprecated_class("SelectJmes", processors.SelectJmes) -Join = create_deprecated_class('Join', processors.Join) +Join = create_deprecated_class("Join", processors.Join) diff --git a/scrapy/logformatter.py b/scrapy/logformatter.py index 87568b2d1..e0b93d812 100644 --- a/scrapy/logformatter.py +++ b/scrapy/logformatter.py @@ -54,20 +54,20 @@ class LogFormatter: def crawled(self, request, response, spider): """Logs a message when the crawler finds a webpage.""" - request_flags = f' {str(request.flags)}' if request.flags else '' - response_flags = f' {str(response.flags)}' if response.flags else '' + request_flags = f" {str(request.flags)}" if request.flags else "" + response_flags = f" {str(response.flags)}" if response.flags else "" return { - 'level': logging.DEBUG, - 'msg': CRAWLEDMSG, - 'args': { - 'status': response.status, - 'request': request, - 'request_flags': request_flags, - 'referer': referer_str(request), - 'response_flags': response_flags, + "level": logging.DEBUG, + "msg": CRAWLEDMSG, + "args": { + "status": response.status, + "request": request, + "request_flags": request_flags, + "referer": referer_str(request), + "response_flags": response_flags, # backward compatibility with Scrapy logformatter below 1.4 version - 'flags': response_flags - } + "flags": response_flags, + }, } def scraped(self, item, response, spider): @@ -77,23 +77,23 @@ class LogFormatter: else: src = response return { - 'level': logging.DEBUG, - 'msg': SCRAPEDMSG, - 'args': { - 'src': src, - 'item': item, - } + "level": logging.DEBUG, + "msg": SCRAPEDMSG, + "args": { + "src": src, + "item": item, + }, } def dropped(self, item, exception, response, spider): """Logs a message when an item is dropped while it is passing through the item pipeline.""" return { - 'level': logging.WARNING, - 'msg': DROPPEDMSG, - 'args': { - 'exception': exception, - 'item': item, - } + "level": logging.WARNING, + "msg": DROPPEDMSG, + "args": { + "exception": exception, + "item": item, + }, } def item_error(self, item, exception, response, spider): @@ -103,11 +103,11 @@ class LogFormatter: .. versionadded:: 2.0 """ return { - 'level': logging.ERROR, - 'msg': ITEMERRORMSG, - 'args': { - 'item': item, - } + "level": logging.ERROR, + "msg": ITEMERRORMSG, + "args": { + "item": item, + }, } def spider_error(self, failure, request, response, spider): @@ -116,12 +116,12 @@ class LogFormatter: .. versionadded:: 2.0 """ return { - 'level': logging.ERROR, - 'msg': SPIDERERRORMSG, - 'args': { - 'request': request, - 'referer': referer_str(request), - } + "level": logging.ERROR, + "msg": SPIDERERRORMSG, + "args": { + "request": request, + "referer": referer_str(request), + }, } def download_error(self, failure, request, spider, errmsg=None): @@ -130,16 +130,16 @@ class LogFormatter: .. versionadded:: 2.0 """ - args = {'request': request} + args = {"request": request} if errmsg: msg = DOWNLOADERRORMSG_LONG - args['errmsg'] = errmsg + args["errmsg"] = errmsg else: msg = DOWNLOADERRORMSG_SHORT return { - 'level': logging.ERROR, - 'msg': msg, - 'args': args, + "level": logging.ERROR, + "msg": msg, + "args": args, } @classmethod diff --git a/scrapy/mail.py b/scrapy/mail.py index 2a25ccd44..fbde9c547 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -34,8 +34,15 @@ def _to_bytes_or_none(text): class MailSender: def __init__( - self, smtphost='localhost', mailfrom='scrapy@localhost', smtpuser=None, - smtppass=None, smtpport=25, smtptls=False, smtpssl=False, debug=False + self, + smtphost="localhost", + mailfrom="scrapy@localhost", + smtpuser=None, + smtppass=None, + smtpport=25, + smtptls=False, + smtpssl=False, + debug=False, ): self.smtphost = smtphost self.smtpport = smtpport @@ -49,44 +56,57 @@ class MailSender: @classmethod def from_settings(cls, settings): return cls( - smtphost=settings['MAIL_HOST'], - mailfrom=settings['MAIL_FROM'], - smtpuser=settings['MAIL_USER'], - smtppass=settings['MAIL_PASS'], - smtpport=settings.getint('MAIL_PORT'), - smtptls=settings.getbool('MAIL_TLS'), - smtpssl=settings.getbool('MAIL_SSL'), + smtphost=settings["MAIL_HOST"], + mailfrom=settings["MAIL_FROM"], + smtpuser=settings["MAIL_USER"], + smtppass=settings["MAIL_PASS"], + smtpport=settings.getint("MAIL_PORT"), + smtptls=settings.getbool("MAIL_TLS"), + smtpssl=settings.getbool("MAIL_SSL"), ) - def send(self, to, subject, body, cc=None, attachs=(), mimetype='text/plain', charset=None, _callback=None): + def send( + self, + to, + subject, + body, + cc=None, + attachs=(), + mimetype="text/plain", + charset=None, + _callback=None, + ): from twisted.internet import reactor + if attachs: msg = MIMEMultipart() else: - msg = MIMENonMultipart(*mimetype.split('/', 1)) + msg = MIMENonMultipart(*mimetype.split("/", 1)) to = list(arg_to_iter(to)) cc = list(arg_to_iter(cc)) - msg['From'] = self.mailfrom - msg['To'] = COMMASPACE.join(to) - msg['Date'] = formatdate(localtime=True) - msg['Subject'] = subject + msg["From"] = self.mailfrom + msg["To"] = COMMASPACE.join(to) + msg["Date"] = formatdate(localtime=True) + msg["Subject"] = subject rcpts = to[:] if cc: rcpts.extend(cc) - msg['Cc'] = COMMASPACE.join(cc) + msg["Cc"] = COMMASPACE.join(cc) if charset: msg.set_charset(charset) if attachs: - msg.attach(MIMEText(body, 'plain', charset or 'us-ascii')) + msg.attach(MIMEText(body, "plain", charset or "us-ascii")) for attach_name, mimetype, f in attachs: - part = MIMEBase(*mimetype.split('/')) + part = MIMEBase(*mimetype.split("/")) part.set_payload(f.read()) Encoders.encode_base64(part) - part.add_header('Content-Disposition', 'attachment', filename=attach_name) + part.add_header( + "Content-Disposition", "attachment", filename=attach_name + ) msg.attach(part) else: msg.set_payload(body) @@ -95,50 +115,79 @@ class MailSender: _callback(to=to, subject=subject, body=body, cc=cc, attach=attachs, msg=msg) if self.debug: - logger.debug('Debug mail sent OK: To=%(mailto)s Cc=%(mailcc)s ' - 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d', - {'mailto': to, 'mailcc': cc, 'mailsubject': subject, - 'mailattachs': len(attachs)}) + logger.debug( + "Debug mail sent OK: To=%(mailto)s Cc=%(mailcc)s " + 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d', + { + "mailto": to, + "mailcc": cc, + "mailsubject": subject, + "mailattachs": len(attachs), + }, + ) return - dfd = self._sendmail(rcpts, msg.as_string().encode(charset or 'utf-8')) + dfd = self._sendmail(rcpts, msg.as_string().encode(charset or "utf-8")) dfd.addCallbacks( callback=self._sent_ok, errback=self._sent_failed, callbackArgs=[to, cc, subject, len(attachs)], errbackArgs=[to, cc, subject, len(attachs)], ) - reactor.addSystemEventTrigger('before', 'shutdown', lambda: dfd) + reactor.addSystemEventTrigger("before", "shutdown", lambda: dfd) return dfd def _sent_ok(self, result, to, cc, subject, nattachs): - logger.info('Mail sent OK: To=%(mailto)s Cc=%(mailcc)s ' - 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d', - {'mailto': to, 'mailcc': cc, 'mailsubject': subject, - 'mailattachs': nattachs}) + logger.info( + "Mail sent OK: To=%(mailto)s Cc=%(mailcc)s " + 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d', + { + "mailto": to, + "mailcc": cc, + "mailsubject": subject, + "mailattachs": nattachs, + }, + ) def _sent_failed(self, failure, to, cc, subject, nattachs): errstr = str(failure.value) - logger.error('Unable to send mail: To=%(mailto)s Cc=%(mailcc)s ' - 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d' - '- %(mailerr)s', - {'mailto': to, 'mailcc': cc, 'mailsubject': subject, - 'mailattachs': nattachs, 'mailerr': errstr}) + logger.error( + "Unable to send mail: To=%(mailto)s Cc=%(mailcc)s " + 'Subject="%(mailsubject)s" Attachs=%(mailattachs)d' + "- %(mailerr)s", + { + "mailto": to, + "mailcc": cc, + "mailsubject": subject, + "mailattachs": nattachs, + "mailerr": errstr, + }, + ) def _sendmail(self, to_addrs, msg): # Import twisted.mail here because it is not available in python3 from twisted.internet import reactor from twisted.mail.smtp import ESMTPSenderFactory + msg = BytesIO(msg) d = defer.Deferred() factory = ESMTPSenderFactory( - self.smtpuser, self.smtppass, self.mailfrom, to_addrs, msg, d, - heloFallback=True, requireAuthentication=False, requireTransportSecurity=self.smtptls, + self.smtpuser, + self.smtppass, + self.mailfrom, + to_addrs, + msg, + d, + heloFallback=True, + requireAuthentication=False, + requireTransportSecurity=self.smtptls, ) factory.noisy = False if self.smtpssl: - reactor.connectSSL(self.smtphost, self.smtpport, factory, ssl.ClientContextFactory()) + reactor.connectSSL( + self.smtphost, self.smtpport, factory, ssl.ClientContextFactory() + ) else: reactor.connectTCP(self.smtphost, self.smtpport, factory) diff --git a/scrapy/middleware.py b/scrapy/middleware.py index 431bd76dc..15f5b23e0 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -17,13 +17,15 @@ logger = logging.getLogger(__name__) class MiddlewareManager: """Base class for implementing middleware managers""" - component_name = 'foo middleware' + component_name = "foo middleware" def __init__(self, *middlewares: Any) -> None: self.middlewares = middlewares # Only process_spider_output and process_spider_exception can be None. # Only process_spider_output can be a tuple, and only until _async compatibility methods are removed. - self.methods: Dict[str, Deque[Union[None, Callable, Tuple[Callable, Callable]]]] = defaultdict(deque) + self.methods: Dict[ + str, Deque[Union[None, Callable, Tuple[Callable, Callable]]] + ] = defaultdict(deque) for mw in middlewares: self._add_middleware(mw) @@ -44,15 +46,21 @@ class MiddlewareManager: enabled.append(clspath) except NotConfigured as e: if e.args: - clsname = clspath.split('.')[-1] - logger.warning("Disabled %(clsname)s: %(eargs)s", - {'clsname': clsname, 'eargs': e.args[0]}, - extra={'crawler': crawler}) + clsname = clspath.split(".")[-1] + logger.warning( + "Disabled %(clsname)s: %(eargs)s", + {"clsname": clsname, "eargs": e.args[0]}, + extra={"crawler": crawler}, + ) - logger.info("Enabled %(componentname)ss:\n%(enabledlist)s", - {'componentname': cls.component_name, - 'enabledlist': pprint.pformat(enabled)}, - extra={'crawler': crawler}) + logger.info( + "Enabled %(componentname)ss:\n%(enabledlist)s", + { + "componentname": cls.component_name, + "enabledlist": pprint.pformat(enabled), + }, + extra={"crawler": crawler}, + ) return cls(*middlewares) @classmethod @@ -60,10 +68,10 @@ class MiddlewareManager: return cls.from_settings(crawler.settings, crawler) def _add_middleware(self, mw) -> None: - if hasattr(mw, 'open_spider'): - self.methods['open_spider'].append(mw.open_spider) - if hasattr(mw, 'close_spider'): - self.methods['close_spider'].appendleft(mw.close_spider) + if hasattr(mw, "open_spider"): + self.methods["open_spider"].append(mw.open_spider) + if hasattr(mw, "close_spider"): + self.methods["close_spider"].appendleft(mw.close_spider) def _process_parallel(self, methodname: str, obj, *args) -> Deferred: methods = cast(Iterable[Callable], self.methods[methodname]) @@ -74,7 +82,7 @@ class MiddlewareManager: return process_chain(methods, obj, *args) def open_spider(self, spider: Spider) -> Deferred: - return self._process_parallel('open_spider', spider) + return self._process_parallel("open_spider", spider) def close_spider(self, spider: Spider) -> Deferred: - return self._process_parallel('close_spider', spider) + return self._process_parallel("close_spider", spider) diff --git a/scrapy/pipelines/__init__.py b/scrapy/pipelines/__init__.py index c42dd423e..536341fc6 100644 --- a/scrapy/pipelines/__init__.py +++ b/scrapy/pipelines/__init__.py @@ -11,16 +11,18 @@ from scrapy.utils.defer import deferred_f_from_coro_f class ItemPipelineManager(MiddlewareManager): - component_name = 'item pipeline' + component_name = "item pipeline" @classmethod def _get_mwlist_from_settings(cls, settings): - return build_component_list(settings.getwithbase('ITEM_PIPELINES')) + return build_component_list(settings.getwithbase("ITEM_PIPELINES")) def _add_middleware(self, pipe): super()._add_middleware(pipe) - if hasattr(pipe, 'process_item'): - self.methods['process_item'].append(deferred_f_from_coro_f(pipe.process_item)) + if hasattr(pipe, "process_item"): + self.methods["process_item"].append( + deferred_f_from_coro_f(pipe.process_item) + ) def process_item(self, item, spider): - return self._process_chain('process_item', item, spider) + return self._process_chain("process_item", item, spider) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 51aedafe8..01a9c41fe 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -42,8 +42,8 @@ class FileException(Exception): class FSFilesStore: def __init__(self, basedir: str): - if '://' in basedir: - basedir = basedir.split('://', 1)[1] + if "://" in basedir: + basedir = basedir.split("://", 1)[1] self.basedir = basedir self._mkdir(Path(self.basedir)) self.created_directories: DefaultDict[str, Set[str]] = defaultdict(set) @@ -60,13 +60,13 @@ class FSFilesStore: except os.error: return {} - with absolute_path.open('rb') as f: + with absolute_path.open("rb") as f: checksum = md5sum(f) - return {'last_modified': last_modified, 'checksum': checksum} + return {"last_modified": last_modified, "checksum": checksum} def _get_filesystem_path(self, path: str) -> Path: - path_comps = path.split('/') + path_comps = path.split("/") return Path(self.basedir, *path_comps) def _mkdir(self, dirname: Path, domain: Optional[str] = None): @@ -86,49 +86,49 @@ class S3FilesStore: AWS_USE_SSL = None AWS_VERIFY = None - POLICY = 'private' # Overridden from settings.FILES_STORE_S3_ACL in FilesPipeline.from_settings + POLICY = "private" # Overridden from settings.FILES_STORE_S3_ACL in FilesPipeline.from_settings HEADERS = { - 'Cache-Control': 'max-age=172800', + "Cache-Control": "max-age=172800", } def __init__(self, uri): if not is_botocore_available(): - raise NotConfigured('missing botocore library') + raise NotConfigured("missing botocore library") import botocore.session + session = botocore.session.get_session() self.s3_client = session.create_client( - 's3', + "s3", aws_access_key_id=self.AWS_ACCESS_KEY_ID, aws_secret_access_key=self.AWS_SECRET_ACCESS_KEY, aws_session_token=self.AWS_SESSION_TOKEN, endpoint_url=self.AWS_ENDPOINT_URL, region_name=self.AWS_REGION_NAME, use_ssl=self.AWS_USE_SSL, - verify=self.AWS_VERIFY + verify=self.AWS_VERIFY, ) if not uri.startswith("s3://"): raise ValueError(f"Incorrect URI scheme in {uri}, expected 's3'") - self.bucket, self.prefix = uri[5:].split('/', 1) + self.bucket, self.prefix = uri[5:].split("/", 1) def stat_file(self, path, info): def _onsuccess(boto_key): - checksum = boto_key['ETag'].strip('"') - last_modified = boto_key['LastModified'] + checksum = boto_key["ETag"].strip('"') + last_modified = boto_key["LastModified"] modified_stamp = time.mktime(last_modified.timetuple()) - return {'checksum': checksum, 'last_modified': modified_stamp} + return {"checksum": checksum, "last_modified": modified_stamp} return self._get_boto_key(path).addCallback(_onsuccess) def _get_boto_key(self, path): - key_name = f'{self.prefix}{path}' + key_name = f"{self.prefix}{path}" return threads.deferToThread( - self.s3_client.head_object, - Bucket=self.bucket, - Key=key_name) + self.s3_client.head_object, Bucket=self.bucket, Key=key_name + ) def persist_file(self, path, buf, info, meta=None, headers=None): """Upload file to S3 storage""" - key_name = f'{self.prefix}{path}' + key_name = f"{self.prefix}{path}" buf.seek(0) extra = self._headers_to_botocore_kwargs(self.HEADERS) if headers: @@ -140,39 +140,41 @@ class S3FilesStore: Body=buf, Metadata={k: str(v) for k, v in (meta or {}).items()}, ACL=self.POLICY, - **extra) + **extra, + ) def _headers_to_botocore_kwargs(self, headers): - """ Convert headers to botocore keyword arguments. - """ + """Convert headers to botocore keyword arguments.""" # This is required while we need to support both boto and botocore. - mapping = CaselessDict({ - 'Content-Type': 'ContentType', - 'Cache-Control': 'CacheControl', - 'Content-Disposition': 'ContentDisposition', - 'Content-Encoding': 'ContentEncoding', - 'Content-Language': 'ContentLanguage', - 'Content-Length': 'ContentLength', - 'Content-MD5': 'ContentMD5', - 'Expires': 'Expires', - 'X-Amz-Grant-Full-Control': 'GrantFullControl', - 'X-Amz-Grant-Read': 'GrantRead', - 'X-Amz-Grant-Read-ACP': 'GrantReadACP', - 'X-Amz-Grant-Write-ACP': 'GrantWriteACP', - 'X-Amz-Object-Lock-Legal-Hold': 'ObjectLockLegalHoldStatus', - 'X-Amz-Object-Lock-Mode': 'ObjectLockMode', - 'X-Amz-Object-Lock-Retain-Until-Date': 'ObjectLockRetainUntilDate', - 'X-Amz-Request-Payer': 'RequestPayer', - 'X-Amz-Server-Side-Encryption': 'ServerSideEncryption', - 'X-Amz-Server-Side-Encryption-Aws-Kms-Key-Id': 'SSEKMSKeyId', - 'X-Amz-Server-Side-Encryption-Context': 'SSEKMSEncryptionContext', - 'X-Amz-Server-Side-Encryption-Customer-Algorithm': 'SSECustomerAlgorithm', - 'X-Amz-Server-Side-Encryption-Customer-Key': 'SSECustomerKey', - 'X-Amz-Server-Side-Encryption-Customer-Key-Md5': 'SSECustomerKeyMD5', - 'X-Amz-Storage-Class': 'StorageClass', - 'X-Amz-Tagging': 'Tagging', - 'X-Amz-Website-Redirect-Location': 'WebsiteRedirectLocation', - }) + mapping = CaselessDict( + { + "Content-Type": "ContentType", + "Cache-Control": "CacheControl", + "Content-Disposition": "ContentDisposition", + "Content-Encoding": "ContentEncoding", + "Content-Language": "ContentLanguage", + "Content-Length": "ContentLength", + "Content-MD5": "ContentMD5", + "Expires": "Expires", + "X-Amz-Grant-Full-Control": "GrantFullControl", + "X-Amz-Grant-Read": "GrantRead", + "X-Amz-Grant-Read-ACP": "GrantReadACP", + "X-Amz-Grant-Write-ACP": "GrantWriteACP", + "X-Amz-Object-Lock-Legal-Hold": "ObjectLockLegalHoldStatus", + "X-Amz-Object-Lock-Mode": "ObjectLockMode", + "X-Amz-Object-Lock-Retain-Until-Date": "ObjectLockRetainUntilDate", + "X-Amz-Request-Payer": "RequestPayer", + "X-Amz-Server-Side-Encryption": "ServerSideEncryption", + "X-Amz-Server-Side-Encryption-Aws-Kms-Key-Id": "SSEKMSKeyId", + "X-Amz-Server-Side-Encryption-Context": "SSEKMSEncryptionContext", + "X-Amz-Server-Side-Encryption-Customer-Algorithm": "SSECustomerAlgorithm", + "X-Amz-Server-Side-Encryption-Customer-Key": "SSECustomerKey", + "X-Amz-Server-Side-Encryption-Customer-Key-Md5": "SSECustomerKeyMD5", + "X-Amz-Storage-Class": "StorageClass", + "X-Amz-Tagging": "Tagging", + "X-Amz-Website-Redirect-Location": "WebsiteRedirectLocation", + } + ) extra = {} for key, value in headers.items(): try: @@ -188,7 +190,7 @@ class GCSFilesStore: GCS_PROJECT_ID = None - CACHE_CONTROL = 'max-age=172800' + CACHE_CONTROL = "max-age=172800" # The bucket's default object ACL will be applied to the object. # Overridden from settings.FILES_STORE_GCS_ACL in FilesPipeline.from_settings. @@ -196,23 +198,24 @@ class GCSFilesStore: def __init__(self, uri): from google.cloud import storage + client = storage.Client(project=self.GCS_PROJECT_ID) - bucket, prefix = uri[5:].split('/', 1) + bucket, prefix = uri[5:].split("/", 1) self.bucket = client.bucket(bucket) self.prefix = prefix permissions = self.bucket.test_iam_permissions( - ['storage.objects.get', 'storage.objects.create'] + ["storage.objects.get", "storage.objects.create"] ) - if 'storage.objects.get' not in permissions: + if "storage.objects.get" not in permissions: logger.warning( "No 'storage.objects.get' permission for GSC bucket %(bucket)s. " "Checking if files are up to date will be impossible. Files will be downloaded every time.", - {'bucket': bucket} + {"bucket": bucket}, ) - if 'storage.objects.create' not in permissions: + if "storage.objects.create" not in permissions: logger.error( "No 'storage.objects.create' permission for GSC bucket %(bucket)s. Saving files will be impossible!", - {'bucket': bucket} + {"bucket": bucket}, ) def stat_file(self, path, info): @@ -220,15 +223,18 @@ class GCSFilesStore: if blob: checksum = blob.md5_hash last_modified = time.mktime(blob.updated.timetuple()) - return {'checksum': checksum, 'last_modified': last_modified} + return {"checksum": checksum, "last_modified": last_modified} return {} + blob_path = self._get_blob_path(path) - return threads.deferToThread(self.bucket.get_blob, blob_path).addCallback(_onsuccess) + return threads.deferToThread(self.bucket.get_blob, blob_path).addCallback( + _onsuccess + ) def _get_content_type(self, headers): - if headers and 'Content-Type' in headers: - return headers['Content-Type'] - return 'application/octet-stream' + if headers and "Content-Type" in headers: + return headers["Content-Type"] + return "application/octet-stream" def _get_blob_path(self, path): return self.prefix + path @@ -242,7 +248,7 @@ class GCSFilesStore: blob.upload_from_string, data=buf.getvalue(), content_type=self._get_content_type(headers), - predefined_acl=self.POLICY + predefined_acl=self.POLICY, ) @@ -261,14 +267,19 @@ class FTPFilesStore: self.port = int(u.port or 21) self.username = u.username or self.FTP_USERNAME self.password = u.password or self.FTP_PASSWORD - self.basedir = u.path.rstrip('/') + self.basedir = u.path.rstrip("/") def persist_file(self, path, buf, info, meta=None, headers=None): - path = f'{self.basedir}/{path}' + path = f"{self.basedir}/{path}" return threads.deferToThread( - ftp_store_file, path=path, file=buf, - host=self.host, port=self.port, username=self.username, - password=self.password, use_active_mode=self.USE_ACTIVE_MODE + ftp_store_file, + path=path, + file=buf, + host=self.host, + port=self.port, + username=self.username, + password=self.password, + use_active_mode=self.USE_ACTIVE_MODE, ) def stat_file(self, path, info): @@ -282,11 +293,12 @@ class FTPFilesStore: file_path = f"{self.basedir}/{path}" last_modified = float(ftp.voidcmd(f"MDTM {file_path}")[4:].strip()) m = hashlib.md5() - ftp.retrbinary(f'RETR {file_path}', m.update) - return {'last_modified': last_modified, 'checksum': m.hexdigest()} + ftp.retrbinary(f"RETR {file_path}", m.update) + return {"last_modified": last_modified, "checksum": m.hexdigest()} # The file doesn't exist except Exception: return {} + return threads.deferToThread(_stat_file, path) @@ -312,14 +324,14 @@ class FilesPipeline(MediaPipeline): MEDIA_NAME = "file" EXPIRES = 90 STORE_SCHEMES = { - '': FSFilesStore, - 'file': FSFilesStore, - 's3': S3FilesStore, - 'gs': GCSFilesStore, - 'ftp': FTPFilesStore + "": FSFilesStore, + "file": FSFilesStore, + "s3": S3FilesStore, + "gs": GCSFilesStore, + "ftp": FTPFilesStore, } - DEFAULT_FILES_URLS_FIELD = 'file_urls' - DEFAULT_FILES_RESULT_FIELD = 'files' + DEFAULT_FILES_URLS_FIELD = "file_urls" + DEFAULT_FILES_RESULT_FIELD = "files" def __init__(self, store_uri, download_func=None, settings=None): if not store_uri: @@ -330,52 +342,50 @@ class FilesPipeline(MediaPipeline): cls_name = "FilesPipeline" self.store = self._get_store(store_uri) - resolve = functools.partial(self._key_for_pipe, - base_class_name=cls_name, - settings=settings) - self.expires = settings.getint( - resolve('FILES_EXPIRES'), self.EXPIRES + resolve = functools.partial( + self._key_for_pipe, base_class_name=cls_name, settings=settings ) + self.expires = settings.getint(resolve("FILES_EXPIRES"), self.EXPIRES) if not hasattr(self, "FILES_URLS_FIELD"): self.FILES_URLS_FIELD = self.DEFAULT_FILES_URLS_FIELD if not hasattr(self, "FILES_RESULT_FIELD"): self.FILES_RESULT_FIELD = self.DEFAULT_FILES_RESULT_FIELD self.files_urls_field = settings.get( - resolve('FILES_URLS_FIELD'), self.FILES_URLS_FIELD + resolve("FILES_URLS_FIELD"), self.FILES_URLS_FIELD ) self.files_result_field = settings.get( - resolve('FILES_RESULT_FIELD'), self.FILES_RESULT_FIELD + resolve("FILES_RESULT_FIELD"), self.FILES_RESULT_FIELD ) super().__init__(download_func=download_func, settings=settings) @classmethod def from_settings(cls, settings): - s3store = cls.STORE_SCHEMES['s3'] - s3store.AWS_ACCESS_KEY_ID = settings['AWS_ACCESS_KEY_ID'] - s3store.AWS_SECRET_ACCESS_KEY = settings['AWS_SECRET_ACCESS_KEY'] - s3store.AWS_SESSION_TOKEN = settings['AWS_SESSION_TOKEN'] - s3store.AWS_ENDPOINT_URL = settings['AWS_ENDPOINT_URL'] - s3store.AWS_REGION_NAME = settings['AWS_REGION_NAME'] - s3store.AWS_USE_SSL = settings['AWS_USE_SSL'] - s3store.AWS_VERIFY = settings['AWS_VERIFY'] - s3store.POLICY = settings['FILES_STORE_S3_ACL'] + s3store = cls.STORE_SCHEMES["s3"] + s3store.AWS_ACCESS_KEY_ID = settings["AWS_ACCESS_KEY_ID"] + s3store.AWS_SECRET_ACCESS_KEY = settings["AWS_SECRET_ACCESS_KEY"] + s3store.AWS_SESSION_TOKEN = settings["AWS_SESSION_TOKEN"] + s3store.AWS_ENDPOINT_URL = settings["AWS_ENDPOINT_URL"] + s3store.AWS_REGION_NAME = settings["AWS_REGION_NAME"] + s3store.AWS_USE_SSL = settings["AWS_USE_SSL"] + s3store.AWS_VERIFY = settings["AWS_VERIFY"] + s3store.POLICY = settings["FILES_STORE_S3_ACL"] - gcs_store = cls.STORE_SCHEMES['gs'] - gcs_store.GCS_PROJECT_ID = settings['GCS_PROJECT_ID'] - gcs_store.POLICY = settings['FILES_STORE_GCS_ACL'] or None + gcs_store = cls.STORE_SCHEMES["gs"] + gcs_store.GCS_PROJECT_ID = settings["GCS_PROJECT_ID"] + gcs_store.POLICY = settings["FILES_STORE_GCS_ACL"] or None - ftp_store = cls.STORE_SCHEMES['ftp'] - ftp_store.FTP_USERNAME = settings['FTP_USER'] - ftp_store.FTP_PASSWORD = settings['FTP_PASSWORD'] - ftp_store.USE_ACTIVE_MODE = settings.getbool('FEED_STORAGE_FTP_ACTIVE') + ftp_store = cls.STORE_SCHEMES["ftp"] + ftp_store.FTP_USERNAME = settings["FTP_USER"] + ftp_store.FTP_PASSWORD = settings["FTP_PASSWORD"] + ftp_store.USE_ACTIVE_MODE = settings.getbool("FEED_STORAGE_FTP_ACTIVE") - store_uri = settings['FILES_STORE'] + store_uri = settings["FILES_STORE"] return cls(store_uri, settings=settings) def _get_store(self, uri: str): if Path(uri).is_absolute(): # to support win32 paths like: C:\\some\dir - scheme = 'file' + scheme = "file" else: scheme = urlparse(uri).scheme store_cls = self.STORE_SCHEMES[scheme] @@ -386,7 +396,7 @@ class FilesPipeline(MediaPipeline): if not result: return # returning None force download - last_modified = result.get('last_modified', None) + last_modified = result.get("last_modified", None) if not last_modified: return # returning None force download @@ -397,25 +407,30 @@ class FilesPipeline(MediaPipeline): referer = referer_str(request) logger.debug( - 'File (uptodate): Downloaded %(medianame)s from %(request)s ' - 'referred in <%(referer)s>', - {'medianame': self.MEDIA_NAME, 'request': request, - 'referer': referer}, - extra={'spider': info.spider} + "File (uptodate): Downloaded %(medianame)s from %(request)s " + "referred in <%(referer)s>", + {"medianame": self.MEDIA_NAME, "request": request, "referer": referer}, + extra={"spider": info.spider}, ) - self.inc_stats(info.spider, 'uptodate') + self.inc_stats(info.spider, "uptodate") - checksum = result.get('checksum', None) - return {'url': request.url, 'path': path, 'checksum': checksum, 'status': 'uptodate'} + checksum = result.get("checksum", None) + return { + "url": request.url, + "path": path, + "checksum": checksum, + "status": "uptodate", + } path = self.file_path(request, info=info, item=item) dfd = defer.maybeDeferred(self.store.stat_file, path, info) dfd.addCallbacks(_onsuccess, lambda _: None) dfd.addErrback( - lambda f: - logger.error(self.__class__.__name__ + '.store.stat_file', - exc_info=failure_to_exc_info(f), - extra={'spider': info.spider}) + lambda f: logger.error( + self.__class__.__name__ + ".store.stat_file", + exc_info=failure_to_exc_info(f), + extra={"spider": info.spider}, + ) ) return dfd @@ -423,11 +438,15 @@ class FilesPipeline(MediaPipeline): if not isinstance(failure.value, IgnoreRequest): referer = referer_str(request) logger.warning( - 'File (unknown-error): Error downloading %(medianame)s from ' - '%(request)s referred in <%(referer)s>: %(exception)s', - {'medianame': self.MEDIA_NAME, 'request': request, - 'referer': referer, 'exception': failure.value}, - extra={'spider': info.spider} + "File (unknown-error): Error downloading %(medianame)s from " + "%(request)s referred in <%(referer)s>: %(exception)s", + { + "medianame": self.MEDIA_NAME, + "request": request, + "referer": referer, + "exception": failure.value, + }, + extra={"spider": info.spider}, ) raise FileException @@ -437,29 +456,28 @@ class FilesPipeline(MediaPipeline): if response.status != 200: logger.warning( - 'File (code: %(status)s): Error downloading file from ' - '%(request)s referred in <%(referer)s>', - {'status': response.status, - 'request': request, 'referer': referer}, - extra={'spider': info.spider} + "File (code: %(status)s): Error downloading file from " + "%(request)s referred in <%(referer)s>", + {"status": response.status, "request": request, "referer": referer}, + extra={"spider": info.spider}, ) - raise FileException('download-error') + raise FileException("download-error") if not response.body: logger.warning( - 'File (empty-content): Empty file from %(request)s referred ' - 'in <%(referer)s>: no-content', - {'request': request, 'referer': referer}, - extra={'spider': info.spider} + "File (empty-content): Empty file from %(request)s referred " + "in <%(referer)s>: no-content", + {"request": request, "referer": referer}, + extra={"spider": info.spider}, ) - raise FileException('empty-content') + raise FileException("empty-content") - status = 'cached' if 'cached' in response.flags else 'downloaded' + status = "cached" if "cached" in response.flags else "downloaded" logger.debug( - 'File (%(status)s): Downloaded file from %(request)s referred in ' - '<%(referer)s>', - {'status': status, 'request': request, 'referer': referer}, - extra={'spider': info.spider} + "File (%(status)s): Downloaded file from %(request)s referred in " + "<%(referer)s>", + {"status": status, "request": request, "referer": referer}, + extra={"spider": info.spider}, ) self.inc_stats(info.spider, status) @@ -468,26 +486,33 @@ class FilesPipeline(MediaPipeline): checksum = self.file_downloaded(response, request, info, item=item) except FileException as exc: logger.warning( - 'File (error): Error processing file from %(request)s ' - 'referred in <%(referer)s>: %(errormsg)s', - {'request': request, 'referer': referer, 'errormsg': str(exc)}, - extra={'spider': info.spider}, exc_info=True + "File (error): Error processing file from %(request)s " + "referred in <%(referer)s>: %(errormsg)s", + {"request": request, "referer": referer, "errormsg": str(exc)}, + extra={"spider": info.spider}, + exc_info=True, ) raise except Exception as exc: logger.error( - 'File (unknown-error): Error processing file from %(request)s ' - 'referred in <%(referer)s>', - {'request': request, 'referer': referer}, - exc_info=True, extra={'spider': info.spider} + "File (unknown-error): Error processing file from %(request)s " + "referred in <%(referer)s>", + {"request": request, "referer": referer}, + exc_info=True, + extra={"spider": info.spider}, ) raise FileException(str(exc)) - return {'url': request.url, 'path': path, 'checksum': checksum, 'status': status} + return { + "url": request.url, + "path": path, + "checksum": checksum, + "status": status, + } def inc_stats(self, spider, status): - spider.crawler.stats.inc_value('file_count', spider=spider) - spider.crawler.stats.inc_value(f'file_status_count/{status}', spider=spider) + spider.crawler.stats.inc_value("file_count", spider=spider) + spider.crawler.stats.inc_value(f"file_status_count/{status}", spider=spider) # Overridable Interface def get_media_requests(self, item, info): @@ -513,8 +538,8 @@ class FilesPipeline(MediaPipeline): # Handles empty and wild extensions by trying to guess the # mime type then extension or default to empty string otherwise if media_ext not in mimetypes.types_map: - media_ext = '' + media_ext = "" media_type = mimetypes.guess_type(request.url)[0] if media_type: media_ext = mimetypes.guess_extension(media_type) - return f'full/{media_guid}{media_ext}' + return f"full/{media_guid}{media_ext}" diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 6a28a3b87..b8724a1cd 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -14,6 +14,7 @@ from itemadapter import ItemAdapter from scrapy.exceptions import DropItem, NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request from scrapy.pipelines.files import FileException, FilesPipeline + # TODO: from scrapy.pipelines.media import MediaPipeline from scrapy.settings import Settings from scrapy.utils.misc import md5sum @@ -24,7 +25,11 @@ class NoimagesDrop(DropItem): """Product with no images exception""" def __init__(self, *args, **kwargs): - warnings.warn("The NoimagesDrop class is deprecated", category=ScrapyDeprecationWarning, stacklevel=2) + warnings.warn( + "The NoimagesDrop class is deprecated", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) super().__init__(*args, **kwargs) @@ -33,11 +38,9 @@ class ImageException(FileException): class ImagesPipeline(FilesPipeline): - """Abstract pipeline that implement the image thumbnail generation logic + """Abstract pipeline that implement the image thumbnail generation logic""" - """ - - MEDIA_NAME = 'image' + MEDIA_NAME = "image" # Uppercase attributes kept for backward compatibility with code that subclasses # ImagesPipeline. They may be overridden by settings. @@ -45,16 +48,17 @@ class ImagesPipeline(FilesPipeline): MIN_HEIGHT = 0 EXPIRES = 90 THUMBS = {} - DEFAULT_IMAGES_URLS_FIELD = 'image_urls' - DEFAULT_IMAGES_RESULT_FIELD = 'images' + DEFAULT_IMAGES_URLS_FIELD = "image_urls" + DEFAULT_IMAGES_RESULT_FIELD = "images" def __init__(self, store_uri, download_func=None, settings=None): try: from PIL import Image + self._Image = Image except ImportError: raise NotConfigured( - 'ImagesPipeline requires installing Pillow 4.0.0 or later' + "ImagesPipeline requires installing Pillow 4.0.0 or later" ) super().__init__(store_uri, settings=settings, download_func=download_func) @@ -62,12 +66,10 @@ class ImagesPipeline(FilesPipeline): if isinstance(settings, dict) or settings is None: settings = Settings(settings) - resolve = functools.partial(self._key_for_pipe, - base_class_name="ImagesPipeline", - settings=settings) - self.expires = settings.getint( - resolve("IMAGES_EXPIRES"), self.EXPIRES + resolve = functools.partial( + self._key_for_pipe, base_class_name="ImagesPipeline", settings=settings ) + self.expires = settings.getint(resolve("IMAGES_EXPIRES"), self.EXPIRES) if not hasattr(self, "IMAGES_RESULT_FIELD"): self.IMAGES_RESULT_FIELD = self.DEFAULT_IMAGES_RESULT_FIELD @@ -75,47 +77,39 @@ class ImagesPipeline(FilesPipeline): self.IMAGES_URLS_FIELD = self.DEFAULT_IMAGES_URLS_FIELD self.images_urls_field = settings.get( - resolve('IMAGES_URLS_FIELD'), - self.IMAGES_URLS_FIELD + resolve("IMAGES_URLS_FIELD"), self.IMAGES_URLS_FIELD ) self.images_result_field = settings.get( - resolve('IMAGES_RESULT_FIELD'), - self.IMAGES_RESULT_FIELD - ) - self.min_width = settings.getint( - resolve('IMAGES_MIN_WIDTH'), self.MIN_WIDTH - ) - self.min_height = settings.getint( - resolve('IMAGES_MIN_HEIGHT'), self.MIN_HEIGHT - ) - self.thumbs = settings.get( - resolve('IMAGES_THUMBS'), self.THUMBS + resolve("IMAGES_RESULT_FIELD"), self.IMAGES_RESULT_FIELD ) + self.min_width = settings.getint(resolve("IMAGES_MIN_WIDTH"), self.MIN_WIDTH) + self.min_height = settings.getint(resolve("IMAGES_MIN_HEIGHT"), self.MIN_HEIGHT) + self.thumbs = settings.get(resolve("IMAGES_THUMBS"), self.THUMBS) self._deprecated_convert_image = None @classmethod def from_settings(cls, settings): - s3store = cls.STORE_SCHEMES['s3'] - s3store.AWS_ACCESS_KEY_ID = settings['AWS_ACCESS_KEY_ID'] - s3store.AWS_SECRET_ACCESS_KEY = settings['AWS_SECRET_ACCESS_KEY'] - s3store.AWS_SESSION_TOKEN = settings['AWS_SESSION_TOKEN'] - s3store.AWS_ENDPOINT_URL = settings['AWS_ENDPOINT_URL'] - s3store.AWS_REGION_NAME = settings['AWS_REGION_NAME'] - s3store.AWS_USE_SSL = settings['AWS_USE_SSL'] - s3store.AWS_VERIFY = settings['AWS_VERIFY'] - s3store.POLICY = settings['IMAGES_STORE_S3_ACL'] + s3store = cls.STORE_SCHEMES["s3"] + s3store.AWS_ACCESS_KEY_ID = settings["AWS_ACCESS_KEY_ID"] + s3store.AWS_SECRET_ACCESS_KEY = settings["AWS_SECRET_ACCESS_KEY"] + s3store.AWS_SESSION_TOKEN = settings["AWS_SESSION_TOKEN"] + s3store.AWS_ENDPOINT_URL = settings["AWS_ENDPOINT_URL"] + s3store.AWS_REGION_NAME = settings["AWS_REGION_NAME"] + s3store.AWS_USE_SSL = settings["AWS_USE_SSL"] + s3store.AWS_VERIFY = settings["AWS_VERIFY"] + s3store.POLICY = settings["IMAGES_STORE_S3_ACL"] - gcs_store = cls.STORE_SCHEMES['gs'] - gcs_store.GCS_PROJECT_ID = settings['GCS_PROJECT_ID'] - gcs_store.POLICY = settings['IMAGES_STORE_GCS_ACL'] or None + gcs_store = cls.STORE_SCHEMES["gs"] + gcs_store.GCS_PROJECT_ID = settings["GCS_PROJECT_ID"] + gcs_store.POLICY = settings["IMAGES_STORE_GCS_ACL"] or None - ftp_store = cls.STORE_SCHEMES['ftp'] - ftp_store.FTP_USERNAME = settings['FTP_USER'] - ftp_store.FTP_PASSWORD = settings['FTP_PASSWORD'] - ftp_store.USE_ACTIVE_MODE = settings.getbool('FEED_STORAGE_FTP_ACTIVE') + ftp_store = cls.STORE_SCHEMES["ftp"] + ftp_store.FTP_USERNAME = settings["FTP_USER"] + ftp_store.FTP_PASSWORD = settings["FTP_PASSWORD"] + ftp_store.USE_ACTIVE_MODE = settings.getbool("FEED_STORAGE_FTP_ACTIVE") - store_uri = settings['IMAGES_STORE'] + store_uri = settings["IMAGES_STORE"] return cls(store_uri, settings=settings) def file_downloaded(self, response, request, info, *, item=None): @@ -129,9 +123,12 @@ class ImagesPipeline(FilesPipeline): checksum = md5sum(buf) width, height = image.size self.store.persist_file( - path, buf, info, - meta={'width': width, 'height': height}, - headers={'Content-Type': 'image/jpeg'}) + path, + buf, + info, + meta={"width": width, "height": height}, + headers={"Content-Type": "image/jpeg"}, + ) return checksum def get_images(self, response, request, info, *, item=None): @@ -140,25 +137,35 @@ class ImagesPipeline(FilesPipeline): width, height = orig_image.size if width < self.min_width or height < self.min_height: - raise ImageException("Image too small " - f"({width}x{height} < " - f"{self.min_width}x{self.min_height})") + raise ImageException( + "Image too small " + f"({width}x{height} < " + f"{self.min_width}x{self.min_height})" + ) if self._deprecated_convert_image is None: - self._deprecated_convert_image = 'response_body' not in get_func_args(self.convert_image) + self._deprecated_convert_image = "response_body" not in get_func_args( + self.convert_image + ) if self._deprecated_convert_image: - warnings.warn(f'{self.__class__.__name__}.convert_image() method overriden in a deprecated way, ' - 'overriden method does not accept response_body argument.', - category=ScrapyDeprecationWarning) + warnings.warn( + f"{self.__class__.__name__}.convert_image() method overriden in a deprecated way, " + "overriden method does not accept response_body argument.", + category=ScrapyDeprecationWarning, + ) if self._deprecated_convert_image: image, buf = self.convert_image(orig_image) else: - image, buf = self.convert_image(orig_image, response_body=BytesIO(response.body)) + image, buf = self.convert_image( + orig_image, response_body=BytesIO(response.body) + ) yield path, image, buf for thumb_id, size in self.thumbs.items(): - thumb_path = self.thumb_path(request, thumb_id, response=response, info=info, item=item) + thumb_path = self.thumb_path( + request, thumb_id, response=response, info=info, item=item + ) if self._deprecated_convert_image: thumb_image, thumb_buf = self.convert_image(image, size) else: @@ -167,21 +174,24 @@ class ImagesPipeline(FilesPipeline): def convert_image(self, image, size=None, response_body=None): if response_body is None: - warnings.warn(f'{self.__class__.__name__}.convert_image() method called in a deprecated way, ' - 'method called without response_body argument.', - category=ScrapyDeprecationWarning, stacklevel=2) + warnings.warn( + f"{self.__class__.__name__}.convert_image() method called in a deprecated way, " + "method called without response_body argument.", + category=ScrapyDeprecationWarning, + stacklevel=2, + ) - if image.format == 'PNG' and image.mode == 'RGBA': - background = self._Image.new('RGBA', image.size, (255, 255, 255)) + if image.format == "PNG" and image.mode == "RGBA": + background = self._Image.new("RGBA", image.size, (255, 255, 255)) background.paste(image, image) - image = background.convert('RGB') - elif image.mode == 'P': + image = background.convert("RGB") + elif image.mode == "P": image = image.convert("RGBA") - background = self._Image.new('RGBA', image.size, (255, 255, 255)) + background = self._Image.new("RGBA", image.size, (255, 255, 255)) background.paste(image, image) - image = background.convert('RGB') - elif image.mode != 'RGB': - image = image.convert('RGB') + image = background.convert("RGB") + elif image.mode != "RGB": + image = image.convert("RGB") if size: image = image.copy() @@ -193,11 +203,11 @@ class ImagesPipeline(FilesPipeline): except AttributeError: resampling_filter = self._Image.ANTIALIAS image.thumbnail(size, resampling_filter) - elif response_body is not None and image.format == 'JPEG': + elif response_body is not None and image.format == "JPEG": return image, response_body buf = BytesIO() - image.save(buf, 'JPEG') + image.save(buf, "JPEG") return image, buf def get_media_requests(self, item, info): @@ -211,8 +221,8 @@ class ImagesPipeline(FilesPipeline): def file_path(self, request, response=None, info=None, *, item=None): image_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() - return f'full/{image_guid}.jpg' + return f"full/{image_guid}.jpg" def thumb_path(self, request, thumb_id, response=None, info=None, *, item=None): thumb_guid = hashlib.sha1(to_bytes(request.url)).hexdigest() - return f'thumbs/{thumb_id}/{thumb_guid}.jpg' + return f"thumbs/{thumb_id}/{thumb_guid}.jpg" diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index 5308a9793..af23b4cc8 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -34,12 +34,10 @@ class MediaPipeline: if isinstance(settings, dict) or settings is None: settings = Settings(settings) - resolve = functools.partial(self._key_for_pipe, - base_class_name="MediaPipeline", - settings=settings) - self.allow_redirects = settings.getbool( - resolve('MEDIA_ALLOW_REDIRECTS'), False + resolve = functools.partial( + self._key_for_pipe, base_class_name="MediaPipeline", settings=settings ) + self.allow_redirects = settings.getbool(resolve("MEDIA_ALLOW_REDIRECTS"), False) self._handle_statuses(self.allow_redirects) # Check if deprecated methods are being used and make them compatible @@ -64,7 +62,8 @@ class MediaPipeline: if ( not base_class_name or class_name == base_class_name - or settings and not settings.get(formatted_key) + or settings + and not settings.get(formatted_key) ): return key return formatted_key @@ -113,16 +112,23 @@ class MediaPipeline: dfd = mustbe_deferred(self.media_to_download, request, info, item=item) dfd.addCallback(self._check_media_to_download, request, info, item=item) dfd.addBoth(self._cache_result_and_execute_waiters, fp, info) - dfd.addErrback(lambda f: logger.error( - f.value, exc_info=failure_to_exc_info(f), extra={'spider': info.spider}) + dfd.addErrback( + lambda f: logger.error( + f.value, exc_info=failure_to_exc_info(f), extra={"spider": info.spider} + ) ) return dfd.addBoth(lambda _: wad) # it must return wad at last def _make_compatible(self): """Make overridable methods of MediaPipeline and subclasses backwards compatible""" methods = [ - "file_path", "thumb_path", "media_to_download", "media_downloaded", - "file_downloaded", "image_downloaded", "get_images" + "file_path", + "thumb_path", + "media_to_download", + "media_downloaded", + "file_downloaded", + "image_downloaded", + "get_images", ] for method_name in methods: @@ -139,7 +145,7 @@ class MediaPipeline: if self._expects_item[func.__name__]: return func(*args, **kwargs) - kwargs.pop('item', None) + kwargs.pop("item", None) return func(*args, **kwargs) return wrapper @@ -148,19 +154,22 @@ class MediaPipeline: sig = signature(func) self._expects_item[func.__name__] = True - if 'item' not in sig.parameters: + if "item" not in sig.parameters: old_params = str(sig)[1:-1] new_params = old_params + ", *, item=None" - warn(f'{func.__name__}(self, {old_params}) is deprecated, ' - f'please use {func.__name__}(self, {new_params})', - ScrapyDeprecationWarning, stacklevel=2) + warn( + f"{func.__name__}(self, {old_params}) is deprecated, " + f"please use {func.__name__}(self, {new_params})", + ScrapyDeprecationWarning, + stacklevel=2, + ) self._expects_item[func.__name__] = False def _modify_media_request(self, request): if self.handle_httpstatus_list: - request.meta['handle_httpstatus_list'] = self.handle_httpstatus_list + request.meta["handle_httpstatus_list"] = self.handle_httpstatus_list else: - request.meta['handle_httpstatus_all'] = True + request.meta["handle_httpstatus_all"] = True def _check_media_to_download(self, result, request, info, item): if result is not None: @@ -169,14 +178,22 @@ class MediaPipeline: # this ugly code was left only to support tests. TODO: remove dfd = mustbe_deferred(self.download_func, request, info.spider) dfd.addCallbacks( - callback=self.media_downloaded, callbackArgs=(request, info), callbackKeywords={'item': item}, - errback=self.media_failed, errbackArgs=(request, info)) + callback=self.media_downloaded, + callbackArgs=(request, info), + callbackKeywords={"item": item}, + errback=self.media_failed, + errbackArgs=(request, info), + ) else: self._modify_media_request(request) dfd = self.crawler.engine.download(request) dfd.addCallbacks( - callback=self.media_downloaded, callbackArgs=(request, info), callbackKeywords={'item': item}, - errback=self.media_failed, errbackArgs=(request, info)) + callback=self.media_downloaded, + callbackArgs=(request, info), + callbackKeywords={"item": item}, + errback=self.media_failed, + errbackArgs=(request, info), + ) return dfd def _cache_result_and_execute_waiters(self, result, fp, info): @@ -207,9 +224,9 @@ class MediaPipeline: # # This problem does not occur in Python 2.7 since we don't have # Exception Chaining (https://www.python.org/dev/peps/pep-3134/). - context = getattr(result.value, '__context__', None) + context = getattr(result.value, "__context__", None) if isinstance(context, StopIteration): - setattr(result.value, '__context__', None) + setattr(result.value, "__context__", None) info.downloading.remove(fp) info.downloaded[fp] = result # cache result @@ -239,10 +256,10 @@ class MediaPipeline: for ok, value in results: if not ok: logger.error( - '%(class)s found errors processing %(item)s', - {'class': self.__class__.__name__, 'item': item}, + "%(class)s found errors processing %(item)s", + {"class": self.__class__.__name__, "item": item}, exc_info=failure_to_exc_info(value), - extra={'spider': info.spider} + extra={"spider": info.spider}, ) return item diff --git a/scrapy/pqueues.py b/scrapy/pqueues.py index b4b63e7c7..6f65184e5 100644 --- a/scrapy/pqueues.py +++ b/scrapy/pqueues.py @@ -18,11 +18,11 @@ def _path_safe(text): >>> _path_safe('some@symbol?').startswith('some_symbol_') True """ - pathable_slot = "".join([c if c.isalnum() or c in '-._' else '_' for c in text]) + pathable_slot = "".join([c if c.isalnum() or c in "-._" else "_" for c in text]) # as we replace some letters we can get collision for different slots # add we add unique part - unique_slot = hashlib.md5(text.encode('utf8')).hexdigest() - return '-'.join([pathable_slot, unique_slot]) + unique_slot = hashlib.md5(text.encode("utf8")).hexdigest() + return "-".join([pathable_slot, unique_slot]) class ScrapyPriorityQueue: @@ -77,7 +77,7 @@ class ScrapyPriorityQueue: self.downstream_queue_cls, None, self.crawler, - self.key + '/' + str(key), + self.key + "/" + str(key), ) def priority(self, request): @@ -128,7 +128,6 @@ class ScrapyPriorityQueue: class DownloaderInterface: - def __init__(self, crawler): self.downloader = crawler.engine.downloader @@ -139,14 +138,14 @@ class DownloaderInterface: return self.downloader._get_slot_key(request, None) def _active_downloads(self, slot): - """ Return a number of requests in a Downloader for a given slot """ + """Return a number of requests in a Downloader for a given slot""" if slot not in self.downloader.slots: return 0 return len(self.downloader.slots[slot].active) class DownloaderAwarePriorityQueue: - """ PriorityQueue which takes Downloader activity into account: + """PriorityQueue which takes Downloader activity into account: domains (slots) with the least amount of active downloads are dequeued first. """ @@ -156,17 +155,21 @@ class DownloaderAwarePriorityQueue: return cls(crawler, downstream_queue_cls, key, startprios) def __init__(self, crawler, downstream_queue_cls, key, slot_startprios=()): - if crawler.settings.getint('CONCURRENT_REQUESTS_PER_IP') != 0: - raise ValueError(f'"{self.__class__}" does not support CONCURRENT_REQUESTS_PER_IP') + if crawler.settings.getint("CONCURRENT_REQUESTS_PER_IP") != 0: + raise ValueError( + f'"{self.__class__}" does not support CONCURRENT_REQUESTS_PER_IP' + ) if slot_startprios and not isinstance(slot_startprios, dict): - raise ValueError("DownloaderAwarePriorityQueue accepts " - "``slot_startprios`` as a dict; " - f"{slot_startprios.__class__!r} instance " - "is passed. Most likely, it means the state is" - "created by an incompatible priority queue. " - "Only a crawl started with the same priority " - "queue class can be resumed.") + raise ValueError( + "DownloaderAwarePriorityQueue accepts " + "``slot_startprios`` as a dict; " + f"{slot_startprios.__class__!r} instance " + "is passed. Most likely, it means the state is" + "created by an incompatible priority queue. " + "Only a crawl started with the same priority " + "queue class can be resumed." + ) self._downloader_interface = DownloaderInterface(crawler) self.downstream_queue_cls = downstream_queue_cls @@ -181,7 +184,7 @@ class DownloaderAwarePriorityQueue: return ScrapyPriorityQueue( self.crawler, self.downstream_queue_cls, - self.key + '/' + _path_safe(slot), + self.key + "/" + _path_safe(slot), startprios, ) diff --git a/scrapy/resolver.py b/scrapy/resolver.py index 0bef555a6..f5d2b8e05 100644 --- a/scrapy/resolver.py +++ b/scrapy/resolver.py @@ -1,6 +1,11 @@ from twisted.internet import defer from twisted.internet.base import ThreadedResolver -from twisted.internet.interfaces import IHostResolution, IHostnameResolver, IResolutionReceiver, IResolverSimple +from twisted.internet.interfaces import ( + IHostResolution, + IHostnameResolver, + IResolutionReceiver, + IResolverSimple, +) from zope.interface.declarations import implementer, provider from scrapy.utils.datatypes import LocalCache @@ -23,11 +28,11 @@ class CachingThreadedResolver(ThreadedResolver): @classmethod def from_crawler(cls, crawler, reactor): - if crawler.settings.getbool('DNSCACHE_ENABLED'): - cache_size = crawler.settings.getint('DNSCACHE_SIZE') + if crawler.settings.getbool("DNSCACHE_ENABLED"): + cache_size = crawler.settings.getint("DNSCACHE_SIZE") else: cache_size = 0 - return cls(reactor, cache_size, crawler.settings.getfloat('DNS_TIMEOUT')) + return cls(reactor, cache_size, crawler.settings.getfloat("DNS_TIMEOUT")) def install_on_reactor(self): self.reactor.installResolver(self) @@ -94,8 +99,8 @@ class CachingHostnameResolver: @classmethod def from_crawler(cls, crawler, reactor): - if crawler.settings.getbool('DNSCACHE_ENABLED'): - cache_size = crawler.settings.getint('DNSCACHE_SIZE') + if crawler.settings.getbool("DNSCACHE_ENABLED"): + cache_size = crawler.settings.getint("DNSCACHE_SIZE") else: cache_size = 0 return cls(reactor, cache_size) @@ -104,7 +109,12 @@ class CachingHostnameResolver: self.reactor.installNameResolver(self) def resolveHostName( - self, resolutionReceiver, hostName, portNumber=0, addressTypes=None, transportSemantics="TCP" + self, + resolutionReceiver, + hostName, + portNumber=0, + addressTypes=None, + transportSemantics="TCP", ): try: addresses = dnscache[hostName] diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index a34d7d25f..6b489bd8b 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -14,26 +14,26 @@ from scrapy.utils.python import binary_is_text, to_bytes, to_unicode class ResponseTypes: CLASSES = { - 'text/html': 'scrapy.http.HtmlResponse', - 'application/atom+xml': 'scrapy.http.XmlResponse', - 'application/rdf+xml': 'scrapy.http.XmlResponse', - 'application/rss+xml': 'scrapy.http.XmlResponse', - 'application/xhtml+xml': 'scrapy.http.HtmlResponse', - 'application/vnd.wap.xhtml+xml': 'scrapy.http.HtmlResponse', - 'application/xml': 'scrapy.http.XmlResponse', - 'application/json': 'scrapy.http.TextResponse', - 'application/x-json': 'scrapy.http.TextResponse', - 'application/json-amazonui-streaming': 'scrapy.http.TextResponse', - 'application/javascript': 'scrapy.http.TextResponse', - 'application/x-javascript': 'scrapy.http.TextResponse', - 'text/xml': 'scrapy.http.XmlResponse', - 'text/*': 'scrapy.http.TextResponse', + "text/html": "scrapy.http.HtmlResponse", + "application/atom+xml": "scrapy.http.XmlResponse", + "application/rdf+xml": "scrapy.http.XmlResponse", + "application/rss+xml": "scrapy.http.XmlResponse", + "application/xhtml+xml": "scrapy.http.HtmlResponse", + "application/vnd.wap.xhtml+xml": "scrapy.http.HtmlResponse", + "application/xml": "scrapy.http.XmlResponse", + "application/json": "scrapy.http.TextResponse", + "application/x-json": "scrapy.http.TextResponse", + "application/json-amazonui-streaming": "scrapy.http.TextResponse", + "application/javascript": "scrapy.http.TextResponse", + "application/x-javascript": "scrapy.http.TextResponse", + "text/xml": "scrapy.http.XmlResponse", + "text/*": "scrapy.http.TextResponse", } def __init__(self): self.classes = {} self.mimetypes = MimeTypes() - mimedata = get_data('scrapy', 'mime.types').decode('utf8') + mimedata = get_data("scrapy", "mime.types").decode("utf8") self.mimetypes.readfp(StringIO(mimedata)) for mimetype, cls in self.CLASSES.items(): self.classes[mimetype] = load_object(cls) @@ -49,17 +49,20 @@ class ResponseTypes: def from_content_type(self, content_type, content_encoding=None): """Return the most appropriate Response class from an HTTP Content-Type - header """ + header""" if content_encoding: return Response - mimetype = to_unicode(content_type).split(';')[0].strip().lower() + mimetype = to_unicode(content_type).split(";")[0].strip().lower() return self.from_mimetype(mimetype) def from_content_disposition(self, content_disposition): try: - filename = to_unicode( - content_disposition, encoding='latin-1', errors='replace' - ).split(';')[1].split('=')[1].strip('"\'') + filename = ( + to_unicode(content_disposition, encoding="latin-1", errors="replace") + .split(";")[1] + .split("=")[1] + .strip("\"'") + ) return self.from_filename(filename) except IndexError: return Response @@ -68,13 +71,13 @@ class ResponseTypes: """Return the most appropriate Response class by looking at the HTTP headers""" cls = Response - if b'Content-Type' in headers: + if b"Content-Type" in headers: cls = self.from_content_type( - content_type=headers[b'Content-Type'], - content_encoding=headers.get(b'Content-Encoding') + content_type=headers[b"Content-Type"], + content_encoding=headers.get(b"Content-Encoding"), ) - if cls is Response and b'Content-Disposition' in headers: - cls = self.from_content_disposition(headers[b'Content-Disposition']) + if cls is Response and b"Content-Disposition" in headers: + cls = self.from_content_disposition(headers[b"Content-Disposition"]) return cls def from_filename(self, filename): @@ -92,15 +95,15 @@ class ResponseTypes: chunk = body[:5000] chunk = to_bytes(chunk) if not binary_is_text(chunk): - return self.from_mimetype('application/octet-stream') + return self.from_mimetype("application/octet-stream") lowercase_chunk = chunk.lower() if b"" in lowercase_chunk: - return self.from_mimetype('text/html') + return self.from_mimetype("text/html") if b"' in lowercase_chunk: - return self.from_mimetype('text/html') - return self.from_mimetype('text') + return self.from_mimetype("text/xml") + if b"" in lowercase_chunk: + return self.from_mimetype("text/html") + return self.from_mimetype("text") def from_args(self, headers=None, url=None, filename=None, body=None): """Guess the most appropriate Response class based on diff --git a/scrapy/robotstxt.py b/scrapy/robotstxt.py index 1d40f0484..0dadeef92 100644 --- a/scrapy/robotstxt.py +++ b/scrapy/robotstxt.py @@ -12,7 +12,7 @@ def decode_robotstxt(robotstxt_body, spider, to_native_str_type=False): if to_native_str_type: robotstxt_body = to_unicode(robotstxt_body) else: - robotstxt_body = robotstxt_body.decode('utf-8') + robotstxt_body = robotstxt_body.decode("utf-8") except UnicodeDecodeError: # If we found garbage or robots.txt in an encoding other than UTF-8, disregard it. # Switch to 'allow all' state. @@ -20,9 +20,9 @@ def decode_robotstxt(robotstxt_body, spider, to_native_str_type=False): "Failure while parsing robots.txt. File either contains garbage or " "is in an encoding other than UTF-8, treating it as an empty file.", exc_info=sys.exc_info(), - extra={'spider': spider}, + extra={"spider": spider}, ) - robotstxt_body = '' + robotstxt_body = "" return robotstxt_body @@ -57,8 +57,11 @@ class RobotParser(metaclass=ABCMeta): class PythonRobotParser(RobotParser): def __init__(self, robotstxt_body, spider): from urllib.robotparser import RobotFileParser + self.spider = spider - robotstxt_body = decode_robotstxt(robotstxt_body, spider, to_native_str_type=True) + robotstxt_body = decode_robotstxt( + robotstxt_body, spider, to_native_str_type=True + ) self.rp = RobotFileParser() self.rp.parse(robotstxt_body.splitlines()) @@ -77,8 +80,9 @@ class PythonRobotParser(RobotParser): class ReppyRobotParser(RobotParser): def __init__(self, robotstxt_body, spider): from reppy.robots import Robots + self.spider = spider - self.rp = Robots.parse('', robotstxt_body) + self.rp = Robots.parse("", robotstxt_body) @classmethod def from_crawler(cls, crawler, robotstxt_body): @@ -93,6 +97,7 @@ class ReppyRobotParser(RobotParser): class RerpRobotParser(RobotParser): def __init__(self, robotstxt_body, spider): from robotexclusionrulesparser import RobotExclusionRulesParser + self.spider = spider self.rp = RobotExclusionRulesParser() robotstxt_body = decode_robotstxt(robotstxt_body, spider) @@ -113,6 +118,7 @@ class RerpRobotParser(RobotParser): class ProtegoRobotParser(RobotParser): def __init__(self, robotstxt_body, spider): from protego import Protego + self.spider = spider robotstxt_body = decode_robotstxt(robotstxt_body, spider) self.rp = Protego.parse(robotstxt_body) diff --git a/scrapy/selector/unified.py b/scrapy/selector/unified.py index 08f08e8d7..6ba87428e 100644 --- a/scrapy/selector/unified.py +++ b/scrapy/selector/unified.py @@ -8,19 +8,18 @@ from scrapy.utils.python import to_bytes from scrapy.http import HtmlResponse, XmlResponse -__all__ = ['Selector', 'SelectorList'] +__all__ = ["Selector", "SelectorList"] def _st(response, st): if st is None: - return 'xml' if isinstance(response, XmlResponse) else 'html' + return "xml" if isinstance(response, XmlResponse) else "html" return st def _response_from_text(text, st): - rt = XmlResponse if st == 'xml' else HtmlResponse - return rt(url='about:blank', encoding='utf-8', - body=to_bytes(text, 'utf-8')) + rt = XmlResponse if st == "xml" else HtmlResponse + return rt(url="about:blank", encoding="utf-8", body=to_bytes(text, "utf-8")) class SelectorList(_ParselSelector.selectorlist_cls, object_ref): @@ -61,13 +60,15 @@ class Selector(_ParselSelector, object_ref): detection will occur. """ - __slots__ = ['response'] + __slots__ = ["response"] selectorlist_cls = SelectorList def __init__(self, response=None, text=None, type=None, root=None, **kwargs): if response is not None and text is not None: - raise ValueError(f'{self.__class__.__name__}.__init__() received ' - 'both response and text') + raise ValueError( + f"{self.__class__.__name__}.__init__() received " + "both response and text" + ) st = _st(response, type) @@ -76,7 +77,7 @@ class Selector(_ParselSelector, object_ref): if response is not None: text = response.text - kwargs.setdefault('base_url', response.url) + kwargs.setdefault("base_url", response.url) self.response = response super().__init__(text=text, type=st, root=root, **kwargs) diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index b540e6182..c0d0741c5 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -8,11 +8,11 @@ from scrapy.settings import default_settings SETTINGS_PRIORITIES = { - 'default': 0, - 'command': 10, - 'project': 20, - 'spider': 30, - 'cmdline': 40, + "default": 0, + "command": 10, + "project": 20, + "spider": 30, + "cmdline": 40, } @@ -76,7 +76,7 @@ class BaseSettings(MutableMapping): highest priority will be retrieved. """ - def __init__(self, values=None, priority='project'): + def __init__(self, values=None, priority="project"): self.frozen = False self.attributes = {} if values: @@ -126,9 +126,11 @@ class BaseSettings(MutableMapping): return True if got in ("False", "false"): return False - raise ValueError("Supported values for boolean settings " - "are 0/1, True/False, '0'/'1', " - "'True'/'False' and 'true'/'false'") + raise ValueError( + "Supported values for boolean settings " + "are 0/1, True/False, '0'/'1', " + "'True'/'False' and 'true'/'false'" + ) def getint(self, name, default=0): """ @@ -170,7 +172,7 @@ class BaseSettings(MutableMapping): """ value = self.get(name, default or []) if isinstance(value, str): - value = value.split(',') + value = value.split(",") return list(value) def getdict(self, name, default=None): @@ -223,7 +225,7 @@ class BaseSettings(MutableMapping): try: return json.loads(value) except ValueError: - return value.split(',') + return value.split(",") return copy.deepcopy(value) def getwithbase(self, name): @@ -234,7 +236,7 @@ class BaseSettings(MutableMapping): :type name: str """ compbs = BaseSettings() - compbs.update(self[name + '_BASE']) + compbs.update(self[name + "_BASE"]) compbs.update(self[name]) return compbs @@ -259,12 +261,12 @@ class BaseSettings(MutableMapping): """ if len(self) > 0: return max(self.getpriority(name) for name in self) - return get_settings_priority('default') + return get_settings_priority("default") def __setitem__(self, name, value): self.set(name, value) - def set(self, name, value, priority='project'): + def set(self, name, value, priority="project"): """ Store a key/value attribute with a given priority. @@ -292,10 +294,10 @@ class BaseSettings(MutableMapping): else: self.attributes[name].set(value, priority) - def setdict(self, values, priority='project'): + def setdict(self, values, priority="project"): self.update(values, priority) - def setmodule(self, module, priority='project'): + def setmodule(self, module, priority="project"): """ Store settings from a module with a given priority. @@ -317,7 +319,7 @@ class BaseSettings(MutableMapping): if key.isupper(): self.set(key, getattr(module, key), priority) - def update(self, values, priority='project'): + def update(self, values, priority="project"): """ Store key/value pairs with a given priority. @@ -350,7 +352,7 @@ class BaseSettings(MutableMapping): for name, value in values.items(): self.set(name, value, priority) - def delete(self, name, priority='project'): + def delete(self, name, priority="project"): self._assert_mutability() priority = get_settings_priority(priority) if priority >= self.getpriority(name): @@ -403,12 +405,17 @@ class BaseSettings(MutableMapping): return len(self.attributes) def _to_dict(self): - return {self._get_key(k): (v._to_dict() if isinstance(v, BaseSettings) else v) - for k, v in self.items()} + return { + self._get_key(k): (v._to_dict() if isinstance(v, BaseSettings) else v) + for k, v in self.items() + } def _get_key(self, key_value): - return (key_value if isinstance(key_value, (bool, float, int, str, type(None))) - else str(key_value)) + return ( + key_value + if isinstance(key_value, (bool, float, int, str, type(None))) + else str(key_value) + ) def copy_to_dict(self): """ @@ -444,17 +451,17 @@ class Settings(BaseSettings): described on :ref:`topics-settings-ref` already populated. """ - def __init__(self, values=None, priority='project'): + def __init__(self, values=None, priority="project"): # Do not pass kwarg values here. We don't want to promote user-defined # dicts, and we want to update, not replace, default dicts with the # values given by the user super().__init__() - self.setmodule(default_settings, 'default') + self.setmodule(default_settings, "default") # Promote default dictionaries to BaseSettings instances for per-key # priorities for name, val in self.items(): if isinstance(val, dict): - self.set(name, BaseSettings(val, 'default'), 'default') + self.set(name, BaseSettings(val, "default"), "default") self.update(values, priority) diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index 5e7379b89..260ec1701 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -27,14 +27,14 @@ AUTOTHROTTLE_MAX_DELAY = 60.0 AUTOTHROTTLE_START_DELAY = 5.0 AUTOTHROTTLE_TARGET_CONCURRENCY = 1.0 -BOT_NAME = 'scrapybot' +BOT_NAME = "scrapybot" CLOSESPIDER_TIMEOUT = 0 CLOSESPIDER_PAGECOUNT = 0 CLOSESPIDER_ITEMCOUNT = 0 CLOSESPIDER_ERRORCOUNT = 0 -COMMANDS_MODULE = '' +COMMANDS_MODULE = "" COMPRESSION_ENABLED = True @@ -47,11 +47,11 @@ CONCURRENT_REQUESTS_PER_IP = 0 COOKIES_ENABLED = True COOKIES_DEBUG = False -DEFAULT_ITEM_CLASS = 'scrapy.item.Item' +DEFAULT_ITEM_CLASS = "scrapy.item.Item" DEFAULT_REQUEST_HEADERS = { - 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8', - 'Accept-Language': 'en', + "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8", + "Accept-Language": "en", } DEPTH_LIMIT = 0 @@ -60,78 +60,82 @@ DEPTH_PRIORITY = 0 DNSCACHE_ENABLED = True DNSCACHE_SIZE = 10000 -DNS_RESOLVER = 'scrapy.resolver.CachingThreadedResolver' +DNS_RESOLVER = "scrapy.resolver.CachingThreadedResolver" DNS_TIMEOUT = 60 DOWNLOAD_DELAY = 0 DOWNLOAD_HANDLERS = {} DOWNLOAD_HANDLERS_BASE = { - 'data': 'scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler', - 'file': 'scrapy.core.downloader.handlers.file.FileDownloadHandler', - 'http': 'scrapy.core.downloader.handlers.http.HTTPDownloadHandler', - 'https': 'scrapy.core.downloader.handlers.http.HTTPDownloadHandler', - 's3': 'scrapy.core.downloader.handlers.s3.S3DownloadHandler', - 'ftp': 'scrapy.core.downloader.handlers.ftp.FTPDownloadHandler', + "data": "scrapy.core.downloader.handlers.datauri.DataURIDownloadHandler", + "file": "scrapy.core.downloader.handlers.file.FileDownloadHandler", + "http": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", + "https": "scrapy.core.downloader.handlers.http.HTTPDownloadHandler", + "s3": "scrapy.core.downloader.handlers.s3.S3DownloadHandler", + "ftp": "scrapy.core.downloader.handlers.ftp.FTPDownloadHandler", } -DOWNLOAD_TIMEOUT = 180 # 3mins +DOWNLOAD_TIMEOUT = 180 # 3mins -DOWNLOAD_MAXSIZE = 1024 * 1024 * 1024 # 1024m -DOWNLOAD_WARNSIZE = 32 * 1024 * 1024 # 32m +DOWNLOAD_MAXSIZE = 1024 * 1024 * 1024 # 1024m +DOWNLOAD_WARNSIZE = 32 * 1024 * 1024 # 32m DOWNLOAD_FAIL_ON_DATALOSS = True -DOWNLOADER = 'scrapy.core.downloader.Downloader' +DOWNLOADER = "scrapy.core.downloader.Downloader" -DOWNLOADER_HTTPCLIENTFACTORY = 'scrapy.core.downloader.webclient.ScrapyHTTPClientFactory' -DOWNLOADER_CLIENTCONTEXTFACTORY = 'scrapy.core.downloader.contextfactory.ScrapyClientContextFactory' -DOWNLOADER_CLIENT_TLS_CIPHERS = 'DEFAULT' +DOWNLOADER_HTTPCLIENTFACTORY = ( + "scrapy.core.downloader.webclient.ScrapyHTTPClientFactory" +) +DOWNLOADER_CLIENTCONTEXTFACTORY = ( + "scrapy.core.downloader.contextfactory.ScrapyClientContextFactory" +) +DOWNLOADER_CLIENT_TLS_CIPHERS = "DEFAULT" # Use highest TLS/SSL protocol version supported by the platform, also allowing negotiation: -DOWNLOADER_CLIENT_TLS_METHOD = 'TLS' +DOWNLOADER_CLIENT_TLS_METHOD = "TLS" DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING = False DOWNLOADER_MIDDLEWARES = {} DOWNLOADER_MIDDLEWARES_BASE = { # Engine side - 'scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware': 100, - 'scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware': 300, - 'scrapy.downloadermiddlewares.downloadtimeout.DownloadTimeoutMiddleware': 350, - 'scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware': 400, - 'scrapy.downloadermiddlewares.useragent.UserAgentMiddleware': 500, - 'scrapy.downloadermiddlewares.retry.RetryMiddleware': 550, - 'scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware': 560, - 'scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware': 580, - 'scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware': 590, - 'scrapy.downloadermiddlewares.redirect.RedirectMiddleware': 600, - 'scrapy.downloadermiddlewares.cookies.CookiesMiddleware': 700, - 'scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware': 750, - 'scrapy.downloadermiddlewares.stats.DownloaderStats': 850, - 'scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware': 900, + "scrapy.downloadermiddlewares.robotstxt.RobotsTxtMiddleware": 100, + "scrapy.downloadermiddlewares.httpauth.HttpAuthMiddleware": 300, + "scrapy.downloadermiddlewares.downloadtimeout.DownloadTimeoutMiddleware": 350, + "scrapy.downloadermiddlewares.defaultheaders.DefaultHeadersMiddleware": 400, + "scrapy.downloadermiddlewares.useragent.UserAgentMiddleware": 500, + "scrapy.downloadermiddlewares.retry.RetryMiddleware": 550, + "scrapy.downloadermiddlewares.ajaxcrawl.AjaxCrawlMiddleware": 560, + "scrapy.downloadermiddlewares.redirect.MetaRefreshMiddleware": 580, + "scrapy.downloadermiddlewares.httpcompression.HttpCompressionMiddleware": 590, + "scrapy.downloadermiddlewares.redirect.RedirectMiddleware": 600, + "scrapy.downloadermiddlewares.cookies.CookiesMiddleware": 700, + "scrapy.downloadermiddlewares.httpproxy.HttpProxyMiddleware": 750, + "scrapy.downloadermiddlewares.stats.DownloaderStats": 850, + "scrapy.downloadermiddlewares.httpcache.HttpCacheMiddleware": 900, # Downloader side } DOWNLOADER_STATS = True -DUPEFILTER_CLASS = 'scrapy.dupefilters.RFPDupeFilter' +DUPEFILTER_CLASS = "scrapy.dupefilters.RFPDupeFilter" -EDITOR = 'vi' -if sys.platform == 'win32': - EDITOR = '%s -m idlelib.idle' +EDITOR = "vi" +if sys.platform == "win32": + EDITOR = "%s -m idlelib.idle" EXTENSIONS = {} EXTENSIONS_BASE = { - 'scrapy.extensions.corestats.CoreStats': 0, - 'scrapy.extensions.telnet.TelnetConsole': 0, - 'scrapy.extensions.memusage.MemoryUsage': 0, - 'scrapy.extensions.memdebug.MemoryDebugger': 0, - 'scrapy.extensions.closespider.CloseSpider': 0, - 'scrapy.extensions.feedexport.FeedExporter': 0, - 'scrapy.extensions.logstats.LogStats': 0, - 'scrapy.extensions.spiderstate.SpiderState': 0, - 'scrapy.extensions.throttle.AutoThrottle': 0, + "scrapy.extensions.corestats.CoreStats": 0, + "scrapy.extensions.telnet.TelnetConsole": 0, + "scrapy.extensions.memusage.MemoryUsage": 0, + "scrapy.extensions.memdebug.MemoryDebugger": 0, + "scrapy.extensions.closespider.CloseSpider": 0, + "scrapy.extensions.feedexport.FeedExporter": 0, + "scrapy.extensions.logstats.LogStats": 0, + "scrapy.extensions.spiderstate.SpiderState": 0, + "scrapy.extensions.throttle.AutoThrottle": 0, } FEED_TEMPDIR = None @@ -142,71 +146,71 @@ FEED_EXPORT_ENCODING = None FEED_EXPORT_FIELDS = None FEED_STORAGES = {} FEED_STORAGES_BASE = { - '': 'scrapy.extensions.feedexport.FileFeedStorage', - 'file': 'scrapy.extensions.feedexport.FileFeedStorage', - 'ftp': 'scrapy.extensions.feedexport.FTPFeedStorage', - 'gs': 'scrapy.extensions.feedexport.GCSFeedStorage', - 's3': 'scrapy.extensions.feedexport.S3FeedStorage', - 'stdout': 'scrapy.extensions.feedexport.StdoutFeedStorage', + "": "scrapy.extensions.feedexport.FileFeedStorage", + "file": "scrapy.extensions.feedexport.FileFeedStorage", + "ftp": "scrapy.extensions.feedexport.FTPFeedStorage", + "gs": "scrapy.extensions.feedexport.GCSFeedStorage", + "s3": "scrapy.extensions.feedexport.S3FeedStorage", + "stdout": "scrapy.extensions.feedexport.StdoutFeedStorage", } FEED_EXPORT_BATCH_ITEM_COUNT = 0 FEED_EXPORTERS = {} FEED_EXPORTERS_BASE = { - 'json': 'scrapy.exporters.JsonItemExporter', - 'jsonlines': 'scrapy.exporters.JsonLinesItemExporter', - 'jsonl': 'scrapy.exporters.JsonLinesItemExporter', - 'jl': 'scrapy.exporters.JsonLinesItemExporter', - 'csv': 'scrapy.exporters.CsvItemExporter', - 'xml': 'scrapy.exporters.XmlItemExporter', - 'marshal': 'scrapy.exporters.MarshalItemExporter', - 'pickle': 'scrapy.exporters.PickleItemExporter', + "json": "scrapy.exporters.JsonItemExporter", + "jsonlines": "scrapy.exporters.JsonLinesItemExporter", + "jsonl": "scrapy.exporters.JsonLinesItemExporter", + "jl": "scrapy.exporters.JsonLinesItemExporter", + "csv": "scrapy.exporters.CsvItemExporter", + "xml": "scrapy.exporters.XmlItemExporter", + "marshal": "scrapy.exporters.MarshalItemExporter", + "pickle": "scrapy.exporters.PickleItemExporter", } FEED_EXPORT_INDENT = 0 FEED_STORAGE_FTP_ACTIVE = False -FEED_STORAGE_GCS_ACL = '' -FEED_STORAGE_S3_ACL = '' +FEED_STORAGE_GCS_ACL = "" +FEED_STORAGE_S3_ACL = "" -FILES_STORE_S3_ACL = 'private' -FILES_STORE_GCS_ACL = '' +FILES_STORE_S3_ACL = "private" +FILES_STORE_GCS_ACL = "" -FTP_USER = 'anonymous' -FTP_PASSWORD = 'guest' +FTP_USER = "anonymous" +FTP_PASSWORD = "guest" FTP_PASSIVE_MODE = True GCS_PROJECT_ID = None HTTPCACHE_ENABLED = False -HTTPCACHE_DIR = 'httpcache' +HTTPCACHE_DIR = "httpcache" HTTPCACHE_IGNORE_MISSING = False -HTTPCACHE_STORAGE = 'scrapy.extensions.httpcache.FilesystemCacheStorage' +HTTPCACHE_STORAGE = "scrapy.extensions.httpcache.FilesystemCacheStorage" HTTPCACHE_EXPIRATION_SECS = 0 HTTPCACHE_ALWAYS_STORE = False HTTPCACHE_IGNORE_HTTP_CODES = [] -HTTPCACHE_IGNORE_SCHEMES = ['file'] +HTTPCACHE_IGNORE_SCHEMES = ["file"] HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS = [] -HTTPCACHE_DBM_MODULE = 'dbm' -HTTPCACHE_POLICY = 'scrapy.extensions.httpcache.DummyPolicy' +HTTPCACHE_DBM_MODULE = "dbm" +HTTPCACHE_POLICY = "scrapy.extensions.httpcache.DummyPolicy" HTTPCACHE_GZIP = False HTTPPROXY_ENABLED = True -HTTPPROXY_AUTH_ENCODING = 'latin-1' +HTTPPROXY_AUTH_ENCODING = "latin-1" -IMAGES_STORE_S3_ACL = 'private' -IMAGES_STORE_GCS_ACL = '' +IMAGES_STORE_S3_ACL = "private" +IMAGES_STORE_GCS_ACL = "" -ITEM_PROCESSOR = 'scrapy.pipelines.ItemPipelineManager' +ITEM_PROCESSOR = "scrapy.pipelines.ItemPipelineManager" ITEM_PIPELINES = {} ITEM_PIPELINES_BASE = {} LOG_ENABLED = True -LOG_ENCODING = 'utf-8' -LOG_FORMATTER = 'scrapy.logformatter.LogFormatter' -LOG_FORMAT = '%(asctime)s [%(name)s] %(levelname)s: %(message)s' -LOG_DATEFORMAT = '%Y-%m-%d %H:%M:%S' +LOG_ENCODING = "utf-8" +LOG_FORMATTER = "scrapy.logformatter.LogFormatter" +LOG_FORMAT = "%(asctime)s [%(name)s] %(levelname)s: %(message)s" +LOG_DATEFORMAT = "%Y-%m-%d %H:%M:%S" LOG_STDOUT = False -LOG_LEVEL = 'DEBUG' +LOG_LEVEL = "DEBUG" LOG_FILE = None LOG_FILE_APPEND = True LOG_SHORT_NAMES = False @@ -215,14 +219,14 @@ SCHEDULER_DEBUG = False LOGSTATS_INTERVAL = 60.0 -MAIL_HOST = 'localhost' +MAIL_HOST = "localhost" MAIL_PORT = 25 -MAIL_FROM = 'scrapy@localhost' +MAIL_FROM = "scrapy@localhost" MAIL_PASS = None MAIL_USER = None -MEMDEBUG_ENABLED = False # enable memory debugging -MEMDEBUG_NOTIFY = [] # send memory debugging report by mail at engine shutdown +MEMDEBUG_ENABLED = False # enable memory debugging +MEMDEBUG_NOTIFY = [] # send memory debugging report by mail at engine shutdown MEMUSAGE_CHECK_INTERVAL_SECONDS = 60.0 MEMUSAGE_ENABLED = True @@ -234,7 +238,7 @@ METAREFRESH_ENABLED = True METAREFRESH_IGNORE_TAGS = [] METAREFRESH_MAXDELAY = 100 -NEWSPIDER_MODULE = '' +NEWSPIDER_MODULE = "" RANDOMIZE_DOWNLOAD_DELAY = True @@ -245,10 +249,10 @@ REDIRECT_MAX_TIMES = 20 # uses Firefox default setting REDIRECT_PRIORITY_ADJUST = +2 REFERER_ENABLED = True -REFERRER_POLICY = 'scrapy.spidermiddlewares.referer.DefaultReferrerPolicy' +REFERRER_POLICY = "scrapy.spidermiddlewares.referer.DefaultReferrerPolicy" -REQUEST_FINGERPRINTER_CLASS = 'scrapy.utils.request.RequestFingerprinter' -REQUEST_FINGERPRINTER_IMPLEMENTATION = '2.6' +REQUEST_FINGERPRINTER_CLASS = "scrapy.utils.request.RequestFingerprinter" +REQUEST_FINGERPRINTER_IMPLEMENTATION = "2.6" RETRY_ENABLED = True RETRY_TIMES = 2 # initial response + 2 retries = 3 requests @@ -256,39 +260,39 @@ RETRY_HTTP_CODES = [500, 502, 503, 504, 522, 524, 408, 429] RETRY_PRIORITY_ADJUST = -1 ROBOTSTXT_OBEY = False -ROBOTSTXT_PARSER = 'scrapy.robotstxt.ProtegoRobotParser' +ROBOTSTXT_PARSER = "scrapy.robotstxt.ProtegoRobotParser" ROBOTSTXT_USER_AGENT = None -SCHEDULER = 'scrapy.core.scheduler.Scheduler' -SCHEDULER_DISK_QUEUE = 'scrapy.squeues.PickleLifoDiskQueue' -SCHEDULER_MEMORY_QUEUE = 'scrapy.squeues.LifoMemoryQueue' -SCHEDULER_PRIORITY_QUEUE = 'scrapy.pqueues.ScrapyPriorityQueue' +SCHEDULER = "scrapy.core.scheduler.Scheduler" +SCHEDULER_DISK_QUEUE = "scrapy.squeues.PickleLifoDiskQueue" +SCHEDULER_MEMORY_QUEUE = "scrapy.squeues.LifoMemoryQueue" +SCHEDULER_PRIORITY_QUEUE = "scrapy.pqueues.ScrapyPriorityQueue" SCRAPER_SLOT_MAX_ACTIVE_SIZE = 5000000 -SPIDER_LOADER_CLASS = 'scrapy.spiderloader.SpiderLoader' +SPIDER_LOADER_CLASS = "scrapy.spiderloader.SpiderLoader" SPIDER_LOADER_WARN_ONLY = False SPIDER_MIDDLEWARES = {} SPIDER_MIDDLEWARES_BASE = { # Engine side - 'scrapy.spidermiddlewares.httperror.HttpErrorMiddleware': 50, - 'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': 500, - 'scrapy.spidermiddlewares.referer.RefererMiddleware': 700, - 'scrapy.spidermiddlewares.urllength.UrlLengthMiddleware': 800, - 'scrapy.spidermiddlewares.depth.DepthMiddleware': 900, + "scrapy.spidermiddlewares.httperror.HttpErrorMiddleware": 50, + "scrapy.spidermiddlewares.offsite.OffsiteMiddleware": 500, + "scrapy.spidermiddlewares.referer.RefererMiddleware": 700, + "scrapy.spidermiddlewares.urllength.UrlLengthMiddleware": 800, + "scrapy.spidermiddlewares.depth.DepthMiddleware": 900, # Spider side } SPIDER_MODULES = [] -STATS_CLASS = 'scrapy.statscollectors.MemoryStatsCollector' +STATS_CLASS = "scrapy.statscollectors.MemoryStatsCollector" STATS_DUMP = True STATSMAILER_RCPTS = [] -TEMPLATES_DIR = str((Path(__file__).parent / '..' / 'templates').resolve()) +TEMPLATES_DIR = str((Path(__file__).parent / ".." / "templates").resolve()) URLLENGTH_LIMIT = 2083 @@ -296,16 +300,16 @@ USER_AGENT = f'Scrapy/{import_module("scrapy").__version__} (+https://scrapy.org TELNETCONSOLE_ENABLED = 1 TELNETCONSOLE_PORT = [6023, 6073] -TELNETCONSOLE_HOST = '127.0.0.1' -TELNETCONSOLE_USERNAME = 'scrapy' +TELNETCONSOLE_HOST = "127.0.0.1" +TELNETCONSOLE_USERNAME = "scrapy" TELNETCONSOLE_PASSWORD = None TWISTED_REACTOR = None SPIDER_CONTRACTS = {} SPIDER_CONTRACTS_BASE = { - 'scrapy.contracts.default.UrlContract': 1, - 'scrapy.contracts.default.CallbackKeywordArgumentsContract': 1, - 'scrapy.contracts.default.ReturnsContract': 2, - 'scrapy.contracts.default.ScrapesContract': 3, + "scrapy.contracts.default.UrlContract": 1, + "scrapy.contracts.default.CallbackKeywordArgumentsContract": 1, + "scrapy.contracts.default.ReturnsContract": 2, + "scrapy.contracts.default.ScrapesContract": 3, } diff --git a/scrapy/shell.py b/scrapy/shell.py index f2dff2ae3..18be383c1 100644 --- a/scrapy/shell.py +++ b/scrapy/shell.py @@ -30,7 +30,7 @@ class Shell: def __init__(self, crawler, update_vars=None, code=None): self.crawler = crawler self.update_vars = update_vars or (lambda x: None) - self.item_class = load_object(crawler.settings['DEFAULT_ITEM_CLASS']) + self.item_class = load_object(crawler.settings["DEFAULT_ITEM_CLASS"]) self.spider = None self.inthread = not threadable.isInIOThread() self.code = code @@ -61,19 +61,20 @@ class Shell: shell = python """ cfg = get_config() - section, option = 'settings', 'shell' - env = os.environ.get('SCRAPY_PYTHON_SHELL') + section, option = "settings", "shell" + env = os.environ.get("SCRAPY_PYTHON_SHELL") shells = [] if env: - shells += env.strip().lower().split(',') + shells += env.strip().lower().split(",") elif cfg.has_option(section, option): shells += [cfg.get(section, option).strip().lower()] else: # try all by default shells += DEFAULT_PYTHON_SHELLS.keys() # always add standard shell as fallback - shells += ['python'] - start_python_console(self.vars, shells=shells, - banner=self.vars.pop('banner', '')) + shells += ["python"] + start_python_console( + self.vars, shells=shells, banner=self.vars.pop("banner", "") + ) def _schedule(self, request, spider): spider = self._open_spider(request, spider) @@ -96,19 +97,23 @@ class Shell: def fetch(self, request_or_url, spider=None, redirect=True, **kwargs): from twisted.internet import reactor + if isinstance(request_or_url, Request): request = request_or_url else: url = any_to_uri(request_or_url) request = Request(url, dont_filter=True, **kwargs) if redirect: - request.meta['handle_httpstatus_list'] = SequenceExclude(range(300, 400)) + request.meta["handle_httpstatus_list"] = SequenceExclude( + range(300, 400) + ) else: - request.meta['handle_httpstatus_all'] = True + request.meta["handle_httpstatus_all"] = True response = None try: response, spider = threads.blockingCallFromThread( - reactor, self._schedule, request, spider) + reactor, self._schedule, request, spider + ) except IgnoreRequest: pass self.populate_vars(response, request, spider) @@ -116,20 +121,20 @@ class Shell: def populate_vars(self, response=None, request=None, spider=None): import scrapy - self.vars['scrapy'] = scrapy - self.vars['crawler'] = self.crawler - self.vars['item'] = self.item_class() - self.vars['settings'] = self.crawler.settings - self.vars['spider'] = spider - self.vars['request'] = request - self.vars['response'] = response + self.vars["scrapy"] = scrapy + self.vars["crawler"] = self.crawler + self.vars["item"] = self.item_class() + self.vars["settings"] = self.crawler.settings + self.vars["spider"] = spider + self.vars["request"] = request + self.vars["response"] = response if self.inthread: - self.vars['fetch'] = self.fetch - self.vars['view'] = open_in_browser - self.vars['shelp'] = self.print_help + self.vars["fetch"] = self.fetch + self.vars["view"] = open_in_browser + self.vars["shelp"] = self.print_help self.update_vars(self.vars) if not self.code: - self.vars['banner'] = self.get_help() + self.vars["banner"] = self.get_help() def print_help(self): print(self.get_help()) @@ -137,16 +142,22 @@ class Shell: def get_help(self): b = [] b.append("Available Scrapy objects:") - b.append(" scrapy scrapy module (contains scrapy.Request, scrapy.Selector, etc)") + b.append( + " scrapy scrapy module (contains scrapy.Request, scrapy.Selector, etc)" + ) for k, v in sorted(self.vars.items()): if self._is_relevant(v): b.append(f" {k:<10} {v}") b.append("Useful shortcuts:") if self.inthread: - b.append(" fetch(url[, redirect=True]) " - "Fetch URL and update local objects (by default, redirects are followed)") - b.append(" fetch(req) " - "Fetch a scrapy.Request and update local objects ") + b.append( + " fetch(url[, redirect=True]) " + "Fetch URL and update local objects (by default, redirects are followed)" + ) + b.append( + " fetch(req) " + "Fetch a scrapy.Request and update local objects " + ) b.append(" shelp() Shell help (print this help)") b.append(" view(response) View response in a browser") diff --git a/scrapy/signalmanager.py b/scrapy/signalmanager.py index ac4044c64..f00447a55 100644 --- a/scrapy/signalmanager.py +++ b/scrapy/signalmanager.py @@ -3,7 +3,6 @@ from scrapy.utils import signal as _signal class SignalManager: - def __init__(self, sender=dispatcher.Anonymous): self.sender = sender @@ -21,7 +20,7 @@ class SignalManager: :param signal: the signal to connect to :type signal: object """ - kwargs.setdefault('sender', self.sender) + kwargs.setdefault("sender", self.sender) return dispatcher.connect(receiver, signal, **kwargs) def disconnect(self, receiver, signal, **kwargs): @@ -30,7 +29,7 @@ class SignalManager: opposite effect of the :meth:`connect` method, and the arguments are the same. """ - kwargs.setdefault('sender', self.sender) + kwargs.setdefault("sender", self.sender) return dispatcher.disconnect(receiver, signal, **kwargs) def send_catch_log(self, signal, **kwargs): @@ -40,7 +39,7 @@ class SignalManager: The keyword arguments are passed to the signal handlers (connected through the :meth:`connect` method). """ - kwargs.setdefault('sender', self.sender) + kwargs.setdefault("sender", self.sender) return _signal.send_catch_log(signal, **kwargs) def send_catch_log_deferred(self, signal, **kwargs): @@ -54,7 +53,7 @@ class SignalManager: The keyword arguments are passed to the signal handlers (connected through the :meth:`connect` method). """ - kwargs.setdefault('sender', self.sender) + kwargs.setdefault("sender", self.sender) return _signal.send_catch_log_deferred(signal, **kwargs) def disconnect_all(self, signal, **kwargs): @@ -64,5 +63,5 @@ class SignalManager: :param signal: the signal to disconnect from :type signal: object """ - kwargs.setdefault('sender', self.sender) + kwargs.setdefault("sender", self.sender) return _signal.disconnect_all(signal, **kwargs) diff --git a/scrapy/spiderloader.py b/scrapy/spiderloader.py index 04fda311f..02a451a2b 100644 --- a/scrapy/spiderloader.py +++ b/scrapy/spiderloader.py @@ -17,8 +17,8 @@ class SpiderLoader: """ def __init__(self, settings): - self.spider_modules = settings.getlist('SPIDER_MODULES') - self.warn_only = settings.getbool('SPIDER_LOADER_WARN_ONLY') + self.spider_modules = settings.getlist("SPIDER_MODULES") + self.warn_only = settings.getbool("SPIDER_LOADER_WARN_ONLY") self._spiders = {} self._found = defaultdict(list) self._load_all_spiders() @@ -26,11 +26,13 @@ class SpiderLoader: def _check_name_duplicates(self): dupes = [] for name, locations in self._found.items(): - dupes.extend([ - f" {cls} named {name!r} (in {mod})" - for mod, cls in locations - if len(locations) > 1 - ]) + dupes.extend( + [ + f" {cls} named {name!r} (in {mod})" + for mod, cls in locations + if len(locations) > 1 + ] + ) if dupes: dupes_string = "\n\n".join(dupes) @@ -81,8 +83,7 @@ class SpiderLoader: Return the list of spider names that can handle the given request. """ return [ - name for name, cls in self._spiders.items() - if cls.handles_request(request) + name for name, cls in self._spiders.items() if cls.handles_request(request) ] def list(self): diff --git a/scrapy/spidermiddlewares/depth.py b/scrapy/spidermiddlewares/depth.py index 4c923b1b3..eadc7c6ab 100644 --- a/scrapy/spidermiddlewares/depth.py +++ b/scrapy/spidermiddlewares/depth.py @@ -12,7 +12,6 @@ logger = logging.getLogger(__name__) class DepthMiddleware: - def __init__(self, maxdepth, stats, verbose_stats=False, prio=1): self.maxdepth = maxdepth self.stats = stats @@ -22,9 +21,9 @@ class DepthMiddleware: @classmethod def from_crawler(cls, crawler): settings = crawler.settings - maxdepth = settings.getint('DEPTH_LIMIT') - verbose = settings.getbool('DEPTH_STATS_VERBOSE') - prio = settings.getint('DEPTH_PRIORITY') + maxdepth = settings.getint("DEPTH_LIMIT") + verbose = settings.getbool("DEPTH_STATS_VERBOSE") + prio = settings.getint("DEPTH_PRIORITY") return cls(maxdepth, crawler.stats, verbose, prio) def process_spider_output(self, response, result, spider): @@ -39,28 +38,26 @@ class DepthMiddleware: def _init_depth(self, response, spider): # base case (depth=0) - if 'depth' not in response.meta: - response.meta['depth'] = 0 + if "depth" not in response.meta: + response.meta["depth"] = 0 if self.verbose_stats: - self.stats.inc_value('request_depth_count/0', spider=spider) + self.stats.inc_value("request_depth_count/0", spider=spider) def _filter(self, request, response, spider): if not isinstance(request, Request): return True - depth = response.meta['depth'] + 1 - request.meta['depth'] = depth + depth = response.meta["depth"] + 1 + request.meta["depth"] = depth if self.prio: request.priority -= depth * self.prio if self.maxdepth and depth > self.maxdepth: logger.debug( "Ignoring link (depth > %(maxdepth)d): %(requrl)s ", - {'maxdepth': self.maxdepth, 'requrl': request.url}, - extra={'spider': spider} + {"maxdepth": self.maxdepth, "requrl": request.url}, + extra={"spider": spider}, ) return False if self.verbose_stats: - self.stats.inc_value(f'request_depth_count/{depth}', - spider=spider) - self.stats.max_value('request_depth_max', depth, - spider=spider) + self.stats.inc_value(f"request_depth_count/{depth}", spider=spider) + self.stats.max_value("request_depth_max", depth, spider=spider) return True diff --git a/scrapy/spidermiddlewares/httperror.py b/scrapy/spidermiddlewares/httperror.py index 9861456de..0d3e5fe0b 100644 --- a/scrapy/spidermiddlewares/httperror.py +++ b/scrapy/spidermiddlewares/httperror.py @@ -19,39 +19,41 @@ class HttpError(IgnoreRequest): class HttpErrorMiddleware: - @classmethod def from_crawler(cls, crawler): return cls(crawler.settings) def __init__(self, settings): - self.handle_httpstatus_all = settings.getbool('HTTPERROR_ALLOW_ALL') - self.handle_httpstatus_list = settings.getlist('HTTPERROR_ALLOWED_CODES') + self.handle_httpstatus_all = settings.getbool("HTTPERROR_ALLOW_ALL") + self.handle_httpstatus_list = settings.getlist("HTTPERROR_ALLOWED_CODES") def process_spider_input(self, response, spider): if 200 <= response.status < 300: # common case return meta = response.meta - if meta.get('handle_httpstatus_all', False): + if meta.get("handle_httpstatus_all", False): return - if 'handle_httpstatus_list' in meta: - allowed_statuses = meta['handle_httpstatus_list'] + if "handle_httpstatus_list" in meta: + allowed_statuses = meta["handle_httpstatus_list"] elif self.handle_httpstatus_all: return else: - allowed_statuses = getattr(spider, 'handle_httpstatus_list', self.handle_httpstatus_list) + allowed_statuses = getattr( + spider, "handle_httpstatus_list", self.handle_httpstatus_list + ) if response.status in allowed_statuses: return - raise HttpError(response, 'Ignoring non-200 response') + raise HttpError(response, "Ignoring non-200 response") def process_spider_exception(self, response, exception, spider): if isinstance(exception, HttpError): - spider.crawler.stats.inc_value('httperror/response_ignored_count') + spider.crawler.stats.inc_value("httperror/response_ignored_count") spider.crawler.stats.inc_value( - f'httperror/response_ignored_status_count/{response.status}' + f"httperror/response_ignored_status_count/{response.status}" ) logger.info( "Ignoring response %(response)r: HTTP status code is not handled or not allowed", - {'response': response}, extra={'spider': spider}, + {"response": response}, + extra={"spider": spider}, ) return [] diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index 98a186510..c57ec8d48 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -15,7 +15,6 @@ logger = logging.getLogger(__name__) class OffsiteMiddleware: - def __init__(self, stats): self.stats = stats @@ -43,22 +42,24 @@ class OffsiteMiddleware: self.domains_seen.add(domain) logger.debug( "Filtered offsite request to %(domain)r: %(request)s", - {'domain': domain, 'request': request}, extra={'spider': spider}) - self.stats.inc_value('offsite/domains', spider=spider) - self.stats.inc_value('offsite/filtered', spider=spider) + {"domain": domain, "request": request}, + extra={"spider": spider}, + ) + self.stats.inc_value("offsite/domains", spider=spider) + self.stats.inc_value("offsite/filtered", spider=spider) return False def should_follow(self, request, spider): regex = self.host_regex # hostname can be None for wrong urls (like javascript links) - host = urlparse_cached(request).hostname or '' + host = urlparse_cached(request).hostname or "" return bool(regex.search(host)) def get_host_regex(self, spider): """Override this method to implement a different offsite policy""" - allowed_domains = getattr(spider, 'allowed_domains', None) + allowed_domains = getattr(spider, "allowed_domains", None) if not allowed_domains: - return re.compile('') # allow all by default + return re.compile("") # allow all by default url_pattern = re.compile(r"^https?://.*$") port_pattern = re.compile(r":\d+$") domains = [] @@ -66,16 +67,20 @@ class OffsiteMiddleware: if domain is None: continue if url_pattern.match(domain): - message = ("allowed_domains accepts only domains, not URLs. " - f"Ignoring URL entry {domain} in allowed_domains.") + message = ( + "allowed_domains accepts only domains, not URLs. " + f"Ignoring URL entry {domain} in allowed_domains." + ) warnings.warn(message, URLWarning) elif port_pattern.search(domain): - message = ("allowed_domains accepts only domains without ports. " - f"Ignoring entry {domain} in allowed_domains.") + message = ( + "allowed_domains accepts only domains without ports. " + f"Ignoring entry {domain} in allowed_domains." + ) warnings.warn(message, PortWarning) else: domains.append(re.escape(domain)) - regex = fr'^(.*\.)?({"|".join(domains)})$' + regex = rf'^(.*\.)?({"|".join(domains)})$' return re.compile(regex) def spider_opened(self, spider): diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index 4a6c4de5e..a99b6315b 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -16,7 +16,12 @@ from scrapy.utils.python import to_unicode from scrapy.utils.url import strip_url -LOCAL_SCHEMES = ('about', 'blob', 'data', 'filesystem',) +LOCAL_SCHEMES = ( + "about", + "blob", + "data", + "filesystem", +) POLICY_NO_REFERRER = "no-referrer" POLICY_NO_REFERRER_WHEN_DOWNGRADE = "no-referrer-when-downgrade" @@ -61,11 +66,13 @@ class ReferrerPolicy: """ if not url: return None - return strip_url(url, - strip_credentials=True, - strip_fragment=True, - strip_default_port=True, - origin_only=origin_only) + return strip_url( + url, + strip_credentials=True, + strip_fragment=True, + strip_default_port=True, + origin_only=origin_only, + ) def origin(self, url): """Return serialized origin (scheme, host, path) for a request or response URL.""" @@ -74,12 +81,12 @@ class ReferrerPolicy: def potentially_trustworthy(self, url): # Note: this does not follow https://w3c.github.io/webappsec-secure-contexts/#is-url-trustworthy parsed_url = urlparse(url) - if parsed_url.scheme in ('data',): + if parsed_url.scheme in ("data",): return False return self.tls_protected(url) def tls_protected(self, url): - return urlparse(url).scheme in ('https', 'ftps') + return urlparse(url).scheme in ("https", "ftps") class NoReferrerPolicy(ReferrerPolicy): @@ -90,6 +97,7 @@ class NoReferrerPolicy(ReferrerPolicy): is to be sent along with requests made from a particular request client to any origin. The header will be omitted entirely. """ + name: str = POLICY_NO_REFERRER def referrer(self, response_url, request_url): @@ -110,6 +118,7 @@ class NoReferrerWhenDowngradePolicy(ReferrerPolicy): This is a user agent's default behavior, if no policy is otherwise specified. """ + name: str = POLICY_NO_REFERRER_WHEN_DOWNGRADE def referrer(self, response_url, request_url): @@ -127,6 +136,7 @@ class SameOriginPolicy(ReferrerPolicy): Cross-origin requests, on the other hand, will contain no referrer information. A Referer HTTP header will not be sent. """ + name: str = POLICY_SAME_ORIGIN def referrer(self, response_url, request_url): @@ -143,6 +153,7 @@ class OriginPolicy(ReferrerPolicy): when making both same-origin requests and cross-origin requests from a particular request client. """ + name: str = POLICY_ORIGIN def referrer(self, response_url, request_url): @@ -162,11 +173,13 @@ class StrictOriginPolicy(ReferrerPolicy): on the other hand, will contain no referrer information. A Referer HTTP header will not be sent. """ + name: str = POLICY_STRICT_ORIGIN def referrer(self, response_url, request_url): if ( - self.tls_protected(response_url) and self.potentially_trustworthy(request_url) + self.tls_protected(response_url) + and self.potentially_trustworthy(request_url) or not self.tls_protected(response_url) ): return self.origin_referrer(response_url) @@ -183,6 +196,7 @@ class OriginWhenCrossOriginPolicy(ReferrerPolicy): is sent as referrer information when making cross-origin requests from a particular request client. """ + name: str = POLICY_ORIGIN_WHEN_CROSS_ORIGIN def referrer(self, response_url, request_url): @@ -209,6 +223,7 @@ class StrictOriginWhenCrossOriginPolicy(ReferrerPolicy): on the other hand, will contain no referrer information. A Referer HTTP header will not be sent. """ + name: str = POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN def referrer(self, response_url, request_url): @@ -216,7 +231,8 @@ class StrictOriginWhenCrossOriginPolicy(ReferrerPolicy): if origin == self.origin(request_url): return self.stripped_referrer(response_url) if ( - self.tls_protected(response_url) and self.potentially_trustworthy(request_url) + self.tls_protected(response_url) + and self.potentially_trustworthy(request_url) or not self.tls_protected(response_url) ): return self.origin_referrer(response_url) @@ -235,6 +251,7 @@ class UnsafeUrlPolicy(ReferrerPolicy): to insecure origins. Carefully consider the impact of setting such a policy for potentially sensitive documents. """ + name: str = POLICY_UNSAFE_URL def referrer(self, response_url, request_url): @@ -247,24 +264,28 @@ class DefaultReferrerPolicy(NoReferrerWhenDowngradePolicy): with the addition that "Referer" is not sent if the parent request was using ``file://`` or ``s3://`` scheme. """ - NOREFERRER_SCHEMES: Tuple[str, ...] = LOCAL_SCHEMES + ('file', 's3') + + NOREFERRER_SCHEMES: Tuple[str, ...] = LOCAL_SCHEMES + ("file", "s3") name: str = POLICY_SCRAPY_DEFAULT -_policy_classes = {p.name: p for p in ( - NoReferrerPolicy, - NoReferrerWhenDowngradePolicy, - SameOriginPolicy, - OriginPolicy, - StrictOriginPolicy, - OriginWhenCrossOriginPolicy, - StrictOriginWhenCrossOriginPolicy, - UnsafeUrlPolicy, - DefaultReferrerPolicy, -)} +_policy_classes = { + p.name: p + for p in ( + NoReferrerPolicy, + NoReferrerWhenDowngradePolicy, + SameOriginPolicy, + OriginPolicy, + StrictOriginPolicy, + OriginWhenCrossOriginPolicy, + StrictOriginWhenCrossOriginPolicy, + UnsafeUrlPolicy, + DefaultReferrerPolicy, + ) +} # Reference: https://www.w3.org/TR/referrer-policy/#referrer-policy-empty-string -_policy_classes[''] = NoReferrerWhenDowngradePolicy +_policy_classes[""] = NoReferrerWhenDowngradePolicy def _load_policy_class(policy, warning_only=False): @@ -288,16 +309,14 @@ def _load_policy_class(policy, warning_only=False): class RefererMiddleware: - def __init__(self, settings=None): self.default_policy = DefaultReferrerPolicy if settings is not None: - self.default_policy = _load_policy_class( - settings.get('REFERRER_POLICY')) + self.default_policy = _load_policy_class(settings.get("REFERRER_POLICY")) @classmethod def from_crawler(cls, crawler): - if not crawler.settings.getbool('REFERER_ENABLED'): + if not crawler.settings.getbool("REFERER_ENABLED"): raise NotConfigured mw = cls(crawler.settings) @@ -319,12 +338,12 @@ class RefererMiddleware: it is used if valid - otherwise, the policy from settings is used. """ - policy_name = request.meta.get('referrer_policy') + policy_name = request.meta.get("referrer_policy") if policy_name is None: if isinstance(resp_or_url, Response): - policy_header = resp_or_url.headers.get('Referrer-Policy') + policy_header = resp_or_url.headers.get("Referrer-Policy") if policy_header is not None: - policy_name = to_unicode(policy_header.decode('latin1')) + policy_name = to_unicode(policy_header.decode("latin1")) if policy_name is None: return self.default_policy() @@ -342,14 +361,14 @@ class RefererMiddleware: if isinstance(r, Request): referrer = self.policy(response, r).referrer(response.url, r.url) if referrer is not None: - r.headers.setdefault('Referer', referrer) + r.headers.setdefault("Referer", referrer) return r def request_scheduled(self, request, spider): # check redirected request to patch "Referer" header if necessary - redirected_urls = request.meta.get('redirect_urls', []) + redirected_urls = request.meta.get("redirect_urls", []) if redirected_urls: - request_referrer = request.headers.get('Referer') + request_referrer = request.headers.get("Referer") # we don't patch the referrer value if there is none if request_referrer is not None: # the request's referrer header value acts as a surrogate @@ -359,9 +378,10 @@ class RefererMiddleware: # the information is not available using this hook parent_url = safe_url_string(request_referrer) policy_referrer = self.policy(parent_url, request).referrer( - parent_url, request.url) + parent_url, request.url + ) if policy_referrer != request_referrer: if policy_referrer is None: - request.headers.pop('Referer') + request.headers.pop("Referer") else: - request.headers['Referer'] = policy_referrer + request.headers["Referer"] = policy_referrer diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 7ad64d2af..9a21379f9 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -13,13 +13,12 @@ logger = logging.getLogger(__name__) class UrlLengthMiddleware: - def __init__(self, maxlength): self.maxlength = maxlength @classmethod def from_settings(cls, settings): - maxlength = settings.getint('URLLENGTH_LIMIT') + maxlength = settings.getint("URLLENGTH_LIMIT") if not maxlength: raise NotConfigured return cls(maxlength) @@ -36,9 +35,11 @@ class UrlLengthMiddleware: if isinstance(request, Request) and len(request.url) > self.maxlength: logger.info( "Ignoring link (url length > %(maxlength)d): %(url)s ", - {'maxlength': self.maxlength, 'url': request.url}, - extra={'spider': spider} + {"maxlength": self.maxlength, "url": request.url}, + extra={"spider": spider}, + ) + spider.crawler.stats.inc_value( + "urllength/request_ignored_count", spider=spider ) - spider.crawler.stats.inc_value('urllength/request_ignored_count', spider=spider) return False return True diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index a37af97ce..f8cac5458 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -28,16 +28,16 @@ class Spider(object_ref): def __init__(self, name=None, **kwargs): if name is not None: self.name = name - elif not getattr(self, 'name', None): + elif not getattr(self, "name", None): raise ValueError(f"{type(self).__name__} must have a name") self.__dict__.update(kwargs) - if not hasattr(self, 'start_urls'): + if not hasattr(self, "start_urls"): self.start_urls = [] @property def logger(self): logger = logging.getLogger(self.name) - return logging.LoggerAdapter(logger, {'spider': self}) + return logging.LoggerAdapter(logger, {"spider": self}) def log(self, message, level=logging.DEBUG, **kw): """Log the given message at the given log level @@ -60,11 +60,12 @@ class Spider(object_ref): crawler.signals.connect(self.close, signals.spider_closed) def start_requests(self): - if not self.start_urls and hasattr(self, 'start_url'): + if not self.start_urls and hasattr(self, "start_url"): raise AttributeError( "Crawling could not start: 'start_urls' not found " "or empty (but found 'start_url' attribute instead, " - "did you miss an 's'?)") + "did you miss an 's'?)" + ) for url in self.start_urls: yield Request(url, dont_filter=True) @@ -72,11 +73,13 @@ class Spider(object_ref): return self.parse(response, **kwargs) def parse(self, response, **kwargs): - raise NotImplementedError(f'{self.__class__.__name__}.parse callback is not defined') + raise NotImplementedError( + f"{self.__class__.__name__}.parse callback is not defined" + ) @classmethod def update_settings(cls, settings): - settings.setdict(cls.custom_settings or {}, priority='spider') + settings.setdict(cls.custom_settings or {}, priority="spider") @classmethod def handles_request(cls, request): @@ -84,7 +87,7 @@ class Spider(object_ref): @staticmethod def close(spider, reason): - closed = getattr(spider, 'closed', None) + closed = getattr(spider, "closed", None) if callable(closed): return closed(reason) diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index b514ed9ce..d75b455ae 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -34,7 +34,6 @@ _default_link_extractor = LinkExtractor() class Rule: - def __init__( self, link_extractor=None, @@ -95,19 +94,24 @@ class CrawlSpider(Spider): return seen = set() for rule_index, rule in enumerate(self._rules): - links = [lnk for lnk in rule.link_extractor.extract_links(response) - if lnk not in seen] + links = [ + lnk + for lnk in rule.link_extractor.extract_links(response) + if lnk not in seen + ] for link in rule.process_links(links): seen.add(link) request = self._build_request(rule_index, link) yield rule.process_request(request, response) def _callback(self, response, **cb_kwargs): - rule = self._rules[response.meta['rule']] - return self._parse_response(response, rule.callback, {**rule.cb_kwargs, **cb_kwargs}, rule.follow) + rule = self._rules[response.meta["rule"]] + return self._parse_response( + response, rule.callback, {**rule.cb_kwargs, **cb_kwargs}, rule.follow + ) def _errback(self, failure): - rule = self._rules[failure.request.meta['rule']] + rule = self._rules[failure.request.meta["rule"]] return self._handle_failure(failure, rule.errback) async def _parse_response(self, response, callback, cb_kwargs, follow=True): @@ -140,5 +144,7 @@ class CrawlSpider(Spider): @classmethod def from_crawler(cls, crawler, *args, **kwargs): spider = super().from_crawler(crawler, *args, **kwargs) - spider._follow_links = crawler.settings.getbool('CRAWLSPIDER_FOLLOW_LINKS', True) + spider._follow_links = crawler.settings.getbool( + "CRAWLSPIDER_FOLLOW_LINKS", True + ) return spider diff --git a/scrapy/spiders/feed.py b/scrapy/spiders/feed.py index 79e12e030..b3c5ff01e 100644 --- a/scrapy/spiders/feed.py +++ b/scrapy/spiders/feed.py @@ -21,8 +21,8 @@ class XMLFeedSpider(Spider): use iternodes, since it's a faster and cleaner. """ - iterator = 'iternodes' - itertag = 'item' + iterator = "iternodes" + itertag = "item" namespaces = () def process_results(self, response, results): @@ -44,7 +44,7 @@ class XMLFeedSpider(Spider): def parse_node(self, response, selector): """This method must be overridden with your custom spider functionality""" - if hasattr(self, 'parse_item'): # backward compatibility + if hasattr(self, "parse_item"): # backward compatibility return self.parse_item(response, selector) raise NotImplementedError @@ -62,22 +62,24 @@ class XMLFeedSpider(Spider): yield result_item def _parse(self, response, **kwargs): - if not hasattr(self, 'parse_node'): - raise NotConfigured('You must define parse_node method in order to scrape this XML feed') + if not hasattr(self, "parse_node"): + raise NotConfigured( + "You must define parse_node method in order to scrape this XML feed" + ) response = self.adapt_response(response) - if self.iterator == 'iternodes': + if self.iterator == "iternodes": nodes = self._iternodes(response) - elif self.iterator == 'xml': - selector = Selector(response, type='xml') + elif self.iterator == "xml": + selector = Selector(response, type="xml") self._register_namespaces(selector) - nodes = selector.xpath(f'//{self.itertag}') - elif self.iterator == 'html': - selector = Selector(response, type='html') + nodes = selector.xpath(f"//{self.itertag}") + elif self.iterator == "html": + selector = Selector(response, type="html") self._register_namespaces(selector) - nodes = selector.xpath(f'//{self.itertag}') + nodes = selector.xpath(f"//{self.itertag}") else: - raise NotSupported('Unsupported node iterator') + raise NotSupported("Unsupported node iterator") return self.parse_nodes(response, nodes) @@ -100,8 +102,12 @@ class CSVFeedSpider(Spider): and the file's headers. """ - delimiter = None # When this is None, python's csv module's default delimiter is used - quotechar = None # When this is None, python's csv module's default quotechar is used + delimiter = ( + None # When this is None, python's csv module's default delimiter is used + ) + quotechar = ( + None # When this is None, python's csv module's default quotechar is used + ) headers = None def process_results(self, response, results): @@ -123,13 +129,17 @@ class CSVFeedSpider(Spider): process_results methods for pre and post-processing purposes. """ - for row in csviter(response, self.delimiter, self.headers, quotechar=self.quotechar): + for row in csviter( + response, self.delimiter, self.headers, quotechar=self.quotechar + ): ret = iterate_spider_output(self.parse_row(response, row)) for result_item in self.process_results(response, ret): yield result_item def _parse(self, response, **kwargs): - if not hasattr(self, 'parse_row'): - raise NotConfigured('You must define parse_row method in order to scrape this CSV feed') + if not hasattr(self, "parse_row"): + raise NotConfigured( + "You must define parse_row method in order to scrape this CSV feed" + ) response = self.adapt_response(response) return self.parse_rows(response) diff --git a/scrapy/spiders/init.py b/scrapy/spiders/init.py index fe8c94e78..3cb215b0f 100644 --- a/scrapy/spiders/init.py +++ b/scrapy/spiders/init.py @@ -13,7 +13,7 @@ class InitSpider(Spider): """This method must be set as the callback of your last initialization request. See self.init_request() docstring for more info. """ - return self.__dict__.pop('_postinit_reqs') + return self.__dict__.pop("_postinit_reqs") def init_request(self): """This function should return one initialization request, with the diff --git a/scrapy/spiders/sitemap.py b/scrapy/spiders/sitemap.py index 43d138753..a1734a3b1 100644 --- a/scrapy/spiders/sitemap.py +++ b/scrapy/spiders/sitemap.py @@ -13,8 +13,8 @@ logger = logging.getLogger(__name__) class SitemapSpider(Spider): sitemap_urls = () - sitemap_rules = [('', 'parse')] - sitemap_follow = [''] + sitemap_rules = [("", "parse")] + sitemap_follow = [""] sitemap_alternate_links = False def __init__(self, *a, **kw): @@ -39,24 +39,27 @@ class SitemapSpider(Spider): yield entry def _parse_sitemap(self, response): - if response.url.endswith('/robots.txt'): + if response.url.endswith("/robots.txt"): for url in sitemap_urls_from_robots(response.text, base_url=response.url): yield Request(url, callback=self._parse_sitemap) else: body = self._get_sitemap_body(response) if body is None: - logger.warning("Ignoring invalid sitemap: %(response)s", - {'response': response}, extra={'spider': self}) + logger.warning( + "Ignoring invalid sitemap: %(response)s", + {"response": response}, + extra={"spider": self}, + ) return s = Sitemap(body) it = self.sitemap_filter(s) - if s.type == 'sitemapindex': + if s.type == "sitemapindex": for loc in iterloc(it, self.sitemap_alternate_links): if any(x.search(loc) for x in self._follow): yield Request(loc, callback=self._parse_sitemap) - elif s.type == 'urlset': + elif s.type == "urlset": for loc in iterloc(it, self.sitemap_alternate_links): for r, c in self._cbs: if r.search(loc): @@ -80,7 +83,7 @@ class SitemapSpider(Spider): # without actually being a .xml.gz file in the first place, # merely XML gzip-compressed on the fly, # in other word, here, we have plain XML - if response.url.endswith('.xml') or response.url.endswith('.xml.gz'): + if response.url.endswith(".xml") or response.url.endswith(".xml.gz"): return response.body @@ -92,8 +95,8 @@ def regex(x): def iterloc(it, alt=False): for d in it: - yield d['loc'] + yield d["loc"] # Also consider alternate URLs (xhtml:link rel="alternate") - if alt and 'alternate' in d: - yield from d['alternate'] + if alt and "alternate" in d: + yield from d["alternate"] diff --git a/scrapy/squeues.py b/scrapy/squeues.py index 2fa84fc00..6afe0d636 100644 --- a/scrapy/squeues.py +++ b/scrapy/squeues.py @@ -15,9 +15,7 @@ from scrapy.utils.request import request_from_dict def _with_mkdir(queue_class): - class DirectoriesCreated(queue_class): - def __init__(self, path: Union[str, PathLike], *args, **kwargs): dirname = Path(path).parent if not dirname.exists(): @@ -28,9 +26,7 @@ def _with_mkdir(queue_class): def _serializable_queue(queue_class, serialize, deserialize): - class SerializableQueue(queue_class): - def push(self, obj): s = serialize(obj) super().push(s) @@ -50,7 +46,9 @@ def _serializable_queue(queue_class, serialize, deserialize): try: s = super().peek() except AttributeError as ex: - raise NotImplementedError("The underlying queue class does not implement 'peek'") from ex + raise NotImplementedError( + "The underlying queue class does not implement 'peek'" + ) from ex if s: return deserialize(s) @@ -58,9 +56,7 @@ def _serializable_queue(queue_class, serialize, deserialize): def _scrapy_serialization_queue(queue_class): - class ScrapyRequestQueue(queue_class): - def __init__(self, crawler, key): self.spider = crawler.spider super().__init__(key) @@ -95,7 +91,6 @@ def _scrapy_serialization_queue(queue_class): def _scrapy_non_serialization_queue(queue_class): - class ScrapyRequestQueue(queue_class): @classmethod def from_crawler(cls, crawler, *args, **kwargs): @@ -111,7 +106,9 @@ def _scrapy_non_serialization_queue(queue_class): try: s = super().peek() except AttributeError as ex: - raise NotImplementedError("The underlying queue class does not implement 'peek'") from ex + raise NotImplementedError( + "The underlying queue class does not implement 'peek'" + ) from ex return s return ScrapyRequestQueue @@ -127,24 +124,16 @@ def _pickle_serialize(obj): _PickleFifoSerializationDiskQueue = _serializable_queue( - _with_mkdir(queue.FifoDiskQueue), - _pickle_serialize, - pickle.loads + _with_mkdir(queue.FifoDiskQueue), _pickle_serialize, pickle.loads ) _PickleLifoSerializationDiskQueue = _serializable_queue( - _with_mkdir(queue.LifoDiskQueue), - _pickle_serialize, - pickle.loads + _with_mkdir(queue.LifoDiskQueue), _pickle_serialize, pickle.loads ) _MarshalFifoSerializationDiskQueue = _serializable_queue( - _with_mkdir(queue.FifoDiskQueue), - marshal.dumps, - marshal.loads + _with_mkdir(queue.FifoDiskQueue), marshal.dumps, marshal.loads ) _MarshalLifoSerializationDiskQueue = _serializable_queue( - _with_mkdir(queue.LifoDiskQueue), - marshal.dumps, - marshal.loads + _with_mkdir(queue.LifoDiskQueue), marshal.dumps, marshal.loads ) # public queue classes diff --git a/scrapy/statscollectors.py b/scrapy/statscollectors.py index ba7d1a6bf..4181c7a2f 100644 --- a/scrapy/statscollectors.py +++ b/scrapy/statscollectors.py @@ -8,9 +8,8 @@ logger = logging.getLogger(__name__) class StatsCollector: - def __init__(self, crawler): - self._dump = crawler.settings.getbool('STATS_DUMP') + self._dump = crawler.settings.getbool("STATS_DUMP") self._stats = {} def get_value(self, key, default=None, spider=None): @@ -43,8 +42,10 @@ class StatsCollector: def close_spider(self, spider, reason): if self._dump: - logger.info("Dumping Scrapy stats:\n" + pprint.pformat(self._stats), - extra={'spider': spider}) + logger.info( + "Dumping Scrapy stats:\n" + pprint.pformat(self._stats), + extra={"spider": spider}, + ) self._persist_stats(self._stats, spider) def _persist_stats(self, stats, spider): @@ -52,7 +53,6 @@ class StatsCollector: class MemoryStatsCollector(StatsCollector): - def __init__(self, crawler): super().__init__(crawler) self.spider_stats = {} @@ -62,7 +62,6 @@ class MemoryStatsCollector(StatsCollector): class DummyStatsCollector(StatsCollector): - def get_value(self, key, default=None, spider=None): return default diff --git a/scrapy/utils/asyncgen.py b/scrapy/utils/asyncgen.py index c84b51e8c..0505db343 100644 --- a/scrapy/utils/asyncgen.py +++ b/scrapy/utils/asyncgen.py @@ -9,7 +9,7 @@ async def collect_asyncgen(result: AsyncIterable) -> list: async def as_async_generator(it: Union[Iterable, AsyncIterable]) -> AsyncGenerator: - """ Wraps an iterable (sync or async) into an async generator. """ + """Wraps an iterable (sync or async) into an async generator.""" if isinstance(it, AsyncIterable): async for r in it: yield r diff --git a/scrapy/utils/benchserver.py b/scrapy/utils/benchserver.py index 86238c4cd..32bc2e38c 100644 --- a/scrapy/utils/benchserver.py +++ b/scrapy/utils/benchserver.py @@ -13,26 +13,28 @@ class Root(Resource): return self def render(self, request): - total = _getarg(request, b'total', 100, int) - show = _getarg(request, b'show', 10, int) + total = _getarg(request, b"total", 100, int) + show = _getarg(request, b"show", 10, int) nlist = [random.randint(1, total) for _ in range(show)] request.write(b"") args = request.args.copy() for nl in nlist: - args['n'] = nl + args["n"] = nl argstr = urlencode(args, doseq=True) - request.write(f"follow {nl}
" - .encode('utf8')) + request.write( + f"follow {nl}
".encode("utf8") + ) request.write(b"") - return b'' + return b"" def _getarg(request, name, default=None, type=str): return type(request.args[name][0]) if name in request.args else default -if __name__ == '__main__': +if __name__ == "__main__": from twisted.internet import reactor + root = Root() factory = Site(root) httpPort = reactor.listenTCP(8998, Site(root)) @@ -40,5 +42,6 @@ if __name__ == '__main__': def _print_listening(): httpHost = httpPort.getHost() print(f"Bench server at http://{httpHost.host}:{httpHost.port}") + reactor.callWhenRunning(_print_listening) reactor.run() diff --git a/scrapy/utils/boto.py b/scrapy/utils/boto.py index 39a681001..085ee7d25 100644 --- a/scrapy/utils/boto.py +++ b/scrapy/utils/boto.py @@ -4,6 +4,7 @@ def is_botocore_available(): try: import botocore # noqa: F401 + return True except ImportError: return False diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 8ea42ce75..2f1569ab6 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -19,8 +19,10 @@ def build_component_list(compdict, custom=None, convert=update_classpath): def _check_components(complist): if len({convert(c) for c in complist}) != len(complist): - raise ValueError(f'Some paths in {complist!r} convert to the same object, ' - 'please update your settings') + raise ValueError( + f"Some paths in {complist!r} convert to the same object, " + "please update your settings" + ) def _map_keys(compdict): if isinstance(compdict, BaseSettings): @@ -28,10 +30,11 @@ def build_component_list(compdict, custom=None, convert=update_classpath): for k, v in compdict.items(): prio = compdict.getpriority(k) if compbs.getpriority(convert(k)) == prio: - raise ValueError(f'Some paths in {list(compdict.keys())!r} ' - 'convert to the same ' - 'object, please update your settings' - ) + raise ValueError( + f"Some paths in {list(compdict.keys())!r} " + "convert to the same " + "object, please update your settings" + ) else: compbs.set(convert(k), v, priority=prio) return compbs @@ -42,8 +45,10 @@ def build_component_list(compdict, custom=None, convert=update_classpath): """Fail if a value in the components dict is not a real number or None.""" for name, value in compdict.items(): if value is not None and not isinstance(value, numbers.Real): - raise ValueError(f'Invalid value {value} for component {name}, ' - 'please provide a real number or None instead') + raise ValueError( + f"Invalid value {value} for component {name}, " + "please provide a real number or None instead" + ) if isinstance(custom, (list, tuple)): _check_components(custom) @@ -61,30 +66,33 @@ def arglist_to_dict(arglist): """Convert a list of arguments like ['arg1=val1', 'arg2=val2', ...] to a dict """ - return dict(x.split('=', 1) for x in arglist) + return dict(x.split("=", 1) for x in arglist) -def closest_scrapy_cfg(path: Union[str, os.PathLike] = '.', prevpath: Optional[Union[str, os.PathLike]] = None) -> str: +def closest_scrapy_cfg( + path: Union[str, os.PathLike] = ".", + prevpath: Optional[Union[str, os.PathLike]] = None, +) -> str: """Return the path to the closest scrapy.cfg file by traversing the current directory and its parents """ if prevpath is not None and str(path) == str(prevpath): - return '' + return "" path = Path(path).resolve() - cfgfile = path / 'scrapy.cfg' + cfgfile = path / "scrapy.cfg" if cfgfile.exists(): return str(cfgfile) return closest_scrapy_cfg(path.parent, path) -def init_env(project='default', set_syspath=True): +def init_env(project="default", set_syspath=True): """Initialize environment to use command-line tool from inside a project dir. This sets the Scrapy settings module and modifies the Python path to be able to locate the project module. """ cfg = get_config() - if cfg.has_option('settings', project): - os.environ['SCRAPY_SETTINGS_MODULE'] = cfg.get('settings', project) + if cfg.has_option("settings", project): + os.environ["SCRAPY_SETTINGS_MODULE"] = cfg.get("settings", project) closest = closest_scrapy_cfg() if closest: projdir = str(Path(closest).parent) @@ -101,12 +109,14 @@ def get_config(use_closest=True): def get_sources(use_closest=True) -> List[str]: - xdg_config_home = os.environ.get('XDG_CONFIG_HOME') or Path('~/.config').expanduser() + xdg_config_home = ( + os.environ.get("XDG_CONFIG_HOME") or Path("~/.config").expanduser() + ) sources = [ - '/etc/scrapy.cfg', - r'c:\scrapy\scrapy.cfg', - str(Path(xdg_config_home) / 'scrapy.cfg'), - str(Path('~/.scrapy.cfg').expanduser()), + "/etc/scrapy.cfg", + r"c:\scrapy\scrapy.cfg", + str(Path(xdg_config_home) / "scrapy.cfg"), + str(Path("~/.scrapy.cfg").expanduser()), ] if use_closest: sources.append(closest_scrapy_cfg()) @@ -115,7 +125,7 @@ def get_sources(use_closest=True) -> List[str]: def feed_complete_default_values_from_settings(feed, settings): out = feed.copy() - out.setdefault("batch_item_count", settings.getint('FEED_EXPORT_BATCH_ITEM_COUNT')) + out.setdefault("batch_item_count", settings.getint("FEED_EXPORT_BATCH_ITEM_COUNT")) out.setdefault("encoding", settings["FEED_EXPORT_ENCODING"]) out.setdefault("fields", settings.getdictorlist("FEED_EXPORT_FIELDS") or None) out.setdefault("store_empty", settings.getbool("FEED_STORE_EMPTY")) @@ -128,15 +138,19 @@ def feed_complete_default_values_from_settings(feed, settings): return out -def feed_process_params_from_cli(settings, output: List[str], output_format=None, - overwrite_output: Optional[List[str]] = None): +def feed_process_params_from_cli( + settings, + output: List[str], + output_format=None, + overwrite_output: Optional[List[str]] = None, +): """ Receives feed export params (from the 'crawl' or 'runspider' commands), checks for inconsistencies in their quantities and returns a dictionary suitable to be used as the FEEDS setting. """ valid_output_formats = without_none_values( - settings.getwithbase('FEED_EXPORTERS') + settings.getwithbase("FEED_EXPORTERS") ).keys() def check_valid_format(output_format): @@ -179,28 +193,28 @@ def feed_process_params_from_cli(settings, output: List[str], output_format=None "scrapy crawl quotes -O quotes.json:json" ) warnings.warn(message, ScrapyDeprecationWarning, stacklevel=2) - return {output[0]: {'format': output_format}} + return {output[0]: {"format": output_format}} raise UsageError( - 'The -t command-line option cannot be used if multiple output ' - 'URIs are specified' + "The -t command-line option cannot be used if multiple output " + "URIs are specified" ) result: Dict[str, Dict[str, Any]] = {} for element in output: try: - feed_uri, feed_format = element.rsplit(':', 1) + feed_uri, feed_format = element.rsplit(":", 1) except ValueError: feed_uri = element - feed_format = Path(element).suffix.replace('.', '') + feed_format = Path(element).suffix.replace(".", "") else: - if feed_uri == '-': - feed_uri = 'stdout:' + if feed_uri == "-": + feed_uri = "stdout:" check_valid_format(feed_format) - result[feed_uri] = {'format': feed_format} + result[feed_uri] = {"format": feed_format} if overwrite: - result[feed_uri]['overwrite'] = True + result[feed_uri]["overwrite"] = True # FEEDS setting should take precedence over the matching CLI options - result.update(settings.getdict('FEEDS')) + result.update(settings.getdict("FEEDS")) return result diff --git a/scrapy/utils/console.py b/scrapy/utils/console.py index 1bc0bd45f..b64098d7b 100644 --- a/scrapy/utils/console.py +++ b/scrapy/utils/console.py @@ -2,7 +2,7 @@ from functools import wraps from collections import OrderedDict -def _embed_ipython_shell(namespace={}, banner=''): +def _embed_ipython_shell(namespace={}, banner=""): """Start an IPython Shell""" try: from IPython.terminal.embed import InteractiveShellEmbed @@ -12,7 +12,7 @@ def _embed_ipython_shell(namespace={}, banner=''): from IPython.frontend.terminal.ipapp import load_default_config @wraps(_embed_ipython_shell) - def wrapper(namespace=namespace, banner=''): + def wrapper(namespace=namespace, banner=""): config = load_default_config() # Always use .instance() to ensure _instance propagation to all parents # this is needed for completion works well for new imports @@ -20,55 +20,64 @@ def _embed_ipython_shell(namespace={}, banner=''): # on repeated breaks like with inspect_response() InteractiveShellEmbed.clear_instance() shell = InteractiveShellEmbed.instance( - banner1=banner, user_ns=namespace, config=config) + banner1=banner, user_ns=namespace, config=config + ) shell() + return wrapper -def _embed_bpython_shell(namespace={}, banner=''): +def _embed_bpython_shell(namespace={}, banner=""): """Start a bpython shell""" import bpython @wraps(_embed_bpython_shell) - def wrapper(namespace=namespace, banner=''): + def wrapper(namespace=namespace, banner=""): bpython.embed(locals_=namespace, banner=banner) + return wrapper -def _embed_ptpython_shell(namespace={}, banner=''): +def _embed_ptpython_shell(namespace={}, banner=""): """Start a ptpython shell""" import ptpython.repl @wraps(_embed_ptpython_shell) - def wrapper(namespace=namespace, banner=''): + def wrapper(namespace=namespace, banner=""): print(banner) ptpython.repl.embed(locals=namespace) + return wrapper -def _embed_standard_shell(namespace={}, banner=''): +def _embed_standard_shell(namespace={}, banner=""): """Start a standard python shell""" import code + try: # readline module is only available on unix systems import readline except ImportError: pass else: import rlcompleter # noqa: F401 + readline.parse_and_bind("tab:complete") @wraps(_embed_standard_shell) - def wrapper(namespace=namespace, banner=''): + def wrapper(namespace=namespace, banner=""): code.interact(banner=banner, local=namespace) + return wrapper -DEFAULT_PYTHON_SHELLS = OrderedDict([ - ('ptpython', _embed_ptpython_shell), - ('ipython', _embed_ipython_shell), - ('bpython', _embed_bpython_shell), - ('python', _embed_standard_shell), -]) +DEFAULT_PYTHON_SHELLS = OrderedDict( + [ + ("ptpython", _embed_ptpython_shell), + ("ipython", _embed_ipython_shell), + ("bpython", _embed_bpython_shell), + ("python", _embed_standard_shell), + ] +) def get_shell_embed_func(shells=None, known_shells=None): @@ -89,7 +98,7 @@ def get_shell_embed_func(shells=None, known_shells=None): continue -def start_python_console(namespace=None, banner='', shells=None): +def start_python_console(namespace=None, banner="", shells=None): """Start Python console bound to the given namespace. Readline support and tab completion will be used on Unix, if available. """ diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index 74f82ad75..3175e5fdc 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -9,52 +9,54 @@ from w3lib.http import basic_auth_header class CurlParser(argparse.ArgumentParser): def error(self, message): - error_msg = f'There was an error parsing the curl command: {message}' + error_msg = f"There was an error parsing the curl command: {message}" raise ValueError(error_msg) curl_parser = CurlParser() -curl_parser.add_argument('url') -curl_parser.add_argument('-H', '--header', dest='headers', action='append') -curl_parser.add_argument('-X', '--request', dest='method') -curl_parser.add_argument('-d', '--data', '--data-raw', dest='data') -curl_parser.add_argument('-u', '--user', dest='auth') +curl_parser.add_argument("url") +curl_parser.add_argument("-H", "--header", dest="headers", action="append") +curl_parser.add_argument("-X", "--request", dest="method") +curl_parser.add_argument("-d", "--data", "--data-raw", dest="data") +curl_parser.add_argument("-u", "--user", dest="auth") safe_to_ignore_arguments = [ - ['--compressed'], + ["--compressed"], # `--compressed` argument is not safe to ignore, but it's included here # because the `HttpCompressionMiddleware` is enabled by default - ['-s', '--silent'], - ['-v', '--verbose'], - ['-#', '--progress-bar'] + ["-s", "--silent"], + ["-v", "--verbose"], + ["-#", "--progress-bar"], ] for argument in safe_to_ignore_arguments: - curl_parser.add_argument(*argument, action='store_true') + curl_parser.add_argument(*argument, action="store_true") def _parse_headers_and_cookies(parsed_args): headers = [] cookies = {} for header in parsed_args.headers or (): - name, val = header.split(':', 1) + name, val = header.split(":", 1) name = name.strip() val = val.strip() - if name.title() == 'Cookie': + if name.title() == "Cookie": for name, morsel in SimpleCookie(val).items(): cookies[name] = morsel.value else: headers.append((name, val)) if parsed_args.auth: - user, password = parsed_args.auth.split(':', 1) - headers.append(('Authorization', basic_auth_header(user, password))) + user, password = parsed_args.auth.split(":", 1) + headers.append(("Authorization", basic_auth_header(user, password))) return headers, cookies -def curl_to_request_kwargs(curl_command: str, ignore_unknown_options: bool = True) -> dict: +def curl_to_request_kwargs( + curl_command: str, ignore_unknown_options: bool = True +) -> dict: """Convert a cURL command syntax to Request kwargs. :param str curl_command: string containing the curl command @@ -66,7 +68,7 @@ def curl_to_request_kwargs(curl_command: str, ignore_unknown_options: bool = Tru curl_args = split(curl_command) - if curl_args[0] != 'curl': + if curl_args[0] != "curl": raise ValueError('A curl command must start with "curl"') parsed_args, argv = curl_parser.parse_known_args(curl_args[1:]) @@ -84,23 +86,23 @@ def curl_to_request_kwargs(curl_command: str, ignore_unknown_options: bool = Tru # needs the scheme to work parsed_url = urlparse(url) if not parsed_url.scheme: - url = 'http://' + url + url = "http://" + url - method = parsed_args.method or 'GET' + method = parsed_args.method or "GET" - result = {'method': method.upper(), 'url': url} + result = {"method": method.upper(), "url": url} headers, cookies = _parse_headers_and_cookies(parsed_args) if headers: - result['headers'] = headers + result["headers"] = headers if cookies: - result['cookies'] = cookies + result["cookies"] = cookies if parsed_args.data: - result['body'] = parsed_args.data + result["body"] = parsed_args.data if not parsed_args.method: # if the "data" is specified but the "method" is not specified, # the default method is 'POST' - result['method'] = 'POST' + result["method"] = "POST" return result diff --git a/scrapy/utils/datatypes.py b/scrapy/utils/datatypes.py index 47df8a717..10497e9ed 100644 --- a/scrapy/utils/datatypes.py +++ b/scrapy/utils/datatypes.py @@ -30,10 +30,12 @@ class CaselessDict(dict): def __contains__(self, key): return dict.__contains__(self, self.normkey(key)) + has_key = __contains__ def __copy__(self): return self.__class__(self) + copy = __copy__ def normkey(self, key): diff --git a/scrapy/utils/decorators.py b/scrapy/utils/decorators.py index fef3882cb..4e684645b 100644 --- a/scrapy/utils/decorators.py +++ b/scrapy/utils/decorators.py @@ -19,6 +19,7 @@ def deprecated(use_instead=None): message += f" Use {use_instead} instead." warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) return func(*args, **kwargs) + return wrapped if callable(use_instead): @@ -29,9 +30,11 @@ def deprecated(use_instead=None): def defers(func): """Decorator to make sure a function always returns a deferred""" + @wraps(func) def wrapped(*a, **kw): return defer.maybeDeferred(func, *a, **kw) + return wrapped @@ -39,7 +42,9 @@ def inthread(func): """Decorator to call a function in a thread and return a deferred with the result """ + @wraps(func) def wrapped(*a, **kw): return threads.deferToThread(func, *a, **kw) + return wrapped diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index ddacfaa49..4af2a647a 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -16,7 +16,7 @@ from typing import ( Iterator, List, Optional, - Union + Union, ) from twisted.internet import defer @@ -26,7 +26,10 @@ from twisted.python import failure from twisted.python.failure import Failure from scrapy.exceptions import IgnoreRequest -from scrapy.utils.reactor import is_asyncio_reactor_installed, get_asyncio_event_loop_policy +from scrapy.utils.reactor import ( + is_asyncio_reactor_installed, + get_asyncio_event_loop_policy, +) def defer_fail(_failure: Failure) -> Deferred: @@ -37,6 +40,7 @@ def defer_fail(_failure: Failure) -> Deferred: before attending pending delayed calls, so do not set delay to zero. """ from twisted.internet import reactor + d = Deferred() reactor.callLater(0.1, d.errback, _failure) return d @@ -50,6 +54,7 @@ def defer_succeed(result) -> Deferred: before attending pending delayed calls, so do not set delay to zero. """ from twisted.internet import reactor + d = Deferred() reactor.callLater(0.1, d.callback, result) return d @@ -80,7 +85,9 @@ def mustbe_deferred(f: Callable, *args, **kw) -> Deferred: return defer_result(result) -def parallel(iterable: Iterable, count: int, callable: Callable, *args, **named) -> DeferredList: +def parallel( + iterable: Iterable, count: int, callable: Callable, *args, **named +) -> DeferredList: """Execute a callable over the objects in the given iterable, in parallel, using no more than ``count`` concurrent calls. @@ -92,7 +99,7 @@ def parallel(iterable: Iterable, count: int, callable: Callable, *args, **named) class _AsyncCooperatorAdapter(Iterator): - """ A class that wraps an async iterable into a normal iterator suitable + """A class that wraps an async iterable into a normal iterator suitable for using in Cooperator.coiterate(). As it's only needed for parallel_async(), it calls the callable directly in the callback, instead of providing a more generic interface. @@ -136,7 +143,14 @@ class _AsyncCooperatorAdapter(Iterator): Cooperator/CooperativeTask and use it instead of this adapter to achieve the same goal. """ - def __init__(self, aiterable: AsyncIterable, callable: Callable, *callable_args, **callable_kwargs): + + def __init__( + self, + aiterable: AsyncIterable, + callable: Callable, + *callable_args, + **callable_kwargs + ): self.aiterator = aiterable.__aiter__() self.callable = callable self.callable_args = callable_args @@ -186,8 +200,10 @@ class _AsyncCooperatorAdapter(Iterator): return d -def parallel_async(async_iterable: AsyncIterable, count: int, callable: Callable, *args, **named) -> DeferredList: - """ Like parallel but for async iterators """ +def parallel_async( + async_iterable: AsyncIterable, count: int, callable: Callable, *args, **named +) -> DeferredList: + """Like parallel but for async iterators""" coop = Cooperator() work = _AsyncCooperatorAdapter(async_iterable, callable, *args, **named) dl = DeferredList([coop.coiterate(work) for _ in range(count)]) @@ -203,14 +219,19 @@ def process_chain(callbacks: Iterable[Callable], input, *a, **kw) -> Deferred: return d -def process_chain_both(callbacks: Iterable[Callable], errbacks: Iterable[Callable], input, *a, **kw) -> Deferred: +def process_chain_both( + callbacks: Iterable[Callable], errbacks: Iterable[Callable], input, *a, **kw +) -> Deferred: """Return a Deferred built by chaining the given callbacks and errbacks""" d = Deferred() for cb, eb in zip(callbacks, errbacks): d.addCallbacks( - callback=cb, errback=eb, - callbackArgs=a, callbackKeywords=kw, - errbackArgs=a, errbackKeywords=kw, + callback=cb, + errback=eb, + callbackArgs=a, + callbackKeywords=kw, + errbackArgs=a, + errbackKeywords=kw, ) if isinstance(input, failure.Failure): d.errback(input) @@ -243,7 +264,9 @@ def iter_errback(iterable: Iterable, errback: Callable, *a, **kw) -> Generator: errback(failure.Failure(), *a, **kw) -async def aiter_errback(aiterable: AsyncIterable, errback: Callable, *a, **kw) -> AsyncGenerator: +async def aiter_errback( + aiterable: AsyncIterable, errback: Callable, *a, **kw +) -> AsyncGenerator: """Wraps an async iterable calling an errback if an error is caught while iterating it. Similar to scrapy.utils.defer.iter_errback() """ @@ -273,19 +296,21 @@ def deferred_from_coro(o) -> Any: def deferred_f_from_coro_f(coro_f: Callable[..., Coroutine]) -> Callable: - """ Converts a coroutine function into a function that returns a Deferred. + """Converts a coroutine function into a function that returns a Deferred. The coroutine function will be called at the time when the wrapper is called. Wrapper args will be passed to it. This is useful for callback chains, as callback functions are called with the previous callback result. """ + @wraps(coro_f) def f(*coro_args, **coro_kwargs): return deferred_from_coro(coro_f(*coro_args, **coro_kwargs)) + return f def maybeDeferred_coro(f: Callable, *args, **kw) -> Deferred: - """ Copy of defer.maybeDeferred that also converts coroutines to Deferreds. """ + """Copy of defer.maybeDeferred that also converts coroutines to Deferreds.""" try: result = f(*args, **kw) except: # noqa: E722 diff --git a/scrapy/utils/deprecate.py b/scrapy/utils/deprecate.py index a0c83f9f1..4757fef0a 100644 --- a/scrapy/utils/deprecate.py +++ b/scrapy/utils/deprecate.py @@ -6,13 +6,14 @@ from typing import List, Tuple from scrapy.exceptions import ScrapyDeprecationWarning -def attribute(obj, oldattr, newattr, version='0.12'): +def attribute(obj, oldattr, newattr, version="0.12"): cname = obj.__class__.__name__ warnings.warn( f"{cname}.{oldattr} attribute is deprecated and will be no longer supported " f"in Scrapy {version}, use {cname}.{newattr} attribute instead", ScrapyDeprecationWarning, - stacklevel=3) + stacklevel=3, + ) def create_deprecated_class( @@ -24,7 +25,7 @@ def create_deprecated_class( old_class_path=None, new_class_path=None, subclass_warn_message="{cls} inherits from deprecated class {old}, please inherit from {new}.", - instance_warn_message="{cls} is deprecated, instantiate {new} instead." + instance_warn_message="{cls} is deprecated, instantiate {new} instead.", ): """ Return a "deprecated" class that causes its subclasses to issue a warning. @@ -67,11 +68,13 @@ def create_deprecated_class( old = meta.deprecated_class if old in bases and not (warn_once and meta.warned_on_subclass): meta.warned_on_subclass = True - msg = subclass_warn_message.format(cls=_clspath(cls), - old=_clspath(old, old_class_path), - new=_clspath(new_class, new_class_path)) + msg = subclass_warn_message.format( + cls=_clspath(cls), + old=_clspath(old, old_class_path), + new=_clspath(new_class, new_class_path), + ) if warn_once: - msg += ' (warning only on first subclass, there may be others)' + msg += " (warning only on first subclass, there may be others)" warnings.warn(msg, warn_category, stacklevel=2) super().__init__(name, bases, clsdict_) @@ -79,8 +82,7 @@ def create_deprecated_class( # and https://docs.python.org/reference/datamodel.html#customizing-instance-and-subclass-checks # for implementation details def __instancecheck__(cls, inst): - return any(cls.__subclasscheck__(c) - for c in (type(inst), inst.__class__)) + return any(cls.__subclasscheck__(c) for c in (type(inst), inst.__class__)) def __subclasscheck__(cls, sub): if cls is not DeprecatedClass.deprecated_class: @@ -93,14 +95,16 @@ def create_deprecated_class( if not inspect.isclass(sub): raise TypeError("issubclass() arg 1 must be a class") - mro = getattr(sub, '__mro__', ()) + mro = getattr(sub, "__mro__", ()) return any(c in {cls, new_class} for c in mro) def __call__(cls, *args, **kwargs): old = DeprecatedClass.deprecated_class if cls is old: - msg = instance_warn_message.format(cls=_clspath(cls, old_class_path), - new=_clspath(new_class, new_class_path)) + msg = instance_warn_message.format( + cls=_clspath(cls, old_class_path), + new=_clspath(new_class, new_class_path), + ) warnings.warn(msg, warn_category, stacklevel=2) return super().__call__(*args, **kwargs) @@ -124,7 +128,7 @@ def create_deprecated_class( def _clspath(cls, forced=None): if forced is not None: return forced - return f'{cls.__module__}.{cls.__name__}' + return f"{cls.__module__}.{cls.__name__}" DEPRECATION_RULES: List[Tuple[str, str]] = [] @@ -135,8 +139,10 @@ def update_classpath(path): for prefix, replacement in DEPRECATION_RULES: if isinstance(path, str) and path.startswith(prefix): new_path = path.replace(prefix, replacement, 1) - warnings.warn(f"`{path}` class is deprecated, use `{new_path}` instead", - ScrapyDeprecationWarning) + warnings.warn( + f"`{path}` class is deprecated, use `{new_path}` instead", + ScrapyDeprecationWarning, + ) return new_path return path diff --git a/scrapy/utils/display.py b/scrapy/utils/display.py index 64969cb13..f6dceb87f 100644 --- a/scrapy/utils/display.py +++ b/scrapy/utils/display.py @@ -37,11 +37,12 @@ def _colorize(text, colorize=True): else: from pygments.formatters import TerminalFormatter from pygments.lexers import PythonLexer + return highlight(text, PythonLexer(), TerminalFormatter()) def pformat(obj, *args, **kwargs): - return _colorize(pformat_(obj), kwargs.pop('colorize', True)) + return _colorize(pformat_(obj), kwargs.pop("colorize", True)) def pprint(obj, *args, **kwargs): diff --git a/scrapy/utils/ftp.py b/scrapy/utils/ftp.py index 775b25ea8..9dbb4180f 100644 --- a/scrapy/utils/ftp.py +++ b/scrapy/utils/ftp.py @@ -18,8 +18,8 @@ def ftp_makedirs_cwd(ftp, path, first_call=True): def ftp_store_file( - *, path, file, host, port, - username, password, use_active_mode=False, overwrite=True): + *, path, file, host, port, username, password, use_active_mode=False, overwrite=True +): """Opens a FTP connection with passed credentials,sets current directory to the directory extracted from given path, then uploads the file to server """ @@ -31,6 +31,6 @@ def ftp_store_file( file.seek(0) dirname, filename = posixpath.split(path) ftp_makedirs_cwd(ftp, dirname) - command = 'STOR' if overwrite else 'APPE' - ftp.storbinary(f'{command} {filename}', file) + command = "STOR" if overwrite else "APPE" + ftp.storbinary(f"{command} {filename}", file) file.close() diff --git a/scrapy/utils/gz.py b/scrapy/utils/gz.py index 0810e1f1d..e5df34d2e 100644 --- a/scrapy/utils/gz.py +++ b/scrapy/utils/gz.py @@ -10,7 +10,7 @@ def gunzip(data): """ f = GzipFile(fileobj=BytesIO(data)) output_list = [] - chunk = b'.' + chunk = b"." while chunk: try: chunk = f.read1(8196) @@ -20,15 +20,15 @@ def gunzip(data): # see issue 87 about catching struct.error # some pages are quite small so output_list is empty and f.extrabuf # contains the whole page content - if output_list or getattr(f, 'extrabuf', None): + if output_list or getattr(f, "extrabuf", None): try: - output_list.append(f.extrabuf[-f.extrasize:]) + output_list.append(f.extrabuf[-f.extrasize :]) finally: break else: raise - return b''.join(output_list) + return b"".join(output_list) def gzip_magic_number(response): - return response.body[:3] == b'\x1f\x8b\x08' + return response.body[:3] == b"\x1f\x8b\x08" diff --git a/scrapy/utils/httpobj.py b/scrapy/utils/httpobj.py index a90f1d278..540035ca9 100644 --- a/scrapy/utils/httpobj.py +++ b/scrapy/utils/httpobj.py @@ -7,7 +7,9 @@ from weakref import WeakKeyDictionary from scrapy.http import Request, Response -_urlparse_cache: "WeakKeyDictionary[Union[Request, Response], ParseResult]" = WeakKeyDictionary() +_urlparse_cache: "WeakKeyDictionary[Union[Request, Response], ParseResult]" = ( + WeakKeyDictionary() +) def urlparse_cached(request_or_response: Union[Request, Response]) -> ParseResult: diff --git a/scrapy/utils/iterators.py b/scrapy/utils/iterators.py index da77ca46f..7d52d35c9 100644 --- a/scrapy/utils/iterators.py +++ b/scrapy/utils/iterators.py @@ -22,60 +22,62 @@ def xmliter(obj, nodename): """ nodename_patt = re.escape(nodename) - DOCUMENT_HEADER_RE = re.compile(r'<\?xml[^>]+>\s*', re.S) - HEADER_END_RE = re.compile(fr'<\s*/{nodename_patt}\s*>', re.S) - END_TAG_RE = re.compile(r'<\s*/([^\s>]+)\s*>', re.S) - NAMESPACE_RE = re.compile(r'((xmlns[:A-Za-z]*)=[^>\s]+)', re.S) + DOCUMENT_HEADER_RE = re.compile(r"<\?xml[^>]+>\s*", re.S) + HEADER_END_RE = re.compile(rf"<\s*/{nodename_patt}\s*>", re.S) + END_TAG_RE = re.compile(r"<\s*/([^\s>]+)\s*>", re.S) + NAMESPACE_RE = re.compile(r"((xmlns[:A-Za-z]*)=[^>\s]+)", re.S) text = _body_or_str(obj) document_header = re.search(DOCUMENT_HEADER_RE, text) - document_header = document_header.group().strip() if document_header else '' + document_header = document_header.group().strip() if document_header else "" header_end_idx = re_rsearch(HEADER_END_RE, text) - header_end = text[header_end_idx[1]:].strip() if header_end_idx else '' + header_end = text[header_end_idx[1] :].strip() if header_end_idx else "" namespaces = {} if header_end: for tagname in reversed(re.findall(END_TAG_RE, header_end)): - tag = re.search(fr'<\s*{tagname}.*?xmlns[:=][^>]*>', text[:header_end_idx[1]], re.S) + tag = re.search( + rf"<\s*{tagname}.*?xmlns[:=][^>]*>", text[: header_end_idx[1]], re.S + ) if tag: - namespaces.update(reversed(x) for x in re.findall(NAMESPACE_RE, tag.group())) + namespaces.update( + reversed(x) for x in re.findall(NAMESPACE_RE, tag.group()) + ) - r = re.compile(fr'<{nodename_patt}[\s>].*?', re.DOTALL) + r = re.compile(rf"<{nodename_patt}[\s>].*?", re.DOTALL) for match in r.finditer(text): nodetext = ( document_header + match.group().replace( - nodename, - f'{nodename} {" ".join(namespaces.values())}', - 1 + nodename, f'{nodename} {" ".join(namespaces.values())}', 1 ) + header_end ) - yield Selector(text=nodetext, type='xml') + yield Selector(text=nodetext, type="xml") -def xmliter_lxml(obj, nodename, namespace=None, prefix='x'): +def xmliter_lxml(obj, nodename, namespace=None, prefix="x"): from lxml import etree + reader = _StreamReader(obj) - tag = f'{{{namespace}}}{nodename}' if namespace else nodename + tag = f"{{{namespace}}}{nodename}" if namespace else nodename iterable = etree.iterparse(reader, tag=tag, encoding=reader.encoding) - selxpath = '//' + (f'{prefix}:{nodename}' if namespace else nodename) + selxpath = "//" + (f"{prefix}:{nodename}" if namespace else nodename) for _, node in iterable: - nodetext = etree.tostring(node, encoding='unicode') + nodetext = etree.tostring(node, encoding="unicode") node.clear() - xs = Selector(text=nodetext, type='xml') + xs = Selector(text=nodetext, type="xml") if namespace: xs.register_namespace(prefix, namespace) yield xs.xpath(selxpath)[0] class _StreamReader: - def __init__(self, obj): self._ptr = 0 if isinstance(obj, Response): self._text, self.encoding = obj.body, obj.encoding else: - self._text, self.encoding = obj, 'utf-8' + self._text, self.encoding = obj, "utf-8" self._is_unicode = isinstance(self._text, str) def read(self, n=65535): @@ -90,11 +92,11 @@ class _StreamReader: def _read_unicode(self, n=65535): s, e = self._ptr, self._ptr + n self._ptr = e - return self._text[s:e].encode('utf-8') + return self._text[s:e].encode("utf-8") def csviter(obj, delimiter=None, headers=None, encoding=None, quotechar=None): - """ Returns an iterator of dictionaries from the given csv object + """Returns an iterator of dictionaries from the given csv object obj can be: - a Response object @@ -109,7 +111,7 @@ def csviter(obj, delimiter=None, headers=None, encoding=None, quotechar=None): quotechar is the character used to enclosure fields on the given obj. """ - encoding = obj.encoding if isinstance(obj, TextResponse) else encoding or 'utf-8' + encoding = obj.encoding if isinstance(obj, TextResponse) else encoding or "utf-8" def row_to_unicode(row_): return [to_unicode(field, encoding) for field in row_] @@ -133,10 +135,15 @@ def csviter(obj, delimiter=None, headers=None, encoding=None, quotechar=None): for row in csv_r: row = row_to_unicode(row) if len(row) != len(headers): - logger.warning("ignoring row %(csvlnum)d (length: %(csvrow)d, " - "should be: %(csvheader)d)", - {'csvlnum': csv_r.line_num, 'csvrow': len(row), - 'csvheader': len(headers)}) + logger.warning( + "ignoring row %(csvlnum)d (length: %(csvrow)d, " + "should be: %(csvheader)d)", + { + "csvlnum": csv_r.line_num, + "csvrow": len(row), + "csvheader": len(headers), + }, + ) continue yield dict(zip(headers, row)) @@ -153,7 +160,7 @@ def _body_or_str(obj, unicode=True): return obj.body if isinstance(obj, TextResponse): return obj.text - return obj.body.decode('utf-8') + return obj.body.decode("utf-8") if isinstance(obj, str): - return obj if unicode else obj.encode('utf-8') - return obj.decode('utf-8') if unicode else obj + return obj if unicode else obj.encode("utf-8") + return obj.decode("utf-8") if unicode else obj diff --git a/scrapy/utils/job.py b/scrapy/utils/job.py index a65f92e95..858affc03 100644 --- a/scrapy/utils/job.py +++ b/scrapy/utils/job.py @@ -5,7 +5,7 @@ from scrapy.settings import BaseSettings def job_dir(settings: BaseSettings) -> Optional[str]: - path = settings['JOBDIR'] + path = settings["JOBDIR"] if path and not Path(path).exists(): Path(path).mkdir(parents=True) return path diff --git a/scrapy/utils/log.py b/scrapy/utils/log.py index 78e302d19..fea4deb4b 100644 --- a/scrapy/utils/log.py +++ b/scrapy/utils/log.py @@ -37,25 +37,25 @@ class TopLevelFormatter(logging.Filter): self.loggers = loggers or [] def filter(self, record): - if any(record.name.startswith(logger + '.') for logger in self.loggers): - record.name = record.name.split('.', 1)[0] + if any(record.name.startswith(logger + ".") for logger in self.loggers): + record.name = record.name.split(".", 1)[0] return True DEFAULT_LOGGING = { - 'version': 1, - 'disable_existing_loggers': False, - 'loggers': { - 'hpack': { - 'level': 'ERROR', + "version": 1, + "disable_existing_loggers": False, + "loggers": { + "hpack": { + "level": "ERROR", }, - 'scrapy': { - 'level': 'DEBUG', + "scrapy": { + "level": "DEBUG", }, - 'twisted': { - 'level': 'ERROR', + "twisted": { + "level": "ERROR", }, - } + }, } @@ -87,7 +87,7 @@ def configure_logging(settings=None, install_root_handler=True): # Route warnings through python logging logging.captureWarnings(True) - observer = twisted_log.PythonLoggingObserver('twisted') + observer = twisted_log.PythonLoggingObserver("twisted") observer.start() dictConfig(DEFAULT_LOGGING) @@ -95,8 +95,8 @@ def configure_logging(settings=None, install_root_handler=True): if isinstance(settings, dict) or settings is None: settings = Settings(settings) - if settings.getbool('LOG_STDOUT'): - sys.stdout = StreamLogger(logging.getLogger('stdout')) + if settings.getbool("LOG_STDOUT"): + sys.stdout = StreamLogger(logging.getLogger("stdout")) if install_root_handler: install_scrapy_root_handler(settings) @@ -105,8 +105,10 @@ def configure_logging(settings=None, install_root_handler=True): def install_scrapy_root_handler(settings): global _scrapy_root_handler - if (_scrapy_root_handler is not None - and _scrapy_root_handler in logging.root.handlers): + if ( + _scrapy_root_handler is not None + and _scrapy_root_handler in logging.root.handlers + ): logging.root.removeHandler(_scrapy_root_handler) logging.root.setLevel(logging.NOTSET) _scrapy_root_handler = _get_handler(settings) @@ -121,43 +123,46 @@ _scrapy_root_handler = None def _get_handler(settings): - """ Return a log handler object according to settings """ - filename = settings.get('LOG_FILE') + """Return a log handler object according to settings""" + filename = settings.get("LOG_FILE") if filename: - mode = 'a' if settings.getbool('LOG_FILE_APPEND') else 'w' - encoding = settings.get('LOG_ENCODING') + mode = "a" if settings.getbool("LOG_FILE_APPEND") else "w" + encoding = settings.get("LOG_ENCODING") handler = logging.FileHandler(filename, mode=mode, encoding=encoding) - elif settings.getbool('LOG_ENABLED'): + elif settings.getbool("LOG_ENABLED"): handler = logging.StreamHandler() else: handler = logging.NullHandler() formatter = logging.Formatter( - fmt=settings.get('LOG_FORMAT'), - datefmt=settings.get('LOG_DATEFORMAT') + fmt=settings.get("LOG_FORMAT"), datefmt=settings.get("LOG_DATEFORMAT") ) handler.setFormatter(formatter) - handler.setLevel(settings.get('LOG_LEVEL')) - if settings.getbool('LOG_SHORT_NAMES'): - handler.addFilter(TopLevelFormatter(['scrapy'])) + handler.setLevel(settings.get("LOG_LEVEL")) + if settings.getbool("LOG_SHORT_NAMES"): + handler.addFilter(TopLevelFormatter(["scrapy"])) return handler def log_scrapy_info(settings: Settings) -> None: - logger.info("Scrapy %(version)s started (bot: %(bot)s)", - {'version': scrapy.__version__, 'bot': settings['BOT_NAME']}) + logger.info( + "Scrapy %(version)s started (bot: %(bot)s)", + {"version": scrapy.__version__, "bot": settings["BOT_NAME"]}, + ) versions = [ f"{name} {version}" for name, version in scrapy_components_versions() if name != "Scrapy" ] - logger.info("Versions: %(versions)s", {'versions': ", ".join(versions)}) + logger.info("Versions: %(versions)s", {"versions": ", ".join(versions)}) def log_reactor_info() -> None: from twisted.internet import reactor + logger.debug("Using reactor: %s.%s", reactor.__module__, reactor.__class__.__name__) from twisted.internet import asyncioreactor + if isinstance(reactor, asyncioreactor.AsyncioSelectorReactor): logger.debug( "Using asyncio event loop: %s.%s", @@ -172,10 +177,11 @@ class StreamLogger: Taken from: https://www.electricmonk.nl/log/2011/08/14/redirect-stdout-and-stderr-to-a-logger-in-python/ """ + def __init__(self, logger, log_level=logging.INFO): self.logger = logger self.log_level = log_level - self.linebuf = '' + self.linebuf = "" def write(self, buf): for line in buf.rstrip().splitlines(): @@ -194,7 +200,7 @@ class LogCounterHandler(logging.Handler): self.crawler = crawler def emit(self, record): - sname = f'log_count/{record.levelname}' + sname = f"log_count/{record.levelname}" self.crawler.stats.inc_value(sname) @@ -204,19 +210,20 @@ def logformatter_adapter(logkws): and adapts it into a tuple of positional arguments for logger.log calls, handling backward compatibility as well. """ - if not {'level', 'msg', 'args'} <= set(logkws): - warnings.warn('Missing keys in LogFormatter method', - ScrapyDeprecationWarning) + if not {"level", "msg", "args"} <= set(logkws): + warnings.warn("Missing keys in LogFormatter method", ScrapyDeprecationWarning) - if 'format' in logkws: - warnings.warn('`format` key in LogFormatter methods has been ' - 'deprecated, use `msg` instead', - ScrapyDeprecationWarning) + if "format" in logkws: + warnings.warn( + "`format` key in LogFormatter methods has been " + "deprecated, use `msg` instead", + ScrapyDeprecationWarning, + ) - level = logkws.get('level', logging.INFO) - message = logkws.get('format', logkws.get('msg')) + level = logkws.get("level", logging.INFO) + message = logkws.get("format", logkws.get("msg")) # NOTE: This also handles 'args' being an empty dict, that case doesn't # play well in logger.log calls - args = logkws if not logkws.get('args') else logkws['args'] + args = logkws if not logkws.get("args") else logkws["args"] return (level, message, args) diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index 1e0342ace..dfd2f767c 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -30,7 +30,7 @@ def arg_to_iter(arg): """ if arg is None: return [] - if not isinstance(arg, _ITERABLE_SINGLE_VALUES) and hasattr(arg, '__iter__'): + if not isinstance(arg, _ITERABLE_SINGLE_VALUES) and hasattr(arg, "__iter__"): return arg return [arg] @@ -48,15 +48,16 @@ def load_object(path): if not isinstance(path, str): if callable(path): return path - raise TypeError("Unexpected argument type, expected string " - f"or object, got: {type(path)}") + raise TypeError( + "Unexpected argument type, expected string " f"or object, got: {type(path)}" + ) try: - dot = path.rindex('.') + dot = path.rindex(".") except ValueError: raise ValueError(f"Error loading object '{path}': not a full path") - module, name = path[:dot], path[dot + 1:] + module, name = path[:dot], path[dot + 1 :] mod = import_module(module) try: @@ -78,9 +79,9 @@ def walk_modules(path): mods = [] mod = import_module(path) mods.append(mod) - if hasattr(mod, '__path__'): + if hasattr(mod, "__path__"): for _, subpath, ispkg in iter_modules(mod.__path__): - fullpath = path + '.' + subpath + fullpath = path + "." + subpath if ispkg: mods += walk_modules(fullpath) else: @@ -89,7 +90,7 @@ def walk_modules(path): return mods -def extract_regex(regex, text, encoding='utf-8'): +def extract_regex(regex, text, encoding="utf-8"): """Extract a list of unicode strings from the given text/encoding using the following policies: * if the regex contains a named group called "extract" that will be returned @@ -99,22 +100,23 @@ def extract_regex(regex, text, encoding='utf-8'): warnings.warn( "scrapy.utils.misc.extract_regex has moved to parsel.utils.extract_regex.", ScrapyDeprecationWarning, - stacklevel=2 + stacklevel=2, ) if isinstance(regex, str): regex = re.compile(regex, re.UNICODE) try: - strings = [regex.search(text).group('extract')] # named group + strings = [regex.search(text).group("extract")] # named group except Exception: - strings = regex.findall(text) # full regex or numbered groups + strings = regex.findall(text) # full regex or numbered groups strings = flatten(strings) if isinstance(text, str): - return [replace_entities(s, keep=['lt', 'amp']) for s in strings] - return [replace_entities(to_unicode(s, encoding), keep=['lt', 'amp']) - for s in strings] + return [replace_entities(s, keep=["lt", "amp"]) for s in strings] + return [ + replace_entities(to_unicode(s, encoding), keep=["lt", "amp"]) for s in strings + ] def md5sum(file): @@ -136,7 +138,7 @@ def md5sum(file): def rel_has_nofollow(rel): """Return True if link rel attribute has nofollow type""" - return rel is not None and 'nofollow' in rel.replace(',', ' ').split() + return rel is not None and "nofollow" in rel.replace(",", " ").split() def create_instance(objcls, settings, crawler, *args, **kwargs): @@ -160,15 +162,15 @@ def create_instance(objcls, settings, crawler, *args, **kwargs): if crawler is None: raise ValueError("Specify at least one of settings and crawler.") settings = crawler.settings - if crawler and hasattr(objcls, 'from_crawler'): + if crawler and hasattr(objcls, "from_crawler"): instance = objcls.from_crawler(crawler, *args, **kwargs) - method_name = 'from_crawler' - elif hasattr(objcls, 'from_settings'): + method_name = "from_crawler" + elif hasattr(objcls, "from_settings"): instance = objcls.from_settings(settings, *args, **kwargs) - method_name = 'from_settings' + method_name = "from_settings" else: instance = objcls(*args, **kwargs) - method_name = '__new__' + method_name = "__new__" if instance is None: raise TypeError(f"{objcls.__qualname__}.{method_name} returned None") return instance @@ -221,7 +223,9 @@ def is_generator_with_return_value(callable): def returns_none(return_node): value = return_node.value - return value is None or isinstance(value, ast.NameConstant) and value.value is None + return ( + value is None or isinstance(value, ast.NameConstant) and value.value is None + ) if inspect.isgeneratorfunction(callable): func = callable @@ -256,8 +260,8 @@ def warn_on_generator_with_return_value(spider, callable): warnings.warn( f'The "{spider.__class__.__name__}.{callable.__name__}" method is ' 'a generator and includes a "return" statement with a value ' - 'different than None. This could lead to unexpected behaviour. Please see ' - 'https://docs.python.org/3/reference/simple_stmts.html#the-return-statement ' + "different than None. This could lead to unexpected behaviour. Please see " + "https://docs.python.org/3/reference/simple_stmts.html#the-return-statement " 'for details about the semantics of the "return" statement within generators', stacklevel=2, ) @@ -265,9 +269,9 @@ def warn_on_generator_with_return_value(spider, callable): callable_name = spider.__class__.__name__ + "." + callable.__name__ warnings.warn( f'Unable to determine whether or not "{callable_name}" is a generator with a return value. ' - 'This will not prevent your code from working, but it prevents Scrapy from detecting ' + "This will not prevent your code from working, but it prevents Scrapy from detecting " f'potential issues in your implementation of "{callable_name}". Please, report this in the ' - 'Scrapy issue tracker (https://github.com/scrapy/scrapy/issues), ' + "Scrapy issue tracker (https://github.com/scrapy/scrapy/issues), " f'including the code of "{callable_name}"', stacklevel=2, ) diff --git a/scrapy/utils/ossignal.py b/scrapy/utils/ossignal.py index cf867f3f8..18d856927 100644 --- a/scrapy/utils/ossignal.py +++ b/scrapy/utils/ossignal.py @@ -3,7 +3,7 @@ import signal signal_names = {} for signame in dir(signal): - if signame.startswith('SIG') and not signame.startswith('SIG_'): + if signame.startswith("SIG") and not signame.startswith("SIG_"): signum = getattr(signal, signame) if isinstance(signum, int): signal_names[signum] = signame @@ -16,10 +16,11 @@ def install_shutdown_handlers(function, override_sigint=True): (e.g. Pdb) """ from twisted.internet import reactor + reactor._handleSignals() signal.signal(signal.SIGTERM, function) if signal.getsignal(signal.SIGINT) == signal.default_int_handler or override_sigint: signal.signal(signal.SIGINT, function) # Catch Ctrl-Break in windows - if hasattr(signal, 'SIGBREAK'): + if hasattr(signal, "SIGBREAK"): signal.signal(signal.SIGBREAK, function) diff --git a/scrapy/utils/project.py b/scrapy/utils/project.py index d21a144ad..4fbb6bcaf 100644 --- a/scrapy/utils/project.py +++ b/scrapy/utils/project.py @@ -9,23 +9,25 @@ from scrapy.settings import Settings from scrapy.exceptions import NotConfigured -ENVVAR = 'SCRAPY_SETTINGS_MODULE' -DATADIR_CFG_SECTION = 'datadir' +ENVVAR = "SCRAPY_SETTINGS_MODULE" +DATADIR_CFG_SECTION = "datadir" def inside_project(): - scrapy_module = os.environ.get('SCRAPY_SETTINGS_MODULE') + scrapy_module = os.environ.get("SCRAPY_SETTINGS_MODULE") if scrapy_module is not None: try: import_module(scrapy_module) except ImportError as exc: - warnings.warn(f"Cannot import scrapy settings module {scrapy_module}: {exc}") + warnings.warn( + f"Cannot import scrapy settings module {scrapy_module}: {exc}" + ) else: return True return bool(closest_scrapy_cfg()) -def project_data_dir(project='default') -> str: +def project_data_dir(project="default") -> str: """Return the current project data dir, creating it if it doesn't exist""" if not inside_project(): raise NotConfigured("Not inside a project") @@ -35,8 +37,10 @@ def project_data_dir(project='default') -> str: else: scrapy_cfg = closest_scrapy_cfg() if not scrapy_cfg: - raise NotConfigured("Unable to find scrapy.cfg file to infer project data dir") - d = (Path(scrapy_cfg).parent / '.scrapy').resolve() + raise NotConfigured( + "Unable to find scrapy.cfg file to infer project data dir" + ) + d = (Path(scrapy_cfg).parent / ".scrapy").resolve() if not d.exists(): d.mkdir(parents=True) return str(d) @@ -52,7 +56,7 @@ def data_path(path: str, createdir=False) -> str: if inside_project(): path_obj = Path(project_data_dir(), path) else: - path_obj = Path('.scrapy', path) + path_obj = Path(".scrapy", path) if createdir and not path_obj.exists(): path_obj.mkdir(parents=True) return str(path_obj) @@ -60,24 +64,27 @@ def data_path(path: str, createdir=False) -> str: def get_project_settings(): if ENVVAR not in os.environ: - project = os.environ.get('SCRAPY_PROJECT', 'default') + project = os.environ.get("SCRAPY_PROJECT", "default") init_env(project) settings = Settings() settings_module_path = os.environ.get(ENVVAR) if settings_module_path: - settings.setmodule(settings_module_path, priority='project') + settings.setmodule(settings_module_path, priority="project") valid_envvars = { - 'CHECK', - 'PROJECT', - 'PYTHON_SHELL', - 'SETTINGS_MODULE', + "CHECK", + "PROJECT", + "PYTHON_SHELL", + "SETTINGS_MODULE", } - scrapy_envvars = {k[7:]: v for k, v in os.environ.items() if - k.startswith('SCRAPY_') and k.replace('SCRAPY_', '') in valid_envvars} + scrapy_envvars = { + k[7:]: v + for k, v in os.environ.items() + if k.startswith("SCRAPY_") and k.replace("SCRAPY_", "") in valid_envvars + } - settings.setdict(scrapy_envvars, priority='project') + settings.setdict(scrapy_envvars, priority="project") return settings diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 9df1c91de..1771e5550 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -82,29 +82,32 @@ def unique(list_, key=lambda x: x): return result -def to_unicode(text, encoding=None, errors='strict'): +def to_unicode(text, encoding=None, errors="strict"): """Return the unicode representation of a bytes object ``text``. If ``text`` is already an unicode object, return it as-is.""" if isinstance(text, str): return text if not isinstance(text, (bytes, str)): - raise TypeError('to_unicode must receive a bytes or str ' - f'object, got {type(text).__name__}') + raise TypeError( + "to_unicode must receive a bytes or str " + f"object, got {type(text).__name__}" + ) if encoding is None: - encoding = 'utf-8' + encoding = "utf-8" return text.decode(encoding, errors) -def to_bytes(text, encoding=None, errors='strict'): +def to_bytes(text, encoding=None, errors="strict"): """Return the binary representation of ``text``. If ``text`` is already a bytes object, return it as-is.""" if isinstance(text, bytes): return text if not isinstance(text, str): - raise TypeError('to_bytes must receive a str or bytes ' - f'object, got {type(text).__name__}') + raise TypeError( + "to_bytes must receive a str or bytes " f"object, got {type(text).__name__}" + ) if encoding is None: - encoding = 'utf-8' + encoding = "utf-8" return text.encode(encoding, errors) @@ -125,7 +128,7 @@ def re_rsearch(pattern, text, chunk_size=1024): def _chunk_iter(): offset = len(text) while True: - offset -= (chunk_size * 1024) + offset -= chunk_size * 1024 if offset <= 0: break yield (text[offset:], offset) @@ -162,7 +165,7 @@ _BINARYCHARS |= {ord(ch) for ch in _BINARYCHARS} def binary_is_text(data): - """ Returns ``True`` if the given ``data`` argument (a ``bytes`` object) + """Returns ``True`` if the given ``data`` argument (a ``bytes`` object) does not contain unprintable control characters. """ if not isinstance(data, bytes): @@ -182,16 +185,19 @@ def get_func_args(func, stripself=False): elif inspect.ismethoddescriptor(func): return [] elif isinstance(func, partial): - return [x for x in get_func_args(func.func)[len(func.args):] - if not (func.keywords and x in func.keywords)] - elif hasattr(func, '__call__'): + return [ + x + for x in get_func_args(func.func)[len(func.args) :] + if not (func.keywords and x in func.keywords) + ] + elif hasattr(func, "__call__"): if inspect.isroutine(func): return [] - if getattr(func, '__name__', None) == '__call__': + if getattr(func, "__name__", None) == "__call__": return [] return get_func_args(func.__call__, True) else: - raise TypeError(f'{type(func)} is not callable') + raise TypeError(f"{type(func)} is not callable") if stripself: func_args.pop(0) return func_args @@ -221,10 +227,10 @@ def get_spec(func): if inspect.isfunction(func) or inspect.ismethod(func): spec = inspect.getfullargspec(func) - elif hasattr(func, '__call__'): + elif hasattr(func, "__call__"): spec = inspect.getfullargspec(func.__call__) else: - raise TypeError(f'{type(func)} is not callable') + raise TypeError(f"{type(func)} is not callable") defaults = spec.defaults or [] @@ -276,11 +282,14 @@ def global_object_name(obj): if hasattr(sys, "pypy_version_info"): + def garbage_collect(): # Collecting weakreferences can take two collections on PyPy. gc.collect() gc.collect() + else: + def garbage_collect(): gc.collect() diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index ddf354d88..46d83059f 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -10,11 +10,12 @@ from scrapy.utils.misc import load_object def listen_tcp(portrange, host, factory): """Like reactor.listenTCP but tries different ports in a range.""" from twisted.internet import reactor + if len(portrange) > 2: raise ValueError(f"invalid portrange: {portrange}") if not portrange: return reactor.listenTCP(0, factory, interface=host) - if not hasattr(portrange, '__iter__'): + if not hasattr(portrange, "__iter__"): return reactor.listenTCP(portrange, factory, interface=host) if len(portrange) == 1: return reactor.listenTCP(portrange[0], factory, interface=host) @@ -39,6 +40,7 @@ class CallLaterOnce: def schedule(self, delay=0): from twisted.internet import reactor + if self._call is None: self._call = reactor.callLater(delay, self) @@ -93,16 +95,20 @@ def verify_installed_reactor(reactor_path): :mod:`~twisted.internet.reactor` does not match the specified import path.""" from twisted.internet import reactor + reactor_class = load_object(reactor_path) if not reactor.__class__ == reactor_class: - msg = ("The installed reactor " - f"({reactor.__module__}.{reactor.__class__.__name__}) does not " - f"match the requested one ({reactor_path})") + msg = ( + "The installed reactor " + f"({reactor.__module__}.{reactor.__class__.__name__}) does not " + f"match the requested one ({reactor_path})" + ) raise Exception(msg) def verify_installed_asyncio_event_loop(loop_path): from twisted.internet import reactor + loop_class = load_object(loop_path) if isinstance(reactor._asyncioEventloop, loop_class): return @@ -121,4 +127,5 @@ def verify_installed_asyncio_event_loop(loop_path): def is_asyncio_reactor_installed(): from twisted.internet import reactor + return isinstance(reactor, asyncioreactor.AsyncioSelectorReactor) diff --git a/scrapy/utils/reqser.py b/scrapy/utils/reqser.py index c254b9f82..c818c8700 100644 --- a/scrapy/utils/reqser.py +++ b/scrapy/utils/reqser.py @@ -7,16 +7,22 @@ from scrapy.utils.request import request_from_dict as _from_dict warnings.warn( - ("Module scrapy.utils.reqser is deprecated, please use request.to_dict method" - " and/or scrapy.utils.request.request_from_dict instead"), + ( + "Module scrapy.utils.reqser is deprecated, please use request.to_dict method" + " and/or scrapy.utils.request.request_from_dict instead" + ), category=ScrapyDeprecationWarning, stacklevel=2, ) -def request_to_dict(request: "scrapy.Request", spider: Optional["scrapy.Spider"] = None) -> dict: +def request_to_dict( + request: "scrapy.Request", spider: Optional["scrapy.Spider"] = None +) -> dict: return request.to_dict(spider=spider) -def request_from_dict(d: dict, spider: Optional["scrapy.Spider"] = None) -> "scrapy.Request": +def request_from_dict( + d: dict, spider: Optional["scrapy.Spider"] = None +) -> "scrapy.Request": return _from_dict(d, spider=spider) diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index d1df8d335..3e29a9c57 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -69,54 +69,54 @@ def request_fingerprint( """ if include_headers or keep_fragments: message = ( - 'Call to deprecated function ' - 'scrapy.utils.request.request_fingerprint().\n' - '\n' - 'If you are using this function in a Scrapy component because you ' - 'need a non-default fingerprinting algorithm, and you are OK ' - 'with that non-default fingerprinting algorithm being used by ' - 'all Scrapy components and not just the one calling this ' - 'function, use crawler.request_fingerprinter.fingerprint() ' - 'instead in your Scrapy component (you can get the crawler ' - 'object from the \'from_crawler\' class method), and use the ' - '\'REQUEST_FINGERPRINTER_CLASS\' setting to configure your ' - 'non-default fingerprinting algorithm.\n' - '\n' - 'Otherwise, consider using the ' - 'scrapy.utils.request.fingerprint() function instead.\n' - '\n' - 'If you switch to \'fingerprint()\', or assign the ' - '\'REQUEST_FINGERPRINTER_CLASS\' setting a class that uses ' - '\'fingerprint()\', the generated fingerprints will not only be ' - 'bytes instead of a string, but they will also be different from ' - 'those generated by \'request_fingerprint()\'. Before you switch, ' - 'make sure that you understand the consequences of this (e.g. ' - 'cache invalidation) and are OK with them; otherwise, consider ' - 'implementing your own function which returns the same ' - 'fingerprints as the deprecated \'request_fingerprint()\' function.' + "Call to deprecated function " + "scrapy.utils.request.request_fingerprint().\n" + "\n" + "If you are using this function in a Scrapy component because you " + "need a non-default fingerprinting algorithm, and you are OK " + "with that non-default fingerprinting algorithm being used by " + "all Scrapy components and not just the one calling this " + "function, use crawler.request_fingerprinter.fingerprint() " + "instead in your Scrapy component (you can get the crawler " + "object from the 'from_crawler' class method), and use the " + "'REQUEST_FINGERPRINTER_CLASS' setting to configure your " + "non-default fingerprinting algorithm.\n" + "\n" + "Otherwise, consider using the " + "scrapy.utils.request.fingerprint() function instead.\n" + "\n" + "If you switch to 'fingerprint()', or assign the " + "'REQUEST_FINGERPRINTER_CLASS' setting a class that uses " + "'fingerprint()', the generated fingerprints will not only be " + "bytes instead of a string, but they will also be different from " + "those generated by 'request_fingerprint()'. Before you switch, " + "make sure that you understand the consequences of this (e.g. " + "cache invalidation) and are OK with them; otherwise, consider " + "implementing your own function which returns the same " + "fingerprints as the deprecated 'request_fingerprint()' function." ) else: message = ( - 'Call to deprecated function ' - 'scrapy.utils.request.request_fingerprint().\n' - '\n' - 'If you are using this function in a Scrapy component, and you ' - 'are OK with users of your component changing the fingerprinting ' - 'algorithm through settings, use ' - 'crawler.request_fingerprinter.fingerprint() instead in your ' - 'Scrapy component (you can get the crawler object from the ' - '\'from_crawler\' class method).\n' - '\n' - 'Otherwise, consider using the ' - 'scrapy.utils.request.fingerprint() function instead.\n' - '\n' - 'Either way, the resulting fingerprints will be returned as ' - 'bytes, not as a string, and they will also be different from ' - 'those generated by \'request_fingerprint()\'. Before you switch, ' - 'make sure that you understand the consequences of this (e.g. ' - 'cache invalidation) and are OK with them; otherwise, consider ' - 'implementing your own function which returns the same ' - 'fingerprints as the deprecated \'request_fingerprint()\' function.' + "Call to deprecated function " + "scrapy.utils.request.request_fingerprint().\n" + "\n" + "If you are using this function in a Scrapy component, and you " + "are OK with users of your component changing the fingerprinting " + "algorithm through settings, use " + "crawler.request_fingerprinter.fingerprint() instead in your " + "Scrapy component (you can get the crawler object from the " + "'from_crawler' class method).\n" + "\n" + "Otherwise, consider using the " + "scrapy.utils.request.fingerprint() function instead.\n" + "\n" + "Either way, the resulting fingerprints will be returned as " + "bytes, not as a string, and they will also be different from " + "those generated by 'request_fingerprint()'. Before you switch, " + "make sure that you understand the consequences of this (e.g. " + "cache invalidation) and are OK with them; otherwise, consider " + "implementing your own function which returns the same " + "fingerprints as the deprecated 'request_fingerprint()' function." ) warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) processed_include_headers: Optional[Tuple[bytes, ...]] = None @@ -129,8 +129,10 @@ def request_fingerprint( if cache_key not in cache: fp = hashlib.sha1() fp.update(to_bytes(request.method)) - fp.update(to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments))) - fp.update(request.body or b'') + fp.update( + to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments)) + ) + fp.update(request.body or b"") if processed_include_headers: for part in _serialize_headers(processed_include_headers, request): fp.update(part) @@ -203,10 +205,10 @@ def fingerprint( for header_value in request.headers.getlist(header) ] fingerprint_data = { - 'method': to_unicode(request.method), - 'url': canonicalize_url(request.url, keep_fragments=keep_fragments), - 'body': (request.body or b'').hex(), - 'headers': headers, + "method": to_unicode(request.method), + "url": canonicalize_url(request.url, keep_fragments=keep_fragments), + "body": (request.body or b"").hex(), + "headers": headers, } fingerprint_json = json.dumps(fingerprint_data, sort_keys=True) cache[cache_key] = hashlib.sha1(fingerprint_json.encode()).digest() @@ -233,35 +235,35 @@ class RequestFingerprinter: def __init__(self, crawler=None): if crawler: implementation = crawler.settings.get( - 'REQUEST_FINGERPRINTER_IMPLEMENTATION' + "REQUEST_FINGERPRINTER_IMPLEMENTATION" ) else: - implementation = '2.6' - if implementation == '2.6': + implementation = "2.6" + if implementation == "2.6": message = ( - '\'2.6\' is a deprecated value for the ' - '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting.\n' - '\n' - 'It is also the default value. In other words, it is normal ' - 'to get this warning if you have not defined a value for the ' - '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting. This is so ' - 'for backward compatibility reasons, but it will change in a ' - 'future version of Scrapy.\n' - '\n' - 'See the documentation of the ' - '\'REQUEST_FINGERPRINTER_IMPLEMENTATION\' setting for ' - 'information on how to handle this deprecation.' + "'2.6' is a deprecated value for the " + "'REQUEST_FINGERPRINTER_IMPLEMENTATION' setting.\n" + "\n" + "It is also the default value. In other words, it is normal " + "to get this warning if you have not defined a value for the " + "'REQUEST_FINGERPRINTER_IMPLEMENTATION' setting. This is so " + "for backward compatibility reasons, but it will change in a " + "future version of Scrapy.\n" + "\n" + "See the documentation of the " + "'REQUEST_FINGERPRINTER_IMPLEMENTATION' setting for " + "information on how to handle this deprecation." ) warnings.warn(message, category=ScrapyDeprecationWarning, stacklevel=2) self._fingerprint = _request_fingerprint_as_bytes - elif implementation == '2.7': + elif implementation == "2.7": self._fingerprint = fingerprint else: raise ValueError( - f'Got an invalid value on setting ' - f'\'REQUEST_FINGERPRINTER_IMPLEMENTATION\': ' - f'{implementation!r}. Valid values are \'2.6\' (deprecated) ' - f'and \'2.7\'.' + f"Got an invalid value on setting " + f"'REQUEST_FINGERPRINTER_IMPLEMENTATION': " + f"{implementation!r}. Valid values are '2.6' (deprecated) " + f"and '2.7'." ) def fingerprint(self, request: Request): @@ -276,7 +278,7 @@ def request_authenticate( """Authenticate the given request (in place) using the HTTP basic access authentication mechanism (RFC 2617) and the given username and password """ - request.headers['Authorization'] = basic_auth_header(username, password) + request.headers["Authorization"] = basic_auth_header(username, password) def request_httprepr(request: Request) -> bytes: @@ -286,9 +288,9 @@ def request_httprepr(request: Request) -> bytes: by Twisted). """ parsed = urlparse_cached(request) - path = urlunparse(('', '', parsed.path or '/', parsed.params, parsed.query, '')) + path = urlunparse(("", "", parsed.path or "/", parsed.params, parsed.query, "")) s = to_bytes(request.method) + b" " + to_bytes(path) + b" HTTP/1.1\r\n" - s += b"Host: " + to_bytes(parsed.hostname or b'') + b"\r\n" + s += b"Host: " + to_bytes(parsed.hostname or b"") + b"\r\n" if request.headers: s += request.headers.to_string() + b"\r\n" s += b"\r\n" @@ -297,11 +299,11 @@ def request_httprepr(request: Request) -> bytes: def referer_str(request: Request) -> Optional[str]: - """ Return Referer HTTP header suitable for logging. """ - referrer = request.headers.get('Referer') + """Return Referer HTTP header suitable for logging.""" + referrer = request.headers.get("Referer") if referrer is None: return referrer - return to_unicode(referrer, errors='replace') + return to_unicode(referrer, errors="replace") def request_from_dict(d: dict, *, spider: Optional[Spider] = None) -> Request: diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index 23bd2da65..3693177e4 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -25,31 +25,35 @@ def get_base_url(response: "scrapy.http.response.text.TextResponse") -> str: """Return the base url of the given response, joined with the response url""" if response not in _baseurl_cache: text = response.text[0:4096] - _baseurl_cache[response] = html.get_base_url(text, response.url, response.encoding) + _baseurl_cache[response] = html.get_base_url( + text, response.url, response.encoding + ) return _baseurl_cache[response] -_metaref_cache: "WeakKeyDictionary[Response, Union[Tuple[None, None], Tuple[float, str]]]" = WeakKeyDictionary() +_metaref_cache: "WeakKeyDictionary[Response, Union[Tuple[None, None], Tuple[float, str]]]" = ( + WeakKeyDictionary() +) def get_meta_refresh( response: "scrapy.http.response.text.TextResponse", - ignore_tags: Optional[Iterable[str]] = ('script', 'noscript'), + ignore_tags: Optional[Iterable[str]] = ("script", "noscript"), ) -> Union[Tuple[None, None], Tuple[float, str]]: """Parse the http-equiv refrsh parameter from the given response""" if response not in _metaref_cache: text = response.text[0:4096] _metaref_cache[response] = html.get_meta_refresh( - text, response.url, response.encoding, ignore_tags=ignore_tags) + text, response.url, response.encoding, ignore_tags=ignore_tags + ) return _metaref_cache[response] def response_status_message(status: Union[bytes, float, int, str]) -> str: - """Return status code plus status text descriptive message - """ + """Return status code plus status text descriptive message""" status_int = int(status) message = http.RESPONSES.get(status_int, "Unknown Status") - return f'{status_int} {to_unicode(message)}' + return f"{status_int} {to_unicode(message)}" @deprecated @@ -62,7 +66,7 @@ def response_httprepr(response: Response) -> bytes: b"HTTP/1.1 ", to_bytes(str(response.status)), b" ", - to_bytes(http.RESPONSES.get(response.status, b'')), + to_bytes(http.RESPONSES.get(response.status, b"")), b"\r\n", ] if response.headers: @@ -72,26 +76,29 @@ def response_httprepr(response: Response) -> bytes: def open_in_browser( - response: Union["scrapy.http.response.html.HtmlResponse", "scrapy.http.response.text.TextResponse"], + response: Union[ + "scrapy.http.response.html.HtmlResponse", + "scrapy.http.response.text.TextResponse", + ], _openfunc: Callable[[str], Any] = webbrowser.open, ) -> Any: """Open the given response in a local web browser, populating the tag for external links to work """ from scrapy.http import HtmlResponse, TextResponse + # XXX: this implementation is a bit dirty and could be improved body = response.body if isinstance(response, HtmlResponse): - if b'' + if b"' body = re.sub(b"", b"", body, flags=re.DOTALL) body = re.sub(rb"(|\s.*?>))", to_bytes(repl), body) - ext = '.html' + ext = ".html" elif isinstance(response, TextResponse): - ext = '.txt' + ext = ".txt" else: - raise TypeError("Unsupported response type: " - f"{response.__class__.__name__}") + raise TypeError("Unsupported response type: " f"{response.__class__.__name__}") fd, fname = tempfile.mkstemp(ext) os.write(fd, body) os.close(fd) diff --git a/scrapy/utils/signal.py b/scrapy/utils/signal.py index fbafc9d45..b7c284174 100644 --- a/scrapy/utils/signal.py +++ b/scrapy/utils/signal.py @@ -5,7 +5,13 @@ import logging from twisted.internet.defer import DeferredList, Deferred from twisted.python.failure import Failure -from pydispatch.dispatcher import Anonymous, Any, disconnect, getAllReceivers, liveReceivers +from pydispatch.dispatcher import ( + Anonymous, + Any, + disconnect, + getAllReceivers, + liveReceivers, +) from pydispatch.robustapply import robustApply from scrapy.exceptions import StopDownload @@ -20,24 +26,36 @@ def send_catch_log(signal=Any, sender=Anonymous, *arguments, **named): """Like pydispatcher.robust.sendRobust but it also logs errors and returns Failures instead of exceptions. """ - dont_log = named.pop('dont_log', ()) - dont_log = tuple(dont_log) if isinstance(dont_log, collections.abc.Sequence) else (dont_log,) - dont_log += (StopDownload, ) - spider = named.get('spider', None) + dont_log = named.pop("dont_log", ()) + dont_log = ( + tuple(dont_log) + if isinstance(dont_log, collections.abc.Sequence) + else (dont_log,) + ) + dont_log += (StopDownload,) + spider = named.get("spider", None) responses = [] for receiver in liveReceivers(getAllReceivers(sender, signal)): try: - response = robustApply(receiver, signal=signal, sender=sender, *arguments, **named) + response = robustApply( + receiver, signal=signal, sender=sender, *arguments, **named + ) if isinstance(response, Deferred): - logger.error("Cannot return deferreds from signal handler: %(receiver)s", - {'receiver': receiver}, extra={'spider': spider}) + logger.error( + "Cannot return deferreds from signal handler: %(receiver)s", + {"receiver": receiver}, + extra={"spider": spider}, + ) except dont_log: result = Failure() except Exception: result = Failure() - logger.error("Error caught on signal handler: %(receiver)s", - {'receiver': receiver}, - exc_info=True, extra={'spider': spider}) + logger.error( + "Error caught on signal handler: %(receiver)s", + {"receiver": receiver}, + exc_info=True, + extra={"spider": spider}, + ) else: result = response responses.append((receiver, result)) @@ -49,19 +67,24 @@ def send_catch_log_deferred(signal=Any, sender=Anonymous, *arguments, **named): Returns a deferred that gets fired once all signal handlers deferreds were fired. """ + def logerror(failure, recv): if dont_log is None or not isinstance(failure.value, dont_log): - logger.error("Error caught on signal handler: %(receiver)s", - {'receiver': recv}, - exc_info=failure_to_exc_info(failure), - extra={'spider': spider}) + logger.error( + "Error caught on signal handler: %(receiver)s", + {"receiver": recv}, + exc_info=failure_to_exc_info(failure), + extra={"spider": spider}, + ) return failure - dont_log = named.pop('dont_log', None) - spider = named.get('spider', None) + dont_log = named.pop("dont_log", None) + spider = named.get("spider", None) dfds = [] for receiver in liveReceivers(getAllReceivers(sender, signal)): - d = maybeDeferred_coro(robustApply, receiver, signal=signal, sender=sender, *arguments, **named) + d = maybeDeferred_coro( + robustApply, receiver, signal=signal, sender=sender, *arguments, **named + ) d.addErrback(logerror, receiver) d.addBoth(lambda result: (receiver, result)) dfds.append(d) diff --git a/scrapy/utils/sitemap.py b/scrapy/utils/sitemap.py index a57a0c291..2622c2775 100644 --- a/scrapy/utils/sitemap.py +++ b/scrapy/utils/sitemap.py @@ -15,25 +15,27 @@ class Sitemap: (type=sitemapindex) files""" def __init__(self, xmltext): - xmlp = lxml.etree.XMLParser(recover=True, remove_comments=True, resolve_entities=False) + xmlp = lxml.etree.XMLParser( + recover=True, remove_comments=True, resolve_entities=False + ) self._root = lxml.etree.fromstring(xmltext, parser=xmlp) rt = self._root.tag - self.type = self._root.tag.split('}', 1)[1] if '}' in rt else rt + self.type = self._root.tag.split("}", 1)[1] if "}" in rt else rt def __iter__(self): for elem in self._root.getchildren(): d = {} for el in elem.getchildren(): tag = el.tag - name = tag.split('}', 1)[1] if '}' in tag else tag + name = tag.split("}", 1)[1] if "}" in tag else tag - if name == 'link': - if 'href' in el.attrib: - d.setdefault('alternate', []).append(el.get('href')) + if name == "link": + if "href" in el.attrib: + d.setdefault("alternate", []).append(el.get("href")) else: - d[name] = el.text.strip() if el.text else '' + d[name] = el.text.strip() if el.text else "" - if 'loc' in d: + if "loc" in d: yield d @@ -42,6 +44,6 @@ def sitemap_urls_from_robots(robots_text, base_url=None): robots.txt file """ for line in robots_text.splitlines(): - if line.lstrip().lower().startswith('sitemap:'): - url = line.split(':', 1)[1].strip() + if line.lstrip().lower().startswith("sitemap:"): + url = line.split(":", 1)[1].strip() yield urljoin(base_url, url) diff --git a/scrapy/utils/spider.py b/scrapy/utils/spider.py index b2da69404..f829bceb8 100644 --- a/scrapy/utils/spider.py +++ b/scrapy/utils/spider.py @@ -32,13 +32,14 @@ def iter_spider_classes(module): inspect.isclass(obj) and issubclass(obj, Spider) and obj.__module__ == module.__name__ - and getattr(obj, 'name', None) + and getattr(obj, "name", None) ): yield obj -def spidercls_for_request(spider_loader, request, default_spidercls=None, - log_none=False, log_multiple=False): +def spidercls_for_request( + spider_loader, request, default_spidercls=None, log_none=False, log_multiple=False +): """Return a spider class that handles the given Request. This will look for the spiders that can handle the given request (using @@ -54,15 +55,18 @@ def spidercls_for_request(spider_loader, request, default_spidercls=None, return spider_loader.load(snames[0]) if len(snames) > 1 and log_multiple: - logger.error('More than one spider can handle: %(request)s - %(snames)s', - {'request': request, 'snames': ', '.join(snames)}) + logger.error( + "More than one spider can handle: %(request)s - %(snames)s", + {"request": request, "snames": ", ".join(snames)}, + ) if len(snames) == 0 and log_none: - logger.error('Unable to find spider that handles: %(request)s', - {'request': request}) + logger.error( + "Unable to find spider that handles: %(request)s", {"request": request} + ) return default_spidercls class DefaultSpider(Spider): - name = 'default' + name = "default" diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index ea4dde882..b73261723 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -6,7 +6,7 @@ from scrapy.utils.python import to_unicode # The OpenSSL symbol is present since 1.1.1 but it's not currently supported in any version of pyOpenSSL. # Using the binding directly, as this code does, requires cryptography 2.4. -SSL_OP_NO_TLSv1_3 = getattr(pyOpenSSLutil.lib, 'SSL_OP_NO_TLSv1_3', 0) +SSL_OP_NO_TLSv1_3 = getattr(pyOpenSSLutil.lib, "SSL_OP_NO_TLSv1_3", 0) def ffi_buf_to_string(buf): @@ -16,13 +16,17 @@ def ffi_buf_to_string(buf): def x509name_to_string(x509name): # from OpenSSL.crypto.X509Name.__repr__ result_buffer = pyOpenSSLutil.ffi.new("char[]", 512) - pyOpenSSLutil.lib.X509_NAME_oneline(x509name._name, result_buffer, len(result_buffer)) + pyOpenSSLutil.lib.X509_NAME_oneline( + x509name._name, result_buffer, len(result_buffer) + ) return ffi_buf_to_string(result_buffer) def get_temp_key_info(ssl_object): - if not hasattr(pyOpenSSLutil.lib, 'SSL_get_server_tmp_key'): # requires OpenSSL 1.0.2 + if not hasattr( + pyOpenSSLutil.lib, "SSL_get_server_tmp_key" + ): # requires OpenSSL 1.0.2 return None # adapted from OpenSSL apps/s_cb.c::ssl_print_tmp_key() @@ -36,26 +40,28 @@ def get_temp_key_info(ssl_object): key_info = [] key_type = pyOpenSSLutil.lib.EVP_PKEY_id(temp_key) if key_type == pyOpenSSLutil.lib.EVP_PKEY_RSA: - key_info.append('RSA') + key_info.append("RSA") elif key_type == pyOpenSSLutil.lib.EVP_PKEY_DH: - key_info.append('DH') + key_info.append("DH") elif key_type == pyOpenSSLutil.lib.EVP_PKEY_EC: - key_info.append('ECDH') + key_info.append("ECDH") ec_key = pyOpenSSLutil.lib.EVP_PKEY_get1_EC_KEY(temp_key) ec_key = pyOpenSSLutil.ffi.gc(ec_key, pyOpenSSLutil.lib.EC_KEY_free) - nid = pyOpenSSLutil.lib.EC_GROUP_get_curve_name(pyOpenSSLutil.lib.EC_KEY_get0_group(ec_key)) + nid = pyOpenSSLutil.lib.EC_GROUP_get_curve_name( + pyOpenSSLutil.lib.EC_KEY_get0_group(ec_key) + ) cname = pyOpenSSLutil.lib.EC_curve_nid2nist(nid) if cname == pyOpenSSLutil.ffi.NULL: cname = pyOpenSSLutil.lib.OBJ_nid2sn(nid) key_info.append(ffi_buf_to_string(cname)) else: key_info.append(ffi_buf_to_string(pyOpenSSLutil.lib.OBJ_nid2sn(key_type))) - key_info.append(f'{pyOpenSSLutil.lib.EVP_PKEY_bits(temp_key)} bits') - return ', '.join(key_info) + key_info.append(f"{pyOpenSSLutil.lib.EVP_PKEY_bits(temp_key)} bits") + return ", ".join(key_info) def get_openssl_version(): - system_openssl = OpenSSL.SSL.SSLeay_version( - OpenSSL.SSL.SSLEAY_VERSION - ).decode('ascii', errors='replace') - return f'{OpenSSL.version.__version__} ({system_openssl})' + system_openssl = OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION).decode( + "ascii", errors="replace" + ) + return f"{OpenSSL.version.__version__} ({system_openssl})" diff --git a/scrapy/utils/template.py b/scrapy/utils/template.py index 2177817d9..89bedfc69 100644 --- a/scrapy/utils/template.py +++ b/scrapy/utils/template.py @@ -9,23 +9,23 @@ from typing import Union def render_templatefile(path: Union[str, PathLike], **kwargs): path_obj = Path(path) - raw = path_obj.read_text('utf8') + raw = path_obj.read_text("utf8") content = string.Template(raw).substitute(**kwargs) - render_path = path_obj.with_suffix('') if path_obj.suffix == '.tmpl' else path_obj + render_path = path_obj.with_suffix("") if path_obj.suffix == ".tmpl" else path_obj - if path_obj.suffix == '.tmpl': + if path_obj.suffix == ".tmpl": path_obj.rename(render_path) - render_path.write_text(content, 'utf8') + render_path.write_text(content, "utf8") -CAMELCASE_INVALID_CHARS = re.compile(r'[^a-zA-Z\d]') +CAMELCASE_INVALID_CHARS = re.compile(r"[^a-zA-Z\d]") def string_camelcase(string): - """ Convert a word to its CamelCase version and remove invalid chars + """Convert a word to its CamelCase version and remove invalid chars >>> string_camelcase('lost-pound') 'LostPound' @@ -34,4 +34,4 @@ def string_camelcase(string): 'MissingImages' """ - return CAMELCASE_INVALID_CHARS.sub('', string.title()) + return CAMELCASE_INVALID_CHARS.sub("", string.title()) diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index 9171d6224..d21065706 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -15,18 +15,19 @@ from scrapy.utils.boto import is_botocore_available def assert_gcs_environ(): - if 'GCS_PROJECT_ID' not in os.environ: + if "GCS_PROJECT_ID" not in os.environ: raise SkipTest("GCS_PROJECT_ID not found") def skip_if_no_boto(): if not is_botocore_available(): - raise SkipTest('missing botocore library') + raise SkipTest("missing botocore library") def get_gcs_content_and_delete(bucket, path): from google.cloud import storage - client = storage.Client(project=os.environ.get('GCS_PROJECT_ID')) + + client = storage.Client(project=os.environ.get("GCS_PROJECT_ID")) bucket = client.get_bucket(bucket) blob = bucket.get_blob(path) content = blob.download_as_string() @@ -36,9 +37,10 @@ def get_gcs_content_and_delete(bucket, path): def get_ftp_content_and_delete( - path, host, port, username, - password, use_active_mode=False): + path, host, port, username, password, use_active_mode=False +): from ftplib import FTP + ftp = FTP() ftp.connect(host, port) ftp.login(username, password) @@ -48,7 +50,8 @@ def get_ftp_content_and_delete( def buffer_data(data): ftp_data.append(data) - ftp.retrbinary(f'RETR {path}', buffer_data) + + ftp.retrbinary(f"RETR {path}", buffer_data) dirname, filename = split(path) ftp.cwd(dirname) ftp.delete(filename) @@ -66,7 +69,7 @@ def get_crawler(spidercls=None, settings_dict=None, prevent_warnings=True): # Set by default settings that prevent deprecation warnings. settings = {} if prevent_warnings: - settings['REQUEST_FINGERPRINTER_IMPLEMENTATION'] = '2.7' + settings["REQUEST_FINGERPRINTER_IMPLEMENTATION"] = "2.7" settings.update(settings_dict or {}) runner = CrawlerRunner(settings) return runner.create_crawler(spidercls or Spider) @@ -75,8 +78,8 @@ def get_crawler(spidercls=None, settings_dict=None, prevent_warnings=True): def get_pythonpath() -> str: """Return a PYTHONPATH suitable to use in processes so that they find this installation of Scrapy""" - scrapy_path = import_module('scrapy').__path__[0] - return str(Path(scrapy_path).parent) + os.pathsep + os.environ.get('PYTHONPATH', '') + scrapy_path = import_module("scrapy").__path__[0] + return str(Path(scrapy_path).parent) + os.pathsep + os.environ.get("PYTHONPATH", "") def get_testenv(): @@ -84,7 +87,7 @@ def get_testenv(): this installation of Scrapy, instead of a system installed one. """ env = os.environ.copy() - env['PYTHONPATH'] = get_pythonpath() + env["PYTHONPATH"] = get_pythonpath() return env @@ -107,6 +110,7 @@ def mock_google_cloud_storage(): classes and set their proper return values. """ from google.cloud.storage import Client, Bucket, Blob + client_mock = mock.create_autospec(Client) bucket_mock = mock.create_autospec(Bucket) @@ -121,5 +125,6 @@ def mock_google_cloud_storage(): def get_web_client_agent_req(url): from twisted.internet import reactor from twisted.web.client import Agent # imports twisted.internet.reactor + agent = Agent(reactor) - return agent.request(b'GET', url.encode('utf-8')) + return agent.request(b"GET", url.encode("utf-8")) diff --git a/scrapy/utils/testproc.py b/scrapy/utils/testproc.py index a54c7db95..fe5c8d74c 100644 --- a/scrapy/utils/testproc.py +++ b/scrapy/utils/testproc.py @@ -7,14 +7,15 @@ from twisted.internet import defer, protocol class ProcessTest: command = None - prefix = [sys.executable, '-m', 'scrapy.cmdline'] + prefix = [sys.executable, "-m", "scrapy.cmdline"] cwd = os.getcwd() # trial chdirs to temp dir def execute(self, args, check_code=True, settings=None): from twisted.internet import reactor + env = os.environ.copy() if settings is not None: - env['SCRAPY_SETTINGS_MODULE'] = settings + env["SCRAPY_SETTINGS_MODULE"] = settings cmd = self.prefix + [self.command] + list(args) pp = TestProcessProtocol() pp.deferred.addBoth(self._process_finished, cmd, check_code) @@ -32,11 +33,10 @@ class ProcessTest: class TestProcessProtocol(protocol.ProcessProtocol): - def __init__(self): self.deferred = defer.Deferred() - self.out = b'' - self.err = b'' + self.out = b"" + self.err = b"" self.exitcode = None def outReceived(self, data): diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py index 5d3710391..a47756c4b 100644 --- a/scrapy/utils/testsite.py +++ b/scrapy/utils/testsite.py @@ -4,9 +4,9 @@ from twisted.web import server, resource, static, util class SiteTest: - def setUp(self): from twisted.internet import reactor + super().setUp() self.site = reactor.listenTCP(0, test_site(), interface="127.0.0.1") self.baseurl = f"http://localhost:{self.site.getHost().port}/" @@ -22,23 +22,34 @@ class SiteTest: class NoMetaRefreshRedirect(util.Redirect): def render(self, request): content = util.Redirect.render(self, request) - return content.replace(b'http-equiv=\"refresh\"', - b'http-no-equiv=\"do-not-refresh-me\"') + return content.replace( + b'http-equiv="refresh"', b'http-no-equiv="do-not-refresh-me"' + ) def test_site(): r = resource.Resource() r.putChild(b"text", static.Data(b"Works", "text/plain")) - r.putChild(b"html", static.Data(b"

Works

World

", "text/html")) - r.putChild(b"enc-gb18030", static.Data(b"

gb18030 encoding

", "text/html; charset=gb18030")) + r.putChild( + b"html", + static.Data( + b"

Works

World

", + "text/html", + ), + ) + r.putChild( + b"enc-gb18030", + static.Data(b"

gb18030 encoding

", "text/html; charset=gb18030"), + ) r.putChild(b"redirect", util.Redirect(b"/redirected")) r.putChild(b"redirect-no-meta-refresh", NoMetaRefreshRedirect(b"/redirected")) r.putChild(b"redirected", static.Data(b"Redirected here", "text/plain")) return server.Site(r) -if __name__ == '__main__': +if __name__ == "__main__": from twisted.internet import reactor + port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") print(f"http://localhost:{port.getHost().port}/") reactor.run() diff --git a/scrapy/utils/trackref.py b/scrapy/utils/trackref.py index b0c6a2424..9aa775a1b 100644 --- a/scrapy/utils/trackref.py +++ b/scrapy/utils/trackref.py @@ -35,8 +35,7 @@ def format_live_refs(ignore=NoneType): """Return a tabular representation of tracked objects""" s = "Live References\n\n" now = time() - for cls, wdict in sorted(live_refs.items(), - key=lambda x: x[0].__name__): + for cls, wdict in sorted(live_refs.items(), key=lambda x: x[0].__name__): if not wdict: continue if issubclass(cls, ignore): diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index 21201ace5..ad3bff4f0 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -21,12 +21,14 @@ def url_is_from_any_domain(url, domains): if not host: return False domains = [d.lower() for d in domains] - return any((host == d) or (host.endswith(f'.{d}')) for d in domains) + return any((host == d) or (host.endswith(f".{d}")) for d in domains) def url_is_from_spider(url, spider): """Return True if the url belongs to the given spider""" - return url_is_from_any_domain(url, [spider.name] + list(getattr(spider, 'allowed_domains', []))) + return url_is_from_any_domain( + url, [spider.name] + list(getattr(spider, "allowed_domains", [])) + ) def url_has_any_extension(url, extensions): @@ -68,9 +70,9 @@ def escape_ajax(url): 'www.example.com/ajax.html' """ defrag, frag = urldefrag(url) - if not frag.startswith('!'): + if not frag.startswith("!"): return url - return add_or_replace_parameter(defrag, '_escaped_fragment_', frag[1:]) + return add_or_replace_parameter(defrag, "_escaped_fragment_", frag[1:]) def add_http_if_no_scheme(url): @@ -87,7 +89,7 @@ def add_http_if_no_scheme(url): def _is_posix_path(string): return bool( re.match( - r''' + r""" ^ # start with... ( \. # ...a single dot, @@ -99,7 +101,7 @@ def _is_posix_path(string): )? # optional match of ".", ".." or ".blabla" / # at least one "/" for a file path, . # and something after the "/" - ''', + """, string, flags=re.VERBOSE, ) @@ -109,13 +111,13 @@ def _is_posix_path(string): def _is_windows_path(string): return bool( re.match( - r''' + r""" ^ ( [a-z]:\\ | \\\\ ) - ''', + """, string, flags=re.IGNORECASE | re.VERBOSE, ) @@ -134,7 +136,13 @@ def guess_scheme(url): return add_http_if_no_scheme(url) -def strip_url(url, strip_credentials=True, strip_default_port=True, origin_only=False, strip_fragment=True): +def strip_url( + url, + strip_credentials=True, + strip_default_port=True, + origin_only=False, + strip_fragment=True, +): """Strip URL string from some of its components: @@ -148,18 +156,24 @@ def strip_url(url, strip_credentials=True, strip_default_port=True, origin_only= parsed_url = urlparse(url) netloc = parsed_url.netloc - if (strip_credentials or origin_only) and (parsed_url.username or parsed_url.password): - netloc = netloc.split('@')[-1] + if (strip_credentials or origin_only) and ( + parsed_url.username or parsed_url.password + ): + netloc = netloc.split("@")[-1] if strip_default_port and parsed_url.port: - if (parsed_url.scheme, parsed_url.port) in (('http', 80), - ('https', 443), - ('ftp', 21)): - netloc = netloc.replace(f':{parsed_url.port}', '') - return urlunparse(( - parsed_url.scheme, - netloc, - '/' if origin_only else parsed_url.path, - '' if origin_only else parsed_url.params, - '' if origin_only else parsed_url.query, - '' if strip_fragment else parsed_url.fragment - )) + if (parsed_url.scheme, parsed_url.port) in ( + ("http", 80), + ("https", 443), + ("ftp", 21), + ): + netloc = netloc.replace(f":{parsed_url.port}", "") + return urlunparse( + ( + parsed_url.scheme, + netloc, + "/" if origin_only else parsed_url.path, + "" if origin_only else parsed_url.params, + "" if origin_only else parsed_url.query, + "" if strip_fragment else parsed_url.fragment, + ) + ) diff --git a/setup.py b/setup.py index 82ac86cdd..27581f81d 100644 --- a/setup.py +++ b/setup.py @@ -3,7 +3,7 @@ from pkg_resources import parse_version from setuptools import setup, find_packages, __version__ as setuptools_version -version = (Path(__file__).parent / 'scrapy/VERSION').read_text('ascii').strip() +version = (Path(__file__).parent / "scrapy/VERSION").read_text("ascii").strip() def has_environment_marker_platform_impl_support(): @@ -14,82 +14,82 @@ def has_environment_marker_platform_impl_support(): it is 18.5, see: https://setuptools.readthedocs.io/en/latest/history.html#id235 """ - return parse_version(setuptools_version) >= parse_version('18.5') + return parse_version(setuptools_version) >= parse_version("18.5") install_requires = [ - 'Twisted>=18.9.0', - 'cryptography>=3.3', - 'cssselect>=0.9.1', - 'itemloaders>=1.0.1', - 'parsel>=1.5.0', - 'pyOpenSSL>=21.0.0', - 'queuelib>=1.4.2', - 'service_identity>=18.1.0', - 'w3lib>=1.17.0', - 'zope.interface>=5.1.0', - 'protego>=0.1.15', - 'itemadapter>=0.1.0', - 'setuptools', - 'packaging', - 'tldextract', - 'lxml>=4.3.0', + "Twisted>=18.9.0", + "cryptography>=3.3", + "cssselect>=0.9.1", + "itemloaders>=1.0.1", + "parsel>=1.5.0", + "pyOpenSSL>=21.0.0", + "queuelib>=1.4.2", + "service_identity>=18.1.0", + "w3lib>=1.17.0", + "zope.interface>=5.1.0", + "protego>=0.1.15", + "itemadapter>=0.1.0", + "setuptools", + "packaging", + "tldextract", + "lxml>=4.3.0", ] extras_require = {} cpython_dependencies = [ - 'PyDispatcher>=2.0.5', + "PyDispatcher>=2.0.5", ] if has_environment_marker_platform_impl_support(): - extras_require[':platform_python_implementation == "CPython"'] = cpython_dependencies + extras_require[ + ':platform_python_implementation == "CPython"' + ] = cpython_dependencies extras_require[':platform_python_implementation == "PyPy"'] = [ - 'PyPyDispatcher>=2.1.0', + "PyPyDispatcher>=2.1.0", ] else: install_requires.extend(cpython_dependencies) setup( - name='Scrapy', + name="Scrapy", version=version, - url='https://scrapy.org', + url="https://scrapy.org", project_urls={ - 'Documentation': 'https://docs.scrapy.org/', - 'Source': 'https://github.com/scrapy/scrapy', - 'Tracker': 'https://github.com/scrapy/scrapy/issues', + "Documentation": "https://docs.scrapy.org/", + "Source": "https://github.com/scrapy/scrapy", + "Tracker": "https://github.com/scrapy/scrapy/issues", }, - description='A high-level Web Crawling and Web Scraping framework', - long_description=open('README.rst', encoding="utf-8").read(), - author='Scrapy developers', - maintainer='Pablo Hoffman', - maintainer_email='pablo@pablohoffman.com', - license='BSD', - packages=find_packages(exclude=('tests', 'tests.*')), + description="A high-level Web Crawling and Web Scraping framework", + long_description=open("README.rst", encoding="utf-8").read(), + author="Scrapy developers", + maintainer="Pablo Hoffman", + maintainer_email="pablo@pablohoffman.com", + license="BSD", + packages=find_packages(exclude=("tests", "tests.*")), include_package_data=True, zip_safe=False, - entry_points={ - 'console_scripts': ['scrapy = scrapy.cmdline:execute'] - }, + entry_points={"console_scripts": ["scrapy = scrapy.cmdline:execute"]}, classifiers=[ - 'Framework :: Scrapy', - 'Development Status :: 5 - Production/Stable', - 'Environment :: Console', - 'Intended Audience :: Developers', - 'License :: OSI Approved :: BSD License', - 'Operating System :: OS Independent', - 'Programming Language :: Python', - 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Programming Language :: Python :: 3.10', - 'Programming Language :: Python :: 3.11', - 'Programming Language :: Python :: Implementation :: CPython', - 'Programming Language :: Python :: Implementation :: PyPy', - 'Topic :: Internet :: WWW/HTTP', - 'Topic :: Software Development :: Libraries :: Application Frameworks', - 'Topic :: Software Development :: Libraries :: Python Modules', + "Framework :: Scrapy", + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Intended Audience :: Developers", + "License :: OSI Approved :: BSD License", + "Operating System :: OS Independent", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: Implementation :: CPython", + "Programming Language :: Python :: Implementation :: PyPy", + "Topic :: Internet :: WWW/HTTP", + "Topic :: Software Development :: Libraries :: Application Frameworks", + "Topic :: Software Development :: Libraries :: Python Modules", ], - python_requires='>=3.7', + python_requires=">=3.7", install_requires=install_requires, extras_require=extras_require, ) diff --git a/tests/CrawlerProcess/asyncio_custom_loop.py b/tests/CrawlerProcess/asyncio_custom_loop.py index 1e4ada722..5e72aa6d4 100644 --- a/tests/CrawlerProcess/asyncio_custom_loop.py +++ b/tests/CrawlerProcess/asyncio_custom_loop.py @@ -3,15 +3,17 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "ASYNCIO_EVENT_LOOP": "uvloop.Loop" -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": "uvloop.Loop", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/asyncio_deferred_signal.py b/tests/CrawlerProcess/asyncio_deferred_signal.py index b83f6a585..1afef4d24 100644 --- a/tests/CrawlerProcess/asyncio_deferred_signal.py +++ b/tests/CrawlerProcess/asyncio_deferred_signal.py @@ -37,9 +37,11 @@ if __name__ == "__main__": except IndexError: ASYNCIO_EVENT_LOOP = None - process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "ASYNCIO_EVENT_LOOP": ASYNCIO_EVENT_LOOP, - }) + process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": ASYNCIO_EVENT_LOOP, + } + ) process.crawl(UrlSpider) process.start() diff --git a/tests/CrawlerProcess/asyncio_enabled_no_reactor.py b/tests/CrawlerProcess/asyncio_enabled_no_reactor.py index d1e4a7bb5..6df6d76fa 100644 --- a/tests/CrawlerProcess/asyncio_enabled_no_reactor.py +++ b/tests/CrawlerProcess/asyncio_enabled_no_reactor.py @@ -3,14 +3,16 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor.py b/tests/CrawlerProcess/asyncio_enabled_reactor.py index e561d63c7..01d23c963 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor.py @@ -2,6 +2,7 @@ import asyncio import sys from twisted.internet import asyncioreactor + if sys.version_info >= (3, 8) and sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) asyncioreactor.install(asyncio.get_event_loop()) @@ -11,14 +12,16 @@ from scrapy.crawler import CrawlerProcess # noqa: E402 class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py index ea8242f67..34ef00143 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_different_loop.py @@ -2,6 +2,7 @@ import asyncio import sys from twisted.internet import asyncioreactor + if sys.version_info >= (3, 8) and sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) asyncioreactor.install(asyncio.get_event_loop()) @@ -11,15 +12,17 @@ from scrapy.crawler import CrawlerProcess # noqa: E402 class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "ASYNCIO_EVENT_LOOP": "uvloop.Loop", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": "uvloop.Loop", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py index d24bf3031..79dd77bb2 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py @@ -4,6 +4,7 @@ import sys from uvloop import Loop from twisted.internet import asyncioreactor + if sys.version_info >= (3, 8) and sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) asyncio.set_event_loop(Loop()) @@ -14,15 +15,17 @@ from scrapy.crawler import CrawlerProcess # noqa: E402 class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "ASYNCIO_EVENT_LOOP": "uvloop.Loop", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "ASYNCIO_EVENT_LOOP": "uvloop.Loop", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/caching_hostname_resolver.py b/tests/CrawlerProcess/caching_hostname_resolver.py index f9eab3543..7b0497bde 100644 --- a/tests/CrawlerProcess/caching_hostname_resolver.py +++ b/tests/CrawlerProcess/caching_hostname_resolver.py @@ -8,6 +8,7 @@ class CachingHostnameResolverSpider(scrapy.Spider): """ Finishes in a finite amount of time (does not hang indefinitely in the DNS resolution) """ + name = "caching_hostname_resolver_spider" def start_requests(self): @@ -15,16 +16,20 @@ class CachingHostnameResolverSpider(scrapy.Spider): def parse(self, response): for _ in range(10): - yield scrapy.Request(response.url, dont_filter=True, callback=self.ignore_response) + yield scrapy.Request( + response.url, dont_filter=True, callback=self.ignore_response + ) def ignore_response(self, response): self.logger.info(repr(response.ip_address)) if __name__ == "__main__": - process = CrawlerProcess(settings={ - "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", - }) + process = CrawlerProcess( + settings={ + "RETRY_ENABLED": False, + "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + } + ) process.crawl(CachingHostnameResolverSpider, url=sys.argv[1]) process.start() diff --git a/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py b/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py index 3340d2f84..d5d19e27e 100644 --- a/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py +++ b/tests/CrawlerProcess/caching_hostname_resolver_ipv6.py @@ -6,14 +6,17 @@ class CachingHostnameResolverSpider(scrapy.Spider): """ Finishes without a twisted.internet.error.DNSLookupError exception """ + name = "caching_hostname_resolver_spider" start_urls = ["http://[::1]"] if __name__ == "__main__": - process = CrawlerProcess(settings={ - "RETRY_ENABLED": False, - "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", - }) + process = CrawlerProcess( + settings={ + "RETRY_ENABLED": False, + "DNS_RESOLVER": "scrapy.resolver.CachingHostnameResolver", + } + ) process.crawl(CachingHostnameResolverSpider) process.start() diff --git a/tests/CrawlerProcess/default_name_resolver.py b/tests/CrawlerProcess/default_name_resolver.py index 05a98fbec..cfc4b38b7 100644 --- a/tests/CrawlerProcess/default_name_resolver.py +++ b/tests/CrawlerProcess/default_name_resolver.py @@ -7,6 +7,7 @@ class IPv6Spider(scrapy.Spider): Raises a twisted.internet.error.DNSLookupError: the default name resolver does not handle IPv6 addresses. """ + name = "ipv6_spider" start_urls = ["http://[::1]"] diff --git a/tests/CrawlerProcess/multi.py b/tests/CrawlerProcess/multi.py index aaa1af5c5..9f7eaf2ae 100644 --- a/tests/CrawlerProcess/multi.py +++ b/tests/CrawlerProcess/multi.py @@ -3,7 +3,7 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] diff --git a/tests/CrawlerProcess/reactor_default.py b/tests/CrawlerProcess/reactor_default.py index 06b849de3..078cb72cb 100644 --- a/tests/CrawlerProcess/reactor_default.py +++ b/tests/CrawlerProcess/reactor_default.py @@ -5,7 +5,7 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] diff --git a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py index a6dff0e05..744b4ecb5 100644 --- a/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_default_twisted_reactor_select.py @@ -5,15 +5,17 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/reactor_select.py b/tests/CrawlerProcess/reactor_select.py index 907f50784..814a2a46d 100644 --- a/tests/CrawlerProcess/reactor_select.py +++ b/tests/CrawlerProcess/reactor_select.py @@ -7,7 +7,7 @@ selectreactor.install() class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] diff --git a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py index 6f48da691..37626c081 100644 --- a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py @@ -13,15 +13,17 @@ installReactor(reactor) class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py index c422b13ff..b397608ec 100644 --- a/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_twisted_reactor_select.py @@ -7,15 +7,17 @@ selectreactor.install() class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", + } +) process.crawl(NoRequestsSpider) process.start() diff --git a/tests/CrawlerProcess/simple.py b/tests/CrawlerProcess/simple.py index 5f6f1ae30..2d8769501 100644 --- a/tests/CrawlerProcess/simple.py +++ b/tests/CrawlerProcess/simple.py @@ -3,7 +3,7 @@ from scrapy.crawler import CrawlerProcess class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] diff --git a/tests/CrawlerProcess/twisted_reactor_asyncio.py b/tests/CrawlerProcess/twisted_reactor_asyncio.py index c6cbf949b..057d0efff 100644 --- a/tests/CrawlerProcess/twisted_reactor_asyncio.py +++ b/tests/CrawlerProcess/twisted_reactor_asyncio.py @@ -3,11 +3,13 @@ from scrapy.crawler import CrawlerProcess class AsyncioReactorSpider(scrapy.Spider): - name = 'asyncio_reactor' + name = "asyncio_reactor" -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + } +) process.crawl(AsyncioReactorSpider) process.start() diff --git a/tests/CrawlerProcess/twisted_reactor_custom_settings.py b/tests/CrawlerProcess/twisted_reactor_custom_settings.py index 56304bd23..4b6a33f66 100644 --- a/tests/CrawlerProcess/twisted_reactor_custom_settings.py +++ b/tests/CrawlerProcess/twisted_reactor_custom_settings.py @@ -3,7 +3,7 @@ from scrapy.crawler import CrawlerProcess class AsyncioReactorSpider(scrapy.Spider): - name = 'asyncio_reactor' + name = "asyncio_reactor" custom_settings = { "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", } diff --git a/tests/CrawlerProcess/twisted_reactor_custom_settings_conflict.py b/tests/CrawlerProcess/twisted_reactor_custom_settings_conflict.py index 3f219098c..19cc08be6 100644 --- a/tests/CrawlerProcess/twisted_reactor_custom_settings_conflict.py +++ b/tests/CrawlerProcess/twisted_reactor_custom_settings_conflict.py @@ -3,14 +3,14 @@ from scrapy.crawler import CrawlerProcess class SelectReactorSpider(scrapy.Spider): - name = 'select_reactor' + name = "select_reactor" custom_settings = { "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", } class AsyncioReactorSpider(scrapy.Spider): - name = 'asyncio_reactor' + name = "asyncio_reactor" custom_settings = { "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", } diff --git a/tests/CrawlerProcess/twisted_reactor_custom_settings_same.py b/tests/CrawlerProcess/twisted_reactor_custom_settings_same.py index 72bb986bc..5c9b737c6 100644 --- a/tests/CrawlerProcess/twisted_reactor_custom_settings_same.py +++ b/tests/CrawlerProcess/twisted_reactor_custom_settings_same.py @@ -3,14 +3,14 @@ from scrapy.crawler import CrawlerProcess class AsyncioReactorSpider1(scrapy.Spider): - name = 'asyncio_reactor1' + name = "asyncio_reactor1" custom_settings = { "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", } class AsyncioReactorSpider2(scrapy.Spider): - name = 'asyncio_reactor2' + name = "asyncio_reactor2" custom_settings = { "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", } diff --git a/tests/CrawlerProcess/twisted_reactor_poll.py b/tests/CrawlerProcess/twisted_reactor_poll.py index 27063260b..b2ca04672 100644 --- a/tests/CrawlerProcess/twisted_reactor_poll.py +++ b/tests/CrawlerProcess/twisted_reactor_poll.py @@ -3,11 +3,13 @@ from scrapy.crawler import CrawlerProcess class PollReactorSpider(scrapy.Spider): - name = 'poll_reactor' + name = "poll_reactor" -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.pollreactor.PollReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.pollreactor.PollReactor", + } +) process.crawl(PollReactorSpider) process.start() diff --git a/tests/CrawlerProcess/twisted_reactor_select.py b/tests/CrawlerProcess/twisted_reactor_select.py index 9af8ceb4d..5048081f7 100644 --- a/tests/CrawlerProcess/twisted_reactor_select.py +++ b/tests/CrawlerProcess/twisted_reactor_select.py @@ -3,11 +3,13 @@ from scrapy.crawler import CrawlerProcess class SelectReactorSpider(scrapy.Spider): - name = 'epoll_reactor' + name = "epoll_reactor" -process = CrawlerProcess(settings={ - "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", -}) +process = CrawlerProcess( + settings={ + "TWISTED_REACTOR": "twisted.internet.selectreactor.SelectReactor", + } +) process.crawl(SelectReactorSpider) process.start() diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index 417294447..26db16dd6 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -14,7 +14,7 @@ from tests.mockserver import MockServer, MockDNSServer # https://stackoverflow.com/a/32784190 def createResolver(servers=None, resolvconf=None, hosts=None): if hosts is None: - hosts = b'/etc/hosts' if platform.getType() == 'posix' else r'c:\windows\hosts' + hosts = b"/etc/hosts" if platform.getType() == "posix" else r"c:\windows\hosts" theResolver = Resolver(resolvconf, servers) hostResolver = hostsModule.Resolver(hosts) chain = [hostResolver, cache.CacheResolver(), theResolver] diff --git a/tests/__init__.py b/tests/__init__.py index be263fa16..5f0c0f7ad 100644 --- a/tests/__init__.py +++ b/tests/__init__.py @@ -11,24 +11,24 @@ from pathlib import Path # ignore system-wide proxies for tests # which would send requests to a totally unsuspecting server # (e.g. because urllib does not fully understand the proxy spec) -os.environ['http_proxy'] = '' -os.environ['https_proxy'] = '' -os.environ['ftp_proxy'] = '' +os.environ["http_proxy"] = "" +os.environ["https_proxy"] = "" +os.environ["ftp_proxy"] = "" # Absolutize paths to coverage config and output file because tests that # spawn subprocesses also changes current working directory. _sourceroot = Path(__file__).resolve().parent.parent -if 'COV_CORE_CONFIG' in os.environ: - os.environ['COVERAGE_FILE'] = str(_sourceroot / '.coverage') - os.environ['COV_CORE_CONFIG'] = str(_sourceroot / os.environ['COV_CORE_CONFIG']) +if "COV_CORE_CONFIG" in os.environ: + os.environ["COVERAGE_FILE"] = str(_sourceroot / ".coverage") + os.environ["COV_CORE_CONFIG"] = str(_sourceroot / os.environ["COV_CORE_CONFIG"]) -tests_datadir = str(Path(__file__).parent.resolve() / 'sample_data') +tests_datadir = str(Path(__file__).parent.resolve() / "sample_data") # In some environments accessing a non-existing host doesn't raise an # error. In such cases we're going to skip tests which rely on it. try: - socket.getaddrinfo('non-existing-host', 80) + socket.getaddrinfo("non-existing-host", 80) NON_EXISTING_RESOLVABLE = True except socket.gaierror: NON_EXISTING_RESOLVABLE = False diff --git a/tests/ftpserver.py b/tests/ftpserver.py index 6f0289e08..0c6ca3621 100644 --- a/tests/ftpserver.py +++ b/tests/ftpserver.py @@ -7,18 +7,18 @@ from pyftpdlib.servers import FTPServer def main(): parser = ArgumentParser() - parser.add_argument('-d', '--directory') + parser.add_argument("-d", "--directory") args = parser.parse_args() authorizer = DummyAuthorizer() - full_permissions = 'elradfmwMT' + full_permissions = "elradfmwMT" authorizer.add_anonymous(args.directory, perm=full_permissions) handler = FTPHandler handler.authorizer = authorizer - address = ('127.0.0.1', 2121) + address = ("127.0.0.1", 2121) server = FTPServer(address, handler) server.serve_forever() -if __name__ == '__main__': +if __name__ == "__main__": main() diff --git a/tests/keys/__init__.py b/tests/keys/__init__.py index 3a41b3a3e..b306437db 100644 --- a/tests/keys/__init__.py +++ b/tests/keys/__init__.py @@ -29,7 +29,7 @@ def generate_keys(): key_size=2048, backend=default_backend(), ) - (folder / 'localhost.key').write_bytes( + (folder / "localhost.key").write_bytes( key.private_bytes( encoding=Encoding.PEM, format=PrivateFormat.TraditionalOpenSSL, @@ -58,4 +58,4 @@ def generate_keys(): ) .sign(key, SHA256(), default_backend()) ) - (folder / 'localhost.crt').write_bytes(cert.public_bytes(Encoding.PEM)) + (folder / "localhost.crt").write_bytes(cert.public_bytes(Encoding.PEM)) diff --git a/tests/mocks/dummydbm.py b/tests/mocks/dummydbm.py index 75c74daf5..e77f53666 100644 --- a/tests/mocks/dummydbm.py +++ b/tests/mocks/dummydbm.py @@ -4,6 +4,7 @@ import collections class DummyDB(dict): """Provide dummy DBM-like interface.""" + def close(self): pass @@ -14,7 +15,7 @@ error = KeyError _DATABASES = collections.defaultdict(DummyDB) -def open(file, flag='r', mode=0o666): +def open(file, flag="r", mode=0o666): """Open or create a dummy database compatible. Arguments ``flag`` and ``mode`` are ignored. diff --git a/tests/mockserver.py b/tests/mockserver.py index 6d2d95692..9f1a707c9 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -111,7 +111,6 @@ class LeafResource(resource.Resource): class Follow(LeafResource): - def render(self, request): total = getarg(request, b"total", 100, type=int) show = getarg(request, b"show", 1, type=int) @@ -140,13 +139,12 @@ class Follow(LeafResource): class Delay(LeafResource): - def render_GET(self, request): n = getarg(request, b"n", 1, type=float) b = getarg(request, b"b", 1, type=int) if b: # send headers now and delay body - request.write('') + request.write("") self.deferRequest(request, n, self._delayedRender, request, n) return NOT_DONE_YET @@ -156,7 +154,6 @@ class Delay(LeafResource): class Status(LeafResource): - def render_GET(self, request): n = getarg(request, b"n", 200, type=int) request.setResponseCode(n) @@ -164,15 +161,15 @@ class Status(LeafResource): class Raw(LeafResource): - def render_GET(self, request): request.startedWriting = 1 self.deferRequest(request, 0, self._delayedRender, request) return NOT_DONE_YET + render_POST = render_GET def _delayedRender(self, request): - raw = getarg(request, b'raw', b'HTTP 1.1 200 OK\n') + raw = getarg(request, b"raw", b"HTTP 1.1 200 OK\n") request.startedWriting = 1 request.write(raw) request.channel.transport.loseConnection() @@ -180,30 +177,29 @@ class Raw(LeafResource): class Echo(LeafResource): - def render_GET(self, request): output = { - 'headers': dict( + "headers": dict( (to_unicode(k), [to_unicode(v) for v in vs]) - for k, vs in request.requestHeaders.getAllRawHeaders()), - 'body': to_unicode(request.content.read()), + for k, vs in request.requestHeaders.getAllRawHeaders() + ), + "body": to_unicode(request.content.read()), } return to_bytes(json.dumps(output)) + render_POST = render_GET class RedirectTo(LeafResource): - def render(self, request): - goto = getarg(request, b'goto', b'/') + goto = getarg(request, b"goto", b"/") # we force the body content, otherwise Twisted redirectTo() # returns HTML with 0: return reqs = [] for i in range(1, 3): - req = Request(self.start_urls[0], dont_filter=True, meta={'req_id': i}) + req = Request(self.start_urls[0], dont_filter=True, meta={"req_id": i}) reqs.append(req) return reqs class AsyncDefAsyncioGenExcSpider(SimpleSpider): - name = 'asyncdef_asyncio_gen_exc' + name = "asyncdef_asyncio_gen_exc" async def parse(self, response): for i in range(10): await asyncio.sleep(0.1) - yield {'foo': i} + yield {"foo": i} if i > 5: raise ValueError("Stopping the processing") class AsyncDefDeferredDirectSpider(SimpleSpider): - name = 'asyncdef_deferred_direct' + name = "asyncdef_deferred_direct" async def parse(self, response): resp = await get_web_client_agent_req(self.mockserver.url("/status?n=200")) - yield {'code': resp.code} + yield {"code": resp.code} class AsyncDefDeferredWrappedSpider(SimpleSpider): - name = 'asyncdef_deferred_wrapped' + name = "asyncdef_deferred_wrapped" async def parse(self, response): - resp = await deferred_to_future(get_web_client_agent_req(self.mockserver.url("/status?n=200"))) - yield {'code': resp.code} + resp = await deferred_to_future( + get_web_client_agent_req(self.mockserver.url("/status?n=200")) + ) + yield {"code": resp.code} class AsyncDefDeferredMaybeWrappedSpider(SimpleSpider): - name = 'asyncdef_deferred_wrapped' + name = "asyncdef_deferred_wrapped" async def parse(self, response): - resp = await maybe_deferred_to_future(get_web_client_agent_req(self.mockserver.url("/status?n=200"))) - yield {'code': resp.code} + resp = await maybe_deferred_to_future( + get_web_client_agent_req(self.mockserver.url("/status?n=200")) + ) + yield {"code": resp.code} class AsyncDefAsyncioGenSpider(SimpleSpider): - name = 'asyncdef_asyncio_gen' + name = "asyncdef_asyncio_gen" async def parse(self, response): await asyncio.sleep(0.2) - yield {'foo': 42} + yield {"foo": 42} self.logger.info(f"Got response {response.status}") class AsyncDefAsyncioGenLoopSpider(SimpleSpider): - name = 'asyncdef_asyncio_gen_loop' + name = "asyncdef_asyncio_gen_loop" async def parse(self, response): for i in range(10): await asyncio.sleep(0.1) - yield {'foo': i} + yield {"foo": i} self.logger.info(f"Got response {response.status}") class AsyncDefAsyncioGenComplexSpider(SimpleSpider): - name = 'asyncdef_asyncio_gen_complex' + name = "asyncdef_asyncio_gen_complex" initial_reqs = 4 following_reqs = 3 depth = 2 def _get_req(self, index, cb=None): - return Request(self.mockserver.url(f"/status?n=200&request={index}"), - meta={'index': index}, - dont_filter=True, - callback=cb) + return Request( + self.mockserver.url(f"/status?n=200&request={index}"), + meta={"index": index}, + dont_filter=True, + callback=cb, + ) def start_requests(self): for i in range(1, self.initial_reqs + 1): yield self._get_req(i) async def parse(self, response): - index = response.meta['index'] - yield {'index': index} - if index < 10 ** self.depth: + index = response.meta["index"] + yield {"index": index} + if index < 10**self.depth: for new_index in range(10 * index, 10 * index + self.following_reqs): yield self._get_req(new_index) yield self._get_req(index, cb=self.parse2) await asyncio.sleep(0.1) - yield {'index': index + 5} + yield {"index": index + 5} async def parse2(self, response): await asyncio.sleep(0.1) - yield {'index2': response.meta['index']} + yield {"index2": response.meta["index"]} class ItemSpider(FollowAllSpider): - name = 'item' + name = "item" def parse(self, response): for request in super().parse(response): @@ -254,11 +262,11 @@ class DefaultError(Exception): class ErrorSpider(FollowAllSpider): - name = 'error' + name = "error" exception_cls = DefaultError def raise_exception(self): - raise self.exception_cls('Expected exception') + raise self.exception_cls("Expected exception") def parse(self, response): for request in super().parse(response): @@ -280,16 +288,18 @@ class BrokenStartRequestsSpider(FollowAllSpider): 1 / 0 for s in range(100): - qargs = {'total': 10, 'seed': s} + qargs = {"total": 10, "seed": s} url = self.mockserver.url(f"/follow?{urlencode(qargs, doseq=True)}") - yield Request(url, meta={'seed': s}) + yield Request(url, meta={"seed": s}) if self.fail_yielding: 2 / 0 - assert self.seedsseen, 'All start requests consumed before any download happened' + assert ( + self.seedsseen + ), "All start requests consumed before any download happened" def parse(self, response): - self.seedsseen.append(response.meta.get('seed')) + self.seedsseen.append(response.meta.get("seed")) for req in super().parse(response): yield req @@ -307,21 +317,21 @@ class SingleRequestSpider(MetaSpider): yield Request(self.seed, callback=self.parse, errback=self.on_error) def parse(self, response): - self.meta.setdefault('responses', []).append(response) + self.meta.setdefault("responses", []).append(response) if callable(self.callback_func): return self.callback_func(response) - if 'next' in response.meta: - return response.meta['next'] + if "next" in response.meta: + return response.meta["next"] def on_error(self, failure): - self.meta['failure'] = failure + self.meta["failure"] = failure if callable(self.errback_func): return self.errback_func(failure) class DuplicateStartRequestsSpider(MockServerSpider): dont_filter = True - name = 'duplicatestartrequests' + name = "duplicatestartrequests" distinct_urls = 2 dupe_factor = 3 @@ -343,13 +353,12 @@ class CrawlSpiderWithParseMethod(MockServerSpider, CrawlSpider): """ A CrawlSpider which overrides the 'parse' method """ - name = 'crawl_spider_with_parse_method' + + name = "crawl_spider_with_parse_method" custom_settings: dict = { - 'RETRY_HTTP_CODES': [], # no need to retry + "RETRY_HTTP_CODES": [], # no need to retry } - rules = ( - Rule(LinkExtractor(), callback='parse', follow=True), - ) + rules = (Rule(LinkExtractor(), callback="parse", follow=True),) def start_requests(self): test_body = b""" @@ -365,39 +374,45 @@ class CrawlSpiderWithParseMethod(MockServerSpider, CrawlSpider): yield Request(url, method="POST", body=test_body) def parse(self, response, foo=None): - self.logger.info('[parse] status %i (foo: %s)', response.status, foo) - yield Request(self.mockserver.url("/status?n=202"), self.parse, cb_kwargs={"foo": "bar"}) + self.logger.info("[parse] status %i (foo: %s)", response.status, foo) + yield Request( + self.mockserver.url("/status?n=202"), self.parse, cb_kwargs={"foo": "bar"} + ) class CrawlSpiderWithAsyncCallback(CrawlSpiderWithParseMethod): """A CrawlSpider with an async def callback""" - name = 'crawl_spider_with_async_callback' - rules = ( - Rule(LinkExtractor(), callback='parse_async', follow=True), - ) + + name = "crawl_spider_with_async_callback" + rules = (Rule(LinkExtractor(), callback="parse_async", follow=True),) async def parse_async(self, response, foo=None): - self.logger.info('[parse_async] status %i (foo: %s)', response.status, foo) - return Request(self.mockserver.url("/status?n=202"), self.parse_async, cb_kwargs={"foo": "bar"}) + self.logger.info("[parse_async] status %i (foo: %s)", response.status, foo) + return Request( + self.mockserver.url("/status?n=202"), + self.parse_async, + cb_kwargs={"foo": "bar"}, + ) class CrawlSpiderWithAsyncGeneratorCallback(CrawlSpiderWithParseMethod): """A CrawlSpider with an async generator callback""" - name = 'crawl_spider_with_async_generator_callback' - rules = ( - Rule(LinkExtractor(), callback='parse_async_gen', follow=True), - ) + + name = "crawl_spider_with_async_generator_callback" + rules = (Rule(LinkExtractor(), callback="parse_async_gen", follow=True),) async def parse_async_gen(self, response, foo=None): - self.logger.info('[parse_async_gen] status %i (foo: %s)', response.status, foo) - yield Request(self.mockserver.url("/status?n=202"), self.parse_async_gen, cb_kwargs={"foo": "bar"}) + self.logger.info("[parse_async_gen] status %i (foo: %s)", response.status, foo) + yield Request( + self.mockserver.url("/status?n=202"), + self.parse_async_gen, + cb_kwargs={"foo": "bar"}, + ) class CrawlSpiderWithErrback(CrawlSpiderWithParseMethod): - name = 'crawl_spider_with_errback' - rules = ( - Rule(LinkExtractor(), callback='parse', errback='errback', follow=True), - ) + name = "crawl_spider_with_errback" + rules = (Rule(LinkExtractor(), callback="parse", errback="errback", follow=True),) def start_requests(self): test_body = b""" @@ -416,13 +431,18 @@ class CrawlSpiderWithErrback(CrawlSpiderWithParseMethod): yield Request(url, method="POST", body=test_body) def errback(self, failure): - self.logger.info('[errback] status %i', failure.value.response.status) + self.logger.info("[errback] status %i", failure.value.response.status) class CrawlSpiderWithProcessRequestCallbackKeywordArguments(CrawlSpiderWithParseMethod): - name = 'crawl_spider_with_process_request_cb_kwargs' + name = "crawl_spider_with_process_request_cb_kwargs" rules = ( - Rule(LinkExtractor(), callback='parse', follow=True, process_request="process_request"), + Rule( + LinkExtractor(), + callback="parse", + follow=True, + process_request="process_request", + ), ) def process_request(self, request, response): @@ -457,14 +477,12 @@ class BytesReceivedCallbackSpider(MetaSpider): class BytesReceivedErrbackSpider(BytesReceivedCallbackSpider): - def bytes_received(self, data, request, spider): self.meta["bytes_received"] = data raise StopDownload(fail=True) class HeadersReceivedCallbackSpider(MetaSpider): - @classmethod def from_crawler(cls, crawler, *args, **kwargs): spider = super().from_crawler(crawler, *args, **kwargs) @@ -486,7 +504,6 @@ class HeadersReceivedCallbackSpider(MetaSpider): class HeadersReceivedErrbackSpider(HeadersReceivedCallbackSpider): - def headers_received(self, headers, body_length, request, spider): self.meta["headers_received"] = headers raise StopDownload(fail=True) diff --git a/tests/test_closespider.py b/tests/test_closespider.py index be8adadb3..c497450f7 100644 --- a/tests/test_closespider.py +++ b/tests/test_closespider.py @@ -6,7 +6,6 @@ from tests.mockserver import MockServer class TestCloseSpider(TestCase): - def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() @@ -17,40 +16,40 @@ class TestCloseSpider(TestCase): @defer.inlineCallbacks def test_closespider_itemcount(self): close_on = 5 - crawler = get_crawler(ItemSpider, {'CLOSESPIDER_ITEMCOUNT': close_on}) + crawler = get_crawler(ItemSpider, {"CLOSESPIDER_ITEMCOUNT": close_on}) yield crawler.crawl(mockserver=self.mockserver) - reason = crawler.spider.meta['close_reason'] - self.assertEqual(reason, 'closespider_itemcount') - itemcount = crawler.stats.get_value('item_scraped_count') + reason = crawler.spider.meta["close_reason"] + self.assertEqual(reason, "closespider_itemcount") + itemcount = crawler.stats.get_value("item_scraped_count") self.assertTrue(itemcount >= close_on) @defer.inlineCallbacks def test_closespider_pagecount(self): close_on = 5 - crawler = get_crawler(FollowAllSpider, {'CLOSESPIDER_PAGECOUNT': close_on}) + crawler = get_crawler(FollowAllSpider, {"CLOSESPIDER_PAGECOUNT": close_on}) yield crawler.crawl(mockserver=self.mockserver) - reason = crawler.spider.meta['close_reason'] - self.assertEqual(reason, 'closespider_pagecount') - pagecount = crawler.stats.get_value('response_received_count') + reason = crawler.spider.meta["close_reason"] + self.assertEqual(reason, "closespider_pagecount") + pagecount = crawler.stats.get_value("response_received_count") self.assertTrue(pagecount >= close_on) @defer.inlineCallbacks def test_closespider_errorcount(self): close_on = 5 - crawler = get_crawler(ErrorSpider, {'CLOSESPIDER_ERRORCOUNT': close_on}) + crawler = get_crawler(ErrorSpider, {"CLOSESPIDER_ERRORCOUNT": close_on}) yield crawler.crawl(total=1000000, mockserver=self.mockserver) - reason = crawler.spider.meta['close_reason'] - self.assertEqual(reason, 'closespider_errorcount') - key = f'spider_exceptions/{crawler.spider.exception_cls.__name__}' + reason = crawler.spider.meta["close_reason"] + self.assertEqual(reason, "closespider_errorcount") + key = f"spider_exceptions/{crawler.spider.exception_cls.__name__}" errorcount = crawler.stats.get_value(key) self.assertTrue(errorcount >= close_on) @defer.inlineCallbacks def test_closespider_timeout(self): close_on = 0.1 - crawler = get_crawler(FollowAllSpider, {'CLOSESPIDER_TIMEOUT': close_on}) + crawler = get_crawler(FollowAllSpider, {"CLOSESPIDER_TIMEOUT": close_on}) yield crawler.crawl(total=1000000, mockserver=self.mockserver) - reason = crawler.spider.meta['close_reason'] - self.assertEqual(reason, 'closespider_timeout') - total_seconds = crawler.stats.get_value('elapsed_time_seconds') + reason = crawler.spider.meta["close_reason"] + self.assertEqual(reason, "closespider_timeout") + total_seconds = crawler.stats.get_value("elapsed_time_seconds") self.assertTrue(total_seconds >= close_on) diff --git a/tests/test_cmdline/__init__.py b/tests/test_cmdline/__init__.py index 87ab1ee81..5aa35a6d9 100644 --- a/tests/test_cmdline/__init__.py +++ b/tests/test_cmdline/__init__.py @@ -12,47 +12,52 @@ from scrapy.utils.test import get_testenv class CmdlineTest(unittest.TestCase): - def setUp(self): self.env = get_testenv() - self.env['SCRAPY_SETTINGS_MODULE'] = 'tests.test_cmdline.settings' + self.env["SCRAPY_SETTINGS_MODULE"] = "tests.test_cmdline.settings" def _execute(self, *new_args, **kwargs): - encoding = getattr(sys.stdout, 'encoding') or 'utf-8' - args = (sys.executable, '-m', 'scrapy.cmdline') + new_args + encoding = getattr(sys.stdout, "encoding") or "utf-8" + args = (sys.executable, "-m", "scrapy.cmdline") + new_args proc = Popen(args, stdout=PIPE, stderr=PIPE, env=self.env, **kwargs) comm = proc.communicate()[0].strip() return comm.decode(encoding) def test_default_settings(self): - self.assertEqual(self._execute('settings', '--get', 'TEST1'), 'default') + self.assertEqual(self._execute("settings", "--get", "TEST1"), "default") def test_override_settings_using_set_arg(self): - self.assertEqual(self._execute('settings', '--get', 'TEST1', '-s', - 'TEST1=override'), 'override') + self.assertEqual( + self._execute("settings", "--get", "TEST1", "-s", "TEST1=override"), + "override", + ) def test_profiling(self): path = Path(tempfile.mkdtemp()) - filename = path / 'res.prof' + filename = path / "res.prof" try: - self._execute('version', '--profile', str(filename)) + self._execute("version", "--profile", str(filename)) self.assertTrue(filename.exists()) out = StringIO() stats = pstats.Stats(str(filename), stream=out) stats.print_stats() out.seek(0) stats = out.read() - self.assertIn(str(Path('scrapy', 'commands', 'version.py')), - stats) - self.assertIn('tottime', stats) + self.assertIn(str(Path("scrapy", "commands", "version.py")), stats) + self.assertIn("tottime", stats) finally: shutil.rmtree(path) def test_override_dict_settings(self): EXT_PATH = "tests.test_cmdline.extensions.DummyExtension" EXTENSIONS = {EXT_PATH: 200} - settingsstr = self._execute('settings', '--get', 'EXTENSIONS', '-s', - 'EXTENSIONS=' + json.dumps(EXTENSIONS)) + settingsstr = self._execute( + "settings", + "--get", + "EXTENSIONS", + "-s", + "EXTENSIONS=" + json.dumps(EXTENSIONS), + ) # XXX: There's gotta be a smarter way to do this... self.assertNotIn("...", settingsstr) for char in ("'", "<", ">"): @@ -62,5 +67,7 @@ class CmdlineTest(unittest.TestCase): self.assertEqual(200, settingsdict[EXT_PATH]) def test_pathlib_path_as_feeds_key(self): - self.assertEqual(self._execute('settings', '--get', 'FEEDS'), - json.dumps({"items.csv": {"format": "csv", "fields": ["price", "name"]}})) + self.assertEqual( + self._execute("settings", "--get", "FEEDS"), + json.dumps({"items.csv": {"format": "csv", "fields": ["price", "name"]}}), + ) diff --git a/tests/test_cmdline/extensions.py b/tests/test_cmdline/extensions.py index 005e45214..11c821f8d 100644 --- a/tests/test_cmdline/extensions.py +++ b/tests/test_cmdline/extensions.py @@ -2,9 +2,8 @@ class TestExtension: - def __init__(self, settings): - settings.set('TEST1', f"{settings['TEST1']} + started") + settings.set("TEST1", f"{settings['TEST1']} + started") @classmethod def from_crawler(cls, crawler): diff --git a/tests/test_cmdline/settings.py b/tests/test_cmdline/settings.py index b0ac6e98b..32b15e191 100644 --- a/tests/test_cmdline/settings.py +++ b/tests/test_cmdline/settings.py @@ -1,14 +1,14 @@ from pathlib import Path EXTENSIONS = { - 'tests.test_cmdline.extensions.TestExtension': 0, + "tests.test_cmdline.extensions.TestExtension": 0, } -TEST1 = 'default' +TEST1 = "default" FEEDS = { - Path('items.csv'): { - 'format': 'csv', - 'fields': ['price', 'name'], + Path("items.csv"): { + "format": "csv", + "fields": ["price", "name"], }, } diff --git a/tests/test_cmdline_crawl_with_pipeline/__init__.py b/tests/test_cmdline_crawl_with_pipeline/__init__.py index fcafcef68..d5088e817 100644 --- a/tests/test_cmdline_crawl_with_pipeline/__init__.py +++ b/tests/test_cmdline_crawl_with_pipeline/__init__.py @@ -5,16 +5,15 @@ from subprocess import Popen, PIPE class CmdlineCrawlPipelineTest(unittest.TestCase): - def _execute(self, spname): - args = (sys.executable, '-m', 'scrapy.cmdline', 'crawl', spname) + args = (sys.executable, "-m", "scrapy.cmdline", "crawl", spname) cwd = Path(__file__).resolve().parent proc = Popen(args, stdout=PIPE, stderr=PIPE, cwd=cwd) proc.communicate() return proc.returncode def test_open_spider_normally_in_pipeline(self): - self.assertEqual(self._execute('normal'), 0) + self.assertEqual(self._execute("normal"), 0) def test_exception_at_open_spider_in_pipeline(self): - self.assertEqual(self._execute('exception'), 1) + self.assertEqual(self._execute("exception"), 1) diff --git a/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py b/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py index bd1f9cd8c..af15cac68 100644 --- a/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py +++ b/tests/test_cmdline_crawl_with_pipeline/test_spider/pipelines.py @@ -1,5 +1,4 @@ class TestSpiderPipeline: - def open_spider(self, spider): pass @@ -8,9 +7,8 @@ class TestSpiderPipeline: class TestSpiderExceptionPipeline: - def open_spider(self, spider): - raise Exception('exception') + raise Exception("exception") def process_item(self, item, spider): return item diff --git a/tests/test_cmdline_crawl_with_pipeline/test_spider/settings.py b/tests/test_cmdline_crawl_with_pipeline/test_spider/settings.py index ae782c0d8..45c5f2eb9 100644 --- a/tests/test_cmdline_crawl_with_pipeline/test_spider/settings.py +++ b/tests/test_cmdline_crawl_with_pipeline/test_spider/settings.py @@ -1,2 +1,2 @@ -BOT_NAME = 'test_spider' -SPIDER_MODULES = ['test_spider.spiders'] +BOT_NAME = "test_spider" +SPIDER_MODULES = ["test_spider.spiders"] diff --git a/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/exception.py b/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/exception.py index 300f45ebf..ebd4082c6 100644 --- a/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/exception.py +++ b/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/exception.py @@ -2,12 +2,10 @@ import scrapy class ExceptionSpider(scrapy.Spider): - name = 'exception' + name = "exception" custom_settings = { - 'ITEM_PIPELINES': { - 'test_spider.pipelines.TestSpiderExceptionPipeline': 300 - } + "ITEM_PIPELINES": {"test_spider.pipelines.TestSpiderExceptionPipeline": 300} } def parse(self, response): diff --git a/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/normal.py b/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/normal.py index 87a40fdcb..9a258c80d 100644 --- a/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/normal.py +++ b/tests/test_cmdline_crawl_with_pipeline/test_spider/spiders/normal.py @@ -2,12 +2,10 @@ import scrapy class NormalSpider(scrapy.Spider): - name = 'normal' + name = "normal" custom_settings = { - 'ITEM_PIPELINES': { - 'test_spider.pipelines.TestSpiderPipeline': 300 - } + "ITEM_PIPELINES": {"test_spider.pipelines.TestSpiderPipeline": 300} } def parse(self, response): diff --git a/tests/test_command_check.py b/tests/test_command_check.py index 049076e5c..1f299587f 100644 --- a/tests/test_command_check.py +++ b/tests/test_command_check.py @@ -3,15 +3,16 @@ from tests.test_commands import CommandTest class CheckCommandTest(CommandTest): - command = 'check' + command = "check" def setUp(self): super().setUp() - self.spider_name = 'check_spider' - self.spider = (self.proj_mod_path / 'spiders' / 'checkspider.py').resolve() + self.spider_name = "check_spider" + self.spider = (self.proj_mod_path / "spiders" / "checkspider.py").resolve() def _write_contract(self, contracts, parse_def): - self.spider.write_text(f""" + self.spider.write_text( + f""" import scrapy class CheckSpider(scrapy.Spider): @@ -24,13 +25,15 @@ class CheckSpider(scrapy.Spider): {contracts} \"\"\" {parse_def} - """, encoding="utf-8") + """, + encoding="utf-8", + ) - def _test_contract(self, contracts='', parse_def='pass'): + def _test_contract(self, contracts="", parse_def="pass"): self._write_contract(contracts, parse_def) - p, out, err = self.proc('check') - self.assertNotIn('F', out) - self.assertIn('OK', err) + p, out, err = self.proc("check") + self.assertNotIn("F", out) + self.assertIn("OK", err) self.assertEqual(p.returncode, 0) def test_check_returns_requests_contract(self): diff --git a/tests/test_command_fetch.py b/tests/test_command_fetch.py index 9d3c8fe73..bd44fa76e 100644 --- a/tests/test_command_fetch.py +++ b/tests/test_command_fetch.py @@ -7,28 +7,30 @@ from scrapy.utils.testproc import ProcessTest class FetchTest(ProcessTest, SiteTest, unittest.TestCase): - command = 'fetch' + command = "fetch" @defer.inlineCallbacks def test_output(self): - _, out, _ = yield self.execute([self.url('/text')]) - self.assertEqual(out.strip(), b'Works') + _, out, _ = yield self.execute([self.url("/text")]) + self.assertEqual(out.strip(), b"Works") @defer.inlineCallbacks def test_redirect_default(self): - _, out, _ = yield self.execute([self.url('/redirect')]) - self.assertEqual(out.strip(), b'Redirected here') + _, out, _ = yield self.execute([self.url("/redirect")]) + self.assertEqual(out.strip(), b"Redirected here") @defer.inlineCallbacks def test_redirect_disabled(self): - _, out, err = yield self.execute(['--no-redirect', self.url('/redirect-no-meta-refresh')]) + _, out, err = yield self.execute( + ["--no-redirect", self.url("/redirect-no-meta-refresh")] + ) err = err.strip() - self.assertIn(b'downloader/response_status_count/302', err, err) - self.assertNotIn(b'downloader/response_status_count/200', err, err) + self.assertIn(b"downloader/response_status_count/302", err, err) + self.assertNotIn(b"downloader/response_status_count/200", err, err) @defer.inlineCallbacks def test_headers(self): - _, out, _ = yield self.execute([self.url('/text'), '--headers']) - out = out.replace(b'\r', b'') # required on win32 - assert b'Server: TwistedWeb' in out, out - assert b'Content-Type: text/plain' in out + _, out, _ = yield self.execute([self.url("/text"), "--headers"]) + out = out.replace(b"\r", b"") # required on win32 + assert b"Server: TwistedWeb" in out, out + assert b"Content-Type: text/plain" in out diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 368b80513..1ee1bf5a7 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -14,16 +14,17 @@ from tests.test_commands import CommandTest def _textmode(bstr): """Normalize input the same as writing to a file and reading from it in text mode""" - return to_unicode(bstr).replace(os.linesep, '\n') + return to_unicode(bstr).replace(os.linesep, "\n") class ParseCommandTest(ProcessTest, SiteTest, CommandTest): - command = 'parse' + command = "parse" def setUp(self): super().setUp() - self.spider_name = 'parse_spider' - (self.proj_mod_path / 'spiders' / 'myspider.py').write_text(f""" + self.spider_name = "parse_spider" + (self.proj_mod_path / "spiders" / "myspider.py").write_text( + f""" import scrapy from scrapy.linkextractors import LinkExtractor from scrapy.spiders import CrawlSpider, Rule @@ -92,9 +93,12 @@ class MyBadCrawlSpider(CrawlSpider): def parse(self, response): return [scrapy.Item(), dict(foo='bar')] -""", encoding="utf-8") +""", + encoding="utf-8", + ) - (self.proj_mod_path / 'pipelines.py').write_text(""" + (self.proj_mod_path / "pipelines.py").write_text( + """ import logging class MyPipeline: @@ -103,91 +107,141 @@ class MyPipeline: def process_item(self, item, spider): logging.info('It Works!') return item -""", encoding="utf-8") +""", + encoding="utf-8", + ) - with (self.proj_mod_path / 'settings.py').open("a", encoding="utf-8") as f: - f.write(f""" + with (self.proj_mod_path / "settings.py").open("a", encoding="utf-8") as f: + f.write( + f""" ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} -""") +""" + ) @defer.inlineCallbacks def test_spider_arguments(self): - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '-a', 'test_arg=1', - '-c', 'parse', - '--verbose', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "-a", + "test_arg=1", + "-c", + "parse", + "--verbose", + self.url("/html"), + ] + ) self.assertIn("DEBUG: It Works!", _textmode(stderr)) @defer.inlineCallbacks def test_request_with_meta(self): raw_json_string = '{"foo" : "baz"}' - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '--meta', raw_json_string, - '-c', 'parse_request_with_meta', - '--verbose', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "--meta", + raw_json_string, + "-c", + "parse_request_with_meta", + "--verbose", + self.url("/html"), + ] + ) self.assertIn("DEBUG: It Works!", _textmode(stderr)) - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '-m', raw_json_string, - '-c', 'parse_request_with_meta', - '--verbose', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "-m", + raw_json_string, + "-c", + "parse_request_with_meta", + "--verbose", + self.url("/html"), + ] + ) self.assertIn("DEBUG: It Works!", _textmode(stderr)) @defer.inlineCallbacks def test_request_with_cb_kwargs(self): raw_json_string = '{"foo" : "bar", "key": "value"}' - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '--cbkwargs', raw_json_string, - '-c', 'parse_request_with_cb_kwargs', - '--verbose', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "--cbkwargs", + raw_json_string, + "-c", + "parse_request_with_cb_kwargs", + "--verbose", + self.url("/html"), + ] + ) self.assertIn("DEBUG: It Works!", _textmode(stderr)) @defer.inlineCallbacks def test_request_without_meta(self): - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '-c', 'parse_request_without_meta', - '--nolinks', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "-c", + "parse_request_without_meta", + "--nolinks", + self.url("/html"), + ] + ) self.assertIn("DEBUG: It Works!", _textmode(stderr)) @defer.inlineCallbacks def test_pipelines(self): - _, _, stderr = yield self.execute(['--spider', self.spider_name, - '--pipelines', - '-c', 'parse', - '--verbose', - self.url('/html')]) + _, _, stderr = yield self.execute( + [ + "--spider", + self.spider_name, + "--pipelines", + "-c", + "parse", + "--verbose", + self.url("/html"), + ] + ) self.assertIn("INFO: It Works!", _textmode(stderr)) @defer.inlineCallbacks def test_asyncio_parse_items(self): status, out, stderr = yield self.execute( - ['--spider', 'asyncdef' + self.spider_name, '-c', 'parse', self.url('/html')] + [ + "--spider", + "asyncdef" + self.spider_name, + "-c", + "parse", + self.url("/html"), + ] ) self.assertIn("""[{}, {'foo': 'bar'}]""", _textmode(out)) @defer.inlineCallbacks def test_parse_items(self): status, out, stderr = yield self.execute( - ['--spider', self.spider_name, '-c', 'parse', self.url('/html')] + ["--spider", self.spider_name, "-c", "parse", self.url("/html")] ) self.assertIn("""[{}, {'foo': 'bar'}]""", _textmode(out)) @defer.inlineCallbacks def test_parse_items_no_callback_passed(self): status, out, stderr = yield self.execute( - ['--spider', self.spider_name, self.url('/html')] + ["--spider", self.spider_name, self.url("/html")] ) self.assertIn("""[{}, {'foo': 'bar'}]""", _textmode(out)) @defer.inlineCallbacks def test_wrong_callback_passed(self): status, out, stderr = yield self.execute( - ['--spider', self.spider_name, '-c', 'dummy', self.url('/html')] + ["--spider", self.spider_name, "-c", "dummy", self.url("/html")] ) self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") self.assertIn("""Cannot find callback""", _textmode(stderr)) @@ -196,7 +250,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} def test_crawlspider_matching_rule_callback_set(self): """If a rule matches the URL, use it's defined callback.""" status, out, stderr = yield self.execute( - ['--spider', 'goodcrawl' + self.spider_name, '-r', self.url('/html')] + ["--spider", "goodcrawl" + self.spider_name, "-r", self.url("/html")] ) self.assertIn("""[{}, {'foo': 'bar'}]""", _textmode(out)) @@ -204,7 +258,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} def test_crawlspider_matching_rule_default_callback(self): """If a rule match but it has no callback set, use the 'parse' callback.""" status, out, stderr = yield self.execute( - ['--spider', 'goodcrawl' + self.spider_name, '-r', self.url('/text')] + ["--spider", "goodcrawl" + self.spider_name, "-r", self.url("/text")] ) self.assertIn("""[{}, {'nomatch': 'default'}]""", _textmode(out)) @@ -212,7 +266,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} def test_spider_with_no_rules_attribute(self): """Using -r with a spider with no rule should not produce items.""" status, out, stderr = yield self.execute( - ['--spider', self.spider_name, '-r', self.url('/html')] + ["--spider", self.spider_name, "-r", self.url("/html")] ) self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") self.assertIn("""No CrawlSpider rules found""", _textmode(stderr)) @@ -220,7 +274,7 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} @defer.inlineCallbacks def test_crawlspider_missing_callback(self): status, out, stderr = yield self.execute( - ['--spider', 'badcrawl' + self.spider_name, '-r', self.url('/html')] + ["--spider", "badcrawl" + self.spider_name, "-r", self.url("/html")] ) self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") @@ -228,14 +282,14 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} def test_crawlspider_no_matching_rule(self): """The requested URL has no matching rule, so no items should be scraped""" status, out, stderr = yield self.execute( - ['--spider', 'badcrawl' + self.spider_name, '-r', self.url('/enc-gb18030')] + ["--spider", "badcrawl" + self.spider_name, "-r", self.url("/enc-gb18030")] ) self.assertRegex(_textmode(out), r"""# Scraped Items -+\n\[\]""") self.assertIn("""Cannot find a rule that matches""", _textmode(stderr)) @defer.inlineCallbacks def test_crawlspider_not_exists_with_not_matched_url(self): - status, out, stderr = yield self.execute([self.url('/invalid_url')]) + status, out, stderr = yield self.execute([self.url("/invalid_url")]) self.assertEqual(status, 0) @defer.inlineCallbacks @@ -243,14 +297,19 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} """Checks if a file was created successfully having correct format containing correct data in it. """ - file_name = 'data.json' + file_name = "data.json" file_path = Path(self.proj_path, file_name) - yield self.execute([ - '--spider', self.spider_name, - '-c', 'parse', - '-o', file_name, - self.url('/html') - ]) + yield self.execute( + [ + "--spider", + self.spider_name, + "-c", + "parse", + "-o", + file_name, + self.url("/html"), + ] + ) self.assertTrue(file_path.exists()) self.assertTrue(file_path.is_file()) @@ -262,12 +321,14 @@ ITEM_PIPELINES = {{'{self.project_name}.pipelines.MyPipeline': 1}} command = parse.Command() command.settings = Settings() parser = argparse.ArgumentParser( - prog='scrapy', formatter_class=argparse.HelpFormatter, - conflict_handler='resolve', prefix_chars='-' + prog="scrapy", + formatter_class=argparse.HelpFormatter, + conflict_handler="resolve", + prefix_chars="-", ) command.add_options(parser) namespace = parser.parse_args( - ['--verbose', '--nolinks', '-d', '2', '--spider', self.spider_name] + ["--verbose", "--nolinks", "-d", "2", "--spider", self.spider_name] ) self.assertTrue(namespace.nolinks) self.assertEqual(namespace.depth, 2) diff --git a/tests/test_command_shell.py b/tests/test_command_shell.py index 33c98ad69..4c4242a1b 100644 --- a/tests/test_command_shell.py +++ b/tests/test_command_shell.py @@ -11,107 +11,118 @@ from tests import tests_datadir, NON_EXISTING_RESOLVABLE class ShellTest(ProcessTest, SiteTest, unittest.TestCase): - command = 'shell' + command = "shell" @defer.inlineCallbacks def test_empty(self): - _, out, _ = yield self.execute(['-c', 'item']) - assert b'{}' in out + _, out, _ = yield self.execute(["-c", "item"]) + assert b"{}" in out @defer.inlineCallbacks def test_response_body(self): - _, out, _ = yield self.execute([self.url('/text'), '-c', 'response.body']) - assert b'Works' in out + _, out, _ = yield self.execute([self.url("/text"), "-c", "response.body"]) + assert b"Works" in out @defer.inlineCallbacks def test_response_type_text(self): - _, out, _ = yield self.execute([self.url('/text'), '-c', 'type(response)']) - assert b'TextResponse' in out + _, out, _ = yield self.execute([self.url("/text"), "-c", "type(response)"]) + assert b"TextResponse" in out @defer.inlineCallbacks def test_response_type_html(self): - _, out, _ = yield self.execute([self.url('/html'), '-c', 'type(response)']) - assert b'HtmlResponse' in out + _, out, _ = yield self.execute([self.url("/html"), "-c", "type(response)"]) + assert b"HtmlResponse" in out @defer.inlineCallbacks def test_response_selector_html(self): - xpath = 'response.xpath("//p[@class=\'one\']/text()").get()' - _, out, _ = yield self.execute([self.url('/html'), '-c', xpath]) - self.assertEqual(out.strip(), b'Works') + xpath = "response.xpath(\"//p[@class='one']/text()\").get()" + _, out, _ = yield self.execute([self.url("/html"), "-c", xpath]) + self.assertEqual(out.strip(), b"Works") @defer.inlineCallbacks def test_response_encoding_gb18030(self): - _, out, _ = yield self.execute([self.url('/enc-gb18030'), '-c', 'response.encoding']) - self.assertEqual(out.strip(), b'gb18030') + _, out, _ = yield self.execute( + [self.url("/enc-gb18030"), "-c", "response.encoding"] + ) + self.assertEqual(out.strip(), b"gb18030") @defer.inlineCallbacks def test_redirect(self): - _, out, _ = yield self.execute([self.url('/redirect'), '-c', 'response.url']) - assert out.strip().endswith(b'/redirected') + _, out, _ = yield self.execute([self.url("/redirect"), "-c", "response.url"]) + assert out.strip().endswith(b"/redirected") @defer.inlineCallbacks def test_redirect_follow_302(self): - _, out, _ = yield self.execute([self.url('/redirect-no-meta-refresh'), '-c', 'response.status']) - assert out.strip().endswith(b'200') + _, out, _ = yield self.execute( + [self.url("/redirect-no-meta-refresh"), "-c", "response.status"] + ) + assert out.strip().endswith(b"200") @defer.inlineCallbacks def test_redirect_not_follow_302(self): _, out, _ = yield self.execute( - ['--no-redirect', self.url('/redirect-no-meta-refresh'), '-c', 'response.status'] + [ + "--no-redirect", + self.url("/redirect-no-meta-refresh"), + "-c", + "response.status", + ] ) - assert out.strip().endswith(b'302') + assert out.strip().endswith(b"302") @defer.inlineCallbacks def test_fetch_redirect_follow_302(self): """Test that calling ``fetch(url)`` follows HTTP redirects by default.""" - url = self.url('/redirect-no-meta-refresh') + url = self.url("/redirect-no-meta-refresh") code = f"fetch('{url}')" - errcode, out, errout = yield self.execute(['-c', code]) + errcode, out, errout = yield self.execute(["-c", code]) self.assertEqual(errcode, 0, out) - assert b'Redirecting (302)' in errout - assert b'Crawled (200)' in errout + assert b"Redirecting (302)" in errout + assert b"Crawled (200)" in errout @defer.inlineCallbacks def test_fetch_redirect_not_follow_302(self): """Test that calling ``fetch(url, redirect=False)`` disables automatic redirects.""" - url = self.url('/redirect-no-meta-refresh') + url = self.url("/redirect-no-meta-refresh") code = f"fetch('{url}', redirect=False)" - errcode, out, errout = yield self.execute(['-c', code]) + errcode, out, errout = yield self.execute(["-c", code]) self.assertEqual(errcode, 0, out) - assert b'Crawled (302)' in errout + assert b"Crawled (302)" in errout @defer.inlineCallbacks def test_request_replace(self): - url = self.url('/text') + url = self.url("/text") code = f"fetch('{url}') or fetch(response.request.replace(method='POST'))" - errcode, out, _ = yield self.execute(['-c', code]) + errcode, out, _ = yield self.execute(["-c", code]) self.assertEqual(errcode, 0, out) @defer.inlineCallbacks def test_scrapy_import(self): - url = self.url('/text') + url = self.url("/text") code = f"fetch(scrapy.Request('{url}'))" - errcode, out, _ = yield self.execute(['-c', code]) + errcode, out, _ = yield self.execute(["-c", code]) self.assertEqual(errcode, 0, out) @defer.inlineCallbacks def test_local_file(self): - filepath = Path(tests_datadir, 'test_site', 'index.html') - _, out, _ = yield self.execute([str(filepath), '-c', 'item']) - assert b'{}' in out + filepath = Path(tests_datadir, "test_site", "index.html") + _, out, _ = yield self.execute([str(filepath), "-c", "item"]) + assert b"{}" in out @defer.inlineCallbacks def test_local_nofile(self): - filepath = 'file:///tests/sample_data/test_site/nothinghere.html' - errcode, out, err = yield self.execute([filepath, '-c', 'item'], check_code=False) + filepath = "file:///tests/sample_data/test_site/nothinghere.html" + errcode, out, err = yield self.execute( + [filepath, "-c", "item"], check_code=False + ) self.assertEqual(errcode, 1, out or err) - self.assertIn(b'No such file or directory', err) + self.assertIn(b"No such file or directory", err) @defer.inlineCallbacks def test_dns_failures(self): if NON_EXISTING_RESOLVABLE: raise unittest.SkipTest("Non-existing hosts are resolvable") - url = 'www.somedomainthatdoesntexi.st' - errcode, out, err = yield self.execute([url, '-c', 'item'], check_code=False) + url = "www.somedomainthatdoesntexi.st" + errcode, out, err = yield self.execute([url, "-c", "item"], check_code=False) self.assertEqual(errcode, 1, out or err) - self.assertIn(b'DNS lookup failed', err) + self.assertIn(b"DNS lookup failed", err) diff --git a/tests/test_command_version.py b/tests/test_command_version.py index 00d998388..f97a088a8 100644 --- a/tests/test_command_version.py +++ b/tests/test_command_version.py @@ -8,11 +8,11 @@ from scrapy.utils.testproc import ProcessTest class VersionTest(ProcessTest, unittest.TestCase): - command = 'version' + command = "version" @defer.inlineCallbacks def test_output(self): - encoding = getattr(sys.stdout, 'encoding') or 'utf-8' + encoding = getattr(sys.stdout, "encoding") or "utf-8" _, out, _ = yield self.execute([]) self.assertEqual( out.strip().decode(encoding), @@ -21,13 +21,25 @@ class VersionTest(ProcessTest, unittest.TestCase): @defer.inlineCallbacks def test_verbose_output(self): - encoding = getattr(sys.stdout, 'encoding') or 'utf-8' - _, out, _ = yield self.execute(['-v']) + encoding = getattr(sys.stdout, "encoding") or "utf-8" + _, out, _ = yield self.execute(["-v"]) headers = [ line.partition(":")[0].strip() for line in out.strip().decode(encoding).splitlines() ] - self.assertEqual(headers, ['Scrapy', 'lxml', 'libxml2', - 'cssselect', 'parsel', 'w3lib', - 'Twisted', 'Python', 'pyOpenSSL', - 'cryptography', 'Platform']) + self.assertEqual( + headers, + [ + "Scrapy", + "lxml", + "libxml2", + "cssselect", + "parsel", + "w3lib", + "Twisted", + "Python", + "pyOpenSSL", + "cryptography", + "Platform", + ], + ) diff --git a/tests/test_commands.py b/tests/test_commands.py index 91476abf8..ed0eb85f5 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -33,35 +33,46 @@ from tests.test_crawler import ExceptionSpider, NoRequestsSpider class CommandSettings(unittest.TestCase): - def setUp(self): self.command = ScrapyCommand() self.command.settings = Settings() - self.parser = argparse.ArgumentParser(formatter_class=ScrapyHelpFormatter, - conflict_handler='resolve') + self.parser = argparse.ArgumentParser( + formatter_class=ScrapyHelpFormatter, conflict_handler="resolve" + ) self.command.add_options(self.parser) def test_settings_json_string(self): feeds_json = '{"data.json": {"format": "json"}, "data.xml": {"format": "xml"}}' - opts, args = self.parser.parse_known_args(args=['-s', f'FEEDS={feeds_json}', 'spider.py']) + opts, args = self.parser.parse_known_args( + args=["-s", f"FEEDS={feeds_json}", "spider.py"] + ) self.command.process_options(args, opts) - self.assertIsInstance(self.command.settings['FEEDS'], scrapy.settings.BaseSettings) - self.assertEqual(dict(self.command.settings['FEEDS']), json.loads(feeds_json)) + self.assertIsInstance( + self.command.settings["FEEDS"], scrapy.settings.BaseSettings + ) + self.assertEqual(dict(self.command.settings["FEEDS"]), json.loads(feeds_json)) def test_help_formatter(self): - formatter = ScrapyHelpFormatter(prog='scrapy') - part_strings = ['usage: scrapy genspider [options] \n\n', - '\n', 'optional arguments:\n', '\n', 'Global Options:\n'] + formatter = ScrapyHelpFormatter(prog="scrapy") + part_strings = [ + "usage: scrapy genspider [options] \n\n", + "\n", + "optional arguments:\n", + "\n", + "Global Options:\n", + ] self.assertEqual( formatter._join_parts(part_strings), - ('Usage\n=====\n scrapy genspider [options] \n\n\n' - 'Optional Arguments\n==================\n\n' - 'Global Options\n--------------\n') + ( + "Usage\n=====\n scrapy genspider [options] \n\n\n" + "Optional Arguments\n==================\n\n" + "Global Options\n--------------\n" + ), ) class ProjectTest(unittest.TestCase): - project_name = 'testproject' + project_name = "testproject" def setUp(self): self.temp_path = mkdtemp() @@ -75,15 +86,16 @@ class ProjectTest(unittest.TestCase): def call(self, *new_args, **kwargs): with tempfile.TemporaryFile() as out: - args = (sys.executable, '-m', 'scrapy.cmdline') + new_args - return subprocess.call(args, stdout=out, stderr=out, cwd=self.cwd, - env=self.env, **kwargs) + args = (sys.executable, "-m", "scrapy.cmdline") + new_args + return subprocess.call( + args, stdout=out, stderr=out, cwd=self.cwd, env=self.env, **kwargs + ) def proc(self, *new_args, **popen_kwargs): - args = (sys.executable, '-m', 'scrapy.cmdline') + new_args + args = (sys.executable, "-m", "scrapy.cmdline") + new_args p = subprocess.Popen( args, - cwd=popen_kwargs.pop('cwd', self.cwd), + cwd=popen_kwargs.pop("cwd", self.cwd), env=self.env, stdout=subprocess.PIPE, stderr=subprocess.PIPE, @@ -93,7 +105,7 @@ class ProjectTest(unittest.TestCase): def kill_proc(): p.kill() p.communicate() - assert False, 'Command took too much time to complete' + assert False, "Command took too much time to complete" timer = Timer(15, kill_proc) try: @@ -104,7 +116,9 @@ class ProjectTest(unittest.TestCase): return p, to_unicode(stdout), to_unicode(stderr) - def find_in_file(self, filename: Union[str, os.PathLike], regex) -> Optional[re.Match]: + def find_in_file( + self, filename: Union[str, os.PathLike], regex + ) -> Optional[re.Match]: """Find first pattern occurrence in file""" pattern = re.compile(regex) with Path(filename).open("r", encoding="utf-8") as f: @@ -116,68 +130,75 @@ class ProjectTest(unittest.TestCase): class StartprojectTest(ProjectTest): - def test_startproject(self): - p, out, err = self.proc('startproject', self.project_name) + p, out, err = self.proc("startproject", self.project_name) print(out) print(err, file=sys.stderr) self.assertEqual(p.returncode, 0) - assert Path(self.proj_path, 'scrapy.cfg').exists() - assert Path(self.proj_path, 'testproject').exists() - assert Path(self.proj_mod_path, '__init__.py').exists() - assert Path(self.proj_mod_path, 'items.py').exists() - assert Path(self.proj_mod_path, 'pipelines.py').exists() - assert Path(self.proj_mod_path, 'settings.py').exists() - assert Path(self.proj_mod_path, 'spiders', '__init__.py').exists() + assert Path(self.proj_path, "scrapy.cfg").exists() + assert Path(self.proj_path, "testproject").exists() + assert Path(self.proj_mod_path, "__init__.py").exists() + assert Path(self.proj_mod_path, "items.py").exists() + assert Path(self.proj_mod_path, "pipelines.py").exists() + assert Path(self.proj_mod_path, "settings.py").exists() + assert Path(self.proj_mod_path, "spiders", "__init__.py").exists() - self.assertEqual(1, self.call('startproject', self.project_name)) - self.assertEqual(1, self.call('startproject', 'wrong---project---name')) - self.assertEqual(1, self.call('startproject', 'sys')) + self.assertEqual(1, self.call("startproject", self.project_name)) + self.assertEqual(1, self.call("startproject", "wrong---project---name")) + self.assertEqual(1, self.call("startproject", "sys")) def test_startproject_with_project_dir(self): project_dir = mkdtemp() - self.assertEqual(0, self.call('startproject', self.project_name, project_dir)) + self.assertEqual(0, self.call("startproject", self.project_name, project_dir)) - assert Path(project_dir, 'scrapy.cfg').exists() - assert Path(project_dir, 'testproject').exists() - assert Path(project_dir, self.project_name, '__init__.py').exists() - assert Path(project_dir, self.project_name, 'items.py').exists() - assert Path(project_dir, self.project_name, 'pipelines.py').exists() - assert Path(project_dir, self.project_name, 'settings.py').exists() - assert Path(project_dir, self.project_name, 'spiders', '__init__.py').exists() + assert Path(project_dir, "scrapy.cfg").exists() + assert Path(project_dir, "testproject").exists() + assert Path(project_dir, self.project_name, "__init__.py").exists() + assert Path(project_dir, self.project_name, "items.py").exists() + assert Path(project_dir, self.project_name, "pipelines.py").exists() + assert Path(project_dir, self.project_name, "settings.py").exists() + assert Path(project_dir, self.project_name, "spiders", "__init__.py").exists() - self.assertEqual(0, self.call('startproject', self.project_name, project_dir + '2')) + self.assertEqual( + 0, self.call("startproject", self.project_name, project_dir + "2") + ) - self.assertEqual(1, self.call('startproject', self.project_name, project_dir)) - self.assertEqual(1, self.call('startproject', self.project_name + '2', project_dir)) - self.assertEqual(1, self.call('startproject', 'wrong---project---name')) - self.assertEqual(1, self.call('startproject', 'sys')) - self.assertEqual(2, self.call('startproject')) - self.assertEqual(2, self.call('startproject', self.project_name, project_dir, 'another_params')) + self.assertEqual(1, self.call("startproject", self.project_name, project_dir)) + self.assertEqual( + 1, self.call("startproject", self.project_name + "2", project_dir) + ) + self.assertEqual(1, self.call("startproject", "wrong---project---name")) + self.assertEqual(1, self.call("startproject", "sys")) + self.assertEqual(2, self.call("startproject")) + self.assertEqual( + 2, + self.call("startproject", self.project_name, project_dir, "another_params"), + ) def test_existing_project_dir(self): project_dir = mkdtemp() - project_name = self.project_name + '_existing' + project_name = self.project_name + "_existing" project_path = Path(project_dir, project_name) project_path.mkdir() - p, out, err = self.proc('startproject', project_name, cwd=project_dir) + p, out, err = self.proc("startproject", project_name, cwd=project_dir) print(out) print(err, file=sys.stderr) self.assertEqual(p.returncode, 0) - assert Path(project_path, 'scrapy.cfg').exists() + assert Path(project_path, "scrapy.cfg").exists() assert Path(project_path, project_name).exists() - assert Path(project_path, project_name, '__init__.py').exists() - assert Path(project_path, project_name, 'items.py').exists() - assert Path(project_path, project_name, 'pipelines.py').exists() - assert Path(project_path, project_name, 'settings.py').exists() - assert Path(project_path, project_name, 'spiders', '__init__.py').exists() + assert Path(project_path, project_name, "__init__.py").exists() + assert Path(project_path, project_name, "items.py").exists() + assert Path(project_path, project_name, "pipelines.py").exists() + assert Path(project_path, project_name, "settings.py").exists() + assert Path(project_path, project_name, "spiders", "__init__.py").exists() -def get_permissions_dict(path: Union[str, os.PathLike], renamings=None, ignore=None) -> Dict[str, str]: - +def get_permissions_dict( + path: Union[str, os.PathLike], renamings=None, ignore=None +) -> Dict[str, str]: def get_permissions(path: Path) -> str: return oct(path.stat().st_mode) @@ -185,7 +206,7 @@ def get_permissions_dict(path: Union[str, os.PathLike], renamings=None, ignore=N renamings = renamings or tuple() permissions_dict = { - '.': get_permissions(path_obj), + ".": get_permissions(path_obj), } for root, dirs, files in os.walk(path_obj): nodes = list(chain(dirs, files)) @@ -196,10 +217,7 @@ def get_permissions_dict(path: Union[str, os.PathLike], renamings=None, ignore=N absolute_path = Path(root, node) relative_path = str(absolute_path.relative_to(path)) for search_string, replacement in renamings: - relative_path = relative_path.replace( - search_string, - replacement - ) + relative_path = relative_path.replace(search_string, replacement) permissions = get_permissions(absolute_path) permissions_dict[relative_path] = permissions return permissions_dict @@ -211,31 +229,33 @@ class StartprojectTemplatesTest(ProjectTest): def setUp(self): super().setUp() - self.tmpl = str(Path(self.temp_path, 'templates')) - self.tmpl_proj = str(Path(self.tmpl, 'project')) + self.tmpl = str(Path(self.temp_path, "templates")) + self.tmpl_proj = str(Path(self.tmpl, "project")) def test_startproject_template_override(self): - copytree(Path(scrapy.__path__[0], 'templates'), self.tmpl) - Path(self.tmpl_proj, 'root_template').write_bytes(b"") - assert Path(self.tmpl_proj, 'root_template').exists() + copytree(Path(scrapy.__path__[0], "templates"), self.tmpl) + Path(self.tmpl_proj, "root_template").write_bytes(b"") + assert Path(self.tmpl_proj, "root_template").exists() - args = ['--set', f'TEMPLATES_DIR={self.tmpl}'] - p, out, err = self.proc('startproject', self.project_name, *args) - self.assertIn(f"New Scrapy project '{self.project_name}', " - "using template directory", out) + args = ["--set", f"TEMPLATES_DIR={self.tmpl}"] + p, out, err = self.proc("startproject", self.project_name, *args) + self.assertIn( + f"New Scrapy project '{self.project_name}', " "using template directory", + out, + ) self.assertIn(self.tmpl_proj, out) - assert Path(self.proj_path, 'root_template').exists() + assert Path(self.proj_path, "root_template").exists() def test_startproject_permissions_from_writable(self): """Check that generated files have the right permissions when the template folder has the same permissions as in the project, i.e. everything is writable.""" scrapy_path = scrapy.__path__[0] - project_template = Path(scrapy_path, 'templates', 'project') - project_name = 'startproject1' + project_template = Path(scrapy_path, "templates", "project") + project_name = "startproject1" renamings = ( - ('module', project_name), - ('.tmpl', ''), + ("module", project_name), + (".tmpl", ""), ) expected_permissions = get_permissions_dict( project_template, @@ -247,9 +267,9 @@ class StartprojectTemplatesTest(ProjectTest): process = subprocess.Popen( ( sys.executable, - '-m', - 'scrapy.cmdline', - 'startproject', + "-m", + "scrapy.cmdline", + "startproject", project_name, ), cwd=destination, @@ -270,12 +290,12 @@ class StartprojectTemplatesTest(ProjectTest): See https://github.com/scrapy/scrapy/pull/4604 """ scrapy_path = scrapy.__path__[0] - templates_dir = Path(scrapy_path, 'templates') - project_template = Path(templates_dir, 'project') - project_name = 'startproject2' + templates_dir = Path(scrapy_path, "templates") + project_template = Path(templates_dir, "project") + project_name = "startproject2" renamings = ( - ('module', project_name), - ('.tmpl', ''), + ("module", project_name), + (".tmpl", ""), ) expected_permissions = get_permissions_dict( project_template, @@ -287,7 +307,7 @@ class StartprojectTemplatesTest(ProjectTest): current_permissions = path.stat().st_mode path.chmod(current_permissions & ~ANYONE_WRITE_PERMISSION) - read_only_templates_dir = str(Path(mkdtemp()) / 'templates') + read_only_templates_dir = str(Path(mkdtemp()) / "templates") copytree(templates_dir, read_only_templates_dir) for root, dirs, files in os.walk(read_only_templates_dir): @@ -298,12 +318,12 @@ class StartprojectTemplatesTest(ProjectTest): process = subprocess.Popen( ( sys.executable, - '-m', - 'scrapy.cmdline', - 'startproject', + "-m", + "scrapy.cmdline", + "startproject", project_name, - '--set', - f'TEMPLATES_DIR={read_only_templates_dir}', + "--set", + f"TEMPLATES_DIR={read_only_templates_dir}", ), cwd=destination, env=self.env, @@ -319,11 +339,11 @@ class StartprojectTemplatesTest(ProjectTest): """Check that pre-existing folders and files in the destination folder do not see their permissions modified.""" scrapy_path = scrapy.__path__[0] - project_template = Path(scrapy_path, 'templates', 'project') - project_name = 'startproject3' + project_template = Path(scrapy_path, "templates", "project") + project_name = "startproject3" renamings = ( - ('module', project_name), - ('.tmpl', ''), + ("module", project_name), + (".tmpl", ""), ) expected_permissions = get_permissions_dict( project_template, @@ -336,15 +356,20 @@ class StartprojectTemplatesTest(ProjectTest): existing_nodes = { oct(permissions)[2:] + extension: permissions - for extension in ('', '.d') + for extension in ("", ".d") for permissions in ( - 0o444, 0o555, 0o644, 0o666, 0o755, 0o777, + 0o444, + 0o555, + 0o644, + 0o666, + 0o755, + 0o777, ) } project_dir.mkdir() for node, permissions in existing_nodes.items(): path = project_dir / node - if node.endswith('.d'): + if node.endswith(".d"): path.mkdir(mode=permissions) else: path.touch(mode=permissions) @@ -353,11 +378,11 @@ class StartprojectTemplatesTest(ProjectTest): process = subprocess.Popen( ( sys.executable, - '-m', - 'scrapy.cmdline', - 'startproject', + "-m", + "scrapy.cmdline", + "startproject", project_name, - '.', + ".", ), cwd=project_dir, env=self.env, @@ -372,6 +397,7 @@ class StartprojectTemplatesTest(ProjectTest): """Check that generated files have the right permissions when the system uses a umask value that causes new files to have different permissions than those from the template folder.""" + @contextmanager def umask(new_mask): cur_mask = os.umask(new_mask) @@ -379,15 +405,11 @@ class StartprojectTemplatesTest(ProjectTest): os.umask(cur_mask) scrapy_path = scrapy.__path__[0] - project_template = Path( - scrapy_path, - 'templates', - 'project' - ) - project_name = 'umaskproject' + project_template = Path(scrapy_path, "templates", "project") + project_name = "umaskproject" renamings = ( - ('module', project_name), - ('.tmpl', ''), + ("module", project_name), + (".tmpl", ""), ) expected_permissions = get_permissions_dict( project_template, @@ -400,9 +422,9 @@ class StartprojectTemplatesTest(ProjectTest): process = subprocess.Popen( ( sys.executable, - '-m', - 'scrapy.cmdline', - 'startproject', + "-m", + "scrapy.cmdline", + "startproject", project_name, ), cwd=destination, @@ -417,67 +439,74 @@ class StartprojectTemplatesTest(ProjectTest): class CommandTest(ProjectTest): - def setUp(self): super().setUp() - self.call('startproject', self.project_name) + self.call("startproject", self.project_name) self.cwd = Path(self.temp_path, self.project_name) - self.env['SCRAPY_SETTINGS_MODULE'] = f'{self.project_name}.settings' + self.env["SCRAPY_SETTINGS_MODULE"] = f"{self.project_name}.settings" class GenspiderCommandTest(CommandTest): - def test_arguments(self): # only pass one argument. spider script shouldn't be created - self.assertEqual(2, self.call('genspider', 'test_name')) - assert not Path(self.proj_mod_path, 'spiders', 'test_name.py').exists() + self.assertEqual(2, self.call("genspider", "test_name")) + assert not Path(self.proj_mod_path, "spiders", "test_name.py").exists() # pass two arguments . spider script should be created - self.assertEqual(0, self.call('genspider', 'test_name', 'test.com')) - assert Path(self.proj_mod_path, 'spiders', 'test_name.py').exists() + self.assertEqual(0, self.call("genspider", "test_name", "test.com")) + assert Path(self.proj_mod_path, "spiders", "test_name.py").exists() - def test_template(self, tplname='crawl'): - args = [f'--template={tplname}'] if tplname else [] - spname = 'test_spider' + def test_template(self, tplname="crawl"): + args = [f"--template={tplname}"] if tplname else [] + spname = "test_spider" spmodule = f"{self.project_name}.spiders.{spname}" - p, out, err = self.proc('genspider', spname, 'test.com', *args) - self.assertIn(f"Created spider {spname!r} using template {tplname!r} in module:{os.linesep} {spmodule}", out) - self.assertTrue(Path(self.proj_mod_path, 'spiders', 'test_spider.py').exists()) - modify_time_before = Path(self.proj_mod_path, 'spiders', 'test_spider.py').stat().st_mtime - p, out, err = self.proc('genspider', spname, 'test.com', *args) + p, out, err = self.proc("genspider", spname, "test.com", *args) + self.assertIn( + f"Created spider {spname!r} using template {tplname!r} in module:{os.linesep} {spmodule}", + out, + ) + self.assertTrue(Path(self.proj_mod_path, "spiders", "test_spider.py").exists()) + modify_time_before = ( + Path(self.proj_mod_path, "spiders", "test_spider.py").stat().st_mtime + ) + p, out, err = self.proc("genspider", spname, "test.com", *args) self.assertIn(f"Spider {spname!r} already exists in module", out) - modify_time_after = Path(self.proj_mod_path, 'spiders', 'test_spider.py').stat().st_mtime + modify_time_after = ( + Path(self.proj_mod_path, "spiders", "test_spider.py").stat().st_mtime + ) self.assertEqual(modify_time_after, modify_time_before) def test_template_basic(self): - self.test_template('basic') + self.test_template("basic") def test_template_csvfeed(self): - self.test_template('csvfeed') + self.test_template("csvfeed") def test_template_xmlfeed(self): - self.test_template('xmlfeed') + self.test_template("xmlfeed") def test_list(self): - self.assertEqual(0, self.call('genspider', '--list')) + self.assertEqual(0, self.call("genspider", "--list")) def test_dump(self): - self.assertEqual(0, self.call('genspider', '--dump=basic')) - self.assertEqual(0, self.call('genspider', '-d', 'basic')) + self.assertEqual(0, self.call("genspider", "--dump=basic")) + self.assertEqual(0, self.call("genspider", "-d", "basic")) def test_same_name_as_project(self): - self.assertEqual(2, self.call('genspider', self.project_name)) - assert not Path(self.proj_mod_path, 'spiders', f'{self.project_name}.py').exists() + self.assertEqual(2, self.call("genspider", self.project_name)) + assert not Path( + self.proj_mod_path, "spiders", f"{self.project_name}.py" + ).exists() def test_same_filename_as_existing_spider(self, force=False): - file_name = 'example' - file_path = Path(self.proj_mod_path, 'spiders', f'{file_name}.py') - self.assertEqual(0, self.call('genspider', file_name, 'example.com')) + file_name = "example" + file_path = Path(self.proj_mod_path, "spiders", f"{file_name}.py") + self.assertEqual(0, self.call("genspider", file_name, "example.com")) assert file_path.exists() # change name of spider but not its file name - with file_path.open('r+', encoding="utf-8") as spider_file: + with file_path.open("r+", encoding="utf-8") as spider_file: file_data = spider_file.read() - file_data = file_data.replace("name = \'example\'", "name = \'renamed\'") + file_data = file_data.replace("name = 'example'", "name = 'renamed'") spider_file.seek(0) spider_file.write(file_data) spider_file.truncate() @@ -485,14 +514,16 @@ class GenspiderCommandTest(CommandTest): file_contents_before = file_data if force: - p, out, err = self.proc('genspider', '--force', file_name, 'example.com') - self.assertIn(f"Created spider {file_name!r} using template \'basic\' in module", out) + p, out, err = self.proc("genspider", "--force", file_name, "example.com") + self.assertIn( + f"Created spider {file_name!r} using template 'basic' in module", out + ) modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) file_contents_after = file_path.read_text(encoding="utf-8") self.assertNotEqual(file_contents_after, file_contents_before) else: - p, out, err = self.proc('genspider', file_name, 'example.com') + p, out, err = self.proc("genspider", file_name, "example.com") self.assertIn(f"{file_path.resolve()} already exists", out) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) @@ -502,53 +533,63 @@ class GenspiderCommandTest(CommandTest): def test_same_filename_as_existing_spider_force(self): self.test_same_filename_as_existing_spider(force=True) - def test_url(self, url='test.com', domain="test.com"): - self.assertEqual(0, self.call('genspider', '--force', 'test_name', url)) - self.assertEqual(domain, - self.find_in_file(Path(self.proj_mod_path, - 'spiders', 'test_name.py'), - r'allowed_domains\s*=\s*\[\'(.+)\'\]').group(1)) - self.assertEqual(f'http://{domain}/', - self.find_in_file(Path(self.proj_mod_path, - 'spiders', 'test_name.py'), - r'start_urls\s*=\s*\[\'(.+)\'\]').group(1)) + def test_url(self, url="test.com", domain="test.com"): + self.assertEqual(0, self.call("genspider", "--force", "test_name", url)) + self.assertEqual( + domain, + self.find_in_file( + Path(self.proj_mod_path, "spiders", "test_name.py"), + r"allowed_domains\s*=\s*\[\'(.+)\'\]", + ).group(1), + ) + self.assertEqual( + f"http://{domain}/", + self.find_in_file( + Path(self.proj_mod_path, "spiders", "test_name.py"), + r"start_urls\s*=\s*\[\'(.+)\'\]", + ).group(1), + ) def test_url_schema(self): - self.test_url('http://test.com', 'test.com') + self.test_url("http://test.com", "test.com") def test_url_path(self): - self.test_url('test.com/some/other/page', 'test.com') + self.test_url("test.com/some/other/page", "test.com") def test_url_schema_path(self): - self.test_url('https://test.com/some/other/page', 'test.com') + self.test_url("https://test.com/some/other/page", "test.com") class GenspiderStandaloneCommandTest(ProjectTest): - def test_generate_standalone_spider(self): - self.call('genspider', 'example', 'example.com') - assert Path(self.temp_path, 'example.py').exists() + self.call("genspider", "example", "example.com") + assert Path(self.temp_path, "example.py").exists() def test_same_name_as_existing_file(self, force=False): - file_name = 'example' - file_path = Path(self.temp_path, file_name + '.py') - p, out, err = self.proc('genspider', file_name, 'example.com') - self.assertIn(f"Created spider {file_name!r} using template \'basic\' ", out) + file_name = "example" + file_path = Path(self.temp_path, file_name + ".py") + p, out, err = self.proc("genspider", file_name, "example.com") + self.assertIn(f"Created spider {file_name!r} using template 'basic' ", out) assert file_path.exists() modify_time_before = file_path.stat().st_mtime file_contents_before = file_path.read_text(encoding="utf-8") if force: # use different template to ensure contents were changed - p, out, err = self.proc('genspider', '--force', '-t', 'crawl', file_name, 'example.com') - self.assertIn(f"Created spider {file_name!r} using template \'crawl\' ", out) + p, out, err = self.proc( + "genspider", "--force", "-t", "crawl", file_name, "example.com" + ) + self.assertIn(f"Created spider {file_name!r} using template 'crawl' ", out) modify_time_after = file_path.stat().st_mtime self.assertNotEqual(modify_time_after, modify_time_before) file_contents_after = file_path.read_text(encoding="utf-8") self.assertNotEqual(file_contents_after, file_contents_before) else: - p, out, err = self.proc('genspider', file_name, 'example.com') - self.assertIn(f"{Path(self.temp_path, file_name + '.py').resolve()} already exists", out) + p, out, err = self.proc("genspider", file_name, "example.com") + self.assertIn( + f"{Path(self.temp_path, file_name + '.py').resolve()} already exists", + out, + ) modify_time_after = file_path.stat().st_mtime self.assertEqual(modify_time_after, modify_time_before) file_contents_after = file_path.read_text(encoding="utf-8") @@ -559,14 +600,13 @@ class GenspiderStandaloneCommandTest(ProjectTest): class MiscCommandsTest(CommandTest): - def test_list(self): - self.assertEqual(0, self.call('list')) + self.assertEqual(0, self.call("list")) class RunSpiderCommandTest(CommandTest): - spider_filename = 'myspider.py' + spider_filename = "myspider.py" debug_log_spider = """ import scrapy @@ -604,7 +644,7 @@ class BadSpider(scrapy.Spider): def runspider(self, code, name=None, args=()): with self._create_file(code, name) as fname: - return self.proc('runspider', fname, *args) + return self.proc("runspider", fname, *args) def get_log(self, code, name=None, args=()): p, stdout, stderr = self.runspider(code, name, args=args) @@ -618,18 +658,21 @@ class BadSpider(scrapy.Spider): self.assertIn("INFO: Spider closed (finished)", log) def test_run_fail_spider(self): - proc, _, _ = self.runspider("import scrapy\n" + inspect.getsource(ExceptionSpider)) + proc, _, _ = self.runspider( + "import scrapy\n" + inspect.getsource(ExceptionSpider) + ) ret = proc.returncode self.assertNotEqual(ret, 0) def test_run_good_spider(self): - proc, _, _ = self.runspider("import scrapy\n" + inspect.getsource(NoRequestsSpider)) + proc, _, _ = self.runspider( + "import scrapy\n" + inspect.getsource(NoRequestsSpider) + ) ret = proc.returncode self.assertEqual(ret, 0) def test_runspider_log_level(self): - log = self.get_log(self.debug_log_spider, - args=('-s', 'LOG_LEVEL=INFO')) + log = self.get_log(self.debug_log_spider, args=("-s", "LOG_LEVEL=INFO")) self.assertNotIn("DEBUG: It Works!", log) self.assertIn("INFO: Spider opened", log) @@ -649,19 +692,17 @@ class MySpider(scrapy.Spider): def parse(self, response): return {'test': 'value'} """ - log = self.get_log(dnscache_spider, args=('-s', 'DNSCACHE_ENABLED=False')) + log = self.get_log(dnscache_spider, args=("-s", "DNSCACHE_ENABLED=False")) self.assertNotIn("DNSLookupError", log) self.assertIn("INFO: Spider opened", log) def test_runspider_log_short_names(self): - log1 = self.get_log(self.debug_log_spider, - args=('-s', 'LOG_SHORT_NAMES=1')) + log1 = self.get_log(self.debug_log_spider, args=("-s", "LOG_SHORT_NAMES=1")) self.assertIn("[myspider] DEBUG: It Works!", log1) self.assertIn("[scrapy]", log1) self.assertNotIn("[scrapy.core.engine]", log1) - log2 = self.get_log(self.debug_log_spider, - args=('-s', 'LOG_SHORT_NAMES=0')) + log2 = self.get_log(self.debug_log_spider, args=("-s", "LOG_SHORT_NAMES=0")) self.assertIn("[myspider] DEBUG: It Works!", log2) self.assertNotIn("[scrapy]", log2) self.assertIn("[scrapy.core.engine]", log2) @@ -671,57 +712,89 @@ class MySpider(scrapy.Spider): self.assertIn("No spider found in file", log) def test_runspider_file_not_found(self): - _, _, log = self.proc('runspider', 'some_non_existent_file') + _, _, log = self.proc("runspider", "some_non_existent_file") self.assertIn("File not found: some_non_existent_file", log) def test_runspider_unable_to_load(self): - log = self.get_log('', name='myspider.txt') - self.assertIn('Unable to load', log) + log = self.get_log("", name="myspider.txt") + self.assertIn("Unable to load", log) def test_start_requests_errors(self): - log = self.get_log(self.badspider, name='badspider.py') + log = self.get_log(self.badspider, name="badspider.py") self.assertIn("start_requests", log) self.assertIn("badspider.py", log) def test_asyncio_enabled_true(self): - log = self.get_log(self.debug_log_spider, args=[ - '-s', 'TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor' - ]) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.get_log( + self.debug_log_spider, + args=[ + "-s", + "TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor", + ], + ) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_asyncio_enabled_default(self): log = self.get_log(self.debug_log_spider, args=[]) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_asyncio_enabled_false(self): - log = self.get_log(self.debug_log_spider, args=[ - '-s', 'TWISTED_REACTOR=twisted.internet.selectreactor.SelectReactor' - ]) - self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) - self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.get_log( + self.debug_log_spider, + args=["-s", "TWISTED_REACTOR=twisted.internet.selectreactor.SelectReactor"], + ) + self.assertIn( + "Using reactor: twisted.internet.selectreactor.SelectReactor", log + ) + self.assertNotIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) - @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') - @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') - @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + @mark.skipif( + sys.implementation.name == "pypy", + reason="uvloop does not support pypy properly", + ) + @mark.skipif( + platform.system() == "Windows", reason="uvloop does not support Windows" + ) + @mark.skipif( + twisted_version == Version("twisted", 21, 2, 0), + reason="https://twistedmatrix.com/trac/ticket/10106", + ) def test_custom_asyncio_loop_enabled_true(self): - log = self.get_log(self.debug_log_spider, args=[ - '-s', - 'TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor', - '-s', - 'ASYNCIO_EVENT_LOOP=uvloop.Loop', - ]) + log = self.get_log( + self.debug_log_spider, + args=[ + "-s", + "TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "-s", + "ASYNCIO_EVENT_LOOP=uvloop.Loop", + ], + ) self.assertIn("Using asyncio event loop: uvloop.Loop", log) def test_custom_asyncio_loop_enabled_false(self): - log = self.get_log(self.debug_log_spider, args=[ - '-s', 'TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor' - ]) + log = self.get_log( + self.debug_log_spider, + args=[ + "-s", + "TWISTED_REACTOR=twisted.internet.asyncioreactor.AsyncioSelectorReactor", + ], + ) import asyncio - if sys.platform != 'win32': + + if sys.platform != "win32": loop = asyncio.new_event_loop() else: loop = asyncio.SelectorEventLoop() - self.assertIn(f"Using asyncio event loop: {loop.__module__}.{loop.__class__.__name__}", log) + self.assertIn( + f"Using asyncio event loop: {loop.__module__}.{loop.__class__.__name__}", + log, + ) def test_output(self): spider_code = """ @@ -734,9 +807,11 @@ class MySpider(scrapy.Spider): self.logger.debug('FEEDS: {}'.format(self.settings.getdict('FEEDS'))) return [] """ - args = ['-o', 'example.json'] + args = ["-o", "example.json"] log = self.get_log(spider_code, args=args) - self.assertIn("[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}", log) + self.assertIn( + "[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}", log + ) def test_overwrite_output(self): spider_code = """ @@ -755,9 +830,12 @@ class MySpider(scrapy.Spider): return [] """ Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") - args = ['-O', 'example.json'] + args = ["-O", "example.json"] log = self.get_log(spider_code, args=args) - self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) + self.assertIn( + '[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', + log, + ) with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") @@ -772,9 +850,11 @@ class MySpider(scrapy.Spider): def start_requests(self): return [] """ - args = ['-o', 'example1.json', '-O', 'example2.json'] + args = ["-o", "example1.json", "-O", "example2.json"] log = self.get_log(spider_code, args=args) - self.assertIn("error: Please use only one of -o/--output and -O/--overwrite-output", log) + self.assertIn( + "error: Please use only one of -o/--output and -O/--overwrite-output", log + ) def test_output_stdout(self): spider_code = """ @@ -787,21 +867,21 @@ class MySpider(scrapy.Spider): self.logger.debug('FEEDS: {}'.format(self.settings.getdict('FEEDS'))) return [] """ - args = ['-o', '-:json'] + args = ["-o", "-:json"] log = self.get_log(spider_code, args=args) self.assertIn("[myspider] DEBUG: FEEDS: {'stdout:': {'format': 'json'}}", log) -@skipIf(platform.system() != 'Windows', "Windows required for .pyw files") +@skipIf(platform.system() != "Windows", "Windows required for .pyw files") class WindowsRunSpiderCommandTest(RunSpiderCommandTest): - spider_filename = 'myspider.pyw' + spider_filename = "myspider.pyw" def setUp(self): super().setUp() def test_start_requests_errors(self): - log = self.get_log(self.badspider, name='badspider.pyw') + log = self.get_log(self.badspider, name="badspider.pyw") self.assertIn("start_requests", log) self.assertIn("badspider.pyw", log) @@ -834,34 +914,37 @@ class WindowsRunSpiderCommandTest(RunSpiderCommandTest): class BenchCommandTest(CommandTest): - def test_run(self): - _, _, log = self.proc('bench', '-s', 'LOGSTATS_INTERVAL=0.001', - '-s', 'CLOSESPIDER_TIMEOUT=0.01') - self.assertIn('INFO: Crawled', log) - self.assertNotIn('Unhandled Error', log) + _, _, log = self.proc( + "bench", "-s", "LOGSTATS_INTERVAL=0.001", "-s", "CLOSESPIDER_TIMEOUT=0.01" + ) + self.assertIn("INFO: Crawled", log) + self.assertNotIn("Unhandled Error", log) class ViewCommandTest(CommandTest): - def test_methods(self): command = view.Command() command.settings = Settings() - parser = argparse.ArgumentParser(prog='scrapy', prefix_chars='-', - formatter_class=ScrapyHelpFormatter, - conflict_handler='resolve') + parser = argparse.ArgumentParser( + prog="scrapy", + prefix_chars="-", + formatter_class=ScrapyHelpFormatter, + conflict_handler="resolve", + ) command.add_options(parser) - self.assertEqual(command.short_desc(), - "Open URL in browser, as seen by Scrapy") - self.assertIn("URL using the Scrapy downloader and show its", - command.long_desc()) + self.assertEqual(command.short_desc(), "Open URL in browser, as seen by Scrapy") + self.assertIn( + "URL using the Scrapy downloader and show its", command.long_desc() + ) class CrawlCommandTest(CommandTest): - def crawl(self, code, args=()): - Path(self.proj_mod_path, 'spiders', 'myspider.py').write_text(code, encoding="utf-8") - return self.proc('crawl', 'myspider', *args) + Path(self.proj_mod_path, "spiders", "myspider.py").write_text( + code, encoding="utf-8" + ) + return self.proc("crawl", "myspider", *args) def get_log(self, code, args=()): _, _, stderr = self.crawl(code, args=args) @@ -892,9 +975,11 @@ class MySpider(scrapy.Spider): self.logger.debug('FEEDS: {}'.format(self.settings.getdict('FEEDS'))) return [] """ - args = ['-o', 'example.json'] + args = ["-o", "example.json"] log = self.get_log(spider_code, args=args) - self.assertIn("[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}", log) + self.assertIn( + "[myspider] DEBUG: FEEDS: {'example.json': {'format': 'json'}}", log + ) def test_overwrite_output(self): spider_code = """ @@ -913,9 +998,12 @@ class MySpider(scrapy.Spider): return [] """ Path(self.cwd, "example.json").write_text("not empty", encoding="utf-8") - args = ['-O', 'example.json'] + args = ["-O", "example.json"] log = self.get_log(spider_code, args=args) - self.assertIn('[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', log) + self.assertIn( + '[myspider] DEBUG: FEEDS: {"example.json": {"format": "json", "overwrite": true}}', + log, + ) with Path(self.cwd, "example.json").open(encoding="utf-8") as f2: first_line = f2.readline() self.assertNotEqual(first_line, "not empty") @@ -930,18 +1018,32 @@ class MySpider(scrapy.Spider): def start_requests(self): return [] """ - args = ['-o', 'example1.json', '-O', 'example2.json'] + args = ["-o", "example1.json", "-O", "example2.json"] log = self.get_log(spider_code, args=args) - self.assertIn("error: Please use only one of -o/--output and -O/--overwrite-output", log) + self.assertIn( + "error: Please use only one of -o/--output and -O/--overwrite-output", log + ) class HelpMessageTest(CommandTest): - def setUp(self): super().setUp() - self.commands = ["parse", "startproject", "view", "crawl", "edit", - "list", "fetch", "settings", "shell", "runspider", - "version", "genspider", "check", "bench"] + self.commands = [ + "parse", + "startproject", + "view", + "crawl", + "edit", + "list", + "fetch", + "settings", + "shell", + "runspider", + "version", + "genspider", + "check", + "bench", + ] def test_help_messages(self): for command in self.commands: diff --git a/tests/test_contracts.py b/tests/test_contracts.py index 136056f50..7b104f618 100644 --- a/tests/test_contracts.py +++ b/tests/test_contracts.py @@ -26,52 +26,52 @@ class TestItem(Item): class ResponseMock: - url = 'http://scrapy.org' + url = "http://scrapy.org" class CustomSuccessContract(Contract): - name = 'custom_success_contract' + name = "custom_success_contract" def adjust_request_args(self, args): - args['url'] = 'http://scrapy.org' + args["url"] = "http://scrapy.org" return args class CustomFailContract(Contract): - name = 'custom_fail_contract' + name = "custom_fail_contract" def adjust_request_args(self, args): - raise TypeError('Error in adjust_request_args') + raise TypeError("Error in adjust_request_args") class CustomFormContract(Contract): - name = 'custom_form' + name = "custom_form" request_cls = FormRequest def adjust_request_args(self, args): - args['formdata'] = {'name': 'scrapy'} + args["formdata"] = {"name": "scrapy"} return args class TestSpider(Spider): - name = 'demo_spider' + name = "demo_spider" def returns_request(self, response): - """ method which returns request + """method which returns request @url http://scrapy.org @returns requests 1 """ - return Request('http://scrapy.org', callback=self.returns_item) + return Request("http://scrapy.org", callback=self.returns_item) def returns_item(self, response): - """ method which returns item + """method which returns item @url http://scrapy.org @returns items 1 1 """ return TestItem(url=response.url) def returns_request_cb_kwargs(self, response, url): - """ method which returns request + """method which returns request @url https://example.org @cb_kwargs {"url": "http://scrapy.org"} @returns requests 1 @@ -79,7 +79,7 @@ class TestSpider(Spider): return Request(url, callback=self.returns_item_cb_kwargs) def returns_item_cb_kwargs(self, response, name): - """ method which returns item + """method which returns item @url http://scrapy.org @cb_kwargs {"name": "Scrapy"} @returns items 1 1 @@ -87,7 +87,7 @@ class TestSpider(Spider): return TestItem(name=name, url=response.url) def returns_item_cb_kwargs_error_unexpected_keyword(self, response): - """ method which returns item + """method which returns item @url http://scrapy.org @cb_kwargs {"arg": "value"} @returns items 1 1 @@ -95,51 +95,51 @@ class TestSpider(Spider): return TestItem(url=response.url) def returns_item_cb_kwargs_error_missing_argument(self, response, arg): - """ method which returns item + """method which returns item @url http://scrapy.org @returns items 1 1 """ return TestItem(url=response.url) def returns_dict_item(self, response): - """ method which returns item + """method which returns item @url http://scrapy.org @returns items 1 1 """ return {"url": response.url} def returns_fail(self, response): - """ method which returns item + """method which returns item @url http://scrapy.org @returns items 0 0 """ return TestItem(url=response.url) def returns_dict_fail(self, response): - """ method which returns item + """method which returns item @url http://scrapy.org @returns items 0 0 """ - return {'url': response.url} + return {"url": response.url} def scrapes_item_ok(self, response): - """ returns item with name and url + """returns item with name and url @url http://scrapy.org @returns items 1 1 @scrapes name url """ - return TestItem(name='test', url=response.url) + return TestItem(name="test", url=response.url) def scrapes_dict_item_ok(self, response): - """ returns item with name and url + """returns item with name and url @url http://scrapy.org @returns items 1 1 @scrapes name url """ - return {'name': 'test', 'url': response.url} + return {"name": "test", "url": response.url} def scrapes_item_fail(self, response): - """ returns item with no name + """returns item with no name @url http://scrapy.org @returns items 1 1 @scrapes name url @@ -147,15 +147,15 @@ class TestSpider(Spider): return TestItem(url=response.url) def scrapes_dict_item_fail(self, response): - """ returns item with no name + """returns item with no name @url http://scrapy.org @returns items 1 1 @scrapes name url """ - return {'url': response.url} + return {"url": response.url} def scrapes_multiple_missing_fields(self, response): - """ returns item with no name + """returns item with no name @url http://scrapy.org @returns items 1 1 @scrapes name url @@ -163,7 +163,7 @@ class TestSpider(Spider): return {} def parse_no_url(self, response): - """ method with no url + """method with no url @returns items 1 1 """ pass @@ -177,7 +177,7 @@ class TestSpider(Spider): class CustomContractSuccessSpider(Spider): - name = 'custom_contract_success_spider' + name = "custom_contract_success_spider" def parse(self, response): """ @@ -187,7 +187,7 @@ class CustomContractSuccessSpider(Spider): class CustomContractFailSpider(Spider): - name = 'custom_contract_fail_spider' + name = "custom_contract_fail_spider" def parse(self, response): """ @@ -197,7 +197,7 @@ class CustomContractFailSpider(Spider): class InheritsTestSpider(TestSpider): - name = 'inherits_demo_spider' + name = "inherits_demo_spider" class ContractsManagerTest(unittest.TestCase): @@ -234,7 +234,8 @@ class ContractsManagerTest(unittest.TestCase): self.assertEqual(len(contracts), 2) self.assertEqual( frozenset(type(x) for x in contracts), - frozenset([UrlContract, ReturnsContract])) + frozenset([UrlContract, ReturnsContract]), + ) # returns request for valid method request = self.conman.from_method(spider.returns_request, self.results) @@ -251,26 +252,40 @@ class ContractsManagerTest(unittest.TestCase): # extract contracts correctly contracts = self.conman.extract_contracts(spider.returns_request_cb_kwargs) self.assertEqual(len(contracts), 3) - self.assertEqual(frozenset(type(x) for x in contracts), - frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract])) + self.assertEqual( + frozenset(type(x) for x in contracts), + frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract]), + ) contracts = self.conman.extract_contracts(spider.returns_item_cb_kwargs) self.assertEqual(len(contracts), 3) - self.assertEqual(frozenset(type(x) for x in contracts), - frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract])) + self.assertEqual( + frozenset(type(x) for x in contracts), + frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract]), + ) - contracts = self.conman.extract_contracts(spider.returns_item_cb_kwargs_error_unexpected_keyword) + contracts = self.conman.extract_contracts( + spider.returns_item_cb_kwargs_error_unexpected_keyword + ) self.assertEqual(len(contracts), 3) - self.assertEqual(frozenset(type(x) for x in contracts), - frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract])) + self.assertEqual( + frozenset(type(x) for x in contracts), + frozenset([UrlContract, CallbackKeywordArgumentsContract, ReturnsContract]), + ) - contracts = self.conman.extract_contracts(spider.returns_item_cb_kwargs_error_missing_argument) + contracts = self.conman.extract_contracts( + spider.returns_item_cb_kwargs_error_missing_argument + ) self.assertEqual(len(contracts), 2) - self.assertEqual(frozenset(type(x) for x in contracts), - frozenset([UrlContract, ReturnsContract])) + self.assertEqual( + frozenset(type(x) for x in contracts), + frozenset([UrlContract, ReturnsContract]), + ) # returns_request - request = self.conman.from_method(spider.returns_request_cb_kwargs, self.results) + request = self.conman.from_method( + spider.returns_request_cb_kwargs, self.results + ) request.callback(response, **request.cb_kwargs) self.should_succeed() @@ -280,12 +295,16 @@ class ContractsManagerTest(unittest.TestCase): self.should_succeed() # returns_item (error, callback doesn't take keyword arguments) - request = self.conman.from_method(spider.returns_item_cb_kwargs_error_unexpected_keyword, self.results) + request = self.conman.from_method( + spider.returns_item_cb_kwargs_error_unexpected_keyword, self.results + ) request.callback(response, **request.cb_kwargs) self.should_error() # returns_item (error, contract doesn't provide keyword arguments) - request = self.conman.from_method(spider.returns_item_cb_kwargs_error_missing_argument, self.results) + request = self.conman.from_method( + spider.returns_item_cb_kwargs_error_missing_argument, self.results + ) request.callback(response, **request.cb_kwargs) self.should_error() @@ -343,10 +362,12 @@ class ContractsManagerTest(unittest.TestCase): self.should_fail() # scrapes_multiple_missing_fields - request = self.conman.from_method(spider.scrapes_multiple_missing_fields, self.results) + request = self.conman.from_method( + spider.scrapes_multiple_missing_fields, self.results + ) request.callback(response) self.should_fail() - message = 'ContractFail: Missing fields: name, url' + message = "ContractFail: Missing fields: name, url" assert message in self.results.failures[-1][-1] def test_custom_contracts(self): @@ -361,7 +382,7 @@ class ContractsManagerTest(unittest.TestCase): response = ResponseMock() try: - raise HttpError(response, 'Ignoring non-200 response') + raise HttpError(response, "Ignoring non-200 response") except HttpError: failure_mock = failure.Failure() @@ -373,9 +394,8 @@ class ContractsManagerTest(unittest.TestCase): @defer.inlineCallbacks def test_same_url(self): - class TestSameUrlSpider(Spider): - name = 'test_same_url' + name = "test_same_url" def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -406,7 +426,7 @@ class ContractsManagerTest(unittest.TestCase): def test_form_contract(self): spider = TestSpider() request = self.conman.from_method(spider.custom_form, self.results) - self.assertEqual(request.method, 'POST') + self.assertEqual(request.method, "POST") self.assertIsInstance(request, FormRequest) def test_inherited_contracts(self): diff --git a/tests/test_core_downloader.py b/tests/test_core_downloader.py index 113ea8f19..9a6e9e4ff 100644 --- a/tests/test_core_downloader.py +++ b/tests/test_core_downloader.py @@ -4,7 +4,8 @@ from scrapy.core.downloader import Slot class SlotTest(unittest.TestCase): - def test_repr(self): slot = Slot(concurrency=8, delay=0.1, randomize_delay=True) - self.assertEqual(repr(slot), 'Slot(concurrency=8, delay=0.10, randomize_delay=True)') + self.assertEqual( + repr(slot), "Slot(concurrency=8, delay=0.10, randomize_delay=True)" + ) diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 5ec96e4a7..3f19bef22 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -53,7 +53,6 @@ from tests.spiders import ( class CrawlTestCase(TestCase): - def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() @@ -82,17 +81,17 @@ class CrawlTestCase(TestCase): mockserver=self.mockserver, total=total, ) - tolerance = (1 - (0.6 if randomize else 0.2)) + tolerance = 1 - (0.6 if randomize else 0.2) - settings = {"DOWNLOAD_DELAY": delay, - 'RANDOMIZE_DOWNLOAD_DELAY': randomize} + settings = {"DOWNLOAD_DELAY": delay, "RANDOMIZE_DOWNLOAD_DELAY": randomize} crawler = get_crawler(FollowAllSpider, settings) yield crawler.crawl(**crawl_kwargs) times = crawler.spider.times total_time = times[-1] - times[0] average = total_time / (len(times) - 1) - self.assertTrue(average > delay * tolerance, - f"download delay too small: {average}") + self.assertTrue( + average > delay * tolerance, f"download delay too small: {average}" + ) # Ensure that the same test parameters would cause a failure if no # download delay is set. Otherwise, it means we are using a combination @@ -104,8 +103,9 @@ class CrawlTestCase(TestCase): times = crawler.spider.times total_time = times[-1] - times[0] average = total_time / (len(times) - 1) - self.assertFalse(average > delay / tolerance, - "test total or delay values are too small") + self.assertFalse( + average > delay / tolerance, "test total or delay values are too small" + ) @defer.inlineCallbacks def test_timeout_success(self): @@ -134,14 +134,18 @@ class CrawlTestCase(TestCase): def test_retry_503(self): crawler = get_crawler(SimpleSpider) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=503"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/status?n=503"), mockserver=self.mockserver + ) self._assert_retried(log) @defer.inlineCallbacks def test_retry_conn_failed(self): crawler = get_crawler(SimpleSpider) with LogCapture() as log: - yield crawler.crawl("http://localhost:65432/status?n=503", mockserver=self.mockserver) + yield crawler.crawl( + "http://localhost:65432/status?n=503", mockserver=self.mockserver + ) self._assert_retried(log) @defer.inlineCallbacks @@ -151,12 +155,14 @@ class CrawlTestCase(TestCase): crawler = get_crawler(SimpleSpider) with LogCapture() as log: # try to fetch the homepage of a non-existent domain - yield crawler.crawl("http://dns.resolution.invalid./", mockserver=self.mockserver) + yield crawler.crawl( + "http://dns.resolution.invalid./", mockserver=self.mockserver + ) self._assert_retried(log) @defer.inlineCallbacks def test_start_requests_bug_before_yield(self): - with LogCapture('scrapy', level=logging.ERROR) as log: + with LogCapture("scrapy", level=logging.ERROR) as log: crawler = get_crawler(BrokenStartRequestsSpider) yield crawler.crawl(fail_before_yield=1, mockserver=self.mockserver) @@ -167,7 +173,7 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_start_requests_bug_yielding(self): - with LogCapture('scrapy', level=logging.ERROR) as log: + with LogCapture("scrapy", level=logging.ERROR) as log: crawler = get_crawler(BrokenStartRequestsSpider) yield crawler.crawl(fail_yielding=1, mockserver=self.mockserver) @@ -183,16 +189,24 @@ class CrawlTestCase(TestCase): yield crawler.crawl(mockserver=self.mockserver) self.assertTrue( crawler.spider.seedsseen.index(None) < crawler.spider.seedsseen.index(99), - crawler.spider.seedsseen) + crawler.spider.seedsseen, + ) @defer.inlineCallbacks def test_start_requests_dupes(self): settings = {"CONCURRENT_REQUESTS": 1} crawler = get_crawler(DuplicateStartRequestsSpider, settings) - yield crawler.crawl(dont_filter=True, distinct_urls=2, dupe_factor=3, mockserver=self.mockserver) + yield crawler.crawl( + dont_filter=True, distinct_urls=2, dupe_factor=3, mockserver=self.mockserver + ) self.assertEqual(crawler.spider.visited, 6) - yield crawler.crawl(dont_filter=False, distinct_urls=3, dupe_factor=4, mockserver=self.mockserver) + yield crawler.crawl( + dont_filter=False, + distinct_urls=3, + dupe_factor=4, + mockserver=self.mockserver, + ) self.assertEqual(crawler.spider.visited, 3) @defer.inlineCallbacks @@ -200,7 +214,10 @@ class CrawlTestCase(TestCase): # Completeness of responses without Content-Length or Transfer-Encoding # can not be determined, we treat them as valid but flagged as "partial" from urllib.parse import urlencode - query = urlencode({'raw': '''\ + + query = urlencode( + { + "raw": """\ HTTP/1.1 200 OK Server: Apache-Coyote/1.1 X-Powered-By: Servlet 2.4; JBoss-4.2.3.GA (build: SVNTag=JBoss_4_2_3_GA date=200807181417)/JBossWeb-2.0 @@ -216,10 +233,14 @@ Connection: close foo body with multiples lines -'''}) +""" + } + ) crawler = get_crawler(SimpleSpider) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url(f"/raw?{query}"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url(f"/raw?{query}"), mockserver=self.mockserver + ) self.assertEqual(str(log).count("Got response 200"), 1) @defer.inlineCallbacks @@ -227,7 +248,9 @@ with multiples lines # connection lost after receiving data crawler = get_crawler(SimpleSpider) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/drop?abort=0"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/drop?abort=0"), mockserver=self.mockserver + ) self._assert_retried(log) @defer.inlineCallbacks @@ -235,7 +258,9 @@ with multiples lines # connection lost before receiving data crawler = get_crawler(SimpleSpider) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/drop?abort=1"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/drop?abort=1"), mockserver=self.mockserver + ) self._assert_retried(log) def _assert_retried(self, log): @@ -245,56 +270,62 @@ with multiples lines @defer.inlineCallbacks def test_referer_header(self): """Referer header is set by RefererMiddleware unless it is already set""" - req0 = Request(self.mockserver.url('/echo?headers=1&body=0'), dont_filter=1) + req0 = Request(self.mockserver.url("/echo?headers=1&body=0"), dont_filter=1) req1 = req0.replace() - req2 = req0.replace(headers={'Referer': None}) - req3 = req0.replace(headers={'Referer': 'http://example.com'}) - req0.meta['next'] = req1 - req1.meta['next'] = req2 - req2.meta['next'] = req3 + req2 = req0.replace(headers={"Referer": None}) + req3 = req0.replace(headers={"Referer": "http://example.com"}) + req0.meta["next"] = req1 + req1.meta["next"] = req2 + req2.meta["next"] = req3 crawler = get_crawler(SingleRequestSpider) yield crawler.crawl(seed=req0, mockserver=self.mockserver) # basic asserts in case of weird communication errors - self.assertIn('responses', crawler.spider.meta) - self.assertNotIn('failures', crawler.spider.meta) + self.assertIn("responses", crawler.spider.meta) + self.assertNotIn("failures", crawler.spider.meta) # start requests doesn't set Referer header - echo0 = json.loads(to_unicode(crawler.spider.meta['responses'][2].body)) - self.assertNotIn('Referer', echo0['headers']) + echo0 = json.loads(to_unicode(crawler.spider.meta["responses"][2].body)) + self.assertNotIn("Referer", echo0["headers"]) # following request sets Referer to start request url - echo1 = json.loads(to_unicode(crawler.spider.meta['responses'][1].body)) - self.assertEqual(echo1['headers'].get('Referer'), [req0.url]) + echo1 = json.loads(to_unicode(crawler.spider.meta["responses"][1].body)) + self.assertEqual(echo1["headers"].get("Referer"), [req0.url]) # next request avoids Referer header - echo2 = json.loads(to_unicode(crawler.spider.meta['responses'][2].body)) - self.assertNotIn('Referer', echo2['headers']) + echo2 = json.loads(to_unicode(crawler.spider.meta["responses"][2].body)) + self.assertNotIn("Referer", echo2["headers"]) # last request explicitly sets a Referer header - echo3 = json.loads(to_unicode(crawler.spider.meta['responses'][3].body)) - self.assertEqual(echo3['headers'].get('Referer'), ['http://example.com']) + echo3 = json.loads(to_unicode(crawler.spider.meta["responses"][3].body)) + self.assertEqual(echo3["headers"].get("Referer"), ["http://example.com"]) @defer.inlineCallbacks def test_engine_status(self): from scrapy.utils.engine import get_engine_status + est = [] def cb(response): est.append(get_engine_status(crawler.engine)) crawler = get_crawler(SingleRequestSpider) - yield crawler.crawl(seed=self.mockserver.url('/'), callback_func=cb, mockserver=self.mockserver) + yield crawler.crawl( + seed=self.mockserver.url("/"), callback_func=cb, mockserver=self.mockserver + ) self.assertEqual(len(est), 1, est) s = dict(est[0]) - self.assertEqual(s['engine.spider.name'], crawler.spider.name) - self.assertEqual(s['len(engine.scraper.slot.active)'], 1) + self.assertEqual(s["engine.spider.name"], crawler.spider.name) + self.assertEqual(s["len(engine.scraper.slot.active)"], 1) @defer.inlineCallbacks def test_format_engine_status(self): from scrapy.utils.engine import format_engine_status + est = [] def cb(response): est.append(format_engine_status(crawler.engine)) crawler = get_crawler(SingleRequestSpider) - yield crawler.crawl(seed=self.mockserver.url('/'), callback_func=cb, mockserver=self.mockserver) + yield crawler.crawl( + seed=self.mockserver.url("/"), callback_func=cb, mockserver=self.mockserver + ) self.assertEqual(len(est), 1, est) est = est[0].split("\n")[2:-2] # remove header & footer # convert to dict @@ -304,8 +335,8 @@ with multiples lines it = iter(est) s = dict(zip(it, it)) - self.assertEqual(s['engine.spider.name'], crawler.spider.name) - self.assertEqual(s['len(engine.scraper.slot.active)'], '1') + self.assertEqual(s["engine.spider.name"], crawler.spider.name) + self.assertEqual(s["len(engine.scraper.slot.active)"], "1") @defer.inlineCallbacks def test_graceful_crawl_error_handling(self): @@ -337,8 +368,11 @@ with multiples lines } crawler = get_crawler(SimpleSpider, settings) yield self.assertFailure( - crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver), - ZeroDivisionError) + crawler.crawl( + self.mockserver.url("/status?n=200"), mockserver=self.mockserver + ), + ZeroDivisionError, + ) self.assertFalse(crawler.crawling) @defer.inlineCallbacks @@ -346,14 +380,26 @@ with multiples lines crawler = get_crawler(SimpleSpider) runner = CrawlerRunner() with LogCapture() as log: - yield runner.crawl(crawler, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield runner.crawl( + crawler, + self.mockserver.url("/status?n=200"), + mockserver=self.mockserver, + ) self.assertIn("Got response 200", str(log)) @defer.inlineCallbacks def test_crawl_multiple(self): - runner = CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'}) - runner.crawl(SimpleSpider, self.mockserver.url("/status?n=200"), mockserver=self.mockserver) - runner.crawl(SimpleSpider, self.mockserver.url("/status?n=503"), mockserver=self.mockserver) + runner = CrawlerRunner({"REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7"}) + runner.crawl( + SimpleSpider, + self.mockserver.url("/status?n=200"), + mockserver=self.mockserver, + ) + runner.crawl( + SimpleSpider, + self.mockserver.url("/status?n=503"), + mockserver=self.mockserver, + ) with LogCapture() as log: yield runner.join() @@ -363,7 +409,6 @@ with multiples lines class CrawlSpiderTestCase(TestCase): - def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() @@ -381,7 +426,9 @@ class CrawlSpiderTestCase(TestCase): crawler = get_crawler(spider_cls) crawler.signals.connect(_on_item_scraped, signals.item_scraped) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/status?n=200"), mockserver=self.mockserver + ) return log, items, crawler.stats @defer.inlineCallbacks @@ -441,17 +488,24 @@ class CrawlSpiderTestCase(TestCase): def test_async_def_parse(self): crawler = get_crawler(AsyncDefSpider) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/status?n=200"), mockserver=self.mockserver + ) self.assertIn("Got response 200", str(log)) @mark.only_asyncio() @defer.inlineCallbacks def test_async_def_asyncio_parse(self): - crawler = get_crawler(AsyncDefAsyncioSpider, { - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor" - }) + crawler = get_crawler( + AsyncDefAsyncioSpider, + { + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor" + }, + ) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/status?n=200"), mockserver=self.mockserver + ) self.assertIn("Got response 200", str(log)) @mark.only_asyncio() @@ -459,8 +513,8 @@ class CrawlSpiderTestCase(TestCase): def test_async_def_asyncio_parse_items_list(self): log, items, _ = yield self._run_spider(AsyncDefAsyncioReturnSpider) self.assertIn("Got response 200", str(log)) - self.assertIn({'id': 1}, items) - self.assertIn({'id': 2}, items) + self.assertIn({"id": 1}, items) + self.assertIn({"id": 2}, items) @mark.only_asyncio() @defer.inlineCallbacks @@ -473,7 +527,9 @@ class CrawlSpiderTestCase(TestCase): crawler = get_crawler(AsyncDefAsyncioReturnSingleElementSpider) crawler.signals.connect(_on_item_scraped, signals.item_scraped) with LogCapture() as log: - yield crawler.crawl(self.mockserver.url("/status?n=200"), mockserver=self.mockserver) + yield crawler.crawl( + self.mockserver.url("/status?n=200"), mockserver=self.mockserver + ) self.assertIn("Got response 200", str(log)) self.assertIn({"foo": 42}, items) @@ -482,7 +538,7 @@ class CrawlSpiderTestCase(TestCase): def test_async_def_asyncgen_parse(self): log, _, stats = yield self._run_spider(AsyncDefAsyncioGenSpider) self.assertIn("Got response 200", str(log)) - itemcount = stats.get_value('item_scraped_count') + itemcount = stats.get_value("item_scraped_count") self.assertEqual(itemcount, 1) @mark.only_asyncio() @@ -490,10 +546,10 @@ class CrawlSpiderTestCase(TestCase): def test_async_def_asyncgen_parse_loop(self): log, items, stats = yield self._run_spider(AsyncDefAsyncioGenLoopSpider) self.assertIn("Got response 200", str(log)) - itemcount = stats.get_value('item_scraped_count') + itemcount = stats.get_value("item_scraped_count") self.assertEqual(itemcount, 10) for i in range(10): - self.assertIn({'foo': i}, items) + self.assertIn({"foo": i}, items) @mark.only_asyncio() @defer.inlineCallbacks @@ -502,22 +558,22 @@ class CrawlSpiderTestCase(TestCase): log = str(log) self.assertIn("Spider error processing", log) self.assertIn("ValueError", log) - itemcount = stats.get_value('item_scraped_count') + itemcount = stats.get_value("item_scraped_count") self.assertEqual(itemcount, 7) for i in range(7): - self.assertIn({'foo': i}, items) + self.assertIn({"foo": i}, items) @mark.only_asyncio() @defer.inlineCallbacks def test_async_def_asyncgen_parse_complex(self): _, items, stats = yield self._run_spider(AsyncDefAsyncioGenComplexSpider) - itemcount = stats.get_value('item_scraped_count') + itemcount = stats.get_value("item_scraped_count") self.assertEqual(itemcount, 156) # some random items for i in [1, 4, 21, 22, 207, 311]: - self.assertIn({'index': i}, items) + self.assertIn({"index": i}, items) for i in [10, 30, 122]: - self.assertIn({'index2': i}, items) + self.assertIn({"index2": i}, items) @mark.only_asyncio() @defer.inlineCallbacks @@ -530,32 +586,32 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_async_def_deferred_direct(self): _, items, _ = yield self._run_spider(AsyncDefDeferredDirectSpider) - self.assertEqual(items, [{'code': 200}]) + self.assertEqual(items, [{"code": 200}]) @mark.only_asyncio() @defer.inlineCallbacks def test_async_def_deferred_wrapped(self): log, items, _ = yield self._run_spider(AsyncDefDeferredWrappedSpider) - self.assertEqual(items, [{'code': 200}]) + self.assertEqual(items, [{"code": 200}]) @defer.inlineCallbacks def test_async_def_deferred_maybe_wrapped(self): _, items, _ = yield self._run_spider(AsyncDefDeferredMaybeWrappedSpider) - self.assertEqual(items, [{'code': 200}]) + self.assertEqual(items, [{"code": 200}]) @defer.inlineCallbacks def test_response_ssl_certificate_none(self): crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/echo?body=test", is_secure=False) yield crawler.crawl(seed=url, mockserver=self.mockserver) - self.assertIsNone(crawler.spider.meta['responses'][0].certificate) + self.assertIsNone(crawler.spider.meta["responses"][0].certificate) @defer.inlineCallbacks def test_response_ssl_certificate(self): crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/echo?body=test", is_secure=True) yield crawler.crawl(seed=url, mockserver=self.mockserver) - cert = crawler.spider.meta['responses'][0].certificate + cert = crawler.spider.meta["responses"][0].certificate self.assertIsInstance(cert, Certificate) self.assertEqual(cert.getSubject().commonName, b"localhost") self.assertEqual(cert.getIssuer().commonName, b"localhost") @@ -566,7 +622,7 @@ class CrawlSpiderTestCase(TestCase): crawler = get_crawler(SingleRequestSpider) url = self.mockserver.url("/status?n=200", is_secure=True) yield crawler.crawl(seed=url, mockserver=self.mockserver) - cert = crawler.spider.meta['responses'][0].certificate + cert = crawler.spider.meta["responses"][0].certificate self.assertIsInstance(cert, Certificate) self.assertEqual(cert.getSubject().commonName, b"localhost") self.assertEqual(cert.getIssuer().commonName, b"localhost") @@ -574,18 +630,18 @@ class CrawlSpiderTestCase(TestCase): @defer.inlineCallbacks def test_dns_server_ip_address_none(self): crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url('/status?n=200') + url = self.mockserver.url("/status?n=200") yield crawler.crawl(seed=url, mockserver=self.mockserver) - ip_address = crawler.spider.meta['responses'][0].ip_address + ip_address = crawler.spider.meta["responses"][0].ip_address self.assertIsNone(ip_address) @defer.inlineCallbacks def test_dns_server_ip_address(self): crawler = get_crawler(SingleRequestSpider) - url = self.mockserver.url('/echo?body=test') - expected_netloc, _ = urlparse(url).netloc.split(':') + url = self.mockserver.url("/echo?body=test") + expected_netloc, _ = urlparse(url).netloc.split(":") yield crawler.crawl(seed=url, mockserver=self.mockserver) - ip_address = crawler.spider.meta['responses'][0].ip_address + ip_address = crawler.spider.meta["responses"][0].ip_address self.assertIsInstance(ip_address, IPv4Address) self.assertEqual(str(ip_address), gethostbyname(expected_netloc)) @@ -595,8 +651,14 @@ class CrawlSpiderTestCase(TestCase): yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("failure")) self.assertIsInstance(crawler.spider.meta["response"], Response) - self.assertEqual(crawler.spider.meta["response"].body, crawler.spider.meta.get("bytes_received")) - self.assertLess(len(crawler.spider.meta["response"].body), crawler.spider.full_response_length) + self.assertEqual( + crawler.spider.meta["response"].body, + crawler.spider.meta.get("bytes_received"), + ) + self.assertLess( + len(crawler.spider.meta["response"].body), + crawler.spider.full_response_length, + ) @defer.inlineCallbacks def test_bytes_received_stop_download_errback(self): @@ -608,10 +670,12 @@ class CrawlSpiderTestCase(TestCase): self.assertIsInstance(crawler.spider.meta["failure"].value.response, Response) self.assertEqual( crawler.spider.meta["failure"].value.response.body, - crawler.spider.meta.get("bytes_received")) + crawler.spider.meta.get("bytes_received"), + ) self.assertLess( len(crawler.spider.meta["failure"].value.response.body), - crawler.spider.full_response_length) + crawler.spider.full_response_length, + ) @defer.inlineCallbacks def test_headers_received_stop_download_callback(self): @@ -619,7 +683,10 @@ class CrawlSpiderTestCase(TestCase): yield crawler.crawl(mockserver=self.mockserver) self.assertIsNone(crawler.spider.meta.get("failure")) self.assertIsInstance(crawler.spider.meta["response"], Response) - self.assertEqual(crawler.spider.meta["response"].headers, crawler.spider.meta.get("headers_received")) + self.assertEqual( + crawler.spider.meta["response"].headers, + crawler.spider.meta.get("headers_received"), + ) @defer.inlineCallbacks def test_headers_received_stop_download_errback(self): @@ -631,4 +698,5 @@ class CrawlSpiderTestCase(TestCase): self.assertIsInstance(crawler.spider.meta["failure"].value.response, Response) self.assertEqual( crawler.spider.meta["failure"].value.response.headers, - crawler.spider.meta.get("headers_received")) + crawler.spider.meta.get("headers_received"), + ) diff --git a/tests/test_crawler.py b/tests/test_crawler.py index e0902fdbe..c6b93599e 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -31,44 +31,42 @@ from tests.mockserver import MockServer class BaseCrawlerTest(unittest.TestCase): - def assertOptionIsDefault(self, settings, key): self.assertIsInstance(settings, Settings) self.assertEqual(settings[key], getattr(default_settings, key)) class CrawlerTestCase(BaseCrawlerTest): - def test_populate_spidercls_settings(self): - spider_settings = {'TEST1': 'spider', 'TEST2': 'spider'} - project_settings = {'TEST1': 'project', 'TEST3': 'project'} + spider_settings = {"TEST1": "spider", "TEST2": "spider"} + project_settings = {"TEST1": "project", "TEST3": "project"} class CustomSettingsSpider(DefaultSpider): custom_settings = spider_settings settings = Settings() - settings.setdict(project_settings, priority='project') + settings.setdict(project_settings, priority="project") with warnings.catch_warnings(): warnings.simplefilter("ignore", ScrapyDeprecationWarning) crawler = Crawler(CustomSettingsSpider, settings) - self.assertEqual(crawler.settings.get('TEST1'), 'spider') - self.assertEqual(crawler.settings.get('TEST2'), 'spider') - self.assertEqual(crawler.settings.get('TEST3'), 'project') + self.assertEqual(crawler.settings.get("TEST1"), "spider") + self.assertEqual(crawler.settings.get("TEST2"), "spider") + self.assertEqual(crawler.settings.get("TEST3"), "project") self.assertFalse(settings.frozen) self.assertTrue(crawler.settings.frozen) def test_crawler_accepts_dict(self): - crawler = get_crawler(DefaultSpider, {'foo': 'bar'}) - self.assertEqual(crawler.settings['foo'], 'bar') - self.assertOptionIsDefault(crawler.settings, 'RETRY_ENABLED') + crawler = get_crawler(DefaultSpider, {"foo": "bar"}) + self.assertEqual(crawler.settings["foo"], "bar") + self.assertOptionIsDefault(crawler.settings, "RETRY_ENABLED") def test_crawler_accepts_None(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", ScrapyDeprecationWarning) crawler = Crawler(DefaultSpider) - self.assertOptionIsDefault(crawler.settings, 'RETRY_ENABLED') + self.assertOptionIsDefault(crawler.settings, "RETRY_ENABLED") def test_crawler_rejects_spider_objects(self): with raises(ValueError): @@ -78,10 +76,8 @@ class CrawlerTestCase(BaseCrawlerTest): class SpiderSettingsTestCase(unittest.TestCase): def test_spider_custom_settings(self): class MySpider(scrapy.Spider): - name = 'spider' - custom_settings = { - 'AUTOTHROTTLE_ENABLED': True - } + name = "spider" + custom_settings = {"AUTOTHROTTLE_ENABLED": True} crawler = get_crawler(MySpider) enabled_exts = [e.__class__ for e in crawler.extensions.middlewares] @@ -95,73 +91,71 @@ class CrawlerLoggingTestCase(unittest.TestCase): logging.root.removeHandler(handler) class MySpider(scrapy.Spider): - name = 'spider' + name = "spider" get_crawler(MySpider) assert get_scrapy_root_handler() is None def test_spider_custom_settings_log_level(self): log_file = Path(self.mktemp()) - log_file.write_text('previous message\n', encoding='utf-8') + log_file.write_text("previous message\n", encoding="utf-8") class MySpider(scrapy.Spider): - name = 'spider' + name = "spider" custom_settings = { - 'LOG_LEVEL': 'INFO', - 'LOG_FILE': str(log_file), + "LOG_LEVEL": "INFO", + "LOG_FILE": str(log_file), # settings to avoid extra warnings - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', - 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + "TELNETCONSOLE_ENABLED": telnet.TWISTED_CONCH_AVAILABLE, } configure_logging() self.assertEqual(get_scrapy_root_handler().level, logging.DEBUG) crawler = get_crawler(MySpider) self.assertEqual(get_scrapy_root_handler().level, logging.INFO) - info_count = crawler.stats.get_value('log_count/INFO') - logging.debug('debug message') - logging.info('info message') - logging.warning('warning message') - logging.error('error message') + info_count = crawler.stats.get_value("log_count/INFO") + logging.debug("debug message") + logging.info("info message") + logging.warning("warning message") + logging.error("error message") - logged = log_file.read_text(encoding='utf-8') + logged = log_file.read_text(encoding="utf-8") - self.assertIn('previous message', logged) - self.assertNotIn('debug message', logged) - self.assertIn('info message', logged) - self.assertIn('warning message', logged) - self.assertIn('error message', logged) - self.assertEqual(crawler.stats.get_value('log_count/ERROR'), 1) - self.assertEqual(crawler.stats.get_value('log_count/WARNING'), 1) - self.assertEqual( - crawler.stats.get_value('log_count/INFO') - info_count, 1) - self.assertEqual(crawler.stats.get_value('log_count/DEBUG', 0), 0) + self.assertIn("previous message", logged) + self.assertNotIn("debug message", logged) + self.assertIn("info message", logged) + self.assertIn("warning message", logged) + self.assertIn("error message", logged) + self.assertEqual(crawler.stats.get_value("log_count/ERROR"), 1) + self.assertEqual(crawler.stats.get_value("log_count/WARNING"), 1) + self.assertEqual(crawler.stats.get_value("log_count/INFO") - info_count, 1) + self.assertEqual(crawler.stats.get_value("log_count/DEBUG", 0), 0) def test_spider_custom_settings_log_append(self): log_file = Path(self.mktemp()) - log_file.write_text('previous message\n', encoding='utf-8') + log_file.write_text("previous message\n", encoding="utf-8") class MySpider(scrapy.Spider): - name = 'spider' + name = "spider" custom_settings = { - 'LOG_FILE': str(log_file), - 'LOG_FILE_APPEND': False, + "LOG_FILE": str(log_file), + "LOG_FILE_APPEND": False, # disable telnet if not available to avoid an extra warning - 'TELNETCONSOLE_ENABLED': telnet.TWISTED_CONCH_AVAILABLE, + "TELNETCONSOLE_ENABLED": telnet.TWISTED_CONCH_AVAILABLE, } configure_logging() get_crawler(MySpider) - logging.debug('debug message') + logging.debug("debug message") - logged = log_file.read_text(encoding='utf-8') + logged = log_file.read_text(encoding="utf-8") - self.assertNotIn('previous message', logged) - self.assertIn('debug message', logged) + self.assertNotIn("previous message", logged) + self.assertIn("debug message", logged) class SpiderLoaderWithWrongInterface: - def unneeded_method(self): pass @@ -171,11 +165,12 @@ class CustomSpiderLoader(SpiderLoader): class CrawlerRunnerTestCase(BaseCrawlerTest): - def test_spider_manager_verify_interface(self): - settings = Settings({ - 'SPIDER_LOADER_CLASS': SpiderLoaderWithWrongInterface, - }) + settings = Settings( + { + "SPIDER_LOADER_CLASS": SpiderLoaderWithWrongInterface, + } + ) with warnings.catch_warnings(record=True) as w: self.assertRaises(AttributeError, CrawlerRunner, settings) self.assertEqual(len(w), 1) @@ -183,13 +178,13 @@ class CrawlerRunnerTestCase(BaseCrawlerTest): self.assertIn("scrapy.interfaces.ISpiderLoader", str(w[0].message)) def test_crawler_runner_accepts_dict(self): - runner = CrawlerRunner({'foo': 'bar'}) - self.assertEqual(runner.settings['foo'], 'bar') - self.assertOptionIsDefault(runner.settings, 'RETRY_ENABLED') + runner = CrawlerRunner({"foo": "bar"}) + self.assertEqual(runner.settings["foo"], "bar") + self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") def test_crawler_runner_accepts_None(self): runner = CrawlerRunner() - self.assertOptionIsDefault(runner.settings, 'RETRY_ENABLED') + self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") def test_deprecated_attribute_spiders(self): with warnings.catch_warnings(record=True) as w: @@ -198,41 +193,40 @@ class CrawlerRunnerTestCase(BaseCrawlerTest): self.assertEqual(len(w), 1) self.assertIn("CrawlerRunner.spiders", str(w[0].message)) self.assertIn("CrawlerRunner.spider_loader", str(w[0].message)) - sl_cls = load_object(runner.settings['SPIDER_LOADER_CLASS']) + sl_cls = load_object(runner.settings["SPIDER_LOADER_CLASS"]) self.assertIsInstance(spiders, sl_cls) class CrawlerProcessTest(BaseCrawlerTest): def test_crawler_process_accepts_dict(self): - runner = CrawlerProcess({'foo': 'bar'}) - self.assertEqual(runner.settings['foo'], 'bar') - self.assertOptionIsDefault(runner.settings, 'RETRY_ENABLED') + runner = CrawlerProcess({"foo": "bar"}) + self.assertEqual(runner.settings["foo"], "bar") + self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") def test_crawler_process_accepts_None(self): runner = CrawlerProcess() - self.assertOptionIsDefault(runner.settings, 'RETRY_ENABLED') + self.assertOptionIsDefault(runner.settings, "RETRY_ENABLED") class ExceptionSpider(scrapy.Spider): - name = 'exception' + name = "exception" @classmethod def from_crawler(cls, crawler, *args, **kwargs): - raise ValueError('Exception in from_crawler method') + raise ValueError("Exception in from_crawler method") class NoRequestsSpider(scrapy.Spider): - name = 'no_request' + name = "no_request" def start_requests(self): return [] -@mark.usefixtures('reactor_pytest') +@mark.usefixtures("reactor_pytest") class CrawlerRunnerHasSpider(unittest.TestCase): - def _runner(self): - return CrawlerRunner({'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'}) + return CrawlerRunner({"REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7"}) @defer.inlineCallbacks def test_crawler_runner_bootstrap_successful(self): @@ -256,7 +250,7 @@ class CrawlerRunnerHasSpider(unittest.TestCase): except ValueError: pass else: - self.fail('Exception should be raised from spider') + self.fail("Exception should be raised from spider") self.assertEqual(runner.bootstrap_failed, True) @@ -269,7 +263,7 @@ class CrawlerRunnerHasSpider(unittest.TestCase): except ValueError: pass else: - self.fail('Exception should be raised from spider') + self.fail("Exception should be raised from spider") yield runner.crawl(NoRequestsSpider) @@ -277,18 +271,22 @@ class CrawlerRunnerHasSpider(unittest.TestCase): @defer.inlineCallbacks def test_crawler_runner_asyncio_enabled_true(self): - if self.reactor_pytest == 'asyncio': - CrawlerRunner(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", - }) + if self.reactor_pytest == "asyncio": + CrawlerRunner( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } + ) else: msg = r"The installed reactor \(.*?\) does not match the requested one \(.*?\)" with self.assertRaisesRegex(Exception, msg): - runner = CrawlerRunner(settings={ - "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", - "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", - }) + runner = CrawlerRunner( + settings={ + "TWISTED_REACTOR": "twisted.internet.asyncioreactor.AsyncioSelectorReactor", + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } + ) yield runner.crawl(NoRequestsSpider) @@ -298,35 +296,42 @@ class ScriptRunnerMixin: def run_script(self, script_name: str, *script_args): script_path = self.script_dir / script_name args = [sys.executable, str(script_path)] + list(script_args) - p = subprocess.Popen(args, env=get_testenv(), - stdout=subprocess.PIPE, stderr=subprocess.PIPE) + p = subprocess.Popen( + args, env=get_testenv(), stdout=subprocess.PIPE, stderr=subprocess.PIPE + ) stdout, stderr = p.communicate() - return stderr.decode('utf-8') + return stderr.decode("utf-8") class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): - script_dir = Path(__file__).parent.resolve() / 'CrawlerProcess' + script_dir = Path(__file__).parent.resolve() / "CrawlerProcess" def test_simple(self): - log = self.run_script('simple.py') - self.assertIn('Spider closed (finished)', log) - self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.run_script("simple.py") + self.assertIn("Spider closed (finished)", log) + self.assertNotIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_multi(self): - log = self.run_script('multi.py') - self.assertIn('Spider closed (finished)', log) - self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.run_script("multi.py") + self.assertIn("Spider closed (finished)", log) + self.assertNotIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertNotIn("ReactorAlreadyInstalledError", log) def test_reactor_default(self): - log = self.run_script('reactor_default.py') - self.assertIn('Spider closed (finished)', log) - self.assertNotIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.run_script("reactor_default.py") + self.assertIn("Spider closed (finished)", log) + self.assertNotIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertNotIn("ReactorAlreadyInstalledError", log) def test_reactor_default_twisted_reactor_select(self): - log = self.run_script('reactor_default_twisted_reactor_select.py') - if platform.system() in ['Windows', 'Darwin']: + log = self.run_script("reactor_default_twisted_reactor_select.py") + if platform.system() in ["Windows", "Darwin"]: # The goal of this test function is to test that, when a reactor is # installed (the default one here) and a different reactor is # configured (select here), an error raises. @@ -337,9 +342,9 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): # If that ever becomes the case on more platforms (i.e. if Linux # also starts using the select reactor by default in a future # version of Twisted), then we will need to rethink this test. - self.assertIn('Spider closed (finished)', log) + self.assertIn("Spider closed (finished)", log) else: - self.assertNotIn('Spider closed (finished)', log) + self.assertNotIn("Spider closed (finished)", log) self.assertIn( ( "does not match the requested one " @@ -349,18 +354,18 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): ) def test_reactor_select(self): - log = self.run_script('reactor_select.py') - self.assertIn('Spider closed (finished)', log) + log = self.run_script("reactor_select.py") + self.assertIn("Spider closed (finished)", log) self.assertNotIn("ReactorAlreadyInstalledError", log) def test_reactor_select_twisted_reactor_select(self): - log = self.run_script('reactor_select_twisted_reactor_select.py') - self.assertIn('Spider closed (finished)', log) + log = self.run_script("reactor_select_twisted_reactor_select.py") + self.assertIn("Spider closed (finished)", log) self.assertNotIn("ReactorAlreadyInstalledError", log) def test_reactor_select_subclass_twisted_reactor_select(self): - log = self.run_script('reactor_select_subclass_twisted_reactor_select.py') - self.assertNotIn('Spider closed (finished)', log) + log = self.run_script("reactor_select_subclass_twisted_reactor_select.py") + self.assertNotIn("Spider closed (finished)", log) self.assertIn( ( "does not match the requested one " @@ -370,24 +375,34 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): ) def test_asyncio_enabled_no_reactor(self): - log = self.run_script('asyncio_enabled_no_reactor.py') - self.assertIn('Spider closed (finished)', log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.run_script("asyncio_enabled_no_reactor.py") + self.assertIn("Spider closed (finished)", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_asyncio_enabled_reactor(self): - log = self.run_script('asyncio_enabled_reactor.py') - self.assertIn('Spider closed (finished)', log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + log = self.run_script("asyncio_enabled_reactor.py") + self.assertIn("Spider closed (finished)", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) - @mark.skipif(parse_version(w3lib_version) >= parse_version("2.0.0"), - reason='w3lib 2.0.0 and later do not allow invalid domains.') + @mark.skipif( + parse_version(w3lib_version) >= parse_version("2.0.0"), + reason="w3lib 2.0.0 and later do not allow invalid domains.", + ) def test_ipv6_default_name_resolver(self): - log = self.run_script('default_name_resolver.py') - self.assertIn('Spider closed (finished)', log) - self.assertIn("'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", log) + log = self.run_script("default_name_resolver.py") + self.assertIn("Spider closed (finished)", log) + self.assertIn( + "'downloader/exception_type_count/twisted.internet.error.DNSLookupError': 1,", + log, + ) self.assertIn( "twisted.internet.error.DNSLookupError: DNS lookup failed: no results for hostname lookup: ::1.", - log) + log, + ) def test_caching_hostname_resolver_ipv6(self): log = self.run_script("caching_hostname_resolver_ipv6.py") @@ -406,9 +421,13 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): def test_twisted_reactor_select(self): log = self.run_script("twisted_reactor_select.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) + self.assertIn( + "Using reactor: twisted.internet.selectreactor.SelectReactor", log + ) - @mark.skipif(platform.system() == 'Windows', reason="PollReactor is not supported on Windows") + @mark.skipif( + platform.system() == "Windows", reason="PollReactor is not supported on Windows" + ) def test_twisted_reactor_poll(self): log = self.run_script("twisted_reactor_poll.py") self.assertIn("Spider closed (finished)", log) @@ -417,54 +436,103 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): def test_twisted_reactor_asyncio(self): log = self.run_script("twisted_reactor_asyncio.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_twisted_reactor_asyncio_custom_settings(self): log = self.run_script("twisted_reactor_custom_settings.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_twisted_reactor_asyncio_custom_settings_same(self): log = self.run_script("twisted_reactor_custom_settings_same.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) def test_twisted_reactor_asyncio_custom_settings_conflict(self): log = self.run_script("twisted_reactor_custom_settings_conflict.py") - self.assertIn("Using reactor: twisted.internet.selectreactor.SelectReactor", log) - self.assertIn("(twisted.internet.selectreactor.SelectReactor) does not match the requested one", log) + self.assertIn( + "Using reactor: twisted.internet.selectreactor.SelectReactor", log + ) + self.assertIn( + "(twisted.internet.selectreactor.SelectReactor) does not match the requested one", + log, + ) - @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') - @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') - @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + @mark.skipif( + sys.implementation.name == "pypy", + reason="uvloop does not support pypy properly", + ) + @mark.skipif( + platform.system() == "Windows", reason="uvloop does not support Windows" + ) + @mark.skipif( + twisted_version == Version("twisted", 21, 2, 0), + reason="https://twistedmatrix.com/trac/ticket/10106", + ) def test_custom_loop_asyncio(self): log = self.run_script("asyncio_custom_loop.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertIn("Using asyncio event loop: uvloop.Loop", log) - @mark.skipif(sys.implementation.name == "pypy", reason="uvloop does not support pypy properly") - @mark.skipif(platform.system() == "Windows", reason="uvloop does not support Windows") - @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + @mark.skipif( + sys.implementation.name == "pypy", + reason="uvloop does not support pypy properly", + ) + @mark.skipif( + platform.system() == "Windows", reason="uvloop does not support Windows" + ) + @mark.skipif( + twisted_version == Version("twisted", 21, 2, 0), + reason="https://twistedmatrix.com/trac/ticket/10106", + ) def test_custom_loop_asyncio_deferred_signal(self): log = self.run_script("asyncio_deferred_signal.py", "uvloop.Loop") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertIn("Using asyncio event loop: uvloop.Loop", log) self.assertIn("async pipeline opened!", log) - @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') - @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') - @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + @mark.skipif( + sys.implementation.name == "pypy", + reason="uvloop does not support pypy properly", + ) + @mark.skipif( + platform.system() == "Windows", reason="uvloop does not support Windows" + ) + @mark.skipif( + twisted_version == Version("twisted", 21, 2, 0), + reason="https://twistedmatrix.com/trac/ticket/10106", + ) def test_asyncio_enabled_reactor_same_loop(self): log = self.run_script("asyncio_enabled_reactor_same_loop.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertIn("Using asyncio event loop: uvloop.Loop", log) - @mark.skipif(sys.implementation.name == 'pypy', reason='uvloop does not support pypy properly') - @mark.skipif(platform.system() == 'Windows', reason='uvloop does not support Windows') - @mark.skipif(twisted_version == Version('twisted', 21, 2, 0), reason='https://twistedmatrix.com/trac/ticket/10106') + @mark.skipif( + sys.implementation.name == "pypy", + reason="uvloop does not support pypy properly", + ) + @mark.skipif( + platform.system() == "Windows", reason="uvloop does not support Windows" + ) + @mark.skipif( + twisted_version == Version("twisted", 21, 2, 0), + reason="https://twistedmatrix.com/trac/ticket/10106", + ) def test_asyncio_enabled_reactor_different_loop(self): log = self.run_script("asyncio_enabled_reactor_different_loop.py") self.assertNotIn("Spider closed (finished)", log) @@ -479,13 +547,15 @@ class CrawlerProcessSubprocess(ScriptRunnerMixin, unittest.TestCase): def test_default_loop_asyncio_deferred_signal(self): log = self.run_script("asyncio_deferred_signal.py") self.assertIn("Spider closed (finished)", log) - self.assertIn("Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log) + self.assertIn( + "Using reactor: twisted.internet.asyncioreactor.AsyncioSelectorReactor", log + ) self.assertNotIn("Using asyncio event loop: uvloop.Loop", log) self.assertIn("async pipeline opened!", log) class CrawlerRunnerSubprocess(ScriptRunnerMixin, unittest.TestCase): - script_dir = Path(__file__).parent.resolve() / 'CrawlerRunner' + script_dir = Path(__file__).parent.resolve() / "CrawlerRunner" def test_response_ip_address(self): log = self.run_script("ip_address.py") diff --git a/tests/test_dependencies.py b/tests/test_dependencies.py index 74fdd966b..f9b2d853c 100644 --- a/tests/test_dependencies.py +++ b/tests/test_dependencies.py @@ -9,15 +9,14 @@ from twisted.trial import unittest class ScrapyUtilsTest(unittest.TestCase): - def test_required_openssl_version(self): try: - module = import_module('OpenSSL') + module = import_module("OpenSSL") except ImportError: raise unittest.SkipTest("OpenSSL is not available") - if hasattr(module, '__version__'): - installed_version = [int(x) for x in module.__version__.split('.')[:2]] + if hasattr(module, "__version__"): + installed_version = [int(x) for x in module.__version__.split(".")[:2]] assert installed_version >= [0, 6], "OpenSSL >= 0.6 required" def test_pinned_twisted_version(self): @@ -27,20 +26,17 @@ class ScrapyUtilsTest(unittest.TestCase): See https://github.com/scrapy/scrapy/pull/4814#issuecomment-706230011 """ - if not os.environ.get('_SCRAPY_PINNED', None): - self.skipTest('Not in a pinned environment') + if not os.environ.get("_SCRAPY_PINNED", None): + self.skipTest("Not in a pinned environment") - tox_config_file_path = Path(__file__).parent / '..' / 'tox.ini' + tox_config_file_path = Path(__file__).parent / ".." / "tox.ini" config_parser = ConfigParser() config_parser.read(tox_config_file_path) - pattern = r'Twisted\[http2\]==([\d.]+)' - match = re.search(pattern, config_parser['pinned']['deps']) + pattern = r"Twisted\[http2\]==([\d.]+)" + match = re.search(pattern, config_parser["pinned"]["deps"]) pinned_twisted_version_string = match[1] - self.assertEqual( - twisted_version.short(), - pinned_twisted_version_string - ) + self.assertEqual(twisted_version.short(), pinned_twisted_version_string) if __name__ == "__main__": diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 3dc2745a0..536d09f18 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -66,50 +66,48 @@ class OffDH: class LoadTestCase(unittest.TestCase): - def test_enabled_handler(self): - handlers = {'scheme': DummyDH} - crawler = get_crawler(settings_dict={'DOWNLOAD_HANDLERS': handlers}) + handlers = {"scheme": DummyDH} + crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) dh = DownloadHandlers(crawler) - self.assertIn('scheme', dh._schemes) - self.assertIn('scheme', dh._handlers) - self.assertNotIn('scheme', dh._notconfigured) + self.assertIn("scheme", dh._schemes) + self.assertIn("scheme", dh._handlers) + self.assertNotIn("scheme", dh._notconfigured) def test_not_configured_handler(self): - handlers = {'scheme': OffDH} - crawler = get_crawler(settings_dict={'DOWNLOAD_HANDLERS': handlers}) + handlers = {"scheme": OffDH} + crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) dh = DownloadHandlers(crawler) - self.assertIn('scheme', dh._schemes) - self.assertNotIn('scheme', dh._handlers) - self.assertIn('scheme', dh._notconfigured) + self.assertIn("scheme", dh._schemes) + self.assertNotIn("scheme", dh._handlers) + self.assertIn("scheme", dh._notconfigured) def test_disabled_handler(self): - handlers = {'scheme': None} - crawler = get_crawler(settings_dict={'DOWNLOAD_HANDLERS': handlers}) + handlers = {"scheme": None} + crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) dh = DownloadHandlers(crawler) - self.assertNotIn('scheme', dh._schemes) + self.assertNotIn("scheme", dh._schemes) for scheme in handlers: # force load handlers dh._get_handler(scheme) - self.assertNotIn('scheme', dh._handlers) - self.assertIn('scheme', dh._notconfigured) + self.assertNotIn("scheme", dh._handlers) + self.assertIn("scheme", dh._notconfigured) def test_lazy_handlers(self): - handlers = {'scheme': DummyLazyDH} - crawler = get_crawler(settings_dict={'DOWNLOAD_HANDLERS': handlers}) + handlers = {"scheme": DummyLazyDH} + crawler = get_crawler(settings_dict={"DOWNLOAD_HANDLERS": handlers}) dh = DownloadHandlers(crawler) - self.assertIn('scheme', dh._schemes) - self.assertNotIn('scheme', dh._handlers) + self.assertIn("scheme", dh._schemes) + self.assertNotIn("scheme", dh._handlers) for scheme in handlers: # force load lazy handler dh._get_handler(scheme) - self.assertIn('scheme', dh._handlers) - self.assertNotIn('scheme', dh._notconfigured) + self.assertIn("scheme", dh._handlers) + self.assertNotIn("scheme", dh._notconfigured) class FileTestCase(unittest.TestCase): - def setUp(self): # add a special char to check that they are handled correctly - self.tmpname = Path(self.mktemp() + '^') + self.tmpname = Path(self.mktemp() + "^") Path(self.tmpname).write_text("0123456789", encoding="utf-8") handler = create_instance(FileDownloadHandler, None, get_crawler()) self.download_request = handler.download_request @@ -121,16 +119,16 @@ class FileTestCase(unittest.TestCase): def _test(response): self.assertEqual(response.url, request.url) self.assertEqual(response.status, 200) - self.assertEqual(response.body, b'0123456789') + self.assertEqual(response.body, b"0123456789") self.assertEqual(response.protocol, None) request = Request(path_to_file_uri(str(self.tmpname))) - assert request.url.upper().endswith('%5E') - return self.download_request(request, Spider('foo')).addCallback(_test) + assert request.url.upper().endswith("%5E") + return self.download_request(request, Spider("foo")).addCallback(_test) def test_non_existent(self): - request = Request(f'file://{self.mktemp()}') - d = self.download_request(request, Spider('foo')) + request = Request(f"file://{self.mktemp()}") + d = self.download_request(request, Spider("foo")) return self.assertFailure(d, IOError) @@ -145,7 +143,6 @@ class ContentLengthHeaderResource(resource.Resource): class ChunkedResource(resource.Resource): - def render(self, request): def response(): request.write(b"chunked ") @@ -157,7 +154,6 @@ class ChunkedResource(resource.Resource): class BrokenChunkedResource(resource.Resource): - def render(self, request): def response(): request.write(b"chunked ") @@ -171,7 +167,6 @@ class BrokenChunkedResource(resource.Resource): class BrokenDownloadResource(resource.Resource): - def render(self, request): def response(): request.setHeader(b"Content-Length", b"20") @@ -185,7 +180,7 @@ class BrokenDownloadResource(resource.Resource): def closeConnection(request): # We have to force a disconnection for HTTP/1.1 clients. Otherwise # client keeps the connection open waiting for more data. - if hasattr(request.channel, 'loseConnection'): # twisted >=16.3.0 + if hasattr(request.channel, "loseConnection"): # twisted >=16.3.0 request.channel.loseConnection() else: request.channel.transport.loseConnection() @@ -215,12 +210,12 @@ class LargeChunkedFileResource(resource.Resource): class HttpTestCase(unittest.TestCase): - scheme = 'http' + scheme = "http" download_handler_cls: Type = HTTPDownloadHandler # only used for HTTPS tests - keyfile = 'keys/localhost.key' - certfile = 'keys/localhost.crt' + keyfile = "keys/localhost.key" + certfile = "keys/localhost.crt" def setUp(self): self.tmpname = Path(self.mktemp()) @@ -242,23 +237,28 @@ class HttpTestCase(unittest.TestCase): r.putChild(b"echo", Echo()) self.site = server.Site(r, timeout=None) self.wrapper = WrappingFactory(self.site) - self.host = 'localhost' - if self.scheme == 'https': + self.host = "localhost" + if self.scheme == "https": # Using WrappingFactory do not enable HTTP/2 failing all the # tests with H2DownloadHandler self.port = reactor.listenSSL( - 0, self.site, ssl_context_factory(self.keyfile, self.certfile), - interface=self.host) + 0, + self.site, + ssl_context_factory(self.keyfile, self.certfile), + interface=self.host, + ) else: self.port = reactor.listenTCP(0, self.wrapper, interface=self.host) self.portno = self.port.getHost().port - self.download_handler = create_instance(self.download_handler_cls, None, get_crawler()) + self.download_handler = create_instance( + self.download_handler_cls, None, get_crawler() + ) self.download_request = self.download_handler.download_request @defer.inlineCallbacks def tearDown(self): yield self.port.stopListening() - if hasattr(self.download_handler, 'close'): + if hasattr(self.download_handler, "close"): yield self.download_handler.close() shutil.rmtree(self.tmpname) @@ -266,29 +266,29 @@ class HttpTestCase(unittest.TestCase): return f"{self.scheme}://{self.host}:{self.portno}/{path}" def test_download(self): - request = Request(self.getURL('file')) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("file")) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") return d def test_download_head(self): - request = Request(self.getURL('file'), method='HEAD') - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("file"), method="HEAD") + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) - d.addCallback(self.assertEqual, b'') + d.addCallback(self.assertEqual, b"") return d def test_redirect_status(self): - request = Request(self.getURL('redirect')) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("redirect")) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.status) d.addCallback(self.assertEqual, 302) return d def test_redirect_status_head(self): - request = Request(self.getURL('redirect'), method='HEAD') - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("redirect"), method="HEAD") + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.status) d.addCallback(self.assertEqual, 302) return d @@ -302,9 +302,9 @@ class HttpTestCase(unittest.TestCase): ) # client connects but no data is received - spider = Spider('foo') - meta = {'download_timeout': 0.5} - request = Request(self.getURL('wait'), meta=meta) + spider = Spider("foo") + meta = {"download_timeout": 0.5} + request = Request(self.getURL("wait"), meta=meta) d = self.download_request(request, spider) yield self.assertFailure(d, defer.TimeoutError, error.TimeoutError) @@ -316,34 +316,33 @@ class HttpTestCase(unittest.TestCase): "This test produces DirtyReactorAggregateError on Windows with asyncio" ) # client connects, server send headers and some body bytes but hangs - spider = Spider('foo') - meta = {'download_timeout': 0.5} - request = Request(self.getURL('hang-after-headers'), meta=meta) + spider = Spider("foo") + meta = {"download_timeout": 0.5} + request = Request(self.getURL("hang-after-headers"), meta=meta) d = self.download_request(request, spider) yield self.assertFailure(d, defer.TimeoutError, error.TimeoutError) def test_host_header_not_in_request_headers(self): def _test(response): - self.assertEqual( - response.body, to_bytes(f'{self.host}:{self.portno}')) + self.assertEqual(response.body, to_bytes(f"{self.host}:{self.portno}")) self.assertEqual(request.headers, {}) - request = Request(self.getURL('host')) - return self.download_request(request, Spider('foo')).addCallback(_test) + request = Request(self.getURL("host")) + return self.download_request(request, Spider("foo")).addCallback(_test) def test_host_header_seted_in_request_headers(self): - host = self.host + ':' + str(self.portno) + host = self.host + ":" + str(self.portno) def _test(response): self.assertEqual(response.body, host.encode()) - self.assertEqual(request.headers.get('Host'), host.encode()) + self.assertEqual(request.headers.get("Host"), host.encode()) - request = Request(self.getURL('host'), headers={'Host': host}) - return self.download_request(request, Spider('foo')).addCallback(_test) + request = Request(self.getURL("host"), headers={"Host": host}) + return self.download_request(request, Spider("foo")).addCallback(_test) - d = self.download_request(request, Spider('foo')) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) - d.addCallback(self.assertEqual, b'localhost') + d.addCallback(self.assertEqual, b"localhost") return d def test_content_length_zero_bodyless_post_request_headers(self): @@ -359,26 +358,27 @@ class HttpTestCase(unittest.TestCase): """ def _test(response): - self.assertEqual(response.body, b'0') + self.assertEqual(response.body, b"0") - request = Request(self.getURL('contentlength'), method='POST') - return self.download_request(request, Spider('foo')).addCallback(_test) + request = Request(self.getURL("contentlength"), method="POST") + return self.download_request(request, Spider("foo")).addCallback(_test) def test_content_length_zero_bodyless_post_only_one(self): def _test(response): import json - headers = Headers(json.loads(response.text)['headers']) - contentlengths = headers.getlist('Content-Length') + + headers = Headers(json.loads(response.text)["headers"]) + contentlengths = headers.getlist("Content-Length") self.assertEqual(len(contentlengths), 1) self.assertEqual(contentlengths, [b"0"]) - request = Request(self.getURL('echo'), method='POST') - return self.download_request(request, Spider('foo')).addCallback(_test) + request = Request(self.getURL("echo"), method="POST") + return self.download_request(request, Spider("foo")).addCallback(_test) def test_payload(self): - body = b'1' * 100 # PayloadResource requires body length to be 100 - request = Request(self.getURL('payload'), method='POST', body=body) - d = self.download_request(request, Spider('foo')) + body = b"1" * 100 # PayloadResource requires body length to be 100 + request = Request(self.getURL("payload"), method="POST", body=body) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, body) return d @@ -386,8 +386,8 @@ class HttpTestCase(unittest.TestCase): def test_response_header_content_length(self): request = Request(self.getURL("file"), method=b"GET") d = self.download_request(request, Spider("foo")) - d.addCallback(lambda r: r.headers[b'content-length']) - d.addCallback(self.assertEqual, b'159') + d.addCallback(lambda r: r.headers[b"content-length"]) + d.addCallback(self.assertEqual, b"159") return d def _test_response_class(self, filename, body, response_class): @@ -395,14 +395,14 @@ class HttpTestCase(unittest.TestCase): self.assertEqual(type(response), response_class) request = Request(self.getURL(filename), body=body) - return self.download_request(request, Spider('foo')).addCallback(_test) + return self.download_request(request, Spider("foo")).addCallback(_test) def test_response_class_from_url(self): - return self._test_response_class('foo.html', b'', HtmlResponse) + return self._test_response_class("foo.html", b"", HtmlResponse) def test_response_class_from_body(self): return self._test_response_class( - 'foo', + "foo", b"\n.", HtmlResponse, ) @@ -410,6 +410,7 @@ class HttpTestCase(unittest.TestCase): class Http10TestCase(HttpTestCase): """HTTP 1.0 test case""" + download_handler_cls: Type = HTTP10DownloadHandler def test_protocol(self): @@ -421,57 +422,58 @@ class Http10TestCase(HttpTestCase): class Https10TestCase(Http10TestCase): - scheme = 'https' + scheme = "https" class Http11TestCase(HttpTestCase): """HTTP 1.1 test case""" + download_handler_cls: Type = HTTP11DownloadHandler def test_download_without_maxsize_limit(self): - request = Request(self.getURL('file')) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("file")) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") return d def test_response_class_choosing_request(self): """Tests choosing of correct response type - in case of Content-Type is empty but body contains text. + in case of Content-Type is empty but body contains text. """ - body = b'Some plain text\ndata with tabs\t and null bytes\0' + body = b"Some plain text\ndata with tabs\t and null bytes\0" def _test_type(response): self.assertEqual(type(response), TextResponse) - request = Request(self.getURL('nocontenttype'), body=body) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("nocontenttype"), body=body) + d = self.download_request(request, Spider("foo")) d.addCallback(_test_type) return d @defer.inlineCallbacks def test_download_with_maxsize(self): - request = Request(self.getURL('file')) + request = Request(self.getURL("file")) # 10 is minimal size for this request and the limit is only counted on # response body. (regardless of headers) - d = self.download_request(request, Spider('foo', download_maxsize=10)) + d = self.download_request(request, Spider("foo", download_maxsize=10)) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") yield d - d = self.download_request(request, Spider('foo', download_maxsize=9)) + d = self.download_request(request, Spider("foo", download_maxsize=9)) yield self.assertFailure(d, defer.CancelledError, error.ConnectionAborted) @defer.inlineCallbacks def test_download_with_maxsize_very_large_file(self): - with mock.patch('scrapy.core.downloader.handlers.http11.logger') as logger: - request = Request(self.getURL('largechunkedfile')) + with mock.patch("scrapy.core.downloader.handlers.http11.logger") as logger: + request = Request(self.getURL("largechunkedfile")) def check(logger): logger.warning.assert_called_once_with(mock.ANY, mock.ANY) - d = self.download_request(request, Spider('foo', download_maxsize=1500)) + d = self.download_request(request, Spider("foo", download_maxsize=1500)) yield self.assertFailure(d, defer.CancelledError, error.ConnectionAborted) # As the error message is logged in the dataReceived callback, we @@ -479,39 +481,39 @@ class Http11TestCase(HttpTestCase): # after closing the connection. d = defer.Deferred() d.addCallback(check) - reactor.callLater(.1, d.callback, logger) + reactor.callLater(0.1, d.callback, logger) yield d @defer.inlineCallbacks def test_download_with_maxsize_per_req(self): - meta = {'download_maxsize': 2} - request = Request(self.getURL('file'), meta=meta) - d = self.download_request(request, Spider('foo')) + meta = {"download_maxsize": 2} + request = Request(self.getURL("file"), meta=meta) + d = self.download_request(request, Spider("foo")) yield self.assertFailure(d, defer.CancelledError, error.ConnectionAborted) @defer.inlineCallbacks def test_download_with_small_maxsize_per_spider(self): - request = Request(self.getURL('file')) - d = self.download_request(request, Spider('foo', download_maxsize=2)) + request = Request(self.getURL("file")) + d = self.download_request(request, Spider("foo", download_maxsize=2)) yield self.assertFailure(d, defer.CancelledError, error.ConnectionAborted) def test_download_with_large_maxsize_per_spider(self): - request = Request(self.getURL('file')) - d = self.download_request(request, Spider('foo', download_maxsize=100)) + request = Request(self.getURL("file")) + d = self.download_request(request, Spider("foo", download_maxsize=100)) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") return d def test_download_chunked_content(self): - request = Request(self.getURL('chunked')) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("chunked")) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"chunked content\n") return d - def test_download_broken_content_cause_data_loss(self, url='broken'): + def test_download_broken_content_cause_data_loss(self, url="broken"): request = Request(self.getURL(url)) - d = self.download_request(request, Spider('foo')) + d = self.download_request(request, Spider("foo")) def checkDataLoss(failure): if failure.check(ResponseFailed): @@ -524,29 +526,31 @@ class Http11TestCase(HttpTestCase): return d def test_download_broken_chunked_content_cause_data_loss(self): - return self.test_download_broken_content_cause_data_loss('broken-chunked') + return self.test_download_broken_content_cause_data_loss("broken-chunked") - def test_download_broken_content_allow_data_loss(self, url='broken'): - request = Request(self.getURL(url), meta={'download_fail_on_dataloss': False}) - d = self.download_request(request, Spider('foo')) + def test_download_broken_content_allow_data_loss(self, url="broken"): + request = Request(self.getURL(url), meta={"download_fail_on_dataloss": False}) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.flags) - d.addCallback(self.assertEqual, ['dataloss']) + d.addCallback(self.assertEqual, ["dataloss"]) return d def test_download_broken_chunked_content_allow_data_loss(self): - return self.test_download_broken_content_allow_data_loss('broken-chunked') + return self.test_download_broken_content_allow_data_loss("broken-chunked") - def test_download_broken_content_allow_data_loss_via_setting(self, url='broken'): - crawler = get_crawler(settings_dict={'DOWNLOAD_FAIL_ON_DATALOSS': False}) + def test_download_broken_content_allow_data_loss_via_setting(self, url="broken"): + crawler = get_crawler(settings_dict={"DOWNLOAD_FAIL_ON_DATALOSS": False}) download_handler = create_instance(self.download_handler_cls, None, crawler) request = Request(self.getURL(url)) - d = download_handler.download_request(request, Spider('foo')) + d = download_handler.download_request(request, Spider("foo")) d.addCallback(lambda r: r.flags) - d.addCallback(self.assertEqual, ['dataloss']) + d.addCallback(self.assertEqual, ["dataloss"]) return d def test_download_broken_chunked_content_allow_data_loss_via_setting(self): - return self.test_download_broken_content_allow_data_loss_via_setting('broken-chunked') + return self.test_download_broken_content_allow_data_loss_via_setting( + "broken-chunked" + ) def test_protocol(self): request = Request(self.getURL("host"), method="GET") @@ -557,7 +561,7 @@ class Http11TestCase(HttpTestCase): class Https11TestCase(Http11TestCase): - scheme = 'https' + scheme = "https" tls_log_message = ( 'SSL connection certificate: issuer "/C=IE/O=Scrapy/CN=localhost", ' @@ -566,30 +570,34 @@ class Https11TestCase(Http11TestCase): @defer.inlineCallbacks def test_tls_logging(self): - crawler = get_crawler(settings_dict={'DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING': True}) + crawler = get_crawler( + settings_dict={"DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING": True} + ) download_handler = create_instance(self.download_handler_cls, None, crawler) try: with LogCapture() as log_capture: - request = Request(self.getURL('file')) - d = download_handler.download_request(request, Spider('foo')) + request = Request(self.getURL("file")) + d = download_handler.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") yield d - log_capture.check_present(('scrapy.core.downloader.tls', 'DEBUG', self.tls_log_message)) + log_capture.check_present( + ("scrapy.core.downloader.tls", "DEBUG", self.tls_log_message) + ) finally: yield download_handler.close() class Https11WrongHostnameTestCase(Http11TestCase): - scheme = 'https' + scheme = "https" # above tests use a server certificate for "localhost", # client connection to "localhost" too. # here we test that even if the server certificate is for another domain, # "www.example.com" in this case, # the tests still pass - keyfile = 'keys/example-com.key.pem' - certfile = 'keys/example-com.cert.pem' + keyfile = "keys/example-com.key.pem" + certfile = "keys/example-com.cert.pem" class Https11InvalidDNSId(Https11TestCase): @@ -597,14 +605,14 @@ class Https11InvalidDNSId(Https11TestCase): def setUp(self): super().setUp() - self.host = '127.0.0.1' + self.host = "127.0.0.1" class Https11InvalidDNSPattern(Https11TestCase): """Connect to HTTPS hosts where the certificate are issued to an ip instead of a domain.""" - keyfile = 'keys/localhost.ip.key' - certfile = 'keys/localhost.ip.crt' + keyfile = "keys/localhost.ip.key" + certfile = "keys/localhost.ip.crt" def setUp(self): try: @@ -619,11 +627,11 @@ class Https11InvalidDNSPattern(Https11TestCase): class Https11CustomCiphers(unittest.TestCase): - scheme = 'https' + scheme = "https" download_handler_cls: Type = HTTP11DownloadHandler - keyfile = 'keys/localhost.key' - certfile = 'keys/localhost.crt' + keyfile = "keys/localhost.key" + certfile = "keys/localhost.crt" def setUp(self): self.tmpname = Path(self.mktemp()) @@ -631,19 +639,28 @@ class Https11CustomCiphers(unittest.TestCase): (self.tmpname / "file").write_bytes(b"0123456789") r = static.File(str(self.tmpname)) self.site = server.Site(r, timeout=None) - self.host = 'localhost' + self.host = "localhost" self.port = reactor.listenSSL( - 0, self.site, ssl_context_factory(self.keyfile, self.certfile, cipher_string='CAMELLIA256-SHA'), - interface=self.host) + 0, + self.site, + ssl_context_factory( + self.keyfile, self.certfile, cipher_string="CAMELLIA256-SHA" + ), + interface=self.host, + ) self.portno = self.port.getHost().port - crawler = get_crawler(settings_dict={'DOWNLOADER_CLIENT_TLS_CIPHERS': 'CAMELLIA256-SHA'}) - self.download_handler = create_instance(self.download_handler_cls, None, crawler) + crawler = get_crawler( + settings_dict={"DOWNLOADER_CLIENT_TLS_CIPHERS": "CAMELLIA256-SHA"} + ) + self.download_handler = create_instance( + self.download_handler_cls, None, crawler + ) self.download_request = self.download_handler.download_request @defer.inlineCallbacks def tearDown(self): yield self.port.stopListening() - if hasattr(self.download_handler, 'close'): + if hasattr(self.download_handler, "close"): yield self.download_handler.close() shutil.rmtree(self.tmpname) @@ -651,8 +668,8 @@ class Https11CustomCiphers(unittest.TestCase): return f"{self.scheme}://{self.host}:{self.portno}/{path}" def test_download(self): - request = Request(self.getURL('file')) - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("file")) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) d.addCallback(self.assertEqual, b"0123456789") return d @@ -660,6 +677,7 @@ class Https11CustomCiphers(unittest.TestCase): class Http11MockServerTestCase(unittest.TestCase): """HTTP 1.1 test case with MockServer""" + settings_dict: Optional[dict] = None def setUp(self): @@ -674,40 +692,48 @@ class Http11MockServerTestCase(unittest.TestCase): crawler = get_crawler(SingleRequestSpider, self.settings_dict) # http://localhost:8998/partial set Content-Length to 1024, use download_maxsize= 1000 to avoid # download it - yield crawler.crawl(seed=Request(url=self.mockserver.url('/partial'), meta={'download_maxsize': 1000})) - failure = crawler.spider.meta['failure'] + yield crawler.crawl( + seed=Request( + url=self.mockserver.url("/partial"), meta={"download_maxsize": 1000} + ) + ) + failure = crawler.spider.meta["failure"] self.assertIsInstance(failure.value, defer.CancelledError) @defer.inlineCallbacks def test_download(self): crawler = get_crawler(SingleRequestSpider, self.settings_dict) - yield crawler.crawl(seed=Request(url=self.mockserver.url(''))) - failure = crawler.spider.meta.get('failure') + yield crawler.crawl(seed=Request(url=self.mockserver.url(""))) + failure = crawler.spider.meta.get("failure") self.assertTrue(failure is None) - reason = crawler.spider.meta['close_reason'] - self.assertTrue(reason, 'finished') + reason = crawler.spider.meta["close_reason"] + self.assertTrue(reason, "finished") @defer.inlineCallbacks def test_download_gzip_response(self): crawler = get_crawler(SingleRequestSpider, self.settings_dict) - body = b'1' * 100 # PayloadResource requires body length to be 100 - request = Request(self.mockserver.url('/payload'), method='POST', - body=body, meta={'download_maxsize': 50}) + body = b"1" * 100 # PayloadResource requires body length to be 100 + request = Request( + self.mockserver.url("/payload"), + method="POST", + body=body, + meta={"download_maxsize": 50}, + ) yield crawler.crawl(seed=request) - failure = crawler.spider.meta['failure'] + failure = crawler.spider.meta["failure"] # download_maxsize < 100, hence the CancelledError self.assertIsInstance(failure.value, defer.CancelledError) # See issue https://twistedmatrix.com/trac/ticket/8175 raise unittest.SkipTest("xpayload fails on PY3") - request.headers.setdefault(b'Accept-Encoding', b'gzip,deflate') - request = request.replace(url=self.mockserver.url('/xpayload')) + request.headers.setdefault(b"Accept-Encoding", b"gzip,deflate") + request = request.replace(url=self.mockserver.url("/xpayload")) yield crawler.crawl(seed=request) # download_maxsize = 50 is enough for the gzipped response - failure = crawler.spider.meta.get('failure') + failure = crawler.spider.meta.get("failure") self.assertTrue(failure is None) - reason = crawler.spider.meta['close_reason'] - self.assertTrue(reason, 'finished') + reason = crawler.spider.meta["close_reason"] + self.assertTrue(reason, "finished") class UriResource(resource.Resource): @@ -720,27 +746,29 @@ class UriResource(resource.Resource): # Note: this is an ugly hack for CONNECT request timeout test. # Returning some data here fail SSL/TLS handshake # ToDo: implement proper HTTPS proxy tests, not faking them. - if request.method != b'CONNECT': + if request.method != b"CONNECT": return request.uri - return b'' + return b"" class HttpProxyTestCase(unittest.TestCase): download_handler_cls: Type = HTTPDownloadHandler - expected_http_proxy_request_body = b'http://example.com' + expected_http_proxy_request_body = b"http://example.com" def setUp(self): site = server.Site(UriResource(), timeout=None) wrapper = WrappingFactory(site) - self.port = reactor.listenTCP(0, wrapper, interface='127.0.0.1') + self.port = reactor.listenTCP(0, wrapper, interface="127.0.0.1") self.portno = self.port.getHost().port - self.download_handler = create_instance(self.download_handler_cls, None, get_crawler()) + self.download_handler = create_instance( + self.download_handler_cls, None, get_crawler() + ) self.download_request = self.download_handler.download_request @defer.inlineCallbacks def tearDown(self): yield self.port.stopListening() - if hasattr(self.download_handler, 'close'): + if hasattr(self.download_handler, "close"): yield self.download_handler.close() def getURL(self, path): @@ -752,25 +780,25 @@ class HttpProxyTestCase(unittest.TestCase): self.assertEqual(response.url, request.url) self.assertEqual(response.body, self.expected_http_proxy_request_body) - http_proxy = self.getURL('') - request = Request('http://example.com', meta={'proxy': http_proxy}) - return self.download_request(request, Spider('foo')).addCallback(_test) + http_proxy = self.getURL("") + request = Request("http://example.com", meta={"proxy": http_proxy}) + return self.download_request(request, Spider("foo")).addCallback(_test) def test_download_without_proxy(self): def _test(response): self.assertEqual(response.status, 200) self.assertEqual(response.url, request.url) - self.assertEqual(response.body, b'/path/to/resource') + self.assertEqual(response.body, b"/path/to/resource") - request = Request(self.getURL('path/to/resource')) - return self.download_request(request, Spider('foo')).addCallback(_test) + request = Request(self.getURL("path/to/resource")) + return self.download_request(request, Spider("foo")).addCallback(_test) class Http10ProxyTestCase(HttpProxyTestCase): download_handler_cls: Type = HTTP10DownloadHandler def test_download_with_proxy_https_noconnect(self): - raise unittest.SkipTest('noconnect is not supported in HTTP10DownloadHandler') + raise unittest.SkipTest("noconnect is not supported in HTTP10DownloadHandler") class Http11ProxyTestCase(HttpProxyTestCase): @@ -778,14 +806,13 @@ class Http11ProxyTestCase(HttpProxyTestCase): @defer.inlineCallbacks def test_download_with_proxy_https_timeout(self): - """ Test TunnelingTCP4ClientEndpoint """ + """Test TunnelingTCP4ClientEndpoint""" if NON_EXISTING_RESOLVABLE: raise SkipTest("Non-existing hosts are resolvable") - http_proxy = self.getURL('') - domain = 'https://no-such-domain.nosuch' - request = Request( - domain, meta={'proxy': http_proxy, 'download_timeout': 0.2}) - d = self.download_request(request, Spider('foo')) + http_proxy = self.getURL("") + domain = "https://no-such-domain.nosuch" + request = Request(domain, meta={"proxy": http_proxy, "download_timeout": 0.2}) + d = self.download_request(request, Spider("foo")) timeout = yield self.assertFailure(d, error.TimeoutError) self.assertIn(domain, timeout.osError) @@ -795,13 +822,12 @@ class Http11ProxyTestCase(HttpProxyTestCase): self.assertEqual(response.url, request.url) self.assertEqual(response.body, self.expected_http_proxy_request_body) - http_proxy = self.getURL('').replace('http://', '') - request = Request('http://example.com', meta={'proxy': http_proxy}) - return self.download_request(request, Spider('foo')).addCallback(_test) + http_proxy = self.getURL("").replace("http://", "") + request = Request("http://example.com", meta={"proxy": http_proxy}) + return self.download_request(request, Spider("foo")).addCallback(_test) class HttpDownloadHandlerMock: - def __init__(self, *args, **kwargs): pass @@ -810,7 +836,6 @@ class HttpDownloadHandlerMock: class S3AnonTestCase(unittest.TestCase): - def setUp(self): skip_if_no_boto() crawler = get_crawler() @@ -822,15 +847,14 @@ class S3AnonTestCase(unittest.TestCase): # anon=True, # implicit ) self.download_request = self.s3reqh.download_request - self.spider = Spider('foo') + self.spider = Spider("foo") def test_anon_request(self): - req = Request('s3://aws-publicdatasets/') + req = Request("s3://aws-publicdatasets/") httpreq = self.download_request(req, self.spider) - self.assertEqual(hasattr(self.s3reqh, 'anon'), True) + self.assertEqual(hasattr(self.s3reqh, "anon"), True) self.assertEqual(self.s3reqh.anon, True) - self.assertEqual( - httpreq.url, 'http://aws-publicdatasets.s3.amazonaws.com/') + self.assertEqual(httpreq.url, "http://aws-publicdatasets.s3.amazonaws.com/") class S3TestCase(unittest.TestCase): @@ -840,8 +864,8 @@ class S3TestCase(unittest.TestCase): # http://s3.amazonaws.com/awsdocs/S3/20060301/s3-dg-20060301.pdf # and the tests described here are the examples from that manual - AWS_ACCESS_KEY_ID = '0PN5J17HBGZHT7JJ3X82' - AWS_SECRET_ACCESS_KEY = 'uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o' + AWS_ACCESS_KEY_ID = "0PN5J17HBGZHT7JJ3X82" + AWS_SECRET_ACCESS_KEY = "uV3F3YluFJax1cknvbcGwgjvx4QpvB+leU8dUj2o" def setUp(self): skip_if_no_boto() @@ -855,7 +879,7 @@ class S3TestCase(unittest.TestCase): httpdownloadhandler=HttpDownloadHandlerMock, ) self.download_request = s3reqh.download_request - self.spider = Spider('foo') + self.spider = Spider("foo") @contextlib.contextmanager def _mocked_date(self, date): @@ -867,7 +891,7 @@ class S3TestCase(unittest.TestCase): # We need to mock botocore.auth.formatdate, because otherwise # botocore overrides Date header with current date and time # and Authorization header is different each time - with mock.patch('botocore.auth.formatdate') as mock_formatdate: + with mock.patch("botocore.auth.formatdate") as mock_formatdate: mock_formatdate.return_value = date yield @@ -887,90 +911,105 @@ class S3TestCase(unittest.TestCase): def test_request_signing1(self): # gets an object from the johnsmith bucket. - date = 'Tue, 27 Mar 2007 19:36:42 +0000' - req = Request('s3://johnsmith/photos/puppy.jpg', headers={'Date': date}) + date = "Tue, 27 Mar 2007 19:36:42 +0000" + req = Request("s3://johnsmith/photos/puppy.jpg", headers={"Date": date}) with self._mocked_date(date): httpreq = self.download_request(req, self.spider) - self.assertEqual(httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:xXjDGYUmKxnwqr5KXNPGldn5LbA=') + self.assertEqual( + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:xXjDGYUmKxnwqr5KXNPGldn5LbA=", + ) def test_request_signing2(self): # puts an object into the johnsmith bucket. - date = 'Tue, 27 Mar 2007 21:15:45 +0000' + date = "Tue, 27 Mar 2007 21:15:45 +0000" req = Request( - 's3://johnsmith/photos/puppy.jpg', - method='PUT', + "s3://johnsmith/photos/puppy.jpg", + method="PUT", headers={ - 'Content-Type': 'image/jpeg', - 'Date': date, - 'Content-Length': '94328', + "Content-Type": "image/jpeg", + "Date": date, + "Content-Length": "94328", }, ) with self._mocked_date(date): httpreq = self.download_request(req, self.spider) - self.assertEqual(httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:hcicpDDvL9SsO6AkvxqmIWkmOuQ=') + self.assertEqual( + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:hcicpDDvL9SsO6AkvxqmIWkmOuQ=", + ) def test_request_signing3(self): # lists the content of the johnsmith bucket. - date = 'Tue, 27 Mar 2007 19:42:41 +0000' + date = "Tue, 27 Mar 2007 19:42:41 +0000" req = Request( - 's3://johnsmith/?prefix=photos&max-keys=50&marker=puppy', - method='GET', headers={ - 'User-Agent': 'Mozilla/5.0', - 'Date': date, - }) - with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) - self.assertEqual(httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:jsRt/rhG+Vtp88HrYL706QhE4w4=') - - def test_request_signing4(self): - # fetches the access control policy sub-resource for the 'johnsmith' bucket. - date = 'Tue, 27 Mar 2007 19:44:46 +0000' - req = Request('s3://johnsmith/?acl', method='GET', headers={'Date': date}) - with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) - self.assertEqual(httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:thdUi9VAkzhkniLj96JIrOPGi0g=') - - def test_request_signing6(self): - # uploads an object to a CNAME style virtual hosted bucket with metadata. - date = 'Tue, 27 Mar 2007 21:06:08 +0000' - req = Request( - 's3://static.johnsmith.net:8080/db-backup.dat.gz', - method='PUT', headers={ - 'User-Agent': 'curl/7.15.5', - 'Host': 'static.johnsmith.net:8080', - 'Date': date, - 'x-amz-acl': 'public-read', - 'content-type': 'application/x-download', - 'Content-MD5': '4gJE4saaMU4BqNR0kLY+lw==', - 'X-Amz-Meta-ReviewedBy': 'joe@johnsmith.net,jane@johnsmith.net', - 'X-Amz-Meta-FileChecksum': '0x02661779', - 'X-Amz-Meta-ChecksumAlgorithm': 'crc32', - 'Content-Disposition': 'attachment; filename=database.dat', - 'Content-Encoding': 'gzip', - 'Content-Length': '5913339', - }) - with self._mocked_date(date): - httpreq = self.download_request(req, self.spider) - self.assertEqual(httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:C0FlOtU8Ylb9KDTpZqYkZPX91iI=') - - def test_request_signing7(self): - # ensure that spaces are quoted properly before signing - date = 'Tue, 27 Mar 2007 19:42:41 +0000' - req = Request( - "s3://johnsmith/photos/my puppy.jpg?response-content-disposition=my puppy.jpg", - method='GET', - headers={'Date': date}, + "s3://johnsmith/?prefix=photos&max-keys=50&marker=puppy", + method="GET", + headers={ + "User-Agent": "Mozilla/5.0", + "Date": date, + }, ) with self._mocked_date(date): httpreq = self.download_request(req, self.spider) self.assertEqual( - httpreq.headers['Authorization'], - b'AWS 0PN5J17HBGZHT7JJ3X82:+CfvG8EZ3YccOrRVMXNaK2eKZmM=') + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:jsRt/rhG+Vtp88HrYL706QhE4w4=", + ) + + def test_request_signing4(self): + # fetches the access control policy sub-resource for the 'johnsmith' bucket. + date = "Tue, 27 Mar 2007 19:44:46 +0000" + req = Request("s3://johnsmith/?acl", method="GET", headers={"Date": date}) + with self._mocked_date(date): + httpreq = self.download_request(req, self.spider) + self.assertEqual( + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:thdUi9VAkzhkniLj96JIrOPGi0g=", + ) + + def test_request_signing6(self): + # uploads an object to a CNAME style virtual hosted bucket with metadata. + date = "Tue, 27 Mar 2007 21:06:08 +0000" + req = Request( + "s3://static.johnsmith.net:8080/db-backup.dat.gz", + method="PUT", + headers={ + "User-Agent": "curl/7.15.5", + "Host": "static.johnsmith.net:8080", + "Date": date, + "x-amz-acl": "public-read", + "content-type": "application/x-download", + "Content-MD5": "4gJE4saaMU4BqNR0kLY+lw==", + "X-Amz-Meta-ReviewedBy": "joe@johnsmith.net,jane@johnsmith.net", + "X-Amz-Meta-FileChecksum": "0x02661779", + "X-Amz-Meta-ChecksumAlgorithm": "crc32", + "Content-Disposition": "attachment; filename=database.dat", + "Content-Encoding": "gzip", + "Content-Length": "5913339", + }, + ) + with self._mocked_date(date): + httpreq = self.download_request(req, self.spider) + self.assertEqual( + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:C0FlOtU8Ylb9KDTpZqYkZPX91iI=", + ) + + def test_request_signing7(self): + # ensure that spaces are quoted properly before signing + date = "Tue, 27 Mar 2007 19:42:41 +0000" + req = Request( + "s3://johnsmith/photos/my puppy.jpg?response-content-disposition=my puppy.jpg", + method="GET", + headers={"Date": date}, + ) + with self._mocked_date(date): + httpreq = self.download_request(req, self.spider) + self.assertEqual( + httpreq.headers["Authorization"], + b"AWS 0PN5J17HBGZHT7JJ3X82:+CfvG8EZ3YccOrRVMXNaK2eKZmM=", + ) class BaseFTPTestCase(unittest.TestCase): @@ -979,9 +1018,9 @@ class BaseFTPTestCase(unittest.TestCase): req_meta = {"ftp_user": username, "ftp_password": password} test_files = ( - ('file.txt', b"I have the power!"), - ('file with spaces.txt', b"Moooooooooo power!"), - ('html-file-without-extension', b"\n."), + ("file.txt", b"I have the power!"), + ("file with spaces.txt", b"Moooooooooo power!"), + ("html-file-without-extension", b"\n."), ) def setUp(self): @@ -997,7 +1036,9 @@ class BaseFTPTestCase(unittest.TestCase): (userdir / filename).write_bytes(content) # setup server - realm = FTPRealm(anonymousRoot=str(self.directory), userHome=str(self.directory)) + realm = FTPRealm( + anonymousRoot=str(self.directory), userHome=str(self.directory) + ) p = portal.Portal(realm) users_checker = checkers.InMemoryUsernamePasswordDatabaseDontUse() users_checker.addUser(self.username, self.password) @@ -1006,7 +1047,9 @@ class BaseFTPTestCase(unittest.TestCase): self.port = reactor.listenTCP(0, self.factory, interface="127.0.0.1") self.portNum = self.port.getHost().port crawler = get_crawler() - self.download_handler = create_instance(FTPDownloadHandler, crawler.settings, crawler) + self.download_handler = create_instance( + FTPDownloadHandler, crawler.settings, crawler + ) self.addCleanup(self.port.stopListening) def tearDown(self): @@ -1025,34 +1068,37 @@ class BaseFTPTestCase(unittest.TestCase): return deferred def test_ftp_download_success(self): - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", - meta=self.req_meta) - d = self.download_handler.download_request(request, None) - - def _test(r): - self.assertEqual(r.status, 200) - self.assertEqual(r.body, b'I have the power!') - self.assertEqual(r.headers, {b'Local Filename': [b''], b'Size': [b'17']}) - self.assertIsNone(r.protocol) - return self._add_test_callbacks(d, _test) - - def test_ftp_download_path_with_spaces(self): request = Request( - url=f"ftp://127.0.0.1:{self.portNum}/file with spaces.txt", - meta=self.req_meta + url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=self.req_meta ) d = self.download_handler.download_request(request, None) def _test(r): self.assertEqual(r.status, 200) - self.assertEqual(r.body, b'Moooooooooo power!') - self.assertEqual(r.headers, {b'Local Filename': [b''], b'Size': [b'18']}) + self.assertEqual(r.body, b"I have the power!") + self.assertEqual(r.headers, {b"Local Filename": [b""], b"Size": [b"17"]}) + self.assertIsNone(r.protocol) + + return self._add_test_callbacks(d, _test) + + def test_ftp_download_path_with_spaces(self): + request = Request( + url=f"ftp://127.0.0.1:{self.portNum}/file with spaces.txt", + meta=self.req_meta, + ) + d = self.download_handler.download_request(request, None) + + def _test(r): + self.assertEqual(r.status, 200) + self.assertEqual(r.body, b"Moooooooooo power!") + self.assertEqual(r.headers, {b"Local Filename": [b""], b"Size": [b"18"]}) return self._add_test_callbacks(d, _test) def test_ftp_download_notexist(self): - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/notexist.txt", - meta=self.req_meta) + request = Request( + url=f"ftp://127.0.0.1:{self.portNum}/notexist.txt", meta=self.req_meta + ) d = self.download_handler.download_request(request, None) def _test(r): @@ -1067,14 +1113,14 @@ class BaseFTPTestCase(unittest.TestCase): os.close(f) meta = {"ftp_local_filename": fname_bytes} meta.update(self.req_meta) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", - meta=meta) + request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=meta) d = self.download_handler.download_request(request, None) def _test(r): self.assertEqual(r.body, fname_bytes) - self.assertEqual(r.headers, {b'Local Filename': [fname_bytes], - b'Size': [b'17']}) + self.assertEqual( + r.headers, {b"Local Filename": [fname_bytes], b"Size": [b"17"]} + ) self.assertTrue(local_fname.exists()) self.assertEqual(local_fname.read_bytes(), b"I have the power!") local_fname.unlink() @@ -1087,24 +1133,23 @@ class BaseFTPTestCase(unittest.TestCase): os.close(f) meta = {} meta.update(self.req_meta) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/{filename}", - meta=meta) + request = Request(url=f"ftp://127.0.0.1:{self.portNum}/{filename}", meta=meta) d = self.download_handler.download_request(request, None) def _test(r): self.assertEqual(type(r), response_class) local_fname.unlink() + return self._add_test_callbacks(d, _test) def test_response_class_from_url(self): - return self._test_response_class('file.txt', TextResponse) + return self._test_response_class("file.txt", TextResponse) def test_response_class_from_body(self): - return self._test_response_class('html-file-without-extension', HtmlResponse) + return self._test_response_class("html-file-without-extension", HtmlResponse) class FTPTestCase(BaseFTPTestCase): - def test_invalid_credentials(self): if self.reactor_pytest == "asyncio" and sys.platform == "win32": raise unittest.SkipTest( @@ -1113,9 +1158,8 @@ class FTPTestCase(BaseFTPTestCase): from twisted.protocols.ftp import ConnectionLost meta = dict(self.req_meta) - meta.update({"ftp_password": 'invalid'}) - request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", - meta=meta) + meta.update({"ftp_password": "invalid"}) + request = Request(url=f"ftp://127.0.0.1:{self.portNum}/file.txt", meta=meta) d = self.download_handler.download_request(request, None) def _test(r): @@ -1142,15 +1186,15 @@ class AnonymousFTPTestCase(BaseFTPTestCase): # setup server for anonymous access realm = FTPRealm(anonymousRoot=str(self.directory)) p = portal.Portal(realm) - p.registerChecker(checkers.AllowAnonymousAccess(), - credentials.IAnonymous) + p.registerChecker(checkers.AllowAnonymousAccess(), credentials.IAnonymous) - self.factory = FTPFactory(portal=p, - userAnonymous=self.username) + self.factory = FTPFactory(portal=p, userAnonymous=self.username) self.port = reactor.listenTCP(0, self.factory, interface="127.0.0.1") self.portNum = self.port.getHost().port crawler = get_crawler() - self.download_handler = create_instance(FTPDownloadHandler, crawler.settings, crawler) + self.download_handler = create_instance( + FTPDownloadHandler, crawler.settings, crawler + ) self.addCleanup(self.port.stopListening) def tearDown(self): @@ -1158,12 +1202,13 @@ class AnonymousFTPTestCase(BaseFTPTestCase): class DataURITestCase(unittest.TestCase): - def setUp(self): crawler = get_crawler() - self.download_handler = create_instance(DataURIDownloadHandler, crawler.settings, crawler) + self.download_handler = create_instance( + DataURIDownloadHandler, crawler.settings, crawler + ) self.download_request = self.download_handler.download_request - self.spider = Spider('foo') + self.spider = Spider("foo") def test_response_attrs(self): uri = "data:,A%20brief%20note" @@ -1177,7 +1222,7 @@ class DataURITestCase(unittest.TestCase): def test_default_mediatype_encoding(self): def _test(response): - self.assertEqual(response.text, 'A brief note') + self.assertEqual(response.text, "A brief note") self.assertEqual(type(response), responsetypes.from_mimetype("text/plain")) self.assertEqual(response.encoding, "US-ASCII") @@ -1186,7 +1231,7 @@ class DataURITestCase(unittest.TestCase): def test_default_mediatype(self): def _test(response): - self.assertEqual(response.text, '\u038e\u03a3\u038e') + self.assertEqual(response.text, "\u038e\u03a3\u038e") self.assertEqual(type(response), responsetypes.from_mimetype("text/plain")) self.assertEqual(response.encoding, "iso-8859-7") @@ -1195,8 +1240,8 @@ class DataURITestCase(unittest.TestCase): def test_text_charset(self): def _test(response): - self.assertEqual(response.text, '\u038e\u03a3\u038e') - self.assertEqual(response.body, b'\xbe\xd3\xbe') + self.assertEqual(response.text, "\u038e\u03a3\u038e") + self.assertEqual(response.body, b"\xbe\xd3\xbe") self.assertEqual(response.encoding, "iso-8859-7") request = Request("data:text/plain;charset=iso-8859-7,%be%d3%be") @@ -1204,20 +1249,22 @@ class DataURITestCase(unittest.TestCase): def test_mediatype_parameters(self): def _test(response): - self.assertEqual(response.text, '\u038e\u03a3\u038e') + self.assertEqual(response.text, "\u038e\u03a3\u038e") self.assertEqual(type(response), responsetypes.from_mimetype("text/plain")) self.assertEqual(response.encoding, "utf-8") - request = Request('data:text/plain;foo=%22foo;bar%5C%22%22;' - 'charset=utf-8;bar=%22foo;%5C%22 foo ;/,%22' - ',%CE%8E%CE%A3%CE%8E') + request = Request( + "data:text/plain;foo=%22foo;bar%5C%22%22;" + "charset=utf-8;bar=%22foo;%5C%22 foo ;/,%22" + ",%CE%8E%CE%A3%CE%8E" + ) return self.download_request(request, self.spider).addCallback(_test) def test_base64(self): def _test(response): - self.assertEqual(response.text, 'Hello, world.') + self.assertEqual(response.text, "Hello, world.") - request = Request('data:text/plain;base64,SGVsbG8sIHdvcmxkLg%3D%3D') + request = Request("data:text/plain;base64,SGVsbG8sIHdvcmxkLg%3D%3D") return self.download_request(request, self.spider).addCallback(_test) def test_protocol(self): diff --git a/tests/test_downloader_handlers_http2.py b/tests/test_downloader_handlers_http2.py index c2fa3ec57..fd765089a 100644 --- a/tests/test_downloader_handlers_http2.py +++ b/tests/test_downloader_handlers_http2.py @@ -15,21 +15,24 @@ from scrapy.utils.misc import create_instance from scrapy.utils.test import get_crawler from tests.mockserver import ssl_context_factory from tests.test_downloader_handlers import ( - Https11TestCase, Https11CustomCiphers, - Http11MockServerTestCase, Http11ProxyTestCase, - UriResource + Https11TestCase, + Https11CustomCiphers, + Http11MockServerTestCase, + Http11ProxyTestCase, + UriResource, ) @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") class Https2TestCase(Https11TestCase): - scheme = 'https' + scheme = "https" HTTP2_DATALOSS_SKIP_REASON = "Content-Length mismatch raises InvalidBodyLengthError" @classmethod def setUpClass(cls): from scrapy.core.downloader.handlers.http2 import H2DownloadHandler + cls.download_handler_cls = H2DownloadHandler def test_protocol(self): @@ -41,13 +44,13 @@ class Https2TestCase(Https11TestCase): @defer.inlineCallbacks def test_download_with_maxsize_very_large_file(self): - with mock.patch('scrapy.core.http2.stream.logger') as logger: - request = Request(self.getURL('largechunkedfile')) + with mock.patch("scrapy.core.http2.stream.logger") as logger: + request = Request(self.getURL("largechunkedfile")) def check(logger): logger.error.assert_called_once_with(mock.ANY) - d = self.download_request(request, Spider('foo', download_maxsize=1500)) + d = self.download_request(request, Spider("foo", download_maxsize=1500)) yield self.assertFailure(d, defer.CancelledError, error.ConnectionAborted) # As the error message is logged in the dataReceived callback, we @@ -55,7 +58,7 @@ class Https2TestCase(Https11TestCase): # after closing the connection. d = defer.Deferred() d.addCallback(check) - reactor.callLater(.1, d.callback, logger) + reactor.callLater(0.1, d.callback, logger) yield d @defer.inlineCallbacks @@ -64,88 +67,86 @@ class Https2TestCase(Https11TestCase): d = self.download_request(request, Spider("foo")) yield self.assertFailure(d, SchemeNotSupported) - def test_download_broken_content_cause_data_loss(self, url='broken'): + def test_download_broken_content_cause_data_loss(self, url="broken"): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) def test_download_broken_chunked_content_cause_data_loss(self): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) - def test_download_broken_content_allow_data_loss(self, url='broken'): + def test_download_broken_content_allow_data_loss(self, url="broken"): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) def test_download_broken_chunked_content_allow_data_loss(self): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) - def test_download_broken_content_allow_data_loss_via_setting(self, url='broken'): + def test_download_broken_content_allow_data_loss_via_setting(self, url="broken"): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) def test_download_broken_chunked_content_allow_data_loss_via_setting(self): raise unittest.SkipTest(self.HTTP2_DATALOSS_SKIP_REASON) def test_concurrent_requests_same_domain(self): - spider = Spider('foo') + spider = Spider("foo") - request1 = Request(self.getURL('file')) + request1 = Request(self.getURL("file")) d1 = self.download_request(request1, spider) d1.addCallback(lambda r: r.body) d1.addCallback(self.assertEqual, b"0123456789") - request2 = Request(self.getURL('echo'), method='POST') + request2 = Request(self.getURL("echo"), method="POST") d2 = self.download_request(request2, spider) - d2.addCallback(lambda r: r.headers['Content-Length']) + d2.addCallback(lambda r: r.headers["Content-Length"]) d2.addCallback(self.assertEqual, b"79") return defer.DeferredList([d1, d2]) @mark.xfail(reason="https://github.com/python-hyper/h2/issues/1247") def test_connect_request(self): - request = Request(self.getURL('file'), method='CONNECT') - d = self.download_request(request, Spider('foo')) + request = Request(self.getURL("file"), method="CONNECT") + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.body) - d.addCallback(self.assertEqual, b'') + d.addCallback(self.assertEqual, b"") return d def test_custom_content_length_good(self): - request = Request(self.getURL('contentlength')) + request = Request(self.getURL("contentlength")) custom_content_length = str(len(request.body)) - request.headers['Content-Length'] = custom_content_length - d = self.download_request(request, Spider('foo')) + request.headers["Content-Length"] = custom_content_length + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.text) d.addCallback(self.assertEqual, custom_content_length) return d def test_custom_content_length_bad(self): - request = Request(self.getURL('contentlength')) + request = Request(self.getURL("contentlength")) actual_content_length = str(len(request.body)) bad_content_length = str(len(request.body) + 1) - request.headers['Content-Length'] = bad_content_length + request.headers["Content-Length"] = bad_content_length log = LogCapture() - d = self.download_request(request, Spider('foo')) + d = self.download_request(request, Spider("foo")) d.addCallback(lambda r: r.text) d.addCallback(self.assertEqual, actual_content_length) d.addCallback( lambda _: log.check_present( ( - 'scrapy.core.http2.stream', - 'WARNING', - f'Ignoring bad Content-Length header ' - f'{bad_content_length!r} of request {request}, sending ' - f'{actual_content_length!r} instead', + "scrapy.core.http2.stream", + "WARNING", + f"Ignoring bad Content-Length header " + f"{bad_content_length!r} of request {request}, sending " + f"{actual_content_length!r} instead", ) ) ) - d.addCallback( - lambda _: log.uninstall() - ) + d.addCallback(lambda _: log.uninstall()) return d def test_duplicate_header(self): - request = Request(self.getURL('echo')) - header, value1, value2 = 'Custom-Header', 'foo', 'bar' + request = Request(self.getURL("echo")) + header, value1, value2 = "Custom-Header", "foo", "bar" request.headers.appendlist(header, value1) request.headers.appendlist(header, value2) - d = self.download_request(request, Spider('foo')) - d.addCallback(lambda r: json.loads(r.text)['headers'][header]) + d = self.download_request(request, Spider("foo")) + d.addCallback(lambda r: json.loads(r.text)["headers"][header]) d.addCallback(self.assertEqual, [value1, value2]) return d @@ -163,8 +164,8 @@ class Https2WrongHostnameTestCase(Https2TestCase): # here we test that even if the server certificate is for another domain, # "www.example.com" in this case, # the tests still pass - keyfile = 'keys/example-com.key.pem' - certfile = 'keys/example-com.cert.pem' + keyfile = "keys/example-com.key.pem" + certfile = "keys/example-com.cert.pem" class Https2InvalidDNSId(Https2TestCase): @@ -172,14 +173,14 @@ class Https2InvalidDNSId(Https2TestCase): def setUp(self): super().setUp() - self.host = '127.0.0.1' + self.host = "127.0.0.1" class Https2InvalidDNSPattern(Https2TestCase): """Connect to HTTPS hosts where the certificate are issued to an ip instead of a domain.""" - keyfile = 'keys/localhost.ip.key' - certfile = 'keys/localhost.ip.crt' + keyfile = "keys/localhost.ip.key" + certfile = "keys/localhost.ip.crt" def setUp(self): try: @@ -195,19 +196,21 @@ class Https2InvalidDNSPattern(Https2TestCase): @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") class Https2CustomCiphers(Https11CustomCiphers): - scheme = 'https' + scheme = "https" @classmethod def setUpClass(cls): from scrapy.core.downloader.handlers.http2 import H2DownloadHandler + cls.download_handler_cls = H2DownloadHandler class Http2MockServerTestCase(Http11MockServerTestCase): """HTTP 2.0 test case with MockServer""" + settings_dict = { - 'DOWNLOAD_HANDLERS': { - 'https': 'scrapy.core.downloader.handlers.http2.H2DownloadHandler' + "DOWNLOAD_HANDLERS": { + "https": "scrapy.core.downloader.handlers.http2.H2DownloadHandler" } } @@ -215,28 +218,32 @@ class Http2MockServerTestCase(Http11MockServerTestCase): @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") class Https2ProxyTestCase(Http11ProxyTestCase): # only used for HTTPS tests - keyfile = 'keys/localhost.key' - certfile = 'keys/localhost.crt' + keyfile = "keys/localhost.key" + certfile = "keys/localhost.crt" - scheme = 'https' - host = '127.0.0.1' + scheme = "https" + host = "127.0.0.1" - expected_http_proxy_request_body = b'/' + expected_http_proxy_request_body = b"/" @classmethod def setUpClass(cls): from scrapy.core.downloader.handlers.http2 import H2DownloadHandler + cls.download_handler_cls = H2DownloadHandler def setUp(self): site = server.Site(UriResource(), timeout=None) self.port = reactor.listenSSL( - 0, site, + 0, + site, ssl_context_factory(self.keyfile, self.certfile), - interface=self.host + interface=self.host, ) self.portno = self.port.getHost().port - self.download_handler = create_instance(self.download_handler_cls, None, get_crawler()) + self.download_handler = create_instance( + self.download_handler_cls, None, get_crawler() + ) self.download_request = self.download_handler.download_request def getURL(self, path): diff --git a/tests/test_downloadermiddleware.py b/tests/test_downloadermiddleware.py index 38be915f2..d8e377519 100644 --- a/tests/test_downloadermiddleware.py +++ b/tests/test_downloadermiddleware.py @@ -21,14 +21,14 @@ class ManagerTestCase(TestCase): def setUp(self): self.crawler = get_crawler(Spider, self.settings_dict) - self.spider = self.crawler._create_spider('foo') + self.spider = self.crawler._create_spider("foo") self.mwman = DownloaderMiddlewareManager.from_crawler(self.crawler) # some mw depends on stats collector self.crawler.stats.open_spider(self.spider) return self.mwman.open_spider(self.spider) def tearDown(self): - self.crawler.stats.close_spider(self.spider, '') + self.crawler.stats.close_spider(self.spider, "") return self.mwman.close_spider(self.spider) def _download(self, request, response=None): @@ -57,7 +57,7 @@ class DefaultsTest(ManagerTestCase): """Tests default behavior with default settings""" def test_request_response(self): - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") resp = Response(req.url, status=200) ret = self._download(req, resp) self.assertTrue(isinstance(ret, Response), "Non-response returned") @@ -74,29 +74,41 @@ class DefaultsTest(ManagerTestCase): exceptions.IOError: Not a gzipped file """ - req = Request('http://example.com') - body = b'

You are being redirected

' - resp = Response(req.url, status=302, body=body, headers={ - 'Content-Length': str(len(body)), - 'Content-Type': 'text/html', - 'Content-Encoding': 'gzip', - 'Location': 'http://example.com/login', - }) + req = Request("http://example.com") + body = b"

You are being redirected

" + resp = Response( + req.url, + status=302, + body=body, + headers={ + "Content-Length": str(len(body)), + "Content-Type": "text/html", + "Content-Encoding": "gzip", + "Location": "http://example.com/login", + }, + ) ret = self._download(request=req, response=resp) - self.assertTrue(isinstance(ret, Request), - f"Not redirected: {ret!r}") - self.assertEqual(to_bytes(ret.url), resp.headers['Location'], - "Not redirected to location header") + self.assertTrue(isinstance(ret, Request), f"Not redirected: {ret!r}") + self.assertEqual( + to_bytes(ret.url), + resp.headers["Location"], + "Not redirected to location header", + ) def test_200_and_invalid_gzipped_body_must_fail(self): - req = Request('http://example.com') - body = b'

You are being redirected

' - resp = Response(req.url, status=200, body=body, headers={ - 'Content-Length': str(len(body)), - 'Content-Type': 'text/html', - 'Content-Encoding': 'gzip', - 'Location': 'http://example.com/login', - }) + req = Request("http://example.com") + body = b"

You are being redirected

" + resp = Response( + req.url, + status=200, + body=body, + headers={ + "Content-Length": str(len(body)), + "Content-Type": "text/html", + "Content-Encoding": "gzip", + "Location": "http://example.com/login", + }, + ) self.assertRaises(IOError, self._download, request=req, response=resp) @@ -104,7 +116,7 @@ class ResponseFromProcessRequestTest(ManagerTestCase): """Tests middleware returning a response from process_request.""" def test_download_func_not_called(self): - resp = Response('http://example.com/index.html') + resp = Response("http://example.com/index.html") class ResponseMiddleware: def process_request(self, request, spider): @@ -112,7 +124,7 @@ class ResponseFromProcessRequestTest(ManagerTestCase): self.mwman._add_middleware(ResponseMiddleware()) - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") download_func = mock.MagicMock() dfd = self.mwman.download(download_func, req, self.spider) results = [] @@ -127,7 +139,7 @@ class ProcessRequestInvalidOutput(ManagerTestCase): """Invalid return value for process_request method should raise an exception""" def test_invalid_process_request(self): - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") class InvalidProcessRequestMiddleware: def process_request(self, request, spider): @@ -146,7 +158,7 @@ class ProcessResponseInvalidOutput(ManagerTestCase): """Invalid return value for process_response method should raise an exception""" def test_invalid_process_response(self): - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") class InvalidProcessResponseMiddleware: def process_response(self, request, response, spider): @@ -165,7 +177,7 @@ class ProcessExceptionInvalidOutput(ManagerTestCase): """Invalid return value for process_exception method should raise an exception""" def test_invalid_process_exception(self): - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") class InvalidProcessExceptionMiddleware: def process_request(self, request, spider): @@ -187,7 +199,7 @@ class MiddlewareUsingDeferreds(ManagerTestCase): """Middlewares using Deferreds should work""" def test_deferred(self): - resp = Response('http://example.com/index.html') + resp = Response("http://example.com/index.html") class DeferredMiddleware: def cb(self, result): @@ -200,7 +212,7 @@ class MiddlewareUsingDeferreds(ManagerTestCase): return d self.mwman._add_middleware(DeferredMiddleware()) - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") download_func = mock.MagicMock() dfd = self.mwman.download(download_func, req, self.spider) results = [] @@ -211,12 +223,12 @@ class MiddlewareUsingDeferreds(ManagerTestCase): self.assertFalse(download_func.called) -@mark.usefixtures('reactor_pytest') +@mark.usefixtures("reactor_pytest") class MiddlewareUsingCoro(ManagerTestCase): """Middlewares using asyncio coroutines should work""" def test_asyncdef(self): - resp = Response('http://example.com/index.html') + resp = Response("http://example.com/index.html") class CoroMiddleware: async def process_request(self, request, spider): @@ -224,7 +236,7 @@ class MiddlewareUsingCoro(ManagerTestCase): return resp self.mwman._add_middleware(CoroMiddleware()) - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") download_func = mock.MagicMock() dfd = self.mwman.download(download_func, req, self.spider) results = [] @@ -236,7 +248,7 @@ class MiddlewareUsingCoro(ManagerTestCase): @mark.only_asyncio() def test_asyncdef_asyncio(self): - resp = Response('http://example.com/index.html') + resp = Response("http://example.com/index.html") class CoroMiddleware: async def process_request(self, request, spider): @@ -245,7 +257,7 @@ class MiddlewareUsingCoro(ManagerTestCase): return result self.mwman._add_middleware(CoroMiddleware()) - req = Request('http://example.com/index.html') + req = Request("http://example.com/index.html") download_func = mock.MagicMock() dfd = self.mwman.download(download_func, req, self.spider) results = [] diff --git a/tests/test_downloadermiddleware_ajaxcrawlable.py b/tests/test_downloadermiddleware_ajaxcrawlable.py index 5a56c9db2..6be107f6f 100644 --- a/tests/test_downloadermiddleware_ajaxcrawlable.py +++ b/tests/test_downloadermiddleware_ajaxcrawlable.py @@ -6,13 +6,13 @@ from scrapy.http import Request, HtmlResponse, Response from scrapy.utils.test import get_crawler -__doctests__ = ['scrapy.downloadermiddlewares.ajaxcrawl'] +__doctests__ = ["scrapy.downloadermiddlewares.ajaxcrawl"] class AjaxCrawlMiddlewareTest(unittest.TestCase): def setUp(self): - crawler = get_crawler(Spider, {'AJAXCRAWL_ENABLED': True}) - self.spider = crawler._create_spider('foo') + crawler = get_crawler(Spider, {"AJAXCRAWL_ENABLED": True}) + self.spider = crawler._create_spider("foo") self.mw = AjaxCrawlMiddleware.from_crawler(crawler) def _ajaxcrawlable_body(self): @@ -24,37 +24,41 @@ class AjaxCrawlMiddlewareTest(unittest.TestCase): return req, resp def test_non_get(self): - req, resp = self._req_resp('http://example.com/', {'method': 'HEAD'}) + req, resp = self._req_resp("http://example.com/", {"method": "HEAD"}) resp2 = self.mw.process_response(req, resp, self.spider) self.assertEqual(resp, resp2) def test_binary_response(self): - req = Request('http://example.com/') - resp = Response('http://example.com/', body=b'foobar\x00\x01\x02', request=req) + req = Request("http://example.com/") + resp = Response("http://example.com/", body=b"foobar\x00\x01\x02", request=req) resp2 = self.mw.process_response(req, resp, self.spider) self.assertIs(resp, resp2) def test_ajaxcrawl(self): req, resp = self._req_resp( - 'http://example.com/', - {'meta': {'foo': 'bar'}}, - {'body': self._ajaxcrawlable_body()} + "http://example.com/", + {"meta": {"foo": "bar"}}, + {"body": self._ajaxcrawlable_body()}, ) req2 = self.mw.process_response(req, resp, self.spider) - self.assertEqual(req2.url, 'http://example.com/?_escaped_fragment_=') - self.assertEqual(req2.meta['foo'], 'bar') + self.assertEqual(req2.url, "http://example.com/?_escaped_fragment_=") + self.assertEqual(req2.meta["foo"], "bar") def test_ajaxcrawl_loop(self): - req, resp = self._req_resp('http://example.com/', {}, {'body': self._ajaxcrawlable_body()}) + req, resp = self._req_resp( + "http://example.com/", {}, {"body": self._ajaxcrawlable_body()} + ) req2 = self.mw.process_response(req, resp, self.spider) resp2 = HtmlResponse(req2.url, body=resp.body, request=req2) resp3 = self.mw.process_response(req2, resp2, self.spider) assert isinstance(resp3, HtmlResponse), (resp3.__class__, resp3) - self.assertEqual(resp3.request.url, 'http://example.com/?_escaped_fragment_=') + self.assertEqual(resp3.request.url, "http://example.com/?_escaped_fragment_=") assert resp3 is resp2 def test_noncrawlable_body(self): - req, resp = self._req_resp('http://example.com/', {}, {'body': b''}) + req, resp = self._req_resp( + "http://example.com/", {}, {"body": b""} + ) resp2 = self.mw.process_response(req, resp, self.spider) self.assertIs(resp, resp2) diff --git a/tests/test_downloadermiddleware_cookies.py b/tests/test_downloadermiddleware_cookies.py index dd835b9c9..812c003da 100644 --- a/tests/test_downloadermiddleware_cookies.py +++ b/tests/test_downloadermiddleware_cookies.py @@ -48,24 +48,18 @@ def _cookies_to_set_cookie_list(cookies): return [] if isinstance(cookies, dict): cookies = ({"name": k, "value": v} for k, v in cookies.items()) - return filter( - None, - ( - _cookie_to_set_cookie_value(cookie) - for cookie in cookies - ) - ) + return filter(None, (_cookie_to_set_cookie_value(cookie) for cookie in cookies)) class CookiesMiddlewareTest(TestCase): - def assertCookieValEqual(self, first, second, msg=None): def split_cookies(cookies): return sorted([s.strip() for s in to_bytes(cookies).split(b";")]) + return self.assertEqual(split_cookies(first), split_cookies(second), msg=msg) def setUp(self): - self.spider = Spider('foo') + self.spider = Spider("foo") self.mw = CookiesMiddleware() self.redirect_middleware = RedirectMiddleware(settings=Settings()) @@ -74,346 +68,391 @@ class CookiesMiddlewareTest(TestCase): del self.redirect_middleware def test_basic(self): - req = Request('http://scrapytest.org/') + req = Request("http://scrapytest.org/") assert self.mw.process_request(req, self.spider) is None - assert 'Cookie' not in req.headers + assert "Cookie" not in req.headers - headers = {'Set-Cookie': 'C1=value1; path=/'} - res = Response('http://scrapytest.org/', headers=headers) + headers = {"Set-Cookie": "C1=value1; path=/"} + res = Response("http://scrapytest.org/", headers=headers) assert self.mw.process_response(req, res, self.spider) is res - req2 = Request('http://scrapytest.org/sub1/') + req2 = Request("http://scrapytest.org/sub1/") assert self.mw.process_request(req2, self.spider) is None - self.assertEqual(req2.headers.get('Cookie'), b"C1=value1") + self.assertEqual(req2.headers.get("Cookie"), b"C1=value1") def test_setting_false_cookies_enabled(self): self.assertRaises( NotConfigured, CookiesMiddleware.from_crawler, - get_crawler(settings_dict={'COOKIES_ENABLED': False}) + get_crawler(settings_dict={"COOKIES_ENABLED": False}), ) def test_setting_default_cookies_enabled(self): self.assertIsInstance( - CookiesMiddleware.from_crawler(get_crawler()), - CookiesMiddleware + CookiesMiddleware.from_crawler(get_crawler()), CookiesMiddleware ) def test_setting_true_cookies_enabled(self): self.assertIsInstance( CookiesMiddleware.from_crawler( - get_crawler(settings_dict={'COOKIES_ENABLED': True}) + get_crawler(settings_dict={"COOKIES_ENABLED": True}) ), - CookiesMiddleware + CookiesMiddleware, ) def test_setting_enabled_cookies_debug(self): - crawler = get_crawler(settings_dict={'COOKIES_DEBUG': True}) + crawler = get_crawler(settings_dict={"COOKIES_DEBUG": True}) mw = CookiesMiddleware.from_crawler(crawler) with LogCapture( - 'scrapy.downloadermiddlewares.cookies', + "scrapy.downloadermiddlewares.cookies", propagate=False, level=logging.DEBUG, ) as log: - req = Request('http://scrapytest.org/') - res = Response('http://scrapytest.org/', headers={'Set-Cookie': 'C1=value1; path=/'}) + req = Request("http://scrapytest.org/") + res = Response( + "http://scrapytest.org/", headers={"Set-Cookie": "C1=value1; path=/"} + ) mw.process_response(req, res, crawler.spider) - req2 = Request('http://scrapytest.org/sub1/') + req2 = Request("http://scrapytest.org/sub1/") mw.process_request(req2, crawler.spider) log.check( - ('scrapy.downloadermiddlewares.cookies', - 'DEBUG', - 'Received cookies from: <200 http://scrapytest.org/>\n' - 'Set-Cookie: C1=value1; path=/\n'), - ('scrapy.downloadermiddlewares.cookies', - 'DEBUG', - 'Sending cookies to: \n' - 'Cookie: C1=value1\n'), + ( + "scrapy.downloadermiddlewares.cookies", + "DEBUG", + "Received cookies from: <200 http://scrapytest.org/>\n" + "Set-Cookie: C1=value1; path=/\n", + ), + ( + "scrapy.downloadermiddlewares.cookies", + "DEBUG", + "Sending cookies to: \n" + "Cookie: C1=value1\n", + ), ) def test_setting_disabled_cookies_debug(self): - crawler = get_crawler(settings_dict={'COOKIES_DEBUG': False}) + crawler = get_crawler(settings_dict={"COOKIES_DEBUG": False}) mw = CookiesMiddleware.from_crawler(crawler) with LogCapture( - 'scrapy.downloadermiddlewares.cookies', + "scrapy.downloadermiddlewares.cookies", propagate=False, level=logging.DEBUG, ) as log: - req = Request('http://scrapytest.org/') - res = Response('http://scrapytest.org/', headers={'Set-Cookie': 'C1=value1; path=/'}) + req = Request("http://scrapytest.org/") + res = Response( + "http://scrapytest.org/", headers={"Set-Cookie": "C1=value1; path=/"} + ) mw.process_response(req, res, crawler.spider) - req2 = Request('http://scrapytest.org/sub1/') + req2 = Request("http://scrapytest.org/sub1/") mw.process_request(req2, crawler.spider) log.check() def test_do_not_break_on_non_utf8_header(self): - req = Request('http://scrapytest.org/') + req = Request("http://scrapytest.org/") assert self.mw.process_request(req, self.spider) is None - assert 'Cookie' not in req.headers + assert "Cookie" not in req.headers - headers = {'Set-Cookie': b'C1=in\xa3valid; path=/', 'Other': b'ignore\xa3me'} - res = Response('http://scrapytest.org/', headers=headers) + headers = {"Set-Cookie": b"C1=in\xa3valid; path=/", "Other": b"ignore\xa3me"} + res = Response("http://scrapytest.org/", headers=headers) assert self.mw.process_response(req, res, self.spider) is res - req2 = Request('http://scrapytest.org/sub1/') + req2 = Request("http://scrapytest.org/sub1/") assert self.mw.process_request(req2, self.spider) is None - self.assertIn('Cookie', req2.headers) + self.assertIn("Cookie", req2.headers) def test_dont_merge_cookies(self): # merge some cookies into jar - headers = {'Set-Cookie': 'C1=value1; path=/'} - req = Request('http://scrapytest.org/') - res = Response('http://scrapytest.org/', headers=headers) + headers = {"Set-Cookie": "C1=value1; path=/"} + req = Request("http://scrapytest.org/") + res = Response("http://scrapytest.org/", headers=headers) assert self.mw.process_response(req, res, self.spider) is res # test Cookie header is not seted to request - req = Request('http://scrapytest.org/dontmerge', meta={'dont_merge_cookies': 1}) + req = Request("http://scrapytest.org/dontmerge", meta={"dont_merge_cookies": 1}) assert self.mw.process_request(req, self.spider) is None - assert 'Cookie' not in req.headers + assert "Cookie" not in req.headers # check that returned cookies are not merged back to jar res = Response( - 'http://scrapytest.org/dontmerge', - headers={'Set-Cookie': 'dont=mergeme; path=/'}, + "http://scrapytest.org/dontmerge", + headers={"Set-Cookie": "dont=mergeme; path=/"}, ) assert self.mw.process_response(req, res, self.spider) is res # check that cookies are merged back - req = Request('http://scrapytest.org/mergeme') + req = Request("http://scrapytest.org/mergeme") assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers.get('Cookie'), b'C1=value1') + self.assertEqual(req.headers.get("Cookie"), b"C1=value1") # check that cookies are merged when dont_merge_cookies is passed as 0 - req = Request('http://scrapytest.org/mergeme', meta={'dont_merge_cookies': 0}) + req = Request("http://scrapytest.org/mergeme", meta={"dont_merge_cookies": 0}) assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers.get('Cookie'), b'C1=value1') + self.assertEqual(req.headers.get("Cookie"), b"C1=value1") def test_complex_cookies(self): # merge some cookies into jar cookies = [ - {'name': 'C1', 'value': 'value1', 'path': '/foo', 'domain': 'scrapytest.org'}, - {'name': 'C2', 'value': 'value2', 'path': '/bar', 'domain': 'scrapytest.org'}, - {'name': 'C3', 'value': 'value3', 'path': '/foo', 'domain': 'scrapytest.org'}, - {'name': 'C4', 'value': 'value4', 'path': '/foo', 'domain': 'scrapy.org'}, + { + "name": "C1", + "value": "value1", + "path": "/foo", + "domain": "scrapytest.org", + }, + { + "name": "C2", + "value": "value2", + "path": "/bar", + "domain": "scrapytest.org", + }, + { + "name": "C3", + "value": "value3", + "path": "/foo", + "domain": "scrapytest.org", + }, + {"name": "C4", "value": "value4", "path": "/foo", "domain": "scrapy.org"}, ] - req = Request('http://scrapytest.org/', cookies=cookies) + req = Request("http://scrapytest.org/", cookies=cookies) self.mw.process_request(req, self.spider) # embed C1 and C3 for scrapytest.org/foo - req = Request('http://scrapytest.org/foo') + req = Request("http://scrapytest.org/foo") self.mw.process_request(req, self.spider) - assert req.headers.get('Cookie') in (b'C1=value1; C3=value3', b'C3=value3; C1=value1') + assert req.headers.get("Cookie") in ( + b"C1=value1; C3=value3", + b"C3=value3; C1=value1", + ) # embed C2 for scrapytest.org/bar - req = Request('http://scrapytest.org/bar') + req = Request("http://scrapytest.org/bar") self.mw.process_request(req, self.spider) - self.assertEqual(req.headers.get('Cookie'), b'C2=value2') + self.assertEqual(req.headers.get("Cookie"), b"C2=value2") # embed nothing for scrapytest.org/baz - req = Request('http://scrapytest.org/baz') + req = Request("http://scrapytest.org/baz") self.mw.process_request(req, self.spider) - assert 'Cookie' not in req.headers + assert "Cookie" not in req.headers def test_merge_request_cookies(self): - req = Request('http://scrapytest.org/', cookies={'galleta': 'salada'}) + req = Request("http://scrapytest.org/", cookies={"galleta": "salada"}) assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers.get('Cookie'), b'galleta=salada') + self.assertEqual(req.headers.get("Cookie"), b"galleta=salada") - headers = {'Set-Cookie': 'C1=value1; path=/'} - res = Response('http://scrapytest.org/', headers=headers) + headers = {"Set-Cookie": "C1=value1; path=/"} + res = Response("http://scrapytest.org/", headers=headers) assert self.mw.process_response(req, res, self.spider) is res - req2 = Request('http://scrapytest.org/sub1/') + req2 = Request("http://scrapytest.org/sub1/") assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers.get('Cookie'), b"C1=value1; galleta=salada") + self.assertCookieValEqual( + req2.headers.get("Cookie"), b"C1=value1; galleta=salada" + ) def test_cookiejar_key(self): req = Request( - 'http://scrapytest.org/', - cookies={'galleta': 'salada'}, - meta={'cookiejar': "store1"}, + "http://scrapytest.org/", + cookies={"galleta": "salada"}, + meta={"cookiejar": "store1"}, ) assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers.get('Cookie'), b'galleta=salada') + self.assertEqual(req.headers.get("Cookie"), b"galleta=salada") - headers = {'Set-Cookie': 'C1=value1; path=/'} - res = Response('http://scrapytest.org/', headers=headers, request=req) + headers = {"Set-Cookie": "C1=value1; path=/"} + res = Response("http://scrapytest.org/", headers=headers, request=req) assert self.mw.process_response(req, res, self.spider) is res - req2 = Request('http://scrapytest.org/', meta=res.meta) + req2 = Request("http://scrapytest.org/", meta=res.meta) assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers.get('Cookie'), b'C1=value1; galleta=salada') + self.assertCookieValEqual( + req2.headers.get("Cookie"), b"C1=value1; galleta=salada" + ) req3 = Request( - 'http://scrapytest.org/', - cookies={'galleta': 'dulce'}, - meta={'cookiejar': "store2"}, + "http://scrapytest.org/", + cookies={"galleta": "dulce"}, + meta={"cookiejar": "store2"}, ) assert self.mw.process_request(req3, self.spider) is None - self.assertEqual(req3.headers.get('Cookie'), b'galleta=dulce') + self.assertEqual(req3.headers.get("Cookie"), b"galleta=dulce") - headers = {'Set-Cookie': 'C2=value2; path=/'} - res2 = Response('http://scrapytest.org/', headers=headers, request=req3) + headers = {"Set-Cookie": "C2=value2; path=/"} + res2 = Response("http://scrapytest.org/", headers=headers, request=req3) assert self.mw.process_response(req3, res2, self.spider) is res2 - req4 = Request('http://scrapytest.org/', meta=res2.meta) + req4 = Request("http://scrapytest.org/", meta=res2.meta) assert self.mw.process_request(req4, self.spider) is None - self.assertCookieValEqual(req4.headers.get('Cookie'), b'C2=value2; galleta=dulce') + self.assertCookieValEqual( + req4.headers.get("Cookie"), b"C2=value2; galleta=dulce" + ) # cookies from hosts with port - req5_1 = Request('http://scrapytest.org:1104/') + req5_1 = Request("http://scrapytest.org:1104/") assert self.mw.process_request(req5_1, self.spider) is None - headers = {'Set-Cookie': 'C1=value1; path=/'} - res5_1 = Response('http://scrapytest.org:1104/', headers=headers, request=req5_1) + headers = {"Set-Cookie": "C1=value1; path=/"} + res5_1 = Response( + "http://scrapytest.org:1104/", headers=headers, request=req5_1 + ) assert self.mw.process_response(req5_1, res5_1, self.spider) is res5_1 - req5_2 = Request('http://scrapytest.org:1104/some-redirected-path') + req5_2 = Request("http://scrapytest.org:1104/some-redirected-path") assert self.mw.process_request(req5_2, self.spider) is None - self.assertEqual(req5_2.headers.get('Cookie'), b'C1=value1') + self.assertEqual(req5_2.headers.get("Cookie"), b"C1=value1") - req5_3 = Request('http://scrapytest.org/some-redirected-path') + req5_3 = Request("http://scrapytest.org/some-redirected-path") assert self.mw.process_request(req5_3, self.spider) is None - self.assertEqual(req5_3.headers.get('Cookie'), b'C1=value1') + self.assertEqual(req5_3.headers.get("Cookie"), b"C1=value1") # skip cookie retrieval for not http request - req6 = Request('file:///scrapy/sometempfile') + req6 = Request("file:///scrapy/sometempfile") assert self.mw.process_request(req6, self.spider) is None - self.assertEqual(req6.headers.get('Cookie'), None) + self.assertEqual(req6.headers.get("Cookie"), None) def test_local_domain(self): - request = Request("http://example-host/", cookies={'currencyCookie': 'USD'}) + request = Request("http://example-host/", cookies={"currencyCookie": "USD"}) assert self.mw.process_request(request, self.spider) is None - self.assertIn('Cookie', request.headers) - self.assertEqual(b'currencyCookie=USD', request.headers['Cookie']) + self.assertIn("Cookie", request.headers) + self.assertEqual(b"currencyCookie=USD", request.headers["Cookie"]) @pytest.mark.xfail(reason="Cookie header is not currently being processed") def test_keep_cookie_from_default_request_headers_middleware(self): - DEFAULT_REQUEST_HEADERS = dict(Cookie='default=value; asdf=qwerty') + DEFAULT_REQUEST_HEADERS = dict(Cookie="default=value; asdf=qwerty") mw_default_headers = DefaultHeadersMiddleware(DEFAULT_REQUEST_HEADERS.items()) # overwrite with values from 'cookies' request argument - req1 = Request('http://example.org', cookies={'default': 'something'}) + req1 = Request("http://example.org", cookies={"default": "something"}) assert mw_default_headers.process_request(req1, self.spider) is None assert self.mw.process_request(req1, self.spider) is None - self.assertCookieValEqual(req1.headers['Cookie'], b'default=something; asdf=qwerty') + self.assertCookieValEqual( + req1.headers["Cookie"], b"default=something; asdf=qwerty" + ) # keep both - req2 = Request('http://example.com', cookies={'a': 'b'}) + req2 = Request("http://example.com", cookies={"a": "b"}) assert mw_default_headers.process_request(req2, self.spider) is None assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers['Cookie'], b'default=value; a=b; asdf=qwerty') + self.assertCookieValEqual( + req2.headers["Cookie"], b"default=value; a=b; asdf=qwerty" + ) @pytest.mark.xfail(reason="Cookie header is not currently being processed") def test_keep_cookie_header(self): # keep only cookies from 'Cookie' request header - req1 = Request('http://scrapytest.org', headers={'Cookie': 'a=b; c=d'}) + req1 = Request("http://scrapytest.org", headers={"Cookie": "a=b; c=d"}) assert self.mw.process_request(req1, self.spider) is None - self.assertCookieValEqual(req1.headers['Cookie'], 'a=b; c=d') + self.assertCookieValEqual(req1.headers["Cookie"], "a=b; c=d") # keep cookies from both 'Cookie' request header and 'cookies' keyword - req2 = Request('http://scrapytest.org', headers={'Cookie': 'a=b; c=d'}, cookies={'e': 'f'}) + req2 = Request( + "http://scrapytest.org", headers={"Cookie": "a=b; c=d"}, cookies={"e": "f"} + ) assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers['Cookie'], 'a=b; c=d; e=f') + self.assertCookieValEqual(req2.headers["Cookie"], "a=b; c=d; e=f") # overwrite values from 'Cookie' request header with 'cookies' keyword req3 = Request( - 'http://scrapytest.org', - headers={'Cookie': 'a=b; c=d'}, - cookies={'a': 'new', 'e': 'f'}, + "http://scrapytest.org", + headers={"Cookie": "a=b; c=d"}, + cookies={"a": "new", "e": "f"}, ) assert self.mw.process_request(req3, self.spider) is None - self.assertCookieValEqual(req3.headers['Cookie'], 'a=new; c=d; e=f') + self.assertCookieValEqual(req3.headers["Cookie"], "a=new; c=d; e=f") def test_request_cookies_encoding(self): # 1) UTF8-encoded bytes - req1 = Request('http://example.org', cookies={'a': 'á'.encode('utf8')}) + req1 = Request("http://example.org", cookies={"a": "á".encode("utf8")}) assert self.mw.process_request(req1, self.spider) is None - self.assertCookieValEqual(req1.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req1.headers["Cookie"], b"a=\xc3\xa1") # 2) Non UTF8-encoded bytes - req2 = Request('http://example.org', cookies={'a': 'á'.encode('latin1')}) + req2 = Request("http://example.org", cookies={"a": "á".encode("latin1")}) assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req2.headers["Cookie"], b"a=\xc3\xa1") # 3) String - req3 = Request('http://example.org', cookies={'a': 'á'}) + req3 = Request("http://example.org", cookies={"a": "á"}) assert self.mw.process_request(req3, self.spider) is None - self.assertCookieValEqual(req3.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req3.headers["Cookie"], b"a=\xc3\xa1") @pytest.mark.xfail(reason="Cookie header is not currently being processed") def test_request_headers_cookie_encoding(self): # 1) UTF8-encoded bytes - req1 = Request('http://example.org', headers={'Cookie': 'a=á'.encode('utf8')}) + req1 = Request("http://example.org", headers={"Cookie": "a=á".encode("utf8")}) assert self.mw.process_request(req1, self.spider) is None - self.assertCookieValEqual(req1.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req1.headers["Cookie"], b"a=\xc3\xa1") # 2) Non UTF8-encoded bytes - req2 = Request('http://example.org', headers={'Cookie': 'a=á'.encode('latin1')}) + req2 = Request("http://example.org", headers={"Cookie": "a=á".encode("latin1")}) assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req2.headers["Cookie"], b"a=\xc3\xa1") # 3) String - req3 = Request('http://example.org', headers={'Cookie': 'a=á'}) + req3 = Request("http://example.org", headers={"Cookie": "a=á"}) assert self.mw.process_request(req3, self.spider) is None - self.assertCookieValEqual(req3.headers['Cookie'], b'a=\xc3\xa1') + self.assertCookieValEqual(req3.headers["Cookie"], b"a=\xc3\xa1") def test_invalid_cookies(self): """ Invalid cookies are logged as warnings and discarded """ with LogCapture( - 'scrapy.downloadermiddlewares.cookies', + "scrapy.downloadermiddlewares.cookies", propagate=False, level=logging.INFO, ) as lc: - cookies1 = [{'value': 'bar'}, {'name': 'key', 'value': 'value1'}] - req1 = Request('http://example.org/1', cookies=cookies1) + cookies1 = [{"value": "bar"}, {"name": "key", "value": "value1"}] + req1 = Request("http://example.org/1", cookies=cookies1) assert self.mw.process_request(req1, self.spider) is None - cookies2 = [{'name': 'foo'}, {'name': 'key', 'value': 'value2'}] - req2 = Request('http://example.org/2', cookies=cookies2) + cookies2 = [{"name": "foo"}, {"name": "key", "value": "value2"}] + req2 = Request("http://example.org/2", cookies=cookies2) assert self.mw.process_request(req2, self.spider) is None - cookies3 = [{'name': 'foo', 'value': None}, {'name': 'key', 'value': ''}] - req3 = Request('http://example.org/3', cookies=cookies3) + cookies3 = [{"name": "foo", "value": None}, {"name": "key", "value": ""}] + req3 = Request("http://example.org/3", cookies=cookies3) assert self.mw.process_request(req3, self.spider) is None lc.check( - ("scrapy.downloadermiddlewares.cookies", - "WARNING", - "Invalid cookie found in request :" - " {'value': 'bar'} ('name' is missing)"), - ("scrapy.downloadermiddlewares.cookies", - "WARNING", - "Invalid cookie found in request :" - " {'name': 'foo'} ('value' is missing)"), - ("scrapy.downloadermiddlewares.cookies", - "WARNING", - "Invalid cookie found in request :" - " {'name': 'foo', 'value': None} ('value' is missing)"), + ( + "scrapy.downloadermiddlewares.cookies", + "WARNING", + "Invalid cookie found in request :" + " {'value': 'bar'} ('name' is missing)", + ), + ( + "scrapy.downloadermiddlewares.cookies", + "WARNING", + "Invalid cookie found in request :" + " {'name': 'foo'} ('value' is missing)", + ), + ( + "scrapy.downloadermiddlewares.cookies", + "WARNING", + "Invalid cookie found in request :" + " {'name': 'foo', 'value': None} ('value' is missing)", + ), ) - self.assertCookieValEqual(req1.headers['Cookie'], 'key=value1') - self.assertCookieValEqual(req2.headers['Cookie'], 'key=value2') - self.assertCookieValEqual(req3.headers['Cookie'], 'key=') + self.assertCookieValEqual(req1.headers["Cookie"], "key=value1") + self.assertCookieValEqual(req2.headers["Cookie"], "key=value2") + self.assertCookieValEqual(req3.headers["Cookie"], "key=") def test_primitive_type_cookies(self): # Boolean - req1 = Request('http://example.org', cookies={'a': True}) + req1 = Request("http://example.org", cookies={"a": True}) assert self.mw.process_request(req1, self.spider) is None - self.assertCookieValEqual(req1.headers['Cookie'], b'a=True') + self.assertCookieValEqual(req1.headers["Cookie"], b"a=True") # Float - req2 = Request('http://example.org', cookies={'a': 9.5}) + req2 = Request("http://example.org", cookies={"a": 9.5}) assert self.mw.process_request(req2, self.spider) is None - self.assertCookieValEqual(req2.headers['Cookie'], b'a=9.5') + self.assertCookieValEqual(req2.headers["Cookie"], b"a=9.5") # Integer - req3 = Request('http://example.org', cookies={'a': 10}) + req3 = Request("http://example.org", cookies={"a": 10}) assert self.mw.process_request(req3, self.spider) is None - self.assertCookieValEqual(req3.headers['Cookie'], b'a=10') + self.assertCookieValEqual(req3.headers["Cookie"], b"a=10") # String - req4 = Request('http://example.org', cookies={'a': 'b'}) + req4 = Request("http://example.org", cookies={"a": "b"}) assert self.mw.process_request(req4, self.spider) is None - self.assertCookieValEqual(req4.headers['Cookie'], b'a=b') + self.assertCookieValEqual(req4.headers["Cookie"], b"a=b") def _test_cookie_redirect( self, @@ -423,22 +462,22 @@ class CookiesMiddlewareTest(TestCase): cookies1, cookies2, ): - input_cookies = {'a': 'b'} + input_cookies = {"a": "b"} if not isinstance(source, dict): - source = {'url': source} + source = {"url": source} if not isinstance(target, dict): - target = {'url': target} - target.setdefault('status', 301) + target = {"url": target} + target.setdefault("status", 301) request1 = Request(cookies=input_cookies, **source) self.mw.process_request(request1, self.spider) - cookies = request1.headers.get('Cookie') + cookies = request1.headers.get("Cookie") self.assertEqual(cookies, b"a=b" if cookies1 else None) response = Response( headers={ - 'Location': target['url'], + "Location": target["url"], }, **target, ) @@ -455,37 +494,37 @@ class CookiesMiddlewareTest(TestCase): self.assertIsInstance(request2, Request) self.mw.process_request(request2, self.spider) - cookies = request2.headers.get('Cookie') + cookies = request2.headers.get("Cookie") self.assertEqual(cookies, b"a=b" if cookies2 else None) def test_cookie_redirect_same_domain(self): self._test_cookie_redirect( - 'https://toscrape.com', - 'https://toscrape.com', + "https://toscrape.com", + "https://toscrape.com", cookies1=True, cookies2=True, ) def test_cookie_redirect_same_domain_forcing_get(self): self._test_cookie_redirect( - 'https://toscrape.com', - {'url': 'https://toscrape.com', 'status': 302}, + "https://toscrape.com", + {"url": "https://toscrape.com", "status": 302}, cookies1=True, cookies2=True, ) def test_cookie_redirect_different_domain(self): self._test_cookie_redirect( - 'https://toscrape.com', - 'https://example.com', + "https://toscrape.com", + "https://example.com", cookies1=True, cookies2=False, ) def test_cookie_redirect_different_domain_forcing_get(self): self._test_cookie_redirect( - 'https://toscrape.com', - {'url': 'https://example.com', 'status': 302}, + "https://toscrape.com", + {"url": "https://example.com", "status": 302}, cookies1=True, cookies2=False, ) @@ -514,16 +553,16 @@ class CookiesMiddlewareTest(TestCase): because the middleware empties the header from every request. """ if not isinstance(source, dict): - source = {'url': source} + source = {"url": source} if not isinstance(target, dict): - target = {'url': target} - target.setdefault('status', 301) + target = {"url": target} + target.setdefault("status", 301) - request1 = Request(headers={'Cookie': b'a=b'}, **source) + request1 = Request(headers={"Cookie": b"a=b"}, **source) response = Response( headers={ - 'Location': target['url'], + "Location": target["url"], }, **target, ) @@ -535,34 +574,34 @@ class CookiesMiddlewareTest(TestCase): ) self.assertIsInstance(request2, Request) - cookies = request2.headers.get('Cookie') + cookies = request2.headers.get("Cookie") self.assertEqual(cookies, b"a=b" if cookies2 else None) def test_cookie_header_redirect_same_domain(self): self._test_cookie_header_redirect( - 'https://toscrape.com', - 'https://toscrape.com', + "https://toscrape.com", + "https://toscrape.com", cookies2=True, ) def test_cookie_header_redirect_same_domain_forcing_get(self): self._test_cookie_header_redirect( - 'https://toscrape.com', - {'url': 'https://toscrape.com', 'status': 302}, + "https://toscrape.com", + {"url": "https://toscrape.com", "status": 302}, cookies2=True, ) def test_cookie_header_redirect_different_domain(self): self._test_cookie_header_redirect( - 'https://toscrape.com', - 'https://example.com', + "https://toscrape.com", + "https://example.com", cookies2=False, ) def test_cookie_header_redirect_different_domain_forcing_get(self): self._test_cookie_header_redirect( - 'https://toscrape.com', - {'url': 'https://example.com', 'status': 302}, + "https://toscrape.com", + {"url": "https://example.com", "status": 302}, cookies2=False, ) @@ -577,54 +616,54 @@ class CookiesMiddlewareTest(TestCase): ): input_cookies = [ { - 'name': 'a', - 'value': 'b', - 'domain': domain, + "name": "a", + "value": "b", + "domain": domain, } ] request1 = Request(url1, cookies=input_cookies) self.mw.process_request(request1, self.spider) - cookies = request1.headers.get('Cookie') + cookies = request1.headers.get("Cookie") self.assertEqual(cookies, b"a=b" if cookies1 else None) request2 = Request(url2) self.mw.process_request(request2, self.spider) - cookies = request2.headers.get('Cookie') + cookies = request2.headers.get("Cookie") self.assertEqual(cookies, b"a=b" if cookies2 else None) def test_user_set_cookie_domain_suffix_private(self): self._test_user_set_cookie_domain_followup( - 'https://books.toscrape.com', - 'https://quotes.toscrape.com', - 'toscrape.com', + "https://books.toscrape.com", + "https://quotes.toscrape.com", + "toscrape.com", cookies1=True, cookies2=True, ) def test_user_set_cookie_domain_suffix_public_period(self): self._test_user_set_cookie_domain_followup( - 'https://foo.co.uk', - 'https://bar.co.uk', - 'co.uk', + "https://foo.co.uk", + "https://bar.co.uk", + "co.uk", cookies1=False, cookies2=False, ) def test_user_set_cookie_domain_suffix_public_private(self): self._test_user_set_cookie_domain_followup( - 'https://foo.blogspot.com', - 'https://bar.blogspot.com', - 'blogspot.com', + "https://foo.blogspot.com", + "https://bar.blogspot.com", + "blogspot.com", cookies1=False, cookies2=False, ) def test_user_set_cookie_domain_public_period(self): self._test_user_set_cookie_domain_followup( - 'https://co.uk', - 'https://co.uk', - 'co.uk', + "https://co.uk", + "https://co.uk", + "co.uk", cookies1=True, cookies2=True, ) @@ -642,14 +681,14 @@ class CookiesMiddlewareTest(TestCase): input_cookies = [ { - 'name': 'a', - 'value': 'b', - 'domain': domain, + "name": "a", + "value": "b", + "domain": domain, } ] headers = { - 'Set-Cookie': _cookies_to_set_cookie_list(input_cookies), + "Set-Cookie": _cookies_to_set_cookie_list(input_cookies), } response = Response(url1, status=200, headers=headers) self.assertEqual( @@ -659,37 +698,37 @@ class CookiesMiddlewareTest(TestCase): request2 = Request(url2) self.mw.process_request(request2, self.spider) - actual_cookies = request2.headers.get('Cookie') + actual_cookies = request2.headers.get("Cookie") self.assertEqual(actual_cookies, b"a=b" if cookies else None) def test_server_set_cookie_domain_suffix_private(self): self._test_server_set_cookie_domain_followup( - 'https://books.toscrape.com', - 'https://quotes.toscrape.com', - 'toscrape.com', + "https://books.toscrape.com", + "https://quotes.toscrape.com", + "toscrape.com", cookies=True, ) def test_server_set_cookie_domain_suffix_public_period(self): self._test_server_set_cookie_domain_followup( - 'https://foo.co.uk', - 'https://bar.co.uk', - 'co.uk', + "https://foo.co.uk", + "https://bar.co.uk", + "co.uk", cookies=False, ) def test_server_set_cookie_domain_suffix_public_private(self): self._test_server_set_cookie_domain_followup( - 'https://foo.blogspot.com', - 'https://bar.blogspot.com', - 'blogspot.com', + "https://foo.blogspot.com", + "https://bar.blogspot.com", + "blogspot.com", cookies=False, ) def test_server_set_cookie_domain_public_period(self): self._test_server_set_cookie_domain_followup( - 'https://co.uk', - 'https://co.uk', - 'co.uk', + "https://co.uk", + "https://co.uk", + "co.uk", cookies=True, ) diff --git a/tests/test_downloadermiddleware_decompression.py b/tests/test_downloadermiddleware_decompression.py index 1c4cae6d1..16ae9ed75 100644 --- a/tests/test_downloadermiddleware_decompression.py +++ b/tests/test_downloadermiddleware_decompression.py @@ -7,39 +7,39 @@ from tests import get_testdata def _test_data(formats): - uncompressed_body = get_testdata('compressed', 'feed-sample1.xml') + uncompressed_body = get_testdata("compressed", "feed-sample1.xml") test_responses = {} for format in formats: - body = get_testdata('compressed', 'feed-sample1.' + format) - test_responses[format] = Response('http://foo.com/bar', body=body) + body = get_testdata("compressed", "feed-sample1." + format) + test_responses[format] = Response("http://foo.com/bar", body=body) return uncompressed_body, test_responses class DecompressionMiddlewareTest(TestCase): - test_formats = ['tar', 'xml.bz2', 'xml.gz', 'zip'] + test_formats = ["tar", "xml.bz2", "xml.gz", "zip"] uncompressed_body, test_responses = _test_data(test_formats) def setUp(self): self.mw = DecompressionMiddleware() - self.spider = Spider('foo') + self.spider = Spider("foo") def test_known_compression_formats(self): for fmt in self.test_formats: rsp = self.test_responses[fmt] new = self.mw.process_response(None, rsp, self.spider) - error_msg = f'Failed {fmt}, response type {type(new).__name__}' + error_msg = f"Failed {fmt}, response type {type(new).__name__}" assert isinstance(new, XmlResponse), error_msg assert_samelines(self, new.body, self.uncompressed_body, fmt) def test_plain_response(self): - rsp = Response(url='http://test.com', body=self.uncompressed_body) + rsp = Response(url="http://test.com", body=self.uncompressed_body) new = self.mw.process_response(None, rsp, self.spider) assert new is rsp assert_samelines(self, new.body, rsp.body) def test_empty_response(self): - rsp = Response(url='http://test.com', body=b'') + rsp = Response(url="http://test.com", body=b"") new = self.mw.process_response(None, rsp, self.spider) assert new is rsp assert not rsp.body @@ -49,5 +49,5 @@ class DecompressionMiddlewareTest(TestCase): del self.mw -if __name__ == '__main__': +if __name__ == "__main__": main() diff --git a/tests/test_downloadermiddleware_defaultheaders.py b/tests/test_downloadermiddleware_defaultheaders.py index 6a31dfcf8..601e85799 100644 --- a/tests/test_downloadermiddleware_defaultheaders.py +++ b/tests/test_downloadermiddleware_defaultheaders.py @@ -8,27 +8,26 @@ from scrapy.utils.python import to_bytes class TestDefaultHeadersMiddleware(TestCase): - def get_defaults_spider_mw(self): crawler = get_crawler(Spider) - spider = crawler._create_spider('foo') + spider = crawler._create_spider("foo") defaults = { to_bytes(k): [to_bytes(v)] - for k, v in crawler.settings.get('DEFAULT_REQUEST_HEADERS').items() + for k, v in crawler.settings.get("DEFAULT_REQUEST_HEADERS").items() } return defaults, spider, DefaultHeadersMiddleware.from_crawler(crawler) def test_process_request(self): defaults, spider, mw = self.get_defaults_spider_mw() - req = Request('http://www.scrapytest.org') + req = Request("http://www.scrapytest.org") mw.process_request(req, spider) self.assertEqual(req.headers, defaults) def test_update_headers(self): defaults, spider, mw = self.get_defaults_spider_mw() - headers = {'Accept-Language': ['es'], 'Test-Header': ['test']} - bytes_headers = {b'Accept-Language': [b'es'], b'Test-Header': [b'test']} - req = Request('http://www.scrapytest.org', headers=headers) + headers = {"Accept-Language": ["es"], "Test-Header": ["test"]} + bytes_headers = {b"Accept-Language": [b"es"], b"Test-Header": [b"test"]} + req = Request("http://www.scrapytest.org", headers=headers) self.assertEqual(req.headers, bytes_headers) mw.process_request(req, spider) diff --git a/tests/test_downloadermiddleware_downloadtimeout.py b/tests/test_downloadermiddleware_downloadtimeout.py index 586bdc0d1..8d2b821b0 100644 --- a/tests/test_downloadermiddleware_downloadtimeout.py +++ b/tests/test_downloadermiddleware_downloadtimeout.py @@ -7,36 +7,35 @@ from scrapy.utils.test import get_crawler class DownloadTimeoutMiddlewareTest(unittest.TestCase): - def get_request_spider_mw(self, settings=None): crawler = get_crawler(Spider, settings) - spider = crawler._create_spider('foo') - request = Request('http://scrapytest.org/') + spider = crawler._create_spider("foo") + request = Request("http://scrapytest.org/") return request, spider, DownloadTimeoutMiddleware.from_crawler(crawler) def test_default_download_timeout(self): req, spider, mw = self.get_request_spider_mw() mw.spider_opened(spider) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta.get('download_timeout'), 180) + self.assertEqual(req.meta.get("download_timeout"), 180) def test_string_download_timeout(self): - req, spider, mw = self.get_request_spider_mw({'DOWNLOAD_TIMEOUT': '20.1'}) + req, spider, mw = self.get_request_spider_mw({"DOWNLOAD_TIMEOUT": "20.1"}) mw.spider_opened(spider) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta.get('download_timeout'), 20.1) + self.assertEqual(req.meta.get("download_timeout"), 20.1) def test_spider_has_download_timeout(self): req, spider, mw = self.get_request_spider_mw() spider.download_timeout = 2 mw.spider_opened(spider) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta.get('download_timeout'), 2) + self.assertEqual(req.meta.get("download_timeout"), 2) def test_request_has_download_timeout(self): req, spider, mw = self.get_request_spider_mw() spider.download_timeout = 2 mw.spider_opened(spider) - req.meta['download_timeout'] = 1 + req.meta["download_timeout"] = 1 assert mw.process_request(req, spider) is None - self.assertEqual(req.meta.get('download_timeout'), 1) + self.assertEqual(req.meta.get("download_timeout"), 1) diff --git a/tests/test_downloadermiddleware_httpauth.py b/tests/test_downloadermiddleware_httpauth.py index b9f3e24a4..1320bded2 100644 --- a/tests/test_downloadermiddleware_httpauth.py +++ b/tests/test_downloadermiddleware_httpauth.py @@ -10,108 +10,106 @@ from scrapy.spiders import Spider class TestSpiderLegacy(Spider): - http_user = 'foo' - http_pass = 'bar' + http_user = "foo" + http_pass = "bar" class TestSpider(Spider): - http_user = 'foo' - http_pass = 'bar' - http_auth_domain = 'example.com' + http_user = "foo" + http_pass = "bar" + http_auth_domain = "example.com" class TestSpiderAny(Spider): - http_user = 'foo' - http_pass = 'bar' + http_user = "foo" + http_pass = "bar" http_auth_domain = None class HttpAuthMiddlewareLegacyTest(unittest.TestCase): - def setUp(self): - self.spider = TestSpiderLegacy('foo') + self.spider = TestSpiderLegacy("foo") def test_auth(self): - with pytest.warns(ScrapyDeprecationWarning, - match="Using HttpAuthMiddleware without http_auth_domain is deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="Using HttpAuthMiddleware without http_auth_domain is deprecated", + ): mw = HttpAuthMiddleware() mw.spider_opened(self.spider) # initial request, sets the domain and sends the header - req = Request('http://example.com/') + req = Request("http://example.com/") assert mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], basic_auth_header('foo', 'bar')) + self.assertEqual(req.headers["Authorization"], basic_auth_header("foo", "bar")) # subsequent request to the same domain, should send the header - req = Request('http://example.com/') + req = Request("http://example.com/") assert mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], basic_auth_header('foo', 'bar')) + self.assertEqual(req.headers["Authorization"], basic_auth_header("foo", "bar")) # subsequent request to a different domain, shouldn't send the header - req = Request('http://example-noauth.com/') + req = Request("http://example-noauth.com/") assert mw.process_request(req, self.spider) is None - self.assertNotIn('Authorization', req.headers) + self.assertNotIn("Authorization", req.headers) def test_auth_already_set(self): - with pytest.warns(ScrapyDeprecationWarning, - match="Using HttpAuthMiddleware without http_auth_domain is deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="Using HttpAuthMiddleware without http_auth_domain is deprecated", + ): mw = HttpAuthMiddleware() mw.spider_opened(self.spider) - req = Request('http://example.com/', - headers=dict(Authorization='Digest 123')) + req = Request("http://example.com/", headers=dict(Authorization="Digest 123")) assert mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], b'Digest 123') + self.assertEqual(req.headers["Authorization"], b"Digest 123") class HttpAuthMiddlewareTest(unittest.TestCase): - def setUp(self): self.mw = HttpAuthMiddleware() - self.spider = TestSpider('foo') + self.spider = TestSpider("foo") self.mw.spider_opened(self.spider) def tearDown(self): del self.mw def test_no_auth(self): - req = Request('http://example-noauth.com/') + req = Request("http://example-noauth.com/") assert self.mw.process_request(req, self.spider) is None - self.assertNotIn('Authorization', req.headers) + self.assertNotIn("Authorization", req.headers) def test_auth_domain(self): - req = Request('http://example.com/') + req = Request("http://example.com/") assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], basic_auth_header('foo', 'bar')) + self.assertEqual(req.headers["Authorization"], basic_auth_header("foo", "bar")) def test_auth_subdomain(self): - req = Request('http://foo.example.com/') + req = Request("http://foo.example.com/") assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], basic_auth_header('foo', 'bar')) + self.assertEqual(req.headers["Authorization"], basic_auth_header("foo", "bar")) def test_auth_already_set(self): - req = Request('http://example.com/', - headers=dict(Authorization='Digest 123')) + req = Request("http://example.com/", headers=dict(Authorization="Digest 123")) assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], b'Digest 123') + self.assertEqual(req.headers["Authorization"], b"Digest 123") class HttpAuthAnyMiddlewareTest(unittest.TestCase): - def setUp(self): self.mw = HttpAuthMiddleware() - self.spider = TestSpiderAny('foo') + self.spider = TestSpiderAny("foo") self.mw.spider_opened(self.spider) def tearDown(self): del self.mw def test_auth(self): - req = Request('http://example.com/') + req = Request("http://example.com/") assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], basic_auth_header('foo', 'bar')) + self.assertEqual(req.headers["Authorization"], basic_auth_header("foo", "bar")) def test_auth_already_set(self): - req = Request('http://example.com/', - headers=dict(Authorization='Digest 123')) + req = Request("http://example.com/", headers=dict(Authorization="Digest 123")) assert self.mw.process_request(req, self.spider) is None - self.assertEqual(req.headers['Authorization'], b'Digest 123') + self.assertEqual(req.headers["Authorization"], b"Digest 123") diff --git a/tests/test_downloadermiddleware_httpcache.py b/tests/test_downloadermiddleware_httpcache.py index b3d8264ba..caa89b6bd 100644 --- a/tests/test_downloadermiddleware_httpcache.py +++ b/tests/test_downloadermiddleware_httpcache.py @@ -15,36 +15,37 @@ from scrapy.downloadermiddlewares.httpcache import HttpCacheMiddleware class _BaseTest(unittest.TestCase): - storage_class = 'scrapy.extensions.httpcache.DbmCacheStorage' - policy_class = 'scrapy.extensions.httpcache.RFC2616Policy' + storage_class = "scrapy.extensions.httpcache.DbmCacheStorage" + policy_class = "scrapy.extensions.httpcache.RFC2616Policy" def setUp(self): self.yesterday = email.utils.formatdate(time.time() - 86400) self.today = email.utils.formatdate() self.tomorrow = email.utils.formatdate(time.time() + 86400) self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('example.com') + self.spider = self.crawler._create_spider("example.com") self.tmpdir = tempfile.mkdtemp() - self.request = Request('http://www.example.com', - headers={'User-Agent': 'test'}) - self.response = Response('http://www.example.com', - headers={'Content-Type': 'text/html'}, - body=b'test body', - status=202) + self.request = Request("http://www.example.com", headers={"User-Agent": "test"}) + self.response = Response( + "http://www.example.com", + headers={"Content-Type": "text/html"}, + body=b"test body", + status=202, + ) self.crawler.stats.open_spider(self.spider) def tearDown(self): - self.crawler.stats.close_spider(self.spider, '') + self.crawler.stats.close_spider(self.spider, "") shutil.rmtree(self.tmpdir) def _get_settings(self, **new_settings): settings = { - 'HTTPCACHE_ENABLED': True, - 'HTTPCACHE_DIR': self.tmpdir, - 'HTTPCACHE_EXPIRATION_SECS': 1, - 'HTTPCACHE_IGNORE_HTTP_CODES': [], - 'HTTPCACHE_POLICY': self.policy_class, - 'HTTPCACHE_STORAGE': self.storage_class, + "HTTPCACHE_ENABLED": True, + "HTTPCACHE_DIR": self.tmpdir, + "HTTPCACHE_EXPIRATION_SECS": 1, + "HTTPCACHE_IGNORE_HTTP_CODES": [], + "HTTPCACHE_POLICY": self.policy_class, + "HTTPCACHE_STORAGE": self.storage_class, } settings.update(new_settings) return Settings(settings) @@ -82,26 +83,32 @@ class _BaseTest(unittest.TestCase): def assertEqualRequestButWithCacheValidators(self, request1, request2): self.assertEqual(request1.url, request2.url) - assert b'If-None-Match' not in request1.headers - assert b'If-Modified-Since' not in request1.headers - assert any(h in request2.headers for h in (b'If-None-Match', b'If-Modified-Since')) + assert b"If-None-Match" not in request1.headers + assert b"If-Modified-Since" not in request1.headers + assert any( + h in request2.headers for h in (b"If-None-Match", b"If-Modified-Since") + ) self.assertEqual(request1.body, request2.body) def test_dont_cache(self): with self._middleware() as mw: - self.request.meta['dont_cache'] = True + self.request.meta["dont_cache"] = True mw.process_response(self.request, self.response, self.spider) - self.assertEqual(mw.storage.retrieve_response(self.spider, self.request), None) + self.assertEqual( + mw.storage.retrieve_response(self.spider, self.request), None + ) with self._middleware() as mw: - self.request.meta['dont_cache'] = False + self.request.meta["dont_cache"] = False mw.process_response(self.request, self.response, self.spider) if mw.policy.should_cache_response(self.response, self.request): - self.assertIsInstance(mw.storage.retrieve_response(self.spider, self.request), self.response.__class__) + self.assertIsInstance( + mw.storage.retrieve_response(self.spider, self.request), + self.response.__class__, + ) class DefaultStorageTest(_BaseTest): - def test_storage(self): with self._storage() as storage: request2 = self.request.copy() @@ -128,8 +135,8 @@ class DefaultStorageTest(_BaseTest): with self._storage() as storage: assert storage.retrieve_response(self.spider, self.request) is None response = Response( - 'http://www.example.com', - body=b'\n.', + "http://www.example.com", + body=b"\n.", status=202, ) storage.store_response(self.spider, self.request, response) @@ -140,15 +147,15 @@ class DefaultStorageTest(_BaseTest): class DbmStorageTest(DefaultStorageTest): - storage_class = 'scrapy.extensions.httpcache.DbmCacheStorage' + storage_class = "scrapy.extensions.httpcache.DbmCacheStorage" class DbmStorageWithCustomDbmModuleTest(DbmStorageTest): - dbm_module = 'tests.mocks.dummydbm' + dbm_module = "tests.mocks.dummydbm" def _get_settings(self, **new_settings): - new_settings.setdefault('HTTPCACHE_DBM_MODULE', self.dbm_module) + new_settings.setdefault("HTTPCACHE_DBM_MODULE", self.dbm_module) return super()._get_settings(**new_settings) def test_custom_dbm_module_loaded(self): @@ -159,19 +166,18 @@ class DbmStorageWithCustomDbmModuleTest(DbmStorageTest): class FilesystemStorageTest(DefaultStorageTest): - storage_class = 'scrapy.extensions.httpcache.FilesystemCacheStorage' + storage_class = "scrapy.extensions.httpcache.FilesystemCacheStorage" class FilesystemStorageGzipTest(FilesystemStorageTest): - def _get_settings(self, **new_settings): - new_settings.setdefault('HTTPCACHE_GZIP', True) + new_settings.setdefault("HTTPCACHE_GZIP", True) return super()._get_settings(**new_settings) class DummyPolicyTest(_BaseTest): - policy_class = 'scrapy.extensions.httpcache.DummyPolicy' + policy_class = "scrapy.extensions.httpcache.DummyPolicy" def test_middleware(self): with self._middleware() as mw: @@ -180,31 +186,33 @@ class DummyPolicyTest(_BaseTest): response = mw.process_request(self.request, self.spider) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) - assert 'cached' in response.flags + assert "cached" in response.flags def test_different_request_response_urls(self): with self._middleware() as mw: - req = Request('http://host.com/path') - res = Response('http://host2.net/test.html') + req = Request("http://host.com/path") + res = Response("http://host2.net/test.html") assert mw.process_request(req, self.spider) is None mw.process_response(req, res, self.spider) cached = mw.process_request(req, self.spider) assert isinstance(cached, Response) self.assertEqualResponse(res, cached) - assert 'cached' in cached.flags + assert "cached" in cached.flags def test_middleware_ignore_missing(self): with self._middleware(HTTPCACHE_IGNORE_MISSING=True) as mw: - self.assertRaises(IgnoreRequest, mw.process_request, self.request, self.spider) + self.assertRaises( + IgnoreRequest, mw.process_request, self.request, self.spider + ) mw.process_response(self.request, self.response, self.spider) response = mw.process_request(self.request, self.spider) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) - assert 'cached' in response.flags + assert "cached" in response.flags def test_middleware_ignore_schemes(self): # http responses are cached by default - req, res = Request('http://test.com/'), Response('http://test.com/') + req, res = Request("http://test.com/"), Response("http://test.com/") with self._middleware() as mw: assert mw.process_request(req, self.spider) is None mw.process_response(req, res, self.spider) @@ -212,10 +220,10 @@ class DummyPolicyTest(_BaseTest): cached = mw.process_request(req, self.spider) assert isinstance(cached, Response), type(cached) self.assertEqualResponse(res, cached) - assert 'cached' in cached.flags + assert "cached" in cached.flags # file response is not cached by default - req, res = Request('file:///tmp/t.txt'), Response('file:///tmp/t.txt') + req, res = Request("file:///tmp/t.txt"), Response("file:///tmp/t.txt") with self._middleware() as mw: assert mw.process_request(req, self.spider) is None mw.process_response(req, res, self.spider) @@ -224,7 +232,7 @@ class DummyPolicyTest(_BaseTest): assert mw.process_request(req, self.spider) is None # s3 scheme response is cached by default - req, res = Request('s3://bucket/key'), Response('http://bucket/key') + req, res = Request("s3://bucket/key"), Response("http://bucket/key") with self._middleware() as mw: assert mw.process_request(req, self.spider) is None mw.process_response(req, res, self.spider) @@ -232,11 +240,11 @@ class DummyPolicyTest(_BaseTest): cached = mw.process_request(req, self.spider) assert isinstance(cached, Response), type(cached) self.assertEqualResponse(res, cached) - assert 'cached' in cached.flags + assert "cached" in cached.flags # ignore s3 scheme - req, res = Request('s3://bucket/key2'), Response('http://bucket/key2') - with self._middleware(HTTPCACHE_IGNORE_SCHEMES=['s3']) as mw: + req, res = Request("s3://bucket/key2"), Response("http://bucket/key2") + with self._middleware(HTTPCACHE_IGNORE_SCHEMES=["s3"]) as mw: assert mw.process_request(req, self.spider) is None mw.process_response(req, res, self.spider) @@ -258,12 +266,12 @@ class DummyPolicyTest(_BaseTest): response = mw.process_request(self.request, self.spider) assert isinstance(response, HtmlResponse) self.assertEqualResponse(self.response, response) - assert 'cached' in response.flags + assert "cached" in response.flags class RFC2616PolicyTest(DefaultStorageTest): - policy_class = 'scrapy.extensions.httpcache.RFC2616Policy' + policy_class = "scrapy.extensions.httpcache.RFC2616Policy" def _process_requestresponse(self, mw, request, response): result = None @@ -276,17 +284,18 @@ class RFC2616PolicyTest(DefaultStorageTest): assert isinstance(result, Response) return result except Exception: - print('Request', request) - print('Response', response) - print('Result', result) + print("Request", request) + print("Response", response) + print("Result", result) raise def test_request_cacheability(self): - res0 = Response(self.request.url, status=200, - headers={'Expires': self.tomorrow}) - req0 = Request('http://example.com') - req1 = req0.replace(headers={'Cache-Control': 'no-store'}) - req2 = req0.replace(headers={'Cache-Control': 'no-cache'}) + res0 = Response( + self.request.url, status=200, headers={"Expires": self.tomorrow} + ) + req0 = Request("http://example.com") + req1 = req0.replace(headers={"Cache-Control": "no-store"}) + req2 = req0.replace(headers={"Cache-Control": "no-cache"}) with self._middleware() as mw: # response for a request with no-store must not be cached res1 = self._process_requestresponse(mw, req1, res0) @@ -294,227 +303,276 @@ class RFC2616PolicyTest(DefaultStorageTest): assert mw.storage.retrieve_response(self.spider, req1) is None # Re-do request without no-store and expect it to be cached res2 = self._process_requestresponse(mw, req0, res0) - assert 'cached' not in res2.flags + assert "cached" not in res2.flags res3 = mw.process_request(req0, self.spider) - assert 'cached' in res3.flags + assert "cached" in res3.flags self.assertEqualResponse(res2, res3) # request with no-cache directive must not return cached response # but it allows new response to be stored - res0b = res0.replace(body=b'foo') + res0b = res0.replace(body=b"foo") res4 = self._process_requestresponse(mw, req2, res0b) self.assertEqualResponse(res4, res0b) - assert 'cached' not in res4.flags + assert "cached" not in res4.flags res5 = self._process_requestresponse(mw, req0, None) self.assertEqualResponse(res5, res0b) - assert 'cached' in res5.flags + assert "cached" in res5.flags def test_response_cacheability(self): responses = [ # 304 is not cacheable no matter what servers sends (False, 304, {}), - (False, 304, {'Last-Modified': self.yesterday}), - (False, 304, {'Expires': self.tomorrow}), - (False, 304, {'Etag': 'bar'}), - (False, 304, {'Cache-Control': 'max-age=3600'}), + (False, 304, {"Last-Modified": self.yesterday}), + (False, 304, {"Expires": self.tomorrow}), + (False, 304, {"Etag": "bar"}), + (False, 304, {"Cache-Control": "max-age=3600"}), # Always obey no-store cache control - (False, 200, {'Cache-Control': 'no-store'}), - (False, 200, {'Cache-Control': 'no-store, max-age=300'}), # invalid - (False, 200, {'Cache-Control': 'no-store', 'Expires': self.tomorrow}), # invalid + (False, 200, {"Cache-Control": "no-store"}), + (False, 200, {"Cache-Control": "no-store, max-age=300"}), # invalid + ( + False, + 200, + {"Cache-Control": "no-store", "Expires": self.tomorrow}, + ), # invalid # Ignore responses missing expiration and/or validation headers (False, 200, {}), (False, 302, {}), (False, 307, {}), (False, 404, {}), # Cache responses with expiration and/or validation headers - (True, 200, {'Last-Modified': self.yesterday}), - (True, 203, {'Last-Modified': self.yesterday}), - (True, 300, {'Last-Modified': self.yesterday}), - (True, 301, {'Last-Modified': self.yesterday}), - (True, 308, {'Last-Modified': self.yesterday}), - (True, 401, {'Last-Modified': self.yesterday}), - (True, 404, {'Cache-Control': 'public, max-age=600'}), - (True, 302, {'Expires': self.tomorrow}), - (True, 200, {'Etag': 'foo'}), + (True, 200, {"Last-Modified": self.yesterday}), + (True, 203, {"Last-Modified": self.yesterday}), + (True, 300, {"Last-Modified": self.yesterday}), + (True, 301, {"Last-Modified": self.yesterday}), + (True, 308, {"Last-Modified": self.yesterday}), + (True, 401, {"Last-Modified": self.yesterday}), + (True, 404, {"Cache-Control": "public, max-age=600"}), + (True, 302, {"Expires": self.tomorrow}), + (True, 200, {"Etag": "foo"}), ] with self._middleware() as mw: for idx, (shouldcache, status, headers) in enumerate(responses): - req0 = Request(f'http://example-{idx}.com') + req0 = Request(f"http://example-{idx}.com") res0 = Response(req0.url, status=status, headers=headers) res1 = self._process_requestresponse(mw, req0, res0) res304 = res0.replace(status=304) - res2 = self._process_requestresponse(mw, req0, res304 if shouldcache else res0) + res2 = self._process_requestresponse( + mw, req0, res304 if shouldcache else res0 + ) self.assertEqualResponse(res1, res0) self.assertEqualResponse(res2, res0) resc = mw.storage.retrieve_response(self.spider, req0) if shouldcache: self.assertEqualResponse(resc, res1) - assert 'cached' in res2.flags and res2.status != 304 + assert "cached" in res2.flags and res2.status != 304 else: self.assertFalse(resc) - assert 'cached' not in res2.flags + assert "cached" not in res2.flags # cache unconditionally unless response contains no-store or is a 304 with self._middleware(HTTPCACHE_ALWAYS_STORE=True) as mw: for idx, (_, status, headers) in enumerate(responses): - shouldcache = 'no-store' not in headers.get('Cache-Control', '') and status != 304 - req0 = Request(f'http://example2-{idx}.com') + shouldcache = ( + "no-store" not in headers.get("Cache-Control", "") and status != 304 + ) + req0 = Request(f"http://example2-{idx}.com") res0 = Response(req0.url, status=status, headers=headers) res1 = self._process_requestresponse(mw, req0, res0) res304 = res0.replace(status=304) - res2 = self._process_requestresponse(mw, req0, res304 if shouldcache else res0) + res2 = self._process_requestresponse( + mw, req0, res304 if shouldcache else res0 + ) self.assertEqualResponse(res1, res0) self.assertEqualResponse(res2, res0) resc = mw.storage.retrieve_response(self.spider, req0) if shouldcache: self.assertEqualResponse(resc, res1) - assert 'cached' in res2.flags and res2.status != 304 + assert "cached" in res2.flags and res2.status != 304 else: self.assertFalse(resc) - assert 'cached' not in res2.flags + assert "cached" not in res2.flags def test_cached_and_fresh(self): sampledata = [ - (200, {'Date': self.yesterday, 'Expires': self.tomorrow}), - (200, {'Date': self.yesterday, 'Cache-Control': 'max-age=86405'}), - (200, {'Age': '299', 'Cache-Control': 'max-age=300'}), + (200, {"Date": self.yesterday, "Expires": self.tomorrow}), + (200, {"Date": self.yesterday, "Cache-Control": "max-age=86405"}), + (200, {"Age": "299", "Cache-Control": "max-age=300"}), # Obey max-age if present over any others - (200, {'Date': self.today, - 'Age': '86405', - 'Cache-Control': 'max-age=' + str(86400 * 3), - 'Expires': self.yesterday, - 'Last-Modified': self.yesterday, - }), + ( + 200, + { + "Date": self.today, + "Age": "86405", + "Cache-Control": "max-age=" + str(86400 * 3), + "Expires": self.yesterday, + "Last-Modified": self.yesterday, + }, + ), # obey Expires if max-age is not present - (200, {'Date': self.yesterday, - 'Age': '86400', - 'Cache-Control': 'public', - 'Expires': self.tomorrow, - 'Last-Modified': self.yesterday, - }), + ( + 200, + { + "Date": self.yesterday, + "Age": "86400", + "Cache-Control": "public", + "Expires": self.tomorrow, + "Last-Modified": self.yesterday, + }, + ), # Default missing Date header to right now - (200, {'Expires': self.tomorrow}), + (200, {"Expires": self.tomorrow}), # Firefox - Expires if age is greater than 10% of (Date - Last-Modified) - (200, {'Date': self.today, 'Last-Modified': self.yesterday, 'Age': str(86400 / 10 - 1)}), + ( + 200, + { + "Date": self.today, + "Last-Modified": self.yesterday, + "Age": str(86400 / 10 - 1), + }, + ), # Firefox - Set one year maxage to permanent redirects missing expiration info - (300, {}), (301, {}), (308, {}), + (300, {}), + (301, {}), + (308, {}), ] with self._middleware() as mw: for idx, (status, headers) in enumerate(sampledata): - req0 = Request(f'http://example-{idx}.com') + req0 = Request(f"http://example-{idx}.com") res0 = Response(req0.url, status=status, headers=headers) # cache fresh response res1 = self._process_requestresponse(mw, req0, res0) self.assertEqualResponse(res1, res0) - assert 'cached' not in res1.flags + assert "cached" not in res1.flags # return fresh cached response without network interaction res2 = self._process_requestresponse(mw, req0, None) self.assertEqualResponse(res1, res2) - assert 'cached' in res2.flags + assert "cached" in res2.flags # validate cached response if request max-age set as 0 - req1 = req0.replace(headers={'Cache-Control': 'max-age=0'}) + req1 = req0.replace(headers={"Cache-Control": "max-age=0"}) res304 = res0.replace(status=304) assert mw.process_request(req1, self.spider) is None res3 = self._process_requestresponse(mw, req1, res304) self.assertEqualResponse(res1, res3) - assert 'cached' in res3.flags + assert "cached" in res3.flags def test_cached_and_stale(self): sampledata = [ - (200, {'Date': self.today, 'Expires': self.yesterday}), - (200, {'Date': self.today, 'Expires': self.yesterday, 'Last-Modified': self.yesterday}), - (200, {'Expires': self.yesterday}), - (200, {'Expires': self.yesterday, 'ETag': 'foo'}), - (200, {'Expires': self.yesterday, 'Last-Modified': self.yesterday}), - (200, {'Expires': self.tomorrow, 'Age': '86405'}), - (200, {'Cache-Control': 'max-age=86400', 'Age': '86405'}), + (200, {"Date": self.today, "Expires": self.yesterday}), + ( + 200, + { + "Date": self.today, + "Expires": self.yesterday, + "Last-Modified": self.yesterday, + }, + ), + (200, {"Expires": self.yesterday}), + (200, {"Expires": self.yesterday, "ETag": "foo"}), + (200, {"Expires": self.yesterday, "Last-Modified": self.yesterday}), + (200, {"Expires": self.tomorrow, "Age": "86405"}), + (200, {"Cache-Control": "max-age=86400", "Age": "86405"}), # no-cache forces expiration, also revalidation if validators exists - (200, {'Cache-Control': 'no-cache'}), - (200, {'Cache-Control': 'no-cache', 'ETag': 'foo'}), - (200, {'Cache-Control': 'no-cache', 'Last-Modified': self.yesterday}), - (200, {'Cache-Control': 'no-cache,must-revalidate', 'Last-Modified': self.yesterday}), - (200, {'Cache-Control': 'must-revalidate', 'Expires': self.yesterday, 'Last-Modified': self.yesterday}), - (200, {'Cache-Control': 'max-age=86400,must-revalidate', 'Age': '86405'}), + (200, {"Cache-Control": "no-cache"}), + (200, {"Cache-Control": "no-cache", "ETag": "foo"}), + (200, {"Cache-Control": "no-cache", "Last-Modified": self.yesterday}), + ( + 200, + { + "Cache-Control": "no-cache,must-revalidate", + "Last-Modified": self.yesterday, + }, + ), + ( + 200, + { + "Cache-Control": "must-revalidate", + "Expires": self.yesterday, + "Last-Modified": self.yesterday, + }, + ), + (200, {"Cache-Control": "max-age=86400,must-revalidate", "Age": "86405"}), ] with self._middleware() as mw: for idx, (status, headers) in enumerate(sampledata): - req0 = Request(f'http://example-{idx}.com') + req0 = Request(f"http://example-{idx}.com") res0a = Response(req0.url, status=status, headers=headers) # cache expired response res1 = self._process_requestresponse(mw, req0, res0a) self.assertEqualResponse(res1, res0a) - assert 'cached' not in res1.flags + assert "cached" not in res1.flags # Same request but as cached response is stale a new response must # be returned - res0b = res0a.replace(body=b'bar') + res0b = res0a.replace(body=b"bar") res2 = self._process_requestresponse(mw, req0, res0b) self.assertEqualResponse(res2, res0b) - assert 'cached' not in res2.flags - cc = headers.get('Cache-Control', '') + assert "cached" not in res2.flags + cc = headers.get("Cache-Control", "") # Previous response expired too, subsequent request to same # resource must revalidate and succeed on 304 if validators # are present - if 'ETag' in headers or 'Last-Modified' in headers: + if "ETag" in headers or "Last-Modified" in headers: res0c = res0b.replace(status=304) res3 = self._process_requestresponse(mw, req0, res0c) self.assertEqualResponse(res3, res0b) - assert 'cached' in res3.flags + assert "cached" in res3.flags # get cached response on server errors unless must-revalidate # in cached response res0d = res0b.replace(status=500) res4 = self._process_requestresponse(mw, req0, res0d) - if 'must-revalidate' in cc: - assert 'cached' not in res4.flags + if "must-revalidate" in cc: + assert "cached" not in res4.flags self.assertEqualResponse(res4, res0d) else: - assert 'cached' in res4.flags + assert "cached" in res4.flags self.assertEqualResponse(res4, res0b) # Requests with max-stale can fetch expired cached responses # unless cached response has must-revalidate - req1 = req0.replace(headers={'Cache-Control': 'max-stale'}) + req1 = req0.replace(headers={"Cache-Control": "max-stale"}) res5 = self._process_requestresponse(mw, req1, res0b) self.assertEqualResponse(res5, res0b) - if 'no-cache' in cc or 'must-revalidate' in cc: - assert 'cached' not in res5.flags + if "no-cache" in cc or "must-revalidate" in cc: + assert "cached" not in res5.flags else: - assert 'cached' in res5.flags + assert "cached" in res5.flags def test_process_exception(self): with self._middleware() as mw: - res0 = Response(self.request.url, headers={'Expires': self.yesterday}) + res0 = Response(self.request.url, headers={"Expires": self.yesterday}) req0 = Request(self.request.url) self._process_requestresponse(mw, req0, res0) for e in mw.DOWNLOAD_EXCEPTIONS: # Simulate encountering an error on download attempts assert mw.process_request(req0, self.spider) is None - res1 = mw.process_exception(req0, e('foo'), self.spider) + res1 = mw.process_exception(req0, e("foo"), self.spider) # Use cached response as recovery - assert 'cached' in res1.flags + assert "cached" in res1.flags self.assertEqualResponse(res0, res1) # Do not use cached response for unhandled exceptions mw.process_request(req0, self.spider) - assert mw.process_exception(req0, Exception('foo'), self.spider) is None + assert mw.process_exception(req0, Exception("foo"), self.spider) is None def test_ignore_response_cache_controls(self): sampledata = [ - (200, {'Date': self.yesterday, 'Expires': self.tomorrow}), - (200, {'Date': self.yesterday, 'Cache-Control': 'no-store,max-age=86405'}), - (200, {'Age': '299', 'Cache-Control': 'max-age=300,no-cache'}), - (300, {'Cache-Control': 'no-cache'}), - (200, {'Expires': self.tomorrow, 'Cache-Control': 'no-store'}), + (200, {"Date": self.yesterday, "Expires": self.tomorrow}), + (200, {"Date": self.yesterday, "Cache-Control": "no-store,max-age=86405"}), + (200, {"Age": "299", "Cache-Control": "max-age=300,no-cache"}), + (300, {"Cache-Control": "no-cache"}), + (200, {"Expires": self.tomorrow, "Cache-Control": "no-store"}), ] - with self._middleware(HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS=['no-cache', 'no-store']) as mw: + with self._middleware( + HTTPCACHE_IGNORE_RESPONSE_CACHE_CONTROLS=["no-cache", "no-store"] + ) as mw: for idx, (status, headers) in enumerate(sampledata): - req0 = Request(f'http://example-{idx}.com') + req0 = Request(f"http://example-{idx}.com") res0 = Response(req0.url, status=status, headers=headers) # cache fresh response res1 = self._process_requestresponse(mw, req0, res0) self.assertEqualResponse(res1, res0) - assert 'cached' not in res1.flags + assert "cached" not in res1.flags # return fresh cached response without network interaction res2 = self._process_requestresponse(mw, req0, None) self.assertEqualResponse(res1, res2) - assert 'cached' in res2.flags + assert "cached" in res2.flags -if __name__ == '__main__': +if __name__ == "__main__": unittest.main() diff --git a/tests/test_downloadermiddleware_httpcompression.py b/tests/test_downloadermiddleware_httpcompression.py index b0272143d..efae7c4e0 100644 --- a/tests/test_downloadermiddleware_httpcompression.py +++ b/tests/test_downloadermiddleware_httpcompression.py @@ -7,35 +7,40 @@ from warnings import catch_warnings from w3lib.encoding import resolve_encoding from scrapy.spiders import Spider from scrapy.http import Response, Request, HtmlResponse -from scrapy.downloadermiddlewares.httpcompression import HttpCompressionMiddleware, ACCEPTED_ENCODINGS +from scrapy.downloadermiddlewares.httpcompression import ( + HttpCompressionMiddleware, + ACCEPTED_ENCODINGS, +) from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.responsetypes import responsetypes from scrapy.utils.gz import gunzip from scrapy.utils.test import get_crawler from tests import tests_datadir -SAMPLEDIR = Path(tests_datadir, 'compressed') +SAMPLEDIR = Path(tests_datadir, "compressed") FORMAT = { - 'gzip': ('html-gzip.bin', 'gzip'), - 'x-gzip': ('html-gzip.bin', 'gzip'), - 'rawdeflate': ('html-rawdeflate.bin', 'deflate'), - 'zlibdeflate': ('html-zlibdeflate.bin', 'deflate'), - 'br': ('html-br.bin', 'br'), + "gzip": ("html-gzip.bin", "gzip"), + "x-gzip": ("html-gzip.bin", "gzip"), + "rawdeflate": ("html-rawdeflate.bin", "deflate"), + "zlibdeflate": ("html-zlibdeflate.bin", "deflate"), + "br": ("html-br.bin", "br"), # $ zstd raw.html --content-size -o html-zstd-static-content-size.bin - 'zstd-static-content-size': ('html-zstd-static-content-size.bin', 'zstd'), + "zstd-static-content-size": ("html-zstd-static-content-size.bin", "zstd"), # $ zstd raw.html --no-content-size -o html-zstd-static-no-content-size.bin - 'zstd-static-no-content-size': ('html-zstd-static-no-content-size.bin', 'zstd'), + "zstd-static-no-content-size": ("html-zstd-static-no-content-size.bin", "zstd"), # $ cat raw.html | zstd -o html-zstd-streaming-no-content-size.bin - 'zstd-streaming-no-content-size': ('html-zstd-streaming-no-content-size.bin', 'zstd'), + "zstd-streaming-no-content-size": ( + "html-zstd-streaming-no-content-size.bin", + "zstd", + ), } class HttpCompressionTest(TestCase): - def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('scrapytest.org') + self.spider = self.crawler._create_spider("scrapytest.org") self.mw = HttpCompressionMiddleware.from_crawler(self.crawler) self.crawler.stats.open_spider(self.spider) @@ -48,90 +53,93 @@ class HttpCompressionTest(TestCase): body = (SAMPLEDIR / samplefile).read_bytes() headers = { - 'Server': 'Yaws/1.49 Yet Another Web Server', - 'Date': 'Sun, 08 Mar 2009 00:41:03 GMT', - 'Content-Length': len(body), - 'Content-Type': 'text/html', - 'Content-Encoding': contentencoding, + "Server": "Yaws/1.49 Yet Another Web Server", + "Date": "Sun, 08 Mar 2009 00:41:03 GMT", + "Content-Length": len(body), + "Content-Type": "text/html", + "Content-Encoding": contentencoding, } - response = Response('http://scrapytest.org/', body=body, headers=headers) - response.request = Request('http://scrapytest.org', headers={'Accept-Encoding': 'gzip, deflate'}) + response = Response("http://scrapytest.org/", body=body, headers=headers) + response.request = Request( + "http://scrapytest.org", headers={"Accept-Encoding": "gzip, deflate"} + ) return response def assertStatsEqual(self, key, value): self.assertEqual( self.crawler.stats.get_value(key, spider=self.spider), value, - str(self.crawler.stats.get_stats(self.spider)) + str(self.crawler.stats.get_stats(self.spider)), ) def test_setting_false_compression_enabled(self): self.assertRaises( NotConfigured, HttpCompressionMiddleware.from_crawler, - get_crawler(settings_dict={'COMPRESSION_ENABLED': False}) + get_crawler(settings_dict={"COMPRESSION_ENABLED": False}), ) def test_setting_default_compression_enabled(self): self.assertIsInstance( HttpCompressionMiddleware.from_crawler(get_crawler()), - HttpCompressionMiddleware + HttpCompressionMiddleware, ) def test_setting_true_compression_enabled(self): self.assertIsInstance( HttpCompressionMiddleware.from_crawler( - get_crawler(settings_dict={'COMPRESSION_ENABLED': True}) + get_crawler(settings_dict={"COMPRESSION_ENABLED": True}) ), - HttpCompressionMiddleware + HttpCompressionMiddleware, ) def test_process_request(self): - request = Request('http://scrapytest.org') - assert 'Accept-Encoding' not in request.headers + request = Request("http://scrapytest.org") + assert "Accept-Encoding" not in request.headers self.mw.process_request(request, self.spider) - self.assertEqual(request.headers.get('Accept-Encoding'), - b', '.join(ACCEPTED_ENCODINGS)) + self.assertEqual( + request.headers.get("Accept-Encoding"), b", ".join(ACCEPTED_ENCODINGS) + ) def test_process_response_gzip(self): - response = self._getresponse('gzip') + response = self._getresponse("gzip") request = response.request - self.assertEqual(response.headers['Content-Encoding'], b'gzip') + self.assertEqual(response.headers["Content-Encoding"], b"gzip") newresponse = self.mw.process_response(request, response, self.spider) assert newresponse is not response - assert newresponse.body.startswith(b'Some page' - b'') - zf = GzipFile(fileobj=f, mode='wb') + plainbody = ( + b"Some page" + b'' + ) + zf = GzipFile(fileobj=f, mode="wb") zf.write(plainbody) zf.close() - response = Response("http;//www.example.com/", headers=headers, body=f.getvalue()) + response = Response( + "http;//www.example.com/", headers=headers, body=f.getvalue() + ) request = Request("http://www.example.com/") newresponse = self.mw.process_response(request, response, self.spider) assert isinstance(newresponse, HtmlResponse) self.assertEqual(newresponse.body, plainbody) - self.assertEqual(newresponse.encoding, resolve_encoding('gb2312')) - self.assertStatsEqual('httpcompression/response_count', 1) - self.assertStatsEqual('httpcompression/response_bytes', 104) + self.assertEqual(newresponse.encoding, resolve_encoding("gb2312")) + self.assertStatsEqual("httpcompression/response_count", 1) + self.assertStatsEqual("httpcompression/response_bytes", 104) def test_process_response_force_recalculate_encoding(self): headers = { - 'Content-Type': 'text/html', - 'Content-Encoding': 'gzip', + "Content-Type": "text/html", + "Content-Encoding": "gzip", } f = BytesIO() - plainbody = (b'Some page' - b'') - zf = GzipFile(fileobj=f, mode='wb') + plainbody = ( + b"Some page" + b'' + ) + zf = GzipFile(fileobj=f, mode="wb") zf.write(plainbody) zf.close() - response = HtmlResponse("http;//www.example.com/page.html", headers=headers, body=f.getvalue()) + response = HtmlResponse( + "http;//www.example.com/page.html", headers=headers, body=f.getvalue() + ) request = Request("http://www.example.com/") newresponse = self.mw.process_response(request, response, self.spider) assert isinstance(newresponse, HtmlResponse) self.assertEqual(newresponse.body, plainbody) - self.assertEqual(newresponse.encoding, resolve_encoding('gb2312')) - self.assertStatsEqual('httpcompression/response_count', 1) - self.assertStatsEqual('httpcompression/response_bytes', 104) + self.assertEqual(newresponse.encoding, resolve_encoding("gb2312")) + self.assertStatsEqual("httpcompression/response_count", 1) + self.assertStatsEqual("httpcompression/response_bytes", 104) def test_process_response_no_content_type_header(self): headers = { - 'Content-Encoding': 'identity', + "Content-Encoding": "identity", } - plainbody = (b'Some page' - b'') - respcls = responsetypes.from_args(url="http://www.example.com/index", headers=headers, body=plainbody) - response = respcls("http://www.example.com/index", headers=headers, body=plainbody) + plainbody = ( + b"Some page" + b'' + ) + respcls = responsetypes.from_args( + url="http://www.example.com/index", headers=headers, body=plainbody + ) + response = respcls( + "http://www.example.com/index", headers=headers, body=plainbody + ) request = Request("http://www.example.com/index") newresponse = self.mw.process_response(request, response, self.spider) assert isinstance(newresponse, respcls) self.assertEqual(newresponse.body, plainbody) - self.assertEqual(newresponse.encoding, resolve_encoding('gb2312')) - self.assertStatsEqual('httpcompression/response_count', 1) - self.assertStatsEqual('httpcompression/response_bytes', 104) + self.assertEqual(newresponse.encoding, resolve_encoding("gb2312")) + self.assertStatsEqual("httpcompression/response_count", 1) + self.assertStatsEqual("httpcompression/response_bytes", 104) def test_process_response_gzipped_contenttype(self): - response = self._getresponse('gzip') - response.headers['Content-Type'] = 'application/gzip' + response = self._getresponse("gzip") + response.headers["Content-Type"] = "application/gzip" request = response.request newresponse = self.mw.process_response(request, response, self.spider) self.assertIsNot(newresponse, response) - self.assertTrue(newresponse.body.startswith(b'0.8 """ - gz_file = GzipFile(fileobj=f, mode='wb') + gz_file = GzipFile(fileobj=f, mode="wb") gz_file.write(plainbody) gz_file.close() # build a gzipped response body containing this gzipped file r = BytesIO() - gz_resp = GzipFile(fileobj=r, mode='wb') + gz_resp = GzipFile(fileobj=r, mode="wb") gz_resp.write(f.getvalue()) gz_resp.close() - response = Response("http;//www.example.com/", headers=headers, body=r.getvalue()) + response = Response( + "http;//www.example.com/", headers=headers, body=r.getvalue() + ) request = Request("http://www.example.com/") newresponse = self.mw.process_response(request, response, self.spider) self.assertEqual(gunzip(newresponse.body), plainbody) - self.assertStatsEqual('httpcompression/response_count', 1) - self.assertStatsEqual('httpcompression/response_bytes', 230) + self.assertStatsEqual("httpcompression/response_count", 1) + self.assertStatsEqual("httpcompression/response_bytes", 230) def test_process_response_head_request_no_decode_required(self): - response = self._getresponse('gzip') - response.headers['Content-Type'] = 'application/gzip' + response = self._getresponse("gzip") + response.headers["Content-Type"] = "application/gzip" request = response.request - request.method = 'HEAD' + request.method = "HEAD" response = response.replace(body=None) newresponse = self.mw.process_response(request, response, self.spider) self.assertIs(newresponse, response) - self.assertEqual(response.body, b'') - self.assertStatsEqual('httpcompression/response_count', None) - self.assertStatsEqual('httpcompression/response_bytes', None) + self.assertEqual(response.body, b"") + self.assertStatsEqual("httpcompression/response_count", None) + self.assertStatsEqual("httpcompression/response_bytes", None) class HttpCompressionSubclassTest(TestCase): - def test_init_missing_stats(self): class HttpCompressionMiddlewareSubclass(HttpCompressionMiddleware): - def __init__(self): super().__init__() @@ -361,7 +383,8 @@ class HttpCompressionSubclassTest(TestCase): with catch_warnings(record=True) as caught_warnings: HttpCompressionMiddlewareSubclass.from_crawler(crawler) messages = tuple( - str(warning.message) for warning in caught_warnings + str(warning.message) + for warning in caught_warnings if warning.category is ScrapyDeprecationWarning ) self.assertEqual( @@ -372,5 +395,5 @@ class HttpCompressionSubclassTest(TestCase): "their '__init__' method to support a 'stats' parameter " "or reimplement the 'from_crawler' method." ), - ) + ), ) diff --git a/tests/test_downloadermiddleware_httpproxy.py b/tests/test_downloadermiddleware_httpproxy.py index 44434f90e..ca125ba36 100644 --- a/tests/test_downloadermiddleware_httpproxy.py +++ b/tests/test_downloadermiddleware_httpproxy.py @@ -9,7 +9,7 @@ from scrapy.http import Request from scrapy.spiders import Spider from scrapy.utils.test import get_crawler -spider = Spider('foo') +spider = Spider("foo") class TestHttpProxyMiddleware(TestCase): @@ -23,184 +23,197 @@ class TestHttpProxyMiddleware(TestCase): os.environ = self._oldenv def test_not_enabled(self): - crawler = get_crawler(Spider, {'HTTPPROXY_ENABLED': False}) + crawler = get_crawler(Spider, {"HTTPPROXY_ENABLED": False}) with pytest.raises(NotConfigured): HttpProxyMiddleware.from_crawler(crawler) def test_no_environment_proxies(self): - os.environ = {'dummy_proxy': 'reset_env_and_do_not_raise'} + os.environ = {"dummy_proxy": "reset_env_and_do_not_raise"} mw = HttpProxyMiddleware() - for url in ('http://e.com', 'https://e.com', 'file:///tmp/a'): + for url in ("http://e.com", "https://e.com", "file:///tmp/a"): req = Request(url) assert mw.process_request(req, spider) is None self.assertEqual(req.url, url) self.assertEqual(req.meta, {}) def test_environment_proxies(self): - os.environ['http_proxy'] = http_proxy = 'https://proxy.for.http:3128' - os.environ['https_proxy'] = https_proxy = 'http://proxy.for.https:8080' - os.environ.pop('file_proxy', None) + os.environ["http_proxy"] = http_proxy = "https://proxy.for.http:3128" + os.environ["https_proxy"] = https_proxy = "http://proxy.for.https:8080" + os.environ.pop("file_proxy", None) mw = HttpProxyMiddleware() for url, proxy in [ - ('http://e.com', http_proxy), - ('https://e.com', https_proxy), - ('file://tmp/a', None), + ("http://e.com", http_proxy), + ("https://e.com", https_proxy), + ("file://tmp/a", None), ]: req = Request(url) assert mw.process_request(req, spider) is None self.assertEqual(req.url, url) - self.assertEqual(req.meta.get('proxy'), proxy) + self.assertEqual(req.meta.get("proxy"), proxy) def test_proxy_precedence_meta(self): - os.environ['http_proxy'] = 'https://proxy.com' + os.environ["http_proxy"] = "https://proxy.com" mw = HttpProxyMiddleware() - req = Request('http://scrapytest.org', meta={'proxy': 'https://new.proxy:3128'}) + req = Request("http://scrapytest.org", meta={"proxy": "https://new.proxy:3128"}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'https://new.proxy:3128'}) + self.assertEqual(req.meta, {"proxy": "https://new.proxy:3128"}) def test_proxy_auth(self): - os.environ['http_proxy'] = 'https://user:pass@proxy:3128' + os.environ["http_proxy"] = "https://user:pass@proxy:3128" mw = HttpProxyMiddleware() - req = Request('http://scrapytest.org') + req = Request("http://scrapytest.org") assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcjpwYXNz') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic dXNlcjpwYXNz") # proxy from request.meta - req = Request('http://scrapytest.org', meta={'proxy': 'https://username:password@proxy:3128'}) + req = Request( + "http://scrapytest.org", + meta={"proxy": "https://username:password@proxy:3128"}, + ) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcm5hbWU6cGFzc3dvcmQ=') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual( + req.headers.get("Proxy-Authorization"), b"Basic dXNlcm5hbWU6cGFzc3dvcmQ=" + ) def test_proxy_auth_empty_passwd(self): - os.environ['http_proxy'] = 'https://user:@proxy:3128' + os.environ["http_proxy"] = "https://user:@proxy:3128" mw = HttpProxyMiddleware() - req = Request('http://scrapytest.org') + req = Request("http://scrapytest.org") assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcjo=') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic dXNlcjo=") # proxy from request.meta - req = Request('http://scrapytest.org', meta={'proxy': 'https://username:@proxy:3128'}) + req = Request( + "http://scrapytest.org", meta={"proxy": "https://username:@proxy:3128"} + ) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic dXNlcm5hbWU6') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic dXNlcm5hbWU6") def test_proxy_auth_encoding(self): # utf-8 encoding - os.environ['http_proxy'] = 'https://m\u00E1n:pass@proxy:3128' - mw = HttpProxyMiddleware(auth_encoding='utf-8') - req = Request('http://scrapytest.org') + os.environ["http_proxy"] = "https://m\u00E1n:pass@proxy:3128" + mw = HttpProxyMiddleware(auth_encoding="utf-8") + req = Request("http://scrapytest.org") assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic bcOhbjpwYXNz') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic bcOhbjpwYXNz") # proxy from request.meta - req = Request('http://scrapytest.org', meta={'proxy': 'https://\u00FCser:pass@proxy:3128'}) + req = Request( + "http://scrapytest.org", meta={"proxy": "https://\u00FCser:pass@proxy:3128"} + ) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic w7xzZXI6cGFzcw==') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual( + req.headers.get("Proxy-Authorization"), b"Basic w7xzZXI6cGFzcw==" + ) # default latin-1 encoding - mw = HttpProxyMiddleware(auth_encoding='latin-1') - req = Request('http://scrapytest.org') + mw = HttpProxyMiddleware(auth_encoding="latin-1") + req = Request("http://scrapytest.org") assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic beFuOnBhc3M=') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic beFuOnBhc3M=") # proxy from request.meta, latin-1 encoding - req = Request('http://scrapytest.org', meta={'proxy': 'https://\u00FCser:pass@proxy:3128'}) + req = Request( + "http://scrapytest.org", meta={"proxy": "https://\u00FCser:pass@proxy:3128"} + ) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta['proxy'], 'https://proxy:3128') - self.assertEqual(req.headers.get('Proxy-Authorization'), b'Basic /HNlcjpwYXNz') + self.assertEqual(req.meta["proxy"], "https://proxy:3128") + self.assertEqual(req.headers.get("Proxy-Authorization"), b"Basic /HNlcjpwYXNz") def test_proxy_already_seted(self): - os.environ['http_proxy'] = 'https://proxy.for.http:3128' + os.environ["http_proxy"] = "https://proxy.for.http:3128" mw = HttpProxyMiddleware() - req = Request('http://noproxy.com', meta={'proxy': None}) + req = Request("http://noproxy.com", meta={"proxy": None}) assert mw.process_request(req, spider) is None - assert 'proxy' in req.meta and req.meta['proxy'] is None + assert "proxy" in req.meta and req.meta["proxy"] is None def test_no_proxy(self): - os.environ['http_proxy'] = 'https://proxy.for.http:3128' + os.environ["http_proxy"] = "https://proxy.for.http:3128" mw = HttpProxyMiddleware() - os.environ['no_proxy'] = '*' - req = Request('http://noproxy.com') + os.environ["no_proxy"] = "*" + req = Request("http://noproxy.com") assert mw.process_request(req, spider) is None - assert 'proxy' not in req.meta + assert "proxy" not in req.meta - os.environ['no_proxy'] = 'other.com' - req = Request('http://noproxy.com') + os.environ["no_proxy"] = "other.com" + req = Request("http://noproxy.com") assert mw.process_request(req, spider) is None - assert 'proxy' in req.meta + assert "proxy" in req.meta - os.environ['no_proxy'] = 'other.com,noproxy.com' - req = Request('http://noproxy.com') + os.environ["no_proxy"] = "other.com,noproxy.com" + req = Request("http://noproxy.com") assert mw.process_request(req, spider) is None - assert 'proxy' not in req.meta + assert "proxy" not in req.meta # proxy from meta['proxy'] takes precedence - os.environ['no_proxy'] = '*' - req = Request('http://noproxy.com', meta={'proxy': 'http://proxy.com'}) + os.environ["no_proxy"] = "*" + req = Request("http://noproxy.com", meta={"proxy": "http://proxy.com"}) assert mw.process_request(req, spider) is None - self.assertEqual(req.meta, {'proxy': 'http://proxy.com'}) + self.assertEqual(req.meta, {"proxy": "http://proxy.com"}) def test_no_proxy_invalid_values(self): - os.environ['no_proxy'] = '/var/run/docker.sock' + os.environ["no_proxy"] = "/var/run/docker.sock" mw = HttpProxyMiddleware() # '/var/run/docker.sock' may be used by the user for # no_proxy value but is not parseable and should be skipped - assert 'no' not in mw.proxies + assert "no" not in mw.proxies def test_add_proxy_without_credentials(self): middleware = HttpProxyMiddleware() - request = Request('https://example.com') + request = Request("https://example.com") assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://example.com' + request.meta["proxy"] = "https://example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_add_proxy_with_credentials(self): middleware = HttpProxyMiddleware() - request = Request('https://example.com') + request = Request("https://example.com") assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user1:password1@example.com' + request.meta["proxy"] = "https://user1:password1@example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_remove_proxy_without_credentials(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://example.com'}, + "https://example.com", + meta={"proxy": "https://example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = None + request.meta["proxy"] = None assert middleware.process_request(request, spider) is None - self.assertIsNone(request.meta['proxy']) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertIsNone(request.meta["proxy"]) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_remove_proxy_with_credentials(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = None + request.meta["proxy"] = None assert middleware.process_request(request, spider) is None - self.assertIsNone(request.meta['proxy']) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertIsNone(request.meta["proxy"]) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_add_credentials(self): """If the proxy request meta switches to a proxy URL with the same @@ -208,21 +221,21 @@ class TestHttpProxyMiddleware(TestCase): credentials must be used.""" middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://example.com'}, + "https://example.com", + meta={"proxy": "https://example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user1:password1@example.com' + request.meta["proxy"] = "https://user1:password1@example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_change_credentials(self): @@ -230,20 +243,20 @@ class TestHttpProxyMiddleware(TestCase): credentials, those new credentials must be used.""" middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user2:password2@example.com' + request.meta["proxy"] = "https://user2:password2@example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") encoded_credentials = middleware._basic_auth_header( - 'user2', - 'password2', + "user2", + "password2", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_remove_credentials(self): @@ -256,93 +269,93 @@ class TestHttpProxyMiddleware(TestCase): """ middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://example.com' + request.meta["proxy"] = "https://example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) - request.meta['proxy'] = 'https://example.com' - del request.headers[b'Proxy-Authorization'] + request.meta["proxy"] = "https://example.com" + del request.headers[b"Proxy-Authorization"] assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_change_proxy_add_credentials(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://example.com'}, + "https://example.com", + meta={"proxy": "https://example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user1:password1@example.org' + request.meta["proxy"] = "https://user1:password1@example.org" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.org') + self.assertEqual(request.meta["proxy"], "https://example.org") encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_change_proxy_keep_credentials(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user1:password1@example.org' + request.meta["proxy"] = "https://user1:password1@example.org" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.org') + self.assertEqual(request.meta["proxy"], "https://example.org") encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) # Make sure, indirectly, that _auth_proxy is updated. - request.meta['proxy'] = 'https://example.com' + request.meta["proxy"] = "https://example.com" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_change_proxy_change_credentials(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://user2:password2@example.org' + request.meta["proxy"] = "https://user2:password2@example.org" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.org') + self.assertEqual(request.meta["proxy"], "https://example.org") encoded_credentials = middleware._basic_auth_header( - 'user2', - 'password2', + "user2", + "password2", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_change_proxy_remove_credentials(self): @@ -350,14 +363,14 @@ class TestHttpProxyMiddleware(TestCase): proxy and no credentials, no credentials must be used.""" middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://example.org' + request.meta["proxy"] = "https://example.org" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta, {'proxy': 'https://example.org'}) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.meta, {"proxy": "https://example.org"}) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_change_proxy_remove_credentials_preremoved_header(self): """Corner case of proxy switch with credentials removal where the @@ -368,36 +381,36 @@ class TestHttpProxyMiddleware(TestCase): """ middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - request.meta['proxy'] = 'https://example.org' - del request.headers[b'Proxy-Authorization'] + request.meta["proxy"] = "https://example.org" + del request.headers[b"Proxy-Authorization"] assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta, {'proxy': 'https://example.org'}) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertEqual(request.meta, {"proxy": "https://example.org"}) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_proxy_authentication_header_undefined_proxy(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - headers={'Proxy-Authorization': 'Basic foo'}, + "https://example.com", + headers={"Proxy-Authorization": "Basic foo"}, ) assert middleware.process_request(request, spider) is None - self.assertNotIn('proxy', request.meta) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertNotIn("proxy", request.meta) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_proxy_authentication_header_disabled_proxy(self): middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - headers={'Proxy-Authorization': 'Basic foo'}, - meta={'proxy': None}, + "https://example.com", + headers={"Proxy-Authorization": "Basic foo"}, + meta={"proxy": None}, ) assert middleware.process_request(request, spider) is None - self.assertIsNone(request.meta['proxy']) - self.assertNotIn(b'Proxy-Authorization', request.headers) + self.assertIsNone(request.meta["proxy"]) + self.assertNotIn(b"Proxy-Authorization", request.headers) def test_proxy_authentication_header_proxy_without_credentials(self): """As long as the proxy URL in request metadata remains the same, the @@ -405,59 +418,59 @@ class TestHttpProxyMiddleware(TestCase): changed.""" middleware = HttpProxyMiddleware() request = Request( - 'https://example.com', - headers={'Proxy-Authorization': 'Basic foo'}, - meta={'proxy': 'https://example.com'}, + "https://example.com", + headers={"Proxy-Authorization": "Basic foo"}, + meta={"proxy": "https://example.com"}, ) assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertEqual(request.headers['Proxy-Authorization'], b'Basic foo') + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertEqual(request.headers["Proxy-Authorization"], b"Basic foo") assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertEqual(request.headers['Proxy-Authorization'], b'Basic foo') + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertEqual(request.headers["Proxy-Authorization"], b"Basic foo") - request.headers['Proxy-Authorization'] = b'Basic bar' + request.headers["Proxy-Authorization"] = b"Basic bar" assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') - self.assertEqual(request.headers['Proxy-Authorization'], b'Basic bar') + self.assertEqual(request.meta["proxy"], "https://example.com") + self.assertEqual(request.headers["Proxy-Authorization"], b"Basic bar") def test_proxy_authentication_header_proxy_with_same_credentials(self): middleware = HttpProxyMiddleware() encoded_credentials = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) request = Request( - 'https://example.com', - headers={'Proxy-Authorization': b'Basic ' + encoded_credentials}, - meta={'proxy': 'https://user1:password1@example.com'}, + "https://example.com", + headers={"Proxy-Authorization": b"Basic " + encoded_credentials}, + meta={"proxy": "https://user1:password1@example.com"}, ) assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials, ) def test_proxy_authentication_header_proxy_with_different_credentials(self): middleware = HttpProxyMiddleware() encoded_credentials1 = middleware._basic_auth_header( - 'user1', - 'password1', + "user1", + "password1", ) request = Request( - 'https://example.com', - headers={'Proxy-Authorization': b'Basic ' + encoded_credentials1}, - meta={'proxy': 'https://user2:password2@example.com'}, + "https://example.com", + headers={"Proxy-Authorization": b"Basic " + encoded_credentials1}, + meta={"proxy": "https://user2:password2@example.com"}, ) assert middleware.process_request(request, spider) is None - self.assertEqual(request.meta['proxy'], 'https://example.com') + self.assertEqual(request.meta["proxy"], "https://example.com") encoded_credentials2 = middleware._basic_auth_header( - 'user2', - 'password2', + "user2", + "password2", ) self.assertEqual( - request.headers['Proxy-Authorization'], - b'Basic ' + encoded_credentials2, + request.headers["Proxy-Authorization"], + b"Basic " + encoded_credentials2, ) diff --git a/tests/test_downloadermiddleware_redirect.py b/tests/test_downloadermiddleware_redirect.py index 816ac1440..e2ff9ec2b 100644 --- a/tests/test_downloadermiddleware_redirect.py +++ b/tests/test_downloadermiddleware_redirect.py @@ -1,6 +1,9 @@ import unittest -from scrapy.downloadermiddlewares.redirect import RedirectMiddleware, MetaRefreshMiddleware +from scrapy.downloadermiddlewares.redirect import ( + RedirectMiddleware, + MetaRefreshMiddleware, +) from scrapy.spiders import Spider from scrapy.exceptions import IgnoreRequest from scrapy.http import Request, Response, HtmlResponse @@ -8,24 +11,25 @@ from scrapy.utils.test import get_crawler class RedirectMiddlewareTest(unittest.TestCase): - def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('foo') + self.spider = self.crawler._create_spider("foo") self.mw = RedirectMiddleware.from_crawler(self.crawler) def test_priority_adjust(self): - req = Request('http://a.com') - rsp = Response('http://a.com', headers={'Location': 'http://a.com/redirected'}, status=301) + req = Request("http://a.com") + rsp = Response( + "http://a.com", headers={"Location": "http://a.com/redirected"}, status=301 + ) req2 = self.mw.process_response(req, rsp, self.spider) assert req2.priority > req.priority def test_redirect_3xx_permanent(self): def _test(method, status=301): - url = f'http://www.example.com/{status}' - url2 = 'http://www.example.com/redirected' + url = f"http://www.example.com/{status}" + url2 = "http://www.example.com/redirected" req = Request(url, method=method) - rsp = Response(url, headers={'Location': url2}, status=status) + rsp = Response(url, headers={"Location": url2}, status=status) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) @@ -33,33 +37,33 @@ class RedirectMiddlewareTest(unittest.TestCase): self.assertEqual(req2.method, method) # response without Location header but with status code is 3XX should be ignored - del rsp.headers['Location'] + del rsp.headers["Location"] assert self.mw.process_response(req, rsp, self.spider) is rsp - _test('GET') - _test('POST') - _test('HEAD') + _test("GET") + _test("POST") + _test("HEAD") - _test('GET', status=307) - _test('POST', status=307) - _test('HEAD', status=307) + _test("GET", status=307) + _test("POST", status=307) + _test("HEAD", status=307) - _test('GET', status=308) - _test('POST', status=308) - _test('HEAD', status=308) + _test("GET", status=308) + _test("POST", status=308) + _test("HEAD", status=308) def test_dont_redirect(self): - url = 'http://www.example.com/301' - url2 = 'http://www.example.com/redirected' - req = Request(url, meta={'dont_redirect': True}) - rsp = Response(url, headers={'Location': url2}, status=301) + url = "http://www.example.com/301" + url2 = "http://www.example.com/redirected" + req = Request(url, meta={"dont_redirect": True}) + rsp = Response(url, headers={"Location": url2}, status=301) r = self.mw.process_response(req, rsp, self.spider) assert isinstance(r, Response) assert r is rsp # Test that it redirects when dont_redirect is False - req = Request(url, meta={'dont_redirect': False}) + req = Request(url, meta={"dont_redirect": False}) rsp = Response(url2, status=200) r = self.mw.process_response(req, rsp, self.spider) @@ -67,247 +71,313 @@ class RedirectMiddlewareTest(unittest.TestCase): assert r is rsp def test_redirect_302(self): - url = 'http://www.example.com/302' - url2 = 'http://www.example.com/redirected2' - req = Request(url, method='POST', body='test', - headers={'Content-Type': 'text/plain', 'Content-length': '4'}) - rsp = Response(url, headers={'Location': url2}, status=302) + url = "http://www.example.com/302" + url2 = "http://www.example.com/redirected2" + req = Request( + url, + method="POST", + body="test", + headers={"Content-Type": "text/plain", "Content-length": "4"}, + ) + rsp = Response(url, headers={"Location": url2}, status=302) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) self.assertEqual(req2.url, url2) - self.assertEqual(req2.method, 'GET') - assert 'Content-Type' not in req2.headers, "Content-Type header must not be present in redirected request" - assert 'Content-Length' not in req2.headers, "Content-Length header must not be present in redirected request" + self.assertEqual(req2.method, "GET") + assert ( + "Content-Type" not in req2.headers + ), "Content-Type header must not be present in redirected request" + assert ( + "Content-Length" not in req2.headers + ), "Content-Length header must not be present in redirected request" assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" # response without Location header but with status code is 3XX should be ignored - del rsp.headers['Location'] + del rsp.headers["Location"] assert self.mw.process_response(req, rsp, self.spider) is rsp def test_redirect_302_head(self): - url = 'http://www.example.com/302' - url2 = 'http://www.example.com/redirected2' - req = Request(url, method='HEAD') - rsp = Response(url, headers={'Location': url2}, status=302) + url = "http://www.example.com/302" + url2 = "http://www.example.com/redirected2" + req = Request(url, method="HEAD") + rsp = Response(url, headers={"Location": url2}, status=302) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) self.assertEqual(req2.url, url2) - self.assertEqual(req2.method, 'HEAD') + self.assertEqual(req2.method, "HEAD") # response without Location header but with status code is 3XX should be ignored - del rsp.headers['Location'] + del rsp.headers["Location"] assert self.mw.process_response(req, rsp, self.spider) is rsp def test_redirect_302_relative(self): - url = 'http://www.example.com/302' - url2 = '///i8n.example2.com/302' - url3 = 'http://i8n.example2.com/302' - req = Request(url, method='HEAD') - rsp = Response(url, headers={'Location': url2}, status=302) + url = "http://www.example.com/302" + url2 = "///i8n.example2.com/302" + url3 = "http://i8n.example2.com/302" + req = Request(url, method="HEAD") + rsp = Response(url, headers={"Location": url2}, status=302) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) self.assertEqual(req2.url, url3) - self.assertEqual(req2.method, 'HEAD') + self.assertEqual(req2.method, "HEAD") # response without Location header but with status code is 3XX should be ignored - del rsp.headers['Location'] + del rsp.headers["Location"] assert self.mw.process_response(req, rsp, self.spider) is rsp def test_max_redirect_times(self): self.mw.max_redirect_times = 1 - req = Request('http://scrapytest.org/302') - rsp = Response('http://scrapytest.org/302', headers={'Location': '/redirected'}, status=302) + req = Request("http://scrapytest.org/302") + rsp = Response( + "http://scrapytest.org/302", headers={"Location": "/redirected"}, status=302 + ) req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - assert 'redirect_times' in req.meta - self.assertEqual(req.meta['redirect_times'], 1) - self.assertRaises(IgnoreRequest, self.mw.process_response, req, rsp, self.spider) + assert "redirect_times" in req.meta + self.assertEqual(req.meta["redirect_times"], 1) + self.assertRaises( + IgnoreRequest, self.mw.process_response, req, rsp, self.spider + ) def test_ttl(self): self.mw.max_redirect_times = 100 - req = Request('http://scrapytest.org/302', meta={'redirect_ttl': 1}) - rsp = Response('http://www.scrapytest.org/302', headers={'Location': '/redirected'}, status=302) + req = Request("http://scrapytest.org/302", meta={"redirect_ttl": 1}) + rsp = Response( + "http://www.scrapytest.org/302", + headers={"Location": "/redirected"}, + status=302, + ) req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - self.assertRaises(IgnoreRequest, self.mw.process_response, req, rsp, self.spider) + self.assertRaises( + IgnoreRequest, self.mw.process_response, req, rsp, self.spider + ) def test_redirect_urls(self): - req1 = Request('http://scrapytest.org/first') - rsp1 = Response('http://scrapytest.org/first', headers={'Location': '/redirected'}, status=302) + req1 = Request("http://scrapytest.org/first") + rsp1 = Response( + "http://scrapytest.org/first", + headers={"Location": "/redirected"}, + status=302, + ) req2 = self.mw.process_response(req1, rsp1, self.spider) - rsp2 = Response('http://scrapytest.org/redirected', headers={'Location': '/redirected2'}, status=302) + rsp2 = Response( + "http://scrapytest.org/redirected", + headers={"Location": "/redirected2"}, + status=302, + ) req3 = self.mw.process_response(req2, rsp2, self.spider) - self.assertEqual(req2.url, 'http://scrapytest.org/redirected') - self.assertEqual(req2.meta['redirect_urls'], ['http://scrapytest.org/first']) - self.assertEqual(req3.url, 'http://scrapytest.org/redirected2') + self.assertEqual(req2.url, "http://scrapytest.org/redirected") + self.assertEqual(req2.meta["redirect_urls"], ["http://scrapytest.org/first"]) + self.assertEqual(req3.url, "http://scrapytest.org/redirected2") self.assertEqual( - req3.meta['redirect_urls'], - ['http://scrapytest.org/first', 'http://scrapytest.org/redirected'] + req3.meta["redirect_urls"], + ["http://scrapytest.org/first", "http://scrapytest.org/redirected"], ) def test_redirect_reasons(self): - req1 = Request('http://scrapytest.org/first') - rsp1 = Response('http://scrapytest.org/first', headers={'Location': '/redirected1'}, status=301) + req1 = Request("http://scrapytest.org/first") + rsp1 = Response( + "http://scrapytest.org/first", + headers={"Location": "/redirected1"}, + status=301, + ) req2 = self.mw.process_response(req1, rsp1, self.spider) - rsp2 = Response('http://scrapytest.org/redirected1', headers={'Location': '/redirected2'}, status=301) + rsp2 = Response( + "http://scrapytest.org/redirected1", + headers={"Location": "/redirected2"}, + status=301, + ) req3 = self.mw.process_response(req2, rsp2, self.spider) - self.assertEqual(req2.meta['redirect_reasons'], [301]) - self.assertEqual(req3.meta['redirect_reasons'], [301, 301]) + self.assertEqual(req2.meta["redirect_reasons"], [301]) + self.assertEqual(req3.meta["redirect_reasons"], [301, 301]) def test_spider_handling(self): - smartspider = self.crawler._create_spider('smarty') + smartspider = self.crawler._create_spider("smarty") smartspider.handle_httpstatus_list = [404, 301, 302] - url = 'http://www.example.com/301' - url2 = 'http://www.example.com/redirected' + url = "http://www.example.com/301" + url2 = "http://www.example.com/redirected" req = Request(url) - rsp = Response(url, headers={'Location': url2}, status=301) + rsp = Response(url, headers={"Location": url2}, status=301) r = self.mw.process_response(req, rsp, smartspider) self.assertIs(r, rsp) def test_request_meta_handling(self): - url = 'http://www.example.com/301' - url2 = 'http://www.example.com/redirected' + url = "http://www.example.com/301" + url2 = "http://www.example.com/redirected" def _test_passthrough(req): - rsp = Response(url, headers={'Location': url2}, status=301, request=req) + rsp = Response(url, headers={"Location": url2}, status=301, request=req) r = self.mw.process_response(req, rsp, self.spider) self.assertIs(r, rsp) - _test_passthrough(Request(url, meta={'handle_httpstatus_list': [404, 301, 302]})) - _test_passthrough(Request(url, meta={'handle_httpstatus_all': True})) + + _test_passthrough( + Request(url, meta={"handle_httpstatus_list": [404, 301, 302]}) + ) + _test_passthrough(Request(url, meta={"handle_httpstatus_all": True})) def test_latin1_location(self): - req = Request('http://scrapytest.org/first') - latin1_location = '/ação'.encode('latin1') # HTTP historically supports latin1 - resp = Response('http://scrapytest.org/first', headers={'Location': latin1_location}, status=302) + req = Request("http://scrapytest.org/first") + latin1_location = "/ação".encode("latin1") # HTTP historically supports latin1 + resp = Response( + "http://scrapytest.org/first", + headers={"Location": latin1_location}, + status=302, + ) req_result = self.mw.process_response(req, resp, self.spider) - perc_encoded_utf8_url = 'http://scrapytest.org/a%E7%E3o' + perc_encoded_utf8_url = "http://scrapytest.org/a%E7%E3o" self.assertEqual(perc_encoded_utf8_url, req_result.url) def test_utf8_location(self): - req = Request('http://scrapytest.org/first') - utf8_location = '/ação'.encode('utf-8') # header using UTF-8 encoding - resp = Response('http://scrapytest.org/first', headers={'Location': utf8_location}, status=302) + req = Request("http://scrapytest.org/first") + utf8_location = "/ação".encode("utf-8") # header using UTF-8 encoding + resp = Response( + "http://scrapytest.org/first", + headers={"Location": utf8_location}, + status=302, + ) req_result = self.mw.process_response(req, resp, self.spider) - perc_encoded_utf8_url = 'http://scrapytest.org/a%C3%A7%C3%A3o' + perc_encoded_utf8_url = "http://scrapytest.org/a%C3%A7%C3%A3o" self.assertEqual(perc_encoded_utf8_url, req_result.url) class MetaRefreshMiddlewareTest(unittest.TestCase): - def setUp(self): crawler = get_crawler(Spider) - self.spider = crawler._create_spider('foo') + self.spider = crawler._create_spider("foo") self.mw = MetaRefreshMiddleware.from_crawler(crawler) - def _body(self, interval=5, url='http://example.org/newpage'): + def _body(self, interval=5, url="http://example.org/newpage"): html = f"""""" - return html.encode('utf-8') + return html.encode("utf-8") def test_priority_adjust(self): - req = Request('http://a.com') + req = Request("http://a.com") rsp = HtmlResponse(req.url, body=self._body()) req2 = self.mw.process_response(req, rsp, self.spider) assert req2.priority > req.priority def test_meta_refresh(self): - req = Request(url='http://example.org') + req = Request(url="http://example.org") rsp = HtmlResponse(req.url, body=self._body()) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) - self.assertEqual(req2.url, 'http://example.org/newpage') + self.assertEqual(req2.url, "http://example.org/newpage") def test_meta_refresh_with_high_interval(self): # meta-refresh with high intervals don't trigger redirects - req = Request(url='http://example.org') - rsp = HtmlResponse(url='http://example.org', - body=self._body(interval=1000), - encoding='utf-8') + req = Request(url="http://example.org") + rsp = HtmlResponse( + url="http://example.org", body=self._body(interval=1000), encoding="utf-8" + ) rsp2 = self.mw.process_response(req, rsp, self.spider) assert rsp is rsp2 def test_meta_refresh_trough_posted_request(self): - req = Request(url='http://example.org', method='POST', body='test', - headers={'Content-Type': 'text/plain', 'Content-length': '4'}) + req = Request( + url="http://example.org", + method="POST", + body="test", + headers={"Content-Type": "text/plain", "Content-length": "4"}, + ) rsp = HtmlResponse(req.url, body=self._body()) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) - self.assertEqual(req2.url, 'http://example.org/newpage') - self.assertEqual(req2.method, 'GET') - assert 'Content-Type' not in req2.headers, "Content-Type header must not be present in redirected request" - assert 'Content-Length' not in req2.headers, "Content-Length header must not be present in redirected request" + self.assertEqual(req2.url, "http://example.org/newpage") + self.assertEqual(req2.method, "GET") + assert ( + "Content-Type" not in req2.headers + ), "Content-Type header must not be present in redirected request" + assert ( + "Content-Length" not in req2.headers + ), "Content-Length header must not be present in redirected request" assert not req2.body, f"Redirected body must be empty, not '{req2.body}'" def test_max_redirect_times(self): self.mw.max_redirect_times = 1 - req = Request('http://scrapytest.org/max') + req = Request("http://scrapytest.org/max") rsp = HtmlResponse(req.url, body=self._body()) req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - assert 'redirect_times' in req.meta - self.assertEqual(req.meta['redirect_times'], 1) - self.assertRaises(IgnoreRequest, self.mw.process_response, req, rsp, self.spider) + assert "redirect_times" in req.meta + self.assertEqual(req.meta["redirect_times"], 1) + self.assertRaises( + IgnoreRequest, self.mw.process_response, req, rsp, self.spider + ) def test_ttl(self): self.mw.max_redirect_times = 100 - req = Request('http://scrapytest.org/302', meta={'redirect_ttl': 1}) + req = Request("http://scrapytest.org/302", meta={"redirect_ttl": 1}) rsp = HtmlResponse(req.url, body=self._body()) req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - self.assertRaises(IgnoreRequest, self.mw.process_response, req, rsp, self.spider) + self.assertRaises( + IgnoreRequest, self.mw.process_response, req, rsp, self.spider + ) def test_redirect_urls(self): - req1 = Request('http://scrapytest.org/first') - rsp1 = HtmlResponse(req1.url, body=self._body(url='/redirected')) + req1 = Request("http://scrapytest.org/first") + rsp1 = HtmlResponse(req1.url, body=self._body(url="/redirected")) req2 = self.mw.process_response(req1, rsp1, self.spider) assert isinstance(req2, Request), req2 - rsp2 = HtmlResponse(req2.url, body=self._body(url='/redirected2')) + rsp2 = HtmlResponse(req2.url, body=self._body(url="/redirected2")) req3 = self.mw.process_response(req2, rsp2, self.spider) assert isinstance(req3, Request), req3 - self.assertEqual(req2.url, 'http://scrapytest.org/redirected') - self.assertEqual(req2.meta['redirect_urls'], ['http://scrapytest.org/first']) - self.assertEqual(req3.url, 'http://scrapytest.org/redirected2') + self.assertEqual(req2.url, "http://scrapytest.org/redirected") + self.assertEqual(req2.meta["redirect_urls"], ["http://scrapytest.org/first"]) + self.assertEqual(req3.url, "http://scrapytest.org/redirected2") self.assertEqual( - req3.meta['redirect_urls'], - ['http://scrapytest.org/first', 'http://scrapytest.org/redirected'] + req3.meta["redirect_urls"], + ["http://scrapytest.org/first", "http://scrapytest.org/redirected"], ) def test_redirect_reasons(self): - req1 = Request('http://scrapytest.org/first') - rsp1 = HtmlResponse('http://scrapytest.org/first', body=self._body(url='/redirected')) + req1 = Request("http://scrapytest.org/first") + rsp1 = HtmlResponse( + "http://scrapytest.org/first", body=self._body(url="/redirected") + ) req2 = self.mw.process_response(req1, rsp1, self.spider) - rsp2 = HtmlResponse('http://scrapytest.org/redirected', body=self._body(url='/redirected1')) + rsp2 = HtmlResponse( + "http://scrapytest.org/redirected", body=self._body(url="/redirected1") + ) req3 = self.mw.process_response(req2, rsp2, self.spider) - self.assertEqual(req2.meta['redirect_reasons'], ['meta refresh']) - self.assertEqual(req3.meta['redirect_reasons'], ['meta refresh', 'meta refresh']) + self.assertEqual(req2.meta["redirect_reasons"], ["meta refresh"]) + self.assertEqual( + req3.meta["redirect_reasons"], ["meta refresh", "meta refresh"] + ) def test_ignore_tags_default(self): - req = Request(url='http://example.org') - body = ('''''') + req = Request(url="http://example.org") + body = ( + """""" + ) rsp = HtmlResponse(req.url, body=body.encode()) req2 = self.mw.process_response(req, rsp, self.spider) assert isinstance(req2, Request) - self.assertEqual(req2.url, 'http://example.org/newpage') + self.assertEqual(req2.url, "http://example.org/newpage") def test_ignore_tags_1_x_list(self): """Test that Scrapy 1.x behavior remains possible""" - settings = {'METAREFRESH_IGNORE_TAGS': ['script', 'noscript']} + settings = {"METAREFRESH_IGNORE_TAGS": ["script", "noscript"]} crawler = get_crawler(Spider, settings) mw = MetaRefreshMiddleware.from_crawler(crawler) - req = Request(url='http://example.org') - body = ('''''') + req = Request(url="http://example.org") + body = ( + """""" + ) rsp = HtmlResponse(req.url, body=body.encode()) response = mw.process_response(req, rsp, self.spider) assert isinstance(response, Response) diff --git a/tests/test_downloadermiddleware_retry.py b/tests/test_downloadermiddleware_retry.py index 915bd3a3e..cadd647ad 100644 --- a/tests/test_downloadermiddleware_retry.py +++ b/tests/test_downloadermiddleware_retry.py @@ -22,65 +22,68 @@ from scrapy.utils.test import get_crawler class RetryTest(unittest.TestCase): def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('foo') + self.spider = self.crawler._create_spider("foo") self.mw = RetryMiddleware.from_crawler(self.crawler) self.mw.max_retry_times = 2 def test_priority_adjust(self): - req = Request('http://www.scrapytest.org/503') - rsp = Response('http://www.scrapytest.org/503', body=b'', status=503) + req = Request("http://www.scrapytest.org/503") + rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) req2 = self.mw.process_response(req, rsp, self.spider) assert req2.priority < req.priority def test_404(self): - req = Request('http://www.scrapytest.org/404') - rsp = Response('http://www.scrapytest.org/404', body=b'', status=404) + req = Request("http://www.scrapytest.org/404") + rsp = Response("http://www.scrapytest.org/404", body=b"", status=404) # dont retry 404s assert self.mw.process_response(req, rsp, self.spider) is rsp def test_dont_retry(self): - req = Request('http://www.scrapytest.org/503', meta={'dont_retry': True}) - rsp = Response('http://www.scrapytest.org/503', body=b'', status=503) + req = Request("http://www.scrapytest.org/503", meta={"dont_retry": True}) + rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) # first retry r = self.mw.process_response(req, rsp, self.spider) assert r is rsp # Test retry when dont_retry set to False - req = Request('http://www.scrapytest.org/503', meta={'dont_retry': False}) - rsp = Response('http://www.scrapytest.org/503') + req = Request("http://www.scrapytest.org/503", meta={"dont_retry": False}) + rsp = Response("http://www.scrapytest.org/503") # first retry r = self.mw.process_response(req, rsp, self.spider) assert r is rsp def test_dont_retry_exc(self): - req = Request('http://www.scrapytest.org/503', meta={'dont_retry': True}) + req = Request("http://www.scrapytest.org/503", meta={"dont_retry": True}) r = self.mw.process_exception(req, DNSLookupError(), self.spider) assert r is None def test_503(self): - req = Request('http://www.scrapytest.org/503') - rsp = Response('http://www.scrapytest.org/503', body=b'', status=503) + req = Request("http://www.scrapytest.org/503") + rsp = Response("http://www.scrapytest.org/503", body=b"", status=503) # first retry req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - self.assertEqual(req.meta['retry_times'], 1) + self.assertEqual(req.meta["retry_times"], 1) # second retry req = self.mw.process_response(req, rsp, self.spider) assert isinstance(req, Request) - self.assertEqual(req.meta['retry_times'], 2) + self.assertEqual(req.meta["retry_times"], 2) # discard it assert self.mw.process_response(req, rsp, self.spider) is rsp - assert self.crawler.stats.get_value('retry/max_reached') == 1 - assert self.crawler.stats.get_value('retry/reason_count/503 Service Unavailable') == 2 - assert self.crawler.stats.get_value('retry/count') == 2 + assert self.crawler.stats.get_value("retry/max_reached") == 1 + assert ( + self.crawler.stats.get_value("retry/reason_count/503 Service Unavailable") + == 2 + ) + assert self.crawler.stats.get_value("retry/count") == 2 def test_twistederrors(self): exceptions = [ @@ -96,24 +99,27 @@ class RetryTest(unittest.TestCase): ] for exc in exceptions: - req = Request(f'http://www.scrapytest.org/{exc.__name__}') - self._test_retry_exception(req, exc('foo')) + req = Request(f"http://www.scrapytest.org/{exc.__name__}") + self._test_retry_exception(req, exc("foo")) stats = self.crawler.stats - assert stats.get_value('retry/max_reached') == len(exceptions) - assert stats.get_value('retry/count') == len(exceptions) * 2 - assert stats.get_value('retry/reason_count/twisted.internet.defer.TimeoutError') == 2 + assert stats.get_value("retry/max_reached") == len(exceptions) + assert stats.get_value("retry/count") == len(exceptions) * 2 + assert ( + stats.get_value("retry/reason_count/twisted.internet.defer.TimeoutError") + == 2 + ) def _test_retry_exception(self, req, exception): # first retry req = self.mw.process_exception(req, exception, self.spider) assert isinstance(req, Request) - self.assertEqual(req.meta['retry_times'], 1) + self.assertEqual(req.meta["retry_times"], 1) # second retry req = self.mw.process_exception(req, exception, self.spider) assert isinstance(req, Request) - self.assertEqual(req.meta['retry_times'], 2) + self.assertEqual(req.meta["retry_times"], 2) # discard it req = self.mw.process_exception(req, exception, self.spider) @@ -122,22 +128,22 @@ class RetryTest(unittest.TestCase): class MaxRetryTimesTest(unittest.TestCase): - invalid_url = 'http://www.scrapytest.org/invalid_url' + invalid_url = "http://www.scrapytest.org/invalid_url" def get_spider_and_middleware(self, settings=None): crawler = get_crawler(Spider, settings or {}) - spider = crawler._create_spider('foo') + spider = crawler._create_spider("foo") middleware = RetryMiddleware.from_crawler(crawler) return spider, middleware def test_with_settings_zero(self): max_retry_times = 0 - settings = {'RETRY_TIMES': max_retry_times} + settings = {"RETRY_TIMES": max_retry_times} spider, middleware = self.get_spider_and_middleware(settings) req = Request(self.invalid_url) self._test_retry( req, - DNSLookupError('foo'), + DNSLookupError("foo"), max_retry_times, spider=spider, middleware=middleware, @@ -146,11 +152,11 @@ class MaxRetryTimesTest(unittest.TestCase): def test_with_metakey_zero(self): max_retry_times = 0 spider, middleware = self.get_spider_and_middleware() - meta = {'max_retry_times': max_retry_times} + meta = {"max_retry_times": max_retry_times} req = Request(self.invalid_url, meta=meta) self._test_retry( req, - DNSLookupError('foo'), + DNSLookupError("foo"), max_retry_times, spider=spider, middleware=middleware, @@ -158,12 +164,12 @@ class MaxRetryTimesTest(unittest.TestCase): def test_without_metakey(self): max_retry_times = 5 - settings = {'RETRY_TIMES': max_retry_times} + settings = {"RETRY_TIMES": max_retry_times} spider, middleware = self.get_spider_and_middleware(settings) req = Request(self.invalid_url) self._test_retry( req, - DNSLookupError('foo'), + DNSLookupError("foo"), max_retry_times, spider=spider, middleware=middleware, @@ -173,22 +179,22 @@ class MaxRetryTimesTest(unittest.TestCase): meta_max_retry_times = 3 middleware_max_retry_times = 2 - req1 = Request(self.invalid_url, meta={'max_retry_times': meta_max_retry_times}) + req1 = Request(self.invalid_url, meta={"max_retry_times": meta_max_retry_times}) req2 = Request(self.invalid_url) - settings = {'RETRY_TIMES': middleware_max_retry_times} + settings = {"RETRY_TIMES": middleware_max_retry_times} spider, middleware = self.get_spider_and_middleware(settings) self._test_retry( req1, - DNSLookupError('foo'), + DNSLookupError("foo"), meta_max_retry_times, spider=spider, middleware=middleware, ) self._test_retry( req2, - DNSLookupError('foo'), + DNSLookupError("foo"), middleware_max_retry_times, spider=spider, middleware=middleware, @@ -198,22 +204,22 @@ class MaxRetryTimesTest(unittest.TestCase): meta_max_retry_times = 4 middleware_max_retry_times = 5 - req1 = Request(self.invalid_url, meta={'max_retry_times': meta_max_retry_times}) + req1 = Request(self.invalid_url, meta={"max_retry_times": meta_max_retry_times}) req2 = Request(self.invalid_url) - settings = {'RETRY_TIMES': middleware_max_retry_times} + settings = {"RETRY_TIMES": middleware_max_retry_times} spider, middleware = self.get_spider_and_middleware(settings) self._test_retry( req1, - DNSLookupError('foo'), + DNSLookupError("foo"), meta_max_retry_times, spider=spider, middleware=middleware, ) self._test_retry( req2, - DNSLookupError('foo'), + DNSLookupError("foo"), middleware_max_retry_times, spider=spider, middleware=middleware, @@ -223,13 +229,13 @@ class MaxRetryTimesTest(unittest.TestCase): max_retry_times = 4 spider, middleware = self.get_spider_and_middleware() meta = { - 'max_retry_times': max_retry_times, - 'dont_retry': True, + "max_retry_times": max_retry_times, + "dont_retry": True, } req = Request(self.invalid_url, meta=meta) self._test_retry( req, - DNSLookupError('foo'), + DNSLookupError("foo"), 0, spider=spider, middleware=middleware, @@ -256,13 +262,12 @@ class MaxRetryTimesTest(unittest.TestCase): class GetRetryRequestTest(unittest.TestCase): - def get_spider(self, settings=None): crawler = get_crawler(Spider, settings or {}) - return crawler._create_spider('foo') + return crawler._create_spider("foo") def test_basic_usage(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() with LogCapture() as log: new_request = get_retry_request( @@ -273,10 +278,10 @@ class GetRetryRequestTest(unittest.TestCase): self.assertNotEqual(new_request, request) self.assertEqual(new_request.dont_filter, True) expected_retry_times = 1 - self.assertEqual(new_request.meta['retry_times'], expected_retry_times) + self.assertEqual(new_request.meta["retry_times"], expected_retry_times) self.assertEqual(new_request.priority, -1) expected_reason = "unspecified" - for stat in ('retry/count', f'retry/reason_count/{expected_reason}'): + for stat in ("retry/count", f"retry/reason_count/{expected_reason}"): self.assertEqual(spider.crawler.stats.get_value(stat), 1) log.check_present( ( @@ -288,7 +293,7 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_max_retries_reached(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() max_retry_times = 0 with LogCapture() as log: @@ -298,10 +303,7 @@ class GetRetryRequestTest(unittest.TestCase): max_retry_times=max_retry_times, ) self.assertEqual(new_request, None) - self.assertEqual( - spider.crawler.stats.get_value('retry/max_reached'), - 1 - ) + self.assertEqual(spider.crawler.stats.get_value("retry/max_reached"), 1) failure_count = max_retry_times + 1 expected_reason = "unspecified" log.check_present( @@ -314,7 +316,7 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_one_retry(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() with LogCapture() as log: new_request = get_retry_request( @@ -326,10 +328,10 @@ class GetRetryRequestTest(unittest.TestCase): self.assertNotEqual(new_request, request) self.assertEqual(new_request.dont_filter, True) expected_retry_times = 1 - self.assertEqual(new_request.meta['retry_times'], expected_retry_times) + self.assertEqual(new_request.meta["retry_times"], expected_retry_times) self.assertEqual(new_request.priority, -1) expected_reason = "unspecified" - for stat in ('retry/count', f'retry/reason_count/{expected_reason}'): + for stat in ("retry/count", f"retry/reason_count/{expected_reason}"): self.assertEqual(spider.crawler.stats.get_value(stat), 1) log.check_present( ( @@ -342,7 +344,7 @@ class GetRetryRequestTest(unittest.TestCase): def test_two_retries(self): spider = self.get_spider() - request = Request('https://example.com') + request = Request("https://example.com") new_request = request max_retry_times = 2 for index in range(max_retry_times): @@ -356,10 +358,10 @@ class GetRetryRequestTest(unittest.TestCase): self.assertNotEqual(new_request, request) self.assertEqual(new_request.dont_filter, True) expected_retry_times = index + 1 - self.assertEqual(new_request.meta['retry_times'], expected_retry_times) + self.assertEqual(new_request.meta["retry_times"], expected_retry_times) self.assertEqual(new_request.priority, -expected_retry_times) expected_reason = "unspecified" - for stat in ('retry/count', f'retry/reason_count/{expected_reason}'): + for stat in ("retry/count", f"retry/reason_count/{expected_reason}"): value = spider.crawler.stats.get_value(stat) self.assertEqual(value, expected_retry_times) log.check_present( @@ -378,10 +380,7 @@ class GetRetryRequestTest(unittest.TestCase): max_retry_times=max_retry_times, ) self.assertEqual(new_request, None) - self.assertEqual( - spider.crawler.stats.get_value('retry/max_reached'), - 1 - ) + self.assertEqual(spider.crawler.stats.get_value("retry/max_reached"), 1) failure_count = max_retry_times + 1 expected_reason = "unspecified" log.check_present( @@ -394,14 +393,14 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_no_spider(self): - request = Request('https://example.com') + request = Request("https://example.com") with self.assertRaises(TypeError): get_retry_request(request) # pylint: disable=missing-kwoa def test_max_retry_times_setting(self): max_retry_times = 0 - spider = self.get_spider({'RETRY_TIMES': max_retry_times}) - request = Request('https://example.com') + spider = self.get_spider({"RETRY_TIMES": max_retry_times}) + request = Request("https://example.com") new_request = get_retry_request( request, spider=spider, @@ -410,9 +409,9 @@ class GetRetryRequestTest(unittest.TestCase): def test_max_retry_times_meta(self): max_retry_times = 0 - spider = self.get_spider({'RETRY_TIMES': max_retry_times + 1}) - meta = {'max_retry_times': max_retry_times} - request = Request('https://example.com', meta=meta) + spider = self.get_spider({"RETRY_TIMES": max_retry_times + 1}) + meta = {"max_retry_times": max_retry_times} + request = Request("https://example.com", meta=meta) new_request = get_retry_request( request, spider=spider, @@ -421,9 +420,9 @@ class GetRetryRequestTest(unittest.TestCase): def test_max_retry_times_argument(self): max_retry_times = 0 - spider = self.get_spider({'RETRY_TIMES': max_retry_times + 1}) - meta = {'max_retry_times': max_retry_times + 1} - request = Request('https://example.com', meta=meta) + spider = self.get_spider({"RETRY_TIMES": max_retry_times + 1}) + meta = {"max_retry_times": max_retry_times + 1} + request = Request("https://example.com", meta=meta) new_request = get_retry_request( request, spider=spider, @@ -433,8 +432,8 @@ class GetRetryRequestTest(unittest.TestCase): def test_priority_adjust_setting(self): priority_adjust = 1 - spider = self.get_spider({'RETRY_PRIORITY_ADJUST': priority_adjust}) - request = Request('https://example.com') + spider = self.get_spider({"RETRY_PRIORITY_ADJUST": priority_adjust}) + request = Request("https://example.com") new_request = get_retry_request( request, spider=spider, @@ -443,8 +442,8 @@ class GetRetryRequestTest(unittest.TestCase): def test_priority_adjust_argument(self): priority_adjust = 1 - spider = self.get_spider({'RETRY_PRIORITY_ADJUST': priority_adjust + 1}) - request = Request('https://example.com') + spider = self.get_spider({"RETRY_PRIORITY_ADJUST": priority_adjust + 1}) + request = Request("https://example.com") new_request = get_retry_request( request, spider=spider, @@ -453,9 +452,9 @@ class GetRetryRequestTest(unittest.TestCase): self.assertEqual(new_request.priority, priority_adjust) def test_log_extra_retry_success(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() - with LogCapture(attributes=('spider',)) as log: + with LogCapture(attributes=("spider",)) as log: get_retry_request( request, spider=spider, @@ -463,9 +462,9 @@ class GetRetryRequestTest(unittest.TestCase): log.check_present(spider) def test_log_extra_retries_exceeded(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() - with LogCapture(attributes=('spider',)) as log: + with LogCapture(attributes=("spider",)) as log: get_retry_request( request, spider=spider, @@ -474,9 +473,9 @@ class GetRetryRequestTest(unittest.TestCase): log.check_present(spider) def test_reason_string(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() - expected_reason = 'because' + expected_reason = "because" with LogCapture() as log: get_retry_request( request, @@ -484,7 +483,7 @@ class GetRetryRequestTest(unittest.TestCase): reason=expected_reason, ) expected_retry_times = 1 - for stat in ('retry/count', f'retry/reason_count/{expected_reason}'): + for stat in ("retry/count", f"retry/reason_count/{expected_reason}"): self.assertEqual(spider.crawler.stats.get_value(stat), 1) log.check_present( ( @@ -496,10 +495,10 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_reason_builtin_exception(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() expected_reason = NotImplementedError() - expected_reason_string = 'builtins.NotImplementedError' + expected_reason_string = "builtins.NotImplementedError" with LogCapture() as log: get_retry_request( request, @@ -508,7 +507,7 @@ class GetRetryRequestTest(unittest.TestCase): ) expected_retry_times = 1 stat = spider.crawler.stats.get_value( - f'retry/reason_count/{expected_reason_string}' + f"retry/reason_count/{expected_reason_string}" ) self.assertEqual(stat, 1) log.check_present( @@ -521,10 +520,10 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_reason_builtin_exception_class(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() expected_reason = NotImplementedError - expected_reason_string = 'builtins.NotImplementedError' + expected_reason_string = "builtins.NotImplementedError" with LogCapture() as log: get_retry_request( request, @@ -533,7 +532,7 @@ class GetRetryRequestTest(unittest.TestCase): ) expected_retry_times = 1 stat = spider.crawler.stats.get_value( - f'retry/reason_count/{expected_reason_string}' + f"retry/reason_count/{expected_reason_string}" ) self.assertEqual(stat, 1) log.check_present( @@ -546,10 +545,10 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_reason_custom_exception(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() expected_reason = IgnoreRequest() - expected_reason_string = 'scrapy.exceptions.IgnoreRequest' + expected_reason_string = "scrapy.exceptions.IgnoreRequest" with LogCapture() as log: get_retry_request( request, @@ -558,7 +557,7 @@ class GetRetryRequestTest(unittest.TestCase): ) expected_retry_times = 1 stat = spider.crawler.stats.get_value( - f'retry/reason_count/{expected_reason_string}' + f"retry/reason_count/{expected_reason_string}" ) self.assertEqual(stat, 1) log.check_present( @@ -571,10 +570,10 @@ class GetRetryRequestTest(unittest.TestCase): ) def test_reason_custom_exception_class(self): - request = Request('https://example.com') + request = Request("https://example.com") spider = self.get_spider() expected_reason = IgnoreRequest - expected_reason_string = 'scrapy.exceptions.IgnoreRequest' + expected_reason_string = "scrapy.exceptions.IgnoreRequest" with LogCapture() as log: get_retry_request( request, @@ -583,7 +582,7 @@ class GetRetryRequestTest(unittest.TestCase): ) expected_retry_times = 1 stat = spider.crawler.stats.get_value( - f'retry/reason_count/{expected_reason_string}' + f"retry/reason_count/{expected_reason_string}" ) self.assertEqual(stat, 1) log.check_present( @@ -626,7 +625,10 @@ class GetRetryRequestTest(unittest.TestCase): reason=expected_reason, stats_base_key=stats_key, ) - for stat in (f"{stats_key}/count", f"{stats_key}/reason_count/{expected_reason}"): + for stat in ( + f"{stats_key}/count", + f"{stats_key}/reason_count/{expected_reason}", + ): self.assertEqual(spider.crawler.stats.get_value(stat), 1) diff --git a/tests/test_downloadermiddleware_robotstxt.py b/tests/test_downloadermiddleware_robotstxt.py index 1460d88eb..ac08c6006 100644 --- a/tests/test_downloadermiddleware_robotstxt.py +++ b/tests/test_downloadermiddleware_robotstxt.py @@ -4,8 +4,10 @@ from twisted.internet import reactor, error from twisted.internet.defer import Deferred, DeferredList, maybeDeferred from twisted.python import failure from twisted.trial import unittest -from scrapy.downloadermiddlewares.robotstxt import (RobotsTxtMiddleware, - logger as mw_module_logger) +from scrapy.downloadermiddlewares.robotstxt import ( + RobotsTxtMiddleware, + logger as mw_module_logger, +) from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request, Response, TextResponse from scrapy.settings import Settings @@ -13,7 +15,6 @@ from tests.test_robotstxt_interface import rerp_available, reppy_available class RobotsTxtMiddlewareTest(unittest.TestCase): - def setUp(self): self.crawler = mock.MagicMock() self.crawler.settings = Settings() @@ -24,12 +25,12 @@ class RobotsTxtMiddlewareTest(unittest.TestCase): def test_robotstxt_settings(self): self.crawler.settings = Settings() - self.crawler.settings.set('USER_AGENT', 'CustomAgent') + self.crawler.settings.set("USER_AGENT", "CustomAgent") self.assertRaises(NotConfigured, RobotsTxtMiddleware, self.crawler) def _get_successful_crawler(self): crawler = self.crawler - crawler.settings.set('ROBOTSTXT_OBEY', True) + crawler.settings.set("ROBOTSTXT_OBEY", True) ROBOTS = """ User-Agent: * Disallow: /admin/ @@ -39,138 +40,179 @@ Disallow: /wiki/K%C3%A4ytt%C3%A4j%C3%A4: Disallow: /wiki/Käyttäjä: User-Agent: UnicödeBöt Disallow: /some/randome/page.html -""".encode('utf-8') - response = TextResponse('http://site.local/robots.txt', body=ROBOTS) +""".encode( + "utf-8" + ) + response = TextResponse("http://site.local/robots.txt", body=ROBOTS) def return_response(request): deferred = Deferred() reactor.callFromThread(deferred.callback, response) return deferred + crawler.engine.download.side_effect = return_response return crawler def test_robotstxt(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) - return DeferredList([ - self.assertNotIgnored(Request('http://site.local/allowed'), middleware), - self.assertIgnored(Request('http://site.local/admin/main'), middleware), - self.assertIgnored(Request('http://site.local/static/'), middleware), - self.assertIgnored(Request('http://site.local/wiki/K%C3%A4ytt%C3%A4j%C3%A4:'), middleware), - self.assertIgnored(Request('http://site.local/wiki/Käyttäjä:'), middleware) - ], fireOnOneErrback=True) + return DeferredList( + [ + self.assertNotIgnored(Request("http://site.local/allowed"), middleware), + self.assertIgnored(Request("http://site.local/admin/main"), middleware), + self.assertIgnored(Request("http://site.local/static/"), middleware), + self.assertIgnored( + Request("http://site.local/wiki/K%C3%A4ytt%C3%A4j%C3%A4:"), + middleware, + ), + self.assertIgnored( + Request("http://site.local/wiki/Käyttäjä:"), middleware + ), + ], + fireOnOneErrback=True, + ) def test_robotstxt_ready_parser(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) - d = self.assertNotIgnored(Request('http://site.local/allowed'), middleware) - d.addCallback(lambda _: self.assertNotIgnored(Request('http://site.local/allowed'), middleware)) + d = self.assertNotIgnored(Request("http://site.local/allowed"), middleware) + d.addCallback( + lambda _: self.assertNotIgnored( + Request("http://site.local/allowed"), middleware + ) + ) return d def test_robotstxt_meta(self): middleware = RobotsTxtMiddleware(self._get_successful_crawler()) - meta = {'dont_obey_robotstxt': True} - return DeferredList([ - self.assertNotIgnored(Request('http://site.local/allowed', meta=meta), middleware), - self.assertNotIgnored(Request('http://site.local/admin/main', meta=meta), middleware), - self.assertNotIgnored(Request('http://site.local/static/', meta=meta), middleware) - ], fireOnOneErrback=True) + meta = {"dont_obey_robotstxt": True} + return DeferredList( + [ + self.assertNotIgnored( + Request("http://site.local/allowed", meta=meta), middleware + ), + self.assertNotIgnored( + Request("http://site.local/admin/main", meta=meta), middleware + ), + self.assertNotIgnored( + Request("http://site.local/static/", meta=meta), middleware + ), + ], + fireOnOneErrback=True, + ) def _get_garbage_crawler(self): crawler = self.crawler - crawler.settings.set('ROBOTSTXT_OBEY', True) - response = Response('http://site.local/robots.txt', body=b'GIF89a\xd3\x00\xfe\x00\xa2') + crawler.settings.set("ROBOTSTXT_OBEY", True) + response = Response( + "http://site.local/robots.txt", body=b"GIF89a\xd3\x00\xfe\x00\xa2" + ) def return_response(request): deferred = Deferred() reactor.callFromThread(deferred.callback, response) return deferred + crawler.engine.download.side_effect = return_response return crawler def test_robotstxt_garbage(self): # garbage response should be discarded, equal 'allow all' middleware = RobotsTxtMiddleware(self._get_garbage_crawler()) - deferred = DeferredList([ - self.assertNotIgnored(Request('http://site.local'), middleware), - self.assertNotIgnored(Request('http://site.local/allowed'), middleware), - self.assertNotIgnored(Request('http://site.local/admin/main'), middleware), - self.assertNotIgnored(Request('http://site.local/static/'), middleware) - ], fireOnOneErrback=True) + deferred = DeferredList( + [ + self.assertNotIgnored(Request("http://site.local"), middleware), + self.assertNotIgnored(Request("http://site.local/allowed"), middleware), + self.assertNotIgnored( + Request("http://site.local/admin/main"), middleware + ), + self.assertNotIgnored(Request("http://site.local/static/"), middleware), + ], + fireOnOneErrback=True, + ) return deferred def _get_emptybody_crawler(self): crawler = self.crawler - crawler.settings.set('ROBOTSTXT_OBEY', True) - response = Response('http://site.local/robots.txt') + crawler.settings.set("ROBOTSTXT_OBEY", True) + response = Response("http://site.local/robots.txt") def return_response(request): deferred = Deferred() reactor.callFromThread(deferred.callback, response) return deferred + crawler.engine.download.side_effect = return_response return crawler def test_robotstxt_empty_response(self): # empty response should equal 'allow all' middleware = RobotsTxtMiddleware(self._get_emptybody_crawler()) - return DeferredList([ - self.assertNotIgnored(Request('http://site.local/allowed'), middleware), - self.assertNotIgnored(Request('http://site.local/admin/main'), middleware), - self.assertNotIgnored(Request('http://site.local/static/'), middleware) - ], fireOnOneErrback=True) + return DeferredList( + [ + self.assertNotIgnored(Request("http://site.local/allowed"), middleware), + self.assertNotIgnored( + Request("http://site.local/admin/main"), middleware + ), + self.assertNotIgnored(Request("http://site.local/static/"), middleware), + ], + fireOnOneErrback=True, + ) def test_robotstxt_error(self): - self.crawler.settings.set('ROBOTSTXT_OBEY', True) - err = error.DNSLookupError('Robotstxt address not found') + self.crawler.settings.set("ROBOTSTXT_OBEY", True) + err = error.DNSLookupError("Robotstxt address not found") def return_failure(request): deferred = Deferred() reactor.callFromThread(deferred.errback, failure.Failure(err)) return deferred + self.crawler.engine.download.side_effect = return_failure middleware = RobotsTxtMiddleware(self.crawler) middleware._logerror = mock.MagicMock(side_effect=middleware._logerror) - deferred = middleware.process_request(Request('http://site.local'), None) + deferred = middleware.process_request(Request("http://site.local"), None) deferred.addCallback(lambda _: self.assertTrue(middleware._logerror.called)) return deferred def test_robotstxt_immediate_error(self): - self.crawler.settings.set('ROBOTSTXT_OBEY', True) - err = error.DNSLookupError('Robotstxt address not found') + self.crawler.settings.set("ROBOTSTXT_OBEY", True) + err = error.DNSLookupError("Robotstxt address not found") def immediate_failure(request): deferred = Deferred() deferred.errback(failure.Failure(err)) return deferred + self.crawler.engine.download.side_effect = immediate_failure middleware = RobotsTxtMiddleware(self.crawler) - return self.assertNotIgnored(Request('http://site.local'), middleware) + return self.assertNotIgnored(Request("http://site.local"), middleware) def test_ignore_robotstxt_request(self): - self.crawler.settings.set('ROBOTSTXT_OBEY', True) + self.crawler.settings.set("ROBOTSTXT_OBEY", True) def ignore_request(request): deferred = Deferred() reactor.callFromThread(deferred.errback, failure.Failure(IgnoreRequest())) return deferred + self.crawler.engine.download.side_effect = ignore_request middleware = RobotsTxtMiddleware(self.crawler) mw_module_logger.error = mock.MagicMock() - d = self.assertNotIgnored(Request('http://site.local/allowed'), middleware) + d = self.assertNotIgnored(Request("http://site.local/allowed"), middleware) d.addCallback(lambda _: self.assertFalse(mw_module_logger.error.called)) return d def test_robotstxt_user_agent_setting(self): crawler = self._get_successful_crawler() - crawler.settings.set('ROBOTSTXT_USER_AGENT', 'Examplebot') - crawler.settings.set('USER_AGENT', 'Mozilla/5.0 (X11; Linux x86_64)') + crawler.settings.set("ROBOTSTXT_USER_AGENT", "Examplebot") + crawler.settings.set("USER_AGENT", "Mozilla/5.0 (X11; Linux x86_64)") middleware = RobotsTxtMiddleware(crawler) rp = mock.MagicMock(return_value=True) - middleware.process_request_2(rp, Request('http://site.local/allowed'), None) - rp.allowed.assert_called_once_with('http://site.local/allowed', 'Examplebot') + middleware.process_request_2(rp, Request("http://site.local/allowed"), None) + rp.allowed.assert_called_once_with("http://site.local/allowed", "Examplebot") def assertNotIgnored(self, request, middleware): spider = None # not actually used @@ -180,8 +222,9 @@ Disallow: /some/randome/page.html def assertIgnored(self, request, middleware): spider = None # not actually used - return self.assertFailure(maybeDeferred(middleware.process_request, request, spider), - IgnoreRequest) + return self.assertFailure( + maybeDeferred(middleware.process_request, request, spider), IgnoreRequest + ) class RobotsTxtMiddlewareWithRerpTest(RobotsTxtMiddlewareTest): @@ -190,7 +233,9 @@ class RobotsTxtMiddlewareWithRerpTest(RobotsTxtMiddlewareTest): def setUp(self): super().setUp() - self.crawler.settings.set('ROBOTSTXT_PARSER', 'scrapy.robotstxt.RerpRobotParser') + self.crawler.settings.set( + "ROBOTSTXT_PARSER", "scrapy.robotstxt.RerpRobotParser" + ) class RobotsTxtMiddlewareWithReppyTest(RobotsTxtMiddlewareTest): @@ -199,4 +244,6 @@ class RobotsTxtMiddlewareWithReppyTest(RobotsTxtMiddlewareTest): def setUp(self): super().setUp() - self.crawler.settings.set('ROBOTSTXT_PARSER', 'scrapy.robotstxt.ReppyRobotParser') + self.crawler.settings.set( + "ROBOTSTXT_PARSER", "scrapy.robotstxt.ReppyRobotParser" + ) diff --git a/tests/test_downloadermiddleware_stats.py b/tests/test_downloadermiddleware_stats.py index 7d88ba4d2..39dfe9ab5 100644 --- a/tests/test_downloadermiddleware_stats.py +++ b/tests/test_downloadermiddleware_stats.py @@ -15,59 +15,57 @@ class MyException(Exception): class TestDownloaderStats(TestCase): - def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('scrapytest.org') + self.spider = self.crawler._create_spider("scrapytest.org") self.mw = DownloaderStats(self.crawler.stats) self.crawler.stats.open_spider(self.spider) - self.req = Request('http://scrapytest.org') - self.res = Response('scrapytest.org', status=400) + self.req = Request("http://scrapytest.org") + self.res = Response("scrapytest.org", status=400) def assertStatsEqual(self, key, value): self.assertEqual( self.crawler.stats.get_value(key, spider=self.spider), value, - str(self.crawler.stats.get_stats(self.spider)) + str(self.crawler.stats.get_stats(self.spider)), ) def test_process_request(self): self.mw.process_request(self.req, self.spider) - self.assertStatsEqual('downloader/request_count', 1) + self.assertStatsEqual("downloader/request_count", 1) def test_process_response(self): self.mw.process_response(self.req, self.res, self.spider) - self.assertStatsEqual('downloader/response_count', 1) + self.assertStatsEqual("downloader/response_count", 1) def test_response_len(self): - body = (b'', b'not_empty') # empty/notempty body - headers = ({}, {'lang': 'en'}, {'lang': 'en', 'User-Agent': 'scrapy'}) # 0 headers, 1h and 2h + body = (b"", b"not_empty") # empty/notempty body + headers = ( + {}, + {"lang": "en"}, + {"lang": "en", "User-Agent": "scrapy"}, + ) # 0 headers, 1h and 2h test_responses = [ # form test responses with all combinations of body/headers - Response( - url='scrapytest.org', - status=200, - body=r[0], - headers=r[1] - ) + Response(url="scrapytest.org", status=200, body=r[0], headers=r[1]) for r in product(body, headers) ] for test_response in test_responses: - self.crawler.stats.set_value('downloader/response_bytes', 0) + self.crawler.stats.set_value("downloader/response_bytes", 0) self.mw.process_response(self.req, test_response, self.spider) with warnings.catch_warnings(): warnings.simplefilter("ignore", ScrapyDeprecationWarning) resp_size = len(response_httprepr(test_response)) - self.assertStatsEqual('downloader/response_bytes', resp_size) + self.assertStatsEqual("downloader/response_bytes", resp_size) def test_process_exception(self): self.mw.process_exception(self.req, MyException(), self.spider) - self.assertStatsEqual('downloader/exception_count', 1) + self.assertStatsEqual("downloader/exception_count", 1) self.assertStatsEqual( - 'downloader/exception_type_count/tests.test_downloadermiddleware_stats.MyException', - 1 + "downloader/exception_type_count/tests.test_downloadermiddleware_stats.MyException", + 1, ) def tearDown(self): - self.crawler.stats.close_spider(self.spider, '') + self.crawler.stats.close_spider(self.spider, "") diff --git a/tests/test_downloadermiddleware_useragent.py b/tests/test_downloadermiddleware_useragent.py index a286764fd..927f0ae4d 100644 --- a/tests/test_downloadermiddleware_useragent.py +++ b/tests/test_downloadermiddleware_useragent.py @@ -7,48 +7,48 @@ from scrapy.utils.test import get_crawler class UserAgentMiddlewareTest(TestCase): - def get_spider_and_mw(self, default_useragent): - crawler = get_crawler(Spider, {'USER_AGENT': default_useragent}) - spider = crawler._create_spider('foo') + crawler = get_crawler(Spider, {"USER_AGENT": default_useragent}) + spider = crawler._create_spider("foo") return spider, UserAgentMiddleware.from_crawler(crawler) def test_default_agent(self): - spider, mw = self.get_spider_and_mw('default_useragent') - req = Request('http://scrapytest.org/') + spider, mw = self.get_spider_and_mw("default_useragent") + req = Request("http://scrapytest.org/") assert mw.process_request(req, spider) is None - self.assertEqual(req.headers['User-Agent'], b'default_useragent') + self.assertEqual(req.headers["User-Agent"], b"default_useragent") def test_remove_agent(self): # settings UESR_AGENT to None should remove the user agent - spider, mw = self.get_spider_and_mw('default_useragent') + spider, mw = self.get_spider_and_mw("default_useragent") spider.user_agent = None mw.spider_opened(spider) - req = Request('http://scrapytest.org/') + req = Request("http://scrapytest.org/") assert mw.process_request(req, spider) is None - assert req.headers.get('User-Agent') is None + assert req.headers.get("User-Agent") is None def test_spider_agent(self): - spider, mw = self.get_spider_and_mw('default_useragent') - spider.user_agent = 'spider_useragent' + spider, mw = self.get_spider_and_mw("default_useragent") + spider.user_agent = "spider_useragent" mw.spider_opened(spider) - req = Request('http://scrapytest.org/') + req = Request("http://scrapytest.org/") assert mw.process_request(req, spider) is None - self.assertEqual(req.headers['User-Agent'], b'spider_useragent') + self.assertEqual(req.headers["User-Agent"], b"spider_useragent") def test_header_agent(self): - spider, mw = self.get_spider_and_mw('default_useragent') - spider.user_agent = 'spider_useragent' + spider, mw = self.get_spider_and_mw("default_useragent") + spider.user_agent = "spider_useragent" mw.spider_opened(spider) - req = Request('http://scrapytest.org/', - headers={'User-Agent': 'header_useragent'}) + req = Request( + "http://scrapytest.org/", headers={"User-Agent": "header_useragent"} + ) assert mw.process_request(req, spider) is None - self.assertEqual(req.headers['User-Agent'], b'header_useragent') + self.assertEqual(req.headers["User-Agent"], b"header_useragent") def test_no_agent(self): spider, mw = self.get_spider_and_mw(None) spider.user_agent = None mw.spider_opened(spider) - req = Request('http://scrapytest.org/') + req = Request("http://scrapytest.org/") assert mw.process_request(req, spider) is None - assert 'User-Agent' not in req.headers + assert "User-Agent" not in req.headers diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index e028dea4d..4019012d1 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -25,59 +25,62 @@ def _get_dupefilter(*, crawler=None, settings=None, open=True): class FromCrawlerRFPDupeFilter(RFPDupeFilter): - @classmethod def from_crawler(cls, crawler): df = super().from_crawler(crawler) - df.method = 'from_crawler' + df.method = "from_crawler" return df class FromSettingsRFPDupeFilter(RFPDupeFilter): - @classmethod def from_settings(cls, settings, *, fingerprinter=None): df = super().from_settings(settings, fingerprinter=fingerprinter) - df.method = 'from_settings' + df.method = "from_settings" return df class DirectDupeFilter: - method = 'n/a' + method = "n/a" class RFPDupeFilterTest(unittest.TestCase): - def test_df_from_crawler_scheduler(self): - settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_DEBUG": True, + "DUPEFILTER_CLASS": FromCrawlerRFPDupeFilter, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) - self.assertEqual(scheduler.df.method, 'from_crawler') + self.assertEqual(scheduler.df.method, "from_crawler") def test_df_from_settings_scheduler(self): - settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromSettingsRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_DEBUG": True, + "DUPEFILTER_CLASS": FromSettingsRFPDupeFilter, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) self.assertTrue(scheduler.df.debug) - self.assertEqual(scheduler.df.method, 'from_settings') + self.assertEqual(scheduler.df.method, "from_settings") def test_df_direct_scheduler(self): - settings = {'DUPEFILTER_CLASS': DirectDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_CLASS": DirectDupeFilter, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(settings_dict=settings) scheduler = Scheduler.from_crawler(crawler) - self.assertEqual(scheduler.df.method, 'n/a') + self.assertEqual(scheduler.df.method, "n/a") def test_filter(self): dupefilter = _get_dupefilter() - r1 = Request('http://scrapytest.org/1') - r2 = Request('http://scrapytest.org/2') - r3 = Request('http://scrapytest.org/2') + r1 = Request("http://scrapytest.org/1") + r2 = Request("http://scrapytest.org/2") + r3 = Request("http://scrapytest.org/2") assert not dupefilter.request_seen(r1) assert dupefilter.request_seen(r1) @@ -85,23 +88,23 @@ class RFPDupeFilterTest(unittest.TestCase): assert not dupefilter.request_seen(r2) assert dupefilter.request_seen(r3) - dupefilter.close('finished') + dupefilter.close("finished") def test_dupefilter_path(self): - r1 = Request('http://scrapytest.org/1') - r2 = Request('http://scrapytest.org/2') + r1 = Request("http://scrapytest.org/1") + r2 = Request("http://scrapytest.org/2") path = tempfile.mkdtemp() try: - df = _get_dupefilter(settings={'JOBDIR': path}, open=False) + df = _get_dupefilter(settings={"JOBDIR": path}, open=False) try: df.open() assert not df.request_seen(r1) assert df.request_seen(r1) finally: - df.close('finished') + df.close("finished") - df2 = _get_dupefilter(settings={'JOBDIR': path}, open=False) + df2 = _get_dupefilter(settings={"JOBDIR": path}, open=False) assert df != df2 try: df2.open() @@ -109,7 +112,7 @@ class RFPDupeFilterTest(unittest.TestCase): assert not df2.request_seen(r2) assert df2.request_seen(r2) finally: - df2.close('finished') + df2.close("finished") finally: shutil.rmtree(path) @@ -119,147 +122,156 @@ class RFPDupeFilterTest(unittest.TestCase): """ dupefilter = _get_dupefilter() - r1 = Request('http://scrapytest.org/index.html') - r2 = Request('http://scrapytest.org/INDEX.html') + r1 = Request("http://scrapytest.org/index.html") + r2 = Request("http://scrapytest.org/INDEX.html") assert not dupefilter.request_seen(r1) assert not dupefilter.request_seen(r2) - dupefilter.close('finished') + dupefilter.close("finished") class RequestFingerprinter: - def fingerprint(self, request): fp = hashlib.sha1() fp.update(to_bytes(request.url.lower())) return fp.digest() - settings = {'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter} + settings = {"REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter} case_insensitive_dupefilter = _get_dupefilter(settings=settings) assert not case_insensitive_dupefilter.request_seen(r1) assert case_insensitive_dupefilter.request_seen(r2) - case_insensitive_dupefilter.close('finished') + case_insensitive_dupefilter.close("finished") def test_seenreq_newlines(self): - """ Checks against adding duplicate \r to - line endings on Windows platforms. """ + """Checks against adding duplicate \r to + line endings on Windows platforms.""" - r1 = Request('http://scrapytest.org/1') + r1 = Request("http://scrapytest.org/1") path = tempfile.mkdtemp() - crawler = get_crawler(settings_dict={'JOBDIR': path}) + crawler = get_crawler(settings_dict={"JOBDIR": path}) try: scheduler = Scheduler.from_crawler(crawler) df = scheduler.df df.open() df.request_seen(r1) - df.close('finished') + df.close("finished") - with Path(path, 'requests.seen').open('rb') as seen_file: + with Path(path, "requests.seen").open("rb") as seen_file: line = next(seen_file).decode() - assert not line.endswith('\r\r\n') - if sys.platform == 'win32': - assert line.endswith('\r\n') + assert not line.endswith("\r\r\n") + if sys.platform == "win32": + assert line.endswith("\r\n") else: - assert line.endswith('\n') + assert line.endswith("\n") finally: shutil.rmtree(path) def test_log(self): with LogCapture() as log: - settings = {'DUPEFILTER_DEBUG': False, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_DEBUG": False, + "DUPEFILTER_CLASS": FromCrawlerRFPDupeFilter, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) - r1 = Request('http://scrapytest.org/index.html') - r2 = Request('http://scrapytest.org/index.html') + r1 = Request("http://scrapytest.org/index.html") + r2 = Request("http://scrapytest.org/index.html") dupefilter.log(r1, spider) dupefilter.log(r2, spider) - assert crawler.stats.get_value('dupefilter/filtered') == 2 + assert crawler.stats.get_value("dupefilter/filtered") == 2 log.check_present( ( - 'scrapy.dupefilters', - 'DEBUG', - 'Filtered duplicate request: - no more' - ' duplicates will be shown (see DUPEFILTER_DEBUG to show all duplicates)' + "scrapy.dupefilters", + "DEBUG", + "Filtered duplicate request: - no more" + " duplicates will be shown (see DUPEFILTER_DEBUG to show all duplicates)", ) ) - dupefilter.close('finished') + dupefilter.close("finished") def test_log_debug(self): with LogCapture() as log: - settings = {'DUPEFILTER_DEBUG': True, - 'DUPEFILTER_CLASS': FromCrawlerRFPDupeFilter, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_DEBUG": True, + "DUPEFILTER_CLASS": FromCrawlerRFPDupeFilter, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) - r1 = Request('http://scrapytest.org/index.html') - r2 = Request('http://scrapytest.org/index.html', - headers={'Referer': 'http://scrapytest.org/INDEX.html'}) + r1 = Request("http://scrapytest.org/index.html") + r2 = Request( + "http://scrapytest.org/index.html", + headers={"Referer": "http://scrapytest.org/INDEX.html"}, + ) dupefilter.log(r1, spider) dupefilter.log(r2, spider) - assert crawler.stats.get_value('dupefilter/filtered') == 2 + assert crawler.stats.get_value("dupefilter/filtered") == 2 log.check_present( ( - 'scrapy.dupefilters', - 'DEBUG', - 'Filtered duplicate request: (referer: None)' + "scrapy.dupefilters", + "DEBUG", + "Filtered duplicate request: (referer: None)", ) ) log.check_present( ( - 'scrapy.dupefilters', - 'DEBUG', - 'Filtered duplicate request: ' - ' (referer: http://scrapytest.org/INDEX.html)' + "scrapy.dupefilters", + "DEBUG", + "Filtered duplicate request: " + " (referer: http://scrapytest.org/INDEX.html)", ) ) - dupefilter.close('finished') + dupefilter.close("finished") def test_log_debug_default_dupefilter(self): with LogCapture() as log: - settings = {'DUPEFILTER_DEBUG': True, - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7'} + settings = { + "DUPEFILTER_DEBUG": True, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } crawler = get_crawler(SimpleSpider, settings_dict=settings) spider = SimpleSpider.from_crawler(crawler) dupefilter = _get_dupefilter(crawler=crawler) - r1 = Request('http://scrapytest.org/index.html') - r2 = Request('http://scrapytest.org/index.html', - headers={'Referer': 'http://scrapytest.org/INDEX.html'}) + r1 = Request("http://scrapytest.org/index.html") + r2 = Request( + "http://scrapytest.org/index.html", + headers={"Referer": "http://scrapytest.org/INDEX.html"}, + ) dupefilter.log(r1, spider) dupefilter.log(r2, spider) - assert crawler.stats.get_value('dupefilter/filtered') == 2 + assert crawler.stats.get_value("dupefilter/filtered") == 2 log.check_present( ( - 'scrapy.dupefilters', - 'DEBUG', - 'Filtered duplicate request: (referer: None)' + "scrapy.dupefilters", + "DEBUG", + "Filtered duplicate request: (referer: None)", ) ) log.check_present( ( - 'scrapy.dupefilters', - 'DEBUG', - 'Filtered duplicate request: ' - ' (referer: http://scrapytest.org/INDEX.html)' + "scrapy.dupefilters", + "DEBUG", + "Filtered duplicate request: " + " (referer: http://scrapytest.org/INDEX.html)", ) ) - dupefilter.close('finished') + dupefilter.close("finished") diff --git a/tests/test_engine.py b/tests/test_engine.py index aa3313659..7b861332e 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -81,11 +81,11 @@ class TestSpider(Spider): adapter = ItemAdapter(self.item_cls()) m = self.name_re.search(response.text) if m: - adapter['name'] = m.group(1) - adapter['url'] = response.url + adapter["name"] = m.group(1) + adapter["url"] = response.url m = self.price_re.search(response.text) if m: - adapter['price'] = m.group(1) + adapter["price"] = m.group(1) return adapter.item @@ -136,8 +136,10 @@ def start_test_site(debug=False): port = reactor.listenTCP(0, server.Site(r), interface="127.0.0.1") if debug: - print(f"Test server running at http://localhost:{port.getHost().port}/ " - "- hit Ctrl-C to finish.") + print( + f"Test server running at http://localhost:{port.getHost().port}/ " + "- hit Ctrl-C to finish." + ) return port @@ -169,7 +171,7 @@ class CrawlerRun: ] for name, signal in vars(signals).items(): - if not name.startswith('_'): + if not name.startswith("_"): dispatcher.connect(self.record_signal, signal) self.crawler = get_crawler(self.spider_class) @@ -179,8 +181,12 @@ class CrawlerRun: self.crawler.signals.connect(self.bytes_received, signals.bytes_received) self.crawler.signals.connect(self.request_scheduled, signals.request_scheduled) self.crawler.signals.connect(self.request_dropped, signals.request_dropped) - self.crawler.signals.connect(self.request_reached, signals.request_reached_downloader) - self.crawler.signals.connect(self.response_downloaded, signals.response_downloaded) + self.crawler.signals.connect( + self.request_reached, signals.request_reached_downloader + ) + self.crawler.signals.connect( + self.response_downloaded, signals.response_downloaded + ) self.crawler.crawl(start_urls=start_urls) self.spider = self.crawler.spider @@ -191,7 +197,7 @@ class CrawlerRun: def stop(self): self.port.stopListening() # FIXME: wait for this Deferred for name, signal in vars(signals).items(): - if not name.startswith('_'): + if not name.startswith("_"): disconnect_all(signal) self.deferred.callback(None) return self.crawler.stop() @@ -230,8 +236,8 @@ class CrawlerRun: def record_signal(self, *args, **kwargs): """Record a signal and its parameters""" signalargs = kwargs.copy() - sig = signalargs.pop('signal') - signalargs.pop('sender', None) + sig = signalargs.pop("signal") + signalargs.pop("sender", None) self.signals_caught[sig] = signalargs @@ -239,7 +245,12 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_crawler(self): - for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): + for spider in ( + TestSpider, + DictItemsSpider, + AttrsItemsSpider, + DataClassItemsSpider, + ): run = CrawlerRun(spider) yield run.run() self._assert_visited_urls(run) @@ -266,20 +277,30 @@ class EngineTest(unittest.TestCase): def test_crawler_change_close_reason_on_idle(self): run = CrawlerRun(ChangeCloseReasonSpider) yield run.run() - self.assertEqual({'spider': run.spider, 'reason': 'custom_reason'}, - run.signals_caught[signals.spider_closed]) + self.assertEqual( + {"spider": run.spider, "reason": "custom_reason"}, + run.signals_caught[signals.spider_closed], + ) def _assert_visited_urls(self, run: CrawlerRun): - must_be_visited = ["/", "/redirect", "/redirected", - "/item1.html", "/item2.html", "/item999.html"] + must_be_visited = [ + "/", + "/redirect", + "/redirected", + "/item1.html", + "/item2.html", + "/item999.html", + ] urls_visited = {rp[0].url for rp in run.respplug} urls_expected = {run.geturl(p) for p in must_be_visited} - assert urls_expected <= urls_visited, f"URLs not visited: {list(urls_expected - urls_visited)}" + assert ( + urls_expected <= urls_visited + ), f"URLs not visited: {list(urls_expected - urls_visited)}" def _assert_scheduled_requests(self, run: CrawlerRun, count=None): self.assertEqual(count, len(run.reqplug)) - paths_expected = ['/item999.html', '/item2.html', '/item1.html'] + paths_expected = ["/item999.html", "/item2.html", "/item1.html"] urls_requested = {rq[0].url for rq in run.reqplug} urls_expected = {run.geturl(p) for p in paths_expected} @@ -287,10 +308,10 @@ class EngineTest(unittest.TestCase): scheduled_requests_count = len(run.reqplug) dropped_requests_count = len(run.reqdropped) responses_count = len(run.respplug) - self.assertEqual(scheduled_requests_count, - dropped_requests_count + responses_count) - self.assertEqual(len(run.reqreached), - responses_count) + self.assertEqual( + scheduled_requests_count, dropped_requests_count + responses_count + ) + self.assertEqual(len(run.reqreached), responses_count) def _assert_dropped_requests(self, run: CrawlerRun): self.assertEqual(len(run.reqdropped), 1) @@ -301,9 +322,9 @@ class EngineTest(unittest.TestCase): self.assertEqual(count, len(run.reqreached)) for response, _ in run.respplug: - if run.getpath(response.url) == '/item999.html': + if run.getpath(response.url) == "/item999.html": self.assertEqual(404, response.status) - if run.getpath(response.url) == '/redirect': + if run.getpath(response.url) == "/redirect": self.assertEqual(302, response.status) def _assert_items_error(self, run: CrawlerRun): @@ -312,25 +333,25 @@ class EngineTest(unittest.TestCase): self.assertEqual(failure.value.__class__, ZeroDivisionError) self.assertEqual(spider, run.spider) - self.assertEqual(item['url'], response.url) - if 'item1.html' in item['url']: - self.assertEqual('Item 1 name', item['name']) - self.assertEqual('100', item['price']) - if 'item2.html' in item['url']: - self.assertEqual('Item 2 name', item['name']) - self.assertEqual('200', item['price']) + self.assertEqual(item["url"], response.url) + if "item1.html" in item["url"]: + self.assertEqual("Item 1 name", item["name"]) + self.assertEqual("100", item["price"]) + if "item2.html" in item["url"]: + self.assertEqual("Item 2 name", item["name"]) + self.assertEqual("200", item["price"]) def _assert_scraped_items(self, run: CrawlerRun): self.assertEqual(2, len(run.itemresp)) for item, response in run.itemresp: item = ItemAdapter(item) - self.assertEqual(item['url'], response.url) - if 'item1.html' in item['url']: - self.assertEqual('Item 1 name', item['name']) - self.assertEqual('100', item['price']) - if 'item2.html' in item['url']: - self.assertEqual('Item 2 name', item['name']) - self.assertEqual('200', item['price']) + self.assertEqual(item["url"], response.url) + if "item1.html" in item["url"]: + self.assertEqual("Item 1 name", item["name"]) + self.assertEqual("100", item["price"]) + if "item2.html" in item["url"]: + self.assertEqual("Item 2 name", item["name"]) + self.assertEqual("200", item["price"]) def _assert_headers_received(self, run: CrawlerRun): for headers in run.headers.values(): @@ -351,17 +372,17 @@ class EngineTest(unittest.TestCase): self.assertEqual(joined_data, get_testdata("test_site", "item2.html")) elif run.getpath(request.url) == "/redirected": self.assertEqual(joined_data, b"Redirected here") - elif run.getpath(request.url) == '/redirect': + elif run.getpath(request.url) == "/redirect": self.assertEqual( joined_data, b"\n\n" b" \n" - b" \n" + b' \n' b" \n" - b" \n" - b" click here\n" + b' \n' + b' click here\n' b" \n" - b"\n" + b"\n", ) elif run.getpath(request.url) == "/tem999.html": self.assertEqual( @@ -372,7 +393,7 @@ class EngineTest(unittest.TestCase): b"

No Such Resource

\n" b"

File not found.

\n" b" \n" - b"\n" + b"\n", ) elif run.getpath(request.url) == "/numbers": # signal was fired multiple times @@ -389,12 +410,16 @@ class EngineTest(unittest.TestCase): assert signals.spider_closed in run.signals_caught assert signals.headers_received in run.signals_caught - self.assertEqual({'spider': run.spider}, - run.signals_caught[signals.spider_opened]) - self.assertEqual({'spider': run.spider}, - run.signals_caught[signals.spider_idle]) - self.assertEqual({'spider': run.spider, 'reason': 'finished'}, - run.signals_caught[signals.spider_closed]) + self.assertEqual( + {"spider": run.spider}, run.signals_caught[signals.spider_opened] + ) + self.assertEqual( + {"spider": run.spider}, run.signals_caught[signals.spider_idle] + ) + self.assertEqual( + {"spider": run.spider, "reason": "finished"}, + run.signals_caught[signals.spider_closed], + ) @defer.inlineCallbacks def test_close_downloader(self): @@ -415,9 +440,11 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_close_spiders_downloader(self): - with pytest.warns(ScrapyDeprecationWarning, - match="ExecutionEngine.open_spiders is deprecated, " - "please use ExecutionEngine.spider instead"): + with pytest.warns( + ScrapyDeprecationWarning, + match="ExecutionEngine.open_spiders is deprecated, " + "please use ExecutionEngine.spider instead", + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) yield e.open_spider(TestSpider(), []) self.assertEqual(len(e.open_spiders), 1) @@ -426,9 +453,11 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_close_engine_spiders_downloader(self): - with pytest.warns(ScrapyDeprecationWarning, - match="ExecutionEngine.open_spiders is deprecated, " - "please use ExecutionEngine.spider instead"): + with pytest.warns( + ScrapyDeprecationWarning, + match="ExecutionEngine.open_spiders is deprecated, " + "please use ExecutionEngine.spider instead", + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) yield e.open_spider(TestSpider(), []) e.start() @@ -439,9 +468,11 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_crawl_deprecated_spider_arg(self): - with pytest.warns(ScrapyDeprecationWarning, - match="Passing a 'spider' argument to " - "ExecutionEngine.crawl is deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="Passing a 'spider' argument to " + "ExecutionEngine.crawl is deprecated", + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) @@ -451,9 +482,11 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_download_deprecated_spider_arg(self): - with pytest.warns(ScrapyDeprecationWarning, - match="Passing a 'spider' argument to " - "ExecutionEngine.download is deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="Passing a 'spider' argument to " + "ExecutionEngine.download is deprecated", + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) @@ -463,9 +496,11 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_deprecated_schedule(self): - with pytest.warns(ScrapyDeprecationWarning, - match="ExecutionEngine.schedule is deprecated, please use " - "ExecutionEngine.crawl or ExecutionEngine.download instead"): + with pytest.warns( + ScrapyDeprecationWarning, + match="ExecutionEngine.schedule is deprecated, please use " + "ExecutionEngine.crawl or ExecutionEngine.download instead", + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) spider = TestSpider() yield e.open_spider(spider, []) @@ -475,8 +510,9 @@ class EngineTest(unittest.TestCase): @defer.inlineCallbacks def test_deprecated_has_capacity(self): - with pytest.warns(ScrapyDeprecationWarning, - match="ExecutionEngine.has_capacity is deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, match="ExecutionEngine.has_capacity is deprecated" + ): e = ExecutionEngine(get_crawler(TestSpider), lambda _: None) self.assertTrue(e.has_capacity()) spider = TestSpider() @@ -489,14 +525,14 @@ class EngineTest(unittest.TestCase): def test_short_timeout(self): args = ( sys.executable, - '-m', - 'scrapy.cmdline', - 'fetch', - '-s', - 'CLOSESPIDER_TIMEOUT=0.001', - '-s', - 'LOG_LEVEL=DEBUG', - 'http://toscrape.com', + "-m", + "scrapy.cmdline", + "fetch", + "-s", + "CLOSESPIDER_TIMEOUT=0.001", + "-s", + "LOG_LEVEL=DEBUG", + "http://toscrape.com", ) p = subprocess.Popen( args, @@ -506,7 +542,7 @@ class EngineTest(unittest.TestCase): def kill_proc(): p.kill() p.communicate() - assert False, 'Command took too much time to complete' + assert False, "Command took too much time to complete" timer = Timer(15, kill_proc) try: @@ -515,10 +551,10 @@ class EngineTest(unittest.TestCase): finally: timer.cancel() - self.assertNotIn(b'Traceback', stderr) + self.assertNotIn(b"Traceback", stderr) if __name__ == "__main__": - if len(sys.argv) > 1 and sys.argv[1] == 'runserver': + if len(sys.argv) > 1 and sys.argv[1] == "runserver": start_test_site(debug=True) reactor.run() diff --git a/tests/test_engine_stop_download_bytes.py b/tests/test_engine_stop_download_bytes.py index 933e4067d..fb8dd4313 100644 --- a/tests/test_engine_stop_download_bytes.py +++ b/tests/test_engine_stop_download_bytes.py @@ -22,22 +22,39 @@ class BytesReceivedCrawlerRun(CrawlerRun): class BytesReceivedEngineTest(EngineTest): @defer.inlineCallbacks def test_crawler(self): - for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): + for spider in ( + TestSpider, + DictItemsSpider, + AttrsItemsSpider, + DataClassItemsSpider, + ): run = BytesReceivedCrawlerRun(spider) with LogCapture() as log: yield run.run() - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received")) - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received")) - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for " - "from signal handler BytesReceivedCrawlerRun.bytes_received")) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for " + "from signal handler BytesReceivedCrawlerRun.bytes_received", + ) + ) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for " + "from signal handler BytesReceivedCrawlerRun.bytes_received", + ) + ) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for " + "from signal handler BytesReceivedCrawlerRun.bytes_received", + ) + ) self._assert_visited_urls(run) self._assert_scheduled_requests(run, count=9) self._assert_downloaded_responses(run, count=9) diff --git a/tests/test_engine_stop_download_headers.py b/tests/test_engine_stop_download_headers.py index 8975d0e3f..93437559d 100644 --- a/tests/test_engine_stop_download_headers.py +++ b/tests/test_engine_stop_download_headers.py @@ -22,22 +22,39 @@ class HeadersReceivedCrawlerRun(CrawlerRun): class HeadersReceivedEngineTest(EngineTest): @defer.inlineCallbacks def test_crawler(self): - for spider in (TestSpider, DictItemsSpider, AttrsItemsSpider, DataClassItemsSpider): + for spider in ( + TestSpider, + DictItemsSpider, + AttrsItemsSpider, + DataClassItemsSpider, + ): run = HeadersReceivedCrawlerRun(spider) with LogCapture() as log: yield run.run() - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from" - " signal handler HeadersReceivedCrawlerRun.headers_received")) - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from signal" - " handler HeadersReceivedCrawlerRun.headers_received")) - log.check_present(("scrapy.core.downloader.handlers.http11", - "DEBUG", - f"Download stopped for from" - " signal handler HeadersReceivedCrawlerRun.headers_received")) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for from" + " signal handler HeadersReceivedCrawlerRun.headers_received", + ) + ) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for from signal" + " handler HeadersReceivedCrawlerRun.headers_received", + ) + ) + log.check_present( + ( + "scrapy.core.downloader.handlers.http11", + "DEBUG", + f"Download stopped for from" + " signal handler HeadersReceivedCrawlerRun.headers_received", + ) + ) self._assert_visited_urls(run) self._assert_downloaded_responses(run, count=6) self._assert_signals_caught(run) @@ -51,4 +68,6 @@ class HeadersReceivedEngineTest(EngineTest): must_be_visited = ["/", "/redirect", "/redirected"] urls_visited = {rp[0].url for rp in run.respplug} urls_expected = {run.geturl(p) for p in must_be_visited} - assert urls_expected <= urls_visited, f"URLs not visited: {list(urls_expected - urls_visited)}" + assert ( + urls_expected <= urls_visited + ), f"URLs not visited: {list(urls_expected - urls_visited)}" diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 86c5d8b5e..7689045b7 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -16,9 +16,15 @@ from scrapy.item import Item, Field from scrapy.utils.python import to_unicode from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.exporters import ( - BaseItemExporter, PprintItemExporter, PickleItemExporter, CsvItemExporter, - XmlItemExporter, JsonLinesItemExporter, JsonItemExporter, - PythonItemExporter, MarshalItemExporter + BaseItemExporter, + PprintItemExporter, + PickleItemExporter, + CsvItemExporter, + XmlItemExporter, + JsonLinesItemExporter, + JsonItemExporter, + PythonItemExporter, + MarshalItemExporter, ) @@ -54,7 +60,7 @@ class BaseItemExporterTest(unittest.TestCase): custom_field_item_class = CustomFieldItem def setUp(self): - self.i = self.item_class(name='John\xa3', age='22') + self.i = self.item_class(name="John\xa3", age="22") self.output = BytesIO() self.ie = self._get_exporter() @@ -71,10 +77,10 @@ class BaseItemExporterTest(unittest.TestCase): def _get_nonstring_types_item(self): return { - 'boolean': False, - 'number': 22, - 'time': datetime(2015, 1, 1, 1, 1, 1), - 'float': 3.14, + "boolean": False, + "number": 22, + "time": datetime(2015, 1, 1, 1, 1, 1), + "float": 3.14, } def assertItemExportWorks(self, item): @@ -95,35 +101,36 @@ class BaseItemExporterTest(unittest.TestCase): def test_serialize_field(self): a = ItemAdapter(self.i) - res = self.ie.serialize_field(a.get_field_meta('name'), 'name', a['name']) - self.assertEqual(res, 'John\xa3') + res = self.ie.serialize_field(a.get_field_meta("name"), "name", a["name"]) + self.assertEqual(res, "John\xa3") - res = self.ie.serialize_field(a.get_field_meta('age'), 'age', a['age']) - self.assertEqual(res, '22') + res = self.ie.serialize_field(a.get_field_meta("age"), "age", a["age"]) + self.assertEqual(res, "22") def test_fields_to_export(self): - ie = self._get_exporter(fields_to_export=['name']) - self.assertEqual(list(ie._get_serialized_fields(self.i)), [('name', 'John\xa3')]) + ie = self._get_exporter(fields_to_export=["name"]) + self.assertEqual( + list(ie._get_serialized_fields(self.i)), [("name", "John\xa3")] + ) - ie = self._get_exporter(fields_to_export=['name'], encoding='latin-1') + ie = self._get_exporter(fields_to_export=["name"], encoding="latin-1") _, name = list(ie._get_serialized_fields(self.i))[0] assert isinstance(name, str) - self.assertEqual(name, 'John\xa3') + self.assertEqual(name, "John\xa3") - ie = self._get_exporter( - fields_to_export={'name': '名稱'} - ) - self.assertEqual( - list(ie._get_serialized_fields(self.i)), - [('名稱', 'John\xa3')] - ) + ie = self._get_exporter(fields_to_export={"name": "名稱"}) + self.assertEqual(list(ie._get_serialized_fields(self.i)), [("名稱", "John\xa3")]) def test_field_custom_serializer(self): - i = self.custom_field_item_class(name='John\xa3', age='22') + i = self.custom_field_item_class(name="John\xa3", age="22") a = ItemAdapter(i) ie = self._get_exporter() - self.assertEqual(ie.serialize_field(a.get_field_meta('name'), 'name', a['name']), 'John\xa3') - self.assertEqual(ie.serialize_field(a.get_field_meta('age'), 'age', a['age']), '24') + self.assertEqual( + ie.serialize_field(a.get_field_meta("name"), "name", a["name"]), "John\xa3" + ) + self.assertEqual( + ie.serialize_field(a.get_field_meta("age"), "age", a["age"]), "24" + ) class BaseItemExporterDataclassTest(BaseItemExporterTest): @@ -137,54 +144,63 @@ class PythonItemExporterTest(BaseItemExporterTest): def test_invalid_option(self): with self.assertRaisesRegex(TypeError, "Unexpected options: invalid_option"): - PythonItemExporter(invalid_option='something') + PythonItemExporter(invalid_option="something") def test_nested_item(self): - i1 = self.item_class(name='Joseph', age='22') - i2 = dict(name='Maria', age=i1) - i3 = self.item_class(name='Jesus', age=i2) + i1 = self.item_class(name="Joseph", age="22") + i2 = dict(name="Maria", age=i1) + i3 = self.item_class(name="Jesus", age=i2) ie = self._get_exporter() exported = ie.export_item(i3) self.assertEqual(type(exported), dict) self.assertEqual( exported, - {'age': {'age': {'age': '22', 'name': 'Joseph'}, 'name': 'Maria'}, 'name': 'Jesus'} + { + "age": {"age": {"age": "22", "name": "Joseph"}, "name": "Maria"}, + "name": "Jesus", + }, ) - self.assertEqual(type(exported['age']), dict) - self.assertEqual(type(exported['age']['age']), dict) + self.assertEqual(type(exported["age"]), dict) + self.assertEqual(type(exported["age"]["age"]), dict) def test_export_list(self): - i1 = self.item_class(name='Joseph', age='22') - i2 = self.item_class(name='Maria', age=[i1]) - i3 = self.item_class(name='Jesus', age=[i2]) + i1 = self.item_class(name="Joseph", age="22") + i2 = self.item_class(name="Maria", age=[i1]) + i3 = self.item_class(name="Jesus", age=[i2]) ie = self._get_exporter() exported = ie.export_item(i3) self.assertEqual( exported, - {'age': [{'age': [{'age': '22', 'name': 'Joseph'}], 'name': 'Maria'}], 'name': 'Jesus'} + { + "age": [{"age": [{"age": "22", "name": "Joseph"}], "name": "Maria"}], + "name": "Jesus", + }, ) - self.assertEqual(type(exported['age'][0]), dict) - self.assertEqual(type(exported['age'][0]['age'][0]), dict) + self.assertEqual(type(exported["age"][0]), dict) + self.assertEqual(type(exported["age"][0]["age"][0]), dict) def test_export_item_dict_list(self): - i1 = self.item_class(name='Joseph', age='22') - i2 = dict(name='Maria', age=[i1]) - i3 = self.item_class(name='Jesus', age=[i2]) + i1 = self.item_class(name="Joseph", age="22") + i2 = dict(name="Maria", age=[i1]) + i3 = self.item_class(name="Jesus", age=[i2]) ie = self._get_exporter() exported = ie.export_item(i3) self.assertEqual( exported, - {'age': [{'age': [{'age': '22', 'name': 'Joseph'}], 'name': 'Maria'}], 'name': 'Jesus'} + { + "age": [{"age": [{"age": "22", "name": "Joseph"}], "name": "Maria"}], + "name": "Jesus", + }, ) - self.assertEqual(type(exported['age'][0]), dict) - self.assertEqual(type(exported['age'][0]['age'][0]), dict) + self.assertEqual(type(exported["age"][0]), dict) + self.assertEqual(type(exported["age"][0]["age"][0]), dict) def test_export_binary(self): with catch_warnings(): - filterwarnings('ignore', category=ScrapyDeprecationWarning) + filterwarnings("ignore", category=ScrapyDeprecationWarning) exporter = PythonItemExporter(binary=True) - value = self.item_class(name='John\xa3', age='22') - expected = {b'name': b'John\xc2\xa3', b'age': b'22'} + value = self.item_class(name="John\xa3", age="22") + expected = {b"name": b"John\xc2\xa3", b"age": b"22"} self.assertEqual(expected, exporter.export_item(value)) def test_nonstring_types_item(self): @@ -200,7 +216,6 @@ class PythonItemExporterDataclassTest(PythonItemExporterTest): class PprintItemExporterTest(BaseItemExporterTest): - def _get_exporter(self, **kwargs): return PprintItemExporter(self.output, **kwargs) @@ -214,7 +229,6 @@ class PprintItemExporterDataclassTest(PprintItemExporterTest): class PickleItemExporterTest(BaseItemExporterTest): - def _get_exporter(self, **kwargs): return PickleItemExporter(self.output, **kwargs) @@ -222,8 +236,8 @@ class PickleItemExporterTest(BaseItemExporterTest): self._assert_expected_item(pickle.loads(self.output.getvalue())) def test_export_multiple_items(self): - i1 = self.item_class(name='hello', age='world') - i2 = self.item_class(name='bye', age='world') + i1 = self.item_class(name="hello", age="world") + i2 = self.item_class(name="bye", age="world") f = BytesIO() ie = PickleItemExporter(f) ie.start_exporting() @@ -250,7 +264,6 @@ class PickleItemExporterDataclassTest(PickleItemExporterTest): class MarshalItemExporterTest(BaseItemExporterTest): - def _get_exporter(self, **kwargs): self.output = tempfile.TemporaryFile() return MarshalItemExporter(self.output, **kwargs) @@ -261,7 +274,7 @@ class MarshalItemExporterTest(BaseItemExporterTest): def test_nonstring_types_item(self): item = self._get_nonstring_types_item() - item.pop('time') # datetime is not marshallable + item.pop("time") # datetime is not marshallable fp = tempfile.TemporaryFile() ie = MarshalItemExporter(fp) ie.start_exporting() @@ -287,11 +300,14 @@ class CsvItemExporterTest(BaseItemExporterTest): sorted(re.split(r"(,|\s+)", line)) for line in to_unicode(csv).splitlines(True) ] + return self.assertEqual(split_csv(first), split_csv(second), msg=msg) def _check_output(self): self.output.seek(0) - self.assertCsvEqual(to_unicode(self.output.read()), 'age,name\r\n22,John\xa3\r\n') + self.assertCsvEqual( + to_unicode(self.output.read()), "age,name\r\n22,John\xa3\r\n" + ) def assertExportResult(self, item, expected, **kwargs): fp = BytesIO() @@ -305,21 +321,21 @@ class CsvItemExporterTest(BaseItemExporterTest): self.assertExportResult( item=self.i, fields_to_export=ItemAdapter(self.i).field_names(), - expected=b'age,name\r\n22,John\xc2\xa3\r\n', + expected=b"age,name\r\n22,John\xc2\xa3\r\n", ) def test_header_export_all_dict(self): self.assertExportResult( item=ItemAdapter(self.i).asdict(), - expected=b'age,name\r\n22,John\xc2\xa3\r\n', + expected=b"age,name\r\n22,John\xc2\xa3\r\n", ) def test_header_export_single_field(self): for item in [self.i, ItemAdapter(self.i).asdict()]: self.assertExportResult( item=item, - fields_to_export=['age'], - expected=b'age\r\n22\r\n', + fields_to_export=["age"], + expected=b"age\r\n22\r\n", ) def test_header_export_two_items(self): @@ -330,15 +346,16 @@ class CsvItemExporterTest(BaseItemExporterTest): ie.export_item(item) ie.export_item(item) ie.finish_exporting() - self.assertCsvEqual(output.getvalue(), - b'age,name\r\n22,John\xc2\xa3\r\n22,John\xc2\xa3\r\n') + self.assertCsvEqual( + output.getvalue(), b"age,name\r\n22,John\xc2\xa3\r\n22,John\xc2\xa3\r\n" + ) def test_header_no_header_line(self): for item in [self.i, ItemAdapter(self.i).asdict()]: self.assertExportResult( item=item, include_headers_line=False, - expected=b'22,John\xc2\xa3\r\n', + expected=b"22,John\xc2\xa3\r\n", ) def test_join_multivalue(self): @@ -348,14 +365,14 @@ class CsvItemExporterTest(BaseItemExporterTest): for cls in TestItem2, dict: self.assertExportResult( - item=cls(name='John', friends=['Mary', 'Paul']), + item=cls(name="John", friends=["Mary", "Paul"]), include_headers_line=False, expected='"Mary,Paul",John\r\n', ) def test_join_multivalue_not_strings(self): self.assertExportResult( - item=dict(name='John', friends=[4, 8]), + item=dict(name="John", friends=[4, 8]), include_headers_line=False, expected='"[4, 8]",John\r\n', ) @@ -364,24 +381,24 @@ class CsvItemExporterTest(BaseItemExporterTest): self.assertExportResult( item=self._get_nonstring_types_item(), include_headers_line=False, - expected='22,False,3.14,2015-01-01 01:01:01\r\n' + expected="22,False,3.14,2015-01-01 01:01:01\r\n", ) def test_errors_default(self): with self.assertRaises(UnicodeEncodeError): self.assertExportResult( - item=dict(text='W\u0275\u200Brd'), + item=dict(text="W\u0275\u200Brd"), expected=None, - encoding='windows-1251', + encoding="windows-1251", ) def test_errors_xmlcharrefreplace(self): self.assertExportResult( - item=dict(text='W\u0275\u200Brd'), + item=dict(text="W\u0275\u200Brd"), include_headers_line=False, - expected='Wɵ​rd\r\n', - encoding='windows-1251', - errors='xmlcharrefreplace', + expected="Wɵ​rd\r\n", + encoding="windows-1251", + errors="xmlcharrefreplace", ) @@ -391,7 +408,6 @@ class CsvItemExporterDataclassTest(CsvItemExporterTest): class XmlItemExporterTest(BaseItemExporterTest): - def _get_exporter(self, **kwargs): return XmlItemExporter(self.output, **kwargs) @@ -405,6 +421,7 @@ class XmlItemExporterTest(BaseItemExporterTest): def xmlsplit(xmlcontent): doc = lxml.etree.fromstring(xmlcontent) return xmltuple(doc) + return self.assertEqual(xmlsplit(first), xmlsplit(second), msg) def assertExportResult(self, item, expected_value): @@ -418,13 +435,13 @@ class XmlItemExporterTest(BaseItemExporterTest): def _check_output(self): expected_value = ( b'\n' - b'22John\xc2\xa3' + b"22John\xc2\xa3" ) self.assertXmlEquivalent(self.output.getvalue(), expected_value) def test_multivalued_fields(self): self.assertExportResult( - self.item_class(name=['John\xa3', 'Doe'], age=[1, 2, 3]), + self.item_class(name=["John\xa3", "Doe"], age=[1, 2, 3]), b"""\n @@ -432,13 +449,13 @@ class XmlItemExporterTest(BaseItemExporterTest): 123 - """ + """, ) def test_nested_item(self): - i1 = dict(name='foo\xa3hoo', age='22') - i2 = dict(name='bar', age=i1) - i3 = self.item_class(name='buz', age=i2) + i1 = dict(name="foo\xa3hoo", age="22") + i2 = dict(name="bar", age=i1) + i3 = self.item_class(name="buz", age=i2) self.assertExportResult( i3, @@ -455,13 +472,13 @@ class XmlItemExporterTest(BaseItemExporterTest): buz - """ + """, ) def test_nested_list_item(self): - i1 = dict(name='foo') - i2 = dict(name='bar', v2={"egg": ["spam"]}) - i3 = self.item_class(name='buz', age=[i1, i2]) + i1 = dict(name="foo") + i2 = dict(name="bar", v2={"egg": ["spam"]}) + i3 = self.item_class(name="buz", age=[i1, i2]) self.assertExportResult( i3, @@ -475,7 +492,7 @@ class XmlItemExporterTest(BaseItemExporterTest): buz - """ + """, ) def test_nonstring_types_item(self): @@ -491,7 +508,7 @@ class XmlItemExporterTest(BaseItemExporterTest): - """ + """, ) @@ -503,7 +520,10 @@ class XmlItemExporterDataclassTest(XmlItemExporterTest): class JsonLinesItemExporterTest(BaseItemExporterTest): - _expected_nested = {'name': 'Jesus', 'age': {'name': 'Maria', 'age': {'name': 'Joseph', 'age': '22'}}} + _expected_nested = { + "name": "Jesus", + "age": {"name": "Maria", "age": {"name": "Joseph", "age": "22"}}, + } def _get_exporter(self, **kwargs): return JsonLinesItemExporter(self.output, **kwargs) @@ -513,9 +533,9 @@ class JsonLinesItemExporterTest(BaseItemExporterTest): self.assertEqual(exported, ItemAdapter(self.i).asdict()) def test_nested_item(self): - i1 = self.item_class(name='Joseph', age='22') - i2 = dict(name='Maria', age=i1) - i3 = self.item_class(name='Jesus', age=i2) + i1 = self.item_class(name="Joseph", age="22") + i2 = dict(name="Maria", age=i1) + i3 = self.item_class(name="Jesus", age=i2) self.ie.start_exporting() self.ie.export_item(i3) self.ie.finish_exporting() @@ -534,7 +554,7 @@ class JsonLinesItemExporterTest(BaseItemExporterTest): self.ie.export_item(item) self.ie.finish_exporting() exported = json.loads(to_unicode(self.output.getvalue())) - item['time'] = str(item['time']) + item["time"] = str(item["time"]) self.assertEqual(exported, item) @@ -561,7 +581,9 @@ class JsonItemExporterTest(JsonLinesItemExporterTest): self.ie.export_item(item) self.ie.finish_exporting() exported = json.loads(to_unicode(self.output.getvalue())) - self.assertEqual(exported, [ItemAdapter(item).asdict(), ItemAdapter(item).asdict()]) + self.assertEqual( + exported, [ItemAdapter(item).asdict(), ItemAdapter(item).asdict()] + ) def test_two_items(self): self.assertTwoItemsExported(self.i) @@ -570,25 +592,28 @@ class JsonItemExporterTest(JsonLinesItemExporterTest): self.assertTwoItemsExported(ItemAdapter(self.i).asdict()) def test_nested_item(self): - i1 = self.item_class(name='Joseph\xa3', age='22') - i2 = self.item_class(name='Maria', age=i1) - i3 = self.item_class(name='Jesus', age=i2) + i1 = self.item_class(name="Joseph\xa3", age="22") + i2 = self.item_class(name="Maria", age=i1) + i3 = self.item_class(name="Jesus", age=i2) self.ie.start_exporting() self.ie.export_item(i3) self.ie.finish_exporting() exported = json.loads(to_unicode(self.output.getvalue())) - expected = {'name': 'Jesus', 'age': {'name': 'Maria', 'age': ItemAdapter(i1).asdict()}} + expected = { + "name": "Jesus", + "age": {"name": "Maria", "age": ItemAdapter(i1).asdict()}, + } self.assertEqual(exported, [expected]) def test_nested_dict_item(self): - i1 = dict(name='Joseph\xa3', age='22') - i2 = self.item_class(name='Maria', age=i1) - i3 = dict(name='Jesus', age=i2) + i1 = dict(name="Joseph\xa3", age="22") + i2 = self.item_class(name="Maria", age=i1) + i3 = dict(name="Jesus", age=i2) self.ie.start_exporting() self.ie.export_item(i3) self.ie.finish_exporting() exported = json.loads(to_unicode(self.output.getvalue())) - expected = {'name': 'Jesus', 'age': {'name': 'Maria', 'age': i1}} + expected = {"name": "Jesus", "age": {"name": "Maria", "age": i1}} self.assertEqual(exported, [expected]) def test_nonstring_types_item(self): @@ -597,7 +622,7 @@ class JsonItemExporterTest(JsonLinesItemExporterTest): self.ie.export_item(item) self.ie.finish_exporting() exported = json.loads(to_unicode(self.output.getvalue())) - item['time'] = str(item['time']) + item["time"] = str(item["time"]) self.assertEqual(exported, [item]) @@ -618,20 +643,24 @@ class CustomExporterItemTest(unittest.TestCase): def test_exporter_custom_serializer(self): class CustomItemExporter(BaseItemExporter): def serialize_field(self, field, name, value): - if name == 'age': + if name == "age": return str(int(value) + 1) return super().serialize_field(field, name, value) - i = self.item_class(name='John', age='22') + i = self.item_class(name="John", age="22") a = ItemAdapter(i) ie = CustomItemExporter() - self.assertEqual(ie.serialize_field(a.get_field_meta('name'), 'name', a['name']), 'John') - self.assertEqual(ie.serialize_field(a.get_field_meta('age'), 'age', a['age']), '23') + self.assertEqual( + ie.serialize_field(a.get_field_meta("name"), "name", a["name"]), "John" + ) + self.assertEqual( + ie.serialize_field(a.get_field_meta("age"), "age", a["age"]), "23" + ) - i2 = {'name': 'John', 'age': '22'} - self.assertEqual(ie.serialize_field({}, 'name', i2['name']), 'John') - self.assertEqual(ie.serialize_field({}, 'age', i2['age']), '23') + i2 = {"name": "John", "age": "22"} + self.assertEqual(ie.serialize_field({}, "name", i2["name"]), "John") + self.assertEqual(ie.serialize_field({}, "age", i2["age"]), "23") class CustomExporterDataclassTest(CustomExporterItemTest): @@ -639,5 +668,5 @@ class CustomExporterDataclassTest(CustomExporterItemTest): item_class = TestDataClass -if __name__ == '__main__': +if __name__ == "__main__": unittest.main() diff --git a/tests/test_extension_telnet.py b/tests/test_extension_telnet.py index 1e716b94a..e36c45d8e 100644 --- a/tests/test_extension_telnet.py +++ b/tests/test_extension_telnet.py @@ -24,7 +24,7 @@ class TelnetExtensionTest(unittest.TestCase): @defer.inlineCallbacks def test_bad_credentials(self): console, portal = self._get_console_and_portal() - creds = credentials.UsernamePassword(b'username', b'password') + creds = credentials.UsernamePassword(b"username", b"password") d = portal.login(creds, None, ITelnetProtocol) yield self.assertFailure(d, ValueError) console.stop_listening() @@ -33,8 +33,7 @@ class TelnetExtensionTest(unittest.TestCase): def test_good_credentials(self): console, portal = self._get_console_and_portal() creds = credentials.UsernamePassword( - console.username.encode('utf8'), - console.password.encode('utf8') + console.username.encode("utf8"), console.password.encode("utf8") ) d = portal.login(creds, None, ITelnetProtocol) yield d @@ -43,11 +42,11 @@ class TelnetExtensionTest(unittest.TestCase): @defer.inlineCallbacks def test_custom_credentials(self): settings = { - 'TELNETCONSOLE_USERNAME': 'user', - 'TELNETCONSOLE_PASSWORD': 'pass', + "TELNETCONSOLE_USERNAME": "user", + "TELNETCONSOLE_PASSWORD": "pass", } console, portal = self._get_console_and_portal(settings=settings) - creds = credentials.UsernamePassword(b'user', b'pass') + creds = credentials.UsernamePassword(b"user", b"pass") d = portal.login(creds, None, ITelnetProtocol) yield d console.stop_listening() diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 97c3a74b3..890c88c7e 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -57,29 +57,28 @@ from tests.spiders import ItemSpider def path_to_url(path): - return urljoin('file:', pathname2url(str(path))) + return urljoin("file:", pathname2url(str(path))) def printf_escape(string): - return string.replace('%', '%%') + return string.replace("%", "%%") def build_url(path: Union[str, PathLike]) -> str: path_str = str(path) - if path_str[0] != '/': - path_str = '/' + path_str - return urljoin('file:', path_str) + if path_str[0] != "/": + path_str = "/" + path_str + return urljoin("file:", path_str) class FileFeedStorageTest(unittest.TestCase): - def test_store_file_uri(self): path = Path(self.mktemp()).resolve() uri = path_to_file_uri(str(path)) return self._assert_stores(FileFeedStorage(uri), path) def test_store_file_uri_makedirs(self): - path = Path(self.mktemp()).resolve() / 'more' / 'paths' / 'file.txt' + path = Path(self.mktemp()).resolve() / "more" / "paths" / "file.txt" uri = path_to_file_uri(str(path)) return self._assert_stores(FileFeedStorage(uri), path) @@ -112,8 +111,7 @@ class FileFeedStorageTest(unittest.TestCase): def test_overwrite(self): path = self._store({"overwrite": True}) return self._assert_stores( - FileFeedStorage(str(path), feed_options={"overwrite": True}), - path + FileFeedStorage(str(path), feed_options={"overwrite": True}), path ) @defer.inlineCallbacks @@ -130,10 +128,9 @@ class FileFeedStorageTest(unittest.TestCase): class FTPFeedStorageTest(unittest.TestCase): - def get_test_spider(self, settings=None): class TestSpider(scrapy.Spider): - name = 'test_spider' + name = "test_spider" crawler = get_crawler(settings_dict=settings) spider = TestSpider.from_crawler(crawler) @@ -162,9 +159,9 @@ class FTPFeedStorageTest(unittest.TestCase): @defer.inlineCallbacks def test_append(self): with MockFTPServer() as ftp_server: - filename = 'file' + filename = "file" url = ftp_server.url(filename) - feed_options = {'overwrite': False} + feed_options = {"overwrite": False} yield self._store(url, b"foo", feed_options=feed_options) yield self._store(url, b"bar", feed_options=feed_options) self._assert_stored(ftp_server.path / filename, b"foobar") @@ -172,7 +169,7 @@ class FTPFeedStorageTest(unittest.TestCase): @defer.inlineCallbacks def test_overwrite(self): with MockFTPServer() as ftp_server: - filename = 'file' + filename = "file" url = ftp_server.url(filename) yield self._store(url, b"foo") yield self._store(url, b"bar") @@ -181,10 +178,10 @@ class FTPFeedStorageTest(unittest.TestCase): @defer.inlineCallbacks def test_append_active_mode(self): with MockFTPServer() as ftp_server: - settings = {'FEED_STORAGE_FTP_ACTIVE': True} - filename = 'file' + settings = {"FEED_STORAGE_FTP_ACTIVE": True} + filename = "file" url = ftp_server.url(filename) - feed_options = {'overwrite': False} + feed_options = {"overwrite": False} yield self._store(url, b"foo", feed_options=feed_options, settings=settings) yield self._store(url, b"bar", feed_options=feed_options, settings=settings) self._assert_stored(ftp_server.path / filename, b"foobar") @@ -192,8 +189,8 @@ class FTPFeedStorageTest(unittest.TestCase): @defer.inlineCallbacks def test_overwrite_active_mode(self): with MockFTPServer() as ftp_server: - settings = {'FEED_STORAGE_FTP_ACTIVE': True} - filename = 'file' + settings = {"FEED_STORAGE_FTP_ACTIVE": True} + filename = "file" url = ftp_server.url(filename) yield self._store(url, b"foo", settings=settings) yield self._store(url, b"bar", settings=settings) @@ -201,16 +198,15 @@ class FTPFeedStorageTest(unittest.TestCase): def test_uri_auth_quote(self): # RFC3986: 3.2.1. User Information - pw_quoted = quote(string.punctuation, safe='') - st = FTPFeedStorage(f'ftp://foo:{pw_quoted}@example.com/some_path', {}) + pw_quoted = quote(string.punctuation, safe="") + st = FTPFeedStorage(f"ftp://foo:{pw_quoted}@example.com/some_path", {}) self.assertEqual(st.password, string.punctuation) class BlockingFeedStorageTest(unittest.TestCase): - def get_test_spider(self, settings=None): class TestSpider(scrapy.Spider): - name = 'test_spider' + name = "test_spider" crawler = get_crawler(settings_dict=settings) spider = TestSpider.from_crawler(crawler) @@ -227,7 +223,7 @@ class BlockingFeedStorageTest(unittest.TestCase): b = BlockingFeedStorage() tests_path = Path(__file__).resolve().parent - spider = self.get_test_spider({'FEED_TEMPDIR': str(tests_path)}) + spider = self.get_test_spider({"FEED_TEMPDIR": str(tests_path)}) tmp = b.open(spider) tmp_path = Path(tmp.name).parent self.assertEqual(tmp_path, tests_path) @@ -236,66 +232,72 @@ class BlockingFeedStorageTest(unittest.TestCase): b = BlockingFeedStorage() tests_path = Path(__file__).resolve().parent - invalid_path = tests_path / 'invalid_path' - spider = self.get_test_spider({'FEED_TEMPDIR': str(invalid_path)}) + invalid_path = tests_path / "invalid_path" + spider = self.get_test_spider({"FEED_TEMPDIR": str(invalid_path)}) self.assertRaises(OSError, b.open, spider=spider) class S3FeedStorageTest(unittest.TestCase): - def test_parse_credentials(self): skip_if_no_boto() - aws_credentials = {'AWS_ACCESS_KEY_ID': 'settings_key', - 'AWS_SECRET_ACCESS_KEY': 'settings_secret', - 'AWS_SESSION_TOKEN': 'settings_token'} + aws_credentials = { + "AWS_ACCESS_KEY_ID": "settings_key", + "AWS_SECRET_ACCESS_KEY": "settings_secret", + "AWS_SESSION_TOKEN": "settings_token", + } crawler = get_crawler(settings_dict=aws_credentials) # Instantiate with crawler storage = S3FeedStorage.from_crawler( crawler, - 's3://mybucket/export.csv', + "s3://mybucket/export.csv", ) - self.assertEqual(storage.access_key, 'settings_key') - self.assertEqual(storage.secret_key, 'settings_secret') - self.assertEqual(storage.session_token, 'settings_token') + self.assertEqual(storage.access_key, "settings_key") + self.assertEqual(storage.secret_key, "settings_secret") + self.assertEqual(storage.session_token, "settings_token") # Instantiate directly - storage = S3FeedStorage('s3://mybucket/export.csv', - aws_credentials['AWS_ACCESS_KEY_ID'], - aws_credentials['AWS_SECRET_ACCESS_KEY'], - session_token=aws_credentials['AWS_SESSION_TOKEN']) - self.assertEqual(storage.access_key, 'settings_key') - self.assertEqual(storage.secret_key, 'settings_secret') - self.assertEqual(storage.session_token, 'settings_token') + storage = S3FeedStorage( + "s3://mybucket/export.csv", + aws_credentials["AWS_ACCESS_KEY_ID"], + aws_credentials["AWS_SECRET_ACCESS_KEY"], + session_token=aws_credentials["AWS_SESSION_TOKEN"], + ) + self.assertEqual(storage.access_key, "settings_key") + self.assertEqual(storage.secret_key, "settings_secret") + self.assertEqual(storage.session_token, "settings_token") # URI priority > settings priority - storage = S3FeedStorage('s3://uri_key:uri_secret@mybucket/export.csv', - aws_credentials['AWS_ACCESS_KEY_ID'], - aws_credentials['AWS_SECRET_ACCESS_KEY']) - self.assertEqual(storage.access_key, 'uri_key') - self.assertEqual(storage.secret_key, 'uri_secret') + storage = S3FeedStorage( + "s3://uri_key:uri_secret@mybucket/export.csv", + aws_credentials["AWS_ACCESS_KEY_ID"], + aws_credentials["AWS_SECRET_ACCESS_KEY"], + ) + self.assertEqual(storage.access_key, "uri_key") + self.assertEqual(storage.secret_key, "uri_secret") @defer.inlineCallbacks def test_store(self): skip_if_no_boto() settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", } crawler = get_crawler(settings_dict=settings) - bucket = 'mybucket' - key = 'export.csv' - storage = S3FeedStorage.from_crawler(crawler, f's3://{bucket}/{key}') + bucket = "mybucket" + key = "export.csv" + storage = S3FeedStorage.from_crawler(crawler, f"s3://{bucket}/{key}") verifyObject(IFeedStorage, storage) file = mock.MagicMock() from botocore.stub import Stubber + with Stubber(storage.s3_client) as stub: stub.add_response( - 'put_object', + "put_object", expected_params={ - 'Body': file, - 'Bucket': bucket, - 'Key': key, + "Body": file, + "Bucket": bucket, + "Key": key, }, service_response={}, ) @@ -309,172 +311,154 @@ class S3FeedStorageTest(unittest.TestCase): mock.call.seek(0), # The call to read does not happen with Stubber mock.call.close(), - ] + ], ) def test_init_without_acl(self): - storage = S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key' - ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') + storage = S3FeedStorage("s3://mybucket/export.csv", "access_key", "secret_key") + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") self.assertEqual(storage.acl, None) def test_init_with_acl(self): storage = S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', - 'custom-acl' + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') - self.assertEqual(storage.acl, 'custom-acl') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") + self.assertEqual(storage.acl, "custom-acl") def test_init_with_endpoint_url(self): storage = S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', - endpoint_url='https://example.com' + "s3://mybucket/export.csv", + "access_key", + "secret_key", + endpoint_url="https://example.com", ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') - self.assertEqual(storage.endpoint_url, 'https://example.com') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") + self.assertEqual(storage.endpoint_url, "https://example.com") def test_from_crawler_without_acl(self): settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", } crawler = get_crawler(settings_dict=settings) storage = S3FeedStorage.from_crawler( crawler, - 's3://mybucket/export.csv', + "s3://mybucket/export.csv", ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") self.assertEqual(storage.acl, None) def test_without_endpoint_url(self): settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", } crawler = get_crawler(settings_dict=settings) storage = S3FeedStorage.from_crawler( crawler, - 's3://mybucket/export.csv', + "s3://mybucket/export.csv", ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") self.assertEqual(storage.endpoint_url, None) def test_from_crawler_with_acl(self): settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', - 'FEED_STORAGE_S3_ACL': 'custom-acl', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "FEED_STORAGE_S3_ACL": "custom-acl", } crawler = get_crawler(settings_dict=settings) storage = S3FeedStorage.from_crawler( crawler, - 's3://mybucket/export.csv', + "s3://mybucket/export.csv", ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') - self.assertEqual(storage.acl, 'custom-acl') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") + self.assertEqual(storage.acl, "custom-acl") def test_from_crawler_with_endpoint_url(self): settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', - 'AWS_ENDPOINT_URL': 'https://example.com', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "AWS_ENDPOINT_URL": "https://example.com", } crawler = get_crawler(settings_dict=settings) - storage = S3FeedStorage.from_crawler( - crawler, - 's3://mybucket/export.csv' - ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') - self.assertEqual(storage.endpoint_url, 'https://example.com') + storage = S3FeedStorage.from_crawler(crawler, "s3://mybucket/export.csv") + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") + self.assertEqual(storage.endpoint_url, "https://example.com") @defer.inlineCallbacks def test_store_botocore_without_acl(self): skip_if_no_boto() storage = S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', + "s3://mybucket/export.csv", + "access_key", + "secret_key", ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") self.assertEqual(storage.acl, None) storage.s3_client = mock.MagicMock() - yield storage.store(BytesIO(b'test file')) - self.assertNotIn('ACL', storage.s3_client.put_object.call_args[1]) + yield storage.store(BytesIO(b"test file")) + self.assertNotIn("ACL", storage.s3_client.put_object.call_args[1]) @defer.inlineCallbacks def test_store_botocore_with_acl(self): skip_if_no_boto() storage = S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', - 'custom-acl' + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" ) - self.assertEqual(storage.access_key, 'access_key') - self.assertEqual(storage.secret_key, 'secret_key') - self.assertEqual(storage.acl, 'custom-acl') + self.assertEqual(storage.access_key, "access_key") + self.assertEqual(storage.secret_key, "secret_key") + self.assertEqual(storage.acl, "custom-acl") storage.s3_client = mock.MagicMock() - yield storage.store(BytesIO(b'test file')) + yield storage.store(BytesIO(b"test file")) self.assertEqual( - storage.s3_client.put_object.call_args[1].get('ACL'), - 'custom-acl' + storage.s3_client.put_object.call_args[1].get("ACL"), "custom-acl" ) def test_overwrite_default(self): with LogCapture() as log: S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', - 'custom-acl' + "s3://mybucket/export.csv", "access_key", "secret_key", "custom-acl" ) - self.assertNotIn('S3 does not support appending to files', str(log)) + self.assertNotIn("S3 does not support appending to files", str(log)) def test_overwrite_false(self): with LogCapture() as log: S3FeedStorage( - 's3://mybucket/export.csv', - 'access_key', - 'secret_key', - 'custom-acl', - feed_options={'overwrite': False}, + "s3://mybucket/export.csv", + "access_key", + "secret_key", + "custom-acl", + feed_options={"overwrite": False}, ) - self.assertIn('S3 does not support appending to files', str(log)) + self.assertIn("S3 does not support appending to files", str(log)) class GCSFeedStorageTest(unittest.TestCase): - def test_parse_settings(self): try: from google.cloud.storage import Client # noqa except ImportError: raise unittest.SkipTest("GCSFeedStorage requires google-cloud-storage") - settings = {'GCS_PROJECT_ID': '123', 'FEED_STORAGE_GCS_ACL': 'publicRead'} + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": "publicRead"} crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, 'gs://mybucket/export.csv') - assert storage.project_id == '123' - assert storage.acl == 'publicRead' - assert storage.bucket_name == 'mybucket' - assert storage.blob_name == 'export.csv' + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") + assert storage.project_id == "123" + assert storage.acl == "publicRead" + assert storage.bucket_name == "mybucket" + assert storage.blob_name == "export.csv" def test_parse_empty_acl(self): try: @@ -482,14 +466,14 @@ class GCSFeedStorageTest(unittest.TestCase): except ImportError: raise unittest.SkipTest("GCSFeedStorage requires google-cloud-storage") - settings = {'GCS_PROJECT_ID': '123', 'FEED_STORAGE_GCS_ACL': ''} + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": ""} crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, 'gs://mybucket/export.csv') + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") assert storage.acl is None - settings = {'GCS_PROJECT_ID': '123', 'FEED_STORAGE_GCS_ACL': None} + settings = {"GCS_PROJECT_ID": "123", "FEED_STORAGE_GCS_ACL": None} crawler = get_crawler(settings_dict=settings) - storage = GCSFeedStorage.from_crawler(crawler, 'gs://mybucket/export.csv') + storage = GCSFeedStorage.from_crawler(crawler, "gs://mybucket/export.csv") assert storage.acl is None @defer.inlineCallbacks @@ -499,11 +483,11 @@ class GCSFeedStorageTest(unittest.TestCase): except ImportError: raise unittest.SkipTest("GCSFeedStorage requires google-cloud-storage") - uri = 'gs://mybucket/export.csv' - project_id = 'myproject-123' - acl = 'publicRead' + uri = "gs://mybucket/export.csv" + project_id = "myproject-123" + acl = "publicRead" (client_mock, bucket_mock, blob_mock) = mock_google_cloud_storage() - with mock.patch('google.cloud.storage.Client') as m: + with mock.patch("google.cloud.storage.Client") as m: m.return_value = client_mock f = mock.Mock() @@ -512,17 +496,16 @@ class GCSFeedStorageTest(unittest.TestCase): f.seek.assert_called_once_with(0) m.assert_called_once_with(project=project_id) - client_mock.get_bucket.assert_called_once_with('mybucket') - bucket_mock.blob.assert_called_once_with('export.csv') + client_mock.get_bucket.assert_called_once_with("mybucket") + bucket_mock.blob.assert_called_once_with("export.csv") blob_mock.upload_from_file.assert_called_once_with(f, predefined_acl=acl) class StdoutFeedStorageTest(unittest.TestCase): - @defer.inlineCallbacks def test_store(self): out = BytesIO() - storage = StdoutFeedStorage('stdout:', _stdout=out) + storage = StdoutFeedStorage("stdout:", _stdout=out) file = storage.open(scrapy.Spider("default")) file.write(b"content") yield storage.store(file) @@ -530,13 +513,17 @@ class StdoutFeedStorageTest(unittest.TestCase): def test_overwrite_default(self): with LogCapture() as log: - StdoutFeedStorage('stdout:') - self.assertNotIn('Standard output (stdout) storage does not support overwriting', str(log)) + StdoutFeedStorage("stdout:") + self.assertNotIn( + "Standard output (stdout) storage does not support overwriting", str(log) + ) def test_overwrite_true(self): with LogCapture() as log: - StdoutFeedStorage('stdout:', feed_options={'overwrite': True}) - self.assertIn('Standard output (stdout) storage does not support overwriting', str(log)) + StdoutFeedStorage("stdout:", feed_options={"overwrite": True}) + self.assertIn( + "Standard output (stdout) storage does not support overwriting", str(log) + ) class FromCrawlerMixin: @@ -553,7 +540,6 @@ class FromCrawlerCsvItemExporter(CsvItemExporter, FromCrawlerMixin): class FromCrawlerFileFeedStorage(FileFeedStorage, FromCrawlerMixin): - @classmethod def from_crawler(cls, crawler, *args, feed_options=None, **kwargs): cls.init_with_crawler = True @@ -561,7 +547,6 @@ class FromCrawlerFileFeedStorage(FileFeedStorage, FromCrawlerMixin): class DummyBlockingFeedStorage(BlockingFeedStorage): - def __init__(self, uri, *args, feed_options=None): self.path = Path(file_uri_to_path(uri)) @@ -569,16 +554,15 @@ class DummyBlockingFeedStorage(BlockingFeedStorage): dirname = self.path.parent if dirname and not dirname.exists(): dirname.mkdir(parents=True) - with self.path.open('ab') as output_file: + with self.path.open("ab") as output_file: output_file.write(file.read()) file.close() class FailingBlockingFeedStorage(DummyBlockingFeedStorage): - def _store_in_thread(self, file): - raise OSError('Cannot store') + raise OSError("Cannot store") @implementer(IFeedStorage) @@ -593,10 +577,10 @@ class LogOnStoreFileStorage: self.logger = getLogger() def open(self, spider): - return tempfile.NamedTemporaryFile(prefix='feed-') + return tempfile.NamedTemporaryFile(prefix="feed-") def store(self, file): - self.logger.info('Storage.store is called') + self.logger.info("Storage.store is called") file.close() @@ -612,9 +596,9 @@ class FeedExportTestBase(ABC, unittest.TestCase): foo = scrapy.Field() hello = scrapy.Field() - def _random_temp_filename(self, inter_dir='') -> Path: + def _random_temp_filename(self, inter_dir="") -> Path: chars = [random.choice(ascii_letters + digits) for _ in range(15)] - filename = ''.join(chars) + filename = "".join(chars) return Path(self.temp_dir, inter_dir, filename) def setUp(self): @@ -630,7 +614,7 @@ class FeedExportTestBase(ABC, unittest.TestCase): """ class TestSpider(scrapy.Spider): - name = 'testspider' + name = "testspider" def parse(self, response): for item in items: @@ -646,7 +630,7 @@ class FeedExportTestBase(ABC, unittest.TestCase): """ class TestSpider(scrapy.Spider): - name = 'testspider' + name = "testspider" def parse(self, response): pass @@ -685,10 +669,10 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def run_and_export(self, spider_cls, settings): - """ Run spider with specified settings; return exported data. """ + """Run spider with specified settings; return exported data.""" - FEEDS = settings.get('FEEDS') or {} - settings['FEEDS'] = { + FEEDS = settings.get("FEEDS") or {} + settings["FEEDS"] = { printf_escape(path_to_url(file_path)): feed_options for file_path, feed_options in FEEDS.items() } @@ -696,7 +680,7 @@ class FeedExportTest(FeedExportTestBase): content = {} try: with MockServer() as s: - spider_cls.start_urls = [s.url('/')] + spider_cls.start_urls = [s.url("/")] crawler = get_crawler(spider_cls, settings) yield crawler.crawl() @@ -704,7 +688,7 @@ class FeedExportTest(FeedExportTestBase): if not Path(file_path).exists(): continue - content[feed_options['format']] = Path(file_path).read_bytes() + content[feed_options["format"]] = Path(file_path).read_bytes() finally: for file_path in FEEDS.keys(): @@ -718,88 +702,102 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'csv'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "csv"}, + }, + } + ) data = yield self.exported_data(items, settings) - reader = csv.DictReader(to_unicode(data['csv']).splitlines()) + reader = csv.DictReader(to_unicode(data["csv"]).splitlines()) self.assertEqual(reader.fieldnames, list(header)) self.assertEqual(rows, list(reader)) @defer.inlineCallbacks def assertExportedJsonLines(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'jl'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "jl"}, + }, + } + ) data = yield self.exported_data(items, settings) - parsed = [json.loads(to_unicode(line)) for line in data['jl'].splitlines()] + parsed = [json.loads(to_unicode(line)) for line in data["jl"].splitlines()] rows = [{k: v for k, v in row.items() if v} for row in rows] self.assertEqual(rows, parsed) @defer.inlineCallbacks def assertExportedXml(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'xml'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "xml"}, + }, + } + ) data = yield self.exported_data(items, settings) rows = [{k: v for k, v in row.items() if v} for row in rows] - root = lxml.etree.fromstring(data['xml']) - got_rows = [{e.tag: e.text for e in it} for it in root.findall('item')] + root = lxml.etree.fromstring(data["xml"]) + got_rows = [{e.tag: e.text for e in it} for it in root.findall("item")] self.assertEqual(rows, got_rows) @defer.inlineCallbacks def assertExportedMultiple(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'xml'}, - self._random_temp_filename(): {'format': 'json'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "xml"}, + self._random_temp_filename(): {"format": "json"}, + }, + } + ) data = yield self.exported_data(items, settings) rows = [{k: v for k, v in row.items() if v} for row in rows] # XML - root = lxml.etree.fromstring(data['xml']) - xml_rows = [{e.tag: e.text for e in it} for it in root.findall('item')] + root = lxml.etree.fromstring(data["xml"]) + xml_rows = [{e.tag: e.text for e in it} for it in root.findall("item")] self.assertEqual(rows, xml_rows) # JSON - json_rows = json.loads(to_unicode(data['json'])) + json_rows = json.loads(to_unicode(data["json"])) self.assertEqual(rows, json_rows) @defer.inlineCallbacks def assertExportedPickle(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'pickle'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "pickle"}, + }, + } + ) data = yield self.exported_data(items, settings) expected = [{k: v for k, v in row.items() if v} for row in rows] import pickle - result = self._load_until_eof(data['pickle'], load_func=pickle.load) + + result = self._load_until_eof(data["pickle"], load_func=pickle.load) self.assertEqual(expected, result) @defer.inlineCallbacks def assertExportedMarshal(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename(): {'format': 'marshal'}, - }, - }) + settings.update( + { + "FEEDS": { + self._random_temp_filename(): {"format": "marshal"}, + }, + } + ) data = yield self.exported_data(items, settings) expected = [{k: v for k, v in row.items() if v} for row in rows] import marshal - result = self._load_until_eof(data['marshal'], load_func=marshal.load) + + result = self._load_until_eof(data["marshal"], load_func=marshal.load) self.assertEqual(expected, result) @defer.inlineCallbacks @@ -814,8 +812,12 @@ class FeedExportTest(FeedExportTestBase): crawler = get_crawler(ItemSpider, settings) with MockServer() as mockserver: yield crawler.crawl(mockserver=mockserver) - self.assertIn("feedexport/success_count/FileFeedStorage", crawler.stats.get_stats()) - self.assertEqual(crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 1) + self.assertIn( + "feedexport/success_count/FileFeedStorage", crawler.stats.get_stats() + ) + self.assertEqual( + crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 1 + ) @defer.inlineCallbacks def test_stats_file_failed(self): @@ -832,17 +834,22 @@ class FeedExportTest(FeedExportTestBase): stack.enter_context( mock.patch( "scrapy.extensions.feedexport.FileFeedStorage.store", - side_effect=KeyError("foo")) + side_effect=KeyError("foo"), + ) ) yield crawler.crawl(mockserver=mockserver) - self.assertIn("feedexport/failed_count/FileFeedStorage", crawler.stats.get_stats()) - self.assertEqual(crawler.stats.get_value("feedexport/failed_count/FileFeedStorage"), 1) + self.assertIn( + "feedexport/failed_count/FileFeedStorage", crawler.stats.get_stats() + ) + self.assertEqual( + crawler.stats.get_value("feedexport/failed_count/FileFeedStorage"), 1 + ) @defer.inlineCallbacks def test_stats_multiple_file(self): settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", "FEEDS": { printf_escape(path_to_url(str(self._random_temp_filename()))): { "format": "json", @@ -852,101 +859,113 @@ class FeedExportTest(FeedExportTestBase): }, "stdout:": { "format": "xml", - } + }, }, } crawler = get_crawler(ItemSpider, settings) with MockServer() as mockserver, mock.patch.object(S3FeedStorage, "store"): yield crawler.crawl(mockserver=mockserver) - self.assertIn("feedexport/success_count/FileFeedStorage", crawler.stats.get_stats()) - self.assertIn("feedexport/success_count/S3FeedStorage", crawler.stats.get_stats()) - self.assertIn("feedexport/success_count/StdoutFeedStorage", crawler.stats.get_stats()) - self.assertEqual(crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 1) - self.assertEqual(crawler.stats.get_value("feedexport/success_count/S3FeedStorage"), 1) - self.assertEqual(crawler.stats.get_value("feedexport/success_count/StdoutFeedStorage"), 1) + self.assertIn( + "feedexport/success_count/FileFeedStorage", crawler.stats.get_stats() + ) + self.assertIn( + "feedexport/success_count/S3FeedStorage", crawler.stats.get_stats() + ) + self.assertIn( + "feedexport/success_count/StdoutFeedStorage", crawler.stats.get_stats() + ) + self.assertEqual( + crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 1 + ) + self.assertEqual( + crawler.stats.get_value("feedexport/success_count/S3FeedStorage"), 1 + ) + self.assertEqual( + crawler.stats.get_value("feedexport/success_count/StdoutFeedStorage"), 1 + ) @defer.inlineCallbacks def test_export_items(self): # feed exporters use field names from Item items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem({'foo': 'bar2', 'egg': 'spam2', 'baz': 'quux2'}), + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), ] rows = [ - {'egg': 'spam1', 'foo': 'bar1', 'baz': ''}, - {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} + {"egg": "spam1", "foo": "bar1", "baz": ""}, + {"egg": "spam2", "foo": "bar2", "baz": "quux2"}, ] header = self.MyItem.fields.keys() yield self.assertExported(items, header, rows) @defer.inlineCallbacks def test_export_no_items_not_store_empty(self): - for fmt in ('json', 'jsonlines', 'xml', 'csv'): + for fmt in ("json", "jsonlines", "xml", "csv"): settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': fmt}, + "FEEDS": { + self._random_temp_filename(): {"format": fmt}, }, } data = yield self.exported_no_data(settings) - self.assertEqual(b'', data[fmt]) + self.assertEqual(b"", data[fmt]) @defer.inlineCallbacks def test_export_no_items_store_empty(self): formats = ( - ('json', b'[]'), - ('jsonlines', b''), - ('xml', b'\n'), - ('csv', b''), + ("json", b"[]"), + ("jsonlines", b""), + ("xml", b'\n'), + ("csv", b""), ) for fmt, expctd in formats: settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': fmt}, + "FEEDS": { + self._random_temp_filename(): {"format": fmt}, }, - 'FEED_STORE_EMPTY': True, - 'FEED_EXPORT_INDENT': None, + "FEED_STORE_EMPTY": True, + "FEED_EXPORT_INDENT": None, } data = yield self.exported_no_data(settings) self.assertEqual(expctd, data[fmt]) @defer.inlineCallbacks def test_export_no_items_multiple_feeds(self): - """ Make sure that `storage.store` is called for every feed. """ + """Make sure that `storage.store` is called for every feed.""" settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': 'json'}, - self._random_temp_filename(): {'format': 'xml'}, - self._random_temp_filename(): {'format': 'csv'}, + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + self._random_temp_filename(): {"format": "xml"}, + self._random_temp_filename(): {"format": "csv"}, }, - 'FEED_STORAGES': {'file': LogOnStoreFileStorage}, - 'FEED_STORE_EMPTY': False + "FEED_STORAGES": {"file": LogOnStoreFileStorage}, + "FEED_STORE_EMPTY": False, } with LogCapture() as log: yield self.exported_no_data(settings) print(log) - self.assertEqual(str(log).count('Storage.store is called'), 3) + self.assertEqual(str(log).count("Storage.store is called"), 3) @defer.inlineCallbacks def test_export_multiple_item_classes(self): items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem2({'hello': 'world2', 'foo': 'bar2'}), - self.MyItem({'foo': 'bar3', 'egg': 'spam3', 'baz': 'quux3'}), - {'hello': 'world4', 'egg': 'spam4'}, + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem2({"hello": "world2", "foo": "bar2"}), + self.MyItem({"foo": "bar3", "egg": "spam3", "baz": "quux3"}), + {"hello": "world4", "egg": "spam4"}, ] # by default, Scrapy uses fields of the first Item for CSV and # all fields for JSON Lines header = self.MyItem.fields.keys() rows_csv = [ - {'egg': 'spam1', 'foo': 'bar1', 'baz': ''}, - {'egg': '', 'foo': 'bar2', 'baz': ''}, - {'egg': 'spam3', 'foo': 'bar3', 'baz': 'quux3'}, - {'egg': 'spam4', 'foo': '', 'baz': ''}, + {"egg": "spam1", "foo": "bar1", "baz": ""}, + {"egg": "", "foo": "bar2", "baz": ""}, + {"egg": "spam3", "foo": "bar3", "baz": "quux3"}, + {"egg": "spam4", "foo": "", "baz": ""}, ] rows_jl = [dict(row) for row in items] yield self.assertExportedCsv(items, header, rows_csv) @@ -955,106 +974,103 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_items_empty_field_list(self): # FEED_EXPORT_FIELDS==[] means the same as default None - items = [{'foo': 'bar'}] + items = [{"foo": "bar"}] header = ["foo"] - rows = [{'foo': 'bar'}] - settings = {'FEED_EXPORT_FIELDS': []} + rows = [{"foo": "bar"}] + settings = {"FEED_EXPORT_FIELDS": []} yield self.assertExportedCsv(items, header, rows) yield self.assertExportedJsonLines(items, rows, settings) @defer.inlineCallbacks def test_export_items_field_list(self): - items = [{'foo': 'bar'}] + items = [{"foo": "bar"}] header = ["foo", "baz"] - rows = [{'foo': 'bar', 'baz': ''}] - settings = {'FEED_EXPORT_FIELDS': header} + rows = [{"foo": "bar", "baz": ""}] + settings = {"FEED_EXPORT_FIELDS": header} yield self.assertExported(items, header, rows, settings=settings) @defer.inlineCallbacks def test_export_items_comma_separated_field_list(self): - items = [{'foo': 'bar'}] + items = [{"foo": "bar"}] header = ["foo", "baz"] - rows = [{'foo': 'bar', 'baz': ''}] - settings = {'FEED_EXPORT_FIELDS': ",".join(header)} + rows = [{"foo": "bar", "baz": ""}] + settings = {"FEED_EXPORT_FIELDS": ",".join(header)} yield self.assertExported(items, header, rows, settings=settings) @defer.inlineCallbacks def test_export_items_json_field_list(self): - items = [{'foo': 'bar'}] + items = [{"foo": "bar"}] header = ["foo", "baz"] - rows = [{'foo': 'bar', 'baz': ''}] - settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} + rows = [{"foo": "bar", "baz": ""}] + settings = {"FEED_EXPORT_FIELDS": json.dumps(header)} yield self.assertExported(items, header, rows, settings=settings) @defer.inlineCallbacks def test_export_items_field_names(self): - items = [{'foo': 'bar'}] - header = {'foo': 'Foo'} - rows = [{'Foo': 'bar'}] - settings = {'FEED_EXPORT_FIELDS': header} - yield self.assertExported(items, list(header.values()), rows, - settings=settings) + items = [{"foo": "bar"}] + header = {"foo": "Foo"} + rows = [{"Foo": "bar"}] + settings = {"FEED_EXPORT_FIELDS": header} + yield self.assertExported(items, list(header.values()), rows, settings=settings) @defer.inlineCallbacks def test_export_items_dict_field_names(self): - items = [{'foo': 'bar'}] + items = [{"foo": "bar"}] header = { - 'baz': 'Baz', - 'foo': 'Foo', + "baz": "Baz", + "foo": "Foo", } - rows = [{'Baz': '', 'Foo': 'bar'}] - settings = {'FEED_EXPORT_FIELDS': header} - yield self.assertExported(items, ['Baz', 'Foo'], rows, - settings=settings) + rows = [{"Baz": "", "Foo": "bar"}] + settings = {"FEED_EXPORT_FIELDS": header} + yield self.assertExported(items, ["Baz", "Foo"], rows, settings=settings) @defer.inlineCallbacks def test_export_items_json_field_names(self): - items = [{'foo': 'bar'}] - header = {'foo': 'Foo'} - rows = [{'Foo': 'bar'}] - settings = {'FEED_EXPORT_FIELDS': json.dumps(header)} - yield self.assertExported(items, list(header.values()), rows, - settings=settings) + items = [{"foo": "bar"}] + header = {"foo": "Foo"} + rows = [{"Foo": "bar"}] + settings = {"FEED_EXPORT_FIELDS": json.dumps(header)} + yield self.assertExported(items, list(header.values()), rows, settings=settings) @defer.inlineCallbacks def test_export_based_on_item_classes(self): items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem2({'hello': 'world2', 'foo': 'bar2'}), - {'hello': 'world3', 'egg': 'spam3'}, + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem2({"hello": "world2", "foo": "bar2"}), + {"hello": "world3", "egg": "spam3"}, ] formats = { - 'csv': b'baz,egg,foo\r\n,spam1,bar1\r\n', - 'json': b'[\n{"hello": "world2", "foo": "bar2"}\n]', - 'jsonlines': ( + "csv": b"baz,egg,foo\r\n,spam1,bar1\r\n", + "json": b'[\n{"hello": "world2", "foo": "bar2"}\n]', + "jsonlines": ( b'{"foo": "bar1", "egg": "spam1"}\n' b'{"hello": "world2", "foo": "bar2"}\n' ), - 'xml': ( + "xml": ( b'\n\n' - b'bar1spam1\n' - b'world2bar2\nworld3' - b'spam3\n' + b"bar1spam1\n" + b"world2bar2\nworld3" + b"spam3\n" ), } settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): { - 'format': 'csv', - 'item_classes': [self.MyItem], + "format": "csv", + "item_classes": [self.MyItem], }, self._random_temp_filename(): { - 'format': 'json', - 'item_classes': [self.MyItem2], + "format": "json", + "item_classes": [self.MyItem2], }, self._random_temp_filename(): { - 'format': 'jsonlines', - 'item_classes': [self.MyItem, self.MyItem2], + "format": "jsonlines", + "item_classes": [self.MyItem, self.MyItem2], }, self._random_temp_filename(): { - 'format': 'xml', + "format": "xml", }, }, } @@ -1066,9 +1082,9 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_based_on_custom_filters(self): items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem2({'hello': 'world2', 'foo': 'bar2'}), - {'hello': 'world3', 'egg': 'spam3'}, + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem2({"hello": "world2", "foo": "bar2"}), + {"hello": "world3", "egg": "spam3"}, ] MyItem = self.MyItem @@ -1082,40 +1098,40 @@ class FeedExportTest(FeedExportTestBase): class CustomFilter2(scrapy.extensions.feedexport.ItemFilter): def accepts(self, item): - if 'foo' not in item.fields: + if "foo" not in item.fields: return False return True class CustomFilter3(scrapy.extensions.feedexport.ItemFilter): def accepts(self, item): - if isinstance(item, tuple(self.item_classes)) and item['foo'] == "bar1": + if isinstance(item, tuple(self.item_classes)) and item["foo"] == "bar1": return True return False formats = { - 'json': b'[\n{"foo": "bar1", "egg": "spam1"}\n]', - 'xml': ( + "json": b'[\n{"foo": "bar1", "egg": "spam1"}\n]', + "xml": ( b'\n\n' - b'bar1spam1\n' - b'world2bar2\n' + b"bar1spam1\n" + b"world2bar2\n" ), - 'jsonlines': b'{"foo": "bar1", "egg": "spam1"}\n', + "jsonlines": b'{"foo": "bar1", "egg": "spam1"}\n', } settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): { - 'format': 'json', - 'item_filter': CustomFilter1, + "format": "json", + "item_filter": CustomFilter1, }, self._random_temp_filename(): { - 'format': 'xml', - 'item_filter': CustomFilter2, + "format": "xml", + "item_filter": CustomFilter2, }, self._random_temp_filename(): { - 'format': 'jsonlines', - 'item_classes': [self.MyItem, self.MyItem2], - 'item_filter': CustomFilter3, + "format": "jsonlines", + "item_classes": [self.MyItem, self.MyItem2], + "item_filter": CustomFilter3, }, }, } @@ -1129,15 +1145,12 @@ class FeedExportTest(FeedExportTestBase): # When dicts are used, only keys from the first row are used as # a header for CSV, and all fields are used for JSON Lines. items = [ - {'foo': 'bar', 'egg': 'spam'}, - {'foo': 'bar', 'egg': 'spam', 'baz': 'quux'}, - ] - rows_csv = [ - {'egg': 'spam', 'foo': 'bar'}, - {'egg': 'spam', 'foo': 'bar'} + {"foo": "bar", "egg": "spam"}, + {"foo": "bar", "egg": "spam", "baz": "quux"}, ] + rows_csv = [{"egg": "spam", "foo": "bar"}, {"egg": "spam", "foo": "bar"}] rows_jl = items - yield self.assertExportedCsv(items, ['foo', 'egg'], rows_csv) + yield self.assertExportedCsv(items, ["foo", "egg"], rows_csv) yield self.assertExportedJsonLines(items, rows_jl) @defer.inlineCallbacks @@ -1147,105 +1160,102 @@ class FeedExportTest(FeedExportTestBase): for item_cls in [self.MyItem, dict]: items = [ - item_cls({'foo': 'bar1', 'egg': 'spam1'}), - item_cls({'foo': 'bar2', 'egg': 'spam2', 'baz': 'quux2'}), + item_cls({"foo": "bar1", "egg": "spam1"}), + item_cls({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), ] # export all columns - settings = {'FEED_EXPORT_FIELDS': 'foo,baz,egg'} + settings = {"FEED_EXPORT_FIELDS": "foo,baz,egg"} rows = [ - {'egg': 'spam1', 'foo': 'bar1', 'baz': ''}, - {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'} + {"egg": "spam1", "foo": "bar1", "baz": ""}, + {"egg": "spam2", "foo": "bar2", "baz": "quux2"}, ] - yield self.assertExported(items, ['foo', 'baz', 'egg'], rows, - settings=settings) + yield self.assertExported( + items, ["foo", "baz", "egg"], rows, settings=settings + ) # export a subset of columns - settings = {'FEED_EXPORT_FIELDS': 'egg,baz'} - rows = [ - {'egg': 'spam1', 'baz': ''}, - {'egg': 'spam2', 'baz': 'quux2'} - ] - yield self.assertExported(items, ['egg', 'baz'], rows, - settings=settings) + settings = {"FEED_EXPORT_FIELDS": "egg,baz"} + rows = [{"egg": "spam1", "baz": ""}, {"egg": "spam2", "baz": "quux2"}] + yield self.assertExported(items, ["egg", "baz"], rows, settings=settings) @defer.inlineCallbacks def test_export_encoding(self): - items = [dict({'foo': 'Test\xd6'})] + items = [dict({"foo": "Test\xd6"})] formats = { - 'json': '[{"foo": "Test\\u00d6"}]'.encode('utf-8'), - 'jsonlines': '{"foo": "Test\\u00d6"}\n'.encode('utf-8'), - 'xml': ( + "json": '[{"foo": "Test\\u00d6"}]'.encode("utf-8"), + "jsonlines": '{"foo": "Test\\u00d6"}\n'.encode("utf-8"), + "xml": ( '\n' - 'Test\xd6' - ).encode('utf-8'), - 'csv': 'foo\r\nTest\xd6\r\n'.encode('utf-8'), + "Test\xd6" + ).encode("utf-8"), + "csv": "foo\r\nTest\xd6\r\n".encode("utf-8"), } for fmt, expected in formats.items(): settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': fmt}, + "FEEDS": { + self._random_temp_filename(): {"format": fmt}, }, - 'FEED_EXPORT_INDENT': None, + "FEED_EXPORT_INDENT": None, } data = yield self.exported_data(items, settings) self.assertEqual(expected, data[fmt]) formats = { - 'json': '[{"foo": "Test\xd6"}]'.encode('latin-1'), - 'jsonlines': '{"foo": "Test\xd6"}\n'.encode('latin-1'), - 'xml': ( + "json": '[{"foo": "Test\xd6"}]'.encode("latin-1"), + "jsonlines": '{"foo": "Test\xd6"}\n'.encode("latin-1"), + "xml": ( '\n' - 'Test\xd6' - ).encode('latin-1'), - 'csv': 'foo\r\nTest\xd6\r\n'.encode('latin-1'), + "Test\xd6" + ).encode("latin-1"), + "csv": "foo\r\nTest\xd6\r\n".encode("latin-1"), } for fmt, expected in formats.items(): settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': fmt}, + "FEEDS": { + self._random_temp_filename(): {"format": fmt}, }, - 'FEED_EXPORT_INDENT': None, - 'FEED_EXPORT_ENCODING': 'latin-1', + "FEED_EXPORT_INDENT": None, + "FEED_EXPORT_ENCODING": "latin-1", } data = yield self.exported_data(items, settings) self.assertEqual(expected, data[fmt]) @defer.inlineCallbacks def test_export_multiple_configs(self): - items = [dict({'foo': 'FOO', 'bar': 'BAR'})] + items = [dict({"foo": "FOO", "bar": "BAR"})] formats = { - 'json': '[\n{"bar": "BAR"}\n]'.encode('utf-8'), - 'xml': ( + "json": '[\n{"bar": "BAR"}\n]'.encode("utf-8"), + "xml": ( '\n' - '\n \n FOO\n \n' - ).encode('latin-1'), - 'csv': 'bar,foo\r\nBAR,FOO\r\n'.encode('utf-8'), + "\n \n FOO\n \n" + ).encode("latin-1"), + "csv": "bar,foo\r\nBAR,FOO\r\n".encode("utf-8"), } settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): { - 'format': 'json', - 'indent': 0, - 'fields': ['bar'], - 'encoding': 'utf-8', + "format": "json", + "indent": 0, + "fields": ["bar"], + "encoding": "utf-8", }, self._random_temp_filename(): { - 'format': 'xml', - 'indent': 2, - 'fields': ['foo'], - 'encoding': 'latin-1', + "format": "xml", + "indent": 2, + "fields": ["foo"], + "encoding": "latin-1", }, self._random_temp_filename(): { - 'format': 'csv', - 'indent': None, - 'fields': ['bar', 'foo'], - 'encoding': 'utf-8', + "format": "csv", + "indent": None, + "fields": ["bar", "foo"], + "encoding": "utf-8", }, }, } @@ -1257,37 +1267,37 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_indentation(self): items = [ - {'foo': ['bar']}, - {'key': 'value'}, + {"foo": ["bar"]}, + {"key": "value"}, ] test_cases = [ # JSON { - 'format': 'json', - 'indent': None, - 'expected': b'[{"foo": ["bar"]},{"key": "value"}]', + "format": "json", + "indent": None, + "expected": b'[{"foo": ["bar"]},{"key": "value"}]', }, { - 'format': 'json', - 'indent': -1, - 'expected': b"""[ + "format": "json", + "indent": -1, + "expected": b"""[ {"foo": ["bar"]}, {"key": "value"} ]""", }, { - 'format': 'json', - 'indent': 0, - 'expected': b"""[ + "format": "json", + "indent": 0, + "expected": b"""[ {"foo": ["bar"]}, {"key": "value"} ]""", }, { - 'format': 'json', - 'indent': 2, - 'expected': b"""[ + "format": "json", + "indent": 2, + "expected": b"""[ { "foo": [ "bar" @@ -1299,9 +1309,9 @@ class FeedExportTest(FeedExportTestBase): ]""", }, { - 'format': 'json', - 'indent': 4, - 'expected': b"""[ + "format": "json", + "indent": 4, + "expected": b"""[ { "foo": [ "bar" @@ -1313,9 +1323,9 @@ class FeedExportTest(FeedExportTestBase): ]""", }, { - 'format': 'json', - 'indent': 5, - 'expected': b"""[ + "format": "json", + "indent": 5, + "expected": b"""[ { "foo": [ "bar" @@ -1326,36 +1336,35 @@ class FeedExportTest(FeedExportTestBase): } ]""", }, - # XML { - 'format': 'xml', - 'indent': None, - 'expected': b""" + "format": "xml", + "indent": None, + "expected": b""" barvalue""", }, { - 'format': 'xml', - 'indent': -1, - 'expected': b""" + "format": "xml", + "indent": -1, + "expected": b""" bar value """, }, { - 'format': 'xml', - 'indent': 0, - 'expected': b""" + "format": "xml", + "indent": 0, + "expected": b""" bar value """, }, { - 'format': 'xml', - 'indent': 2, - 'expected': b""" + "format": "xml", + "indent": 2, + "expected": b""" @@ -1368,9 +1377,9 @@ class FeedExportTest(FeedExportTestBase): """, }, { - 'format': 'xml', - 'indent': 4, - 'expected': b""" + "format": "xml", + "indent": 4, + "expected": b""" @@ -1383,9 +1392,9 @@ class FeedExportTest(FeedExportTestBase): """, }, { - 'format': 'xml', - 'indent': 5, - 'expected': b""" + "format": "xml", + "indent": 5, + "expected": b""" @@ -1401,23 +1410,23 @@ class FeedExportTest(FeedExportTestBase): for row in test_cases: settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): { - 'format': row['format'], - 'indent': row['indent'], + "format": row["format"], + "indent": row["indent"], }, }, } data = yield self.exported_data(items, settings) - self.assertEqual(row['expected'], data[row['format']]) + self.assertEqual(row["expected"], data[row["format"]]) @defer.inlineCallbacks def test_init_exporters_storages_with_crawler(self): settings = { - 'FEED_EXPORTERS': {'csv': FromCrawlerCsvItemExporter}, - 'FEED_STORAGES': {'file': FromCrawlerFileFeedStorage}, - 'FEEDS': { - self._random_temp_filename(): {'format': 'csv'}, + "FEED_EXPORTERS": {"csv": FromCrawlerCsvItemExporter}, + "FEED_STORAGES": {"file": FromCrawlerFileFeedStorage}, + "FEEDS": { + self._random_temp_filename(): {"format": "csv"}, }, } yield self.exported_data(items=[], settings=settings) @@ -1427,105 +1436,103 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_str_uri(self): settings = { - 'FEED_STORE_EMPTY': True, - 'FEEDS': { - str(self._random_temp_filename()): {'format': 'csv'} - }, + "FEED_STORE_EMPTY": True, + "FEEDS": {str(self._random_temp_filename()): {"format": "csv"}}, } data = yield self.exported_no_data(settings) - self.assertEqual(data['csv'], b'') + self.assertEqual(data["csv"], b"") @defer.inlineCallbacks def test_multiple_feeds_success_logs_blocking_feed_storage(self): settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': 'json'}, - self._random_temp_filename(): {'format': 'xml'}, - self._random_temp_filename(): {'format': 'csv'}, + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + self._random_temp_filename(): {"format": "xml"}, + self._random_temp_filename(): {"format": "csv"}, }, - 'FEED_STORAGES': {'file': DummyBlockingFeedStorage}, + "FEED_STORAGES": {"file": DummyBlockingFeedStorage}, } items = [ - {'foo': 'bar1', 'baz': ''}, - {'foo': 'bar2', 'baz': 'quux'}, + {"foo": "bar1", "baz": ""}, + {"foo": "bar2", "baz": "quux"}, ] with LogCapture() as log: yield self.exported_data(items, settings) print(log) - for fmt in ['json', 'xml', 'csv']: - self.assertIn(f'Stored {fmt} feed (2 items)', str(log)) + for fmt in ["json", "xml", "csv"]: + self.assertIn(f"Stored {fmt} feed (2 items)", str(log)) @defer.inlineCallbacks def test_multiple_feeds_failing_logs_blocking_feed_storage(self): settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': 'json'}, - self._random_temp_filename(): {'format': 'xml'}, - self._random_temp_filename(): {'format': 'csv'}, + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + self._random_temp_filename(): {"format": "xml"}, + self._random_temp_filename(): {"format": "csv"}, }, - 'FEED_STORAGES': {'file': FailingBlockingFeedStorage}, + "FEED_STORAGES": {"file": FailingBlockingFeedStorage}, } items = [ - {'foo': 'bar1', 'baz': ''}, - {'foo': 'bar2', 'baz': 'quux'}, + {"foo": "bar1", "baz": ""}, + {"foo": "bar2", "baz": "quux"}, ] with LogCapture() as log: yield self.exported_data(items, settings) print(log) - for fmt in ['json', 'xml', 'csv']: - self.assertIn(f'Error storing {fmt} feed (2 items)', str(log)) + for fmt in ["json", "xml", "csv"]: + self.assertIn(f"Error storing {fmt} feed (2 items)", str(log)) @defer.inlineCallbacks def test_extend_kwargs(self): - items = [{'foo': 'FOO', 'bar': 'BAR'}] + items = [{"foo": "FOO", "bar": "BAR"}] - expected_with_title_csv = 'foo,bar\r\nFOO,BAR\r\n'.encode('utf-8') - expected_without_title_csv = 'FOO,BAR\r\n'.encode('utf-8') + expected_with_title_csv = "foo,bar\r\nFOO,BAR\r\n".encode("utf-8") + expected_without_title_csv = "FOO,BAR\r\n".encode("utf-8") test_cases = [ # with title { - 'options': { - 'format': 'csv', - 'item_export_kwargs': {'include_headers_line': True}, + "options": { + "format": "csv", + "item_export_kwargs": {"include_headers_line": True}, }, - 'expected': expected_with_title_csv, + "expected": expected_with_title_csv, }, # without title { - 'options': { - 'format': 'csv', - 'item_export_kwargs': {'include_headers_line': False}, + "options": { + "format": "csv", + "item_export_kwargs": {"include_headers_line": False}, }, - 'expected': expected_without_title_csv, + "expected": expected_without_title_csv, }, ] for row in test_cases: - feed_options = row['options'] + feed_options = row["options"] settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): feed_options, }, - 'FEED_EXPORT_INDENT': None, + "FEED_EXPORT_INDENT": None, } data = yield self.exported_data(items, settings) - self.assertEqual(row['expected'], data[feed_options['format']]) + self.assertEqual(row["expected"], data[feed_options["format"]]) class FeedPostProcessedExportsTest(FeedExportTestBase): __test__ = True - items = [{'foo': 'bar'}] - expected = b'foo\r\nbar\r\n' + items = [{"foo": "bar"}] + expected = b"foo\r\nbar\r\n" class MyPlugin1: def __init__(self, file, feed_options): self.file = file self.feed_options = feed_options - self.char = self.feed_options.get('plugin1_char', b'') + self.char = self.feed_options.get("plugin1_char", b"") def write(self, data): written_count = self.file.write(data) @@ -1540,10 +1547,10 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def run_and_export(self, spider_cls, settings): - """ Run spider with specified settings; return exported data with filename. """ + """Run spider with specified settings; return exported data with filename.""" - FEEDS = settings.get('FEEDS') or {} - settings['FEEDS'] = { + FEEDS = settings.get("FEEDS") or {} + settings["FEEDS"] = { printf_escape(path_to_url(file_path)): feed_options for file_path, feed_options in FEEDS.items() } @@ -1551,7 +1558,7 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): content = {} try: with MockServer() as s: - spider_cls.start_urls = [s.url('/')] + spider_cls.start_urls = [s.url("/")] crawler = get_crawler(spider_cls, settings) yield crawler.crawl() @@ -1570,10 +1577,15 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): return content - def get_gzip_compressed(self, data, compresslevel=9, mtime=0, filename=''): + def get_gzip_compressed(self, data, compresslevel=9, mtime=0, filename=""): data_stream = BytesIO() - gzipf = gzip.GzipFile(fileobj=data_stream, filename=filename, mtime=mtime, - compresslevel=compresslevel, mode="wb") + gzipf = gzip.GzipFile( + fileobj=data_stream, + filename=filename, + mtime=mtime, + compresslevel=compresslevel, + mode="wb", + ) gzipf.write(data) gzipf.close() data_stream.seek(0) @@ -1582,13 +1594,13 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_gzip_plugin(self): - filename = self._named_tempfile('gzip_file') + filename = self._named_tempfile("gzip_file") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], }, }, } @@ -1603,25 +1615,29 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_gzip_plugin_compresslevel(self): filename_to_compressed = { - self._named_tempfile('compresslevel_0'): self.get_gzip_compressed(self.expected, compresslevel=0), - self._named_tempfile('compresslevel_9'): self.get_gzip_compressed(self.expected, compresslevel=9), + self._named_tempfile("compresslevel_0"): self.get_gzip_compressed( + self.expected, compresslevel=0 + ), + self._named_tempfile("compresslevel_9"): self.get_gzip_compressed( + self.expected, compresslevel=9 + ), } settings = { - 'FEEDS': { - self._named_tempfile('compresslevel_0'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_compresslevel': 0, - 'gzip_mtime': 0, - 'gzip_filename': "", + "FEEDS": { + self._named_tempfile("compresslevel_0"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_compresslevel": 0, + "gzip_mtime": 0, + "gzip_filename": "", }, - self._named_tempfile('compresslevel_9'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_compresslevel': 9, - 'gzip_mtime': 0, - 'gzip_filename': "", + self._named_tempfile("compresslevel_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_compresslevel": 9, + "gzip_mtime": 0, + "gzip_filename": "", }, }, } @@ -1636,23 +1652,27 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_gzip_plugin_mtime(self): filename_to_compressed = { - self._named_tempfile('mtime_123'): self.get_gzip_compressed(self.expected, mtime=123), - self._named_tempfile('mtime_123456789'): self.get_gzip_compressed(self.expected, mtime=123456789), + self._named_tempfile("mtime_123"): self.get_gzip_compressed( + self.expected, mtime=123 + ), + self._named_tempfile("mtime_123456789"): self.get_gzip_compressed( + self.expected, mtime=123456789 + ), } settings = { - 'FEEDS': { - self._named_tempfile('mtime_123'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_mtime': 123, - 'gzip_filename': "", + "FEEDS": { + self._named_tempfile("mtime_123"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 123, + "gzip_filename": "", }, - self._named_tempfile('mtime_123456789'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_mtime': 123456789, - 'gzip_filename': "", + self._named_tempfile("mtime_123456789"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 123456789, + "gzip_filename": "", }, }, } @@ -1667,23 +1687,27 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_gzip_plugin_filename(self): filename_to_compressed = { - self._named_tempfile('filename_FILE1'): self.get_gzip_compressed(self.expected, filename="FILE1"), - self._named_tempfile('filename_FILE2'): self.get_gzip_compressed(self.expected, filename="FILE2"), + self._named_tempfile("filename_FILE1"): self.get_gzip_compressed( + self.expected, filename="FILE1" + ), + self._named_tempfile("filename_FILE2"): self.get_gzip_compressed( + self.expected, filename="FILE2" + ), } settings = { - 'FEEDS': { - self._named_tempfile('filename_FILE1'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_mtime': 0, - 'gzip_filename': "FILE1", + "FEEDS": { + self._named_tempfile("filename_FILE1"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 0, + "gzip_filename": "FILE1", }, - self._named_tempfile('filename_FILE2'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.GzipPlugin'], - 'gzip_mtime': 0, - 'gzip_filename': "FILE2", + self._named_tempfile("filename_FILE2"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.GzipPlugin"], + "gzip_mtime": 0, + "gzip_filename": "FILE2", }, }, } @@ -1698,13 +1722,13 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_lzma_plugin(self): - filename = self._named_tempfile('lzma_file') + filename = self._named_tempfile("lzma_file") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], }, }, } @@ -1719,21 +1743,25 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_lzma_plugin_format(self): filename_to_compressed = { - self._named_tempfile('format_FORMAT_XZ'): lzma.compress(self.expected, format=lzma.FORMAT_XZ), - self._named_tempfile('format_FORMAT_ALONE'): lzma.compress(self.expected, format=lzma.FORMAT_ALONE), + self._named_tempfile("format_FORMAT_XZ"): lzma.compress( + self.expected, format=lzma.FORMAT_XZ + ), + self._named_tempfile("format_FORMAT_ALONE"): lzma.compress( + self.expected, format=lzma.FORMAT_ALONE + ), } settings = { - 'FEEDS': { - self._named_tempfile('format_FORMAT_XZ'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_format': lzma.FORMAT_XZ, + "FEEDS": { + self._named_tempfile("format_FORMAT_XZ"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_format": lzma.FORMAT_XZ, }, - self._named_tempfile('format_FORMAT_ALONE'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_format': lzma.FORMAT_ALONE, + self._named_tempfile("format_FORMAT_ALONE"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_format": lzma.FORMAT_ALONE, }, }, } @@ -1749,21 +1777,25 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_lzma_plugin_check(self): filename_to_compressed = { - self._named_tempfile('check_CHECK_NONE'): lzma.compress(self.expected, check=lzma.CHECK_NONE), - self._named_tempfile('check_CHECK_CRC256'): lzma.compress(self.expected, check=lzma.CHECK_SHA256), + self._named_tempfile("check_CHECK_NONE"): lzma.compress( + self.expected, check=lzma.CHECK_NONE + ), + self._named_tempfile("check_CHECK_CRC256"): lzma.compress( + self.expected, check=lzma.CHECK_SHA256 + ), } settings = { - 'FEEDS': { - self._named_tempfile('check_CHECK_NONE'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_check': lzma.CHECK_NONE, + "FEEDS": { + self._named_tempfile("check_CHECK_NONE"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_check": lzma.CHECK_NONE, }, - self._named_tempfile('check_CHECK_CRC256'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_check': lzma.CHECK_SHA256, + self._named_tempfile("check_CHECK_CRC256"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_check": lzma.CHECK_SHA256, }, }, } @@ -1779,21 +1811,25 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_lzma_plugin_preset(self): filename_to_compressed = { - self._named_tempfile('preset_PRESET_0'): lzma.compress(self.expected, preset=0), - self._named_tempfile('preset_PRESET_9'): lzma.compress(self.expected, preset=9), + self._named_tempfile("preset_PRESET_0"): lzma.compress( + self.expected, preset=0 + ), + self._named_tempfile("preset_PRESET_9"): lzma.compress( + self.expected, preset=9 + ), } settings = { - 'FEEDS': { - self._named_tempfile('preset_PRESET_0'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_preset': 0, + "FEEDS": { + self._named_tempfile("preset_PRESET_0"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_preset": 0, }, - self._named_tempfile('preset_PRESET_9'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_preset': 9, + self._named_tempfile("preset_PRESET_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_preset": 9, }, }, } @@ -1811,16 +1847,16 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): # https://foss.heptapod.net/pypy/pypy/-/issues/3527 raise unittest.SkipTest("lzma filters doesn't work in PyPy") - filters = [{'id': lzma.FILTER_LZMA2}] + filters = [{"id": lzma.FILTER_LZMA2}] compressed = lzma.compress(self.expected, filters=filters) - filename = self._named_tempfile('filters') + filename = self._named_tempfile("filters") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.LZMAPlugin'], - 'lzma_filters': filters, + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.LZMAPlugin"], + "lzma_filters": filters, }, }, } @@ -1833,13 +1869,13 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_bz2_plugin(self): - filename = self._named_tempfile('bz2_file') + filename = self._named_tempfile("bz2_file") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.Bz2Plugin'], + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], }, }, } @@ -1854,21 +1890,25 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_bz2_plugin_compresslevel(self): filename_to_compressed = { - self._named_tempfile('compresslevel_1'): bz2.compress(self.expected, compresslevel=1), - self._named_tempfile('compresslevel_9'): bz2.compress(self.expected, compresslevel=9), + self._named_tempfile("compresslevel_1"): bz2.compress( + self.expected, compresslevel=1 + ), + self._named_tempfile("compresslevel_9"): bz2.compress( + self.expected, compresslevel=9 + ), } settings = { - 'FEEDS': { - self._named_tempfile('compresslevel_1'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.Bz2Plugin'], - 'bz2_compresslevel': 1, + "FEEDS": { + self._named_tempfile("compresslevel_1"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], + "bz2_compresslevel": 1, }, - self._named_tempfile('compresslevel_9'): { - 'format': 'csv', - 'postprocessing': ['scrapy.extensions.postprocessing.Bz2Plugin'], - 'bz2_compresslevel': 9, + self._named_tempfile("compresslevel_9"): { + "format": "csv", + "postprocessing": ["scrapy.extensions.postprocessing.Bz2Plugin"], + "bz2_compresslevel": 9, }, }, } @@ -1882,13 +1922,13 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_custom_plugin(self): - filename = self._named_tempfile('csv_file') + filename = self._named_tempfile("csv_file") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1], + "format": "csv", + "postprocessing": [self.MyPlugin1], }, }, } @@ -1899,15 +1939,15 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_custom_plugin_with_parameter(self): - expected = b'foo\r\n\nbar\r\n\n' - filename = self._named_tempfile('newline') + expected = b"foo\r\n\nbar\r\n\n" + filename = self._named_tempfile("newline") settings = { - 'FEEDS': { + "FEEDS": { filename: { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1], - 'plugin1_char': b'\n' + "format": "csv", + "postprocessing": [self.MyPlugin1], + "plugin1_char": b"\n", }, }, } @@ -1918,30 +1958,39 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): @defer.inlineCallbacks def test_custom_plugin_with_compression(self): - expected = b'foo\r\n\nbar\r\n\n' + expected = b"foo\r\n\nbar\r\n\n" filename_to_decompressor = { - self._named_tempfile('bz2'): bz2.decompress, - self._named_tempfile('lzma'): lzma.decompress, - self._named_tempfile('gzip'): gzip.decompress, + self._named_tempfile("bz2"): bz2.decompress, + self._named_tempfile("lzma"): lzma.decompress, + self._named_tempfile("gzip"): gzip.decompress, } settings = { - 'FEEDS': { - self._named_tempfile('bz2'): { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1, 'scrapy.extensions.postprocessing.Bz2Plugin'], - 'plugin1_char': b'\n', + "FEEDS": { + self._named_tempfile("bz2"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.Bz2Plugin", + ], + "plugin1_char": b"\n", }, - self._named_tempfile('lzma'): { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1, 'scrapy.extensions.postprocessing.LZMAPlugin'], - 'plugin1_char': b'\n', + self._named_tempfile("lzma"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.LZMAPlugin", + ], + "plugin1_char": b"\n", }, - self._named_tempfile('gzip'): { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1, 'scrapy.extensions.postprocessing.GzipPlugin'], - 'plugin1_char': b'\n', + self._named_tempfile("gzip"): { + "format": "csv", + "postprocessing": [ + self.MyPlugin1, + "scrapy.extensions.postprocessing.GzipPlugin", + ], + "plugin1_char": b"\n", }, }, } @@ -1956,40 +2005,41 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): def test_exports_compatibility_with_postproc(self): import marshal import pickle + filename_to_expected = { - self._named_tempfile('csv'): b'foo\r\nbar\r\n', - self._named_tempfile('json'): b'[\n{"foo": "bar"}\n]', - self._named_tempfile('jsonlines'): b'{"foo": "bar"}\n', - self._named_tempfile('xml'): b'\n' - b'\nbar\n', + self._named_tempfile("csv"): b"foo\r\nbar\r\n", + self._named_tempfile("json"): b'[\n{"foo": "bar"}\n]', + self._named_tempfile("jsonlines"): b'{"foo": "bar"}\n', + self._named_tempfile("xml"): b'\n' + b"\nbar\n", } settings = { - 'FEEDS': { - self._named_tempfile('csv'): { - 'format': 'csv', - 'postprocessing': [self.MyPlugin1], + "FEEDS": { + self._named_tempfile("csv"): { + "format": "csv", + "postprocessing": [self.MyPlugin1], # empty plugin to activate postprocessing.PostProcessingManager }, - self._named_tempfile('json'): { - 'format': 'json', - 'postprocessing': [self.MyPlugin1], + self._named_tempfile("json"): { + "format": "json", + "postprocessing": [self.MyPlugin1], }, - self._named_tempfile('jsonlines'): { - 'format': 'jsonlines', - 'postprocessing': [self.MyPlugin1], + self._named_tempfile("jsonlines"): { + "format": "jsonlines", + "postprocessing": [self.MyPlugin1], }, - self._named_tempfile('xml'): { - 'format': 'xml', - 'postprocessing': [self.MyPlugin1], + self._named_tempfile("xml"): { + "format": "xml", + "postprocessing": [self.MyPlugin1], }, - self._named_tempfile('marshal'): { - 'format': 'marshal', - 'postprocessing': [self.MyPlugin1], + self._named_tempfile("marshal"): { + "format": "marshal", + "postprocessing": [self.MyPlugin1], }, - self._named_tempfile('pickle'): { - 'format': 'pickle', - 'postprocessing': [self.MyPlugin1], + self._named_tempfile("pickle"): { + "format": "pickle", + "postprocessing": [self.MyPlugin1], }, }, } @@ -1997,9 +2047,9 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): data = yield self.exported_data(self.items, settings) for filename, result in data.items(): - if 'pickle' in filename: + if "pickle" in filename: expected, result = self.items[0], pickle.loads(result) - elif 'marshal' in filename: + elif "marshal" in filename: expected, result = self.items[0], marshal.loads(result) else: expected = filename_to_expected[filename] @@ -2008,28 +2058,27 @@ class FeedPostProcessedExportsTest(FeedExportTestBase): class BatchDeliveriesTest(FeedExportTestBase): __test__ = True - _file_mark = '_%(batch_time)s_#%(batch_id)02d_' + _file_mark = "_%(batch_time)s_#%(batch_id)02d_" @defer.inlineCallbacks def run_and_export(self, spider_cls, settings): - """ Run spider with specified settings; return exported data. """ + """Run spider with specified settings; return exported data.""" - FEEDS = settings.get('FEEDS') or {} - settings['FEEDS'] = { - build_url(file_path): feed - for file_path, feed in FEEDS.items() + FEEDS = settings.get("FEEDS") or {} + settings["FEEDS"] = { + build_url(file_path): feed for file_path, feed in FEEDS.items() } content = defaultdict(list) try: with MockServer() as s: - spider_cls.start_urls = [s.url('/')] + spider_cls.start_urls = [s.url("/")] crawler = get_crawler(spider_cls, settings) yield crawler.crawl() for path, feed in FEEDS.items(): dir_name = Path(path).parent for file in sorted(dir_name.iterdir()): - content[feed['format']].append(file.read_bytes()) + content[feed["format"]].append(file.read_bytes()) finally: self.tearDown() defer.returnValue(content) @@ -2037,30 +2086,40 @@ class BatchDeliveriesTest(FeedExportTestBase): @defer.inlineCallbacks def assertExportedJsonLines(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'jl' / self._file_mark: {'format': 'jl'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "jl" + / self._file_mark: {"format": "jl"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) - for batch in data['jl']: - got_batch = [json.loads(to_unicode(batch_item)) for batch_item in batch.splitlines()] + for batch in data["jl"]: + got_batch = [ + json.loads(to_unicode(batch_item)) for batch_item in batch.splitlines() + ] expected_batch, rows = rows[:batch_size], rows[batch_size:] self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks def assertExportedCsv(self, items, header, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'csv' / self._file_mark: {'format': 'csv'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "csv" + / self._file_mark: {"format": "csv"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") data = yield self.exported_data(items, settings) - for batch in data['csv']: + for batch in data["csv"]: got_batch = csv.DictReader(to_unicode(batch).splitlines()) self.assertEqual(list(header), got_batch.fieldnames) expected_batch, rows = rows[:batch_size], rows[batch_size:] @@ -2069,59 +2128,74 @@ class BatchDeliveriesTest(FeedExportTestBase): @defer.inlineCallbacks def assertExportedXml(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'xml' / self._file_mark: {'format': 'xml'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "xml" + / self._file_mark: {"format": "xml"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) - for batch in data['xml']: + for batch in data["xml"]: root = lxml.etree.fromstring(batch) - got_batch = [{e.tag: e.text for e in it} for it in root.findall('item')] + got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] expected_batch, rows = rows[:batch_size], rows[batch_size:] self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks def assertExportedMultiple(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'xml' / self._file_mark: {'format': 'xml'}, - self._random_temp_filename() / 'json' / self._file_mark: {'format': 'json'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "xml" + / self._file_mark: {"format": "xml"}, + self._random_temp_filename() + / "json" + / self._file_mark: {"format": "json"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) # XML xml_rows = rows.copy() - for batch in data['xml']: + for batch in data["xml"]: root = lxml.etree.fromstring(batch) - got_batch = [{e.tag: e.text for e in it} for it in root.findall('item')] + got_batch = [{e.tag: e.text for e in it} for it in root.findall("item")] expected_batch, xml_rows = xml_rows[:batch_size], xml_rows[batch_size:] self.assertEqual(expected_batch, got_batch) # JSON json_rows = rows.copy() - for batch in data['json']: - got_batch = json.loads(batch.decode('utf-8')) + for batch in data["json"]: + got_batch = json.loads(batch.decode("utf-8")) expected_batch, json_rows = json_rows[:batch_size], json_rows[batch_size:] self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks def assertExportedPickle(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'pickle' / self._file_mark: {'format': 'pickle'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "pickle" + / self._file_mark: {"format": "pickle"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) import pickle - for batch in data['pickle']: + + for batch in data["pickle"]: got_batch = self._load_until_eof(batch, load_func=pickle.load) expected_batch, rows = rows[:batch_size], rows[batch_size:] self.assertEqual(expected_batch, got_batch) @@ -2129,80 +2203,87 @@ class BatchDeliveriesTest(FeedExportTestBase): @defer.inlineCallbacks def assertExportedMarshal(self, items, rows, settings=None): settings = settings or {} - settings.update({ - 'FEEDS': { - self._random_temp_filename() / 'marshal' / self._file_mark: {'format': 'marshal'}, - }, - }) - batch_size = Settings(settings).getint('FEED_EXPORT_BATCH_ITEM_COUNT') + settings.update( + { + "FEEDS": { + self._random_temp_filename() + / "marshal" + / self._file_mark: {"format": "marshal"}, + }, + } + ) + batch_size = Settings(settings).getint("FEED_EXPORT_BATCH_ITEM_COUNT") rows = [{k: v for k, v in row.items() if v} for row in rows] data = yield self.exported_data(items, settings) import marshal - for batch in data['marshal']: + + for batch in data["marshal"]: got_batch = self._load_until_eof(batch, load_func=marshal.load) expected_batch, rows = rows[:batch_size], rows[batch_size:] self.assertEqual(expected_batch, got_batch) @defer.inlineCallbacks def test_export_items(self): - """ Test partial deliveries in all supported formats """ + """Test partial deliveries in all supported formats""" items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem({'foo': 'bar2', 'egg': 'spam2', 'baz': 'quux2'}), - self.MyItem({'foo': 'bar3', 'baz': 'quux3'}), + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), ] rows = [ - {'egg': 'spam1', 'foo': 'bar1', 'baz': ''}, - {'egg': 'spam2', 'foo': 'bar2', 'baz': 'quux2'}, - {'foo': 'bar3', 'baz': 'quux3', 'egg': ''} + {"egg": "spam1", "foo": "bar1", "baz": ""}, + {"egg": "spam2", "foo": "bar2", "baz": "quux2"}, + {"foo": "bar3", "baz": "quux3", "egg": ""}, ] - settings = { - 'FEED_EXPORT_BATCH_ITEM_COUNT': 2 - } + settings = {"FEED_EXPORT_BATCH_ITEM_COUNT": 2} header = self.MyItem.fields.keys() yield self.assertExported(items, header, rows, settings=settings) def test_wrong_path(self): - """ If path is without %(batch_time)s and %(batch_id) an exception must be raised """ + """If path is without %(batch_time)s and %(batch_id) an exception must be raised""" settings = { - 'FEEDS': { - self._random_temp_filename(): {'format': 'xml'}, + "FEEDS": { + self._random_temp_filename(): {"format": "xml"}, }, - 'FEED_EXPORT_BATCH_ITEM_COUNT': 1 + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, } crawler = get_crawler(settings_dict=settings) self.assertRaises(NotConfigured, FeedExporter, crawler) @defer.inlineCallbacks def test_export_no_items_not_store_empty(self): - for fmt in ('json', 'jsonlines', 'xml', 'csv'): + for fmt in ("json", "jsonlines", "xml", "csv"): settings = { - 'FEEDS': { - self._random_temp_filename() / fmt / self._file_mark: {'format': fmt}, + "FEEDS": { + self._random_temp_filename() + / fmt + / self._file_mark: {"format": fmt}, }, - 'FEED_EXPORT_BATCH_ITEM_COUNT': 1 + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, } data = yield self.exported_no_data(settings) data = dict(data) - self.assertEqual(b'', data[fmt][0]) + self.assertEqual(b"", data[fmt][0]) @defer.inlineCallbacks def test_export_no_items_store_empty(self): formats = ( - ('json', b'[]'), - ('jsonlines', b''), - ('xml', b'\n'), - ('csv', b''), + ("json", b"[]"), + ("jsonlines", b""), + ("xml", b'\n'), + ("csv", b""), ) for fmt, expctd in formats: settings = { - 'FEEDS': { - self._random_temp_filename() / fmt / self._file_mark: {'format': fmt}, + "FEEDS": { + self._random_temp_filename() + / fmt + / self._file_mark: {"format": fmt}, }, - 'FEED_STORE_EMPTY': True, - 'FEED_EXPORT_INDENT': None, - 'FEED_EXPORT_BATCH_ITEM_COUNT': 1, + "FEED_STORE_EMPTY": True, + "FEED_EXPORT_INDENT": None, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, } data = yield self.exported_no_data(settings) data = dict(data) @@ -2210,47 +2291,60 @@ class BatchDeliveriesTest(FeedExportTestBase): @defer.inlineCallbacks def test_export_multiple_configs(self): - items = [dict({'foo': 'FOO', 'bar': 'BAR'}), dict({'foo': 'FOO1', 'bar': 'BAR1'})] + items = [ + dict({"foo": "FOO", "bar": "BAR"}), + dict({"foo": "FOO1", "bar": "BAR1"}), + ] formats = { - 'json': ['[\n{"bar": "BAR"}\n]'.encode('utf-8'), - '[\n{"bar": "BAR1"}\n]'.encode('utf-8')], - 'xml': [ - ( - '\n' - '\n \n FOO\n \n' - ).encode('latin-1'), - ( - '\n' - '\n \n FOO1\n \n' - ).encode('latin-1') + "json": [ + '[\n{"bar": "BAR"}\n]'.encode("utf-8"), + '[\n{"bar": "BAR1"}\n]'.encode("utf-8"), + ], + "xml": [ + ( + '\n' + "\n \n FOO\n \n" + ).encode("latin-1"), + ( + '\n' + "\n \n FOO1\n \n" + ).encode("latin-1"), + ], + "csv": [ + "foo,bar\r\nFOO,BAR\r\n".encode("utf-8"), + "foo,bar\r\nFOO1,BAR1\r\n".encode("utf-8"), ], - 'csv': ['foo,bar\r\nFOO,BAR\r\n'.encode('utf-8'), - 'foo,bar\r\nFOO1,BAR1\r\n'.encode('utf-8')], } settings = { - 'FEEDS': { - self._random_temp_filename() / 'json' / self._file_mark: { - 'format': 'json', - 'indent': 0, - 'fields': ['bar'], - 'encoding': 'utf-8', + "FEEDS": { + self._random_temp_filename() + / "json" + / self._file_mark: { + "format": "json", + "indent": 0, + "fields": ["bar"], + "encoding": "utf-8", }, - self._random_temp_filename() / 'xml' / self._file_mark: { - 'format': 'xml', - 'indent': 2, - 'fields': ['foo'], - 'encoding': 'latin-1', + self._random_temp_filename() + / "xml" + / self._file_mark: { + "format": "xml", + "indent": 2, + "fields": ["foo"], + "encoding": "latin-1", }, - self._random_temp_filename() / 'csv' / self._file_mark: { - 'format': 'csv', - 'indent': None, - 'fields': ['foo', 'bar'], - 'encoding': 'utf-8', + self._random_temp_filename() + / "csv" + / self._file_mark: { + "format": "csv", + "indent": None, + "fields": ["foo", "bar"], + "encoding": "utf-8", }, }, - 'FEED_EXPORT_BATCH_ITEM_COUNT': 1, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, } data = yield self.exported_data(items, settings) for fmt, expected in formats.items(): @@ -2259,18 +2353,22 @@ class BatchDeliveriesTest(FeedExportTestBase): @defer.inlineCallbacks def test_batch_item_count_feeds_setting(self): - items = [dict({'foo': 'FOO'}), dict({'foo': 'FOO1'})] + items = [dict({"foo": "FOO"}), dict({"foo": "FOO1"})] formats = { - 'json': ['[{"foo": "FOO"}]'.encode('utf-8'), - '[{"foo": "FOO1"}]'.encode('utf-8')], + "json": [ + '[{"foo": "FOO"}]'.encode("utf-8"), + '[{"foo": "FOO1"}]'.encode("utf-8"), + ], } settings = { - 'FEEDS': { - self._random_temp_filename() / 'json' / self._file_mark: { - 'format': 'json', - 'indent': None, - 'encoding': 'utf-8', - 'batch_item_count': 1, + "FEEDS": { + self._random_temp_filename() + / "json" + / self._file_mark: { + "format": "json", + "indent": None, + "encoding": "utf-8", + "batch_item_count": 1, }, }, } @@ -2279,7 +2377,9 @@ class BatchDeliveriesTest(FeedExportTestBase): for expected_batch, got_batch in zip(expected, data[fmt]): self.assertEqual(expected_batch, got_batch) - @pytest.mark.skipif(sys.platform == 'win32', reason='Odd behaviour on file creation/output') + @pytest.mark.skipif( + sys.platform == "win32", reason="Odd behaviour on file creation/output" + ) @defer.inlineCallbacks def test_batch_path_differ(self): """ @@ -2287,26 +2387,29 @@ class BatchDeliveriesTest(FeedExportTestBase): So %(batch_time)s replaced with the current date. """ items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem({'foo': 'bar2', 'egg': 'spam2', 'baz': 'quux2'}), - self.MyItem({'foo': 'bar3', 'baz': 'quux3'}), + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), ] settings = { - 'FEEDS': { - self._random_temp_filename() / '%(batch_time)s': { - 'format': 'json', + "FEEDS": { + self._random_temp_filename() + / "%(batch_time)s": { + "format": "json", }, }, - 'FEED_EXPORT_BATCH_ITEM_COUNT': 1, + "FEED_EXPORT_BATCH_ITEM_COUNT": 1, } data = yield self.exported_data(items, settings) - self.assertEqual(len(items), len([_ for _ in data['json'] if _])) + self.assertEqual(len(items), len([_ for _ in data["json"] if _])) @defer.inlineCallbacks def test_stats_batch_file_success(self): settings = { "FEEDS": { - build_url(str(self._random_temp_filename() / "json" / self._file_mark)): { + build_url( + str(self._random_temp_filename() / "json" / self._file_mark) + ): { "format": "json", } }, @@ -2315,18 +2418,22 @@ class BatchDeliveriesTest(FeedExportTestBase): crawler = get_crawler(ItemSpider, settings) with MockServer() as mockserver: yield crawler.crawl(total=2, mockserver=mockserver) - self.assertIn("feedexport/success_count/FileFeedStorage", crawler.stats.get_stats()) - self.assertEqual(crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 12) + self.assertIn( + "feedexport/success_count/FileFeedStorage", crawler.stats.get_stats() + ) + self.assertEqual( + crawler.stats.get_value("feedexport/success_count/FileFeedStorage"), 12 + ) @defer.inlineCallbacks def test_s3_export(self): skip_if_no_boto() - bucket = 'mybucket' + bucket = "mybucket" items = [ - self.MyItem({'foo': 'bar1', 'egg': 'spam1'}), - self.MyItem({'foo': 'bar2', 'egg': 'spam2', 'baz': 'quux2'}), - self.MyItem({'foo': 'bar3', 'baz': 'quux3'}), + self.MyItem({"foo": "bar1", "egg": "spam1"}), + self.MyItem({"foo": "bar2", "egg": "spam2", "baz": "quux2"}), + self.MyItem({"foo": "bar3", "baz": "quux3"}), ] class CustomS3FeedStorage(S3FeedStorage): @@ -2335,33 +2442,34 @@ class BatchDeliveriesTest(FeedExportTestBase): def open(self, *args, **kwargs): from botocore.stub import ANY, Stubber + stub = Stubber(self.s3_client) stub.activate() CustomS3FeedStorage.stubs.append(stub) stub.add_response( - 'put_object', + "put_object", expected_params={ - 'Body': ANY, - 'Bucket': bucket, - 'Key': ANY, + "Body": ANY, + "Bucket": bucket, + "Key": ANY, }, service_response={}, ) return super().open(*args, **kwargs) - key = 'export.csv' - uri = f's3://{bucket}/{key}/%(batch_time)s.json' + key = "export.csv" + uri = f"s3://{bucket}/{key}/%(batch_time)s.json" batch_item_count = 1 settings = { - 'AWS_ACCESS_KEY_ID': 'access_key', - 'AWS_SECRET_ACCESS_KEY': 'secret_key', - 'FEED_EXPORT_BATCH_ITEM_COUNT': batch_item_count, - 'FEED_STORAGES': { - 's3': CustomS3FeedStorage, + "AWS_ACCESS_KEY_ID": "access_key", + "AWS_SECRET_ACCESS_KEY": "secret_key", + "FEED_EXPORT_BATCH_ITEM_COUNT": batch_item_count, + "FEED_STORAGES": { + "s3": CustomS3FeedStorage, }, - 'FEEDS': { + "FEEDS": { uri: { - 'format': 'json', + "format": "json", }, }, } @@ -2370,14 +2478,14 @@ class BatchDeliveriesTest(FeedExportTestBase): verifyObject(IFeedStorage, storage) class TestSpider(scrapy.Spider): - name = 'testspider' + name = "testspider" def parse(self, response): for item in items: yield item with MockServer() as server: - TestSpider.start_urls = [server.url('/')] + TestSpider.start_urls = [server.url("/")] crawler = get_crawler(TestSpider, settings) yield crawler.crawl() @@ -2387,11 +2495,10 @@ class BatchDeliveriesTest(FeedExportTestBase): class FeedExportInitTest(unittest.TestCase): - def test_unsupported_storage(self): settings = { - 'FEEDS': { - 'unsupported://uri': {}, + "FEEDS": { + "unsupported://uri": {}, }, } crawler = get_crawler(settings_dict=settings) @@ -2400,9 +2507,9 @@ class FeedExportInitTest(unittest.TestCase): def test_unsupported_format(self): settings = { - 'FEEDS': { - 'file://path': { - 'format': 'unsupported_format', + "FEEDS": { + "file://path": { + "format": "unsupported_format", }, }, } @@ -2412,7 +2519,6 @@ class FeedExportInitTest(unittest.TestCase): class StdoutFeedStorageWithoutFeedOptions(StdoutFeedStorage): - def __init__(self, uri): super().__init__(uri) @@ -2424,25 +2530,26 @@ class StdoutFeedStoragePreFeedOptionsTest(unittest.TestCase): def test_init(self): settings_dict = { - 'FEED_URI': 'file:///tmp/foobar', - 'FEED_STORAGES': { - 'file': StdoutFeedStorageWithoutFeedOptions - }, + "FEED_URI": "file:///tmp/foobar", + "FEED_STORAGES": {"file": StdoutFeedStorageWithoutFeedOptions}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") - with pytest.warns(ScrapyDeprecationWarning, - match="StdoutFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="StdoutFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) class FileFeedStorageWithoutFeedOptions(FileFeedStorage): - def __init__(self, uri): super().__init__(uri) @@ -2457,31 +2564,31 @@ class FileFeedStoragePreFeedOptionsTest(unittest.TestCase): def test_init(self): with tempfile.NamedTemporaryFile() as temp: settings_dict = { - 'FEED_URI': f'file:///{temp.name}', - 'FEED_STORAGES': { - 'file': FileFeedStorageWithoutFeedOptions - }, + "FEED_URI": f"file:///{temp.name}", + "FEED_STORAGES": {"file": FileFeedStorageWithoutFeedOptions}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") - with pytest.warns(ScrapyDeprecationWarning, - match="FileFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="FileFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) class S3FeedStorageWithoutFeedOptions(S3FeedStorage): - def __init__(self, uri, access_key, secret_key, acl, endpoint_url, **kwargs): super().__init__(uri, access_key, secret_key, acl, endpoint_url, **kwargs) class S3FeedStorageWithoutFeedOptionsWithFromCrawler(S3FeedStorage): - @classmethod def from_crawler(cls, crawler, uri): return super().from_crawler(crawler, uri) @@ -2496,53 +2603,55 @@ class S3FeedStoragePreFeedOptionsTest(unittest.TestCase): def test_init(self): settings_dict = { - 'FEED_URI': 'file:///tmp/foobar', - 'FEED_STORAGES': { - 'file': S3FeedStorageWithoutFeedOptions - }, + "FEED_URI": "file:///tmp/foobar", + "FEED_STORAGES": {"file": S3FeedStorageWithoutFeedOptions}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") spider.crawler = crawler - with pytest.warns(ScrapyDeprecationWarning, - match="S3FeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="S3FeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) def test_from_crawler(self): settings_dict = { - 'FEED_URI': 'file:///tmp/foobar', - 'FEED_STORAGES': { - 'file': S3FeedStorageWithoutFeedOptionsWithFromCrawler - }, + "FEED_URI": "file:///tmp/foobar", + "FEED_STORAGES": {"file": S3FeedStorageWithoutFeedOptionsWithFromCrawler}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") spider.crawler = crawler - with pytest.warns(ScrapyDeprecationWarning, - match="S3FeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="S3FeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) class FTPFeedStorageWithoutFeedOptions(FTPFeedStorage): - def __init__(self, uri, use_active_mode=False): super().__init__(uri) class FTPFeedStorageWithoutFeedOptionsWithFromCrawler(FTPFeedStorage): - @classmethod def from_crawler(cls, crawler, uri): return super().from_crawler(crawler, uri) @@ -2557,42 +2666,46 @@ class FTPFeedStoragePreFeedOptionsTest(unittest.TestCase): def test_init(self): settings_dict = { - 'FEED_URI': 'file:///tmp/foobar', - 'FEED_STORAGES': { - 'file': FTPFeedStorageWithoutFeedOptions - }, + "FEED_URI": "file:///tmp/foobar", + "FEED_STORAGES": {"file": FTPFeedStorageWithoutFeedOptions}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") spider.crawler = crawler - with pytest.warns(ScrapyDeprecationWarning, - match="FTPFeedStorageWithoutFeedOptions does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="FTPFeedStorageWithoutFeedOptions does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) def test_from_crawler(self): settings_dict = { - 'FEED_URI': 'file:///tmp/foobar', - 'FEED_STORAGES': { - 'file': FTPFeedStorageWithoutFeedOptionsWithFromCrawler - }, + "FEED_URI": "file:///tmp/foobar", + "FEED_STORAGES": {"file": FTPFeedStorageWithoutFeedOptionsWithFromCrawler}, } - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings_dict) feed_exporter = FeedExporter.from_crawler(crawler) spider = scrapy.Spider("default") spider.crawler = crawler - with pytest.warns(ScrapyDeprecationWarning, - match="FTPFeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " - "the 'feed_options' keyword argument."): + with pytest.warns( + ScrapyDeprecationWarning, + match="FTPFeedStorageWithoutFeedOptionsWithFromCrawler.from_crawler does not support " + "the 'feed_options' keyword argument.", + ): feed_exporter.open_spider(spider) @@ -2601,13 +2714,15 @@ class URIParamsTest: spider_name = "uri_params_spider" deprecated_options = False - def build_settings(self, uri='file:///tmp/foobar', uri_params=None): + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): raise NotImplementedError def _crawler_feed_exporter(self, settings): if self.deprecated_options: - with pytest.warns(ScrapyDeprecationWarning, - match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated"): + with pytest.warns( + ScrapyDeprecationWarning, + match="The `FEED_URI` and `FEED_FORMAT` settings have been deprecated", + ): crawler = get_crawler(settings_dict=settings) feed_exporter = FeedExporter.from_crawler(crawler) else: @@ -2617,7 +2732,7 @@ class URIParamsTest: def test_default(self): settings = self.build_settings( - uri='file:///tmp/%(name)s', + uri="file:///tmp/%(name)s", ) crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) @@ -2627,38 +2742,33 @@ class URIParamsTest: warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - self.assertEqual( - feed_exporter.slots[0].uri, - f'file:///tmp/{self.spider_name}' - ) + self.assertEqual(feed_exporter.slots[0].uri, f"file:///tmp/{self.spider_name}") def test_none(self): def uri_params(params, spider): pass settings = self.build_settings( - uri='file:///tmp/%(name)s', + uri="file:///tmp/%(name)s", uri_params=uri_params, ) crawler, feed_exporter = self._crawler_feed_exporter(settings) spider = scrapy.Spider(self.spider_name) spider.crawler = crawler - with pytest.warns(ScrapyDeprecationWarning, - match="Modifying the params dictionary in-place"): + with pytest.warns( + ScrapyDeprecationWarning, match="Modifying the params dictionary in-place" + ): feed_exporter.open_spider(spider) - self.assertEqual( - feed_exporter.slots[0].uri, - f'file:///tmp/{self.spider_name}' - ) + self.assertEqual(feed_exporter.slots[0].uri, f"file:///tmp/{self.spider_name}") def test_empty_dict(self): def uri_params(params, spider): return {} settings = self.build_settings( - uri='file:///tmp/%(name)s', + uri="file:///tmp/%(name)s", uri_params=uri_params, ) crawler, feed_exporter = self._crawler_feed_exporter(settings) @@ -2675,7 +2785,7 @@ class URIParamsTest: return params settings = self.build_settings( - uri='file:///tmp/%(name)s', + uri="file:///tmp/%(name)s", uri_params=uri_params, ) crawler, feed_exporter = self._crawler_feed_exporter(settings) @@ -2685,17 +2795,14 @@ class URIParamsTest: warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - self.assertEqual( - feed_exporter.slots[0].uri, - f'file:///tmp/{self.spider_name}' - ) + self.assertEqual(feed_exporter.slots[0].uri, f"file:///tmp/{self.spider_name}") def test_custom_param(self): def uri_params(params, spider): - return {**params, 'foo': self.spider_name} + return {**params, "foo": self.spider_name} settings = self.build_settings( - uri='file:///tmp/%(foo)s', + uri="file:///tmp/%(foo)s", uri_params=uri_params, ) crawler, feed_exporter = self._crawler_feed_exporter(settings) @@ -2705,21 +2812,18 @@ class URIParamsTest: warnings.simplefilter("error", ScrapyDeprecationWarning) feed_exporter.open_spider(spider) - self.assertEqual( - feed_exporter.slots[0].uri, - f'file:///tmp/{self.spider_name}' - ) + self.assertEqual(feed_exporter.slots[0].uri, f"file:///tmp/{self.spider_name}") class URIParamsSettingTest(URIParamsTest, unittest.TestCase): deprecated_options = True - def build_settings(self, uri='file:///tmp/foobar', uri_params=None): + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): extra_settings = {} if uri_params: - extra_settings['FEED_URI_PARAMS'] = uri_params + extra_settings["FEED_URI_PARAMS"] = uri_params return { - 'FEED_URI': uri, + "FEED_URI": uri, **extra_settings, } @@ -2727,14 +2831,14 @@ class URIParamsSettingTest(URIParamsTest, unittest.TestCase): class URIParamsFeedOptionTest(URIParamsTest, unittest.TestCase): deprecated_options = False - def build_settings(self, uri='file:///tmp/foobar', uri_params=None): + def build_settings(self, uri="file:///tmp/foobar", uri_params=None): options = { - 'format': 'jl', + "format": "jl", } if uri_params: - options['uri_params'] = uri_params + options["uri_params"] = uri_params return { - 'FEEDS': { + "FEEDS": { uri: options, }, } diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index e461bcf2c..88345d2bc 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -9,7 +9,12 @@ from unittest import mock, skipIf from urllib.parse import urlencode from twisted.internet import reactor -from twisted.internet.defer import CancelledError, Deferred, DeferredList, inlineCallbacks +from twisted.internet.defer import ( + CancelledError, + Deferred, + DeferredList, + inlineCallbacks, +) from twisted.internet.endpoints import SSL4ClientEndpoint, SSL4ServerEndpoint from twisted.internet.error import TimeoutError from twisted.internet.ssl import optionsForClientTLS, PrivateCertificate, Certificate @@ -27,22 +32,19 @@ from tests.mockserver import ssl_context_factory, LeafResource, Status def generate_random_string(size): - return ''.join(random.choices( - string.ascii_uppercase + string.digits, - k=size - )) + return "".join(random.choices(string.ascii_uppercase + string.digits, k=size)) def make_html_body(val): - response = f''' + response = f"""

Hello from HTTP2

{val}

-''' - return bytes(response, 'utf-8') +""" + return bytes(response, "utf-8") class DummySpider(Spider): - name = 'dummy' + name = "dummy" start_urls: list = [] def parse(self, response): @@ -51,33 +53,33 @@ class DummySpider(Spider): class Data: SMALL_SIZE = 1024 # 1 KB - LARGE_SIZE = 1024 ** 2 # 1 MB + LARGE_SIZE = 1024**2 # 1 MB STR_SMALL = generate_random_string(SMALL_SIZE) STR_LARGE = generate_random_string(LARGE_SIZE) EXTRA_SMALL = generate_random_string(1024 * 15) - EXTRA_LARGE = generate_random_string((1024 ** 2) * 15) + EXTRA_LARGE = generate_random_string((1024**2) * 15) HTML_SMALL = make_html_body(STR_SMALL) HTML_LARGE = make_html_body(STR_LARGE) - JSON_SMALL = {'data': STR_SMALL} - JSON_LARGE = {'data': STR_LARGE} + JSON_SMALL = {"data": STR_SMALL} + JSON_LARGE = {"data": STR_LARGE} - DATALOSS = b'Dataloss Content' - NO_CONTENT_LENGTH = b'This response do not have any content-length header' + DATALOSS = b"Dataloss Content" + NO_CONTENT_LENGTH = b"This response do not have any content-length header" class GetDataHtmlSmall(LeafResource): def render_GET(self, request: TxRequest): - request.setHeader('Content-Type', 'text/html; charset=UTF-8') + request.setHeader("Content-Type", "text/html; charset=UTF-8") return Data.HTML_SMALL class GetDataHtmlLarge(LeafResource): def render_GET(self, request: TxRequest): - request.setHeader('Content-Type', 'text/html; charset=UTF-8') + request.setHeader("Content-Type", "text/html; charset=UTF-8") return Data.HTML_LARGE @@ -85,16 +87,16 @@ class PostDataJsonMixin: @staticmethod def make_response(request: TxRequest, extra_data: str): response = { - 'request-headers': {}, - 'request-body': json.loads(request.content.read()), - 'extra-data': extra_data + "request-headers": {}, + "request-body": json.loads(request.content.read()), + "extra-data": extra_data, } for k, v in request.requestHeaders.getAllRawHeaders(): - response['request-headers'][str(k, 'utf-8')] = str(v[0], 'utf-8') + response["request-headers"][str(k, "utf-8")] = str(v[0], "utf-8") - response_bytes = bytes(json.dumps(response), 'utf-8') - request.setHeader('Content-Type', 'application/json; charset=UTF-8') - request.setHeader('Content-Encoding', 'UTF-8') + response_bytes = bytes(json.dumps(response), "utf-8") + request.setHeader("Content-Type", "application/json; charset=UTF-8") + request.setHeader("Content-Encoding", "UTF-8") return response_bytes @@ -109,7 +111,6 @@ class PostDataJsonLarge(LeafResource, PostDataJsonMixin): class Dataloss(LeafResource): - def render_GET(self, request: TxRequest): request.setHeader(b"Content-Length", b"1024") self.deferRequest(request, 0, self._delayed_render, request) @@ -123,7 +124,7 @@ class Dataloss(LeafResource): class NoContentLengthHeader(LeafResource): def render_GET(self, request: TxRequest): - request.requestHeaders.removeHeader('Content-Length') + request.requestHeaders.removeHeader("Content-Length") self.deferRequest(request, 0, self._delayed_render, request) return NOT_DONE_YET @@ -140,57 +141,61 @@ class TimeoutResponse(LeafResource): class QueryParams(LeafResource): def render_GET(self, request: TxRequest): - request.setHeader('Content-Type', 'application/json; charset=UTF-8') - request.setHeader('Content-Encoding', 'UTF-8') + request.setHeader("Content-Type", "application/json; charset=UTF-8") + request.setHeader("Content-Encoding", "UTF-8") query_params = {} for k, v in request.args.items(): - query_params[str(k, 'utf-8')] = str(v[0], 'utf-8') + query_params[str(k, "utf-8")] = str(v[0], "utf-8") - return bytes(json.dumps(query_params), 'utf-8') + return bytes(json.dumps(query_params), "utf-8") class RequestHeaders(LeafResource): """Sends all the headers received as a response""" def render_GET(self, request: TxRequest): - request.setHeader('Content-Type', 'application/json; charset=UTF-8') - request.setHeader('Content-Encoding', 'UTF-8') + request.setHeader("Content-Type", "application/json; charset=UTF-8") + request.setHeader("Content-Encoding", "UTF-8") headers = {} for k, v in request.requestHeaders.getAllRawHeaders(): - headers[str(k, 'utf-8')] = str(v[0], 'utf-8') + headers[str(k, "utf-8")] = str(v[0], "utf-8") - return bytes(json.dumps(headers), 'utf-8') + return bytes(json.dumps(headers), "utf-8") -def get_client_certificate(key_file: Path, certificate_file: Path) -> PrivateCertificate: - pem = key_file.read_text(encoding="utf-8") + certificate_file.read_text(encoding="utf-8") +def get_client_certificate( + key_file: Path, certificate_file: Path +) -> PrivateCertificate: + pem = key_file.read_text(encoding="utf-8") + certificate_file.read_text( + encoding="utf-8" + ) return PrivateCertificate.loadPEM(pem) @skipIf(not H2_ENABLED, "HTTP/2 support in Twisted is not enabled") class Https2ClientProtocolTestCase(TestCase): - scheme = 'https' - key_file = Path(__file__).parent / 'keys' / 'localhost.key' - certificate_file = Path(__file__).parent / 'keys' / 'localhost.crt' + scheme = "https" + key_file = Path(__file__).parent / "keys" / "localhost.key" + certificate_file = Path(__file__).parent / "keys" / "localhost.crt" def _init_resource(self): self.temp_directory = self.mktemp() Path(self.temp_directory).mkdir() r = File(self.temp_directory) - r.putChild(b'get-data-html-small', GetDataHtmlSmall()) - r.putChild(b'get-data-html-large', GetDataHtmlLarge()) + r.putChild(b"get-data-html-small", GetDataHtmlSmall()) + r.putChild(b"get-data-html-large", GetDataHtmlLarge()) - r.putChild(b'post-data-json-small', PostDataJsonSmall()) - r.putChild(b'post-data-json-large', PostDataJsonLarge()) + r.putChild(b"post-data-json-small", PostDataJsonSmall()) + r.putChild(b"post-data-json-large", PostDataJsonLarge()) - r.putChild(b'dataloss', Dataloss()) - r.putChild(b'no-content-length-header', NoContentLengthHeader()) - r.putChild(b'status', Status()) - r.putChild(b'query-params', QueryParams()) - r.putChild(b'timeout', TimeoutResponse()) - r.putChild(b'request-headers', RequestHeaders()) + r.putChild(b"dataloss", Dataloss()) + r.putChild(b"no-content-length-header", NoContentLengthHeader()) + r.putChild(b"status", Status()) + r.putChild(b"query-params", QueryParams()) + r.putChild(b"timeout", TimeoutResponse()) + r.putChild(b"request-headers", RequestHeaders()) return r @inlineCallbacks @@ -200,26 +205,35 @@ class Https2ClientProtocolTestCase(TestCase): self.site = Site(root, timeout=None) # Start server for testing - self.hostname = 'localhost' - context_factory = ssl_context_factory(str(self.key_file), str(self.certificate_file)) + self.hostname = "localhost" + context_factory = ssl_context_factory( + str(self.key_file), str(self.certificate_file) + ) - server_endpoint = SSL4ServerEndpoint(reactor, 0, context_factory, interface=self.hostname) + server_endpoint = SSL4ServerEndpoint( + reactor, 0, context_factory, interface=self.hostname + ) self.server = yield server_endpoint.listen(self.site) self.port_number = self.server.getHost().port # Connect H2 client with server - self.client_certificate = get_client_certificate(self.key_file, self.certificate_file) + self.client_certificate = get_client_certificate( + self.key_file, self.certificate_file + ) client_options = optionsForClientTLS( hostname=self.hostname, trustRoot=self.client_certificate, - acceptableProtocols=[b'h2'] + acceptableProtocols=[b"h2"], ) - uri = URI.fromBytes(bytes(self.get_url('/'), 'utf-8')) + uri = URI.fromBytes(bytes(self.get_url("/"), "utf-8")) self.conn_closed_deferred = Deferred() from scrapy.core.http2.protocol import H2ClientFactory + h2_client_factory = H2ClientFactory(uri, Settings(), self.conn_closed_deferred) - client_endpoint = SSL4ClientEndpoint(reactor, self.hostname, self.port_number, client_options) + client_endpoint = SSL4ClientEndpoint( + reactor, self.hostname, self.port_number, client_options + ) self.client = yield client_endpoint.connect(h2_client_factory) @inlineCallbacks @@ -236,8 +250,8 @@ class Https2ClientProtocolTestCase(TestCase): :param path: Should have / at the starting compulsorily if not empty :return: Complete url """ - assert len(path) > 0 and (path[0] == '/' or path[0] == '&') - return f'{self.scheme}://{self.hostname}:{self.port_number}{path}' + assert len(path) > 0 and (path[0] == "/" or path[0] == "&") + return f"{self.scheme}://{self.hostname}:{self.port_number}{path}" def make_request(self, request: Request) -> Deferred: return self.client.request(request, DummySpider()) @@ -251,18 +265,13 @@ class Https2ClientProtocolTestCase(TestCase): return DeferredList(d_list, fireOnOneErrback=True) - def _check_GET( - self, - request: Request, - expected_body, - expected_status - ): + def _check_GET(self, request: Request, expected_body, expected_status): def check_response(response: Response): self.assertEqual(response.status, expected_status) self.assertEqual(response.body, expected_body) self.assertEqual(response.request, request) - content_length = int(response.headers.get('Content-Length')) + content_length = int(response.headers.get("Content-Length")) self.assertEqual(len(response.body), content_length) d = self.make_request(request) @@ -271,11 +280,11 @@ class Https2ClientProtocolTestCase(TestCase): return d def test_GET_small_body(self): - request = Request(self.get_url('/get-data-html-small')) + request = Request(self.get_url("/get-data-html-small")) return self._check_GET(request, Data.HTML_SMALL, 200) def test_GET_large_body(self): - request = Request(self.get_url('/get-data-html-large')) + request = Request(self.get_url("/get-data-html-large")) return self._check_GET(request, Data.HTML_LARGE, 200) def _check_GET_x10(self, *args, **kwargs): @@ -286,16 +295,12 @@ class Https2ClientProtocolTestCase(TestCase): def test_GET_small_body_x10(self): return self._check_GET_x10( - Request(self.get_url('/get-data-html-small')), - Data.HTML_SMALL, - 200 + Request(self.get_url("/get-data-html-small")), Data.HTML_SMALL, 200 ) def test_GET_large_body_x10(self): return self._check_GET_x10( - Request(self.get_url('/get-data-html-large')), - Data.HTML_LARGE, - 200 + Request(self.get_url("/get-data-html-large")), Data.HTML_LARGE, 200 ) def _check_POST_json( @@ -303,7 +308,7 @@ class Https2ClientProtocolTestCase(TestCase): request: Request, expected_request_body, expected_extra_data, - expected_status: int + expected_status: int, ): d = self.make_request(request) @@ -311,50 +316,48 @@ class Https2ClientProtocolTestCase(TestCase): self.assertEqual(response.status, expected_status) self.assertEqual(response.request, request) - content_length = int(response.headers.get('Content-Length')) + content_length = int(response.headers.get("Content-Length")) self.assertEqual(len(response.body), content_length) # Parse the body - content_encoding = str(response.headers[b'Content-Encoding'], 'utf-8') + content_encoding = str(response.headers[b"Content-Encoding"], "utf-8") body = json.loads(str(response.body, content_encoding)) - self.assertIn('request-body', body) - self.assertIn('extra-data', body) - self.assertIn('request-headers', body) + self.assertIn("request-body", body) + self.assertIn("extra-data", body) + self.assertIn("request-headers", body) - request_body = body['request-body'] + request_body = body["request-body"] self.assertEqual(request_body, expected_request_body) - extra_data = body['extra-data'] + extra_data = body["extra-data"] self.assertEqual(extra_data, expected_extra_data) # Check if headers were sent successfully - request_headers = body['request-headers'] + request_headers = body["request-headers"] for k, v in request.headers.items(): - k_str = str(k, 'utf-8') + k_str = str(k, "utf-8") self.assertIn(k_str, request_headers) - self.assertEqual(request_headers[k_str], str(v[0], 'utf-8')) + self.assertEqual(request_headers[k_str], str(v[0], "utf-8")) d.addCallback(assert_response) d.addErrback(self.fail) return d def test_POST_small_json(self): - request = JsonRequest(url=self.get_url('/post-data-json-small'), method='POST', data=Data.JSON_SMALL) - return self._check_POST_json( - request, - Data.JSON_SMALL, - Data.EXTRA_SMALL, - 200 + request = JsonRequest( + url=self.get_url("/post-data-json-small"), + method="POST", + data=Data.JSON_SMALL, ) + return self._check_POST_json(request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200) def test_POST_large_json(self): - request = JsonRequest(url=self.get_url('/post-data-json-large'), method='POST', data=Data.JSON_LARGE) - return self._check_POST_json( - request, - Data.JSON_LARGE, - Data.EXTRA_LARGE, - 200 + request = JsonRequest( + url=self.get_url("/post-data-json-large"), + method="POST", + data=Data.JSON_LARGE, ) + return self._check_POST_json(request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200) def _check_POST_json_x10(self, *args, **kwargs): def get_deferred(): @@ -363,32 +366,36 @@ class Https2ClientProtocolTestCase(TestCase): return self._check_repeat(get_deferred, 10) def test_POST_small_json_x10(self): - request = JsonRequest(url=self.get_url('/post-data-json-small'), method='POST', data=Data.JSON_SMALL) + request = JsonRequest( + url=self.get_url("/post-data-json-small"), + method="POST", + data=Data.JSON_SMALL, + ) return self._check_POST_json_x10( - request, - Data.JSON_SMALL, - Data.EXTRA_SMALL, - 200 + request, Data.JSON_SMALL, Data.EXTRA_SMALL, 200 ) def test_POST_large_json_x10(self): - request = JsonRequest(url=self.get_url('/post-data-json-large'), method='POST', data=Data.JSON_LARGE) + request = JsonRequest( + url=self.get_url("/post-data-json-large"), + method="POST", + data=Data.JSON_LARGE, + ) return self._check_POST_json_x10( - request, - Data.JSON_LARGE, - Data.EXTRA_LARGE, - 200 + request, Data.JSON_LARGE, Data.EXTRA_LARGE, 200 ) @inlineCallbacks def test_invalid_negotiated_protocol(self): - with mock.patch("scrapy.core.http2.protocol.PROTOCOL_NAME", return_value=b"not-h2"): - request = Request(url=self.get_url('/status?n=200')) + with mock.patch( + "scrapy.core.http2.protocol.PROTOCOL_NAME", return_value=b"not-h2" + ): + request = Request(url=self.get_url("/status?n=200")) with self.assertRaises(ResponseFailed): yield self.make_request(request) def test_cancel_request(self): - request = Request(url=self.get_url('/get-data-html-large')) + request = Request(url=self.get_url("/get-data-html-large")) def assert_response(response: Response): self.assertEqual(response.status, 499) @@ -402,13 +409,15 @@ class Https2ClientProtocolTestCase(TestCase): return d def test_download_maxsize_exceeded(self): - request = Request(url=self.get_url('/get-data-html-large'), meta={'download_maxsize': 1000}) + request = Request( + url=self.get_url("/get-data-html-large"), meta={"download_maxsize": 1000} + ) def assert_cancelled_error(failure): self.assertIsInstance(failure.value, CancelledError) error_pattern = re.compile( - rf'Cancelling download of {request.url}: received response ' - rf'size \(\d*\) larger than download max size \(1000\)' + rf"Cancelling download of {request.url}: received response " + rf"size \(\d*\) larger than download max size \(1000\)" ) self.assertEqual(len(re.findall(error_pattern, str(failure.value))), 1) @@ -420,15 +429,18 @@ class Https2ClientProtocolTestCase(TestCase): def test_received_dataloss_response(self): """In case when value of Header Content-Length != len(Received Data) ProtocolError is raised""" - request = Request(url=self.get_url('/dataloss')) + request = Request(url=self.get_url("/dataloss")) def assert_failure(failure: Failure): self.assertTrue(len(failure.value.reasons) > 0) from h2.exceptions import InvalidBodyLengthError - self.assertTrue(any( - isinstance(error, InvalidBodyLengthError) - for error in failure.value.reasons - )) + + self.assertTrue( + any( + isinstance(error, InvalidBodyLengthError) + for error in failure.value.reasons + ) + ) d = self.make_request(request) d.addCallback(self.fail) @@ -436,13 +448,13 @@ class Https2ClientProtocolTestCase(TestCase): return d def test_missing_content_length_header(self): - request = Request(url=self.get_url('/no-content-length-header')) + request = Request(url=self.get_url("/no-content-length-header")) def assert_content_length(response: Response): self.assertEqual(response.status, 200) self.assertEqual(response.body, Data.NO_CONTENT_LENGTH) self.assertEqual(response.request, request) - self.assertNotIn('Content-Length', response.headers) + self.assertNotIn("Content-Length", response.headers) d = self.make_request(request) d.addCallback(assert_content_length) @@ -450,40 +462,39 @@ class Https2ClientProtocolTestCase(TestCase): return d @inlineCallbacks - def _check_log_warnsize( - self, - request, - warn_pattern, - expected_body - ): - with self.assertLogs('scrapy.core.http2.stream', level='WARNING') as cm: + def _check_log_warnsize(self, request, warn_pattern, expected_body): + with self.assertLogs("scrapy.core.http2.stream", level="WARNING") as cm: response = yield self.make_request(request) self.assertEqual(response.status, 200) self.assertEqual(response.request, request) self.assertEqual(response.body, expected_body) # Check the warning is raised only once for this request - self.assertEqual(sum( - len(re.findall(warn_pattern, log)) - for log in cm.output - ), 1) + self.assertEqual( + sum(len(re.findall(warn_pattern, log)) for log in cm.output), 1 + ) @inlineCallbacks def test_log_expected_warnsize(self): - request = Request(url=self.get_url('/get-data-html-large'), meta={'download_warnsize': 1000}) + request = Request( + url=self.get_url("/get-data-html-large"), meta={"download_warnsize": 1000} + ) warn_pattern = re.compile( - rf'Expected response size \(\d*\) larger than ' - rf'download warn size \(1000\) in request {request}' + rf"Expected response size \(\d*\) larger than " + rf"download warn size \(1000\) in request {request}" ) yield self._check_log_warnsize(request, warn_pattern, Data.HTML_LARGE) @inlineCallbacks def test_log_received_warnsize(self): - request = Request(url=self.get_url('/no-content-length-header'), meta={'download_warnsize': 10}) + request = Request( + url=self.get_url("/no-content-length-header"), + meta={"download_warnsize": 10}, + ) warn_pattern = re.compile( - rf'Received more \(\d*\) bytes than download ' - rf'warn size \(10\) in request {request}' + rf"Received more \(\d*\) bytes than download " + rf"warn size \(10\) in request {request}" ) yield self._check_log_warnsize(request, warn_pattern, Data.NO_CONTENT_LENGTH) @@ -495,9 +506,7 @@ class Https2ClientProtocolTestCase(TestCase): def get_deferred(): return self._check_GET( - Request(self.get_url('/get-data-html-small')), - Data.HTML_SMALL, - 200 + Request(self.get_url("/get-data-html-small")), Data.HTML_SMALL, 200 ) return self._check_repeat(get_deferred, 500) @@ -511,20 +520,20 @@ class Https2ClientProtocolTestCase(TestCase): def assert_inactive_stream(failure): self.assertIsNotNone(failure.check(ResponseFailed)) from scrapy.core.http2.stream import InactiveStreamClosed - self.assertTrue(any( - isinstance(e, InactiveStreamClosed) - for e in failure.value.reasons - )) + + self.assertTrue( + any(isinstance(e, InactiveStreamClosed) for e in failure.value.reasons) + ) # Send 100 request (we do not check the result) for _ in range(100): - d = self.make_request(Request(self.get_url('/get-data-html-small'))) + d = self.make_request(Request(self.get_url("/get-data-html-small"))) d.addBoth(lambda _: None) d_list.append(d) # Now send 10 extra request and save the response deferred in a list for _ in range(10): - d = self.make_request(Request(self.get_url('/get-data-html-small'))) + d = self.make_request(Request(self.get_url("/get-data-html-small"))) d.addCallback(self.fail) d.addErrback(assert_inactive_stream) d_list.append(d) @@ -537,19 +546,19 @@ class Https2ClientProtocolTestCase(TestCase): def test_invalid_request_type(self): with self.assertRaises(TypeError): - self.make_request('https://InvalidDataTypePassed.com') + self.make_request("https://InvalidDataTypePassed.com") def test_query_parameters(self): params = { - 'a': generate_random_string(20), - 'b': generate_random_string(20), - 'c': generate_random_string(20), - 'd': generate_random_string(20) + "a": generate_random_string(20), + "b": generate_random_string(20), + "c": generate_random_string(20), + "d": generate_random_string(20), } - request = Request(self.get_url(f'/query-params?{urlencode(params)}')) + request = Request(self.get_url(f"/query-params?{urlencode(params)}")) def assert_query_params(response: Response): - content_encoding = str(response.headers[b'Content-Encoding'], 'utf-8') + content_encoding = str(response.headers[b"Content-Encoding"], "utf-8") data = json.loads(str(response.body, content_encoding)) self.assertEqual(data, params) @@ -565,7 +574,7 @@ class Https2ClientProtocolTestCase(TestCase): d_list = [] for status in [200, 404]: - request = Request(self.get_url(f'/status?n={status}')) + request = Request(self.get_url(f"/status?n={status}")) d = self.make_request(request) d.addCallback(assert_response_status, status) d.addErrback(self.fail) @@ -574,17 +583,23 @@ class Https2ClientProtocolTestCase(TestCase): return DeferredList(d_list, fireOnOneErrback=True) def test_response_has_correct_certificate_ip_address(self): - request = Request(self.get_url('/status?n=200')) + request = Request(self.get_url("/status?n=200")) def assert_metadata(response: Response): self.assertEqual(response.request, request) self.assertIsInstance(response.certificate, Certificate) self.assertIsNotNone(response.certificate.original) - self.assertEqual(response.certificate.getIssuer(), self.client_certificate.getIssuer()) - self.assertTrue(response.certificate.getPublicKey().matches(self.client_certificate.getPublicKey())) + self.assertEqual( + response.certificate.getIssuer(), self.client_certificate.getIssuer() + ) + self.assertTrue( + response.certificate.getPublicKey().matches( + self.client_certificate.getPublicKey() + ) + ) self.assertIsInstance(response.ip_address, IPv4Address) - self.assertEqual(str(response.ip_address), '127.0.0.1') + self.assertEqual(str(response.ip_address), "127.0.0.1") d = self.make_request(request) d.addCallback(assert_metadata) @@ -597,10 +612,11 @@ class Https2ClientProtocolTestCase(TestCase): def assert_invalid_hostname(failure: Failure): from scrapy.core.http2.stream import InvalidHostname + self.assertIsNotNone(failure.check(InvalidHostname)) error_msg = str(failure.value) - self.assertIn('localhost', error_msg) - self.assertIn('127.0.0.1', error_msg) + self.assertIn("localhost", error_msg) + self.assertIn("127.0.0.1", error_msg) self.assertIn(str(request), error_msg) d = self.make_request(request) @@ -609,24 +625,24 @@ class Https2ClientProtocolTestCase(TestCase): return d def test_invalid_hostname(self): - return self._check_invalid_netloc('https://notlocalhost.notlocalhostdomain') + return self._check_invalid_netloc("https://notlocalhost.notlocalhostdomain") def test_invalid_host_port(self): port = self.port_number + 1 - return self._check_invalid_netloc(f'https://127.0.0.1:{port}') + return self._check_invalid_netloc(f"https://127.0.0.1:{port}") def test_connection_stays_with_invalid_requests(self): d_list = [ self.test_invalid_hostname(), self.test_invalid_host_port(), self.test_GET_small_body(), - self.test_POST_small_json() + self.test_POST_small_json(), ] return DeferredList(d_list, fireOnOneErrback=True) def test_connection_timeout(self): - request = Request(self.get_url('/timeout')) + request = Request(self.get_url("/timeout")) d = self.make_request(request) # Update the timer to 1s to test connection timeout @@ -635,8 +651,12 @@ class Https2ClientProtocolTestCase(TestCase): def assert_timeout_error(failure: Failure): for err in failure.value.reasons: from scrapy.core.http2.protocol import H2ClientProtocol + if isinstance(err, TimeoutError): - self.assertIn(f"Connection was IDLE for more than {H2ClientProtocol.IDLE_TIMEOUT}s", str(err)) + self.assertIn( + f"Connection was IDLE for more than {H2ClientProtocol.IDLE_TIMEOUT}s", + str(err), + ) break else: self.fail() @@ -646,20 +666,20 @@ class Https2ClientProtocolTestCase(TestCase): return d def test_request_headers_received(self): - request = Request(self.get_url('/request-headers'), headers={ - 'header-1': 'header value 1', - 'header-2': 'header value 2' - }) + request = Request( + self.get_url("/request-headers"), + headers={"header-1": "header value 1", "header-2": "header value 2"}, + ) d = self.make_request(request) def assert_request_headers(response: Response): self.assertEqual(response.status, 200) self.assertEqual(response.request, request) - response_headers = json.loads(str(response.body, 'utf-8')) + response_headers = json.loads(str(response.body, "utf-8")) self.assertIsInstance(response_headers, dict) for k, v in request.headers.items(): - k, v = str(k, 'utf-8'), str(v[0], 'utf-8') + k, v = str(k, "utf-8"), str(v[0], "utf-8") self.assertIn(k, response_headers) self.assertEqual(v, response_headers[k]) diff --git a/tests/test_http_cookies.py b/tests/test_http_cookies.py index 08420332c..ea42cadcd 100644 --- a/tests/test_http_cookies.py +++ b/tests/test_http_cookies.py @@ -6,10 +6,10 @@ from scrapy.http.cookies import WrappedRequest, WrappedResponse class WrappedRequestTest(TestCase): - def setUp(self): - self.request = Request("http://www.example.com/page.html", - headers={"Content-Type": "text/html"}) + self.request = Request( + "http://www.example.com/page.html", headers={"Content-Type": "text/html"} + ) self.wrapped = WrappedRequest(self.request) def test_get_full_url(self): @@ -29,35 +29,34 @@ class WrappedRequestTest(TestCase): self.assertFalse(self.wrapped.unverifiable) def test_is_unverifiable2(self): - self.request.meta['is_unverifiable'] = True + self.request.meta["is_unverifiable"] = True self.assertTrue(self.wrapped.is_unverifiable()) self.assertTrue(self.wrapped.unverifiable) def test_get_origin_req_host(self): - self.assertEqual(self.wrapped.origin_req_host, 'www.example.com') + self.assertEqual(self.wrapped.origin_req_host, "www.example.com") def test_has_header(self): - self.assertTrue(self.wrapped.has_header('content-type')) - self.assertFalse(self.wrapped.has_header('xxxxx')) + self.assertTrue(self.wrapped.has_header("content-type")) + self.assertFalse(self.wrapped.has_header("xxxxx")) def test_get_header(self): - self.assertEqual(self.wrapped.get_header('content-type'), 'text/html') - self.assertEqual(self.wrapped.get_header('xxxxx', 'def'), 'def') + self.assertEqual(self.wrapped.get_header("content-type"), "text/html") + self.assertEqual(self.wrapped.get_header("xxxxx", "def"), "def") def test_header_items(self): - self.assertEqual(self.wrapped.header_items(), - [('Content-Type', ['text/html'])]) + self.assertEqual(self.wrapped.header_items(), [("Content-Type", ["text/html"])]) def test_add_unredirected_header(self): - self.wrapped.add_unredirected_header('hello', 'world') - self.assertEqual(self.request.headers['hello'], b'world') + self.wrapped.add_unredirected_header("hello", "world") + self.assertEqual(self.request.headers["hello"], b"world") class WrappedResponseTest(TestCase): - def setUp(self): - self.response = Response("http://www.example.com/page.html", - headers={"Content-TYpe": "text/html"}) + self.response = Response( + "http://www.example.com/page.html", headers={"Content-TYpe": "text/html"} + ) self.wrapped = WrappedResponse(self.response) def test_info(self): @@ -65,4 +64,4 @@ class WrappedResponseTest(TestCase): def test_get_all(self): # get_all result must be native string - self.assertEqual(self.wrapped.get_all('content-type'), ['text/html']) + self.assertEqual(self.wrapped.get_all("content-type"), ["text/html"]) diff --git a/tests/test_http_headers.py b/tests/test_http_headers.py index 1ca936247..566bb302d 100644 --- a/tests/test_http_headers.py +++ b/tests/test_http_headers.py @@ -5,38 +5,39 @@ from scrapy.http import Headers class HeadersTest(unittest.TestCase): - def assertSortedEqual(self, first, second, msg=None): return self.assertEqual(sorted(first), sorted(second), msg) def test_basics(self): - h = Headers({'Content-Type': 'text/html', 'Content-Length': 1234}) - assert h['Content-Type'] - assert h['Content-Length'] + h = Headers({"Content-Type": "text/html", "Content-Length": 1234}) + assert h["Content-Type"] + assert h["Content-Length"] - self.assertRaises(KeyError, h.__getitem__, 'Accept') - self.assertEqual(h.get('Accept'), None) - self.assertEqual(h.getlist('Accept'), []) + self.assertRaises(KeyError, h.__getitem__, "Accept") + self.assertEqual(h.get("Accept"), None) + self.assertEqual(h.getlist("Accept"), []) - self.assertEqual(h.get('Accept', '*/*'), b'*/*') - self.assertEqual(h.getlist('Accept', '*/*'), [b'*/*']) - self.assertEqual(h.getlist('Accept', ['text/html', 'images/jpeg']), - [b'text/html', b'images/jpeg']) + self.assertEqual(h.get("Accept", "*/*"), b"*/*") + self.assertEqual(h.getlist("Accept", "*/*"), [b"*/*"]) + self.assertEqual( + h.getlist("Accept", ["text/html", "images/jpeg"]), + [b"text/html", b"images/jpeg"], + ) def test_single_value(self): h = Headers() - h['Content-Type'] = 'text/html' - self.assertEqual(h['Content-Type'], b'text/html') - self.assertEqual(h.get('Content-Type'), b'text/html') - self.assertEqual(h.getlist('Content-Type'), [b'text/html']) + h["Content-Type"] = "text/html" + self.assertEqual(h["Content-Type"], b"text/html") + self.assertEqual(h.get("Content-Type"), b"text/html") + self.assertEqual(h.getlist("Content-Type"), [b"text/html"]) def test_multivalue(self): h = Headers() - h['X-Forwarded-For'] = hlist = ['ip1', 'ip2'] - self.assertEqual(h['X-Forwarded-For'], b'ip2') - self.assertEqual(h.get('X-Forwarded-For'), b'ip2') - self.assertEqual(h.getlist('X-Forwarded-For'), [b'ip1', b'ip2']) - assert h.getlist('X-Forwarded-For') is not hlist + h["X-Forwarded-For"] = hlist = ["ip1", "ip2"] + self.assertEqual(h["X-Forwarded-For"], b"ip2") + self.assertEqual(h.get("X-Forwarded-For"), b"ip2") + self.assertEqual(h.getlist("X-Forwarded-For"), [b"ip1", b"ip2"]) + assert h.getlist("X-Forwarded-For") is not hlist def test_multivalue_for_one_header(self): h = Headers((("a", "b"), ("a", "c"))) @@ -45,117 +46,121 @@ class HeadersTest(unittest.TestCase): self.assertEqual(h.getlist("a"), [b"b", b"c"]) def test_encode_utf8(self): - h = Headers({'key': '\xa3'}, encoding='utf-8') + h = Headers({"key": "\xa3"}, encoding="utf-8") key, val = dict(h).popitem() assert isinstance(key, bytes), key assert isinstance(val[0], bytes), val[0] - self.assertEqual(val[0], b'\xc2\xa3') + self.assertEqual(val[0], b"\xc2\xa3") def test_encode_latin1(self): - h = Headers({'key': '\xa3'}, encoding='latin1') + h = Headers({"key": "\xa3"}, encoding="latin1") key, val = dict(h).popitem() - self.assertEqual(val[0], b'\xa3') + self.assertEqual(val[0], b"\xa3") def test_encode_multiple(self): - h = Headers({'key': ['\xa3']}, encoding='utf-8') + h = Headers({"key": ["\xa3"]}, encoding="utf-8") key, val = dict(h).popitem() - self.assertEqual(val[0], b'\xc2\xa3') + self.assertEqual(val[0], b"\xc2\xa3") def test_delete_and_contains(self): h = Headers() - h['Content-Type'] = 'text/html' - assert 'Content-Type' in h - del h['Content-Type'] - assert 'Content-Type' not in h + h["Content-Type"] = "text/html" + assert "Content-Type" in h + del h["Content-Type"] + assert "Content-Type" not in h def test_setdefault(self): h = Headers() - hlist = ['ip1', 'ip2'] - olist = h.setdefault('X-Forwarded-For', hlist) - assert h.getlist('X-Forwarded-For') is not hlist - assert h.getlist('X-Forwarded-For') is olist + hlist = ["ip1", "ip2"] + olist = h.setdefault("X-Forwarded-For", hlist) + assert h.getlist("X-Forwarded-For") is not hlist + assert h.getlist("X-Forwarded-For") is olist h = Headers() - olist = h.setdefault('X-Forwarded-For', 'ip1') - self.assertEqual(h.getlist('X-Forwarded-For'), [b'ip1']) - assert h.getlist('X-Forwarded-For') is olist + olist = h.setdefault("X-Forwarded-For", "ip1") + self.assertEqual(h.getlist("X-Forwarded-For"), [b"ip1"]) + assert h.getlist("X-Forwarded-For") is olist def test_iterables(self): - idict = {'Content-Type': 'text/html', 'X-Forwarded-For': ['ip1', 'ip2']} + idict = {"Content-Type": "text/html", "X-Forwarded-For": ["ip1", "ip2"]} h = Headers(idict) - self.assertDictEqual(dict(h), - {b'Content-Type': [b'text/html'], - b'X-Forwarded-For': [b'ip1', b'ip2']}) - self.assertSortedEqual(h.keys(), - [b'X-Forwarded-For', b'Content-Type']) - self.assertSortedEqual(h.items(), - [(b'X-Forwarded-For', [b'ip1', b'ip2']), - (b'Content-Type', [b'text/html'])]) - self.assertSortedEqual(h.values(), [b'ip2', b'text/html']) + self.assertDictEqual( + dict(h), + {b"Content-Type": [b"text/html"], b"X-Forwarded-For": [b"ip1", b"ip2"]}, + ) + self.assertSortedEqual(h.keys(), [b"X-Forwarded-For", b"Content-Type"]) + self.assertSortedEqual( + h.items(), + [(b"X-Forwarded-For", [b"ip1", b"ip2"]), (b"Content-Type", [b"text/html"])], + ) + self.assertSortedEqual(h.values(), [b"ip2", b"text/html"]) def test_update(self): h = Headers() - h.update({'Content-Type': 'text/html', - 'X-Forwarded-For': ['ip1', 'ip2']}) - self.assertEqual(h.getlist('Content-Type'), [b'text/html']) - self.assertEqual(h.getlist('X-Forwarded-For'), [b'ip1', b'ip2']) + h.update({"Content-Type": "text/html", "X-Forwarded-For": ["ip1", "ip2"]}) + self.assertEqual(h.getlist("Content-Type"), [b"text/html"]) + self.assertEqual(h.getlist("X-Forwarded-For"), [b"ip1", b"ip2"]) def test_copy(self): - h1 = Headers({'header1': ['value1', 'value2']}) + h1 = Headers({"header1": ["value1", "value2"]}) h2 = copy.copy(h1) self.assertEqual(h1, h2) - self.assertEqual(h1.getlist('header1'), h2.getlist('header1')) - assert h1.getlist('header1') is not h2.getlist('header1') + self.assertEqual(h1.getlist("header1"), h2.getlist("header1")) + assert h1.getlist("header1") is not h2.getlist("header1") assert isinstance(h2, Headers) def test_appendlist(self): - h1 = Headers({'header1': 'value1'}) - h1.appendlist('header1', 'value3') - self.assertEqual(h1.getlist('header1'), [b'value1', b'value3']) + h1 = Headers({"header1": "value1"}) + h1.appendlist("header1", "value3") + self.assertEqual(h1.getlist("header1"), [b"value1", b"value3"]) h1 = Headers() - h1.appendlist('header1', 'value1') - h1.appendlist('header1', 'value3') - self.assertEqual(h1.getlist('header1'), [b'value1', b'value3']) + h1.appendlist("header1", "value1") + h1.appendlist("header1", "value3") + self.assertEqual(h1.getlist("header1"), [b"value1", b"value3"]) def test_setlist(self): - h1 = Headers({'header1': 'value1'}) - self.assertEqual(h1.getlist('header1'), [b'value1']) - h1.setlist('header1', [b'value2', b'value3']) - self.assertEqual(h1.getlist('header1'), [b'value2', b'value3']) + h1 = Headers({"header1": "value1"}) + self.assertEqual(h1.getlist("header1"), [b"value1"]) + h1.setlist("header1", [b"value2", b"value3"]) + self.assertEqual(h1.getlist("header1"), [b"value2", b"value3"]) def test_setlistdefault(self): - h1 = Headers({'header1': 'value1'}) - h1.setlistdefault('header1', ['value2', 'value3']) - h1.setlistdefault('header2', ['value2', 'value3']) - self.assertEqual(h1.getlist('header1'), [b'value1']) - self.assertEqual(h1.getlist('header2'), [b'value2', b'value3']) + h1 = Headers({"header1": "value1"}) + h1.setlistdefault("header1", ["value2", "value3"]) + h1.setlistdefault("header2", ["value2", "value3"]) + self.assertEqual(h1.getlist("header1"), [b"value1"]) + self.assertEqual(h1.getlist("header2"), [b"value2", b"value3"]) def test_none_value(self): h1 = Headers() - h1['foo'] = 'bar' - h1['foo'] = None - h1.setdefault('foo', 'bar') - self.assertEqual(h1.get('foo'), None) - self.assertEqual(h1.getlist('foo'), []) + h1["foo"] = "bar" + h1["foo"] = None + h1.setdefault("foo", "bar") + self.assertEqual(h1.get("foo"), None) + self.assertEqual(h1.getlist("foo"), []) def test_int_value(self): - h1 = Headers({'hey': 5}) - h1['foo'] = 1 - h1.setdefault('bar', 2) - h1.setlist('buz', [1, 'dos', 3]) - self.assertEqual(h1.getlist('foo'), [b'1']) - self.assertEqual(h1.getlist('bar'), [b'2']) - self.assertEqual(h1.getlist('buz'), [b'1', b'dos', b'3']) - self.assertEqual(h1.getlist('hey'), [b'5']) + h1 = Headers({"hey": 5}) + h1["foo"] = 1 + h1.setdefault("bar", 2) + h1.setlist("buz", [1, "dos", 3]) + self.assertEqual(h1.getlist("foo"), [b"1"]) + self.assertEqual(h1.getlist("bar"), [b"2"]) + self.assertEqual(h1.getlist("buz"), [b"1", b"dos", b"3"]) + self.assertEqual(h1.getlist("hey"), [b"5"]) def test_invalid_value(self): - self.assertRaisesRegex(TypeError, 'Unsupported value type', - Headers, {'foo': object()}) - self.assertRaisesRegex(TypeError, 'Unsupported value type', - Headers().__setitem__, 'foo', object()) - self.assertRaisesRegex(TypeError, 'Unsupported value type', - Headers().setdefault, 'foo', object()) - self.assertRaisesRegex(TypeError, 'Unsupported value type', - Headers().setlist, 'foo', [object()]) + self.assertRaisesRegex( + TypeError, "Unsupported value type", Headers, {"foo": object()} + ) + self.assertRaisesRegex( + TypeError, "Unsupported value type", Headers().__setitem__, "foo", object() + ) + self.assertRaisesRegex( + TypeError, "Unsupported value type", Headers().setdefault, "foo", object() + ) + self.assertRaisesRegex( + TypeError, "Unsupported value type", Headers().setlist, "foo", [object()] + ) diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 9f7f1854f..b6f999b29 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -6,14 +6,21 @@ import warnings from unittest import mock from urllib.parse import parse_qs, unquote_to_bytes, urlparse -from scrapy.http import Request, FormRequest, XmlRpcRequest, JsonRequest, Headers, HtmlResponse +from scrapy.http import ( + Request, + FormRequest, + XmlRpcRequest, + JsonRequest, + Headers, + HtmlResponse, +) from scrapy.utils.python import to_bytes, to_unicode class RequestTest(unittest.TestCase): request_class = Request - default_method = 'GET' + default_method = "GET" default_headers = {} default_meta = {} @@ -23,7 +30,7 @@ class RequestTest(unittest.TestCase): # url argument must be basestring self.assertRaises(TypeError, self.request_class, 123) - r = self.request_class('http://www.example.com') + r = self.request_class("http://www.example.com") r = self.request_class("http://www.example.com") assert isinstance(r.url, str) @@ -36,7 +43,9 @@ class RequestTest(unittest.TestCase): meta = {"lala": "lolo"} headers = {b"caca": b"coco"} - r = self.request_class("http://www.example.com", meta=meta, headers=headers, body="a body") + r = self.request_class( + "http://www.example.com", meta=meta, headers=headers, body="a body" + ) assert r.meta is not meta self.assertEqual(r.meta, meta) @@ -45,22 +54,22 @@ class RequestTest(unittest.TestCase): def test_url_scheme(self): # This test passes by not raising any (ValueError) exception - self.request_class('http://example.org') - self.request_class('https://example.org') - self.request_class('s3://example.org') - self.request_class('ftp://example.org') - self.request_class('about:config') - self.request_class('data:,Hello%2C%20World!') + self.request_class("http://example.org") + self.request_class("https://example.org") + self.request_class("s3://example.org") + self.request_class("ftp://example.org") + self.request_class("about:config") + self.request_class("data:,Hello%2C%20World!") def test_url_no_scheme(self): - self.assertRaises(ValueError, self.request_class, 'foo') - self.assertRaises(ValueError, self.request_class, '/foo/') - self.assertRaises(ValueError, self.request_class, '/foo:bar') + self.assertRaises(ValueError, self.request_class, "foo") + self.assertRaises(ValueError, self.request_class, "/foo/") + self.assertRaises(ValueError, self.request_class, "/foo:bar") def test_headers(self): # Different ways of setting headers attribute - url = 'http://www.scrapy.org' - headers = {b'Accept': 'gzip', b'Custom-Header': 'nothing to tell you'} + url = "http://www.scrapy.org" + headers = {b"Accept": "gzip", b"Custom-Header": "nothing to tell you"} r = self.request_class(url=url, headers=headers) p = self.request_class(url=url, headers=r.headers) @@ -69,15 +78,15 @@ class RequestTest(unittest.TestCase): self.assertFalse(p.headers is r.headers) # headers must not be unicode - h = Headers({'key1': 'val1', 'key2': 'val2'}) - h['newkey'] = 'newval' + h = Headers({"key1": "val1", "key2": "val2"}) + h["newkey"] = "newval" for k, v in h.items(): self.assertIsInstance(k, bytes) for s in v: self.assertIsInstance(s, bytes) def test_eq(self): - url = 'http://www.scrapy.org' + url = "http://www.scrapy.org" r1 = self.request_class(url=url) r2 = self.request_class(url=url) self.assertNotEqual(r1, r2) @@ -115,13 +124,17 @@ class RequestTest(unittest.TestCase): self.assertEqual(r1.url, "http://www.scrapy.org/price/%C2%A3?unit=%C2%B5") # should be same as above - r2 = self.request_class(url="http://www.scrapy.org/price/£?unit=µ", encoding="utf-8") + r2 = self.request_class( + url="http://www.scrapy.org/price/£?unit=µ", encoding="utf-8" + ) self.assertEqual(r2.url, "http://www.scrapy.org/price/%C2%A3?unit=%C2%B5") def test_url_encoding_query_latin1(self): # encoding is used for encoding query-string before percent-escaping; # path is still UTF-8 encoded before percent-escaping - r3 = self.request_class(url="http://www.scrapy.org/price/µ?currency=£", encoding="latin1") + r3 = self.request_class( + url="http://www.scrapy.org/price/µ?currency=£", encoding="latin1" + ) self.assertEqual(r3.url, "http://www.scrapy.org/price/%C2%B5?currency=%A3") def test_url_encoding_nonutf8_untouched(self): @@ -154,27 +167,35 @@ class RequestTest(unittest.TestCase): def test_body(self): r1 = self.request_class(url="http://www.example.com/") - assert r1.body == b'' + assert r1.body == b"" r2 = self.request_class(url="http://www.example.com/", body=b"") assert isinstance(r2.body, bytes) - self.assertEqual(r2.encoding, 'utf-8') # default encoding + self.assertEqual(r2.encoding, "utf-8") # default encoding - r3 = self.request_class(url="http://www.example.com/", body="Price: \xa3100", encoding='utf-8') + r3 = self.request_class( + url="http://www.example.com/", body="Price: \xa3100", encoding="utf-8" + ) assert isinstance(r3.body, bytes) self.assertEqual(r3.body, b"Price: \xc2\xa3100") - r4 = self.request_class(url="http://www.example.com/", body="Price: \xa3100", encoding='latin1') + r4 = self.request_class( + url="http://www.example.com/", body="Price: \xa3100", encoding="latin1" + ) assert isinstance(r4.body, bytes) self.assertEqual(r4.body, b"Price: \xa3100") def test_ajax_url(self): # ascii url r = self.request_class(url="http://www.example.com/ajax.html#!key=value") - self.assertEqual(r.url, "http://www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue") + self.assertEqual( + r.url, "http://www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue" + ) # unicode url r = self.request_class(url="http://www.example.com/ajax.html#!key=value") - self.assertEqual(r.url, "http://www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue") + self.assertEqual( + r.url, "http://www.example.com/ajax.html?_escaped_fragment_=key%3Dvalue" + ) def test_copy(self): """Test Request copy""" @@ -182,10 +203,14 @@ class RequestTest(unittest.TestCase): def somecallback(): pass - r1 = self.request_class("http://www.example.com", flags=['f1', 'f2'], - callback=somecallback, errback=somecallback) - r1.meta['foo'] = 'bar' - r1.cb_kwargs['key'] = 'value' + r1 = self.request_class( + "http://www.example.com", + flags=["f1", "f2"], + callback=somecallback, + errback=somecallback, + ) + r1.meta["foo"] = "bar" + r1.cb_kwargs["key"] = "value" r2 = r1.copy() # make sure copy does not propagate callbacks @@ -199,7 +224,9 @@ class RequestTest(unittest.TestCase): self.assertEqual(r1.flags, r2.flags) # make sure cb_kwargs dict is shallow copied - assert r1.cb_kwargs is not r2.cb_kwargs, "cb_kwargs must be a shallow copy, not identical" + assert ( + r1.cb_kwargs is not r2.cb_kwargs + ), "cb_kwargs must be a shallow copy, not identical" self.assertEqual(r1.cb_kwargs, r2.cb_kwargs) # make sure meta dict is shallow copied @@ -207,7 +234,9 @@ class RequestTest(unittest.TestCase): self.assertEqual(r1.meta, r2.meta) # make sure headers attribute is shallow copied - assert r1.headers is not r2.headers, "headers must be a shallow copy, not identical" + assert ( + r1.headers is not r2.headers + ), "headers must be a shallow copy, not identical" self.assertEqual(r1.headers, r2.headers) self.assertEqual(r1.encoding, r2.encoding) self.assertEqual(r1.dont_filter, r2.dont_filter) @@ -220,27 +249,31 @@ class RequestTest(unittest.TestCase): class CustomRequest(self.request_class): pass - r1 = CustomRequest('http://www.example.com') + r1 = CustomRequest("http://www.example.com") r2 = r1.copy() assert isinstance(r2, CustomRequest) def test_replace(self): """Test Request.replace() method""" - r1 = self.request_class("http://www.example.com", method='GET') + r1 = self.request_class("http://www.example.com", method="GET") hdrs = Headers(r1.headers) - hdrs[b'key'] = b'value' + hdrs[b"key"] = b"value" r2 = r1.replace(method="POST", body="New body", headers=hdrs) self.assertEqual(r1.url, r2.url) self.assertEqual((r1.method, r2.method), ("GET", "POST")) - self.assertEqual((r1.body, r2.body), (b'', b"New body")) + self.assertEqual((r1.body, r2.body), (b"", b"New body")) self.assertEqual((r1.headers, r2.headers), (self.default_headers, hdrs)) # Empty attributes (which may fail if not compared properly) - r3 = self.request_class("http://www.example.com", meta={'a': 1}, dont_filter=True) - r4 = r3.replace(url="http://www.example.com/2", body=b'', meta={}, dont_filter=False) + r3 = self.request_class( + "http://www.example.com", meta={"a": 1}, dont_filter=True + ) + r4 = r3.replace( + url="http://www.example.com/2", body=b"", meta={}, dont_filter=False + ) self.assertEqual(r4.url, "http://www.example.com/2") - self.assertEqual(r4.body, b'') + self.assertEqual(r4.body, b"") self.assertEqual(r4.meta, {}) assert r4.dont_filter is False @@ -250,27 +283,27 @@ class RequestTest(unittest.TestCase): def test_immutable_attributes(self): r = self.request_class("http://example.com") - self.assertRaises(AttributeError, setattr, r, 'url', 'http://example2.com') - self.assertRaises(AttributeError, setattr, r, 'body', 'xxx') + self.assertRaises(AttributeError, setattr, r, "url", "http://example2.com") + self.assertRaises(AttributeError, setattr, r, "body", "xxx") def test_callback_and_errback(self): def a_function(): pass - r1 = self.request_class('http://example.com') + r1 = self.request_class("http://example.com") self.assertIsNone(r1.callback) self.assertIsNone(r1.errback) - r2 = self.request_class('http://example.com', callback=a_function) + r2 = self.request_class("http://example.com", callback=a_function) self.assertIs(r2.callback, a_function) self.assertIsNone(r2.errback) - r3 = self.request_class('http://example.com', errback=a_function) + r3 = self.request_class("http://example.com", errback=a_function) self.assertIsNone(r3.callback) self.assertIs(r3.errback, a_function) r4 = self.request_class( - url='http://example.com', + url="http://example.com", callback=a_function, errback=a_function, ) @@ -279,14 +312,14 @@ class RequestTest(unittest.TestCase): def test_callback_and_errback_type(self): with self.assertRaises(TypeError): - self.request_class('http://example.com', callback='a_function') + self.request_class("http://example.com", callback="a_function") with self.assertRaises(TypeError): - self.request_class('http://example.com', errback='a_function') + self.request_class("http://example.com", errback="a_function") with self.assertRaises(TypeError): self.request_class( - url='http://example.com', - callback='a_function', - errback='a_function', + url="http://example.com", + callback="a_function", + errback="a_function", ) def test_from_curl(self): @@ -311,37 +344,48 @@ class RequestTest(unittest.TestCase): r = self.request_class.from_curl(curl_command) self.assertEqual(r.method, "POST") self.assertEqual(r.url, "http://httpbin.org/post") - self.assertEqual(r.body, - b"custname=John+Smith&custtel=500&custemail=jsmith%40" - b"example.org&size=small&topping=cheese&topping=onion" - b"&delivery=12%3A15&comments=") - self.assertEqual(r.cookies, { - '_gauges_unique_year': '1', - '_gauges_unique': '1', - '_gauges_unique_month': '1', - '_gauges_unique_hour': '1', - '_gauges_unique_day': '1' - }) - self.assertEqual(r.headers, { - b'Origin': [b'http://httpbin.org'], - b'Accept-Encoding': [b'gzip, deflate'], - b'Accept-Language': [b'en-US,en;q=0.9,ru;q=0.8,es;q=0.7'], - b'Upgrade-Insecure-Requests': [b'1'], - b'User-Agent': [b'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.' - b'36 (KHTML, like Gecko) Ubuntu Chromium/62.0.3202' - b'.75 Chrome/62.0.3202.75 Safari/537.36'], - b'Content-Type': [b'application /x-www-form-urlencoded'], - b'Accept': [b'text/html,application/xhtml+xml,application/xml;q=0.' - b'9,image/webp,image/apng,*/*;q=0.8'], - b'Cache-Control': [b'max-age=0'], - b'Referer': [b'http://httpbin.org/forms/post'], - b'Connection': [b'keep-alive']}) + self.assertEqual( + r.body, + b"custname=John+Smith&custtel=500&custemail=jsmith%40" + b"example.org&size=small&topping=cheese&topping=onion" + b"&delivery=12%3A15&comments=", + ) + self.assertEqual( + r.cookies, + { + "_gauges_unique_year": "1", + "_gauges_unique": "1", + "_gauges_unique_month": "1", + "_gauges_unique_hour": "1", + "_gauges_unique_day": "1", + }, + ) + self.assertEqual( + r.headers, + { + b"Origin": [b"http://httpbin.org"], + b"Accept-Encoding": [b"gzip, deflate"], + b"Accept-Language": [b"en-US,en;q=0.9,ru;q=0.8,es;q=0.7"], + b"Upgrade-Insecure-Requests": [b"1"], + b"User-Agent": [ + b"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537." + b"36 (KHTML, like Gecko) Ubuntu Chromium/62.0.3202" + b".75 Chrome/62.0.3202.75 Safari/537.36" + ], + b"Content-Type": [b"application /x-www-form-urlencoded"], + b"Accept": [ + b"text/html,application/xhtml+xml,application/xml;q=0." + b"9,image/webp,image/apng,*/*;q=0.8" + ], + b"Cache-Control": [b"max-age=0"], + b"Referer": [b"http://httpbin.org/forms/post"], + b"Connection": [b"keep-alive"], + }, + ) def test_from_curl_with_kwargs(self): r = self.request_class.from_curl( - 'curl -X PATCH "http://example.org"', - method="POST", - meta={'key': 'value'} + 'curl -X PATCH "http://example.org"', method="POST", meta={"key": "value"} ) self.assertEqual(r.method, "POST") self.assertEqual(r.meta, {"key": "value"}) @@ -349,7 +393,7 @@ class RequestTest(unittest.TestCase): def test_from_curl_ignore_unknown_options(self): # By default: it works and ignores the unknown options: --foo and -z with warnings.catch_warnings(): # avoid warning when executing tests - warnings.simplefilter('ignore') + warnings.simplefilter("ignore") r = self.request_class.from_curl( 'curl -X DELETE "http://example.org" --foo -z', ) @@ -377,68 +421,85 @@ class FormRequestTest(RequestTest): def test_empty_formdata(self): r1 = self.request_class("http://www.example.com", formdata={}) - self.assertEqual(r1.body, b'') + self.assertEqual(r1.body, b"") def test_formdata_overrides_querystring(self): - data = (('a', 'one'), ('a', 'two'), ('b', '2')) - url = self.request_class('http://www.example.com/?a=0&b=1&c=3#fragment', - method='GET', formdata=data).url.split('#')[0] - fs = _qs(self.request_class(url, method='GET', formdata=data)) - self.assertEqual(set(fs[b'a']), {b'one', b'two'}) - self.assertEqual(fs[b'b'], [b'2']) - self.assertIsNone(fs.get(b'c')) + data = (("a", "one"), ("a", "two"), ("b", "2")) + url = self.request_class( + "http://www.example.com/?a=0&b=1&c=3#fragment", method="GET", formdata=data + ).url.split("#")[0] + fs = _qs(self.request_class(url, method="GET", formdata=data)) + self.assertEqual(set(fs[b"a"]), {b"one", b"two"}) + self.assertEqual(fs[b"b"], [b"2"]) + self.assertIsNone(fs.get(b"c")) - data = {'a': '1', 'b': '2'} - fs = _qs(self.request_class('http://www.example.com/', method='GET', formdata=data)) - self.assertEqual(fs[b'a'], [b'1']) - self.assertEqual(fs[b'b'], [b'2']) + data = {"a": "1", "b": "2"} + fs = _qs( + self.request_class("http://www.example.com/", method="GET", formdata=data) + ) + self.assertEqual(fs[b"a"], [b"1"]) + self.assertEqual(fs[b"b"], [b"2"]) def test_default_encoding_bytes(self): # using default encoding (utf-8) - data = {b'one': b'two', b'price': b'\xc2\xa3 100'} + data = {b"one": b"two", b"price": b"\xc2\xa3 100"} r2 = self.request_class("http://www.example.com", formdata=data) - self.assertEqual(r2.method, 'POST') - self.assertEqual(r2.encoding, 'utf-8') - self.assertQueryEqual(r2.body, b'price=%C2%A3+100&one=two') - self.assertEqual(r2.headers[b'Content-Type'], b'application/x-www-form-urlencoded') + self.assertEqual(r2.method, "POST") + self.assertEqual(r2.encoding, "utf-8") + self.assertQueryEqual(r2.body, b"price=%C2%A3+100&one=two") + self.assertEqual( + r2.headers[b"Content-Type"], b"application/x-www-form-urlencoded" + ) def test_default_encoding_textual_data(self): # using default encoding (utf-8) - data = {'µ one': 'two', 'price': '£ 100'} + data = {"µ one": "two", "price": "£ 100"} r2 = self.request_class("http://www.example.com", formdata=data) - self.assertEqual(r2.method, 'POST') - self.assertEqual(r2.encoding, 'utf-8') - self.assertQueryEqual(r2.body, b'price=%C2%A3+100&%C2%B5+one=two') - self.assertEqual(r2.headers[b'Content-Type'], b'application/x-www-form-urlencoded') + self.assertEqual(r2.method, "POST") + self.assertEqual(r2.encoding, "utf-8") + self.assertQueryEqual(r2.body, b"price=%C2%A3+100&%C2%B5+one=two") + self.assertEqual( + r2.headers[b"Content-Type"], b"application/x-www-form-urlencoded" + ) def test_default_encoding_mixed_data(self): # using default encoding (utf-8) - data = {'\u00b5one': b'two', b'price\xc2\xa3': '\u00a3 100'} + data = {"\u00b5one": b"two", b"price\xc2\xa3": "\u00a3 100"} r2 = self.request_class("http://www.example.com", formdata=data) - self.assertEqual(r2.method, 'POST') - self.assertEqual(r2.encoding, 'utf-8') - self.assertQueryEqual(r2.body, b'%C2%B5one=two&price%C2%A3=%C2%A3+100') - self.assertEqual(r2.headers[b'Content-Type'], b'application/x-www-form-urlencoded') + self.assertEqual(r2.method, "POST") + self.assertEqual(r2.encoding, "utf-8") + self.assertQueryEqual(r2.body, b"%C2%B5one=two&price%C2%A3=%C2%A3+100") + self.assertEqual( + r2.headers[b"Content-Type"], b"application/x-www-form-urlencoded" + ) def test_custom_encoding_bytes(self): - data = {b'\xb5 one': b'two', b'price': b'\xa3 100'} - r2 = self.request_class("http://www.example.com", formdata=data, encoding='latin1') - self.assertEqual(r2.method, 'POST') - self.assertEqual(r2.encoding, 'latin1') - self.assertQueryEqual(r2.body, b'price=%A3+100&%B5+one=two') - self.assertEqual(r2.headers[b'Content-Type'], b'application/x-www-form-urlencoded') + data = {b"\xb5 one": b"two", b"price": b"\xa3 100"} + r2 = self.request_class( + "http://www.example.com", formdata=data, encoding="latin1" + ) + self.assertEqual(r2.method, "POST") + self.assertEqual(r2.encoding, "latin1") + self.assertQueryEqual(r2.body, b"price=%A3+100&%B5+one=two") + self.assertEqual( + r2.headers[b"Content-Type"], b"application/x-www-form-urlencoded" + ) def test_custom_encoding_textual_data(self): - data = {'price': '£ 100'} - r3 = self.request_class("http://www.example.com", formdata=data, encoding='latin1') - self.assertEqual(r3.encoding, 'latin1') - self.assertEqual(r3.body, b'price=%A3+100') + data = {"price": "£ 100"} + r3 = self.request_class( + "http://www.example.com", formdata=data, encoding="latin1" + ) + self.assertEqual(r3.encoding, "latin1") + self.assertEqual(r3.body, b"price=%A3+100") def test_multi_key_values(self): # using multiples values for a single key - data = {'price': '\xa3 100', 'colours': ['red', 'blue', 'green']} + data = {"price": "\xa3 100", "colours": ["red", "blue", "green"]} r3 = self.request_class("http://www.example.com", formdata=data) - self.assertQueryEqual(r3.body, b'colours=red&colours=blue&colours=green&price=%C2%A3+100') + self.assertQueryEqual( + r3.body, b"colours=red&colours=blue&colours=green&price=%C2%A3+100" + ) def test_from_response_post(self): response = _buildresponse( @@ -447,17 +508,22 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") - req = self.request_class.from_response(response, formdata={'one': ['two', 'three'], 'six': 'seven'}) + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers[b'Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers[b"Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req) - self.assertEqual(set(fs[b'test']), {b'val1', b'val2'}) - self.assertEqual(set(fs[b'one']), {b'two', b'three'}) - self.assertEqual(fs[b'test2'], [b'xxx']) - self.assertEqual(fs[b'six'], [b'seven']) + self.assertEqual(set(fs[b"test"]), {b"val1", b"val2"}) + self.assertEqual(set(fs[b"one"]), {b"two", b"three"}) + self.assertEqual(fs[b"test2"], [b"xxx"]) + self.assertEqual(fs[b"six"], [b"seven"]) def test_from_response_post_nonascii_bytes_utf8(self): response = _buildresponse( @@ -466,17 +532,22 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") - req = self.request_class.from_response(response, formdata={'one': ['two', 'three'], 'six': 'seven'}) + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers[b'Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers[b"Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req, to_unicode=True) - self.assertEqual(set(fs['test £']), {'val1', 'val2'}) - self.assertEqual(set(fs['one']), {'two', 'three'}) - self.assertEqual(fs['test2'], ['xxx µ']) - self.assertEqual(fs['six'], ['seven']) + self.assertEqual(set(fs["test £"]), {"val1", "val2"}) + self.assertEqual(set(fs["one"]), {"two", "three"}) + self.assertEqual(fs["test2"], ["xxx µ"]) + self.assertEqual(fs["six"], ["seven"]) def test_from_response_post_nonascii_bytes_latin1(self): response = _buildresponse( @@ -486,18 +557,22 @@ class FormRequestTest(RequestTest): """, url="http://www.example.com/this/list.html", - encoding='latin1', + encoding="latin1", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} ) - req = self.request_class.from_response(response, formdata={'one': ['two', 'three'], 'six': 'seven'}) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers[b'Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers[b"Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") - fs = _qs(req, to_unicode=True, encoding='latin1') - self.assertEqual(set(fs['test £']), {'val1', 'val2'}) - self.assertEqual(set(fs['one']), {'two', 'three'}) - self.assertEqual(fs['test2'], ['xxx µ']) - self.assertEqual(fs['six'], ['seven']) + fs = _qs(req, to_unicode=True, encoding="latin1") + self.assertEqual(set(fs["test £"]), {"val1", "val2"}) + self.assertEqual(set(fs["one"]), {"two", "three"}) + self.assertEqual(fs["test2"], ["xxx µ"]) + self.assertEqual(fs["six"], ["seven"]) def test_from_response_post_nonascii_unicode(self): response = _buildresponse( @@ -506,42 +581,46 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") - req = self.request_class.from_response(response, formdata={'one': ['two', 'three'], 'six': 'seven'}) + url="http://www.example.com/this/list.html", + ) + req = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers[b'Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers[b"Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req, to_unicode=True) - self.assertEqual(set(fs['test £']), {'val1', 'val2'}) - self.assertEqual(set(fs['one']), {'two', 'three'}) - self.assertEqual(fs['test2'], ['xxx µ']) - self.assertEqual(fs['six'], ['seven']) + self.assertEqual(set(fs["test £"]), {"val1", "val2"}) + self.assertEqual(set(fs["one"]), {"two", "three"}) + self.assertEqual(fs["test2"], ["xxx µ"]) + self.assertEqual(fs["six"], ["seven"]) def test_from_response_duplicate_form_key(self): - response = _buildresponse( - '
', - url='http://www.example.com') + response = _buildresponse("
", url="http://www.example.com") req = self.request_class.from_response( response=response, - method='GET', - formdata=(('foo', 'bar'), ('foo', 'baz')), + method="GET", + formdata=(("foo", "bar"), ("foo", "baz")), ) - self.assertEqual(urlparse(req.url).hostname, 'www.example.com') - self.assertEqual(urlparse(req.url).query, 'foo=bar&foo=baz') + self.assertEqual(urlparse(req.url).hostname, "www.example.com") + self.assertEqual(urlparse(req.url).query, "foo=bar&foo=baz") def test_from_response_override_duplicate_form_key(self): response = _buildresponse( """
-
""") + """ + ) req = self.request_class.from_response( - response, - formdata=(('two', '2'), ('two', '4'))) + response, formdata=(("two", "2"), ("two", "4")) + ) fs = _qs(req) - self.assertEqual(fs[b'one'], [b'1']) - self.assertEqual(fs[b'two'], [b'2', b'4']) + self.assertEqual(fs[b"one"], [b"1"]) + self.assertEqual(fs[b"two"], [b"2", b"4"]) def test_from_response_extra_headers(self): response = _buildresponse( @@ -549,15 +628,18 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response( response=response, - formdata={'one': ['two', 'three'], 'six': 'seven'}, + formdata={"one": ["two", "three"], "six": "seven"}, headers={"Accept-Encoding": "gzip,deflate"}, ) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers['Content-type'], b'application/x-www-form-urlencoded') - self.assertEqual(req.headers['Accept-Encoding'], b'gzip,deflate') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers["Content-type"], b"application/x-www-form-urlencoded" + ) + self.assertEqual(req.headers["Accept-Encoding"], b"gzip,deflate") def test_from_response_get(self): response = _buildresponse( @@ -566,60 +648,67 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") - r1 = self.request_class.from_response(response, formdata={'one': ['two', 'three'], 'six': 'seven'}) - self.assertEqual(r1.method, 'GET') + url="http://www.example.com/this/list.html", + ) + r1 = self.request_class.from_response( + response, formdata={"one": ["two", "three"], "six": "seven"} + ) + self.assertEqual(r1.method, "GET") self.assertEqual(urlparse(r1.url).hostname, "www.example.com") self.assertEqual(urlparse(r1.url).path, "/this/get.php") fs = _qs(r1) - self.assertEqual(set(fs[b'test']), {b'val1', b'val2'}) - self.assertEqual(set(fs[b'one']), {b'two', b'three'}) - self.assertEqual(fs[b'test2'], [b'xxx']) - self.assertEqual(fs[b'six'], [b'seven']) + self.assertEqual(set(fs[b"test"]), {b"val1", b"val2"}) + self.assertEqual(set(fs[b"one"]), {b"two", b"three"}) + self.assertEqual(fs[b"test2"], [b"xxx"]) + self.assertEqual(fs[b"six"], [b"seven"]) def test_from_response_override_params(self): response = _buildresponse( """
-
""") - req = self.request_class.from_response(response, formdata={'two': '2'}) + """ + ) + req = self.request_class.from_response(response, formdata={"two": "2"}) fs = _qs(req) - self.assertEqual(fs[b'one'], [b'1']) - self.assertEqual(fs[b'two'], [b'2']) + self.assertEqual(fs[b"one"], [b"1"]) + self.assertEqual(fs[b"two"], [b"2"]) def test_from_response_drop_params(self): response = _buildresponse( """
-
""") - req = self.request_class.from_response(response, formdata={'two': None}) + """ + ) + req = self.request_class.from_response(response, formdata={"two": None}) fs = _qs(req) - self.assertEqual(fs[b'one'], [b'1']) - self.assertNotIn(b'two', fs) + self.assertEqual(fs[b"one"], [b"1"]) + self.assertNotIn(b"two", fs) def test_from_response_override_method(self): response = _buildresponse( - ''' + """
- ''') + """ + ) request = FormRequest.from_response(response) - self.assertEqual(request.method, 'GET') - request = FormRequest.from_response(response, method='POST') - self.assertEqual(request.method, 'POST') + self.assertEqual(request.method, "GET") + request = FormRequest.from_response(response, method="POST") + self.assertEqual(request.method, "POST") def test_from_response_override_url(self): response = _buildresponse( - ''' + """
- ''') + """ + ) request = FormRequest.from_response(response) - self.assertEqual(request.url, 'http://example.com/app') - request = FormRequest.from_response(response, url='http://foo.bar/absolute') - self.assertEqual(request.url, 'http://foo.bar/absolute') - request = FormRequest.from_response(response, url='/relative') - self.assertEqual(request.url, 'http://example.com/relative') + self.assertEqual(request.url, "http://example.com/app") + request = FormRequest.from_response(response, url="http://foo.bar/absolute") + self.assertEqual(request.url, "http://foo.bar/absolute") + request = FormRequest.from_response(response, url="/relative") + self.assertEqual(request.url, "http://example.com/relative") def test_from_response_case_insensitive(self): response = _buildresponse( @@ -627,12 +716,13 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response(response) fs = _qs(req) - self.assertEqual(fs[b'clickable1'], [b'clicked1']) - self.assertFalse(b'i1' in fs, fs) # xpath in _get_inputs() - self.assertFalse(b'clickable2' in fs, fs) # xpath in _get_clickable() + self.assertEqual(fs[b"clickable1"], [b"clicked1"]) + self.assertFalse(b"i1" in fs, fs) # xpath in _get_inputs() + self.assertFalse(b"clickable2" in fs, fs) # xpath in _get_clickable() def test_from_response_submit_first_clickable(self): response = _buildresponse( @@ -641,13 +731,14 @@ class FormRequestTest(RequestTest): - """) - req = self.request_class.from_response(response, formdata={'two': '2'}) + """ + ) + req = self.request_class.from_response(response, formdata={"two": "2"}) fs = _qs(req) - self.assertEqual(fs[b'clickable1'], [b'clicked1']) - self.assertFalse(b'clickable2' in fs, fs) - self.assertEqual(fs[b'one'], [b'1']) - self.assertEqual(fs[b'two'], [b'2']) + self.assertEqual(fs[b"clickable1"], [b"clicked1"]) + self.assertFalse(b"clickable2" in fs, fs) + self.assertEqual(fs[b"one"], [b"1"]) + self.assertEqual(fs[b"two"], [b"2"]) def test_from_response_submit_not_first_clickable(self): response = _buildresponse( @@ -656,15 +747,16 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response( - response, formdata={'two': '2'}, clickdata={'name': 'clickable2'} + response, formdata={"two": "2"}, clickdata={"name": "clickable2"} ) fs = _qs(req) - self.assertEqual(fs[b'clickable2'], [b'clicked2']) - self.assertFalse(b'clickable1' in fs, fs) - self.assertEqual(fs[b'one'], [b'1']) - self.assertEqual(fs[b'two'], [b'2']) + self.assertEqual(fs[b"clickable2"], [b"clicked2"]) + self.assertFalse(b"clickable1" in fs, fs) + self.assertEqual(fs[b"one"], [b"1"]) + self.assertEqual(fs[b"two"], [b"2"]) def test_from_response_dont_submit_image_as_input(self): response = _buildresponse( @@ -672,10 +764,11 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response(response, dont_click=True) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v']}) + self.assertEqual(fs, {b"i1": [b"i1v"]}) def test_from_response_dont_submit_reset_as_input(self): response = _buildresponse( @@ -684,20 +777,22 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response(response, dont_click=True) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v'], b'i2': [b'i2v']}) + self.assertEqual(fs, {b"i1": [b"i1v"], b"i2": [b"i2v"]}) def test_from_response_clickdata_does_not_ignore_image(self): response = _buildresponse( """
-
""") + """ + ) req = self.request_class.from_response(response) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v'], b'i2': [b'i2v']}) + self.assertEqual(fs, {b"i1": [b"i1v"], b"i2": [b"i2v"]}) def test_from_response_multiple_clickdata(self): response = _buildresponse( @@ -706,14 +801,15 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response( - response, clickdata={'name': 'clickable', 'value': 'clicked2'} + response, clickdata={"name": "clickable", "value": "clicked2"} ) fs = _qs(req) - self.assertEqual(fs[b'clickable'], [b'clicked2']) - self.assertEqual(fs[b'one'], [b'clicked1']) - self.assertEqual(fs[b'two'], [b'clicked2']) + self.assertEqual(fs[b"clickable"], [b"clicked2"]) + self.assertEqual(fs[b"one"], [b"clicked1"]) + self.assertEqual(fs[b"two"], [b"clicked2"]) def test_from_response_unicode_clickdata(self): response = _buildresponse( @@ -722,12 +818,13 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response( - response, clickdata={'name': 'price in \u00a3'} + response, clickdata={"name": "price in \u00a3"} ) fs = _qs(req, to_unicode=True) - self.assertTrue(fs['price in \u00a3']) + self.assertTrue(fs["price in \u00a3"]) def test_from_response_unicode_clickdata_latin1(self): response = _buildresponse( @@ -737,12 +834,13 @@ class FormRequestTest(RequestTest): """, - encoding='latin1') - req = self.request_class.from_response( - response, clickdata={'name': 'price in \u00a5'} + encoding="latin1", ) - fs = _qs(req, to_unicode=True, encoding='latin1') - self.assertTrue(fs['price in \u00a5']) + req = self.request_class.from_response( + response, clickdata={"name": "price in \u00a5"} + ) + fs = _qs(req, to_unicode=True, encoding="latin1") + self.assertTrue(fs["price in \u00a5"]) def test_from_response_multiple_forms_clickdata(self): response = _buildresponse( @@ -754,22 +852,25 @@ class FormRequestTest(RequestTest): - """) + """ + ) req = self.request_class.from_response( - response, formname='form2', clickdata={'name': 'clickable'} + response, formname="form2", clickdata={"name": "clickable"} ) fs = _qs(req) - self.assertEqual(fs[b'clickable'], [b'clicked2']) - self.assertEqual(fs[b'field2'], [b'value2']) - self.assertFalse(b'field1' in fs, fs) + self.assertEqual(fs[b"clickable"], [b"clicked2"]) + self.assertEqual(fs[b"field2"], [b"value2"]) + self.assertFalse(b"field1" in fs, fs) def test_from_response_override_clickable(self): - response = _buildresponse('''
''') + response = _buildresponse( + """
""" + ) req = self.request_class.from_response( - response, formdata={'clickme': 'two'}, clickdata={'name': 'clickme'} + response, formdata={"clickme": "two"}, clickdata={"name": "clickme"} ) fs = _qs(req) - self.assertEqual(fs[b'clickme'], [b'two']) + self.assertEqual(fs[b"clickme"], [b"two"]) def test_from_response_dont_click(self): response = _buildresponse( @@ -778,11 +879,12 @@ class FormRequestTest(RequestTest): - """) + """ + ) r1 = self.request_class.from_response(response, dont_click=True) fs = _qs(r1) - self.assertFalse(b'clickable1' in fs, fs) - self.assertFalse(b'clickable2' in fs, fs) + self.assertFalse(b"clickable1" in fs, fs) + self.assertFalse(b"clickable2" in fs, fs) def test_from_response_ambiguous_clickdata(self): response = _buildresponse( @@ -792,17 +894,27 @@ class FormRequestTest(RequestTest): - """) - self.assertRaises(ValueError, self.request_class.from_response, - response, clickdata={'type': 'submit'}) + """ + ) + self.assertRaises( + ValueError, + self.request_class.from_response, + response, + clickdata={"type": "submit"}, + ) def test_from_response_non_matching_clickdata(self): response = _buildresponse( """
-
""") - self.assertRaises(ValueError, self.request_class.from_response, - response, clickdata={'nonexistent': 'notme'}) + """ + ) + self.assertRaises( + ValueError, + self.request_class.from_response, + response, + clickdata={"nonexistent": "notme"}, + ) def test_from_response_nr_index_clickdata(self): response = _buildresponse( @@ -810,32 +922,37 @@ class FormRequestTest(RequestTest): - """) - req = self.request_class.from_response(response, clickdata={'nr': 1}) + """ + ) + req = self.request_class.from_response(response, clickdata={"nr": 1}) fs = _qs(req) - self.assertIn(b'clickable2', fs) - self.assertNotIn(b'clickable1', fs) + self.assertIn(b"clickable2", fs) + self.assertNotIn(b"clickable1", fs) def test_from_response_invalid_nr_index_clickdata(self): response = _buildresponse( """
- """) - self.assertRaises(ValueError, self.request_class.from_response, - response, clickdata={'nr': 1}) + """ + ) + self.assertRaises( + ValueError, self.request_class.from_response, response, clickdata={"nr": 1} + ) def test_from_response_errors_noform(self): response = _buildresponse("""""") self.assertRaises(ValueError, self.request_class.from_response, response) def test_from_response_invalid_html5(self): - response = _buildresponse("""
""" - """""" - """
""") - req = self.request_class.from_response(response, formdata={'bar': 'buz'}) + response = _buildresponse( + """
""" + """""" + """
""" + ) + req = self.request_class.from_response(response, formdata={"bar": "buz"}) fs = _qs(req) - self.assertEqual(fs, {b'foo': [b'xxx'], b'bar': [b'buz']}) + self.assertEqual(fs, {b"foo": [b"xxx"], b"bar": [b"buz"]}) def test_from_response_errors_formnumber(self): response = _buildresponse( @@ -843,20 +960,26 @@ class FormRequestTest(RequestTest): - """) - self.assertRaises(IndexError, self.request_class.from_response, response, formnumber=1) + """ + ) + self.assertRaises( + IndexError, self.request_class.from_response, response, formnumber=1 + ) def test_from_response_noformname(self): response = _buildresponse( """
-
""") - r1 = self.request_class.from_response(response, formdata={'two': '3'}) - self.assertEqual(r1.method, 'POST') - self.assertEqual(r1.headers['Content-type'], b'application/x-www-form-urlencoded') + """ + ) + r1 = self.request_class.from_response(response, formdata={"two": "3"}) + self.assertEqual(r1.method, "POST") + self.assertEqual( + r1.headers["Content-type"], b"application/x-www-form-urlencoded" + ) fs = _qs(r1) - self.assertEqual(fs, {b'one': [b'1'], b'two': [b'3']}) + self.assertEqual(fs, {b"one": [b"1"], b"two": [b"3"]}) def test_from_response_formname_exists(self): response = _buildresponse( @@ -867,11 +990,12 @@ class FormRequestTest(RequestTest):
-
""") + """ + ) r1 = self.request_class.from_response(response, formname="form2") - self.assertEqual(r1.method, 'POST') + self.assertEqual(r1.method, "POST") fs = _qs(r1) - self.assertEqual(fs, {b'four': [b'4'], b'three': [b'3']}) + self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) def test_from_response_formname_notexist(self): response = _buildresponse( @@ -880,11 +1004,12 @@ class FormRequestTest(RequestTest):
-
""") + """ + ) r1 = self.request_class.from_response(response, formname="form3") - self.assertEqual(r1.method, 'POST') + self.assertEqual(r1.method, "POST") fs = _qs(r1) - self.assertEqual(fs, {b'one': [b'1']}) + self.assertEqual(fs, {b"one": [b"1"]}) def test_from_response_formname_errors_formnumber(self): response = _buildresponse( @@ -893,9 +1018,15 @@ class FormRequestTest(RequestTest):
-
""") - self.assertRaises(IndexError, self.request_class.from_response, - response, formname="form3", formnumber=2) + """ + ) + self.assertRaises( + IndexError, + self.request_class.from_response, + response, + formname="form3", + formnumber=2, + ) def test_from_response_formid_exists(self): response = _buildresponse( @@ -906,11 +1037,12 @@ class FormRequestTest(RequestTest):
-
""") + """ + ) r1 = self.request_class.from_response(response, formid="form2") - self.assertEqual(r1.method, 'POST') + self.assertEqual(r1.method, "POST") fs = _qs(r1) - self.assertEqual(fs, {b'four': [b'4'], b'three': [b'3']}) + self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) def test_from_response_formname_notexists_fallback_formid(self): response = _buildresponse( @@ -921,11 +1053,14 @@ class FormRequestTest(RequestTest):
-
""") - r1 = self.request_class.from_response(response, formname="form3", formid="form2") - self.assertEqual(r1.method, 'POST') + """ + ) + r1 = self.request_class.from_response( + response, formname="form3", formid="form2" + ) + self.assertEqual(r1.method, "POST") fs = _qs(r1) - self.assertEqual(fs, {b'four': [b'4'], b'three': [b'3']}) + self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) def test_from_response_formid_notexist(self): response = _buildresponse( @@ -934,11 +1069,12 @@ class FormRequestTest(RequestTest):
-
""") + """ + ) r1 = self.request_class.from_response(response, formid="form3") - self.assertEqual(r1.method, 'POST') + self.assertEqual(r1.method, "POST") fs = _qs(r1) - self.assertEqual(fs, {b'one': [b'1']}) + self.assertEqual(fs, {b"one": [b"1"]}) def test_from_response_formid_errors_formnumber(self): response = _buildresponse( @@ -947,13 +1083,19 @@ class FormRequestTest(RequestTest):
-
""") - self.assertRaises(IndexError, self.request_class.from_response, - response, formid="form3", formnumber=2) + """ + ) + self.assertRaises( + IndexError, + self.request_class.from_response, + response, + formid="form3", + formnumber=2, + ) def test_from_response_select(self): res = _buildresponse( - '''
+ """ @@ -993,14 +1136,15 @@ class FormRequestTest(RequestTest): -
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'iv2'], b'i2': [b'on']}) + self.assertEqual(fs, {b"i1": [b"iv2"], b"i2": [b"on"]}) def test_from_response_checkbox(self): res = _buildresponse( - '''
+ """ @@ -1009,51 +1153,55 @@ class FormRequestTest(RequestTest): -
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'iv2'], b'i2': [b'on']}) + self.assertEqual(fs, {b"i1": [b"iv2"], b"i2": [b"on"]}) def test_from_response_input_text(self): res = _buildresponse( - '''
+ """ -
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v1'], b'i2': [b''], b'i4': [b'i4v1']}) + self.assertEqual(fs, {b"i1": [b"i1v1"], b"i2": [b""], b"i4": [b"i4v1"]}) def test_from_response_input_hidden(self): res = _buildresponse( - '''
+ """ -
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v1'], b'i2': [b'']}) + self.assertEqual(fs, {b"i1": [b"i1v1"], b"i2": [b""]}) def test_from_response_input_textarea(self): res = _buildresponse( - '''
+ """ -
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(fs, {b'i1': [b'i1v'], b'i2': [b''], b'i3': [b'']}) + self.assertEqual(fs, {b"i1": [b"i1v"], b"i2": [b""], b"i3": [b""]}) def test_from_response_descendants(self): res = _buildresponse( - '''
+ """
@@ -1067,10 +1215,11 @@ class FormRequestTest(RequestTest):
-
''') + """ + ) req = self.request_class.from_response(res) fs = _qs(req) - self.assertEqual(set(fs), {b'h2', b'i2', b'i1', b'i3', b'h1', b'i5', b'i4'}) + self.assertEqual(set(fs), {b"h2", b"i2", b"i1", b"i3", b"h1", b"i5", b"i4"}) def test_from_response_xpath(self): response = _buildresponse( @@ -1081,28 +1230,43 @@ class FormRequestTest(RequestTest):
-
""") - r1 = self.request_class.from_response(response, formxpath="//form[@action='post.php']") + """ + ) + r1 = self.request_class.from_response( + response, formxpath="//form[@action='post.php']" + ) fs = _qs(r1) - self.assertEqual(fs[b'one'], [b'1']) + self.assertEqual(fs[b"one"], [b"1"]) - r1 = self.request_class.from_response(response, formxpath="//form/input[@name='four']") + r1 = self.request_class.from_response( + response, formxpath="//form/input[@name='four']" + ) fs = _qs(r1) - self.assertEqual(fs[b'three'], [b'3']) + self.assertEqual(fs[b"three"], [b"3"]) - self.assertRaises(ValueError, self.request_class.from_response, - response, formxpath="//form/input[@name='abc']") + self.assertRaises( + ValueError, + self.request_class.from_response, + response, + formxpath="//form/input[@name='abc']", + ) def test_from_response_unicode_xpath(self): response = _buildresponse(b'
') - r = self.request_class.from_response(response, formxpath="//form[@name='\u044a']") + r = self.request_class.from_response( + response, formxpath="//form[@name='\u044a']" + ) fs = _qs(r) self.assertEqual(fs, {}) xpath = "//form[@name='\u03b1']" - self.assertRaisesRegex(ValueError, re.escape(xpath), - self.request_class.from_response, - response, formxpath=xpath) + self.assertRaisesRegex( + ValueError, + re.escape(xpath), + self.request_class.from_response, + response, + formxpath=xpath, + ) def test_from_response_button_submit(self): response = _buildresponse( @@ -1111,15 +1275,18 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") + url="http://www.example.com/this/list.html", + ) req = self.request_class.from_response(response) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers['Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers["Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req) - self.assertEqual(fs[b'test1'], [b'val1']) - self.assertEqual(fs[b'test2'], [b'val2']) - self.assertEqual(fs[b'button1'], [b'submit1']) + self.assertEqual(fs[b"test1"], [b"val1"]) + self.assertEqual(fs[b"test2"], [b"val2"]) + self.assertEqual(fs[b"button1"], [b"submit1"]) def test_from_response_button_notype(self): response = _buildresponse( @@ -1128,15 +1295,18 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") + url="http://www.example.com/this/list.html", + ) req = self.request_class.from_response(response) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers['Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers["Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req) - self.assertEqual(fs[b'test1'], [b'val1']) - self.assertEqual(fs[b'test2'], [b'val2']) - self.assertEqual(fs[b'button1'], [b'submit1']) + self.assertEqual(fs[b"test1"], [b"val1"]) + self.assertEqual(fs[b"test2"], [b"val2"]) + self.assertEqual(fs[b"button1"], [b"submit1"]) def test_from_response_submit_novalue(self): response = _buildresponse( @@ -1145,15 +1315,18 @@ class FormRequestTest(RequestTest): Submit """, - url="http://www.example.com/this/list.html") + url="http://www.example.com/this/list.html", + ) req = self.request_class.from_response(response) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers['Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers["Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req) - self.assertEqual(fs[b'test1'], [b'val1']) - self.assertEqual(fs[b'test2'], [b'val2']) - self.assertEqual(fs[b'button1'], [b'']) + self.assertEqual(fs[b"test1"], [b"val1"]) + self.assertEqual(fs[b"test2"], [b"val2"]) + self.assertEqual(fs[b"button1"], [b""]) def test_from_response_button_novalue(self): response = _buildresponse( @@ -1162,15 +1335,18 @@ class FormRequestTest(RequestTest): """, - url="http://www.example.com/this/list.html") + url="http://www.example.com/this/list.html", + ) req = self.request_class.from_response(response) - self.assertEqual(req.method, 'POST') - self.assertEqual(req.headers['Content-type'], b'application/x-www-form-urlencoded') + self.assertEqual(req.method, "POST") + self.assertEqual( + req.headers["Content-type"], b"application/x-www-form-urlencoded" + ) self.assertEqual(req.url, "http://www.example.com/this/post.php") fs = _qs(req) - self.assertEqual(fs[b'test1'], [b'val1']) - self.assertEqual(fs[b'test2'], [b'val2']) - self.assertEqual(fs[b'button1'], [b'']) + self.assertEqual(fs[b"test1"], [b"val1"]) + self.assertEqual(fs[b"test2"], [b"val2"]) + self.assertEqual(fs[b"button1"], [b""]) def test_html_base_form_action(self): response = _buildresponse( @@ -1185,15 +1361,15 @@ class FormRequestTest(RequestTest): """, - url='http://a.com/' + url="http://a.com/", ) req = self.request_class.from_response(response) - self.assertEqual(req.url, 'http://b.com/test_form') + self.assertEqual(req.url, "http://b.com/test_form") def test_spaces_in_action(self): resp = _buildresponse('
') req = self.request_class.from_response(resp) - self.assertEqual(req.url, 'http://example.com/path') + self.assertEqual(req.url, "http://example.com/path") def test_from_response_css(self): response = _buildresponse( @@ -1204,44 +1380,53 @@ class FormRequestTest(RequestTest):
-
""") - r1 = self.request_class.from_response(response, formcss="form[action='post.php']") + """ + ) + r1 = self.request_class.from_response( + response, formcss="form[action='post.php']" + ) fs = _qs(r1) - self.assertEqual(fs[b'one'], [b'1']) + self.assertEqual(fs[b"one"], [b"1"]) r1 = self.request_class.from_response(response, formcss="input[name='four']") fs = _qs(r1) - self.assertEqual(fs[b'three'], [b'3']) + self.assertEqual(fs[b"three"], [b"3"]) - self.assertRaises(ValueError, self.request_class.from_response, - response, formcss="input[name='abc']") + self.assertRaises( + ValueError, + self.request_class.from_response, + response, + formcss="input[name='abc']", + ) def test_from_response_valid_form_methods(self): - form_methods = [[method, method] for method in self.request_class.valid_form_methods] - form_methods.append(['UNKNOWN', 'GET']) + form_methods = [ + [method, method] for method in self.request_class.valid_form_methods + ] + form_methods.append(["UNKNOWN", "GET"]) for method, expected in form_methods: response = _buildresponse( f'
' '' - '
' + "" ) r = self.request_class.from_response(response) self.assertEqual(r.method, expected) def _buildresponse(body, **kwargs): - kwargs.setdefault('body', body) - kwargs.setdefault('url', 'http://example.com') - kwargs.setdefault('encoding', 'utf-8') + kwargs.setdefault("body", body) + kwargs.setdefault("url", "http://example.com") + kwargs.setdefault("encoding", "utf-8") return HtmlResponse(**kwargs) -def _qs(req, encoding='utf-8', to_unicode=False): - if req.method == 'POST': +def _qs(req, encoding="utf-8", to_unicode=False): + if req.method == "POST": qs = req.body else: - qs = req.url.partition('?')[2] + qs = req.url.partition("?")[2] uqs = unquote_to_bytes(qs) if to_unicode: uqs = uqs.decode(encoding) @@ -1251,38 +1436,41 @@ def _qs(req, encoding='utf-8', to_unicode=False): class XmlRpcRequestTest(RequestTest): request_class = XmlRpcRequest - default_method = 'POST' - default_headers = {b'Content-Type': [b'text/xml']} + default_method = "POST" + default_headers = {b"Content-Type": [b"text/xml"]} def _test_request(self, **kwargs): - r = self.request_class('http://scrapytest.org/rpc2', **kwargs) - self.assertEqual(r.headers[b'Content-Type'], b'text/xml') - self.assertEqual(r.body, - to_bytes(xmlrpc.client.dumps(**kwargs), - encoding=kwargs.get('encoding', 'utf-8'))) - self.assertEqual(r.method, 'POST') - self.assertEqual(r.encoding, kwargs.get('encoding', 'utf-8')) + r = self.request_class("http://scrapytest.org/rpc2", **kwargs) + self.assertEqual(r.headers[b"Content-Type"], b"text/xml") + self.assertEqual( + r.body, + to_bytes( + xmlrpc.client.dumps(**kwargs), encoding=kwargs.get("encoding", "utf-8") + ), + ) + self.assertEqual(r.method, "POST") + self.assertEqual(r.encoding, kwargs.get("encoding", "utf-8")) self.assertTrue(r.dont_filter, True) def test_xmlrpc_dumps(self): - self._test_request(params=('value',)) - self._test_request(params=('username', 'password'), methodname='login') - self._test_request(params=('response', ), methodresponse='login') - self._test_request(params=('pas£',), encoding='utf-8') + self._test_request(params=("value",)) + self._test_request(params=("username", "password"), methodname="login") + self._test_request(params=("response",), methodresponse="login") + self._test_request(params=("pas£",), encoding="utf-8") self._test_request(params=(None,), allow_none=1) self.assertRaises(TypeError, self._test_request) self.assertRaises(TypeError, self._test_request, params=(None,)) def test_latin1(self): - self._test_request(params=('pas£',), encoding='latin1') + self._test_request(params=("pas£",), encoding="latin1") class JsonRequestTest(RequestTest): request_class = JsonRequest - default_method = 'GET' + default_method = "GET" default_headers = { - b'Content-Type': [b'application/json'], - b'Accept': [b'application/json, text/javascript, */*; q=0.01'], + b"Content-Type": [b"application/json"], + b"Accept": [b"application/json, text/javascript, */*; q=0.01"], } def setUp(self): @@ -1291,14 +1479,14 @@ class JsonRequestTest(RequestTest): def test_data(self): r1 = self.request_class(url="http://www.example.com/") - self.assertEqual(r1.body, b'') + self.assertEqual(r1.body, b"") - body = b'body' + body = b"body" r2 = self.request_class(url="http://www.example.com/", body=body) self.assertEqual(r2.body, body) data = { - 'name': 'value', + "name": "value", } r3 = self.request_class(url="http://www.example.com/", data=data) self.assertEqual(r3.body, to_bytes(json.dumps(data))) @@ -1310,134 +1498,138 @@ class JsonRequestTest(RequestTest): def test_data_method(self): # data is not passed r1 = self.request_class(url="http://www.example.com/") - self.assertEqual(r1.method, 'GET') + self.assertEqual(r1.method, "GET") - body = b'body' + body = b"body" r2 = self.request_class(url="http://www.example.com/", body=body) - self.assertEqual(r2.method, 'GET') + self.assertEqual(r2.method, "GET") data = { - 'name': 'value', + "name": "value", } r3 = self.request_class(url="http://www.example.com/", data=data) - self.assertEqual(r3.method, 'POST') + self.assertEqual(r3.method, "POST") # method passed explicitly - r4 = self.request_class(url="http://www.example.com/", data=data, method='GET') - self.assertEqual(r4.method, 'GET') + r4 = self.request_class(url="http://www.example.com/", data=data, method="GET") + self.assertEqual(r4.method, "GET") r5 = self.request_class(url="http://www.example.com/", data=[]) - self.assertEqual(r5.method, 'POST') + self.assertEqual(r5.method, "POST") def test_body_data(self): - """ passing both body and data should result a warning """ - body = b'body' + """passing both body and data should result a warning""" + body = b"body" data = { - 'name': 'value', + "name": "value", } with warnings.catch_warnings(record=True) as _warnings: r5 = self.request_class(url="http://www.example.com/", body=body, data=data) self.assertEqual(r5.body, body) - self.assertEqual(r5.method, 'GET') + self.assertEqual(r5.method, "GET") self.assertEqual(len(_warnings), 1) - self.assertIn('data will be ignored', str(_warnings[0].message)) + self.assertIn("data will be ignored", str(_warnings[0].message)) def test_empty_body_data(self): - """ passing any body value and data should result a warning """ + """passing any body value and data should result a warning""" data = { - 'name': 'value', + "name": "value", } with warnings.catch_warnings(record=True) as _warnings: - r6 = self.request_class(url="http://www.example.com/", body=b'', data=data) - self.assertEqual(r6.body, b'') - self.assertEqual(r6.method, 'GET') + r6 = self.request_class(url="http://www.example.com/", body=b"", data=data) + self.assertEqual(r6.body, b"") + self.assertEqual(r6.method, "GET") self.assertEqual(len(_warnings), 1) - self.assertIn('data will be ignored', str(_warnings[0].message)) + self.assertIn("data will be ignored", str(_warnings[0].message)) def test_body_none_data(self): data = { - 'name': 'value', + "name": "value", } with warnings.catch_warnings(record=True) as _warnings: r7 = self.request_class(url="http://www.example.com/", body=None, data=data) self.assertEqual(r7.body, to_bytes(json.dumps(data))) - self.assertEqual(r7.method, 'POST') + self.assertEqual(r7.method, "POST") self.assertEqual(len(_warnings), 0) def test_body_data_none(self): with warnings.catch_warnings(record=True) as _warnings: r8 = self.request_class(url="http://www.example.com/", body=None, data=None) - self.assertEqual(r8.method, 'GET') + self.assertEqual(r8.method, "GET") self.assertEqual(len(_warnings), 0) def test_dumps_sort_keys(self): - """ Test that sort_keys=True is passed to json.dumps by default """ + """Test that sort_keys=True is passed to json.dumps by default""" data = { - 'name': 'value', + "name": "value", } - with mock.patch('json.dumps', return_value=b'') as mock_dumps: + with mock.patch("json.dumps", return_value=b"") as mock_dumps: self.request_class(url="http://www.example.com/", data=data) kwargs = mock_dumps.call_args[1] - self.assertEqual(kwargs['sort_keys'], True) + self.assertEqual(kwargs["sort_keys"], True) def test_dumps_kwargs(self): - """ Test that dumps_kwargs are passed to json.dumps """ + """Test that dumps_kwargs are passed to json.dumps""" data = { - 'name': 'value', + "name": "value", } dumps_kwargs = { - 'ensure_ascii': True, - 'allow_nan': True, + "ensure_ascii": True, + "allow_nan": True, } - with mock.patch('json.dumps', return_value=b'') as mock_dumps: - self.request_class(url="http://www.example.com/", data=data, dumps_kwargs=dumps_kwargs) + with mock.patch("json.dumps", return_value=b"") as mock_dumps: + self.request_class( + url="http://www.example.com/", data=data, dumps_kwargs=dumps_kwargs + ) kwargs = mock_dumps.call_args[1] - self.assertEqual(kwargs['ensure_ascii'], True) - self.assertEqual(kwargs['allow_nan'], True) + self.assertEqual(kwargs["ensure_ascii"], True) + self.assertEqual(kwargs["allow_nan"], True) def test_replace_data(self): data1 = { - 'name1': 'value1', + "name1": "value1", } data2 = { - 'name2': 'value2', + "name2": "value2", } r1 = self.request_class(url="http://www.example.com/", data=data1) r2 = r1.replace(data=data2) self.assertEqual(r2.body, to_bytes(json.dumps(data2))) def test_replace_sort_keys(self): - """ Test that replace provides sort_keys=True to json.dumps """ + """Test that replace provides sort_keys=True to json.dumps""" data1 = { - 'name1': 'value1', + "name1": "value1", } data2 = { - 'name2': 'value2', + "name2": "value2", } r1 = self.request_class(url="http://www.example.com/", data=data1) - with mock.patch('json.dumps', return_value=b'') as mock_dumps: + with mock.patch("json.dumps", return_value=b"") as mock_dumps: r1.replace(data=data2) kwargs = mock_dumps.call_args[1] - self.assertEqual(kwargs['sort_keys'], True) + self.assertEqual(kwargs["sort_keys"], True) def test_replace_dumps_kwargs(self): - """ Test that dumps_kwargs are provided to json.dumps when replace is called """ + """Test that dumps_kwargs are provided to json.dumps when replace is called""" data1 = { - 'name1': 'value1', + "name1": "value1", } data2 = { - 'name2': 'value2', + "name2": "value2", } dumps_kwargs = { - 'ensure_ascii': True, - 'allow_nan': True, + "ensure_ascii": True, + "allow_nan": True, } - r1 = self.request_class(url="http://www.example.com/", data=data1, dumps_kwargs=dumps_kwargs) - with mock.patch('json.dumps', return_value=b'') as mock_dumps: + r1 = self.request_class( + url="http://www.example.com/", data=data1, dumps_kwargs=dumps_kwargs + ) + with mock.patch("json.dumps", return_value=b"") as mock_dumps: r1.replace(data=data2) kwargs = mock_dumps.call_args[1] - self.assertEqual(kwargs['ensure_ascii'], True) - self.assertEqual(kwargs['allow_nan'], True) + self.assertEqual(kwargs["ensure_ascii"], True) + self.assertEqual(kwargs["allow_nan"], True) def tearDown(self): warnings.resetwarnings() diff --git a/tests/test_http_response.py b/tests/test_http_response.py index f51f3d988..c52fcce09 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -4,8 +4,14 @@ from unittest import mock from w3lib.encoding import resolve_encoding -from scrapy.http import (Request, Response, TextResponse, HtmlResponse, - XmlResponse, Headers) +from scrapy.http import ( + Request, + Response, + TextResponse, + HtmlResponse, + XmlResponse, + Headers, +) from scrapy.selector import Selector from scrapy.utils.python import to_unicode from scrapy.exceptions import NotSupported @@ -20,15 +26,30 @@ class BaseResponseTest(unittest.TestCase): def test_init(self): # Response requires url in the constructor self.assertRaises(Exception, self.response_class) - self.assertTrue(isinstance(self.response_class('http://example.com/'), self.response_class)) + self.assertTrue( + isinstance(self.response_class("http://example.com/"), self.response_class) + ) self.assertRaises(TypeError, self.response_class, b"http://example.com") # body can be str or None - self.assertTrue(isinstance(self.response_class('http://example.com/', body=b''), self.response_class)) - self.assertTrue(isinstance(self.response_class('http://example.com/', body=b'body'), self.response_class)) + self.assertTrue( + isinstance( + self.response_class("http://example.com/", body=b""), + self.response_class, + ) + ) + self.assertTrue( + isinstance( + self.response_class("http://example.com/", body=b"body"), + self.response_class, + ) + ) # test presence of all optional parameters self.assertTrue( isinstance( - self.response_class('http://example.com/', body=b'', headers={}, status=200), self.response_class + self.response_class( + "http://example.com/", body=b"", headers={}, status=200 + ), + self.response_class, ) ) @@ -49,15 +70,17 @@ class BaseResponseTest(unittest.TestCase): r = self.response_class("http://www.example.com", status=301) self.assertEqual(r.status, 301) - r = self.response_class("http://www.example.com", status='301') + r = self.response_class("http://www.example.com", status="301") self.assertEqual(r.status, 301) - self.assertRaises(ValueError, self.response_class, "http://example.com", status='lala200') + self.assertRaises( + ValueError, self.response_class, "http://example.com", status="lala200" + ) def test_copy(self): """Test Response copy""" r1 = self.response_class("http://www.example.com", body=b"Some body") - r1.flags.append('cached') + r1.flags.append("cached") r2 = r1.copy() self.assertEqual(r1.status, r2.status) @@ -68,29 +91,37 @@ class BaseResponseTest(unittest.TestCase): self.assertEqual(r1.flags, r2.flags) # make sure headers attribute is shallow copied - assert r1.headers is not r2.headers, "headers must be a shallow copy, not identical" + assert ( + r1.headers is not r2.headers + ), "headers must be a shallow copy, not identical" self.assertEqual(r1.headers, r2.headers) def test_copy_meta(self): req = Request("http://www.example.com") - req.meta['foo'] = 'bar' - r1 = self.response_class("http://www.example.com", body=b"Some body", request=req) + req.meta["foo"] = "bar" + r1 = self.response_class( + "http://www.example.com", body=b"Some body", request=req + ) assert r1.meta is req.meta def test_copy_cb_kwargs(self): req = Request("http://www.example.com") - req.cb_kwargs['foo'] = 'bar' - r1 = self.response_class("http://www.example.com", body=b"Some body", request=req) + req.cb_kwargs["foo"] = "bar" + r1 = self.response_class( + "http://www.example.com", body=b"Some body", request=req + ) assert r1.cb_kwargs is req.cb_kwargs def test_unavailable_meta(self): r1 = self.response_class("http://www.example.com", body=b"Some body") - with self.assertRaisesRegex(AttributeError, r'Response\.meta not available'): + with self.assertRaisesRegex(AttributeError, r"Response\.meta not available"): r1.meta def test_unavailable_cb_kwargs(self): r1 = self.response_class("http://www.example.com", body=b"Some body") - with self.assertRaisesRegex(AttributeError, r'Response\.cb_kwargs not available'): + with self.assertRaisesRegex( + AttributeError, r"Response\.cb_kwargs not available" + ): r1.cb_kwargs def test_copy_inherited_classes(self): @@ -99,7 +130,7 @@ class BaseResponseTest(unittest.TestCase): class CustomResponse(self.response_class): pass - r1 = CustomResponse('http://www.example.com') + r1 = CustomResponse("http://www.example.com") r2 = r1.copy() assert isinstance(r2, CustomResponse) @@ -109,16 +140,16 @@ class BaseResponseTest(unittest.TestCase): hdrs = Headers({"key": "value"}) r1 = self.response_class("http://www.example.com") r2 = r1.replace(status=301, body=b"New body", headers=hdrs) - assert r1.body == b'' + assert r1.body == b"" self.assertEqual(r1.url, r2.url) self.assertEqual((r1.status, r2.status), (200, 301)) - self.assertEqual((r1.body, r2.body), (b'', b"New body")) + self.assertEqual((r1.body, r2.body), (b"", b"New body")) self.assertEqual((r1.headers, r2.headers), ({}, hdrs)) # Empty attributes (which may fail if not compared properly) - r3 = self.response_class("http://www.example.com", flags=['cached']) - r4 = r3.replace(body=b'', flags=[]) - self.assertEqual(r4.body, b'') + r3 = self.response_class("http://www.example.com", flags=["cached"]) + r4 = r3.replace(body=b"", flags=[]) + self.assertEqual(r4.body, b"") self.assertEqual(r4.flags, []) def _assert_response_values(self, response, encoding, body): @@ -140,81 +171,84 @@ class BaseResponseTest(unittest.TestCase): def test_immutable_attributes(self): r = self.response_class("http://example.com") - self.assertRaises(AttributeError, setattr, r, 'url', 'http://example2.com') - self.assertRaises(AttributeError, setattr, r, 'body', 'xxx') + self.assertRaises(AttributeError, setattr, r, "url", "http://example2.com") + self.assertRaises(AttributeError, setattr, r, "body", "xxx") def test_urljoin(self): """Test urljoin shortcut (only for existence, since behavior equals urljoin)""" - joined = self.response_class('http://www.example.com').urljoin('/test') - absolute = 'http://www.example.com/test' + joined = self.response_class("http://www.example.com").urljoin("/test") + absolute = "http://www.example.com/test" self.assertEqual(joined, absolute) def test_shortcut_attributes(self): - r = self.response_class("http://example.com", body=b'hello') + r = self.response_class("http://example.com", body=b"hello") if self.response_class == Response: msg = "Response content isn't text" - self.assertRaisesRegex(AttributeError, msg, getattr, r, 'text') - self.assertRaisesRegex(NotSupported, msg, r.css, 'body') - self.assertRaisesRegex(NotSupported, msg, r.xpath, '//body') + self.assertRaisesRegex(AttributeError, msg, getattr, r, "text") + self.assertRaisesRegex(NotSupported, msg, r.css, "body") + self.assertRaisesRegex(NotSupported, msg, r.xpath, "//body") else: r.text - r.css('body') - r.xpath('//body') + r.css("body") + r.xpath("//body") # Response.follow def test_follow_url_absolute(self): - self._assert_followed_url('http://foo.example.com', - 'http://foo.example.com') + self._assert_followed_url("http://foo.example.com", "http://foo.example.com") def test_follow_url_relative(self): - self._assert_followed_url('foo', - 'http://example.com/foo') + self._assert_followed_url("foo", "http://example.com/foo") def test_follow_link(self): - self._assert_followed_url(Link('http://example.com/foo'), - 'http://example.com/foo') + self._assert_followed_url( + Link("http://example.com/foo"), "http://example.com/foo" + ) def test_follow_None_url(self): r = self.response_class("http://example.com") self.assertRaises(ValueError, r.follow, None) def test_follow_whitespace_url(self): - self._assert_followed_url('foo ', - 'http://example.com/foo%20') + self._assert_followed_url("foo ", "http://example.com/foo%20") def test_follow_whitespace_link(self): - self._assert_followed_url(Link('http://example.com/foo '), - 'http://example.com/foo%20') + self._assert_followed_url( + Link("http://example.com/foo "), "http://example.com/foo%20" + ) def test_follow_flags(self): - res = self.response_class('http://example.com/') - fol = res.follow('http://example.com/', flags=['cached', 'allowed']) - self.assertEqual(fol.flags, ['cached', 'allowed']) + res = self.response_class("http://example.com/") + fol = res.follow("http://example.com/", flags=["cached", "allowed"]) + self.assertEqual(fol.flags, ["cached", "allowed"]) # Response.follow_all def test_follow_all_absolute(self): - url_list = ['http://example.org', 'http://www.example.org', - 'http://example.com', 'http://www.example.com'] + url_list = [ + "http://example.org", + "http://www.example.org", + "http://example.com", + "http://www.example.com", + ] self._assert_followed_all_urls(url_list, url_list) def test_follow_all_relative(self): - relative = ['foo', 'bar', 'foo/bar', 'bar/foo'] + relative = ["foo", "bar", "foo/bar", "bar/foo"] absolute = [ - 'http://example.com/foo', - 'http://example.com/bar', - 'http://example.com/foo/bar', - 'http://example.com/bar/foo', + "http://example.com/foo", + "http://example.com/bar", + "http://example.com/foo/bar", + "http://example.com/bar/foo", ] self._assert_followed_all_urls(relative, absolute) def test_follow_all_links(self): absolute = [ - 'http://example.com/foo', - 'http://example.com/bar', - 'http://example.com/foo/bar', - 'http://example.com/bar/foo', + "http://example.com/foo", + "http://example.com/bar", + "http://example.com/foo/bar", + "http://example.com/bar/foo", ] links = map(Link, absolute) self._assert_followed_all_urls(links, absolute) @@ -241,36 +275,36 @@ class BaseResponseTest(unittest.TestCase): list(r.follow_all(urls=[None])) def test_follow_all_whitespace(self): - relative = ['foo ', 'bar ', 'foo/bar ', 'bar/foo '] + relative = ["foo ", "bar ", "foo/bar ", "bar/foo "] absolute = [ - 'http://example.com/foo%20', - 'http://example.com/bar%20', - 'http://example.com/foo/bar%20', - 'http://example.com/bar/foo%20', + "http://example.com/foo%20", + "http://example.com/bar%20", + "http://example.com/foo/bar%20", + "http://example.com/bar/foo%20", ] self._assert_followed_all_urls(relative, absolute) def test_follow_all_whitespace_links(self): absolute = [ - 'http://example.com/foo ', - 'http://example.com/bar ', - 'http://example.com/foo/bar ', - 'http://example.com/bar/foo ', + "http://example.com/foo ", + "http://example.com/bar ", + "http://example.com/foo/bar ", + "http://example.com/bar/foo ", ] links = map(Link, absolute) - expected = [u.replace(' ', '%20') for u in absolute] + expected = [u.replace(" ", "%20") for u in absolute] self._assert_followed_all_urls(links, expected) def test_follow_all_flags(self): - re = self.response_class('http://www.example.com/') + re = self.response_class("http://www.example.com/") urls = [ - 'http://www.example.com/', - 'http://www.example.com/2', - 'http://www.example.com/foo', + "http://www.example.com/", + "http://www.example.com/2", + "http://www.example.com/foo", ] - fol = re.follow_all(urls, flags=['cached', 'allowed']) + fol = re.follow_all(urls, flags=["cached", "allowed"]) for req in fol: - self.assertEqual(req.flags, ['cached', 'allowed']) + self.assertEqual(req.flags, ["cached", "allowed"]) def _assert_followed_url(self, follow_obj, target_url, response=None): if response is None: @@ -288,13 +322,13 @@ class BaseResponseTest(unittest.TestCase): yield req def _links_response(self): - body = get_testdata('link_extractor', 'linkextractor.html') - resp = self.response_class('http://example.com/index', body=body) + body = get_testdata("link_extractor", "linkextractor.html") + resp = self.response_class("http://example.com/index", body=body) return resp def _links_response_no_href(self): - body = get_testdata('link_extractor', 'linkextractor_no_href.html') - resp = self.response_class('http://example.com/index', body=body) + body = get_testdata("link_extractor", "linkextractor_no_href.html") + resp = self.response_class("http://example.com/index", body=body) return resp @@ -304,7 +338,9 @@ class TextResponseTest(BaseResponseTest): def test_replace(self): super().test_replace() - r1 = self.response_class("http://www.example.com", body="hello", encoding="cp852") + r1 = self.response_class( + "http://www.example.com", body="hello", encoding="cp852" + ) r2 = r1.replace(url="http://www.example.com/other") r3 = r1.replace(url="http://www.example.com/other", encoding="latin1") @@ -320,52 +356,89 @@ class TextResponseTest(BaseResponseTest): self._assert_response_encoding(resp, self.response_class._DEFAULT_ENCODING) # make sure urls are converted to str - resp = self.response_class(url="http://www.example.com/", encoding='utf-8') + resp = self.response_class(url="http://www.example.com/", encoding="utf-8") assert isinstance(resp.url, str) - resp = self.response_class(url="http://www.example.com/price/\xa3", encoding='utf-8') - self.assertEqual(resp.url, to_unicode(b'http://www.example.com/price/\xc2\xa3')) - resp = self.response_class(url="http://www.example.com/price/\xa3", encoding='latin-1') - self.assertEqual(resp.url, 'http://www.example.com/price/\xa3') - resp = self.response_class("http://www.example.com/price/\xa3", - headers={"Content-type": ["text/html; charset=utf-8"]}) - self.assertEqual(resp.url, to_unicode(b'http://www.example.com/price/\xc2\xa3')) - resp = self.response_class("http://www.example.com/price/\xa3", - headers={"Content-type": ["text/html; charset=iso-8859-1"]}) - self.assertEqual(resp.url, 'http://www.example.com/price/\xa3') + resp = self.response_class( + url="http://www.example.com/price/\xa3", encoding="utf-8" + ) + self.assertEqual(resp.url, to_unicode(b"http://www.example.com/price/\xc2\xa3")) + resp = self.response_class( + url="http://www.example.com/price/\xa3", encoding="latin-1" + ) + self.assertEqual(resp.url, "http://www.example.com/price/\xa3") + resp = self.response_class( + "http://www.example.com/price/\xa3", + headers={"Content-type": ["text/html; charset=utf-8"]}, + ) + self.assertEqual(resp.url, to_unicode(b"http://www.example.com/price/\xc2\xa3")) + resp = self.response_class( + "http://www.example.com/price/\xa3", + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) + self.assertEqual(resp.url, "http://www.example.com/price/\xa3") def test_unicode_body(self): - unicode_string = ('\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0447\u0435\u0441\u043a\u0438\u0439 ' - '\u0442\u0435\u043a\u0441\u0442') - self.assertRaises(TypeError, self.response_class, 'http://www.example.com', body='unicode body') + unicode_string = ( + "\u043a\u0438\u0440\u0438\u043b\u043b\u0438\u0447\u0435\u0441\u043a\u0438\u0439 " + "\u0442\u0435\u043a\u0441\u0442" + ) + self.assertRaises( + TypeError, + self.response_class, + "http://www.example.com", + body="unicode body", + ) - original_string = unicode_string.encode('cp1251') - r1 = self.response_class('http://www.example.com', body=original_string, encoding='cp1251') + original_string = unicode_string.encode("cp1251") + r1 = self.response_class( + "http://www.example.com", body=original_string, encoding="cp1251" + ) # check response.text self.assertTrue(isinstance(r1.text, str)) self.assertEqual(r1.text, unicode_string) def test_encoding(self): - r1 = self.response_class("http://www.example.com", body=b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=utf-8"]}) - r2 = self.response_class("http://www.example.com", encoding='utf-8', body="\xa3") - r3 = self.response_class("http://www.example.com", body=b"\xa3", - headers={"Content-type": ["text/html; charset=iso-8859-1"]}) + r1 = self.response_class( + "http://www.example.com", + body=b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=utf-8"]}, + ) + r2 = self.response_class( + "http://www.example.com", encoding="utf-8", body="\xa3" + ) + r3 = self.response_class( + "http://www.example.com", + body=b"\xa3", + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) r4 = self.response_class("http://www.example.com", body=b"\xa2\xa3") - r5 = self.response_class("http://www.example.com", body=b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=None"]}) - r6 = self.response_class("http://www.example.com", body=b"\xa8D", - headers={"Content-type": ["text/html; charset=gb2312"]}) - r7 = self.response_class("http://www.example.com", body=b"\xa8D", - headers={"Content-type": ["text/html; charset=gbk"]}) - r8 = self.response_class("http://www.example.com", body=codecs.BOM_UTF8 + b"\xc2\xa3", - headers={"Content-type": ["text/html; charset=cp1251"]}) + r5 = self.response_class( + "http://www.example.com", + body=b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=None"]}, + ) + r6 = self.response_class( + "http://www.example.com", + body=b"\xa8D", + headers={"Content-type": ["text/html; charset=gb2312"]}, + ) + r7 = self.response_class( + "http://www.example.com", + body=b"\xa8D", + headers={"Content-type": ["text/html; charset=gbk"]}, + ) + r8 = self.response_class( + "http://www.example.com", + body=codecs.BOM_UTF8 + b"\xc2\xa3", + headers={"Content-type": ["text/html; charset=cp1251"]}, + ) self.assertEqual(r1._headers_encoding(), "utf-8") self.assertEqual(r2._headers_encoding(), None) - self.assertEqual(r2._declared_encoding(), 'utf-8') - self._assert_response_encoding(r2, 'utf-8') + self.assertEqual(r2._declared_encoding(), "utf-8") + self._assert_response_encoding(r2, "utf-8") self.assertEqual(r3._headers_encoding(), "cp1252") self.assertEqual(r3._declared_encoding(), "cp1252") self.assertEqual(r4._headers_encoding(), None) @@ -374,81 +447,96 @@ class TextResponseTest(BaseResponseTest): self.assertEqual(r8._declared_encoding(), "utf-8") self._assert_response_encoding(r5, "utf-8") self._assert_response_encoding(r8, "utf-8") - assert r4._body_inferred_encoding() is not None and r4._body_inferred_encoding() != 'ascii' - self._assert_response_values(r1, 'utf-8', "\xa3") - self._assert_response_values(r2, 'utf-8', "\xa3") - self._assert_response_values(r3, 'iso-8859-1', "\xa3") - self._assert_response_values(r6, 'gb18030', "\u2015") - self._assert_response_values(r7, 'gb18030', "\u2015") + assert ( + r4._body_inferred_encoding() is not None + and r4._body_inferred_encoding() != "ascii" + ) + self._assert_response_values(r1, "utf-8", "\xa3") + self._assert_response_values(r2, "utf-8", "\xa3") + self._assert_response_values(r3, "iso-8859-1", "\xa3") + self._assert_response_values(r6, "gb18030", "\u2015") + self._assert_response_values(r7, "gb18030", "\u2015") # TextResponse (and subclasses) must be passed a encoding when instantiating with unicode bodies - self.assertRaises(TypeError, self.response_class, "http://www.example.com", body="\xa3") + self.assertRaises( + TypeError, self.response_class, "http://www.example.com", body="\xa3" + ) def test_declared_encoding_invalid(self): """Check that unknown declared encodings are ignored""" - r = self.response_class("http://www.example.com", - headers={"Content-type": ["text/html; charset=UNKNOWN"]}, - body=b"\xc2\xa3") + r = self.response_class( + "http://www.example.com", + headers={"Content-type": ["text/html; charset=UNKNOWN"]}, + body=b"\xc2\xa3", + ) self.assertEqual(r._declared_encoding(), None) - self._assert_response_values(r, 'utf-8', "\xa3") + self._assert_response_values(r, "utf-8", "\xa3") def test_utf16(self): """Test utf-16 because UnicodeDammit is known to have problems with""" - r = self.response_class("http://www.example.com", - body=b'\xff\xfeh\x00i\x00', - encoding='utf-16') - self._assert_response_values(r, 'utf-16', "hi") + r = self.response_class( + "http://www.example.com", body=b"\xff\xfeh\x00i\x00", encoding="utf-16" + ) + self._assert_response_values(r, "utf-16", "hi") def test_invalid_utf8_encoded_body_with_valid_utf8_BOM(self): - r6 = self.response_class("http://www.example.com", - headers={"Content-type": ["text/html; charset=utf-8"]}, - body=b"\xef\xbb\xbfWORD\xe3\xab") - self.assertEqual(r6.encoding, 'utf-8') - self.assertIn(r6.text, { - 'WORD\ufffd\ufffd', # w3lib < 1.19.0 - 'WORD\ufffd', # w3lib >= 1.19.0 - }) + r6 = self.response_class( + "http://www.example.com", + headers={"Content-type": ["text/html; charset=utf-8"]}, + body=b"\xef\xbb\xbfWORD\xe3\xab", + ) + self.assertEqual(r6.encoding, "utf-8") + self.assertIn( + r6.text, + { + "WORD\ufffd\ufffd", # w3lib < 1.19.0 + "WORD\ufffd", # w3lib >= 1.19.0 + }, + ) def test_bom_is_removed_from_body(self): # Inferring encoding from body also cache decoded body as sideeffect, # this test tries to ensure that calling response.encoding and # response.text in indistint order doesn't affect final # values for encoding and decoded body. - url = 'http://example.com' + url = "http://example.com" body = b"\xef\xbb\xbfWORD" headers = {"Content-type": ["text/html; charset=utf-8"]} # Test response without content-type and BOM encoding response = self.response_class(url, body=body) - self.assertEqual(response.encoding, 'utf-8') - self.assertEqual(response.text, 'WORD') + self.assertEqual(response.encoding, "utf-8") + self.assertEqual(response.text, "WORD") response = self.response_class(url, body=body) - self.assertEqual(response.text, 'WORD') - self.assertEqual(response.encoding, 'utf-8') + self.assertEqual(response.text, "WORD") + self.assertEqual(response.encoding, "utf-8") # Body caching sideeffect isn't triggered when encoding is declared in # content-type header but BOM still need to be removed from decoded # body response = self.response_class(url, headers=headers, body=body) - self.assertEqual(response.encoding, 'utf-8') - self.assertEqual(response.text, 'WORD') + self.assertEqual(response.encoding, "utf-8") + self.assertEqual(response.text, "WORD") response = self.response_class(url, headers=headers, body=body) - self.assertEqual(response.text, 'WORD') - self.assertEqual(response.encoding, 'utf-8') + self.assertEqual(response.text, "WORD") + self.assertEqual(response.encoding, "utf-8") def test_replace_wrong_encoding(self): """Test invalid chars are replaced properly""" - r = self.response_class("http://www.example.com", encoding='utf-8', body=b'PREFIX\xe3\xabSUFFIX') + r = self.response_class( + "http://www.example.com", encoding="utf-8", body=b"PREFIX\xe3\xabSUFFIX" + ) # XXX: Policy for replacing invalid chars may suffer minor variations # but it should always contain the unicode replacement char ('\ufffd') - assert '\ufffd' in r.text, repr(r.text) - assert 'PREFIX' in r.text, repr(r.text) - assert 'SUFFIX' in r.text, repr(r.text) + assert "\ufffd" in r.text, repr(r.text) + assert "PREFIX" in r.text, repr(r.text) + assert "SUFFIX" in r.text, repr(r.text) # Do not destroy html tags due to encoding bugs - r = self.response_class("http://example.com", encoding='utf-8', - body=b'\xf0value') - assert 'value' in r.text, repr(r.text) + r = self.response_class( + "http://example.com", encoding="utf-8", body=b"\xf0value" + ) + assert "value" in r.text, repr(r.text) # FIXME: This test should pass once we stop using BeautifulSoup's UnicodeDammit in TextResponse # r = self.response_class("http://www.example.com", body=b'PREFIX\xe3\xabSUFFIX') @@ -459,22 +547,15 @@ class TextResponseTest(BaseResponseTest): response = self.response_class("http://www.example.com", body=body) self.assertIsInstance(response.selector, Selector) - self.assertEqual(response.selector.type, 'html') + self.assertEqual(response.selector.type, "html") self.assertIs(response.selector, response.selector) # property is cached self.assertIs(response.selector.response, response) self.assertEqual( - response.selector.xpath("//title/text()").getall(), - ['Some page'] - ) - self.assertEqual( - response.selector.css("title::text").getall(), - ['Some page'] - ) - self.assertEqual( - response.selector.re("Some (.*)"), - ['page'] + response.selector.xpath("//title/text()").getall(), ["Some page"] ) + self.assertEqual(response.selector.css("title::text").getall(), ["Some page"]) + self.assertEqual(response.selector.re("Some (.*)"), ["page"]) def test_selector_shortcuts(self): body = b"Some page" @@ -490,151 +571,163 @@ class TextResponseTest(BaseResponseTest): ) def test_selector_shortcuts_kwargs(self): - body = b"Some page

A nice paragraph.

" + body = b'Some page

A nice paragraph.

' response = self.response_class("http://www.example.com", body=body) self.assertEqual( - response.xpath("normalize-space(//p[@class=$pclass])", pclass="content").getall(), - response.xpath("normalize-space(//p[@class=\"content\"])").getall(), + response.xpath( + "normalize-space(//p[@class=$pclass])", pclass="content" + ).getall(), + response.xpath('normalize-space(//p[@class="content"])').getall(), ) self.assertEqual( response.xpath( "//title[count(following::p[@class=$pclass])=$pcount]/text()", - pclass="content", pcount=1, + pclass="content", + pcount=1, + ).getall(), + response.xpath( + '//title[count(following::p[@class="content"])=1]/text()' ).getall(), - response.xpath("//title[count(following::p[@class=\"content\"])=1]/text()").getall(), ) def test_urljoin_with_base_url(self): """Test urljoin shortcut which also evaluates base-url through get_base_url().""" body = b'' - joined = self.response_class('http://www.example.com', body=body).urljoin('/test') - absolute = 'https://example.net/test' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "/test" + ) + absolute = "https://example.net/test" self.assertEqual(joined, absolute) body = b'' - joined = self.response_class('http://www.example.com', body=body).urljoin('test') - absolute = 'http://www.example.com/test' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "test" + ) + absolute = "http://www.example.com/test" self.assertEqual(joined, absolute) body = b'' - joined = self.response_class('http://www.example.com', body=body).urljoin('test') - absolute = 'http://www.example.com/elsewhere/test' + joined = self.response_class("http://www.example.com", body=body).urljoin( + "test" + ) + absolute = "http://www.example.com/elsewhere/test" self.assertEqual(joined, absolute) def test_follow_selector(self): resp = self._links_response() urls = [ - 'http://example.com/sample2.html', - 'http://example.com/sample3.html', - 'http://example.com/sample3.html', - 'http://example.com/sample3.html#foo', - 'http://www.google.com/something', - 'http://example.com/innertag.html' + "http://example.com/sample2.html", + "http://example.com/sample3.html", + "http://example.com/sample3.html", + "http://example.com/sample3.html#foo", + "http://www.google.com/something", + "http://example.com/innertag.html", ] # select elements - for sellist in [resp.css('a'), resp.xpath('//a')]: + for sellist in [resp.css("a"), resp.xpath("//a")]: for sel, url in zip(sellist, urls): self._assert_followed_url(sel, url, response=resp) # select elements self._assert_followed_url( - Selector(text='').css('link')[0], - 'http://example.com/foo', - response=resp + Selector(text='').css("link")[0], + "http://example.com/foo", + response=resp, ) # href attributes should work - for sellist in [resp.css('a::attr(href)'), resp.xpath('//a/@href')]: + for sellist in [resp.css("a::attr(href)"), resp.xpath("//a/@href")]: for sel, url in zip(sellist, urls): self._assert_followed_url(sel, url, response=resp) # non-a elements are not supported - self.assertRaises(ValueError, resp.follow, resp.css('div')[0]) + self.assertRaises(ValueError, resp.follow, resp.css("div")[0]) def test_follow_selector_list(self): resp = self._links_response() - self.assertRaisesRegex(ValueError, 'SelectorList', - resp.follow, resp.css('a')) + self.assertRaisesRegex(ValueError, "SelectorList", resp.follow, resp.css("a")) def test_follow_selector_invalid(self): resp = self._links_response() - self.assertRaisesRegex(ValueError, 'Unsupported', - resp.follow, resp.xpath('count(//div)')[0]) + self.assertRaisesRegex( + ValueError, "Unsupported", resp.follow, resp.xpath("count(//div)")[0] + ) def test_follow_selector_attribute(self): resp = self._links_response() - for src in resp.css('img::attr(src)'): - self._assert_followed_url(src, 'http://example.com/sample2.jpg') + for src in resp.css("img::attr(src)"): + self._assert_followed_url(src, "http://example.com/sample2.jpg") def test_follow_selector_no_href(self): resp = self.response_class( - url='http://example.com', - body=b'click me', + url="http://example.com", + body=b"click me", ) - self.assertRaisesRegex(ValueError, 'no href', - resp.follow, resp.css('a')[0]) + self.assertRaisesRegex(ValueError, "no href", resp.follow, resp.css("a")[0]) def test_follow_whitespace_selector(self): resp = self.response_class( - 'http://example.com', - body=b'''click me''' + "http://example.com", + body=b"""click me""", ) self._assert_followed_url( - resp.css('a')[0], - 'http://example.com/foo', - response=resp) + resp.css("a")[0], "http://example.com/foo", response=resp + ) self._assert_followed_url( - resp.css('a::attr(href)')[0], - 'http://example.com/foo', - response=resp) + resp.css("a::attr(href)")[0], "http://example.com/foo", response=resp + ) def test_follow_encoding(self): resp1 = self.response_class( - 'http://example.com', - encoding='utf8', - body='click me'.encode('utf8') + "http://example.com", + encoding="utf8", + body='click me'.encode( + "utf8" + ), ) req = self._assert_followed_url( - resp1.css('a')[0], - 'http://example.com/foo?%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82', + resp1.css("a")[0], + "http://example.com/foo?%D0%BF%D1%80%D0%B8%D0%B2%D0%B5%D1%82", response=resp1, ) - self.assertEqual(req.encoding, 'utf8') + self.assertEqual(req.encoding, "utf8") resp2 = self.response_class( - 'http://example.com', - encoding='cp1251', - body='click me'.encode('cp1251') + "http://example.com", + encoding="cp1251", + body='click me'.encode( + "cp1251" + ), ) req = self._assert_followed_url( - resp2.css('a')[0], - 'http://example.com/foo?%EF%F0%E8%E2%E5%F2', + resp2.css("a")[0], + "http://example.com/foo?%EF%F0%E8%E2%E5%F2", response=resp2, ) - self.assertEqual(req.encoding, 'cp1251') + self.assertEqual(req.encoding, "cp1251") def test_follow_flags(self): - res = self.response_class('http://example.com/') - fol = res.follow('http://example.com/', flags=['cached', 'allowed']) - self.assertEqual(fol.flags, ['cached', 'allowed']) + res = self.response_class("http://example.com/") + fol = res.follow("http://example.com/", flags=["cached", "allowed"]) + self.assertEqual(fol.flags, ["cached", "allowed"]) def test_follow_all_flags(self): - re = self.response_class('http://www.example.com/') + re = self.response_class("http://www.example.com/") urls = [ - 'http://www.example.com/', - 'http://www.example.com/2', - 'http://www.example.com/foo', + "http://www.example.com/", + "http://www.example.com/2", + "http://www.example.com/foo", ] - fol = re.follow_all(urls, flags=['cached', 'allowed']) + fol = re.follow_all(urls, flags=["cached", "allowed"]) for req in fol: - self.assertEqual(req.flags, ['cached', 'allowed']) + self.assertEqual(req.flags, ["cached", "allowed"]) def test_follow_all_css(self): expected = [ - 'http://example.com/sample3.html', - 'http://example.com/innertag.html', + "http://example.com/sample3.html", + "http://example.com/innertag.html", ] response = self._links_response() extracted = [r.url for r in response.follow_all(css='a[href*="example.com"]')] @@ -642,20 +735,20 @@ class TextResponseTest(BaseResponseTest): def test_follow_all_css_skip_invalid(self): expected = [ - 'http://example.com/page/1/', - 'http://example.com/page/3/', - 'http://example.com/page/4/', + "http://example.com/page/1/", + "http://example.com/page/3/", + "http://example.com/page/4/", ] response = self._links_response_no_href() - extracted1 = [r.url for r in response.follow_all(css='.pagination a')] + extracted1 = [r.url for r in response.follow_all(css=".pagination a")] self.assertEqual(expected, extracted1) - extracted2 = [r.url for r in response.follow_all(response.css('.pagination a'))] + extracted2 = [r.url for r in response.follow_all(response.css(".pagination a"))] self.assertEqual(expected, extracted2) def test_follow_all_xpath(self): expected = [ - 'http://example.com/sample3.html', - 'http://example.com/innertag.html', + "http://example.com/sample3.html", + "http://example.com/innertag.html", ] response = self._links_response() extracted = response.follow_all(xpath='//a[contains(@href, "example.com")]') @@ -663,25 +756,33 @@ class TextResponseTest(BaseResponseTest): def test_follow_all_xpath_skip_invalid(self): expected = [ - 'http://example.com/page/1/', - 'http://example.com/page/3/', - 'http://example.com/page/4/', + "http://example.com/page/1/", + "http://example.com/page/3/", + "http://example.com/page/4/", ] response = self._links_response_no_href() - extracted1 = [r.url for r in response.follow_all(xpath='//div[@id="pagination"]/a')] + extracted1 = [ + r.url for r in response.follow_all(xpath='//div[@id="pagination"]/a') + ] self.assertEqual(expected, extracted1) - extracted2 = [r.url for r in response.follow_all(response.xpath('//div[@id="pagination"]/a'))] + extracted2 = [ + r.url + for r in response.follow_all(response.xpath('//div[@id="pagination"]/a')) + ] self.assertEqual(expected, extracted2) def test_follow_all_too_many_arguments(self): response = self._links_response() with self.assertRaises(ValueError): - response.follow_all(css='a[href*="example.com"]', xpath='//a[contains(@href, "example.com")]') + response.follow_all( + css='a[href*="example.com"]', + xpath='//a[contains(@href, "example.com")]', + ) def test_json_response(self): json_body = b"""{"ip": "109.187.217.200"}""" json_response = self.response_class("http://www.example.com", body=json_body) - self.assertEqual(json_response.json(), {'ip': '109.187.217.200'}) + self.assertEqual(json_response.json(), {"ip": "109.187.217.200"}) text_body = b"""text""" text_response = self.response_class("http://www.example.com", body=text_body) @@ -691,9 +792,11 @@ class TextResponseTest(BaseResponseTest): def test_cache_json_response(self): json_valid_bodies = [b"""{"ip": "109.187.217.200"}""", b"""null"""] for json_body in json_valid_bodies: - json_response = self.response_class("http://www.example.com", body=json_body) + json_response = self.response_class( + "http://www.example.com", body=json_body + ) - with mock.patch('json.loads') as mock_json: + with mock.patch("json.loads") as mock_json: for _ in range(2): json_response.json() mock_json.assert_called_once_with(json_body.decode()) @@ -710,33 +813,36 @@ class HtmlResponseTest(TextResponseTest): Price: \xa3100' """ r1 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r1, 'iso-8859-1', body) + self._assert_response_values(r1, "iso-8859-1", body) body = b""" Price: \xa3100 """ r2 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r2, 'iso-8859-1', body) + self._assert_response_values(r2, "iso-8859-1", body) # for conflicting declarations headers must take precedence body = b"""Some page Price: \xa3100' """ - r3 = self.response_class("http://www.example.com", body=body, - headers={"Content-type": ["text/html; charset=iso-8859-1"]}) - self._assert_response_values(r3, 'iso-8859-1', body) + r3 = self.response_class( + "http://www.example.com", + body=body, + headers={"Content-type": ["text/html; charset=iso-8859-1"]}, + ) + self._assert_response_values(r3, "iso-8859-1", body) # make sure replace() preserves the encoding of the original response body = b"New body \xa3" r4 = r3.replace(body=body) - self._assert_response_values(r4, 'iso-8859-1', body) + self._assert_response_values(r4, "iso-8859-1", body) def test_html5_meta_charset(self): body = b"""Some pagebla bla""" r1 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r1, 'gb2312', body) + self._assert_response_values(r1, "gb2312", body) class XmlResponseTest(TextResponseTest): @@ -750,14 +856,14 @@ class XmlResponseTest(TextResponseTest): body = b"""""" r2 = self.response_class("http://www.example.com", body=body) - self._assert_response_values(r2, 'iso-8859-1', body) + self._assert_response_values(r2, "iso-8859-1", body) # make sure replace() preserves the explicit encoding passed in the __init__ method body = b"""""" - r3 = self.response_class("http://www.example.com", body=body, encoding='utf-8') + r3 = self.response_class("http://www.example.com", body=body, encoding="utf-8") body2 = b"New body" r4 = r3.replace(body=body2) - self._assert_response_values(r4, 'utf-8', body2) + self._assert_response_values(r4, "utf-8", body2) def test_replace_encoding(self): # make sure replace() keeps the previous encoding unless overridden explicitly @@ -765,24 +871,21 @@ class XmlResponseTest(TextResponseTest): body2 = b"""""" r5 = self.response_class("http://www.example.com", body=body) r6 = r5.replace(body=body2) - r7 = r5.replace(body=body2, encoding='utf-8') - self._assert_response_values(r5, 'iso-8859-1', body) - self._assert_response_values(r6, 'iso-8859-1', body2) - self._assert_response_values(r7, 'utf-8', body2) + r7 = r5.replace(body=body2, encoding="utf-8") + self._assert_response_values(r5, "iso-8859-1", body) + self._assert_response_values(r6, "iso-8859-1", body2) + self._assert_response_values(r7, "utf-8", body2) def test_selector(self): body = b'value' response = self.response_class("http://www.example.com", body=body) self.assertIsInstance(response.selector, Selector) - self.assertEqual(response.selector.type, 'xml') + self.assertEqual(response.selector.type, "xml") self.assertIs(response.selector, response.selector) # property is cached self.assertIs(response.selector.response, response) - self.assertEqual( - response.selector.xpath("//elem/text()").getall(), - ['value'] - ) + self.assertEqual(response.selector.xpath("//elem/text()").getall(), ["value"]) def test_selector_shortcuts(self): body = b'value' @@ -794,20 +897,26 @@ class XmlResponseTest(TextResponseTest): ) def test_selector_shortcuts_kwargs(self): - body = b''' + body = b""" value - ''' + """ response = self.response_class("http://www.example.com", body=body) self.assertEqual( - response.xpath("//s:elem/text()", namespaces={'s': 'http://scrapy.org'}).getall(), - response.selector.xpath("//s:elem/text()", namespaces={'s': 'http://scrapy.org'}).getall(), + response.xpath( + "//s:elem/text()", namespaces={"s": "http://scrapy.org"} + ).getall(), + response.selector.xpath( + "//s:elem/text()", namespaces={"s": "http://scrapy.org"} + ).getall(), ) - response.selector.register_namespace('s2', 'http://scrapy.org') + response.selector.register_namespace("s2", "http://scrapy.org") self.assertEqual( - response.xpath("//s1:elem/text()", namespaces={'s1': 'http://scrapy.org'}).getall(), + response.xpath( + "//s1:elem/text()", namespaces={"s1": "http://scrapy.org"} + ).getall(), response.selector.xpath("//s2:elem/text()").getall(), ) @@ -827,7 +936,9 @@ class CustomResponseTest(TextResponseTest): def test_copy(self): super().test_copy() - r1 = self.response_class(url="https://example.org", status=200, foo="foo", bar="bar", lost="lost") + r1 = self.response_class( + url="https://example.org", status=200, foo="foo", bar="bar", lost="lost" + ) r2 = r1.copy() self.assertIsInstance(r2, self.response_class) self.assertEqual(r1.foo, r2.foo) @@ -837,7 +948,9 @@ class CustomResponseTest(TextResponseTest): def test_replace(self): super().test_replace() - r1 = self.response_class(url="https://example.org", status=200, foo="foo", bar="bar", lost="lost") + r1 = self.response_class( + url="https://example.org", status=200, foo="foo", bar="bar", lost="lost" + ) r2 = r1.replace(foo="new-foo", bar="new-bar", lost="new-lost") self.assertIsInstance(r2, self.response_class) @@ -868,4 +981,8 @@ class CustomResponseTest(TextResponseTest): with self.assertRaises(TypeError) as ctx: r1.replace(unknown="unknown") - self.assertTrue(str(ctx.exception).endswith("__init__() got an unexpected keyword argument 'unknown'")) + self.assertTrue( + str(ctx.exception).endswith( + "__init__() got an unexpected keyword argument 'unknown'" + ) + ) diff --git a/tests/test_item.py b/tests/test_item.py index 25f2aea0a..ce2b4fd15 100644 --- a/tests/test_item.py +++ b/tests/test_item.py @@ -5,7 +5,6 @@ from scrapy.item import ABCMeta, Field, Item, ItemMeta class ItemTest(unittest.TestCase): - def assertSortedEqual(self, first, second, msg=None): return self.assertEqual(sorted(first), sorted(second), msg) @@ -14,35 +13,34 @@ class ItemTest(unittest.TestCase): name = Field() i = TestItem() - i['name'] = 'name' - self.assertEqual(i['name'], 'name') + i["name"] = "name" + self.assertEqual(i["name"], "name") def test_init(self): class TestItem(Item): name = Field() i = TestItem() - self.assertRaises(KeyError, i.__getitem__, 'name') + self.assertRaises(KeyError, i.__getitem__, "name") - i2 = TestItem(name='john doe') - self.assertEqual(i2['name'], 'john doe') + i2 = TestItem(name="john doe") + self.assertEqual(i2["name"], "john doe") - i3 = TestItem({'name': 'john doe'}) - self.assertEqual(i3['name'], 'john doe') + i3 = TestItem({"name": "john doe"}) + self.assertEqual(i3["name"], "john doe") i4 = TestItem(i3) - self.assertEqual(i4['name'], 'john doe') + self.assertEqual(i4["name"], "john doe") - self.assertRaises(KeyError, TestItem, {'name': 'john doe', - 'other': 'foo'}) + self.assertRaises(KeyError, TestItem, {"name": "john doe", "other": "foo"}) def test_invalid_field(self): class TestItem(Item): pass i = TestItem() - self.assertRaises(KeyError, i.__setitem__, 'field', 'text') - self.assertRaises(KeyError, i.__getitem__, 'field') + self.assertRaises(KeyError, i.__setitem__, "field", "text") + self.assertRaises(KeyError, i.__getitem__, "field") def test_repr(self): class TestItem(Item): @@ -50,55 +48,54 @@ class ItemTest(unittest.TestCase): number = Field() i = TestItem() - i['name'] = 'John Doe' - i['number'] = 123 + i["name"] = "John Doe" + i["number"] = 123 itemrepr = repr(i) - self.assertEqual(itemrepr, - "{'name': 'John Doe', 'number': 123}") + self.assertEqual(itemrepr, "{'name': 'John Doe', 'number': 123}") i2 = eval(itemrepr) - self.assertEqual(i2['name'], 'John Doe') - self.assertEqual(i2['number'], 123) + self.assertEqual(i2["name"], "John Doe") + self.assertEqual(i2["number"], 123) def test_private_attr(self): class TestItem(Item): name = Field() i = TestItem() - i._private = 'test' - self.assertEqual(i._private, 'test') + i._private = "test" + self.assertEqual(i._private, "test") def test_raise_getattr(self): class TestItem(Item): name = Field() i = TestItem() - self.assertRaises(AttributeError, getattr, i, 'name') + self.assertRaises(AttributeError, getattr, i, "name") def test_raise_setattr(self): class TestItem(Item): name = Field() i = TestItem() - self.assertRaises(AttributeError, setattr, i, 'name', 'john') + self.assertRaises(AttributeError, setattr, i, "name", "john") def test_custom_methods(self): class TestItem(Item): name = Field() def get_name(self): - return self['name'] + return self["name"] def change_name(self, name): - self['name'] = name + self["name"] = name i = TestItem() self.assertRaises(KeyError, i.get_name) - i['name'] = 'lala' - self.assertEqual(i.get_name(), 'lala') - i.change_name('other') - self.assertEqual(i.get_name(), 'other') + i["name"] = "lala" + self.assertEqual(i.get_name(), "lala") + i.change_name("other") + self.assertEqual(i.get_name(), "other") def test_metaclass(self): class TestItem(Item): @@ -107,22 +104,22 @@ class ItemTest(unittest.TestCase): values = Field() i = TestItem() - i['name'] = 'John' - self.assertEqual(list(i.keys()), ['name']) - self.assertEqual(list(i.values()), ['John']) + i["name"] = "John" + self.assertEqual(list(i.keys()), ["name"]) + self.assertEqual(list(i.values()), ["John"]) - i['keys'] = 'Keys' - i['values'] = 'Values' - self.assertSortedEqual(list(i.keys()), ['keys', 'values', 'name']) - self.assertSortedEqual(list(i.values()), ['Keys', 'Values', 'John']) + i["keys"] = "Keys" + i["values"] = "Values" + self.assertSortedEqual(list(i.keys()), ["keys", "values", "name"]) + self.assertSortedEqual(list(i.values()), ["Keys", "Values", "John"]) def test_metaclass_with_fields_attribute(self): class TestItem(Item): - fields = {'new': Field(default='X')} + fields = {"new": Field(default="X")} - item = TestItem(new='New') - self.assertSortedEqual(list(item.keys()), ['new']) - self.assertSortedEqual(list(item.values()), ['New']) + item = TestItem(new="New") + self.assertSortedEqual(list(item.keys()), ["new"]) + self.assertSortedEqual(list(item.values()), ["New"]) def test_metaclass_inheritance(self): class ParentItem(Item): @@ -134,151 +131,163 @@ class ItemTest(unittest.TestCase): keys = Field() i = TestItem() - i['keys'] = 3 - self.assertEqual(list(i.keys()), ['keys']) + i["keys"] = 3 + self.assertEqual(list(i.keys()), ["keys"]) self.assertEqual(list(i.values()), [3]) def test_metaclass_multiple_inheritance_simple(self): class A(Item): - fields = {'load': Field(default='A')} - save = Field(default='A') + fields = {"load": Field(default="A")} + save = Field(default="A") class B(A): pass class C(Item): - fields = {'load': Field(default='C')} - save = Field(default='C') + fields = {"load": Field(default="C")} + save = Field(default="C") class D(B, C): pass - item = D(save='X', load='Y') - self.assertEqual(item['save'], 'X') - self.assertEqual(item['load'], 'Y') - self.assertEqual(D.fields, {'load': {'default': 'A'}, 'save': {'default': 'A'}}) + item = D(save="X", load="Y") + self.assertEqual(item["save"], "X") + self.assertEqual(item["load"], "Y") + self.assertEqual(D.fields, {"load": {"default": "A"}, "save": {"default": "A"}}) # D class inverted class E(C, B): pass - self.assertEqual(E(save='X')['save'], 'X') - self.assertEqual(E(load='X')['load'], 'X') - self.assertEqual(E.fields, {'load': {'default': 'C'}, 'save': {'default': 'C'}}) + self.assertEqual(E(save="X")["save"], "X") + self.assertEqual(E(load="X")["load"], "X") + self.assertEqual(E.fields, {"load": {"default": "C"}, "save": {"default": "C"}}) def test_metaclass_multiple_inheritance_diamond(self): class A(Item): - fields = {'update': Field(default='A')} - save = Field(default='A') - load = Field(default='A') + fields = {"update": Field(default="A")} + save = Field(default="A") + load = Field(default="A") class B(A): pass class C(A): - fields = {'update': Field(default='C')} - save = Field(default='C') + fields = {"update": Field(default="C")} + save = Field(default="C") class D(B, C): - fields = {'update': Field(default='D')} - load = Field(default='D') + fields = {"update": Field(default="D")} + load = Field(default="D") - self.assertEqual(D(save='X')['save'], 'X') - self.assertEqual(D(load='X')['load'], 'X') + self.assertEqual(D(save="X")["save"], "X") + self.assertEqual(D(load="X")["load"], "X") self.assertEqual( D.fields, - {'save': {'default': 'C'}, 'load': {'default': 'D'}, 'update': {'default': 'D'}}) + { + "save": {"default": "C"}, + "load": {"default": "D"}, + "update": {"default": "D"}, + }, + ) # D class inverted class E(C, B): - load = Field(default='E') + load = Field(default="E") - self.assertEqual(E(save='X')['save'], 'X') - self.assertEqual(E(load='X')['load'], 'X') + self.assertEqual(E(save="X")["save"], "X") + self.assertEqual(E(load="X")["load"], "X") self.assertEqual( E.fields, - {'save': {'default': 'C'}, 'load': {'default': 'E'}, 'update': {'default': 'C'}}) + { + "save": {"default": "C"}, + "load": {"default": "E"}, + "update": {"default": "C"}, + }, + ) def test_metaclass_multiple_inheritance_without_metaclass(self): class A(Item): - fields = {'load': Field(default='A')} - save = Field(default='A') + fields = {"load": Field(default="A")} + save = Field(default="A") class B(A): pass class C: - fields = {'load': Field(default='C')} - not_allowed = Field(default='not_allowed') - save = Field(default='C') + fields = {"load": Field(default="C")} + not_allowed = Field(default="not_allowed") + save = Field(default="C") class D(B, C): pass - self.assertRaises(KeyError, D, not_allowed='value') - self.assertEqual(D(save='X')['save'], 'X') - self.assertEqual(D.fields, {'save': {'default': 'A'}, 'load': {'default': 'A'}}) + self.assertRaises(KeyError, D, not_allowed="value") + self.assertEqual(D(save="X")["save"], "X") + self.assertEqual(D.fields, {"save": {"default": "A"}, "load": {"default": "A"}}) # D class inverted class E(C, B): pass - self.assertRaises(KeyError, E, not_allowed='value') - self.assertEqual(E(save='X')['save'], 'X') - self.assertEqual(E.fields, {'save': {'default': 'A'}, 'load': {'default': 'A'}}) + self.assertRaises(KeyError, E, not_allowed="value") + self.assertEqual(E(save="X")["save"], "X") + self.assertEqual(E.fields, {"save": {"default": "A"}, "load": {"default": "A"}}) def test_to_dict(self): class TestItem(Item): name = Field() i = TestItem() - i['name'] = 'John' - self.assertEqual(dict(i), {'name': 'John'}) + i["name"] = "John" + self.assertEqual(dict(i), {"name": "John"}) def test_copy(self): class TestItem(Item): name = Field() - item = TestItem({'name': 'lower'}) + + item = TestItem({"name": "lower"}) copied_item = item.copy() self.assertNotEqual(id(item), id(copied_item)) - copied_item['name'] = copied_item['name'].upper() - self.assertNotEqual(item['name'], copied_item['name']) + copied_item["name"] = copied_item["name"].upper() + self.assertNotEqual(item["name"], copied_item["name"]) def test_deepcopy(self): class TestItem(Item): tags = Field() - item = TestItem({'tags': ['tag1']}) + + item = TestItem({"tags": ["tag1"]}) copied_item = item.deepcopy() - item['tags'].append('tag2') - assert item['tags'] != copied_item['tags'] + item["tags"].append("tag2") + assert item["tags"] != copied_item["tags"] class ItemMetaTest(unittest.TestCase): - def test_new_method_propagates_classcell(self): new_mock = mock.Mock(side_effect=ABCMeta.__new__) base = ItemMeta.__bases__[0] - with mock.patch.object(base, '__new__', new_mock): + with mock.patch.object(base, "__new__", new_mock): class MyItem(Item): def f(self): # For rationale of this see: # https://github.com/python/cpython/blob/ee1a81b77444c6715cbe610e951c655b6adab88b/Lib/test/test_super.py#L222 - return __class__ # noqa https://github.com/scrapy/scrapy/issues/2836 + return ( + __class__ # noqa https://github.com/scrapy/scrapy/issues/2836 + ) MyItem() (first_call, second_call) = new_mock.call_args_list[-2:] mcs, class_name, bases, attrs = first_call[0] - assert '__classcell__' not in attrs + assert "__classcell__" not in attrs mcs, class_name, bases, attrs = second_call[0] - assert '__classcell__' in attrs + assert "__classcell__" in attrs class ItemMetaClassCellRegression(unittest.TestCase): - def test_item_meta_classcell_regression(self): class MyItem(Item, metaclass=ItemMeta): def __init__(self, *args, **kwargs): diff --git a/tests/test_link.py b/tests/test_link.py index e0f1efffa..7ba0851ae 100644 --- a/tests/test_link.py +++ b/tests/test_link.py @@ -4,7 +4,6 @@ from scrapy.link import Link class LinkTest(unittest.TestCase): - def _assert_same_links(self, link1, link2): self.assertEqual(link1, link2) self.assertEqual(hash(link1), hash(link2)) @@ -30,16 +29,26 @@ class LinkTest(unittest.TestCase): self._assert_different_links(l4, l5) self._assert_same_links(l4, l6) - l7 = Link("http://www.example.com", text="test", fragment='something', nofollow=False) - l8 = Link("http://www.example.com", text="test", fragment='something', nofollow=False) - l9 = Link("http://www.example.com", text="test", fragment='something', nofollow=True) - l10 = Link("http://www.example.com", text="test", fragment='other', nofollow=False) + l7 = Link( + "http://www.example.com", text="test", fragment="something", nofollow=False + ) + l8 = Link( + "http://www.example.com", text="test", fragment="something", nofollow=False + ) + l9 = Link( + "http://www.example.com", text="test", fragment="something", nofollow=True + ) + l10 = Link( + "http://www.example.com", text="test", fragment="other", nofollow=False + ) self._assert_same_links(l7, l8) self._assert_different_links(l7, l9) self._assert_different_links(l7, l10) def test_repr(self): - l1 = Link("http://www.example.com", text="test", fragment='something', nofollow=True) + l1 = Link( + "http://www.example.com", text="test", fragment="something", nofollow=True + ) l2 = eval(repr(l1)) self._assert_same_links(l1, l2) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index e28dc9bdb..520effedb 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -14,108 +14,163 @@ class Base: extractor_cls = None def setUp(self): - body = get_testdata('link_extractor', 'linkextractor.html') - self.response = HtmlResponse(url='http://example.com/index', body=body) + body = get_testdata("link_extractor", "linkextractor.html") + self.response = HtmlResponse(url="http://example.com/index", body=body) def test_urls_type(self): - ''' Test that the resulting urls are str objects ''' + """Test that the resulting urls are str objects""" lx = self.extractor_cls() - self.assertTrue(all(isinstance(link.url, str) - for link in lx.extract_links(self.response))) + self.assertTrue( + all( + isinstance(link.url, str) + for link in lx.extract_links(self.response) + ) + ) def test_extract_all_links(self): lx = self.extractor_cls() - page4_url = 'http://example.com/page%204.html' + page4_url = "http://example.com/page%204.html" - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment'), - Link(url='http://www.google.com/something', text=''), - Link(url='http://example.com/innertag.html', text='inner tag'), - Link(url=page4_url, text='href with whitespaces'), - ]) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + Link(url="http://www.google.com/something", text=""), + Link(url="http://example.com/innertag.html", text="inner tag"), + Link(url=page4_url, text="href with whitespaces"), + ], + ) def test_extract_filter_allow(self): - lx = self.extractor_cls(allow=('sample', )) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment') - ]) + lx = self.extractor_cls(allow=("sample",)) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + ], + ) def test_extract_filter_allow_with_duplicates(self): - lx = self.extractor_cls(allow=('sample', ), unique=False) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html', text='sample 3 repetition'), - Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment') - ]) + lx = self.extractor_cls(allow=("sample",), unique=False) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html", + text="sample 3 repetition", + ), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + ], + ) def test_extract_filter_allow_with_duplicates_canonicalize(self): - lx = self.extractor_cls(allow=('sample', ), unique=False, - canonicalize=True) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html', text='sample 3 repetition'), - Link(url='http://example.com/sample3.html', text='sample 3 repetition with fragment') - ]) + lx = self.extractor_cls(allow=("sample",), unique=False, canonicalize=True) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html", + text="sample 3 repetition", + ), + Link( + url="http://example.com/sample3.html", + text="sample 3 repetition with fragment", + ), + ], + ) def test_extract_filter_allow_no_duplicates_canonicalize(self): - lx = self.extractor_cls(allow=('sample',), unique=True, - canonicalize=True) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - ]) + lx = self.extractor_cls(allow=("sample",), unique=True, canonicalize=True) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + ], + ) def test_extract_filter_allow_and_deny(self): - lx = self.extractor_cls(allow=('sample', ), deny=('3', )) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - ]) + lx = self.extractor_cls(allow=("sample",), deny=("3",)) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + ], + ) def test_extract_filter_allowed_domains(self): - lx = self.extractor_cls(allow_domains=('google.com', )) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://www.google.com/something', text=''), - ]) + lx = self.extractor_cls(allow_domains=("google.com",)) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://www.google.com/something", text=""), + ], + ) def test_extraction_using_single_values(self): - '''Test the extractor's behaviour among different situations''' + """Test the extractor's behaviour among different situations""" - lx = self.extractor_cls(allow='sample') - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html#foo', - text='sample 3 repetition with fragment') - ]) + lx = self.extractor_cls(allow="sample") + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + ], + ) - lx = self.extractor_cls(allow='sample', deny='3') - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - ]) + lx = self.extractor_cls(allow="sample", deny="3") + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + ], + ) - lx = self.extractor_cls(allow_domains='google.com') - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://www.google.com/something', text=''), - ]) + lx = self.extractor_cls(allow_domains="google.com") + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://www.google.com/something", text=""), + ], + ) - lx = self.extractor_cls(deny_domains='example.com') - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://www.google.com/something', text=''), - ]) + lx = self.extractor_cls(deny_domains="example.com") + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://www.google.com/something", text=""), + ], + ) def test_nofollow(self): '''Test the extractor's behaviour for links with rel="nofollow"''' @@ -141,48 +196,68 @@ class Base: response = HtmlResponse("http://example.org/somepage/index.html", body=html) lx = self.extractor_cls() - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.org/about.html', text='About us'), - Link(url='http://example.org/follow.html', text='Follow this link'), - Link(url='http://example.org/nofollow.html', text='Dont follow this one', nofollow=True), - Link(url='http://example.org/nofollow2.html', text='Choose to follow or not'), - Link(url='http://google.com/something', text='External link not to follow', nofollow=True), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.org/about.html", text="About us"), + Link(url="http://example.org/follow.html", text="Follow this link"), + Link( + url="http://example.org/nofollow.html", + text="Dont follow this one", + nofollow=True, + ), + Link( + url="http://example.org/nofollow2.html", + text="Choose to follow or not", + ), + Link( + url="http://google.com/something", + text="External link not to follow", + nofollow=True, + ), + ], + ) def test_matches(self): - url1 = 'http://lotsofstuff.com/stuff1/index' - url2 = 'http://evenmorestuff.com/uglystuff/index' + url1 = "http://lotsofstuff.com/stuff1/index" + url2 = "http://evenmorestuff.com/uglystuff/index" - lx = self.extractor_cls(allow=(r'stuff1', )) + lx = self.extractor_cls(allow=(r"stuff1",)) self.assertEqual(lx.matches(url1), True) self.assertEqual(lx.matches(url2), False) - lx = self.extractor_cls(deny=(r'uglystuff', )) + lx = self.extractor_cls(deny=(r"uglystuff",)) self.assertEqual(lx.matches(url1), True) self.assertEqual(lx.matches(url2), False) - lx = self.extractor_cls(allow_domains=('evenmorestuff.com', )) + lx = self.extractor_cls(allow_domains=("evenmorestuff.com",)) self.assertEqual(lx.matches(url1), False) self.assertEqual(lx.matches(url2), True) - lx = self.extractor_cls(deny_domains=('lotsofstuff.com', )) + lx = self.extractor_cls(deny_domains=("lotsofstuff.com",)) self.assertEqual(lx.matches(url1), False) self.assertEqual(lx.matches(url2), True) - lx = self.extractor_cls(allow=['blah1'], deny=['blah2'], - allow_domains=['blah1.com'], - deny_domains=['blah2.com']) - self.assertEqual(lx.matches('http://blah1.com/blah1'), True) - self.assertEqual(lx.matches('http://blah1.com/blah2'), False) - self.assertEqual(lx.matches('http://blah2.com/blah1'), False) - self.assertEqual(lx.matches('http://blah2.com/blah2'), False) + lx = self.extractor_cls( + allow=["blah1"], + deny=["blah2"], + allow_domains=["blah1.com"], + deny_domains=["blah2.com"], + ) + self.assertEqual(lx.matches("http://blah1.com/blah1"), True) + self.assertEqual(lx.matches("http://blah1.com/blah2"), False) + self.assertEqual(lx.matches("http://blah2.com/blah1"), False) + self.assertEqual(lx.matches("http://blah2.com/blah2"), False) def test_restrict_xpaths(self): - lx = self.extractor_cls(restrict_xpaths=('//div[@id="subwrapper"]', )) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - ]) + lx = self.extractor_cls(restrict_xpaths=('//div[@id="subwrapper"]',)) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + ], + ) def test_restrict_xpaths_encoding(self): """Test restrict_xpaths with encodings""" @@ -195,84 +270,143 @@ class Base:

This shouldn't be followed

""" - response = HtmlResponse("http://example.org/somepage/index.html", body=html, encoding='windows-1252') + response = HtmlResponse( + "http://example.org/somepage/index.html", + body=html, + encoding="windows-1252", + ) lx = self.extractor_cls(restrict_xpaths="//div[@class='links']") - self.assertEqual(lx.extract_links(response), - [Link(url='http://example.org/about.html', text='About us\xa3')]) + self.assertEqual( + lx.extract_links(response), + [Link(url="http://example.org/about.html", text="About us\xa3")], + ) def test_restrict_xpaths_with_html_entities(self): html = b'

text

' - response = HtmlResponse("http://example.org/somepage/index.html", body=html, encoding='iso8859-15') - links = self.extractor_cls(restrict_xpaths='//p').extract_links(response) - self.assertEqual(links, - [Link(url='http://example.org/%E2%99%A5/you?c=%A4', text='text')]) + response = HtmlResponse( + "http://example.org/somepage/index.html", + body=html, + encoding="iso8859-15", + ) + links = self.extractor_cls(restrict_xpaths="//p").extract_links(response) + self.assertEqual( + links, [Link(url="http://example.org/%E2%99%A5/you?c=%A4", text="text")] + ) def test_restrict_xpaths_concat_in_handle_data(self): """html entities cause SGMLParser to call handle_data hook twice""" body = b"""
>\xbe\xa9<\xb6\xab""" - response = HtmlResponse("http://example.org", body=body, encoding='gb18030') + response = HtmlResponse("http://example.org", body=body, encoding="gb18030") lx = self.extractor_cls(restrict_xpaths="//div") - self.assertEqual(lx.extract_links(response), - [Link(url='http://example.org/foo', text='>\u4eac<\u4e1c', - fragment='', nofollow=False)]) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://example.org/foo", + text=">\u4eac<\u4e1c", + fragment="", + nofollow=False, + ) + ], + ) def test_restrict_css(self): - lx = self.extractor_cls(restrict_css=('#subwrapper a',)) - self.assertEqual(lx.extract_links(self.response), [ - Link(url='http://example.com/sample2.html', text='sample 2') - ]) + lx = self.extractor_cls(restrict_css=("#subwrapper a",)) + self.assertEqual( + lx.extract_links(self.response), + [Link(url="http://example.com/sample2.html", text="sample 2")], + ) def test_restrict_css_and_restrict_xpaths_together(self): - lx = self.extractor_cls(restrict_xpaths=('//div[@id="subwrapper"]', ), - restrict_css=('#subwrapper + a', )) - self.assertEqual([link for link in lx.extract_links(self.response)], [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - ]) + lx = self.extractor_cls( + restrict_xpaths=('//div[@id="subwrapper"]',), + restrict_css=("#subwrapper + a",), + ) + self.assertEqual( + [link for link in lx.extract_links(self.response)], + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + ], + ) def test_area_tag_with_unicode_present(self): body = b"""\xbe\xa9""" - response = HtmlResponse("http://example.org", body=body, encoding='utf-8') + response = HtmlResponse("http://example.org", body=body, encoding="utf-8") lx = self.extractor_cls() lx.extract_links(response) lx.extract_links(response) lx.extract_links(response) - self.assertEqual(lx.extract_links(response), - [Link(url='http://example.org/foo', text='', - fragment='', nofollow=False)]) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://example.org/foo", + text="", + fragment="", + nofollow=False, + ) + ], + ) def test_encoded_url(self): body = b"""
BinB""" - response = HtmlResponse("http://known.fm/AC%2FDC/", body=body, encoding='utf8') + response = HtmlResponse( + "http://known.fm/AC%2FDC/", body=body, encoding="utf8" + ) lx = self.extractor_cls() - self.assertEqual(lx.extract_links(response), [ - Link(url='http://known.fm/AC%2FDC/?page=2', text='BinB', fragment='', nofollow=False), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://known.fm/AC%2FDC/?page=2", + text="BinB", + fragment="", + nofollow=False, + ), + ], + ) def test_encoded_url_in_restricted_xpath(self): body = b"""
BinB""" - response = HtmlResponse("http://known.fm/AC%2FDC/", body=body, encoding='utf8') + response = HtmlResponse( + "http://known.fm/AC%2FDC/", body=body, encoding="utf8" + ) lx = self.extractor_cls(restrict_xpaths="//div") - self.assertEqual(lx.extract_links(response), [ - Link(url='http://known.fm/AC%2FDC/?page=2', text='BinB', fragment='', nofollow=False), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://known.fm/AC%2FDC/?page=2", + text="BinB", + fragment="", + nofollow=False, + ), + ], + ) def test_ignored_extensions(self): # jpg is ignored by default html = b"""asd and """ response = HtmlResponse("http://example.org/", body=html) lx = self.extractor_cls() - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.org/page.html', text='asd'), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.org/page.html", text="asd"), + ], + ) # override denied extensions - lx = self.extractor_cls(deny_extensions=['html']) - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.org/photo.jpg'), - ]) + lx = self.extractor_cls(deny_extensions=["html"]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.org/photo.jpg"), + ], + ) def test_process_value(self): """Test restrict_xpaths with encodings""" @@ -280,7 +414,11 @@ class Base: Text About us """ - response = HtmlResponse("http://example.org/somepage/index.html", body=html, encoding='windows-1252') + response = HtmlResponse( + "http://example.org/somepage/index.html", + body=html, + encoding="windows-1252", + ) def process_value(value): m = re.search(r"javascript:goToPage\('(.*?)'", value) @@ -288,8 +426,10 @@ class Base: return m.group(1) lx = self.extractor_cls(process_value=process_value) - self.assertEqual(lx.extract_links(response), - [Link(url='http://example.org/other/page.html', text='Text')]) + self.assertEqual( + lx.extract_links(response), + [Link(url="http://example.org/other/page.html", text="Text")], + ) def test_base_url_with_restrict_xpaths(self): html = b"""Page title<title><base href="http://otherdomain.com/base/" /> @@ -297,34 +437,50 @@ class Base: </body></html>""" response = HtmlResponse("http://example.org/somepage/index.html", body=html) lx = self.extractor_cls(restrict_xpaths="//p") - self.assertEqual(lx.extract_links(response), - [Link(url='http://otherdomain.com/base/item/12.html', text='Item 12')]) + self.assertEqual( + lx.extract_links(response), + [Link(url="http://otherdomain.com/base/item/12.html", text="Item 12")], + ) def test_attrs(self): lx = self.extractor_cls(attrs="href") - page4_url = 'http://example.com/page%204.html' + page4_url = "http://example.com/page%204.html" - self.assertEqual(lx.extract_links(self.response), [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment'), - Link(url='http://www.google.com/something', text=''), - Link(url='http://example.com/innertag.html', text='inner tag'), - Link(url=page4_url, text='href with whitespaces'), - ]) + self.assertEqual( + lx.extract_links(self.response), + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + Link(url="http://www.google.com/something", text=""), + Link(url="http://example.com/innertag.html", text="inner tag"), + Link(url=page4_url, text="href with whitespaces"), + ], + ) - lx = self.extractor_cls(attrs=("href", "src"), tags=("a", "area", "img"), deny_extensions=()) - self.assertEqual(lx.extract_links(self.response), [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample2.jpg', text=''), - Link(url='http://example.com/sample3.html', text='sample 3 text'), - Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment'), - Link(url='http://www.google.com/something', text=''), - Link(url='http://example.com/innertag.html', text='inner tag'), - Link(url=page4_url, text='href with whitespaces'), - ]) + lx = self.extractor_cls( + attrs=("href", "src"), tags=("a", "area", "img"), deny_extensions=() + ) + self.assertEqual( + lx.extract_links(self.response), + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample2.jpg", text=""), + Link(url="http://example.com/sample3.html", text="sample 3 text"), + Link( + url="http://example.com/sample3.html#foo", + text="sample 3 repetition with fragment", + ), + Link(url="http://www.google.com/something", text=""), + Link(url="http://example.com/innertag.html", text="inner tag"), + Link(url=page4_url, text="href with whitespaces"), + ], + ) lx = self.extractor_cls(attrs=None) self.assertEqual(lx.extract_links(self.response), []) @@ -340,26 +496,40 @@ class Base: self.assertEqual(lx.extract_links(response), []) lx = self.extractor_cls() - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/sample1.html', text=''), - Link(url='http://example.com/sample2.html', text='sample 2'), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.com/sample1.html", text=""), + Link(url="http://example.com/sample2.html", text="sample 2"), + ], + ) lx = self.extractor_cls(tags="area") - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/sample1.html', text=''), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.com/sample1.html", text=""), + ], + ) lx = self.extractor_cls(tags="a") - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/sample2.html', text='sample 2'), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.com/sample2.html", text="sample 2"), + ], + ) - lx = self.extractor_cls(tags=("a", "img"), attrs=("href", "src"), deny_extensions=()) - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/sample2.html', text='sample 2'), - Link(url='http://example.com/sample2.jpg', text=''), - ]) + lx = self.extractor_cls( + tags=("a", "img"), attrs=("href", "src"), deny_extensions=() + ) + self.assertEqual( + lx.extract_links(response), + [ + Link(url="http://example.com/sample2.html", text="sample 2"), + Link(url="http://example.com/sample2.jpg", text=""), + ], + ) def test_tags_attrs(self): html = b""" @@ -370,17 +540,43 @@ class Base: """ response = HtmlResponse("http://example.com/index.html", body=html) - lx = self.extractor_cls(tags='div', attrs='data-url') - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/get?id=1', text='Item 1', fragment='', nofollow=False), - Link(url='http://example.com/get?id=2', text='Item 2', fragment='', nofollow=False) - ]) + lx = self.extractor_cls(tags="div", attrs="data-url") + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://example.com/get?id=1", + text="Item 1", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/get?id=2", + text="Item 2", + fragment="", + nofollow=False, + ), + ], + ) - lx = self.extractor_cls(tags=('div',), attrs=('data-url',)) - self.assertEqual(lx.extract_links(response), [ - Link(url='http://example.com/get?id=1', text='Item 1', fragment='', nofollow=False), - Link(url='http://example.com/get?id=2', text='Item 2', fragment='', nofollow=False) - ]) + lx = self.extractor_cls(tags=("div",), attrs=("data-url",)) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="http://example.com/get?id=1", + text="Item 1", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/get?id=2", + text="Item 2", + fragment="", + nofollow=False, + ), + ], + ) def test_xhtml(self): xhtml = b""" @@ -417,14 +613,36 @@ class Base: self.assertEqual( lx.extract_links(response), [ - Link(url='http://example.com/about.html', text='About us', fragment='', nofollow=False), - Link(url='http://example.com/follow.html', text='Follow this link', fragment='', nofollow=False), - Link(url='http://example.com/nofollow.html', text='Dont follow this one', - fragment='', nofollow=True), - Link(url='http://example.com/nofollow2.html', text='Choose to follow or not', - fragment='', nofollow=False), - Link(url='http://google.com/something', text='External link not to follow', nofollow=True), - ] + Link( + url="http://example.com/about.html", + text="About us", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/follow.html", + text="Follow this link", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/nofollow.html", + text="Dont follow this one", + fragment="", + nofollow=True, + ), + Link( + url="http://example.com/nofollow2.html", + text="Choose to follow or not", + fragment="", + nofollow=False, + ), + Link( + url="http://google.com/something", + text="External link not to follow", + nofollow=True, + ), + ], ) response = XmlResponse("http://example.com/index.xhtml", body=xhtml) @@ -433,14 +651,36 @@ class Base: self.assertEqual( lx.extract_links(response), [ - Link(url='http://example.com/about.html', text='About us', fragment='', nofollow=False), - Link(url='http://example.com/follow.html', text='Follow this link', fragment='', nofollow=False), - Link(url='http://example.com/nofollow.html', text='Dont follow this one', - fragment='', nofollow=True), - Link(url='http://example.com/nofollow2.html', text='Choose to follow or not', - fragment='', nofollow=False), - Link(url='http://google.com/something', text='External link not to follow', nofollow=True), - ] + Link( + url="http://example.com/about.html", + text="About us", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/follow.html", + text="Follow this link", + fragment="", + nofollow=False, + ), + Link( + url="http://example.com/nofollow.html", + text="Dont follow this one", + fragment="", + nofollow=True, + ), + Link( + url="http://example.com/nofollow2.html", + text="Choose to follow or not", + fragment="", + nofollow=False, + ), + Link( + url="http://google.com/something", + text="External link not to follow", + nofollow=True, + ), + ], ) def test_link_wrong_href(self): @@ -451,21 +691,42 @@ class Base: """ response = HtmlResponse("http://example.org/index.html", body=html) lx = self.extractor_cls() - self.assertEqual([link for link in lx.extract_links(response)], [ - Link(url='http://example.org/item1.html', text='Item 1', nofollow=False), - Link(url='http://example.org/item3.html', text='Item 3', nofollow=False), - ]) + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item1.html", + text="Item 1", + nofollow=False, + ), + Link( + url="http://example.org/item3.html", + text="Item 3", + nofollow=False, + ), + ], + ) def test_ftp_links(self): body = b""" <html><body> <div><a href="ftp://www.external.com/">An Item</a></div> </body></html>""" - response = HtmlResponse("http://www.example.com/index.html", body=body, encoding='utf8') + response = HtmlResponse( + "http://www.example.com/index.html", body=body, encoding="utf8" + ) lx = self.extractor_cls() - self.assertEqual(lx.extract_links(response), [ - Link(url='ftp://www.external.com/', text='An Item', fragment='', nofollow=False), - ]) + self.assertEqual( + lx.extract_links(response), + [ + Link( + url="ftp://www.external.com/", + text="An Item", + fragment="", + nofollow=False, + ), + ], + ) def test_pickle_extractor(self): lx = self.extractor_cls() @@ -483,10 +744,17 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): """ response = HtmlResponse("http://example.org/index.html", body=html) lx = self.extractor_cls() - self.assertEqual([link for link in lx.extract_links(response)], [ - Link(url='http://example.org/item1.html', text='Item 1', nofollow=False), - Link(url='http://example.org/item3.html', text='Item 3', nofollow=False), - ]) + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item1.html", text="Item 1", nofollow=False + ), + Link( + url="http://example.org/item3.html", text="Item 3", nofollow=False + ), + ], + ) def test_link_restrict_text(self): html = b""" @@ -496,21 +764,46 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): """ response = HtmlResponse("http://example.org/index.html", body=html) # Simple text inclusion test - lx = self.extractor_cls(restrict_text='dog') - self.assertEqual([link for link in lx.extract_links(response)], [ - Link(url='http://example.org/item2.html', text='Pic of a dog', nofollow=False), - ]) + lx = self.extractor_cls(restrict_text="dog") + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item2.html", + text="Pic of a dog", + nofollow=False, + ), + ], + ) # Unique regex test - lx = self.extractor_cls(restrict_text=r'of.*dog') - self.assertEqual([link for link in lx.extract_links(response)], [ - Link(url='http://example.org/item2.html', text='Pic of a dog', nofollow=False), - ]) + lx = self.extractor_cls(restrict_text=r"of.*dog") + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item2.html", + text="Pic of a dog", + nofollow=False, + ), + ], + ) # Multiple regex test - lx = self.extractor_cls(restrict_text=[r'of.*dog', r'of.*cat']) - self.assertEqual([link for link in lx.extract_links(response)], [ - Link(url='http://example.org/item1.html', text='Pic of a cat', nofollow=False), - Link(url='http://example.org/item2.html', text='Pic of a dog', nofollow=False), - ]) + lx = self.extractor_cls(restrict_text=[r"of.*dog", r"of.*cat"]) + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item1.html", + text="Pic of a cat", + nofollow=False, + ), + Link( + url="http://example.org/item2.html", + text="Pic of a dog", + nofollow=False, + ), + ], + ) def test_restrict_xpaths_with_html_entities(self): super().test_restrict_xpaths_with_html_entities() diff --git a/tests/test_loader.py b/tests/test_loader.py index b3e44d36b..9dd298864 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -59,32 +59,31 @@ class DefaultedItemLoader(NameItemLoader): # test processors def processor_with_args(value, other=None, loader_context=None): - if 'key' in loader_context: - return loader_context['key'] + if "key" in loader_context: + return loader_context["key"] return value class BasicItemLoaderTest(unittest.TestCase): - def test_add_value_on_unknown_field(self): il = TestItemLoader() - self.assertRaises(KeyError, il.add_value, 'wrong_field', ['lala', 'lolo']) + self.assertRaises(KeyError, il.add_value, "wrong_field", ["lala", "lolo"]) def test_load_item_using_default_loader(self): i = TestItem() - i['summary'] = 'lala' + i["summary"] = "lala" il = ItemLoader(item=i) - il.add_value('name', 'marta') + il.add_value("name", "marta") item = il.load_item() assert item is i - self.assertEqual(item['summary'], ['lala']) - self.assertEqual(item['name'], ['marta']) + self.assertEqual(item["summary"], ["lala"]) + self.assertEqual(item["name"], ["marta"]) def test_load_item_using_custom_loader(self): il = TestItemLoader() - il.add_value('name', 'marta') + il.add_value("name", "marta") item = il.load_item() - self.assertEqual(item['name'], ['Marta']) + self.assertEqual(item["name"], ["Marta"]) class InitializationTestMixin: @@ -93,85 +92,94 @@ class InitializationTestMixin: def test_keep_single_value(self): """Loaded item should contain values from the initial item""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo']}) + self.assertEqual(ItemAdapter(loaded_item).asdict(), {"name": ["foo"]}) def test_keep_list(self): """Loaded item should contain values from the initial item""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo', 'bar']}) + self.assertEqual(ItemAdapter(loaded_item).asdict(), {"name": ["foo", "bar"]}) def test_add_value_singlevalue_singlevalue(self): """Values added after initialization should be appended""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - il.add_value('name', 'bar') + il.add_value("name", "bar") loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo', 'bar']}) + self.assertEqual(ItemAdapter(loaded_item).asdict(), {"name": ["foo", "bar"]}) def test_add_value_singlevalue_list(self): """Values added after initialization should be appended""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - il.add_value('name', ['item', 'loader']) + il.add_value("name", ["item", "loader"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo', 'item', 'loader']}) + self.assertEqual( + ItemAdapter(loaded_item).asdict(), {"name": ["foo", "item", "loader"]} + ) def test_add_value_list_singlevalue(self): """Values added after initialization should be appended""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - il.add_value('name', 'qwerty') + il.add_value("name", "qwerty") loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo', 'bar', 'qwerty']}) + self.assertEqual( + ItemAdapter(loaded_item).asdict(), {"name": ["foo", "bar", "qwerty"]} + ) def test_add_value_list_list(self): """Values added after initialization should be appended""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - il.add_value('name', ['item', 'loader']) + il.add_value("name", ["item", "loader"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), {'name': ['foo', 'bar', 'item', 'loader']}) + self.assertEqual( + ItemAdapter(loaded_item).asdict(), + {"name": ["foo", "bar", "item", "loader"]}, + ) def test_get_output_value_singlevalue(self): """Getting output value must not remove value from item""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - self.assertEqual(il.get_output_value('name'), ['foo']) + self.assertEqual(il.get_output_value("name"), ["foo"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), dict({'name': ['foo']})) + self.assertEqual(ItemAdapter(loaded_item).asdict(), dict({"name": ["foo"]})) def test_get_output_value_list(self): """Getting output value must not remove value from item""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - self.assertEqual(il.get_output_value('name'), ['foo', 'bar']) + self.assertEqual(il.get_output_value("name"), ["foo", "bar"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(ItemAdapter(loaded_item).asdict(), dict({'name': ['foo', 'bar']})) + self.assertEqual( + ItemAdapter(loaded_item).asdict(), dict({"name": ["foo", "bar"]}) + ) def test_values_single(self): """Values from initial item must be added to loader._values""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - self.assertEqual(il._values.get('name'), ['foo']) + self.assertEqual(il._values.get("name"), ["foo"]) def test_values_list(self): """Values from initial item must be added to loader._values""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - self.assertEqual(il._values.get('name'), ['foo', 'bar']) + self.assertEqual(il._values.get("name"), ["foo", "bar"]) class InitializationFromDictTest(InitializationTestMixin, unittest.TestCase): @@ -207,42 +215,52 @@ class NoInputReprocessingFromItemTest(unittest.TestCase): """ Loaders initialized from loaded items must not reprocess fields (Item instances) """ + def test_avoid_reprocessing_with_initial_values_single(self): - il = NoInputReprocessingItemLoader(item=NoInputReprocessingItem(title='foo')) + il = NoInputReprocessingItemLoader(item=NoInputReprocessingItem(title="foo")) il_loaded = il.load_item() - self.assertEqual(il_loaded, {'title': 'foo'}) - self.assertEqual(NoInputReprocessingItemLoader(item=il_loaded).load_item(), {'title': 'foo'}) + self.assertEqual(il_loaded, {"title": "foo"}) + self.assertEqual( + NoInputReprocessingItemLoader(item=il_loaded).load_item(), {"title": "foo"} + ) def test_avoid_reprocessing_with_initial_values_list(self): - il = NoInputReprocessingItemLoader(item=NoInputReprocessingItem(title=['foo', 'bar'])) + il = NoInputReprocessingItemLoader( + item=NoInputReprocessingItem(title=["foo", "bar"]) + ) il_loaded = il.load_item() - self.assertEqual(il_loaded, {'title': 'foo'}) - self.assertEqual(NoInputReprocessingItemLoader(item=il_loaded).load_item(), {'title': 'foo'}) + self.assertEqual(il_loaded, {"title": "foo"}) + self.assertEqual( + NoInputReprocessingItemLoader(item=il_loaded).load_item(), {"title": "foo"} + ) def test_avoid_reprocessing_without_initial_values_single(self): il = NoInputReprocessingItemLoader() - il.add_value('title', 'FOO') + il.add_value("title", "FOO") il_loaded = il.load_item() - self.assertEqual(il_loaded, {'title': 'FOO'}) - self.assertEqual(NoInputReprocessingItemLoader(item=il_loaded).load_item(), {'title': 'FOO'}) + self.assertEqual(il_loaded, {"title": "FOO"}) + self.assertEqual( + NoInputReprocessingItemLoader(item=il_loaded).load_item(), {"title": "FOO"} + ) def test_avoid_reprocessing_without_initial_values_list(self): il = NoInputReprocessingItemLoader() - il.add_value('title', ['foo', 'bar']) + il.add_value("title", ["foo", "bar"]) il_loaded = il.load_item() - self.assertEqual(il_loaded, {'title': 'FOO'}) - self.assertEqual(NoInputReprocessingItemLoader(item=il_loaded).load_item(), {'title': 'FOO'}) + self.assertEqual(il_loaded, {"title": "FOO"}) + self.assertEqual( + NoInputReprocessingItemLoader(item=il_loaded).load_item(), {"title": "FOO"} + ) class TestOutputProcessorItem(unittest.TestCase): def test_output_processor(self): - class TempItem(Item): temp = Field() def __init__(self, *args, **kwargs): super().__init__(self, *args, **kwargs) - self.setdefault('temp', 0.3) + self.setdefault("temp", 0.3) class TempLoader(ItemLoader): default_item_class = TempItem @@ -252,11 +270,14 @@ class TestOutputProcessorItem(unittest.TestCase): loader = TempLoader() item = loader.load_item() self.assertIsInstance(item, TempItem) - self.assertEqual(dict(item), {'temp': 0.3}) + self.assertEqual(dict(item), {"temp": 0.3}) class SelectortemLoaderTest(unittest.TestCase): - response = HtmlResponse(url="", encoding='utf-8', body=b""" + response = HtmlResponse( + url="", + encoding="utf-8", + body=b""" <html> <body> <div id="id">marta</div> @@ -265,7 +286,8 @@ class SelectortemLoaderTest(unittest.TestCase): <img src="/images/logo.png" width="244" height="65" alt="Scrapy"> </body> </html> - """) + """, + ) def test_init_method(self): l = TestItemLoader() @@ -273,28 +295,28 @@ class SelectortemLoaderTest(unittest.TestCase): def test_init_method_errors(self): l = TestItemLoader() - self.assertRaises(RuntimeError, l.add_xpath, 'url', '//a/@href') - self.assertRaises(RuntimeError, l.replace_xpath, 'url', '//a/@href') - self.assertRaises(RuntimeError, l.get_xpath, '//a/@href') - self.assertRaises(RuntimeError, l.add_css, 'name', '#name::text') - self.assertRaises(RuntimeError, l.replace_css, 'name', '#name::text') - self.assertRaises(RuntimeError, l.get_css, '#name::text') + self.assertRaises(RuntimeError, l.add_xpath, "url", "//a/@href") + self.assertRaises(RuntimeError, l.replace_xpath, "url", "//a/@href") + self.assertRaises(RuntimeError, l.get_xpath, "//a/@href") + self.assertRaises(RuntimeError, l.add_css, "name", "#name::text") + self.assertRaises(RuntimeError, l.replace_css, "name", "#name::text") + self.assertRaises(RuntimeError, l.get_css, "#name::text") def test_init_method_with_selector(self): sel = Selector(text="<html><body><div>marta</div></body></html>") l = TestItemLoader(selector=sel) self.assertIs(l.selector, sel) - l.add_xpath('name', '//div/text()') - self.assertEqual(l.get_output_value('name'), ['Marta']) + l.add_xpath("name", "//div/text()") + self.assertEqual(l.get_output_value("name"), ["Marta"]) def test_init_method_with_selector_css(self): sel = Selector(text="<html><body><div>marta</div></body></html>") l = TestItemLoader(selector=sel) self.assertIs(l.selector, sel) - l.add_css('name', 'div::text') - self.assertEqual(l.get_output_value('name'), ['Marta']) + l.add_css("name", "div::text") + self.assertEqual(l.get_output_value("name"), ["Marta"]) def test_init_method_with_base_response(self): """Selector should be None after initialization""" @@ -306,122 +328,131 @@ class SelectortemLoaderTest(unittest.TestCase): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_xpath('name', '//div/text()') - self.assertEqual(l.get_output_value('name'), ['Marta']) + l.add_xpath("name", "//div/text()") + self.assertEqual(l.get_output_value("name"), ["Marta"]) def test_init_method_with_response_css(self): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_css('name', 'div::text') - self.assertEqual(l.get_output_value('name'), ['Marta']) + l.add_css("name", "div::text") + self.assertEqual(l.get_output_value("name"), ["Marta"]) - l.add_css('url', 'a::attr(href)') - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org']) + l.add_css("url", "a::attr(href)") + self.assertEqual(l.get_output_value("url"), ["http://www.scrapy.org"]) # combining/accumulating CSS selectors and XPath expressions - l.add_xpath('name', '//div/text()') - self.assertEqual(l.get_output_value('name'), ['Marta', 'Marta']) + l.add_xpath("name", "//div/text()") + self.assertEqual(l.get_output_value("name"), ["Marta", "Marta"]) - l.add_xpath('url', '//img/@src') - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org', '/images/logo.png']) + l.add_xpath("url", "//img/@src") + self.assertEqual( + l.get_output_value("url"), ["http://www.scrapy.org", "/images/logo.png"] + ) def test_add_xpath_re(self): l = TestItemLoader(response=self.response) - l.add_xpath('name', '//div/text()', re='ma') - self.assertEqual(l.get_output_value('name'), ['Ma']) + l.add_xpath("name", "//div/text()", re="ma") + self.assertEqual(l.get_output_value("name"), ["Ma"]) def test_replace_xpath(self): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_xpath('name', '//div/text()') - self.assertEqual(l.get_output_value('name'), ['Marta']) - l.replace_xpath('name', '//p/text()') - self.assertEqual(l.get_output_value('name'), ['Paragraph']) + l.add_xpath("name", "//div/text()") + self.assertEqual(l.get_output_value("name"), ["Marta"]) + l.replace_xpath("name", "//p/text()") + self.assertEqual(l.get_output_value("name"), ["Paragraph"]) - l.replace_xpath('name', ['//p/text()', '//div/text()']) - self.assertEqual(l.get_output_value('name'), ['Paragraph', 'Marta']) + l.replace_xpath("name", ["//p/text()", "//div/text()"]) + self.assertEqual(l.get_output_value("name"), ["Paragraph", "Marta"]) def test_get_xpath(self): l = TestItemLoader(response=self.response) - self.assertEqual(l.get_xpath('//p/text()'), ['paragraph']) - self.assertEqual(l.get_xpath('//p/text()', TakeFirst()), 'paragraph') - self.assertEqual(l.get_xpath('//p/text()', TakeFirst(), re='pa'), 'pa') + self.assertEqual(l.get_xpath("//p/text()"), ["paragraph"]) + self.assertEqual(l.get_xpath("//p/text()", TakeFirst()), "paragraph") + self.assertEqual(l.get_xpath("//p/text()", TakeFirst(), re="pa"), "pa") - self.assertEqual(l.get_xpath(['//p/text()', '//div/text()']), ['paragraph', 'marta']) + self.assertEqual( + l.get_xpath(["//p/text()", "//div/text()"]), ["paragraph", "marta"] + ) def test_replace_xpath_multi_fields(self): l = TestItemLoader(response=self.response) - l.add_xpath(None, '//div/text()', TakeFirst(), lambda x: {'name': x}) - self.assertEqual(l.get_output_value('name'), ['Marta']) - l.replace_xpath(None, '//p/text()', TakeFirst(), lambda x: {'name': x}) - self.assertEqual(l.get_output_value('name'), ['Paragraph']) + l.add_xpath(None, "//div/text()", TakeFirst(), lambda x: {"name": x}) + self.assertEqual(l.get_output_value("name"), ["Marta"]) + l.replace_xpath(None, "//p/text()", TakeFirst(), lambda x: {"name": x}) + self.assertEqual(l.get_output_value("name"), ["Paragraph"]) def test_replace_xpath_re(self): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_xpath('name', '//div/text()') - self.assertEqual(l.get_output_value('name'), ['Marta']) - l.replace_xpath('name', '//div/text()', re='ma') - self.assertEqual(l.get_output_value('name'), ['Ma']) + l.add_xpath("name", "//div/text()") + self.assertEqual(l.get_output_value("name"), ["Marta"]) + l.replace_xpath("name", "//div/text()", re="ma") + self.assertEqual(l.get_output_value("name"), ["Ma"]) def test_add_css_re(self): l = TestItemLoader(response=self.response) - l.add_css('name', 'div::text', re='ma') - self.assertEqual(l.get_output_value('name'), ['Ma']) + l.add_css("name", "div::text", re="ma") + self.assertEqual(l.get_output_value("name"), ["Ma"]) - l.add_css('url', 'a::attr(href)', re='http://(.+)') - self.assertEqual(l.get_output_value('url'), ['www.scrapy.org']) + l.add_css("url", "a::attr(href)", re="http://(.+)") + self.assertEqual(l.get_output_value("url"), ["www.scrapy.org"]) def test_replace_css(self): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_css('name', 'div::text') - self.assertEqual(l.get_output_value('name'), ['Marta']) - l.replace_css('name', 'p::text') - self.assertEqual(l.get_output_value('name'), ['Paragraph']) + l.add_css("name", "div::text") + self.assertEqual(l.get_output_value("name"), ["Marta"]) + l.replace_css("name", "p::text") + self.assertEqual(l.get_output_value("name"), ["Paragraph"]) - l.replace_css('name', ['p::text', 'div::text']) - self.assertEqual(l.get_output_value('name'), ['Paragraph', 'Marta']) + l.replace_css("name", ["p::text", "div::text"]) + self.assertEqual(l.get_output_value("name"), ["Paragraph", "Marta"]) - l.add_css('url', 'a::attr(href)', re='http://(.+)') - self.assertEqual(l.get_output_value('url'), ['www.scrapy.org']) - l.replace_css('url', 'img::attr(src)') - self.assertEqual(l.get_output_value('url'), ['/images/logo.png']) + l.add_css("url", "a::attr(href)", re="http://(.+)") + self.assertEqual(l.get_output_value("url"), ["www.scrapy.org"]) + l.replace_css("url", "img::attr(src)") + self.assertEqual(l.get_output_value("url"), ["/images/logo.png"]) def test_get_css(self): l = TestItemLoader(response=self.response) - self.assertEqual(l.get_css('p::text'), ['paragraph']) - self.assertEqual(l.get_css('p::text', TakeFirst()), 'paragraph') - self.assertEqual(l.get_css('p::text', TakeFirst(), re='pa'), 'pa') + self.assertEqual(l.get_css("p::text"), ["paragraph"]) + self.assertEqual(l.get_css("p::text", TakeFirst()), "paragraph") + self.assertEqual(l.get_css("p::text", TakeFirst(), re="pa"), "pa") - self.assertEqual(l.get_css(['p::text', 'div::text']), ['paragraph', 'marta']) - self.assertEqual(l.get_css(['a::attr(href)', 'img::attr(src)']), - ['http://www.scrapy.org', '/images/logo.png']) + self.assertEqual(l.get_css(["p::text", "div::text"]), ["paragraph", "marta"]) + self.assertEqual( + l.get_css(["a::attr(href)", "img::attr(src)"]), + ["http://www.scrapy.org", "/images/logo.png"], + ) def test_replace_css_multi_fields(self): l = TestItemLoader(response=self.response) - l.add_css(None, 'div::text', TakeFirst(), lambda x: {'name': x}) - self.assertEqual(l.get_output_value('name'), ['Marta']) - l.replace_css(None, 'p::text', TakeFirst(), lambda x: {'name': x}) - self.assertEqual(l.get_output_value('name'), ['Paragraph']) + l.add_css(None, "div::text", TakeFirst(), lambda x: {"name": x}) + self.assertEqual(l.get_output_value("name"), ["Marta"]) + l.replace_css(None, "p::text", TakeFirst(), lambda x: {"name": x}) + self.assertEqual(l.get_output_value("name"), ["Paragraph"]) - l.add_css(None, 'a::attr(href)', TakeFirst(), lambda x: {'url': x}) - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org']) - l.replace_css(None, 'img::attr(src)', TakeFirst(), lambda x: {'url': x}) - self.assertEqual(l.get_output_value('url'), ['/images/logo.png']) + l.add_css(None, "a::attr(href)", TakeFirst(), lambda x: {"url": x}) + self.assertEqual(l.get_output_value("url"), ["http://www.scrapy.org"]) + l.replace_css(None, "img::attr(src)", TakeFirst(), lambda x: {"url": x}) + self.assertEqual(l.get_output_value("url"), ["/images/logo.png"]) def test_replace_css_re(self): l = TestItemLoader(response=self.response) self.assertTrue(l.selector) - l.add_css('url', 'a::attr(href)') - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org']) - l.replace_css('url', 'a::attr(href)', re=r'http://www\.(.+)') - self.assertEqual(l.get_output_value('url'), ['scrapy.org']) + l.add_css("url", "a::attr(href)") + self.assertEqual(l.get_output_value("url"), ["http://www.scrapy.org"]) + l.replace_css("url", "a::attr(href)", re=r"http://www\.(.+)") + self.assertEqual(l.get_output_value("url"), ["scrapy.org"]) class SubselectorLoaderTest(unittest.TestCase): - response = HtmlResponse(url="", encoding='utf-8', body=b""" + response = HtmlResponse( + url="", + encoding="utf-8", + body=b""" <html> <body> <header> @@ -434,76 +465,88 @@ class SubselectorLoaderTest(unittest.TestCase): </footer> </body> </html> - """) + """, + ) def test_nested_xpath(self): l = NestedItemLoader(response=self.response) nl = l.nested_xpath("//header") - nl.add_xpath('name', 'div/text()') - nl.add_css('name_div', '#id') - nl.add_value('name_value', nl.selector.xpath('div[@id = "id"]/text()').getall()) + nl.add_xpath("name", "div/text()") + nl.add_css("name_div", "#id") + nl.add_value("name_value", nl.selector.xpath('div[@id = "id"]/text()').getall()) - self.assertEqual(l.get_output_value('name'), ['marta']) - self.assertEqual(l.get_output_value('name_div'), ['<div id="id">marta</div>']) - self.assertEqual(l.get_output_value('name_value'), ['marta']) + self.assertEqual(l.get_output_value("name"), ["marta"]) + self.assertEqual(l.get_output_value("name_div"), ['<div id="id">marta</div>']) + self.assertEqual(l.get_output_value("name_value"), ["marta"]) - self.assertEqual(l.get_output_value('name'), nl.get_output_value('name')) - self.assertEqual(l.get_output_value('name_div'), nl.get_output_value('name_div')) - self.assertEqual(l.get_output_value('name_value'), nl.get_output_value('name_value')) + self.assertEqual(l.get_output_value("name"), nl.get_output_value("name")) + self.assertEqual( + l.get_output_value("name_div"), nl.get_output_value("name_div") + ) + self.assertEqual( + l.get_output_value("name_value"), nl.get_output_value("name_value") + ) def test_nested_css(self): l = NestedItemLoader(response=self.response) nl = l.nested_css("header") - nl.add_xpath('name', 'div/text()') - nl.add_css('name_div', '#id') - nl.add_value('name_value', nl.selector.xpath('div[@id = "id"]/text()').getall()) + nl.add_xpath("name", "div/text()") + nl.add_css("name_div", "#id") + nl.add_value("name_value", nl.selector.xpath('div[@id = "id"]/text()').getall()) - self.assertEqual(l.get_output_value('name'), ['marta']) - self.assertEqual(l.get_output_value('name_div'), ['<div id="id">marta</div>']) - self.assertEqual(l.get_output_value('name_value'), ['marta']) + self.assertEqual(l.get_output_value("name"), ["marta"]) + self.assertEqual(l.get_output_value("name_div"), ['<div id="id">marta</div>']) + self.assertEqual(l.get_output_value("name_value"), ["marta"]) - self.assertEqual(l.get_output_value('name'), nl.get_output_value('name')) - self.assertEqual(l.get_output_value('name_div'), nl.get_output_value('name_div')) - self.assertEqual(l.get_output_value('name_value'), nl.get_output_value('name_value')) + self.assertEqual(l.get_output_value("name"), nl.get_output_value("name")) + self.assertEqual( + l.get_output_value("name_div"), nl.get_output_value("name_div") + ) + self.assertEqual( + l.get_output_value("name_value"), nl.get_output_value("name_value") + ) def test_nested_replace(self): l = NestedItemLoader(response=self.response) - nl1 = l.nested_xpath('//footer') - nl2 = nl1.nested_xpath('a') + nl1 = l.nested_xpath("//footer") + nl2 = nl1.nested_xpath("a") - l.add_xpath('url', '//footer/a/@href') - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org']) - nl1.replace_xpath('url', 'img/@src') - self.assertEqual(l.get_output_value('url'), ['/images/logo.png']) - nl2.replace_xpath('url', '@href') - self.assertEqual(l.get_output_value('url'), ['http://www.scrapy.org']) + l.add_xpath("url", "//footer/a/@href") + self.assertEqual(l.get_output_value("url"), ["http://www.scrapy.org"]) + nl1.replace_xpath("url", "img/@src") + self.assertEqual(l.get_output_value("url"), ["/images/logo.png"]) + nl2.replace_xpath("url", "@href") + self.assertEqual(l.get_output_value("url"), ["http://www.scrapy.org"]) def test_nested_ordering(self): l = NestedItemLoader(response=self.response) - nl1 = l.nested_xpath('//footer') - nl2 = nl1.nested_xpath('a') + nl1 = l.nested_xpath("//footer") + nl2 = nl1.nested_xpath("a") - nl1.add_xpath('url', 'img/@src') - l.add_xpath('url', '//footer/a/@href') - nl2.add_xpath('url', 'text()') - l.add_xpath('url', '//footer/a/@href') + nl1.add_xpath("url", "img/@src") + l.add_xpath("url", "//footer/a/@href") + nl2.add_xpath("url", "text()") + l.add_xpath("url", "//footer/a/@href") - self.assertEqual(l.get_output_value('url'), [ - '/images/logo.png', - 'http://www.scrapy.org', - 'homepage', - 'http://www.scrapy.org', - ]) + self.assertEqual( + l.get_output_value("url"), + [ + "/images/logo.png", + "http://www.scrapy.org", + "homepage", + "http://www.scrapy.org", + ], + ) def test_nested_load_item(self): l = NestedItemLoader(response=self.response) - nl1 = l.nested_xpath('//footer') - nl2 = nl1.nested_xpath('img') + nl1 = l.nested_xpath("//footer") + nl2 = nl1.nested_xpath("img") - l.add_xpath('name', '//header/div/text()') - nl1.add_xpath('url', 'a/@href') - nl2.add_xpath('image', '@src') + l.add_xpath("name", "//header/div/text()") + nl1.add_xpath("url", "a/@href") + nl2.add_xpath("image", "@src") item = l.load_item() @@ -511,13 +554,14 @@ class SubselectorLoaderTest(unittest.TestCase): assert item is nl1.item assert item is nl2.item - self.assertEqual(item['name'], ['marta']) - self.assertEqual(item['url'], ['http://www.scrapy.org']) - self.assertEqual(item['image'], ['/images/logo.png']) + self.assertEqual(item["name"], ["marta"]) + self.assertEqual(item["url"], ["http://www.scrapy.org"]) + self.assertEqual(item["image"], ["/images/logo.png"]) # Functions as processors + def function_processor_strip(iterable): return [x.strip() for x in iterable] @@ -538,15 +582,11 @@ class FunctionProcessorItemLoader(ItemLoader): class FunctionProcessorTestCase(unittest.TestCase): - def test_processor_defined_in_item(self): lo = FunctionProcessorItemLoader() - lo.add_value('foo', ' bar ') - lo.add_value('foo', [' asdf ', ' qwerty ']) - self.assertEqual( - dict(lo.load_item()), - {'foo': ['BAR', 'ASDF', 'QWERTY']} - ) + lo.add_value("foo", " bar ") + lo.add_value("foo", [" asdf ", " qwerty "]) + self.assertEqual(dict(lo.load_item()), {"foo": ["BAR", "ASDF", "QWERTY"]}) if __name__ == "__main__": diff --git a/tests/test_loader_deprecated.py b/tests/test_loader_deprecated.py index 14b3b5568..8757db0ce 100644 --- a/tests/test_loader_deprecated.py +++ b/tests/test_loader_deprecated.py @@ -7,8 +7,14 @@ import unittest import warnings from functools import partial -from itemloaders.processors import (Compose, Identity, Join, - MapCompose, SelectJmes, TakeFirst) +from itemloaders.processors import ( + Compose, + Identity, + Join, + MapCompose, + SelectJmes, + TakeFirst, +) from scrapy.item import Item, Field from scrapy.loader import ItemLoader @@ -42,28 +48,27 @@ class DefaultedItemLoader(NameItemLoader): # test processors def processor_with_args(value, other=None, loader_context=None): - if 'key' in loader_context: - return loader_context['key'] + if "key" in loader_context: + return loader_context["key"] return value class BasicItemLoaderTest(unittest.TestCase): - def test_load_item_using_default_loader(self): i = TestItem() - i['summary'] = 'lala' + i["summary"] = "lala" il = ItemLoader(item=i) - il.add_value('name', 'marta') + il.add_value("name", "marta") item = il.load_item() assert item is i - self.assertEqual(item['summary'], ['lala']) - self.assertEqual(item['name'], ['marta']) + self.assertEqual(item["summary"], ["lala"]) + self.assertEqual(item["name"], ["marta"]) def test_load_item_using_custom_loader(self): il = TestItemLoader() - il.add_value('name', 'marta') + il.add_value("name", "marta") item = il.load_item() - self.assertEqual(item['name'], ['Marta']) + self.assertEqual(item["name"], ["Marta"]) def test_load_item_ignore_none_field_values(self): def validate_sku(value): @@ -76,206 +81,223 @@ class BasicItemLoaderTest(unittest.TestCase): price_out = Compose(TakeFirst(), float) sku_out = Compose(TakeFirst(), validate_sku) - valid_fragment = 'SKU: 1234' - invalid_fragment = 'SKU: not available' - sku_re = 'SKU: (.+)' + valid_fragment = "SKU: 1234" + invalid_fragment = "SKU: not available" + sku_re = "SKU: (.+)" il = MyLoader(item={}) # Should not return "sku: None". - il.add_value('sku', [invalid_fragment], re=sku_re) + il.add_value("sku", [invalid_fragment], re=sku_re) # Should not ignore empty values. - il.add_value('name', '') - il.add_value('price', ['0']) - self.assertEqual(il.load_item(), { - 'name': '', - 'price': 0.0, - }) + il.add_value("name", "") + il.add_value("price", ["0"]) + self.assertEqual( + il.load_item(), + { + "name": "", + "price": 0.0, + }, + ) - il.replace_value('sku', [valid_fragment], re=sku_re) - self.assertEqual(il.load_item()['sku'], '1234') + il.replace_value("sku", [valid_fragment], re=sku_re) + self.assertEqual(il.load_item()["sku"], "1234") def test_self_referencing_loader(self): class MyLoader(ItemLoader): url_out = TakeFirst() def img_url_out(self, values): - return (self.get_output_value('url') or '') + values[0] + return (self.get_output_value("url") or "") + values[0] il = MyLoader(item={}) - il.add_value('url', 'http://example.com/') - il.add_value('img_url', '1234.png') - self.assertEqual(il.load_item(), { - 'url': 'http://example.com/', - 'img_url': 'http://example.com/1234.png', - }) + il.add_value("url", "http://example.com/") + il.add_value("img_url", "1234.png") + self.assertEqual( + il.load_item(), + { + "url": "http://example.com/", + "img_url": "http://example.com/1234.png", + }, + ) il = MyLoader(item={}) - il.add_value('img_url', '1234.png') - self.assertEqual(il.load_item(), { - 'img_url': '1234.png', - }) + il.add_value("img_url", "1234.png") + self.assertEqual( + il.load_item(), + { + "img_url": "1234.png", + }, + ) def test_add_value(self): il = TestItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_collected_values('name'), ['Marta']) - self.assertEqual(il.get_output_value('name'), ['Marta']) - il.add_value('name', 'pepe') - self.assertEqual(il.get_collected_values('name'), ['Marta', 'Pepe']) - self.assertEqual(il.get_output_value('name'), ['Marta', 'Pepe']) + il.add_value("name", "marta") + self.assertEqual(il.get_collected_values("name"), ["Marta"]) + self.assertEqual(il.get_output_value("name"), ["Marta"]) + il.add_value("name", "pepe") + self.assertEqual(il.get_collected_values("name"), ["Marta", "Pepe"]) + self.assertEqual(il.get_output_value("name"), ["Marta", "Pepe"]) # test add object value - il.add_value('summary', {'key': 1}) - self.assertEqual(il.get_collected_values('summary'), [{'key': 1}]) + il.add_value("summary", {"key": 1}) + self.assertEqual(il.get_collected_values("summary"), [{"key": 1}]) - il.add_value(None, 'Jim', lambda x: {'name': x}) - self.assertEqual(il.get_collected_values('name'), ['Marta', 'Pepe', 'Jim']) + il.add_value(None, "Jim", lambda x: {"name": x}) + self.assertEqual(il.get_collected_values("name"), ["Marta", "Pepe", "Jim"]) def test_add_zero(self): il = NameItemLoader() - il.add_value('name', 0) - self.assertEqual(il.get_collected_values('name'), [0]) + il.add_value("name", 0) + self.assertEqual(il.get_collected_values("name"), [0]) def test_replace_value(self): il = TestItemLoader() - il.replace_value('name', 'marta') - self.assertEqual(il.get_collected_values('name'), ['Marta']) - self.assertEqual(il.get_output_value('name'), ['Marta']) - il.replace_value('name', 'pepe') - self.assertEqual(il.get_collected_values('name'), ['Pepe']) - self.assertEqual(il.get_output_value('name'), ['Pepe']) + il.replace_value("name", "marta") + self.assertEqual(il.get_collected_values("name"), ["Marta"]) + self.assertEqual(il.get_output_value("name"), ["Marta"]) + il.replace_value("name", "pepe") + self.assertEqual(il.get_collected_values("name"), ["Pepe"]) + self.assertEqual(il.get_output_value("name"), ["Pepe"]) - il.replace_value(None, 'Jim', lambda x: {'name': x}) - self.assertEqual(il.get_collected_values('name'), ['Jim']) + il.replace_value(None, "Jim", lambda x: {"name": x}) + self.assertEqual(il.get_collected_values("name"), ["Jim"]) def test_get_value(self): il = NameItemLoader() - self.assertEqual('FOO', il.get_value(['foo', 'bar'], TakeFirst(), str.upper)) - self.assertEqual(['foo', 'bar'], il.get_value(['name:foo', 'name:bar'], re='name:(.*)$')) - self.assertEqual('foo', il.get_value(['name:foo', 'name:bar'], TakeFirst(), re='name:(.*)$')) + self.assertEqual("FOO", il.get_value(["foo", "bar"], TakeFirst(), str.upper)) + self.assertEqual( + ["foo", "bar"], il.get_value(["name:foo", "name:bar"], re="name:(.*)$") + ) + self.assertEqual( + "foo", il.get_value(["name:foo", "name:bar"], TakeFirst(), re="name:(.*)$") + ) - il.add_value('name', ['name:foo', 'name:bar'], TakeFirst(), re='name:(.*)$') - self.assertEqual(['foo'], il.get_collected_values('name')) - il.replace_value('name', 'name:bar', re='name:(.*)$') - self.assertEqual(['bar'], il.get_collected_values('name')) + il.add_value("name", ["name:foo", "name:bar"], TakeFirst(), re="name:(.*)$") + self.assertEqual(["foo"], il.get_collected_values("name")) + il.replace_value("name", "name:bar", re="name:(.*)$") + self.assertEqual(["bar"], il.get_collected_values("name")) def test_iter_on_input_processor_input(self): class NameFirstItemLoader(NameItemLoader): name_in = TakeFirst() il = NameFirstItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_collected_values('name'), ['marta']) + il.add_value("name", "marta") + self.assertEqual(il.get_collected_values("name"), ["marta"]) il = NameFirstItemLoader() - il.add_value('name', ['marta', 'jose']) - self.assertEqual(il.get_collected_values('name'), ['marta']) + il.add_value("name", ["marta", "jose"]) + self.assertEqual(il.get_collected_values("name"), ["marta"]) il = NameFirstItemLoader() - il.replace_value('name', 'marta') - self.assertEqual(il.get_collected_values('name'), ['marta']) + il.replace_value("name", "marta") + self.assertEqual(il.get_collected_values("name"), ["marta"]) il = NameFirstItemLoader() - il.replace_value('name', ['marta', 'jose']) - self.assertEqual(il.get_collected_values('name'), ['marta']) + il.replace_value("name", ["marta", "jose"]) + self.assertEqual(il.get_collected_values("name"), ["marta"]) il = NameFirstItemLoader() - il.add_value('name', 'marta') - il.add_value('name', ['jose', 'pedro']) - self.assertEqual(il.get_collected_values('name'), ['marta', 'jose']) + il.add_value("name", "marta") + il.add_value("name", ["jose", "pedro"]) + self.assertEqual(il.get_collected_values("name"), ["marta", "jose"]) def test_map_compose_filter(self): def filter_world(x): - return None if x == 'world' else x + return None if x == "world" else x proc = MapCompose(filter_world, str.upper) - self.assertEqual(proc(['hello', 'world', 'this', 'is', 'scrapy']), - ['HELLO', 'THIS', 'IS', 'SCRAPY']) + self.assertEqual( + proc(["hello", "world", "this", "is", "scrapy"]), + ["HELLO", "THIS", "IS", "SCRAPY"], + ) def test_map_compose_filter_multil(self): class TestItemLoader(NameItemLoader): name_in = MapCompose(lambda v: v.title(), lambda v: v[:-1]) il = TestItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['Mart']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["Mart"]) item = il.load_item() - self.assertEqual(item['name'], ['Mart']) + self.assertEqual(item["name"], ["Mart"]) def test_default_input_processor(self): il = DefaultedItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['mart']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["mart"]) def test_inherited_default_input_processor(self): class InheritDefaultedItemLoader(DefaultedItemLoader): pass il = InheritDefaultedItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['mart']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["mart"]) def test_input_processor_inheritance(self): class ChildItemLoader(TestItemLoader): url_in = MapCompose(lambda v: v.lower()) il = ChildItemLoader() - il.add_value('url', 'HTTP://scrapy.ORG') - self.assertEqual(il.get_output_value('url'), ['http://scrapy.org']) - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['Marta']) + il.add_value("url", "HTTP://scrapy.ORG") + self.assertEqual(il.get_output_value("url"), ["http://scrapy.org"]) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["Marta"]) class ChildChildItemLoader(ChildItemLoader): url_in = MapCompose(lambda v: v.upper()) summary_in = MapCompose(lambda v: v) il = ChildChildItemLoader() - il.add_value('url', 'http://scrapy.org') - self.assertEqual(il.get_output_value('url'), ['HTTP://SCRAPY.ORG']) - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['Marta']) + il.add_value("url", "http://scrapy.org") + self.assertEqual(il.get_output_value("url"), ["HTTP://SCRAPY.ORG"]) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["Marta"]) def test_empty_map_compose(self): class IdentityDefaultedItemLoader(DefaultedItemLoader): name_in = MapCompose() il = IdentityDefaultedItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['marta']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["marta"]) def test_identity_input_processor(self): class IdentityDefaultedItemLoader(DefaultedItemLoader): name_in = Identity() il = IdentityDefaultedItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['marta']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["marta"]) def test_extend_custom_input_processors(self): class ChildItemLoader(TestItemLoader): name_in = MapCompose(TestItemLoader.name_in, str.swapcase) il = ChildItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['mARTA']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["mARTA"]) def test_extend_default_input_processors(self): class ChildDefaultedItemLoader(DefaultedItemLoader): - name_in = MapCompose(DefaultedItemLoader.default_input_processor, str.swapcase) + name_in = MapCompose( + DefaultedItemLoader.default_input_processor, str.swapcase + ) il = ChildDefaultedItemLoader() - il.add_value('name', 'marta') - self.assertEqual(il.get_output_value('name'), ['MART']) + il.add_value("name", "marta") + self.assertEqual(il.get_output_value("name"), ["MART"]) def test_output_processor_using_function(self): il = TestItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), ['Mar', 'Ta']) + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), ["Mar", "Ta"]) class TakeFirstItemLoader(TestItemLoader): name_out = " ".join il = TakeFirstItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), 'Mar Ta') + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), "Mar Ta") def test_output_processor_error(self): class TestItemLoader(ItemLoader): @@ -283,9 +305,9 @@ class BasicItemLoaderTest(unittest.TestCase): name_out = MapCompose(float) il = TestItemLoader() - il.add_value('name', ['$10']) + il.add_value("name", ["$10"]) try: - float('$10') + float("$10") except Exception as e: expected_exc_str = str(e) @@ -296,118 +318,118 @@ class BasicItemLoaderTest(unittest.TestCase): exc = e assert isinstance(exc, ValueError) s = str(exc) - assert 'name' in s, s - assert '$10' in s, s - assert 'ValueError' in s, s + assert "name" in s, s + assert "$10" in s, s + assert "ValueError" in s, s assert expected_exc_str in s, s def test_output_processor_using_classes(self): il = TestItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), ['Mar', 'Ta']) + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), ["Mar", "Ta"]) class TakeFirstItemLoader(TestItemLoader): name_out = Join() il = TakeFirstItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), 'Mar Ta') + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), "Mar Ta") class TakeFirstItemLoader(TestItemLoader): name_out = Join("<br>") il = TakeFirstItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), 'Mar<br>Ta') + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), "Mar<br>Ta") def test_default_output_processor(self): il = TestItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), ['Mar', 'Ta']) + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), ["Mar", "Ta"]) class LalaItemLoader(TestItemLoader): default_output_processor = Identity() il = LalaItemLoader() - il.add_value('name', ['mar', 'ta']) - self.assertEqual(il.get_output_value('name'), ['Mar', 'Ta']) + il.add_value("name", ["mar", "ta"]) + self.assertEqual(il.get_output_value("name"), ["Mar", "Ta"]) def test_loader_context_on_declaration(self): class ChildItemLoader(TestItemLoader): - url_in = MapCompose(processor_with_args, key='val') + url_in = MapCompose(processor_with_args, key="val") il = ChildItemLoader() - il.add_value('url', 'text') - self.assertEqual(il.get_output_value('url'), ['val']) - il.replace_value('url', 'text2') - self.assertEqual(il.get_output_value('url'), ['val']) + il.add_value("url", "text") + self.assertEqual(il.get_output_value("url"), ["val"]) + il.replace_value("url", "text2") + self.assertEqual(il.get_output_value("url"), ["val"]) def test_loader_context_on_instantiation(self): class ChildItemLoader(TestItemLoader): url_in = MapCompose(processor_with_args) - il = ChildItemLoader(key='val') - il.add_value('url', 'text') - self.assertEqual(il.get_output_value('url'), ['val']) - il.replace_value('url', 'text2') - self.assertEqual(il.get_output_value('url'), ['val']) + il = ChildItemLoader(key="val") + il.add_value("url", "text") + self.assertEqual(il.get_output_value("url"), ["val"]) + il.replace_value("url", "text2") + self.assertEqual(il.get_output_value("url"), ["val"]) def test_loader_context_on_assign(self): class ChildItemLoader(TestItemLoader): url_in = MapCompose(processor_with_args) il = ChildItemLoader() - il.context['key'] = 'val' - il.add_value('url', 'text') - self.assertEqual(il.get_output_value('url'), ['val']) - il.replace_value('url', 'text2') - self.assertEqual(il.get_output_value('url'), ['val']) + il.context["key"] = "val" + il.add_value("url", "text") + self.assertEqual(il.get_output_value("url"), ["val"]) + il.replace_value("url", "text2") + self.assertEqual(il.get_output_value("url"), ["val"]) def test_item_passed_to_input_processor_functions(self): def processor(value, loader_context): - return loader_context['item']['name'] + return loader_context["item"]["name"] class ChildItemLoader(TestItemLoader): url_in = MapCompose(processor) - it = TestItem(name='marta') + it = TestItem(name="marta") il = ChildItemLoader(item=it) - il.add_value('url', 'text') - self.assertEqual(il.get_output_value('url'), ['marta']) - il.replace_value('url', 'text2') - self.assertEqual(il.get_output_value('url'), ['marta']) + il.add_value("url", "text") + self.assertEqual(il.get_output_value("url"), ["marta"]) + il.replace_value("url", "text2") + self.assertEqual(il.get_output_value("url"), ["marta"]) def test_compose_processor(self): class TestItemLoader(NameItemLoader): name_out = Compose(lambda v: v[0], lambda v: v.title(), lambda v: v[:-1]) il = TestItemLoader() - il.add_value('name', ['marta', 'other']) - self.assertEqual(il.get_output_value('name'), 'Mart') + il.add_value("name", ["marta", "other"]) + self.assertEqual(il.get_output_value("name"), "Mart") item = il.load_item() - self.assertEqual(item['name'], 'Mart') + self.assertEqual(item["name"], "Mart") def test_partial_processor(self): def join(values, sep=None, loader_context=None, ignored=None): if sep is not None: return sep.join(values) - if loader_context and 'sep' in loader_context: - return loader_context['sep'].join(values) - return ''.join(values) + if loader_context and "sep" in loader_context: + return loader_context["sep"].join(values) + return "".join(values) class TestItemLoader(NameItemLoader): - name_out = Compose(partial(join, sep='+')) - url_out = Compose(partial(join, loader_context={'sep': '.'})) - summary_out = Compose(partial(join, ignored='foo')) + name_out = Compose(partial(join, sep="+")) + url_out = Compose(partial(join, loader_context={"sep": "."})) + summary_out = Compose(partial(join, ignored="foo")) il = TestItemLoader() - il.add_value('name', ['rabbit', 'hole']) - il.add_value('url', ['rabbit', 'hole']) - il.add_value('summary', ['rabbit', 'hole']) + il.add_value("name", ["rabbit", "hole"]) + il.add_value("url", ["rabbit", "hole"]) + il.add_value("summary", ["rabbit", "hole"]) item = il.load_item() - self.assertEqual(item['name'], 'rabbit+hole') - self.assertEqual(item['url'], 'rabbit.hole') - self.assertEqual(item['summary'], 'rabbithole') + self.assertEqual(item["name"], "rabbit+hole") + self.assertEqual(item["url"], "rabbit.hole") + self.assertEqual(item["summary"], "rabbithole") def test_error_input_processor(self): class TestItem(Item): @@ -418,8 +440,7 @@ class BasicItemLoaderTest(unittest.TestCase): name_in = MapCompose(float) il = TestItemLoader() - self.assertRaises(ValueError, il.add_value, 'name', - ['marta', 'other']) + self.assertRaises(ValueError, il.add_value, "name", ["marta", "other"]) def test_error_output_processor(self): class TestItem(Item): @@ -430,7 +451,7 @@ class BasicItemLoaderTest(unittest.TestCase): name_out = Compose(Join(), float) il = TestItemLoader() - il.add_value('name', 'marta') + il.add_value("name", "marta") with self.assertRaises(ValueError): il.load_item() @@ -442,8 +463,9 @@ class BasicItemLoaderTest(unittest.TestCase): default_item_class = TestItem il = TestItemLoader() - self.assertRaises(ValueError, il.add_value, 'name', - ['marta', 'other'], Compose(float)) + self.assertRaises( + ValueError, il.add_value, "name", ["marta", "other"], Compose(float) + ) class InitializationFromDictTest(unittest.TestCase): @@ -452,85 +474,85 @@ class InitializationFromDictTest(unittest.TestCase): def test_keep_single_value(self): """Loaded item should contain values from the initial item""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo']}) + self.assertEqual(dict(loaded_item), {"name": ["foo"]}) def test_keep_list(self): """Loaded item should contain values from the initial item""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo', 'bar']}) + self.assertEqual(dict(loaded_item), {"name": ["foo", "bar"]}) def test_add_value_singlevalue_singlevalue(self): """Values added after initialization should be appended""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - il.add_value('name', 'bar') + il.add_value("name", "bar") loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo', 'bar']}) + self.assertEqual(dict(loaded_item), {"name": ["foo", "bar"]}) def test_add_value_singlevalue_list(self): """Values added after initialization should be appended""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - il.add_value('name', ['item', 'loader']) + il.add_value("name", ["item", "loader"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo', 'item', 'loader']}) + self.assertEqual(dict(loaded_item), {"name": ["foo", "item", "loader"]}) def test_add_value_list_singlevalue(self): """Values added after initialization should be appended""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - il.add_value('name', 'qwerty') + il.add_value("name", "qwerty") loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo', 'bar', 'qwerty']}) + self.assertEqual(dict(loaded_item), {"name": ["foo", "bar", "qwerty"]}) def test_add_value_list_list(self): """Values added after initialization should be appended""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - il.add_value('name', ['item', 'loader']) + il.add_value("name", ["item", "loader"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(dict(loaded_item), {'name': ['foo', 'bar', 'item', 'loader']}) + self.assertEqual(dict(loaded_item), {"name": ["foo", "bar", "item", "loader"]}) def test_get_output_value_singlevalue(self): """Getting output value must not remove value from item""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - self.assertEqual(il.get_output_value('name'), ['foo']) + self.assertEqual(il.get_output_value("name"), ["foo"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(loaded_item, dict({'name': ['foo']})) + self.assertEqual(loaded_item, dict({"name": ["foo"]})) def test_get_output_value_list(self): """Getting output value must not remove value from item""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - self.assertEqual(il.get_output_value('name'), ['foo', 'bar']) + self.assertEqual(il.get_output_value("name"), ["foo", "bar"]) loaded_item = il.load_item() self.assertIsInstance(loaded_item, self.item_class) - self.assertEqual(loaded_item, dict({'name': ['foo', 'bar']})) + self.assertEqual(loaded_item, dict({"name": ["foo", "bar"]})) def test_values_single(self): """Values from initial item must be added to loader._values""" - input_item = self.item_class(name='foo') + input_item = self.item_class(name="foo") il = ItemLoader(item=input_item) - self.assertEqual(il._values.get('name'), ['foo']) + self.assertEqual(il._values.get("name"), ["foo"]) def test_values_list(self): """Values from initial item must be added to loader._values""" - input_item = self.item_class(name=['foo', 'bar']) + input_item = self.item_class(name=["foo", "bar"]) il = ItemLoader(item=input_item) - self.assertEqual(il._values.get('name'), ['foo', 'bar']) + self.assertEqual(il._values.get("name"), ["foo", "bar"]) class BaseNoInputReprocessingLoader(ItemLoader): @@ -546,40 +568,48 @@ class NoInputReprocessingFromDictTest(unittest.TestCase): """ Loaders initialized from loaded items must not reprocess fields (dict instances) """ + def test_avoid_reprocessing_with_initial_values_single(self): - il = NoInputReprocessingDictLoader(item=dict(title='foo')) + il = NoInputReprocessingDictLoader(item=dict(title="foo")) il_loaded = il.load_item() - self.assertEqual(il_loaded, dict(title='foo')) - self.assertEqual(NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title='foo')) + self.assertEqual(il_loaded, dict(title="foo")) + self.assertEqual( + NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title="foo") + ) def test_avoid_reprocessing_with_initial_values_list(self): - il = NoInputReprocessingDictLoader(item=dict(title=['foo', 'bar'])) + il = NoInputReprocessingDictLoader(item=dict(title=["foo", "bar"])) il_loaded = il.load_item() - self.assertEqual(il_loaded, dict(title='foo')) - self.assertEqual(NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title='foo')) + self.assertEqual(il_loaded, dict(title="foo")) + self.assertEqual( + NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title="foo") + ) def test_avoid_reprocessing_without_initial_values_single(self): il = NoInputReprocessingDictLoader() - il.add_value('title', 'foo') + il.add_value("title", "foo") il_loaded = il.load_item() - self.assertEqual(il_loaded, dict(title='FOO')) - self.assertEqual(NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title='FOO')) + self.assertEqual(il_loaded, dict(title="FOO")) + self.assertEqual( + NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title="FOO") + ) def test_avoid_reprocessing_without_initial_values_list(self): il = NoInputReprocessingDictLoader() - il.add_value('title', ['foo', 'bar']) + il.add_value("title", ["foo", "bar"]) il_loaded = il.load_item() - self.assertEqual(il_loaded, dict(title='FOO')) - self.assertEqual(NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title='FOO')) + self.assertEqual(il_loaded, dict(title="FOO")) + self.assertEqual( + NoInputReprocessingDictLoader(item=il_loaded).load_item(), dict(title="FOO") + ) class TestOutputProcessorDict(unittest.TestCase): def test_output_processor(self): - class TempDict(dict): def __init__(self, *args, **kwargs): super().__init__(self, *args, **kwargs) - self.setdefault('temp', 0.3) + self.setdefault("temp", 0.3) class TempLoader(ItemLoader): default_item_class = TempDict @@ -589,64 +619,67 @@ class TestOutputProcessorDict(unittest.TestCase): loader = TempLoader() item = loader.load_item() self.assertIsInstance(item, TempDict) - self.assertEqual(dict(item), {'temp': 0.3}) + self.assertEqual(dict(item), {"temp": 0.3}) class ProcessorsTest(unittest.TestCase): - def test_take_first(self): proc = TakeFirst() - self.assertEqual(proc([None, '', 'hello', 'world']), 'hello') - self.assertEqual(proc([None, '', 0, 'hello', 'world']), 0) + self.assertEqual(proc([None, "", "hello", "world"]), "hello") + self.assertEqual(proc([None, "", 0, "hello", "world"]), 0) def test_identity(self): proc = Identity() - self.assertEqual(proc([None, '', 'hello', 'world']), - [None, '', 'hello', 'world']) + self.assertEqual( + proc([None, "", "hello", "world"]), [None, "", "hello", "world"] + ) def test_join(self): proc = Join() - self.assertRaises(TypeError, proc, [None, '', 'hello', 'world']) - self.assertEqual(proc(['', 'hello', 'world']), ' hello world') - self.assertEqual(proc(['hello', 'world']), 'hello world') - self.assertIsInstance(proc(['hello', 'world']), str) + self.assertRaises(TypeError, proc, [None, "", "hello", "world"]) + self.assertEqual(proc(["", "hello", "world"]), " hello world") + self.assertEqual(proc(["hello", "world"]), "hello world") + self.assertIsInstance(proc(["hello", "world"]), str) def test_compose(self): proc = Compose(lambda v: v[0], str.upper) - self.assertEqual(proc(['hello', 'world']), 'HELLO') + self.assertEqual(proc(["hello", "world"]), "HELLO") proc = Compose(str.upper) self.assertEqual(proc(None), None) proc = Compose(str.upper, stop_on_none=False) self.assertRaises(ValueError, proc, None) proc = Compose(str.upper, lambda x: x + 1) - self.assertRaises(ValueError, proc, 'hello') + self.assertRaises(ValueError, proc, "hello") def test_mapcompose(self): def filter_world(x): - return None if x == 'world' else x + return None if x == "world" else x + proc = MapCompose(filter_world, str.upper) - self.assertEqual(proc(['hello', 'world', 'this', 'is', 'scrapy']), - ['HELLO', 'THIS', 'IS', 'SCRAPY']) + self.assertEqual( + proc(["hello", "world", "this", "is", "scrapy"]), + ["HELLO", "THIS", "IS", "SCRAPY"], + ) proc = MapCompose(filter_world, str.upper) self.assertEqual(proc(None), []) proc = MapCompose(filter_world, str.upper) self.assertRaises(ValueError, proc, [1]) proc = MapCompose(filter_world, lambda x: x + 1) - self.assertRaises(ValueError, proc, 'hello') + self.assertRaises(ValueError, proc, "hello") class SelectJmesTestCase(unittest.TestCase): test_list_equals = { - 'simple': ('foo.bar', {"foo": {"bar": "baz"}}, "baz"), - 'invalid': ('foo.bar.baz', {"foo": {"bar": "baz"}}, None), - 'top_level': ('foo', {"foo": {"bar": "baz"}}, {"bar": "baz"}), - 'double_vs_single_quote_string': ('foo.bar', {"foo": {"bar": "baz"}}, "baz"), - 'dict': ( - 'foo.bar[*].name', + "simple": ("foo.bar", {"foo": {"bar": "baz"}}, "baz"), + "invalid": ("foo.bar.baz", {"foo": {"bar": "baz"}}, None), + "top_level": ("foo", {"foo": {"bar": "baz"}}, {"bar": "baz"}), + "double_vs_single_quote_string": ("foo.bar", {"foo": {"bar": "baz"}}, "baz"), + "dict": ( + "foo.bar[*].name", {"foo": {"bar": [{"name": "one"}, {"name": "two"}]}}, - ['one', 'two'] + ["one", "two"], ), - 'list': ('[1]', [1, 2], 2) + "list": ("[1]", [1, 2], 2), } def test_output(self): @@ -654,14 +687,13 @@ class SelectJmesTestCase(unittest.TestCase): expr, test_list, expected = self.test_list_equals[tl] test = SelectJmes(expr)(test_list) self.assertEqual( - test, - expected, - msg=f'test "{tl}" got {test} expected {expected}' + test, expected, msg=f'test "{tl}" got {test} expected {expected}' ) # Functions as processors + def function_processor_strip(iterable): return [x.strip() for x in iterable] @@ -684,19 +716,14 @@ class FunctionProcessorDictLoader(ItemLoader): class FunctionProcessorTestCase(unittest.TestCase): - def test_processor_defined_in_item_loader(self): lo = FunctionProcessorDictLoader() - lo.add_value('foo', ' bar ') - lo.add_value('foo', [' asdf ', ' qwerty ']) - self.assertEqual( - dict(lo.load_item()), - {'foo': ['BAR', 'ASDF', 'QWERTY']} - ) + lo.add_value("foo", " bar ") + lo.add_value("foo", [" asdf ", " qwerty "]) + self.assertEqual(dict(lo.load_item()), {"foo": ["BAR", "ASDF", "QWERTY"]}) class DeprecatedUtilityFunctionsTestCase(unittest.TestCase): - def test_deprecated_wrap_loader_context(self): def function(*args): return None @@ -709,7 +736,7 @@ class DeprecatedUtilityFunctionsTestCase(unittest.TestCase): def test_deprecated_extract_regex(self): with warnings.catch_warnings(record=True) as w: - extract_regex(r'\w+', 'this is a test') + extract_regex(r"\w+", "this is a test") assert len(w) == 1 assert issubclass(w[0].category, ScrapyDeprecationWarning) diff --git a/tests/test_logformatter.py b/tests/test_logformatter.py index f3bb23bda..11cf6d81a 100644 --- a/tests/test_logformatter.py +++ b/tests/test_logformatter.py @@ -24,67 +24,74 @@ class CustomItem(Item): class LogFormatterTestCase(unittest.TestCase): - def setUp(self): self.formatter = LogFormatter() - self.spider = Spider('default') + self.spider = Spider("default") def test_crawled_with_referer(self): req = Request("http://www.example.com") res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] - self.assertEqual(logline, "Crawled (200) <GET http://www.example.com> (referer: None)") + logline = logkws["msg"] % logkws["args"] + self.assertEqual( + logline, "Crawled (200) <GET http://www.example.com> (referer: None)" + ) def test_crawled_without_referer(self): - req = Request("http://www.example.com", headers={'referer': 'http://example.com'}) - res = Response("http://www.example.com", flags=['cached']) + req = Request( + "http://www.example.com", headers={"referer": "http://example.com"} + ) + res = Response("http://www.example.com", flags=["cached"]) logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( logline, - "Crawled (200) <GET http://www.example.com> (referer: http://example.com) ['cached']") + "Crawled (200) <GET http://www.example.com> (referer: http://example.com) ['cached']", + ) def test_flags_in_request(self): - req = Request("http://www.example.com", flags=['test', 'flag']) + req = Request("http://www.example.com", flags=["test", "flag"]) res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( logline, - "Crawled (200) <GET http://www.example.com> ['test', 'flag'] (referer: None)") + "Crawled (200) <GET http://www.example.com> ['test', 'flag'] (referer: None)", + ) def test_dropped(self): item = {} exception = Exception("\u2018") response = Response("http://www.example.com") logkws = self.formatter.dropped(item, exception, response, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] lines = logline.splitlines() assert all(isinstance(x, str) for x in lines) - self.assertEqual(lines, ["Dropped: \u2018", '{}']) + self.assertEqual(lines, ["Dropped: \u2018", "{}"]) def test_item_error(self): # In practice, the complete traceback is shown by passing the # 'exc_info' argument to the logging function - item = {'key': 'value'} + item = {"key": "value"} exception = Exception() response = Response("http://www.example.com") logkws = self.formatter.item_error(item, exception, response, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual(logline, "Error processing {'key': 'value'}") def test_spider_error(self): # In practice, the complete traceback is shown by passing the # 'exc_info' argument to the logging function failure = Failure(Exception()) - request = Request("http://www.example.com", headers={'Referer': 'http://example.org'}) + request = Request( + "http://www.example.com", headers={"Referer": "http://example.org"} + ) response = Response("http://www.example.com", request=request) logkws = self.formatter.spider_error(failure, request, response, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( logline, - "Spider error processing <GET http://www.example.com> (referer: http://example.org)" + "Spider error processing <GET http://www.example.com> (referer: http://example.org)", ) def test_download_error_short(self): @@ -93,7 +100,7 @@ class LogFormatterTestCase(unittest.TestCase): failure = Failure(Exception()) request = Request("http://www.example.com") logkws = self.formatter.download_error(failure, request, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual(logline, "Error downloading <GET http://www.example.com>") def test_download_error_long(self): @@ -101,67 +108,77 @@ class LogFormatterTestCase(unittest.TestCase): # 'exc_info' argument to the logging function failure = Failure(Exception()) request = Request("http://www.example.com") - logkws = self.formatter.download_error(failure, request, self.spider, "Some message") - logline = logkws['msg'] % logkws['args'] - self.assertEqual(logline, "Error downloading <GET http://www.example.com>: Some message") + logkws = self.formatter.download_error( + failure, request, self.spider, "Some message" + ) + logline = logkws["msg"] % logkws["args"] + self.assertEqual( + logline, "Error downloading <GET http://www.example.com>: Some message" + ) def test_scraped(self): item = CustomItem() - item['name'] = '\xa3' + item["name"] = "\xa3" response = Response("http://www.example.com") logkws = self.formatter.scraped(item, response, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] lines = logline.splitlines() assert all(isinstance(x, str) for x in lines) - self.assertEqual(lines, ["Scraped from <200 http://www.example.com>", 'name: \xa3']) + self.assertEqual( + lines, ["Scraped from <200 http://www.example.com>", "name: \xa3"] + ) class LogFormatterSubclass(LogFormatter): def crawled(self, request, response, spider): kwargs = super().crawled(request, response, spider) - CRAWLEDMSG = ( - "Crawled (%(status)s) %(request)s (referer: %(referer)s) %(flags)s" - ) - log_args = kwargs['args'] - log_args['flags'] = str(request.flags) + CRAWLEDMSG = "Crawled (%(status)s) %(request)s (referer: %(referer)s) %(flags)s" + log_args = kwargs["args"] + log_args["flags"] = str(request.flags) return { - 'level': kwargs['level'], - 'msg': CRAWLEDMSG, - 'args': log_args, + "level": kwargs["level"], + "msg": CRAWLEDMSG, + "args": log_args, } class LogformatterSubclassTest(LogFormatterTestCase): def setUp(self): self.formatter = LogFormatterSubclass() - self.spider = Spider('default') + self.spider = Spider("default") def test_crawled_with_referer(self): req = Request("http://www.example.com") res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( - logline, - "Crawled (200) <GET http://www.example.com> (referer: None) []") + logline, "Crawled (200) <GET http://www.example.com> (referer: None) []" + ) def test_crawled_without_referer(self): - req = Request("http://www.example.com", headers={'referer': 'http://example.com'}, flags=['cached']) + req = Request( + "http://www.example.com", + headers={"referer": "http://example.com"}, + flags=["cached"], + ) res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( logline, - "Crawled (200) <GET http://www.example.com> (referer: http://example.com) ['cached']") + "Crawled (200) <GET http://www.example.com> (referer: http://example.com) ['cached']", + ) def test_flags_in_request(self): - req = Request("http://www.example.com", flags=['test', 'flag']) + req = Request("http://www.example.com", flags=["test", "flag"]) res = Response("http://www.example.com") logkws = self.formatter.crawled(req, res, self.spider) - logline = logkws['msg'] % logkws['args'] + logline = logkws["msg"] % logkws["args"] self.assertEqual( logline, - "Crawled (200) <GET http://www.example.com> (referer: None) ['test', 'flag']") + "Crawled (200) <GET http://www.example.com> (referer: None) ['test', 'flag']", + ) class SkipMessagesLogFormatter(LogFormatter): @@ -191,8 +208,8 @@ class ShowOrSkipMessagesTestCase(TwistedTestCase): self.mockserver = MockServer() self.mockserver.__enter__() self.base_settings = { - 'LOG_LEVEL': 'DEBUG', - 'ITEM_PIPELINES': { + "LOG_LEVEL": "DEBUG", + "ITEM_PIPELINES": { DropSomeItemsPipeline: 300, }, } @@ -212,7 +229,7 @@ class ShowOrSkipMessagesTestCase(TwistedTestCase): @defer.inlineCallbacks def test_skip_messages(self): settings = self.base_settings.copy() - settings['LOG_FORMATTER'] = SkipMessagesLogFormatter + settings["LOG_FORMATTER"] = SkipMessagesLogFormatter crawler = get_crawler(ItemSpider, settings) with LogCapture() as lc: yield crawler.crawl(mockserver=self.mockserver) diff --git a/tests/test_mail.py b/tests/test_mail.py index 9b248fbfa..c78980d57 100644 --- a/tests/test_mail.py +++ b/tests/test_mail.py @@ -8,118 +8,144 @@ from scrapy.mail import MailSender class MailSenderTest(unittest.TestCase): - def test_send(self): mailsender = MailSender(debug=True) - mailsender.send(to=['test@scrapy.org'], subject='subject', body='body', - _callback=self._catch_mail_sent) + mailsender.send( + to=["test@scrapy.org"], + subject="subject", + body="body", + _callback=self._catch_mail_sent, + ) assert self.catched_msg - self.assertEqual(self.catched_msg['to'], ['test@scrapy.org']) - self.assertEqual(self.catched_msg['subject'], 'subject') - self.assertEqual(self.catched_msg['body'], 'body') + self.assertEqual(self.catched_msg["to"], ["test@scrapy.org"]) + self.assertEqual(self.catched_msg["subject"], "subject") + self.assertEqual(self.catched_msg["body"], "body") - msg = self.catched_msg['msg'] - self.assertEqual(msg['to'], 'test@scrapy.org') - self.assertEqual(msg['subject'], 'subject') - self.assertEqual(msg.get_payload(), 'body') - self.assertEqual(msg.get('Content-Type'), 'text/plain') + msg = self.catched_msg["msg"] + self.assertEqual(msg["to"], "test@scrapy.org") + self.assertEqual(msg["subject"], "subject") + self.assertEqual(msg.get_payload(), "body") + self.assertEqual(msg.get("Content-Type"), "text/plain") def test_send_single_values_to_and_cc(self): mailsender = MailSender(debug=True) - mailsender.send(to='test@scrapy.org', subject='subject', body='body', - cc='test@scrapy.org', _callback=self._catch_mail_sent) + mailsender.send( + to="test@scrapy.org", + subject="subject", + body="body", + cc="test@scrapy.org", + _callback=self._catch_mail_sent, + ) def test_send_html(self): mailsender = MailSender(debug=True) - mailsender.send(to=['test@scrapy.org'], subject='subject', - body='<p>body</p>', mimetype='text/html', - _callback=self._catch_mail_sent) + mailsender.send( + to=["test@scrapy.org"], + subject="subject", + body="<p>body</p>", + mimetype="text/html", + _callback=self._catch_mail_sent, + ) - msg = self.catched_msg['msg'] - self.assertEqual(msg.get_payload(), '<p>body</p>') - self.assertEqual(msg.get('Content-Type'), 'text/html') + msg = self.catched_msg["msg"] + self.assertEqual(msg.get_payload(), "<p>body</p>") + self.assertEqual(msg.get("Content-Type"), "text/html") def test_send_attach(self): attach = BytesIO() - attach.write(b'content') + attach.write(b"content") attach.seek(0) - attachs = [('attachment', 'text/plain', attach)] + attachs = [("attachment", "text/plain", attach)] mailsender = MailSender(debug=True) - mailsender.send(to=['test@scrapy.org'], subject='subject', body='body', - attachs=attachs, _callback=self._catch_mail_sent) + mailsender.send( + to=["test@scrapy.org"], + subject="subject", + body="body", + attachs=attachs, + _callback=self._catch_mail_sent, + ) assert self.catched_msg - self.assertEqual(self.catched_msg['to'], ['test@scrapy.org']) - self.assertEqual(self.catched_msg['subject'], 'subject') - self.assertEqual(self.catched_msg['body'], 'body') + self.assertEqual(self.catched_msg["to"], ["test@scrapy.org"]) + self.assertEqual(self.catched_msg["subject"], "subject") + self.assertEqual(self.catched_msg["body"], "body") - msg = self.catched_msg['msg'] - self.assertEqual(msg['to'], 'test@scrapy.org') - self.assertEqual(msg['subject'], 'subject') + msg = self.catched_msg["msg"] + self.assertEqual(msg["to"], "test@scrapy.org") + self.assertEqual(msg["subject"], "subject") payload = msg.get_payload() assert isinstance(payload, list) self.assertEqual(len(payload), 2) text, attach = payload - self.assertEqual(text.get_payload(decode=True), b'body') - self.assertEqual(text.get_charset(), Charset('us-ascii')) - self.assertEqual(attach.get_payload(decode=True), b'content') + self.assertEqual(text.get_payload(decode=True), b"body") + self.assertEqual(text.get_charset(), Charset("us-ascii")) + self.assertEqual(attach.get_payload(decode=True), b"content") def _catch_mail_sent(self, **kwargs): self.catched_msg = dict(**kwargs) def test_send_utf8(self): - subject = 'sübjèçt' - body = 'bödÿ-àéïöñß' + subject = "sübjèçt" + body = "bödÿ-àéïöñß" mailsender = MailSender(debug=True) - mailsender.send(to=['test@scrapy.org'], subject=subject, body=body, - charset='utf-8', _callback=self._catch_mail_sent) + mailsender.send( + to=["test@scrapy.org"], + subject=subject, + body=body, + charset="utf-8", + _callback=self._catch_mail_sent, + ) assert self.catched_msg - self.assertEqual(self.catched_msg['subject'], subject) - self.assertEqual(self.catched_msg['body'], body) + self.assertEqual(self.catched_msg["subject"], subject) + self.assertEqual(self.catched_msg["body"], body) - msg = self.catched_msg['msg'] - self.assertEqual(msg['subject'], subject) + msg = self.catched_msg["msg"] + self.assertEqual(msg["subject"], subject) self.assertEqual(msg.get_payload(), body) - self.assertEqual(msg.get_charset(), Charset('utf-8')) - self.assertEqual(msg.get('Content-Type'), 'text/plain; charset="utf-8"') + self.assertEqual(msg.get_charset(), Charset("utf-8")) + self.assertEqual(msg.get("Content-Type"), 'text/plain; charset="utf-8"') def test_send_attach_utf8(self): - subject = 'sübjèçt' - body = 'bödÿ-àéïöñß' + subject = "sübjèçt" + body = "bödÿ-àéïöñß" attach = BytesIO() - attach.write(body.encode('utf-8')) + attach.write(body.encode("utf-8")) attach.seek(0) - attachs = [('attachment', 'text/plain', attach)] + attachs = [("attachment", "text/plain", attach)] mailsender = MailSender(debug=True) - mailsender.send(to=['test@scrapy.org'], subject=subject, body=body, - attachs=attachs, charset='utf-8', - _callback=self._catch_mail_sent) + mailsender.send( + to=["test@scrapy.org"], + subject=subject, + body=body, + attachs=attachs, + charset="utf-8", + _callback=self._catch_mail_sent, + ) assert self.catched_msg - self.assertEqual(self.catched_msg['subject'], subject) - self.assertEqual(self.catched_msg['body'], body) + self.assertEqual(self.catched_msg["subject"], subject) + self.assertEqual(self.catched_msg["body"], body) - msg = self.catched_msg['msg'] - self.assertEqual(msg['subject'], subject) - self.assertEqual(msg.get_charset(), Charset('utf-8')) - self.assertEqual(msg.get('Content-Type'), - 'multipart/mixed; charset="utf-8"') + msg = self.catched_msg["msg"] + self.assertEqual(msg["subject"], subject) + self.assertEqual(msg.get_charset(), Charset("utf-8")) + self.assertEqual(msg.get("Content-Type"), 'multipart/mixed; charset="utf-8"') payload = msg.get_payload() assert isinstance(payload, list) self.assertEqual(len(payload), 2) text, attach = payload - self.assertEqual(text.get_payload(decode=True).decode('utf-8'), body) - self.assertEqual(text.get_charset(), Charset('utf-8')) - self.assertEqual(attach.get_payload(decode=True).decode('utf-8'), body) + self.assertEqual(text.get_payload(decode=True).decode("utf-8"), body) + self.assertEqual(text.get_charset(), Charset("utf-8")) + self.assertEqual(attach.get_payload(decode=True).decode("utf-8"), body) if __name__ == "__main__": diff --git a/tests/test_middleware.py b/tests/test_middleware.py index 8651431b5..a84cf4c28 100644 --- a/tests/test_middleware.py +++ b/tests/test_middleware.py @@ -6,7 +6,6 @@ from scrapy.middleware import MiddlewareManager class M1: - def open_spider(self, spider): pass @@ -18,7 +17,6 @@ class M1: class M2: - def open_spider(self, spider): pass @@ -29,13 +27,11 @@ class M2: class M3: - def process(self, response, request, spider): pass class MOff: - def open_spider(self, spider): pass @@ -47,37 +43,39 @@ class MOff: class TestMiddlewareManager(MiddlewareManager): - @classmethod def _get_mwlist_from_settings(cls, settings): return [M1, MOff, M3] def _add_middleware(self, mw): super()._add_middleware(mw) - if hasattr(mw, 'process'): - self.methods['process'].append(mw.process) + if hasattr(mw, "process"): + self.methods["process"].append(mw.process) class MiddlewareManagerTest(unittest.TestCase): - def test_init(self): m1, m2, m3 = M1(), M2(), M3() mwman = TestMiddlewareManager(m1, m2, m3) - self.assertEqual(list(mwman.methods['open_spider']), [m1.open_spider, m2.open_spider]) - self.assertEqual(list(mwman.methods['close_spider']), [m2.close_spider, m1.close_spider]) - self.assertEqual(list(mwman.methods['process']), [m1.process, m3.process]) + self.assertEqual( + list(mwman.methods["open_spider"]), [m1.open_spider, m2.open_spider] + ) + self.assertEqual( + list(mwman.methods["close_spider"]), [m2.close_spider, m1.close_spider] + ) + self.assertEqual(list(mwman.methods["process"]), [m1.process, m3.process]) def test_methods(self): mwman = TestMiddlewareManager(M1(), M2(), M3()) self.assertEqual( - [x.__self__.__class__ for x in mwman.methods['open_spider']], - [M1, M2]) + [x.__self__.__class__ for x in mwman.methods["open_spider"]], [M1, M2] + ) self.assertEqual( - [x.__self__.__class__ for x in mwman.methods['close_spider']], - [M2, M1]) + [x.__self__.__class__ for x in mwman.methods["close_spider"]], [M2, M1] + ) self.assertEqual( - [x.__self__.__class__ for x in mwman.methods['process']], - [M1, M3]) + [x.__self__.__class__ for x in mwman.methods["process"]], [M1, M3] + ) def test_enabled(self): m1, m2, m3 = M1(), M2(), M3() diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index 39bca7bf2..b04da22be 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -13,7 +13,7 @@ from tests.spiders import SimpleSpider class MediaDownloadSpider(SimpleSpider): - name = 'mediadownload' + name = "mediadownload" def _process_url(self, url): return url @@ -27,34 +27,38 @@ class MediaDownloadSpider(SimpleSpider): self._process_url(response.urljoin(href)) for href in response.xpath( '//table[thead/tr/th="Filename"]/tbody//a/@href' - ).getall()], + ).getall() + ], } yield item class BrokenLinksMediaDownloadSpider(MediaDownloadSpider): - name = 'brokenmedia' + name = "brokenmedia" def _process_url(self, url): - return url + '.foo' + return url + ".foo" class RedirectedMediaDownloadSpider(MediaDownloadSpider): - name = 'redirectedmedia' + name = "redirectedmedia" def _process_url(self, url): - return add_or_replace_parameter(self.mockserver.url('/redirect-to'), 'goto', url) + return add_or_replace_parameter( + self.mockserver.url("/redirect-to"), "goto", url + ) class FileDownloadCrawlTestCase(TestCase): - pipeline_class = 'scrapy.pipelines.files.FilesPipeline' - store_setting_key = 'FILES_STORE' - media_key = 'files' - media_urls_key = 'file_urls' + pipeline_class = "scrapy.pipelines.files.FilesPipeline" + store_setting_key = "FILES_STORE" + media_key = "files" + media_urls_key = "file_urls" expected_checksums = { - '5547178b89448faf0015a13f904c936e', - 'c2281c83670e31d8aaab7cb642b824db', - 'ed3f6538dc15d4d9179dae57319edc5f'} + "5547178b89448faf0015a13f904c936e", + "c2281c83670e31d8aaab7cb642b824db", + "ed3f6538dc15d4d9179dae57319edc5f", + } def setUp(self): self.mockserver = MockServer() @@ -64,8 +68,8 @@ class FileDownloadCrawlTestCase(TestCase): self.tmpmediastore = Path(self.mktemp()) self.tmpmediastore.mkdir() self.settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', - 'ITEM_PIPELINES': {self.pipeline_class: 1}, + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + "ITEM_PIPELINES": {self.pipeline_class: 1}, self.store_setting_key: str(self.tmpmediastore), } self.runner = CrawlerRunner(self.settings) @@ -91,27 +95,25 @@ class FileDownloadCrawlTestCase(TestCase): self.assertIn(self.media_key, items[0]) # check that logs show the expected number of successful file downloads - file_dl_success = 'File (downloaded): Downloaded file from' + file_dl_success = "File (downloaded): Downloaded file from" self.assertEqual(logs.count(file_dl_success), 3) # check that the images/files status is `downloaded` for item in items: for i in item[self.media_key]: - self.assertEqual(i['status'], 'downloaded') + self.assertEqual(i["status"], "downloaded") # check that the images/files checksums are what we know they should be if self.expected_checksums is not None: checksums = set( - i['checksum'] - for item in items - for i in item[self.media_key] + i["checksum"] for item in items for i in item[self.media_key] ) self.assertEqual(checksums, self.expected_checksums) # check that the image files where actually written to the media store for item in items: for i in item[self.media_key]: - self.assertTrue((self.tmpmediastore / i['path']).exists()) + self.assertTrue((self.tmpmediastore / i["path"]).exists()) def _assert_files_download_failure(self, crawler, items, code, logs): @@ -121,13 +123,19 @@ class FileDownloadCrawlTestCase(TestCase): self.assertFalse(items[0][self.media_key]) # check that there was 1 successful fetch and 3 other responses with non-200 code - self.assertEqual(crawler.stats.get_value('downloader/request_method_count/GET'), 4) - self.assertEqual(crawler.stats.get_value('downloader/response_count'), 4) - self.assertEqual(crawler.stats.get_value('downloader/response_status_count/200'), 1) - self.assertEqual(crawler.stats.get_value(f'downloader/response_status_count/{code}'), 3) + self.assertEqual( + crawler.stats.get_value("downloader/request_method_count/GET"), 4 + ) + self.assertEqual(crawler.stats.get_value("downloader/response_count"), 4) + self.assertEqual( + crawler.stats.get_value("downloader/response_status_count/200"), 1 + ) + self.assertEqual( + crawler.stats.get_value(f"downloader/response_status_count/{code}"), 3 + ) # check that logs do show the failure on the file downloads - file_dl_failure = f'File (code: {code}): Error downloading file from' + file_dl_failure = f"File (code: {code}): Error downloading file from" self.assertEqual(logs.count(file_dl_failure), 3) # check that no files were written to the media store @@ -140,7 +148,8 @@ class FileDownloadCrawlTestCase(TestCase): yield crawler.crawl( self.mockserver.url("/files/images/"), media_key=self.media_key, - media_urls_key=self.media_urls_key) + media_urls_key=self.media_urls_key, + ) self._assert_files_downloaded(self.items, str(log)) @defer.inlineCallbacks @@ -150,7 +159,8 @@ class FileDownloadCrawlTestCase(TestCase): yield crawler.crawl( self.mockserver.url("/files/images/"), media_key=self.media_key, - media_urls_key=self.media_urls_key) + media_urls_key=self.media_urls_key, + ) self._assert_files_download_failure(crawler, self.items, 404, str(log)) @defer.inlineCallbacks @@ -161,13 +171,14 @@ class FileDownloadCrawlTestCase(TestCase): self.mockserver.url("/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, - mockserver=self.mockserver) + mockserver=self.mockserver, + ) self._assert_files_download_failure(crawler, self.items, 302, str(log)) @defer.inlineCallbacks def test_download_media_redirected_allowed(self): settings = dict(self.settings) - settings.update({'MEDIA_ALLOW_REDIRECTS': True}) + settings.update({"MEDIA_ALLOW_REDIRECTS": True}) runner = CrawlerRunner(settings) crawler = self._create_crawler(RedirectedMediaDownloadSpider, runner=runner) with LogCapture() as log: @@ -175,15 +186,20 @@ class FileDownloadCrawlTestCase(TestCase): self.mockserver.url("/files/images/"), media_key=self.media_key, media_urls_key=self.media_urls_key, - mockserver=self.mockserver) + mockserver=self.mockserver, + ) self._assert_files_downloaded(self.items, str(log)) - self.assertEqual(crawler.stats.get_value('downloader/response_status_count/302'), 3) + self.assertEqual( + crawler.stats.get_value("downloader/response_status_count/302"), 3 + ) try: from PIL import Image # noqa: imported just to check for the import error except ImportError: - skip_pillow = 'Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow' + skip_pillow = ( + "Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow" + ) else: skip_pillow = None @@ -192,10 +208,10 @@ class ImageDownloadCrawlTestCase(FileDownloadCrawlTestCase): skip = skip_pillow - pipeline_class = 'scrapy.pipelines.images.ImagesPipeline' - store_setting_key = 'IMAGES_STORE' - media_key = 'images' - media_urls_key = 'image_urls' + pipeline_class = "scrapy.pipelines.images.ImagesPipeline" + store_setting_key = "IMAGES_STORE" + media_key = "images" + media_urls_key = "image_urls" # somehow checksums for images are different for Python 3.3 expected_checksums = None diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 4acd29bf7..43942e53e 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -35,15 +35,14 @@ from scrapy.utils.test import ( def _mocked_download_func(request, info): - response = request.meta.get('response') + response = request.meta.get("response") return response() if callable(response) else response class FilesPipelineTestCase(unittest.TestCase): - def setUp(self): self.tempdir = mkdtemp() - settings_dict = {'FILES_STORE': self.tempdir} + settings_dict = {"FILES_STORE": self.tempdir} crawler = get_crawler(spidercls=None, settings_dict=settings_dict) self.pipeline = FilesPipeline.from_crawler(crawler) self.pipeline.download_func = _mocked_download_func @@ -56,41 +55,70 @@ class FilesPipelineTestCase(unittest.TestCase): file_path = self.pipeline.file_path self.assertEqual( file_path(Request("https://dev.mydeco.com/mydeco.pdf")), - 'full/c9b564df929f4bc635bdd19fde4f3d4847c757c5.pdf') + "full/c9b564df929f4bc635bdd19fde4f3d4847c757c5.pdf", + ) self.assertEqual( - file_path(Request("http://www.maddiebrown.co.uk///catalogue-items//image_54642_12175_95307.txt")), - 'full/4ce274dd83db0368bafd7e406f382ae088e39219.txt') + file_path( + Request( + "http://www.maddiebrown.co.uk///catalogue-items//image_54642_12175_95307.txt" + ) + ), + "full/4ce274dd83db0368bafd7e406f382ae088e39219.txt", + ) self.assertEqual( - file_path(Request("https://dev.mydeco.com/two/dirs/with%20spaces%2Bsigns.doc")), - 'full/94ccc495a17b9ac5d40e3eabf3afcb8c2c9b9e1a.doc') + file_path( + Request("https://dev.mydeco.com/two/dirs/with%20spaces%2Bsigns.doc") + ), + "full/94ccc495a17b9ac5d40e3eabf3afcb8c2c9b9e1a.doc", + ) self.assertEqual( - file_path(Request("http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg")), - 'full/4507be485f38b0da8a0be9eb2e1dfab8a19223f2.jpg') + file_path( + Request( + "http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg" + ) + ), + "full/4507be485f38b0da8a0be9eb2e1dfab8a19223f2.jpg", + ) self.assertEqual( file_path(Request("http://www.dorma.co.uk/images/product_details/2532/")), - 'full/97ee6f8a46cbbb418ea91502fd24176865cf39b2') + "full/97ee6f8a46cbbb418ea91502fd24176865cf39b2", + ) self.assertEqual( file_path(Request("http://www.dorma.co.uk/images/product_details/2532")), - 'full/244e0dd7d96a3b7b01f54eded250c9e272577aa1') + "full/244e0dd7d96a3b7b01f54eded250c9e272577aa1", + ) self.assertEqual( - file_path(Request("http://www.dorma.co.uk/images/product_details/2532"), - response=Response("http://www.dorma.co.uk/images/product_details/2532"), - info=object()), - 'full/244e0dd7d96a3b7b01f54eded250c9e272577aa1') + file_path( + Request("http://www.dorma.co.uk/images/product_details/2532"), + response=Response("http://www.dorma.co.uk/images/product_details/2532"), + info=object(), + ), + "full/244e0dd7d96a3b7b01f54eded250c9e272577aa1", + ) self.assertEqual( - file_path(Request("http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg.bohaha")), - 'full/76c00cef2ef669ae65052661f68d451162829507') + file_path( + Request( + "http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg.bohaha" + ) + ), + "full/76c00cef2ef669ae65052661f68d451162829507", + ) self.assertEqual( - file_path(Request("data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAR0AAACxCAMAAADOHZloAAACClBMVEX/\ - //+F0tzCwMK76ZKQ21AMqr7oAAC96JvD5aWM2kvZ78J0N7fmAAC46Y4Ap7y")), - 'full/178059cbeba2e34120a67f2dc1afc3ecc09b61cb.png') + file_path( + Request( + "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAR0AAACxCAMAAADOHZloAAACClBMVEX/\ + //+F0tzCwMK76ZKQ21AMqr7oAAC96JvD5aWM2kvZ78J0N7fmAAC46Y4Ap7y" + ) + ), + "full/178059cbeba2e34120a67f2dc1afc3ecc09b61cb.png", + ) def test_fs_store(self): assert isinstance(self.pipeline.store, FSFilesStore) self.assertEqual(self.pipeline.store.basedir, self.tempdir) - path = 'some/image/key.jpg' - fullpath = Path(self.tempdir, 'some', 'image', 'key.jpg') + path = "some/image/key.jpg" + fullpath = Path(self.tempdir, "some", "image", "key.jpg") self.assertEqual(self.pipeline.store._get_filesystem_path(path), fullpath) @defer.inlineCallbacks @@ -98,18 +126,24 @@ class FilesPipelineTestCase(unittest.TestCase): item_url = "http://example.com/file.pdf" item = _create_item_with_files(item_url) patchers = [ - mock.patch.object(FilesPipeline, 'inc_stats', return_value=True), - mock.patch.object(FSFilesStore, 'stat_file', return_value={ - 'checksum': 'abc', 'last_modified': time.time()}), - mock.patch.object(FilesPipeline, 'get_media_requests', - return_value=[_prepare_request_object(item_url)]) + mock.patch.object(FilesPipeline, "inc_stats", return_value=True), + mock.patch.object( + FSFilesStore, + "stat_file", + return_value={"checksum": "abc", "last_modified": time.time()}, + ), + mock.patch.object( + FilesPipeline, + "get_media_requests", + return_value=[_prepare_request_object(item_url)], + ), ] for p in patchers: p.start() result = yield self.pipeline.process_item(item, None) - self.assertEqual(result['files'][0]['checksum'], 'abc') - self.assertEqual(result['files'][0]['status'], 'uptodate') + self.assertEqual(result["files"][0]["checksum"], "abc") + self.assertEqual(result["files"][0]["status"], "uptodate") for p in patchers: p.stop() @@ -119,19 +153,28 @@ class FilesPipelineTestCase(unittest.TestCase): item_url = "http://example.com/file2.pdf" item = _create_item_with_files(item_url) patchers = [ - mock.patch.object(FSFilesStore, 'stat_file', return_value={ - 'checksum': 'abc', - 'last_modified': time.time() - (self.pipeline.expires * 60 * 60 * 24 * 2)}), - mock.patch.object(FilesPipeline, 'get_media_requests', - return_value=[_prepare_request_object(item_url)]), - mock.patch.object(FilesPipeline, 'inc_stats', return_value=True) + mock.patch.object( + FSFilesStore, + "stat_file", + return_value={ + "checksum": "abc", + "last_modified": time.time() + - (self.pipeline.expires * 60 * 60 * 24 * 2), + }, + ), + mock.patch.object( + FilesPipeline, + "get_media_requests", + return_value=[_prepare_request_object(item_url)], + ), + mock.patch.object(FilesPipeline, "inc_stats", return_value=True), ] for p in patchers: p.start() result = yield self.pipeline.process_item(item, None) - self.assertNotEqual(result['files'][0]['checksum'], 'abc') - self.assertEqual(result['files'][0]['status'], 'downloaded') + self.assertNotEqual(result["files"][0]["checksum"], "abc") + self.assertEqual(result["files"][0]["status"], "downloaded") for p in patchers: p.stop() @@ -141,19 +184,28 @@ class FilesPipelineTestCase(unittest.TestCase): item_url = "http://example.com/file3.pdf" item = _create_item_with_files(item_url) patchers = [ - mock.patch.object(FilesPipeline, 'inc_stats', return_value=True), - mock.patch.object(FSFilesStore, 'stat_file', return_value={ - 'checksum': 'abc', - 'last_modified': time.time() - (self.pipeline.expires * 60 * 60 * 24 * 2)}), - mock.patch.object(FilesPipeline, 'get_media_requests', - return_value=[_prepare_request_object(item_url, flags=['cached'])]) + mock.patch.object(FilesPipeline, "inc_stats", return_value=True), + mock.patch.object( + FSFilesStore, + "stat_file", + return_value={ + "checksum": "abc", + "last_modified": time.time() + - (self.pipeline.expires * 60 * 60 * 24 * 2), + }, + ), + mock.patch.object( + FilesPipeline, + "get_media_requests", + return_value=[_prepare_request_object(item_url, flags=["cached"])], + ), ] for p in patchers: p.start() result = yield self.pipeline.process_item(item, None) - self.assertNotEqual(result['files'][0]['checksum'], 'abc') - self.assertEqual(result['files'][0]['status'], 'cached') + self.assertNotEqual(result["files"][0]["checksum"], "abc") + self.assertEqual(result["files"][0]["status"], "cached") for p in patchers: p.stop() @@ -162,48 +214,58 @@ class FilesPipelineTestCase(unittest.TestCase): """ Custom file path based on item data, overriding default implementation """ + class CustomFilesPipeline(FilesPipeline): def file_path(self, request, response=None, info=None, item=None): return f'full/{item.get("path")}' - file_path = CustomFilesPipeline.from_settings(Settings({'FILES_STORE': self.tempdir})).file_path - item = dict(path='path-to-store-file') + file_path = CustomFilesPipeline.from_settings( + Settings({"FILES_STORE": self.tempdir}) + ).file_path + item = dict(path="path-to-store-file") request = Request("http://example.com") - self.assertEqual(file_path(request, item=item), 'full/path-to-store-file') + self.assertEqual(file_path(request, item=item), "full/path-to-store-file") class FilesPipelineTestCaseFieldsMixin: - def test_item_fields_default(self): - url = 'http://www.example.com/files/1.txt' - item = self.item_class(name='item1', file_urls=[url]) - pipeline = FilesPipeline.from_settings(Settings({'FILES_STORE': 's3://example/files/'})) + url = "http://www.example.com/files/1.txt" + item = self.item_class(name="item1", file_urls=[url]) + pipeline = FilesPipeline.from_settings( + Settings({"FILES_STORE": "s3://example/files/"}) + ) requests = list(pipeline.get_media_requests(item, None)) self.assertEqual(requests[0].url, url) - results = [(True, {'url': url})] + results = [(True, {"url": url})] item = pipeline.item_completed(results, item, None) files = ItemAdapter(item).get("files") self.assertEqual(files, [results[0][1]]) self.assertIsInstance(item, self.item_class) def test_item_fields_override_settings(self): - url = 'http://www.example.com/files/1.txt' - item = self.item_class(name='item1', custom_file_urls=[url]) - pipeline = FilesPipeline.from_settings(Settings({ - 'FILES_STORE': 's3://example/files/', - 'FILES_URLS_FIELD': 'custom_file_urls', - 'FILES_RESULT_FIELD': 'custom_files' - })) + url = "http://www.example.com/files/1.txt" + item = self.item_class(name="item1", custom_file_urls=[url]) + pipeline = FilesPipeline.from_settings( + Settings( + { + "FILES_STORE": "s3://example/files/", + "FILES_URLS_FIELD": "custom_file_urls", + "FILES_RESULT_FIELD": "custom_files", + } + ) + ) requests = list(pipeline.get_media_requests(item, None)) self.assertEqual(requests[0].url, url) - results = [(True, {'url': url})] + results = [(True, {"url": url})] item = pipeline.item_completed(results, item, None) custom_files = ItemAdapter(item).get("custom_files") self.assertEqual(custom_files, [results[0][1]]) self.assertIsInstance(item, self.item_class) -class FilesPipelineTestCaseFieldsDict(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): +class FilesPipelineTestCaseFieldsDict( + FilesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = dict @@ -217,7 +279,9 @@ class FilesPipelineTestItem(Item): custom_files = Field() -class FilesPipelineTestCaseFieldsItem(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): +class FilesPipelineTestCaseFieldsItem( + FilesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = FilesPipelineTestItem @@ -232,7 +296,9 @@ class FilesPipelineTestDataClass: custom_files: list = dataclasses.field(default_factory=list) -class FilesPipelineTestCaseFieldsDataClass(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): +class FilesPipelineTestCaseFieldsDataClass( + FilesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = FilesPipelineTestDataClass @@ -247,7 +313,9 @@ class FilesPipelineTestAttrsItem: custom_files = attr.ib(default=lambda: []) -class FilesPipelineTestCaseFieldsAttrsItem(FilesPipelineTestCaseFieldsMixin, unittest.TestCase): +class FilesPipelineTestCaseFieldsAttrsItem( + FilesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = FilesPipelineTestAttrsItem @@ -255,12 +323,12 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): default_cls_settings = { "EXPIRES": 90, "FILES_URLS_FIELD": "file_urls", - "FILES_RESULT_FIELD": "files" + "FILES_RESULT_FIELD": "files", } file_cls_attr_settings_map = { ("EXPIRES", "FILES_EXPIRES", "expires"), ("FILES_URLS_FIELD", "FILES_URLS_FIELD", "files_urls_field"), - ("FILES_RESULT_FIELD", "FILES_RESULT_FIELD", "files_result_field") + ("FILES_RESULT_FIELD", "FILES_RESULT_FIELD", "files_result_field"), } def setUp(self): @@ -270,7 +338,6 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): rmtree(self.tempdir) def _generate_fake_settings(self, prefix=None): - def random_string(): return "".join([chr(random.randint(97, 123)) for _ in range(10)]) @@ -278,15 +345,17 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): "FILES_EXPIRES": random.randint(100, 1000), "FILES_URLS_FIELD": random_string(), "FILES_RESULT_FIELD": random_string(), - "FILES_STORE": self.tempdir + "FILES_STORE": self.tempdir, } if not prefix: return settings - return {prefix.upper() + "_" + k if k != "FILES_STORE" else k: v for k, v in settings.items()} + return { + prefix.upper() + "_" + k if k != "FILES_STORE" else k: v + for k, v in settings.items() + } def _generate_fake_pipeline(self): - class UserDefinedFilePipeline(FilesPipeline): EXPIRES = 1001 FILES_URLS_FIELD = "alfa" @@ -339,10 +408,13 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): If there are no settings for subclass and no subclass attributes, pipeline should use attributes of base class. """ + class UserDefinedFilesPipeline(FilesPipeline): pass - user_pipeline = UserDefinedFilesPipeline.from_settings(Settings({"FILES_STORE": self.tempdir})) + user_pipeline = UserDefinedFilesPipeline.from_settings( + Settings({"FILES_STORE": self.tempdir}) + ) for pipe_attr, settings_attr, pipe_ins_attr in self.file_cls_attr_settings_map: # Values from settings for custom pipeline should be set on pipeline instance. custom_value = self.default_cls_settings.get(pipe_attr.upper()) @@ -353,6 +425,7 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): If there are custom settings for subclass and NO class attributes, pipeline should use custom settings. """ + class UserDefinedFilesPipeline(FilesPipeline): pass @@ -374,7 +447,11 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): prefix = pipeline_cls.__name__.upper() settings = self._generate_fake_settings(prefix=prefix) user_pipeline = pipeline_cls.from_settings(Settings(settings)) - for pipe_cls_attr, settings_attr, pipe_inst_attr in self.file_cls_attr_settings_map: + for ( + pipe_cls_attr, + settings_attr, + pipe_inst_attr, + ) in self.file_cls_attr_settings_map: custom_value = settings.get(prefix + "_" + settings_attr) self.assertNotEqual(custom_value, self.default_cls_settings[pipe_cls_attr]) self.assertEqual(getattr(user_pipeline, pipe_inst_attr), custom_value) @@ -384,7 +461,9 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): DEFAULT_FILES_RESULT_FIELD = "this" DEFAULT_FILES_URLS_FIELD = "that" - pipeline = UserDefinedFilesPipeline.from_settings(Settings({"FILES_STORE": self.tempdir})) + pipeline = UserDefinedFilesPipeline.from_settings( + Settings({"FILES_STORE": self.tempdir}) + ) self.assertEqual(pipeline.files_result_field, "this") self.assertEqual(pipeline.files_urls_field, "that") @@ -402,37 +481,36 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): for pipe_attr, settings_attr, pipe_inst_attr in self.file_cls_attr_settings_map: expected_value = settings.get(settings_attr) - self.assertEqual(getattr(pipeline_cls, pipe_inst_attr), - expected_value) + self.assertEqual(getattr(pipeline_cls, pipe_inst_attr), expected_value) class TestS3FilesStore(unittest.TestCase): - @defer.inlineCallbacks def test_persist(self): skip_if_no_boto() - bucket = 'mybucket' - key = 'export.csv' - uri = f's3://{bucket}/{key}' + bucket = "mybucket" + key = "export.csv" + uri = f"s3://{bucket}/{key}" buffer = mock.MagicMock() - meta = {'foo': 'bar'} - path = '' - content_type = 'image/png' + meta = {"foo": "bar"} + path = "" + content_type = "image/png" store = S3FilesStore(uri) from botocore.stub import Stubber + with Stubber(store.s3_client) as stub: stub.add_response( - 'put_object', + "put_object", expected_params={ - 'ACL': S3FilesStore.POLICY, - 'Body': buffer, - 'Bucket': bucket, - 'CacheControl': S3FilesStore.HEADERS['Cache-Control'], - 'ContentType': content_type, - 'Key': key, - 'Metadata': meta, + "ACL": S3FilesStore.POLICY, + "Body": buffer, + "Bucket": bucket, + "CacheControl": S3FilesStore.HEADERS["Cache-Control"], + "ContentType": content_type, + "Key": key, + "Metadata": meta, }, service_response={}, ) @@ -442,7 +520,7 @@ class TestS3FilesStore(unittest.TestCase): buffer, info=None, meta=meta, - headers={'Content-Type': content_type}, + headers={"Content-Type": content_type}, ) stub.assert_no_pending_responses() @@ -451,40 +529,41 @@ class TestS3FilesStore(unittest.TestCase): [ mock.call.seek(0), # The call to read does not happen with Stubber - ] + ], ) @defer.inlineCallbacks def test_stat(self): skip_if_no_boto() - bucket = 'mybucket' - key = 'export.csv' - uri = f's3://{bucket}/{key}' - checksum = '3187896a9657a28163abb31667df64c8' + bucket = "mybucket" + key = "export.csv" + uri = f"s3://{bucket}/{key}" + checksum = "3187896a9657a28163abb31667df64c8" last_modified = datetime(2019, 12, 1) store = S3FilesStore(uri) from botocore.stub import Stubber + with Stubber(store.s3_client) as stub: stub.add_response( - 'head_object', + "head_object", expected_params={ - 'Bucket': bucket, - 'Key': key, + "Bucket": bucket, + "Key": key, }, service_response={ - 'ETag': f'"{checksum}"', - 'LastModified': last_modified, + "ETag": f'"{checksum}"', + "LastModified": last_modified, }, ) - file_stats = yield store.stat_file('', info=None) + file_stats = yield store.stat_file("", info=None) self.assertEqual( file_stats, { - 'checksum': checksum, - 'last_modified': last_modified.timestamp(), + "checksum": checksum, + "last_modified": last_modified.timestamp(), }, ) @@ -495,27 +574,27 @@ class TestGCSFilesStore(unittest.TestCase): @defer.inlineCallbacks def test_persist(self): assert_gcs_environ() - uri = os.environ.get('GCS_TEST_FILE_URI') + uri = os.environ.get("GCS_TEST_FILE_URI") if not uri: raise unittest.SkipTest("No GCS URI available for testing") data = b"TestGCSFilesStore: \xe2\x98\x83" buf = BytesIO(data) - meta = {'foo': 'bar'} - path = 'full/filename' + meta = {"foo": "bar"} + path = "full/filename" store = GCSFilesStore(uri) - store.POLICY = 'authenticatedRead' - expected_policy = {'role': 'READER', 'entity': 'allAuthenticatedUsers'} + store.POLICY = "authenticatedRead" + expected_policy = {"role": "READER", "entity": "allAuthenticatedUsers"} yield store.persist_file(path, buf, info=None, meta=meta, headers=None) s = yield store.stat_file(path, info=None) - self.assertIn('last_modified', s) - self.assertIn('checksum', s) - self.assertEqual(s['checksum'], 'zc2oVgXkbQr2EQdSdw3OPA==') + self.assertIn("last_modified", s) + self.assertIn("checksum", s) + self.assertEqual(s["checksum"], "zc2oVgXkbQr2EQdSdw3OPA==") u = urlparse(uri) content, acl, blob = get_gcs_content_and_delete(u.hostname, u.path[1:] + path) self.assertEqual(content, data) - self.assertEqual(blob.metadata, {'foo': 'bar'}) + self.assertEqual(blob.metadata, {"foo": "bar"}) self.assertEqual(blob.cache_control, GCSFilesStore.CACHE_CONTROL) - self.assertEqual(blob.content_type, 'application/octet-stream') + self.assertEqual(blob.content_type, "application/octet-stream") self.assertIn(expected_policy, acl) @defer.inlineCallbacks @@ -525,17 +604,19 @@ class TestGCSFilesStore(unittest.TestCase): """ assert_gcs_environ() try: - import google.cloud.storage # noqa + import google.cloud.storage # noqa except ModuleNotFoundError: raise unittest.SkipTest("google-cloud-storage is not installed") else: - with mock.patch('google.cloud.storage') as _: - with mock.patch('scrapy.pipelines.files.time') as _: - uri = 'gs://my_bucket/my_prefix/' + with mock.patch("google.cloud.storage") as _: + with mock.patch("scrapy.pipelines.files.time") as _: + uri = "gs://my_bucket/my_prefix/" store = GCSFilesStore(uri) store.bucket = mock.Mock() - path = 'full/my_data.txt' - yield store.persist_file(path, mock.Mock(), info=None, meta=None, headers=None) + path = "full/my_data.txt" + yield store.persist_file( + path, mock.Mock(), info=None, meta=None, headers=None + ) yield store.stat_file(path, info=None) expected_blob_path = store.prefix + path store.bucket.blob.assert_called_with(expected_blob_path) @@ -545,25 +626,30 @@ class TestGCSFilesStore(unittest.TestCase): class TestFTPFileStore(unittest.TestCase): @defer.inlineCallbacks def test_persist(self): - uri = os.environ.get('FTP_TEST_FILE_URI') + uri = os.environ.get("FTP_TEST_FILE_URI") if not uri: raise unittest.SkipTest("No FTP URI available for testing") data = b"TestFTPFilesStore: \xe2\x98\x83" buf = BytesIO(data) - meta = {'foo': 'bar'} - path = 'full/filename' + meta = {"foo": "bar"} + path = "full/filename" store = FTPFilesStore(uri) empty_dict = yield store.stat_file(path, info=None) self.assertEqual(empty_dict, {}) yield store.persist_file(path, buf, info=None, meta=meta, headers=None) stat = yield store.stat_file(path, info=None) - self.assertIn('last_modified', stat) - self.assertIn('checksum', stat) - self.assertEqual(stat['checksum'], 'd113d66b2ec7258724a268bd88eef6b6') - path = f'{store.basedir}/{path}' + self.assertIn("last_modified", stat) + self.assertIn("checksum", stat) + self.assertEqual(stat["checksum"], "d113d66b2ec7258724a268bd88eef6b6") + path = f"{store.basedir}/{path}" content = get_ftp_content_and_delete( - path, store.host, store.port, - store.username, store.password, store.USE_ACTIVE_MODE) + path, + store.host, + store.port, + store.username, + store.password, + store.USE_ACTIVE_MODE, + ) self.assertEqual(data.decode(), content) @@ -574,14 +660,15 @@ class ItemWithFiles(Item): def _create_item_with_files(*files): item = ItemWithFiles() - item['file_urls'] = files + item["file_urls"] = files return item def _prepare_request_object(item_url, flags=None): return Request( item_url, - meta={'response': Response(item_url, status=200, body=b'data', flags=flags)}) + meta={"response": Response(item_url, status=200, body=b"data", flags=flags)}, + ) if __name__ == "__main__": diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index f98d40fda..3cd3e5966 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -22,17 +22,19 @@ from scrapy.utils.python import to_bytes try: from PIL import Image except ImportError: - skip_pillow = 'Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow' + skip_pillow = ( + "Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow" + ) else: - encoders = {'jpeg_encoder', 'jpeg_decoder'} + encoders = {"jpeg_encoder", "jpeg_decoder"} if not encoders.issubset(set(Image.core.__dict__)): - skip_pillow = 'Missing JPEG encoders' + skip_pillow = "Missing JPEG encoders" else: skip_pillow = None def _mocked_download_func(request, info): - response = request.meta.get('response') + response = request.meta.get("response") return response() if callable(response) else response @@ -42,7 +44,9 @@ class ImagesPipelineTestCase(unittest.TestCase): def setUp(self): self.tempdir = mkdtemp() - self.pipeline = ImagesPipeline(self.tempdir, download_func=_mocked_download_func) + self.pipeline = ImagesPipeline( + self.tempdir, download_func=_mocked_download_func + ) def tearDown(self): rmtree(self.tempdir) @@ -51,43 +55,75 @@ class ImagesPipelineTestCase(unittest.TestCase): file_path = self.pipeline.file_path self.assertEqual( file_path(Request("https://dev.mydeco.com/mydeco.gif")), - 'full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + "full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg", + ) self.assertEqual( - file_path(Request("http://www.maddiebrown.co.uk///catalogue-items//image_54642_12175_95307.jpg")), - 'full/0ffcd85d563bca45e2f90becd0ca737bc58a00b2.jpg') + file_path( + Request( + "http://www.maddiebrown.co.uk///catalogue-items//image_54642_12175_95307.jpg" + ) + ), + "full/0ffcd85d563bca45e2f90becd0ca737bc58a00b2.jpg", + ) self.assertEqual( - file_path(Request("https://dev.mydeco.com/two/dirs/with%20spaces%2Bsigns.gif")), - 'full/b250e3a74fff2e4703e310048a5b13eba79379d2.jpg') + file_path( + Request("https://dev.mydeco.com/two/dirs/with%20spaces%2Bsigns.gif") + ), + "full/b250e3a74fff2e4703e310048a5b13eba79379d2.jpg", + ) self.assertEqual( - file_path(Request("http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg")), - 'full/4507be485f38b0da8a0be9eb2e1dfab8a19223f2.jpg') + file_path( + Request( + "http://www.dfsonline.co.uk/get_prod_image.php?img=status_0907_mdm.jpg" + ) + ), + "full/4507be485f38b0da8a0be9eb2e1dfab8a19223f2.jpg", + ) self.assertEqual( file_path(Request("http://www.dorma.co.uk/images/product_details/2532/")), - 'full/97ee6f8a46cbbb418ea91502fd24176865cf39b2.jpg') + "full/97ee6f8a46cbbb418ea91502fd24176865cf39b2.jpg", + ) self.assertEqual( file_path(Request("http://www.dorma.co.uk/images/product_details/2532")), - 'full/244e0dd7d96a3b7b01f54eded250c9e272577aa1.jpg') + "full/244e0dd7d96a3b7b01f54eded250c9e272577aa1.jpg", + ) self.assertEqual( - file_path(Request("http://www.dorma.co.uk/images/product_details/2532"), - response=Response("http://www.dorma.co.uk/images/product_details/2532"), - info=object()), - 'full/244e0dd7d96a3b7b01f54eded250c9e272577aa1.jpg') + file_path( + Request("http://www.dorma.co.uk/images/product_details/2532"), + response=Response("http://www.dorma.co.uk/images/product_details/2532"), + info=object(), + ), + "full/244e0dd7d96a3b7b01f54eded250c9e272577aa1.jpg", + ) def test_thumbnail_name(self): thumb_path = self.pipeline.thumb_path - name = '50' - self.assertEqual(thumb_path(Request("file:///tmp/foo.jpg"), name), - 'thumbs/50/38a86208c36e59d4404db9e37ce04be863ef0335.jpg') - self.assertEqual(thumb_path(Request("file://foo.png"), name), - 'thumbs/50/e55b765eba0ec7348e50a1df496040449071b96a.jpg') - self.assertEqual(thumb_path(Request("file:///tmp/foo"), name), - 'thumbs/50/0329ad83ebb8e93ea7c7906d46e9ed55f7349a50.jpg') - self.assertEqual(thumb_path(Request("file:///tmp/some.name/foo"), name), - 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') - self.assertEqual(thumb_path(Request("file:///tmp/some.name/foo"), name, - response=Response("file:///tmp/some.name/foo"), - info=object()), - 'thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg') + name = "50" + self.assertEqual( + thumb_path(Request("file:///tmp/foo.jpg"), name), + "thumbs/50/38a86208c36e59d4404db9e37ce04be863ef0335.jpg", + ) + self.assertEqual( + thumb_path(Request("file://foo.png"), name), + "thumbs/50/e55b765eba0ec7348e50a1df496040449071b96a.jpg", + ) + self.assertEqual( + thumb_path(Request("file:///tmp/foo"), name), + "thumbs/50/0329ad83ebb8e93ea7c7906d46e9ed55f7349a50.jpg", + ) + self.assertEqual( + thumb_path(Request("file:///tmp/some.name/foo"), name), + "thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg", + ) + self.assertEqual( + thumb_path( + Request("file:///tmp/some.name/foo"), + name, + response=Response("file:///tmp/some.name/foo"), + info=object(), + ), + "thumbs/50/850233df65a5b83361798f532f1fc549cd13cbe9.jpg", + ) def test_thumbnail_name_from_item(self): """ @@ -95,23 +131,27 @@ class ImagesPipelineTestCase(unittest.TestCase): """ class CustomImagesPipeline(ImagesPipeline): - def thumb_path(self, request, thumb_id, response=None, info=None, item=None): + def thumb_path( + self, request, thumb_id, response=None, info=None, item=None + ): return f"thumb/{thumb_id}/{item.get('path')}" - thumb_path = CustomImagesPipeline.from_settings(Settings( - {'IMAGES_STORE': self.tempdir} - )).thumb_path - item = dict(path='path-to-store-file') + thumb_path = CustomImagesPipeline.from_settings( + Settings({"IMAGES_STORE": self.tempdir}) + ).thumb_path + item = dict(path="path-to-store-file") request = Request("http://example.com") - self.assertEqual(thumb_path(request, 'small', item=item), 'thumb/small/path-to-store-file') + self.assertEqual( + thumb_path(request, "small", item=item), "thumb/small/path-to-store-file" + ) def test_get_images_exception(self): self.pipeline.min_width = 100 self.pipeline.min_height = 100 - _, buf1 = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) - _, buf2 = _create_image('JPEG', 'RGB', (150, 50), (0, 0, 0)) - _, buf3 = _create_image('JPEG', 'RGB', (50, 150), (0, 0, 0)) + _, buf1 = _create_image("JPEG", "RGB", (50, 50), (0, 0, 0)) + _, buf2 = _create_image("JPEG", "RGB", (150, 50), (0, 0, 0)) + _, buf3 = _create_image("JPEG", "RGB", (50, 150), (0, 0, 0)) resp1 = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf1.getvalue()) resp2 = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf2.getvalue()) @@ -128,121 +168,154 @@ class ImagesPipelineTestCase(unittest.TestCase): def test_get_images_new(self): self.pipeline.min_width = 0 self.pipeline.min_height = 0 - self.pipeline.thumbs = {'small': (20, 20)} + self.pipeline.thumbs = {"small": (20, 20)} - orig_im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) - orig_thumb, orig_thumb_buf = _create_image('JPEG', 'RGB', (20, 20), (0, 0, 0)) + orig_im, buf = _create_image("JPEG", "RGB", (50, 50), (0, 0, 0)) + orig_thumb, orig_thumb_buf = _create_image("JPEG", "RGB", (20, 20), (0, 0, 0)) resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) req = Request(url="https://dev.mydeco.com/mydeco.gif") - get_images_gen = self.pipeline.get_images(response=resp, request=req, info=object()) + get_images_gen = self.pipeline.get_images( + response=resp, request=req, info=object() + ) path, new_im, new_buf = next(get_images_gen) - self.assertEqual(path, 'full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual(path, "full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg") self.assertEqual(orig_im, new_im) self.assertEqual(buf.getvalue(), new_buf.getvalue()) thumb_path, thumb_img, thumb_buf = next(get_images_gen) - self.assertEqual(thumb_path, 'thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual( + thumb_path, "thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg" + ) self.assertEqual(thumb_img, thumb_img) self.assertEqual(orig_thumb_buf.getvalue(), thumb_buf.getvalue()) def test_get_images_old(self): - self.pipeline.thumbs = {'small': (20, 20)} - orig_im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + self.pipeline.thumbs = {"small": (20, 20)} + orig_im, buf = _create_image("JPEG", "RGB", (50, 50), (0, 0, 0)) resp = Response(url="https://dev.mydeco.com/mydeco.gif", body=buf.getvalue()) req = Request(url="https://dev.mydeco.com/mydeco.gif") def overridden_convert_image(image, size=None): - im, buf = _create_image('JPEG', 'RGB', (50, 50), (0, 0, 0)) + im, buf = _create_image("JPEG", "RGB", (50, 50), (0, 0, 0)) return im, buf - with patch.object(self.pipeline, 'convert_image', overridden_convert_image): + with patch.object(self.pipeline, "convert_image", overridden_convert_image): with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - get_images_gen = self.pipeline.get_images(response=resp, request=req, info=object()) + warnings.simplefilter("always") + get_images_gen = self.pipeline.get_images( + response=resp, request=req, info=object() + ) path, new_im, new_buf = next(get_images_gen) - self.assertEqual(path, 'full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual( + path, "full/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg" + ) self.assertEqual(orig_im.mode, new_im.mode) self.assertEqual(orig_im.getcolors(), new_im.getcolors()) self.assertEqual(buf.getvalue(), new_buf.getvalue()) thumb_path, thumb_img, thumb_buf = next(get_images_gen) - self.assertEqual(thumb_path, 'thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg') + self.assertEqual( + thumb_path, + "thumbs/small/3fd165099d8e71b8a48b2683946e64dbfad8b52d.jpg", + ) self.assertEqual(orig_im.mode, thumb_img.mode) self.assertEqual(orig_im.getcolors(), thumb_img.getcolors()) self.assertEqual(buf.getvalue(), thumb_buf.getvalue()) - expected_warning_msg = ('.convert_image() method overriden in a deprecated way, ' - 'overriden method does not accept response_body argument.') - self.assertEqual(len([warning for warning in w if expected_warning_msg in str(warning.message)]), 1) + expected_warning_msg = ( + ".convert_image() method overriden in a deprecated way, " + "overriden method does not accept response_body argument." + ) + self.assertEqual( + len( + [ + warning + for warning in w + if expected_warning_msg in str(warning.message) + ] + ), + 1, + ) def test_convert_image_old(self): # tests for old API with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') + warnings.simplefilter("always") SIZE = (100, 100) # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) - im, _ = _create_image('JPEG', 'RGB', SIZE, COLOUR) + im, _ = _create_image("JPEG", "RGB", SIZE, COLOUR) converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) # check that thumbnail keep image ratio thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25)) - self.assertEqual(thumbnail.mode, 'RGB') + self.assertEqual(thumbnail.mode, "RGB") self.assertEqual(thumbnail.size, (10, 10)) # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) - im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im, _ = _create_image("PNG", "RGBA", SIZE, COLOUR) converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # transparency case with palette: P and PNG COLOUR = (0, 127, 255, 50) - im, _ = _create_image('PNG', 'RGBA', SIZE, COLOUR) - im = im.convert('P') + im, _ = _create_image("PNG", "RGBA", SIZE, COLOUR) + im = im.convert("P") converted, _ = self.pipeline.convert_image(im) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # ensure that we recieved deprecation warnings - expected_warning_msg = '.convert_image() method called in a deprecated way' - self.assertTrue(len([warning for warning in w if expected_warning_msg in str(warning.message)]) == 4) + expected_warning_msg = ".convert_image() method called in a deprecated way" + self.assertTrue( + len( + [ + warning + for warning in w + if expected_warning_msg in str(warning.message) + ] + ) + == 4 + ) def test_convert_image_new(self): # tests for new API SIZE = (100, 100) # straigh forward case: RGB and JPEG COLOUR = (0, 127, 255) - im, buf = _create_image('JPEG', 'RGB', SIZE, COLOUR) + im, buf = _create_image("JPEG", "RGB", SIZE, COLOUR) converted, converted_buf = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, COLOUR)]) # check that we don't convert JPEGs again self.assertEqual(converted_buf, buf) # check that thumbnail keep image ratio - thumbnail, _ = self.pipeline.convert_image(converted, size=(10, 25), response_body=converted_buf) - self.assertEqual(thumbnail.mode, 'RGB') + thumbnail, _ = self.pipeline.convert_image( + converted, size=(10, 25), response_body=converted_buf + ) + self.assertEqual(thumbnail.mode, "RGB") self.assertEqual(thumbnail.size, (10, 10)) # transparency case: RGBA and PNG COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) + im, buf = _create_image("PNG", "RGBA", SIZE, COLOUR) converted, _ = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) # transparency case with palette: P and PNG COLOUR = (0, 127, 255, 50) - im, buf = _create_image('PNG', 'RGBA', SIZE, COLOUR) - im = im.convert('P') + im, buf = _create_image("PNG", "RGBA", SIZE, COLOUR) + im = im.convert("P") converted, _ = self.pipeline.convert_image(im, response_body=buf) - self.assertEqual(converted.mode, 'RGB') + self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) @@ -252,11 +325,11 @@ class DeprecatedImagesPipeline(ImagesPipeline): def image_key(self, url): image_guid = hashlib.sha1(to_bytes(url)).hexdigest() - return f'empty/{image_guid}.jpg' + return f"empty/{image_guid}.jpg" def thumb_key(self, url, thumb_id): thumb_guid = hashlib.sha1(to_bytes(url)).hexdigest() - return f'thumbsup/{thumb_id}/{thumb_guid}.jpg' + return f"thumbsup/{thumb_id}/{thumb_guid}.jpg" class ImagesPipelineTestCaseFieldsMixin: @@ -264,35 +337,43 @@ class ImagesPipelineTestCaseFieldsMixin: skip = skip_pillow def test_item_fields_default(self): - url = 'http://www.example.com/images/1.jpg' - item = self.item_class(name='item1', image_urls=[url]) - pipeline = ImagesPipeline.from_settings(Settings({'IMAGES_STORE': 's3://example/images/'})) + url = "http://www.example.com/images/1.jpg" + item = self.item_class(name="item1", image_urls=[url]) + pipeline = ImagesPipeline.from_settings( + Settings({"IMAGES_STORE": "s3://example/images/"}) + ) requests = list(pipeline.get_media_requests(item, None)) self.assertEqual(requests[0].url, url) - results = [(True, {'url': url})] + results = [(True, {"url": url})] item = pipeline.item_completed(results, item, None) images = ItemAdapter(item).get("images") self.assertEqual(images, [results[0][1]]) self.assertIsInstance(item, self.item_class) def test_item_fields_override_settings(self): - url = 'http://www.example.com/images/1.jpg' - item = self.item_class(name='item1', custom_image_urls=[url]) - pipeline = ImagesPipeline.from_settings(Settings({ - 'IMAGES_STORE': 's3://example/images/', - 'IMAGES_URLS_FIELD': 'custom_image_urls', - 'IMAGES_RESULT_FIELD': 'custom_images' - })) + url = "http://www.example.com/images/1.jpg" + item = self.item_class(name="item1", custom_image_urls=[url]) + pipeline = ImagesPipeline.from_settings( + Settings( + { + "IMAGES_STORE": "s3://example/images/", + "IMAGES_URLS_FIELD": "custom_image_urls", + "IMAGES_RESULT_FIELD": "custom_images", + } + ) + ) requests = list(pipeline.get_media_requests(item, None)) self.assertEqual(requests[0].url, url) - results = [(True, {'url': url})] + results = [(True, {"url": url})] item = pipeline.item_completed(results, item, None) custom_images = ItemAdapter(item).get("custom_images") self.assertEqual(custom_images, [results[0][1]]) self.assertIsInstance(item, self.item_class) -class ImagesPipelineTestCaseFieldsDict(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): +class ImagesPipelineTestCaseFieldsDict( + ImagesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = dict @@ -306,7 +387,9 @@ class ImagesPipelineTestItem(Item): custom_images = Field() -class ImagesPipelineTestCaseFieldsItem(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): +class ImagesPipelineTestCaseFieldsItem( + ImagesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = ImagesPipelineTestItem @@ -321,7 +404,9 @@ class ImagesPipelineTestDataClass: custom_images: list = dataclasses.field(default_factory=list) -class ImagesPipelineTestCaseFieldsDataClass(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): +class ImagesPipelineTestCaseFieldsDataClass( + ImagesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = ImagesPipelineTestDataClass @@ -336,7 +421,9 @@ class ImagesPipelineTestAttrsItem: custom_images = attr.ib(default=lambda: []) -class ImagesPipelineTestCaseFieldsAttrsItem(ImagesPipelineTestCaseFieldsMixin, unittest.TestCase): +class ImagesPipelineTestCaseFieldsAttrsItem( + ImagesPipelineTestCaseFieldsMixin, unittest.TestCase +): item_class = ImagesPipelineTestAttrsItem @@ -351,7 +438,7 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): ("MIN_HEIGHT", "IMAGES_MIN_HEIGHT"), ("IMAGES_URLS_FIELD", "IMAGES_URLS_FIELD"), ("IMAGES_RESULT_FIELD", "IMAGES_RESULT_FIELD"), - ("THUMBS", "IMAGES_THUMBS") + ("THUMBS", "IMAGES_THUMBS"), ] # This should match what is defined in ImagesPipeline. @@ -360,8 +447,8 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): MIN_HEIGHT=0, EXPIRES=90, THUMBS={}, - IMAGES_URLS_FIELD='image_urls', - IMAGES_RESULT_FIELD='images' + IMAGES_URLS_FIELD="image_urls", + IMAGES_RESULT_FIELD="images", ) def setUp(self): @@ -387,26 +474,30 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): "IMAGES_MIN_WIDTH": random.randint(1, 1000), "IMAGES_MIN_HEIGHT": random.randint(1, 1000), "IMAGES_THUMBS": { - 'small': (random.randint(1, 1000), random.randint(1, 1000)), - 'big': (random.randint(1, 1000), random.randint(1, 1000)) - } + "small": (random.randint(1, 1000), random.randint(1, 1000)), + "big": (random.randint(1, 1000), random.randint(1, 1000)), + }, } if not prefix: return settings - return {prefix.upper() + "_" + k if k != "IMAGES_STORE" else k: v for k, v in settings.items()} + return { + prefix.upper() + "_" + k if k != "IMAGES_STORE" else k: v + for k, v in settings.items() + } def _generate_fake_pipeline_subclass(self): """ :return: ImagePipeline class will all uppercase attributes set. """ + class UserDefinedImagePipeline(ImagesPipeline): # Values should be in different range than fake_settings. MIN_WIDTH = random.randint(1000, 2000) MIN_HEIGHT = random.randint(1000, 2000) THUMBS = { - 'small': (random.randint(1000, 2000), random.randint(1000, 2000)), - 'big': (random.randint(1000, 2000), random.randint(1000, 2000)) + "small": (random.randint(1000, 2000), random.randint(1000, 2000)), + "big": (random.randint(1000, 2000), random.randint(1000, 2000)), } EXPIRES = random.randint(1000, 2000) IMAGES_URLS_FIELD = "field_one" @@ -427,7 +518,9 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): expected_default_value = self.default_pipeline_settings.get(pipe_attr) custom_value = custom_settings.get(settings_attr) self.assertNotEqual(expected_default_value, custom_value) - self.assertEqual(getattr(default_sts_pipe, pipe_attr.lower()), expected_default_value) + self.assertEqual( + getattr(default_sts_pipe, pipe_attr.lower()), expected_default_value + ) self.assertEqual(getattr(user_sts_pipe, pipe_attr.lower()), custom_value) def test_subclass_attrs_preserved_default_settings(self): @@ -464,10 +557,13 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): If there are no settings for subclass and no subclass attributes, pipeline should use attributes of base class. """ + class UserDefinedImagePipeline(ImagesPipeline): pass - user_pipeline = UserDefinedImagePipeline.from_settings(Settings({"IMAGES_STORE": self.tempdir})) + user_pipeline = UserDefinedImagePipeline.from_settings( + Settings({"IMAGES_STORE": self.tempdir}) + ) for pipe_attr, settings_attr in self.img_cls_attribute_names: # Values from settings for custom pipeline should be set on pipeline instance. custom_value = self.default_pipeline_settings.get(pipe_attr.upper()) @@ -478,6 +574,7 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): If there are custom settings for subclass and NO class attributes, pipeline should use custom settings. """ + class UserDefinedImagePipeline(ImagesPipeline): pass @@ -508,7 +605,10 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): class UserDefinedImagePipeline(ImagesPipeline): DEFAULT_IMAGES_URLS_FIELD = "something" DEFAULT_IMAGES_RESULT_FIELD = "something_else" - pipeline = UserDefinedImagePipeline.from_settings(Settings({"IMAGES_STORE": self.tempdir})) + + pipeline = UserDefinedImagePipeline.from_settings( + Settings({"IMAGES_STORE": self.tempdir}) + ) self.assertEqual(pipeline.images_result_field, "something_else") self.assertEqual(pipeline.images_urls_field, "something") @@ -526,12 +626,10 @@ class ImagesPipelineTestCaseCustomSettings(unittest.TestCase): for pipe_attr, settings_attr in self.img_cls_attribute_names: expected_value = settings.get(settings_attr) - self.assertEqual(getattr(pipeline_cls, pipe_attr.lower()), - expected_value) + self.assertEqual(getattr(pipeline_cls, pipe_attr.lower()), expected_value) class NoimagesDropTestCase(unittest.TestCase): - def test_deprecation_warning(self): arg = str() with warnings.catch_warnings(record=True) as w: @@ -539,8 +637,10 @@ class NoimagesDropTestCase(unittest.TestCase): self.assertEqual(len(w), 1) self.assertEqual(w[0].category, ScrapyDeprecationWarning) with warnings.catch_warnings(record=True) as w: + class SubclassedNoimagesDrop(NoimagesDrop): pass + SubclassedNoimagesDrop(arg) self.assertEqual(len(w), 1) self.assertEqual(w[0].category, ScrapyDeprecationWarning) diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 0a94ae699..87ab03395 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -23,13 +23,15 @@ from scrapy.utils.test import get_crawler try: from PIL import Image # noqa: imported just to check for the import error except ImportError: - skip_pillow: Optional[str] = 'Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow' + skip_pillow: Optional[ + str + ] = "Missing Python Imaging Library, install https://pypi.python.org/pypi/Pillow" else: skip_pillow = None def _mocked_download_func(request, info): - response = request.meta.get('response') + response = request.meta.get("response") return response() if callable(response) else response @@ -40,7 +42,7 @@ class BaseMediaPipelineTestCase(unittest.TestCase): def setUp(self): spider_cls = Spider - self.spider = spider_cls('media.com') + self.spider = spider_cls("media.com") crawler = get_crawler(spider_cls, self.settings) self.pipe = self.pipeline_class.from_crawler(crawler) self.pipe.download_func = _mocked_download_func @@ -50,29 +52,29 @@ class BaseMediaPipelineTestCase(unittest.TestCase): def tearDown(self): for name, signal in vars(signals).items(): - if not name.startswith('_'): + if not name.startswith("_"): disconnect_all(signal) def test_default_media_to_download(self): - request = Request('http://url') + request = Request("http://url") assert self.pipe.media_to_download(request, self.info) is None def test_default_get_media_requests(self): - item = dict(name='name') + item = dict(name="name") assert self.pipe.get_media_requests(item, self.info) is None def test_default_media_downloaded(self): - request = Request('http://url') - response = Response('http://url', body=b'') + request = Request("http://url") + response = Response("http://url", body=b"") assert self.pipe.media_downloaded(response, request, self.info) is response def test_default_media_failed(self): - request = Request('http://url') + request = Request("http://url") fail = Failure(Exception()) assert self.pipe.media_failed(fail, request, self.info) is fail def test_default_item_completed(self): - item = dict(name='name') + item = dict(name="name") assert self.pipe.item_completed([], item, self.info) is item # Check that failures are logged by default @@ -85,7 +87,7 @@ class BaseMediaPipelineTestCase(unittest.TestCase): assert new_item is item assert len(log.records) == 1 record = log.records[0] - assert record.levelname == 'ERROR' + assert record.levelname == "ERROR" self.assertTupleEqual(record.exc_info, failure_to_exc_info(fail)) # disable failure logging and check again @@ -97,14 +99,14 @@ class BaseMediaPipelineTestCase(unittest.TestCase): @inlineCallbacks def test_default_process_item(self): - item = dict(name='name') + item = dict(name="name") new_item = yield self.pipe.process_item(item, self.spider) assert new_item is item def test_modify_media_request(self): - request = Request('http://url') + request = Request("http://url") self.pipe._modify_media_request(request) - assert request.meta == {'handle_httpstatus_all': True} + assert request.meta == {"handle_httpstatus_all": True} def test_should_remove_req_res_references_before_caching_the_results(self): """Regression test case to prevent a memory leak in the Media Pipeline. @@ -134,8 +136,8 @@ class BaseMediaPipelineTestCase(unittest.TestCase): Chaining (https://www.python.org/dev/peps/pep-3134/). """ # Create sample pair of Request and Response objects - request = Request('http://url') - response = Response('http://url', body=b'', request=request) + request = Request("http://url") + response = Response("http://url", body=b"", request=request) # Simulate the Media Pipeline behavior to produce a Twisted Failure try: @@ -146,7 +148,7 @@ class BaseMediaPipelineTestCase(unittest.TestCase): try: # Simulate the media_downloaded callback raising a FileException # This usually happens when the status code is not 200 OK - raise FileException('download-error') + raise FileException("download-error") except Exception as exc: file_exc = exc # Simulate Twisted capturing the FileException @@ -171,42 +173,41 @@ class BaseMediaPipelineTestCase(unittest.TestCase): # ... encapsulating the original FileException ... self.assertEqual(info.downloaded[fp].value, file_exc) # ... but it should not store the StopIteration exception on its context - context = getattr(info.downloaded[fp].value, '__context__', None) + context = getattr(info.downloaded[fp].value, "__context__", None) self.assertIsNone(context) class MockedMediaPipeline(MediaPipeline): - def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self._mockcalled = [] def download(self, request, info): - self._mockcalled.append('download') + self._mockcalled.append("download") return super().download(request, info) def media_to_download(self, request, info, *, item=None): - self._mockcalled.append('media_to_download') - if 'result' in request.meta: - return request.meta.get('result') + self._mockcalled.append("media_to_download") + if "result" in request.meta: + return request.meta.get("result") return super().media_to_download(request, info) def get_media_requests(self, item, info): - self._mockcalled.append('get_media_requests') - return item.get('requests') + self._mockcalled.append("get_media_requests") + return item.get("requests") def media_downloaded(self, response, request, info, *, item=None): - self._mockcalled.append('media_downloaded') + self._mockcalled.append("media_downloaded") return super().media_downloaded(response, request, info) def media_failed(self, failure, request, info): - self._mockcalled.append('media_failed') + self._mockcalled.append("media_failed") return super().media_failed(failure, request, info) def item_completed(self, results, item, info): - self._mockcalled.append('item_completed') + self._mockcalled.append("item_completed") item = super().item_completed(results, item, info) - item['results'] = results + item["results"] = results return item @@ -215,72 +216,94 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): pipeline_class = MockedMediaPipeline def _callback(self, result): - self.pipe._mockcalled.append('request_callback') + self.pipe._mockcalled.append("request_callback") return result def _errback(self, result): - self.pipe._mockcalled.append('request_errback') + self.pipe._mockcalled.append("request_errback") return result @inlineCallbacks def test_result_succeed(self): - rsp = Response('http://url1') - req = Request('http://url1', meta=dict(response=rsp), - callback=self._callback, errback=self._errback) + rsp = Response("http://url1") + req = Request( + "http://url1", + meta=dict(response=rsp), + callback=self._callback, + errback=self._errback, + ) item = dict(requests=req) new_item = yield self.pipe.process_item(item, self.spider) - self.assertEqual(new_item['results'], [(True, rsp)]) + self.assertEqual(new_item["results"], [(True, rsp)]) self.assertEqual( self.pipe._mockcalled, - ['get_media_requests', 'media_to_download', 'media_downloaded', 'request_callback', 'item_completed']) + [ + "get_media_requests", + "media_to_download", + "media_downloaded", + "request_callback", + "item_completed", + ], + ) @inlineCallbacks def test_result_failure(self): self.pipe.LOG_FAILED_RESULTS = False fail = Failure(Exception()) - req = Request('http://url1', meta=dict(response=fail), - callback=self._callback, errback=self._errback) + req = Request( + "http://url1", + meta=dict(response=fail), + callback=self._callback, + errback=self._errback, + ) item = dict(requests=req) new_item = yield self.pipe.process_item(item, self.spider) - self.assertEqual(new_item['results'], [(False, fail)]) + self.assertEqual(new_item["results"], [(False, fail)]) self.assertEqual( self.pipe._mockcalled, - ['get_media_requests', 'media_to_download', 'media_failed', 'request_errback', 'item_completed']) + [ + "get_media_requests", + "media_to_download", + "media_failed", + "request_errback", + "item_completed", + ], + ) @inlineCallbacks def test_mix_of_success_and_failure(self): self.pipe.LOG_FAILED_RESULTS = False - rsp1 = Response('http://url1') - req1 = Request('http://url1', meta=dict(response=rsp1)) + rsp1 = Response("http://url1") + req1 = Request("http://url1", meta=dict(response=rsp1)) fail = Failure(Exception()) - req2 = Request('http://url2', meta=dict(response=fail)) + req2 = Request("http://url2", meta=dict(response=fail)) item = dict(requests=[req1, req2]) new_item = yield self.pipe.process_item(item, self.spider) - self.assertEqual(new_item['results'], [(True, rsp1), (False, fail)]) + self.assertEqual(new_item["results"], [(True, rsp1), (False, fail)]) m = self.pipe._mockcalled # only once - self.assertEqual(m[0], 'get_media_requests') # first hook called - self.assertEqual(m.count('get_media_requests'), 1) - self.assertEqual(m.count('item_completed'), 1) - self.assertEqual(m[-1], 'item_completed') # last hook called + self.assertEqual(m[0], "get_media_requests") # first hook called + self.assertEqual(m.count("get_media_requests"), 1) + self.assertEqual(m.count("item_completed"), 1) + self.assertEqual(m[-1], "item_completed") # last hook called # twice, one per request - self.assertEqual(m.count('media_to_download'), 2) + self.assertEqual(m.count("media_to_download"), 2) # one to handle success and other for failure - self.assertEqual(m.count('media_downloaded'), 1) - self.assertEqual(m.count('media_failed'), 1) + self.assertEqual(m.count("media_downloaded"), 1) + self.assertEqual(m.count("media_failed"), 1) @inlineCallbacks def test_get_media_requests(self): # returns single Request (without callback) - req = Request('http://url') + req = Request("http://url") item = dict(requests=req) # pass a single item new_item = yield self.pipe.process_item(item, self.spider) assert new_item is item self.assertIn(self.fingerprint(req), self.info.downloaded) # returns iterable of Requests - req1 = Request('http://url1') - req2 = Request('http://url2') + req1 = Request("http://url1") + req2 = Request("http://url2") item = dict(requests=iter([req1, req2])) new_item = yield self.pipe.process_item(item, self.spider) assert new_item is item @@ -289,30 +312,34 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): @inlineCallbacks def test_results_are_cached_across_multiple_items(self): - rsp1 = Response('http://url1') - req1 = Request('http://url1', meta=dict(response=rsp1)) + rsp1 = Response("http://url1") + req1 = Request("http://url1", meta=dict(response=rsp1)) item = dict(requests=req1) new_item = yield self.pipe.process_item(item, self.spider) self.assertTrue(new_item is item) - self.assertEqual(new_item['results'], [(True, rsp1)]) + self.assertEqual(new_item["results"], [(True, rsp1)]) # rsp2 is ignored, rsp1 must be in results because request fingerprints are the same - req2 = Request(req1.url, meta=dict(response=Response('http://donot.download.me'))) + req2 = Request( + req1.url, meta=dict(response=Response("http://donot.download.me")) + ) item = dict(requests=req2) new_item = yield self.pipe.process_item(item, self.spider) self.assertTrue(new_item is item) self.assertEqual(self.fingerprint(req1), self.fingerprint(req2)) - self.assertEqual(new_item['results'], [(True, rsp1)]) + self.assertEqual(new_item["results"], [(True, rsp1)]) @inlineCallbacks def test_results_are_cached_for_requests_of_single_item(self): - rsp1 = Response('http://url1') - req1 = Request('http://url1', meta=dict(response=rsp1)) - req2 = Request(req1.url, meta=dict(response=Response('http://donot.download.me'))) + rsp1 = Response("http://url1") + req1 = Request("http://url1", meta=dict(response=rsp1)) + req2 = Request( + req1.url, meta=dict(response=Response("http://donot.download.me")) + ) item = dict(requests=[req1, req2]) new_item = yield self.pipe.process_item(item, self.spider) self.assertTrue(new_item is item) - self.assertEqual(new_item['results'], [(True, rsp1), (True, rsp1)]) + self.assertEqual(new_item["results"], [(True, rsp1), (True, rsp1)]) @inlineCallbacks def test_wait_if_request_is_downloading(self): @@ -324,78 +351,80 @@ class MediaPipelineTestCase(BaseMediaPipelineTestCase): self.assertEqual(len(self.info.waiting[fp]), 2) return response - rsp1 = Response('http://url') + rsp1 = Response("http://url") def rsp1_func(): dfd = Deferred().addCallback(_check_downloading) - reactor.callLater(.1, dfd.callback, rsp1) + reactor.callLater(0.1, dfd.callback, rsp1) return dfd def rsp2_func(): - self.fail('it must cache rsp1 result and must not try to redownload') + self.fail("it must cache rsp1 result and must not try to redownload") - req1 = Request('http://url', meta=dict(response=rsp1_func)) + req1 = Request("http://url", meta=dict(response=rsp1_func)) req2 = Request(req1.url, meta=dict(response=rsp2_func)) item = dict(requests=[req1, req2]) new_item = yield self.pipe.process_item(item, self.spider) - self.assertEqual(new_item['results'], [(True, rsp1), (True, rsp1)]) + self.assertEqual(new_item["results"], [(True, rsp1), (True, rsp1)]) @inlineCallbacks def test_use_media_to_download_result(self): - req = Request('http://url', meta=dict(result='ITSME', response=self.fail)) + req = Request("http://url", meta=dict(result="ITSME", response=self.fail)) item = dict(requests=req) new_item = yield self.pipe.process_item(item, self.spider) - self.assertEqual(new_item['results'], [(True, 'ITSME')]) + self.assertEqual(new_item["results"], [(True, "ITSME")]) self.assertEqual( self.pipe._mockcalled, - ['get_media_requests', 'media_to_download', 'item_completed']) + ["get_media_requests", "media_to_download", "item_completed"], + ) class MockedMediaPipelineDeprecatedMethods(ImagesPipeline): - def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self._mockcalled = [] def get_media_requests(self, item, info): - item_url = item['image_urls'][0] + item_url = item["image_urls"][0] output_img = io.BytesIO() - img = Image.new('RGB', (60, 30), color='red') - img.save(output_img, format='JPEG') + img = Image.new("RGB", (60, 30), color="red") + img.save(output_img, format="JPEG") return Request( item_url, - meta={'response': Response(item_url, status=200, body=output_img.getvalue())} + meta={ + "response": Response(item_url, status=200, body=output_img.getvalue()) + }, ) def inc_stats(self, *args, **kwargs): return True def media_to_download(self, request, info): - self._mockcalled.append('media_to_download') + self._mockcalled.append("media_to_download") return super().media_to_download(request, info) def media_downloaded(self, response, request, info): - self._mockcalled.append('media_downloaded') + self._mockcalled.append("media_downloaded") return super().media_downloaded(response, request, info) def file_downloaded(self, response, request, info): - self._mockcalled.append('file_downloaded') + self._mockcalled.append("file_downloaded") return super().file_downloaded(response, request, info) def file_path(self, request, response=None, info=None): - self._mockcalled.append('file_path') + self._mockcalled.append("file_path") return super().file_path(request, response, info) def thumb_path(self, request, thumb_id, response=None, info=None): - self._mockcalled.append('thumb_path') + self._mockcalled.append("thumb_path") return super().thumb_path(request, thumb_id, response, info) def get_images(self, response, request, info): - self._mockcalled.append('get_images') + self._mockcalled.append("get_images") return super().get_images(response, request, info) def image_downloaded(self, response, request, info): - self._mockcalled.append('image_downloaded') + self._mockcalled.append("image_downloaded") return super().image_downloaded(response, request, info) @@ -404,20 +433,23 @@ class MediaPipelineDeprecatedMethodsTestCase(unittest.TestCase): def setUp(self): settings_dict = { - 'IMAGES_STORE': 'store-uri', - 'IMAGES_THUMBS': {'small': (50, 50)}, + "IMAGES_STORE": "store-uri", + "IMAGES_THUMBS": {"small": (50, 50)}, } crawler = get_crawler(spidercls=None, settings_dict=settings_dict) self.pipe = MockedMediaPipelineDeprecatedMethods.from_crawler(crawler) self.pipe.download_func = _mocked_download_func self.pipe.open_spider(None) - self.item = dict(image_urls=['http://picsum.photos/id/1014/200/300'], images=[]) + self.item = dict(image_urls=["http://picsum.photos/id/1014/200/300"], images=[]) def _assert_method_called_with_warnings(self, method, message, warnings): self.assertIn(method, self.pipe._mockcalled) warningShown = False for warning in warnings: - if warning['message'] == message and warning['category'] == ScrapyDeprecationWarning: + if ( + warning["message"] == message + and warning["category"] == ScrapyDeprecationWarning + ): warningShown = True self.assertTrue(warningShown) @@ -426,125 +458,111 @@ class MediaPipelineDeprecatedMethodsTestCase(unittest.TestCase): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'media_to_download(self, request, info) is deprecated, ' - 'please use media_to_download(self, request, info, *, item=None)' + "media_to_download(self, request, info) is deprecated, " + "please use media_to_download(self, request, info, *, item=None)" ) - self._assert_method_called_with_warnings('media_to_download', message, warnings) + self._assert_method_called_with_warnings("media_to_download", message, warnings) @inlineCallbacks def test_media_downloaded_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'media_downloaded(self, response, request, info) is deprecated, ' - 'please use media_downloaded(self, response, request, info, *, item=None)' + "media_downloaded(self, response, request, info) is deprecated, " + "please use media_downloaded(self, response, request, info, *, item=None)" ) - self._assert_method_called_with_warnings('media_downloaded', message, warnings) + self._assert_method_called_with_warnings("media_downloaded", message, warnings) @inlineCallbacks def test_file_downloaded_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'file_downloaded(self, response, request, info) is deprecated, ' - 'please use file_downloaded(self, response, request, info, *, item=None)' + "file_downloaded(self, response, request, info) is deprecated, " + "please use file_downloaded(self, response, request, info, *, item=None)" ) - self._assert_method_called_with_warnings('file_downloaded', message, warnings) + self._assert_method_called_with_warnings("file_downloaded", message, warnings) @inlineCallbacks def test_file_path_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'file_path(self, request, response=None, info=None) is deprecated, ' - 'please use file_path(self, request, response=None, info=None, *, item=None)' + "file_path(self, request, response=None, info=None) is deprecated, " + "please use file_path(self, request, response=None, info=None, *, item=None)" ) - self._assert_method_called_with_warnings('file_path', message, warnings) + self._assert_method_called_with_warnings("file_path", message, warnings) @inlineCallbacks def test_thumb_path_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'thumb_path(self, request, thumb_id, response=None, info=None) is deprecated, ' - 'please use thumb_path(self, request, thumb_id, response=None, info=None, *, item=None)' + "thumb_path(self, request, thumb_id, response=None, info=None) is deprecated, " + "please use thumb_path(self, request, thumb_id, response=None, info=None, *, item=None)" ) - self._assert_method_called_with_warnings('thumb_path', message, warnings) + self._assert_method_called_with_warnings("thumb_path", message, warnings) @inlineCallbacks def test_get_images_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'get_images(self, response, request, info) is deprecated, ' - 'please use get_images(self, response, request, info, *, item=None)' + "get_images(self, response, request, info) is deprecated, " + "please use get_images(self, response, request, info, *, item=None)" ) - self._assert_method_called_with_warnings('get_images', message, warnings) + self._assert_method_called_with_warnings("get_images", message, warnings) @inlineCallbacks def test_image_downloaded_called(self): yield self.pipe.process_item(self.item, None) warnings = self.flushWarnings([MediaPipeline._compatible]) message = ( - 'image_downloaded(self, response, request, info) is deprecated, ' - 'please use image_downloaded(self, response, request, info, *, item=None)' + "image_downloaded(self, response, request, info) is deprecated, " + "please use image_downloaded(self, response, request, info, *, item=None)" ) - self._assert_method_called_with_warnings('image_downloaded', message, warnings) + self._assert_method_called_with_warnings("image_downloaded", message, warnings) class MediaPipelineAllowRedirectSettingsTestCase(unittest.TestCase): - def _assert_request_no3xx(self, pipeline_class, settings): pipe = pipeline_class(settings=Settings(settings)) - request = Request('http://url') + request = Request("http://url") pipe._modify_media_request(request) - self.assertIn('handle_httpstatus_list', request.meta) + self.assertIn("handle_httpstatus_list", request.meta) for status, check in [ - (200, True), - - # These are the status codes we want - # the downloader to handle itself - (301, False), - (302, False), - (302, False), - (307, False), - (308, False), - - # we still want to get 4xx and 5xx - (400, True), - (404, True), - (500, True)]: + (200, True), + # These are the status codes we want + # the downloader to handle itself + (301, False), + (302, False), + (302, False), + (307, False), + (308, False), + # we still want to get 4xx and 5xx + (400, True), + (404, True), + (500, True), + ]: if check: - self.assertIn(status, request.meta['handle_httpstatus_list']) + self.assertIn(status, request.meta["handle_httpstatus_list"]) else: - self.assertNotIn(status, request.meta['handle_httpstatus_list']) + self.assertNotIn(status, request.meta["handle_httpstatus_list"]) def test_standard_setting(self): - self._assert_request_no3xx( - MediaPipeline, - { - 'MEDIA_ALLOW_REDIRECTS': True - }) + self._assert_request_no3xx(MediaPipeline, {"MEDIA_ALLOW_REDIRECTS": True}) def test_subclass_standard_setting(self): - class UserDefinedPipeline(MediaPipeline): pass - self._assert_request_no3xx( - UserDefinedPipeline, - { - 'MEDIA_ALLOW_REDIRECTS': True - }) + self._assert_request_no3xx(UserDefinedPipeline, {"MEDIA_ALLOW_REDIRECTS": True}) def test_subclass_specific_setting(self): - class UserDefinedPipeline(MediaPipeline): pass self._assert_request_no3xx( - UserDefinedPipeline, - { - 'USERDEFINEDPIPELINE_MEDIA_ALLOW_REDIRECTS': True - }) + UserDefinedPipeline, {"USERDEFINEDPIPELINE_MEDIA_ALLOW_REDIRECTS": True} + ) diff --git a/tests/test_pipelines.py b/tests/test_pipelines.py index 8e432b913..7b905d321 100644 --- a/tests/test_pipelines.py +++ b/tests/test_pipelines.py @@ -14,13 +14,13 @@ from tests.mockserver import MockServer class SimplePipeline: def process_item(self, item, spider): - item['pipeline_passed'] = True + item["pipeline_passed"] = True return item class DeferredPipeline: def cb(self, item): - item['pipeline_passed'] = True + item["pipeline_passed"] = True return item def process_item(self, item, spider): @@ -34,9 +34,10 @@ class AsyncDefPipeline: async def process_item(self, item, spider): d = Deferred() from twisted.internet import reactor + reactor.callLater(0, d.callback, None) await maybe_deferred_to_future(d) - item['pipeline_passed'] = True + item["pipeline_passed"] = True return item @@ -44,10 +45,11 @@ class AsyncDefAsyncioPipeline: async def process_item(self, item, spider): d = Deferred() from twisted.internet import reactor + reactor.callLater(0, d.callback, None) await deferred_to_future(d) await asyncio.sleep(0.2) - item['pipeline_passed'] = await get_from_asyncio_queue(True) + item["pipeline_passed"] = await get_from_asyncio_queue(True) return item @@ -55,23 +57,24 @@ class AsyncDefNotAsyncioPipeline: async def process_item(self, item, spider): d1 = Deferred() from twisted.internet import reactor + reactor.callLater(0, d1.callback, None) await d1 d2 = Deferred() reactor.callLater(0, d2.callback, None) await maybe_deferred_to_future(d2) - item['pipeline_passed'] = True + item["pipeline_passed"] = True return item class ItemSpider(Spider): - name = 'itemspider' + name = "itemspider" def start_requests(self): - yield Request(self.mockserver.url('/status?n=200')) + yield Request(self.mockserver.url("/status?n=200")) def parse(self, response): - return {'field': 42} + return {"field": 42} class PipelineTestCase(unittest.TestCase): @@ -84,12 +87,12 @@ class PipelineTestCase(unittest.TestCase): def _on_item_scraped(self, item): self.assertIsInstance(item, dict) - self.assertTrue(item.get('pipeline_passed')) + self.assertTrue(item.get("pipeline_passed")) self.items.append(item) def _create_crawler(self, pipeline_class): settings = { - 'ITEM_PIPELINES': {pipeline_class: 1}, + "ITEM_PIPELINES": {pipeline_class: 1}, } crawler = get_crawler(ItemSpider, settings) crawler.signals.connect(self._on_item_scraped, signals.item_scraped) diff --git a/tests/test_pqueues.py b/tests/test_pqueues.py index ec55033d1..96a64c19d 100644 --- a/tests/test_pqueues.py +++ b/tests/test_pqueues.py @@ -19,7 +19,9 @@ class PriorityQueueTest(unittest.TestCase): def test_queue_push_pop_one(self): temp_dir = tempfile.mkdtemp() - queue = ScrapyPriorityQueue.from_crawler(self.crawler, FifoMemoryQueue, temp_dir) + queue = ScrapyPriorityQueue.from_crawler( + self.crawler, FifoMemoryQueue, temp_dir + ) self.assertIsNone(queue.pop()) self.assertEqual(len(queue), 0) req1 = Request("https://example.org/1", priority=1) @@ -35,9 +37,14 @@ class PriorityQueueTest(unittest.TestCase): if hasattr(queuelib.queue.FifoMemoryQueue, "peek"): raise unittest.SkipTest("queuelib.queue.FifoMemoryQueue.peek is defined") temp_dir = tempfile.mkdtemp() - queue = ScrapyPriorityQueue.from_crawler(self.crawler, FifoMemoryQueue, temp_dir) + queue = ScrapyPriorityQueue.from_crawler( + self.crawler, FifoMemoryQueue, temp_dir + ) queue.push(Request("https://example.org")) - with self.assertRaises(NotImplementedError, msg="The underlying queue class does not implement 'peek'"): + with self.assertRaises( + NotImplementedError, + msg="The underlying queue class does not implement 'peek'", + ): queue.peek() queue.close() @@ -45,7 +52,9 @@ class PriorityQueueTest(unittest.TestCase): if not hasattr(queuelib.queue.FifoMemoryQueue, "peek"): raise unittest.SkipTest("queuelib.queue.FifoMemoryQueue.peek is undefined") temp_dir = tempfile.mkdtemp() - queue = ScrapyPriorityQueue.from_crawler(self.crawler, FifoMemoryQueue, temp_dir) + queue = ScrapyPriorityQueue.from_crawler( + self.crawler, FifoMemoryQueue, temp_dir + ) self.assertEqual(len(queue), 0) self.assertIsNone(queue.peek()) req1 = Request("https://example.org/1") @@ -67,7 +76,9 @@ class PriorityQueueTest(unittest.TestCase): def test_queue_push_pop_priorities(self): temp_dir = tempfile.mkdtemp() - queue = ScrapyPriorityQueue.from_crawler(self.crawler, FifoMemoryQueue, temp_dir, [-1, -2, -3]) + queue = ScrapyPriorityQueue.from_crawler( + self.crawler, FifoMemoryQueue, temp_dir, [-1, -2, -3] + ) self.assertIsNone(queue.pop()) self.assertEqual(len(queue), 0) req1 = Request("https://example.org/1", priority=1) @@ -119,7 +130,10 @@ class DownloaderAwarePriorityQueueTest(unittest.TestCase): if hasattr(queuelib.queue.FifoMemoryQueue, "peek"): raise unittest.SkipTest("queuelib.queue.FifoMemoryQueue.peek is defined") self.queue.push(Request("https://example.org")) - with self.assertRaises(NotImplementedError, msg="The underlying queue class does not implement 'peek'"): + with self.assertRaises( + NotImplementedError, + msg="The underlying queue class does not implement 'peek'", + ): self.queue.peek() def test_peek(self): diff --git a/tests/test_proxy_connect.py b/tests/test_proxy_connect.py index ea7701b5d..5aeae7546 100644 --- a/tests/test_proxy_connect.py +++ b/tests/test_proxy_connect.py @@ -17,30 +17,40 @@ from tests.spiders import SimpleSpider, SingleRequestSpider class MitmProxy: - auth_user = 'scrapy' - auth_pass = 'scrapy' + auth_user = "scrapy" + auth_pass = "scrapy" def start(self): from scrapy.utils.test import get_testenv + script = """ import sys from mitmproxy.tools.main import mitmdump sys.argv[0] = "mitmdump" sys.exit(mitmdump()) """ - cert_path = Path(__file__).parent.resolve() / 'keys' / 'mitmproxy-ca.pem' - self.proc = Popen([sys.executable, - '-c', script, - '--listen-host', '127.0.0.1', - '--listen-port', '0', - '--proxyauth', f'{self.auth_user}:{self.auth_pass}', - '--certs', str(cert_path), - '--ssl-insecure', - ], - stdout=PIPE, env=get_testenv()) - line = self.proc.stdout.readline().decode('utf-8') - host_port = re.search(r'listening at http://([^:]+:\d+)', line).group(1) - address = f'http://{self.auth_user}:{self.auth_pass}@{host_port}' + cert_path = Path(__file__).parent.resolve() / "keys" / "mitmproxy-ca.pem" + self.proc = Popen( + [ + sys.executable, + "-c", + script, + "--listen-host", + "127.0.0.1", + "--listen-port", + "0", + "--proxyauth", + f"{self.auth_user}:{self.auth_pass}", + "--certs", + str(cert_path), + "--ssl-insecure", + ], + stdout=PIPE, + env=get_testenv(), + ) + line = self.proc.stdout.readline().decode("utf-8") + host_port = re.search(r"listening at http://([^:]+:\d+)", line).group(1) + address = f"http://{self.auth_user}:{self.auth_pass}@{host_port}" return address def stop(self): @@ -50,17 +60,16 @@ sys.exit(mitmdump()) def _wrong_credentials(proxy_url): bad_auth_proxy = list(urlsplit(proxy_url)) - bad_auth_proxy[1] = bad_auth_proxy[1].replace('scrapy:scrapy@', 'wrong:wronger@') + bad_auth_proxy[1] = bad_auth_proxy[1].replace("scrapy:scrapy@", "wrong:wronger@") return urlunsplit(bad_auth_proxy) class ProxyConnectTestCase(TestCase): - def setUp(self): try: import mitmproxy # noqa: F401 except ImportError: - self.skipTest('mitmproxy is not installed') + self.skipTest("mitmproxy is not installed") self.mockserver = MockServer() self.mockserver.__enter__() @@ -68,8 +77,8 @@ class ProxyConnectTestCase(TestCase): self._proxy = MitmProxy() proxy_url = self._proxy.start() - os.environ['https_proxy'] = proxy_url - os.environ['http_proxy'] = proxy_url + os.environ["https_proxy"] = proxy_url + os.environ["http_proxy"] = proxy_url def tearDown(self): self.mockserver.__exit__(None, None, None) @@ -85,7 +94,7 @@ class ProxyConnectTestCase(TestCase): @defer.inlineCallbacks def test_https_tunnel_auth_error(self): - os.environ['https_proxy'] = _wrong_credentials(os.environ['https_proxy']) + os.environ["https_proxy"] = _wrong_credentials(os.environ["https_proxy"]) crawler = get_crawler(SimpleSpider) with LogCapture() as log: yield crawler.crawl(self.mockserver.url("/status?n=200", is_secure=True)) @@ -100,13 +109,13 @@ class ProxyConnectTestCase(TestCase): with LogCapture() as log: yield crawler.crawl(seed=request) self._assert_got_response_code(200, log) - echo = json.loads(crawler.spider.meta['responses'][0].text) - self.assertTrue('Proxy-Authorization' not in echo['headers']) + echo = json.loads(crawler.spider.meta["responses"][0].text) + self.assertTrue("Proxy-Authorization" not in echo["headers"]) def _assert_got_response_code(self, code, log): print(log) - self.assertEqual(str(log).count(f'Crawled ({code})'), 1) + self.assertEqual(str(log).count(f"Crawled ({code})"), 1) def _assert_got_tunnel_error(self, log): print(log) - self.assertIn('TunnelError', str(log)) + self.assertIn("TunnelError", str(log)) diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index 15e400327..f7540743d 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -60,7 +60,6 @@ class AlternativeCallbacksMiddleware: class CrawlTestCase(TestCase): - def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() @@ -90,11 +89,14 @@ class CrawlTestCase(TestCase): @defer.inlineCallbacks def test_downloader_middleware_raise_exception(self): url = self.mockserver.url("/status?n=200") - crawler = get_crawler(SingleRequestSpider, { - "DOWNLOADER_MIDDLEWARES": { - RaiseExceptionRequestMiddleware: 590, + crawler = get_crawler( + SingleRequestSpider, + { + "DOWNLOADER_MIDDLEWARES": { + RaiseExceptionRequestMiddleware: 590, + }, }, - }) + ) yield crawler.crawl(seed=url, mockserver=self.mockserver) failure = crawler.spider.meta["failure"] self.assertEqual(failure.request.url, url) @@ -116,11 +118,14 @@ class CrawlTestCase(TestCase): signal_params["request"] = request url = self.mockserver.url("/status?n=200") - crawler = get_crawler(SingleRequestSpider, { - "DOWNLOADER_MIDDLEWARES": { - ProcessResponseMiddleware: 595, - } - }) + crawler = get_crawler( + SingleRequestSpider, + { + "DOWNLOADER_MIDDLEWARES": { + ProcessResponseMiddleware: 595, + } + }, + ) crawler.signals.connect(signal_handler, signal=signals.response_received) with LogCapture() as log: @@ -133,7 +138,11 @@ class CrawlTestCase(TestCase): self.assertEqual(signal_params["request"].url, OVERRIDEN_URL) log.check_present( - ("scrapy.core.engine", "DEBUG", f"Crawled (200) <GET {OVERRIDEN_URL}> (referer: None)"), + ( + "scrapy.core.engine", + "DEBUG", + f"Crawled (200) <GET {OVERRIDEN_URL}> (referer: None)", + ), ) @defer.inlineCallbacks @@ -145,12 +154,15 @@ class CrawlTestCase(TestCase): The spider callback should receive the overridden response.request """ url = self.mockserver.url("/status?n=200") - crawler = get_crawler(SingleRequestSpider, { - "DOWNLOADER_MIDDLEWARES": { - RaiseExceptionRequestMiddleware: 590, - CatchExceptionOverrideRequestMiddleware: 595, + crawler = get_crawler( + SingleRequestSpider, + { + "DOWNLOADER_MIDDLEWARES": { + RaiseExceptionRequestMiddleware: 590, + CatchExceptionOverrideRequestMiddleware: 595, + }, }, - }) + ) yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.body, b"Caught ZeroDivisionError") @@ -165,12 +177,15 @@ class CrawlTestCase(TestCase): The spider callback should receive the original response.request """ url = self.mockserver.url("/status?n=200") - crawler = get_crawler(SingleRequestSpider, { - "DOWNLOADER_MIDDLEWARES": { - RaiseExceptionRequestMiddleware: 590, - CatchExceptionDoNotOverrideRequestMiddleware: 595, + crawler = get_crawler( + SingleRequestSpider, + { + "DOWNLOADER_MIDDLEWARES": { + RaiseExceptionRequestMiddleware: 590, + CatchExceptionDoNotOverrideRequestMiddleware: 595, + }, }, - }) + ) yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.body, b"Caught ZeroDivisionError") @@ -182,16 +197,23 @@ class CrawlTestCase(TestCase): Downloader middleware which returns a response with a specific 'request' attribute, with an alternative callback """ - crawler = get_crawler(AlternativeCallbacksSpider, { - "DOWNLOADER_MIDDLEWARES": { - AlternativeCallbacksMiddleware: 595, - } - }) + crawler = get_crawler( + AlternativeCallbacksSpider, + { + "DOWNLOADER_MIDDLEWARES": { + AlternativeCallbacksMiddleware: 595, + } + }, + ) with LogCapture() as log: url = self.mockserver.url("/status?n=200") yield crawler.crawl(seed=url, mockserver=self.mockserver) log.check_present( - ("alternative_callbacks_spider", "INFO", "alt_callback was invoked with foo=bar"), + ( + "alternative_callbacks_spider", + "INFO", + "alt_callback was invoked with foo=bar", + ), ) diff --git a/tests/test_request_cb_kwargs.py b/tests/test_request_cb_kwargs.py index 63e3aac00..5a3dae103 100644 --- a/tests/test_request_cb_kwargs.py +++ b/tests/test_request_cb_kwargs.py @@ -12,14 +12,15 @@ class InjectArgumentsDownloaderMiddleware: """ Make sure downloader middlewares are able to update the keyword arguments """ + def process_request(self, request, spider): - if request.callback.__name__ == 'parse_downloader_mw': - request.cb_kwargs['from_process_request'] = True + if request.callback.__name__ == "parse_downloader_mw": + request.cb_kwargs["from_process_request"] = True return None def process_response(self, request, response, spider): - if request.callback.__name__ == 'parse_downloader_mw': - request.cb_kwargs['from_process_response'] = True + if request.callback.__name__ == "parse_downloader_mw": + request.cb_kwargs["from_process_response"] = True return response @@ -27,32 +28,36 @@ class InjectArgumentsSpiderMiddleware: """ Make sure spider middlewares are able to update the keyword arguments """ + def process_start_requests(self, start_requests, spider): for request in start_requests: - if request.callback.__name__ == 'parse_spider_mw': - request.cb_kwargs['from_process_start_requests'] = True + if request.callback.__name__ == "parse_spider_mw": + request.cb_kwargs["from_process_start_requests"] = True yield request def process_spider_input(self, response, spider): request = response.request - if request.callback.__name__ == 'parse_spider_mw': - request.cb_kwargs['from_process_spider_input'] = True + if request.callback.__name__ == "parse_spider_mw": + request.cb_kwargs["from_process_spider_input"] = True return None def process_spider_output(self, response, result, spider): for element in result: - if isinstance(element, Request) and element.callback.__name__ == 'parse_spider_mw_2': - element.cb_kwargs['from_process_spider_output'] = True + if ( + isinstance(element, Request) + and element.callback.__name__ == "parse_spider_mw_2" + ): + element.cb_kwargs["from_process_spider_output"] = True yield element class KeywordArgumentsSpider(MockServerSpider): - name = 'kwargs' + name = "kwargs" custom_settings = { - 'DOWNLOADER_MIDDLEWARES': { + "DOWNLOADER_MIDDLEWARES": { InjectArgumentsDownloaderMiddleware: 750, }, - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { InjectArgumentsSpiderMiddleware: 750, }, } @@ -60,50 +65,61 @@ class KeywordArgumentsSpider(MockServerSpider): checks = [] def start_requests(self): - data = {'key': 'value', 'number': 123, 'callback': 'some_callback'} - yield Request(self.mockserver.url('/first'), self.parse_first, cb_kwargs=data) - yield Request(self.mockserver.url('/general_with'), self.parse_general, cb_kwargs=data) - yield Request(self.mockserver.url('/general_without'), self.parse_general) - yield Request(self.mockserver.url('/no_kwargs'), self.parse_no_kwargs) - yield Request(self.mockserver.url('/default'), self.parse_default, cb_kwargs=data) - yield Request(self.mockserver.url('/takes_less'), self.parse_takes_less, cb_kwargs=data) - yield Request(self.mockserver.url('/takes_more'), self.parse_takes_more, cb_kwargs=data) - yield Request(self.mockserver.url('/downloader_mw'), self.parse_downloader_mw) - yield Request(self.mockserver.url('/spider_mw'), self.parse_spider_mw) + data = {"key": "value", "number": 123, "callback": "some_callback"} + yield Request(self.mockserver.url("/first"), self.parse_first, cb_kwargs=data) + yield Request( + self.mockserver.url("/general_with"), self.parse_general, cb_kwargs=data + ) + yield Request(self.mockserver.url("/general_without"), self.parse_general) + yield Request(self.mockserver.url("/no_kwargs"), self.parse_no_kwargs) + yield Request( + self.mockserver.url("/default"), self.parse_default, cb_kwargs=data + ) + yield Request( + self.mockserver.url("/takes_less"), self.parse_takes_less, cb_kwargs=data + ) + yield Request( + self.mockserver.url("/takes_more"), self.parse_takes_more, cb_kwargs=data + ) + yield Request(self.mockserver.url("/downloader_mw"), self.parse_downloader_mw) + yield Request(self.mockserver.url("/spider_mw"), self.parse_spider_mw) def parse_first(self, response, key, number): - self.checks.append(key == 'value') + self.checks.append(key == "value") self.checks.append(number == 123) - self.crawler.stats.inc_value('boolean_checks', 2) + self.crawler.stats.inc_value("boolean_checks", 2) yield response.follow( - self.mockserver.url('/two'), + self.mockserver.url("/two"), self.parse_second, - cb_kwargs={'new_key': 'new_value'}) + cb_kwargs={"new_key": "new_value"}, + ) def parse_second(self, response, new_key): - self.checks.append(new_key == 'new_value') - self.crawler.stats.inc_value('boolean_checks') + self.checks.append(new_key == "new_value") + self.crawler.stats.inc_value("boolean_checks") def parse_general(self, response, **kwargs): - if response.url.endswith('/general_with'): - self.checks.append(kwargs['key'] == 'value') - self.checks.append(kwargs['number'] == 123) - self.checks.append(kwargs['callback'] == 'some_callback') - self.crawler.stats.inc_value('boolean_checks', 3) - elif response.url.endswith('/general_without'): - self.checks.append(kwargs == {}) # pylint: disable=use-implicit-booleaness-not-comparison - self.crawler.stats.inc_value('boolean_checks') + if response.url.endswith("/general_with"): + self.checks.append(kwargs["key"] == "value") + self.checks.append(kwargs["number"] == 123) + self.checks.append(kwargs["callback"] == "some_callback") + self.crawler.stats.inc_value("boolean_checks", 3) + elif response.url.endswith("/general_without"): + self.checks.append( + kwargs == {} + ) # pylint: disable=use-implicit-booleaness-not-comparison + self.crawler.stats.inc_value("boolean_checks") def parse_no_kwargs(self, response): - self.checks.append(response.url.endswith('/no_kwargs')) - self.crawler.stats.inc_value('boolean_checks') + self.checks.append(response.url.endswith("/no_kwargs")) + self.crawler.stats.inc_value("boolean_checks") def parse_default(self, response, key, number=None, default=99): - self.checks.append(response.url.endswith('/default')) - self.checks.append(key == 'value') + self.checks.append(response.url.endswith("/default")) + self.checks.append(key == "value") self.checks.append(number == 123) self.checks.append(default == 99) - self.crawler.stats.inc_value('boolean_checks', 4) + self.crawler.stats.inc_value("boolean_checks", 4) def parse_takes_less(self, response, key, callback): """ @@ -117,20 +133,24 @@ class KeywordArgumentsSpider(MockServerSpider): TypeError: parse_takes_more() missing 1 required positional argument: 'other' """ - def parse_downloader_mw(self, response, from_process_request, from_process_response): + def parse_downloader_mw( + self, response, from_process_request, from_process_response + ): self.checks.append(bool(from_process_request)) self.checks.append(bool(from_process_response)) - self.crawler.stats.inc_value('boolean_checks', 2) + self.crawler.stats.inc_value("boolean_checks", 2) - def parse_spider_mw(self, response, from_process_spider_input, from_process_start_requests): + def parse_spider_mw( + self, response, from_process_spider_input, from_process_start_requests + ): self.checks.append(bool(from_process_spider_input)) self.checks.append(bool(from_process_start_requests)) - self.crawler.stats.inc_value('boolean_checks', 2) - return Request(self.mockserver.url('/spider_mw_2'), self.parse_spider_mw_2) + self.crawler.stats.inc_value("boolean_checks", 2) + return Request(self.mockserver.url("/spider_mw_2"), self.parse_spider_mw_2) def parse_spider_mw_2(self, response, from_process_spider_output): self.checks.append(bool(from_process_spider_output)) - self.crawler.stats.inc_value('boolean_checks', 1) + self.crawler.stats.inc_value("boolean_checks", 1) class CallbackKeywordArgumentsTestCase(TestCase): @@ -150,24 +170,26 @@ class CallbackKeywordArgumentsTestCase(TestCase): with LogCapture() as log: yield crawler.crawl(mockserver=self.mockserver) self.assertTrue(all(crawler.spider.checks)) - self.assertEqual(len(crawler.spider.checks), crawler.stats.get_value('boolean_checks')) + self.assertEqual( + len(crawler.spider.checks), crawler.stats.get_value("boolean_checks") + ) # check exceptions for argument mismatch exceptions = {} for line in log.records: - for key in ('takes_less', 'takes_more'): + for key in ("takes_less", "takes_more"): if key in line.getMessage(): exceptions[key] = line - self.assertEqual(exceptions['takes_less'].exc_info[0], TypeError) + self.assertEqual(exceptions["takes_less"].exc_info[0], TypeError) self.assertTrue( - str(exceptions['takes_less'].exc_info[1]).endswith( + str(exceptions["takes_less"].exc_info[1]).endswith( "parse_takes_less() got an unexpected keyword argument 'number'" ), - msg="Exception message: " + str(exceptions['takes_less'].exc_info[1]), + msg="Exception message: " + str(exceptions["takes_less"].exc_info[1]), ) - self.assertEqual(exceptions['takes_more'].exc_info[0], TypeError) + self.assertEqual(exceptions["takes_more"].exc_info[0], TypeError) self.assertTrue( - str(exceptions['takes_more'].exc_info[1]).endswith( + str(exceptions["takes_more"].exc_info[1]).endswith( "parse_takes_more() missing 1 required positional argument: 'other'" ), - msg="Exception message: " + str(exceptions['takes_more'].exc_info[1]), + msg="Exception message: " + str(exceptions["takes_more"].exc_info[1]), ) diff --git a/tests/test_request_dict.py b/tests/test_request_dict.py index 5bdcb975b..d9067610e 100644 --- a/tests/test_request_dict.py +++ b/tests/test_request_dict.py @@ -14,7 +14,6 @@ class CustomRequest(Request): class RequestSerializationTest(unittest.TestCase): - def setUp(self): self.spider = TestSpider() @@ -29,13 +28,13 @@ class RequestSerializationTest(unittest.TestCase): errback=self.spider.handle_error, method="POST", body=b"some body", - headers={'content-encoding': 'text/html; charset=latin-1'}, - cookies={'currency': 'руб'}, - encoding='latin-1', + headers={"content-encoding": "text/html; charset=latin-1"}, + cookies={"currency": "руб"}, + encoding="latin-1", priority=20, - meta={'a': 'b'}, - cb_kwargs={'k': 'v'}, - flags=['testFlag'], + meta={"a": "b"}, + cb_kwargs={"k": "v"}, + flags=["testFlag"], ) self._assert_serializes_ok(r, spider=self.spider) @@ -80,46 +79,57 @@ class RequestSerializationTest(unittest.TestCase): self._assert_serializes_ok(r3, spider=self.spider) def test_callback_serialization(self): - r = Request("http://www.example.com", callback=self.spider.parse_item, - errback=self.spider.handle_error) + r = Request( + "http://www.example.com", + callback=self.spider.parse_item, + errback=self.spider.handle_error, + ) self._assert_serializes_ok(r, spider=self.spider) def test_reference_callback_serialization(self): - r = Request("http://www.example.com", - callback=self.spider.parse_item_reference, - errback=self.spider.handle_error_reference) + r = Request( + "http://www.example.com", + callback=self.spider.parse_item_reference, + errback=self.spider.handle_error_reference, + ) self._assert_serializes_ok(r, spider=self.spider) request_dict = r.to_dict(spider=self.spider) - self.assertEqual(request_dict['callback'], 'parse_item_reference') - self.assertEqual(request_dict['errback'], 'handle_error_reference') + self.assertEqual(request_dict["callback"], "parse_item_reference") + self.assertEqual(request_dict["errback"], "handle_error_reference") def test_private_reference_callback_serialization(self): - r = Request("http://www.example.com", - callback=self.spider._TestSpider__parse_item_reference, - errback=self.spider._TestSpider__handle_error_reference) + r = Request( + "http://www.example.com", + callback=self.spider._TestSpider__parse_item_reference, + errback=self.spider._TestSpider__handle_error_reference, + ) self._assert_serializes_ok(r, spider=self.spider) request_dict = r.to_dict(spider=self.spider) - self.assertEqual(request_dict['callback'], - '_TestSpider__parse_item_reference') - self.assertEqual(request_dict['errback'], - '_TestSpider__handle_error_reference') + self.assertEqual(request_dict["callback"], "_TestSpider__parse_item_reference") + self.assertEqual(request_dict["errback"], "_TestSpider__handle_error_reference") def test_private_callback_serialization(self): - r = Request("http://www.example.com", - callback=self.spider._TestSpider__parse_item_private, - errback=self.spider.handle_error) + r = Request( + "http://www.example.com", + callback=self.spider._TestSpider__parse_item_private, + errback=self.spider.handle_error, + ) self._assert_serializes_ok(r, spider=self.spider) def test_mixin_private_callback_serialization(self): - r = Request("http://www.example.com", - callback=self.spider._TestSpiderMixin__mixin_callback, - errback=self.spider.handle_error) + r = Request( + "http://www.example.com", + callback=self.spider._TestSpiderMixin__mixin_callback, + errback=self.spider.handle_error, + ) self._assert_serializes_ok(r, spider=self.spider) def test_delegated_callback_serialization(self): - r = Request("http://www.example.com", - callback=self.spider.delegated_callback, - errback=self.spider.handle_error) + r = Request( + "http://www.example.com", + callback=self.spider.delegated_callback, + errback=self.spider.handle_error, + ) self._assert_serializes_ok(r, spider=self.spider) def test_unserializable_callback1(self): @@ -134,14 +144,14 @@ class RequestSerializationTest(unittest.TestCase): """Parser method is removed or replaced dynamically.""" class MySpider(Spider): - name = 'my_spider' + name = "my_spider" def parse(self, response): pass spider = MySpider() r = Request("http://www.example.com", callback=spider.parse) - setattr(spider, 'parse', None) + setattr(spider, "parse", None) self.assertRaises(ValueError, r.to_dict, spider=spider) def test_callback_not_available(self): @@ -157,9 +167,14 @@ class DeprecatedMethodsRequestSerializationTest(RequestSerializationTest): with warnings.catch_warnings(record=True) as caught: warnings.simplefilter("always") with suppress(KeyError): - del sys.modules["scrapy.utils.reqser"] # delete module to reset the deprecation warning + del sys.modules[ + "scrapy.utils.reqser" + ] # delete module to reset the deprecation warning - from scrapy.utils.reqser import request_from_dict as _from_dict, request_to_dict as _to_dict + from scrapy.utils.reqser import ( + request_from_dict as _from_dict, + request_to_dict as _to_dict, + ) request_copy = _from_dict(_to_dict(request, spider), spider) self._assert_same_request(request, request_copy) @@ -200,7 +215,7 @@ def private_handle_error(failure): class TestSpider(Spider, TestSpiderMixin): - name = 'test' + name = "test" parse_item_reference = parse_item handle_error_reference = handle_error __parse_item_reference = private_parse_item diff --git a/tests/test_request_left.py b/tests/test_request_left.py index 4d4483881..d08ed0f68 100644 --- a/tests/test_request_left.py +++ b/tests/test_request_left.py @@ -7,12 +7,11 @@ from tests.mockserver import MockServer class SignalCatcherSpider(Spider): - name = 'signal_catcher' + name = "signal_catcher" def __init__(self, crawler, url, *args, **kwargs): super().__init__(*args, **kwargs) - crawler.signals.connect(self.on_request_left, - signal=request_left_downloader) + crawler.signals.connect(self.on_request_left, signal=request_left_downloader) self.caught_times = 0 self.start_urls = [url] @@ -26,7 +25,6 @@ class SignalCatcherSpider(Spider): class TestCatching(TestCase): - def setUp(self): self.mockserver = MockServer() self.mockserver.__enter__() @@ -42,8 +40,7 @@ class TestCatching(TestCase): @defer.inlineCallbacks def test_timeout(self): - crawler = get_crawler(SignalCatcherSpider, - {'DOWNLOAD_TIMEOUT': 0.1}) + crawler = get_crawler(SignalCatcherSpider, {"DOWNLOAD_TIMEOUT": 0.1}) yield crawler.crawl(self.mockserver.url("/delay?n=0.2")) self.assertEqual(crawler.spider.caught_times, 1) @@ -56,5 +53,5 @@ class TestCatching(TestCase): @defer.inlineCallbacks def test_noconnect(self): crawler = get_crawler(SignalCatcherSpider) - yield crawler.crawl('http://thereisdefinetelynosuchdomain.com') + yield crawler.crawl("http://thereisdefinetelynosuchdomain.com") self.assertEqual(crawler.spider.caught_times, 1) diff --git a/tests/test_responsetypes.py b/tests/test_responsetypes.py index 4b4095fb0..57484a2a1 100644 --- a/tests/test_responsetypes.py +++ b/tests/test_responsetypes.py @@ -5,15 +5,14 @@ from scrapy.http import Response, TextResponse, XmlResponse, HtmlResponse, Heade class ResponseTypesTest(unittest.TestCase): - def test_from_filename(self): mappings = [ - ('data.bin', Response), - ('file.txt', TextResponse), - ('file.xml.gz', Response), - ('file.xml', XmlResponse), - ('file.html', HtmlResponse), - ('file.unknownext', Response), + ("data.bin", Response), + ("file.txt", TextResponse), + ("file.xml.gz", Response), + ("file.xml", XmlResponse), + ("file.html", HtmlResponse), + ("file.unknownext", Response), ] for source, cls in mappings: retcls = responsetypes.from_filename(source) @@ -22,13 +21,12 @@ class ResponseTypesTest(unittest.TestCase): def test_from_content_disposition(self): mappings = [ (b'attachment; filename="data.xml"', XmlResponse), - (b'attachment; filename=data.xml', XmlResponse), - ('attachment;filename=data£.tar.gz'.encode('utf-8'), Response), - ('attachment;filename=dataµ.tar.gz'.encode('latin-1'), Response), - ('attachment;filename=data高.doc'.encode('gbk'), Response), - ('attachment;filename=دورهdata.html'.encode('cp720'), HtmlResponse), - ('attachment;filename=日本語版Wikipedia.xml'.encode('iso2022_jp'), XmlResponse), - + (b"attachment; filename=data.xml", XmlResponse), + ("attachment;filename=data£.tar.gz".encode("utf-8"), Response), + ("attachment;filename=dataµ.tar.gz".encode("latin-1"), Response), + ("attachment;filename=data高.doc".encode("gbk"), Response), + ("attachment;filename=دورهdata.html".encode("cp720"), HtmlResponse), + ("attachment;filename=日本語版Wikipedia.xml".encode("iso2022_jp"), XmlResponse), ] for source, cls in mappings: retcls = responsetypes.from_content_disposition(source) @@ -36,14 +34,14 @@ class ResponseTypesTest(unittest.TestCase): def test_from_content_type(self): mappings = [ - ('text/html; charset=UTF-8', HtmlResponse), - ('text/xml; charset=UTF-8', XmlResponse), - ('application/xhtml+xml; charset=UTF-8', HtmlResponse), - ('application/vnd.wap.xhtml+xml; charset=utf-8', HtmlResponse), - ('application/xml; charset=UTF-8', XmlResponse), - ('application/octet-stream', Response), - ('application/x-json; encoding=UTF8;charset=UTF-8', TextResponse), - ('application/json-amazonui-streaming;charset=UTF-8', TextResponse), + ("text/html; charset=UTF-8", HtmlResponse), + ("text/xml; charset=UTF-8", XmlResponse), + ("application/xhtml+xml; charset=UTF-8", HtmlResponse), + ("application/vnd.wap.xhtml+xml; charset=utf-8", HtmlResponse), + ("application/xml; charset=UTF-8", XmlResponse), + ("application/octet-stream", Response), + ("application/x-json; encoding=UTF8;charset=UTF-8", TextResponse), + ("application/json-amazonui-streaming;charset=UTF-8", TextResponse), ] for source, cls in mappings: retcls = responsetypes.from_content_type(source) @@ -51,11 +49,11 @@ class ResponseTypesTest(unittest.TestCase): def test_from_body(self): mappings = [ - (b'\x03\x02\xdf\xdd\x23', Response), - (b'Some plain text\ndata with tabs\t and null bytes\0', TextResponse), - (b'<html><head><title>Hello', HtmlResponse), + (b"\x03\x02\xdf\xdd\x23", Response), + (b"Some plain text\ndata with tabs\t and null bytes\0", TextResponse), + (b"Hello", HtmlResponse), # https://codersblock.com/blog/the-smallest-valid-html5-page/ - (b'\n.', HtmlResponse), + (b"\n.", HtmlResponse), (b'

" - response = TextResponse(url="http://example.com", body=body, encoding='utf-8') + response = TextResponse(url="http://example.com", body=body, encoding="utf-8") sel = Selector(response) - xl = sel.xpath('//input') + xl = sel.xpath("//input") self.assertEqual(2, len(xl)) for x in xl: assert isinstance(x, Selector) self.assertEqual( - sel.xpath('//input').getall(), - [x.get() for x in sel.xpath('//input')] + sel.xpath("//input").getall(), [x.get() for x in sel.xpath("//input")] ) self.assertEqual( - [x.get() for x in sel.xpath("//input[@name='a']/@name")], - ['a'] + [x.get() for x in sel.xpath("//input[@name='a']/@name")], ["a"] ) self.assertEqual( - [x.get() for x in sel.xpath("number(concat(//input[@name='a']/@value, //input[@name='b']/@value))")], - ['12.0'] + [ + x.get() + for x in sel.xpath( + "number(concat(//input[@name='a']/@value, //input[@name='b']/@value))" + ) + ], + ["12.0"], ) + self.assertEqual(sel.xpath("concat('xpath', 'rules')").getall(), ["xpathrules"]) self.assertEqual( - sel.xpath("concat('xpath', 'rules')").getall(), - ['xpathrules'] - ) - self.assertEqual( - [x.get() for x in sel.xpath("concat(//input[@name='a']/@value, //input[@name='b']/@value)")], - ['12'] + [ + x.get() + for x in sel.xpath( + "concat(//input[@name='a']/@value, //input[@name='b']/@value)" + ) + ], + ["12"], ) def test_root_base_url(self): body = b'
' url = "http://example.com" - response = TextResponse(url=url, body=body, encoding='utf-8') + response = TextResponse(url=url, body=body, encoding="utf-8") sel = Selector(response) self.assertEqual(url, sel.root.base) def test_flavor_detection(self): text = b'

Hello

' - sel = Selector(XmlResponse('http://example.com', body=text, encoding='utf-8')) - self.assertEqual(sel.type, 'xml') - self.assertEqual(sel.xpath("//div").getall(), - ['

Hello

']) + sel = Selector(XmlResponse("http://example.com", body=text, encoding="utf-8")) + self.assertEqual(sel.type, "xml") + self.assertEqual( + sel.xpath("//div").getall(), + ['

Hello

'], + ) - sel = Selector(HtmlResponse('http://example.com', body=text, encoding='utf-8')) - self.assertEqual(sel.type, 'html') - self.assertEqual(sel.xpath("//div").getall(), - ['

Hello

']) + sel = Selector(HtmlResponse("http://example.com", body=text, encoding="utf-8")) + self.assertEqual(sel.type, "html") + self.assertEqual( + sel.xpath("//div").getall(), ['

Hello

'] + ) def test_http_header_encoding_precedence(self): # '\xa3' = pound symbol in unicode # '\xc2\xa3' = pound symbol in utf-8 # '\xa3' = pound symbol in latin-1 (iso-8859-1) - meta = '' - head = '' + meta + '' + meta = ( + '' + ) + head = "" + meta + "" body_content = '\xa3' - body = '' + body_content + '' - html = '' + head + body + '' - encoding = 'utf-8' + body = "" + body_content + "" + html = "" + head + body + "" + encoding = "utf-8" html_utf8 = html.encode(encoding) - headers = {'Content-Type': ['text/html; charset=utf-8']} - response = HtmlResponse(url="http://example.com", headers=headers, body=html_utf8) + headers = {"Content-Type": ["text/html; charset=utf-8"]} + response = HtmlResponse( + url="http://example.com", headers=headers, body=html_utf8 + ) x = Selector(response) - self.assertEqual(x.xpath("//span[@id='blank']/text()").getall(), ['\xa3']) + self.assertEqual(x.xpath("//span[@id='blank']/text()").getall(), ["\xa3"]) def test_badly_encoded_body(self): # \xe9 alone isn't valid utf8 sequence - r1 = TextResponse('http://www.example.com', - body=b'

an Jos\xe9 de

', - encoding='utf-8') - Selector(r1).xpath('//text()').getall() + r1 = TextResponse( + "http://www.example.com", + body=b"

an Jos\xe9 de

", + encoding="utf-8", + ) + Selector(r1).xpath("//text()").getall() def test_weakref_slots(self): """Check that classes are using slots and are weak-referenceable""" - x = Selector(text='') + x = Selector(text="") weakref.ref(x) - assert not hasattr(x, '__dict__'), f"{x.__class__.__name__} does not use __slots__" + assert not hasattr( + x, "__dict__" + ), f"{x.__class__.__name__} does not use __slots__" def test_selector_bad_args(self): - with self.assertRaisesRegex(ValueError, 'received both response and text'): - Selector(TextResponse(url='http://example.com', body=b''), text='') + with self.assertRaisesRegex(ValueError, "received both response and text"): + Selector(TextResponse(url="http://example.com", body=b""), text="") diff --git a/tests/test_settings/__init__.py b/tests/test_settings/__init__.py index 916fe012a..9a01fd433 100644 --- a/tests/test_settings/__init__.py +++ b/tests/test_settings/__init__.py @@ -1,13 +1,17 @@ import unittest from unittest import mock -from scrapy.settings import (BaseSettings, Settings, SettingsAttribute, - SETTINGS_PRIORITIES, get_settings_priority) +from scrapy.settings import ( + BaseSettings, + Settings, + SettingsAttribute, + SETTINGS_PRIORITIES, + get_settings_priority, +) from . import default_settings class SettingsGlobalFuncsTest(unittest.TestCase): - def test_get_settings_priority(self): for prio_str, prio_num in SETTINGS_PRIORITIES.items(): self.assertEqual(get_settings_priority(prio_str), prio_num) @@ -15,127 +19,130 @@ class SettingsGlobalFuncsTest(unittest.TestCase): class SettingsAttributeTest(unittest.TestCase): - def setUp(self): - self.attribute = SettingsAttribute('value', 10) + self.attribute = SettingsAttribute("value", 10) def test_set_greater_priority(self): - self.attribute.set('value2', 20) - self.assertEqual(self.attribute.value, 'value2') + self.attribute.set("value2", 20) + self.assertEqual(self.attribute.value, "value2") self.assertEqual(self.attribute.priority, 20) def test_set_equal_priority(self): - self.attribute.set('value2', 10) - self.assertEqual(self.attribute.value, 'value2') + self.attribute.set("value2", 10) + self.assertEqual(self.attribute.value, "value2") self.assertEqual(self.attribute.priority, 10) def test_set_less_priority(self): - self.attribute.set('value2', 0) - self.assertEqual(self.attribute.value, 'value') + self.attribute.set("value2", 0) + self.assertEqual(self.attribute.value, "value") self.assertEqual(self.attribute.priority, 10) def test_overwrite_basesettings(self): - original_dict = {'one': 10, 'two': 20} + original_dict = {"one": 10, "two": 20} original_settings = BaseSettings(original_dict, 0) attribute = SettingsAttribute(original_settings, 0) - new_dict = {'three': 11, 'four': 21} + new_dict = {"three": 11, "four": 21} attribute.set(new_dict, 10) self.assertIsInstance(attribute.value, BaseSettings) self.assertCountEqual(attribute.value, new_dict) self.assertCountEqual(original_settings, original_dict) - new_settings = BaseSettings({'five': 12}, 0) + new_settings = BaseSettings({"five": 12}, 0) attribute.set(new_settings, 0) # Insufficient priority self.assertCountEqual(attribute.value, new_dict) attribute.set(new_settings, 10) self.assertCountEqual(attribute.value, new_settings) def test_repr(self): - self.assertEqual(repr(self.attribute), - "") + self.assertEqual( + repr(self.attribute), "" + ) class BaseSettingsTest(unittest.TestCase): - def setUp(self): self.settings = BaseSettings() def test_set_new_attribute(self): - self.settings.set('TEST_OPTION', 'value', 0) - self.assertIn('TEST_OPTION', self.settings.attributes) + self.settings.set("TEST_OPTION", "value", 0) + self.assertIn("TEST_OPTION", self.settings.attributes) - attr = self.settings.attributes['TEST_OPTION'] + attr = self.settings.attributes["TEST_OPTION"] self.assertIsInstance(attr, SettingsAttribute) - self.assertEqual(attr.value, 'value') + self.assertEqual(attr.value, "value") self.assertEqual(attr.priority, 0) def test_set_settingsattribute(self): myattr = SettingsAttribute(0, 30) # Note priority 30 - self.settings.set('TEST_ATTR', myattr, 10) - self.assertEqual(self.settings.get('TEST_ATTR'), 0) - self.assertEqual(self.settings.getpriority('TEST_ATTR'), 30) + self.settings.set("TEST_ATTR", myattr, 10) + self.assertEqual(self.settings.get("TEST_ATTR"), 0) + self.assertEqual(self.settings.getpriority("TEST_ATTR"), 30) def test_set_instance_identity_on_update(self): - attr = SettingsAttribute('value', 0) - self.settings.attributes = {'TEST_OPTION': attr} - self.settings.set('TEST_OPTION', 'othervalue', 10) + attr = SettingsAttribute("value", 0) + self.settings.attributes = {"TEST_OPTION": attr} + self.settings.set("TEST_OPTION", "othervalue", 10) - self.assertIn('TEST_OPTION', self.settings.attributes) - self.assertIs(attr, self.settings.attributes['TEST_OPTION']) + self.assertIn("TEST_OPTION", self.settings.attributes) + self.assertIs(attr, self.settings.attributes["TEST_OPTION"]) def test_set_calls_settings_attributes_methods_on_update(self): - attr = SettingsAttribute('value', 10) - with mock.patch.object(attr, '__setattr__') as mock_setattr, mock.patch.object(attr, 'set') as mock_set: + attr = SettingsAttribute("value", 10) + with mock.patch.object(attr, "__setattr__") as mock_setattr, mock.patch.object( + attr, "set" + ) as mock_set: - self.settings.attributes = {'TEST_OPTION': attr} + self.settings.attributes = {"TEST_OPTION": attr} for priority in (0, 10, 20): - self.settings.set('TEST_OPTION', 'othervalue', priority) - mock_set.assert_called_once_with('othervalue', priority) + self.settings.set("TEST_OPTION", "othervalue", priority) + mock_set.assert_called_once_with("othervalue", priority) self.assertFalse(mock_setattr.called) mock_set.reset_mock() mock_setattr.reset_mock() def test_setitem(self): settings = BaseSettings() - settings.set('key', 'a', 'default') - settings['key'] = 'b' - self.assertEqual(settings['key'], 'b') - self.assertEqual(settings.getpriority('key'), 20) - settings['key'] = 'c' - self.assertEqual(settings['key'], 'c') - settings['key2'] = 'x' - self.assertIn('key2', settings) - self.assertEqual(settings['key2'], 'x') - self.assertEqual(settings.getpriority('key2'), 20) + settings.set("key", "a", "default") + settings["key"] = "b" + self.assertEqual(settings["key"], "b") + self.assertEqual(settings.getpriority("key"), 20) + settings["key"] = "c" + self.assertEqual(settings["key"], "c") + settings["key2"] = "x" + self.assertIn("key2", settings) + self.assertEqual(settings["key2"], "x") + self.assertEqual(settings.getpriority("key2"), 20) def test_setdict_alias(self): - with mock.patch.object(self.settings, 'set') as mock_set: - self.settings.setdict({'TEST_1': 'value1', 'TEST_2': 'value2'}, 10) + with mock.patch.object(self.settings, "set") as mock_set: + self.settings.setdict({"TEST_1": "value1", "TEST_2": "value2"}, 10) self.assertEqual(mock_set.call_count, 2) - calls = [mock.call('TEST_1', 'value1', 10), - mock.call('TEST_2', 'value2', 10)] + calls = [ + mock.call("TEST_1", "value1", 10), + mock.call("TEST_2", "value2", 10), + ] mock_set.assert_has_calls(calls, any_order=True) def test_setmodule_only_load_uppercase_vars(self): - class ModuleMock(): - UPPERCASE_VAR = 'value' - MIXEDcase_VAR = 'othervalue' - lowercase_var = 'anothervalue' + class ModuleMock: + UPPERCASE_VAR = "value" + MIXEDcase_VAR = "othervalue" + lowercase_var = "anothervalue" self.settings.attributes = {} self.settings.setmodule(ModuleMock(), 10) - self.assertIn('UPPERCASE_VAR', self.settings.attributes) - self.assertNotIn('MIXEDcase_VAR', self.settings.attributes) - self.assertNotIn('lowercase_var', self.settings.attributes) + self.assertIn("UPPERCASE_VAR", self.settings.attributes) + self.assertNotIn("MIXEDcase_VAR", self.settings.attributes) + self.assertNotIn("lowercase_var", self.settings.attributes) self.assertEqual(len(self.settings.attributes), 1) def test_setmodule_alias(self): - with mock.patch.object(self.settings, 'set') as mock_set: + with mock.patch.object(self.settings, "set") as mock_set: self.settings.setmodule(default_settings, 10) - mock_set.assert_any_call('TEST_DEFAULT', 'defvalue', 10) - mock_set.assert_any_call('TEST_DICT', {'key': 'val'}, 10) + mock_set.assert_any_call("TEST_DEFAULT", "defvalue", 10) + mock_set.assert_any_call("TEST_DICT", {"key": "val"}, 10) def test_setmodule_by_path(self): self.settings.attributes = {} @@ -143,11 +150,9 @@ class BaseSettingsTest(unittest.TestCase): ctrl_attributes = self.settings.attributes.copy() self.settings.attributes = {} - self.settings.setmodule( - 'tests.test_settings.default_settings', 10) + self.settings.setmodule("tests.test_settings.default_settings", 10) - self.assertCountEqual(self.settings.attributes.keys(), - ctrl_attributes.keys()) + self.assertCountEqual(self.settings.attributes.keys(), ctrl_attributes.keys()) for key in ctrl_attributes.keys(): attr = self.settings.attributes[key] @@ -156,181 +161,196 @@ class BaseSettingsTest(unittest.TestCase): self.assertEqual(attr.priority, ctrl_attr.priority) def test_update(self): - settings = BaseSettings({'key_lowprio': 0}, priority=0) - settings.set('key_highprio', 10, priority=50) - custom_settings = BaseSettings({'key_lowprio': 1, 'key_highprio': 11}, - priority=30) - custom_settings.set('newkey_one', None, priority=50) - custom_dict = {'key_lowprio': 2, 'key_highprio': 12, 'newkey_two': None} + settings = BaseSettings({"key_lowprio": 0}, priority=0) + settings.set("key_highprio", 10, priority=50) + custom_settings = BaseSettings( + {"key_lowprio": 1, "key_highprio": 11}, priority=30 + ) + custom_settings.set("newkey_one", None, priority=50) + custom_dict = {"key_lowprio": 2, "key_highprio": 12, "newkey_two": None} settings.update(custom_dict, priority=20) - self.assertEqual(settings['key_lowprio'], 2) - self.assertEqual(settings.getpriority('key_lowprio'), 20) - self.assertEqual(settings['key_highprio'], 10) - self.assertIn('newkey_two', settings) - self.assertEqual(settings.getpriority('newkey_two'), 20) + self.assertEqual(settings["key_lowprio"], 2) + self.assertEqual(settings.getpriority("key_lowprio"), 20) + self.assertEqual(settings["key_highprio"], 10) + self.assertIn("newkey_two", settings) + self.assertEqual(settings.getpriority("newkey_two"), 20) settings.update(custom_settings) - self.assertEqual(settings['key_lowprio'], 1) - self.assertEqual(settings.getpriority('key_lowprio'), 30) - self.assertEqual(settings['key_highprio'], 10) - self.assertIn('newkey_one', settings) - self.assertEqual(settings.getpriority('newkey_one'), 50) + self.assertEqual(settings["key_lowprio"], 1) + self.assertEqual(settings.getpriority("key_lowprio"), 30) + self.assertEqual(settings["key_highprio"], 10) + self.assertIn("newkey_one", settings) + self.assertEqual(settings.getpriority("newkey_one"), 50) - settings.update({'key_lowprio': 3}, priority=20) - self.assertEqual(settings['key_lowprio'], 1) + settings.update({"key_lowprio": 3}, priority=20) + self.assertEqual(settings["key_lowprio"], 1) def test_update_jsonstring(self): - settings = BaseSettings({'number': 0, 'dict': BaseSettings({'key': 'val'})}) + settings = BaseSettings({"number": 0, "dict": BaseSettings({"key": "val"})}) settings.update('{"number": 1, "newnumber": 2}') - self.assertEqual(settings['number'], 1) - self.assertEqual(settings['newnumber'], 2) + self.assertEqual(settings["number"], 1) + self.assertEqual(settings["newnumber"], 2) settings.set("dict", '{"key": "newval", "newkey": "newval2"}') - self.assertEqual(settings['dict']['key'], "newval") - self.assertEqual(settings['dict']['newkey'], "newval2") + self.assertEqual(settings["dict"]["key"], "newval") + self.assertEqual(settings["dict"]["newkey"], "newval2") def test_delete(self): - settings = BaseSettings({'key': None}) - settings.set('key_highprio', None, priority=50) - settings.delete('key') - settings.delete('key_highprio') - self.assertNotIn('key', settings) - self.assertIn('key_highprio', settings) - del settings['key_highprio'] - self.assertNotIn('key_highprio', settings) + settings = BaseSettings({"key": None}) + settings.set("key_highprio", None, priority=50) + settings.delete("key") + settings.delete("key_highprio") + self.assertNotIn("key", settings) + self.assertIn("key_highprio", settings) + del settings["key_highprio"] + self.assertNotIn("key_highprio", settings) def test_get(self): test_configuration = { - 'TEST_ENABLED1': '1', - 'TEST_ENABLED2': True, - 'TEST_ENABLED3': 1, - 'TEST_ENABLED4': 'True', - 'TEST_ENABLED5': 'true', - 'TEST_ENABLED_WRONG': 'on', - 'TEST_DISABLED1': '0', - 'TEST_DISABLED2': False, - 'TEST_DISABLED3': 0, - 'TEST_DISABLED4': 'False', - 'TEST_DISABLED5': 'false', - 'TEST_DISABLED_WRONG': 'off', - 'TEST_INT1': 123, - 'TEST_INT2': '123', - 'TEST_FLOAT1': 123.45, - 'TEST_FLOAT2': '123.45', - 'TEST_LIST1': ['one', 'two'], - 'TEST_LIST2': 'one,two', - 'TEST_STR': 'value', - 'TEST_DICT1': {'key1': 'val1', 'ke2': 3}, - 'TEST_DICT2': '{"key1": "val1", "ke2": 3}', + "TEST_ENABLED1": "1", + "TEST_ENABLED2": True, + "TEST_ENABLED3": 1, + "TEST_ENABLED4": "True", + "TEST_ENABLED5": "true", + "TEST_ENABLED_WRONG": "on", + "TEST_DISABLED1": "0", + "TEST_DISABLED2": False, + "TEST_DISABLED3": 0, + "TEST_DISABLED4": "False", + "TEST_DISABLED5": "false", + "TEST_DISABLED_WRONG": "off", + "TEST_INT1": 123, + "TEST_INT2": "123", + "TEST_FLOAT1": 123.45, + "TEST_FLOAT2": "123.45", + "TEST_LIST1": ["one", "two"], + "TEST_LIST2": "one,two", + "TEST_STR": "value", + "TEST_DICT1": {"key1": "val1", "ke2": 3}, + "TEST_DICT2": '{"key1": "val1", "ke2": 3}', } settings = self.settings - settings.attributes = {key: SettingsAttribute(value, 0) for key, value - in test_configuration.items()} + settings.attributes = { + key: SettingsAttribute(value, 0) + for key, value in test_configuration.items() + } - self.assertTrue(settings.getbool('TEST_ENABLED1')) - self.assertTrue(settings.getbool('TEST_ENABLED2')) - self.assertTrue(settings.getbool('TEST_ENABLED3')) - self.assertTrue(settings.getbool('TEST_ENABLED4')) - self.assertTrue(settings.getbool('TEST_ENABLED5')) - self.assertFalse(settings.getbool('TEST_ENABLEDx')) - self.assertTrue(settings.getbool('TEST_ENABLEDx', True)) - self.assertFalse(settings.getbool('TEST_DISABLED1')) - self.assertFalse(settings.getbool('TEST_DISABLED2')) - self.assertFalse(settings.getbool('TEST_DISABLED3')) - self.assertFalse(settings.getbool('TEST_DISABLED4')) - self.assertFalse(settings.getbool('TEST_DISABLED5')) - self.assertEqual(settings.getint('TEST_INT1'), 123) - self.assertEqual(settings.getint('TEST_INT2'), 123) - self.assertEqual(settings.getint('TEST_INTx'), 0) - self.assertEqual(settings.getint('TEST_INTx', 45), 45) - self.assertEqual(settings.getfloat('TEST_FLOAT1'), 123.45) - self.assertEqual(settings.getfloat('TEST_FLOAT2'), 123.45) - self.assertEqual(settings.getfloat('TEST_FLOATx'), 0.0) - self.assertEqual(settings.getfloat('TEST_FLOATx', 55.0), 55.0) - self.assertEqual(settings.getlist('TEST_LIST1'), ['one', 'two']) - self.assertEqual(settings.getlist('TEST_LIST2'), ['one', 'two']) - self.assertEqual(settings.getlist('TEST_LISTx'), []) - self.assertEqual(settings.getlist('TEST_LISTx', ['default']), ['default']) - self.assertEqual(settings['TEST_STR'], 'value') - self.assertEqual(settings.get('TEST_STR'), 'value') - self.assertEqual(settings['TEST_STRx'], None) - self.assertEqual(settings.get('TEST_STRx'), None) - self.assertEqual(settings.get('TEST_STRx', 'default'), 'default') - self.assertEqual(settings.getdict('TEST_DICT1'), {'key1': 'val1', 'ke2': 3}) - self.assertEqual(settings.getdict('TEST_DICT2'), {'key1': 'val1', 'ke2': 3}) - self.assertEqual(settings.getdict('TEST_DICT3'), {}) - self.assertEqual(settings.getdict('TEST_DICT3', {'key1': 5}), {'key1': 5}) - self.assertRaises(ValueError, settings.getdict, 'TEST_LIST1') - self.assertRaises(ValueError, settings.getbool, 'TEST_ENABLED_WRONG') - self.assertRaises(ValueError, settings.getbool, 'TEST_DISABLED_WRONG') + self.assertTrue(settings.getbool("TEST_ENABLED1")) + self.assertTrue(settings.getbool("TEST_ENABLED2")) + self.assertTrue(settings.getbool("TEST_ENABLED3")) + self.assertTrue(settings.getbool("TEST_ENABLED4")) + self.assertTrue(settings.getbool("TEST_ENABLED5")) + self.assertFalse(settings.getbool("TEST_ENABLEDx")) + self.assertTrue(settings.getbool("TEST_ENABLEDx", True)) + self.assertFalse(settings.getbool("TEST_DISABLED1")) + self.assertFalse(settings.getbool("TEST_DISABLED2")) + self.assertFalse(settings.getbool("TEST_DISABLED3")) + self.assertFalse(settings.getbool("TEST_DISABLED4")) + self.assertFalse(settings.getbool("TEST_DISABLED5")) + self.assertEqual(settings.getint("TEST_INT1"), 123) + self.assertEqual(settings.getint("TEST_INT2"), 123) + self.assertEqual(settings.getint("TEST_INTx"), 0) + self.assertEqual(settings.getint("TEST_INTx", 45), 45) + self.assertEqual(settings.getfloat("TEST_FLOAT1"), 123.45) + self.assertEqual(settings.getfloat("TEST_FLOAT2"), 123.45) + self.assertEqual(settings.getfloat("TEST_FLOATx"), 0.0) + self.assertEqual(settings.getfloat("TEST_FLOATx", 55.0), 55.0) + self.assertEqual(settings.getlist("TEST_LIST1"), ["one", "two"]) + self.assertEqual(settings.getlist("TEST_LIST2"), ["one", "two"]) + self.assertEqual(settings.getlist("TEST_LISTx"), []) + self.assertEqual(settings.getlist("TEST_LISTx", ["default"]), ["default"]) + self.assertEqual(settings["TEST_STR"], "value") + self.assertEqual(settings.get("TEST_STR"), "value") + self.assertEqual(settings["TEST_STRx"], None) + self.assertEqual(settings.get("TEST_STRx"), None) + self.assertEqual(settings.get("TEST_STRx", "default"), "default") + self.assertEqual(settings.getdict("TEST_DICT1"), {"key1": "val1", "ke2": 3}) + self.assertEqual(settings.getdict("TEST_DICT2"), {"key1": "val1", "ke2": 3}) + self.assertEqual(settings.getdict("TEST_DICT3"), {}) + self.assertEqual(settings.getdict("TEST_DICT3", {"key1": 5}), {"key1": 5}) + self.assertRaises(ValueError, settings.getdict, "TEST_LIST1") + self.assertRaises(ValueError, settings.getbool, "TEST_ENABLED_WRONG") + self.assertRaises(ValueError, settings.getbool, "TEST_DISABLED_WRONG") def test_getpriority(self): - settings = BaseSettings({'key': 'value'}, priority=99) - self.assertEqual(settings.getpriority('key'), 99) - self.assertEqual(settings.getpriority('nonexistentkey'), None) + settings = BaseSettings({"key": "value"}, priority=99) + self.assertEqual(settings.getpriority("key"), 99) + self.assertEqual(settings.getpriority("nonexistentkey"), None) def test_getwithbase(self): - s = BaseSettings({'TEST_BASE': BaseSettings({1: 1, 2: 2}, 'project'), - 'TEST': BaseSettings({1: 10, 3: 30}, 'default'), - 'HASNOBASE': BaseSettings({3: 3000}, 'default')}) - s['TEST'].set(2, 200, 'cmdline') - self.assertCountEqual(s.getwithbase('TEST'), {1: 1, 2: 200, 3: 30}) - self.assertCountEqual(s.getwithbase('HASNOBASE'), s['HASNOBASE']) - self.assertEqual(s.getwithbase('NONEXISTENT'), {}) + s = BaseSettings( + { + "TEST_BASE": BaseSettings({1: 1, 2: 2}, "project"), + "TEST": BaseSettings({1: 10, 3: 30}, "default"), + "HASNOBASE": BaseSettings({3: 3000}, "default"), + } + ) + s["TEST"].set(2, 200, "cmdline") + self.assertCountEqual(s.getwithbase("TEST"), {1: 1, 2: 200, 3: 30}) + self.assertCountEqual(s.getwithbase("HASNOBASE"), s["HASNOBASE"]) + self.assertEqual(s.getwithbase("NONEXISTENT"), {}) def test_maxpriority(self): # Empty settings should return 'default' self.assertEqual(self.settings.maxpriority(), 0) - self.settings.set('A', 0, 10) - self.settings.set('B', 0, 30) + self.settings.set("A", 0, 10) + self.settings.set("B", 0, 30) self.assertEqual(self.settings.maxpriority(), 30) def test_copy(self): values = { - 'TEST_BOOL': True, - 'TEST_LIST': ['one', 'two'], - 'TEST_LIST_OF_LISTS': [['first_one', 'first_two'], - ['second_one', 'second_two']] + "TEST_BOOL": True, + "TEST_LIST": ["one", "two"], + "TEST_LIST_OF_LISTS": [ + ["first_one", "first_two"], + ["second_one", "second_two"], + ], } self.settings.setdict(values) copy = self.settings.copy() - self.settings.set('TEST_BOOL', False) - self.assertTrue(copy.get('TEST_BOOL')) + self.settings.set("TEST_BOOL", False) + self.assertTrue(copy.get("TEST_BOOL")) - test_list = self.settings.get('TEST_LIST') - test_list.append('three') - self.assertListEqual(copy.get('TEST_LIST'), ['one', 'two']) + test_list = self.settings.get("TEST_LIST") + test_list.append("three") + self.assertListEqual(copy.get("TEST_LIST"), ["one", "two"]) - test_list_of_lists = self.settings.get('TEST_LIST_OF_LISTS') - test_list_of_lists[0].append('first_three') - self.assertListEqual(copy.get('TEST_LIST_OF_LISTS')[0], - ['first_one', 'first_two']) + test_list_of_lists = self.settings.get("TEST_LIST_OF_LISTS") + test_list_of_lists[0].append("first_three") + self.assertListEqual( + copy.get("TEST_LIST_OF_LISTS")[0], ["first_one", "first_two"] + ) def test_copy_to_dict(self): - s = BaseSettings({'TEST_STRING': 'a string', - 'TEST_LIST': [1, 2], - 'TEST_BOOLEAN': False, - 'TEST_BASE': BaseSettings({1: 1, 2: 2}, 'project'), - 'TEST': BaseSettings({1: 10, 3: 30}, 'default'), - 'HASNOBASE': BaseSettings({3: 3000}, 'default')}) + s = BaseSettings( + { + "TEST_STRING": "a string", + "TEST_LIST": [1, 2], + "TEST_BOOLEAN": False, + "TEST_BASE": BaseSettings({1: 1, 2: 2}, "project"), + "TEST": BaseSettings({1: 10, 3: 30}, "default"), + "HASNOBASE": BaseSettings({3: 3000}, "default"), + } + ) self.assertDictEqual( s.copy_to_dict(), { - 'HASNOBASE': {3: 3000}, - 'TEST': {1: 10, 3: 30}, - 'TEST_BASE': {1: 1, 2: 2}, - 'TEST_LIST': [1, 2], - 'TEST_BOOLEAN': False, - 'TEST_STRING': 'a string', - } + "HASNOBASE": {3: 3000}, + "TEST": {1: 10, 3: 30}, + "TEST_BASE": {1: 1, 2: 2}, + "TEST_LIST": [1, 2], + "TEST_BOOLEAN": False, + "TEST_STRING": "a string", + }, ) def test_freeze(self): self.settings.freeze() with self.assertRaises(TypeError) as cm: - self.settings.set('TEST_BOOL', False) - self.assertEqual(str(cm.exception), - "Trying to modify an immutable Settings object") + self.settings.set("TEST_BOOL", False) + self.assertEqual( + str(cm.exception), "Trying to modify an immutable Settings object" + ) def test_frozencopy(self): frozencopy = self.settings.frozencopy() @@ -339,83 +359,84 @@ class BaseSettingsTest(unittest.TestCase): class SettingsTest(unittest.TestCase): - def setUp(self): self.settings = Settings() - @mock.patch.dict('scrapy.settings.SETTINGS_PRIORITIES', {'default': 10}) - @mock.patch('scrapy.settings.default_settings', default_settings) + @mock.patch.dict("scrapy.settings.SETTINGS_PRIORITIES", {"default": 10}) + @mock.patch("scrapy.settings.default_settings", default_settings) def test_initial_defaults(self): settings = Settings() self.assertEqual(len(settings.attributes), 2) - self.assertIn('TEST_DEFAULT', settings.attributes) + self.assertIn("TEST_DEFAULT", settings.attributes) - attr = settings.attributes['TEST_DEFAULT'] + attr = settings.attributes["TEST_DEFAULT"] self.assertIsInstance(attr, SettingsAttribute) - self.assertEqual(attr.value, 'defvalue') + self.assertEqual(attr.value, "defvalue") self.assertEqual(attr.priority, 10) - @mock.patch.dict('scrapy.settings.SETTINGS_PRIORITIES', {}) - @mock.patch('scrapy.settings.default_settings', {}) + @mock.patch.dict("scrapy.settings.SETTINGS_PRIORITIES", {}) + @mock.patch("scrapy.settings.default_settings", {}) def test_initial_values(self): - settings = Settings({'TEST_OPTION': 'value'}, 10) + settings = Settings({"TEST_OPTION": "value"}, 10) self.assertEqual(len(settings.attributes), 1) - self.assertIn('TEST_OPTION', settings.attributes) + self.assertIn("TEST_OPTION", settings.attributes) - attr = settings.attributes['TEST_OPTION'] + attr = settings.attributes["TEST_OPTION"] self.assertIsInstance(attr, SettingsAttribute) - self.assertEqual(attr.value, 'value') + self.assertEqual(attr.value, "value") self.assertEqual(attr.priority, 10) - @mock.patch('scrapy.settings.default_settings', default_settings) + @mock.patch("scrapy.settings.default_settings", default_settings) def test_autopromote_dicts(self): settings = Settings() - mydict = settings.get('TEST_DICT') + mydict = settings.get("TEST_DICT") self.assertIsInstance(mydict, BaseSettings) - self.assertIn('key', mydict) - self.assertEqual(mydict['key'], 'val') - self.assertEqual(mydict.getpriority('key'), 0) + self.assertIn("key", mydict) + self.assertEqual(mydict["key"], "val") + self.assertEqual(mydict.getpriority("key"), 0) - @mock.patch('scrapy.settings.default_settings', default_settings) + @mock.patch("scrapy.settings.default_settings", default_settings) def test_getdict_autodegrade_basesettings(self): settings = Settings() - mydict = settings.getdict('TEST_DICT') + mydict = settings.getdict("TEST_DICT") self.assertIsInstance(mydict, dict) self.assertEqual(len(mydict), 1) - self.assertIn('key', mydict) - self.assertEqual(mydict['key'], 'val') + self.assertIn("key", mydict) + self.assertEqual(mydict["key"], "val") def test_passing_objects_as_values(self): from scrapy.core.downloader.handlers.file import FileDownloadHandler from scrapy.utils.misc import create_instance from scrapy.utils.test import get_crawler - class TestPipeline(): + class TestPipeline: def process_item(self, i, s): return i - settings = Settings({ - 'ITEM_PIPELINES': { - TestPipeline: 800, - }, - 'DOWNLOAD_HANDLERS': { - 'ftp': FileDownloadHandler, - }, - }) + settings = Settings( + { + "ITEM_PIPELINES": { + TestPipeline: 800, + }, + "DOWNLOAD_HANDLERS": { + "ftp": FileDownloadHandler, + }, + } + ) - self.assertIn('ITEM_PIPELINES', settings.attributes) + self.assertIn("ITEM_PIPELINES", settings.attributes) - mypipeline, priority = settings.getdict('ITEM_PIPELINES').popitem() + mypipeline, priority = settings.getdict("ITEM_PIPELINES").popitem() self.assertEqual(priority, 800) self.assertEqual(mypipeline, TestPipeline) self.assertIsInstance(mypipeline(), TestPipeline) - self.assertEqual(mypipeline().process_item('item', None), 'item') + self.assertEqual(mypipeline().process_item("item", None), "item") - myhandler = settings.getdict('DOWNLOAD_HANDLERS').pop('ftp') + myhandler = settings.getdict("DOWNLOAD_HANDLERS").pop("ftp") self.assertEqual(myhandler, FileDownloadHandler) myhandler_instance = create_instance(myhandler, None, get_crawler()) self.assertIsInstance(myhandler_instance, FileDownloadHandler) - self.assertTrue(hasattr(myhandler_instance, 'download_request')) + self.assertTrue(hasattr(myhandler_instance, "download_request")) if __name__ == "__main__": diff --git a/tests/test_settings/default_settings.py b/tests/test_settings/default_settings.py index 26a555275..2a2142b32 100644 --- a/tests/test_settings/default_settings.py +++ b/tests/test_settings/default_settings.py @@ -1,4 +1,3 @@ +TEST_DEFAULT = "defvalue" -TEST_DEFAULT = 'defvalue' - -TEST_DICT = {'key': 'val'} +TEST_DICT = {"key": "val"} diff --git a/tests/test_signals.py b/tests/test_signals.py index a43f00b27..4c6ffabdc 100644 --- a/tests/test_signals.py +++ b/tests/test_signals.py @@ -9,15 +9,16 @@ from tests.mockserver import MockServer class ItemSpider(Spider): - name = 'itemspider' + name = "itemspider" def start_requests(self): for index in range(10): - yield Request(self.mockserver.url(f'/status?n=200&id={index}'), - meta={'index': index}) + yield Request( + self.mockserver.url(f"/status?n=200&id={index}"), meta={"index": index} + ) def parse(self, response): - return {'index': response.meta['index']} + return {"index": response.meta["index"]} class AsyncSignalTestCase(unittest.TestCase): @@ -41,4 +42,4 @@ class AsyncSignalTestCase(unittest.TestCase): yield crawler.crawl(mockserver=self.mockserver) self.assertEqual(len(self.items), 10) for index in range(10): - self.assertIn({'index': index}, self.items) + self.assertIn({"index": index}, self.items) diff --git a/tests/test_spider.py b/tests/test_spider.py index cb66066b0..540091516 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -37,39 +37,39 @@ class SpiderTest(unittest.TestCase): def test_base_spider(self): spider = self.spider_class("example.com") - self.assertEqual(spider.name, 'example.com') + self.assertEqual(spider.name, "example.com") self.assertEqual(spider.start_urls, []) def test_start_requests(self): - spider = self.spider_class('example.com') + spider = self.spider_class("example.com") start_requests = spider.start_requests() self.assertTrue(inspect.isgenerator(start_requests)) self.assertEqual(list(start_requests), []) def test_spider_args(self): """``__init__`` method arguments are assigned to spider attributes""" - spider = self.spider_class('example.com', foo='bar') - self.assertEqual(spider.foo, 'bar') + spider = self.spider_class("example.com", foo="bar") + self.assertEqual(spider.foo, "bar") def test_spider_without_name(self): """``__init__`` method arguments are assigned to spider attributes""" self.assertRaises(ValueError, self.spider_class) - self.assertRaises(ValueError, self.spider_class, somearg='foo') + self.assertRaises(ValueError, self.spider_class, somearg="foo") def test_from_crawler_crawler_and_settings_population(self): crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, 'example.com') - self.assertTrue(hasattr(spider, 'crawler')) + spider = self.spider_class.from_crawler(crawler, "example.com") + self.assertTrue(hasattr(spider, "crawler")) self.assertIs(spider.crawler, crawler) - self.assertTrue(hasattr(spider, 'settings')) + self.assertTrue(hasattr(spider, "settings")) self.assertIs(spider.settings, crawler.settings) def test_from_crawler_init_call(self): - with mock.patch.object(self.spider_class, '__init__', - return_value=None) as mock_init: - self.spider_class.from_crawler(get_crawler(), 'example.com', - foo='bar') - mock_init.assert_called_once_with('example.com', foo='bar') + with mock.patch.object( + self.spider_class, "__init__", return_value=None + ) as mock_init: + self.spider_class.from_crawler(get_crawler(), "example.com", foo="bar") + mock_init.assert_called_once_with("example.com", foo="bar") def test_closed_signal_call(self): class TestSpider(self.spider_class): @@ -79,39 +79,39 @@ class SpiderTest(unittest.TestCase): self.closed_called = True crawler = get_crawler() - spider = TestSpider.from_crawler(crawler, 'example.com') - crawler.signals.send_catch_log(signal=signals.spider_opened, - spider=spider) - crawler.signals.send_catch_log(signal=signals.spider_closed, - spider=spider, reason=None) + spider = TestSpider.from_crawler(crawler, "example.com") + crawler.signals.send_catch_log(signal=signals.spider_opened, spider=spider) + crawler.signals.send_catch_log( + signal=signals.spider_closed, spider=spider, reason=None + ) self.assertTrue(spider.closed_called) def test_update_settings(self): - spider_settings = {'TEST1': 'spider', 'TEST2': 'spider'} - project_settings = {'TEST1': 'project', 'TEST3': 'project'} + spider_settings = {"TEST1": "spider", "TEST2": "spider"} + project_settings = {"TEST1": "project", "TEST3": "project"} self.spider_class.custom_settings = spider_settings - settings = Settings(project_settings, priority='project') + settings = Settings(project_settings, priority="project") self.spider_class.update_settings(settings) - self.assertEqual(settings.get('TEST1'), 'spider') - self.assertEqual(settings.get('TEST2'), 'spider') - self.assertEqual(settings.get('TEST3'), 'project') + self.assertEqual(settings.get("TEST1"), "spider") + self.assertEqual(settings.get("TEST2"), "spider") + self.assertEqual(settings.get("TEST3"), "project") def test_logger(self): - spider = self.spider_class('example.com') + spider = self.spider_class("example.com") with LogCapture() as lc: - spider.logger.info('test log msg') - lc.check(('example.com', 'INFO', 'test log msg')) + spider.logger.info("test log msg") + lc.check(("example.com", "INFO", "test log msg")) record = lc.records[0] - self.assertIn('spider', record.__dict__) + self.assertIn("spider", record.__dict__) self.assertIs(record.spider, spider) def test_log(self): - spider = self.spider_class('example.com') - with mock.patch('scrapy.spiders.Spider.logger') as mock_logger: - spider.log('test log msg', 'INFO') - mock_logger.log.assert_called_once_with('INFO', 'test log msg') + spider = self.spider_class("example.com") + with mock.patch("scrapy.spiders.Spider.logger") as mock_logger: + spider.log("test log msg", "INFO") + mock_logger.log.assert_called_once_with("INFO", "test log msg") class InitSpiderTest(SpiderTest): @@ -132,37 +132,45 @@ class XMLFeedSpiderTest(SpiderTest): http://www.example.com/2009-08-16 """ - response = XmlResponse(url='http://example.com/sitemap.xml', body=body) + response = XmlResponse(url="http://example.com/sitemap.xml", body=body) class _XMLSpider(self.spider_class): - itertag = 'url' + itertag = "url" namespaces = ( - ('a', 'http://www.google.com/schemas/sitemap/0.84'), - ('b', 'http://www.example.com/schemas/extras/1.0'), + ("a", "http://www.google.com/schemas/sitemap/0.84"), + ("b", "http://www.example.com/schemas/extras/1.0"), ) def parse_node(self, response, selector): yield { - 'loc': selector.xpath('a:loc/text()').getall(), - 'updated': selector.xpath('b:updated/text()').getall(), - 'other': selector.xpath('other/@value').getall(), - 'custom': selector.xpath('other/@b:custom').getall(), + "loc": selector.xpath("a:loc/text()").getall(), + "updated": selector.xpath("b:updated/text()").getall(), + "other": selector.xpath("other/@value").getall(), + "custom": selector.xpath("other/@b:custom").getall(), } - for iterator in ('iternodes', 'xml'): - spider = _XMLSpider('example', iterator=iterator) + for iterator in ("iternodes", "xml"): + spider = _XMLSpider("example", iterator=iterator) output = list(spider._parse(response)) self.assertEqual(len(output), 2, iterator) - self.assertEqual(output, [ - {'loc': ['http://www.example.com/Special-Offers.html'], - 'updated': ['2009-08-16'], - 'custom': ['fuu'], - 'other': ['bar']}, - {'loc': [], - 'updated': ['2009-08-16'], - 'other': ['foo'], - 'custom': []}, - ], iterator) + self.assertEqual( + output, + [ + { + "loc": ["http://www.example.com/Special-Offers.html"], + "updated": ["2009-08-16"], + "custom": ["fuu"], + "other": ["bar"], + }, + { + "loc": [], + "updated": ["2009-08-16"], + "other": ["foo"], + "custom": [], + }, + ], + iterator, + ) class CSVFeedSpiderTest(SpiderTest): @@ -170,7 +178,7 @@ class CSVFeedSpiderTest(SpiderTest): spider_class = CSVFeedSpider def test_parse_rows(self): - body = get_testdata('feeds', 'feed-sample6.csv') + body = get_testdata("feeds", "feed-sample6.csv") response = Response("http://example.org/dummy.csv", body=body) class _CrawlSpider(self.spider_class): @@ -183,7 +191,7 @@ class CSVFeedSpiderTest(SpiderTest): spider = _CrawlSpider() rows = list(spider.parse_rows(response)) - assert rows[0] == {'id': '1', 'name': 'alpha', 'value': 'foobar'} + assert rows[0] == {"id": "1", "name": "alpha", "value": "foobar"} assert len(rows) == 4 @@ -203,34 +211,38 @@ class CrawlSpiderTest(SpiderTest): def test_rule_without_link_extractor(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] - rules = ( - Rule(), - ) + allowed_domains = ["example.org"] + rules = (Rule(),) spider = _CrawlSpider() output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html', - 'http://example.org/nofollow.html']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ], + ) def test_process_links(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] - rules = ( - Rule(LinkExtractor(), process_links="dummy_process_links"), - ) + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) def dummy_process_links(self, links): return links @@ -239,47 +251,54 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html', - 'http://example.org/nofollow.html']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ], + ) def test_process_links_filter(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): import re name = "test" - allowed_domains = ['example.org'] - rules = ( - Rule(LinkExtractor(), process_links="filter_process_links"), - ) - _test_regex = re.compile('nofollow') + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="filter_process_links"),) + _test_regex = re.compile("nofollow") def filter_process_links(self, links): - return [link for link in links - if not self._test_regex.search(link.url)] + return [link for link in links if not self._test_regex.search(link.url)] spider = _CrawlSpider() output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 2) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + ], + ) def test_process_links_generator(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] - rules = ( - Rule(LinkExtractor(), process_links="dummy_process_links"), - ) + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_links="dummy_process_links"),) def dummy_process_links(self, links): for link in links: @@ -289,21 +308,27 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html', - 'http://example.org/nofollow.html']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ], + ) def test_process_request(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) def process_request_change_domain(request, response): - return request.replace(url=request.url.replace('.org', '.com')) + return request.replace(url=request.url.replace(".org", ".com")) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] + allowed_domains = ["example.org"] rules = ( Rule(LinkExtractor(), process_request=process_request_change_domain), ) @@ -312,47 +337,61 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.com/somepage/item/12.html', - 'http://example.com/about.html', - 'http://example.com/nofollow.html']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.com/somepage/item/12.html", + "http://example.com/about.html", + "http://example.com/nofollow.html", + ], + ) def test_process_request_with_response(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) def process_request_meta_response_class(request, response): - request.meta['response_class'] = response.__class__.__name__ + request.meta["response_class"] = response.__class__.__name__ return request class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] + allowed_domains = ["example.org"] rules = ( - Rule(LinkExtractor(), process_request=process_request_meta_response_class), + Rule( + LinkExtractor(), process_request=process_request_meta_response_class + ), ) spider = _CrawlSpider() output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html', - 'http://example.org/nofollow.html']) - self.assertEqual([r.meta['response_class'] for r in output], - ['HtmlResponse', 'HtmlResponse', 'HtmlResponse']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ], + ) + self.assertEqual( + [r.meta["response_class"] for r in output], + ["HtmlResponse", "HtmlResponse", "HtmlResponse"], + ) def test_process_request_instance_method(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] - rules = ( - Rule(LinkExtractor(), process_request='process_request_upper'), - ) + allowed_domains = ["example.org"] + rules = (Rule(LinkExtractor(), process_request="process_request_upper"),) def process_request_upper(self, request, response): return request.replace(url=request.url.upper()) @@ -361,55 +400,69 @@ class CrawlSpiderTest(SpiderTest): output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - [safe_url_string('http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML'), - safe_url_string('http://EXAMPLE.ORG/ABOUT.HTML'), - safe_url_string('http://EXAMPLE.ORG/NOFOLLOW.HTML')]) + self.assertEqual( + [r.url for r in output], + [ + safe_url_string("http://EXAMPLE.ORG/SOMEPAGE/ITEM/12.HTML"), + safe_url_string("http://EXAMPLE.ORG/ABOUT.HTML"), + safe_url_string("http://EXAMPLE.ORG/NOFOLLOW.HTML"), + ], + ) def test_process_request_instance_method_with_response(self): - response = HtmlResponse("http://example.org/somepage/index.html", body=self.test_body) + response = HtmlResponse( + "http://example.org/somepage/index.html", body=self.test_body + ) class _CrawlSpider(self.spider_class): name = "test" - allowed_domains = ['example.org'] + allowed_domains = ["example.org"] rules = ( - Rule(LinkExtractor(), process_request='process_request_meta_response_class'), + Rule( + LinkExtractor(), + process_request="process_request_meta_response_class", + ), ) def process_request_meta_response_class(self, request, response): - request.meta['response_class'] = response.__class__.__name__ + request.meta["response_class"] = response.__class__.__name__ return request spider = _CrawlSpider() output = list(spider._requests_to_follow(response)) self.assertEqual(len(output), 3) self.assertTrue(all(map(lambda r: isinstance(r, Request), output))) - self.assertEqual([r.url for r in output], - ['http://example.org/somepage/item/12.html', - 'http://example.org/about.html', - 'http://example.org/nofollow.html']) - self.assertEqual([r.meta['response_class'] for r in output], - ['HtmlResponse', 'HtmlResponse', 'HtmlResponse']) + self.assertEqual( + [r.url for r in output], + [ + "http://example.org/somepage/item/12.html", + "http://example.org/about.html", + "http://example.org/nofollow.html", + ], + ) + self.assertEqual( + [r.meta["response_class"] for r in output], + ["HtmlResponse", "HtmlResponse", "HtmlResponse"], + ) def test_follow_links_attribute_population(self): crawler = get_crawler() - spider = self.spider_class.from_crawler(crawler, 'example.com') - self.assertTrue(hasattr(spider, '_follow_links')) + spider = self.spider_class.from_crawler(crawler, "example.com") + self.assertTrue(hasattr(spider, "_follow_links")) self.assertTrue(spider._follow_links) - settings_dict = {'CRAWLSPIDER_FOLLOW_LINKS': False} + settings_dict = {"CRAWLSPIDER_FOLLOW_LINKS": False} crawler = get_crawler(settings_dict=settings_dict) - spider = self.spider_class.from_crawler(crawler, 'example.com') - self.assertTrue(hasattr(spider, '_follow_links')) + spider = self.spider_class.from_crawler(crawler, "example.com") + self.assertTrue(hasattr(spider, "_follow_links")) self.assertFalse(spider._follow_links) def test_start_url(self): spider = self.spider_class("example.com") - spider.start_url = 'https://www.example.com' + spider.start_url = "https://www.example.com" - with self.assertRaisesRegex(AttributeError, - r'^Crawling could not start.*$'): + with self.assertRaisesRegex(AttributeError, r"^Crawling could not start.*$"): list(spider.start_requests()) @@ -419,7 +472,7 @@ class SitemapSpiderTest(SpiderTest): BODY = b"SITEMAP" f = BytesIO() - g = gzip.GzipFile(fileobj=f, mode='w+b') + g = gzip.GzipFile(fileobj=f, mode="w+b") g.write(BODY) g.close() GZBODY = f.getvalue() @@ -439,8 +492,11 @@ class SitemapSpiderTest(SpiderTest): self.assertSitemapBody(r, None) def test_get_sitemap_body_gzip_headers(self): - r = Response(url="http://www.example.com/sitemap", body=self.GZBODY, - headers={"content-type": "application/gzip"}) + r = Response( + url="http://www.example.com/sitemap", + body=self.GZBODY, + headers={"content-type": "application/gzip"}, + ) self.assertSitemapBody(r, self.BODY) def test_get_sitemap_body_xml_url(self): @@ -465,11 +521,15 @@ Sitemap: /sitemap-relative-url.xml r = TextResponse(url="http://www.example.com/robots.txt", body=robots) spider = self.spider_class("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://example.com/sitemap.xml', - 'http://example.com/sitemap-product-index.xml', - 'http://example.com/sitemap-uppercase.xml', - 'http://www.example.com/sitemap-relative-url.xml']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + [ + "http://example.com/sitemap.xml", + "http://example.com/sitemap-product-index.xml", + "http://example.com/sitemap-uppercase.xml", + "http://www.example.com/sitemap-relative-url.xml", + ], + ) def test_alternate_url_locs(self): sitemap = b""" @@ -488,15 +548,21 @@ Sitemap: /sitemap-relative-url.xml """ r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) spider = self.spider_class("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/english/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + ["http://www.example.com/english/"], + ) spider.sitemap_alternate_links = True - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/english/', - 'http://www.example.com/deutsch/', - 'http://www.example.com/schweiz-deutsch/', - 'http://www.example.com/italiano/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + [ + "http://www.example.com/english/", + "http://www.example.com/deutsch/", + "http://www.example.com/schweiz-deutsch/", + "http://www.example.com/italiano/", + ], + ) def test_sitemap_filter(self): sitemap = b""" @@ -515,20 +581,24 @@ Sitemap: /sitemap-relative-url.xml class FilteredSitemapSpider(self.spider_class): def sitemap_filter(self, entries): from datetime import datetime + for entry in entries: - date_time = datetime.strptime(entry['lastmod'], '%Y-%m-%d') + date_time = datetime.strptime(entry["lastmod"], "%Y-%m-%d") if date_time.year > 2008: yield entry r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) spider = self.spider_class("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/english/', - 'http://www.example.com/portuguese/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + ["http://www.example.com/english/", "http://www.example.com/portuguese/"], + ) spider = FilteredSitemapSpider("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/english/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + ["http://www.example.com/english/"], + ) def test_sitemap_filter_with_alternate_links(self): sitemap = b""" @@ -549,21 +619,27 @@ Sitemap: /sitemap-relative-url.xml class FilteredSitemapSpider(self.spider_class): def sitemap_filter(self, entries): for entry in entries: - alternate_links = entry.get('alternate', tuple()) + alternate_links = entry.get("alternate", tuple()) for link in alternate_links: - if '/deutsch/' in link: - entry['loc'] = link + if "/deutsch/" in link: + entry["loc"] = link yield entry r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) spider = self.spider_class("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/english/article_1/', - 'http://www.example.com/english/article_2/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + [ + "http://www.example.com/english/article_1/", + "http://www.example.com/english/article_2/", + ], + ) spider = FilteredSitemapSpider("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/deutsch/article_1/']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + ["http://www.example.com/deutsch/article_1/"], + ) def test_sitemapindex_filter(self): sitemap = b""" @@ -581,27 +657,35 @@ Sitemap: /sitemap-relative-url.xml class FilteredSitemapSpider(self.spider_class): def sitemap_filter(self, entries): from datetime import datetime + for entry in entries: - date_time = datetime.strptime(entry['lastmod'].split('T')[0], '%Y-%m-%d') + date_time = datetime.strptime( + entry["lastmod"].split("T")[0], "%Y-%m-%d" + ) if date_time.year > 2004: yield entry r = TextResponse(url="http://www.example.com/sitemap.xml", body=sitemap) spider = self.spider_class("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/sitemap1.xml', - 'http://www.example.com/sitemap2.xml']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + [ + "http://www.example.com/sitemap1.xml", + "http://www.example.com/sitemap2.xml", + ], + ) spider = FilteredSitemapSpider("example.com") - self.assertEqual([req.url for req in spider._parse_sitemap(r)], - ['http://www.example.com/sitemap2.xml']) + self.assertEqual( + [req.url for req in spider._parse_sitemap(r)], + ["http://www.example.com/sitemap2.xml"], + ) class DeprecationTest(unittest.TestCase): - def test_crawl_spider(self): assert issubclass(CrawlSpider, Spider) - assert isinstance(CrawlSpider(name='foo'), Spider) + assert isinstance(CrawlSpider(name="foo"), Spider) class NoParseMethodSpiderTest(unittest.TestCase): @@ -609,10 +693,10 @@ class NoParseMethodSpiderTest(unittest.TestCase): spider_class = Spider def test_undefined_parse_method(self): - spider = self.spider_class('example.com') - text = b'Random text' + spider = self.spider_class("example.com") + text = b"Random text" resp = TextResponse(url="http://www.example.com/random_url", body=text) - exc_msg = 'Spider.parse callback is not defined' + exc_msg = "Spider.parse callback is not defined" with self.assertRaisesRegex(NotImplementedError, exc_msg): spider.parse(resp) diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 0b6b51a5b..3745355a0 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -28,19 +28,18 @@ def _copytree(source: Path, target: Path): class SpiderLoaderTest(unittest.TestCase): - def setUp(self): - orig_spiders_dir = module_dir / 'test_spiders' + orig_spiders_dir = module_dir / "test_spiders" self.tmpdir = Path(tempfile.mkdtemp()) - self.spiders_dir = self.tmpdir / 'test_spiders_xxx' + self.spiders_dir = self.tmpdir / "test_spiders_xxx" _copytree(orig_spiders_dir, self.spiders_dir) sys.path.append(str(self.tmpdir)) - settings = Settings({'SPIDER_MODULES': ['test_spiders_xxx']}) + settings = Settings({"SPIDER_MODULES": ["test_spiders_xxx"]}) self.spider_loader = SpiderLoader.from_settings(settings) def tearDown(self): del self.spider_loader - del sys.modules['test_spiders_xxx'] + del sys.modules["test_spiders_xxx"] sys.path.remove(str(self.tmpdir)) def test_interface(self): @@ -48,78 +47,86 @@ class SpiderLoaderTest(unittest.TestCase): def test_list(self): self.assertEqual( - set(self.spider_loader.list()), - {'spider1', 'spider2', 'spider3', 'spider4'}) + set(self.spider_loader.list()), {"spider1", "spider2", "spider3", "spider4"} + ) def test_load(self): spider1 = self.spider_loader.load("spider1") - self.assertEqual(spider1.__name__, 'Spider1') + self.assertEqual(spider1.__name__, "Spider1") def test_find_by_request(self): self.assertEqual( - self.spider_loader.find_by_request(Request('http://scrapy1.org/test')), - ['spider1']) + self.spider_loader.find_by_request(Request("http://scrapy1.org/test")), + ["spider1"], + ) self.assertEqual( - self.spider_loader.find_by_request(Request('http://scrapy2.org/test')), - ['spider2']) + self.spider_loader.find_by_request(Request("http://scrapy2.org/test")), + ["spider2"], + ) self.assertEqual( - set(self.spider_loader.find_by_request(Request('http://scrapy3.org/test'))), - {'spider1', 'spider2'}) + set(self.spider_loader.find_by_request(Request("http://scrapy3.org/test"))), + {"spider1", "spider2"}, + ) self.assertEqual( - self.spider_loader.find_by_request(Request('http://scrapy999.org/test')), - []) + self.spider_loader.find_by_request(Request("http://scrapy999.org/test")), [] + ) self.assertEqual( - self.spider_loader.find_by_request(Request('http://spider3.com')), - []) + self.spider_loader.find_by_request(Request("http://spider3.com")), [] + ) self.assertEqual( - self.spider_loader.find_by_request(Request('http://spider3.com/onlythis')), - ['spider3']) + self.spider_loader.find_by_request(Request("http://spider3.com/onlythis")), + ["spider3"], + ) def test_load_spider_module(self): - module = 'tests.test_spiderloader.test_spiders.spider1' - settings = Settings({'SPIDER_MODULES': [module]}) + module = "tests.test_spiderloader.test_spiders.spider1" + settings = Settings({"SPIDER_MODULES": [module]}) self.spider_loader = SpiderLoader.from_settings(settings) assert len(self.spider_loader._spiders) == 1 def test_load_spider_module_multiple(self): - prefix = 'tests.test_spiderloader.test_spiders.' - module = ','.join(prefix + s for s in ('spider1', 'spider2')) - settings = Settings({'SPIDER_MODULES': module}) + prefix = "tests.test_spiderloader.test_spiders." + module = ",".join(prefix + s for s in ("spider1", "spider2")) + settings = Settings({"SPIDER_MODULES": module}) self.spider_loader = SpiderLoader.from_settings(settings) assert len(self.spider_loader._spiders) == 2 def test_load_base_spider(self): - module = 'tests.test_spiderloader.test_spiders.spider0' - settings = Settings({'SPIDER_MODULES': [module]}) + module = "tests.test_spiderloader.test_spiders.spider0" + settings = Settings({"SPIDER_MODULES": [module]}) self.spider_loader = SpiderLoader.from_settings(settings) assert len(self.spider_loader._spiders) == 0 def test_crawler_runner_loading(self): - module = 'tests.test_spiderloader.test_spiders.spider1' - runner = CrawlerRunner({ - 'SPIDER_MODULES': [module], - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', - }) + module = "tests.test_spiderloader.test_spiders.spider1" + runner = CrawlerRunner( + { + "SPIDER_MODULES": [module], + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", + } + ) - self.assertRaisesRegex(KeyError, 'Spider not found', - runner.create_crawler, 'spider2') + self.assertRaisesRegex( + KeyError, "Spider not found", runner.create_crawler, "spider2" + ) - crawler = runner.create_crawler('spider1') + crawler = runner.create_crawler("spider1") self.assertTrue(issubclass(crawler.spidercls, scrapy.Spider)) - self.assertEqual(crawler.spidercls.name, 'spider1') + self.assertEqual(crawler.spidercls.name, "spider1") def test_bad_spider_modules_exception(self): - module = 'tests.test_spiderloader.test_spiders.doesnotexist' - settings = Settings({'SPIDER_MODULES': [module]}) + module = "tests.test_spiderloader.test_spiders.doesnotexist" + settings = Settings({"SPIDER_MODULES": [module]}) self.assertRaises(ImportError, SpiderLoader.from_settings, settings) def test_bad_spider_modules_warning(self): with warnings.catch_warnings(record=True) as w: - module = 'tests.test_spiderloader.test_spiders.doesnotexist' - settings = Settings({'SPIDER_MODULES': [module], - 'SPIDER_LOADER_WARN_ONLY': True}) + module = "tests.test_spiderloader.test_spiders.doesnotexist" + settings = Settings( + {"SPIDER_MODULES": [module], "SPIDER_LOADER_WARN_ONLY": True} + ) spider_loader = SpiderLoader.from_settings(settings) if str(w[0].message).startswith("_SixMetaPathImporter"): # needed on 3.10 because of https://github.com/benjaminp/six/issues/349, @@ -133,24 +140,25 @@ class SpiderLoaderTest(unittest.TestCase): class DuplicateSpiderNameLoaderTest(unittest.TestCase): - def setUp(self): - orig_spiders_dir = module_dir / 'test_spiders' + orig_spiders_dir = module_dir / "test_spiders" self.tmpdir = Path(self.mktemp()) self.tmpdir.mkdir() - self.spiders_dir = self.tmpdir / 'test_spiders_xxx' + self.spiders_dir = self.tmpdir / "test_spiders_xxx" _copytree(orig_spiders_dir, self.spiders_dir) sys.path.append(str(self.tmpdir)) - self.settings = Settings({'SPIDER_MODULES': ['test_spiders_xxx']}) + self.settings = Settings({"SPIDER_MODULES": ["test_spiders_xxx"]}) def tearDown(self): - del sys.modules['test_spiders_xxx'] + del sys.modules["test_spiders_xxx"] sys.path.remove(str(self.tmpdir)) def test_dupename_warning(self): # copy 1 spider module so as to have duplicate spider name - shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider3.py', - self.tmpdir / 'test_spiders_xxx' / 'spider3dupe.py') + shutil.copyfile( + self.tmpdir / "test_spiders_xxx" / "spider3.py", + self.tmpdir / "test_spiders_xxx" / "spider3dupe.py", + ) with warnings.catch_warnings(record=True) as w: spider_loader = SpiderLoader.from_settings(self.settings) @@ -166,15 +174,19 @@ class DuplicateSpiderNameLoaderTest(unittest.TestCase): self.assertNotIn("'spider4'", msg) spiders = set(spider_loader.list()) - self.assertEqual(spiders, {'spider1', 'spider2', 'spider3', 'spider4'}) + self.assertEqual(spiders, {"spider1", "spider2", "spider3", "spider4"}) def test_multiple_dupename_warning(self): # copy 2 spider modules so as to have duplicate spider name # This should issue 2 warning, 1 for each duplicate spider name - shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider1.py', - self.tmpdir / 'test_spiders_xxx' / 'spider1dupe.py') - shutil.copyfile(self.tmpdir / 'test_spiders_xxx' / 'spider2.py', - self.tmpdir / 'test_spiders_xxx' / 'spider2dupe.py') + shutil.copyfile( + self.tmpdir / "test_spiders_xxx" / "spider1.py", + self.tmpdir / "test_spiders_xxx" / "spider1dupe.py", + ) + shutil.copyfile( + self.tmpdir / "test_spiders_xxx" / "spider2.py", + self.tmpdir / "test_spiders_xxx" / "spider2dupe.py", + ) with warnings.catch_warnings(record=True) as w: spider_loader = SpiderLoader.from_settings(self.settings) @@ -192,4 +204,4 @@ class DuplicateSpiderNameLoaderTest(unittest.TestCase): self.assertNotIn("'spider4'", msg) spiders = set(spider_loader.list()) - self.assertEqual(spiders, {'spider1', 'spider2', 'spider3', 'spider4'}) + self.assertEqual(spiders, {"spider1", "spider2", "spider3", "spider4"}) diff --git a/tests/test_spiderloader/test_spiders/nested/spider4.py b/tests/test_spiderloader/test_spiders/nested/spider4.py index dbd1fb123..6c8ea4fe4 100644 --- a/tests/test_spiderloader/test_spiders/nested/spider4.py +++ b/tests/test_spiderloader/test_spiders/nested/spider4.py @@ -3,8 +3,8 @@ from scrapy.spiders import Spider class Spider4(Spider): name = "spider4" - allowed_domains = ['spider4.com'] + allowed_domains = ["spider4.com"] @classmethod def handles_request(cls, request): - return request.url == 'http://spider4.com/onlythis' + return request.url == "http://spider4.com/onlythis" diff --git a/tests/test_spiderloader/test_spiders/spider3.py b/tests/test_spiderloader/test_spiders/spider3.py index 84998ba35..d99878276 100644 --- a/tests/test_spiderloader/test_spiders/spider3.py +++ b/tests/test_spiderloader/test_spiders/spider3.py @@ -3,8 +3,8 @@ from scrapy.spiders import Spider class Spider3(Spider): name = "spider3" - allowed_domains = ['spider3.com'] + allowed_domains = ["spider3.com"] @classmethod def handles_request(cls, request): - return request.url == 'http://spider3.com/onlythis' + return request.url == "http://spider3.com/onlythis" diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index edde6f682..760ee43df 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -17,12 +17,11 @@ from scrapy.core.spidermw import SpiderMiddlewareManager class SpiderMiddlewareTestCase(TestCase): - def setUp(self): - self.request = Request('http://example.com/index.html') + self.request = Request("http://example.com/index.html") self.response = Response(self.request.url, request=self.request) - self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}}) - self.spider = self.crawler._create_spider('foo') + self.crawler = get_crawler(Spider, {"SPIDER_MIDDLEWARES_BASE": {}}) + self.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) def _scrape_response(self): @@ -30,7 +29,9 @@ class SpiderMiddlewareTestCase(TestCase): Raise exception in case of failure. """ scrape_func = mock.MagicMock() - dfd = self.mwman.scrape_response(scrape_func, self.response, self.request, self.spider) + dfd = self.mwman.scrape_response( + scrape_func, self.response, self.request, self.spider + ) # catch deferred result and return the value results = [] dfd.addBoth(results.append) @@ -43,7 +44,6 @@ class ProcessSpiderInputInvalidOutput(SpiderMiddlewareTestCase): """Invalid return value for process_spider_input method""" def test_invalid_process_spider_input(self): - class InvalidProcessSpiderInputMiddleware: def process_spider_input(self, response, spider): return 1 @@ -58,7 +58,6 @@ class ProcessSpiderOutputInvalidOutput(SpiderMiddlewareTestCase): """Invalid return value for process_spider_output method""" def test_invalid_process_spider_output(self): - class InvalidProcessSpiderOutputMiddleware: def process_spider_output(self, response, result, spider): return 1 @@ -73,7 +72,6 @@ class ProcessSpiderExceptionInvalidOutput(SpiderMiddlewareTestCase): """Invalid return value for process_spider_exception method""" def test_invalid_process_spider_exception(self): - class InvalidProcessSpiderOutputExceptionMiddleware: def process_spider_exception(self, response, exception, spider): return 1 @@ -93,7 +91,6 @@ class ProcessSpiderExceptionReRaise(SpiderMiddlewareTestCase): """Re raise the exception by returning None""" def test_process_spider_exception_return_none(self): - class ProcessSpiderExceptionReturnNoneMiddleware: def process_spider_exception(self, response, exception, spider): return None @@ -110,7 +107,7 @@ class ProcessSpiderExceptionReRaise(SpiderMiddlewareTestCase): class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): - """ Helpers for testing sync, async and mixed middlewares. + """Helpers for testing sync, async and mixed middlewares. Should work for process_spider_output and, when it's supported, process_start_requests. """ @@ -124,23 +121,31 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): return {i: c for c, i in enumerate(mw_classes, start=start_index)} def _scrape_func(self, *args, **kwargs): - yield {'foo': 1} - yield {'foo': 2} - yield {'foo': 3} + yield {"foo": 1} + yield {"foo": 2} + yield {"foo": 3} @defer.inlineCallbacks def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): setting = self._construct_mw_setting(*mw_classes, start_index=start_index) - self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}, 'SPIDER_MIDDLEWARES': setting}) - self.spider = self.crawler._create_spider('foo') + self.crawler = get_crawler( + Spider, {"SPIDER_MIDDLEWARES_BASE": {}, "SPIDER_MIDDLEWARES": setting} + ) + self.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) - result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) + result = yield self.mwman.scrape_response( + self._scrape_func, self.response, self.request, self.spider + ) return result @defer.inlineCallbacks - def _test_simple_base(self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None): + def _test_simple_base( + self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None + ): with LogCapture() as log: - result = yield self._get_middleware_result(*mw_classes, start_index=start_index) + result = yield self._get_middleware_result( + *mw_classes, start_index=start_index + ) self.assertIsInstance(result, collections.abc.Iterable) result_list = list(result) self.assertEqual(len(result_list), self.RESULT_COUNT) @@ -148,9 +153,13 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): self.assertEqual("downgraded to a non-async" in str(log), downgrade) @defer.inlineCallbacks - def _test_asyncgen_base(self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None): + def _test_asyncgen_base( + self, *mw_classes, downgrade: bool = False, start_index: Optional[int] = None + ): with LogCapture() as log: - result = yield self._get_middleware_result(*mw_classes, start_index=start_index) + result = yield self._get_middleware_result( + *mw_classes, start_index=start_index + ) self.assertIsInstance(result, collections.abc.AsyncIterator) result_list = yield deferred_from_coro(collect_asyncgen(result)) self.assertEqual(len(result_list), self.RESULT_COUNT) @@ -182,24 +191,25 @@ class ProcessSpiderOutputUniversalMiddleware: class ProcessSpiderExceptionSimpleIterableMiddleware: def process_spider_exception(self, response, exception, spider): - yield {'foo': 1} - yield {'foo': 2} - yield {'foo': 3} + yield {"foo": 1} + yield {"foo": 2} + yield {"foo": 3} class ProcessSpiderExceptionAsyncIterableMiddleware: async def process_spider_exception(self, response, exception, spider): - yield {'foo': 1} + yield {"foo": 1} d = defer.Deferred() from twisted.internet import reactor + reactor.callLater(0, d.callback, None) await maybe_deferred_to_future(d) - yield {'foo': 2} - yield {'foo': 3} + yield {"foo": 2} + yield {"foo": 3} class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): - """ process_spider_output tests for simple callbacks""" + """process_spider_output tests for simple callbacks""" ITEM_TYPE = dict MW_SIMPLE = ProcessSpiderOutputSimpleMiddleware @@ -207,82 +217,70 @@ class ProcessSpiderOutputSimple(BaseAsyncSpiderMiddlewareTestCase): MW_UNIVERSAL = ProcessSpiderOutputUniversalMiddleware def test_simple(self): - """ Simple mw """ + """Simple mw""" return self._test_simple_base(self.MW_SIMPLE) def test_asyncgen(self): - """ Asyncgen mw; upgrade """ + """Asyncgen mw; upgrade""" return self._test_asyncgen_base(self.MW_ASYNCGEN) def test_simple_asyncgen(self): - """ Simple mw -> asyncgen mw; upgrade """ - return self._test_asyncgen_base(self.MW_ASYNCGEN, - self.MW_SIMPLE) + """Simple mw -> asyncgen mw; upgrade""" + return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_SIMPLE) def test_asyncgen_simple(self): - """ Asyncgen mw -> simple mw; upgrade then downgrade """ - return self._test_simple_base(self.MW_SIMPLE, - self.MW_ASYNCGEN, - downgrade=True) + """Asyncgen mw -> simple mw; upgrade then downgrade""" + return self._test_simple_base(self.MW_SIMPLE, self.MW_ASYNCGEN, downgrade=True) def test_universal(self): - """ Universal mw """ + """Universal mw""" return self._test_simple_base(self.MW_UNIVERSAL) def test_universal_simple(self): - """ Universal mw -> simple mw """ - return self._test_simple_base(self.MW_SIMPLE, - self.MW_UNIVERSAL) + """Universal mw -> simple mw""" + return self._test_simple_base(self.MW_SIMPLE, self.MW_UNIVERSAL) def test_simple_universal(self): - """ Simple mw -> universal mw """ - return self._test_simple_base(self.MW_UNIVERSAL, - self.MW_SIMPLE) + """Simple mw -> universal mw""" + return self._test_simple_base(self.MW_UNIVERSAL, self.MW_SIMPLE) def test_universal_asyncgen(self): - """ Universal mw -> asyncgen mw; upgrade """ - return self._test_asyncgen_base(self.MW_ASYNCGEN, - self.MW_UNIVERSAL) + """Universal mw -> asyncgen mw; upgrade""" + return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_UNIVERSAL) def test_asyncgen_universal(self): - """ Asyncgen mw -> universal mw; upgrade """ - return self._test_asyncgen_base(self.MW_UNIVERSAL, - self.MW_ASYNCGEN) + """Asyncgen mw -> universal mw; upgrade""" + return self._test_asyncgen_base(self.MW_UNIVERSAL, self.MW_ASYNCGEN) class ProcessSpiderOutputAsyncGen(ProcessSpiderOutputSimple): - """ process_spider_output tests for async generator callbacks """ + """process_spider_output tests for async generator callbacks""" async def _scrape_func(self, *args, **kwargs): for item in super()._scrape_func(): yield item def test_simple(self): - """ Simple mw; downgrade """ - return self._test_simple_base(self.MW_SIMPLE, - downgrade=True) + """Simple mw; downgrade""" + return self._test_simple_base(self.MW_SIMPLE, downgrade=True) def test_simple_asyncgen(self): - """ Simple mw -> asyncgen mw; downgrade then upgrade """ - return self._test_asyncgen_base(self.MW_ASYNCGEN, - self.MW_SIMPLE, - downgrade=True) + """Simple mw -> asyncgen mw; downgrade then upgrade""" + return self._test_asyncgen_base( + self.MW_ASYNCGEN, self.MW_SIMPLE, downgrade=True + ) def test_universal(self): - """ Universal mw """ + """Universal mw""" return self._test_asyncgen_base(self.MW_UNIVERSAL) def test_universal_simple(self): - """ Universal mw -> simple mw; downgrade """ - return self._test_simple_base(self.MW_SIMPLE, - self.MW_UNIVERSAL, - downgrade=True) + """Universal mw -> simple mw; downgrade""" + return self._test_simple_base(self.MW_SIMPLE, self.MW_UNIVERSAL, downgrade=True) def test_simple_universal(self): - """ Simple mw -> universal mw; downgrade """ - return self._test_simple_base(self.MW_UNIVERSAL, - self.MW_SIMPLE, - downgrade=True) + """Simple mw -> universal mw; downgrade""" + return self._test_simple_base(self.MW_UNIVERSAL, self.MW_SIMPLE, downgrade=True) class ProcessSpiderOutputNonIterableMiddleware: @@ -299,7 +297,6 @@ class ProcessSpiderOutputCoroutineMiddleware: class ProcessSpiderOutputInvalidResult(BaseAsyncSpiderMiddlewareTestCase): - @defer.inlineCallbacks def test_non_iterable(self): with self.assertRaisesRegex( @@ -331,27 +328,29 @@ class ProcessStartRequestsSimpleMiddleware: class ProcessStartRequestsSimple(BaseAsyncSpiderMiddlewareTestCase): - """ process_start_requests tests for simple start_requests""" + """process_start_requests tests for simple start_requests""" ITEM_TYPE = Request MW_SIMPLE = ProcessStartRequestsSimpleMiddleware def _start_requests(self): for i in range(3): - yield Request(f'https://example.com/{i}', dont_filter=True) + yield Request(f"https://example.com/{i}", dont_filter=True) @defer.inlineCallbacks def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): setting = self._construct_mw_setting(*mw_classes, start_index=start_index) - self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES_BASE': {}, 'SPIDER_MIDDLEWARES': setting}) - self.spider = self.crawler._create_spider('foo') + self.crawler = get_crawler( + Spider, {"SPIDER_MIDDLEWARES_BASE": {}, "SPIDER_MIDDLEWARES": setting} + ) + self.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) start_requests = iter(self._start_requests()) results = yield self.mwman.process_start_requests(start_requests, self.spider) return results def test_simple(self): - """ Simple mw """ + """Simple mw""" return self._test_simple_base(self.MW_SIMPLE) @@ -383,41 +382,57 @@ class UniversalMiddlewareManagerTest(TestCase): def test_simple_mw(self): mw = ProcessSpiderOutputSimpleMiddleware self.mwman._add_middleware(mw) - self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + self.assertEqual( + self.mwman.methods["process_spider_output"][0], mw.process_spider_output + ) def test_async_mw(self): mw = ProcessSpiderOutputAsyncGenMiddleware self.mwman._add_middleware(mw) - self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + self.assertEqual( + self.mwman.methods["process_spider_output"][0], mw.process_spider_output + ) def test_universal_mw(self): mw = ProcessSpiderOutputUniversalMiddleware self.mwman._add_middleware(mw) - self.assertEqual(self.mwman.methods['process_spider_output'][0], - (mw.process_spider_output, mw.process_spider_output_async)) + self.assertEqual( + self.mwman.methods["process_spider_output"][0], + (mw.process_spider_output, mw.process_spider_output_async), + ) def test_universal_mw_no_sync(self): with LogCapture() as log: self.mwman._add_middleware(UniversalMiddlewareNoSync) - self.assertIn("UniversalMiddlewareNoSync has process_spider_output_async" - " without process_spider_output", str(log)) - self.assertEqual(self.mwman.methods['process_spider_output'][0], None) + self.assertIn( + "UniversalMiddlewareNoSync has process_spider_output_async" + " without process_spider_output", + str(log), + ) + self.assertEqual(self.mwman.methods["process_spider_output"][0], None) def test_universal_mw_both_sync(self): mw = UniversalMiddlewareBothSync with LogCapture() as log: self.mwman._add_middleware(mw) - self.assertIn("UniversalMiddlewareBothSync.process_spider_output_async " - "is not an async generator function", str(log)) - self.assertEqual(self.mwman.methods['process_spider_output'][0], mw.process_spider_output) + self.assertIn( + "UniversalMiddlewareBothSync.process_spider_output_async " + "is not an async generator function", + str(log), + ) + self.assertEqual( + self.mwman.methods["process_spider_output"][0], mw.process_spider_output + ) def test_universal_mw_both_async(self): with LogCapture() as log: self.mwman._add_middleware(UniversalMiddlewareBothAsync) - self.assertIn("UniversalMiddlewareBothAsync.process_spider_output " - "is an async generator function while process_spider_output_async exists", - str(log)) - self.assertEqual(self.mwman.methods['process_spider_output'][0], None) + self.assertIn( + "UniversalMiddlewareBothAsync.process_spider_output " + "is an async generator function while process_spider_output_async exists", + str(log), + ) + self.assertEqual(self.mwman.methods["process_spider_output"][0], None) class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): @@ -429,10 +444,12 @@ class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): @defer.inlineCallbacks def _get_middleware_result(self, *mw_classes, start_index: Optional[int] = None): setting = self._construct_mw_setting(*mw_classes, start_index=start_index) - self.crawler = get_crawler(Spider, {'SPIDER_MIDDLEWARES': setting}) - self.spider = self.crawler._create_spider('foo') + self.crawler = get_crawler(Spider, {"SPIDER_MIDDLEWARES": setting}) + self.spider = self.crawler._create_spider("foo") self.mwman = SpiderMiddlewareManager.from_crawler(self.crawler) - result = yield self.mwman.scrape_response(self._scrape_func, self.response, self.request, self.spider) + result = yield self.mwman.scrape_response( + self._scrape_func, self.response, self.request, self.spider + ) return result def test_just_builtin(self): @@ -442,7 +459,7 @@ class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): return self._test_simple_base(self.MW_SIMPLE, start_index=1000) def test_builtin_async(self): - """ Upgrade """ + """Upgrade""" return self._test_asyncgen_base(self.MW_ASYNCGEN, start_index=1000) def test_builtin_universal(self): @@ -452,7 +469,7 @@ class BuiltinMiddlewareSimpleTest(BaseAsyncSpiderMiddlewareTestCase): return self._test_simple_base(self.MW_SIMPLE) def test_async_builtin(self): - """ Upgrade """ + """Upgrade""" return self._test_asyncgen_base(self.MW_ASYNCGEN) def test_universal_builtin(self): @@ -468,7 +485,7 @@ class BuiltinMiddlewareAsyncGenTest(BuiltinMiddlewareSimpleTest): return self._test_asyncgen_base() def test_builtin_simple(self): - """ Downgrade """ + """Downgrade""" return self._test_simple_base(self.MW_SIMPLE, downgrade=True, start_index=1000) def test_builtin_async(self): @@ -478,7 +495,7 @@ class BuiltinMiddlewareAsyncGenTest(BuiltinMiddlewareSimpleTest): return self._test_asyncgen_base(self.MW_UNIVERSAL, start_index=1000) def test_simple_builtin(self): - """ Downgrade """ + """Downgrade""" return self._test_simple_base(self.MW_SIMPLE, downgrade=True) def test_async_builtin(self): @@ -501,33 +518,31 @@ class ProcessSpiderExceptionTest(BaseAsyncSpiderMiddlewareTestCase): @defer.inlineCallbacks def _test_asyncgen_nodowngrade(self, *mw_classes): - with self.assertRaisesRegex(_InvalidOutput, "Async iterable returned from .+ cannot be downgraded"): + with self.assertRaisesRegex( + _InvalidOutput, "Async iterable returned from .+ cannot be downgraded" + ): yield self._get_middleware_result(*mw_classes) def test_exc_simple(self): - """ Simple exc mw """ + """Simple exc mw""" return self._test_simple_base(self.MW_EXC_SIMPLE) def test_exc_async(self): - """ Async exc mw """ + """Async exc mw""" return self._test_asyncgen_base(self.MW_EXC_ASYNCGEN) def test_exc_simple_simple(self): - """ Simple exc mw -> simple output mw """ - return self._test_simple_base(self.MW_SIMPLE, - self.MW_EXC_SIMPLE) + """Simple exc mw -> simple output mw""" + return self._test_simple_base(self.MW_SIMPLE, self.MW_EXC_SIMPLE) def test_exc_async_async(self): - """ Async exc mw -> async output mw """ - return self._test_asyncgen_base(self.MW_ASYNCGEN, - self.MW_EXC_ASYNCGEN) + """Async exc mw -> async output mw""" + return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_EXC_ASYNCGEN) def test_exc_simple_async(self): - """ Simple exc mw -> async output mw; upgrade """ - return self._test_asyncgen_base(self.MW_ASYNCGEN, - self.MW_EXC_SIMPLE) + """Simple exc mw -> async output mw; upgrade""" + return self._test_asyncgen_base(self.MW_ASYNCGEN, self.MW_EXC_SIMPLE) def test_exc_async_simple(self): - """ Async exc mw -> simple output mw; cannot work as downgrading is not supported """ - return self._test_asyncgen_nodowngrade(self.MW_SIMPLE, - self.MW_EXC_ASYNCGEN) + """Async exc mw -> simple output mw; cannot work as downgrading is not supported""" + return self._test_asyncgen_nodowngrade(self.MW_SIMPLE, self.MW_EXC_ASYNCGEN) diff --git a/tests/test_spidermiddleware_depth.py b/tests/test_spidermiddleware_depth.py index 71cca2472..af17c13a0 100644 --- a/tests/test_spidermiddleware_depth.py +++ b/tests/test_spidermiddleware_depth.py @@ -8,10 +8,9 @@ from scrapy.utils.test import get_crawler class TestDepthMiddleware(TestCase): - def setUp(self): crawler = get_crawler(Spider) - self.spider = crawler._create_spider('scrapytest.org') + self.spider = crawler._create_spider("scrapytest.org") self.stats = StatsCollector(crawler) self.stats.open_spider(self.spider) @@ -19,24 +18,24 @@ class TestDepthMiddleware(TestCase): self.mw = DepthMiddleware(1, self.stats, True) def test_process_spider_output(self): - req = Request('http://scrapytest.org') - resp = Response('http://scrapytest.org') + req = Request("http://scrapytest.org") + resp = Response("http://scrapytest.org") resp.request = req - result = [Request('http://scrapytest.org')] + result = [Request("http://scrapytest.org")] out = list(self.mw.process_spider_output(resp, result, self.spider)) self.assertEqual(out, result) - rdc = self.stats.get_value('request_depth_count/1', spider=self.spider) + rdc = self.stats.get_value("request_depth_count/1", spider=self.spider) self.assertEqual(rdc, 1) - req.meta['depth'] = 1 + req.meta["depth"] = 1 out2 = list(self.mw.process_spider_output(resp, result, self.spider)) self.assertEqual(out2, []) - rdm = self.stats.get_value('request_depth_max', spider=self.spider) + rdm = self.stats.get_value("request_depth_max", spider=self.spider) self.assertEqual(rdm, 1) def tearDown(self): - self.stats.close_spider(self.spider, '') + self.stats.close_spider(self.spider, "") diff --git a/tests/test_spidermiddleware_httperror.py b/tests/test_spidermiddleware_httperror.py index ee11ee492..faa8e9091 100644 --- a/tests/test_spidermiddleware_httperror.py +++ b/tests/test_spidermiddleware_httperror.py @@ -15,7 +15,7 @@ from tests.spiders import MockServerSpider class _HttpErrorSpider(MockServerSpider): - name = 'httperror' + name = "httperror" bypass_status_codes = set() def __init__(self, *args, **kwargs): @@ -59,28 +59,35 @@ def _responses(request, status_codes): class TestHttpErrorMiddleware(TestCase): - def setUp(self): crawler = get_crawler(Spider) - self.spider = Spider.from_crawler(crawler, name='foo') + self.spider = Spider.from_crawler(crawler, name="foo") self.mw = HttpErrorMiddleware(Settings({})) - self.req = Request('http://scrapytest.org') + self.req = Request("http://scrapytest.org") self.res200, self.res404 = _responses(self.req, [200, 404]) def test_process_spider_input(self): self.assertIsNone(self.mw.process_spider_input(self.res200, self.spider)) - self.assertRaises(HttpError, self.mw.process_spider_input, self.res404, self.spider) + self.assertRaises( + HttpError, self.mw.process_spider_input, self.res404, self.spider + ) def test_process_spider_exception(self): self.assertEqual( [], - self.mw.process_spider_exception(self.res404, HttpError(self.res404), self.spider)) - self.assertIsNone(self.mw.process_spider_exception(self.res404, Exception(), self.spider)) + self.mw.process_spider_exception( + self.res404, HttpError(self.res404), self.spider + ), + ) + self.assertIsNone( + self.mw.process_spider_exception(self.res404, Exception(), self.spider) + ) def test_handle_httpstatus_list(self): res = self.res404.copy() - res.request = Request('http://scrapytest.org', - meta={'handle_httpstatus_list': [404]}) + res.request = Request( + "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} + ) self.assertIsNone(self.mw.process_spider_input(res, self.spider)) self.spider.handle_httpstatus_list = [404] @@ -91,18 +98,22 @@ class TestHttpErrorMiddlewareSettings(TestCase): """Similar test, but with settings""" def setUp(self): - self.spider = Spider('foo') - self.mw = HttpErrorMiddleware(Settings({'HTTPERROR_ALLOWED_CODES': (402,)})) - self.req = Request('http://scrapytest.org') + self.spider = Spider("foo") + self.mw = HttpErrorMiddleware(Settings({"HTTPERROR_ALLOWED_CODES": (402,)})) + self.req = Request("http://scrapytest.org") self.res200, self.res404, self.res402 = _responses(self.req, [200, 404, 402]) def test_process_spider_input(self): self.assertIsNone(self.mw.process_spider_input(self.res200, self.spider)) - self.assertRaises(HttpError, self.mw.process_spider_input, self.res404, self.spider) + self.assertRaises( + HttpError, self.mw.process_spider_input, self.res404, self.spider + ) self.assertIsNone(self.mw.process_spider_input(self.res402, self.spider)) def test_meta_overrides_settings(self): - request = Request('http://scrapytest.org', meta={'handle_httpstatus_list': [404]}) + request = Request( + "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} + ) res404 = self.res404.copy() res404.request = request res402 = self.res402.copy() @@ -114,15 +125,16 @@ class TestHttpErrorMiddlewareSettings(TestCase): def test_spider_override_settings(self): self.spider.handle_httpstatus_list = [404] self.assertIsNone(self.mw.process_spider_input(self.res404, self.spider)) - self.assertRaises(HttpError, self.mw.process_spider_input, self.res402, self.spider) + self.assertRaises( + HttpError, self.mw.process_spider_input, self.res402, self.spider + ) class TestHttpErrorMiddlewareHandleAll(TestCase): - def setUp(self): - self.spider = Spider('foo') - self.mw = HttpErrorMiddleware(Settings({'HTTPERROR_ALLOW_ALL': True})) - self.req = Request('http://scrapytest.org') + self.spider = Spider("foo") + self.mw = HttpErrorMiddleware(Settings({"HTTPERROR_ALLOW_ALL": True})) + self.req = Request("http://scrapytest.org") self.res200, self.res404, self.res402 = _responses(self.req, [200, 404, 402]) def test_process_spider_input(self): @@ -130,7 +142,9 @@ class TestHttpErrorMiddlewareHandleAll(TestCase): self.assertIsNone(self.mw.process_spider_input(self.res404, self.spider)) def test_meta_overrides_settings(self): - request = Request('http://scrapytest.org', meta={'handle_httpstatus_list': [404]}) + request = Request( + "http://scrapytest.org", meta={"handle_httpstatus_list": [404]} + ) res404 = self.res404.copy() res404.request = request res402 = self.res402.copy() @@ -142,8 +156,12 @@ class TestHttpErrorMiddlewareHandleAll(TestCase): def test_httperror_allow_all_false(self): crawler = get_crawler(_HttpErrorSpider) mw = HttpErrorMiddleware.from_crawler(crawler) - request_httpstatus_false = Request('http://scrapytest.org', meta={'handle_httpstatus_all': False}) - request_httpstatus_true = Request('http://scrapytest.org', meta={'handle_httpstatus_all': True}) + request_httpstatus_false = Request( + "http://scrapytest.org", meta={"handle_httpstatus_all": False} + ) + request_httpstatus_true = Request( + "http://scrapytest.org", meta={"handle_httpstatus_all": True} + ) res404 = self.res404.copy() res404.request = request_httpstatus_false res402 = self.res402.copy() @@ -166,28 +184,28 @@ class TestHttpErrorMiddlewareIntegrational(TrialTestCase): crawler = get_crawler(_HttpErrorSpider) yield crawler.crawl(mockserver=self.mockserver) assert not crawler.spider.skipped, crawler.spider.skipped - self.assertEqual(crawler.spider.parsed, {'200'}) - self.assertEqual(crawler.spider.failed, {'404', '402', '500'}) + self.assertEqual(crawler.spider.parsed, {"200"}) + self.assertEqual(crawler.spider.failed, {"404", "402", "500"}) get_value = crawler.stats.get_value - self.assertEqual(get_value('httperror/response_ignored_count'), 3) - self.assertEqual(get_value('httperror/response_ignored_status_count/404'), 1) - self.assertEqual(get_value('httperror/response_ignored_status_count/402'), 1) - self.assertEqual(get_value('httperror/response_ignored_status_count/500'), 1) + self.assertEqual(get_value("httperror/response_ignored_count"), 3) + self.assertEqual(get_value("httperror/response_ignored_status_count/404"), 1) + self.assertEqual(get_value("httperror/response_ignored_status_count/402"), 1) + self.assertEqual(get_value("httperror/response_ignored_status_count/500"), 1) @defer.inlineCallbacks def test_logging(self): crawler = get_crawler(_HttpErrorSpider) with LogCapture() as log: yield crawler.crawl(mockserver=self.mockserver, bypass_status_codes={402}) - self.assertEqual(crawler.spider.parsed, {'200', '402'}) - self.assertEqual(crawler.spider.skipped, {'402'}) - self.assertEqual(crawler.spider.failed, {'404', '500'}) + self.assertEqual(crawler.spider.parsed, {"200", "402"}) + self.assertEqual(crawler.spider.skipped, {"402"}) + self.assertEqual(crawler.spider.failed, {"404", "500"}) - self.assertIn('Ignoring response <404', str(log)) - self.assertIn('Ignoring response <500', str(log)) - self.assertNotIn('Ignoring response <200', str(log)) - self.assertNotIn('Ignoring response <402', str(log)) + self.assertIn("Ignoring response <404", str(log)) + self.assertIn("Ignoring response <500", str(log)) + self.assertNotIn("Ignoring response <200", str(log)) + self.assertNotIn("Ignoring response <402", str(log)) @defer.inlineCallbacks def test_logging_level(self): @@ -195,22 +213,22 @@ class TestHttpErrorMiddlewareIntegrational(TrialTestCase): crawler = get_crawler(_HttpErrorSpider) with LogCapture(level=logging.INFO) as log: yield crawler.crawl(mockserver=self.mockserver) - self.assertEqual(crawler.spider.parsed, {'200'}) - self.assertEqual(crawler.spider.failed, {'404', '402', '500'}) + self.assertEqual(crawler.spider.parsed, {"200"}) + self.assertEqual(crawler.spider.failed, {"404", "402", "500"}) - self.assertIn('Ignoring response <402', str(log)) - self.assertIn('Ignoring response <404', str(log)) - self.assertIn('Ignoring response <500', str(log)) - self.assertNotIn('Ignoring response <200', str(log)) + self.assertIn("Ignoring response <402", str(log)) + self.assertIn("Ignoring response <404", str(log)) + self.assertIn("Ignoring response <500", str(log)) + self.assertNotIn("Ignoring response <200", str(log)) # with level WARNING, we shouldn't capture anything from HttpError crawler = get_crawler(_HttpErrorSpider) with LogCapture(level=logging.WARNING) as log: yield crawler.crawl(mockserver=self.mockserver) - self.assertEqual(crawler.spider.parsed, {'200'}) - self.assertEqual(crawler.spider.failed, {'404', '402', '500'}) + self.assertEqual(crawler.spider.parsed, {"200"}) + self.assertEqual(crawler.spider.failed, {"404", "402", "500"}) - self.assertNotIn('Ignoring response <402', str(log)) - self.assertNotIn('Ignoring response <404', str(log)) - self.assertNotIn('Ignoring response <500', str(log)) - self.assertNotIn('Ignoring response <200', str(log)) + self.assertNotIn("Ignoring response <402", str(log)) + self.assertNotIn("Ignoring response <404", str(log)) + self.assertNotIn("Ignoring response <500", str(log)) + self.assertNotIn("Ignoring response <200", str(log)) diff --git a/tests/test_spidermiddleware_offsite.py b/tests/test_spidermiddleware_offsite.py index 0f4b98a07..380bafe04 100644 --- a/tests/test_spidermiddleware_offsite.py +++ b/tests/test_spidermiddleware_offsite.py @@ -9,7 +9,6 @@ from scrapy.utils.test import get_crawler class TestOffsiteMiddleware(TestCase): - def setUp(self): crawler = get_crawler(Spider) self.spider = crawler._create_spider(**self._get_spiderargs()) @@ -17,28 +16,31 @@ class TestOffsiteMiddleware(TestCase): self.mw.spider_opened(self.spider) def _get_spiderargs(self): - return dict(name='foo', allowed_domains=['scrapytest.org', 'scrapy.org', 'scrapy.test.org']) + return dict( + name="foo", + allowed_domains=["scrapytest.org", "scrapy.org", "scrapy.test.org"], + ) def test_process_spider_output(self): - res = Response('http://scrapytest.org') + res = Response("http://scrapytest.org") onsite_reqs = [ - Request('http://scrapytest.org/1'), - Request('http://scrapy.org/1'), - Request('http://sub.scrapy.org/1'), - Request('http://offsite.tld/letmepass', dont_filter=True), - Request('http://scrapy.test.org/'), - Request('http://scrapy.test.org:8000/'), + Request("http://scrapytest.org/1"), + Request("http://scrapy.org/1"), + Request("http://sub.scrapy.org/1"), + Request("http://offsite.tld/letmepass", dont_filter=True), + Request("http://scrapy.test.org/"), + Request("http://scrapy.test.org:8000/"), ] offsite_reqs = [ - Request('http://scrapy2.org'), - Request('http://offsite.tld/'), - Request('http://offsite.tld/scrapytest.org'), - Request('http://offsite.tld/rogue.scrapytest.org'), - Request('http://rogue.scrapytest.org.haha.com'), - Request('http://roguescrapytest.org'), - Request('http://test.org/'), - Request('http://notscrapy.test.org/'), + Request("http://scrapy2.org"), + Request("http://offsite.tld/"), + Request("http://offsite.tld/scrapytest.org"), + Request("http://offsite.tld/rogue.scrapytest.org"), + Request("http://rogue.scrapytest.org.haha.com"), + Request("http://roguescrapytest.org"), + Request("http://test.org/"), + Request("http://notscrapy.test.org/"), ] reqs = onsite_reqs + offsite_reqs @@ -47,40 +49,40 @@ class TestOffsiteMiddleware(TestCase): class TestOffsiteMiddleware2(TestOffsiteMiddleware): - def _get_spiderargs(self): - return dict(name='foo', allowed_domains=None) + return dict(name="foo", allowed_domains=None) def test_process_spider_output(self): - res = Response('http://scrapytest.org') - reqs = [Request('http://a.com/b.html'), Request('http://b.com/1')] + res = Response("http://scrapytest.org") + reqs = [Request("http://a.com/b.html"), Request("http://b.com/1")] out = list(self.mw.process_spider_output(res, reqs, self.spider)) self.assertEqual(out, reqs) class TestOffsiteMiddleware3(TestOffsiteMiddleware2): - def _get_spiderargs(self): - return dict(name='foo') + return dict(name="foo") class TestOffsiteMiddleware4(TestOffsiteMiddleware3): - def _get_spiderargs(self): - bad_hostname = urlparse('http:////scrapytest.org').hostname - return dict(name='foo', allowed_domains=['scrapytest.org', None, bad_hostname]) + bad_hostname = urlparse("http:////scrapytest.org").hostname + return dict(name="foo", allowed_domains=["scrapytest.org", None, bad_hostname]) def test_process_spider_output(self): - res = Response('http://scrapytest.org') - reqs = [Request('http://scrapytest.org/1')] + res = Response("http://scrapytest.org") + reqs = [Request("http://scrapytest.org/1")] out = list(self.mw.process_spider_output(res, reqs, self.spider)) self.assertEqual(out, reqs) class TestOffsiteMiddleware5(TestOffsiteMiddleware4): - def test_get_host_regex(self): - self.spider.allowed_domains = ['http://scrapytest.org', 'scrapy.org', 'scrapy.test.org'] + self.spider.allowed_domains = [ + "http://scrapytest.org", + "scrapy.org", + "scrapy.test.org", + ] with warnings.catch_warnings(record=True) as w: warnings.simplefilter("always") self.mw.get_host_regex(self.spider) @@ -88,9 +90,12 @@ class TestOffsiteMiddleware5(TestOffsiteMiddleware4): class TestOffsiteMiddleware6(TestOffsiteMiddleware4): - def test_get_host_regex(self): - self.spider.allowed_domains = ['scrapytest.org:8000', 'scrapy.org', 'scrapy.test.org'] + self.spider.allowed_domains = [ + "scrapytest.org:8000", + "scrapy.org", + "scrapy.test.org", + ] with warnings.catch_warnings(record=True) as w: warnings.simplefilter("always") self.mw.get_host_regex(self.spider) diff --git a/tests/test_spidermiddleware_output_chain.py b/tests/test_spidermiddleware_output_chain.py index 8dd1def17..fad5dcaac 100644 --- a/tests/test_spidermiddleware_output_chain.py +++ b/tests/test_spidermiddleware_output_chain.py @@ -9,7 +9,9 @@ from tests.mockserver import MockServer class LogExceptionMiddleware: def process_spider_exception(self, response, exception, spider): - spider.logger.info('Middleware: %s exception caught', exception.__class__.__name__) + spider.logger.info( + "Middleware: %s exception caught", exception.__class__.__name__ + ) return None @@ -17,34 +19,36 @@ class LogExceptionMiddleware: # (0) recover from an exception on a spider callback class RecoveryMiddleware: def process_spider_exception(self, response, exception, spider): - spider.logger.info('Middleware: %s exception caught', exception.__class__.__name__) + spider.logger.info( + "Middleware: %s exception caught", exception.__class__.__name__ + ) return [ - {'from': 'process_spider_exception'}, - Request(response.url, meta={'dont_fail': True}, dont_filter=True), + {"from": "process_spider_exception"}, + Request(response.url, meta={"dont_fail": True}, dont_filter=True), ] class RecoverySpider(Spider): - name = 'RecoverySpider' + name = "RecoverySpider" custom_settings = { - 'SPIDER_MIDDLEWARES_BASE': {}, - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES_BASE": {}, + "SPIDER_MIDDLEWARES": { RecoveryMiddleware: 10, }, } def start_requests(self): - yield Request(self.mockserver.url('/status?n=200')) + yield Request(self.mockserver.url("/status?n=200")) def parse(self, response): - yield {'test': 1} - self.logger.info('DONT_FAIL: %s', response.meta.get('dont_fail')) - if not response.meta.get('dont_fail'): + yield {"test": 1} + self.logger.info("DONT_FAIL: %s", response.meta.get("dont_fail")) + if not response.meta.get("dont_fail"): raise TabError() class RecoveryAsyncGenSpider(RecoverySpider): - name = 'RecoveryAsyncGenSpider' + name = "RecoveryAsyncGenSpider" async def parse(self, response): for r in super().parse(response): @@ -55,14 +59,14 @@ class RecoveryAsyncGenSpider(RecoverySpider): # (1) exceptions from a spider middleware's process_spider_input method class FailProcessSpiderInputMiddleware: def process_spider_input(self, response, spider): - spider.logger.info('Middleware: will raise IndexError') + spider.logger.info("Middleware: will raise IndexError") raise IndexError() class ProcessSpiderInputSpiderWithoutErrback(Spider): - name = 'ProcessSpiderInputSpiderWithoutErrback' + name = "ProcessSpiderInputSpiderWithoutErrback" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { # spider FailProcessSpiderInputMiddleware: 8, LogExceptionMiddleware: 6, @@ -71,55 +75,57 @@ class ProcessSpiderInputSpiderWithoutErrback(Spider): } def start_requests(self): - yield Request(url=self.mockserver.url('/status?n=200'), callback=self.parse) + yield Request(url=self.mockserver.url("/status?n=200"), callback=self.parse) def parse(self, response): - return {'from': 'callback'} + return {"from": "callback"} class ProcessSpiderInputSpiderWithErrback(ProcessSpiderInputSpiderWithoutErrback): - name = 'ProcessSpiderInputSpiderWithErrback' + name = "ProcessSpiderInputSpiderWithErrback" def start_requests(self): - yield Request(self.mockserver.url('/status?n=200'), self.parse, errback=self.errback) + yield Request( + self.mockserver.url("/status?n=200"), self.parse, errback=self.errback + ) def errback(self, failure): - self.logger.info('Got a Failure on the Request errback') - return {'from': 'errback'} + self.logger.info("Got a Failure on the Request errback") + return {"from": "errback"} # ================================================================================ # (2) exceptions from a spider callback (generator) class GeneratorCallbackSpider(Spider): - name = 'GeneratorCallbackSpider' + name = "GeneratorCallbackSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { LogExceptionMiddleware: 10, }, } def start_requests(self): - yield Request(self.mockserver.url('/status?n=200')) + yield Request(self.mockserver.url("/status?n=200")) def parse(self, response): - yield {'test': 1} - yield {'test': 2} + yield {"test": 1} + yield {"test": 2} raise ImportError() class AsyncGeneratorCallbackSpider(GeneratorCallbackSpider): async def parse(self, response): - yield {'test': 1} - yield {'test': 2} + yield {"test": 1} + yield {"test": 2} raise ImportError() # ================================================================================ # (2.1) exceptions from a spider callback (generator, middleware right after callback) class GeneratorCallbackSpiderMiddlewareRightAfterSpider(GeneratorCallbackSpider): - name = 'GeneratorCallbackSpiderMiddlewareRightAfterSpider' + name = "GeneratorCallbackSpiderMiddlewareRightAfterSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { LogExceptionMiddleware: 100000, }, } @@ -128,26 +134,26 @@ class GeneratorCallbackSpiderMiddlewareRightAfterSpider(GeneratorCallbackSpider) # ================================================================================ # (3) exceptions from a spider callback (not a generator) class NotGeneratorCallbackSpider(Spider): - name = 'NotGeneratorCallbackSpider' + name = "NotGeneratorCallbackSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { LogExceptionMiddleware: 10, }, } def start_requests(self): - yield Request(self.mockserver.url('/status?n=200')) + yield Request(self.mockserver.url("/status?n=200")) def parse(self, response): - return [{'test': 1}, {'test': 1 / 0}] + return [{"test": 1}, {"test": 1 / 0}] # ================================================================================ # (3.1) exceptions from a spider callback (not a generator, middleware right after callback) class NotGeneratorCallbackSpiderMiddlewareRightAfterSpider(NotGeneratorCallbackSpider): - name = 'NotGeneratorCallbackSpiderMiddlewareRightAfterSpider' + name = "NotGeneratorCallbackSpiderMiddlewareRightAfterSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { LogExceptionMiddleware: 100000, }, } @@ -158,26 +164,26 @@ class NotGeneratorCallbackSpiderMiddlewareRightAfterSpider(NotGeneratorCallbackS class _GeneratorDoNothingMiddleware: def process_spider_output(self, response, result, spider): for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) return None class GeneratorFailMiddleware: def process_spider_output(self, response, result, spider): for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r raise LookupError() def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) - yield {'processed': [method]} + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + yield {"processed": [method]} class GeneratorDoNothingAfterFailureMiddleware(_GeneratorDoNothingMiddleware): @@ -187,13 +193,13 @@ class GeneratorDoNothingAfterFailureMiddleware(_GeneratorDoNothingMiddleware): class GeneratorRecoverMiddleware: def process_spider_output(self, response, result, spider): for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") yield r def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) - yield {'processed': [method]} + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + yield {"processed": [method]} class GeneratorDoNothingAfterRecoveryMiddleware(_GeneratorDoNothingMiddleware): @@ -201,9 +207,9 @@ class GeneratorDoNothingAfterRecoveryMiddleware(_GeneratorDoNothingMiddleware): class GeneratorOutputChainSpider(Spider): - name = 'GeneratorOutputChainSpider' + name = "GeneratorOutputChainSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { GeneratorFailMiddleware: 10, GeneratorDoNothingAfterFailureMiddleware: 8, GeneratorRecoverMiddleware: 5, @@ -212,27 +218,28 @@ class GeneratorOutputChainSpider(Spider): } def start_requests(self): - yield Request(self.mockserver.url('/status?n=200')) + yield Request(self.mockserver.url("/status?n=200")) def parse(self, response): - yield {'processed': ['parse-first-item']} - yield {'processed': ['parse-second-item']} + yield {"processed": ["parse-first-item"]} + yield {"processed": ["parse-second-item"]} # ================================================================================ # (5) exceptions from a middleware process_spider_output method (not generator) + class _NotGeneratorDoNothingMiddleware: def process_spider_output(self, response, result, spider): out = [] for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") out.append(r) return out def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) return None @@ -240,15 +247,15 @@ class NotGeneratorFailMiddleware: def process_spider_output(self, response, result, spider): out = [] for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") out.append(r) raise ReferenceError() return out def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) - return [{'processed': [method]}] + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + return [{"processed": [method]}] class NotGeneratorDoNothingAfterFailureMiddleware(_NotGeneratorDoNothingMiddleware): @@ -259,14 +266,14 @@ class NotGeneratorRecoverMiddleware: def process_spider_output(self, response, result, spider): out = [] for r in result: - r['processed'].append(f'{self.__class__.__name__}.process_spider_output') + r["processed"].append(f"{self.__class__.__name__}.process_spider_output") out.append(r) return out def process_spider_exception(self, response, exception, spider): - method = f'{self.__class__.__name__}.process_spider_exception' - spider.logger.info('%s: %s caught', method, exception.__class__.__name__) - return [{'processed': [method]}] + method = f"{self.__class__.__name__}.process_spider_exception" + spider.logger.info("%s: %s caught", method, exception.__class__.__name__) + return [{"processed": [method]}] class NotGeneratorDoNothingAfterRecoveryMiddleware(_NotGeneratorDoNothingMiddleware): @@ -274,9 +281,9 @@ class NotGeneratorDoNothingAfterRecoveryMiddleware(_NotGeneratorDoNothingMiddlew class NotGeneratorOutputChainSpider(Spider): - name = 'NotGeneratorOutputChainSpider' + name = "NotGeneratorOutputChainSpider" custom_settings = { - 'SPIDER_MIDDLEWARES': { + "SPIDER_MIDDLEWARES": { NotGeneratorFailMiddleware: 10, NotGeneratorDoNothingAfterFailureMiddleware: 8, NotGeneratorRecoverMiddleware: 5, @@ -285,10 +292,13 @@ class NotGeneratorOutputChainSpider(Spider): } def start_requests(self): - return [Request(self.mockserver.url('/status?n=200'))] + return [Request(self.mockserver.url("/status?n=200"))] def parse(self, response): - return [{'processed': ['parse-first-item']}, {'processed': ['parse-second-item']}] + return [ + {"processed": ["parse-first-item"]}, + {"processed": ["parse-second-item"]}, + ] # ================================================================================ @@ -402,7 +412,9 @@ class TestSpiderMiddleware(TestCase): (3.1) Special case of (3): Exceptions should be caught even if the middleware is placed right after the spider """ - log31 = yield self.crawl_log(NotGeneratorCallbackSpiderMiddlewareRightAfterSpider) + log31 = yield self.crawl_log( + NotGeneratorCallbackSpiderMiddlewareRightAfterSpider + ) self.assertIn("Middleware: ZeroDivisionError exception caught", str(log31)) self.assertNotIn("item_scraped_count", str(log31)) @@ -418,28 +430,40 @@ class TestSpiderMiddleware(TestCase): """ log4 = yield self.crawl_log(GeneratorOutputChainSpider) self.assertIn("'item_scraped_count': 2", str(log4)) - self.assertIn("GeneratorRecoverMiddleware.process_spider_exception: LookupError caught", str(log4)) + self.assertIn( + "GeneratorRecoverMiddleware.process_spider_exception: LookupError caught", + str(log4), + ) self.assertIn( "GeneratorDoNothingAfterFailureMiddleware.process_spider_exception: LookupError caught", - str(log4)) + str(log4), + ) self.assertNotIn( "GeneratorFailMiddleware.process_spider_exception: LookupError caught", - str(log4)) + str(log4), + ) self.assertNotIn( "GeneratorDoNothingAfterRecoveryMiddleware.process_spider_exception: LookupError caught", - str(log4)) - item_from_callback = {'processed': [ - 'parse-first-item', - 'GeneratorFailMiddleware.process_spider_output', - 'GeneratorDoNothingAfterFailureMiddleware.process_spider_output', - 'GeneratorRecoverMiddleware.process_spider_output', - 'GeneratorDoNothingAfterRecoveryMiddleware.process_spider_output']} - item_recovered = {'processed': [ - 'GeneratorRecoverMiddleware.process_spider_exception', - 'GeneratorDoNothingAfterRecoveryMiddleware.process_spider_output']} + str(log4), + ) + item_from_callback = { + "processed": [ + "parse-first-item", + "GeneratorFailMiddleware.process_spider_output", + "GeneratorDoNothingAfterFailureMiddleware.process_spider_output", + "GeneratorRecoverMiddleware.process_spider_output", + "GeneratorDoNothingAfterRecoveryMiddleware.process_spider_output", + ] + } + item_recovered = { + "processed": [ + "GeneratorRecoverMiddleware.process_spider_exception", + "GeneratorDoNothingAfterRecoveryMiddleware.process_spider_output", + ] + } self.assertIn(str(item_from_callback), str(log4)) self.assertIn(str(item_recovered), str(log4)) - self.assertNotIn('parse-second-item', str(log4)) + self.assertNotIn("parse-second-item", str(log4)) @defer.inlineCallbacks def test_not_a_generator_output_chain(self): @@ -453,17 +477,28 @@ class TestSpiderMiddleware(TestCase): """ log5 = yield self.crawl_log(NotGeneratorOutputChainSpider) self.assertIn("'item_scraped_count': 1", str(log5)) - self.assertIn("GeneratorRecoverMiddleware.process_spider_exception: ReferenceError caught", str(log5)) + self.assertIn( + "GeneratorRecoverMiddleware.process_spider_exception: ReferenceError caught", + str(log5), + ) self.assertIn( "GeneratorDoNothingAfterFailureMiddleware.process_spider_exception: ReferenceError caught", - str(log5)) - self.assertNotIn("GeneratorFailMiddleware.process_spider_exception: ReferenceError caught", str(log5)) + str(log5), + ) + self.assertNotIn( + "GeneratorFailMiddleware.process_spider_exception: ReferenceError caught", + str(log5), + ) self.assertNotIn( "GeneratorDoNothingAfterRecoveryMiddleware.process_spider_exception: ReferenceError caught", - str(log5)) - item_recovered = {'processed': [ - 'NotGeneratorRecoverMiddleware.process_spider_exception', - 'NotGeneratorDoNothingAfterRecoveryMiddleware.process_spider_output']} + str(log5), + ) + item_recovered = { + "processed": [ + "NotGeneratorRecoverMiddleware.process_spider_exception", + "NotGeneratorDoNothingAfterRecoveryMiddleware.process_spider_output", + ] + } self.assertIn(str(item_recovered), str(log5)) - self.assertNotIn('parse-first-item', str(log5)) - self.assertNotIn('parse-second-item', str(log5)) + self.assertNotIn("parse-first-item", str(log5)) + self.assertNotIn("parse-second-item", str(log5)) diff --git a/tests/test_spidermiddleware_referer.py b/tests/test_spidermiddleware_referer.py index 63daf0b8a..db5a22adb 100644 --- a/tests/test_spidermiddleware_referer.py +++ b/tests/test_spidermiddleware_referer.py @@ -36,11 +36,11 @@ class TestRefererMiddleware(TestCase): resp_headers = {} settings = {} scenarii = [ - ('http://scrapytest.org', 'http://scrapytest.org/', b'http://scrapytest.org'), + ("http://scrapytest.org", "http://scrapytest.org/", b"http://scrapytest.org"), ] def setUp(self): - self.spider = Spider('foo') + self.spider = Spider("foo") settings = Settings(self.settings) self.mw = RefererMiddleware(settings) @@ -56,7 +56,7 @@ class TestRefererMiddleware(TestCase): response = self.get_response(origin) request = self.get_request(target) out = list(self.mw.process_spider_output(response, [request], self.spider)) - self.assertEqual(out[0].headers.get('Referer'), referrer) + self.assertEqual(out[0].headers.get("Referer"), referrer) class MixinDefault: @@ -65,101 +65,184 @@ class MixinDefault: with some additional filtering of s3:// """ + scenarii = [ - ('https://example.com/', 'https://scrapy.org/', b'https://example.com/'), - ('http://example.com/', 'http://scrapy.org/', b'http://example.com/'), - ('http://example.com/', 'https://scrapy.org/', b'http://example.com/'), - ('https://example.com/', 'http://scrapy.org/', None), - + ("https://example.com/", "https://scrapy.org/", b"https://example.com/"), + ("http://example.com/", "http://scrapy.org/", b"http://example.com/"), + ("http://example.com/", "https://scrapy.org/", b"http://example.com/"), + ("https://example.com/", "http://scrapy.org/", None), # no credentials leak - ('http://user:password@example.com/', 'https://scrapy.org/', b'http://example.com/'), - + ( + "http://user:password@example.com/", + "https://scrapy.org/", + b"http://example.com/", + ), # no referrer leak for local schemes - ('file:///home/path/to/somefile.html', 'https://scrapy.org/', None), - ('file:///home/path/to/somefile.html', 'http://scrapy.org/', None), - + ("file:///home/path/to/somefile.html", "https://scrapy.org/", None), + ("file:///home/path/to/somefile.html", "http://scrapy.org/", None), # no referrer leak for s3 origins - ('s3://mybucket/path/to/data.csv', 'https://scrapy.org/', None), - ('s3://mybucket/path/to/data.csv', 'http://scrapy.org/', None), + ("s3://mybucket/path/to/data.csv", "https://scrapy.org/", None), + ("s3://mybucket/path/to/data.csv", "http://scrapy.org/", None), ] class MixinNoReferrer: scenarii = [ - ('https://example.com/page.html', 'https://example.com/', None), - ('http://www.example.com/', 'https://scrapy.org/', None), - ('http://www.example.com/', 'http://scrapy.org/', None), - ('https://www.example.com/', 'http://scrapy.org/', None), - ('file:///home/path/to/somefile.html', 'http://scrapy.org/', None), + ("https://example.com/page.html", "https://example.com/", None), + ("http://www.example.com/", "https://scrapy.org/", None), + ("http://www.example.com/", "http://scrapy.org/", None), + ("https://www.example.com/", "http://scrapy.org/", None), + ("file:///home/path/to/somefile.html", "http://scrapy.org/", None), ] class MixinNoReferrerWhenDowngrade: scenarii = [ # TLS to TLS: send non-empty referrer - ('https://example.com/page.html', 'https://not.example.com/', b'https://example.com/page.html'), - ('https://example.com/page.html', 'https://scrapy.org/', b'https://example.com/page.html'), - ('https://example.com:443/page.html', 'https://scrapy.org/', b'https://example.com/page.html'), - ('https://example.com:444/page.html', 'https://scrapy.org/', b'https://example.com:444/page.html'), - ('ftps://example.com/urls.zip', 'https://scrapy.org/', b'ftps://example.com/urls.zip'), - + ( + "https://example.com/page.html", + "https://not.example.com/", + b"https://example.com/page.html", + ), + ( + "https://example.com/page.html", + "https://scrapy.org/", + b"https://example.com/page.html", + ), + ( + "https://example.com:443/page.html", + "https://scrapy.org/", + b"https://example.com/page.html", + ), + ( + "https://example.com:444/page.html", + "https://scrapy.org/", + b"https://example.com:444/page.html", + ), + ( + "ftps://example.com/urls.zip", + "https://scrapy.org/", + b"ftps://example.com/urls.zip", + ), # TLS to non-TLS: do not send referrer - ('https://example.com/page.html', 'http://not.example.com/', None), - ('https://example.com/page.html', 'http://scrapy.org/', None), - ('ftps://example.com/urls.zip', 'http://scrapy.org/', None), - + ("https://example.com/page.html", "http://not.example.com/", None), + ("https://example.com/page.html", "http://scrapy.org/", None), + ("ftps://example.com/urls.zip", "http://scrapy.org/", None), # non-TLS to TLS or non-TLS: send referrer - ('http://example.com/page.html', 'https://not.example.com/', b'http://example.com/page.html'), - ('http://example.com/page.html', 'https://scrapy.org/', b'http://example.com/page.html'), - ('http://example.com:8080/page.html', 'https://scrapy.org/', b'http://example.com:8080/page.html'), - ('http://example.com:80/page.html', 'http://not.example.com/', b'http://example.com/page.html'), - ('http://example.com/page.html', 'http://scrapy.org/', b'http://example.com/page.html'), - ('http://example.com:443/page.html', 'http://scrapy.org/', b'http://example.com:443/page.html'), - ('ftp://example.com/urls.zip', 'http://scrapy.org/', b'ftp://example.com/urls.zip'), - ('ftp://example.com/urls.zip', 'https://scrapy.org/', b'ftp://example.com/urls.zip'), - + ( + "http://example.com/page.html", + "https://not.example.com/", + b"http://example.com/page.html", + ), + ( + "http://example.com/page.html", + "https://scrapy.org/", + b"http://example.com/page.html", + ), + ( + "http://example.com:8080/page.html", + "https://scrapy.org/", + b"http://example.com:8080/page.html", + ), + ( + "http://example.com:80/page.html", + "http://not.example.com/", + b"http://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://scrapy.org/", + b"http://example.com/page.html", + ), + ( + "http://example.com:443/page.html", + "http://scrapy.org/", + b"http://example.com:443/page.html", + ), + ( + "ftp://example.com/urls.zip", + "http://scrapy.org/", + b"ftp://example.com/urls.zip", + ), + ( + "ftp://example.com/urls.zip", + "https://scrapy.org/", + b"ftp://example.com/urls.zip", + ), # test for user/password stripping - ('http://user:password@example.com/page.html', 'https://not.example.com/', b'http://example.com/page.html'), + ( + "http://user:password@example.com/page.html", + "https://not.example.com/", + b"http://example.com/page.html", + ), ] class MixinSameOrigin: scenarii = [ # Same origin (protocol, host, port): send referrer - ('https://example.com/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('https://example.com:443/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com:80/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com:80/not-page.html', b'http://example.com/page.html'), ( - 'http://example.com:8888/page.html', - 'http://example.com:8888/not-page.html', - b'http://example.com:8888/page.html', + "https://example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", ), - - # Different host: do NOT send referrer - ('https://example.com/page.html', 'https://not.example.com/otherpage.html', None), - ('http://example.com/page.html', 'http://not.example.com/otherpage.html', None), - ('http://example.com/page.html', 'http://www.example.com/otherpage.html', None), - - # Different port: do NOT send referrer - ('https://example.com:444/page.html', 'https://example.com/not-page.html', None), - ('http://example.com:81/page.html', 'http://example.com/not-page.html', None), - ('http://example.com/page.html', 'http://example.com:81/not-page.html', None), - - # Different protocols: do NOT send refferer - ('https://example.com/page.html', 'http://example.com/not-page.html', None), - ('https://example.com/page.html', 'http://not.example.com/', None), - ('ftps://example.com/urls.zip', 'https://example.com/not-page.html', None), - ('ftp://example.com/urls.zip', 'http://example.com/not-page.html', None), - ('ftps://example.com/urls.zip', 'https://example.com/not-page.html', None), - - # test for user/password stripping - ('https://user:password@example.com/page.html', 'http://example.com/not-page.html', None), ( - 'https://user:password@example.com/page.html', - 'https://example.com/not-page.html', - b'https://example.com/page.html', + "http://example.com/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "https://example.com:443/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", + ), + ( + "http://example.com:80/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://example.com:80/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com:8888/page.html", + "http://example.com:8888/not-page.html", + b"http://example.com:8888/page.html", + ), + # Different host: do NOT send referrer + ( + "https://example.com/page.html", + "https://not.example.com/otherpage.html", + None, + ), + ("http://example.com/page.html", "http://not.example.com/otherpage.html", None), + ("http://example.com/page.html", "http://www.example.com/otherpage.html", None), + # Different port: do NOT send referrer + ( + "https://example.com:444/page.html", + "https://example.com/not-page.html", + None, + ), + ("http://example.com:81/page.html", "http://example.com/not-page.html", None), + ("http://example.com/page.html", "http://example.com:81/not-page.html", None), + # Different protocols: do NOT send refferer + ("https://example.com/page.html", "http://example.com/not-page.html", None), + ("https://example.com/page.html", "http://not.example.com/", None), + ("ftps://example.com/urls.zip", "https://example.com/not-page.html", None), + ("ftp://example.com/urls.zip", "http://example.com/not-page.html", None), + ("ftps://example.com/urls.zip", "https://example.com/not-page.html", None), + # test for user/password stripping + ( + "https://user:password@example.com/page.html", + "http://example.com/not-page.html", + None, + ), + ( + "https://user:password@example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", ), ] @@ -167,78 +250,158 @@ class MixinSameOrigin: class MixinOrigin: scenarii = [ # TLS or non-TLS to TLS or non-TLS: referrer origin is sent (yes, even for downgrades) - ('https://example.com/page.html', 'https://example.com/not-page.html', b'https://example.com/'), - ('https://example.com/page.html', 'https://scrapy.org', b'https://example.com/'), - ('https://example.com/page.html', 'http://scrapy.org', b'https://example.com/'), - ('http://example.com/page.html', 'http://scrapy.org', b'http://example.com/'), - + ( + "https://example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/", + ), + ( + "https://example.com/page.html", + "https://scrapy.org", + b"https://example.com/", + ), + ("https://example.com/page.html", "http://scrapy.org", b"https://example.com/"), + ("http://example.com/page.html", "http://scrapy.org", b"http://example.com/"), # test for user/password stripping - ('https://user:password@example.com/page.html', 'http://scrapy.org', b'https://example.com/'), + ( + "https://user:password@example.com/page.html", + "http://scrapy.org", + b"https://example.com/", + ), ] class MixinStrictOrigin: scenarii = [ # TLS or non-TLS to TLS or non-TLS: referrer origin is sent but not for downgrades - ('https://example.com/page.html', 'https://example.com/not-page.html', b'https://example.com/'), - ('https://example.com/page.html', 'https://scrapy.org', b'https://example.com/'), - ('http://example.com/page.html', 'http://scrapy.org', b'http://example.com/'), - + ( + "https://example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/", + ), + ( + "https://example.com/page.html", + "https://scrapy.org", + b"https://example.com/", + ), + ("http://example.com/page.html", "http://scrapy.org", b"http://example.com/"), # downgrade: send nothing - ('https://example.com/page.html', 'http://scrapy.org', None), - + ("https://example.com/page.html", "http://scrapy.org", None), # upgrade: send origin - ('http://example.com/page.html', 'https://scrapy.org', b'http://example.com/'), - + ("http://example.com/page.html", "https://scrapy.org", b"http://example.com/"), # test for user/password stripping - ('https://user:password@example.com/page.html', 'https://scrapy.org', b'https://example.com/'), - ('https://user:password@example.com/page.html', 'http://scrapy.org', None), + ( + "https://user:password@example.com/page.html", + "https://scrapy.org", + b"https://example.com/", + ), + ("https://user:password@example.com/page.html", "http://scrapy.org", None), ] class MixinOriginWhenCrossOrigin: scenarii = [ # Same origin (protocol, host, port): send referrer - ('https://example.com/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('https://example.com:443/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com:80/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com:80/not-page.html', b'http://example.com/page.html'), ( - 'http://example.com:8888/page.html', - 'http://example.com:8888/not-page.html', - b'http://example.com:8888/page.html', + "https://example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "https://example.com:443/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", + ), + ( + "http://example.com:80/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://example.com:80/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com:8888/page.html", + "http://example.com:8888/not-page.html", + b"http://example.com:8888/page.html", ), - # Different host: send origin as referrer - ('https://example2.com/page.html', 'https://scrapy.org/otherpage.html', b'https://example2.com/'), - ('https://example2.com/page.html', 'https://not.example2.com/otherpage.html', b'https://example2.com/'), - ('http://example2.com/page.html', 'http://not.example2.com/otherpage.html', b'http://example2.com/'), + ( + "https://example2.com/page.html", + "https://scrapy.org/otherpage.html", + b"https://example2.com/", + ), + ( + "https://example2.com/page.html", + "https://not.example2.com/otherpage.html", + b"https://example2.com/", + ), + ( + "http://example2.com/page.html", + "http://not.example2.com/otherpage.html", + b"http://example2.com/", + ), # exact match required - ('http://example2.com/page.html', 'http://www.example2.com/otherpage.html', b'http://example2.com/'), - + ( + "http://example2.com/page.html", + "http://www.example2.com/otherpage.html", + b"http://example2.com/", + ), # Different port: send origin as referrer - ('https://example3.com:444/page.html', 'https://example3.com/not-page.html', b'https://example3.com:444/'), - ('http://example3.com:81/page.html', 'http://example3.com/not-page.html', b'http://example3.com:81/'), - + ( + "https://example3.com:444/page.html", + "https://example3.com/not-page.html", + b"https://example3.com:444/", + ), + ( + "http://example3.com:81/page.html", + "http://example3.com/not-page.html", + b"http://example3.com:81/", + ), # Different protocols: send origin as referrer - ('https://example4.com/page.html', 'http://example4.com/not-page.html', b'https://example4.com/'), - ('https://example4.com/page.html', 'http://not.example4.com/', b'https://example4.com/'), - ('ftps://example4.com/urls.zip', 'https://example4.com/not-page.html', b'ftps://example4.com/'), - ('ftp://example4.com/urls.zip', 'http://example4.com/not-page.html', b'ftp://example4.com/'), - ('ftps://example4.com/urls.zip', 'https://example4.com/not-page.html', b'ftps://example4.com/'), - + ( + "https://example4.com/page.html", + "http://example4.com/not-page.html", + b"https://example4.com/", + ), + ( + "https://example4.com/page.html", + "http://not.example4.com/", + b"https://example4.com/", + ), + ( + "ftps://example4.com/urls.zip", + "https://example4.com/not-page.html", + b"ftps://example4.com/", + ), + ( + "ftp://example4.com/urls.zip", + "http://example4.com/not-page.html", + b"ftp://example4.com/", + ), + ( + "ftps://example4.com/urls.zip", + "https://example4.com/not-page.html", + b"ftps://example4.com/", + ), # test for user/password stripping ( - 'https://user:password@example5.com/page.html', - 'https://example5.com/not-page.html', - b'https://example5.com/page.html', + "https://user:password@example5.com/page.html", + "https://example5.com/not-page.html", + b"https://example5.com/page.html", ), # TLS to non-TLS downgrade: send origin ( - 'https://user:password@example5.com/page.html', - 'http://example5.com/not-page.html', - b'https://example5.com/', + "https://user:password@example5.com/page.html", + "http://example5.com/not-page.html", + b"https://example5.com/", ), ] @@ -246,90 +409,215 @@ class MixinOriginWhenCrossOrigin: class MixinStrictOriginWhenCrossOrigin: scenarii = [ # Same origin (protocol, host, port): send referrer - ('https://example.com/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('https://example.com:443/page.html', 'https://example.com/not-page.html', b'https://example.com/page.html'), - ('http://example.com:80/page.html', 'http://example.com/not-page.html', b'http://example.com/page.html'), - ('http://example.com/page.html', 'http://example.com:80/not-page.html', b'http://example.com/page.html'), ( - 'http://example.com:8888/page.html', - 'http://example.com:8888/not-page.html', - b'http://example.com:8888/page.html', + "https://example.com/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "https://example.com:443/page.html", + "https://example.com/not-page.html", + b"https://example.com/page.html", + ), + ( + "http://example.com:80/page.html", + "http://example.com/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com/page.html", + "http://example.com:80/not-page.html", + b"http://example.com/page.html", + ), + ( + "http://example.com:8888/page.html", + "http://example.com:8888/not-page.html", + b"http://example.com:8888/page.html", ), - # Different host: send origin as referrer - ('https://example2.com/page.html', 'https://scrapy.org/otherpage.html', b'https://example2.com/'), - ('https://example2.com/page.html', 'https://not.example2.com/otherpage.html', b'https://example2.com/'), - ('http://example2.com/page.html', 'http://not.example2.com/otherpage.html', b'http://example2.com/'), + ( + "https://example2.com/page.html", + "https://scrapy.org/otherpage.html", + b"https://example2.com/", + ), + ( + "https://example2.com/page.html", + "https://not.example2.com/otherpage.html", + b"https://example2.com/", + ), + ( + "http://example2.com/page.html", + "http://not.example2.com/otherpage.html", + b"http://example2.com/", + ), # exact match required - ('http://example2.com/page.html', 'http://www.example2.com/otherpage.html', b'http://example2.com/'), - + ( + "http://example2.com/page.html", + "http://www.example2.com/otherpage.html", + b"http://example2.com/", + ), # Different port: send origin as referrer - ('https://example3.com:444/page.html', 'https://example3.com/not-page.html', b'https://example3.com:444/'), - ('http://example3.com:81/page.html', 'http://example3.com/not-page.html', b'http://example3.com:81/'), - + ( + "https://example3.com:444/page.html", + "https://example3.com/not-page.html", + b"https://example3.com:444/", + ), + ( + "http://example3.com:81/page.html", + "http://example3.com/not-page.html", + b"http://example3.com:81/", + ), # downgrade - ('https://example4.com/page.html', 'http://example4.com/not-page.html', None), - ('https://example4.com/page.html', 'http://not.example4.com/', None), - + ("https://example4.com/page.html", "http://example4.com/not-page.html", None), + ("https://example4.com/page.html", "http://not.example4.com/", None), # non-TLS to non-TLS - ('ftp://example4.com/urls.zip', 'http://example4.com/not-page.html', b'ftp://example4.com/'), - + ( + "ftp://example4.com/urls.zip", + "http://example4.com/not-page.html", + b"ftp://example4.com/", + ), # upgrade - ('http://example4.com/page.html', 'https://example4.com/not-page.html', b'http://example4.com/'), - ('http://example4.com/page.html', 'https://not.example4.com/', b'http://example4.com/'), - + ( + "http://example4.com/page.html", + "https://example4.com/not-page.html", + b"http://example4.com/", + ), + ( + "http://example4.com/page.html", + "https://not.example4.com/", + b"http://example4.com/", + ), # Different protocols: send origin as referrer - ('ftps://example4.com/urls.zip', 'https://example4.com/not-page.html', b'ftps://example4.com/'), - ('ftps://example4.com/urls.zip', 'https://example4.com/not-page.html', b'ftps://example4.com/'), - + ( + "ftps://example4.com/urls.zip", + "https://example4.com/not-page.html", + b"ftps://example4.com/", + ), + ( + "ftps://example4.com/urls.zip", + "https://example4.com/not-page.html", + b"ftps://example4.com/", + ), # test for user/password stripping ( - 'https://user:password@example5.com/page.html', - 'https://example5.com/not-page.html', - b'https://example5.com/page.html', + "https://user:password@example5.com/page.html", + "https://example5.com/not-page.html", + b"https://example5.com/page.html", ), - # TLS to non-TLS downgrade: send nothing - ('https://user:password@example5.com/page.html', 'http://example5.com/not-page.html', None), + ( + "https://user:password@example5.com/page.html", + "http://example5.com/not-page.html", + None, + ), ] class MixinUnsafeUrl: scenarii = [ # TLS to TLS: send referrer - ('https://example.com/sekrit.html', 'http://not.example.com/', b'https://example.com/sekrit.html'), - ('https://example1.com/page.html', 'https://not.example1.com/', b'https://example1.com/page.html'), - ('https://example1.com/page.html', 'https://scrapy.org/', b'https://example1.com/page.html'), - ('https://example1.com:443/page.html', 'https://scrapy.org/', b'https://example1.com/page.html'), - ('https://example1.com:444/page.html', 'https://scrapy.org/', b'https://example1.com:444/page.html'), - ('ftps://example1.com/urls.zip', 'https://scrapy.org/', b'ftps://example1.com/urls.zip'), - - # TLS to non-TLS: send referrer (yes, it's unsafe) - ('https://example2.com/page.html', 'http://not.example2.com/', b'https://example2.com/page.html'), - ('https://example2.com/page.html', 'http://scrapy.org/', b'https://example2.com/page.html'), - ('ftps://example2.com/urls.zip', 'http://scrapy.org/', b'ftps://example2.com/urls.zip'), - - # non-TLS to TLS or non-TLS: send referrer (yes, it's unsafe) - ('http://example3.com/page.html', 'https://not.example3.com/', b'http://example3.com/page.html'), - ('http://example3.com/page.html', 'https://scrapy.org/', b'http://example3.com/page.html'), - ('http://example3.com:8080/page.html', 'https://scrapy.org/', b'http://example3.com:8080/page.html'), - ('http://example3.com:80/page.html', 'http://not.example3.com/', b'http://example3.com/page.html'), - ('http://example3.com/page.html', 'http://scrapy.org/', b'http://example3.com/page.html'), - ('http://example3.com:443/page.html', 'http://scrapy.org/', b'http://example3.com:443/page.html'), - ('ftp://example3.com/urls.zip', 'http://scrapy.org/', b'ftp://example3.com/urls.zip'), - ('ftp://example3.com/urls.zip', 'https://scrapy.org/', b'ftp://example3.com/urls.zip'), - - # test for user/password stripping ( - 'http://user:password@example4.com/page.html', - 'https://not.example4.com/', - b'http://example4.com/page.html', + "https://example.com/sekrit.html", + "http://not.example.com/", + b"https://example.com/sekrit.html", ), ( - 'https://user:password@example4.com/page.html', - 'http://scrapy.org/', - b'https://example4.com/page.html', + "https://example1.com/page.html", + "https://not.example1.com/", + b"https://example1.com/page.html", + ), + ( + "https://example1.com/page.html", + "https://scrapy.org/", + b"https://example1.com/page.html", + ), + ( + "https://example1.com:443/page.html", + "https://scrapy.org/", + b"https://example1.com/page.html", + ), + ( + "https://example1.com:444/page.html", + "https://scrapy.org/", + b"https://example1.com:444/page.html", + ), + ( + "ftps://example1.com/urls.zip", + "https://scrapy.org/", + b"ftps://example1.com/urls.zip", + ), + # TLS to non-TLS: send referrer (yes, it's unsafe) + ( + "https://example2.com/page.html", + "http://not.example2.com/", + b"https://example2.com/page.html", + ), + ( + "https://example2.com/page.html", + "http://scrapy.org/", + b"https://example2.com/page.html", + ), + ( + "ftps://example2.com/urls.zip", + "http://scrapy.org/", + b"ftps://example2.com/urls.zip", + ), + # non-TLS to TLS or non-TLS: send referrer (yes, it's unsafe) + ( + "http://example3.com/page.html", + "https://not.example3.com/", + b"http://example3.com/page.html", + ), + ( + "http://example3.com/page.html", + "https://scrapy.org/", + b"http://example3.com/page.html", + ), + ( + "http://example3.com:8080/page.html", + "https://scrapy.org/", + b"http://example3.com:8080/page.html", + ), + ( + "http://example3.com:80/page.html", + "http://not.example3.com/", + b"http://example3.com/page.html", + ), + ( + "http://example3.com/page.html", + "http://scrapy.org/", + b"http://example3.com/page.html", + ), + ( + "http://example3.com:443/page.html", + "http://scrapy.org/", + b"http://example3.com:443/page.html", + ), + ( + "ftp://example3.com/urls.zip", + "http://scrapy.org/", + b"ftp://example3.com/urls.zip", + ), + ( + "ftp://example3.com/urls.zip", + "https://scrapy.org/", + b"ftp://example3.com/urls.zip", + ), + # test for user/password stripping + ( + "http://user:password@example4.com/page.html", + "https://not.example4.com/", + b"http://example4.com/page.html", + ), + ( + "https://user:password@example4.com/page.html", + "http://scrapy.org/", + b"https://example4.com/page.html", ), ] @@ -340,35 +628,49 @@ class TestRefererMiddlewareDefault(MixinDefault, TestRefererMiddleware): # --- Tests using settings to set policy using class path class TestSettingsNoReferrer(MixinNoReferrer, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.NoReferrerPolicy'} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerPolicy"} -class TestSettingsNoReferrerWhenDowngrade(MixinNoReferrerWhenDowngrade, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy'} +class TestSettingsNoReferrerWhenDowngrade( + MixinNoReferrerWhenDowngrade, TestRefererMiddleware +): + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" + } class TestSettingsSameOrigin(MixinSameOrigin, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.SameOriginPolicy'} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.SameOriginPolicy"} class TestSettingsOrigin(MixinOrigin, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginPolicy'} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginPolicy"} class TestSettingsStrictOrigin(MixinStrictOrigin, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.StrictOriginPolicy'} + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.StrictOriginPolicy" + } -class TestSettingsOriginWhenCrossOrigin(MixinOriginWhenCrossOrigin, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy'} +class TestSettingsOriginWhenCrossOrigin( + MixinOriginWhenCrossOrigin, TestRefererMiddleware +): + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" + } -class TestSettingsStrictOriginWhenCrossOrigin(MixinStrictOriginWhenCrossOrigin, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.StrictOriginWhenCrossOriginPolicy'} +class TestSettingsStrictOriginWhenCrossOrigin( + MixinStrictOriginWhenCrossOrigin, TestRefererMiddleware +): + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.StrictOriginWhenCrossOriginPolicy" + } class TestSettingsUnsafeUrl(MixinUnsafeUrl, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.UnsafeUrlPolicy'} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.UnsafeUrlPolicy"} class CustomPythonOrgPolicy(ReferrerPolicy): @@ -376,77 +678,95 @@ class CustomPythonOrgPolicy(ReferrerPolicy): A dummy policy that returns referrer as http(s)://python.org depending on the scheme of the target URL. """ + def referrer(self, response, request): scheme = urlparse(request).scheme - if scheme == 'https': - return b'https://python.org/' - if scheme == 'http': - return b'http://python.org/' + if scheme == "https": + return b"https://python.org/" + if scheme == "http": + return b"http://python.org/" class TestSettingsCustomPolicy(TestRefererMiddleware): - settings = {'REFERRER_POLICY': CustomPythonOrgPolicy} + settings = {"REFERRER_POLICY": CustomPythonOrgPolicy} scenarii = [ - ('https://example.com/', 'https://scrapy.org/', b'https://python.org/'), - ('http://example.com/', 'http://scrapy.org/', b'http://python.org/'), - ('http://example.com/', 'https://scrapy.org/', b'https://python.org/'), - ('https://example.com/', 'http://scrapy.org/', b'http://python.org/'), - ('file:///home/path/to/somefile.html', 'https://scrapy.org/', b'https://python.org/'), - ('file:///home/path/to/somefile.html', 'http://scrapy.org/', b'http://python.org/'), - + ("https://example.com/", "https://scrapy.org/", b"https://python.org/"), + ("http://example.com/", "http://scrapy.org/", b"http://python.org/"), + ("http://example.com/", "https://scrapy.org/", b"https://python.org/"), + ("https://example.com/", "http://scrapy.org/", b"http://python.org/"), + ( + "file:///home/path/to/somefile.html", + "https://scrapy.org/", + b"https://python.org/", + ), + ( + "file:///home/path/to/somefile.html", + "http://scrapy.org/", + b"http://python.org/", + ), ] # --- Tests using Request meta dict to set policy class TestRequestMetaDefault(MixinDefault, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_SCRAPY_DEFAULT} + req_meta = {"referrer_policy": POLICY_SCRAPY_DEFAULT} class TestRequestMetaNoReferrer(MixinNoReferrer, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_NO_REFERRER} + req_meta = {"referrer_policy": POLICY_NO_REFERRER} -class TestRequestMetaNoReferrerWhenDowngrade(MixinNoReferrerWhenDowngrade, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_NO_REFERRER_WHEN_DOWNGRADE} +class TestRequestMetaNoReferrerWhenDowngrade( + MixinNoReferrerWhenDowngrade, TestRefererMiddleware +): + req_meta = {"referrer_policy": POLICY_NO_REFERRER_WHEN_DOWNGRADE} class TestRequestMetaSameOrigin(MixinSameOrigin, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_SAME_ORIGIN} + req_meta = {"referrer_policy": POLICY_SAME_ORIGIN} class TestRequestMetaOrigin(MixinOrigin, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_ORIGIN} + req_meta = {"referrer_policy": POLICY_ORIGIN} class TestRequestMetaSrictOrigin(MixinStrictOrigin, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_STRICT_ORIGIN} + req_meta = {"referrer_policy": POLICY_STRICT_ORIGIN} -class TestRequestMetaOriginWhenCrossOrigin(MixinOriginWhenCrossOrigin, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_ORIGIN_WHEN_CROSS_ORIGIN} +class TestRequestMetaOriginWhenCrossOrigin( + MixinOriginWhenCrossOrigin, TestRefererMiddleware +): + req_meta = {"referrer_policy": POLICY_ORIGIN_WHEN_CROSS_ORIGIN} -class TestRequestMetaStrictOriginWhenCrossOrigin(MixinStrictOriginWhenCrossOrigin, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN} +class TestRequestMetaStrictOriginWhenCrossOrigin( + MixinStrictOriginWhenCrossOrigin, TestRefererMiddleware +): + req_meta = {"referrer_policy": POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN} class TestRequestMetaUnsafeUrl(MixinUnsafeUrl, TestRefererMiddleware): - req_meta = {'referrer_policy': POLICY_UNSAFE_URL} + req_meta = {"referrer_policy": POLICY_UNSAFE_URL} class TestRequestMetaPredecence001(MixinUnsafeUrl, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.SameOriginPolicy'} - req_meta = {'referrer_policy': POLICY_UNSAFE_URL} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.SameOriginPolicy"} + req_meta = {"referrer_policy": POLICY_UNSAFE_URL} class TestRequestMetaPredecence002(MixinNoReferrer, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy'} - req_meta = {'referrer_policy': POLICY_NO_REFERRER} + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" + } + req_meta = {"referrer_policy": POLICY_NO_REFERRER} class TestRequestMetaPredecence003(MixinUnsafeUrl, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy'} - req_meta = {'referrer_policy': POLICY_UNSAFE_URL} + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" + } + req_meta = {"referrer_policy": POLICY_UNSAFE_URL} class TestRequestMetaSettingFallback(TestCase): @@ -456,57 +776,65 @@ class TestRequestMetaSettingFallback(TestCase): # When an unknown policy is referenced in Request.meta # (here, a typo error), # the policy defined in settings takes precedence - {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy'}, + { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" + }, {}, - {'referrer_policy': 'ssscrapy-default'}, + {"referrer_policy": "ssscrapy-default"}, OriginWhenCrossOriginPolicy, - True + True, ), ( # same as above but with string value for settings policy - {'REFERRER_POLICY': 'origin-when-cross-origin'}, + {"REFERRER_POLICY": "origin-when-cross-origin"}, {}, - {'referrer_policy': 'ssscrapy-default'}, + {"referrer_policy": "ssscrapy-default"}, OriginWhenCrossOriginPolicy, - True + True, ), ( # request meta references a wrong policy but it is set, # so the Referrer-Policy header in response is not used, # and the settings' policy is applied - {'REFERRER_POLICY': 'origin-when-cross-origin'}, - {'Referrer-Policy': 'unsafe-url'}, - {'referrer_policy': 'ssscrapy-default'}, + {"REFERRER_POLICY": "origin-when-cross-origin"}, + {"Referrer-Policy": "unsafe-url"}, + {"referrer_policy": "ssscrapy-default"}, OriginWhenCrossOriginPolicy, - True + True, ), ( # here, request meta does not set the policy # so response headers take precedence - {'REFERRER_POLICY': 'origin-when-cross-origin'}, - {'Referrer-Policy': 'unsafe-url'}, + {"REFERRER_POLICY": "origin-when-cross-origin"}, + {"Referrer-Policy": "unsafe-url"}, {}, UnsafeUrlPolicy, - False + False, ), ( # here, request meta does not set the policy, # but response headers also use an unknown policy, # so the settings' policy is used - {'REFERRER_POLICY': 'origin-when-cross-origin'}, - {'Referrer-Policy': 'unknown'}, + {"REFERRER_POLICY": "origin-when-cross-origin"}, + {"Referrer-Policy": "unknown"}, {}, OriginWhenCrossOriginPolicy, - True - ) + True, + ), ] def test(self): - origin = 'http://www.scrapy.org' - target = 'http://www.example.com' + origin = "http://www.scrapy.org" + target = "http://www.example.com" - for settings, response_headers, request_meta, policy_class, check_warning in self.params[3:]: + for ( + settings, + response_headers, + request_meta, + policy_class, + check_warning, + ) in self.params[3:]: mw = RefererMiddleware(Settings(settings)) response = Response(origin, headers=response_headers) @@ -522,7 +850,6 @@ class TestRequestMetaSettingFallback(TestCase): class TestSettingsPolicyByName(TestCase): - def test_valid_name(self): for s, p in [ (POLICY_SCRAPY_DEFAULT, DefaultReferrerPolicy), @@ -535,7 +862,7 @@ class TestSettingsPolicyByName(TestCase): (POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN, StrictOriginWhenCrossOriginPolicy), (POLICY_UNSAFE_URL, UnsafeUrlPolicy), ]: - settings = Settings({'REFERRER_POLICY': s}) + settings = Settings({"REFERRER_POLICY": s}) mw = RefererMiddleware(settings) self.assertEqual(mw.default_policy, p) @@ -551,98 +878,121 @@ class TestSettingsPolicyByName(TestCase): (POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN, StrictOriginWhenCrossOriginPolicy), (POLICY_UNSAFE_URL, UnsafeUrlPolicy), ]: - settings = Settings({'REFERRER_POLICY': s.upper()}) + settings = Settings({"REFERRER_POLICY": s.upper()}) mw = RefererMiddleware(settings) self.assertEqual(mw.default_policy, p) def test_invalid_name(self): - settings = Settings({'REFERRER_POLICY': 'some-custom-unknown-policy'}) + settings = Settings({"REFERRER_POLICY": "some-custom-unknown-policy"}) with self.assertRaises(RuntimeError): RefererMiddleware(settings) class TestPolicyHeaderPredecence001(MixinUnsafeUrl, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.SameOriginPolicy'} - resp_headers = {'Referrer-Policy': POLICY_UNSAFE_URL.upper()} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.SameOriginPolicy"} + resp_headers = {"Referrer-Policy": POLICY_UNSAFE_URL.upper()} class TestPolicyHeaderPredecence002(MixinNoReferrer, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy'} - resp_headers = {'Referrer-Policy': POLICY_NO_REFERRER.swapcase()} + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" + } + resp_headers = {"Referrer-Policy": POLICY_NO_REFERRER.swapcase()} -class TestPolicyHeaderPredecence003(MixinNoReferrerWhenDowngrade, TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy'} - resp_headers = {'Referrer-Policy': POLICY_NO_REFERRER_WHEN_DOWNGRADE.title()} +class TestPolicyHeaderPredecence003( + MixinNoReferrerWhenDowngrade, TestRefererMiddleware +): + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" + } + resp_headers = {"Referrer-Policy": POLICY_NO_REFERRER_WHEN_DOWNGRADE.title()} -class TestPolicyHeaderPredecence004(MixinNoReferrerWhenDowngrade, TestRefererMiddleware): +class TestPolicyHeaderPredecence004( + MixinNoReferrerWhenDowngrade, TestRefererMiddleware +): """ The empty string means "no-referrer-when-downgrade" """ - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy'} - resp_headers = {'Referrer-Policy': ''} + + settings = { + "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" + } + resp_headers = {"Referrer-Policy": ""} class TestReferrerOnRedirect(TestRefererMiddleware): - settings = {'REFERRER_POLICY': 'scrapy.spidermiddlewares.referer.UnsafeUrlPolicy'} + settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.UnsafeUrlPolicy"} scenarii = [ ( - 'http://scrapytest.org/1', # parent - 'http://scrapytest.org/2', # target + "http://scrapytest.org/1", # parent + "http://scrapytest.org/2", # target ( # redirections: code, URL - (301, 'http://scrapytest.org/3'), - (301, 'http://scrapytest.org/4'), + (301, "http://scrapytest.org/3"), + (301, "http://scrapytest.org/4"), ), - b'http://scrapytest.org/1', # expected initial referer - b'http://scrapytest.org/1', # expected referer for the redirection request + b"http://scrapytest.org/1", # expected initial referer + b"http://scrapytest.org/1", # expected referer for the redirection request ), ( - 'https://scrapytest.org/1', - 'https://scrapytest.org/2', + "https://scrapytest.org/1", + "https://scrapytest.org/2", ( # redirecting to non-secure URL - (301, 'http://scrapytest.org/3'), + (301, "http://scrapytest.org/3"), ), - b'https://scrapytest.org/1', - b'https://scrapytest.org/1', + b"https://scrapytest.org/1", + b"https://scrapytest.org/1", ), ( - 'https://scrapytest.org/1', - 'https://scrapytest.com/2', + "https://scrapytest.org/1", + "https://scrapytest.com/2", ( # redirecting to non-secure URL: different origin - (301, 'http://scrapytest.com/3'), + (301, "http://scrapytest.com/3"), ), - b'https://scrapytest.org/1', - b'https://scrapytest.org/1', + b"https://scrapytest.org/1", + b"https://scrapytest.org/1", ), ] def setUp(self): - self.spider = Spider('foo') + self.spider = Spider("foo") settings = Settings(self.settings) self.referrermw = RefererMiddleware(settings) self.redirectmw = RedirectMiddleware(settings) def test(self): - for parent, target, redirections, init_referrer, final_referrer in self.scenarii: + for ( + parent, + target, + redirections, + init_referrer, + final_referrer, + ) in self.scenarii: response = self.get_response(parent) request = self.get_request(target) - out = list(self.referrermw.process_spider_output(response, [request], self.spider)) - self.assertEqual(out[0].headers.get('Referer'), init_referrer) + out = list( + self.referrermw.process_spider_output(response, [request], self.spider) + ) + self.assertEqual(out[0].headers.get("Referer"), init_referrer) for status, url in redirections: - response = Response(request.url, headers={'Location': url}, status=status) - request = self.redirectmw.process_response(request, response, self.spider) + response = Response( + request.url, headers={"Location": url}, status=status + ) + request = self.redirectmw.process_response( + request, response, self.spider + ) self.referrermw.request_scheduled(request, self.spider) assert isinstance(request, Request) - self.assertEqual(request.headers.get('Referer'), final_referrer) + self.assertEqual(request.headers.get("Referer"), final_referrer) class TestReferrerOnRedirectNoReferrer(TestReferrerOnRedirect): @@ -650,34 +1000,31 @@ class TestReferrerOnRedirectNoReferrer(TestReferrerOnRedirect): No Referrer policy never sets the "Referer" header. HTTP redirections should not change that. """ - settings = {'REFERRER_POLICY': 'no-referrer'} + + settings = {"REFERRER_POLICY": "no-referrer"} scenarii = [ ( - 'http://scrapytest.org/1', # parent - 'http://scrapytest.org/2', # target + "http://scrapytest.org/1", # parent + "http://scrapytest.org/2", # target ( # redirections: code, URL - (301, 'http://scrapytest.org/3'), - (301, 'http://scrapytest.org/4'), + (301, "http://scrapytest.org/3"), + (301, "http://scrapytest.org/4"), ), None, # expected initial "Referer" None, # expected "Referer" for the redirection request ), ( - 'https://scrapytest.org/1', - 'https://scrapytest.org/2', - ( - (301, 'http://scrapytest.org/3'), - ), + "https://scrapytest.org/1", + "https://scrapytest.org/2", + ((301, "http://scrapytest.org/3"),), None, None, ), ( - 'https://scrapytest.org/1', - 'https://example.com/2', # different origin - ( - (301, 'http://scrapytest.com/3'), - ), + "https://scrapytest.org/1", + "https://example.com/2", # different origin + ((301, "http://scrapytest.com/3"),), None, None, ), @@ -692,37 +1039,38 @@ class TestReferrerOnRedirectSameOrigin(TestReferrerOnRedirect): HTTP redirections to a different domain or a lower secure level should have the "Referer" removed. """ - settings = {'REFERRER_POLICY': 'same-origin'} + + settings = {"REFERRER_POLICY": "same-origin"} scenarii = [ ( - 'http://scrapytest.org/101', # origin - 'http://scrapytest.org/102', # target + "http://scrapytest.org/101", # origin + "http://scrapytest.org/102", # target ( # redirections: code, URL - (301, 'http://scrapytest.org/103'), - (301, 'http://scrapytest.org/104'), + (301, "http://scrapytest.org/103"), + (301, "http://scrapytest.org/104"), ), - b'http://scrapytest.org/101', # expected initial "Referer" - b'http://scrapytest.org/101', # expected referer for the redirection request + b"http://scrapytest.org/101", # expected initial "Referer" + b"http://scrapytest.org/101", # expected referer for the redirection request ), ( - 'https://scrapytest.org/201', - 'https://scrapytest.org/202', + "https://scrapytest.org/201", + "https://scrapytest.org/202", ( # redirecting from secure to non-secure URL == different origin - (301, 'http://scrapytest.org/203'), + (301, "http://scrapytest.org/203"), ), - b'https://scrapytest.org/201', + b"https://scrapytest.org/201", None, ), ( - 'https://scrapytest.org/301', - 'https://scrapytest.org/302', + "https://scrapytest.org/301", + "https://scrapytest.org/302", ( # different domain == different origin - (301, 'http://example.com/303'), + (301, "http://example.com/303"), ), - b'https://scrapytest.org/301', + b"https://scrapytest.org/301", None, ), ] @@ -737,63 +1085,65 @@ class TestReferrerOnRedirectStrictOrigin(TestReferrerOnRedirect): Redirections from secure to non-secure URLs should have the "Referrer" header removed if necessary. """ - settings = {'REFERRER_POLICY': POLICY_STRICT_ORIGIN} + + settings = {"REFERRER_POLICY": POLICY_STRICT_ORIGIN} scenarii = [ ( - 'http://scrapytest.org/101', - 'http://scrapytest.org/102', + "http://scrapytest.org/101", + "http://scrapytest.org/102", ( - (301, 'http://scrapytest.org/103'), - (301, 'http://scrapytest.org/104'), + (301, "http://scrapytest.org/103"), + (301, "http://scrapytest.org/104"), ), - b'http://scrapytest.org/', # send origin - b'http://scrapytest.org/', # redirects to same origin: send origin + b"http://scrapytest.org/", # send origin + b"http://scrapytest.org/", # redirects to same origin: send origin ), ( - 'https://scrapytest.org/201', - 'https://scrapytest.org/202', + "https://scrapytest.org/201", + "https://scrapytest.org/202", ( # redirecting to non-secure URL: no referrer - (301, 'http://scrapytest.org/203'), + (301, "http://scrapytest.org/203"), ), - b'https://scrapytest.org/', + b"https://scrapytest.org/", None, ), ( - 'https://scrapytest.org/301', - 'https://scrapytest.org/302', + "https://scrapytest.org/301", + "https://scrapytest.org/302", ( # redirecting to non-secure URL (different domain): no referrer - (301, 'http://example.com/303'), + (301, "http://example.com/303"), ), - b'https://scrapytest.org/', + b"https://scrapytest.org/", None, ), ( - 'http://scrapy.org/401', - 'http://example.com/402', - ( - (301, 'http://scrapytest.org/403'), - ), - b'http://scrapy.org/', - b'http://scrapy.org/', + "http://scrapy.org/401", + "http://example.com/402", + ((301, "http://scrapytest.org/403"),), + b"http://scrapy.org/", + b"http://scrapy.org/", ), ( - 'https://scrapy.org/501', - 'https://example.com/502', + "https://scrapy.org/501", + "https://example.com/502", ( # HTTPS all along, so origin referrer is kept as-is - (301, 'https://google.com/503'), - (301, 'https://facebook.com/504'), + (301, "https://google.com/503"), + (301, "https://facebook.com/504"), ), - b'https://scrapy.org/', - b'https://scrapy.org/', + b"https://scrapy.org/", + b"https://scrapy.org/", ), ( - 'https://scrapytest.org/601', - 'http://scrapytest.org/602', # TLS to non-TLS: no referrer + "https://scrapytest.org/601", + "http://scrapytest.org/602", # TLS to non-TLS: no referrer ( - (301, 'https://scrapytest.org/603'), # TLS URL again: (still) no referrer + ( + 301, + "https://scrapytest.org/603", + ), # TLS URL again: (still) no referrer ), None, None, @@ -810,67 +1160,64 @@ class TestReferrerOnRedirectOriginWhenCrossOrigin(TestReferrerOnRedirect): Redirections to a different origin should strip the "Referer" to the parent origin. """ - settings = {'REFERRER_POLICY': POLICY_ORIGIN_WHEN_CROSS_ORIGIN} + + settings = {"REFERRER_POLICY": POLICY_ORIGIN_WHEN_CROSS_ORIGIN} scenarii = [ ( - 'http://scrapytest.org/101', # origin - 'http://scrapytest.org/102', # target + redirection + "http://scrapytest.org/101", # origin + "http://scrapytest.org/102", # target + redirection ( # redirections: code, URL - (301, 'http://scrapytest.org/103'), - (301, 'http://scrapytest.org/104'), + (301, "http://scrapytest.org/103"), + (301, "http://scrapytest.org/104"), ), - b'http://scrapytest.org/101', # expected initial referer - b'http://scrapytest.org/101', # expected referer for the redirection request + b"http://scrapytest.org/101", # expected initial referer + b"http://scrapytest.org/101", # expected referer for the redirection request ), ( - 'https://scrapytest.org/201', - 'https://scrapytest.org/202', + "https://scrapytest.org/201", + "https://scrapytest.org/202", ( # redirecting to non-secure URL: send origin - (301, 'http://scrapytest.org/203'), + (301, "http://scrapytest.org/203"), ), - b'https://scrapytest.org/201', - b'https://scrapytest.org/', + b"https://scrapytest.org/201", + b"https://scrapytest.org/", ), ( - 'https://scrapytest.org/301', - 'https://scrapytest.org/302', + "https://scrapytest.org/301", + "https://scrapytest.org/302", ( # redirecting to non-secure URL (different domain): send origin - (301, 'http://example.com/303'), + (301, "http://example.com/303"), ), - b'https://scrapytest.org/301', - b'https://scrapytest.org/', + b"https://scrapytest.org/301", + b"https://scrapytest.org/", ), ( - 'http://scrapy.org/401', - 'http://example.com/402', - ( - (301, 'http://scrapytest.org/403'), - ), - b'http://scrapy.org/', - b'http://scrapy.org/', + "http://scrapy.org/401", + "http://example.com/402", + ((301, "http://scrapytest.org/403"),), + b"http://scrapy.org/", + b"http://scrapy.org/", ), ( - 'https://scrapy.org/501', - 'https://example.com/502', + "https://scrapy.org/501", + "https://example.com/502", ( # all different domains: send origin - (301, 'https://google.com/503'), - (301, 'https://facebook.com/504'), + (301, "https://google.com/503"), + (301, "https://facebook.com/504"), ), - b'https://scrapy.org/', - b'https://scrapy.org/', + b"https://scrapy.org/", + b"https://scrapy.org/", ), ( - 'https://scrapytest.org/301', - 'http://scrapytest.org/302', # TLS to non-TLS: send origin - ( - (301, 'https://scrapytest.org/303'), # TLS URL again: send origin (also) - ), - b'https://scrapytest.org/', - b'https://scrapytest.org/', + "https://scrapytest.org/301", + "http://scrapytest.org/302", # TLS to non-TLS: send origin + ((301, "https://scrapytest.org/303"),), # TLS URL again: send origin (also) + b"https://scrapytest.org/", + b"https://scrapytest.org/", ), ] @@ -886,64 +1233,66 @@ class TestReferrerOnRedirectStrictOriginWhenCrossOrigin(TestReferrerOnRedirect): Redirections to a different origin should strip the "Referer" to the parent origin, and from https:// to http:// will remove the "Referer" header. """ - settings = {'REFERRER_POLICY': POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN} + + settings = {"REFERRER_POLICY": POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN} scenarii = [ ( - 'http://scrapytest.org/101', # origin - 'http://scrapytest.org/102', # target + redirection + "http://scrapytest.org/101", # origin + "http://scrapytest.org/102", # target + redirection ( # redirections: code, URL - (301, 'http://scrapytest.org/103'), - (301, 'http://scrapytest.org/104'), + (301, "http://scrapytest.org/103"), + (301, "http://scrapytest.org/104"), ), - b'http://scrapytest.org/101', # expected initial referer - b'http://scrapytest.org/101', # expected referer for the redirection request + b"http://scrapytest.org/101", # expected initial referer + b"http://scrapytest.org/101", # expected referer for the redirection request ), ( - 'https://scrapytest.org/201', - 'https://scrapytest.org/202', + "https://scrapytest.org/201", + "https://scrapytest.org/202", ( # redirecting to non-secure URL: do not send the "Referer" header - (301, 'http://scrapytest.org/203'), + (301, "http://scrapytest.org/203"), ), - b'https://scrapytest.org/201', + b"https://scrapytest.org/201", None, ), ( - 'https://scrapytest.org/301', - 'https://scrapytest.org/302', + "https://scrapytest.org/301", + "https://scrapytest.org/302", ( # redirecting to non-secure URL (different domain): send origin - (301, 'http://example.com/303'), + (301, "http://example.com/303"), ), - b'https://scrapytest.org/301', + b"https://scrapytest.org/301", None, ), ( - 'http://scrapy.org/401', - 'http://example.com/402', - ( - (301, 'http://scrapytest.org/403'), - ), - b'http://scrapy.org/', - b'http://scrapy.org/', + "http://scrapy.org/401", + "http://example.com/402", + ((301, "http://scrapytest.org/403"),), + b"http://scrapy.org/", + b"http://scrapy.org/", ), ( - 'https://scrapy.org/501', - 'https://example.com/502', + "https://scrapy.org/501", + "https://example.com/502", ( # all different domains: send origin - (301, 'https://google.com/503'), - (301, 'https://facebook.com/504'), + (301, "https://google.com/503"), + (301, "https://facebook.com/504"), ), - b'https://scrapy.org/', - b'https://scrapy.org/', + b"https://scrapy.org/", + b"https://scrapy.org/", ), ( - 'https://scrapytest.org/601', - 'http://scrapytest.org/602', # TLS to non-TLS: do not send "Referer" + "https://scrapytest.org/601", + "http://scrapytest.org/602", # TLS to non-TLS: do not send "Referer" ( - (301, 'https://scrapytest.org/603'), # TLS URL again: (still) send nothing + ( + 301, + "https://scrapytest.org/603", + ), # TLS URL again: (still) send nothing ), None, None, diff --git a/tests/test_spidermiddleware_urllength.py b/tests/test_spidermiddleware_urllength.py index 171f4ddfd..22716bdda 100644 --- a/tests/test_spidermiddleware_urllength.py +++ b/tests/test_spidermiddleware_urllength.py @@ -10,23 +10,24 @@ from scrapy.settings import Settings class TestUrlLengthMiddleware(TestCase): - def setUp(self): self.maxlength = 25 - settings = Settings({'URLLENGTH_LIMIT': self.maxlength}) + settings = Settings({"URLLENGTH_LIMIT": self.maxlength}) crawler = get_crawler(Spider) - self.spider = crawler._create_spider('foo') + self.spider = crawler._create_spider("foo") self.stats = crawler.stats self.mw = UrlLengthMiddleware.from_settings(settings) - self.response = Response('http://scrapytest.org') - self.short_url_req = Request('http://scrapytest.org/') - self.long_url_req = Request('http://scrapytest.org/this_is_a_long_url') + self.response = Response("http://scrapytest.org") + self.short_url_req = Request("http://scrapytest.org/") + self.long_url_req = Request("http://scrapytest.org/this_is_a_long_url") self.reqs = [self.short_url_req, self.long_url_req] def process_spider_output(self): - return list(self.mw.process_spider_output(self.response, self.reqs, self.spider)) + return list( + self.mw.process_spider_output(self.response, self.reqs, self.spider) + ) def test_middleware_works(self): self.assertEqual(self.process_spider_output(), [self.short_url_req]) @@ -35,7 +36,9 @@ class TestUrlLengthMiddleware(TestCase): with LogCapture() as log: self.process_spider_output() - ric = self.stats.get_value('urllength/request_ignored_count', spider=self.spider) + ric = self.stats.get_value( + "urllength/request_ignored_count", spider=self.spider + ) self.assertEqual(ric, 1) - self.assertIn(f'Ignoring link (url length > {self.maxlength})', str(log)) + self.assertIn(f"Ignoring link (url length > {self.maxlength})", str(log)) diff --git a/tests/test_spiderstate.py b/tests/test_spiderstate.py index ab215576e..5c6dccf11 100644 --- a/tests/test_spiderstate.py +++ b/tests/test_spiderstate.py @@ -10,24 +10,23 @@ from scrapy.utils.test import get_crawler class SpiderStateTest(unittest.TestCase): - def test_store_load(self): jobdir = self.mktemp() Path(jobdir).mkdir() try: - spider = Spider(name='default') + spider = Spider(name="default") dt = datetime.now() ss = SpiderState(jobdir) ss.spider_opened(spider) - spider.state['one'] = 1 - spider.state['dt'] = dt + spider.state["one"] = 1 + spider.state["dt"] = dt ss.spider_closed(spider) - spider2 = Spider(name='default') + spider2 = Spider(name="default") ss2 = SpiderState(jobdir) ss2.spider_opened(spider2) - self.assertEqual(spider.state, {'one': 1, 'dt': dt}) + self.assertEqual(spider.state, {"one": 1, "dt": dt}) ss2.spider_closed(spider2) finally: shutil.rmtree(jobdir) @@ -35,7 +34,7 @@ class SpiderStateTest(unittest.TestCase): def test_state_attribute(self): # state attribute must be present if jobdir is not set, to provide a # consistent interface - spider = Spider(name='default') + spider = Spider(name="default") ss = SpiderState() ss.spider_opened(spider) self.assertEqual(spider.state, {}) diff --git a/tests/test_squeues.py b/tests/test_squeues.py index acc821b83..0e2441f90 100644 --- a/tests/test_squeues.py +++ b/tests/test_squeues.py @@ -31,20 +31,19 @@ def nonserializable_object_test(self): q = self.queue() self.assertRaises(ValueError, q.push, lambda x: x) # Selectors should fail (lxml.html.HtmlElement objects can't be pickled) - sel = Selector(text='

some text

') + sel = Selector(text="

some text

") self.assertRaises(ValueError, q.push, sel) class FifoDiskQueueTestMixin: - def test_serialize(self): q = self.queue() - q.push('a') + q.push("a") q.push(123) - q.push({'a': 'dict'}) - self.assertEqual(q.pop(), 'a') + q.push({"a": "dict"}) + self.assertEqual(q.pop(), "a") self.assertEqual(q.pop(), 123) - self.assertEqual(q.pop(), {'a': 'dict'}) + self.assertEqual(q.pop(), {"a": "dict"}) test_nonserializable_object = nonserializable_object_test @@ -81,7 +80,7 @@ class PickleFifoDiskQueueTest(t.FifoDiskQueueTest, FifoDiskQueueTestMixin): def test_serialize_item(self): q = self.queue() - i = TestItem(name='foo') + i = TestItem(name="foo") q.push(i) i2 = q.pop() assert isinstance(i2, TestItem) @@ -94,17 +93,17 @@ class PickleFifoDiskQueueTest(t.FifoDiskQueueTest, FifoDiskQueueTestMixin): loader2 = q.pop() assert isinstance(loader2, TestLoader) assert loader2.default_item_class is TestItem - self.assertEqual(loader2.name_out('x'), 'xx') + self.assertEqual(loader2.name_out("x"), "xx") def test_serialize_request_recursive(self): q = self.queue() - r = Request('http://www.example.com') - r.meta['request'] = r + r = Request("http://www.example.com") + r.meta["request"] = r q.push(r) r2 = q.pop() assert isinstance(r2, Request) self.assertEqual(r.url, r2.url) - assert r2.meta['request'] is r2 + assert r2.meta["request"] is r2 def test_non_pickable_object(self): q = self.queue() @@ -115,7 +114,7 @@ class PickleFifoDiskQueueTest(t.FifoDiskQueueTest, FifoDiskQueueTestMixin): self.assertIsInstance(exc.__context__, pickle.PicklingError) else: self.assertIsInstance(exc.__context__, AttributeError) - sel = Selector(text='

some text

') + sel = Selector(text="

some text

") try: q.push(sel) except ValueError as exc: @@ -139,33 +138,30 @@ class ChunkSize4PickleFifoDiskQueueTest(PickleFifoDiskQueueTest): class LifoDiskQueueTestMixin: - def test_serialize(self): q = self.queue() - q.push('a') + q.push("a") q.push(123) - q.push({'a': 'dict'}) - self.assertEqual(q.pop(), {'a': 'dict'}) + q.push({"a": "dict"}) + self.assertEqual(q.pop(), {"a": "dict"}) self.assertEqual(q.pop(), 123) - self.assertEqual(q.pop(), 'a') + self.assertEqual(q.pop(), "a") test_nonserializable_object = nonserializable_object_test class MarshalLifoDiskQueueTest(t.LifoDiskQueueTest, LifoDiskQueueTestMixin): - def queue(self): return _MarshalLifoSerializationDiskQueue(self.qpath) class PickleLifoDiskQueueTest(t.LifoDiskQueueTest, LifoDiskQueueTestMixin): - def queue(self): return _PickleLifoSerializationDiskQueue(self.qpath) def test_serialize_item(self): q = self.queue() - i = TestItem(name='foo') + i = TestItem(name="foo") q.push(i) i2 = q.pop() assert isinstance(i2, TestItem) @@ -178,14 +174,14 @@ class PickleLifoDiskQueueTest(t.LifoDiskQueueTest, LifoDiskQueueTestMixin): loader2 = q.pop() assert isinstance(loader2, TestLoader) assert loader2.default_item_class is TestItem - self.assertEqual(loader2.name_out('x'), 'xx') + self.assertEqual(loader2.name_out("x"), "xx") def test_serialize_request_recursive(self): q = self.queue() - r = Request('http://www.example.com') - r.meta['request'] = r + r = Request("http://www.example.com") + r.meta["request"] = r q.push(r) r2 = q.pop() assert isinstance(r2, Request) self.assertEqual(r.url, r2.url) - assert r2.meta['request'] is r2 + assert r2.meta["request"] is r2 diff --git a/tests/test_squeues_request.py b/tests/test_squeues_request.py index 22dafb2d2..5d9001bb0 100644 --- a/tests/test_squeues_request.py +++ b/tests/test_squeues_request.py @@ -69,7 +69,10 @@ class RequestQueueTestMixin: req = Request("http://www.example.com") q.push(req) self.assertEqual(len(q), 1) - with self.assertRaises(NotImplementedError, msg="The underlying queue class does not implement 'peek'"): + with self.assertRaises( + NotImplementedError, + msg="The underlying queue class does not implement 'peek'", + ): q.peek() self.assertEqual(q.pop().url, req.url) self.assertEqual(len(q), 0) @@ -117,7 +120,10 @@ class FifoQueueMixin(RequestQueueTestMixin): q.push(req1) q.push(req2) q.push(req3) - with self.assertRaises(NotImplementedError, msg="The underlying queue class does not implement 'peek'"): + with self.assertRaises( + NotImplementedError, + msg="The underlying queue class does not implement 'peek'", + ): q.peek() self.assertEqual(len(q), 3) self.assertEqual(q.pop().url, req1.url) @@ -170,7 +176,10 @@ class LifoQueueMixin(RequestQueueTestMixin): q.push(req1) q.push(req2) q.push(req3) - with self.assertRaises(NotImplementedError, msg="The underlying queue class does not implement 'peek'"): + with self.assertRaises( + NotImplementedError, + msg="The underlying queue class does not implement 'peek'", + ): q.peek() self.assertEqual(len(q), 3) self.assertEqual(q.pop().url, req3.url) @@ -195,12 +204,16 @@ class PickleLifoDiskQueueRequestTest(LifoQueueMixin, BaseQueueTestCase): class MarshalFifoDiskQueueRequestTest(FifoQueueMixin, BaseQueueTestCase): def queue(self): - return MarshalFifoDiskQueue.from_crawler(crawler=self.crawler, key="marshal/fifo") + return MarshalFifoDiskQueue.from_crawler( + crawler=self.crawler, key="marshal/fifo" + ) class MarshalLifoDiskQueueRequestTest(LifoQueueMixin, BaseQueueTestCase): def queue(self): - return MarshalLifoDiskQueue.from_crawler(crawler=self.crawler, key="marshal/lifo") + return MarshalLifoDiskQueue.from_crawler( + crawler=self.crawler, key="marshal/lifo" + ) class FifoMemoryQueueRequestTest(FifoQueueMixin, BaseQueueTestCase): diff --git a/tests/test_stats.py b/tests/test_stats.py index 2bbbb9e2c..2ee04429a 100644 --- a/tests/test_stats.py +++ b/tests/test_stats.py @@ -9,12 +9,11 @@ from scrapy.utils.test import get_crawler class CoreStatsExtensionTest(unittest.TestCase): - def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('foo') + self.spider = self.crawler._create_spider("foo") - @mock.patch('scrapy.extensions.corestats.datetime') + @mock.patch("scrapy.extensions.corestats.datetime") def test_core_stats_default_stats_collector(self, mock_datetime): fixed_datetime = datetime(2019, 12, 1, 11, 38) mock_datetime.utcnow = mock.Mock(return_value=fixed_datetime) @@ -24,19 +23,19 @@ class CoreStatsExtensionTest(unittest.TestCase): ext.item_scraped({}, self.spider) ext.response_received(self.spider) ext.item_dropped({}, self.spider, ZeroDivisionError()) - ext.spider_closed(self.spider, 'finished') + ext.spider_closed(self.spider, "finished") self.assertEqual( ext.stats._stats, { - 'start_time': fixed_datetime, - 'finish_time': fixed_datetime, - 'item_scraped_count': 1, - 'response_received_count': 1, - 'item_dropped_count': 1, - 'item_dropped_reasons_count/ZeroDivisionError': 1, - 'finish_reason': 'finished', - 'elapsed_time_seconds': 0.0, - } + "start_time": fixed_datetime, + "finish_time": fixed_datetime, + "item_scraped_count": 1, + "response_received_count": 1, + "item_dropped_count": 1, + "item_dropped_reasons_count/ZeroDivisionError": 1, + "finish_reason": "finished", + "elapsed_time_seconds": 0.0, + }, ) def test_core_stats_dummy_stats_collector(self): @@ -46,53 +45,52 @@ class CoreStatsExtensionTest(unittest.TestCase): ext.item_scraped({}, self.spider) ext.response_received(self.spider) ext.item_dropped({}, self.spider, ZeroDivisionError()) - ext.spider_closed(self.spider, 'finished') + ext.spider_closed(self.spider, "finished") self.assertEqual(ext.stats._stats, {}) class StatsCollectorTest(unittest.TestCase): - def setUp(self): self.crawler = get_crawler(Spider) - self.spider = self.crawler._create_spider('foo') + self.spider = self.crawler._create_spider("foo") def test_collector(self): stats = StatsCollector(self.crawler) self.assertEqual(stats.get_stats(), {}) - self.assertEqual(stats.get_value('anything'), None) - self.assertEqual(stats.get_value('anything', 'default'), 'default') - stats.set_value('test', 'value') - self.assertEqual(stats.get_stats(), {'test': 'value'}) - stats.set_value('test2', 23) - self.assertEqual(stats.get_stats(), {'test': 'value', 'test2': 23}) - self.assertEqual(stats.get_value('test2'), 23) - stats.inc_value('test2') - self.assertEqual(stats.get_value('test2'), 24) - stats.inc_value('test2', 6) - self.assertEqual(stats.get_value('test2'), 30) - stats.max_value('test2', 6) - self.assertEqual(stats.get_value('test2'), 30) - stats.max_value('test2', 40) - self.assertEqual(stats.get_value('test2'), 40) - stats.max_value('test3', 1) - self.assertEqual(stats.get_value('test3'), 1) - stats.min_value('test2', 60) - self.assertEqual(stats.get_value('test2'), 40) - stats.min_value('test2', 35) - self.assertEqual(stats.get_value('test2'), 35) - stats.min_value('test4', 7) - self.assertEqual(stats.get_value('test4'), 7) + self.assertEqual(stats.get_value("anything"), None) + self.assertEqual(stats.get_value("anything", "default"), "default") + stats.set_value("test", "value") + self.assertEqual(stats.get_stats(), {"test": "value"}) + stats.set_value("test2", 23) + self.assertEqual(stats.get_stats(), {"test": "value", "test2": 23}) + self.assertEqual(stats.get_value("test2"), 23) + stats.inc_value("test2") + self.assertEqual(stats.get_value("test2"), 24) + stats.inc_value("test2", 6) + self.assertEqual(stats.get_value("test2"), 30) + stats.max_value("test2", 6) + self.assertEqual(stats.get_value("test2"), 30) + stats.max_value("test2", 40) + self.assertEqual(stats.get_value("test2"), 40) + stats.max_value("test3", 1) + self.assertEqual(stats.get_value("test3"), 1) + stats.min_value("test2", 60) + self.assertEqual(stats.get_value("test2"), 40) + stats.min_value("test2", 35) + self.assertEqual(stats.get_value("test2"), 35) + stats.min_value("test4", 7) + self.assertEqual(stats.get_value("test4"), 7) def test_dummy_collector(self): stats = DummyStatsCollector(self.crawler) self.assertEqual(stats.get_stats(), {}) - self.assertEqual(stats.get_value('anything'), None) - self.assertEqual(stats.get_value('anything', 'default'), 'default') - stats.set_value('test', 'value') - stats.inc_value('v1') - stats.max_value('v2', 100) - stats.min_value('v3', 100) - stats.open_spider('a') - stats.set_value('test', 'value', spider=self.spider) + self.assertEqual(stats.get_value("anything"), None) + self.assertEqual(stats.get_value("anything", "default"), "default") + stats.set_value("test", "value") + stats.inc_value("v1") + stats.max_value("v2", 100) + stats.min_value("v3", 100) + stats.open_spider("a") + stats.set_value("test", "value", spider=self.spider) self.assertEqual(stats.get_stats(), {}) - self.assertEqual(stats.get_stats('a'), {}) + self.assertEqual(stats.get_stats("a"), {}) diff --git a/tests/test_toplevel.py b/tests/test_toplevel.py index fdc5df166..9a4eeb04e 100644 --- a/tests/test_toplevel.py +++ b/tests/test_toplevel.py @@ -4,7 +4,6 @@ import scrapy class ToplevelTestCase(TestCase): - def test_version(self): self.assertIs(type(scrapy.__version__), str) @@ -13,18 +12,22 @@ class ToplevelTestCase(TestCase): def test_request_shortcut(self): from scrapy.http import Request, FormRequest + self.assertIs(scrapy.Request, Request) self.assertIs(scrapy.FormRequest, FormRequest) def test_spider_shortcut(self): from scrapy.spiders import Spider + self.assertIs(scrapy.Spider, Spider) def test_selector_shortcut(self): from scrapy.selector import Selector + self.assertIs(scrapy.Selector, Selector) def test_item_shortcut(self): from scrapy.item import Item, Field + self.assertIs(scrapy.Item, Item) self.assertIs(scrapy.Field, Field) diff --git a/tests/test_urlparse_monkeypatches.py b/tests/test_urlparse_monkeypatches.py index bea0cf3e5..3b6428686 100644 --- a/tests/test_urlparse_monkeypatches.py +++ b/tests/test_urlparse_monkeypatches.py @@ -3,10 +3,9 @@ import unittest class UrlparseTestCase(unittest.TestCase): - def test_s3_url(self): - p = urlparse('s3://bucket/key/name?param=value') - self.assertEqual(p.scheme, 's3') - self.assertEqual(p.hostname, 'bucket') - self.assertEqual(p.path, '/key/name') - self.assertEqual(p.query, 'param=value') + p = urlparse("s3://bucket/key/name?param=value") + self.assertEqual(p.scheme, "s3") + self.assertEqual(p.hostname, "bucket") + self.assertEqual(p.path, "/key/name") + self.assertEqual(p.query, "param=value") diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index 741c6a505..25cef2b26 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -6,12 +6,13 @@ from pytest import mark from scrapy.utils.reactor import is_asyncio_reactor_installed, install_reactor -@mark.usefixtures('reactor_pytest') +@mark.usefixtures("reactor_pytest") class AsyncioTest(TestCase): - def test_is_asyncio_reactor_installed(self): # the result should depend only on the pytest --reactor argument - self.assertEqual(is_asyncio_reactor_installed(), self.reactor_pytest == 'asyncio') + self.assertEqual( + is_asyncio_reactor_installed(), self.reactor_pytest == "asyncio" + ) def test_install_asyncio_reactor(self): with warnings.catch_warnings(record=True) as w: diff --git a/tests/test_utils_conf.py b/tests/test_utils_conf.py index a92880626..61a683318 100644 --- a/tests/test_utils_conf.py +++ b/tests/test_utils_conf.py @@ -7,200 +7,242 @@ from scrapy.utils.conf import ( arglist_to_dict, build_component_list, feed_complete_default_values_from_settings, - feed_process_params_from_cli + feed_process_params_from_cli, ) class BuildComponentListTest(unittest.TestCase): - def test_build_dict(self): - d = {'one': 1, 'two': None, 'three': 8, 'four': 4} - self.assertEqual(build_component_list(d, convert=lambda x: x), - ['one', 'four', 'three']) + d = {"one": 1, "two": None, "three": 8, "four": 4} + self.assertEqual( + build_component_list(d, convert=lambda x: x), ["one", "four", "three"] + ) def test_backward_compatible_build_dict(self): - base = {'one': 1, 'two': 2, 'three': 3, 'five': 5, 'six': None} - custom = {'two': None, 'three': 8, 'four': 4} - self.assertEqual(build_component_list(base, custom, - convert=lambda x: x), - ['one', 'four', 'five', 'three']) + base = {"one": 1, "two": 2, "three": 3, "five": 5, "six": None} + custom = {"two": None, "three": 8, "four": 4} + self.assertEqual( + build_component_list(base, custom, convert=lambda x: x), + ["one", "four", "five", "three"], + ) def test_return_list(self): - custom = ['a', 'b', 'c'] - self.assertEqual(build_component_list(None, custom, - convert=lambda x: x), - custom) + custom = ["a", "b", "c"] + self.assertEqual( + build_component_list(None, custom, convert=lambda x: x), custom + ) def test_map_dict(self): - custom = {'one': 1, 'two': 2, 'three': 3} - self.assertEqual(build_component_list({}, custom, - convert=lambda x: x.upper()), - ['ONE', 'TWO', 'THREE']) + custom = {"one": 1, "two": 2, "three": 3} + self.assertEqual( + build_component_list({}, custom, convert=lambda x: x.upper()), + ["ONE", "TWO", "THREE"], + ) def test_map_list(self): - custom = ['a', 'b', 'c'] - self.assertEqual(build_component_list(None, custom, - lambda x: x.upper()), - ['A', 'B', 'C']) + custom = ["a", "b", "c"] + self.assertEqual( + build_component_list(None, custom, lambda x: x.upper()), ["A", "B", "C"] + ) def test_duplicate_components_in_dict(self): - duplicate_dict = {'one': 1, 'two': 2, 'ONE': 4} - self.assertRaises(ValueError, build_component_list, {}, duplicate_dict, - convert=lambda x: x.lower()) + duplicate_dict = {"one": 1, "two": 2, "ONE": 4} + self.assertRaises( + ValueError, + build_component_list, + {}, + duplicate_dict, + convert=lambda x: x.lower(), + ) def test_duplicate_components_in_list(self): - duplicate_list = ['a', 'b', 'a'] + duplicate_list = ["a", "b", "a"] with self.assertRaises(ValueError) as cm: build_component_list(None, duplicate_list, convert=lambda x: x) self.assertIn(str(duplicate_list), str(cm.exception)) def test_duplicate_components_in_basesettings(self): # Higher priority takes precedence - duplicate_bs = BaseSettings({'one': 1, 'two': 2}, priority=0) - duplicate_bs.set('ONE', 4, priority=10) - self.assertEqual(build_component_list(duplicate_bs, - convert=lambda x: x.lower()), - ['two', 'one']) - duplicate_bs.set('one', duplicate_bs['one'], priority=20) - self.assertEqual(build_component_list(duplicate_bs, - convert=lambda x: x.lower()), - ['one', 'two']) + duplicate_bs = BaseSettings({"one": 1, "two": 2}, priority=0) + duplicate_bs.set("ONE", 4, priority=10) + self.assertEqual( + build_component_list(duplicate_bs, convert=lambda x: x.lower()), + ["two", "one"], + ) + duplicate_bs.set("one", duplicate_bs["one"], priority=20) + self.assertEqual( + build_component_list(duplicate_bs, convert=lambda x: x.lower()), + ["one", "two"], + ) # Same priority raises ValueError - duplicate_bs.set('ONE', duplicate_bs['ONE'], priority=20) - self.assertRaises(ValueError, build_component_list, duplicate_bs, - convert=lambda x: x.lower()) + duplicate_bs.set("ONE", duplicate_bs["ONE"], priority=20) + self.assertRaises( + ValueError, build_component_list, duplicate_bs, convert=lambda x: x.lower() + ) def test_valid_numbers(self): # work well with None and numeric values - d = {'a': 10, 'b': None, 'c': 15, 'd': 5.0} - self.assertEqual(build_component_list(d, convert=lambda x: x), - ['d', 'a', 'c']) - d = {'a': 33333333333333333333, 'b': 11111111111111111111, 'c': 22222222222222222222} - self.assertEqual(build_component_list(d, convert=lambda x: x), - ['b', 'c', 'a']) + d = {"a": 10, "b": None, "c": 15, "d": 5.0} + self.assertEqual(build_component_list(d, convert=lambda x: x), ["d", "a", "c"]) + d = { + "a": 33333333333333333333, + "b": 11111111111111111111, + "c": 22222222222222222222, + } + self.assertEqual(build_component_list(d, convert=lambda x: x), ["b", "c", "a"]) # raise exception for invalid values - d = {'one': '5'} + d = {"one": "5"} self.assertRaises(ValueError, build_component_list, {}, d, convert=lambda x: x) - d = {'one': '1.0'} + d = {"one": "1.0"} self.assertRaises(ValueError, build_component_list, {}, d, convert=lambda x: x) - d = {'one': [1, 2, 3]} + d = {"one": [1, 2, 3]} self.assertRaises(ValueError, build_component_list, {}, d, convert=lambda x: x) - d = {'one': {'a': 'a', 'b': 2}} + d = {"one": {"a": "a", "b": 2}} self.assertRaises(ValueError, build_component_list, {}, d, convert=lambda x: x) - d = {'one': 'lorem ipsum'} + d = {"one": "lorem ipsum"} self.assertRaises(ValueError, build_component_list, {}, d, convert=lambda x: x) class UtilsConfTestCase(unittest.TestCase): - def test_arglist_to_dict(self): self.assertEqual( - arglist_to_dict(['arg1=val1', 'arg2=val2']), - {'arg1': 'val1', 'arg2': 'val2'}) + arglist_to_dict(["arg1=val1", "arg2=val2"]), + {"arg1": "val1", "arg2": "val2"}, + ) class FeedExportConfigTestCase(unittest.TestCase): - def test_feed_export_config_invalid_format(self): settings = Settings() - self.assertRaises(UsageError, feed_process_params_from_cli, settings, ['items.dat'], 'noformat') + self.assertRaises( + UsageError, + feed_process_params_from_cli, + settings, + ["items.dat"], + "noformat", + ) def test_feed_export_config_mismatch(self): settings = Settings() self.assertRaises( UsageError, - feed_process_params_from_cli, settings, ['items1.dat', 'items2.dat'], 'noformat' + feed_process_params_from_cli, + settings, + ["items1.dat", "items2.dat"], + "noformat", ) def test_feed_export_config_backward_compatible(self): with warnings.catch_warnings(record=True) as cw: settings = Settings() self.assertEqual( - {'items.dat': {'format': 'csv'}}, - feed_process_params_from_cli(settings, ['items.dat'], 'csv') + {"items.dat": {"format": "csv"}}, + feed_process_params_from_cli(settings, ["items.dat"], "csv"), ) self.assertEqual(cw[0].category, ScrapyDeprecationWarning) def test_feed_export_config_explicit_formats(self): settings = Settings() self.assertEqual( - {'items_1.dat': {'format': 'json'}, 'items_2.dat': {'format': 'xml'}, 'items_3.dat': {'format': 'csv'}}, - feed_process_params_from_cli(settings, ['items_1.dat:json', 'items_2.dat:xml', 'items_3.dat:csv']) + { + "items_1.dat": {"format": "json"}, + "items_2.dat": {"format": "xml"}, + "items_3.dat": {"format": "csv"}, + }, + feed_process_params_from_cli( + settings, ["items_1.dat:json", "items_2.dat:xml", "items_3.dat:csv"] + ), ) def test_feed_export_config_implicit_formats(self): settings = Settings() self.assertEqual( - {'items_1.json': {'format': 'json'}, 'items_2.xml': {'format': 'xml'}, 'items_3.csv': {'format': 'csv'}}, - feed_process_params_from_cli(settings, ['items_1.json', 'items_2.xml', 'items_3.csv']) + { + "items_1.json": {"format": "json"}, + "items_2.xml": {"format": "xml"}, + "items_3.csv": {"format": "csv"}, + }, + feed_process_params_from_cli( + settings, ["items_1.json", "items_2.xml", "items_3.csv"] + ), ) def test_feed_export_config_stdout(self): settings = Settings() self.assertEqual( - {'stdout:': {'format': 'pickle'}}, - feed_process_params_from_cli(settings, ['-:pickle']) + {"stdout:": {"format": "pickle"}}, + feed_process_params_from_cli(settings, ["-:pickle"]), ) def test_feed_export_config_overwrite(self): settings = Settings() self.assertEqual( - {'output.json': {'format': 'json', 'overwrite': True}}, - feed_process_params_from_cli(settings, [], None, ['output.json']) + {"output.json": {"format": "json", "overwrite": True}}, + feed_process_params_from_cli(settings, [], None, ["output.json"]), ) def test_output_and_overwrite_output(self): with self.assertRaises(UsageError): feed_process_params_from_cli( Settings(), - ['output1.json'], + ["output1.json"], None, - ['output2.json'], + ["output2.json"], ) def test_feed_complete_default_values_from_settings_empty(self): feed = {} - settings = Settings({ - "FEED_EXPORT_ENCODING": "custom encoding", - "FEED_EXPORT_FIELDS": ["f1", "f2", "f3"], - "FEED_EXPORT_INDENT": 42, - "FEED_STORE_EMPTY": True, - "FEED_URI_PARAMS": (1, 2, 3, 4), - "FEED_EXPORT_BATCH_ITEM_COUNT": 2, - }) + settings = Settings( + { + "FEED_EXPORT_ENCODING": "custom encoding", + "FEED_EXPORT_FIELDS": ["f1", "f2", "f3"], + "FEED_EXPORT_INDENT": 42, + "FEED_STORE_EMPTY": True, + "FEED_URI_PARAMS": (1, 2, 3, 4), + "FEED_EXPORT_BATCH_ITEM_COUNT": 2, + } + ) new_feed = feed_complete_default_values_from_settings(feed, settings) - self.assertEqual(new_feed, { - "encoding": "custom encoding", - "fields": ["f1", "f2", "f3"], - "indent": 42, - "store_empty": True, - "uri_params": (1, 2, 3, 4), - "batch_item_count": 2, - "item_export_kwargs": {}, - }) + self.assertEqual( + new_feed, + { + "encoding": "custom encoding", + "fields": ["f1", "f2", "f3"], + "indent": 42, + "store_empty": True, + "uri_params": (1, 2, 3, 4), + "batch_item_count": 2, + "item_export_kwargs": {}, + }, + ) def test_feed_complete_default_values_from_settings_non_empty(self): feed = { "encoding": "other encoding", "fields": None, } - settings = Settings({ - "FEED_EXPORT_ENCODING": "custom encoding", - "FEED_EXPORT_FIELDS": ["f1", "f2", "f3"], - "FEED_EXPORT_INDENT": 42, - "FEED_STORE_EMPTY": True, - "FEED_EXPORT_BATCH_ITEM_COUNT": 2, - }) + settings = Settings( + { + "FEED_EXPORT_ENCODING": "custom encoding", + "FEED_EXPORT_FIELDS": ["f1", "f2", "f3"], + "FEED_EXPORT_INDENT": 42, + "FEED_STORE_EMPTY": True, + "FEED_EXPORT_BATCH_ITEM_COUNT": 2, + } + ) new_feed = feed_complete_default_values_from_settings(feed, settings) - self.assertEqual(new_feed, { - "encoding": "other encoding", - "fields": None, - "indent": 42, - "store_empty": True, - "uri_params": None, - "batch_item_count": 2, - "item_export_kwargs": {}, - }) + self.assertEqual( + new_feed, + { + "encoding": "other encoding", + "fields": None, + "indent": 42, + "store_empty": True, + "uri_params": None, + "batch_item_count": 2, + "item_export_kwargs": {}, + }, + ) if __name__ == "__main__": diff --git a/tests/test_utils_console.py b/tests/test_utils_console.py index 380c41367..18f63b540 100644 --- a/tests/test_utils_console.py +++ b/tests/test_utils_console.py @@ -1,14 +1,17 @@ import unittest from scrapy.utils.console import get_shell_embed_func + try: import bpython + bpy = True del bpython except ImportError: bpy = False try: import IPython + ipy = True del IPython except ImportError: @@ -16,29 +19,28 @@ except ImportError: class UtilsConsoleTestCase(unittest.TestCase): - def test_get_shell_embed_func(self): - shell = get_shell_embed_func(['invalid']) + shell = get_shell_embed_func(["invalid"]) self.assertEqual(shell, None) - shell = get_shell_embed_func(['invalid', 'python']) + shell = get_shell_embed_func(["invalid", "python"]) self.assertTrue(callable(shell)) - self.assertEqual(shell.__name__, '_embed_standard_shell') + self.assertEqual(shell.__name__, "_embed_standard_shell") - @unittest.skipIf(not bpy, 'bpython not available in testenv') + @unittest.skipIf(not bpy, "bpython not available in testenv") def test_get_shell_embed_func2(self): - shell = get_shell_embed_func(['bpython']) + shell = get_shell_embed_func(["bpython"]) self.assertTrue(callable(shell)) - self.assertEqual(shell.__name__, '_embed_bpython_shell') + self.assertEqual(shell.__name__, "_embed_bpython_shell") - @unittest.skipIf(not ipy, 'IPython not available in testenv') + @unittest.skipIf(not ipy, "IPython not available in testenv") def test_get_shell_embed_func3(self): # default shell should be 'ipython' shell = get_shell_embed_func() - self.assertEqual(shell.__name__, '_embed_ipython_shell') + self.assertEqual(shell.__name__, "_embed_ipython_shell") if __name__ == "__main__": diff --git a/tests/test_utils_curl.py b/tests/test_utils_curl.py index f5d684d3f..fd4612eba 100644 --- a/tests/test_utils_curl.py +++ b/tests/test_utils_curl.py @@ -34,10 +34,7 @@ class CurlToRequestKwargsTest(unittest.TestCase): "method": "GET", "url": "https://api.test.com/", "headers": [ - ( - "Authorization", - basic_auth_header("some_username", "some_password") - ) + ("Authorization", basic_auth_header("some_username", "some_password")) ], } self._test_command(curl_command, expected_result) @@ -77,11 +74,11 @@ class CurlToRequestKwargsTest(unittest.TestCase): ("Connection", "keep-alive"), ], "cookies": { - '_gauges_unique_year': '1', - '_gauges_unique_hour': '1', - '_gauges_unique_day': '1', - '_gauges_unique': '1', - '_gauges_unique_month': '1' + "_gauges_unique_year": "1", + "_gauges_unique_hour": "1", + "_gauges_unique_day": "1", + "_gauges_unique": "1", + "_gauges_unique_month": "1", }, } self._test_command(curl_command, expected_result) @@ -107,14 +104,14 @@ class CurlToRequestKwargsTest(unittest.TestCase): "method": "POST", "url": "http://httpbin.org/post", "body": "custname=John+Smith&custtel=500&custemail=jsmith%40exampl" - "e.org&size=small&topping=cheese&topping=onion&delivery=12" - "%3A15&comments=", + "e.org&size=small&topping=cheese&topping=onion&delivery=12" + "%3A15&comments=", "cookies": { - '_gauges_unique_year': '1', - '_gauges_unique_hour': '1', - '_gauges_unique_day': '1', - '_gauges_unique': '1', - '_gauges_unique_month': '1' + "_gauges_unique_year": "1", + "_gauges_unique_hour": "1", + "_gauges_unique_day": "1", + "_gauges_unique": "1", + "_gauges_unique_month": "1", }, "headers": [ ("Origin", "http://httpbin.org"), @@ -152,16 +149,17 @@ class CurlToRequestKwargsTest(unittest.TestCase): "body": ( "excerptLength=200&enableDidYouMean=true&sortCriteria=ffirstz3" "2xnamez32x201740686%20ascending&queryFunctions=%5B%5D&ranking" - "Functions=%5B%5D") + "Functions=%5B%5D" + ), } self._test_command(curl_command, expected_result) def test_explicit_get_with_data(self): - curl_command = 'curl httpbin.org/anything -X GET --data asdf' + curl_command = "curl httpbin.org/anything -X GET --data asdf" expected_result = { "method": "GET", "url": "http://httpbin.org/anything", - "body": "asdf" + "body": "asdf", } self._test_command(curl_command, expected_result) @@ -182,16 +180,14 @@ class CurlToRequestKwargsTest(unittest.TestCase): ("Authorization", basic_auth_header("username", "password")), ], "body": '{"hostname": "agent02.example.com", "agent_config_state"' - ': "Enabled", "resources": ["Java","Linux"], "environments' - '": ["Dev"]}', + ': "Enabled", "resources": ["Java","Linux"], "environments' + '": ["Dev"]}', } self._test_command(curl_command, expected_result) def test_delete(self): curl_command = 'curl -X "DELETE" https://www.url.com/page' - expected_result = { - "method": "DELETE", "url": "https://www.url.com/page" - } + expected_result = {"method": "DELETE", "url": "https://www.url.com/page"} self._test_command(curl_command, expected_result) def test_get_silent(self): @@ -209,8 +205,8 @@ class CurlToRequestKwargsTest(unittest.TestCase): def test_ignore_unknown_options(self): # case 1: ignore_unknown_options=True: with warnings.catch_warnings(): # avoid warning when executing tests - warnings.simplefilter('ignore') - curl_command = 'curl --bar --baz http://www.example.com' + warnings.simplefilter("ignore") + curl_command = "curl --bar --baz http://www.example.com" expected_result = {"method": "GET", "url": "http://www.example.com"} self.assertEqual(curl_to_request_kwargs(curl_command), expected_result) @@ -219,13 +215,12 @@ class CurlToRequestKwargsTest(unittest.TestCase): ValueError, "Unrecognized options:.*--bar.*--baz", lambda: curl_to_request_kwargs( - "curl --bar --baz http://www.example.com", - ignore_unknown_options=False + "curl --bar --baz http://www.example.com", ignore_unknown_options=False ), ) def test_must_start_with_curl_error(self): self.assertRaises( ValueError, - lambda: curl_to_request_kwargs("carl -X POST http://example.org") + lambda: curl_to_request_kwargs("carl -X POST http://example.org"), ) diff --git a/tests/test_utils_datatypes.py b/tests/test_utils_datatypes.py index e4bccf30e..0c86c7e7a 100644 --- a/tests/test_utils_datatypes.py +++ b/tests/test_utils_datatypes.py @@ -3,26 +3,30 @@ import unittest from collections.abc import Mapping, MutableMapping from scrapy.http import Request -from scrapy.utils.datatypes import CaselessDict, LocalCache, LocalWeakReferencedCache, SequenceExclude +from scrapy.utils.datatypes import ( + CaselessDict, + LocalCache, + LocalWeakReferencedCache, + SequenceExclude, +) from scrapy.utils.python import garbage_collect -__doctests__ = ['scrapy.utils.datatypes'] +__doctests__ = ["scrapy.utils.datatypes"] class CaselessDictTest(unittest.TestCase): - def test_init_dict(self): - seq = {'red': 1, 'black': 3} + seq = {"red": 1, "black": 3} d = CaselessDict(seq) - self.assertEqual(d['red'], 1) - self.assertEqual(d['black'], 3) + self.assertEqual(d["red"], 1) + self.assertEqual(d["black"], 3) def test_init_pair_sequence(self): - seq = (('red', 1), ('black', 3)) + seq = (("red", 1), ("black", 3)) d = CaselessDict(seq) - self.assertEqual(d['red'], 1) - self.assertEqual(d['black'], 3) + self.assertEqual(d["red"], 1) + self.assertEqual(d["black"], 3) def test_init_mapping(self): class MyMapping(Mapping): @@ -40,8 +44,8 @@ class CaselessDictTest(unittest.TestCase): seq = MyMapping(red=1, black=3) d = CaselessDict(seq) - self.assertEqual(d['red'], 1) - self.assertEqual(d['black'], 3) + self.assertEqual(d["red"], 1) + self.assertEqual(d["black"], 3) def test_init_mutable_mapping(self): class MyMutableMapping(MutableMapping): @@ -65,72 +69,72 @@ class CaselessDictTest(unittest.TestCase): seq = MyMutableMapping(red=1, black=3) d = CaselessDict(seq) - self.assertEqual(d['red'], 1) - self.assertEqual(d['black'], 3) + self.assertEqual(d["red"], 1) + self.assertEqual(d["black"], 3) def test_caseless(self): d = CaselessDict() - d['key_Lower'] = 1 - self.assertEqual(d['KEy_loWer'], 1) - self.assertEqual(d.get('KEy_loWer'), 1) + d["key_Lower"] = 1 + self.assertEqual(d["KEy_loWer"], 1) + self.assertEqual(d.get("KEy_loWer"), 1) - d['KEY_LOWER'] = 3 - self.assertEqual(d['key_Lower'], 3) - self.assertEqual(d.get('key_Lower'), 3) + d["KEY_LOWER"] = 3 + self.assertEqual(d["key_Lower"], 3) + self.assertEqual(d.get("key_Lower"), 3) def test_delete(self): - d = CaselessDict({'key_lower': 1}) - del d['key_LOWER'] - self.assertRaises(KeyError, d.__getitem__, 'key_LOWER') - self.assertRaises(KeyError, d.__getitem__, 'key_lower') + d = CaselessDict({"key_lower": 1}) + del d["key_LOWER"] + self.assertRaises(KeyError, d.__getitem__, "key_LOWER") + self.assertRaises(KeyError, d.__getitem__, "key_lower") def test_getdefault(self): d = CaselessDict() - self.assertEqual(d.get('c', 5), 5) - d['c'] = 10 - self.assertEqual(d.get('c', 5), 10) + self.assertEqual(d.get("c", 5), 5) + d["c"] = 10 + self.assertEqual(d.get("c", 5), 10) def test_setdefault(self): - d = CaselessDict({'a': 1, 'b': 2}) + d = CaselessDict({"a": 1, "b": 2}) - r = d.setdefault('A', 5) + r = d.setdefault("A", 5) self.assertEqual(r, 1) - self.assertEqual(d['A'], 1) + self.assertEqual(d["A"], 1) - r = d.setdefault('c', 5) + r = d.setdefault("c", 5) self.assertEqual(r, 5) - self.assertEqual(d['C'], 5) + self.assertEqual(d["C"], 5) def test_fromkeys(self): - keys = ('a', 'b') + keys = ("a", "b") d = CaselessDict.fromkeys(keys) - self.assertEqual(d['A'], None) - self.assertEqual(d['B'], None) + self.assertEqual(d["A"], None) + self.assertEqual(d["B"], None) d = CaselessDict.fromkeys(keys, 1) - self.assertEqual(d['A'], 1) - self.assertEqual(d['B'], 1) + self.assertEqual(d["A"], 1) + self.assertEqual(d["B"], 1) instance = CaselessDict() d = instance.fromkeys(keys) - self.assertEqual(d['A'], None) - self.assertEqual(d['B'], None) + self.assertEqual(d["A"], None) + self.assertEqual(d["B"], None) d = instance.fromkeys(keys, 1) - self.assertEqual(d['A'], 1) - self.assertEqual(d['B'], 1) + self.assertEqual(d["A"], 1) + self.assertEqual(d["B"], 1) def test_contains(self): d = CaselessDict() - d['a'] = 1 - assert 'a' in d + d["a"] = 1 + assert "a" in d def test_pop(self): d = CaselessDict() - d['a'] = 1 - self.assertEqual(d.pop('A'), 1) - self.assertRaises(KeyError, d.pop, 'A') + d["a"] = 1 + self.assertEqual(d.pop("A"), 1) + self.assertRaises(KeyError, d.pop, "A") def test_normkey(self): class MyDict(CaselessDict): @@ -138,8 +142,8 @@ class CaselessDictTest(unittest.TestCase): return key.title() d = MyDict() - d['key-one'] = 2 - self.assertEqual(list(d.keys()), ['Key-One']) + d["key-one"] = 2 + self.assertEqual(list(d.keys()), ["Key-One"]) def test_normvalue(self): class MyDict(CaselessDict): @@ -147,39 +151,38 @@ class CaselessDictTest(unittest.TestCase): if value is not None: return value + 1 - d = MyDict({'key': 1}) - self.assertEqual(d['key'], 2) - self.assertEqual(d.get('key'), 2) + d = MyDict({"key": 1}) + self.assertEqual(d["key"], 2) + self.assertEqual(d.get("key"), 2) d = MyDict() - d['key'] = 1 - self.assertEqual(d['key'], 2) - self.assertEqual(d.get('key'), 2) + d["key"] = 1 + self.assertEqual(d["key"], 2) + self.assertEqual(d.get("key"), 2) d = MyDict() - d.setdefault('key', 1) - self.assertEqual(d['key'], 2) - self.assertEqual(d.get('key'), 2) + d.setdefault("key", 1) + self.assertEqual(d["key"], 2) + self.assertEqual(d.get("key"), 2) d = MyDict() - d.update({'key': 1}) - self.assertEqual(d['key'], 2) - self.assertEqual(d.get('key'), 2) + d.update({"key": 1}) + self.assertEqual(d["key"], 2) + self.assertEqual(d.get("key"), 2) - d = MyDict.fromkeys(('key',), 1) - self.assertEqual(d['key'], 2) - self.assertEqual(d.get('key'), 2) + d = MyDict.fromkeys(("key",), 1) + self.assertEqual(d["key"], 2) + self.assertEqual(d.get("key"), 2) def test_copy(self): - h1 = CaselessDict({'header1': 'value'}) + h1 = CaselessDict({"header1": "value"}) h2 = copy.copy(h1) self.assertEqual(h1, h2) - self.assertEqual(h1.get('header1'), h2.get('header1')) + self.assertEqual(h1.get("header1"), h2.get("header1")) assert isinstance(h2, CaselessDict) class SequenceExcludeTest(unittest.TestCase): - def test_list(self): seq = [1, 2, 3] d = SequenceExclude(seq) @@ -226,25 +229,24 @@ class SequenceExcludeTest(unittest.TestCase): # supplied sequence is a set, so checking for list (non)inclusion fails self.assertRaises(TypeError, (0, 1, 2) in d) - self.assertRaises(TypeError, d.__contains__, ['a', 'b', 'c']) + self.assertRaises(TypeError, d.__contains__, ["a", "b", "c"]) for v in [-3, "test", 1.1]: self.assertNotIn(v, d) class LocalCacheTest(unittest.TestCase): - def test_cache_with_limit(self): cache = LocalCache(limit=2) - cache['a'] = 1 - cache['b'] = 2 - cache['c'] = 3 + cache["a"] = 1 + cache["b"] = 2 + cache["c"] = 3 self.assertEqual(len(cache), 2) - self.assertNotIn('a', cache) - self.assertIn('b', cache) - self.assertIn('c', cache) - self.assertEqual(cache['b'], 2) - self.assertEqual(cache['c'], 3) + self.assertNotIn("a", cache) + self.assertIn("b", cache) + self.assertIn("c", cache) + self.assertEqual(cache["b"], 2) + self.assertEqual(cache["c"], 3) def test_cache_without_limit(self): maximum = 10**4 @@ -258,12 +260,11 @@ class LocalCacheTest(unittest.TestCase): class LocalWeakReferencedCacheTest(unittest.TestCase): - def test_cache_with_limit(self): cache = LocalWeakReferencedCache(limit=2) - r1 = Request('https://example.org') - r2 = Request('https://example.com') - r3 = Request('https://example.net') + r1 = Request("https://example.org") + r2 = Request("https://example.com") + r3 = Request("https://example.net") cache[r1] = 1 cache[r2] = 2 cache[r3] = 3 @@ -299,7 +300,7 @@ class LocalWeakReferencedCacheTest(unittest.TestCase): cache = LocalWeakReferencedCache() refs = [] for x in range(max): - refs.append(Request(f'https://example.org/{x}')) + refs.append(Request(f"https://example.org/{x}")) cache[refs[-1]] = x self.assertEqual(len(cache), max) for i, r in enumerate(refs): diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index 97c1c60d1..8d7f33c9a 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -68,41 +68,43 @@ def eb1(failure, arg1, arg2): class DeferUtilsTest(unittest.TestCase): - @defer.inlineCallbacks def test_process_chain(self): - x = yield process_chain([cb1, cb2, cb3], 'res', 'v1', 'v2') + x = yield process_chain([cb1, cb2, cb3], "res", "v1", "v2") self.assertEqual(x, "(cb3 (cb2 (cb1 res v1 v2) v1 v2) v1 v2)") gotexc = False try: - yield process_chain([cb1, cb_fail, cb3], 'res', 'v1', 'v2') + yield process_chain([cb1, cb_fail, cb3], "res", "v1", "v2") except TypeError: gotexc = True self.assertTrue(gotexc) @defer.inlineCallbacks def test_process_chain_both(self): - x = yield process_chain_both([cb_fail, cb2, cb3], [None, eb1, None], 'res', 'v1', 'v2') + x = yield process_chain_both( + [cb_fail, cb2, cb3], [None, eb1, None], "res", "v1", "v2" + ) self.assertEqual(x, "(cb3 (eb1 TypeError v1 v2) v1 v2)") fail = Failure(ZeroDivisionError()) - x = yield process_chain_both([eb1, cb2, cb3], [eb1, None, None], fail, 'v1', 'v2') + x = yield process_chain_both( + [eb1, cb2, cb3], [eb1, None, None], fail, "v1", "v2" + ) self.assertEqual(x, "(cb3 (cb2 (eb1 ZeroDivisionError v1 v2) v1 v2) v1 v2)") @defer.inlineCallbacks def test_process_parallel(self): - x = yield process_parallel([cb1, cb2, cb3], 'res', 'v1', 'v2') - self.assertEqual(x, ['(cb1 res v1 v2)', '(cb2 res v1 v2)', '(cb3 res v1 v2)']) + x = yield process_parallel([cb1, cb2, cb3], "res", "v1", "v2") + self.assertEqual(x, ["(cb1 res v1 v2)", "(cb2 res v1 v2)", "(cb3 res v1 v2)"]) def test_process_parallel_failure(self): - d = process_parallel([cb1, cb_fail, cb3], 'res', 'v1', 'v2') + d = process_parallel([cb1, cb_fail, cb3], "res", "v1", "v2") self.failUnlessFailure(d, TypeError) return d class IterErrbackTest(unittest.TestCase): - def test_iter_errback_good(self): def itergood(): for x in range(10): @@ -128,7 +130,6 @@ class IterErrbackTest(unittest.TestCase): class AiterErrbackTest(unittest.TestCase): - @deferred_f_from_coro_f async def test_aiter_errback_good(self): async def itergood(): @@ -171,7 +172,7 @@ class AsyncDefTestsuiteTest(unittest.TestCase): class AsyncCooperatorTest(unittest.TestCase): - """ This tests _AsyncCooperatorAdapter by testing parallel_async which is its only usage. + """This tests _AsyncCooperatorAdapter by testing parallel_async which is its only usage. parallel_async is called with the results of a callback (so an iterable of items, requests and None, with arbitrary delays between values), and it uses Scraper._process_spidermw_output as the callable @@ -182,6 +183,7 @@ class AsyncCooperatorTest(unittest.TestCase): We also want to simulate the real usage, with arbitrary delays between getting the values from the iterable. We also want to simulate sync and async results from the callable. """ + CONCURRENT_ITEMS = 50 @staticmethod diff --git a/tests/test_utils_deprecate.py b/tests/test_utils_deprecate.py index 50c63dfab..1a8c96e7a 100644 --- a/tests/test_utils_deprecate.py +++ b/tests/test_utils_deprecate.py @@ -20,22 +20,23 @@ class NewName(SomeBaseClass): class WarnWhenSubclassedTest(unittest.TestCase): - def _mywarnings(self, w, category=MyWarning): return [x for x in w if x.category is MyWarning] def test_no_warning_on_definition(self): with warnings.catch_warnings(record=True) as w: - create_deprecated_class('Deprecated', NewName) + create_deprecated_class("Deprecated", NewName) w = self._mywarnings(w) self.assertEqual(w, []) def test_subclassing_warning_message(self): - Deprecated = create_deprecated_class('Deprecated', NewName, - warn_category=MyWarning) + Deprecated = create_deprecated_class( + "Deprecated", NewName, warn_category=MyWarning + ) with warnings.catch_warnings(record=True) as w: + class UserClass(Deprecated): pass @@ -46,17 +47,21 @@ class WarnWhenSubclassedTest(unittest.TestCase): "tests.test_utils_deprecate.UserClass inherits from " "deprecated class tests.test_utils_deprecate.Deprecated, " "please inherit from tests.test_utils_deprecate.NewName." - " (warning only on first subclass, there may be others)" + " (warning only on first subclass, there may be others)", ) self.assertEqual(w[0].lineno, inspect.getsourcelines(UserClass)[1]) def test_custom_class_paths(self): - Deprecated = create_deprecated_class('Deprecated', NewName, - new_class_path='foo.NewClass', - old_class_path='bar.OldClass', - warn_category=MyWarning) + Deprecated = create_deprecated_class( + "Deprecated", + NewName, + new_class_path="foo.NewClass", + old_class_path="bar.OldClass", + warn_category=MyWarning, + ) with warnings.catch_warnings(record=True) as w: + class UserClass(Deprecated): pass @@ -64,17 +69,18 @@ class WarnWhenSubclassedTest(unittest.TestCase): w = self._mywarnings(w) self.assertEqual(len(w), 2) - self.assertIn('foo.NewClass', str(w[0].message)) - self.assertIn('bar.OldClass', str(w[0].message)) - self.assertIn('foo.NewClass', str(w[1].message)) - self.assertIn('bar.OldClass', str(w[1].message)) + self.assertIn("foo.NewClass", str(w[0].message)) + self.assertIn("bar.OldClass", str(w[0].message)) + self.assertIn("foo.NewClass", str(w[1].message)) + self.assertIn("bar.OldClass", str(w[1].message)) def test_subclassing_warns_only_on_direct_childs(self): - Deprecated = create_deprecated_class('Deprecated', NewName, - warn_once=False, - warn_category=MyWarning) + Deprecated = create_deprecated_class( + "Deprecated", NewName, warn_once=False, warn_category=MyWarning + ) with warnings.catch_warnings(record=True) as w: + class UserClass(Deprecated): pass @@ -83,13 +89,15 @@ class WarnWhenSubclassedTest(unittest.TestCase): w = self._mywarnings(w) self.assertEqual(len(w), 1) - self.assertIn('UserClass', str(w[0].message)) + self.assertIn("UserClass", str(w[0].message)) def test_subclassing_warns_once_by_default(self): - Deprecated = create_deprecated_class('Deprecated', NewName, - warn_category=MyWarning) + Deprecated = create_deprecated_class( + "Deprecated", NewName, warn_category=MyWarning + ) with warnings.catch_warnings(record=True) as w: + class UserClass(Deprecated): pass @@ -101,15 +109,16 @@ class WarnWhenSubclassedTest(unittest.TestCase): w = self._mywarnings(w) self.assertEqual(len(w), 1) - self.assertIn('UserClass', str(w[0].message)) + self.assertIn("UserClass", str(w[0].message)) def test_warning_on_instance(self): - Deprecated = create_deprecated_class('Deprecated', NewName, - warn_category=MyWarning) + Deprecated = create_deprecated_class( + "Deprecated", NewName, warn_category=MyWarning + ) # ignore subclassing warnings with warnings.catch_warnings(): - warnings.simplefilter('ignore', MyWarning) + warnings.simplefilter("ignore", MyWarning) class UserClass(Deprecated): pass @@ -123,13 +132,13 @@ class WarnWhenSubclassedTest(unittest.TestCase): self.assertEqual( str(w[0].message), "tests.test_utils_deprecate.Deprecated is deprecated, " - "instantiate tests.test_utils_deprecate.NewName instead." + "instantiate tests.test_utils_deprecate.NewName instead.", ) self.assertEqual(w[0].lineno, lineno) def test_warning_auto_message(self): with warnings.catch_warnings(record=True) as w: - Deprecated = create_deprecated_class('Deprecated', NewName) + Deprecated = create_deprecated_class("Deprecated", NewName) class UserClass2(Deprecated): pass @@ -140,8 +149,8 @@ class WarnWhenSubclassedTest(unittest.TestCase): def test_issubclass(self): with warnings.catch_warnings(): - warnings.simplefilter('ignore', ScrapyDeprecationWarning) - DeprecatedName = create_deprecated_class('DeprecatedName', NewName) + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + DeprecatedName = create_deprecated_class("DeprecatedName", NewName) class UpdatedUserClass1(NewName): pass @@ -176,8 +185,8 @@ class WarnWhenSubclassedTest(unittest.TestCase): def test_isinstance(self): with warnings.catch_warnings(): - warnings.simplefilter('ignore', ScrapyDeprecationWarning) - DeprecatedName = create_deprecated_class('DeprecatedName', NewName) + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + DeprecatedName = create_deprecated_class("DeprecatedName", NewName) class UpdatedUserClass2(NewName): pass @@ -210,24 +219,28 @@ class WarnWhenSubclassedTest(unittest.TestCase): def test_clsdict(self): with warnings.catch_warnings(): - warnings.simplefilter('ignore', ScrapyDeprecationWarning) - Deprecated = create_deprecated_class('Deprecated', NewName, {'foo': 'bar'}) + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + Deprecated = create_deprecated_class("Deprecated", NewName, {"foo": "bar"}) - self.assertEqual(Deprecated.foo, 'bar') + self.assertEqual(Deprecated.foo, "bar") def test_deprecate_a_class_with_custom_metaclass(self): - Meta1 = type('Meta1', (type,), {}) - New = Meta1('New', (), {}) - create_deprecated_class('Deprecated', New) + Meta1 = type("Meta1", (type,), {}) + New = Meta1("New", (), {}) + create_deprecated_class("Deprecated", New) def test_deprecate_subclass_of_deprecated_class(self): with warnings.catch_warnings(record=True) as w: - warnings.simplefilter('always') - Deprecated = create_deprecated_class('Deprecated', NewName, - warn_category=MyWarning) - AlsoDeprecated = create_deprecated_class('AlsoDeprecated', Deprecated, - new_class_path='foo.Bar', - warn_category=MyWarning) + warnings.simplefilter("always") + Deprecated = create_deprecated_class( + "Deprecated", NewName, warn_category=MyWarning + ) + AlsoDeprecated = create_deprecated_class( + "AlsoDeprecated", + Deprecated, + new_class_path="foo.Bar", + warn_category=MyWarning, + ) w = self._mywarnings(w) self.assertEqual(len(w), 0, str(map(str, w))) @@ -240,15 +253,15 @@ class WarnWhenSubclassedTest(unittest.TestCase): w = self._mywarnings(w) self.assertEqual(len(w), 2) - self.assertIn('AlsoDeprecated', str(w[0].message)) - self.assertIn('foo.Bar', str(w[0].message)) - self.assertIn('AlsoDeprecated', str(w[1].message)) - self.assertIn('foo.Bar', str(w[1].message)) + self.assertIn("AlsoDeprecated", str(w[0].message)) + self.assertIn("foo.Bar", str(w[0].message)) + self.assertIn("AlsoDeprecated", str(w[1].message)) + self.assertIn("foo.Bar", str(w[1].message)) def test_inspect_stack(self): - with mock.patch('inspect.stack', side_effect=IndexError): + with mock.patch("inspect.stack", side_effect=IndexError): with warnings.catch_warnings(record=True) as w: - DeprecatedName = create_deprecated_class('DeprecatedName', NewName) + DeprecatedName = create_deprecated_class("DeprecatedName", NewName) class SubClass(DeprecatedName): pass @@ -256,27 +269,30 @@ class WarnWhenSubclassedTest(unittest.TestCase): self.assertIn("Error detecting parent module", str(w[0].message)) -@mock.patch('scrapy.utils.deprecate.DEPRECATION_RULES', - [('scrapy.contrib.pipeline.', 'scrapy.pipelines.'), - ('scrapy.contrib.', 'scrapy.extensions.')]) +@mock.patch( + "scrapy.utils.deprecate.DEPRECATION_RULES", + [ + ("scrapy.contrib.pipeline.", "scrapy.pipelines."), + ("scrapy.contrib.", "scrapy.extensions."), + ], +) class UpdateClassPathTest(unittest.TestCase): - def test_old_path_gets_fixed(self): with warnings.catch_warnings(record=True) as w: - output = update_classpath('scrapy.contrib.debug.Debug') - self.assertEqual(output, 'scrapy.extensions.debug.Debug') + output = update_classpath("scrapy.contrib.debug.Debug") + self.assertEqual(output, "scrapy.extensions.debug.Debug") self.assertEqual(len(w), 1) self.assertIn("scrapy.contrib.debug.Debug", str(w[0].message)) self.assertIn("scrapy.extensions.debug.Debug", str(w[0].message)) def test_sorted_replacement(self): with warnings.catch_warnings(): - warnings.simplefilter('ignore', ScrapyDeprecationWarning) - output = update_classpath('scrapy.contrib.pipeline.Pipeline') - self.assertEqual(output, 'scrapy.pipelines.Pipeline') + warnings.simplefilter("ignore", ScrapyDeprecationWarning) + output = update_classpath("scrapy.contrib.pipeline.Pipeline") + self.assertEqual(output, "scrapy.pipelines.Pipeline") def test_unmatched_path_stays_the_same(self): with warnings.catch_warnings(record=True) as w: - output = update_classpath('scrapy.unmatched.Path') - self.assertEqual(output, 'scrapy.unmatched.Path') + output = update_classpath("scrapy.unmatched.Path") + self.assertEqual(output, "scrapy.unmatched.Path") self.assertEqual(len(w), 0) diff --git a/tests/test_utils_display.py b/tests/test_utils_display.py index 9ec8311d9..43236acec 100644 --- a/tests/test_utils_display.py +++ b/tests/test_utils_display.py @@ -6,14 +6,14 @@ from scrapy.utils.display import pformat, pprint class TestDisplay(TestCase): - object = {'a': 1} + object = {"a": 1} colorized_string = ( "{\x1b[33m'\x1b[39;49;00m\x1b[33ma\x1b[39;49;00m\x1b[33m'" "\x1b[39;49;00m: \x1b[34m1\x1b[39;49;00m}\n" ) plain_string = "{'a': 1}" - @mock.patch('sys.platform', 'linux') + @mock.patch("sys.platform", "linux") @mock.patch("sys.stdout.isatty") def test_pformat(self, isatty): isatty.return_value = True @@ -27,44 +27,47 @@ class TestDisplay(TestCase): def test_pformat_not_tty(self): self.assertEqual(pformat(self.object), self.plain_string) - @mock.patch('sys.platform', 'win32') - @mock.patch('platform.version') + @mock.patch("sys.platform", "win32") + @mock.patch("platform.version") @mock.patch("sys.stdout.isatty") def test_pformat_old_windows(self, isatty, version): isatty.return_value = True - version.return_value = '10.0.14392' + version.return_value = "10.0.14392" self.assertEqual(pformat(self.object), self.colorized_string) - @mock.patch('sys.platform', 'win32') - @mock.patch('scrapy.utils.display._enable_windows_terminal_processing') - @mock.patch('platform.version') + @mock.patch("sys.platform", "win32") + @mock.patch("scrapy.utils.display._enable_windows_terminal_processing") + @mock.patch("platform.version") @mock.patch("sys.stdout.isatty") - def test_pformat_windows_no_terminal_processing(self, isatty, version, terminal_processing): + def test_pformat_windows_no_terminal_processing( + self, isatty, version, terminal_processing + ): isatty.return_value = True - version.return_value = '10.0.14393' + version.return_value = "10.0.14393" terminal_processing.return_value = False self.assertEqual(pformat(self.object), self.plain_string) - @mock.patch('sys.platform', 'win32') - @mock.patch('scrapy.utils.display._enable_windows_terminal_processing') - @mock.patch('platform.version') + @mock.patch("sys.platform", "win32") + @mock.patch("scrapy.utils.display._enable_windows_terminal_processing") + @mock.patch("platform.version") @mock.patch("sys.stdout.isatty") def test_pformat_windows(self, isatty, version, terminal_processing): isatty.return_value = True - version.return_value = '10.0.14393' + version.return_value = "10.0.14393" terminal_processing.return_value = True self.assertEqual(pformat(self.object), self.colorized_string) - @mock.patch('sys.platform', 'linux') + @mock.patch("sys.platform", "linux") @mock.patch("sys.stdout.isatty") def test_pformat_no_pygments(self, isatty): isatty.return_value = True import builtins + real_import = builtins.__import__ def mock_import(name, globals, locals, fromlist, level): - if 'pygments' in name: + if "pygments" in name: raise ImportError return real_import(name, globals, locals, fromlist, level) @@ -73,6 +76,6 @@ class TestDisplay(TestCase): builtins.__import__ = real_import def test_pprint(self): - with mock.patch('sys.stdout', new=StringIO()) as mock_out: + with mock.patch("sys.stdout", new=StringIO()) as mock_out: pprint(self.object) self.assertEqual(mock_out.getvalue(), "{'a': 1}\n") diff --git a/tests/test_utils_gz.py b/tests/test_utils_gz.py index ca98bff21..a34664956 100644 --- a/tests/test_utils_gz.py +++ b/tests/test_utils_gz.py @@ -8,13 +8,15 @@ from scrapy.http import Response from tests import tests_datadir -SAMPLEDIR = Path(tests_datadir, 'compressed') +SAMPLEDIR = Path(tests_datadir, "compressed") class GunzipTest(unittest.TestCase): - def test_gunzip_basic(self): - r1 = Response("http://www.example.com", body=(SAMPLEDIR / 'feed-sample1.xml.gz').read_bytes()) + r1 = Response( + "http://www.example.com", + body=(SAMPLEDIR / "feed-sample1.xml.gz").read_bytes(), + ) self.assertTrue(gzip_magic_number(r1)) r2 = Response("http://www.example.com", body=gunzip(r1.body)) @@ -22,18 +24,23 @@ class GunzipTest(unittest.TestCase): self.assertEqual(len(r2.body), 9950) def test_gunzip_truncated(self): - text = gunzip((SAMPLEDIR / 'truncated-crc-error.gz').read_bytes()) - assert text.endswith(b'') + assert r2.body.endswith(b"") self.assertFalse(gzip_magic_number(r2)) def test_is_gzipped_empty(self): @@ -41,7 +48,11 @@ class GunzipTest(unittest.TestCase): self.assertFalse(gzip_magic_number(r1)) def test_gunzip_illegal_eof(self): - text = html_to_unicode('charset=cp1252', gunzip((SAMPLEDIR / 'unexpected-eof.gz').read_bytes()))[1] - expected_text = (SAMPLEDIR / 'unexpected-eof-output.txt').read_text(encoding="utf-8") + text = html_to_unicode( + "charset=cp1252", gunzip((SAMPLEDIR / "unexpected-eof.gz").read_bytes()) + )[1] + expected_text = (SAMPLEDIR / "unexpected-eof-output.txt").read_text( + encoding="utf-8" + ) self.assertEqual(len(text), len(expected_text)) self.assertEqual(text, expected_text) diff --git a/tests/test_utils_httpobj.py b/tests/test_utils_httpobj.py index cf8ad1f23..b824972d5 100644 --- a/tests/test_utils_httpobj.py +++ b/tests/test_utils_httpobj.py @@ -6,7 +6,6 @@ from scrapy.utils.httpobj import urlparse_cached class HttpobjUtilsTest(unittest.TestCase): - def test_urlparse_cached(self): url = "http://www.example.com/index.html" request1 = Request(url) diff --git a/tests/test_utils_iterators.py b/tests/test_utils_iterators.py index ba3136b96..893582a32 100644 --- a/tests/test_utils_iterators.py +++ b/tests/test_utils_iterators.py @@ -28,14 +28,18 @@ class XmliterTestCase(unittest.TestCase): response = XmlResponse(url="http://example.com", body=body) attrs = [] - for x in self.xmliter(response, 'product'): - attrs.append(( - x.attrib['id'], - x.xpath("name/text()").getall(), - x.xpath("./type/text()").getall())) + for x in self.xmliter(response, "product"): + attrs.append( + ( + x.attrib["id"], + x.xpath("name/text()").getall(), + x.xpath("./type/text()").getall(), + ) + ) - self.assertEqual(attrs, - [('001', ['Name 1'], ['Type 1']), ('002', ['Name 2'], ['Type 2'])]) + self.assertEqual( + attrs, [("001", ["Name 1"], ["Type 1"]), ("002", ["Name 2"], ["Type 2"])] + ) def test_xmliter_unusual_node(self): body = b""" @@ -45,8 +49,10 @@ class XmliterTestCase(unittest.TestCase): """ response = XmlResponse(url="http://example.com", body=body) - nodenames = [e.xpath('name()').getall() for e in self.xmliter(response, 'matchme...')] - self.assertEqual(nodenames, [['matchme...']]) + nodenames = [ + e.xpath("name()").getall() for e in self.xmliter(response, "matchme...") + ] + self.assertEqual(nodenames, [["matchme..."]]) def test_xmliter_unicode(self): # example taken from https://github.com/scrapy/scrapy/issues/1665 @@ -88,29 +94,35 @@ class XmliterTestCase(unittest.TestCase): for r in ( # with bytes - XmlResponse(url="http://example.com", body=body.encode('utf-8')), + XmlResponse(url="http://example.com", body=body.encode("utf-8")), # Unicode body needs encoding information - XmlResponse(url="http://example.com", body=body, encoding='utf-8'), + XmlResponse(url="http://example.com", body=body, encoding="utf-8"), ): attrs = [] - for x in self.xmliter(r, 'þingflokkur'): - attrs.append((x.attrib['id'], - x.xpath('./skammstafanir/stuttskammstöfun/text()').getall(), - x.xpath('./tímabil/fyrstaþing/text()').getall())) + for x in self.xmliter(r, "þingflokkur"): + attrs.append( + ( + x.attrib["id"], + x.xpath("./skammstafanir/stuttskammstöfun/text()").getall(), + x.xpath("./tímabil/fyrstaþing/text()").getall(), + ) + ) - self.assertEqual(attrs, - [('26', ['-'], ['80']), - ('21', ['Ab'], ['76']), - ('27', ['A'], ['27'])]) + self.assertEqual( + attrs, + [("26", ["-"], ["80"]), ("21", ["Ab"], ["76"]), ("27", ["A"], ["27"])], + ) def test_xmliter_text(self): body = ( '' - 'onetwo' + "onetwo" ) - self.assertEqual([x.xpath("text()").getall() for x in self.xmliter(body, 'product')], - [['one'], ['two']]) + self.assertEqual( + [x.xpath("text()").getall() for x in self.xmliter(body, "product")], + [["one"], ["two"]], + ) def test_xmliter_namespaces(self): body = b""" @@ -131,22 +143,25 @@ class XmliterTestCase(unittest.TestCase): """ - response = XmlResponse(url='http://mydummycompany.com', body=body) - my_iter = self.xmliter(response, 'item') + response = XmlResponse(url="http://mydummycompany.com", body=body) + my_iter = self.xmliter(response, "item") node = next(my_iter) - node.register_namespace('g', 'http://base.google.com/ns/1.0') - self.assertEqual(node.xpath('title/text()').getall(), ['Item 1']) - self.assertEqual(node.xpath('description/text()').getall(), ['This is item 1']) - self.assertEqual(node.xpath('link/text()').getall(), ['http://www.mydummycompany.com/items/1']) + node.register_namespace("g", "http://base.google.com/ns/1.0") + self.assertEqual(node.xpath("title/text()").getall(), ["Item 1"]) + self.assertEqual(node.xpath("description/text()").getall(), ["This is item 1"]) self.assertEqual( - node.xpath('g:image_link/text()').getall(), - ['http://www.mydummycompany.com/images/item1.jpg'] + node.xpath("link/text()").getall(), + ["http://www.mydummycompany.com/items/1"], ) - self.assertEqual(node.xpath('g:id/text()').getall(), ['ITEM_1']) - self.assertEqual(node.xpath('g:price/text()').getall(), ['400']) - self.assertEqual(node.xpath('image_link/text()').getall(), []) - self.assertEqual(node.xpath('id/text()').getall(), []) - self.assertEqual(node.xpath('price/text()').getall(), []) + self.assertEqual( + node.xpath("g:image_link/text()").getall(), + ["http://www.mydummycompany.com/images/item1.jpg"], + ) + self.assertEqual(node.xpath("g:id/text()").getall(), ["ITEM_1"]) + self.assertEqual(node.xpath("g:price/text()").getall(), ["400"]) + self.assertEqual(node.xpath("image_link/text()").getall(), []) + self.assertEqual(node.xpath("id/text()").getall(), []) + self.assertEqual(node.xpath("price/text()").getall(), []) def test_xmliter_namespaced_nodename(self): body = b""" @@ -167,11 +182,14 @@ class XmliterTestCase(unittest.TestCase): """ - response = XmlResponse(url='http://mydummycompany.com', body=body) - my_iter = self.xmliter(response, 'g:image_link') + response = XmlResponse(url="http://mydummycompany.com", body=body) + my_iter = self.xmliter(response, "g:image_link") node = next(my_iter) - node.register_namespace('g', 'http://base.google.com/ns/1.0') - self.assertEqual(node.xpath('text()').extract(), ['http://www.mydummycompany.com/images/item1.jpg']) + node.register_namespace("g", "http://base.google.com/ns/1.0") + self.assertEqual( + node.xpath("text()").extract(), + ["http://www.mydummycompany.com/images/item1.jpg"], + ) def test_xmliter_namespaced_nodename_missing(self): body = b""" @@ -192,45 +210,45 @@ class XmliterTestCase(unittest.TestCase): """ - response = XmlResponse(url='http://mydummycompany.com', body=body) - my_iter = self.xmliter(response, 'g:link_image') + response = XmlResponse(url="http://mydummycompany.com", body=body) + my_iter = self.xmliter(response, "g:link_image") with self.assertRaises(StopIteration): next(my_iter) def test_xmliter_exception(self): body = ( '' - 'onetwo' + "onetwo" ) - iter = self.xmliter(body, 'product') + iter = self.xmliter(body, "product") next(iter) next(iter) self.assertRaises(StopIteration, next, iter) def test_xmliter_objtype_exception(self): - i = self.xmliter(42, 'product') + i = self.xmliter(42, "product") self.assertRaises(TypeError, next, i) def test_xmliter_encoding(self): body = ( b'\n' - b'\n' - b' Some Turkish Characters \xd6\xc7\xde\xdd\xd0\xdc \xfc\xf0\xfd\xfe\xe7\xf6\n' - b'\n\n' + b"\n" + b" Some Turkish Characters \xd6\xc7\xde\xdd\xd0\xdc \xfc\xf0\xfd\xfe\xe7\xf6\n" + b"\n\n" ) - response = XmlResponse('http://www.example.com', body=body) + response = XmlResponse("http://www.example.com", body=body) self.assertEqual( - next(self.xmliter(response, 'item')).get(), - 'Some Turkish Characters \xd6\xc7\u015e\u0130\u011e\xdc \xfc\u011f\u0131\u015f\xe7\xf6' + next(self.xmliter(response, "item")).get(), + "Some Turkish Characters \xd6\xc7\u015e\u0130\u011e\xdc \xfc\u011f\u0131\u015f\xe7\xf6", ) class LxmlXmliterTestCase(XmliterTestCase): xmliter = staticmethod(xmliter_lxml) - @mark.xfail(reason='known bug of the current implementation') + @mark.xfail(reason="known bug of the current implementation") def test_xmliter_namespaced_nodename(self): super().test_xmliter_namespaced_nodename() @@ -252,16 +270,24 @@ class LxmlXmliterTestCase(XmliterTestCase): """ - response = XmlResponse(url='http://mydummycompany.com', body=body) + response = XmlResponse(url="http://mydummycompany.com", body=body) - no_namespace_iter = self.xmliter(response, 'image_link') + no_namespace_iter = self.xmliter(response, "image_link") self.assertEqual(len(list(no_namespace_iter)), 0) - namespace_iter = self.xmliter(response, 'image_link', 'http://base.google.com/ns/1.0') + namespace_iter = self.xmliter( + response, "image_link", "http://base.google.com/ns/1.0" + ) node = next(namespace_iter) - self.assertEqual(node.xpath('text()').getall(), ['http://www.mydummycompany.com/images/item1.jpg']) + self.assertEqual( + node.xpath("text()").getall(), + ["http://www.mydummycompany.com/images/item1.jpg"], + ) node = next(namespace_iter) - self.assertEqual(node.xpath('text()').getall(), ['http://www.mydummycompany.com/images/item2.jpg']) + self.assertEqual( + node.xpath("text()").getall(), + ["http://www.mydummycompany.com/images/item2.jpg"], + ) def test_xmliter_namespaces_prefix(self): body = b""" @@ -282,36 +308,42 @@ class LxmlXmliterTestCase(XmliterTestCase): """ - response = XmlResponse(url='http://mydummycompany.com', body=body) - my_iter = self.xmliter(response, 'table', 'http://www.w3.org/TR/html4/', 'h') + response = XmlResponse(url="http://mydummycompany.com", body=body) + my_iter = self.xmliter(response, "table", "http://www.w3.org/TR/html4/", "h") node = next(my_iter) - self.assertEqual(len(node.xpath('h:tr/h:td').getall()), 2) - self.assertEqual(node.xpath('h:tr/h:td[1]/text()').getall(), ['Apples']) - self.assertEqual(node.xpath('h:tr/h:td[2]/text()').getall(), ['Bananas']) + self.assertEqual(len(node.xpath("h:tr/h:td").getall()), 2) + self.assertEqual(node.xpath("h:tr/h:td[1]/text()").getall(), ["Apples"]) + self.assertEqual(node.xpath("h:tr/h:td[2]/text()").getall(), ["Bananas"]) - my_iter = self.xmliter(response, 'table', 'http://www.w3schools.com/furniture', 'f') + my_iter = self.xmliter( + response, "table", "http://www.w3schools.com/furniture", "f" + ) node = next(my_iter) - self.assertEqual(node.xpath('f:name/text()').getall(), ['African Coffee Table']) + self.assertEqual(node.xpath("f:name/text()").getall(), ["African Coffee Table"]) def test_xmliter_objtype_exception(self): - i = self.xmliter(42, 'product') + i = self.xmliter(42, "product") self.assertRaises(TypeError, next, i) class UtilsCsvTestCase(unittest.TestCase): def test_csviter_defaults(self): - body = get_testdata('feeds', 'feed-sample3.csv') + body = get_testdata("feeds", "feed-sample3.csv") response = TextResponse(url="http://example.com/", body=body) csv = csviter(response) result = [row for row in csv] - self.assertEqual(result, - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + result, + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) # explicit type check cuz' we no like stinkin' autocasting! yarrr for result_row in result: @@ -319,88 +351,120 @@ class UtilsCsvTestCase(unittest.TestCase): self.assertTrue(all((isinstance(v, str) for v in result_row.values()))) def test_csviter_delimiter(self): - body = get_testdata('feeds', 'feed-sample3.csv').replace(b',', b'\t') + body = get_testdata("feeds", "feed-sample3.csv").replace(b",", b"\t") response = TextResponse(url="http://example.com/", body=body) - csv = csviter(response, delimiter='\t') + csv = csviter(response, delimiter="\t") - self.assertEqual([row for row in csv], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) def test_csviter_quotechar(self): - body1 = get_testdata('feeds', 'feed-sample6.csv') - body2 = get_testdata('feeds', 'feed-sample6.csv').replace(b',', b'|') + body1 = get_testdata("feeds", "feed-sample6.csv") + body2 = get_testdata("feeds", "feed-sample6.csv").replace(b",", b"|") response1 = TextResponse(url="http://example.com/", body=body1) csv1 = csviter(response1, quotechar="'") - self.assertEqual([row for row in csv1], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv1], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) response2 = TextResponse(url="http://example.com/", body=body2) csv2 = csviter(response2, delimiter="|", quotechar="'") - self.assertEqual([row for row in csv2], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv2], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) def test_csviter_wrong_quotechar(self): - body = get_testdata('feeds', 'feed-sample6.csv') + body = get_testdata("feeds", "feed-sample6.csv") response = TextResponse(url="http://example.com/", body=body) csv = csviter(response) - self.assertEqual([row for row in csv], - [{"'id'": "1", "'name'": "'alpha'", "'value'": "'foobar'"}, - {"'id'": "2", "'name'": "'unicode'", "'value'": "'\xfan\xedc\xf3d\xe9\u203d'"}, - {"'id'": "'3'", "'name'": "'multi'", "'value'": "'foo"}, - {"'id'": "4", "'name'": "'empty'", "'value'": ""}]) + self.assertEqual( + [row for row in csv], + [ + {"'id'": "1", "'name'": "'alpha'", "'value'": "'foobar'"}, + { + "'id'": "2", + "'name'": "'unicode'", + "'value'": "'\xfan\xedc\xf3d\xe9\u203d'", + }, + {"'id'": "'3'", "'name'": "'multi'", "'value'": "'foo"}, + {"'id'": "4", "'name'": "'empty'", "'value'": ""}, + ], + ) def test_csviter_delimiter_binary_response_assume_utf8_encoding(self): - body = get_testdata('feeds', 'feed-sample3.csv').replace(b',', b'\t') + body = get_testdata("feeds", "feed-sample3.csv").replace(b",", b"\t") response = Response(url="http://example.com/", body=body) - csv = csviter(response, delimiter='\t') + csv = csviter(response, delimiter="\t") - self.assertEqual([row for row in csv], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) def test_csviter_headers(self): - sample = get_testdata('feeds', 'feed-sample3.csv').splitlines() - headers, body = sample[0].split(b','), b'\n'.join(sample[1:]) + sample = get_testdata("feeds", "feed-sample3.csv").splitlines() + headers, body = sample[0].split(b","), b"\n".join(sample[1:]) response = TextResponse(url="http://example.com/", body=body) - csv = csviter(response, headers=[h.decode('utf-8') for h in headers]) + csv = csviter(response, headers=[h.decode("utf-8") for h in headers]) - self.assertEqual([row for row in csv], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': 'foo\nbar'}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) def test_csviter_falserow(self): - body = get_testdata('feeds', 'feed-sample3.csv') - body = b'\n'.join((body, b'a,b', b'a,b,c,d')) + body = get_testdata("feeds", "feed-sample3.csv") + body = b"\n".join((body, b"a,b", b"a,b,c,d")) response = TextResponse(url="http://example.com/", body=body) csv = csviter(response) - self.assertEqual([row for row in csv], - [{'id': '1', 'name': 'alpha', 'value': 'foobar'}, - {'id': '2', 'name': 'unicode', 'value': '\xfan\xedc\xf3d\xe9\u203d'}, - {'id': '3', 'name': 'multi', 'value': "foo\nbar"}, - {'id': '4', 'name': 'empty', 'value': ''}]) + self.assertEqual( + [row for row in csv], + [ + {"id": "1", "name": "alpha", "value": "foobar"}, + {"id": "2", "name": "unicode", "value": "\xfan\xedc\xf3d\xe9\u203d"}, + {"id": "3", "name": "multi", "value": "foo\nbar"}, + {"id": "4", "name": "empty", "value": ""}, + ], + ) def test_csviter_exception(self): - body = get_testdata('feeds', 'feed-sample3.csv') + body = get_testdata("feeds", "feed-sample3.csv") response = TextResponse(url="http://example.com/", body=body) iter = csviter(response) @@ -412,35 +476,41 @@ class UtilsCsvTestCase(unittest.TestCase): self.assertRaises(StopIteration, next, iter) def test_csviter_encoding(self): - body1 = get_testdata('feeds', 'feed-sample4.csv') - body2 = get_testdata('feeds', 'feed-sample5.csv') + body1 = get_testdata("feeds", "feed-sample4.csv") + body2 = get_testdata("feeds", "feed-sample5.csv") - response = TextResponse(url="http://example.com/", body=body1, encoding='latin1') + response = TextResponse( + url="http://example.com/", body=body1, encoding="latin1" + ) csv = csviter(response) self.assertEqual( list(csv), [ - {'id': '1', 'name': 'latin1', 'value': 'test'}, - {'id': '2', 'name': 'something', 'value': '\xf1\xe1\xe9\xf3'}, - ] + {"id": "1", "name": "latin1", "value": "test"}, + {"id": "2", "name": "something", "value": "\xf1\xe1\xe9\xf3"}, + ], ) - response = TextResponse(url="http://example.com/", body=body2, encoding='cp852') + response = TextResponse(url="http://example.com/", body=body2, encoding="cp852") csv = csviter(response) self.assertEqual( list(csv), [ - {'id': '1', 'name': 'cp852', 'value': 'test'}, - {'id': '2', 'name': 'something', 'value': '\u255a\u2569\u2569\u2569\u2550\u2550\u2557'}, - ] + {"id": "1", "name": "cp852", "value": "test"}, + { + "id": "2", + "name": "something", + "value": "\u255a\u2569\u2569\u2569\u2550\u2550\u2557", + }, + ], ) class TestHelper(unittest.TestCase): - bbody = b'utf8-body' - ubody = bbody.decode('utf8') - txtresponse = TextResponse(url='http://example.org/', body=bbody, encoding='utf-8') - response = Response(url='http://example.org/', body=bbody) + bbody = b"utf8-body" + ubody = bbody.decode("utf8") + txtresponse = TextResponse(url="http://example.org/", body=bbody, encoding="utf-8") + response = Response(url="http://example.org/", body=bbody) def test_body_or_str(self): for obj in (self.bbody, self.ubody, self.txtresponse, self.response): @@ -454,8 +524,9 @@ class TestHelper(unittest.TestCase): self.assertTrue(type(r1) is not type(r3)) def _assert_type_and_value(self, a, b, obj): - self.assertTrue(type(a) is type(b), - f'Got {type(a)}, expected {type(b)} for { obj!r}') + self.assertTrue( + type(a) is type(b), f"Got {type(a)}, expected {type(b)} for { obj!r}" + ) self.assertEqual(a, b) diff --git a/tests/test_utils_log.py b/tests/test_utils_log.py index 535f56691..438dd0cdc 100644 --- a/tests/test_utils_log.py +++ b/tests/test_utils_log.py @@ -5,14 +5,17 @@ import unittest from testfixtures import LogCapture from twisted.python.failure import Failure -from scrapy.utils.log import (failure_to_exc_info, TopLevelFormatter, - LogCounterHandler, StreamLogger) +from scrapy.utils.log import ( + failure_to_exc_info, + TopLevelFormatter, + LogCounterHandler, + StreamLogger, +) from scrapy.utils.test import get_crawler from scrapy.extensions import telnet class FailureToExcInfoTest(unittest.TestCase): - def test_failure(self): try: 0 / 0 @@ -23,48 +26,46 @@ class FailureToExcInfoTest(unittest.TestCase): self.assertTupleEqual(exc_info, failure_to_exc_info(failure)) def test_non_failure(self): - self.assertIsNone(failure_to_exc_info('test')) + self.assertIsNone(failure_to_exc_info("test")) class TopLevelFormatterTest(unittest.TestCase): - def setUp(self): self.handler = LogCapture() - self.handler.addFilter(TopLevelFormatter(['test'])) + self.handler.addFilter(TopLevelFormatter(["test"])) def test_top_level_logger(self): - logger = logging.getLogger('test') + logger = logging.getLogger("test") with self.handler as log: - logger.warning('test log msg') - log.check(('test', 'WARNING', 'test log msg')) + logger.warning("test log msg") + log.check(("test", "WARNING", "test log msg")) def test_children_logger(self): - logger = logging.getLogger('test.test1') + logger = logging.getLogger("test.test1") with self.handler as log: - logger.warning('test log msg') - log.check(('test', 'WARNING', 'test log msg')) + logger.warning("test log msg") + log.check(("test", "WARNING", "test log msg")) def test_overlapping_name_logger(self): - logger = logging.getLogger('test2') + logger = logging.getLogger("test2") with self.handler as log: - logger.warning('test log msg') - log.check(('test2', 'WARNING', 'test log msg')) + logger.warning("test log msg") + log.check(("test2", "WARNING", "test log msg")) def test_different_name_logger(self): - logger = logging.getLogger('different') + logger = logging.getLogger("different") with self.handler as log: - logger.warning('test log msg') - log.check(('different', 'WARNING', 'test log msg')) + logger.warning("test log msg") + log.check(("different", "WARNING", "test log msg")) class LogCounterHandlerTest(unittest.TestCase): - def setUp(self): - settings = {'LOG_LEVEL': 'WARNING'} + settings = {"LOG_LEVEL": "WARNING"} if not telnet.TWISTED_CONCH_AVAILABLE: # disable it to avoid the extra warning - settings['TELNETCONSOLE_ENABLED'] = False - self.logger = logging.getLogger('test') + settings["TELNETCONSOLE_ENABLED"] = False + self.logger = logging.getLogger("test") self.logger.setLevel(logging.NOTSET) self.logger.propagate = False self.crawler = get_crawler(settings_dict=settings) @@ -76,26 +77,25 @@ class LogCounterHandlerTest(unittest.TestCase): self.logger.removeHandler(self.handler) def test_init(self): - self.assertIsNone(self.crawler.stats.get_value('log_count/DEBUG')) - self.assertIsNone(self.crawler.stats.get_value('log_count/INFO')) - self.assertIsNone(self.crawler.stats.get_value('log_count/WARNING')) - self.assertIsNone(self.crawler.stats.get_value('log_count/ERROR')) - self.assertIsNone(self.crawler.stats.get_value('log_count/CRITICAL')) + self.assertIsNone(self.crawler.stats.get_value("log_count/DEBUG")) + self.assertIsNone(self.crawler.stats.get_value("log_count/INFO")) + self.assertIsNone(self.crawler.stats.get_value("log_count/WARNING")) + self.assertIsNone(self.crawler.stats.get_value("log_count/ERROR")) + self.assertIsNone(self.crawler.stats.get_value("log_count/CRITICAL")) def test_accepted_level(self): - self.logger.error('test log msg') - self.assertEqual(self.crawler.stats.get_value('log_count/ERROR'), 1) + self.logger.error("test log msg") + self.assertEqual(self.crawler.stats.get_value("log_count/ERROR"), 1) def test_filtered_out_level(self): - self.logger.debug('test log msg') - self.assertIsNone(self.crawler.stats.get_value('log_count/INFO')) + self.logger.debug("test log msg") + self.assertIsNone(self.crawler.stats.get_value("log_count/INFO")) class StreamLoggerTest(unittest.TestCase): - def setUp(self): self.stdout = sys.stdout - logger = logging.getLogger('test') + logger = logging.getLogger("test") logger.setLevel(logging.WARNING) sys.stdout = StreamLogger(logger, logging.ERROR) @@ -104,5 +104,5 @@ class StreamLoggerTest(unittest.TestCase): def test_redirect(self): with LogCapture() as log: - print('test log msg') - log.check(('test', 'ERROR', 'test log msg')) + print("test log msg") + log.check(("test", "ERROR", "test log msg")) diff --git a/tests/test_utils_misc/__init__.py b/tests/test_utils_misc/__init__.py index dc5b9e123..38a61036c 100644 --- a/tests/test_utils_misc/__init__.py +++ b/tests/test_utils_misc/__init__.py @@ -5,118 +5,122 @@ from pathlib import Path from unittest import mock from scrapy.item import Item, Field -from scrapy.utils.misc import arg_to_iter, create_instance, load_object, rel_has_nofollow, set_environ, walk_modules +from scrapy.utils.misc import ( + arg_to_iter, + create_instance, + load_object, + rel_has_nofollow, + set_environ, + walk_modules, +) -__doctests__ = ['scrapy.utils.misc'] +__doctests__ = ["scrapy.utils.misc"] class UtilsMiscTestCase(unittest.TestCase): - def test_load_object_class(self): obj = load_object(Field) self.assertIs(obj, Field) - obj = load_object('scrapy.item.Field') + obj = load_object("scrapy.item.Field") self.assertIs(obj, Field) def test_load_object_function(self): obj = load_object(load_object) self.assertIs(obj, load_object) - obj = load_object('scrapy.utils.misc.load_object') + obj = load_object("scrapy.utils.misc.load_object") self.assertIs(obj, load_object) def test_load_object_exceptions(self): - self.assertRaises(ImportError, load_object, 'nomodule999.mod.function') - self.assertRaises(NameError, load_object, 'scrapy.utils.misc.load_object999') + self.assertRaises(ImportError, load_object, "nomodule999.mod.function") + self.assertRaises(NameError, load_object, "scrapy.utils.misc.load_object999") self.assertRaises(TypeError, load_object, {}) def test_walk_modules(self): - mods = walk_modules('tests.test_utils_misc.test_walk_modules') + mods = walk_modules("tests.test_utils_misc.test_walk_modules") expected = [ - 'tests.test_utils_misc.test_walk_modules', - 'tests.test_utils_misc.test_walk_modules.mod', - 'tests.test_utils_misc.test_walk_modules.mod.mod0', - 'tests.test_utils_misc.test_walk_modules.mod1', + "tests.test_utils_misc.test_walk_modules", + "tests.test_utils_misc.test_walk_modules.mod", + "tests.test_utils_misc.test_walk_modules.mod.mod0", + "tests.test_utils_misc.test_walk_modules.mod1", ] self.assertEqual({m.__name__ for m in mods}, set(expected)) - mods = walk_modules('tests.test_utils_misc.test_walk_modules.mod') + mods = walk_modules("tests.test_utils_misc.test_walk_modules.mod") expected = [ - 'tests.test_utils_misc.test_walk_modules.mod', - 'tests.test_utils_misc.test_walk_modules.mod.mod0', + "tests.test_utils_misc.test_walk_modules.mod", + "tests.test_utils_misc.test_walk_modules.mod.mod0", ] self.assertEqual({m.__name__ for m in mods}, set(expected)) - mods = walk_modules('tests.test_utils_misc.test_walk_modules.mod1') + mods = walk_modules("tests.test_utils_misc.test_walk_modules.mod1") expected = [ - 'tests.test_utils_misc.test_walk_modules.mod1', + "tests.test_utils_misc.test_walk_modules.mod1", ] self.assertEqual({m.__name__ for m in mods}, set(expected)) - self.assertRaises(ImportError, walk_modules, 'nomodule999') + self.assertRaises(ImportError, walk_modules, "nomodule999") def test_walk_modules_egg(self): - egg = str(Path(__file__).parent / 'test.egg') + egg = str(Path(__file__).parent / "test.egg") sys.path.append(egg) try: - mods = walk_modules('testegg') + mods = walk_modules("testegg") expected = [ - 'testegg.spiders', - 'testegg.spiders.a', - 'testegg.spiders.b', - 'testegg' + "testegg.spiders", + "testegg.spiders.a", + "testegg.spiders.b", + "testegg", ] self.assertEqual({m.__name__ for m in mods}, set(expected)) finally: sys.path.remove(egg) def test_arg_to_iter(self): - class TestItem(Item): name = Field() - assert hasattr(arg_to_iter(None), '__iter__') - assert hasattr(arg_to_iter(100), '__iter__') - assert hasattr(arg_to_iter('lala'), '__iter__') - assert hasattr(arg_to_iter([1, 2, 3]), '__iter__') - assert hasattr(arg_to_iter(c for c in 'abcd'), '__iter__') + assert hasattr(arg_to_iter(None), "__iter__") + assert hasattr(arg_to_iter(100), "__iter__") + assert hasattr(arg_to_iter("lala"), "__iter__") + assert hasattr(arg_to_iter([1, 2, 3]), "__iter__") + assert hasattr(arg_to_iter(c for c in "abcd"), "__iter__") self.assertEqual(list(arg_to_iter(None)), []) - self.assertEqual(list(arg_to_iter('lala')), ['lala']) + self.assertEqual(list(arg_to_iter("lala")), ["lala"]) self.assertEqual(list(arg_to_iter(100)), [100]) - self.assertEqual(list(arg_to_iter(c for c in 'abc')), ['a', 'b', 'c']) + self.assertEqual(list(arg_to_iter(c for c in "abc")), ["a", "b", "c"]) self.assertEqual(list(arg_to_iter([1, 2, 3])), [1, 2, 3]) - self.assertEqual(list(arg_to_iter({'a': 1})), [{'a': 1}]) - self.assertEqual(list(arg_to_iter(TestItem(name="john"))), [TestItem(name="john")]) + self.assertEqual(list(arg_to_iter({"a": 1})), [{"a": 1}]) + self.assertEqual( + list(arg_to_iter(TestItem(name="john"))), [TestItem(name="john")] + ) def test_create_instance(self): settings = mock.MagicMock() - crawler = mock.MagicMock(spec_set=['settings']) - args = (True, 100.) - kwargs = {'key': 'val'} + crawler = mock.MagicMock(spec_set=["settings"]) + args = (True, 100.0) + kwargs = {"key": "val"} def _test_with_settings(mock, settings): create_instance(mock, settings, None, *args, **kwargs) - if hasattr(mock, 'from_crawler'): + if hasattr(mock, "from_crawler"): self.assertEqual(mock.from_crawler.call_count, 0) - if hasattr(mock, 'from_settings'): - mock.from_settings.assert_called_once_with(settings, *args, - **kwargs) + if hasattr(mock, "from_settings"): + mock.from_settings.assert_called_once_with(settings, *args, **kwargs) self.assertEqual(mock.call_count, 0) else: mock.assert_called_once_with(*args, **kwargs) def _test_with_crawler(mock, settings, crawler): create_instance(mock, settings, crawler, *args, **kwargs) - if hasattr(mock, 'from_crawler'): - mock.from_crawler.assert_called_once_with(crawler, *args, - **kwargs) - if hasattr(mock, 'from_settings'): + if hasattr(mock, "from_crawler"): + mock.from_crawler.assert_called_once_with(crawler, *args, **kwargs) + if hasattr(mock, "from_settings"): self.assertEqual(mock.from_settings.call_count, 0) self.assertEqual(mock.call_count, 0) - elif hasattr(mock, 'from_settings'): - mock.from_settings.assert_called_once_with(settings, *args, - **kwargs) + elif hasattr(mock, "from_settings"): + mock.from_settings.assert_called_once_with(settings, *args, **kwargs) self.assertEqual(mock.call_count, 0) else: mock.assert_called_once_with(*args, **kwargs) @@ -127,10 +131,10 @@ class UtilsMiscTestCase(unittest.TestCase): # 3. with from_crawler() constructor # 4. with from_settings() and from_crawler() constructor spec_sets = ( - ['__qualname__'], - ['__qualname__', 'from_settings'], - ['__qualname__', 'from_crawler'], - ['__qualname__', 'from_settings', 'from_crawler'], + ["__qualname__"], + ["__qualname__", "from_settings"], + ["__qualname__", "from_crawler"], + ["__qualname__", "from_settings", "from_crawler"], ) for specs in spec_sets: m = mock.MagicMock(spec_set=specs) @@ -139,10 +143,9 @@ class UtilsMiscTestCase(unittest.TestCase): _test_with_crawler(m, settings, crawler) # Check adoption of crawler settings - m = mock.MagicMock(spec_set=['__qualname__', 'from_settings']) + m = mock.MagicMock(spec_set=["__qualname__", "from_settings"]) create_instance(m, None, crawler, *args, **kwargs) - m.from_settings.assert_called_once_with(crawler.settings, *args, - **kwargs) + m.from_settings.assert_called_once_with(crawler.settings, *args, **kwargs) with self.assertRaises(ValueError): create_instance(m, None, None) @@ -152,25 +155,25 @@ class UtilsMiscTestCase(unittest.TestCase): create_instance(m, settings, None) def test_set_environ(self): - assert os.environ.get('some_test_environ') is None - with set_environ(some_test_environ='test_value'): - assert os.environ.get('some_test_environ') == 'test_value' - assert os.environ.get('some_test_environ') is None + assert os.environ.get("some_test_environ") is None + with set_environ(some_test_environ="test_value"): + assert os.environ.get("some_test_environ") == "test_value" + assert os.environ.get("some_test_environ") is None - os.environ['some_test_environ'] = 'test' - assert os.environ.get('some_test_environ') == 'test' - with set_environ(some_test_environ='test_value'): - assert os.environ.get('some_test_environ') == 'test_value' - assert os.environ.get('some_test_environ') == 'test' + os.environ["some_test_environ"] = "test" + assert os.environ.get("some_test_environ") == "test" + with set_environ(some_test_environ="test_value"): + assert os.environ.get("some_test_environ") == "test_value" + assert os.environ.get("some_test_environ") == "test" def test_rel_has_nofollow(self): - assert rel_has_nofollow('ugc nofollow') is True - assert rel_has_nofollow('ugc,nofollow') is True - assert rel_has_nofollow('ugc') is False - assert rel_has_nofollow('nofollow') is True - assert rel_has_nofollow('nofollowfoo') is False - assert rel_has_nofollow('foonofollow') is False - assert rel_has_nofollow('ugc, , nofollow') is True + assert rel_has_nofollow("ugc nofollow") is True + assert rel_has_nofollow("ugc,nofollow") is True + assert rel_has_nofollow("ugc") is False + assert rel_has_nofollow("nofollow") is True + assert rel_has_nofollow("nofollowfoo") is False + assert rel_has_nofollow("foonofollow") is False + assert rel_has_nofollow("ugc, , nofollow") is True if __name__ == "__main__": diff --git a/tests/test_utils_misc/test_return_with_argument_inside_generator.py b/tests/test_utils_misc/test_return_with_argument_inside_generator.py index 562f72fee..484757035 100644 --- a/tests/test_utils_misc/test_return_with_argument_inside_generator.py +++ b/tests/test_utils_misc/test_return_with_argument_inside_generator.py @@ -3,7 +3,10 @@ import warnings from functools import partial from unittest import mock -from scrapy.utils.misc import is_generator_with_return_value, warn_on_generator_with_return_value +from scrapy.utils.misc import ( + is_generator_with_return_value, + warn_on_generator_with_return_value, +) def _indentation_error(*args, **kwargs): @@ -12,7 +15,7 @@ def _indentation_error(*args, **kwargs): def top_level_return_something(): """ -docstring + docstring """ url = """ https://example.org @@ -23,7 +26,7 @@ https://example.org def top_level_return_none(): """ -docstring + docstring """ url = """ https://example.org @@ -39,7 +42,6 @@ def generator_that_returns_stuff(): class UtilsMiscPy3TestCase(unittest.TestCase): - def test_generators_return_something(self): def f1(): yield 1 @@ -60,7 +62,7 @@ class UtilsMiscPy3TestCase(unittest.TestCase): def i1(): """ -docstring + docstring """ url = """ https://example.org @@ -77,7 +79,10 @@ https://example.org with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(None, top_level_return_something) self.assertEqual(len(w), 1) - self.assertIn('The "NoneType.top_level_return_something" method is a generator', str(w[0].message)) + self.assertIn( + 'The "NoneType.top_level_return_something" method is a generator', + str(w[0].message), + ) with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(None, f1) self.assertEqual(len(w), 1) @@ -121,7 +126,7 @@ https://example.org def k2(): """ -docstring + docstring """ url = """ https://example.org @@ -170,6 +175,7 @@ https://example.org def decorator(func): def inner_func(): func() + return inner_func @decorator @@ -203,7 +209,7 @@ https://example.org @decorator def k3(): """ -docstring + docstring """ url = """ https://example.org @@ -249,12 +255,14 @@ https://example.org warn_on_generator_with_return_value(None, l3) self.assertEqual(len(w), 0) - @mock.patch("scrapy.utils.misc.is_generator_with_return_value", new=_indentation_error) + @mock.patch( + "scrapy.utils.misc.is_generator_with_return_value", new=_indentation_error + ) def test_indentation_error(self): with warnings.catch_warnings(record=True) as w: warn_on_generator_with_return_value(None, top_level_return_none) self.assertEqual(len(w), 1) - self.assertIn('Unable to determine', str(w[0].message)) + self.assertIn("Unable to determine", str(w[0].message)) def test_partial(self): def cb(arg1, arg2): diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index 867e12103..b08e5f475 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -16,7 +16,7 @@ def inside_a_project(): try: os.chdir(project_dir) - Path('scrapy.cfg').touch() + Path("scrapy.cfg").touch() yield project_dir finally: @@ -26,21 +26,15 @@ def inside_a_project(): class ProjectUtilsTest(unittest.TestCase): def test_data_path_outside_project(self): - self.assertEqual( - str(Path('.scrapy', 'somepath')), - data_path('somepath') - ) - abspath = str(Path(os.path.sep, 'absolute', 'path')) + self.assertEqual(str(Path(".scrapy", "somepath")), data_path("somepath")) + abspath = str(Path(os.path.sep, "absolute", "path")) self.assertEqual(abspath, data_path(abspath)) def test_data_path_inside_project(self): with inside_a_project() as proj_path: - expected = Path(proj_path, '.scrapy', 'somepath') - self.assertEqual( - expected.resolve(), - Path(data_path('somepath')).resolve() - ) - abspath = str(Path(os.path.sep, 'absolute', 'path').resolve()) + expected = Path(proj_path, ".scrapy", "somepath") + self.assertEqual(expected.resolve(), Path(data_path("somepath")).resolve()) + abspath = str(Path(os.path.sep, "absolute", "path").resolve()) self.assertEqual(abspath, data_path(abspath)) @@ -59,22 +53,21 @@ def set_env(**update): class GetProjectSettingsTestCase(unittest.TestCase): - def test_valid_envvar(self): - value = 'tests.test_cmdline.settings' + value = "tests.test_cmdline.settings" envvars = { - 'SCRAPY_SETTINGS_MODULE': value, + "SCRAPY_SETTINGS_MODULE": value, } with warnings.catch_warnings(): warnings.simplefilter("error") with set_env(**envvars): settings = get_project_settings() - assert settings.get('SETTINGS_MODULE') == value + assert settings.get("SETTINGS_MODULE") == value def test_invalid_envvar(self): envvars = { - 'SCRAPY_FOO': 'bar', + "SCRAPY_FOO": "bar", } with set_env(**envvars): settings = get_project_settings() @@ -82,12 +75,12 @@ class GetProjectSettingsTestCase(unittest.TestCase): assert settings.get("SCRAPY_FOO") is None def test_valid_and_invalid_envvars(self): - value = 'tests.test_cmdline.settings' + value = "tests.test_cmdline.settings" envvars = { - 'SCRAPY_FOO': 'bar', - 'SCRAPY_SETTINGS_MODULE': value, + "SCRAPY_FOO": "bar", + "SCRAPY_SETTINGS_MODULE": value, } with set_env(**envvars): settings = get_project_settings() - assert settings.get('SETTINGS_MODULE') == value - assert settings.get('SCRAPY_FOO') is None + assert settings.get("SETTINGS_MODULE") == value + assert settings.get("SCRAPY_FOO") is None diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 403e4f8fe..3c6270864 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -7,12 +7,19 @@ from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.defer import deferred_f_from_coro_f, aiter_errback from scrapy.utils.python import ( - memoizemethod_noargs, binary_is_text, equal_attributes, - get_func_args, to_bytes, to_unicode, - without_none_values, MutableChain, MutableAsyncChain) + memoizemethod_noargs, + binary_is_text, + equal_attributes, + get_func_args, + to_bytes, + to_unicode, + without_none_values, + MutableChain, + MutableAsyncChain, +) -__doctests__ = ['scrapy.utils.python'] +__doctests__ = ["scrapy.utils.python"] class MutableChainTest(unittest.TestCase): @@ -79,48 +86,41 @@ class MutableAsyncChainTest(unittest.TestCase): class ToUnicodeTest(unittest.TestCase): def test_converting_an_utf8_encoded_string_to_unicode(self): - self.assertEqual(to_unicode(b'lel\xc3\xb1e'), 'lel\xf1e') + self.assertEqual(to_unicode(b"lel\xc3\xb1e"), "lel\xf1e") def test_converting_a_latin_1_encoded_string_to_unicode(self): - self.assertEqual(to_unicode(b'lel\xf1e', 'latin-1'), 'lel\xf1e') + self.assertEqual(to_unicode(b"lel\xf1e", "latin-1"), "lel\xf1e") def test_converting_a_unicode_to_unicode_should_return_the_same_object(self): - self.assertEqual(to_unicode('\xf1e\xf1e\xf1e'), '\xf1e\xf1e\xf1e') + self.assertEqual(to_unicode("\xf1e\xf1e\xf1e"), "\xf1e\xf1e\xf1e") def test_converting_a_strange_object_should_raise_TypeError(self): self.assertRaises(TypeError, to_unicode, 423) def test_errors_argument(self): - self.assertEqual( - to_unicode(b'a\xedb', 'utf-8', errors='replace'), - 'a\ufffdb' - ) + self.assertEqual(to_unicode(b"a\xedb", "utf-8", errors="replace"), "a\ufffdb") class ToBytesTest(unittest.TestCase): def test_converting_a_unicode_object_to_an_utf_8_encoded_string(self): - self.assertEqual(to_bytes('\xa3 49'), b'\xc2\xa3 49') + self.assertEqual(to_bytes("\xa3 49"), b"\xc2\xa3 49") def test_converting_a_unicode_object_to_a_latin_1_encoded_string(self): - self.assertEqual(to_bytes('\xa3 49', 'latin-1'), b'\xa3 49') + self.assertEqual(to_bytes("\xa3 49", "latin-1"), b"\xa3 49") def test_converting_a_regular_bytes_to_bytes_should_return_the_same_object(self): - self.assertEqual(to_bytes(b'lel\xf1e'), b'lel\xf1e') + self.assertEqual(to_bytes(b"lel\xf1e"), b"lel\xf1e") def test_converting_a_strange_object_should_raise_TypeError(self): self.assertRaises(TypeError, to_bytes, unittest) def test_errors_argument(self): - self.assertEqual( - to_bytes('a\ufffdb', 'latin-1', errors='replace'), - b'a?b' - ) + self.assertEqual(to_bytes("a\ufffdb", "latin-1", errors="replace"), b"a?b") class MemoizedMethodTest(unittest.TestCase): def test_memoizemethod_noargs(self): class A: - @memoizemethod_noargs def cached(self): return object() @@ -141,7 +141,7 @@ class BinaryIsTextTest(unittest.TestCase): assert binary_is_text(b"hello") def test_utf_16_strings_contain_null_bytes(self): - assert binary_is_text("hello".encode('utf-16')) + assert binary_is_text("hello".encode("utf-16")) def test_one_with_encoding(self): assert binary_is_text(b"
Price \xa3
") @@ -151,7 +151,6 @@ class BinaryIsTextTest(unittest.TestCase): class UtilsPythonTestCase(unittest.TestCase): - def test_equal_attributes(self): class Obj: pass @@ -161,44 +160,44 @@ class UtilsPythonTestCase(unittest.TestCase): # no attributes given return False self.assertFalse(equal_attributes(a, b, [])) # not existent attributes - self.assertFalse(equal_attributes(a, b, ['x', 'y'])) + self.assertFalse(equal_attributes(a, b, ["x", "y"])) a.x = 1 b.x = 1 # equal attribute - self.assertTrue(equal_attributes(a, b, ['x'])) + self.assertTrue(equal_attributes(a, b, ["x"])) b.y = 2 # obj1 has no attribute y - self.assertFalse(equal_attributes(a, b, ['x', 'y'])) + self.assertFalse(equal_attributes(a, b, ["x", "y"])) a.y = 2 # equal attributes - self.assertTrue(equal_attributes(a, b, ['x', 'y'])) + self.assertTrue(equal_attributes(a, b, ["x", "y"])) a.y = 1 # differente attributes - self.assertFalse(equal_attributes(a, b, ['x', 'y'])) + self.assertFalse(equal_attributes(a, b, ["x", "y"])) # test callable a.meta = {} b.meta = {} - self.assertTrue(equal_attributes(a, b, ['meta'])) + self.assertTrue(equal_attributes(a, b, ["meta"])) # compare ['meta']['a'] - a.meta['z'] = 1 - b.meta['z'] = 1 + a.meta["z"] = 1 + b.meta["z"] = 1 - get_z = operator.itemgetter('z') - get_meta = operator.attrgetter('meta') + get_z = operator.itemgetter("z") + get_meta = operator.attrgetter("meta") def compare_z(obj): return get_z(get_meta(obj)) - self.assertTrue(equal_attributes(a, b, [compare_z, 'x'])) + self.assertTrue(equal_attributes(a, b, [compare_z, "x"])) # fail z equality - a.meta['z'] = 2 - self.assertFalse(equal_attributes(a, b, [compare_z, 'x'])) + a.meta["z"] = 2 + self.assertFalse(equal_attributes(a, b, [compare_z, "x"])) def test_get_func_args(self): def f1(a, b, c): @@ -218,7 +217,6 @@ class UtilsPythonTestCase(unittest.TestCase): pass class Callable: - def __call__(self, a, b, c): pass @@ -228,33 +226,38 @@ class UtilsPythonTestCase(unittest.TestCase): partial_f2 = functools.partial(f1, b=None) partial_f3 = functools.partial(partial_f2, None) - self.assertEqual(get_func_args(f1), ['a', 'b', 'c']) - self.assertEqual(get_func_args(f2), ['a', 'b', 'c']) - self.assertEqual(get_func_args(f3), ['a', 'b', 'c']) - self.assertEqual(get_func_args(A), ['a', 'b', 'c']) - self.assertEqual(get_func_args(a.method), ['a', 'b', 'c']) - self.assertEqual(get_func_args(partial_f1), ['b', 'c']) - self.assertEqual(get_func_args(partial_f2), ['a', 'c']) - self.assertEqual(get_func_args(partial_f3), ['c']) - self.assertEqual(get_func_args(cal), ['a', 'b', 'c']) + self.assertEqual(get_func_args(f1), ["a", "b", "c"]) + self.assertEqual(get_func_args(f2), ["a", "b", "c"]) + self.assertEqual(get_func_args(f3), ["a", "b", "c"]) + self.assertEqual(get_func_args(A), ["a", "b", "c"]) + self.assertEqual(get_func_args(a.method), ["a", "b", "c"]) + self.assertEqual(get_func_args(partial_f1), ["b", "c"]) + self.assertEqual(get_func_args(partial_f2), ["a", "c"]) + self.assertEqual(get_func_args(partial_f3), ["c"]) + self.assertEqual(get_func_args(cal), ["a", "b", "c"]) self.assertEqual(get_func_args(object), []) - if platform.python_implementation() == 'CPython': + if platform.python_implementation() == "CPython": # TODO: how do we fix this to return the actual argument names? self.assertEqual(get_func_args(str.split), []) self.assertEqual(get_func_args(" ".join), []) self.assertEqual(get_func_args(operator.itemgetter(2)), []) - elif platform.python_implementation() == 'PyPy': - self.assertEqual(get_func_args(str.split, stripself=True), ['sep', 'maxsplit']) - self.assertEqual(get_func_args(operator.itemgetter(2), stripself=True), ['obj']) - self.assertEqual(get_func_args(" ".join, stripself=True), ['iterable']) + elif platform.python_implementation() == "PyPy": + self.assertEqual( + get_func_args(str.split, stripself=True), ["sep", "maxsplit"] + ) + self.assertEqual( + get_func_args(operator.itemgetter(2), stripself=True), ["obj"] + ) + self.assertEqual(get_func_args(" ".join, stripself=True), ["iterable"]) def test_without_none_values(self): self.assertEqual(without_none_values([1, None, 3, 4]), [1, 3, 4]) self.assertEqual(without_none_values((1, None, 3, 4)), (1, 3, 4)) self.assertEqual( - without_none_values({'one': 1, 'none': None, 'three': 3, 'four': 4}), - {'one': 1, 'three': 3, 'four': 4}) + without_none_values({"one": 1, "none": None, "three": 3, "four": 4}), + {"one": 1, "three": 3, "four": 4}, + ) if __name__ == "__main__": diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index a92d9a0ac..4760bf92b 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -23,24 +23,32 @@ from scrapy.utils.test import get_crawler class UtilsRequestTest(unittest.TestCase): - def test_request_authenticate(self): r = Request("http://www.example.com") - request_authenticate(r, 'someuser', 'somepass') - self.assertEqual(r.headers['Authorization'], b'Basic c29tZXVzZXI6c29tZXBhc3M=') + request_authenticate(r, "someuser", "somepass") + self.assertEqual(r.headers["Authorization"], b"Basic c29tZXVzZXI6c29tZXBhc3M=") def test_request_httprepr(self): r1 = Request("http://www.example.com") - self.assertEqual(request_httprepr(r1), b'GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n') + self.assertEqual( + request_httprepr(r1), b"GET / HTTP/1.1\r\nHost: www.example.com\r\n\r\n" + ) r1 = Request("http://www.example.com/some/page.html?arg=1") - self.assertEqual(request_httprepr(r1), b'GET /some/page.html?arg=1 HTTP/1.1\r\nHost: www.example.com\r\n\r\n') - - r1 = Request("http://www.example.com", method='POST', - headers={"Content-type": b"text/html"}, body=b"Some body") self.assertEqual( request_httprepr(r1), - b'POST / HTTP/1.1\r\nHost: www.example.com\r\nContent-Type: text/html\r\n\r\nSome body' + b"GET /some/page.html?arg=1 HTTP/1.1\r\nHost: www.example.com\r\n\r\n", + ) + + r1 = Request( + "http://www.example.com", + method="POST", + headers={"Content-type": b"text/html"}, + body=b"Some body", + ) + self.assertEqual( + request_httprepr(r1), + b"POST / HTTP/1.1\r\nHost: www.example.com\r\nContent-Type: text/html\r\n\r\nSome body", ) def test_request_httprepr_for_non_http_request(self): @@ -61,77 +69,77 @@ class FingerprintTest(unittest.TestCase): known_hashes: Tuple[Tuple[Request, Union[bytes, str], Dict], ...] = ( ( Request("http://example.org"), - b'xs\xd7\x0c3uj\x15\xfe\xd7d\x9b\xa9\t\xe0d\xbf\x9cXD', + b"xs\xd7\x0c3uj\x15\xfe\xd7d\x9b\xa9\t\xe0d\xbf\x9cXD", {}, ), ( Request("https://example.org"), - b'\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l', + b"\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l", {}, ), ( Request("https://example.org?a"), - b'G\xad\xb8Ck\x19\x1c\xed\x838,\x01\xc4\xde;\xee\xa5\x94a\x0c', + b"G\xad\xb8Ck\x19\x1c\xed\x838,\x01\xc4\xde;\xee\xa5\x94a\x0c", {}, ), ( Request("https://example.org?a=b"), - b'\x024MYb\x8a\xc2\x1e\xbc>\xd6\xac*\xda\x9cF\xc1r\x7f\x17', + b"\x024MYb\x8a\xc2\x1e\xbc>\xd6\xac*\xda\x9cF\xc1r\x7f\x17", {}, ), ( Request("https://example.org?a=b&a"), - b't+\xe8*\xfb\x84\xe3v\x1a}\x88p\xc0\xccB\xd7\x9d\xfez\x96', + b"t+\xe8*\xfb\x84\xe3v\x1a}\x88p\xc0\xccB\xd7\x9d\xfez\x96", {}, ), ( Request("https://example.org?a=b&a=c"), - b'\xda\x1ec\xd0\x9c\x08s`\xb4\x9b\xe2\xb6R\xf8k\xef\xeaQG\xef', + b"\xda\x1ec\xd0\x9c\x08s`\xb4\x9b\xe2\xb6R\xf8k\xef\xeaQG\xef", {}, ), ( - Request("https://example.org", method='POST'), - b'\x9d\xcdA\x0fT\x02:\xca\xa0}\x90\xda\x05B\xded\x8aN7\x1d', + Request("https://example.org", method="POST"), + b"\x9d\xcdA\x0fT\x02:\xca\xa0}\x90\xda\x05B\xded\x8aN7\x1d", {}, ), ( - Request("https://example.org", body=b'a'), - b'\xc34z>\xd8\x99\x8b\xda7\x05r\x99I\xa8\xa0x;\xa41_', + Request("https://example.org", body=b"a"), + b"\xc34z>\xd8\x99\x8b\xda7\x05r\x99I\xa8\xa0x;\xa41_", {}, ), ( - Request("https://example.org", method='POST', body=b'a'), - b'5`\xe2y4\xd0\x9d\xee\xe0\xbatw\x87Q\xe8O\xd78\xfc\xe7', + Request("https://example.org", method="POST", body=b"a"), + b"5`\xe2y4\xd0\x9d\xee\xe0\xbatw\x87Q\xe8O\xd78\xfc\xe7", {}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - b'\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l', + Request("https://example.org#a", headers={"A": b"B"}), + b"\xc04\x85P,\xaa\x91\x06\xf8t\xb4\xbd*\xd9\xe9\x8a:m\xc3l", {}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - b']\xc7\x1f\xf2\xafG2\xbc\xa4\xfa\x99\n33\xda\x18\x94\x81U.', - {'include_headers': ['A']}, + Request("https://example.org#a", headers={"A": b"B"}), + b"]\xc7\x1f\xf2\xafG2\xbc\xa4\xfa\x99\n33\xda\x18\x94\x81U.", + {"include_headers": ["A"]}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - b'<\x1a\xeb\x85y\xdeW\xfb\xdcq\x88\xee\xaf\x17\xdd\x0c\xbfH\x18\x1f', - {'keep_fragments': True}, + Request("https://example.org#a", headers={"A": b"B"}), + b"<\x1a\xeb\x85y\xdeW\xfb\xdcq\x88\xee\xaf\x17\xdd\x0c\xbfH\x18\x1f", + {"keep_fragments": True}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - b'\xc1\xef~\x94\x9bS\xc1\x83\t\xdcz8\x9f\xdc{\x11\x16I.\x11', - {'include_headers': ['A'], 'keep_fragments': True}, + Request("https://example.org#a", headers={"A": b"B"}), + b"\xc1\xef~\x94\x9bS\xc1\x83\t\xdcz8\x9f\xdc{\x11\x16I.\x11", + {"include_headers": ["A"], "keep_fragments": True}, ), ( Request("https://example.org/ab"), - b'N\xe5l\xb8\x12@iw\xe2\xf3\x1bp\xea\xffp!u\xe2\x8a\xc6', + b"N\xe5l\xb8\x12@iw\xe2\xf3\x1bp\xea\xffp!u\xe2\x8a\xc6", {}, ), ( - Request("https://example.org/a", body=b'b'), - b'_NOv\xbco$6\xfcW\x9f\xb24g\x9f\xbb\xdd\xa82\xc5', + Request("https://example.org/a", body=b"b"), + b"_NOv\xbco$6\xfcW\x9f\xb24g\x9f\xbb\xdd\xa82\xc5", {}, ), ) @@ -143,42 +151,42 @@ class FingerprintTest(unittest.TestCase): self.assertEqual(self.function(r1), self.function(r2)) def test_query_string_key_without_value(self): - r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78132,199') - r2 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') + r1 = Request("http://www.example.com/hnnoticiaj1.aspx?78132,199") + r2 = Request("http://www.example.com/hnnoticiaj1.aspx?78160,199") self.assertNotEqual(self.function(r1), self.function(r2)) def test_caching(self): - r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') - self.assertEqual( - self.function(r1), - self.cache[r1][self.default_cache_key] - ) + r1 = Request("http://www.example.com/hnnoticiaj1.aspx?78160,199") + self.assertEqual(self.function(r1), self.cache[r1][self.default_cache_key]) def test_header(self): r1 = Request("http://www.example.com/members/offers.html") r2 = Request("http://www.example.com/members/offers.html") - r2.headers['SESSIONID'] = b"somehash" + r2.headers["SESSIONID"] = b"somehash" self.assertEqual(self.function(r1), self.function(r2)) def test_headers(self): r1 = Request("http://www.example.com/") r2 = Request("http://www.example.com/") - r2.headers['Accept-Language'] = b'en' + r2.headers["Accept-Language"] = b"en" r3 = Request("http://www.example.com/") - r3.headers['Accept-Language'] = b'en' - r3.headers['SESSIONID'] = b"somehash" + r3.headers["Accept-Language"] = b"en" + r3.headers["SESSIONID"] = b"somehash" self.assertEqual(self.function(r1), self.function(r2), self.function(r3)) - self.assertEqual(self.function(r1), - self.function(r1, include_headers=['Accept-Language'])) + self.assertEqual( + self.function(r1), self.function(r1, include_headers=["Accept-Language"]) + ) self.assertNotEqual( - self.function(r1), - self.function(r2, include_headers=['Accept-Language'])) + self.function(r1), self.function(r2, include_headers=["Accept-Language"]) + ) - self.assertEqual(self.function(r3, include_headers=['accept-language', 'sessionid']), - self.function(r3, include_headers=['SESSIONID', 'Accept-Language'])) + self.assertEqual( + self.function(r3, include_headers=["accept-language", "sessionid"]), + self.function(r3, include_headers=["SESSIONID", "Accept-Language"]), + ) def test_fragment(self): r1 = Request("http://www.example.com/test.html") @@ -190,8 +198,8 @@ class FingerprintTest(unittest.TestCase): def test_method_and_body(self): r1 = Request("http://www.example.com") - r2 = Request("http://www.example.com", method='POST') - r3 = Request("http://www.example.com", method='POST', body=b'request body') + r2 = Request("http://www.example.com", method="POST") + r3 = Request("http://www.example.com", method="POST", body=b"request body") self.assertNotEqual(self.function(r1), self.function(r2)) self.assertNotEqual(self.function(r2), self.function(r3)) @@ -209,7 +217,7 @@ class FingerprintTest(unittest.TestCase): # would put the body right after the URL. r1 = Request("http://www.example.com/foo") fp1 = self.function(r1) - r2 = Request("http://www.example.com/f", body=b'oo') + r2 = Request("http://www.example.com/f", body=b"oo") fp2 = self.function(r2) self.assertNotEqual(fp1, fp2) @@ -217,13 +225,9 @@ class FingerprintTest(unittest.TestCase): """Test hardcoded hashes, to make sure future changes to not introduce backward incompatibilities.""" actual = [ - self.function(request, **kwargs) - for request, _, kwargs in self.known_hashes - ] - expected = [ - _fingerprint - for _, _fingerprint, _ in self.known_hashes + self.function(request, **kwargs) for request, _, kwargs in self.known_hashes ] + expected = [_fingerprint for _, _fingerprint, _ in self.known_hashes] self.assertEqual(actual, expected) @@ -233,77 +237,77 @@ class RequestFingerprintTest(FingerprintTest): known_hashes: Tuple[Tuple[Request, Union[bytes, str], Dict], ...] = ( ( Request("http://example.org"), - 'b2e5245ef826fd9576c93bd6e392fce3133fab62', + "b2e5245ef826fd9576c93bd6e392fce3133fab62", {}, ), ( Request("https://example.org"), - 'bd10a0a89ea32cdee77917320f1309b0da87e892', + "bd10a0a89ea32cdee77917320f1309b0da87e892", {}, ), ( Request("https://example.org?a"), - '2fb7d48ae02f04b749f40caa969c0bc3c43204ce', + "2fb7d48ae02f04b749f40caa969c0bc3c43204ce", {}, ), ( Request("https://example.org?a=b"), - '42e5fe149b147476e3f67ad0670c57b4cc57856a', + "42e5fe149b147476e3f67ad0670c57b4cc57856a", {}, ), ( Request("https://example.org?a=b&a"), - 'd23a9787cb56c6375c2cae4453c5a8c634526942', + "d23a9787cb56c6375c2cae4453c5a8c634526942", {}, ), ( Request("https://example.org?a=b&a=c"), - '9a18a7a8552a9182b7f1e05d33876409e421e5c5', + "9a18a7a8552a9182b7f1e05d33876409e421e5c5", {}, ), ( - Request("https://example.org", method='POST'), - 'ba20a80cb5c5ca460021ceefb3c2467b2bfd1bc6', + Request("https://example.org", method="POST"), + "ba20a80cb5c5ca460021ceefb3c2467b2bfd1bc6", {}, ), ( - Request("https://example.org", body=b'a'), - '4bb136e54e715a4ea7a9dd1101831765d33f2d60', + Request("https://example.org", body=b"a"), + "4bb136e54e715a4ea7a9dd1101831765d33f2d60", {}, ), ( - Request("https://example.org", method='POST', body=b'a'), - '6c6595374a304b293be762f7b7be3f54e9947c65', + Request("https://example.org", method="POST", body=b"a"), + "6c6595374a304b293be762f7b7be3f54e9947c65", {}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - 'bd10a0a89ea32cdee77917320f1309b0da87e892', + Request("https://example.org#a", headers={"A": b"B"}), + "bd10a0a89ea32cdee77917320f1309b0da87e892", {}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - '515b633cb3ca502a33a9d8c890e889ec1e425e65', - {'include_headers': ['A']}, + Request("https://example.org#a", headers={"A": b"B"}), + "515b633cb3ca502a33a9d8c890e889ec1e425e65", + {"include_headers": ["A"]}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - '505c96e7da675920dfef58725e8c957dfdb38f47', - {'keep_fragments': True}, + Request("https://example.org#a", headers={"A": b"B"}), + "505c96e7da675920dfef58725e8c957dfdb38f47", + {"keep_fragments": True}, ), ( - Request("https://example.org#a", headers={'A': b'B'}), - 'd6f673cdcb661b7970c2b9a00ee63e87d1e2e5da', - {'include_headers': ['A'], 'keep_fragments': True}, + Request("https://example.org#a", headers={"A": b"B"}), + "d6f673cdcb661b7970c2b9a00ee63e87d1e2e5da", + {"include_headers": ["A"], "keep_fragments": True}, ), ( Request("https://example.org/ab"), - '4e2870fee58582d6f81755e9b8fdefe3cba0c951', + "4e2870fee58582d6f81755e9b8fdefe3cba0c951", {}, ), ( - Request("https://example.org/a", body=b'b'), - '4e2870fee58582d6f81755e9b8fdefe3cba0c951', + Request("https://example.org/a", body=b"b"), + "4e2870fee58582d6f81755e9b8fdefe3cba0c951", {}, ), ) @@ -314,36 +318,29 @@ class RequestFingerprintTest(FingerprintTest): def tearDown(self) -> None: warnings.simplefilter("default", ScrapyDeprecationWarning) - @pytest.mark.xfail(reason='known bug kept for backward compatibility', strict=True) + @pytest.mark.xfail(reason="known bug kept for backward compatibility", strict=True) def test_part_separation(self): super().test_part_separation() class RequestFingerprintDeprecationTest(unittest.TestCase): - def test_deprecation_default_parameters(self): with pytest.warns(ScrapyDeprecationWarning) as warnings: request_fingerprint(Request("http://www.example.com")) messages = [str(warning.message) for warning in warnings] self.assertTrue( - any( - 'Call to deprecated function' in message - for message in messages - ) + any("Call to deprecated function" in message for message in messages) ) - self.assertFalse(any('non-default' in message for message in messages)) + self.assertFalse(any("non-default" in message for message in messages)) def test_deprecation_non_default_parameters(self): with pytest.warns(ScrapyDeprecationWarning) as warnings: request_fingerprint(Request("http://www.example.com"), keep_fragments=True) messages = [str(warning.message) for warning in warnings] self.assertTrue( - any( - 'Call to deprecated function' in message - for message in messages - ) + any("Call to deprecated function" in message for message in messages) ) - self.assertTrue(any('non-default' in message for message in messages)) + self.assertTrue(any("non-default" in message for message in messages)) class RequestFingerprintAsBytesTest(FingerprintTest): @@ -352,24 +349,21 @@ class RequestFingerprintAsBytesTest(FingerprintTest): known_hashes = RequestFingerprintTest.known_hashes def test_caching(self): - r1 = Request('http://www.example.com/hnnoticiaj1.aspx?78160,199') + r1 = Request("http://www.example.com/hnnoticiaj1.aspx?78160,199") self.assertEqual( - self.function(r1), - bytes.fromhex(self.cache[r1][self.default_cache_key]) + self.function(r1), bytes.fromhex(self.cache[r1][self.default_cache_key]) ) - @pytest.mark.xfail(reason='known bug kept for backward compatibility', strict=True) + @pytest.mark.xfail(reason="known bug kept for backward compatibility", strict=True) def test_part_separation(self): super().test_part_separation() def test_hashes(self): actual = [ - self.function(request, **kwargs) - for request, _, kwargs in self.known_hashes + self.function(request, **kwargs) for request, _, kwargs in self.known_hashes ] expected = [ - bytes.fromhex(_fingerprint) - for _, _fingerprint, _ in self.known_hashes + bytes.fromhex(_fingerprint) for _, _fingerprint, _ in self.known_hashes ] self.assertEqual(actual, expected) @@ -385,8 +379,10 @@ def request_fingerprint_2_6(request, include_headers=None, keep_fragments=False) if cache_key not in cache: fp = sha1() fp.update(to_bytes(request.method)) - fp.update(to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments))) - fp.update(request.body or b'') + fp.update( + to_bytes(canonicalize_url(request.url, keep_fragments=keep_fragments)) + ) + fp.update(request.body or b"") if include_headers: for hdr in include_headers: if hdr in request.headers: @@ -401,39 +397,38 @@ REQUEST_OBJECTS_TO_TEST = ( Request("http://www.example.com/"), Request("http://www.example.com/query?id=111&cat=222"), Request("http://www.example.com/query?cat=222&id=111"), - Request('http://www.example.com/hnnoticiaj1.aspx?78132,199'), - Request('http://www.example.com/hnnoticiaj1.aspx?78160,199'), + Request("http://www.example.com/hnnoticiaj1.aspx?78132,199"), + Request("http://www.example.com/hnnoticiaj1.aspx?78160,199"), Request("http://www.example.com/members/offers.html"), Request( "http://www.example.com/members/offers.html", - headers={'SESSIONID': b"somehash"}, + headers={"SESSIONID": b"somehash"}, ), Request( "http://www.example.com/", - headers={'Accept-Language': b"en"}, + headers={"Accept-Language": b"en"}, ), Request( "http://www.example.com/", headers={ - 'Accept-Language': b"en", - 'SESSIONID': b"somehash", + "Accept-Language": b"en", + "SESSIONID": b"somehash", }, ), Request("http://www.example.com/test.html"), Request("http://www.example.com/test.html#fragment"), - Request("http://www.example.com", method='POST'), - Request("http://www.example.com", method='POST', body=b'request body'), + Request("http://www.example.com", method="POST"), + Request("http://www.example.com", method="POST", body=b"request body"), ) class BackwardCompatibilityTestCase(unittest.TestCase): - def test_function_backward_compatibility(self): include_headers_to_test = ( None, - ['Accept-Language'], - ['accept-language', 'sessionid'], - ['SESSIONID', 'Accept-Language'], + ["Accept-Language"], + ["accept-language", "sessionid"], + ["SESSIONID", "Accept-Language"], ) for request_object in REQUEST_OBJECTS_TO_TEST: for include_headers in include_headers_to_test: @@ -475,14 +470,14 @@ class BackwardCompatibilityTestCase(unittest.TestCase): fp = sha1() fp.update(to_bytes(request.method)) fp.update(to_bytes(canonicalize_url(request.url))) - fp.update(request.body or b'') + fp.update(request.body or b"") self.cache[request] = fp.digest() return self.cache[request] for request_object in REQUEST_OBJECTS_TO_TEST: with warnings.catch_warnings() as logged_warnings: settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, } crawler = get_crawler(settings_dict=settings) fp = crawler.request_fingerprinter.fingerprint(request_object) @@ -492,11 +487,10 @@ class BackwardCompatibilityTestCase(unittest.TestCase): class RequestFingerprinterTestCase(unittest.TestCase): - def test_default_implementation(self): with warnings.catch_warnings(record=True) as logged_warnings: crawler = get_crawler(prevent_warnings=False) - request = Request('https://example.com') + request = Request("https://example.com") self.assertEqual( crawler.request_fingerprinter.fingerprint(request), _request_fingerprint_as_bytes(request), @@ -505,11 +499,11 @@ class RequestFingerprinterTestCase(unittest.TestCase): def test_deprecated_implementation(self): settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.6', + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.6", } with warnings.catch_warnings(record=True) as logged_warnings: crawler = get_crawler(settings_dict=settings) - request = Request('https://example.com') + request = Request("https://example.com") self.assertEqual( crawler.request_fingerprinter.fingerprint(request), _request_fingerprint_as_bytes(request), @@ -518,11 +512,11 @@ class RequestFingerprinterTestCase(unittest.TestCase): def test_recommended_implementation(self): settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.7', + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.7", } with warnings.catch_warnings(record=True) as logged_warnings: crawler = get_crawler(settings_dict=settings) - request = Request('https://example.com') + request = Request("https://example.com") self.assertEqual( crawler.request_fingerprinter.fingerprint(request), fingerprint(request), @@ -531,34 +525,30 @@ class RequestFingerprinterTestCase(unittest.TestCase): def test_unknown_implementation(self): settings = { - 'REQUEST_FINGERPRINTER_IMPLEMENTATION': '2.5', + "REQUEST_FINGERPRINTER_IMPLEMENTATION": "2.5", } with self.assertRaises(ValueError): get_crawler(settings_dict=settings) class CustomRequestFingerprinterTestCase(unittest.TestCase): - def test_include_headers(self): - class RequestFingerprinter: - def fingerprint(self, request): - return fingerprint(request, include_headers=['X-ID']) + return fingerprint(request, include_headers=["X-ID"]) settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, } crawler = get_crawler(settings_dict=settings) - r1 = Request("http://www.example.com", headers={'X-ID': '1'}) + r1 = Request("http://www.example.com", headers={"X-ID": "1"}) fp1 = crawler.request_fingerprinter.fingerprint(r1) - r2 = Request("http://www.example.com", headers={'X-ID': '2'}) + r2 = Request("http://www.example.com", headers={"X-ID": "2"}) fp2 = crawler.request_fingerprinter.fingerprint(r2) self.assertNotEqual(fp1, fp2) def test_dont_canonicalize(self): - class RequestFingerprinter: cache = WeakKeyDictionary() @@ -570,7 +560,7 @@ class CustomRequestFingerprinterTestCase(unittest.TestCase): return self.cache[request] settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, } crawler = get_crawler(settings_dict=settings) @@ -581,26 +571,24 @@ class CustomRequestFingerprinterTestCase(unittest.TestCase): self.assertNotEqual(fp1, fp2) def test_meta(self): - class RequestFingerprinter: - def fingerprint(self, request): - if 'fingerprint' in request.meta: - return request.meta['fingerprint'] + if "fingerprint" in request.meta: + return request.meta["fingerprint"] return fingerprint(request) settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, } crawler = get_crawler(settings_dict=settings) r1 = Request("http://www.example.com") fp1 = crawler.request_fingerprinter.fingerprint(r1) - r2 = Request("http://www.example.com", meta={'fingerprint': 'a'}) + r2 = Request("http://www.example.com", meta={"fingerprint": "a"}) fp2 = crawler.request_fingerprinter.fingerprint(r2) - r3 = Request("http://www.example.com", meta={'fingerprint': 'a'}) + r3 = Request("http://www.example.com", meta={"fingerprint": "a"}) fp3 = crawler.request_fingerprinter.fingerprint(r3) - r4 = Request("http://www.example.com", meta={'fingerprint': 'b'}) + r4 = Request("http://www.example.com", meta={"fingerprint": "b"}) fp4 = crawler.request_fingerprinter.fingerprint(r4) self.assertNotEqual(fp1, fp2) self.assertNotEqual(fp1, fp4) @@ -608,55 +596,50 @@ class CustomRequestFingerprinterTestCase(unittest.TestCase): self.assertEqual(fp2, fp3) def test_from_crawler(self): - class RequestFingerprinter: - @classmethod def from_crawler(cls, crawler): return cls(crawler) def __init__(self, crawler): - self._fingerprint = crawler.settings['FINGERPRINT'] + self._fingerprint = crawler.settings["FINGERPRINT"] def fingerprint(self, request): return self._fingerprint settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, - 'FINGERPRINT': b'fingerprint', + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, + "FINGERPRINT": b"fingerprint", } crawler = get_crawler(settings_dict=settings) request = Request("http://www.example.com") fingerprint = crawler.request_fingerprinter.fingerprint(request) - self.assertEqual(fingerprint, settings['FINGERPRINT']) + self.assertEqual(fingerprint, settings["FINGERPRINT"]) def test_from_settings(self): - class RequestFingerprinter: - @classmethod def from_settings(cls, settings): return cls(settings) def __init__(self, settings): - self._fingerprint = settings['FINGERPRINT'] + self._fingerprint = settings["FINGERPRINT"] def fingerprint(self, request): return self._fingerprint settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, - 'FINGERPRINT': b'fingerprint', + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, + "FINGERPRINT": b"fingerprint", } crawler = get_crawler(settings_dict=settings) request = Request("http://www.example.com") fingerprint = crawler.request_fingerprinter.fingerprint(request) - self.assertEqual(fingerprint, settings['FINGERPRINT']) + self.assertEqual(fingerprint, settings["FINGERPRINT"]) def test_from_crawler_and_settings(self): - class RequestFingerprinter: # This method is ignored due to the presence of from_crawler @@ -669,20 +652,20 @@ class CustomRequestFingerprinterTestCase(unittest.TestCase): return cls(crawler) def __init__(self, crawler): - self._fingerprint = crawler.settings['FINGERPRINT'] + self._fingerprint = crawler.settings["FINGERPRINT"] def fingerprint(self, request): return self._fingerprint settings = { - 'REQUEST_FINGERPRINTER_CLASS': RequestFingerprinter, - 'FINGERPRINT': b'fingerprint', + "REQUEST_FINGERPRINTER_CLASS": RequestFingerprinter, + "FINGERPRINT": b"fingerprint", } crawler = get_crawler(settings_dict=settings) request = Request("http://www.example.com") fingerprint = crawler.request_fingerprinter.fingerprint(request) - self.assertEqual(fingerprint, settings['FINGERPRINT']) + self.assertEqual(fingerprint, settings["FINGERPRINT"]) if __name__ == "__main__": diff --git a/tests/test_utils_response.py b/tests/test_utils_response.py index cdf972933..d82aa19c6 100644 --- a/tests/test_utils_response.py +++ b/tests/test_utils_response.py @@ -6,32 +6,49 @@ from urllib.parse import urlparse from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Response, TextResponse, HtmlResponse from scrapy.utils.python import to_bytes -from scrapy.utils.response import (response_httprepr, open_in_browser, - get_meta_refresh, get_base_url, response_status_message) +from scrapy.utils.response import ( + response_httprepr, + open_in_browser, + get_meta_refresh, + get_base_url, + response_status_message, +) -__doctests__ = ['scrapy.utils.response'] +__doctests__ = ["scrapy.utils.response"] class ResponseUtilsTest(unittest.TestCase): - dummy_response = TextResponse(url='http://example.org/', body=b'dummy_response') + dummy_response = TextResponse(url="http://example.org/", body=b"dummy_response") def test_response_httprepr(self): with warnings.catch_warnings(): warnings.simplefilter("ignore", ScrapyDeprecationWarning) r1 = Response("http://www.example.com") - self.assertEqual(response_httprepr(r1), b'HTTP/1.1 200 OK\r\n\r\n') + self.assertEqual(response_httprepr(r1), b"HTTP/1.1 200 OK\r\n\r\n") - r1 = Response("http://www.example.com", status=404, - headers={"Content-type": "text/html"}, body=b"Some body") - self.assertEqual(response_httprepr(r1), - b'HTTP/1.1 404 Not Found\r\nContent-Type: text/html\r\n\r\nSome body') + r1 = Response( + "http://www.example.com", + status=404, + headers={"Content-type": "text/html"}, + body=b"Some body", + ) + self.assertEqual( + response_httprepr(r1), + b"HTTP/1.1 404 Not Found\r\nContent-Type: text/html\r\n\r\nSome body", + ) - r1 = Response("http://www.example.com", status=6666, - headers={"Content-type": "text/html"}, body=b"Some body") - self.assertEqual(response_httprepr(r1), - b'HTTP/1.1 6666 \r\nContent-Type: text/html\r\n\r\nSome body') + r1 = Response( + "http://www.example.com", + status=6666, + headers={"Content-type": "text/html"}, + body=b"Some body", + ) + self.assertEqual( + response_httprepr(r1), + b"HTTP/1.1 6666 \r\nContent-Type: text/html\r\n\r\nSome body", + ) def test_open_in_browser(self): url = "http:///www.example.com/some/page.html" @@ -40,10 +57,11 @@ class ResponseUtilsTest(unittest.TestCase): def browser_open(burl): path = urlparse(burl).path if not path or not Path(path).exists(): - path = burl.replace('file://', '') + path = burl.replace("file://", "") bbody = Path(path).read_bytes() self.assertIn(b'', bbody) return True + response = HtmlResponse(url, body=body) assert open_in_browser(response, _openfunc=browser_open), "Browser not called" @@ -51,45 +69,60 @@ class ResponseUtilsTest(unittest.TestCase): self.assertRaises(TypeError, open_in_browser, resp, debug=True) def test_get_meta_refresh(self): - r1 = HtmlResponse("http://www.example.com", body=b""" + r1 = HtmlResponse( + "http://www.example.com", + body=b""" Dummy blahablsdfsal& - """) - r2 = HtmlResponse("http://www.example.com", body=b""" + """, + ) + r2 = HtmlResponse( + "http://www.example.com", + body=b""" Dummy blahablsdfsal& - """) - r3 = HtmlResponse("http://www.example.com", body=b""" + """, + ) + r3 = HtmlResponse( + "http://www.example.com", + body=b"""
sample 3 text sample 3 repetition + sample 3 repetition sample 3 repetition with fragment inner tag diff --git a/tests/test_http_response.py b/tests/test_http_response.py index 74e170ec0..07aef2ee1 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -541,6 +541,7 @@ class TextResponseTest(BaseResponseTest): 'http://example.com/sample2.html', 'http://example.com/sample3.html', 'http://example.com/sample3.html', + 'http://example.com/sample3.html', 'http://example.com/sample3.html#foo', 'http://www.google.com/something', 'http://example.com/innertag.html' diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index e28dc9bdb..6c34a96a0 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -53,6 +53,7 @@ class Base: Link(url='http://example.com/sample2.html', text='sample 2'), Link(url='http://example.com/sample3.html', text='sample 3 text'), Link(url='http://example.com/sample3.html', text='sample 3 repetition'), + Link(url='http://example.com/sample3.html', text='sample 3 repetition'), Link(url='http://example.com/sample3.html#foo', text='sample 3 repetition with fragment') ]) @@ -64,6 +65,7 @@ class Base: Link(url='http://example.com/sample2.html', text='sample 2'), Link(url='http://example.com/sample3.html', text='sample 3 text'), Link(url='http://example.com/sample3.html', text='sample 3 repetition'), + Link(url='http://example.com/sample3.html', text='sample 3 repetition'), Link(url='http://example.com/sample3.html', text='sample 3 repetition with fragment') ]) From faa5bd0f6b688eaef18a6245f2d703e8fc8ff684 Mon Sep 17 00:00:00 2001 From: silviopavanetto Date: Wed, 11 Jan 2023 20:30:57 +0100 Subject: [PATCH 328/532] Update scrapy/linkextractors/lxmlhtml.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- scrapy/linkextractors/lxmlhtml.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 8a4175d49..f772df987 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -195,7 +195,7 @@ class LxmlLinkExtractor: Only links that match the settings passed to the ``__init__`` method of the link extractor are returned. - Duplicate links are omitted if the ``unique`` parameter is set to ``True``, + Duplicate links are omitted if the ``unique`` attribute is set to ``True``, otherwise they are returned. """ base_url = get_base_url(response) From 36b89a4b20f12a84123930664eab888dfdf3dd8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 12 Jan 2023 08:36:31 +0100 Subject: [PATCH 329/532] Remove trailing whitespace --- scrapy/linkextractors/lxmlhtml.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index f772df987..3f90ed84a 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -195,7 +195,7 @@ class LxmlLinkExtractor: Only links that match the settings passed to the ``__init__`` method of the link extractor are returned. - Duplicate links are omitted if the ``unique`` attribute is set to ``True``, + Duplicate links are omitted if the ``unique`` attribute is set to ``True``, otherwise they are returned. """ base_url = get_base_url(response) From 93ad6a4bc2fd2d453a37961b817a8a2a85f589c4 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 13 Jan 2023 20:39:44 +0400 Subject: [PATCH 330/532] Simplify code for modern pyOpenSSL. --- scrapy/core/downloader/tls.py | 8 ++++---- scrapy/utils/ssl.py | 14 ++------------ tests/mockserver.py | 3 +-- 3 files changed, 7 insertions(+), 18 deletions(-) diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 7d67a426f..65028d21f 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -17,10 +17,10 @@ METHOD_TLSv12 = 'TLSv1.2' openssl_methods = { - METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) - METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only - METHOD_TLSv11: getattr(SSL, 'TLSv1_1_METHOD', 5), # TLS 1.1 only - METHOD_TLSv12: getattr(SSL, 'TLSv1_2_METHOD', 6), # TLS 1.2 only + METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) + METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only + METHOD_TLSv11: SSL.TLSv1_1_METHOD, # TLS 1.1 only + METHOD_TLSv12: SSL.TLSv1_2_METHOD, # TLS 1.2 only } diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index ea4dde882..98efd91c7 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -1,14 +1,9 @@ -import OpenSSL +import OpenSSL.SSL import OpenSSL._util as pyOpenSSLutil from scrapy.utils.python import to_unicode -# The OpenSSL symbol is present since 1.1.1 but it's not currently supported in any version of pyOpenSSL. -# Using the binding directly, as this code does, requires cryptography 2.4. -SSL_OP_NO_TLSv1_3 = getattr(pyOpenSSLutil.lib, 'SSL_OP_NO_TLSv1_3', 0) - - def ffi_buf_to_string(buf): return to_unicode(pyOpenSSLutil.ffi.string(buf)) @@ -22,9 +17,6 @@ def x509name_to_string(x509name): def get_temp_key_info(ssl_object): - if not hasattr(pyOpenSSLutil.lib, 'SSL_get_server_tmp_key'): # requires OpenSSL 1.0.2 - return None - # adapted from OpenSSL apps/s_cb.c::ssl_print_tmp_key() temp_key_p = pyOpenSSLutil.ffi.new("EVP_PKEY **") if not pyOpenSSLutil.lib.SSL_get_server_tmp_key(ssl_object, temp_key_p): @@ -55,7 +47,5 @@ def get_temp_key_info(ssl_object): def get_openssl_version(): - system_openssl = OpenSSL.SSL.SSLeay_version( - OpenSSL.SSL.SSLEAY_VERSION - ).decode('ascii', errors='replace') + system_openssl = OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION) return f'{OpenSSL.version.__version__} ({system_openssl})' diff --git a/tests/mockserver.py b/tests/mockserver.py index 6d2d95692..4fd3adce7 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -19,7 +19,6 @@ from twisted.web.static import File from twisted.web.util import redirectTo from scrapy.utils.python import to_bytes, to_unicode -from scrapy.utils.ssl import SSL_OP_NO_TLSv1_3 from scrapy.utils.test import get_testenv @@ -350,7 +349,7 @@ def ssl_context_factory(keyfile='keys/localhost.key', certfile='keys/localhost.c if cipher_string: ctx = factory.getContext() # disabling TLS1.3 because it unconditionally enables some strong ciphers - ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL_OP_NO_TLSv1_3) + ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL.OP_NO_TLSv1_3) ctx.set_cipher_list(to_bytes(cipher_string)) return factory From fb52918d23b37cd2581aa39ebbd422b017ec8051 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 13 Jan 2023 20:46:55 +0400 Subject: [PATCH 331/532] Set OP_LEGACY_SERVER_CONNECT to support some old servers when using OpenSSL 3. --- scrapy/core/downloader/contextfactory.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index 4abde2238..bc6ad34d8 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -61,7 +61,9 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): # kept for old-style HTTP/1.0 downloader context twisted calls, # e.g. connectSSL() def getContext(self, hostname=None, port=None): - return self.getCertificateOptions().getContext() + ctx = self.getCertificateOptions().getContext() + ctx.set_options(0x4) # OP_LEGACY_SERVER_CONNECT + return ctx def creatorForNetloc(self, hostname, port): return ScrapyClientTLSOptions(hostname.decode("ascii"), self.getContext(), From 43ab8bd16acdabc8be64b421b030fb6e1751e47b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 13 Jan 2023 20:51:07 +0400 Subject: [PATCH 332/532] Roll back the get_openssl_version() type change. --- scrapy/utils/ssl.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index 98efd91c7..ce211bf9b 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -47,5 +47,7 @@ def get_temp_key_info(ssl_object): def get_openssl_version(): - system_openssl = OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION) + system_openssl = OpenSSL.SSL.SSLeay_version( + OpenSSL.SSL.SSLEAY_VERSION + ).decode('ascii', errors='replace') return f'{OpenSSL.version.__version__} ({system_openssl})' From caaeb235a08a250a9438c97259f2a74ae2ca8bbd Mon Sep 17 00:00:00 2001 From: Serhii A Date: Tue, 17 Jan 2023 13:52:41 +0200 Subject: [PATCH 333/532] =?UTF-8?q?scrapy.utils.console.DEFAULT=5FPYTHON?= =?UTF-8?q?=5FSHELLS:=20OrderedDict=20=E2=86=92=20dict=20(#5795)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/utils/console.py | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/scrapy/utils/console.py b/scrapy/utils/console.py index 1bc0bd45f..4828c7767 100644 --- a/scrapy/utils/console.py +++ b/scrapy/utils/console.py @@ -1,5 +1,4 @@ from functools import wraps -from collections import OrderedDict def _embed_ipython_shell(namespace={}, banner=''): @@ -63,12 +62,12 @@ def _embed_standard_shell(namespace={}, banner=''): return wrapper -DEFAULT_PYTHON_SHELLS = OrderedDict([ - ('ptpython', _embed_ptpython_shell), - ('ipython', _embed_ipython_shell), - ('bpython', _embed_bpython_shell), - ('python', _embed_standard_shell), -]) +DEFAULT_PYTHON_SHELLS = { + 'ptpython': _embed_ptpython_shell, + 'ipython': _embed_ipython_shell, + 'bpython': _embed_bpython_shell, + 'python': _embed_standard_shell, +} def get_shell_embed_func(shells=None, known_shells=None): From 482a0b79e3e5ca274cf30584eb8a29c1b79791a8 Mon Sep 17 00:00:00 2001 From: Emmanuel Rondan Date: Tue, 17 Jan 2023 14:26:12 -0300 Subject: [PATCH 334/532] explaining pre-commit on documentation --- docs/contributing.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 9cfe10012..dca635f15 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -179,6 +179,25 @@ Scrapy: See https://help.github.com/en/github/using-git/setting-your-username-in-git for setup instructions. +.. _pre-commit: + +Pre-commit +========== + +Pre-commit is a tool that allows developers to specify a set of checks to be run +automatically every time they make a commit. This can include code style checks, +linting, and automated tests. +The checks are defined in a configuration file called .pre-commit-config.yaml. + +By using pre-commit, developers can ensure that their code adheres to a consistent +style and passes certain tests before they make a commit. +This can help catch errors early in the development process and prevent them +from being pushed to the main branch. + +To use pre-commit, developers first need to install it on their local machine. +Once it is installed, they can specify the checks they want to run in the .pre-commit-config.yaml file. +After that, pre-commit will run automatically every time they make a commit. + .. _documentation-policies: Documentation policies From 23e8b553b4db0c33645f371fd161470545733320 Mon Sep 17 00:00:00 2001 From: Emmanuel Rondan Date: Wed, 18 Jan 2023 11:42:30 -0300 Subject: [PATCH 335/532] fixing docs with suggestions --- docs/contributing.rst | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index dca635f15..f7f1218c8 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -169,10 +169,10 @@ Coding style Please follow these coding conventions when writing code for inclusion in Scrapy: -* Unless otherwise specified, follow :pep:`8`. - -* It's OK to use lines longer than 79 chars if it improves the code - readability. +* We use `black `_ for code formatting. + There is a hook in the pre-commit config + that will automatically format your code before every commit. You can also + run black manually with ``tox -e black``. * Don't put your name in the code you contribute; git provides enough metadata to identify author of the code. @@ -184,19 +184,21 @@ Scrapy: Pre-commit ========== -Pre-commit is a tool that allows developers to specify a set of checks to be run -automatically every time they make a commit. This can include code style checks, -linting, and automated tests. -The checks are defined in a configuration file called .pre-commit-config.yaml. +We use `pre-commit`_ to automatically address simple code issues before every +commit. -By using pre-commit, developers can ensure that their code adheres to a consistent -style and passes certain tests before they make a commit. -This can help catch errors early in the development process and prevent them -from being pushed to the main branch. +Before you start writing a patch: +#. `Install pre-commit `_. +#. On the root of your local clone of the Scrapy repository, run the following command: + .. code-block:: bash + + pre-commit install -To use pre-commit, developers first need to install it on their local machine. -Once it is installed, they can specify the checks they want to run in the .pre-commit-config.yaml file. -After that, pre-commit will run automatically every time they make a commit. +Now our pre-commit hooks will run every time you create a Git commit. Upon +finding issues, pre-commit hooks aborts your commit, and they either fix +the corresponding issues automatically or only report them to you. If they fix +the issues automatically, creating your commit again should succeed. Otherwise, +you may need to address the corresponding issues manually first. .. _documentation-policies: From 50500a6b2897418405b459b6a2a80a7a5b0a6f29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 19 Jan 2023 17:14:18 +0100 Subject: [PATCH 336/532] Implement a NO_CALLBACK value for Request.callback --- docs/topics/request-response.rst | 43 ++++++++++++++------ scrapy/downloadermiddlewares/robotstxt.py | 4 +- scrapy/http/request/__init__.py | 28 ++++++++++--- scrapy/pipelines/media.py | 3 +- tests/test_downloadermiddleware_robotstxt.py | 8 ++++ tests/test_http_request.py | 9 ++++ tests/test_pipeline_files.py | 5 +-- tests/test_pipeline_images.py | 7 +--- tests/test_pipeline_media.py | 2 + 9 files changed, 79 insertions(+), 30 deletions(-) diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index a0d9fc03e..766710d66 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -32,11 +32,22 @@ Request objects :type url: str :param callback: the function that will be called with the response of this - request (once it's downloaded) as its first parameter. For more information - see :ref:`topics-request-response-ref-request-callback-arguments` below. - If a Request doesn't specify a callback, the spider's - :meth:`~scrapy.Spider.parse` method will be used. - Note that if exceptions are raised during processing, errback is called instead. + request (once it's downloaded) as its first parameter. + + In addition to a function, the following values are supported: + + - ``None`` (default), which indicates that the spider's + :meth:`~scrapy.Spider.parse` method must be used. + + - :py:data:`scrapy.http.request.NO_CALLBACK` + + .. autodata:: scrapy.http.request.NO_CALLBACK + + For more information, see + :ref:`topics-request-response-ref-request-callback-arguments`. + + .. note:: If exceptions are raised during processing, ``errback`` is + called instead. :type callback: collections.abc.Callable @@ -69,16 +80,24 @@ Request objects 1. Using a dict:: - request_with_cookies = Request(url="http://www.example.com", - cookies={'currency': 'USD', 'country': 'UY'}) + request_with_cookies = Request( + url="http://www.example.com", + cookies={'currency': 'USD', 'country': 'UY'}, + ) 2. Using a list of dicts:: - request_with_cookies = Request(url="http://www.example.com", - cookies=[{'name': 'currency', - 'value': 'USD', - 'domain': 'example.com', - 'path': '/currency'}]) + request_with_cookies = Request( + url="http://www.example.com", + cookies=[ + { + 'name': 'currency', + 'value': 'USD', + 'domain': 'example.com', + 'path': '/currency', + }, + ], + ) The latter form allows for customizing the ``domain`` and ``path`` attributes of the cookie. This is only useful if the cookies are saved diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index 7bd39aa43..67e14b7b5 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -9,6 +9,7 @@ import logging from twisted.internet.defer import Deferred, maybeDeferred from scrapy.exceptions import NotConfigured, IgnoreRequest from scrapy.http import Request +from scrapy.http.request import NO_CALLBACK from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import load_object @@ -65,7 +66,8 @@ class RobotsTxtMiddleware: robotsreq = Request( robotsurl, priority=self.DOWNLOAD_PRIORITY, - meta={'dont_obey_robotstxt': True} + meta={'dont_obey_robotstxt': True}, + callback=NO_CALLBACK, ) dfd = self.crawler.engine.download(robotsreq) dfd.addCallback(self._parse_robots, netloc, spider) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index a1001fc4a..b57faf121 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -20,6 +20,17 @@ from scrapy.utils.url import escape_ajax RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") +#: When assigned to the ``callback`` parameter of +#: :class:`~scrapy.http.Request`, it indicates that the request it not meant to +#: have a spider callback at all. +#: +#: This value should be used by :ref:`components ` +#: that create and handle their own requests, e.g. through +#: :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download +#: middlewares handling such requests can treat them differently from requests +#: intended for the :meth:`~scrapy.Spider.parse` callback. +NO_CALLBACK = object() + class Request(object_ref): """Represents an HTTP request, which is usually generated in a Spider and @@ -63,12 +74,8 @@ class Request(object_ref): raise TypeError(f"Request priority not an integer: {priority!r}") self.priority = priority - if callback is not None and not callable(callback): - raise TypeError(f'callback must be a callable, got {type(callback).__name__}') - if errback is not None and not callable(errback): - raise TypeError(f'errback must be a callable, got {type(errback).__name__}') - self.callback = callback - self.errback = errback + self._set_xback("callback", callback) + self._set_xback("errback", errback) self.cookies = cookies or {} self.headers = Headers(headers or {}, encoding=encoding) @@ -78,6 +85,15 @@ class Request(object_ref): self._cb_kwargs = dict(cb_kwargs) if cb_kwargs else None self.flags = [] if flags is None else list(flags) + def _set_xback(self, name: str, value: Optional[Callable]) -> None: + if ( + value is not None + and (name != "callback" or value is not NO_CALLBACK) + and not callable(value) + ): + raise TypeError(f'{name} must be a callable, got {type(value).__name__}') + setattr(self, name, value) + @property def cb_kwargs(self) -> dict: if self._cb_kwargs is None: diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index 5308a9793..fc5db58e8 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -7,6 +7,7 @@ from warnings import warn from twisted.internet.defer import Deferred, DeferredList from twisted.python.failure import Failure +from scrapy.http.request import NO_CALLBACK from scrapy.settings import Settings from scrapy.utils.datatypes import SequenceExclude from scrapy.utils.defer import mustbe_deferred, defer_result @@ -93,7 +94,7 @@ class MediaPipeline: fp = self._fingerprinter.fingerprint(request) cb = request.callback or (lambda _: _) eb = request.errback - request.callback = None + request.callback = NO_CALLBACK request.errback = None # Return cached result if request was already seen diff --git a/tests/test_downloadermiddleware_robotstxt.py b/tests/test_downloadermiddleware_robotstxt.py index 1460d88eb..71d53ff1a 100644 --- a/tests/test_downloadermiddleware_robotstxt.py +++ b/tests/test_downloadermiddleware_robotstxt.py @@ -8,6 +8,7 @@ from scrapy.downloadermiddlewares.robotstxt import (RobotsTxtMiddleware, logger as mw_module_logger) from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request, Response, TextResponse +from scrapy.http.request import NO_CALLBACK from scrapy.settings import Settings from tests.test_robotstxt_interface import rerp_available, reppy_available @@ -53,6 +54,7 @@ Disallow: /some/randome/page.html middleware = RobotsTxtMiddleware(self._get_successful_crawler()) return DeferredList([ self.assertNotIgnored(Request('http://site.local/allowed'), middleware), + maybeDeferred(self.assertRobotsTxtRequested, "http://site.local"), self.assertIgnored(Request('http://site.local/admin/main'), middleware), self.assertIgnored(Request('http://site.local/static/'), middleware), self.assertIgnored(Request('http://site.local/wiki/K%C3%A4ytt%C3%A4j%C3%A4:'), middleware), @@ -183,6 +185,12 @@ Disallow: /some/randome/page.html return self.assertFailure(maybeDeferred(middleware.process_request, request, spider), IgnoreRequest) + def assertRobotsTxtRequested(self, base_url): + calls = self.crawler.engine.download.call_args_list + request = calls[0][0][0] + self.assertEqual(request.url, f"{base_url}/robots.txt") + self.assertEqual(request.callback, NO_CALLBACK) + class RobotsTxtMiddlewareWithRerpTest(RobotsTxtMiddlewareTest): if not rerp_available(): diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 81cebdc7b..e14f8c8f4 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -7,6 +7,7 @@ from unittest import mock from urllib.parse import parse_qs, unquote_to_bytes, urlparse from scrapy.http import Request, FormRequest, XmlRpcRequest, JsonRequest, Headers, HtmlResponse +from scrapy.http.request import NO_CALLBACK from scrapy.utils.python import to_bytes, to_unicode @@ -277,6 +278,12 @@ class RequestTest(unittest.TestCase): self.assertIs(r4.callback, a_function) self.assertIs(r4.errback, a_function) + r5 = self.request_class( + url='http://example.com', + callback=NO_CALLBACK, + ) + self.assertIs(r5.callback, NO_CALLBACK) + def test_callback_and_errback_type(self): with self.assertRaises(TypeError): self.request_class('http://example.com', callback='a_function') @@ -288,6 +295,8 @@ class RequestTest(unittest.TestCase): callback='a_function', errback='a_function', ) + with self.assertRaises(TypeError): + self.request_class('http://example.com', errback=NO_CALLBACK) def test_from_curl(self): # Note: more curated tests regarding curl conversion are in diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 4acd29bf7..83572e74f 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -33,10 +33,7 @@ from scrapy.utils.test import ( skip_if_no_boto, ) - -def _mocked_download_func(request, info): - response = request.meta.get('response') - return response() if callable(response) else response +from .test_pipeline_media import _mocked_download_func class FilesPipelineTestCase(unittest.TestCase): diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 6f5466191..3b39212bd 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -31,18 +31,13 @@ else: skip_pillow = None -def _mocked_download_func(request, info): - response = request.meta.get('response') - return response() if callable(response) else response - - class ImagesPipelineTestCase(unittest.TestCase): skip = skip_pillow def setUp(self): self.tempdir = mkdtemp() - self.pipeline = ImagesPipeline(self.tempdir, download_func=_mocked_download_func) + self.pipeline = ImagesPipeline(self.tempdir) def tearDown(self): rmtree(self.tempdir) diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 0a94ae699..99fb424f4 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -9,6 +9,7 @@ from twisted.internet.defer import Deferred, inlineCallbacks from scrapy import signals from scrapy.http import Request, Response +from scrapy.http.request import NO_CALLBACK from scrapy.settings import Settings from scrapy.spiders import Spider from scrapy.pipelines.files import FileException @@ -29,6 +30,7 @@ else: def _mocked_download_func(request, info): + assert request.callback is NO_CALLBACK response = request.meta.get('response') return response() if callable(response) else response From f449ee53778b038f9ecb1feccb2fa9baa40e1f56 Mon Sep 17 00:00:00 2001 From: Tobias Mayr Date: Thu, 19 Jan 2023 18:44:55 +0000 Subject: [PATCH 337/532] Fix SMTP STARTTLS for Twisted >= 21.2.0 (#5406) --- scrapy/mail.py | 28 +++++++++++++++++++++------- tests/test_mail.py | 16 ++++++++++++++++ 2 files changed, 37 insertions(+), 7 deletions(-) diff --git a/scrapy/mail.py b/scrapy/mail.py index 2a25ccd44..b8cc28335 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -12,7 +12,9 @@ from email.mime.text import MIMEText from email.utils import formatdate from io import BytesIO +from twisted.python.versions import Version from twisted.internet import defer, ssl +from twisted import version as twisted_version from scrapy.utils.misc import arg_to_iter from scrapy.utils.python import to_bytes @@ -126,16 +128,11 @@ class MailSender: 'mailattachs': nattachs, 'mailerr': errstr}) def _sendmail(self, to_addrs, msg): - # Import twisted.mail here because it is not available in python3 from twisted.internet import reactor - from twisted.mail.smtp import ESMTPSenderFactory msg = BytesIO(msg) d = defer.Deferred() - factory = ESMTPSenderFactory( - self.smtpuser, self.smtppass, self.mailfrom, to_addrs, msg, d, - heloFallback=True, requireAuthentication=False, requireTransportSecurity=self.smtptls, - ) - factory.noisy = False + + factory = self._create_sender_factory(to_addrs, msg, d) if self.smtpssl: reactor.connectSSL(self.smtphost, self.smtpport, factory, ssl.ClientContextFactory()) @@ -143,3 +140,20 @@ class MailSender: reactor.connectTCP(self.smtphost, self.smtpport, factory) return d + + def _create_sender_factory(self, to_addrs, msg, d): + from twisted.mail.smtp import ESMTPSenderFactory + + factory_keywords = { + 'heloFallback': True, + 'requireAuthentication': False, + 'requireTransportSecurity': self.smtptls + } + + # Newer versions of twisted require the hostname to use STARTTLS + if twisted_version >= Version('twisted', 21, 2, 0): + factory_keywords['hostname'] = self.smtphost + + factory = ESMTPSenderFactory(self.smtpuser, self.smtppass, self.mailfrom, to_addrs, msg, d, **factory_keywords) + factory.noisy = False + return factory diff --git a/tests/test_mail.py b/tests/test_mail.py index 9b248fbfa..fd02020ee 100644 --- a/tests/test_mail.py +++ b/tests/test_mail.py @@ -4,6 +4,11 @@ import unittest from io import BytesIO from email.charset import Charset +from twisted.internet._sslverify import ClientTLSOptions +from twisted.internet.ssl import ClientContextFactory +from twisted.python.versions import Version +from twisted.internet import defer +from twisted import version as twisted_version from scrapy.mail import MailSender @@ -121,6 +126,17 @@ class MailSenderTest(unittest.TestCase): self.assertEqual(text.get_charset(), Charset('utf-8')) self.assertEqual(attach.get_payload(decode=True).decode('utf-8'), body) + def test_create_sender_factory_with_host(self): + mailsender = MailSender(debug=False, smtphost='smtp.testhost.com') + + factory = mailsender._create_sender_factory(to_addrs=['test@scrapy.org'], msg='test', d=defer.Deferred()) + + context = factory.buildProtocol('test@scrapy.org').context + if twisted_version >= Version('twisted', 21, 2, 0): + self.assertIsInstance(context, ClientTLSOptions) + else: + self.assertIsInstance(context, ClientContextFactory) + if __name__ == "__main__": unittest.main() From a49346494201d3d7a9d017f16fd64fa2d9042b02 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 19 Jan 2023 19:53:53 +0100 Subject: [PATCH 338/532] Update the screenshot pipeline code example --- docs/topics/item-pipeline.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/topics/item-pipeline.rst b/docs/topics/item-pipeline.rst index 1672ccbcc..fa19d2f4c 100644 --- a/docs/topics/item-pipeline.rst +++ b/docs/topics/item-pipeline.rst @@ -191,6 +191,7 @@ item. import scrapy from itemadapter import ItemAdapter + from scrapy.http.request import NO_CALLBACK from scrapy.utils.defer import maybe_deferred_to_future @@ -204,8 +205,10 @@ item. adapter = ItemAdapter(item) encoded_item_url = quote(adapter["url"]) screenshot_url = self.SPLASH_URL.format(encoded_item_url) - request = scrapy.Request(screenshot_url) - response = await maybe_deferred_to_future(spider.crawler.engine.download(request, spider)) + request = scrapy.Request(screenshot_url, callback=NO_CALLBACK) + response = await maybe_deferred_to_future( + spider.crawler.engine.download(request, spider) + ) if response.status != 200: # Error happened, return item. From 5c1559f60e459a9678eecfe24c4fea06e272dbab Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 19 Jan 2023 20:30:22 +0100 Subject: [PATCH 339/532] Address typing issues --- scrapy/http/request/__init__.py | 12 ++++++++++-- tox.ini | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index b57faf121..ea73781c8 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -5,7 +5,8 @@ requests in Scrapy. See documentation in docs/topics/request-response.rst """ import inspect -from typing import Callable, List, Optional, Tuple, Type, TypeVar, Union +from enum import Enum +from typing import Any, Callable, Final, List, Optional, Tuple, Type, TypeVar, Union from w3lib.url import safe_url_string @@ -20,6 +21,11 @@ from scrapy.utils.url import escape_ajax RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") + +# https://github.com/python/typing/issues/689#issuecomment-561425237 +class _NoCallback(Enum): + NO_CALLBACK = 0 + #: When assigned to the ``callback`` parameter of #: :class:`~scrapy.http.Request`, it indicates that the request it not meant to #: have a spider callback at all. @@ -29,7 +35,7 @@ RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") #: :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download #: middlewares handling such requests can treat them differently from requests #: intended for the :meth:`~scrapy.Spider.parse` callback. -NO_CALLBACK = object() +NO_CALLBACK: Final = _NoCallback.NO_CALLBACK class Request(object_ref): @@ -49,6 +55,8 @@ class Request(object_ref): Currently used by :meth:`Request.replace`, :meth:`Request.to_dict` and :func:`~scrapy.utils.request.request_from_dict`. """ + callback: Union[None, _NoCallback, Callable] + errback: Optional[Callable] def __init__( self, diff --git a/tox.ini b/tox.ini index 520d90303..076178d8e 100644 --- a/tox.ini +++ b/tox.ini @@ -4,7 +4,7 @@ # and then run "tox" from this directory. [tox] -envlist = security,flake8,py +envlist = security,flake8,typing,py minversion = 1.7.0 [testenv] From 4242ae405d9775098607a67612b5640a4daaf840 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Thu, 19 Jan 2023 20:37:24 +0100 Subject: [PATCH 340/532] Restore Python 3.7 support --- scrapy/http/request/__init__.py | 4 +++- setup.py | 1 + tox.ini | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index ea73781c8..936afb007 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -6,8 +6,9 @@ See documentation in docs/topics/request-response.rst """ import inspect from enum import Enum -from typing import Any, Callable, Final, List, Optional, Tuple, Type, TypeVar, Union +from typing import Callable, List, Optional, Tuple, Type, TypeVar, Union +from typing_extensions import Final from w3lib.url import safe_url_string import scrapy @@ -26,6 +27,7 @@ RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") class _NoCallback(Enum): NO_CALLBACK = 0 + #: When assigned to the ``callback`` parameter of #: :class:`~scrapy.http.Request`, it indicates that the request it not meant to #: have a spider callback at all. diff --git a/setup.py b/setup.py index bdae28047..049c4f9a6 100644 --- a/setup.py +++ b/setup.py @@ -34,6 +34,7 @@ install_requires = [ 'packaging', 'tldextract', 'lxml>=4.3.0', + 'typing-extensions>=3.10.0.0', ] extras_require = {} cpython_dependencies = [ diff --git a/tox.ini b/tox.ini index 076178d8e..1ff5f7a4e 100644 --- a/tox.ini +++ b/tox.ini @@ -94,6 +94,7 @@ deps = w3lib==1.17.0 zope.interface==5.1.0 lxml==4.3.0 + typing-extensions==3.10.0.0 -rtests/requirements.txt # mitmproxy 4.0.4+ requires upgrading some of the pinned dependencies From b1dd893fbb4d2efed3342e6c98a6bbf4b393d48e Mon Sep 17 00:00:00 2001 From: Alex Date: Fri, 20 Jan 2023 02:17:02 -0800 Subject: [PATCH 341/532] Support Path Objects Issue #5739 --- scrapy/pipelines/files.py | 9 +++++---- tests/test_pipeline_files.py | 17 +++++++++++++++++ 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 51aedafe8..4b0c96b25 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -14,7 +14,7 @@ from contextlib import suppress from ftplib import FTP from io import BytesIO from pathlib import Path -from typing import DefaultDict, Optional, Set +from typing import DefaultDict, Optional, Set, Union from urllib.parse import urlparse from itemadapter import ItemAdapter @@ -41,7 +41,8 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir: str): + def __init__(self, basedir: Union[str, os.PathLike]): + basedir = str(basedir) # support Path object if '://' in basedir: basedir = basedir.split('://', 1)[1] self.basedir = basedir @@ -65,8 +66,8 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path: str) -> Path: - path_comps = path.split('/') + def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: + path_comps = str(path).split('/') return Path(self.basedir, *path_comps) def _mkdir(self, dirname: Path, domain: Optional[str] = None): diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 4acd29bf7..5280ab0d2 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -405,6 +405,23 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): self.assertEqual(getattr(pipeline_cls, pipe_inst_attr), expected_value) + def test_file_pipeline_using_pathlike_objects(self): + + class CustomFilesPipelineWithPathLikeDir(FilesPipeline): + def file_path(self, request, response=None, info=None, *, item=None): + return Path('subdir') / Path(request.url).name + + pipeline = CustomFilesPipelineWithPathLikeDir.from_settings( + Settings({'FILES_STORE': Path('./Temp')}) + ) + request = Request("http://example.com/image01.jpg") + self.assertEqual(pipeline.file_path(request), Path('subdir/image01.jpg')) + + def test_files_store_constructor_with_pathlike_object(self): + path = Path('./FileDir') + fs_store = FSFilesStore(path) + self.assertEqual(fs_store.basedir, str(path)) + class TestS3FilesStore(unittest.TestCase): From 8270df754d5caa7e8115432923197f09b4ebc78f Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Fri, 20 Jan 2023 07:55:16 -0300 Subject: [PATCH 342/532] Set `FEED_EXPORT_ENCODING='utf-8'` in the default template --- docs/topics/feed-exports.rst | 5 +++++ scrapy/templates/project/module/settings.py.tmpl | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index a620e2c04..7b662f34d 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -515,6 +515,11 @@ which uses safe numeric encoding (``\uXXXX`` sequences) for historic reasons. Use ``utf-8`` if you want UTF-8 for JSON too. +.. versionchanged:: 2.8 + The :command:`startproject` command now sets this setting to + ``utf-8`` in the generated + ``settings.py`` file. + .. setting:: FEED_EXPORT_FIELDS FEED_EXPORT_FIELDS diff --git a/scrapy/templates/project/module/settings.py.tmpl b/scrapy/templates/project/module/settings.py.tmpl index bbf60982c..2f6df5abc 100644 --- a/scrapy/templates/project/module/settings.py.tmpl +++ b/scrapy/templates/project/module/settings.py.tmpl @@ -90,3 +90,4 @@ ROBOTSTXT_OBEY = True # Set settings whose default value is deprecated to a future-proof value REQUEST_FINGERPRINTER_IMPLEMENTATION = '2.7' TWISTED_REACTOR = 'twisted.internet.asyncioreactor.AsyncioSelectorReactor' +FEED_EXPORT_ENCODING = 'utf-8' From 973f0cf5678adcec36aaf5d0ceb860198f34de4a Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Fri, 20 Jan 2023 08:23:05 -0300 Subject: [PATCH 343/532] fix: line break --- docs/topics/feed-exports.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index 7b662f34d..8775a99d0 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -517,8 +517,7 @@ Use ``utf-8`` if you want UTF-8 for JSON too. .. versionchanged:: 2.8 The :command:`startproject` command now sets this setting to - ``utf-8`` in the generated - ``settings.py`` file. + ``utf-8`` in the generated ``settings.py`` file. .. setting:: FEED_EXPORT_FIELDS From b6118480299384c88d194bf09ad60b67a36395ed Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Fri, 20 Jan 2023 08:33:35 -0300 Subject: [PATCH 344/532] fix(docs): Change `versionchanged` value --- docs/topics/feed-exports.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index 8775a99d0..8f96b1154 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -515,7 +515,7 @@ which uses safe numeric encoding (``\uXXXX`` sequences) for historic reasons. Use ``utf-8`` if you want UTF-8 for JSON too. -.. versionchanged:: 2.8 +.. versionchanged:: VERSION The :command:`startproject` command now sets this setting to ``utf-8`` in the generated ``settings.py`` file. From 818d69fa003a14a2f2058e76258e6269d227efb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 20 Jan 2023 12:38:07 +0100 Subject: [PATCH 345/532] =?UTF-8?q?Fix=20typo:=20it=20=E2=86=92=20is?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Andrey Rakhmatullin --- scrapy/http/request/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 936afb007..302895781 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -29,7 +29,7 @@ class _NoCallback(Enum): #: When assigned to the ``callback`` parameter of -#: :class:`~scrapy.http.Request`, it indicates that the request it not meant to +#: :class:`~scrapy.http.Request`, it indicates that the request is not meant to #: have a spider callback at all. #: #: This value should be used by :ref:`components ` From 8ee48174717591bbf74497fded060d7ae83d67ba Mon Sep 17 00:00:00 2001 From: Emmanuel Rondan Date: Fri, 20 Jan 2023 10:54:46 -0300 Subject: [PATCH 346/532] reaplying black, fixing conflicts and ignoring bandit checks on test directory --- .bandit.yml | 1 + .github/workflows/checks.yml | 4 +- .github/workflows/publish.yml | 4 +- .github/workflows/tests-ubuntu.yml | 5 +- docs/news.rst | 18 +-- docs/topics/settings.rst | 32 +++-- docs/topics/spiders.rst | 2 +- extras/qpsclient.py | 5 +- scrapy/cmdline.py | 2 +- scrapy/core/downloader/contextfactory.py | 4 +- scrapy/core/downloader/tls.py | 4 +- scrapy/core/downloader/webclient.py | 2 +- scrapy/core/http2/stream.py | 2 +- scrapy/extensions/feedexport.py | 2 +- scrapy/extensions/httpcache.py | 2 +- scrapy/http/request/form.py | 2 +- scrapy/linkextractors/lxmlhtml.py | 7 +- scrapy/pipelines/images.py | 4 +- scrapy/shell.py | 4 + scrapy/utils/console.py | 15 +-- scrapy/utils/defer.py | 10 +- scrapy/utils/reactor.py | 28 +++- scrapy/utils/response.py | 2 +- scrapy/utils/ssl.py | 12 +- scrapy/utils/url.py | 2 +- sep/sep-016.rst | 2 +- sep/sep-018.rst | 12 +- sep/sep-021.rst | 2 +- setup.py | 2 +- tests/mockserver.py | 3 +- tests/pipelines.py | 2 +- .../link_extractor/linkextractor.html | 1 + tests/test_commands.py | 2 +- tests/test_crawl.py | 4 +- tests/test_downloader_handlers.py | 21 ++- tests/test_downloadermiddleware_useragent.py | 2 +- tests/test_engine.py | 2 +- tests/test_feedexport.py | 125 +++++++++++++++++- tests/test_http_request.py | 8 +- tests/test_http_response.py | 3 +- tests/test_linkextractors.py | 8 ++ tests/test_pipeline_images.py | 10 +- tests/test_request_attribute_binding.py | 16 +-- tests/test_spidermiddleware_referer.py | 16 +-- tests/test_utils_asyncio.py | 5 + tests/test_utils_deprecate.py | 2 +- tests/test_utils_display.py | 24 +++- tests/test_utils_python.py | 2 +- tox.ini | 16 +-- 49 files changed, 326 insertions(+), 139 deletions(-) diff --git a/.bandit.yml b/.bandit.yml index 41f1bb597..c8e84cc2e 100644 --- a/.bandit.yml +++ b/.bandit.yml @@ -17,3 +17,4 @@ skips: - B503 - B603 - B605 +exclude_dirs: ['tests'] diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 90b6ade4a..740092dab 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -14,9 +14,7 @@ jobs: - python-version: "3.11" env: TOXENV: flake8 - # Pylint requires installing reppy, which does not support Python 3.9 - # https://github.com/seomoz/reppy/issues/122 - - python-version: 3.8 + - python-version: "3.11" env: TOXENV: pylint - python-version: 3.7 diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 991b0b6e8..eee9a4f02 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -24,8 +24,8 @@ jobs: - name: Publish to PyPI if: steps.check-release-tag.outputs.release_tag == 'true' run: | - pip install --upgrade setuptools wheel twine - python setup.py sdist bdist_wheel + pip install --upgrade build twine + python -m build export TWINE_USERNAME=__token__ export TWINE_PASSWORD=${{ secrets.PYPI_TOKEN }} twine upload dist/* diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 9c3ce8115..8fcf90a18 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -38,10 +38,7 @@ jobs: env: TOXENV: pypy3-pinned - # extras - # extra-deps includes reppy, which does not support Python 3.9 - # https://github.com/seomoz/reppy/issues/122 - - python-version: 3.8 + - python-version: "3.11" env: TOXENV: extra-deps diff --git a/docs/news.rst b/docs/news.rst index c97de0ed8..07264827b 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -4700,7 +4700,7 @@ Scrapy 0.22.1 (released 2014-02-08) - 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 (:commit:`7e4d627`) - Fix tests for Travis-CI build (:commit:`76c7e20`) -- replace unencodable codepoints with html entities. fixes #562 and #285 (:commit:`5f87b17`) +- replace unencodeable codepoints with html entities. fixes #562 and #285 (:commit:`5f87b17`) - RegexLinkExtractor: encode URL unicode value when creating Links (:commit:`d0ee545`) - Updated the tutorial crawl output with latest output. (:commit:`8da65de`) - Updated shell docs with the crawler reference and fixed the actual shell output. (:commit:`875b9ab`) @@ -4725,7 +4725,7 @@ Enhancements - [**Backward incompatible**] Switched HTTPCacheMiddleware backend to filesystem (:issue:`541`) To restore old backend set ``HTTPCACHE_STORAGE`` to ``scrapy.contrib.httpcache.DbmCacheStorage`` - Proxy \https:// urls using CONNECT method (:issue:`392`, :issue:`397`) -- Add a middleware to crawl ajax crawleable pages as defined by google (:issue:`343`) +- Add a middleware to crawl ajax crawlable pages as defined by google (:issue:`343`) - Rename scrapy.spider.BaseSpider to scrapy.spider.Spider (:issue:`510`, :issue:`519`) - Selectors register EXSLT namespaces by default (:issue:`472`) - Unify item loaders similar to selectors renaming (:issue:`461`) @@ -4905,7 +4905,7 @@ 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 (:commit:`3fe2a32`) +- Handle GET parameters for AJAX crawlable urls (:commit:`3fe2a32`) - Use lxml recover option to parse sitemaps (:issue:`347`) - Bugfix cookie merging by hostname and not by netloc (:issue:`352`) - Support disabling ``HttpCompressionMiddleware`` using a flag setting (:issue:`359`) @@ -4939,8 +4939,8 @@ Scrapy 0.18.0 (released 2013-08-09) - Added ``--pdb`` option to ``scrapy`` command line tool - Added :meth:`XPathSelector.remove_namespaces ` which allows to remove all namespaces from XML documents for convenience (to work with namespace-less XPaths). Documented in :ref:`topics-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 +- New default middleware named MetaRefreshMiddleware that handles meta-refresh html tag redirections, +- MetaRefreshMiddleware 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) @@ -5082,7 +5082,7 @@ Scrapy changes: - promoted :ref:`topics-djangoitem` to main contrib - LogFormatter method now return dicts(instead of strings) to support lazy formatting (:issue:`164`, :commit:`dcef7b0`) - downloader handlers (:setting:`DOWNLOAD_HANDLERS` setting) now receive settings as the first argument of the ``__init__`` method -- replaced memory usage acounting with (more portable) `resource`_ module, removed ``scrapy.utils.memory`` module +- replaced memory usage accounting with (more portable) `resource`_ module, removed ``scrapy.utils.memory`` module - removed signal: ``scrapy.mail.mail_sent`` - removed ``TRACK_REFS`` setting, now :ref:`trackrefs ` is always enabled - DBM is now the default storage backend for HTTP cache middleware @@ -5148,7 +5148,7 @@ Scrapy 0.14 New features and settings ~~~~~~~~~~~~~~~~~~~~~~~~~ -- Support for `AJAX crawleable urls`_ +- Support for `AJAX crawlable urls`_ - New persistent scheduler that stores requests on disk, allowing to suspend and resume crawls (:rev:`2737`) - added ``-o`` option to ``scrapy 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 (:rev:`2779`, :rev:`2783`) @@ -5408,7 +5408,7 @@ Backward-incompatible changes - Renamed setting: ``REQUESTS_PER_DOMAIN`` to ``CONCURRENT_REQUESTS_PER_SPIDER`` (:rev:`1830`, :rev:`1844`) - Renamed setting: ``CONCURRENT_DOMAINS`` to ``CONCURRENT_SPIDERS`` (:rev:`1830`) - Refactored HTTP Cache middleware -- HTTP Cache middleware has been heavilty refactored, retaining the same functionality except for the domain sectorization which was removed. (:rev:`1843` ) +- HTTP Cache middleware has been heavily refactored, retaining the same functionality except for the domain sectorization which was removed. (:rev:`1843` ) - Renamed exception: ``DontCloseDomain`` to ``DontCloseSpider`` (:rev:`1859` | #120) - Renamed extension: ``DelayedCloseDomain`` to ``SpiderCloseDelay`` (:rev:`1861` | #121) - Removed obsolete ``scrapy.utils.markup.remove_escape_chars`` function - use ``scrapy.utils.markup.replace_escape_chars`` instead (:rev:`1865`) @@ -5419,7 +5419,7 @@ Scrapy 0.7 First release of Scrapy. -.. _AJAX crawleable urls: https://developers.google.com/search/docs/ajax-crawling/docs/getting-started?csw=1 +.. _AJAX crawlable urls: https://developers.google.com/search/docs/ajax-crawling/docs/getting-started?csw=1 .. _botocore: https://github.com/boto/botocore .. _chunked transfer encoding: https://en.wikipedia.org/wiki/Chunked_transfer_encoding .. _ClientForm: http://wwwsearch.sourceforge.net/old/ClientForm/ diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 022265992..e147a943b 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -636,19 +636,30 @@ DOWNLOAD_DELAY Default: ``0`` -The amount of time (in secs) that the downloader should wait before downloading -consecutive pages from the same website. This can be used to throttle the -crawling speed to avoid hitting servers too hard. Decimal numbers are -supported. Example:: +Minimum seconds to wait between 2 consecutive requests to the same domain. - DOWNLOAD_DELAY = 0.25 # 250 ms of delay +Use :setting:`DOWNLOAD_DELAY` to throttle your crawling speed, to avoid hitting +servers too hard. + +Decimal numbers are supported. For example, to send a maximum of 4 requests +every 10 seconds:: + + DOWNLOAD_DELAY = 2.5 This setting is also affected by the :setting:`RANDOMIZE_DOWNLOAD_DELAY` -setting (which is enabled by default). By default, Scrapy doesn't wait a fixed -amount of time between requests, but uses a random interval between 0.5 * :setting:`DOWNLOAD_DELAY` and 1.5 * :setting:`DOWNLOAD_DELAY`. +setting, which is enabled by default. When :setting:`CONCURRENT_REQUESTS_PER_IP` is non-zero, delays are enforced -per ip address instead of per domain. +per IP address instead of per domain. + +Note that :setting:`DOWNLOAD_DELAY` can lower the effective per-domain +concurrency below :setting:`CONCURRENT_REQUESTS_PER_DOMAIN`. If the response +time of a domain is lower than :setting:`DOWNLOAD_DELAY`, the effective +concurrency for that domain is 1. When testing throttling configurations, it +usually makes sense to lower :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` first, +and only increase :setting:`DOWNLOAD_DELAY` once +:setting:`CONCURRENT_REQUESTS_PER_DOMAIN` is 1 but a higher throttling is +desired. .. _spider-download_delay-attribute: @@ -656,6 +667,11 @@ per ip address instead of per domain. This delay can be set per spider using :attr:`download_delay` spider attribute. +It is also possible to change this setting per domain, although it requires +non-trivial code. See the implementation of the :ref:`AutoThrottle +` extension for an example. + + .. setting:: DOWNLOAD_HANDLERS DOWNLOAD_HANDLERS diff --git a/docs/topics/spiders.rst b/docs/topics/spiders.rst index ffe41cf3e..7aa8555d5 100644 --- a/docs/topics/spiders.rst +++ b/docs/topics/spiders.rst @@ -99,7 +99,7 @@ scrapy.Spider .. attribute:: crawler This attribute is set by the :meth:`from_crawler` class method after - initializating the class, and links to the + initializing the class, and links to the :class:`~scrapy.crawler.Crawler` object to which this spider instance is bound. diff --git a/extras/qpsclient.py b/extras/qpsclient.py index 83bb08561..bb8527af2 100644 --- a/extras/qpsclient.py +++ b/extras/qpsclient.py @@ -1,9 +1,10 @@ """ -A spider that generate light requests to meassure QPS throughput +A spider that generate light requests to measure QPS throughput usage: - scrapy runspider qpsclient.py --loglevel=INFO --set RANDOMIZE_DOWNLOAD_DELAY=0 --set CONCURRENT_REQUESTS=50 -a qps=10 -a latency=0.3 + scrapy runspider qpsclient.py --loglevel=INFO --set RANDOMIZE_DOWNLOAD_DELAY=0 + --set CONCURRENT_REQUESTS=50 -a qps=10 -a latency=0.3 """ diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 1d74923a9..ffb40e1c5 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -24,7 +24,7 @@ class ScrapyArgumentParser(argparse.ArgumentParser): def _iter_command_classes(module_name): - # TODO: add `name` attribute to commands and and merge this function with + # TODO: add `name` attribute to commands and merge this function with # scrapy.utils.spider.iter_spider_classes for module in walk_modules(module_name): for obj in vars(module).values(): diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index 9dd2df638..1513638df 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -83,7 +83,9 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): # kept for old-style HTTP/1.0 downloader context twisted calls, # e.g. connectSSL() def getContext(self, hostname=None, port=None): - return self.getCertificateOptions().getContext() + ctx = self.getCertificateOptions().getContext() + ctx.set_options(0x4) # OP_LEGACY_SERVER_CONNECT + return ctx def creatorForNetloc(self, hostname, port): return ScrapyClientTLSOptions( diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index db2639a75..d1c511db0 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -23,8 +23,8 @@ METHOD_TLSv12 = "TLSv1.2" openssl_methods = { METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only - METHOD_TLSv11: getattr(SSL, "TLSv1_1_METHOD", 5), # TLS 1.1 only - METHOD_TLSv12: getattr(SSL, "TLSv1_2_METHOD", 6), # TLS 1.2 only + METHOD_TLSv11: SSL.TLSv1_1_METHOD, # TLS 1.1 only + METHOD_TLSv12: SSL.TLSv1_2_METHOD, # TLS 1.2 only } diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index a00afb7af..6421391d0 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -101,7 +101,7 @@ class ScrapyHTTPPageGetter(HTTPClient): # This class used to inherit from Twisted’s # twisted.web.client.HTTPClientFactory. When that class was deprecated in # Twisted (https://github.com/twisted/twisted/pull/643), we merged its -# non-overriden code into this class. +# non-overridden code into this class. class ScrapyHTTPClientFactory(ClientFactory): protocol = ScrapyHTTPPageGetter diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index 1b185cd8c..2b5c98e5f 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -348,7 +348,7 @@ class Stream: def receive_headers(self, headers: List[HeaderTuple]) -> None: for name, value in headers: - self._response["headers"][name] = value + self._response["headers"].appendlist(name, value) # Check if we exceed the allowed max data size which can be received expected_size = int(self._response["headers"].get(b"Content-Length", -1)) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index ca4d77a35..823955aa3 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -384,11 +384,11 @@ class FeedExporter: return defer.DeferredList(deferred_list) if deferred_list else None def _close_slot(self, slot, spider): + slot.finish_exporting() if not slot.itemcount and not slot.store_empty: # We need to call slot.storage.store nonetheless to get the file # properly closed. return defer.maybeDeferred(slot.storage.store, slot.file) - slot.finish_exporting() logmsg = f"{slot.format} feed ({slot.itemcount} items) in: {slot.uri}" d = defer.maybeDeferred(slot.storage.store, slot.file) diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index 3bfbddc54..bbddaac40 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -196,7 +196,7 @@ class RFC2616Policy: if response.status in (300, 301, 308): return self.MAXAGE - # Insufficient information to compute fresshness lifetime + # Insufficient information to compute freshness lifetime return 0 def _compute_current_age(self, response, request, now): diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index ea519fb19..993219745 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -200,7 +200,7 @@ def _select_value(ele: SelectElement, n: str, v: str): o = ele.value_options return (n, o[0]) if o else (None, None) if v is not None and multiple: - # This is a workround to bug in lxml fixed 2.3.1 + # This is a workaround to bug in lxml fixed 2.3.1 # fix https://github.com/lxml/lxml/commit/57f49eed82068a20da3db8f1b18ae00c1bab8b12#L1L1139 selected_options = ele.xpath(".//option[@selected]") values = [(o.get("value") or o.text or "").strip() for o in selected_options] diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 0bd28a882..66cf58d89 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -226,7 +226,8 @@ class LxmlLinkExtractor: Only links that match the settings passed to the ``__init__`` method of the link extractor are returned. - Duplicate links are omitted. + Duplicate links are omitted if the ``unique`` attribute is set to ``True``, + otherwise they are returned. """ base_url = get_base_url(response) if self.restrict_xpaths: @@ -239,4 +240,6 @@ class LxmlLinkExtractor: for doc in docs: links = self._extract_links(doc, response.url, response.encoding, base_url) all_links.extend(self._process_links(links)) - return unique_list(all_links) + if self.link_extractor.unique: + return unique_list(all_links) + return all_links diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index fcecb5fbb..0cfa5665a 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -151,8 +151,8 @@ class ImagesPipeline(FilesPipeline): ) if self._deprecated_convert_image: warnings.warn( - f"{self.__class__.__name__}.convert_image() method overriden in a deprecated way, " - "overriden method does not accept response_body argument.", + f"{self.__class__.__name__}.convert_image() method overridden in a deprecated way, " + "overridden method does not accept response_body argument.", category=ScrapyDeprecationWarning, ) diff --git a/scrapy/shell.py b/scrapy/shell.py index a42dedc93..084a27141 100644 --- a/scrapy/shell.py +++ b/scrapy/shell.py @@ -177,7 +177,11 @@ class Shell: def inspect_response(response, spider): """Open a shell to inspect the given response""" + # Shell.start removes the SIGINT handler, so save it and re-add it after + # the shell has closed + sigint_handler = signal.getsignal(signal.SIGINT) Shell(spider.crawler).start(response=response, spider=spider) + signal.signal(signal.SIGINT, sigint_handler) def _request_deferred(request): diff --git a/scrapy/utils/console.py b/scrapy/utils/console.py index b64098d7b..100f040bb 100644 --- a/scrapy/utils/console.py +++ b/scrapy/utils/console.py @@ -1,5 +1,4 @@ from functools import wraps -from collections import OrderedDict def _embed_ipython_shell(namespace={}, banner=""): @@ -70,14 +69,12 @@ def _embed_standard_shell(namespace={}, banner=""): return wrapper -DEFAULT_PYTHON_SHELLS = OrderedDict( - [ - ("ptpython", _embed_ptpython_shell), - ("ipython", _embed_ipython_shell), - ("bpython", _embed_bpython_shell), - ("python", _embed_standard_shell), - ] -) +DEFAULT_PYTHON_SHELLS = { + "ptpython": _embed_ptpython_shell, + "ipython": _embed_ipython_shell, + "bpython": _embed_bpython_shell, + "python": _embed_standard_shell, +} def get_shell_embed_func(shells=None, known_shells=None): diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 4af2a647a..21cd5e78f 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -26,10 +26,7 @@ from twisted.python import failure from twisted.python.failure import Failure from scrapy.exceptions import IgnoreRequest -from scrapy.utils.reactor import ( - is_asyncio_reactor_installed, - get_asyncio_event_loop_policy, -) +from scrapy.utils.reactor import is_asyncio_reactor_installed, _get_asyncio_event_loop def defer_fail(_failure: Failure) -> Deferred: @@ -290,7 +287,7 @@ def deferred_from_coro(o) -> Any: # that use asyncio, e.g. "await asyncio.sleep(1)" return ensureDeferred(o) # wrapping the coroutine into a Future and then into a Deferred, this requires AsyncioSelectorReactor - event_loop = get_asyncio_event_loop_policy().get_event_loop() + event_loop = _get_asyncio_event_loop() return Deferred.fromFuture(asyncio.ensure_future(o, loop=event_loop)) return o @@ -343,8 +340,7 @@ def deferred_to_future(d: Deferred) -> Future: d = treq.get('https://example.com/additional') additional_response = await deferred_to_future(d) """ - policy = get_asyncio_event_loop_policy() - return d.asFuture(policy.get_event_loop()) + return d.asFuture(_get_asyncio_event_loop()) def maybe_deferred_to_future(d: Deferred) -> Union[Deferred, Future]: diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index e40016031..c20948fd3 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -1,6 +1,7 @@ import asyncio import sys from contextlib import suppress +from warnings import catch_warnings, filterwarnings from twisted.internet import asyncioreactor, error @@ -83,6 +84,10 @@ def install_reactor(reactor_path, event_loop_path=None): installer() +def _get_asyncio_event_loop(): + return set_asyncio_event_loop(None) + + def set_asyncio_event_loop(event_loop_path): """Sets and returns the event loop with specified import path.""" policy = get_asyncio_event_loop_policy() @@ -92,11 +97,26 @@ def set_asyncio_event_loop(event_loop_path): asyncio.set_event_loop(event_loop) else: try: - event_loop = policy.get_event_loop() + with catch_warnings(): + # In Python 3.10.9, 3.11.1, 3.12 and 3.13, a DeprecationWarning + # is emitted about the lack of a current event loop, because in + # Python 3.14 and later `get_event_loop` will raise a + # RuntimeError in that event. Because our code is already + # prepared for that future behavior, we ignore the deprecation + # warning. + filterwarnings( + "ignore", + message="There is no current event loop", + category=DeprecationWarning, + ) + event_loop = policy.get_event_loop() except RuntimeError: - # `get_event_loop` is expected to fail when called from a new thread - # with no asyncio event loop yet installed. Such is the case when - # called from `scrapy shell` + # `get_event_loop` raises RuntimeError when called with no asyncio + # event loop yet installed in the following scenarios: + # - From a thread other than the main thread. For example, when + # using ``scrapy shell``. + # - Previsibly on Python 3.14 and later. + # https://github.com/python/cpython/issues/100160#issuecomment-1345581902 event_loop = policy.new_event_loop() asyncio.set_event_loop(event_loop) return event_loop diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index 3693177e4..a91a49170 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -40,7 +40,7 @@ def get_meta_refresh( response: "scrapy.http.response.text.TextResponse", ignore_tags: Optional[Iterable[str]] = ("script", "noscript"), ) -> Union[Tuple[None, None], Tuple[float, str]]: - """Parse the http-equiv refrsh parameter from the given response""" + """Parse the http-equiv refresh parameter from the given response""" if response not in _metaref_cache: text = response.text[0:4096] _metaref_cache[response] = html.get_meta_refresh( diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index b73261723..9f03621c1 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -1,14 +1,9 @@ -import OpenSSL +import OpenSSL.SSL import OpenSSL._util as pyOpenSSLutil from scrapy.utils.python import to_unicode -# The OpenSSL symbol is present since 1.1.1 but it's not currently supported in any version of pyOpenSSL. -# Using the binding directly, as this code does, requires cryptography 2.4. -SSL_OP_NO_TLSv1_3 = getattr(pyOpenSSLutil.lib, "SSL_OP_NO_TLSv1_3", 0) - - def ffi_buf_to_string(buf): return to_unicode(pyOpenSSLutil.ffi.string(buf)) @@ -24,11 +19,6 @@ def x509name_to_string(x509name): def get_temp_key_info(ssl_object): - if not hasattr( - pyOpenSSLutil.lib, "SSL_get_server_tmp_key" - ): # requires OpenSSL 1.0.2 - return None - # adapted from OpenSSL apps/s_cb.c::ssl_print_tmp_key() temp_key_p = pyOpenSSLutil.ffi.new("EVP_PKEY **") if not pyOpenSSLutil.lib.SSL_get_server_tmp_key(ssl_object, temp_key_p): diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index ad3bff4f0..cd8a6a05a 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -48,7 +48,7 @@ def parse_url(url, encoding=None): def escape_ajax(url): """ - Return the crawleable url according to: + Return the crawlable url according to: https://developers.google.com/webmasters/ajax-crawling/docs/getting-started >>> escape_ajax("www.example.com/ajax.html#!key=value") diff --git a/sep/sep-016.rst b/sep/sep-016.rst index 335f09f45..a60ab30dd 100644 --- a/sep/sep-016.rst +++ b/sep/sep-016.rst @@ -148,7 +148,7 @@ Another example could be for building URL canonicalizers: :: #!python - class CanonializeUrl(LegSpider): + class CanonicalizeUrl(LegSpider): def process_request(self, request): curl = canonicalize_url(request.url, rules=self.spider.canonicalization_rules) diff --git a/sep/sep-018.rst b/sep/sep-018.rst index fe707923a..96df82f6b 100644 --- a/sep/sep-018.rst +++ b/sep/sep-018.rst @@ -321,7 +321,7 @@ Another example could be for building URL canonicalizers: :: #!python - class CanonializeUrl(object): + class CanonicalizeUrl(object): def process_request(self, request, response, spider): curl = canonicalize_url(request.url, @@ -594,18 +594,18 @@ A middleware to Scrape data using Parsley as described in UsingParsley class ParsleyExtractor(object): - def __init__(self, parslet_json_code): - parslet = json.loads(parselet_json_code) + def __init__(self, parsley_json_code): + parsley = json.loads(parselet_json_code) class ParsleyItem(Item): def __init__(self, *a, **kw): - for name in parslet.keys(): + for name in parsley.keys(): self.fields[name] = Field() super(ParsleyItem, self).__init__(*a, **kw) self.item_class = ParsleyItem - self.parsley = PyParsley(parslet, output='python') + self.parsley = PyParsley(parsley, output='python') def process_response(self, response, request, spider): - return self.item_class(self.parsly.parse(string=response.body)) + return self.item_class(self.parsley.parse(string=response.body)) diff --git a/sep/sep-021.rst b/sep/sep-021.rst index c1ec16f7f..d56bc26af 100644 --- a/sep/sep-021.rst +++ b/sep/sep-021.rst @@ -79,7 +79,7 @@ If it raises an exception, Scrapy will print it and exit. Examples:: def addon_configure(settings): - settings.overrides['DOWNLADER_MIDDLEWARES'].update({ + settings.overrides['DOWNLOADER_MIDDLEWARES'].update({ 'scrapy.contrib.downloadermiddleware.httpcache.HttpCacheMiddleware': 900, }) diff --git a/setup.py b/setup.py index 5d1245f37..f53334d4e 100644 --- a/setup.py +++ b/setup.py @@ -19,7 +19,7 @@ def has_environment_marker_platform_impl_support(): install_requires = [ "Twisted>=18.9.0", - "cryptography>=3.3", + "cryptography>=3.4.6", "cssselect>=0.9.1", "itemloaders>=1.0.1", "parsel>=1.5.0", diff --git a/tests/mockserver.py b/tests/mockserver.py index 9f1a707c9..e07ae8797 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -19,7 +19,6 @@ from twisted.web.static import File from twisted.web.util import redirectTo from scrapy.utils.python import to_bytes, to_unicode -from scrapy.utils.ssl import SSL_OP_NO_TLSv1_3 from scrapy.utils.test import get_testenv @@ -358,7 +357,7 @@ def ssl_context_factory( if cipher_string: ctx = factory.getContext() # disabling TLS1.3 because it unconditionally enables some strong ciphers - ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL_OP_NO_TLSv1_3) + ctx.set_options(SSL.OP_CIPHER_SERVER_PREFERENCE | SSL.OP_NO_TLSv1_3) ctx.set_cipher_list(to_bytes(cipher_string)) return factory diff --git a/tests/pipelines.py b/tests/pipelines.py index 4e73178d5..d9fc12676 100644 --- a/tests/pipelines.py +++ b/tests/pipelines.py @@ -11,6 +11,6 @@ class ZeroDivisionErrorPipeline: return item -class ProcessWithZeroDivisionErrorPipiline: +class ProcessWithZeroDivisionErrorPipeline: def process_item(self, item, spider): 1 / 0 diff --git a/tests/sample_data/link_extractor/linkextractor.html b/tests/sample_data/link_extractor/linkextractor.html index e3a2a4145..29075602d 100644 --- a/tests/sample_data/link_extractor/linkextractor.html +++ b/tests/sample_data/link_extractor/linkextractor.html @@ -13,6 +13,7 @@
sample 3 text sample 3 repetition + sample 3 repetition sample 3 repetition with fragment inner tag diff --git a/tests/test_commands.py b/tests/test_commands.py index ed0eb85f5..363e87aa7 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -336,7 +336,7 @@ class StartprojectTemplatesTest(ProjectTest): self.assertEqual(actual_permissions, expected_permissions) def test_startproject_permissions_unchanged_in_destination(self): - """Check that pre-existing folders and files in the destination folder + """Check that preexisting folders and files in the destination folder do not see their permissions modified.""" scrapy_path = scrapy.__path__[0] project_template = Path(scrapy_path, "templates", "project") diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 3f19bef22..4139f1b11 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -154,7 +154,7 @@ class CrawlTestCase(TestCase): raise unittest.SkipTest("Non-existing hosts are resolvable") crawler = get_crawler(SimpleSpider) with LogCapture() as log: - # try to fetch the homepage of a non-existent domain + # try to fetch the homepage of a nonexistent domain yield crawler.crawl( "http://dns.resolution.invalid./", mockserver=self.mockserver ) @@ -183,7 +183,7 @@ class CrawlTestCase(TestCase): self.assertIs(record.exc_info[0], ZeroDivisionError) @defer.inlineCallbacks - def test_start_requests_lazyness(self): + def test_start_requests_laziness(self): settings = {"CONCURRENT_REQUESTS": 1} crawler = get_crawler(BrokenStartRequestsSpider, settings) yield crawler.crawl(mockserver=self.mockserver) diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 536d09f18..4f953439d 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -209,6 +209,12 @@ class LargeChunkedFileResource(resource.Resource): return server.NOT_DONE_YET +class DuplicateHeaderResource(resource.Resource): + def render(self, request): + request.responseHeaders.setRawHeaders(b"Set-Cookie", [b"a=b", b"c=d"]) + return b"" + + class HttpTestCase(unittest.TestCase): scheme = "http" download_handler_cls: Type = HTTPDownloadHandler @@ -234,6 +240,7 @@ class HttpTestCase(unittest.TestCase): r.putChild(b"contentlength", ContentLengthHeaderResource()) r.putChild(b"nocontenttype", EmptyContentTypeHeaderResource()) r.putChild(b"largechunkedfile", LargeChunkedFileResource()) + r.putChild(b"duplicate-header", DuplicateHeaderResource()) r.putChild(b"echo", Echo()) self.site = server.Site(r, timeout=None) self.wrapper = WrappingFactory(self.site) @@ -407,6 +414,16 @@ class HttpTestCase(unittest.TestCase): HtmlResponse, ) + def test_get_duplicate_header(self): + def _test(response): + self.assertEqual( + response.headers.getlist(b"Set-Cookie"), + [b"a=b", b"c=d"], + ) + + request = Request(self.getURL("duplicate-header")) + return self.download_request(request, Spider("foo")).addCallback(_test) + class Http10TestCase(HttpTestCase): """HTTP 1.0 test case""" @@ -1095,9 +1112,9 @@ class BaseFTPTestCase(unittest.TestCase): return self._add_test_callbacks(d, _test) - def test_ftp_download_notexist(self): + def test_ftp_download_nonexistent(self): request = Request( - url=f"ftp://127.0.0.1:{self.portNum}/notexist.txt", meta=self.req_meta + url=f"ftp://127.0.0.1:{self.portNum}/nonexistent.txt", meta=self.req_meta ) d = self.download_handler.download_request(request, None) diff --git a/tests/test_downloadermiddleware_useragent.py b/tests/test_downloadermiddleware_useragent.py index 927f0ae4d..0702dd042 100644 --- a/tests/test_downloadermiddleware_useragent.py +++ b/tests/test_downloadermiddleware_useragent.py @@ -19,7 +19,7 @@ class UserAgentMiddlewareTest(TestCase): self.assertEqual(req.headers["User-Agent"], b"default_useragent") def test_remove_agent(self): - # settings UESR_AGENT to None should remove the user agent + # settings USER_AGENT to None should remove the user agent spider, mw = self.get_spider_and_mw("default_useragent") spider.user_agent = None mw.spider_opened(spider) diff --git a/tests/test_engine.py b/tests/test_engine.py index 7b861332e..7ddb420ba 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -109,7 +109,7 @@ class DataClassItemsSpider(TestSpider): class ItemZeroDivisionErrorSpider(TestSpider): custom_settings = { "ITEM_PIPELINES": { - "tests.pipelines.ProcessWithZeroDivisionErrorPipiline": 300, + "tests.pipelines.ProcessWithZeroDivisionErrorPipeline": 300, } } diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 890c88c7e..09a4aa823 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -33,8 +33,9 @@ from zope.interface.verify import verifyObject import scrapy from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning -from scrapy.exporters import CsvItemExporter +from scrapy.exporters import CsvItemExporter, JsonItemExporter from scrapy.extensions.feedexport import ( + _FeedSlot, BlockingFeedStorage, FeedExporter, FileFeedStorage, @@ -664,6 +665,50 @@ class FeedExportTestBase(ABC, unittest.TestCase): return result +class InstrumentedFeedSlot(_FeedSlot): + """Instrumented _FeedSlot subclass for keeping track of calls to + start_exporting and finish_exporting.""" + + def start_exporting(self): + self.update_listener("start") + super().start_exporting() + + def finish_exporting(self): + self.update_listener("finish") + super().finish_exporting() + + @classmethod + def subscribe__listener(cls, listener): + cls.update_listener = listener.update + + +class IsExportingListener: + """When subscribed to InstrumentedFeedSlot, keeps track of when + a call to start_exporting has been made without a closing call to + finish_exporting and when a call to finish_exporting has been made + before a call to start_exporting.""" + + def __init__(self): + self.start_without_finish = False + self.finish_without_start = False + + def update(self, method): + if method == "start": + self.start_without_finish = True + elif method == "finish": + if self.start_without_finish: + self.start_without_finish = False + else: + self.finish_before_start = True + + +class ExceptionJsonItemExporter(JsonItemExporter): + """JsonItemExporter that throws an exception every time export_item is called.""" + + def export_item(self, _): + raise Exception("foo") + + class FeedExportTest(FeedExportTestBase): __test__ = True @@ -909,6 +954,84 @@ class FeedExportTest(FeedExportTestBase): data = yield self.exported_no_data(settings) self.assertEqual(b"", data[fmt]) + @defer.inlineCallbacks + def test_start_finish_exporting_items(self): + items = [ + self.MyItem({"foo": "bar1", "egg": "spam1"}), + ] + settings = { + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + }, + "FEED_EXPORT_INDENT": None, + } + + listener = IsExportingListener() + InstrumentedFeedSlot.subscribe__listener(listener) + + with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + _ = yield self.exported_data(items, settings) + self.assertFalse(listener.start_without_finish) + self.assertFalse(listener.finish_without_start) + + @defer.inlineCallbacks + def test_start_finish_exporting_no_items(self): + items = [] + settings = { + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + }, + "FEED_EXPORT_INDENT": None, + } + + listener = IsExportingListener() + InstrumentedFeedSlot.subscribe__listener(listener) + + with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + _ = yield self.exported_data(items, settings) + self.assertFalse(listener.start_without_finish) + self.assertFalse(listener.finish_without_start) + + @defer.inlineCallbacks + def test_start_finish_exporting_items_exception(self): + items = [ + self.MyItem({"foo": "bar1", "egg": "spam1"}), + ] + settings = { + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + }, + "FEED_EXPORTERS": {"json": ExceptionJsonItemExporter}, + "FEED_EXPORT_INDENT": None, + } + + listener = IsExportingListener() + InstrumentedFeedSlot.subscribe__listener(listener) + + with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + _ = yield self.exported_data(items, settings) + self.assertFalse(listener.start_without_finish) + self.assertFalse(listener.finish_without_start) + + @defer.inlineCallbacks + def test_start_finish_exporting_no_items_exception(self): + items = [] + settings = { + "FEEDS": { + self._random_temp_filename(): {"format": "json"}, + }, + "FEED_EXPORTERS": {"json": ExceptionJsonItemExporter}, + "FEED_EXPORT_INDENT": None, + } + + listener = IsExportingListener() + InstrumentedFeedSlot.subscribe__listener(listener) + + with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + _ = yield self.exported_data(items, settings) + self.assertFalse(listener.start_without_finish) + self.assertFalse(listener.finish_without_start) + @defer.inlineCallbacks def test_export_no_items_store_empty(self): formats = ( diff --git a/tests/test_http_request.py b/tests/test_http_request.py index b6f999b29..0c10b27a0 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -399,7 +399,7 @@ class RequestTest(unittest.TestCase): ) self.assertEqual(r.method, "DELETE") - # If `ignore_unknon_options` is set to `False` it raises an error with + # If `ignore_unknown_options` is set to `False` it raises an error with # the unknown options: --foo and -z self.assertRaises( ValueError, @@ -997,7 +997,7 @@ class FormRequestTest(RequestTest): fs = _qs(r1) self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) - def test_from_response_formname_notexist(self): + def test_from_response_formname_nonexistent(self): response = _buildresponse( """ @@ -1044,7 +1044,7 @@ class FormRequestTest(RequestTest): fs = _qs(r1) self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) - def test_from_response_formname_notexists_fallback_formid(self): + def test_from_response_formname_nonexistent_fallback_formid(self): response = _buildresponse( """ @@ -1062,7 +1062,7 @@ class FormRequestTest(RequestTest): fs = _qs(r1) self.assertEqual(fs, {b"four": [b"4"], b"three": [b"3"]}) - def test_from_response_formid_notexist(self): + def test_from_response_formid_nonexistent(self): response = _buildresponse( """ diff --git a/tests/test_http_response.py b/tests/test_http_response.py index ce32092c1..8c422bb4f 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -518,7 +518,7 @@ class TextResponseTest(BaseResponseTest): def test_bom_is_removed_from_body(self): # Inferring encoding from body also cache decoded body as sideeffect, # this test tries to ensure that calling response.encoding and - # response.text in indistint order doesn't affect final + # response.text in indistinct order doesn't affect final # values for encoding and decoded body. url = "http://example.com" body = b"\xef\xbb\xbfWORD" @@ -645,6 +645,7 @@ class TextResponseTest(BaseResponseTest): "http://example.com/sample2.html", "http://example.com/sample3.html", "http://example.com/sample3.html", + "http://example.com/sample3.html", "http://example.com/sample3.html#foo", "http://www.google.com/something", "http://example.com/innertag.html", diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 520effedb..f663013ba 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -74,6 +74,10 @@ class Base: url="http://example.com/sample3.html", text="sample 3 repetition", ), + Link( + url="http://example.com/sample3.html", + text="sample 3 repetition", + ), Link( url="http://example.com/sample3.html#foo", text="sample 3 repetition with fragment", @@ -93,6 +97,10 @@ class Base: url="http://example.com/sample3.html", text="sample 3 repetition", ), + Link( + url="http://example.com/sample3.html", + text="sample 3 repetition", + ), Link( url="http://example.com/sample3.html", text="sample 3 repetition with fragment", diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 3cd3e5966..38a2d6c41 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -225,8 +225,8 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(buf.getvalue(), thumb_buf.getvalue()) expected_warning_msg = ( - ".convert_image() method overriden in a deprecated way, " - "overriden method does not accept response_body argument." + ".convert_image() method overridden in a deprecated way, " + "overridden method does not accept response_body argument." ) self.assertEqual( len( @@ -244,7 +244,7 @@ class ImagesPipelineTestCase(unittest.TestCase): with warnings.catch_warnings(record=True) as w: warnings.simplefilter("always") SIZE = (100, 100) - # straigh forward case: RGB and JPEG + # straight forward case: RGB and JPEG COLOUR = (0, 127, 255) im, _ = _create_image("JPEG", "RGB", SIZE, COLOUR) converted, _ = self.pipeline.convert_image(im) @@ -271,7 +271,7 @@ class ImagesPipelineTestCase(unittest.TestCase): self.assertEqual(converted.mode, "RGB") self.assertEqual(converted.getcolors(), [(10000, (205, 230, 255))]) - # ensure that we recieved deprecation warnings + # ensure that we received deprecation warnings expected_warning_msg = ".convert_image() method called in a deprecated way" self.assertTrue( len( @@ -287,7 +287,7 @@ class ImagesPipelineTestCase(unittest.TestCase): def test_convert_image_new(self): # tests for new API SIZE = (100, 100) - # straigh forward case: RGB and JPEG + # straight forward case: RGB and JPEG COLOUR = (0, 127, 255) im, buf = _create_image("JPEG", "RGB", SIZE, COLOUR) converted, converted_buf = self.pipeline.convert_image(im, response_body=buf) diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index f7540743d..17c0309d1 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -11,12 +11,12 @@ from tests.mockserver import MockServer from tests.spiders import SingleRequestSpider -OVERRIDEN_URL = "https://example.org" +OVERRIDDEN_URL = "https://example.org" class ProcessResponseMiddleware: def process_response(self, request, response, spider): - return response.replace(request=Request(OVERRIDEN_URL)) + return response.replace(request=Request(OVERRIDDEN_URL)) class RaiseExceptionRequestMiddleware: @@ -30,7 +30,7 @@ class CatchExceptionOverrideRequestMiddleware: return Response( url="http://localhost/", body=b"Caught " + exception.__class__.__name__.encode("utf-8"), - request=Request(OVERRIDEN_URL), + request=Request(OVERRIDDEN_URL), ) @@ -52,7 +52,7 @@ class AlternativeCallbacksSpider(SingleRequestSpider): class AlternativeCallbacksMiddleware: def process_response(self, request, response, spider): new_request = request.replace( - url=OVERRIDEN_URL, + url=OVERRIDDEN_URL, callback=spider.alt_callback, cb_kwargs={"foo": "bar"}, ) @@ -132,16 +132,16 @@ class CrawlTestCase(TestCase): yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] - self.assertEqual(response.request.url, OVERRIDEN_URL) + self.assertEqual(response.request.url, OVERRIDDEN_URL) self.assertEqual(signal_params["response"].url, url) - self.assertEqual(signal_params["request"].url, OVERRIDEN_URL) + self.assertEqual(signal_params["request"].url, OVERRIDDEN_URL) log.check_present( ( "scrapy.core.engine", "DEBUG", - f"Crawled (200) (referer: None)", + f"Crawled (200) (referer: None)", ), ) @@ -166,7 +166,7 @@ class CrawlTestCase(TestCase): yield crawler.crawl(seed=url, mockserver=self.mockserver) response = crawler.spider.meta["responses"][0] self.assertEqual(response.body, b"Caught ZeroDivisionError") - self.assertEqual(response.request.url, OVERRIDEN_URL) + self.assertEqual(response.request.url, OVERRIDDEN_URL) @defer.inlineCallbacks def test_downloader_middleware_do_not_override_in_process_exception(self): diff --git a/tests/test_spidermiddleware_referer.py b/tests/test_spidermiddleware_referer.py index db5a22adb..dad39b6ee 100644 --- a/tests/test_spidermiddleware_referer.py +++ b/tests/test_spidermiddleware_referer.py @@ -227,7 +227,7 @@ class MixinSameOrigin: ), ("http://example.com:81/page.html", "http://example.com/not-page.html", None), ("http://example.com/page.html", "http://example.com:81/not-page.html", None), - # Different protocols: do NOT send refferer + # Different protocols: do NOT send referrer ("https://example.com/page.html", "http://example.com/not-page.html", None), ("https://example.com/page.html", "http://not.example.com/", None), ("ftps://example.com/urls.zip", "https://example.com/not-page.html", None), @@ -750,19 +750,19 @@ class TestRequestMetaUnsafeUrl(MixinUnsafeUrl, TestRefererMiddleware): req_meta = {"referrer_policy": POLICY_UNSAFE_URL} -class TestRequestMetaPredecence001(MixinUnsafeUrl, TestRefererMiddleware): +class TestRequestMetaPrecedence001(MixinUnsafeUrl, TestRefererMiddleware): settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.SameOriginPolicy"} req_meta = {"referrer_policy": POLICY_UNSAFE_URL} -class TestRequestMetaPredecence002(MixinNoReferrer, TestRefererMiddleware): +class TestRequestMetaPrecedence002(MixinNoReferrer, TestRefererMiddleware): settings = { "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" } req_meta = {"referrer_policy": POLICY_NO_REFERRER} -class TestRequestMetaPredecence003(MixinUnsafeUrl, TestRefererMiddleware): +class TestRequestMetaPrecedence003(MixinUnsafeUrl, TestRefererMiddleware): settings = { "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.OriginWhenCrossOriginPolicy" } @@ -888,19 +888,19 @@ class TestSettingsPolicyByName(TestCase): RefererMiddleware(settings) -class TestPolicyHeaderPredecence001(MixinUnsafeUrl, TestRefererMiddleware): +class TestPolicyHeaderPrecedence001(MixinUnsafeUrl, TestRefererMiddleware): settings = {"REFERRER_POLICY": "scrapy.spidermiddlewares.referer.SameOriginPolicy"} resp_headers = {"Referrer-Policy": POLICY_UNSAFE_URL.upper()} -class TestPolicyHeaderPredecence002(MixinNoReferrer, TestRefererMiddleware): +class TestPolicyHeaderPrecedence002(MixinNoReferrer, TestRefererMiddleware): settings = { "REFERRER_POLICY": "scrapy.spidermiddlewares.referer.NoReferrerWhenDowngradePolicy" } resp_headers = {"Referrer-Policy": POLICY_NO_REFERRER.swapcase()} -class TestPolicyHeaderPredecence003( +class TestPolicyHeaderPrecedence003( MixinNoReferrerWhenDowngrade, TestRefererMiddleware ): settings = { @@ -909,7 +909,7 @@ class TestPolicyHeaderPredecence003( resp_headers = {"Referrer-Policy": POLICY_NO_REFERRER_WHEN_DOWNGRADE.title()} -class TestPolicyHeaderPredecence004( +class TestPolicyHeaderPrecedence004( MixinNoReferrerWhenDowngrade, TestRefererMiddleware ): """ diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index 25cef2b26..d09335651 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -15,6 +15,11 @@ class AsyncioTest(TestCase): ) def test_install_asyncio_reactor(self): + from twisted.internet import reactor as original_reactor + with warnings.catch_warnings(record=True) as w: install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") self.assertEqual(len(w), 0) + from twisted.internet import reactor + + assert original_reactor == reactor diff --git a/tests/test_utils_deprecate.py b/tests/test_utils_deprecate.py index 1a8c96e7a..214deceb2 100644 --- a/tests/test_utils_deprecate.py +++ b/tests/test_utils_deprecate.py @@ -74,7 +74,7 @@ class WarnWhenSubclassedTest(unittest.TestCase): self.assertIn("foo.NewClass", str(w[1].message)) self.assertIn("bar.OldClass", str(w[1].message)) - def test_subclassing_warns_only_on_direct_childs(self): + def test_subclassing_warns_only_on_direct_children(self): Deprecated = create_deprecated_class( "Deprecated", NewName, warn_once=False, warn_category=MyWarning ) diff --git a/tests/test_utils_display.py b/tests/test_utils_display.py index 43236acec..da61f4b0b 100644 --- a/tests/test_utils_display.py +++ b/tests/test_utils_display.py @@ -7,17 +7,27 @@ from scrapy.utils.display import pformat, pprint class TestDisplay(TestCase): object = {"a": 1} - colorized_string = ( - "{\x1b[33m'\x1b[39;49;00m\x1b[33ma\x1b[39;49;00m\x1b[33m'" - "\x1b[39;49;00m: \x1b[34m1\x1b[39;49;00m}\n" - ) + colorized_strings = { + ( + ( + "{\x1b[33m'\x1b[39;49;00m\x1b[33ma\x1b[39;49;00m\x1b[33m'" + "\x1b[39;49;00m: \x1b[34m1\x1b[39;49;00m}" + ) + + suffix + ) + for suffix in ( + # https://github.com/pygments/pygments/issues/2313 + "\n", # pygments ≤ 2.13 + "\x1b[37m\x1b[39;49;00m\n", # pygments ≥ 2.14 + ) + } plain_string = "{'a': 1}" @mock.patch("sys.platform", "linux") @mock.patch("sys.stdout.isatty") def test_pformat(self, isatty): isatty.return_value = True - self.assertEqual(pformat(self.object), self.colorized_string) + self.assertIn(pformat(self.object), self.colorized_strings) @mock.patch("sys.stdout.isatty") def test_pformat_dont_colorize(self, isatty): @@ -33,7 +43,7 @@ class TestDisplay(TestCase): def test_pformat_old_windows(self, isatty, version): isatty.return_value = True version.return_value = "10.0.14392" - self.assertEqual(pformat(self.object), self.colorized_string) + self.assertIn(pformat(self.object), self.colorized_strings) @mock.patch("sys.platform", "win32") @mock.patch("scrapy.utils.display._enable_windows_terminal_processing") @@ -55,7 +65,7 @@ class TestDisplay(TestCase): isatty.return_value = True version.return_value = "10.0.14393" terminal_processing.return_value = True - self.assertEqual(pformat(self.object), self.colorized_string) + self.assertIn(pformat(self.object), self.colorized_strings) @mock.patch("sys.platform", "linux") @mock.patch("sys.stdout.isatty") diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 3c6270864..5caa5b8f2 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -159,7 +159,7 @@ class UtilsPythonTestCase(unittest.TestCase): b = Obj() # no attributes given return False self.assertFalse(equal_attributes(a, b, [])) - # not existent attributes + # nonexistent attributes self.assertFalse(equal_attributes(a, b, ["x", "y"])) a.x = 1 diff --git a/tox.ini b/tox.ini index e37ae4579..eaf29173a 100644 --- a/tox.ini +++ b/tox.ini @@ -32,7 +32,7 @@ download = true commands = pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:--durations=10 docs scrapy tests} install_command = - pip install -U -ctests/upper-constraints.txt {opts} {packages} + python -I -m pip install -ctests/upper-constraints.txt {opts} {packages} [testenv:typing] basepython = python3 @@ -63,8 +63,7 @@ commands = flake8 {posargs:docs scrapy tests} [testenv:pylint] -# reppy does not support Python 3.9+ -basepython = python3.8 +basepython = python3 deps = {[testenv:extra-deps]deps} pylint==2.15.6 @@ -75,13 +74,14 @@ commands = basepython = python3 deps = twine==4.0.1 + build==0.9.0 commands = - python setup.py sdist + python -m build --sdist twine check dist/* [pinned] deps = - cryptography==3.3 + cryptography==3.4.6 cssselect==0.9.1 h2==3.0 itemadapter==0.1.0 @@ -106,7 +106,7 @@ deps = setenv = _SCRAPY_PINNED=true install_command = - pip install -U {opts} {packages} + python -I -m pip install {opts} {packages} [testenv:pinned] deps = @@ -126,8 +126,7 @@ setenv = {[pinned]setenv} [testenv:extra-deps] -# reppy does not support Python 3.9+ -basepython = python3.8 +basepython = python3 deps = {[testenv]deps} boto @@ -135,7 +134,6 @@ deps = # Twisted[http2] currently forces old mitmproxy because of h2 version # restrictions in their deps, so we need to pin old markupsafe here too. markupsafe < 2.1.0 - reppy robotexclusionrulesparser Pillow>=4.0.0 Twisted[http2]>=17.9.0 From 0cfe81d1d3978169f6c8ccc90e49315dcd67aca7 Mon Sep 17 00:00:00 2001 From: Laerte Pereira <5853172+Laerte@users.noreply.github.com> Date: Sat, 21 Jan 2023 16:57:31 -0300 Subject: [PATCH 347/532] `set-output` command is deprecated --- .github/workflows/publish.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index eee9a4f02..02cf0c9fa 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -18,7 +18,7 @@ jobs: id: check-release-tag run: | if [[ ${{ github.event.ref }} =~ ^refs/tags/[0-9]+[.][0-9]+[.][0-9]+(rc[0-9]+|[.]dev[0-9]+)?$ ]]; then - echo ::set-output name=release_tag::true + echo "release_tag=true" >> $GITHUB_OUTPUT fi - name: Publish to PyPI From 72a853c751044172d90704bce1adb6780e50934e Mon Sep 17 00:00:00 2001 From: Emmanuel Rondan Date: Mon, 23 Jan 2023 14:56:48 -0300 Subject: [PATCH 348/532] fixing contributing page with suggestions --- docs/contributing.rst | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 12f0e8d21..edc6c2179 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -179,27 +179,30 @@ Scrapy: See https://help.github.com/en/github/using-git/setting-your-username-in-git for setup instructions. -.. _pre-commit: - Pre-commit ========== We use `pre-commit`_ to automatically address simple code issues before every commit. +.. _pre-commit: https://pre-commit.com/ + Before you start writing a patch: - #. `Install pre-commit `_. - #. On the root of your local clone of the Scrapy repository, run the following command: + +#. `Install pre-commit `_. + +#. On the root of your local clone of the Scrapy repository, run the following + command: .. code-block:: bash - - pre-commit install -Now our pre-commit hooks will run every time you create a Git commit. Upon -finding issues, pre-commit hooks aborts your commit, and they either fix -the corresponding issues automatically or only report them to you. If they fix -the issues automatically, creating your commit again should succeed. Otherwise, -you may need to address the corresponding issues manually first. + pre-commit install + +Now pre-commit will check your changes every time you create a Git commit. Upon +finding issues, pre-commit aborts your commit, and either fixes those issues +automatically, or only reports them to you. If it fixes those issues +automatically, creating your commit again should succeed. Otherwise, you may +need to address the corresponding issues manually first. .. _documentation-policies: From 84fb234cae1bffa944d9f5870c2fc87c75d35261 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 24 Jan 2023 22:47:38 -0800 Subject: [PATCH 349/532] fixed additional trigger in FilesPipeline --- scrapy/pipelines/files.py | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 4b0c96b25..a5948525a 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -36,13 +36,17 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) +def _to_string(path: Union[str, os.PathLike]): + return str(path) # convert a Path object to string + + class FileException(Exception): """General media error exception""" class FSFilesStore: def __init__(self, basedir: Union[str, os.PathLike]): - basedir = str(basedir) # support Path object + basedir = _to_string(basedir) if '://' in basedir: basedir = basedir.split('://', 1)[1] self.basedir = basedir @@ -67,7 +71,7 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: - path_comps = str(path).split('/') + path_comps = _to_string(path).split('/') return Path(self.basedir, *path_comps) def _mkdir(self, dirname: Path, domain: Optional[str] = None): @@ -323,12 +327,12 @@ class FilesPipeline(MediaPipeline): DEFAULT_FILES_RESULT_FIELD = 'files' def __init__(self, store_uri, download_func=None, settings=None): + store_uri = _to_string(store_uri) if not store_uri: raise NotConfigured if isinstance(settings, dict) or settings is None: settings = Settings(settings) - cls_name = "FilesPipeline" self.store = self._get_store(store_uri) resolve = functools.partial(self._key_for_pipe, From 44512bebc8bc74164c73be55a8fd5debafb48f10 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 24 Jan 2023 22:57:25 -0800 Subject: [PATCH 350/532] fixed mypy warnings with type declaration for os.PathLike --- scrapy/pipelines/files.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index a5948525a..6a32c8b47 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -36,7 +36,7 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) -def _to_string(path: Union[str, os.PathLike]): +def _to_string(path: Union[str, os.PathLike[str]]): return str(path) # convert a Path object to string @@ -45,7 +45,7 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir: Union[str, os.PathLike]): + def __init__(self, basedir: Union[str, os.PathLike[str]]): basedir = _to_string(basedir) if '://' in basedir: basedir = basedir.split('://', 1)[1] @@ -70,7 +70,7 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: + def _get_filesystem_path(self, path: Union[str, os.PathLike[str]]) -> Path: path_comps = _to_string(path).split('/') return Path(self.basedir, *path_comps) From 7c753adbe532f1a027d1d285a7c1e4b59fd9e5a8 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 24 Jan 2023 23:05:17 -0800 Subject: [PATCH 351/532] revert mypy fix didn't work --- scrapy/pipelines/files.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 6a32c8b47..a5948525a 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -36,7 +36,7 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) -def _to_string(path: Union[str, os.PathLike[str]]): +def _to_string(path: Union[str, os.PathLike]): return str(path) # convert a Path object to string @@ -45,7 +45,7 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir: Union[str, os.PathLike[str]]): + def __init__(self, basedir: Union[str, os.PathLike]): basedir = _to_string(basedir) if '://' in basedir: basedir = basedir.split('://', 1)[1] @@ -70,7 +70,7 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path: Union[str, os.PathLike[str]]) -> Path: + def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: path_comps = _to_string(path).split('/') return Path(self.basedir, *path_comps) From 42e8d5a6157a9d2495bd7a2934efe776eee2a7d6 Mon Sep 17 00:00:00 2001 From: Alex Date: Wed, 25 Jan 2023 01:03:27 -0800 Subject: [PATCH 352/532] fixing type declerations --- scrapy/pipelines/files.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index a5948525a..f9dfa53e3 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -9,6 +9,7 @@ import logging import mimetypes import os import time +from os import PathLike from collections import defaultdict from contextlib import suppress from ftplib import FTP @@ -36,7 +37,7 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) -def _to_string(path: Union[str, os.PathLike]): +def _to_string(path: Union[str, PathLike]): return str(path) # convert a Path object to string @@ -45,7 +46,7 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir: Union[str, os.PathLike]): + def __init__(self, basedir: Union[str, PathLike]): basedir = _to_string(basedir) if '://' in basedir: basedir = basedir.split('://', 1)[1] @@ -70,7 +71,7 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: + def _get_filesystem_path(self, path: Union[str, PathLike]) -> Path: path_comps = _to_string(path).split('/') return Path(self.basedir, *path_comps) From c883a13006ad98f9f529fe130f7d717ad91f7afb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 25 Jan 2023 17:43:10 +0100 Subject: [PATCH 353/532] Make the _set_xback condition more readable --- scrapy/http/request/__init__.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index a78ba5115..065f2daef 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -106,10 +106,10 @@ class Request(object_ref): self.flags = [] if flags is None else list(flags) def _set_xback(self, name: str, value: Optional[Callable]) -> None: - if ( - value is not None - and (name != "callback" or value is not NO_CALLBACK) - and not callable(value) + if not ( + callable(value) + or value is None + or (name == "callback" and value is NO_CALLBACK) ): raise TypeError(f"{name} must be a callable, got {type(value).__name__}") setattr(self, name, value) From 1f3e42897a6697f799d04a4a4320a7c16cbcd939 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 25 Jan 2023 18:30:29 +0100 Subject: [PATCH 354/532] =?UTF-8?q?=5FNoCallback=20=E2=86=92=20NoCallbackT?= =?UTF-8?q?ype?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- scrapy/http/request/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 924bd1d3e..068a4baa3 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -24,7 +24,7 @@ RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") # https://github.com/python/typing/issues/689#issuecomment-561425237 -class _NoCallback(Enum): +class NoCallbackType(Enum): NO_CALLBACK = 0 @@ -37,7 +37,7 @@ class _NoCallback(Enum): #: :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download #: middlewares handling such requests can treat them differently from requests #: intended for the :meth:`~scrapy.Spider.parse` callback. -NO_CALLBACK: Final = _NoCallback.NO_CALLBACK +NO_CALLBACK: Final = NoCallbackType.NO_CALLBACK class Request(object_ref): @@ -67,7 +67,7 @@ class Request(object_ref): Currently used by :meth:`Request.replace`, :meth:`Request.to_dict` and :func:`~scrapy.utils.request.request_from_dict`. """ - callback: Union[None, _NoCallback, Callable] + callback: Union[None, NoCallbackType, Callable] errback: Optional[Callable] def __init__( From 73f697f1db835be09bf5b717c25f3565d0c054b1 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 23 Jan 2023 01:10:06 +0400 Subject: [PATCH 355/532] Re-enable follow_imports. --- setup.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 1fab6fe22..c711e6e72 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,7 +6,6 @@ universal=1 [mypy] ignore_missing_imports = true -follow_imports = skip # FIXME: remove the following sections once the issues are solved From c0ea7fd4fd2726494adf6a84a9fd6b6d7fcf116f Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 22:14:24 +0400 Subject: [PATCH 356/532] Remove obsolete top-level run code in tests. --- tests/test_dependencies.py | 4 ---- tests/test_utils_iterators.py | 4 ---- tests/test_utils_python.py | 4 ---- 3 files changed, 12 deletions(-) diff --git a/tests/test_dependencies.py b/tests/test_dependencies.py index f9b2d853c..a39ed0694 100644 --- a/tests/test_dependencies.py +++ b/tests/test_dependencies.py @@ -37,7 +37,3 @@ class ScrapyUtilsTest(unittest.TestCase): pinned_twisted_version_string = match[1] self.assertEqual(twisted_version.short(), pinned_twisted_version_string) - - -if __name__ == "__main__": - unittest.main() diff --git a/tests/test_utils_iterators.py b/tests/test_utils_iterators.py index 893582a32..778f7162d 100644 --- a/tests/test_utils_iterators.py +++ b/tests/test_utils_iterators.py @@ -528,7 +528,3 @@ class TestHelper(unittest.TestCase): type(a) is type(b), f"Got {type(a)}, expected {type(b)} for { obj!r}" ) self.assertEqual(a, b) - - -if __name__ == "__main__": - unittest.main() diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 5caa5b8f2..8d2695b0d 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -258,7 +258,3 @@ class UtilsPythonTestCase(unittest.TestCase): without_none_values({"one": 1, "none": None, "three": 3, "four": 4}), {"one": 1, "three": 3, "four": 4}, ) - - -if __name__ == "__main__": - unittest.main() From 2e33fb812b227b8f5ded8be9913467c31929a87b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 22:15:07 +0400 Subject: [PATCH 357/532] Silence improper typing of twisted.internet.reactor in tests. --- scrapy/utils/benchserver.py | 6 +++--- tests/CrawlerRunner/ip_address.py | 6 +++--- tests/mockserver.py | 13 ++++++++----- tests/test_engine.py | 2 +- 4 files changed, 15 insertions(+), 12 deletions(-) diff --git a/scrapy/utils/benchserver.py b/scrapy/utils/benchserver.py index 32bc2e38c..750d3c093 100644 --- a/scrapy/utils/benchserver.py +++ b/scrapy/utils/benchserver.py @@ -37,11 +37,11 @@ if __name__ == "__main__": root = Root() factory = Site(root) - httpPort = reactor.listenTCP(8998, Site(root)) + httpPort = reactor.listenTCP(8998, Site(root)) # type: ignore[attr-defined] def _print_listening(): httpHost = httpPort.getHost() print(f"Bench server at http://{httpHost.host}:{httpHost.port}") - reactor.callWhenRunning(_print_listening) - reactor.run() + reactor.callWhenRunning(_print_listening) # type: ignore[attr-defined] + reactor.run() # type: ignore[attr-defined] diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index 26db16dd6..b9a4485a9 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -41,10 +41,10 @@ if __name__ == "__main__": url = f"http://not.a.real.domain:{port}/echo" servers = [(mock_dns_server.host, mock_dns_server.port)] - reactor.installResolver(createResolver(servers=servers)) + reactor.installResolver(createResolver(servers=servers)) # type: ignore[attr-defined] configure_logging() runner = CrawlerRunner() d = runner.crawl(LocalhostSpider, url=url) - d.addBoth(lambda _: reactor.stop()) - reactor.run() + d.addBoth(lambda _: reactor.stop()) # type: ignore[attr-defined] + reactor.run() # type: ignore[attr-defined] diff --git a/tests/mockserver.py b/tests/mockserver.py index e07ae8797..185897373 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -10,6 +10,7 @@ from urllib.parse import urlencode from OpenSSL import SSL from twisted.internet import defer, reactor, ssl +from twisted.internet.protocol import ServerFactory from twisted.internet.task import deferLater from twisted.names import dns, error from twisted.names.server import DNSServerFactory @@ -369,12 +370,14 @@ if __name__ == "__main__": ) args = parser.parse_args() + factory: ServerFactory + if args.type == "http": root = Root() factory = Site(root) - httpPort = reactor.listenTCP(0, factory) + httpPort = reactor.listenTCP(0, factory) # type: ignore[attr-defined] contextFactory = ssl_context_factory() - httpsPort = reactor.listenSSL(0, factory, contextFactory) + httpsPort = reactor.listenSSL(0, factory, contextFactory) # type: ignore[attr-defined] def print_listening(): httpHost = httpPort.getHost() @@ -388,11 +391,11 @@ if __name__ == "__main__": clients = [MockDNSResolver()] factory = DNSServerFactory(clients=clients) protocol = dns.DNSDatagramProtocol(controller=factory) - listener = reactor.listenUDP(0, protocol) + listener = reactor.listenUDP(0, protocol) # type: ignore[attr-defined] def print_listening(): host = listener.getHost() print(f"{host.host}:{host.port}") - reactor.callWhenRunning(print_listening) - reactor.run() + reactor.callWhenRunning(print_listening) # type: ignore[attr-defined] + reactor.run() # type: ignore[attr-defined] diff --git a/tests/test_engine.py b/tests/test_engine.py index 7ddb420ba..5fb87424b 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -557,4 +557,4 @@ class EngineTest(unittest.TestCase): if __name__ == "__main__": if len(sys.argv) > 1 and sys.argv[1] == "runserver": start_test_site(debug=True) - reactor.run() + reactor.run() # type: ignore[attr-defined] From afd5d8532093c25a6ed4453e3a10b275335c94bd Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 23 Jan 2023 01:12:59 +0400 Subject: [PATCH 358/532] Fix remaining issues in tests. --- tests/test_downloadermiddleware_httpproxy.py | 2 +- tests/test_http2_client_protocol.py | 5 ++++- tests/test_spidermiddleware.py | 1 + 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/tests/test_downloadermiddleware_httpproxy.py b/tests/test_downloadermiddleware_httpproxy.py index ca125ba36..0040f8d23 100644 --- a/tests/test_downloadermiddleware_httpproxy.py +++ b/tests/test_downloadermiddleware_httpproxy.py @@ -14,7 +14,7 @@ spider = Spider("foo") class TestHttpProxyMiddleware(TestCase): - failureException = AssertionError + failureException = AssertionError # type: ignore[assignment] def setUp(self): self._oldenv = os.environ.copy() diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index 88345d2bc..2a928eea0 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -5,6 +5,7 @@ import shutil import string from ipaddress import IPv4Address from pathlib import Path +from typing import Dict from unittest import mock, skipIf from urllib.parse import urlencode @@ -86,6 +87,7 @@ class GetDataHtmlLarge(LeafResource): class PostDataJsonMixin: @staticmethod def make_response(request: TxRequest, extra_data: str): + assert request.content is not None response = { "request-headers": {}, "request-body": json.loads(request.content.read()), @@ -144,7 +146,8 @@ class QueryParams(LeafResource): request.setHeader("Content-Type", "application/json; charset=UTF-8") request.setHeader("Content-Encoding", "UTF-8") - query_params = {} + query_params: Dict[str, str] = {} + assert request.args is not None for k, v in request.args.items(): query_params[str(k, "utf-8")] = str(v[0], "utf-8") diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 760ee43df..ca6348913 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -112,6 +112,7 @@ class BaseAsyncSpiderMiddlewareTestCase(SpiderMiddlewareTestCase): Should work for process_spider_output and, when it's supported, process_start_requests. """ + ITEM_TYPE: type RESULT_COUNT = 3 # to simplify checks, let everything return 3 objects @staticmethod From 232aab53b38553262d60259461adf3fa8054e445 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 22:28:15 +0400 Subject: [PATCH 359/532] Fix most of the new typing issues in utils. --- scrapy/utils/defer.py | 19 +++++++++++-------- scrapy/utils/response.py | 7 ++++--- scrapy/utils/testsite.py | 4 ++-- 3 files changed, 17 insertions(+), 13 deletions(-) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 21cd5e78f..8fee5a7ed 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -10,6 +10,7 @@ from typing import ( AsyncGenerator, AsyncIterable, Callable, + cast, Coroutine, Generator, Iterable, @@ -38,8 +39,8 @@ def defer_fail(_failure: Failure) -> Deferred: """ from twisted.internet import reactor - d = Deferred() - reactor.callLater(0.1, d.errback, _failure) + d: Deferred = Deferred() + reactor.callLater(0.1, d.errback, _failure) # type: ignore[attr-defined] return d @@ -52,8 +53,8 @@ def defer_succeed(result) -> Deferred: """ from twisted.internet import reactor - d = Deferred() - reactor.callLater(0.1, d.callback, result) + d: Deferred = Deferred() + reactor.callLater(0.1, d.callback, result) # type: ignore[attr-defined] return d @@ -182,7 +183,9 @@ class _AsyncCooperatorAdapter(Iterator): def _call_anext(self) -> None: # This starts waiting for the next result from aiterator. # If aiterator is exhausted, _errback will be called. - self.anext_deferred = deferred_from_coro(self.aiterator.__anext__()) + self.anext_deferred = cast( + Deferred, deferred_from_coro(self.aiterator.__anext__()) + ) self.anext_deferred.addCallbacks(self._callback, self._errback) def __next__(self) -> Deferred: @@ -190,7 +193,7 @@ class _AsyncCooperatorAdapter(Iterator): # It also calls __anext__() if needed. if self.finished: raise StopIteration - d = Deferred() + d: Deferred = Deferred() self.waiting_deferreds.append(d) if not self.anext_deferred: self._call_anext() @@ -209,7 +212,7 @@ def parallel_async( def process_chain(callbacks: Iterable[Callable], input, *a, **kw) -> Deferred: """Return a Deferred built by chaining the given callbacks""" - d = Deferred() + d: Deferred = Deferred() for x in callbacks: d.addCallback(x, *a, **kw) d.callback(input) @@ -220,7 +223,7 @@ def process_chain_both( callbacks: Iterable[Callable], errbacks: Iterable[Callable], input, *a, **kw ) -> Deferred: """Return a Deferred built by chaining the given callbacks and errbacks""" - d = Deferred() + d: Deferred = Deferred() for cb, eb in zip(callbacks, errbacks): d.addCallbacks( callback=cb, diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index a91a49170..40a32309a 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -6,7 +6,7 @@ import os import re import tempfile import webbrowser -from typing import Any, Callable, Iterable, Optional, Tuple, Union +from typing import Any, Callable, Iterable, Tuple, Union from weakref import WeakKeyDictionary from twisted.web import http @@ -38,12 +38,13 @@ _metaref_cache: "WeakKeyDictionary[Response, Union[Tuple[None, None], Tuple[floa def get_meta_refresh( response: "scrapy.http.response.text.TextResponse", - ignore_tags: Optional[Iterable[str]] = ("script", "noscript"), + ignore_tags: Iterable[str] = ("script", "noscript"), ) -> Union[Tuple[None, None], Tuple[float, str]]: """Parse the http-equiv refresh parameter from the given response""" if response not in _metaref_cache: text = response.text[0:4096] - _metaref_cache[response] = html.get_meta_refresh( + # a w3lib typing bug here + _metaref_cache[response] = html.get_meta_refresh( # type: ignore[assignment] text, response.url, response.encoding, ignore_tags=ignore_tags ) return _metaref_cache[response] diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py index a47756c4b..119be1dfb 100644 --- a/scrapy/utils/testsite.py +++ b/scrapy/utils/testsite.py @@ -50,6 +50,6 @@ def test_site(): if __name__ == "__main__": from twisted.internet import reactor - port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") + port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") # type: ignore[attr-defined] print(f"http://localhost:{port.getHost().port}/") - reactor.run() + reactor.run() # type: ignore[attr-defined] From 764a9d47bb95e87519a4fc2fe20ddf0c97b11739 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 22:31:12 +0400 Subject: [PATCH 360/532] Fix typing of inlineCallbacks-decorated functions. --- scrapy/core/engine.py | 6 +++--- scrapy/core/spidermw.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index 19696415b..cafa7f6da 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -7,7 +7,7 @@ For more information see docs/topics/architecture.rst import logging import warnings from time import time -from typing import Callable, Iterable, Iterator, Optional, Set, Union +from typing import Any, Callable, Generator, Iterable, Iterator, Optional, Set, Union from twisted.internet.defer import Deferred, inlineCallbacks, succeed from twisted.internet.task import LoopingCall @@ -96,7 +96,7 @@ class ExecutionEngine: return scheduler_cls @inlineCallbacks - def start(self) -> Deferred: + def start(self) -> Generator[Deferred, Any, None]: if self.running: raise RuntimeError("Engine already running") self.start_time = time() @@ -109,7 +109,7 @@ class ExecutionEngine: """Gracefully stop the execution engine""" @inlineCallbacks - def _finish_stopping_engine(_) -> Deferred: + def _finish_stopping_engine(_) -> Generator[Deferred, Any, None]: yield self.signals.send_catch_log_deferred(signal=signals.engine_stopped) self._closewait.callback(None) diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 1aaed5865..0bc8d54d2 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -182,7 +182,7 @@ class SpiderMiddlewareManager(MiddlewareManager): spider: Spider, result: Union[Iterable, AsyncIterable], start_index: int = 0, - ) -> Deferred: + ) -> Generator[Deferred, Any, Union[MutableChain, MutableAsyncChain]]: # items in this iterable do not need to go through the process_spider_output # chain, they went through it already from the process_spider_exception method recovered: Union[MutableChain, MutableAsyncChain] From 5fde6d533903441fe3d986030319de3415a9b956 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 22:54:46 +0400 Subject: [PATCH 361/532] Don't type-check Twisted interfaces. --- setup.cfg | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/setup.cfg b/setup.cfg index c711e6e72..af9c87945 100644 --- a/setup.cfg +++ b/setup.cfg @@ -7,6 +7,10 @@ universal=1 [mypy] ignore_missing_imports = true +# Interface classes are hard to support +[mypy-twisted.internet.interfaces] +follow_imports = skip + # FIXME: remove the following sections once the issues are solved [mypy-scrapy.downloadermiddlewares.httpproxy] From e9094d1f38f2ed2904a6955004a8069054c8e35b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 23:22:18 +0400 Subject: [PATCH 362/532] Address remaining typing issues in scrapy.core. --- scrapy/core/downloader/__init__.py | 2 +- scrapy/core/downloader/handlers/http2.py | 8 +++---- scrapy/core/engine.py | 27 ++++++++++++++++++------ scrapy/core/http2/agent.py | 10 +++++---- scrapy/core/http2/protocol.py | 7 ++++++ scrapy/core/http2/stream.py | 2 +- scrapy/core/scraper.py | 8 ++++--- scrapy/core/spidermw.py | 2 +- 8 files changed, 45 insertions(+), 21 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 3a7de8072..e66156ba1 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -95,7 +95,7 @@ class Downloader: dfd = self.middleware.download(self._enqueue_request, request, spider) return dfd.addBoth(_deactivate) - def needs_backout(self): + def needs_backout(self) -> bool: return len(self.active) >= self.total_concurrency def _get_slot(self, request, spider): diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index 25ac0307b..20cd50c5a 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -28,7 +28,7 @@ class H2DownloadHandler: from twisted.internet import reactor - self._pool = H2ConnectionPool(reactor, settings) + self._pool = H2ConnectionPool(reactor, settings) # type: ignore[arg-type] self._context_factory = load_context_factory_from_settings(settings, crawler) @classmethod @@ -82,7 +82,7 @@ class ScrapyH2Agent: "Tunneling via CONNECT method using HTTP/2.0 is not yet supported" ) return self._ProxyAgent( - reactor=reactor, + reactor=reactor, # type: ignore[arg-type] context_factory=self._context_factory, proxy_uri=URI.fromBytes(to_bytes(proxy, encoding="ascii")), connect_timeout=timeout, @@ -91,7 +91,7 @@ class ScrapyH2Agent: ) return self._Agent( - reactor=reactor, + reactor=reactor, # type: ignore[arg-type] context_factory=self._context_factory, connect_timeout=timeout, bind_address=bind_address, @@ -108,7 +108,7 @@ class ScrapyH2Agent: d = agent.request(request, spider) d.addCallback(self._cb_latency, request, start_time) - timeout_cl = reactor.callLater(timeout, d.cancel) + timeout_cl = reactor.callLater(timeout, d.cancel) # type: ignore[attr-defined] d.addBoth(self._cb_timeout, request, timeout, timeout_cl) return d diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index cafa7f6da..e44675ef0 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -7,13 +7,24 @@ For more information see docs/topics/architecture.rst import logging import warnings from time import time -from typing import Any, Callable, Generator, Iterable, Iterator, Optional, Set, Union +from typing import ( + Any, + Callable, + cast, + Generator, + Iterable, + Iterator, + Optional, + Set, + Union, +) from twisted.internet.defer import Deferred, inlineCallbacks, succeed from twisted.internet.task import LoopingCall from twisted.python.failure import Failure from scrapy import signals +from scrapy.core.downloader import Downloader from scrapy.core.scraper import Scraper from scrapy.exceptions import ( CloseSpider, @@ -80,7 +91,7 @@ class ExecutionEngine: self.paused = False self.scheduler_cls = self._get_scheduler_class(crawler.settings) downloader_cls = load_object(self.settings["DOWNLOADER"]) - self.downloader = downloader_cls(crawler) + self.downloader: Downloader = downloader_cls(crawler) self.scraper = Scraper(crawler) self._spider_closed_callback = spider_closed_callback @@ -102,7 +113,7 @@ class ExecutionEngine: self.start_time = time() yield self.signals.send_catch_log_deferred(signal=signals.engine_started) self.running = True - self._closewait = Deferred() + self._closewait: Deferred = Deferred() yield self._closewait def stop(self) -> Deferred: @@ -177,11 +188,13 @@ class ExecutionEngine: self._spider_idle() def _needs_backout(self) -> bool: + assert self.slot is not None # typing + assert self.scraper.slot is not None # typing return ( not self.running - or self.slot.closing # type: ignore[union-attr] + or bool(self.slot.closing) or self.downloader.needs_backout() - or self.scraper.slot.needs_backout() # type: ignore[union-attr] + or self.scraper.slot.needs_backout() ) def _next_request_from_scheduler(self) -> Optional[Deferred]: @@ -201,7 +214,7 @@ class ExecutionEngine: extra={"spider": self.spider}, ) ) - d.addBoth(lambda _: self.slot.remove_request(request)) + d.addBoth(lambda _: cast(Slot, self.slot).remove_request(request)) d.addErrback( lambda f: logger.info( "Error while removing request from slot", @@ -429,7 +442,7 @@ class ExecutionEngine: dfd.addErrback(log_failure("Scraper close failure")) if hasattr(self.slot.scheduler, "close"): - dfd.addBoth(lambda _: self.slot.scheduler.close(reason)) + dfd.addBoth(lambda _: cast(Slot, self.slot).scheduler.close(reason)) dfd.addErrback(log_failure("Scheduler close failure")) dfd.addBoth( diff --git a/scrapy/core/http2/agent.py b/scrapy/core/http2/agent.py index 119443c80..3ceda9b61 100644 --- a/scrapy/core/http2/agent.py +++ b/scrapy/core/http2/agent.py @@ -35,7 +35,7 @@ class H2ConnectionPool: # Received a request while connecting to remote # Create a deferred which will fire with the H2ClientProtocol # instance - d = Deferred() + d: Deferred = Deferred() self._pending_requests[key].append(d) return d @@ -53,14 +53,14 @@ class H2ConnectionPool: ) -> Deferred: self._pending_requests[key] = deque() - conn_lost_deferred = Deferred() + conn_lost_deferred: Deferred = Deferred() conn_lost_deferred.addCallback(self._remove_connection, key) factory = H2ClientFactory(uri, self.settings, conn_lost_deferred) conn_d = endpoint.connect(factory) conn_d.addCallback(self.put_connection, key) - d = Deferred() + d: Deferred = Deferred() self._pending_requests[key].append(d) return d @@ -83,7 +83,8 @@ class H2ConnectionPool: pending_requests = self._pending_requests.pop(key, None) while pending_requests: d = pending_requests.popleft() - d.errback(errors) + # TODO: this is incorrect, errback takes a single exception + d.errback(errors) # type: ignore[arg-type] def close_connections(self) -> None: """Close all the HTTP/2 connections and remove them from pool @@ -92,6 +93,7 @@ class H2ConnectionPool: Deferred that fires when all connections have been closed """ for conn in self._connections.values(): + assert conn.transport is not None # typing conn.transport.abortConnection() diff --git a/scrapy/core/http2/protocol.py b/scrapy/core/http2/protocol.py index 214deeed0..e44aed43c 100644 --- a/scrapy/core/http2/protocol.py +++ b/scrapy/core/http2/protocol.py @@ -141,6 +141,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): This is used while initiating pending streams to make sure that we initiate stream only during active HTTP/2 Connection """ + assert self.transport is not None # typing return bool(self.transport.connected) and self.metadata["settings_acknowledged"] @property @@ -197,6 +198,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """Write data to the underlying transport connection from the HTTP2 connection instance if any """ + assert self.transport is not None # typing # Reset the idle timeout as connection is still actively sending data self.resetTimeout() @@ -227,6 +229,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): # Initialize the timeout self.setTimeout(self.IDLE_TIMEOUT) + assert self.transport is not None # typing destination = self.transport.getPeer() self.metadata["ip_address"] = ipaddress.ip_address(destination.host) @@ -238,12 +241,14 @@ class H2ClientProtocol(Protocol, TimeoutMixin): """Helper function to lose the connection with the error sent as a reason""" self._conn_lost_errors += errors + assert self.transport is not None # typing self.transport.loseConnection() def handshakeCompleted(self) -> None: """ Close the connection if it's not made via the expected protocol """ + assert self.transport is not None # typing if ( self.transport.negotiatedProtocol is not None and self.transport.negotiatedProtocol != PROTOCOL_NAME @@ -276,6 +281,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): # hyper-h2 does not drop the connection in this scenario, we # need to abort the connection manually. self._conn_lost_errors += [e] + assert self.transport is not None # typing self.transport.abortConnection() return @@ -389,6 +395,7 @@ class H2ClientProtocol(Protocol, TimeoutMixin): self._send_pending_requests() # Update certificate when our HTTP/2 connection is established + assert self.transport is not None # typing self.metadata["certificate"] = Certificate(self.transport.getPeerCertificate()) def stream_ended(self, event: StreamEnded) -> None: diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index 2b5c98e5f..5324a5ca1 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -151,7 +151,7 @@ class Stream: else: self.close(StreamCloseReason.CANCELLED) - self._deferred_response = Deferred(_cancel) + self._deferred_response: Deferred = Deferred(_cancel) def __repr__(self) -> str: return f"Stream(id={self.stream_id!r})" diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 7c2eefbe6..c1488a46c 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -66,7 +66,7 @@ class Slot: def add_response_request( self, result: Union[Response, Failure], request: Request ) -> Deferred: - deferred = Deferred() + deferred: Deferred = Deferred() self.queue.append((result, request, deferred)) if isinstance(result, Response): self.active_size += max(len(result.body), self.MIN_RESPONSE_SIZE) @@ -205,10 +205,12 @@ class Scraper: callback=callback, callbackKeywords=result.request.cb_kwargs ) else: # result is a Failure - result.request = request + # TODO: properly type adding this attribute to a Failure + result.request = request # type: ignore[attr-defined] warn_on_generator_with_return_value(spider, request.errback) dfd = defer_fail(result) - dfd.addErrback(request.errback) + if request.errback: + dfd.addErrback(request.errback) return dfd.addCallback(iterate_spider_output) def handle_spider_error( diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 0bc8d54d2..31e815b19 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -157,7 +157,7 @@ class SpiderMiddlewareManager(MiddlewareManager): # simplified when downgrading is removed. if dfd.called: # the result is available immediately if _process_spider_output didn't do downgrading - return dfd.result + return cast(MutableChain, dfd.result) # we forbid waiting here because otherwise we would need to return a deferred from # _process_spider_exception too, which complicates the architecture msg = f"Async iterable returned from {method.__qualname__} cannot be downgraded" From a4edff31b91c4647a02bb392020110856b669fd9 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 23:30:21 +0400 Subject: [PATCH 363/532] Replace lxml-stubs with types-lxml. --- tox.ini | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tox.ini b/tox.ini index eaf29173a..f05ebc45a 100644 --- a/tox.ini +++ b/tox.ini @@ -37,9 +37,9 @@ install_command = [testenv:typing] basepython = python3 deps = - lxml-stubs==0.2.0 mypy==0.991 types-attrs==19.1.0 + types-lxml==2022.11.8 types-pyOpenSSL==21.0.0 types-setuptools==57.0.0 commands = @@ -201,4 +201,4 @@ deps = black==22.12.0 commands = black {posargs:--check .} - \ No newline at end of file + From 69bb9a78594ed864291d45d36108cc0ad960f048 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 25 Jan 2023 23:52:46 +0400 Subject: [PATCH 364/532] Install types-Pillow and types-Pygments. --- tox.ini | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tox.ini b/tox.ini index f05ebc45a..7048391ac 100644 --- a/tox.ini +++ b/tox.ini @@ -40,6 +40,8 @@ deps = mypy==0.991 types-attrs==19.1.0 types-lxml==2022.11.8 + types-Pillow==9.4.0.5 + types-Pygments==2.14.0.1 types-pyOpenSSL==21.0.0 types-setuptools==57.0.0 commands = From 6d0f9df8c1ad5ad4c4bab4be32cdbe8aed325cd4 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Wed, 25 Jan 2023 14:22:42 -0600 Subject: [PATCH 365/532] added isort.cfg --- .isort.cfg | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 .isort.cfg diff --git a/.isort.cfg b/.isort.cfg new file mode 100644 index 000000000..a29184f0a --- /dev/null +++ b/.isort.cfg @@ -0,0 +1,3 @@ +[settings] +profile = black +multi_line_output = 3 From a5c1ef82762c6c0910abea00c0a6249c40005e44 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Wed, 25 Jan 2023 14:25:15 -0600 Subject: [PATCH 366/532] sort imports with isort --- conftest.py | 1 - docs/_ext/scrapydocs.py | 3 ++- extras/qps-bench-server.py | 7 ++++--- extras/qpsclient.py | 2 +- scrapy/__init__.py | 8 ++++---- scrapy/cmdline.py | 9 +++++---- scrapy/commands/__init__.py | 6 +++--- scrapy/commands/bench.py | 2 +- scrapy/commands/check.py | 5 +++-- scrapy/commands/edit.py | 2 +- scrapy/commands/fetch.py | 5 +++-- scrapy/commands/genspider.py | 5 ++--- scrapy/commands/parse.py | 6 +++--- scrapy/commands/runspider.py | 6 +++--- scrapy/commands/shell.py | 2 +- scrapy/commands/startproject.py | 7 +++---- scrapy/commands/view.py | 1 + scrapy/contracts/default.py | 2 +- scrapy/core/downloader/__init__.py | 12 +++++------ scrapy/core/downloader/contextfactory.py | 8 ++++---- scrapy/core/downloader/handlers/__init__.py | 1 - scrapy/core/downloader/handlers/http11.py | 6 +++--- scrapy/core/downloader/handlers/http2.py | 1 - scrapy/core/downloader/middleware.py | 2 +- scrapy/core/downloader/tls.py | 4 ++-- scrapy/core/downloader/webclient.py | 6 +++--- scrapy/core/engine.py | 11 +++------- scrapy/core/http2/agent.py | 2 +- scrapy/core/http2/protocol.py | 5 ++--- scrapy/core/http2/stream.py | 4 ++-- scrapy/core/scheduler.py | 1 - scrapy/core/scraper.py | 6 ++---- scrapy/core/spidermw.py | 5 ++--- scrapy/crawler.py | 6 +++--- scrapy/downloadermiddlewares/ajaxcrawl.py | 3 +-- scrapy/downloadermiddlewares/decompression.py | 1 - scrapy/downloadermiddlewares/httpcache.py | 1 - scrapy/downloadermiddlewares/httpproxy.py | 2 +- scrapy/downloadermiddlewares/redirect.py | 2 +- scrapy/downloadermiddlewares/retry.py | 3 +-- scrapy/downloadermiddlewares/robotstxt.py | 3 ++- scrapy/dupefilters.py | 3 +-- scrapy/exporters.py | 3 +-- scrapy/extensions/debug.py | 6 +++--- scrapy/extensions/feedexport.py | 5 ++--- scrapy/extensions/httpcache.py | 2 +- scrapy/extensions/logstats.py | 2 +- scrapy/extensions/memusage.py | 6 +++--- scrapy/extensions/statsmailer.py | 2 +- scrapy/extensions/telnet.py | 12 +++++------ scrapy/extensions/throttle.py | 2 +- scrapy/http/__init__.py | 6 ++---- scrapy/http/cookies.py | 4 ++-- scrapy/http/headers.py | 1 + scrapy/http/request/__init__.py | 1 - scrapy/http/request/form.py | 5 ++--- scrapy/http/request/rpc.py | 1 - scrapy/http/response/text.py | 2 +- scrapy/loader/processors.py | 1 - scrapy/logformatter.py | 2 +- scrapy/mail.py | 5 ++--- scrapy/middleware.py | 2 +- scrapy/pipelines/files.py | 1 - scrapy/pipelines/media.py | 4 ++-- scrapy/pqueues.py | 1 - scrapy/resolver.py | 3 +-- scrapy/responsetypes.py | 2 +- scrapy/robotstxt.py | 2 +- scrapy/selector/unified.py | 6 +++--- scrapy/settings/__init__.py | 3 +-- scrapy/shell.py | 7 ++----- scrapy/signalmanager.py | 1 + scrapy/spidermiddlewares/offsite.py | 2 +- scrapy/spidermiddlewares/referer.py | 1 - scrapy/spidermiddlewares/urllength.py | 2 +- scrapy/spiders/__init__.py | 2 +- scrapy/spiders/crawl.py | 2 +- scrapy/spiders/feed.py | 8 ++++---- scrapy/spiders/sitemap.py | 7 +++---- scrapy/statscollectors.py | 2 +- scrapy/utils/benchserver.py | 2 +- scrapy/utils/conf.py | 1 - scrapy/utils/curl.py | 2 +- scrapy/utils/defer.py | 2 +- scrapy/utils/deprecate.py | 3 ++- scrapy/utils/display.py | 1 + scrapy/utils/ftp.py | 2 +- scrapy/utils/httpobj.py | 3 +-- scrapy/utils/iterators.py | 3 +-- scrapy/utils/log.py | 1 - scrapy/utils/misc.py | 9 ++++----- scrapy/utils/ossignal.py | 1 - scrapy/utils/project.py | 6 ++---- scrapy/utils/reqser.py | 1 - scrapy/utils/request.py | 1 - scrapy/utils/response.py | 5 ++--- scrapy/utils/serialize.py | 4 ++-- scrapy/utils/signal.py | 6 ++---- scrapy/utils/spider.py | 1 - scrapy/utils/ssl.py | 2 +- scrapy/utils/template.py | 2 +- scrapy/utils/test.py | 4 ++-- scrapy/utils/testproc.py | 2 +- scrapy/utils/testsite.py | 2 +- scrapy/utils/trackref.py | 1 - scrapy/utils/url.py | 1 + setup.py | 5 +++-- .../asyncio_enabled_reactor_same_loop.py | 3 +-- ..._select_subclass_twisted_reactor_select.py | 1 + tests/CrawlerRunner/ip_address.py | 8 +++++--- tests/keys/__init__.py | 2 +- tests/mockserver.py | 4 ++-- tests/test_closespider.py | 3 ++- tests/test_cmdline/__init__.py | 2 +- .../__init__.py | 2 +- tests/test_command_fetch.py | 4 ++-- tests/test_command_parse.py | 7 ++++--- tests/test_command_shell.py | 7 +++---- tests/test_command_version.py | 3 ++- tests/test_commands.py | 7 +++---- tests/test_contracts.py | 14 ++++++------- tests/test_crawl.py | 2 +- tests/test_crawler.py | 17 +++++++--------- tests/test_downloader_handlers.py | 8 +++++--- tests/test_downloader_handlers_http2.py | 4 ++-- tests/test_downloadermiddleware.py | 8 ++++---- ...test_downloadermiddleware_ajaxcrawlable.py | 3 +-- tests/test_downloadermiddleware_cookies.py | 4 ++-- ...test_downloadermiddleware_decompression.py | 3 ++- ...est_downloadermiddleware_defaultheaders.py | 2 +- ...st_downloadermiddleware_downloadtimeout.py | 2 +- tests/test_downloadermiddleware_httpauth.py | 2 +- tests/test_downloadermiddleware_httpcache.py | 18 ++++++++--------- ...st_downloadermiddleware_httpcompression.py | 9 +++++---- tests/test_downloadermiddleware_redirect.py | 6 +++--- tests/test_downloadermiddleware_retry.py | 2 +- tests/test_downloadermiddleware_robotstxt.py | 11 +++++----- tests/test_downloadermiddleware_useragent.py | 4 ++-- tests/test_dupefilters.py | 7 ++++--- tests/test_engine.py | 7 +++---- tests/test_engine_stop_download_bytes.py | 5 ++--- tests/test_engine_stop_download_headers.py | 5 ++--- tests/test_exporters.py | 20 +++++++++---------- tests/test_extension_telnet.py | 2 +- tests/test_feedexport.py | 11 +++------- tests/test_http2_client_protocol.py | 13 ++++++------ tests/test_http_cookies.py | 2 +- tests/test_http_headers.py | 2 +- tests/test_http_request.py | 12 +++++------ tests/test_loader.py | 4 ++-- tests/test_loader_deprecated.py | 2 +- tests/test_logformatter.py | 4 ++-- tests/test_mail.py | 7 ++++--- tests/test_middleware.py | 2 +- tests/test_pipeline_crawl.py | 2 +- tests/test_pipeline_files.py | 2 +- tests/test_pipeline_images.py | 1 - tests/test_pipeline_media.py | 11 +++++----- tests/test_pipelines.py | 5 ++--- tests/test_pqueues.py | 3 +-- tests/test_proxy_connect.py | 4 ++-- tests/test_request_attribute_binding.py | 5 +---- tests/test_request_cb_kwargs.py | 2 +- tests/test_request_dict.py | 8 +++----- tests/test_request_left.py | 1 + tests/test_responsetypes.py | 4 ++-- tests/test_scheduler.py | 5 ++--- tests/test_selector.py | 2 +- tests/test_settings/__init__.py | 3 ++- tests/test_signals.py | 3 +-- tests/test_spider.py | 10 +++++----- tests/test_spiderloader/__init__.py | 15 +++++++------- tests/test_spidermiddleware.py | 8 ++++---- tests/test_spidermiddleware_depth.py | 2 +- tests/test_spidermiddleware_httperror.py | 10 +++++----- tests/test_spidermiddleware_offsite.py | 6 +++--- tests/test_spidermiddleware_referer.py | 20 +++++++++---------- tests/test_spidermiddleware_urllength.py | 4 ++-- tests/test_spiderstate.py | 5 +++-- tests/test_squeues.py | 9 +++++---- tests/test_squeues_request.py | 16 +++++++-------- tests/test_stats.py | 4 ++-- tests/test_toplevel.py | 4 ++-- tests/test_urlparse_monkeypatches.py | 2 +- tests/test_utils_asyncio.py | 2 +- tests/test_utils_conf.py | 2 +- tests/test_utils_datatypes.py | 1 - tests/test_utils_defer.py | 6 +++--- tests/test_utils_deprecate.py | 2 +- tests/test_utils_display.py | 3 +-- tests/test_utils_gz.py | 3 +-- tests/test_utils_iterators.py | 4 ++-- tests/test_utils_log.py | 8 ++++---- tests/test_utils_misc/__init__.py | 5 ++--- tests/test_utils_project.py | 8 ++++---- tests/test_utils_python.py | 9 ++++----- tests/test_utils_response.py | 9 ++++----- tests/test_utils_serialize.py | 2 +- tests/test_utils_spider.py | 2 +- tests/test_utils_template.py | 4 ++-- tests/test_utils_url.py | 4 ++-- tests/test_webclient.py | 9 +++++---- 202 files changed, 428 insertions(+), 484 deletions(-) diff --git a/conftest.py b/conftest.py index 585356a3e..e1d4b1213 100644 --- a/conftest.py +++ b/conftest.py @@ -4,7 +4,6 @@ import pytest from twisted.web.http import H2_ENABLED from scrapy.utils.reactor import install_reactor - from tests.keys import generate_keys diff --git a/docs/_ext/scrapydocs.py b/docs/_ext/scrapydocs.py index 1419792fc..c23a89089 100644 --- a/docs/_ext/scrapydocs.py +++ b/docs/_ext/scrapydocs.py @@ -1,7 +1,8 @@ from operator import itemgetter -from docutils.parsers.rst.roles import set_classes + from docutils import nodes from docutils.parsers.rst import Directive +from docutils.parsers.rst.roles import set_classes from sphinx.util.nodes import make_refnode diff --git a/extras/qps-bench-server.py b/extras/qps-bench-server.py index 622164c75..70c9003e5 100755 --- a/extras/qps-bench-server.py +++ b/extras/qps-bench-server.py @@ -1,9 +1,10 @@ #!/usr/bin/env python -from time import time from collections import deque -from twisted.web.server import Site, NOT_DONE_YET -from twisted.web.resource import Resource +from time import time + from twisted.internet import reactor +from twisted.web.resource import Resource +from twisted.web.server import NOT_DONE_YET, Site class Root(Resource): diff --git a/extras/qpsclient.py b/extras/qpsclient.py index bb8527af2..acad71e07 100644 --- a/extras/qpsclient.py +++ b/extras/qpsclient.py @@ -8,8 +8,8 @@ usage: """ -from scrapy.spiders import Spider from scrapy.http import Request +from scrapy.spiders import Spider class QPSSpider(Spider): diff --git a/scrapy/__init__.py b/scrapy/__init__.py index f0d85198d..44df3d54b 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -8,12 +8,12 @@ import warnings from twisted import version as _txv +from scrapy.http import FormRequest, Request +from scrapy.item import Field, Item +from scrapy.selector import Selector + # Declare top-level shortcuts from scrapy.spiders import Spider -from scrapy.http import Request, FormRequest -from scrapy.selector import Selector -from scrapy.item import Item, Field - __all__ = [ "__version__", diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index ffb40e1c5..730e55350 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -1,16 +1,17 @@ -import sys -import os import argparse import cProfile import inspect +import os +import sys + import pkg_resources import scrapy +from scrapy.commands import BaseRunSpiderCommand, ScrapyCommand, ScrapyHelpFormatter from scrapy.crawler import CrawlerProcess -from scrapy.commands import ScrapyCommand, ScrapyHelpFormatter, BaseRunSpiderCommand from scrapy.exceptions import UsageError from scrapy.utils.misc import walk_modules -from scrapy.utils.project import inside_project, get_project_settings +from scrapy.utils.project import get_project_settings, inside_project from scrapy.utils.python import garbage_collect diff --git a/scrapy/commands/__init__.py b/scrapy/commands/__init__.py index f37d61321..de68c43a5 100644 --- a/scrapy/commands/__init__.py +++ b/scrapy/commands/__init__.py @@ -1,16 +1,16 @@ """ Base class for Scrapy commands """ -import os import argparse +import os from pathlib import Path from typing import Any, Dict, Optional from twisted.python import failure -from scrapy.crawler import CrawlerProcess -from scrapy.utils.conf import arglist_to_dict, feed_process_params_from_cli +from scrapy.crawler import CrawlerProcess from scrapy.exceptions import UsageError +from scrapy.utils.conf import arglist_to_dict, feed_process_params_from_cli class ScrapyCommand: diff --git a/scrapy/commands/bench.py b/scrapy/commands/bench.py index 2e2a21f00..911e5afe6 100644 --- a/scrapy/commands/bench.py +++ b/scrapy/commands/bench.py @@ -1,6 +1,6 @@ +import subprocess import sys import time -import subprocess from urllib.parse import urlencode import scrapy diff --git a/scrapy/commands/check.py b/scrapy/commands/check.py index efc7a46ed..de54ca4d3 100644 --- a/scrapy/commands/check.py +++ b/scrapy/commands/check.py @@ -1,11 +1,12 @@ import time from collections import defaultdict -from unittest import TextTestRunner, TextTestResult as _TextTestResult +from unittest import TextTestResult as _TextTestResult +from unittest import TextTestRunner from scrapy.commands import ScrapyCommand from scrapy.contracts import ContractsManager -from scrapy.utils.misc import load_object, set_environ from scrapy.utils.conf import build_component_list +from scrapy.utils.misc import load_object, set_environ class TextTestResult(_TextTestResult): diff --git a/scrapy/commands/edit.py b/scrapy/commands/edit.py index 537b2013c..ca591011c 100644 --- a/scrapy/commands/edit.py +++ b/scrapy/commands/edit.py @@ -1,5 +1,5 @@ -import sys import os +import sys from scrapy.commands import ScrapyCommand from scrapy.exceptions import UsageError diff --git a/scrapy/commands/fetch.py b/scrapy/commands/fetch.py index 918db55c6..a9076c5b1 100644 --- a/scrapy/commands/fetch.py +++ b/scrapy/commands/fetch.py @@ -1,11 +1,12 @@ import sys + from w3lib.url import is_url from scrapy.commands import ScrapyCommand -from scrapy.http import Request from scrapy.exceptions import UsageError +from scrapy.http import Request from scrapy.utils.datatypes import SequenceExclude -from scrapy.utils.spider import spidercls_for_request, DefaultSpider +from scrapy.utils.spider import DefaultSpider, spidercls_for_request class Command(ScrapyCommand): diff --git a/scrapy/commands/genspider.py b/scrapy/commands/genspider.py index e880e44a9..90dd0874e 100644 --- a/scrapy/commands/genspider.py +++ b/scrapy/commands/genspider.py @@ -1,16 +1,15 @@ import os import shutil import string - -from pathlib import Path from importlib import import_module +from pathlib import Path from typing import Optional, cast from urllib.parse import urlparse import scrapy from scrapy.commands import ScrapyCommand -from scrapy.utils.template import render_templatefile, string_camelcase from scrapy.exceptions import UsageError +from scrapy.utils.template import render_templatefile, string_camelcase def sanitize_module_name(module_name): diff --git a/scrapy/commands/parse.py b/scrapy/commands/parse.py index ac97b6193..9c3fc86d4 100644 --- a/scrapy/commands/parse.py +++ b/scrapy/commands/parse.py @@ -2,15 +2,15 @@ import json import logging from typing import Dict -from itemadapter import is_item, ItemAdapter +from itemadapter import ItemAdapter, is_item +from twisted.internet.defer import maybeDeferred from w3lib.url import is_url -from twisted.internet.defer import maybeDeferred from scrapy.commands import BaseRunSpiderCommand +from scrapy.exceptions import UsageError from scrapy.http import Request from scrapy.utils import display from scrapy.utils.spider import iterate_spider_output, spidercls_for_request -from scrapy.exceptions import UsageError logger = logging.getLogger(__name__) diff --git a/scrapy/commands/runspider.py b/scrapy/commands/runspider.py index 9751c6c30..8a75f9270 100644 --- a/scrapy/commands/runspider.py +++ b/scrapy/commands/runspider.py @@ -1,13 +1,13 @@ import sys +from importlib import import_module from os import PathLike from pathlib import Path -from importlib import import_module from types import ModuleType from typing import Union -from scrapy.utils.spider import iter_spider_classes -from scrapy.exceptions import UsageError from scrapy.commands import BaseRunSpiderCommand +from scrapy.exceptions import UsageError +from scrapy.utils.spider import iter_spider_classes def _import_file(filepath: Union[str, PathLike]) -> ModuleType: diff --git a/scrapy/commands/shell.py b/scrapy/commands/shell.py index 1fad8f328..05c76d1eb 100644 --- a/scrapy/commands/shell.py +++ b/scrapy/commands/shell.py @@ -8,7 +8,7 @@ from threading import Thread from scrapy.commands import ScrapyCommand from scrapy.http import Request from scrapy.shell import Shell -from scrapy.utils.spider import spidercls_for_request, DefaultSpider +from scrapy.utils.spider import DefaultSpider, spidercls_for_request from scrapy.utils.url import guess_scheme diff --git a/scrapy/commands/startproject.py b/scrapy/commands/startproject.py index 3ed1f5dbc..88bd5bb33 100644 --- a/scrapy/commands/startproject.py +++ b/scrapy/commands/startproject.py @@ -1,16 +1,15 @@ -import re import os +import re import string from importlib.util import find_spec from pathlib import Path -from shutil import ignore_patterns, move, copy2, copystat +from shutil import copy2, copystat, ignore_patterns, move from stat import S_IWUSR as OWNER_WRITE_PERMISSION import scrapy from scrapy.commands import ScrapyCommand -from scrapy.utils.template import render_templatefile, string_camelcase from scrapy.exceptions import UsageError - +from scrapy.utils.template import render_templatefile, string_camelcase TEMPLATES_TO_RENDER = ( ("scrapy.cfg",), diff --git a/scrapy/commands/view.py b/scrapy/commands/view.py index a81af7565..ebdfa10a8 100644 --- a/scrapy/commands/view.py +++ b/scrapy/commands/view.py @@ -1,4 +1,5 @@ import argparse + from scrapy.commands import fetch from scrapy.utils.response import open_in_browser diff --git a/scrapy/contracts/default.py b/scrapy/contracts/default.py index e41d83960..eac702cef 100644 --- a/scrapy/contracts/default.py +++ b/scrapy/contracts/default.py @@ -1,6 +1,6 @@ import json -from itemadapter import is_item, ItemAdapter +from itemadapter import ItemAdapter, is_item from scrapy.contracts import Contract from scrapy.exceptions import ContractFail diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 3a7de8072..7e0b62bb0 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -1,16 +1,16 @@ import random -from time import time -from datetime import datetime from collections import deque +from datetime import datetime +from time import time from twisted.internet import defer, task +from scrapy import signals +from scrapy.core.downloader.handlers import DownloadHandlers +from scrapy.core.downloader.middleware import DownloaderMiddlewareManager +from scrapy.resolver import dnscache from scrapy.utils.defer import mustbe_deferred from scrapy.utils.httpobj import urlparse_cached -from scrapy.resolver import dnscache -from scrapy import signals -from scrapy.core.downloader.middleware import DownloaderMiddlewareManager -from scrapy.core.downloader.handlers import DownloadHandlers class Slot: diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index 1513638df..53ae78918 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -3,10 +3,10 @@ import warnings from OpenSSL import SSL from twisted.internet._sslverify import _setAcceptableProtocols from twisted.internet.ssl import ( - optionsForClientTLS, - CertificateOptions, - platformTrust, AcceptableCiphers, + CertificateOptions, + optionsForClientTLS, + platformTrust, ) from twisted.web.client import BrowserLikePolicyForHTTPS from twisted.web.iweb import IPolicyForHTTPS @@ -15,8 +15,8 @@ from zope.interface.verify import verifyObject from scrapy.core.downloader.tls import ( DEFAULT_CIPHERS, - openssl_methods, ScrapyClientTLSOptions, + openssl_methods, ) from scrapy.utils.misc import create_instance, load_object diff --git a/scrapy/core/downloader/handlers/__init__.py b/scrapy/core/downloader/handlers/__init__.py index bb2141d28..39155efe9 100644 --- a/scrapy/core/downloader/handlers/__init__.py +++ b/scrapy/core/downloader/handlers/__init__.py @@ -10,7 +10,6 @@ from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import create_instance, load_object from scrapy.utils.python import without_none_values - logger = logging.getLogger(__name__) diff --git a/scrapy/core/downloader/handlers/http11.py b/scrapy/core/downloader/handlers/http11.py index 201c84ff8..8de5459e9 100644 --- a/scrapy/core/downloader/handlers/http11.py +++ b/scrapy/core/downloader/handlers/http11.py @@ -13,15 +13,15 @@ from twisted.internet.endpoints import TCP4ClientEndpoint from twisted.internet.error import TimeoutError from twisted.python.failure import Failure from twisted.web.client import ( + URI, Agent, HTTPConnectionPool, ResponseDone, ResponseFailed, - URI, ) -from twisted.web.http import _DataLoss, PotentialDataLoss +from twisted.web.http import PotentialDataLoss, _DataLoss from twisted.web.http_headers import Headers as TxHeaders -from twisted.web.iweb import IBodyProducer, UNKNOWN_LENGTH +from twisted.web.iweb import UNKNOWN_LENGTH, IBodyProducer from zope.interface import implementer from scrapy import signals diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index 25ac0307b..b2579362c 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -16,7 +16,6 @@ from scrapy.settings import Settings from scrapy.spiders import Spider from scrapy.utils.python import to_bytes - H2DownloadHandlerOrSubclass = TypeVar( "H2DownloadHandlerOrSubclass", bound="H2DownloadHandler" ) diff --git a/scrapy/core/downloader/middleware.py b/scrapy/core/downloader/middleware.py index 3410b4255..5a94e66a6 100644 --- a/scrapy/core/downloader/middleware.py +++ b/scrapy/core/downloader/middleware.py @@ -12,8 +12,8 @@ from scrapy import Spider from scrapy.exceptions import _InvalidOutput from scrapy.http import Request, Response from scrapy.middleware import MiddlewareManager -from scrapy.utils.defer import mustbe_deferred, deferred_from_coro from scrapy.utils.conf import build_component_list +from scrapy.utils.defer import deferred_from_coro, mustbe_deferred class DownloaderMiddlewareManager(MiddlewareManager): diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index d1c511db0..025575fe1 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -4,12 +4,12 @@ from OpenSSL import SSL from service_identity.exceptions import CertificateError from twisted.internet._sslverify import ( ClientTLSOptions, - verifyHostname, VerificationError, + verifyHostname, ) from twisted.internet.ssl import AcceptableCiphers -from scrapy.utils.ssl import x509name_to_string, get_temp_key_info +from scrapy.utils.ssl import get_temp_key_info, x509name_to_string logger = logging.getLogger(__name__) diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index 6421391d0..4558402b2 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -1,15 +1,15 @@ import re from time import time -from urllib.parse import urlparse, urlunparse, urldefrag -from twisted.web.http import HTTPClient +from urllib.parse import urldefrag, urlparse, urlunparse from twisted.internet import defer from twisted.internet.protocol import ClientFactory +from twisted.web.http import HTTPClient from scrapy.http import Headers +from scrapy.responsetypes import responsetypes from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_bytes, to_unicode -from scrapy.responsetypes import responsetypes def _parsed_url_args(parsed): diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index 19696415b..1efbdb271 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -15,19 +15,14 @@ from twisted.python.failure import Failure from scrapy import signals from scrapy.core.scraper import Scraper -from scrapy.exceptions import ( - CloseSpider, - DontCloseSpider, - ScrapyDeprecationWarning, -) -from scrapy.http import Response, Request +from scrapy.exceptions import CloseSpider, DontCloseSpider, ScrapyDeprecationWarning +from scrapy.http import Request, Response from scrapy.settings import BaseSettings from scrapy.spiders import Spider -from scrapy.utils.log import logformatter_adapter, failure_to_exc_info +from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import create_instance, load_object from scrapy.utils.reactor import CallLaterOnce - logger = logging.getLogger(__name__) diff --git a/scrapy/core/http2/agent.py b/scrapy/core/http2/agent.py index 119443c80..1c43d241c 100644 --- a/scrapy/core/http2/agent.py +++ b/scrapy/core/http2/agent.py @@ -10,7 +10,7 @@ from twisted.web.client import URI, BrowserLikePolicyForHTTPS, _StandardEndpoint from twisted.web.error import SchemeNotSupported from scrapy.core.downloader.contextfactory import AcceptableProtocolsContextFactory -from scrapy.core.http2.protocol import H2ClientProtocol, H2ClientFactory +from scrapy.core.http2.protocol import H2ClientFactory, H2ClientProtocol from scrapy.http.request import Request from scrapy.settings import Settings from scrapy.spiders import Spider diff --git a/scrapy/core/http2/protocol.py b/scrapy/core/http2/protocol.py index 214deeed0..0bf69e513 100644 --- a/scrapy/core/http2/protocol.py +++ b/scrapy/core/http2/protocol.py @@ -9,9 +9,9 @@ from h2.config import H2Configuration from h2.connection import H2Connection from h2.errors import ErrorCodes from h2.events import ( - Event, ConnectionTerminated, DataReceived, + Event, ResponseReceived, SettingsAcknowledged, StreamEnded, @@ -23,7 +23,7 @@ from h2.exceptions import FrameTooLargeError, H2Error from twisted.internet.defer import Deferred from twisted.internet.error import TimeoutError from twisted.internet.interfaces import IHandshakeListener, IProtocolNegotiationFactory -from twisted.internet.protocol import connectionDone, Factory, Protocol +from twisted.internet.protocol import Factory, Protocol, connectionDone from twisted.internet.ssl import Certificate from twisted.protocols.policies import TimeoutMixin from twisted.python.failure import Failure @@ -35,7 +35,6 @@ from scrapy.http import Request from scrapy.settings import Settings from scrapy.spiders import Spider - logger = logging.getLogger(__name__) diff --git a/scrapy/core/http2/stream.py b/scrapy/core/http2/stream.py index 2b5c98e5f..87beb41e5 100644 --- a/scrapy/core/http2/stream.py +++ b/scrapy/core/http2/stream.py @@ -1,13 +1,13 @@ import logging from enum import Enum from io import BytesIO +from typing import TYPE_CHECKING, Dict, List, Optional, Tuple from urllib.parse import urlparse -from typing import Dict, List, Optional, Tuple, TYPE_CHECKING from h2.errors import ErrorCodes from h2.exceptions import H2Error, ProtocolError, StreamClosedError from hpack import HeaderTuple -from twisted.internet.defer import Deferred, CancelledError +from twisted.internet.defer import CancelledError, Deferred from twisted.internet.error import ConnectionClosed from twisted.python.failure import Failure from twisted.web.client import ResponseFailed diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 1e6fc69e1..3c46e3a5f 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -12,7 +12,6 @@ from scrapy.spiders import Spider from scrapy.utils.job import job_dir from scrapy.utils.misc import create_instance, load_object - logger = logging.getLogger(__name__) diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 7c2eefbe6..1a09f22f7 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -5,6 +5,7 @@ from __future__ import annotations import logging from collections import deque from typing import ( + TYPE_CHECKING, Any, AsyncGenerator, AsyncIterable, @@ -13,7 +14,6 @@ from typing import ( Iterable, Optional, Set, - TYPE_CHECKING, Tuple, Union, ) @@ -22,7 +22,7 @@ from itemadapter import is_item from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure -from scrapy import signals, Spider +from scrapy import Spider, signals from scrapy.core.spidermw import SpiderMiddlewareManager from scrapy.exceptions import CloseSpider, DropItem, IgnoreRequest from scrapy.http import Request, Response @@ -34,12 +34,10 @@ from scrapy.utils.defer import ( parallel, parallel_async, ) - from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import load_object, warn_on_generator_with_return_value from scrapy.utils.spider import iterate_spider_output - if TYPE_CHECKING: from scrapy.crawler import Crawler diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index 1aaed5865..ba9c37e38 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -28,14 +28,13 @@ from scrapy.middleware import MiddlewareManager from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.conf import build_component_list from scrapy.utils.defer import ( - mustbe_deferred, - deferred_from_coro, deferred_f_from_coro_f, + deferred_from_coro, maybe_deferred_to_future, + mustbe_deferred, ) from scrapy.utils.python import MutableAsyncChain, MutableChain - logger = logging.getLogger(__name__) diff --git a/scrapy/crawler.py b/scrapy/crawler.py index f58cd73d3..397817d6f 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -17,20 +17,20 @@ except ImportError: from zope.interface.verify import verifyClass -from scrapy import signals, Spider +from scrapy import Spider, signals from scrapy.core.engine import ExecutionEngine from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.extension import ExtensionManager from scrapy.interfaces import ISpiderLoader -from scrapy.settings import overridden_settings, Settings +from scrapy.settings import Settings, overridden_settings from scrapy.signalmanager import SignalManager from scrapy.utils.log import ( + LogCounterHandler, configure_logging, get_scrapy_root_handler, install_scrapy_root_handler, log_reactor_info, log_scrapy_info, - LogCounterHandler, ) from scrapy.utils.misc import create_instance, load_object from scrapy.utils.ossignal import install_shutdown_handlers, signal_names diff --git a/scrapy/downloadermiddlewares/ajaxcrawl.py b/scrapy/downloadermiddlewares/ajaxcrawl.py index 86ff7b9fe..137ed5b18 100644 --- a/scrapy/downloadermiddlewares/ajaxcrawl.py +++ b/scrapy/downloadermiddlewares/ajaxcrawl.py @@ -1,12 +1,11 @@ -import re import logging +import re from w3lib import html from scrapy.exceptions import NotConfigured from scrapy.http import HtmlResponse - logger = logging.getLogger(__name__) diff --git a/scrapy/downloadermiddlewares/decompression.py b/scrapy/downloadermiddlewares/decompression.py index 410015281..368ca60f7 100644 --- a/scrapy/downloadermiddlewares/decompression.py +++ b/scrapy/downloadermiddlewares/decompression.py @@ -14,7 +14,6 @@ from warnings import warn from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.responsetypes import responsetypes - warn( "scrapy.downloadermiddlewares.decompression is deprecated", ScrapyDeprecationWarning, diff --git a/scrapy/downloadermiddlewares/httpcache.py b/scrapy/downloadermiddlewares/httpcache.py index eb2754f1d..74c55f6e2 100644 --- a/scrapy/downloadermiddlewares/httpcache.py +++ b/scrapy/downloadermiddlewares/httpcache.py @@ -23,7 +23,6 @@ from scrapy.spiders import Spider from scrapy.statscollectors import StatsCollector from scrapy.utils.misc import load_object - HttpCacheMiddlewareTV = TypeVar("HttpCacheMiddlewareTV", bound="HttpCacheMiddleware") diff --git a/scrapy/downloadermiddlewares/httpproxy.py b/scrapy/downloadermiddlewares/httpproxy.py index 489867918..f74d84b69 100644 --- a/scrapy/downloadermiddlewares/httpproxy.py +++ b/scrapy/downloadermiddlewares/httpproxy.py @@ -1,6 +1,6 @@ import base64 from urllib.parse import unquote, urlunparse -from urllib.request import getproxies, proxy_bypass, _parse_proxy +from urllib.request import _parse_proxy, getproxies, proxy_bypass from scrapy.exceptions import NotConfigured from scrapy.utils.httpobj import urlparse_cached diff --git a/scrapy/downloadermiddlewares/redirect.py b/scrapy/downloadermiddlewares/redirect.py index 003c59fc4..f442a3012 100644 --- a/scrapy/downloadermiddlewares/redirect.py +++ b/scrapy/downloadermiddlewares/redirect.py @@ -3,10 +3,10 @@ from urllib.parse import urljoin, urlparse from w3lib.url import safe_url_string +from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import HtmlResponse from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.response import get_meta_refresh -from scrapy.exceptions import IgnoreRequest, NotConfigured logger = logging.getLogger(__name__) diff --git a/scrapy/downloadermiddlewares/retry.py b/scrapy/downloadermiddlewares/retry.py index 8a8f15f9a..11a30911c 100644 --- a/scrapy/downloadermiddlewares/retry.py +++ b/scrapy/downloadermiddlewares/retry.py @@ -9,7 +9,7 @@ RETRY_HTTP_CODES - which HTTP response codes to retry Failed pages are collected on the scraping process and rescheduled at the end, once the spider has finished crawling all regular (non failed) pages. """ -from logging import getLogger, Logger +from logging import Logger, getLogger from typing import Optional, Union from twisted.internet import defer @@ -31,7 +31,6 @@ from scrapy.spiders import Spider from scrapy.utils.python import global_object_name from scrapy.utils.response import response_status_message - retry_logger = getLogger(__name__) diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index 326c35290..89f8f7428 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -7,7 +7,8 @@ enable this middleware and enable the ROBOTSTXT_OBEY setting. import logging from twisted.internet.defer import Deferred, maybeDeferred -from scrapy.exceptions import NotConfigured, IgnoreRequest + +from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.log import failure_to_exc_info diff --git a/scrapy/dupefilters.py b/scrapy/dupefilters.py index fa0f8f846..d796e5cbb 100644 --- a/scrapy/dupefilters.py +++ b/scrapy/dupefilters.py @@ -10,8 +10,7 @@ from scrapy.settings import BaseSettings from scrapy.spiders import Spider from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.job import job_dir -from scrapy.utils.request import referer_str, RequestFingerprinter - +from scrapy.utils.request import RequestFingerprinter, referer_str BaseDupeFilterTV = TypeVar("BaseDupeFilterTV", bound="BaseDupeFilter") diff --git a/scrapy/exporters.py b/scrapy/exporters.py index 7d9a9b6ff..bb3e3c662 100644 --- a/scrapy/exporters.py +++ b/scrapy/exporters.py @@ -11,14 +11,13 @@ import warnings from collections.abc import Mapping from xml.sax.saxutils import XMLGenerator -from itemadapter import is_item, ItemAdapter +from itemadapter import ItemAdapter, is_item from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.item import Item from scrapy.utils.python import is_listlike, to_bytes, to_unicode from scrapy.utils.serialize import ScrapyJSONEncoder - __all__ = [ "BaseItemExporter", "PprintItemExporter", diff --git a/scrapy/extensions/debug.py b/scrapy/extensions/debug.py index 8628b4a1e..1b6c7777f 100644 --- a/scrapy/extensions/debug.py +++ b/scrapy/extensions/debug.py @@ -4,11 +4,11 @@ Extensions for debugging Scrapy See documentation in docs/topics/extensions.rst """ -import sys -import signal import logging -import traceback +import signal +import sys import threading +import traceback from pdb import Pdb from scrapy.utils.engine import format_engine_status diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index 823955aa3..cd26b5778 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -16,9 +16,9 @@ from urllib.parse import unquote, urlparse from twisted.internet import defer, threads from w3lib.url import file_uri_to_path -from zope.interface import implementer, Interface +from zope.interface import Interface, implementer -from scrapy import signals, Spider +from scrapy import Spider, signals from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.extensions.postprocessing import PostProcessingManager from scrapy.utils.boto import is_botocore_available @@ -28,7 +28,6 @@ from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import create_instance, load_object from scrapy.utils.python import get_func_args, without_none_values - logger = logging.getLogger(__name__) diff --git a/scrapy/extensions/httpcache.py b/scrapy/extensions/httpcache.py index bbddaac40..2d120a6ed 100644 --- a/scrapy/extensions/httpcache.py +++ b/scrapy/extensions/httpcache.py @@ -7,7 +7,7 @@ from pathlib import Path from time import time from weakref import WeakKeyDictionary -from w3lib.http import headers_raw_to_dict, headers_dict_to_raw +from w3lib.http import headers_dict_to_raw, headers_raw_to_dict from scrapy.http import Headers, Response from scrapy.http.request import Request diff --git a/scrapy/extensions/logstats.py b/scrapy/extensions/logstats.py index 6295dcdb7..78874a6db 100644 --- a/scrapy/extensions/logstats.py +++ b/scrapy/extensions/logstats.py @@ -2,8 +2,8 @@ import logging from twisted.internet import task -from scrapy.exceptions import NotConfigured from scrapy import signals +from scrapy.exceptions import NotConfigured logger = logging.getLogger(__name__) diff --git a/scrapy/extensions/memusage.py b/scrapy/extensions/memusage.py index 2bba71972..221967bda 100644 --- a/scrapy/extensions/memusage.py +++ b/scrapy/extensions/memusage.py @@ -3,11 +3,11 @@ MemoryUsage extension See documentation in docs/topics/extensions.rst """ -import sys -import socket import logging -from pprint import pformat +import socket +import sys from importlib import import_module +from pprint import pformat from twisted.internet import task diff --git a/scrapy/extensions/statsmailer.py b/scrapy/extensions/statsmailer.py index 8733ad22b..58610c25e 100644 --- a/scrapy/extensions/statsmailer.py +++ b/scrapy/extensions/statsmailer.py @@ -5,8 +5,8 @@ Use STATSMAILER_RCPTS setting to enable and give the recipient mail address """ from scrapy import signals -from scrapy.mail import MailSender from scrapy.exceptions import NotConfigured +from scrapy.mail import MailSender class StatsMailer: diff --git a/scrapy/extensions/telnet.py b/scrapy/extensions/telnet.py index 271f22428..c92b7f5fe 100644 --- a/scrapy/extensions/telnet.py +++ b/scrapy/extensions/telnet.py @@ -4,11 +4,11 @@ Scrapy Telnet Console extension See documentation in docs/topics/telnetconsole.rst """ -import pprint -import logging -import traceback import binascii +import logging import os +import pprint +import traceback from twisted.internet import protocol @@ -21,12 +21,12 @@ except (ImportError, SyntaxError): _TWISTED_CONCH_TRACEBACK = traceback.format_exc() TWISTED_CONCH_AVAILABLE = False -from scrapy.exceptions import NotConfigured from scrapy import signals -from scrapy.utils.trackref import print_live_refs +from scrapy.exceptions import NotConfigured +from scrapy.utils.decorators import defers from scrapy.utils.engine import print_engine_status from scrapy.utils.reactor import listen_tcp -from scrapy.utils.decorators import defers +from scrapy.utils.trackref import print_live_refs logger = logging.getLogger(__name__) diff --git a/scrapy/extensions/throttle.py b/scrapy/extensions/throttle.py index 79e20de2a..396800775 100644 --- a/scrapy/extensions/throttle.py +++ b/scrapy/extensions/throttle.py @@ -1,7 +1,7 @@ import logging -from scrapy.exceptions import NotConfigured from scrapy import signals +from scrapy.exceptions import NotConfigured logger = logging.getLogger(__name__) diff --git a/scrapy/http/__init__.py b/scrapy/http/__init__.py index e6c58e1f1..ac3946302 100644 --- a/scrapy/http/__init__.py +++ b/scrapy/http/__init__.py @@ -6,13 +6,11 @@ Request and Response outside this module. """ from scrapy.http.headers import Headers - from scrapy.http.request import Request from scrapy.http.request.form import FormRequest -from scrapy.http.request.rpc import XmlRpcRequest from scrapy.http.request.json_request import JsonRequest - +from scrapy.http.request.rpc import XmlRpcRequest from scrapy.http.response import Response from scrapy.http.response.html import HtmlResponse -from scrapy.http.response.xml import XmlResponse from scrapy.http.response.text import TextResponse +from scrapy.http.response.xml import XmlResponse diff --git a/scrapy/http/cookies.py b/scrapy/http/cookies.py index 94afedb08..a5329ad51 100644 --- a/scrapy/http/cookies.py +++ b/scrapy/http/cookies.py @@ -1,11 +1,11 @@ import re import time -from http.cookiejar import CookieJar as _CookieJar, DefaultCookiePolicy +from http.cookiejar import CookieJar as _CookieJar +from http.cookiejar import DefaultCookiePolicy from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_unicode - # Defined in the http.cookiejar module, but undocumented: # https://github.com/python/cpython/blob/v3.9.0/Lib/http/cookiejar.py#L527 IPV4_RE = re.compile(r"\.\d+$", re.ASCII) diff --git a/scrapy/http/headers.py b/scrapy/http/headers.py index a5db30d6f..2540be01a 100644 --- a/scrapy/http/headers.py +++ b/scrapy/http/headers.py @@ -1,6 +1,7 @@ from collections.abc import Mapping from w3lib.http import headers_dict_to_raw + from scrapy.utils.datatypes import CaselessDict from scrapy.utils.python import to_unicode diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index e290f2143..0e925301e 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -17,7 +17,6 @@ from scrapy.utils.python import to_bytes from scrapy.utils.trackref import object_ref from scrapy.utils.url import escape_ajax - RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") diff --git a/scrapy/http/request/form.py b/scrapy/http/request/form.py index 993219745..bdc6a3e39 100644 --- a/scrapy/http/request/form.py +++ b/scrapy/http/request/form.py @@ -6,7 +6,7 @@ See documentation in docs/topics/request-response.rst """ from typing import Iterable, List, Optional, Tuple, Type, TypeVar, Union -from urllib.parse import urljoin, urlencode, urlsplit, urlunsplit +from urllib.parse import urlencode, urljoin, urlsplit, urlunsplit from lxml.html import FormElement, HtmlElement, HTMLParser, SelectElement from parsel.selector import create_root_node @@ -14,10 +14,9 @@ from w3lib.html import strip_html5_whitespace from scrapy.http.request import Request from scrapy.http.response.text import TextResponse -from scrapy.utils.python import to_bytes, is_listlike +from scrapy.utils.python import is_listlike, to_bytes from scrapy.utils.response import get_base_url - FormRequestTypeVar = TypeVar("FormRequestTypeVar", bound="FormRequest") FormdataType = Optional[Union[dict, List[Tuple[str, str]]]] diff --git a/scrapy/http/request/rpc.py b/scrapy/http/request/rpc.py index c0a6e86c1..43692923b 100644 --- a/scrapy/http/request/rpc.py +++ b/scrapy/http/request/rpc.py @@ -10,7 +10,6 @@ from typing import Optional from scrapy.http.request import Request from scrapy.utils.python import get_func_args - DUMPS_ARGS = get_func_args(xmlrpclib.dumps) diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index f9df4e1b0..e45d95602 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -15,8 +15,8 @@ from w3lib.encoding import ( html_body_declared_encoding, html_to_unicode, http_content_type_encoding, - resolve_encoding, read_bom, + resolve_encoding, ) from w3lib.html import strip_html5_whitespace diff --git a/scrapy/loader/processors.py b/scrapy/loader/processors.py index f27a669d6..b82c6d5c7 100644 --- a/scrapy/loader/processors.py +++ b/scrapy/loader/processors.py @@ -7,7 +7,6 @@ from itemloaders import processors from scrapy.utils.deprecate import create_deprecated_class - MapCompose = create_deprecated_class("MapCompose", processors.MapCompose) Compose = create_deprecated_class("Compose", processors.Compose) diff --git a/scrapy/logformatter.py b/scrapy/logformatter.py index e0b93d812..560006c95 100644 --- a/scrapy/logformatter.py +++ b/scrapy/logformatter.py @@ -1,5 +1,5 @@ -import os import logging +import os from twisted.python.failure import Failure diff --git a/scrapy/mail.py b/scrapy/mail.py index fa1e55f1f..43115c53e 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -12,14 +12,13 @@ from email.mime.text import MIMEText from email.utils import formatdate from io import BytesIO -from twisted.python.versions import Version -from twisted.internet import defer, ssl from twisted import version as twisted_version +from twisted.internet import defer, ssl +from twisted.python.versions import Version from scrapy.utils.misc import arg_to_iter from scrapy.utils.python import to_bytes - logger = logging.getLogger(__name__) diff --git a/scrapy/middleware.py b/scrapy/middleware.py index 15f5b23e0..f82d722fa 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -8,8 +8,8 @@ from twisted.internet.defer import Deferred from scrapy import Spider from scrapy.exceptions import NotConfigured from scrapy.settings import Settings +from scrapy.utils.defer import process_chain, process_parallel from scrapy.utils.misc import create_instance, load_object -from scrapy.utils.defer import process_parallel, process_chain logger = logging.getLogger(__name__) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 01a9c41fe..d925fc984 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -32,7 +32,6 @@ from scrapy.utils.misc import md5sum from scrapy.utils.python import to_bytes from scrapy.utils.request import referer_str - logger = logging.getLogger(__name__) diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index af23b4cc8..f6eb5b139 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -9,10 +9,10 @@ from twisted.python.failure import Failure from scrapy.settings import Settings from scrapy.utils.datatypes import SequenceExclude -from scrapy.utils.defer import mustbe_deferred, defer_result +from scrapy.utils.defer import defer_result, mustbe_deferred from scrapy.utils.deprecate import ScrapyDeprecationWarning -from scrapy.utils.misc import arg_to_iter from scrapy.utils.log import failure_to_exc_info +from scrapy.utils.misc import arg_to_iter logger = logging.getLogger(__name__) diff --git a/scrapy/pqueues.py b/scrapy/pqueues.py index 6f65184e5..62a9af477 100644 --- a/scrapy/pqueues.py +++ b/scrapy/pqueues.py @@ -3,7 +3,6 @@ import logging from scrapy.utils.misc import create_instance - logger = logging.getLogger(__name__) diff --git a/scrapy/resolver.py b/scrapy/resolver.py index f5d2b8e05..6cbe01cbf 100644 --- a/scrapy/resolver.py +++ b/scrapy/resolver.py @@ -1,8 +1,8 @@ from twisted.internet import defer from twisted.internet.base import ThreadedResolver from twisted.internet.interfaces import ( - IHostResolution, IHostnameResolver, + IHostResolution, IResolutionReceiver, IResolverSimple, ) @@ -10,7 +10,6 @@ from zope.interface.declarations import implementer, provider from scrapy.utils.datatypes import LocalCache - # TODO: cache misses dnscache = LocalCache(10000) diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index 6b489bd8b..6af8915c2 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -2,9 +2,9 @@ This module implements a class which returns the appropriate Response class based on different criteria. """ +from io import StringIO from mimetypes import MimeTypes from pkgutil import get_data -from io import StringIO from scrapy.http import Response from scrapy.utils.misc import load_object diff --git a/scrapy/robotstxt.py b/scrapy/robotstxt.py index 0dadeef92..604b5e314 100644 --- a/scrapy/robotstxt.py +++ b/scrapy/robotstxt.py @@ -1,5 +1,5 @@ -import sys import logging +import sys from abc import ABCMeta, abstractmethod from scrapy.utils.python import to_unicode diff --git a/scrapy/selector/unified.py b/scrapy/selector/unified.py index 6ba87428e..cff97104a 100644 --- a/scrapy/selector/unified.py +++ b/scrapy/selector/unified.py @@ -3,10 +3,10 @@ XPath selectors based on lxml """ from parsel import Selector as _ParselSelector -from scrapy.utils.trackref import object_ref -from scrapy.utils.python import to_bytes -from scrapy.http import HtmlResponse, XmlResponse +from scrapy.http import HtmlResponse, XmlResponse +from scrapy.utils.python import to_bytes +from scrapy.utils.trackref import object_ref __all__ = ["Selector", "SelectorList"] diff --git a/scrapy/settings/__init__.py b/scrapy/settings/__init__.py index c0d0741c5..fde8fdde4 100644 --- a/scrapy/settings/__init__.py +++ b/scrapy/settings/__init__.py @@ -1,12 +1,11 @@ -import json import copy +import json from collections.abc import MutableMapping from importlib import import_module from pprint import pformat from scrapy.settings import default_settings - SETTINGS_PRIORITIES = { "default": 0, "command": 10, diff --git a/scrapy/shell.py b/scrapy/shell.py index 084a27141..ae6e641fd 100644 --- a/scrapy/shell.py +++ b/scrapy/shell.py @@ -7,7 +7,7 @@ import os import signal from itemadapter import is_item -from twisted.internet import threads, defer +from twisted.internet import defer, threads from twisted.python import threadable from w3lib.url import any_to_uri @@ -20,11 +20,8 @@ from scrapy.utils.conf import get_config from scrapy.utils.console import DEFAULT_PYTHON_SHELLS, start_python_console from scrapy.utils.datatypes import SequenceExclude from scrapy.utils.misc import load_object +from scrapy.utils.reactor import is_asyncio_reactor_installed, set_asyncio_event_loop from scrapy.utils.response import open_in_browser -from scrapy.utils.reactor import ( - is_asyncio_reactor_installed, - set_asyncio_event_loop, -) class Shell: diff --git a/scrapy/signalmanager.py b/scrapy/signalmanager.py index f00447a55..d7e3bce91 100644 --- a/scrapy/signalmanager.py +++ b/scrapy/signalmanager.py @@ -1,4 +1,5 @@ from pydispatch import dispatcher + from scrapy.utils import signal as _signal diff --git a/scrapy/spidermiddlewares/offsite.py b/scrapy/spidermiddlewares/offsite.py index c57ec8d48..1a48926b3 100644 --- a/scrapy/spidermiddlewares/offsite.py +++ b/scrapy/spidermiddlewares/offsite.py @@ -3,8 +3,8 @@ Offsite Spider Middleware See documentation in docs/topics/spider-middleware.rst """ -import re import logging +import re import warnings from scrapy import signals diff --git a/scrapy/spidermiddlewares/referer.py b/scrapy/spidermiddlewares/referer.py index a99b6315b..d86f55a40 100644 --- a/scrapy/spidermiddlewares/referer.py +++ b/scrapy/spidermiddlewares/referer.py @@ -15,7 +15,6 @@ from scrapy.utils.misc import load_object from scrapy.utils.python import to_unicode from scrapy.utils.url import strip_url - LOCAL_SCHEMES = ( "about", "blob", diff --git a/scrapy/spidermiddlewares/urllength.py b/scrapy/spidermiddlewares/urllength.py index 9a21379f9..f6d92e53a 100644 --- a/scrapy/spidermiddlewares/urllength.py +++ b/scrapy/spidermiddlewares/urllength.py @@ -6,8 +6,8 @@ See documentation in docs/topics/spider-middleware.rst import logging -from scrapy.http import Request from scrapy.exceptions import NotConfigured +from scrapy.http import Request logger = logging.getLogger(__name__) diff --git a/scrapy/spiders/__init__.py b/scrapy/spiders/__init__.py index f8cac5458..3502f8b27 100644 --- a/scrapy/spiders/__init__.py +++ b/scrapy/spiders/__init__.py @@ -97,5 +97,5 @@ class Spider(object_ref): # Top-level imports from scrapy.spiders.crawl import CrawlSpider, Rule -from scrapy.spiders.feed import XMLFeedSpider, CSVFeedSpider +from scrapy.spiders.feed import CSVFeedSpider, XMLFeedSpider from scrapy.spiders.sitemap import SitemapSpider diff --git a/scrapy/spiders/crawl.py b/scrapy/spiders/crawl.py index d75b455ae..05c425948 100644 --- a/scrapy/spiders/crawl.py +++ b/scrapy/spiders/crawl.py @@ -8,7 +8,7 @@ See documentation in docs/topics/spiders.rst import copy from typing import AsyncIterable, Awaitable, Sequence -from scrapy.http import Request, Response, HtmlResponse +from scrapy.http import HtmlResponse, Request, Response from scrapy.linkextractors import LinkExtractor from scrapy.spiders import Spider from scrapy.utils.asyncgen import collect_asyncgen diff --git a/scrapy/spiders/feed.py b/scrapy/spiders/feed.py index b3c5ff01e..5ec0504a8 100644 --- a/scrapy/spiders/feed.py +++ b/scrapy/spiders/feed.py @@ -4,11 +4,11 @@ for scraping from an XML feed. See documentation in docs/topics/spiders.rst """ -from scrapy.spiders import Spider -from scrapy.utils.iterators import xmliter, csviter -from scrapy.utils.spider import iterate_spider_output -from scrapy.selector import Selector from scrapy.exceptions import NotConfigured, NotSupported +from scrapy.selector import Selector +from scrapy.spiders import Spider +from scrapy.utils.iterators import csviter, xmliter +from scrapy.utils.spider import iterate_spider_output class XMLFeedSpider(Spider): diff --git a/scrapy/spiders/sitemap.py b/scrapy/spiders/sitemap.py index a1734a3b1..c3cca9699 100644 --- a/scrapy/spiders/sitemap.py +++ b/scrapy/spiders/sitemap.py @@ -1,11 +1,10 @@ -import re import logging +import re -from scrapy.spiders import Spider from scrapy.http import Request, XmlResponse -from scrapy.utils.sitemap import Sitemap, sitemap_urls_from_robots +from scrapy.spiders import Spider from scrapy.utils.gz import gunzip, gzip_magic_number - +from scrapy.utils.sitemap import Sitemap, sitemap_urls_from_robots logger = logging.getLogger(__name__) diff --git a/scrapy/statscollectors.py b/scrapy/statscollectors.py index 4181c7a2f..dd3c32737 100644 --- a/scrapy/statscollectors.py +++ b/scrapy/statscollectors.py @@ -1,8 +1,8 @@ """ Scrapy extension for collecting scraping stats """ -import pprint import logging +import pprint logger = logging.getLogger(__name__) diff --git a/scrapy/utils/benchserver.py b/scrapy/utils/benchserver.py index 32bc2e38c..1089ba7b8 100644 --- a/scrapy/utils/benchserver.py +++ b/scrapy/utils/benchserver.py @@ -1,8 +1,8 @@ import random from urllib.parse import urlencode -from twisted.web.server import Site from twisted.web.resource import Resource +from twisted.web.server import Site class Root(Resource): diff --git a/scrapy/utils/conf.py b/scrapy/utils/conf.py index 2f1569ab6..3ade1d105 100644 --- a/scrapy/utils/conf.py +++ b/scrapy/utils/conf.py @@ -8,7 +8,6 @@ from pathlib import Path from typing import Any, Dict, List, Optional, Union from scrapy.exceptions import ScrapyDeprecationWarning, UsageError - from scrapy.settings import BaseSettings from scrapy.utils.deprecate import update_classpath from scrapy.utils.python import without_none_values diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index 3175e5fdc..a2243ae2e 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -1,7 +1,7 @@ import argparse import warnings -from shlex import split from http.cookies import SimpleCookie +from shlex import split from urllib.parse import urlparse from w3lib.http import basic_auth_header diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 21cd5e78f..ec130d685 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -26,7 +26,7 @@ from twisted.python import failure from twisted.python.failure import Failure from scrapy.exceptions import IgnoreRequest -from scrapy.utils.reactor import is_asyncio_reactor_installed, _get_asyncio_event_loop +from scrapy.utils.reactor import _get_asyncio_event_loop, is_asyncio_reactor_installed def defer_fail(_failure: Failure) -> Deferred: diff --git a/scrapy/utils/deprecate.py b/scrapy/utils/deprecate.py index 4757fef0a..61a4347ea 100644 --- a/scrapy/utils/deprecate.py +++ b/scrapy/utils/deprecate.py @@ -1,8 +1,9 @@ """Some helpers for deprecation messages""" -import warnings import inspect +import warnings from typing import List, Tuple + from scrapy.exceptions import ScrapyDeprecationWarning diff --git a/scrapy/utils/display.py b/scrapy/utils/display.py index f6dceb87f..77c32b002 100644 --- a/scrapy/utils/display.py +++ b/scrapy/utils/display.py @@ -6,6 +6,7 @@ import ctypes import platform import sys from pprint import pformat as pformat_ + from packaging.version import Version as parse_version diff --git a/scrapy/utils/ftp.py b/scrapy/utils/ftp.py index 9dbb4180f..6bf6e9195 100644 --- a/scrapy/utils/ftp.py +++ b/scrapy/utils/ftp.py @@ -1,5 +1,5 @@ import posixpath -from ftplib import error_perm, FTP +from ftplib import FTP, error_perm from posixpath import dirname diff --git a/scrapy/utils/httpobj.py b/scrapy/utils/httpobj.py index 540035ca9..d502e8910 100644 --- a/scrapy/utils/httpobj.py +++ b/scrapy/utils/httpobj.py @@ -1,12 +1,11 @@ """Helper functions for scrapy.http objects (Request, Response)""" from typing import Union -from urllib.parse import urlparse, ParseResult +from urllib.parse import ParseResult, urlparse from weakref import WeakKeyDictionary from scrapy.http import Request, Response - _urlparse_cache: "WeakKeyDictionary[Union[Request, Response], ParseResult]" = ( WeakKeyDictionary() ) diff --git a/scrapy/utils/iterators.py b/scrapy/utils/iterators.py index 7d52d35c9..170055d5e 100644 --- a/scrapy/utils/iterators.py +++ b/scrapy/utils/iterators.py @@ -3,11 +3,10 @@ import logging import re from io import StringIO -from scrapy.http import TextResponse, Response +from scrapy.http import Response, TextResponse from scrapy.selector import Selector from scrapy.utils.python import re_rsearch, to_unicode - logger = logging.getLogger(__name__) diff --git a/scrapy/utils/log.py b/scrapy/utils/log.py index 2560a421f..6ae27dc29 100644 --- a/scrapy/utils/log.py +++ b/scrapy/utils/log.py @@ -11,7 +11,6 @@ from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.settings import Settings from scrapy.utils.versions import scrapy_components_versions - logger = logging.getLogger(__name__) diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index dfd2f767c..f9f9c0d5b 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -1,23 +1,22 @@ """Helper functions which don't fit anywhere else""" import ast +import hashlib import inspect import os import re -import hashlib import warnings from collections import deque from contextlib import contextmanager +from functools import partial from importlib import import_module from pkgutil import iter_modules -from functools import partial from w3lib.html import replace_entities -from scrapy.utils.datatypes import LocalWeakReferencedCache -from scrapy.utils.python import flatten, to_unicode from scrapy.item import Item +from scrapy.utils.datatypes import LocalWeakReferencedCache from scrapy.utils.deprecate import ScrapyDeprecationWarning - +from scrapy.utils.python import flatten, to_unicode _ITERABLE_SINGLE_VALUES = dict, Item, str, bytes diff --git a/scrapy/utils/ossignal.py b/scrapy/utils/ossignal.py index 18d856927..7646264a8 100644 --- a/scrapy/utils/ossignal.py +++ b/scrapy/utils/ossignal.py @@ -1,6 +1,5 @@ import signal - signal_names = {} for signame in dir(signal): if signame.startswith("SIG") and not signame.startswith("SIG_"): diff --git a/scrapy/utils/project.py b/scrapy/utils/project.py index 4fbb6bcaf..ab1b8e3ee 100644 --- a/scrapy/utils/project.py +++ b/scrapy/utils/project.py @@ -1,13 +1,11 @@ import os import warnings - from importlib import import_module from pathlib import Path -from scrapy.utils.conf import closest_scrapy_cfg, get_config, init_env -from scrapy.settings import Settings from scrapy.exceptions import NotConfigured - +from scrapy.settings import Settings +from scrapy.utils.conf import closest_scrapy_cfg, get_config, init_env ENVVAR = "SCRAPY_SETTINGS_MODULE" DATADIR_CFG_SECTION = "datadir" diff --git a/scrapy/utils/reqser.py b/scrapy/utils/reqser.py index c818c8700..15705db83 100644 --- a/scrapy/utils/reqser.py +++ b/scrapy/utils/reqser.py @@ -5,7 +5,6 @@ import scrapy from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.request import request_from_dict as _from_dict - warnings.warn( ( "Module scrapy.utils.reqser is deprecated, please use request.to_dict method" diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index 3e29a9c57..409ca2e52 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -19,7 +19,6 @@ from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import load_object from scrapy.utils.python import to_bytes, to_unicode - _deprecated_fingerprint_cache: "WeakKeyDictionary[Request, Dict[Tuple[Optional[Tuple[bytes, ...]], bool], str]]" _deprecated_fingerprint_cache = WeakKeyDictionary() diff --git a/scrapy/utils/response.py b/scrapy/utils/response.py index a91a49170..730d005e8 100644 --- a/scrapy/utils/response.py +++ b/scrapy/utils/response.py @@ -11,12 +11,11 @@ from weakref import WeakKeyDictionary from twisted.web import http from w3lib import html + import scrapy from scrapy.http.response import Response - - -from scrapy.utils.python import to_bytes, to_unicode from scrapy.utils.decorators import deprecated +from scrapy.utils.python import to_bytes, to_unicode _baseurl_cache: "WeakKeyDictionary[Response, str]" = WeakKeyDictionary() diff --git a/scrapy/utils/serialize.py b/scrapy/utils/serialize.py index 3602043f3..358f41679 100644 --- a/scrapy/utils/serialize.py +++ b/scrapy/utils/serialize.py @@ -1,8 +1,8 @@ -import json import datetime import decimal +import json -from itemadapter import is_item, ItemAdapter +from itemadapter import ItemAdapter, is_item from twisted.internet import defer from scrapy.http import Request, Response diff --git a/scrapy/utils/signal.py b/scrapy/utils/signal.py index b7c284174..b95786d35 100644 --- a/scrapy/utils/signal.py +++ b/scrapy/utils/signal.py @@ -2,9 +2,6 @@ import collections.abc import logging -from twisted.internet.defer import DeferredList, Deferred -from twisted.python.failure import Failure - from pydispatch.dispatcher import ( Anonymous, Any, @@ -13,12 +10,13 @@ from pydispatch.dispatcher import ( liveReceivers, ) from pydispatch.robustapply import robustApply +from twisted.internet.defer import Deferred, DeferredList +from twisted.python.failure import Failure from scrapy.exceptions import StopDownload from scrapy.utils.defer import maybeDeferred_coro from scrapy.utils.log import failure_to_exc_info - logger = logging.getLogger(__name__) diff --git a/scrapy/utils/spider.py b/scrapy/utils/spider.py index f829bceb8..86449eeb2 100644 --- a/scrapy/utils/spider.py +++ b/scrapy/utils/spider.py @@ -5,7 +5,6 @@ from scrapy.spiders import Spider from scrapy.utils.defer import deferred_from_coro from scrapy.utils.misc import arg_to_iter - logger = logging.getLogger(__name__) diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index 9f03621c1..f4b598ac7 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -1,5 +1,5 @@ -import OpenSSL.SSL import OpenSSL._util as pyOpenSSLutil +import OpenSSL.SSL from scrapy.utils.python import to_unicode diff --git a/scrapy/utils/template.py b/scrapy/utils/template.py index 89bedfc69..1499aeb3d 100644 --- a/scrapy/utils/template.py +++ b/scrapy/utils/template.py @@ -1,8 +1,8 @@ """Helper functions for working with templates""" -from os import PathLike import re import string +from os import PathLike from pathlib import Path from typing import Union diff --git a/scrapy/utils/test.py b/scrapy/utils/test.py index d21065706..58576903a 100644 --- a/scrapy/utils/test.py +++ b/scrapy/utils/test.py @@ -4,11 +4,11 @@ This module contains some assorted functions used in tests import asyncio import os +from importlib import import_module from pathlib import Path from posixpath import split from unittest import mock -from importlib import import_module from twisted.trial.unittest import SkipTest from scrapy.utils.boto import is_botocore_available @@ -109,7 +109,7 @@ def mock_google_cloud_storage(): """Creates autospec mocks for google-cloud-storage Client, Bucket and Blob classes and set their proper return values. """ - from google.cloud.storage import Client, Bucket, Blob + from google.cloud.storage import Blob, Bucket, Client client_mock = mock.create_autospec(Client) diff --git a/scrapy/utils/testproc.py b/scrapy/utils/testproc.py index fe5c8d74c..ecb2e31bf 100644 --- a/scrapy/utils/testproc.py +++ b/scrapy/utils/testproc.py @@ -1,5 +1,5 @@ -import sys import os +import sys from twisted.internet import defer, protocol diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py index a47756c4b..de9ce992a 100644 --- a/scrapy/utils/testsite.py +++ b/scrapy/utils/testsite.py @@ -1,6 +1,6 @@ from urllib.parse import urljoin -from twisted.web import server, resource, static, util +from twisted.web import resource, server, static, util class SiteTest: diff --git a/scrapy/utils/trackref.py b/scrapy/utils/trackref.py index 9aa775a1b..01b980c93 100644 --- a/scrapy/utils/trackref.py +++ b/scrapy/utils/trackref.py @@ -15,7 +15,6 @@ from time import time from typing import DefaultDict from weakref import WeakKeyDictionary - NoneType = type(None) live_refs: DefaultDict[type, WeakKeyDictionary] = defaultdict(WeakKeyDictionary) diff --git a/scrapy/utils/url.py b/scrapy/utils/url.py index cd8a6a05a..0a27ccd6d 100644 --- a/scrapy/utils/url.py +++ b/scrapy/utils/url.py @@ -12,6 +12,7 @@ from urllib.parse import ParseResult, urldefrag, urlparse, urlunparse # move doesn't break old code from w3lib.url import * from w3lib.url import _safe_chars, _unquotepath # noqa: F401 + from scrapy.utils.python import to_unicode diff --git a/setup.py b/setup.py index f53334d4e..c6bcf2439 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,8 @@ from pathlib import Path -from pkg_resources import parse_version -from setuptools import setup, find_packages, __version__ as setuptools_version +from pkg_resources import parse_version +from setuptools import __version__ as setuptools_version +from setuptools import find_packages, setup version = (Path(__file__).parent / "scrapy/VERSION").read_text("ascii").strip() diff --git a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py index 79dd77bb2..be9c83b95 100644 --- a/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py +++ b/tests/CrawlerProcess/asyncio_enabled_reactor_same_loop.py @@ -1,9 +1,8 @@ import asyncio import sys -from uvloop import Loop - from twisted.internet import asyncioreactor +from uvloop import Loop if sys.version_info >= (3, 8) and sys.platform == "win32": asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) diff --git a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py index 37626c081..a8f707841 100644 --- a/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py +++ b/tests/CrawlerProcess/reactor_select_subclass_twisted_reactor_select.py @@ -1,5 +1,6 @@ from twisted.internet.main import installReactor from twisted.internet.selectreactor import SelectReactor + import scrapy from scrapy.crawler import CrawlerProcess diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index 26db16dd6..23260ab0d 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -1,14 +1,16 @@ from urllib.parse import urlparse from twisted.internet import reactor -from twisted.names import cache, hosts as hostsModule, resolve +from twisted.names import cache +from twisted.names import hosts as hostsModule +from twisted.names import resolve from twisted.names.client import Resolver from twisted.python.runtime import platform -from scrapy import Spider, Request +from scrapy import Request, Spider from scrapy.crawler import CrawlerRunner from scrapy.utils.log import configure_logging -from tests.mockserver import MockServer, MockDNSServer +from tests.mockserver import MockDNSServer, MockServer # https://stackoverflow.com/a/32784190 diff --git a/tests/keys/__init__.py b/tests/keys/__init__.py index b306437db..5cc65a903 100644 --- a/tests/keys/__init__.py +++ b/tests/keys/__init__.py @@ -14,8 +14,8 @@ from cryptography.x509 import ( DNSName, Name, NameAttribute, - random_serial_number, SubjectAlternativeName, + random_serial_number, ) from cryptography.x509.oid import NameOID diff --git a/tests/mockserver.py b/tests/mockserver.py index e07ae8797..7991da9dc 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -4,7 +4,7 @@ import random import sys from pathlib import Path from shutil import rmtree -from subprocess import Popen, PIPE +from subprocess import PIPE, Popen from tempfile import mkdtemp from urllib.parse import urlencode @@ -14,7 +14,7 @@ from twisted.internet.task import deferLater from twisted.names import dns, error from twisted.names.server import DNSServerFactory from twisted.web import resource, server -from twisted.web.server import GzipEncoderFactory, NOT_DONE_YET, Site +from twisted.web.server import NOT_DONE_YET, GzipEncoderFactory, Site from twisted.web.static import File from twisted.web.util import redirectTo diff --git a/tests/test_closespider.py b/tests/test_closespider.py index c497450f7..9b39187d5 100644 --- a/tests/test_closespider.py +++ b/tests/test_closespider.py @@ -1,8 +1,9 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase + from scrapy.utils.test import get_crawler -from tests.spiders import FollowAllSpider, ItemSpider, ErrorSpider from tests.mockserver import MockServer +from tests.spiders import ErrorSpider, FollowAllSpider, ItemSpider class TestCloseSpider(TestCase): diff --git a/tests/test_cmdline/__init__.py b/tests/test_cmdline/__init__.py index 5aa35a6d9..15833cd19 100644 --- a/tests/test_cmdline/__init__.py +++ b/tests/test_cmdline/__init__.py @@ -6,7 +6,7 @@ import tempfile import unittest from io import StringIO from pathlib import Path -from subprocess import Popen, PIPE +from subprocess import PIPE, Popen from scrapy.utils.test import get_testenv diff --git a/tests/test_cmdline_crawl_with_pipeline/__init__.py b/tests/test_cmdline_crawl_with_pipeline/__init__.py index d5088e817..5cb09b5c0 100644 --- a/tests/test_cmdline_crawl_with_pipeline/__init__.py +++ b/tests/test_cmdline_crawl_with_pipeline/__init__.py @@ -1,7 +1,7 @@ import sys import unittest from pathlib import Path -from subprocess import Popen, PIPE +from subprocess import PIPE, Popen class CmdlineCrawlPipelineTest(unittest.TestCase): diff --git a/tests/test_command_fetch.py b/tests/test_command_fetch.py index bd44fa76e..124c968c2 100644 --- a/tests/test_command_fetch.py +++ b/tests/test_command_fetch.py @@ -1,8 +1,8 @@ -from twisted.trial import unittest from twisted.internet import defer +from twisted.trial import unittest -from scrapy.utils.testsite import SiteTest from scrapy.utils.testproc import ProcessTest +from scrapy.utils.testsite import SiteTest class FetchTest(ProcessTest, SiteTest, unittest.TestCase): diff --git a/tests/test_command_parse.py b/tests/test_command_parse.py index 1ee1bf5a7..b0fb978e9 100644 --- a/tests/test_command_parse.py +++ b/tests/test_command_parse.py @@ -1,13 +1,14 @@ -import os import argparse +import os from pathlib import Path from twisted.internet import defer + from scrapy.commands import parse from scrapy.settings import Settings -from scrapy.utils.testsite import SiteTest -from scrapy.utils.testproc import ProcessTest from scrapy.utils.python import to_unicode +from scrapy.utils.testproc import ProcessTest +from scrapy.utils.testsite import SiteTest from tests.test_commands import CommandTest diff --git a/tests/test_command_shell.py b/tests/test_command_shell.py index 7e99a7296..8ce82db86 100644 --- a/tests/test_command_shell.py +++ b/tests/test_command_shell.py @@ -1,12 +1,11 @@ from pathlib import Path -from twisted.trial import unittest from twisted.internet import defer +from twisted.trial import unittest -from scrapy.utils.testsite import SiteTest from scrapy.utils.testproc import ProcessTest - -from tests import tests_datadir, NON_EXISTING_RESOLVABLE +from scrapy.utils.testsite import SiteTest +from tests import NON_EXISTING_RESOLVABLE, tests_datadir class ShellTest(ProcessTest, SiteTest, unittest.TestCase): diff --git a/tests/test_command_version.py b/tests/test_command_version.py index f97a088a8..3bf6019b5 100644 --- a/tests/test_command_version.py +++ b/tests/test_command_version.py @@ -1,6 +1,7 @@ import sys -from twisted.trial import unittest + from twisted.internet import defer +from twisted.trial import unittest import scrapy from scrapy.utils.testproc import ProcessTest diff --git a/tests/test_commands.py b/tests/test_commands.py index 363e87aa7..5ff2dd482 100644 --- a/tests/test_commands.py +++ b/tests/test_commands.py @@ -1,6 +1,6 @@ +import argparse import inspect import json -import argparse import os import platform import re @@ -10,7 +10,7 @@ import tempfile from contextlib import contextmanager from itertools import chain from pathlib import Path -from shutil import rmtree, copytree +from shutil import copytree, rmtree from stat import S_IWRITE as ANYONE_WRITE_PERMISSION from tempfile import mkdtemp from threading import Timer @@ -23,12 +23,11 @@ from twisted.python.versions import Version from twisted.trial import unittest import scrapy -from scrapy.commands import view, ScrapyCommand, ScrapyHelpFormatter +from scrapy.commands import ScrapyCommand, ScrapyHelpFormatter, view from scrapy.commands.startproject import IGNORE from scrapy.settings import Settings from scrapy.utils.python import to_unicode from scrapy.utils.test import get_testenv - from tests.test_crawler import ExceptionSpider, NoRequestsSpider diff --git a/tests/test_contracts.py b/tests/test_contracts.py index 7b104f618..813927fc5 100644 --- a/tests/test_contracts.py +++ b/tests/test_contracts.py @@ -5,18 +5,18 @@ from twisted.python import failure from twisted.trial import unittest from scrapy import FormRequest -from scrapy.spidermiddlewares.httperror import HttpError -from scrapy.spiders import Spider -from scrapy.http import Request -from scrapy.item import Item, Field -from scrapy.utils.test import get_crawler -from scrapy.contracts import ContractsManager, Contract +from scrapy.contracts import Contract, ContractsManager from scrapy.contracts.default import ( - UrlContract, CallbackKeywordArgumentsContract, ReturnsContract, ScrapesContract, + UrlContract, ) +from scrapy.http import Request +from scrapy.item import Field, Item +from scrapy.spidermiddlewares.httperror import HttpError +from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler from tests.mockserver import MockServer diff --git a/tests/test_crawl.py b/tests/test_crawl.py index 4139f1b11..ca9084294 100644 --- a/tests/test_crawl.py +++ b/tests/test_crawl.py @@ -1,9 +1,9 @@ import json import logging +import unittest from ipaddress import IPv4Address from socket import gethostbyname from urllib.parse import urlparse -import unittest from pytest import mark from testfixtures import LogCapture diff --git a/tests/test_crawler.py b/tests/test_crawler.py index c6b93599e..706bfbaa9 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -5,28 +5,25 @@ import sys import warnings from pathlib import Path -from pytest import raises, mark +from pkg_resources import parse_version +from pytest import mark, raises from twisted import version as twisted_version from twisted.internet import defer from twisted.python.versions import Version from twisted.trial import unittest - -from pkg_resources import parse_version from w3lib import __version__ as w3lib_version import scrapy -from scrapy.crawler import Crawler, CrawlerRunner, CrawlerProcess +from scrapy.crawler import Crawler, CrawlerProcess, CrawlerRunner from scrapy.exceptions import ScrapyDeprecationWarning +from scrapy.extensions import telnet +from scrapy.extensions.throttle import AutoThrottle from scrapy.settings import Settings, default_settings from scrapy.spiderloader import SpiderLoader from scrapy.utils.log import configure_logging, get_scrapy_root_handler -from scrapy.utils.spider import DefaultSpider from scrapy.utils.misc import load_object -from scrapy.utils.test import get_crawler -from scrapy.extensions.throttle import AutoThrottle -from scrapy.extensions import telnet -from scrapy.utils.test import get_testenv - +from scrapy.utils.spider import DefaultSpider +from scrapy.utils.test import get_crawler, get_testenv from tests.mockserver import MockServer diff --git a/tests/test_downloader_handlers.py b/tests/test_downloader_handlers.py index 4f953439d..fd4176e2f 100644 --- a/tests/test_downloader_handlers.py +++ b/tests/test_downloader_handlers.py @@ -5,7 +5,7 @@ import sys import tempfile from pathlib import Path from typing import Optional, Type -from unittest import mock, SkipTest +from unittest import SkipTest, mock from testfixtures import LogCapture from twisted.cred import checkers, credentials, portal @@ -1041,7 +1041,8 @@ class BaseFTPTestCase(unittest.TestCase): ) def setUp(self): - from twisted.protocols.ftp import FTPRealm, FTPFactory + from twisted.protocols.ftp import FTPFactory, FTPRealm + from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler # setup dirs and test file @@ -1190,7 +1191,8 @@ class AnonymousFTPTestCase(BaseFTPTestCase): req_meta = {} def setUp(self): - from twisted.protocols.ftp import FTPRealm, FTPFactory + from twisted.protocols.ftp import FTPFactory, FTPRealm + from scrapy.core.downloader.handlers.ftp import FTPDownloadHandler # setup dir and test file diff --git a/tests/test_downloader_handlers_http2.py b/tests/test_downloader_handlers_http2.py index fd765089a..8090d50b9 100644 --- a/tests/test_downloader_handlers_http2.py +++ b/tests/test_downloader_handlers_http2.py @@ -15,10 +15,10 @@ from scrapy.utils.misc import create_instance from scrapy.utils.test import get_crawler from tests.mockserver import ssl_context_factory from tests.test_downloader_handlers import ( - Https11TestCase, - Https11CustomCiphers, Http11MockServerTestCase, Http11ProxyTestCase, + Https11CustomCiphers, + Https11TestCase, UriResource, ) diff --git a/tests/test_downloadermiddleware.py b/tests/test_downloadermiddleware.py index d8e377519..2be32e37b 100644 --- a/tests/test_downloadermiddleware.py +++ b/tests/test_downloadermiddleware.py @@ -4,15 +4,15 @@ from unittest import mock from pytest import mark from twisted.internet import defer from twisted.internet.defer import Deferred -from twisted.trial.unittest import TestCase from twisted.python.failure import Failure +from twisted.trial.unittest import TestCase +from scrapy.core.downloader.middleware import DownloaderMiddlewareManager +from scrapy.exceptions import _InvalidOutput from scrapy.http import Request, Response from scrapy.spiders import Spider -from scrapy.exceptions import _InvalidOutput -from scrapy.core.downloader.middleware import DownloaderMiddlewareManager -from scrapy.utils.test import get_crawler, get_from_asyncio_queue from scrapy.utils.python import to_bytes +from scrapy.utils.test import get_crawler, get_from_asyncio_queue class ManagerTestCase(TestCase): diff --git a/tests/test_downloadermiddleware_ajaxcrawlable.py b/tests/test_downloadermiddleware_ajaxcrawlable.py index 6be107f6f..043dc0a12 100644 --- a/tests/test_downloadermiddleware_ajaxcrawlable.py +++ b/tests/test_downloadermiddleware_ajaxcrawlable.py @@ -1,11 +1,10 @@ import unittest from scrapy.downloadermiddlewares.ajaxcrawl import AjaxCrawlMiddleware +from scrapy.http import HtmlResponse, Request, Response from scrapy.spiders import Spider -from scrapy.http import Request, HtmlResponse, Response from scrapy.utils.test import get_crawler - __doctests__ = ["scrapy.downloadermiddlewares.ajaxcrawl"] diff --git a/tests/test_downloadermiddleware_cookies.py b/tests/test_downloadermiddleware_cookies.py index 812c003da..4a81a638e 100644 --- a/tests/test_downloadermiddleware_cookies.py +++ b/tests/test_downloadermiddleware_cookies.py @@ -1,14 +1,14 @@ import logging from unittest import TestCase -from testfixtures import LogCapture import pytest +from testfixtures import LogCapture from scrapy.downloadermiddlewares.cookies import CookiesMiddleware from scrapy.downloadermiddlewares.defaultheaders import DefaultHeadersMiddleware from scrapy.downloadermiddlewares.redirect import RedirectMiddleware from scrapy.exceptions import NotConfigured -from scrapy.http import Response, Request +from scrapy.http import Request, Response from scrapy.settings import Settings from scrapy.spiders import Spider from scrapy.utils.python import to_bytes diff --git a/tests/test_downloadermiddleware_decompression.py b/tests/test_downloadermiddleware_decompression.py index 16ae9ed75..412c20a78 100644 --- a/tests/test_downloadermiddleware_decompression.py +++ b/tests/test_downloadermiddleware_decompression.py @@ -1,6 +1,7 @@ from unittest import TestCase, main -from scrapy.http import Response, XmlResponse + from scrapy.downloadermiddlewares.decompression import DecompressionMiddleware +from scrapy.http import Response, XmlResponse from scrapy.spiders import Spider from scrapy.utils.test import assert_samelines from tests import get_testdata diff --git a/tests/test_downloadermiddleware_defaultheaders.py b/tests/test_downloadermiddleware_defaultheaders.py index 601e85799..27d6224b4 100644 --- a/tests/test_downloadermiddleware_defaultheaders.py +++ b/tests/test_downloadermiddleware_defaultheaders.py @@ -3,8 +3,8 @@ from unittest import TestCase from scrapy.downloadermiddlewares.defaultheaders import DefaultHeadersMiddleware from scrapy.http import Request from scrapy.spiders import Spider -from scrapy.utils.test import get_crawler from scrapy.utils.python import to_bytes +from scrapy.utils.test import get_crawler class TestDefaultHeadersMiddleware(TestCase): diff --git a/tests/test_downloadermiddleware_downloadtimeout.py b/tests/test_downloadermiddleware_downloadtimeout.py index 8d2b821b0..44458ade8 100644 --- a/tests/test_downloadermiddleware_downloadtimeout.py +++ b/tests/test_downloadermiddleware_downloadtimeout.py @@ -1,8 +1,8 @@ import unittest from scrapy.downloadermiddlewares.downloadtimeout import DownloadTimeoutMiddleware -from scrapy.spiders import Spider from scrapy.http import Request +from scrapy.spiders import Spider from scrapy.utils.test import get_crawler diff --git a/tests/test_downloadermiddleware_httpauth.py b/tests/test_downloadermiddleware_httpauth.py index 1320bded2..6b79234d0 100644 --- a/tests/test_downloadermiddleware_httpauth.py +++ b/tests/test_downloadermiddleware_httpauth.py @@ -3,9 +3,9 @@ import unittest import pytest from w3lib.http import basic_auth_header +from scrapy.downloadermiddlewares.httpauth import HttpAuthMiddleware from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import Request -from scrapy.downloadermiddlewares.httpauth import HttpAuthMiddleware from scrapy.spiders import Spider diff --git a/tests/test_downloadermiddleware_httpcache.py b/tests/test_downloadermiddleware_httpcache.py index caa89b6bd..a355a9b5b 100644 --- a/tests/test_downloadermiddleware_httpcache.py +++ b/tests/test_downloadermiddleware_httpcache.py @@ -1,16 +1,16 @@ -import time -import tempfile -import shutil -import unittest import email.utils +import shutil +import tempfile +import time +import unittest from contextlib import contextmanager -from scrapy.http import Response, HtmlResponse, Request -from scrapy.spiders import Spider -from scrapy.settings import Settings -from scrapy.exceptions import IgnoreRequest -from scrapy.utils.test import get_crawler from scrapy.downloadermiddlewares.httpcache import HttpCacheMiddleware +from scrapy.exceptions import IgnoreRequest +from scrapy.http import HtmlResponse, Request, Response +from scrapy.settings import Settings +from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler class _BaseTest(unittest.TestCase): diff --git a/tests/test_downloadermiddleware_httpcompression.py b/tests/test_downloadermiddleware_httpcompression.py index efae7c4e0..fac5588ff 100644 --- a/tests/test_downloadermiddleware_httpcompression.py +++ b/tests/test_downloadermiddleware_httpcompression.py @@ -1,18 +1,19 @@ from gzip import GzipFile from io import BytesIO from pathlib import Path -from unittest import TestCase, SkipTest +from unittest import SkipTest, TestCase from warnings import catch_warnings from w3lib.encoding import resolve_encoding -from scrapy.spiders import Spider -from scrapy.http import Response, Request, HtmlResponse + from scrapy.downloadermiddlewares.httpcompression import ( - HttpCompressionMiddleware, ACCEPTED_ENCODINGS, + HttpCompressionMiddleware, ) from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning +from scrapy.http import HtmlResponse, Request, Response from scrapy.responsetypes import responsetypes +from scrapy.spiders import Spider from scrapy.utils.gz import gunzip from scrapy.utils.test import get_crawler from tests import tests_datadir diff --git a/tests/test_downloadermiddleware_redirect.py b/tests/test_downloadermiddleware_redirect.py index e2ff9ec2b..dc15b672c 100644 --- a/tests/test_downloadermiddleware_redirect.py +++ b/tests/test_downloadermiddleware_redirect.py @@ -1,12 +1,12 @@ import unittest from scrapy.downloadermiddlewares.redirect import ( - RedirectMiddleware, MetaRefreshMiddleware, + RedirectMiddleware, ) -from scrapy.spiders import Spider from scrapy.exceptions import IgnoreRequest -from scrapy.http import Request, Response, HtmlResponse +from scrapy.http import HtmlResponse, Request, Response +from scrapy.spiders import Spider from scrapy.utils.test import get_crawler diff --git a/tests/test_downloadermiddleware_retry.py b/tests/test_downloadermiddleware_retry.py index cadd647ad..02854c2a7 100644 --- a/tests/test_downloadermiddleware_retry.py +++ b/tests/test_downloadermiddleware_retry.py @@ -12,7 +12,7 @@ from twisted.internet.error import ( ) from twisted.web.client import ResponseFailed -from scrapy.downloadermiddlewares.retry import get_retry_request, RetryMiddleware +from scrapy.downloadermiddlewares.retry import RetryMiddleware, get_retry_request from scrapy.exceptions import IgnoreRequest from scrapy.http import Request, Response from scrapy.spiders import Spider diff --git a/tests/test_downloadermiddleware_robotstxt.py b/tests/test_downloadermiddleware_robotstxt.py index ac08c6006..f98e0b12e 100644 --- a/tests/test_downloadermiddleware_robotstxt.py +++ b/tests/test_downloadermiddleware_robotstxt.py @@ -1,17 +1,16 @@ from unittest import mock -from twisted.internet import reactor, error +from twisted.internet import error, reactor from twisted.internet.defer import Deferred, DeferredList, maybeDeferred from twisted.python import failure from twisted.trial import unittest -from scrapy.downloadermiddlewares.robotstxt import ( - RobotsTxtMiddleware, - logger as mw_module_logger, -) + +from scrapy.downloadermiddlewares.robotstxt import RobotsTxtMiddleware +from scrapy.downloadermiddlewares.robotstxt import logger as mw_module_logger from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request, Response, TextResponse from scrapy.settings import Settings -from tests.test_robotstxt_interface import rerp_available, reppy_available +from tests.test_robotstxt_interface import reppy_available, rerp_available class RobotsTxtMiddlewareTest(unittest.TestCase): diff --git a/tests/test_downloadermiddleware_useragent.py b/tests/test_downloadermiddleware_useragent.py index 0702dd042..cad3dea5c 100644 --- a/tests/test_downloadermiddleware_useragent.py +++ b/tests/test_downloadermiddleware_useragent.py @@ -1,8 +1,8 @@ from unittest import TestCase -from scrapy.spiders import Spider -from scrapy.http import Request from scrapy.downloadermiddlewares.useragent import UserAgentMiddleware +from scrapy.http import Request +from scrapy.spiders import Spider from scrapy.utils.test import get_crawler diff --git a/tests/test_dupefilters.py b/tests/test_dupefilters.py index 4019012d1..aa0975555 100644 --- a/tests/test_dupefilters.py +++ b/tests/test_dupefilters.py @@ -1,14 +1,15 @@ import hashlib -import tempfile -import unittest import shutil import sys +import tempfile +import unittest from pathlib import Path + from testfixtures import LogCapture +from scrapy.core.scheduler import Scheduler from scrapy.dupefilters import RFPDupeFilter from scrapy.http import Request -from scrapy.core.scheduler import Scheduler from scrapy.utils.python import to_bytes from scrapy.utils.test import get_crawler from tests.spiders import SimpleSpider diff --git a/tests/test_engine.py b/tests/test_engine.py index 7ddb420ba..02b59f448 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -14,13 +14,13 @@ import re import subprocess import sys from collections import defaultdict +from dataclasses import dataclass from pathlib import Path from threading import Timer from urllib.parse import urlparse -from dataclasses import dataclass -import pytest import attr +import pytest from itemadapter import ItemAdapter from pydispatch import dispatcher from twisted.internet import defer, reactor @@ -31,12 +31,11 @@ from scrapy import signals from scrapy.core.engine import ExecutionEngine from scrapy.exceptions import CloseSpider, ScrapyDeprecationWarning from scrapy.http import Request -from scrapy.item import Item, Field +from scrapy.item import Field, Item from scrapy.linkextractors import LinkExtractor from scrapy.spiders import Spider from scrapy.utils.signal import disconnect_all from scrapy.utils.test import get_crawler - from tests import get_testdata, tests_datadir diff --git a/tests/test_engine_stop_download_bytes.py b/tests/test_engine_stop_download_bytes.py index fb8dd4313..8dbb5b7ea 100644 --- a/tests/test_engine_stop_download_bytes.py +++ b/tests/test_engine_stop_download_bytes.py @@ -2,14 +2,13 @@ from testfixtures import LogCapture from twisted.internet import defer from scrapy.exceptions import StopDownload - from tests.test_engine import ( AttrsItemsSpider, + CrawlerRun, DataClassItemsSpider, DictItemsSpider, - TestSpider, - CrawlerRun, EngineTest, + TestSpider, ) diff --git a/tests/test_engine_stop_download_headers.py b/tests/test_engine_stop_download_headers.py index 93437559d..0bad5ba55 100644 --- a/tests/test_engine_stop_download_headers.py +++ b/tests/test_engine_stop_download_headers.py @@ -2,14 +2,13 @@ from testfixtures import LogCapture from twisted.internet import defer from scrapy.exceptions import StopDownload - from tests.test_engine import ( AttrsItemsSpider, + CrawlerRun, DataClassItemsSpider, DictItemsSpider, - TestSpider, - CrawlerRun, EngineTest, + TestSpider, ) diff --git a/tests/test_exporters.py b/tests/test_exporters.py index 7689045b7..8e0999348 100644 --- a/tests/test_exporters.py +++ b/tests/test_exporters.py @@ -1,31 +1,31 @@ -import re +import dataclasses import json import marshal import pickle +import re import tempfile import unittest -import dataclasses -from io import BytesIO from datetime import datetime +from io import BytesIO from warnings import catch_warnings, filterwarnings import lxml.etree from itemadapter import ItemAdapter -from scrapy.item import Item, Field -from scrapy.utils.python import to_unicode from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.exporters import ( BaseItemExporter, - PprintItemExporter, - PickleItemExporter, CsvItemExporter, - XmlItemExporter, - JsonLinesItemExporter, JsonItemExporter, - PythonItemExporter, + JsonLinesItemExporter, MarshalItemExporter, + PickleItemExporter, + PprintItemExporter, + PythonItemExporter, + XmlItemExporter, ) +from scrapy.item import Field, Item +from scrapy.utils.python import to_unicode def custom_serializer(value): diff --git a/tests/test_extension_telnet.py b/tests/test_extension_telnet.py index e36c45d8e..9fd680e9f 100644 --- a/tests/test_extension_telnet.py +++ b/tests/test_extension_telnet.py @@ -1,7 +1,7 @@ -from twisted.trial import unittest from twisted.conch.telnet import ITelnetProtocol from twisted.cred import credentials from twisted.internet import defer +from twisted.trial import unittest from scrapy.extensions.telnet import TelnetConsole from scrapy.utils.test import get_crawler diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 09a4aa823..96f97ca99 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -19,7 +19,7 @@ from pathlib import Path from string import ascii_letters, digits from typing import Union from unittest import mock -from urllib.parse import urljoin, quote +from urllib.parse import quote, urljoin from urllib.request import pathname2url import lxml.etree @@ -35,7 +35,6 @@ import scrapy from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.exporters import CsvItemExporter, JsonItemExporter from scrapy.extensions.feedexport import ( - _FeedSlot, BlockingFeedStorage, FeedExporter, FileFeedStorage, @@ -44,15 +43,11 @@ from scrapy.extensions.feedexport import ( IFeedStorage, S3FeedStorage, StdoutFeedStorage, + _FeedSlot, ) from scrapy.settings import Settings from scrapy.utils.python import to_unicode -from scrapy.utils.test import ( - get_crawler, - mock_google_cloud_storage, - skip_if_no_boto, -) - +from scrapy.utils.test import get_crawler, mock_google_cloud_storage, skip_if_no_boto from tests.mockserver import MockFTPServer, MockServer from tests.spiders import ItemSpider diff --git a/tests/test_http2_client_protocol.py b/tests/test_http2_client_protocol.py index 88345d2bc..17a94f036 100644 --- a/tests/test_http2_client_protocol.py +++ b/tests/test_http2_client_protocol.py @@ -17,18 +17,19 @@ from twisted.internet.defer import ( ) from twisted.internet.endpoints import SSL4ClientEndpoint, SSL4ServerEndpoint from twisted.internet.error import TimeoutError -from twisted.internet.ssl import optionsForClientTLS, PrivateCertificate, Certificate +from twisted.internet.ssl import Certificate, PrivateCertificate, optionsForClientTLS from twisted.python.failure import Failure from twisted.trial.unittest import TestCase -from twisted.web.client import ResponseFailed, URI -from twisted.web.http import H2_ENABLED, Request as TxRequest -from twisted.web.server import Site, NOT_DONE_YET +from twisted.web.client import URI, ResponseFailed +from twisted.web.http import H2_ENABLED +from twisted.web.http import Request as TxRequest +from twisted.web.server import NOT_DONE_YET, Site from twisted.web.static import File -from scrapy.http import Request, Response, JsonRequest +from scrapy.http import JsonRequest, Request, Response from scrapy.settings import Settings from scrapy.spiders import Spider -from tests.mockserver import ssl_context_factory, LeafResource, Status +from tests.mockserver import LeafResource, Status, ssl_context_factory def generate_random_string(size): diff --git a/tests/test_http_cookies.py b/tests/test_http_cookies.py index ea42cadcd..9e43b72b0 100644 --- a/tests/test_http_cookies.py +++ b/tests/test_http_cookies.py @@ -1,5 +1,5 @@ -from urllib.parse import urlparse from unittest import TestCase +from urllib.parse import urlparse from scrapy.http import Request, Response from scrapy.http.cookies import WrappedRequest, WrappedResponse diff --git a/tests/test_http_headers.py b/tests/test_http_headers.py index 566bb302d..7db1eb8c5 100644 --- a/tests/test_http_headers.py +++ b/tests/test_http_headers.py @@ -1,5 +1,5 @@ -import unittest import copy +import unittest from scrapy.http import Headers diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 0c10b27a0..d02f11f0e 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -1,18 +1,18 @@ -import unittest -import re import json -import xmlrpc.client +import re +import unittest import warnings +import xmlrpc.client from unittest import mock from urllib.parse import parse_qs, unquote_to_bytes, urlparse from scrapy.http import ( - Request, FormRequest, - XmlRpcRequest, - JsonRequest, Headers, HtmlResponse, + JsonRequest, + Request, + XmlRpcRequest, ) from scrapy.utils.python import to_bytes, to_unicode diff --git a/tests/test_loader.py b/tests/test_loader.py index 9dd298864..5f4750ff3 100644 --- a/tests/test_loader.py +++ b/tests/test_loader.py @@ -1,12 +1,12 @@ -import unittest import dataclasses +import unittest import attr from itemadapter import ItemAdapter from itemloaders.processors import Compose, Identity, MapCompose, TakeFirst from scrapy.http import HtmlResponse, Response -from scrapy.item import Item, Field +from scrapy.item import Field, Item from scrapy.loader import ItemLoader from scrapy.selector import Selector diff --git a/tests/test_loader_deprecated.py b/tests/test_loader_deprecated.py index 8757db0ce..638af825b 100644 --- a/tests/test_loader_deprecated.py +++ b/tests/test_loader_deprecated.py @@ -16,7 +16,7 @@ from itemloaders.processors import ( TakeFirst, ) -from scrapy.item import Item, Field +from scrapy.item import Field, Item from scrapy.loader import ItemLoader from scrapy.loader.common import wrap_loader_context from scrapy.utils.deprecate import ScrapyDeprecationWarning diff --git a/tests/test_logformatter.py b/tests/test_logformatter.py index 11cf6d81a..0971a5a38 100644 --- a/tests/test_logformatter.py +++ b/tests/test_logformatter.py @@ -6,11 +6,11 @@ from twisted.python.failure import Failure from twisted.trial.unittest import TestCase as TwistedTestCase from scrapy.exceptions import DropItem -from scrapy.utils.test import get_crawler from scrapy.http import Request, Response -from scrapy.item import Item, Field +from scrapy.item import Field, Item from scrapy.logformatter import LogFormatter from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler from tests.mockserver import MockServer from tests.spiders import ItemSpider diff --git a/tests/test_mail.py b/tests/test_mail.py index 0ee0400cd..bc7298e9d 100644 --- a/tests/test_mail.py +++ b/tests/test_mail.py @@ -1,14 +1,15 @@ # coding=utf-8 import unittest -from io import BytesIO from email.charset import Charset +from io import BytesIO +from twisted import version as twisted_version +from twisted.internet import defer from twisted.internet._sslverify import ClientTLSOptions from twisted.internet.ssl import ClientContextFactory from twisted.python.versions import Version -from twisted.internet import defer -from twisted import version as twisted_version + from scrapy.mail import MailSender diff --git a/tests/test_middleware.py b/tests/test_middleware.py index a84cf4c28..00ff746ee 100644 --- a/tests/test_middleware.py +++ b/tests/test_middleware.py @@ -1,8 +1,8 @@ from twisted.trial import unittest -from scrapy.settings import Settings from scrapy.exceptions import NotConfigured from scrapy.middleware import MiddlewareManager +from scrapy.settings import Settings class M1: diff --git a/tests/test_pipeline_crawl.py b/tests/test_pipeline_crawl.py index b04da22be..8f5d87ebf 100644 --- a/tests/test_pipeline_crawl.py +++ b/tests/test_pipeline_crawl.py @@ -6,8 +6,8 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase from w3lib.url import add_or_replace_parameter -from scrapy.crawler import CrawlerRunner from scrapy import signals +from scrapy.crawler import CrawlerRunner from tests.mockserver import MockServer from tests.spiders import SimpleSpider diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 43942e53e..13de042a4 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -1,3 +1,4 @@ +import dataclasses import os import random import time @@ -8,7 +9,6 @@ from shutil import rmtree from tempfile import mkdtemp from unittest import mock from urllib.parse import urlparse -import dataclasses import attr from itemadapter import ItemAdapter diff --git a/tests/test_pipeline_images.py b/tests/test_pipeline_images.py index 38a2d6c41..a5a495393 100644 --- a/tests/test_pipeline_images.py +++ b/tests/test_pipeline_images.py @@ -18,7 +18,6 @@ from scrapy.pipelines.images import ImageException, ImagesPipeline, NoimagesDrop from scrapy.settings import Settings from scrapy.utils.python import to_bytes - try: from PIL import Image except ImportError: diff --git a/tests/test_pipeline_media.py b/tests/test_pipeline_media.py index 87ab03395..e6d8ed2a2 100644 --- a/tests/test_pipeline_media.py +++ b/tests/test_pipeline_media.py @@ -1,25 +1,24 @@ -from typing import Optional import io +from typing import Optional from testfixtures import LogCapture -from twisted.trial import unittest -from twisted.python.failure import Failure from twisted.internet import reactor from twisted.internet.defer import Deferred, inlineCallbacks +from twisted.python.failure import Failure +from twisted.trial import unittest from scrapy import signals from scrapy.http import Request, Response -from scrapy.settings import Settings -from scrapy.spiders import Spider from scrapy.pipelines.files import FileException from scrapy.pipelines.images import ImagesPipeline from scrapy.pipelines.media import MediaPipeline +from scrapy.settings import Settings +from scrapy.spiders import Spider from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.log import failure_to_exc_info from scrapy.utils.signal import disconnect_all from scrapy.utils.test import get_crawler - try: from PIL import Image # noqa: imported just to check for the import error except ImportError: diff --git a/tests/test_pipelines.py b/tests/test_pipelines.py index 7b905d321..5ab288c1a 100644 --- a/tests/test_pipelines.py +++ b/tests/test_pipelines.py @@ -5,10 +5,9 @@ from twisted.internet import defer from twisted.internet.defer import Deferred from twisted.trial import unittest -from scrapy import Spider, signals, Request -from scrapy.utils.defer import maybe_deferred_to_future, deferred_to_future +from scrapy import Request, Spider, signals +from scrapy.utils.defer import deferred_to_future, maybe_deferred_to_future from scrapy.utils.test import get_crawler, get_from_asyncio_queue - from tests.mockserver import MockServer diff --git a/tests/test_pqueues.py b/tests/test_pqueues.py index 96a64c19d..1584014b8 100644 --- a/tests/test_pqueues.py +++ b/tests/test_pqueues.py @@ -4,11 +4,10 @@ import unittest import queuelib from scrapy.http.request import Request -from scrapy.pqueues import ScrapyPriorityQueue, DownloaderAwarePriorityQueue +from scrapy.pqueues import DownloaderAwarePriorityQueue, ScrapyPriorityQueue from scrapy.spiders import Spider from scrapy.squeues import FifoMemoryQueue from scrapy.utils.test import get_crawler - from tests.test_scheduler import MockDownloader, MockEngine diff --git a/tests/test_proxy_connect.py b/tests/test_proxy_connect.py index 5aeae7546..c05f4da91 100644 --- a/tests/test_proxy_connect.py +++ b/tests/test_proxy_connect.py @@ -3,15 +3,15 @@ import os import re import sys from pathlib import Path -from subprocess import Popen, PIPE +from subprocess import PIPE, Popen from urllib.parse import urlsplit, urlunsplit + from testfixtures import LogCapture from twisted.internet import defer from twisted.trial.unittest import TestCase from scrapy.http import Request from scrapy.utils.test import get_crawler - from tests.mockserver import MockServer from tests.spiders import SimpleSpider, SingleRequestSpider diff --git a/tests/test_request_attribute_binding.py b/tests/test_request_attribute_binding.py index 17c0309d1..d65d74206 100644 --- a/tests/test_request_attribute_binding.py +++ b/tests/test_request_attribute_binding.py @@ -1,16 +1,13 @@ +from testfixtures import LogCapture from twisted.internet import defer from twisted.trial.unittest import TestCase -from testfixtures import LogCapture - from scrapy import Request, signals from scrapy.http.response import Response from scrapy.utils.test import get_crawler - from tests.mockserver import MockServer from tests.spiders import SingleRequestSpider - OVERRIDDEN_URL = "https://example.org" diff --git a/tests/test_request_cb_kwargs.py b/tests/test_request_cb_kwargs.py index 454b68942..577522c6c 100644 --- a/tests/test_request_cb_kwargs.py +++ b/tests/test_request_cb_kwargs.py @@ -4,8 +4,8 @@ from twisted.trial.unittest import TestCase from scrapy.http import Request from scrapy.utils.test import get_crawler -from tests.spiders import MockServerSpider from tests.mockserver import MockServer +from tests.spiders import MockServerSpider class InjectArgumentsDownloaderMiddleware: diff --git a/tests/test_request_dict.py b/tests/test_request_dict.py index d9067610e..8665a9205 100644 --- a/tests/test_request_dict.py +++ b/tests/test_request_dict.py @@ -3,7 +3,7 @@ import unittest import warnings from contextlib import suppress -from scrapy import Spider, Request +from scrapy import Request, Spider from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.http import FormRequest, JsonRequest from scrapy.utils.request import request_from_dict @@ -171,10 +171,8 @@ class DeprecatedMethodsRequestSerializationTest(RequestSerializationTest): "scrapy.utils.reqser" ] # delete module to reset the deprecation warning - from scrapy.utils.reqser import ( - request_from_dict as _from_dict, - request_to_dict as _to_dict, - ) + from scrapy.utils.reqser import request_from_dict as _from_dict + from scrapy.utils.reqser import request_to_dict as _to_dict request_copy = _from_dict(_to_dict(request, spider), spider) self._assert_same_request(request, request_copy) diff --git a/tests/test_request_left.py b/tests/test_request_left.py index d08ed0f68..54155f7ef 100644 --- a/tests/test_request_left.py +++ b/tests/test_request_left.py @@ -1,5 +1,6 @@ from twisted.internet import defer from twisted.trial.unittest import TestCase + from scrapy.signals import request_left_downloader from scrapy.spiders import Spider from scrapy.utils.test import get_crawler diff --git a/tests/test_responsetypes.py b/tests/test_responsetypes.py index 57484a2a1..859960518 100644 --- a/tests/test_responsetypes.py +++ b/tests/test_responsetypes.py @@ -1,7 +1,7 @@ import unittest -from scrapy.responsetypes import responsetypes -from scrapy.http import Response, TextResponse, XmlResponse, HtmlResponse, Headers +from scrapy.http import Headers, HtmlResponse, Response, TextResponse, XmlResponse +from scrapy.responsetypes import responsetypes class ResponseTypesTest(unittest.TestCase): diff --git a/tests/test_scheduler.py b/tests/test_scheduler.py index 67728321d..5acc412e5 100644 --- a/tests/test_scheduler.py +++ b/tests/test_scheduler.py @@ -1,21 +1,20 @@ +import collections import shutil import tempfile import unittest -import collections from twisted.internet import defer from twisted.trial.unittest import TestCase -from scrapy.crawler import Crawler from scrapy.core.downloader import Downloader from scrapy.core.scheduler import Scheduler +from scrapy.crawler import Crawler from scrapy.http import Request from scrapy.spiders import Spider from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.test import get_crawler from tests.mockserver import MockServer - MockEngine = collections.namedtuple("MockEngine", ["downloader"]) MockSlot = collections.namedtuple("MockSlot", ["active"]) diff --git a/tests/test_selector.py b/tests/test_selector.py index ad72e068d..febae46ac 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -2,7 +2,7 @@ import weakref from twisted.trial import unittest -from scrapy.http import TextResponse, HtmlResponse, XmlResponse +from scrapy.http import HtmlResponse, TextResponse, XmlResponse from scrapy.selector import Selector diff --git a/tests/test_settings/__init__.py b/tests/test_settings/__init__.py index 9a01fd433..2a3b2d529 100644 --- a/tests/test_settings/__init__.py +++ b/tests/test_settings/__init__.py @@ -2,12 +2,13 @@ import unittest from unittest import mock from scrapy.settings import ( + SETTINGS_PRIORITIES, BaseSettings, Settings, SettingsAttribute, - SETTINGS_PRIORITIES, get_settings_priority, ) + from . import default_settings diff --git a/tests/test_signals.py b/tests/test_signals.py index 4c6ffabdc..0df104600 100644 --- a/tests/test_signals.py +++ b/tests/test_signals.py @@ -2,9 +2,8 @@ from pytest import mark from twisted.internet import defer from twisted.trial import unittest -from scrapy import signals, Request, Spider +from scrapy import Request, Spider, signals from scrapy.utils.test import get_crawler, get_from_asyncio_queue - from tests.mockserver import MockServer diff --git a/tests/test_spider.py b/tests/test_spider.py index 540091516..eb8a1f9f0 100644 --- a/tests/test_spider.py +++ b/tests/test_spider.py @@ -6,21 +6,21 @@ from unittest import mock from testfixtures import LogCapture from twisted.trial import unittest - from w3lib.url import safe_url_string + from scrapy import signals +from scrapy.http import HtmlResponse, Request, Response, TextResponse, XmlResponse +from scrapy.linkextractors import LinkExtractor from scrapy.settings import Settings -from scrapy.http import Request, Response, TextResponse, XmlResponse, HtmlResponse -from scrapy.spiders.init import InitSpider from scrapy.spiders import ( - CSVFeedSpider, CrawlSpider, + CSVFeedSpider, Rule, SitemapSpider, Spider, XMLFeedSpider, ) -from scrapy.linkextractors import LinkExtractor +from scrapy.spiders.init import InitSpider from scrapy.utils.test import get_crawler from tests import get_testdata diff --git a/tests/test_spiderloader/__init__.py b/tests/test_spiderloader/__init__.py index 3745355a0..da656303d 100644 --- a/tests/test_spiderloader/__init__.py +++ b/tests/test_spiderloader/__init__.py @@ -1,21 +1,20 @@ -import sys import shutil +import sys +import tempfile import warnings from pathlib import Path -import tempfile -from zope.interface.verify import verifyObject from twisted.trial import unittest - +from zope.interface.verify import verifyObject # ugly hack to avoid cyclic imports of scrapy.spiders when running this test # alone import scrapy -from scrapy.interfaces import ISpiderLoader -from scrapy.spiderloader import SpiderLoader -from scrapy.settings import Settings -from scrapy.http import Request from scrapy.crawler import CrawlerRunner +from scrapy.http import Request +from scrapy.interfaces import ISpiderLoader +from scrapy.settings import Settings +from scrapy.spiderloader import SpiderLoader module_dir = Path(__file__).resolve().parent diff --git a/tests/test_spidermiddleware.py b/tests/test_spidermiddleware.py index 760ee43df..974a0023d 100644 --- a/tests/test_spidermiddleware.py +++ b/tests/test_spidermiddleware.py @@ -4,16 +4,16 @@ from unittest import mock from testfixtures import LogCapture from twisted.internet import defer -from twisted.trial.unittest import TestCase from twisted.python.failure import Failure +from twisted.trial.unittest import TestCase -from scrapy.spiders import Spider -from scrapy.http import Request, Response +from scrapy.core.spidermw import SpiderMiddlewareManager from scrapy.exceptions import _InvalidOutput +from scrapy.http import Request, Response +from scrapy.spiders import Spider from scrapy.utils.asyncgen import collect_asyncgen from scrapy.utils.defer import deferred_from_coro, maybe_deferred_to_future from scrapy.utils.test import get_crawler -from scrapy.core.spidermw import SpiderMiddlewareManager class SpiderMiddlewareTestCase(TestCase): diff --git a/tests/test_spidermiddleware_depth.py b/tests/test_spidermiddleware_depth.py index af17c13a0..e359d9cfc 100644 --- a/tests/test_spidermiddleware_depth.py +++ b/tests/test_spidermiddleware_depth.py @@ -1,7 +1,7 @@ from unittest import TestCase +from scrapy.http import Request, Response from scrapy.spidermiddlewares.depth import DepthMiddleware -from scrapy.http import Response, Request from scrapy.spiders import Spider from scrapy.statscollectors import StatsCollector from scrapy.utils.test import get_crawler diff --git a/tests/test_spidermiddleware_httperror.py b/tests/test_spidermiddleware_httperror.py index faa8e9091..1d5a887cc 100644 --- a/tests/test_spidermiddleware_httperror.py +++ b/tests/test_spidermiddleware_httperror.py @@ -2,14 +2,14 @@ import logging from unittest import TestCase from testfixtures import LogCapture -from twisted.trial.unittest import TestCase as TrialTestCase from twisted.internet import defer +from twisted.trial.unittest import TestCase as TrialTestCase -from scrapy.utils.test import get_crawler -from scrapy.http import Response, Request -from scrapy.spiders import Spider -from scrapy.spidermiddlewares.httperror import HttpErrorMiddleware, HttpError +from scrapy.http import Request, Response from scrapy.settings import Settings +from scrapy.spidermiddlewares.httperror import HttpError, HttpErrorMiddleware +from scrapy.spiders import Spider +from scrapy.utils.test import get_crawler from tests.mockserver import MockServer from tests.spiders import MockServerSpider diff --git a/tests/test_spidermiddleware_offsite.py b/tests/test_spidermiddleware_offsite.py index 380bafe04..ea45b7698 100644 --- a/tests/test_spidermiddleware_offsite.py +++ b/tests/test_spidermiddleware_offsite.py @@ -1,10 +1,10 @@ +import warnings from unittest import TestCase from urllib.parse import urlparse -import warnings -from scrapy.http import Response, Request +from scrapy.http import Request, Response +from scrapy.spidermiddlewares.offsite import OffsiteMiddleware, PortWarning, URLWarning from scrapy.spiders import Spider -from scrapy.spidermiddlewares.offsite import OffsiteMiddleware, URLWarning, PortWarning from scrapy.utils.test import get_crawler diff --git a/tests/test_spidermiddleware_referer.py b/tests/test_spidermiddleware_referer.py index dad39b6ee..1bc5ccb9a 100644 --- a/tests/test_spidermiddleware_referer.py +++ b/tests/test_spidermiddleware_referer.py @@ -1,17 +1,11 @@ -from urllib.parse import urlparse -from unittest import TestCase import warnings -from scrapy.http import Response, Request +from unittest import TestCase +from urllib.parse import urlparse -from scrapy.settings import Settings -from scrapy.spiders import Spider from scrapy.downloadermiddlewares.redirect import RedirectMiddleware +from scrapy.http import Request, Response +from scrapy.settings import Settings from scrapy.spidermiddlewares.referer import ( - DefaultReferrerPolicy, - NoReferrerPolicy, - NoReferrerWhenDowngradePolicy, - OriginPolicy, - OriginWhenCrossOriginPolicy, POLICY_NO_REFERRER, POLICY_NO_REFERRER_WHEN_DOWNGRADE, POLICY_ORIGIN, @@ -21,6 +15,11 @@ from scrapy.spidermiddlewares.referer import ( POLICY_STRICT_ORIGIN, POLICY_STRICT_ORIGIN_WHEN_CROSS_ORIGIN, POLICY_UNSAFE_URL, + DefaultReferrerPolicy, + NoReferrerPolicy, + NoReferrerWhenDowngradePolicy, + OriginPolicy, + OriginWhenCrossOriginPolicy, RefererMiddleware, ReferrerPolicy, SameOriginPolicy, @@ -28,6 +27,7 @@ from scrapy.spidermiddlewares.referer import ( StrictOriginWhenCrossOriginPolicy, UnsafeUrlPolicy, ) +from scrapy.spiders import Spider class TestRefererMiddleware(TestCase): diff --git a/tests/test_spidermiddleware_urllength.py b/tests/test_spidermiddleware_urllength.py index 22716bdda..9111e4c82 100644 --- a/tests/test_spidermiddleware_urllength.py +++ b/tests/test_spidermiddleware_urllength.py @@ -2,11 +2,11 @@ from unittest import TestCase from testfixtures import LogCapture +from scrapy.http import Request, Response +from scrapy.settings import Settings from scrapy.spidermiddlewares.urllength import UrlLengthMiddleware -from scrapy.http import Response, Request from scrapy.spiders import Spider from scrapy.utils.test import get_crawler -from scrapy.settings import Settings class TestUrlLengthMiddleware(TestCase): diff --git a/tests/test_spiderstate.py b/tests/test_spiderstate.py index 5c6dccf11..f645f4cce 100644 --- a/tests/test_spiderstate.py +++ b/tests/test_spiderstate.py @@ -1,11 +1,12 @@ +import shutil from datetime import datetime from pathlib import Path -import shutil + from twisted.trial import unittest +from scrapy.exceptions import NotConfigured from scrapy.extensions.spiderstate import SpiderState from scrapy.spiders import Spider -from scrapy.exceptions import NotConfigured from scrapy.utils.test import get_crawler diff --git a/tests/test_squeues.py b/tests/test_squeues.py index 0e2441f90..1586f90c5 100644 --- a/tests/test_squeues.py +++ b/tests/test_squeues.py @@ -2,16 +2,17 @@ import pickle import sys from queuelib.tests import test_queue as t + +from scrapy.http import Request +from scrapy.item import Field, Item +from scrapy.loader import ItemLoader +from scrapy.selector import Selector from scrapy.squeues import ( _MarshalFifoSerializationDiskQueue, _MarshalLifoSerializationDiskQueue, _PickleFifoSerializationDiskQueue, _PickleLifoSerializationDiskQueue, ) -from scrapy.item import Item, Field -from scrapy.http import Request -from scrapy.loader import ItemLoader -from scrapy.selector import Selector class TestItem(Item): diff --git a/tests/test_squeues_request.py b/tests/test_squeues_request.py index 5d9001bb0..b444c32b7 100644 --- a/tests/test_squeues_request.py +++ b/tests/test_squeues_request.py @@ -4,16 +4,16 @@ import unittest import queuelib -from scrapy.squeues import ( - PickleFifoDiskQueue, - PickleLifoDiskQueue, - MarshalFifoDiskQueue, - MarshalLifoDiskQueue, - FifoMemoryQueue, - LifoMemoryQueue, -) from scrapy.http import Request from scrapy.spiders import Spider +from scrapy.squeues import ( + FifoMemoryQueue, + LifoMemoryQueue, + MarshalFifoDiskQueue, + MarshalLifoDiskQueue, + PickleFifoDiskQueue, + PickleLifoDiskQueue, +) from scrapy.utils.test import get_crawler """ diff --git a/tests/test_stats.py b/tests/test_stats.py index 2ee04429a..7a8adf638 100644 --- a/tests/test_stats.py +++ b/tests/test_stats.py @@ -1,10 +1,10 @@ -from datetime import datetime import unittest +from datetime import datetime from unittest import mock from scrapy.extensions.corestats import CoreStats from scrapy.spiders import Spider -from scrapy.statscollectors import StatsCollector, DummyStatsCollector +from scrapy.statscollectors import DummyStatsCollector, StatsCollector from scrapy.utils.test import get_crawler diff --git a/tests/test_toplevel.py b/tests/test_toplevel.py index 9a4eeb04e..d272101b8 100644 --- a/tests/test_toplevel.py +++ b/tests/test_toplevel.py @@ -11,7 +11,7 @@ class ToplevelTestCase(TestCase): self.assertIs(type(scrapy.version_info), tuple) def test_request_shortcut(self): - from scrapy.http import Request, FormRequest + from scrapy.http import FormRequest, Request self.assertIs(scrapy.Request, Request) self.assertIs(scrapy.FormRequest, FormRequest) @@ -27,7 +27,7 @@ class ToplevelTestCase(TestCase): self.assertIs(scrapy.Selector, Selector) def test_item_shortcut(self): - from scrapy.item import Item, Field + from scrapy.item import Field, Item self.assertIs(scrapy.Item, Item) self.assertIs(scrapy.Field, Field) diff --git a/tests/test_urlparse_monkeypatches.py b/tests/test_urlparse_monkeypatches.py index 3b6428686..c695968d7 100644 --- a/tests/test_urlparse_monkeypatches.py +++ b/tests/test_urlparse_monkeypatches.py @@ -1,5 +1,5 @@ -from urllib.parse import urlparse import unittest +from urllib.parse import urlparse class UrlparseTestCase(unittest.TestCase): diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index d09335651..746731a2e 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -3,7 +3,7 @@ from unittest import TestCase from pytest import mark -from scrapy.utils.reactor import is_asyncio_reactor_installed, install_reactor +from scrapy.utils.reactor import install_reactor, is_asyncio_reactor_installed @mark.usefixtures("reactor_pytest") diff --git a/tests/test_utils_conf.py b/tests/test_utils_conf.py index 61a683318..78ed9a7c9 100644 --- a/tests/test_utils_conf.py +++ b/tests/test_utils_conf.py @@ -1,7 +1,7 @@ import unittest import warnings -from scrapy.exceptions import UsageError, ScrapyDeprecationWarning +from scrapy.exceptions import ScrapyDeprecationWarning, UsageError from scrapy.settings import BaseSettings, Settings from scrapy.utils.conf import ( arglist_to_dict, diff --git a/tests/test_utils_datatypes.py b/tests/test_utils_datatypes.py index 0c86c7e7a..b6a84ee91 100644 --- a/tests/test_utils_datatypes.py +++ b/tests/test_utils_datatypes.py @@ -11,7 +11,6 @@ from scrapy.utils.datatypes import ( ) from scrapy.utils.python import garbage_collect - __doctests__ = ["scrapy.utils.datatypes"] diff --git a/tests/test_utils_defer.py b/tests/test_utils_defer.py index 8d7f33c9a..bb0ebc2a4 100644 --- a/tests/test_utils_defer.py +++ b/tests/test_utils_defer.py @@ -1,11 +1,11 @@ import random from pytest import mark -from twisted.trial import unittest -from twisted.internet import reactor, defer +from twisted.internet import defer, reactor from twisted.python.failure import Failure +from twisted.trial import unittest -from scrapy.utils.asyncgen import collect_asyncgen, as_async_generator +from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.defer import ( aiter_errback, deferred_f_from_coro_f, diff --git a/tests/test_utils_deprecate.py b/tests/test_utils_deprecate.py index 214deceb2..2d9210410 100644 --- a/tests/test_utils_deprecate.py +++ b/tests/test_utils_deprecate.py @@ -1,7 +1,7 @@ import inspect import unittest -from unittest import mock import warnings +from unittest import mock from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.deprecate import create_deprecated_class, update_classpath diff --git a/tests/test_utils_display.py b/tests/test_utils_display.py index da61f4b0b..d1bf64828 100644 --- a/tests/test_utils_display.py +++ b/tests/test_utils_display.py @@ -1,6 +1,5 @@ from io import StringIO - -from unittest import mock, TestCase +from unittest import TestCase, mock from scrapy.utils.display import pformat, pprint diff --git a/tests/test_utils_gz.py b/tests/test_utils_gz.py index a34664956..6b2a458bc 100644 --- a/tests/test_utils_gz.py +++ b/tests/test_utils_gz.py @@ -3,11 +3,10 @@ from pathlib import Path from w3lib.encoding import html_to_unicode -from scrapy.utils.gz import gunzip, gzip_magic_number from scrapy.http import Response +from scrapy.utils.gz import gunzip, gzip_magic_number from tests import tests_datadir - SAMPLEDIR = Path(tests_datadir, "compressed") diff --git a/tests/test_utils_iterators.py b/tests/test_utils_iterators.py index 893582a32..ed077440c 100644 --- a/tests/test_utils_iterators.py +++ b/tests/test_utils_iterators.py @@ -1,8 +1,8 @@ from pytest import mark from twisted.trial import unittest -from scrapy.utils.iterators import csviter, xmliter, _body_or_str, xmliter_lxml -from scrapy.http import XmlResponse, TextResponse, Response +from scrapy.http import Response, TextResponse, XmlResponse +from scrapy.utils.iterators import _body_or_str, csviter, xmliter, xmliter_lxml from tests import get_testdata diff --git a/tests/test_utils_log.py b/tests/test_utils_log.py index 438dd0cdc..eae744df5 100644 --- a/tests/test_utils_log.py +++ b/tests/test_utils_log.py @@ -1,18 +1,18 @@ -import sys import logging +import sys import unittest from testfixtures import LogCapture from twisted.python.failure import Failure +from scrapy.extensions import telnet from scrapy.utils.log import ( - failure_to_exc_info, - TopLevelFormatter, LogCounterHandler, StreamLogger, + TopLevelFormatter, + failure_to_exc_info, ) from scrapy.utils.test import get_crawler -from scrapy.extensions import telnet class FailureToExcInfoTest(unittest.TestCase): diff --git a/tests/test_utils_misc/__init__.py b/tests/test_utils_misc/__init__.py index 38a61036c..69793ee75 100644 --- a/tests/test_utils_misc/__init__.py +++ b/tests/test_utils_misc/__init__.py @@ -1,10 +1,10 @@ -import sys import os +import sys import unittest from pathlib import Path from unittest import mock -from scrapy.item import Item, Field +from scrapy.item import Field, Item from scrapy.utils.misc import ( arg_to_iter, create_instance, @@ -14,7 +14,6 @@ from scrapy.utils.misc import ( walk_modules, ) - __doctests__ = ["scrapy.utils.misc"] diff --git a/tests/test_utils_project.py b/tests/test_utils_project.py index b08e5f475..90bd350a5 100644 --- a/tests/test_utils_project.py +++ b/tests/test_utils_project.py @@ -1,8 +1,8 @@ -import unittest -import os -import tempfile -import shutil import contextlib +import os +import shutil +import tempfile +import unittest import warnings from pathlib import Path diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 5caa5b8f2..fbf60ca71 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -5,20 +5,19 @@ import platform from twisted.trial import unittest from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen -from scrapy.utils.defer import deferred_f_from_coro_f, aiter_errback +from scrapy.utils.defer import aiter_errback, deferred_f_from_coro_f from scrapy.utils.python import ( - memoizemethod_noargs, + MutableAsyncChain, + MutableChain, binary_is_text, equal_attributes, get_func_args, + memoizemethod_noargs, to_bytes, to_unicode, without_none_values, - MutableChain, - MutableAsyncChain, ) - __doctests__ = ["scrapy.utils.python"] diff --git a/tests/test_utils_response.py b/tests/test_utils_response.py index d82aa19c6..80e15a60f 100644 --- a/tests/test_utils_response.py +++ b/tests/test_utils_response.py @@ -4,17 +4,16 @@ from pathlib import Path from urllib.parse import urlparse from scrapy.exceptions import ScrapyDeprecationWarning -from scrapy.http import Response, TextResponse, HtmlResponse +from scrapy.http import HtmlResponse, Response, TextResponse from scrapy.utils.python import to_bytes from scrapy.utils.response import ( - response_httprepr, - open_in_browser, - get_meta_refresh, get_base_url, + get_meta_refresh, + open_in_browser, + response_httprepr, response_status_message, ) - __doctests__ = ["scrapy.utils.response"] diff --git a/tests/test_utils_serialize.py b/tests/test_utils_serialize.py index 20aebc2d7..5cdcc7f7c 100644 --- a/tests/test_utils_serialize.py +++ b/tests/test_utils_serialize.py @@ -1,7 +1,7 @@ +import dataclasses import datetime import json import unittest -import dataclasses from decimal import Decimal import attr diff --git a/tests/test_utils_spider.py b/tests/test_utils_spider.py index 6fb7b8b82..460ae40c3 100644 --- a/tests/test_utils_spider.py +++ b/tests/test_utils_spider.py @@ -3,7 +3,7 @@ import unittest from scrapy import Spider from scrapy.http import Request from scrapy.item import Item -from scrapy.utils.spider import iterate_spider_output, iter_spider_classes +from scrapy.utils.spider import iter_spider_classes, iterate_spider_output class MySpider1(Spider): diff --git a/tests/test_utils_template.py b/tests/test_utils_template.py index 45e23f793..c79a1fdce 100644 --- a/tests/test_utils_template.py +++ b/tests/test_utils_template.py @@ -1,9 +1,9 @@ +import unittest from pathlib import Path from shutil import rmtree from tempfile import mkdtemp -import unittest -from scrapy.utils.template import render_templatefile +from scrapy.utils.template import render_templatefile __doctests__ = ["scrapy.utils.template"] diff --git a/tests/test_utils_url.py b/tests/test_utils_url.py index 9133663d9..65522f0fd 100644 --- a/tests/test_utils_url.py +++ b/tests/test_utils_url.py @@ -4,13 +4,13 @@ from scrapy.linkextractors import IGNORED_EXTENSIONS from scrapy.spiders import Spider from scrapy.utils.misc import arg_to_iter from scrapy.utils.url import ( + _is_filesystem_path, add_http_if_no_scheme, guess_scheme, - _is_filesystem_path, strip_url, + url_has_any_extension, url_is_from_any_domain, url_is_from_spider, - url_has_any_extension, ) __doctests__ = ["scrapy.utils.url"] diff --git a/tests/test_webclient.py b/tests/test_webclient.py index aadfe0f40..0042fe8f0 100644 --- a/tests/test_webclient.py +++ b/tests/test_webclient.py @@ -6,9 +6,9 @@ import shutil from pathlib import Path import OpenSSL.SSL +from twisted.internet import defer, reactor from twisted.trial import unittest -from twisted.web import server, static, util, resource -from twisted.internet import reactor, defer +from twisted.web import resource, server, static, util try: from twisted.internet.testing import StringTransport @@ -16,12 +16,13 @@ except ImportError: # deprecated in Twisted 19.7.0 # (remove once we bump our requirement past that version) from twisted.test.proto_helpers import StringTransport -from twisted.protocols.policies import WrappingFactory + from twisted.internet.defer import inlineCallbacks +from twisted.protocols.policies import WrappingFactory from scrapy.core.downloader import webclient as client from scrapy.core.downloader.contextfactory import ScrapyClientContextFactory -from scrapy.http import Request, Headers +from scrapy.http import Headers, Request from scrapy.settings import Settings from scrapy.utils.misc import create_instance from scrapy.utils.python import to_bytes, to_unicode From 7f01e1f0ce106bf810501d53217730b754d35edf Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Wed, 25 Jan 2023 14:43:25 -0600 Subject: [PATCH 367/532] added isort to pre-commit-config --- .pre-commit-config.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index b93a73453..d67249371 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,3 +17,7 @@ repos: rev: 22.12.0 hooks: - id: black +- repo: https://github.com/pycqa/isort + rev: 5.11.3 + hooks: + - id: isort From 0a21a9457b7aeafef3b9ee1c0206546d6c8fb294 Mon Sep 17 00:00:00 2001 From: Alex Date: Thu, 26 Jan 2023 00:50:29 -0800 Subject: [PATCH 368/532] fixed mypy typing error --- scrapy/pipelines/files.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index f9dfa53e3..94b0b1b70 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -37,7 +37,7 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) -def _to_string(path: Union[str, PathLike]): +def _to_string(path: Union[str, PathLike]) -> str: return str(path) # convert a Path object to string From 3054235dc09b1667c5c897f976eafa18845283e1 Mon Sep 17 00:00:00 2001 From: Cj Malone Date: Thu, 26 Jan 2023 16:10:57 +0000 Subject: [PATCH 369/532] Don't check robotstxt for local files --- scrapy/downloadermiddlewares/robotstxt.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scrapy/downloadermiddlewares/robotstxt.py b/scrapy/downloadermiddlewares/robotstxt.py index 326c35290..8e9beeeef 100644 --- a/scrapy/downloadermiddlewares/robotstxt.py +++ b/scrapy/downloadermiddlewares/robotstxt.py @@ -38,6 +38,8 @@ class RobotsTxtMiddleware: def process_request(self, request, spider): if request.meta.get("dont_obey_robotstxt"): return + if request.url.startswith("data:") or request.url.startswith("file:"): + return d = maybeDeferred(self.robot_parser, request, spider) d.addCallback(self.process_request_2, request, spider) return d From 33b85a9e2a379b355398e2daf416130bb840167d Mon Sep 17 00:00:00 2001 From: Cj Malone Date: Thu, 26 Jan 2023 19:51:20 +0000 Subject: [PATCH 370/532] Test local files aren't processed --- tests/test_downloadermiddleware_robotstxt.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/tests/test_downloadermiddleware_robotstxt.py b/tests/test_downloadermiddleware_robotstxt.py index ac08c6006..fd27e637d 100644 --- a/tests/test_downloadermiddleware_robotstxt.py +++ b/tests/test_downloadermiddleware_robotstxt.py @@ -214,6 +214,19 @@ Disallow: /some/randome/page.html middleware.process_request_2(rp, Request("http://site.local/allowed"), None) rp.allowed.assert_called_once_with("http://site.local/allowed", "Examplebot") + def test_robotstxt_local_file(self): + middleware = RobotsTxtMiddleware(self._get_emptybody_crawler()) + assert not middleware.process_request( + Request("data:text/plain,Hello World data"), None + ) + assert not middleware.process_request( + Request("file:///tests/sample_data/test_site/nothinghere.html"), None + ) + assert isinstance( + middleware.process_request(Request("http://site.local/allowed"), None), + Deferred, + ) + def assertNotIgnored(self, request, middleware): spider = None # not actually used dfd = maybeDeferred(middleware.process_request, request, spider) From 94161d101cd47d2dac4be7e8325a24f0ddea86cf Mon Sep 17 00:00:00 2001 From: Alex Date: Thu, 26 Jan 2023 16:41:06 -0800 Subject: [PATCH 371/532] update --- scrapy/pipelines/files.py | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 6a32c8b47..afa237b3d 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -36,7 +36,7 @@ from scrapy.utils.request import referer_str logger = logging.getLogger(__name__) -def _to_string(path: Union[str, os.PathLike[str]]): +def _to_string(path: Union[str, os.PathLike]) -> str: return str(path) # convert a Path object to string @@ -45,10 +45,10 @@ class FileException(Exception): class FSFilesStore: - def __init__(self, basedir: Union[str, os.PathLike[str]]): + def __init__(self, basedir: Union[str, os.PathLike]): basedir = _to_string(basedir) - if '://' in basedir: - basedir = basedir.split('://', 1)[1] + if "://" in basedir: + basedir = basedir.split("://", 1)[1] self.basedir = basedir self._mkdir(Path(self.basedir)) self.created_directories: DefaultDict[str, Set[str]] = defaultdict(set) @@ -70,7 +70,7 @@ class FSFilesStore: return {'last_modified': last_modified, 'checksum': checksum} - def _get_filesystem_path(self, path: Union[str, os.PathLike[str]]) -> Path: + def _get_filesystem_path(self, path: Union[str, os.PathLike]) -> Path: path_comps = _to_string(path).split('/') return Path(self.basedir, *path_comps) From a1e2fbafdcaae9b70cf7c4216c5cb80d1df5268e Mon Sep 17 00:00:00 2001 From: Alex Date: Thu, 26 Jan 2023 16:46:08 -0800 Subject: [PATCH 372/532] applied black to tests --- tests/test_pipeline_files.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 76c16e57f..1e00e6d1d 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -484,19 +484,18 @@ class FilesPipelineTestCaseCustomSettings(unittest.TestCase): self.assertEqual(getattr(pipeline_cls, pipe_inst_attr), expected_value) def test_file_pipeline_using_pathlike_objects(self): - class CustomFilesPipelineWithPathLikeDir(FilesPipeline): def file_path(self, request, response=None, info=None, *, item=None): - return Path('subdir') / Path(request.url).name + return Path("subdir") / Path(request.url).name pipeline = CustomFilesPipelineWithPathLikeDir.from_settings( - Settings({'FILES_STORE': Path('./Temp')}) + Settings({"FILES_STORE": Path("./Temp")}) ) request = Request("http://example.com/image01.jpg") - self.assertEqual(pipeline.file_path(request), Path('subdir/image01.jpg')) + self.assertEqual(pipeline.file_path(request), Path("subdir/image01.jpg")) def test_files_store_constructor_with_pathlike_object(self): - path = Path('./FileDir') + path = Path("./FileDir") fs_store = FSFilesStore(path) self.assertEqual(fs_store.basedir, str(path)) From f03b47db05e623189cf7719e647d18e8457494f3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Fri, 27 Jan 2023 17:35:32 +0100 Subject: [PATCH 373/532] Make NO_CALLBACK a callable --- scrapy/http/request/__init__.py | 52 +++++++++++++++------------------ setup.py | 1 - tests/test_http_request.py | 8 +++-- 3 files changed, 29 insertions(+), 32 deletions(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 068a4baa3..de13cf264 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -5,10 +5,8 @@ requests in Scrapy. See documentation in docs/topics/request-response.rst """ import inspect -from enum import Enum from typing import Callable, List, Optional, Tuple, Type, TypeVar, Union -from typing_extensions import Final from w3lib.url import safe_url_string import scrapy @@ -23,21 +21,22 @@ from scrapy.utils.url import escape_ajax RequestTypeVar = TypeVar("RequestTypeVar", bound="Request") -# https://github.com/python/typing/issues/689#issuecomment-561425237 -class NoCallbackType(Enum): - NO_CALLBACK = 0 +def NO_CALLBACK(*args, **kwargs): + """When assigned to the ``callback`` parameter of + :class:`~scrapy.http.Request`, it indicates that the request is not meant + to have a spider callback at all. - -#: When assigned to the ``callback`` parameter of -#: :class:`~scrapy.http.Request`, it indicates that the request is not meant to -#: have a spider callback at all. -#: -#: This value should be used by :ref:`components ` -#: that create and handle their own requests, e.g. through -#: :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download -#: middlewares handling such requests can treat them differently from requests -#: intended for the :meth:`~scrapy.Spider.parse` callback. -NO_CALLBACK: Final = NoCallbackType.NO_CALLBACK + This value should be used by :ref:`components ` that + create and handle their own requests, e.g. through + :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download + middlewares handling such requests can treat them differently from requests + intended for the :meth:`~scrapy.Spider.parse` callback. + """ + raise RuntimeError( + "The NO_CALLBACK callback has been called. This is a special callback " + "value intended for requests whose callback is never meant to be " + "called." + ) class Request(object_ref): @@ -67,8 +66,6 @@ class Request(object_ref): Currently used by :meth:`Request.replace`, :meth:`Request.to_dict` and :func:`~scrapy.utils.request.request_from_dict`. """ - callback: Union[None, NoCallbackType, Callable] - errback: Optional[Callable] def __init__( self, @@ -94,8 +91,14 @@ class Request(object_ref): raise TypeError(f"Request priority not an integer: {priority!r}") self.priority = priority - self._set_xback("callback", callback) - self._set_xback("errback", errback) + if not (callable(callback) or callback is None): + raise TypeError( + f"callback must be a callable, got {type(callback).__name__}" + ) + if not (callable(errback) or errback is None): + raise TypeError(f"errback must be a callable, got {type(errback).__name__}") + self.callback = callback + self.errback = errback self.cookies = cookies or {} self.headers = Headers(headers or {}, encoding=encoding) @@ -105,15 +108,6 @@ class Request(object_ref): self._cb_kwargs = dict(cb_kwargs) if cb_kwargs else None self.flags = [] if flags is None else list(flags) - def _set_xback(self, name: str, value: Optional[Callable]) -> None: - if not ( - callable(value) - or value is None - or (name == "callback" and value is NO_CALLBACK) - ): - raise TypeError(f"{name} must be a callable, got {type(value).__name__}") - setattr(self, name, value) - @property def cb_kwargs(self) -> dict: if self._cb_kwargs is None: diff --git a/setup.py b/setup.py index 9150dac0b..f53334d4e 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,6 @@ install_requires = [ "packaging", "tldextract", "lxml>=4.3.0", - "typing-extensions>=3.10.0.0", ] extras_require = {} cpython_dependencies = [ diff --git a/tests/test_http_request.py b/tests/test_http_request.py index 233a5f0b2..e800f427f 100644 --- a/tests/test_http_request.py +++ b/tests/test_http_request.py @@ -314,8 +314,10 @@ class RequestTest(unittest.TestCase): r5 = self.request_class( url="http://example.com", callback=NO_CALLBACK, + errback=NO_CALLBACK, ) self.assertIs(r5.callback, NO_CALLBACK) + self.assertIs(r5.errback, NO_CALLBACK) def test_callback_and_errback_type(self): with self.assertRaises(TypeError): @@ -328,8 +330,10 @@ class RequestTest(unittest.TestCase): callback="a_function", errback="a_function", ) - with self.assertRaises(TypeError): - self.request_class("http://example.com", errback=NO_CALLBACK) + + def test_no_callback(self): + with self.assertRaises(RuntimeError): + NO_CALLBACK() def test_from_curl(self): # Note: more curated tests regarding curl conversion are in From c0efb271a23218656b5f629fde6d23c115a0c3de Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 27 Jan 2023 23:19:44 +0400 Subject: [PATCH 374/532] Ignore typing for twisted.internet.reactor globally. --- scrapy/core/downloader/handlers/http2.py | 8 ++++---- scrapy/utils/benchserver.py | 6 +++--- scrapy/utils/defer.py | 4 ++-- scrapy/utils/testsite.py | 4 ++-- setup.cfg | 3 +++ tests/CrawlerRunner/ip_address.py | 6 +++--- tests/mockserver.py | 10 +++++----- tests/test_engine.py | 2 +- 8 files changed, 23 insertions(+), 20 deletions(-) diff --git a/scrapy/core/downloader/handlers/http2.py b/scrapy/core/downloader/handlers/http2.py index 20cd50c5a..25ac0307b 100644 --- a/scrapy/core/downloader/handlers/http2.py +++ b/scrapy/core/downloader/handlers/http2.py @@ -28,7 +28,7 @@ class H2DownloadHandler: from twisted.internet import reactor - self._pool = H2ConnectionPool(reactor, settings) # type: ignore[arg-type] + self._pool = H2ConnectionPool(reactor, settings) self._context_factory = load_context_factory_from_settings(settings, crawler) @classmethod @@ -82,7 +82,7 @@ class ScrapyH2Agent: "Tunneling via CONNECT method using HTTP/2.0 is not yet supported" ) return self._ProxyAgent( - reactor=reactor, # type: ignore[arg-type] + reactor=reactor, context_factory=self._context_factory, proxy_uri=URI.fromBytes(to_bytes(proxy, encoding="ascii")), connect_timeout=timeout, @@ -91,7 +91,7 @@ class ScrapyH2Agent: ) return self._Agent( - reactor=reactor, # type: ignore[arg-type] + reactor=reactor, context_factory=self._context_factory, connect_timeout=timeout, bind_address=bind_address, @@ -108,7 +108,7 @@ class ScrapyH2Agent: d = agent.request(request, spider) d.addCallback(self._cb_latency, request, start_time) - timeout_cl = reactor.callLater(timeout, d.cancel) # type: ignore[attr-defined] + timeout_cl = reactor.callLater(timeout, d.cancel) d.addBoth(self._cb_timeout, request, timeout, timeout_cl) return d diff --git a/scrapy/utils/benchserver.py b/scrapy/utils/benchserver.py index 750d3c093..32bc2e38c 100644 --- a/scrapy/utils/benchserver.py +++ b/scrapy/utils/benchserver.py @@ -37,11 +37,11 @@ if __name__ == "__main__": root = Root() factory = Site(root) - httpPort = reactor.listenTCP(8998, Site(root)) # type: ignore[attr-defined] + httpPort = reactor.listenTCP(8998, Site(root)) def _print_listening(): httpHost = httpPort.getHost() print(f"Bench server at http://{httpHost.host}:{httpHost.port}") - reactor.callWhenRunning(_print_listening) # type: ignore[attr-defined] - reactor.run() # type: ignore[attr-defined] + reactor.callWhenRunning(_print_listening) + reactor.run() diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 8fee5a7ed..7f2211877 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -40,7 +40,7 @@ def defer_fail(_failure: Failure) -> Deferred: from twisted.internet import reactor d: Deferred = Deferred() - reactor.callLater(0.1, d.errback, _failure) # type: ignore[attr-defined] + reactor.callLater(0.1, d.errback, _failure) return d @@ -54,7 +54,7 @@ def defer_succeed(result) -> Deferred: from twisted.internet import reactor d: Deferred = Deferred() - reactor.callLater(0.1, d.callback, result) # type: ignore[attr-defined] + reactor.callLater(0.1, d.callback, result) return d diff --git a/scrapy/utils/testsite.py b/scrapy/utils/testsite.py index 119be1dfb..a47756c4b 100644 --- a/scrapy/utils/testsite.py +++ b/scrapy/utils/testsite.py @@ -50,6 +50,6 @@ def test_site(): if __name__ == "__main__": from twisted.internet import reactor - port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") # type: ignore[attr-defined] + port = reactor.listenTCP(0, test_site(), interface="127.0.0.1") print(f"http://localhost:{port.getHost().port}/") - reactor.run() # type: ignore[attr-defined] + reactor.run() diff --git a/setup.cfg b/setup.cfg index af9c87945..db79c5821 100644 --- a/setup.cfg +++ b/setup.cfg @@ -11,6 +11,9 @@ ignore_missing_imports = true [mypy-twisted.internet.interfaces] follow_imports = skip +[mypy-twisted.internet.reactor] +follow_imports = skip + # FIXME: remove the following sections once the issues are solved [mypy-scrapy.downloadermiddlewares.httpproxy] diff --git a/tests/CrawlerRunner/ip_address.py b/tests/CrawlerRunner/ip_address.py index b9a4485a9..26db16dd6 100644 --- a/tests/CrawlerRunner/ip_address.py +++ b/tests/CrawlerRunner/ip_address.py @@ -41,10 +41,10 @@ if __name__ == "__main__": url = f"http://not.a.real.domain:{port}/echo" servers = [(mock_dns_server.host, mock_dns_server.port)] - reactor.installResolver(createResolver(servers=servers)) # type: ignore[attr-defined] + reactor.installResolver(createResolver(servers=servers)) configure_logging() runner = CrawlerRunner() d = runner.crawl(LocalhostSpider, url=url) - d.addBoth(lambda _: reactor.stop()) # type: ignore[attr-defined] - reactor.run() # type: ignore[attr-defined] + d.addBoth(lambda _: reactor.stop()) + reactor.run() diff --git a/tests/mockserver.py b/tests/mockserver.py index 185897373..eb1c03db7 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -375,9 +375,9 @@ if __name__ == "__main__": if args.type == "http": root = Root() factory = Site(root) - httpPort = reactor.listenTCP(0, factory) # type: ignore[attr-defined] + httpPort = reactor.listenTCP(0, factory) contextFactory = ssl_context_factory() - httpsPort = reactor.listenSSL(0, factory, contextFactory) # type: ignore[attr-defined] + httpsPort = reactor.listenSSL(0, factory, contextFactory) def print_listening(): httpHost = httpPort.getHost() @@ -391,11 +391,11 @@ if __name__ == "__main__": clients = [MockDNSResolver()] factory = DNSServerFactory(clients=clients) protocol = dns.DNSDatagramProtocol(controller=factory) - listener = reactor.listenUDP(0, protocol) # type: ignore[attr-defined] + listener = reactor.listenUDP(0, protocol) def print_listening(): host = listener.getHost() print(f"{host.host}:{host.port}") - reactor.callWhenRunning(print_listening) # type: ignore[attr-defined] - reactor.run() # type: ignore[attr-defined] + reactor.callWhenRunning(print_listening) + reactor.run() diff --git a/tests/test_engine.py b/tests/test_engine.py index 5fb87424b..7ddb420ba 100644 --- a/tests/test_engine.py +++ b/tests/test_engine.py @@ -557,4 +557,4 @@ class EngineTest(unittest.TestCase): if __name__ == "__main__": if len(sys.argv) > 1 and sys.argv[1] == "runserver": start_test_site(debug=True) - reactor.run() # type: ignore[attr-defined] + reactor.run() From 5fa0f64db5d4b7bf3f3a7c83578ce15ec534d3d3 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 27 Jan 2023 23:29:23 +0400 Subject: [PATCH 375/532] Ru typing on 3.8 as types-lxml isn't available for 3.7. --- .github/workflows/checks.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 740092dab..bd26e8bb2 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -17,7 +17,7 @@ jobs: - python-version: "3.11" env: TOXENV: pylint - - python-version: 3.7 + - python-version: 3.8 env: TOXENV: typing - python-version: "3.11" # Keep in sync with .readthedocs.yml From e9ee9454f960d7e14b5cca4527bf2b185235bd89 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Fri, 27 Jan 2023 14:59:08 -0600 Subject: [PATCH 376/532] fix .isort.cfg --- .isort.cfg | 1 - 1 file changed, 1 deletion(-) diff --git a/.isort.cfg b/.isort.cfg index a29184f0a..f238bf7ea 100644 --- a/.isort.cfg +++ b/.isort.cfg @@ -1,3 +1,2 @@ [settings] profile = black -multi_line_output = 3 From ef794251f6bd238986c4e90763521a0b3ac02dc6 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Fri, 27 Jan 2023 15:00:19 -0600 Subject: [PATCH 377/532] fix scrapy/__init__.py --- scrapy/__init__.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/scrapy/__init__.py b/scrapy/__init__.py index 44df3d54b..a757a9290 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -8,11 +8,10 @@ import warnings from twisted import version as _txv +# Declare top-level shortcuts from scrapy.http import FormRequest, Request from scrapy.item import Field, Item from scrapy.selector import Selector - -# Declare top-level shortcuts from scrapy.spiders import Spider __all__ = [ From 4bd48d26138176c83086180172e1cff245d49648 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Fri, 27 Jan 2023 15:06:54 -0600 Subject: [PATCH 378/532] added pre-commit action --- .github/workflows/checks.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 740092dab..6b2f4ef10 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -32,6 +32,7 @@ jobs: steps: - uses: actions/checkout@v3 + - uses: pre-commit/action@v3.0.0 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v4 From 80453d53b19bbe288dc1e5b721f2f29acb89706a Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sat, 28 Jan 2023 01:29:09 +0400 Subject: [PATCH 379/532] Type DeferredLists as Deferreds. --- scrapy/utils/defer.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index 7f2211877..79b96856c 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -85,7 +85,7 @@ def mustbe_deferred(f: Callable, *args, **kw) -> Deferred: def parallel( iterable: Iterable, count: int, callable: Callable, *args, **named -) -> DeferredList: +) -> Deferred: """Execute a callable over the objects in the given iterable, in parallel, using no more than ``count`` concurrent calls. @@ -202,11 +202,11 @@ class _AsyncCooperatorAdapter(Iterator): def parallel_async( async_iterable: AsyncIterable, count: int, callable: Callable, *args, **named -) -> DeferredList: +) -> Deferred: """Like parallel but for async iterators""" coop = Cooperator() work = _AsyncCooperatorAdapter(async_iterable, callable, *args, **named) - dl = DeferredList([coop.coiterate(work) for _ in range(count)]) + dl: Deferred = DeferredList([coop.coiterate(work) for _ in range(count)]) return dl @@ -245,7 +245,7 @@ def process_parallel(callbacks: Iterable[Callable], input, *a, **kw) -> Deferred callbacks """ dfds = [defer.succeed(input).addCallback(x, *a, **kw) for x in callbacks] - d = DeferredList(dfds, fireOnOneErrback=True, consumeErrors=True) + d: Deferred = DeferredList(dfds, fireOnOneErrback=True, consumeErrors=True) d.addCallbacks(lambda r: [x[1] for x in r], lambda f: f.value.subFailure) return d From 5dcf8b9015d412919aca99cad0371298f9591b94 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Sun, 29 Jan 2023 00:22:56 -0600 Subject: [PATCH 380/532] fix isort version --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d67249371..0534bb142 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,6 +18,6 @@ repos: hooks: - id: black - repo: https://github.com/pycqa/isort - rev: 5.11.3 + rev: 5.12.0 hooks: - id: isort From 17354a61b11eb792adbe77fcdfa6b95a5993cc30 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 30 Jan 2023 10:04:27 +0100 Subject: [PATCH 381/532] Avoid duplicities in CI; remove pylint from pre-commit --- .github/workflows/checks.yml | 16 ++++++---------- .pre-commit-config.yaml | 7 +------ 2 files changed, 7 insertions(+), 16 deletions(-) diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 6b2f4ef10..aa79cbc0d 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -8,12 +8,6 @@ jobs: fail-fast: false matrix: include: - - python-version: "3.11" - env: - TOXENV: security - - python-version: "3.11" - env: - TOXENV: flake8 - python-version: "3.11" env: TOXENV: pylint @@ -26,13 +20,9 @@ jobs: - python-version: "3.11" env: TOXENV: twinecheck - - python-version: "3.11" - env: - TOXENV: black steps: - uses: actions/checkout@v3 - - uses: pre-commit/action@v3.0.0 - name: Set up Python ${{ matrix.python-version }} uses: actions/setup-python@v4 @@ -44,3 +34,9 @@ jobs: run: | pip install -U tox tox + + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: pre-commit/action@v3.0.0 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0534bb142..f5fc1285f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -8,11 +8,6 @@ repos: rev: 6.0.0 hooks: - id: flake8 -- repo: https://github.com/PyCQA/pylint - rev: v2.15.6 - hooks: - - id: pylint - args: [conftest.py, docs, extras, scrapy, setup.py, tests] - repo: https://github.com/psf/black.git rev: 22.12.0 hooks: @@ -20,4 +15,4 @@ repos: - repo: https://github.com/pycqa/isort rev: 5.12.0 hooks: - - id: isort + - id: isort From e1699479f6e48ce87dea1e6ed5661fea9ca7b1aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 30 Jan 2023 11:54:31 +0100 Subject: [PATCH 382/532] =?UTF-8?q?Fix=20typo:=20download=20middleware=20?= =?UTF-8?q?=E2=86=92=20downloader=20middleware?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Andrey Rakhmatullin --- scrapy/http/request/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/http/request/__init__.py b/scrapy/http/request/__init__.py index 75dd2a74f..7afb28db5 100644 --- a/scrapy/http/request/__init__.py +++ b/scrapy/http/request/__init__.py @@ -27,7 +27,7 @@ def NO_CALLBACK(*args, **kwargs): This value should be used by :ref:`components ` that create and handle their own requests, e.g. through - :meth:`scrapy.core.engine.ExecutionEngine.download`, so that download + :meth:`scrapy.core.engine.ExecutionEngine.download`, so that downloader middlewares handling such requests can treat them differently from requests intended for the :meth:`~scrapy.Spider.parse` callback. """ From 389fd99e79374bad73faf98424c97ac804eb1a68 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 30 Jan 2023 12:37:34 +0100 Subject: [PATCH 383/532] get_media_requests: support and encourage callback=NO_CALLBACK --- scrapy/pipelines/files.py | 3 ++- scrapy/pipelines/images.py | 3 ++- scrapy/pipelines/media.py | 9 ++++++++- 3 files changed, 12 insertions(+), 3 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 01a9c41fe..91fc172b2 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -22,6 +22,7 @@ from twisted.internet import defer, threads from scrapy.exceptions import IgnoreRequest, NotConfigured from scrapy.http import Request +from scrapy.http.request import NO_CALLBACK from scrapy.pipelines.media import MediaPipeline from scrapy.settings import Settings from scrapy.utils.boto import is_botocore_available @@ -517,7 +518,7 @@ class FilesPipeline(MediaPipeline): # Overridable Interface def get_media_requests(self, item, info): urls = ItemAdapter(item).get(self.files_urls_field, []) - return [Request(u) for u in urls] + return [Request(u, callback=NO_CALLBACK) for u in urls] def file_downloaded(self, response, request, info, *, item=None): path = self.file_path(request, response=response, info=info, item=item) diff --git a/scrapy/pipelines/images.py b/scrapy/pipelines/images.py index 0cfa5665a..9d18144ee 100644 --- a/scrapy/pipelines/images.py +++ b/scrapy/pipelines/images.py @@ -13,6 +13,7 @@ from itemadapter import ItemAdapter from scrapy.exceptions import DropItem, NotConfigured, ScrapyDeprecationWarning from scrapy.http import Request +from scrapy.http.request import NO_CALLBACK from scrapy.pipelines.files import FileException, FilesPipeline # TODO: from scrapy.pipelines.media import MediaPipeline @@ -214,7 +215,7 @@ class ImagesPipeline(FilesPipeline): def get_media_requests(self, item, info): urls = ItemAdapter(item).get(self.images_urls_field, []) - return [Request(u) for u in urls] + return [Request(u, callback=NO_CALLBACK) for u in urls] def item_completed(self, results, item, info): with suppress(KeyError): diff --git a/scrapy/pipelines/media.py b/scrapy/pipelines/media.py index 1e921f0b5..679035c5d 100644 --- a/scrapy/pipelines/media.py +++ b/scrapy/pipelines/media.py @@ -18,6 +18,10 @@ from scrapy.utils.log import failure_to_exc_info logger = logging.getLogger(__name__) +def _DUMMY_CALLBACK(response): + return response + + class MediaPipeline: LOG_FAILED_RESULTS = True @@ -91,7 +95,10 @@ class MediaPipeline: def _process_request(self, request, info, item): fp = self._fingerprinter.fingerprint(request) - cb = request.callback or (lambda _: _) + if not request.callback or request.callback is NO_CALLBACK: + cb = _DUMMY_CALLBACK + else: + cb = request.callback eb = request.errback request.callback = NO_CALLBACK request.errback = None From 78eaf0671bd50642f68d5b07bec3175298120a60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 30 Jan 2023 14:33:11 +0100 Subject: [PATCH 384/532] Remove typing-extensions from tox.ini --- tox.ini | 1 - 1 file changed, 1 deletion(-) diff --git a/tox.ini b/tox.ini index f2268b0f6..453c28c4c 100644 --- a/tox.ini +++ b/tox.ini @@ -94,7 +94,6 @@ deps = w3lib==1.17.0 zope.interface==5.1.0 lxml==4.3.0 - typing-extensions==3.10.0.0 -rtests/requirements.txt # mitmproxy 4.0.4+ requires upgrading some of the pinned dependencies From 349fc33cc70aee38d30f7715811829b70ef77492 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 31 Jan 2023 14:28:08 -0800 Subject: [PATCH 385/532] added disable_warnings instruction to .coveragerc --- .coveragerc | 1 + 1 file changed, 1 insertion(+) diff --git a/.coveragerc b/.coveragerc index 02acbff8e..ad0ee0f6c 100644 --- a/.coveragerc +++ b/.coveragerc @@ -3,3 +3,4 @@ branch = true include = scrapy/* omit = tests/* +disable_warnings = include-ignored From c1bbb299d7dc30d03c33cc3eda776ae30ba77d0d Mon Sep 17 00:00:00 2001 From: pankaj1707k <76695979+pankaj1707k@users.noreply.github.com> Date: Wed, 1 Feb 2023 16:30:57 +0530 Subject: [PATCH 386/532] Add and run pre-commit hook 'blacken-docs' Change python code snippets to begin with '.. code-block:: python' to be recognized by the hook for formatting. All snippets under '::' (rst literal blocks) are ignored. --- .pre-commit-config.yaml | 6 + docs/faq.rst | 44 ++- docs/intro/overview.rst | 14 +- docs/intro/tutorial.rst | 120 +++--- docs/topics/asyncio.rst | 6 +- docs/topics/broad-crawls.rst | 40 +- docs/topics/commands.rst | 17 +- docs/topics/components.rst | 8 +- docs/topics/contracts.rst | 38 +- docs/topics/coroutines.rst | 29 +- docs/topics/debug.rst | 35 +- docs/topics/developer-tools.rst | 17 +- docs/topics/downloader-middleware.rst | 50 ++- docs/topics/dynamic-content.rst | 15 +- docs/topics/email.rst | 20 +- docs/topics/exceptions.rst | 8 +- docs/topics/exporters.rst | 35 +- docs/topics/extensions.rst | 24 +- docs/topics/feed-exports.rst | 67 ++-- docs/topics/item-pipeline.rst | 50 ++- docs/topics/items.rst | 30 +- docs/topics/jobs.rst | 6 +- docs/topics/link-extractors.rst | 8 +- docs/topics/loaders.rst | 100 +++-- docs/topics/logging.rst | 109 +++-- docs/topics/media-pipeline.rst | 177 ++++++--- docs/topics/practices.rst | 55 ++- docs/topics/request-response.rst | 176 ++++++--- docs/topics/selectors.rst | 33 +- docs/topics/settings.rst | 202 ++++++---- docs/topics/shell.rst | 5 +- docs/topics/signals.rst | 31 +- docs/topics/spider-middleware.rst | 18 +- docs/topics/spiders.rst | 246 +++++++----- docs/topics/stats.rst | 29 +- sep/sep-001.rst | 549 +++++++++++++------------- sep/sep-002.rst | 44 ++- sep/sep-003.rst | 90 +++-- sep/sep-004.rst | 9 +- sep/sep-005.rst | 33 +- sep/sep-008.rst | 5 +- sep/sep-009.rst | 18 +- sep/sep-012.rst | 6 +- sep/sep-014.rst | 170 ++++---- sep/sep-016.rst | 49 ++- sep/sep-017.rst | 10 +- sep/sep-018.rst | 150 +++---- sep/sep-019.rst | 10 +- sep/sep-020.rst | 50 +-- sep/sep-021.rst | 20 +- 50 files changed, 1821 insertions(+), 1260 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f5fc1285f..729682392 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -16,3 +16,9 @@ repos: rev: 5.12.0 hooks: - id: isort +- repo: https://github.com/adamchainz/blacken-docs + rev: 1.13.0 + hooks: + - id: blacken-docs + additional_dependencies: + - black==22.12.0 diff --git a/docs/faq.rst b/docs/faq.rst index 8a9ba809b..836420567 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -35,8 +35,9 @@ for parsing HTML responses in Scrapy callbacks. You just have to feed the response's body into a ``BeautifulSoup`` object and extract whatever data you need from it. -Here's an example spider using BeautifulSoup API, with ``lxml`` as the HTML parser:: +Here's an example spider using BeautifulSoup API, with ``lxml`` as the HTML parser: +.. code-block:: python from bs4 import BeautifulSoup import scrapy @@ -45,17 +46,12 @@ Here's an example spider using BeautifulSoup API, with ``lxml`` as the HTML pars class ExampleSpider(scrapy.Spider): name = "example" allowed_domains = ["example.com"] - start_urls = ( - 'http://www.example.com/', - ) + start_urls = ("http://www.example.com/",) def parse(self, response): # use lxml to get decent HTML parsing speed - soup = BeautifulSoup(response.text, 'lxml') - yield { - "url": response.url, - "title": soup.h1.string - } + soup = BeautifulSoup(response.text, "lxml") + yield {"url": response.url, "title": soup.h1.string} .. note:: @@ -109,11 +105,13 @@ basically means that it crawls in `DFO order`_. This order is more convenient in most cases. If you do want to crawl in true `BFO order`_, you can do it by -setting the following settings:: +setting the following settings: + +.. code-block:: python DEPTH_PRIORITY = 1 - SCHEDULER_DISK_QUEUE = 'scrapy.squeues.PickleFifoDiskQueue' - SCHEDULER_MEMORY_QUEUE = 'scrapy.squeues.FifoMemoryQueue' + SCHEDULER_DISK_QUEUE = "scrapy.squeues.PickleFifoDiskQueue" + SCHEDULER_MEMORY_QUEUE = "scrapy.squeues.FifoMemoryQueue" While pending requests are below the configured values of :setting:`CONCURRENT_REQUESTS`, :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` or @@ -159,11 +157,13 @@ See also other suggestions at `StackOverflow`_. .. note:: Remember to disable :class:`scrapy.spidermiddlewares.offsite.OffsiteMiddleware` when you enable - your custom implementation:: + your custom implementation: + + .. code-block:: python SPIDER_MIDDLEWARES = { - 'scrapy.spidermiddlewares.offsite.OffsiteMiddleware': None, - 'myproject.middlewares.CustomOffsiteMiddleware': 500, + "scrapy.spidermiddlewares.offsite.OffsiteMiddleware": None, + "myproject.middlewares.CustomOffsiteMiddleware": 500, } .. _meet the installation requirements: https://github.com/andreasvc/pyre2#installation @@ -235,11 +235,13 @@ What does the response status code 999 means? 999 is a custom response status code used by Yahoo sites to throttle requests. Try slowing down the crawling speed by using a download delay of ``2`` (or -higher) in your spider:: +higher) in your spider: + +.. code-block:: python class MySpider(CrawlSpider): - name = 'myspider' + name = "myspider" download_delay = 2 @@ -351,19 +353,21 @@ How to split an item into multiple items in an item pipeline? input item. :ref:`Create a spider middleware ` instead, and use its :meth:`~scrapy.spidermiddlewares.SpiderMiddleware.process_spider_output` -method for this purpose. For example:: +method for this purpose. For example: + +.. code-block:: python from copy import deepcopy from itemadapter import is_item, ItemAdapter - class MultiplyItemsMiddleware: + class MultiplyItemsMiddleware: def process_spider_output(self, response, result, spider): for item in result: if is_item(item): adapter = ItemAdapter(item) - for _ in range(adapter['multiply_by']): + for _ in range(adapter["multiply_by"]): yield deepcopy(item) Does Scrapy support IPv6 addresses? diff --git a/docs/intro/overview.rst b/docs/intro/overview.rst index cfa6bfa83..495aad091 100644 --- a/docs/intro/overview.rst +++ b/docs/intro/overview.rst @@ -20,22 +20,24 @@ In order to show you what Scrapy brings to the table, we'll walk you through an example of a Scrapy Spider using the simplest way to run a spider. Here's the code for a spider that scrapes famous quotes from website -https://quotes.toscrape.com, following the pagination:: +https://quotes.toscrape.com, following the pagination + +.. code-block:: python import scrapy class QuotesSpider(scrapy.Spider): - name = 'quotes' + name = "quotes" start_urls = [ - 'https://quotes.toscrape.com/tag/humor/', + "https://quotes.toscrape.com/tag/humor/", ] def parse(self, response): - for quote in response.css('div.quote'): + for quote in response.css("div.quote"): yield { - 'author': quote.xpath('span/small/text()').get(), - 'text': quote.css('span.text::text').get(), + "author": quote.xpath("span/small/text()").get(), + "text": quote.css("span.text::text").get(), } next_page = response.css('li.next a::attr("href")').get() diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index 901a170b4..f5e9b372e 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -177,7 +177,9 @@ that generates :class:`scrapy.Request ` objects from URLs, you can just define a :attr:`~scrapy.Spider.start_urls` class attribute with a list of URLs. This list will then be used by the default implementation of :meth:`~scrapy.Spider.start_requests` to create the initial requests -for your spider:: +for your spider. + +.. code-block:: python from pathlib import Path @@ -187,13 +189,13 @@ for your spider:: class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ - 'https://quotes.toscrape.com/page/1/', - 'https://quotes.toscrape.com/page/2/', + "https://quotes.toscrape.com/page/1/", + "https://quotes.toscrape.com/page/2/", ] def parse(self, response): page = response.url.split("/")[-2] - filename = f'quotes-{page}.html' + filename = f"quotes-{page}.html" Path(filename).write_bytes(response.body) The :meth:`~scrapy.Spider.parse` method will be called to handle each @@ -438,7 +440,9 @@ extraction logic above into our spider. A Scrapy spider typically generates many dictionaries containing the data extracted from the page. To do that, we use the ``yield`` Python keyword -in the callback, as you can see below:: +in the callback, as you can see below: + +.. code-block:: python import scrapy @@ -446,16 +450,16 @@ in the callback, as you can see below:: class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ - 'https://quotes.toscrape.com/page/1/', - 'https://quotes.toscrape.com/page/2/', + "https://quotes.toscrape.com/page/1/", + "https://quotes.toscrape.com/page/2/", ] def parse(self, response): - for quote in response.css('div.quote'): + for quote in response.css("div.quote"): yield { - 'text': quote.css('span.text::text').get(), - 'author': quote.css('small.author::text').get(), - 'tags': quote.css('div.tags a.tag::text').getall(), + "text": quote.css("span.text::text").get(), + "author": quote.css("small.author::text").get(), + "tags": quote.css("div.tags a.tag::text").getall(), } If you run this spider, it will output the extracted data with the log:: @@ -543,7 +547,9 @@ There is also an ``attrib`` property available '/page/2/' Let's see now our spider modified to recursively follow the link to the next -page, extracting data from it:: +page, extracting data from it: + +.. code-block:: python import scrapy @@ -551,18 +557,18 @@ page, extracting data from it:: class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ - 'https://quotes.toscrape.com/page/1/', + "https://quotes.toscrape.com/page/1/", ] def parse(self, response): - for quote in response.css('div.quote'): + for quote in response.css("div.quote"): yield { - 'text': quote.css('span.text::text').get(), - 'author': quote.css('small.author::text').get(), - 'tags': quote.css('div.tags a.tag::text').getall(), + "text": quote.css("span.text::text").get(), + "author": quote.css("small.author::text").get(), + "tags": quote.css("div.tags a.tag::text").getall(), } - next_page = response.css('li.next a::attr(href)').get() + next_page = response.css("li.next a::attr(href)").get() if next_page is not None: next_page = response.urljoin(next_page) yield scrapy.Request(next_page, callback=self.parse) @@ -594,7 +600,9 @@ A shortcut for creating Requests -------------------------------- As a shortcut for creating Request objects you can use -:meth:`response.follow `:: +:meth:`response.follow ` + +.. code-block:: python import scrapy @@ -602,18 +610,18 @@ As a shortcut for creating Request objects you can use class QuotesSpider(scrapy.Spider): name = "quotes" start_urls = [ - 'https://quotes.toscrape.com/page/1/', + "https://quotes.toscrape.com/page/1/", ] def parse(self, response): - for quote in response.css('div.quote'): + for quote in response.css("div.quote"): yield { - 'text': quote.css('span.text::text').get(), - 'author': quote.css('span small::text').get(), - 'tags': quote.css('div.tags a.tag::text').getall(), + "text": quote.css("span.text::text").get(), + "author": quote.css("span small::text").get(), + "tags": quote.css("div.tags a.tag::text").getall(), } - next_page = response.css('li.next a::attr(href)').get() + next_page = response.css("li.next a::attr(href)").get() if next_page is not None: yield response.follow(next_page, callback=self.parse) @@ -622,57 +630,67 @@ need to call urljoin. Note that ``response.follow`` just returns a Request instance; you still have to yield this Request. You can also pass a selector to ``response.follow`` instead of a string; -this selector should extract necessary attributes:: +this selector should extract necessary attributes: - for href in response.css('ul.pager a::attr(href)'): +.. code-block:: python + + for href in response.css("ul.pager a::attr(href)"): yield response.follow(href, callback=self.parse) For ```` elements there is a shortcut: ``response.follow`` uses their href -attribute automatically. So the code can be shortened further:: +attribute automatically. So the code can be shortened further: - for a in response.css('ul.pager a'): +.. code-block:: python + + for a in response.css("ul.pager a"): yield response.follow(a, callback=self.parse) To create multiple requests from an iterable, you can use -:meth:`response.follow_all ` instead:: +:meth:`response.follow_all ` instead: - anchors = response.css('ul.pager a') +.. code-block:: python + + anchors = response.css("ul.pager a") yield from response.follow_all(anchors, callback=self.parse) -or, shortening it further:: +or, shortening it further: - yield from response.follow_all(css='ul.pager a', callback=self.parse) +.. code-block:: python + + yield from response.follow_all(css="ul.pager a", callback=self.parse) More examples and patterns -------------------------- Here is another spider that illustrates callbacks and following links, -this time for scraping author information:: +this time for scraping author information: + +.. code-block:: python import scrapy class AuthorSpider(scrapy.Spider): - name = 'author' + name = "author" - start_urls = ['https://quotes.toscrape.com/'] + start_urls = ["https://quotes.toscrape.com/"] def parse(self, response): - author_page_links = response.css('.author + a') + author_page_links = response.css(".author + a") yield from response.follow_all(author_page_links, self.parse_author) - pagination_links = response.css('li.next a') + pagination_links = response.css("li.next a") yield from response.follow_all(pagination_links, self.parse) def parse_author(self, response): def extract_with_css(query): - return response.css(query).get(default='').strip() + return response.css(query).get(default="").strip() yield { - 'name': extract_with_css('h3.author-title::text'), - 'birthdate': extract_with_css('.author-born-date::text'), - 'bio': extract_with_css('.author-description::text'), + "name": extract_with_css("h3.author-title::text"), + "birthdate": extract_with_css(".author-born-date::text"), + "bio": extract_with_css(".author-description::text"), } This spider will start from the main page, it will follow all the links to the @@ -720,7 +738,9 @@ spider attributes by default. In this example, the value provided for the ``tag`` argument will be available via ``self.tag``. You can use this to make your spider fetch only quotes -with a specific tag, building the URL based on the argument:: +with a specific tag, building the URL based on the argument: + +.. code-block:: python import scrapy @@ -729,20 +749,20 @@ with a specific tag, building the URL based on the argument:: name = "quotes" def start_requests(self): - url = 'https://quotes.toscrape.com/' - tag = getattr(self, 'tag', None) + url = "https://quotes.toscrape.com/" + tag = getattr(self, "tag", None) if tag is not None: - url = url + 'tag/' + tag + url = url + "tag/" + tag yield scrapy.Request(url, self.parse) def parse(self, response): - for quote in response.css('div.quote'): + for quote in response.css("div.quote"): yield { - 'text': quote.css('span.text::text').get(), - 'author': quote.css('small.author::text').get(), + "text": quote.css("span.text::text").get(), + "author": quote.css("small.author::text").get(), } - next_page = response.css('li.next a::attr(href)').get() + next_page = response.css("li.next a::attr(href)").get() if next_page is not None: yield response.follow(next_page, self.parse) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index dbee7146d..7713b1af1 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -106,12 +106,14 @@ Enforcing asyncio as a requirement If you are writing a :ref:`component ` that requires asyncio to work, use :func:`scrapy.utils.reactor.is_asyncio_reactor_installed` to :ref:`enforce it as a requirement `. For -example:: +example: + +.. code-block:: python from scrapy.utils.reactor import is_asyncio_reactor_installed - class MyComponent: + class MyComponent: def __init__(self): if not is_asyncio_reactor_installed(): raise ValueError( diff --git a/docs/topics/broad-crawls.rst b/docs/topics/broad-crawls.rst index 0927ac2d2..8be89feb2 100644 --- a/docs/topics/broad-crawls.rst +++ b/docs/topics/broad-crawls.rst @@ -48,9 +48,11 @@ Scrapy’s default scheduler priority queue is ``'scrapy.pqueues.ScrapyPriorityQ It works best during single-domain crawl. It does not work well with crawling many different domains in parallel -To apply the recommended priority queue use:: +To apply the recommended priority queue use: - SCHEDULER_PRIORITY_QUEUE = 'scrapy.pqueues.DownloaderAwarePriorityQueue' +.. code-block:: python + + SCHEDULER_PRIORITY_QUEUE = "scrapy.pqueues.DownloaderAwarePriorityQueue" .. _broad-crawls-concurrency: @@ -71,7 +73,9 @@ many different domains in parallel, so you will want to increase it. How much to increase it will depend on how much CPU and memory your crawler will have available. -A good starting point is ``100``:: +A good starting point is ``100``: + +.. code-block:: python CONCURRENT_REQUESTS = 100 @@ -92,7 +96,9 @@ hitting DNS resolver timeouts. Possible solution to increase the number of threads handling DNS queries. The DNS queue will be processed faster speeding up establishing of connection and crawling overall. -To increase maximum thread pool size use:: +To increase maximum thread pool size use: + +.. code-block:: python REACTOR_THREADPOOL_MAXSIZE = 20 @@ -114,9 +120,11 @@ should not use ``DEBUG`` log level when preforming large broad crawls in production. Using ``DEBUG`` level when developing your (broad) crawler may be fine though. -To set the log level use:: +To set the log level use: - LOG_LEVEL = 'INFO' +.. code-block:: python + + LOG_LEVEL = "INFO" Disable cookies =============== @@ -126,7 +134,9 @@ doing broad crawls (search engine crawlers ignore them), and they improve performance by saving some CPU cycles and reducing the memory footprint of your Scrapy crawler. -To disable cookies use:: +To disable cookies use: + +.. code-block:: python COOKIES_ENABLED = False @@ -138,7 +148,9 @@ when sites causes are very slow (or fail) to respond, thus causing a timeout error which gets retried many times, unnecessarily, preventing crawler capacity to be reused for other domains. -To disable retries use:: +To disable retries use: + +.. code-block:: python RETRY_ENABLED = False @@ -149,7 +161,9 @@ Unless you are crawling from a very slow connection (which shouldn't be the case for broad crawls) reduce the download timeout so that stuck requests are discarded quickly and free up capacity to process the next ones. -To reduce the download timeout use:: +To reduce the download timeout use: + +.. code-block:: python DOWNLOAD_TIMEOUT = 15 @@ -162,7 +176,9 @@ revisiting the site at a later crawl. This also help to keep the number of request constant per crawl batch, otherwise redirect loops may cause the crawler to dedicate too many resources on any specific domain. -To disable redirects use:: +To disable redirects use: + +.. code-block:: python REDIRECT_ENABLED = False @@ -179,7 +195,9 @@ Pages can indicate it in two ways: "main", "index" website pages. Scrapy handles (1) automatically; to handle (2) enable -:ref:`AjaxCrawlMiddleware `:: +:ref:`AjaxCrawlMiddleware `: + +.. code-block:: python AJAXCRAWL_ENABLED = True diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index 362190116..54fd5d663 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -617,7 +617,7 @@ Example: .. code-block:: python - COMMANDS_MODULE = 'mybot.commands' + COMMANDS_MODULE = "mybot.commands" .. _Deploying your project: https://scrapyd.readthedocs.io/en/latest/deploy.html @@ -636,10 +636,11 @@ The following example adds ``my_command`` command: from setuptools import setup, find_packages - setup(name='scrapy-mymodule', - entry_points={ - 'scrapy.commands': [ - 'my_command=my_scrapy_module.commands:MyCommand', - ], - }, - ) + setup( + name="scrapy-mymodule", + entry_points={ + "scrapy.commands": [ + "my_command=my_scrapy_module.commands:MyCommand", + ], + }, + ) diff --git a/docs/topics/components.rst b/docs/topics/components.rst index ca301b827..1ed55f000 100644 --- a/docs/topics/components.rst +++ b/docs/topics/components.rst @@ -66,16 +66,18 @@ version mismatch, while :exc:`ValueError` may be better if the issue is the value of a setting. If your requirement is a minimum Scrapy version, you may use -:attr:`scrapy.__version__` to enforce your requirement. For example:: +:attr:`scrapy.__version__` to enforce your requirement. For example: + +.. code-block:: python from pkg_resources import parse_version import scrapy - class MyComponent: + class MyComponent: def __init__(self): - if parse_version(scrapy.__version__) < parse_version('2.7'): + if parse_version(scrapy.__version__) < parse_version("2.7"): raise RuntimeError( f"{MyComponent.__qualname__} requires Scrapy 2.7 or " f"later, which allow defining the process_spider_output " diff --git a/docs/topics/contracts.rst b/docs/topics/contracts.rst index c29a3a410..211a0f5f2 100644 --- a/docs/topics/contracts.rst +++ b/docs/topics/contracts.rst @@ -11,10 +11,13 @@ integrated way of testing your spiders by the means of contracts. This allows you to test each callback of your spider by hardcoding a sample url and check various constraints for how the callback processes the response. Each contract is prefixed with an ``@`` and included in the docstring. See the -following example:: +following example: + +.. code-block:: python def parse(self, response): - """ This function parses a sample response. Some contracts are mingled + """ + This function parses a sample response. Some contracts are mingled with this docstring. @url http://www.amazon.com/s?field-keywords=selfish+gene @@ -64,11 +67,13 @@ Custom Contracts If you find you need more power than the built-in Scrapy contracts you can create and load your own contracts in the project by using the -:setting:`SPIDER_CONTRACTS` setting:: +:setting:`SPIDER_CONTRACTS` setting: + +.. code-block:: python SPIDER_CONTRACTS = { - 'myproject.contracts.ResponseCheck': 10, - 'myproject.contracts.ItemValidate': 10, + "myproject.contracts.ResponseCheck": 10, + "myproject.contracts.ItemValidate": 10, } Each contract must inherit from :class:`~scrapy.contracts.Contract` and can @@ -111,22 +116,26 @@ Raise :class:`~scrapy.exceptions.ContractFail` from .. autoclass:: scrapy.exceptions.ContractFail Here is a demo contract which checks the presence of a custom header in the -response received:: +response received: + +.. code-block:: python from scrapy.contracts import Contract from scrapy.exceptions import ContractFail + class HasHeaderContract(Contract): - """ Demo contract which checks the presence of a custom header - @has_header X-CustomHeader + """ + Demo contract which checks the presence of a custom header + @has_header X-CustomHeader """ - name = 'has_header' + name = "has_header" def pre_process(self, response): for header in self.args: if header not in response.headers: - raise ContractFail('X-CustomHeader not present') + raise ContractFail("X-CustomHeader not present") .. _detecting-contract-check-runs: @@ -135,14 +144,17 @@ Detecting check runs When ``scrapy check`` is running, the ``SCRAPY_CHECK`` environment variable is set to the ``true`` string. You can use :data:`os.environ` to perform any change to -your spiders or your settings when ``scrapy check`` is used:: +your spiders or your settings when ``scrapy check`` is used: + +.. code-block:: python import os import scrapy + class ExampleSpider(scrapy.Spider): - name = 'example' + name = "example" def __init__(self): - if os.environ.get('SCRAPY_CHECK'): + if os.environ.get("SCRAPY_CHECK"): pass # Do some scraper adjustments when a check is running diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index a1ba4ba5c..a0c005204 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -58,49 +58,58 @@ There are several use cases for coroutines in Scrapy. Code that would return Deferreds when written for previous Scrapy versions, such as downloader middlewares and signal handlers, can be rewritten to be -shorter and cleaner:: +shorter and cleaner: + +.. code-block:: python from itemadapter import ItemAdapter + class DbPipeline: def _update_item(self, data, item): adapter = ItemAdapter(item) - adapter['field'] = data + adapter["field"] = data return item def process_item(self, item, spider): adapter = ItemAdapter(item) - dfd = db.get_some_data(adapter['id']) + dfd = db.get_some_data(adapter["id"]) dfd.addCallback(self._update_item, item) return dfd -becomes:: +becomes: + +.. code-block:: python from itemadapter import ItemAdapter + class DbPipeline: async def process_item(self, item, spider): adapter = ItemAdapter(item) - adapter['field'] = await db.get_some_data(adapter['id']) + adapter["field"] = await db.get_some_data(adapter["id"]) return item Coroutines may be used to call asynchronous code. This includes other coroutines, functions that return Deferreds and functions that return :term:`awaitable objects ` such as :class:`~asyncio.Future`. -This means you can use many useful Python libraries providing such code:: +This means you can use many useful Python libraries providing such code: + +.. code-block:: python class MySpiderDeferred(Spider): # ... async def parse(self, response): - additional_response = await treq.get('https://additional.url') + additional_response = await treq.get("https://additional.url") additional_data = await treq.content(additional_response) # ... use response and additional_data to yield items and requests + class MySpiderAsyncio(Spider): # ... async def parse(self, response): async with aiohttp.ClientSession() as session: - async with session.get('https://additional.url') as additional_response: + async with session.get("https://additional.url") as additional_response: additional_data = await additional_response.text() # ... use response and additional_data to yield items and requests @@ -192,7 +201,9 @@ while maintaining support for older Scrapy versions, you may define :term:`asynchronous generator` version of that method with an alternative name: ``process_spider_output_async``. -For example:: +For example: + +.. code-block:: python class UniversalSpiderMiddleware: def process_spider_output(self, response, result, spider): diff --git a/docs/topics/debug.rst b/docs/topics/debug.rst index edbcaf432..b133fcc1e 100644 --- a/docs/topics/debug.rst +++ b/docs/topics/debug.rst @@ -5,21 +5,24 @@ Debugging Spiders ================= This document explains the most common techniques for debugging spiders. -Consider the following Scrapy spider below:: +Consider the following Scrapy spider below: + +.. code-block:: python import scrapy from myproject.items import MyItem + class MySpider(scrapy.Spider): - name = 'myspider' + name = "myspider" start_urls = ( - 'http://example.com/page1', - 'http://example.com/page2', - ) + "http://example.com/page1", + "http://example.com/page2", + ) def parse(self, response): # - # collect `item_urls` + # collect `item_urls` for item_url in item_urls: yield scrapy.Request(item_url, self.parse_item) @@ -28,7 +31,9 @@ Consider the following Scrapy spider below:: item = MyItem() # populate `item` fields # and extract item_details_url - yield scrapy.Request(item_details_url, self.parse_details, cb_kwargs={'item': item}) + yield scrapy.Request( + item_details_url, self.parse_details, cb_kwargs={"item": item} + ) def parse_details(self, response, item): # populate more `item` fields @@ -103,10 +108,13 @@ showing the response received and the output. How to debug the situation when .. highlight:: python Fortunately, the :command:`shell` is your bread and butter in this case (see -:ref:`topics-shell-inspect-response`):: +:ref:`topics-shell-inspect-response`): + +.. code-block:: python from scrapy.shell import inspect_response + def parse_details(self, response, item=None): if item: # populate more `item` fields @@ -121,10 +129,13 @@ Open in browser Sometimes you just want to see how a certain response looks in a browser, you can use the ``open_in_browser`` function for that. Here is an example of how -you would use it:: +you would use it: + +.. code-block:: python from scrapy.utils.response import open_in_browser + def parse_details(self, response): if "item name" not in response.body: open_in_browser(response) @@ -138,14 +149,16 @@ Logging Logging is another useful option for getting information about your spider run. Although not as convenient, it comes with the advantage that the logs will be -available in all future runs should they be necessary again:: +available in all future runs should they be necessary again: + +.. code-block:: python def parse_details(self, response, item=None): if item: # populate more `item` fields return item else: - self.logger.warning('No item received for %s', response.url) + self.logger.warning("No item received for %s", response.url) For more information, check the :ref:`topics-logging` section. diff --git a/docs/topics/developer-tools.rst b/docs/topics/developer-tools.rst index 9bf97c628..39e7b7d3c 100644 --- a/docs/topics/developer-tools.rst +++ b/docs/topics/developer-tools.rst @@ -237,17 +237,19 @@ on the request and open ``Open in new tab`` to get a better overview. :alt: JSON-object returned from the quotes.toscrape API With this response we can now easily parse the JSON-object and -also request each page to get every quote on the site:: +also request each page to get every quote on the site: + +.. code-block:: python import scrapy import json class QuoteSpider(scrapy.Spider): - name = 'quote' - allowed_domains = ['quotes.toscrape.com'] + name = "quote" + allowed_domains = ["quotes.toscrape.com"] page = 1 - start_urls = ['https://quotes.toscrape.com/api/quotes?page=1'] + start_urls = ["https://quotes.toscrape.com/api/quotes?page=1"] def parse(self, response): data = json.loads(response.text) @@ -275,7 +277,9 @@ requests, as we could need to add ``headers`` or ``cookies`` to make it work. In those cases you can export the requests in `cURL `_ format, by right-clicking on each of them in the network tool and using the :meth:`~scrapy.Request.from_curl()` method to generate an equivalent -request:: +request: + +.. code-block:: python from scrapy import Request @@ -286,7 +290,8 @@ request:: "-Requested-With: XMLHttpRequest' -H 'Proxy-Authorization: Basic QFRLLTAzM" "zEwZTAxLTk5MWUtNDFiNC1iZWRmLTJjNGI4M2ZiNDBmNDpAVEstMDMzMTBlMDEtOTkxZS00MW" "I0LWJlZGYtMmM0YjgzZmI0MGY0' -H 'Connection: keep-alive' -H 'Referer: http" - "://quotes.toscrape.com/scroll' -H 'Cache-Control: max-age=0'") + "://quotes.toscrape.com/scroll' -H 'Cache-Control: max-age=0'" + ) Alternatively, if you want to know the arguments needed to recreate that request you can use the :func:`~scrapy.utils.curl.curl_to_request_kwargs` diff --git a/docs/topics/downloader-middleware.rst b/docs/topics/downloader-middleware.rst index 986da0476..e1c481c37 100644 --- a/docs/topics/downloader-middleware.rst +++ b/docs/topics/downloader-middleware.rst @@ -17,10 +17,12 @@ To activate a downloader middleware component, add it to the :setting:`DOWNLOADER_MIDDLEWARES` setting, which is a dict whose keys are the middleware class paths and their values are the middleware orders. -Here's an example:: +Here's an example: + +.. code-block:: python DOWNLOADER_MIDDLEWARES = { - 'myproject.middlewares.CustomDownloaderMiddleware': 543, + "myproject.middlewares.CustomDownloaderMiddleware": 543, } The :setting:`DOWNLOADER_MIDDLEWARES` setting is merged with the @@ -42,11 +44,13 @@ previous (or subsequent) middleware being applied. If you want to disable a built-in middleware (the ones defined in :setting:`DOWNLOADER_MIDDLEWARES_BASE` and enabled by default) you must define it in your project's :setting:`DOWNLOADER_MIDDLEWARES` setting and assign ``None`` -as its value. For example, if you want to disable the user-agent middleware:: +as its value. For example, if you want to disable the user-agent middleware: + +.. code-block:: python DOWNLOADER_MIDDLEWARES = { - 'myproject.middlewares.CustomDownloaderMiddleware': 543, - 'scrapy.downloadermiddlewares.useragent.UserAgentMiddleware': None, + "myproject.middlewares.CustomDownloaderMiddleware": 543, + "scrapy.downloadermiddlewares.useragent.UserAgentMiddleware": None, } Finally, keep in mind that some middlewares may need to be enabled through a @@ -226,20 +230,25 @@ There is support for keeping multiple cookie sessions per spider by using the :reqmeta:`cookiejar` Request meta key. By default it uses a single cookie jar (session), but you can pass an identifier to use different ones. -For example:: +For example: + +.. code-block:: python for i, url in enumerate(urls): - yield scrapy.Request(url, meta={'cookiejar': i}, - callback=self.parse_page) + yield scrapy.Request(url, meta={"cookiejar": i}, callback=self.parse_page) Keep in mind that the :reqmeta:`cookiejar` meta key is not "sticky". You need to keep -passing it along on subsequent requests. For example:: +passing it along on subsequent requests. For example: + +.. code-block:: python def parse_page(self, response): # do some processing - return scrapy.Request("http://www.example.com/otherpage", - meta={'cookiejar': response.meta['cookiejar']}, - callback=self.parse_other_page) + return scrapy.Request( + "http://www.example.com/otherpage", + meta={"cookiejar": response.meta["cookiejar"]}, + callback=self.parse_other_page, + ) .. setting:: COOKIES_ENABLED @@ -339,16 +348,19 @@ HttpAuthMiddleware domain of the first request, which will work for some spiders but not for others. In the future the middleware will produce an error instead. - Example:: + Example: + + .. code-block:: python from scrapy.spiders import CrawlSpider + class SomeIntranetSiteSpider(CrawlSpider): - http_user = 'someuser' - http_pass = 'somepass' - http_auth_domain = 'intranet.example.com' - name = 'intranet.example.com' + http_user = "someuser" + http_pass = "somepass" + http_auth_domain = "intranet.example.com" + name = "intranet.example.com" # .. rest of the spider code omitted ... @@ -792,7 +804,9 @@ If you want to handle some redirect status codes in your spider, you can specify these in the ``handle_httpstatus_list`` spider attribute. For example, if you want the redirect middleware to ignore 301 and 302 -responses (and pass them through to your spider) you can do this:: +responses (and pass them through to your spider) you can do this: + +.. code-block:: python class MySpider(CrawlSpider): handle_httpstatus_list = [301, 302] diff --git a/docs/topics/dynamic-content.rst b/docs/topics/dynamic-content.rst index ea5d06210..9be0ed058 100644 --- a/docs/topics/dynamic-content.rst +++ b/docs/topics/dynamic-content.rst @@ -119,16 +119,20 @@ data from it depends on the type of response: ` as usual. - If the response is JSON, use :func:`json.loads` to load the desired data from - :attr:`response.text `:: + :attr:`response.text `: + + .. code-block:: python data = json.loads(response.text) If the desired data is inside HTML or XML code embedded within JSON data, you can load that HTML or XML code into a :class:`~scrapy.Selector` and then - :ref:`use it ` as usual:: + :ref:`use it ` as usual: - selector = Selector(data['html']) + .. code-block:: python + + selector = Selector(data["html"]) - If the response is JavaScript, or HTML with a `` -{% endblock %} From 46bb7b31d1d4ea351615ae890286e40b6d0a82c4 Mon Sep 17 00:00:00 2001 From: karza_abhishek Date: Tue, 28 Mar 2023 23:23:32 +0530 Subject: [PATCH 450/532] Fixed Docs Makefile to open build/html/index.html in browser(#5878) --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index 596cb6cef..48401bac8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -87,7 +87,7 @@ coverage: build htmlview: html $(PYTHON) -c "import webbrowser; from pathlib import Path; \ - webbrowser.open('file://' + Path('build/html/index.html').resolve())" + webbrowser.open(Path('build/html/index.html').resolve().as_uri())" clean: -rm -rf build/* From b83fa60a0a76364a64d4036e826a713a9a47f96d Mon Sep 17 00:00:00 2001 From: Prathm-s Date: Thu, 30 Mar 2023 16:57:56 +0530 Subject: [PATCH 451/532] return added to _sent_failed --- scrapy/mail.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scrapy/mail.py b/scrapy/mail.py index 43115c53e..c11f3898d 100644 --- a/scrapy/mail.py +++ b/scrapy/mail.py @@ -164,6 +164,7 @@ class MailSender: "mailerr": errstr, }, ) + return failure def _sendmail(self, to_addrs, msg): from twisted.internet import reactor From 90ce6589eee58e8aca9c368a71907b30250df68d Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Thu, 30 Mar 2023 13:07:51 +0000 Subject: [PATCH 452/532] Add try/except to safe_url_string() Added a try catch condition to the safe_url_string() processing in the LxmlParserLinkExtractor class to avoid scrapers crashing unneccessarily --- scrapy/linkextractors/lxmlhtml.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index dd8dcdf7c..1ee81427c 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -88,7 +88,11 @@ class LxmlParserLinkExtractor: url = self.process_attr(attr_val) if url is None: continue - url = safe_url_string(url, encoding=response_encoding) + try: + url = safe_url_string(url, encoding=response_encoding) + except ValueError: + continue # Disregard badly formatted urls + # to fix relative links after process_value url = urljoin(response_url, url) link = Link( From 9ef00c5c0bc16c9b44c878952a2b54310dc25638 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 08:01:54 +0000 Subject: [PATCH 453/532] Add logging Lines Adds an error loggign line to the LinkExtractor to detail encountered bad links --- scrapy/linkextractors/lxmlhtml.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 1ee81427c..f7c6937b0 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -2,6 +2,7 @@ Link extractor based on lxml.html """ import operator +import logging from functools import partial from urllib.parse import urljoin, urlparse @@ -23,6 +24,8 @@ from scrapy.utils.python import unique as unique_list from scrapy.utils.response import get_base_url from scrapy.utils.url import url_has_any_extension, url_is_from_any_domain +logger = logging.getLogger(__name__) + # from lxml/src/lxml/html/__init__.py XHTML_NAMESPACE = "http://www.w3.org/1999/xhtml" @@ -91,6 +94,7 @@ class LxmlParserLinkExtractor: try: url = safe_url_string(url, encoding=response_encoding) except ValueError: + logger.error(f"Skipping extraction of bad link {url}") continue # Disregard badly formatted urls # to fix relative links after process_value From 9cbcf7724df7de9a449659fbf68bc5d532c33499 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 08:07:43 +0000 Subject: [PATCH 454/532] Add test to make sure spider doesn't crash on bad --- tests/test_linkextractors.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index f663013ba..d992a5eae 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -815,3 +815,26 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): def test_restrict_xpaths_with_html_entities(self): super().test_restrict_xpaths_with_html_entities() + + def test_skip_bad_links(self): + html = b""" + Why would you do this? + Good Link + Good Link 2 + """ + response = HtmlResponse("http://example.org/index.html", body=html) + self.assertEqual( + [link for link in lx.extract_links(response)], + [ + Link( + url="http://example.org/item2.html", + text="Good Link", + nofollow=False, + ), + Link( + url="http://example.org/item3.html", + text="Good Link 2", + nofollow=False, + ), + ], + ) From 7cb7cf1ad1aa3d75b494a5b069e5b76b60328daa Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 08:09:02 +0000 Subject: [PATCH 455/532] Add link extractor back to test --- tests/test_linkextractors.py | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index d992a5eae..3ad1abea5 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -823,6 +823,7 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): Good Link 2 """ response = HtmlResponse("http://example.org/index.html", body=html) + lx = self.extractor_cls() self.assertEqual( [link for link in lx.extract_links(response)], [ From 00d93026c8b078d75e4fe43c344f6524f9b45f28 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 08:30:19 +0000 Subject: [PATCH 456/532] Fix bad test case --- tests/test_linkextractors.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 3ad1abea5..1ea364d80 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -818,11 +818,11 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): def test_skip_bad_links(self): html = b""" - Why would you do this? + Why would you do this? Good Link Good Link 2 """ - response = HtmlResponse("http://example.org/index.html", body=html) + response = HtmlResponse("http://example.org/index.html", body=html, encoding='utf-8') lx = self.extractor_cls() self.assertEqual( [link for link in lx.extract_links(response)], From 6d94aa061ca96275ab8b83840ac21f0e72ad1583 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20DIDIER?= <73602526+sdidier-dev@users.noreply.github.com> Date: Fri, 31 Mar 2023 11:05:20 +0200 Subject: [PATCH 457/532] Add missing 'crawl' command in crawl examples --- docs/topics/commands.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/topics/commands.rst b/docs/topics/commands.rst index 362190116..c2f2da4e2 100644 --- a/docs/topics/commands.rst +++ b/docs/topics/commands.rst @@ -288,13 +288,13 @@ Usage examples:: $ scrapy crawl myspider [ ... myspider starts crawling ... ] - $ scrapy -o myfile:csv myspider + $ scrapy crawl -o myfile:csv myspider [ ... myspider starts crawling and appends the result to the file myfile in csv format ... ] - $ scrapy -O myfile:json myspider + $ scrapy crawl -O myfile:json myspider [ ... myspider starts crawling and saves the result in myfile in json format overwriting the original content... ] - $ scrapy -o myfile -t csv myspider + $ scrapy crawl -o myfile -t csv myspider [ ... myspider starts crawling and appends the result to the file myfile in csv format ... ] .. command:: check From 4043560547faac0ee4cfadba4d0f02b4be1f72de Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 12:29:22 +0000 Subject: [PATCH 458/532] remove utf-8 encoding flag from test --- tests/test_linkextractors.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 1ea364d80..3673e82cd 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -822,7 +822,7 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): Good Link Good Link 2 """ - response = HtmlResponse("http://example.org/index.html", body=html, encoding='utf-8') + response = HtmlResponse("http://example.org/index.html", body=html) lx = self.extractor_cls() self.assertEqual( [link for link in lx.extract_links(response)], From c9a5934494cbb3fe0aa572b536ee222a3e212487 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 12:29:49 +0000 Subject: [PATCH 459/532] Reduce logging level of bad URL --- scrapy/linkextractors/lxmlhtml.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index f7c6937b0..0d1b76531 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -94,7 +94,7 @@ class LxmlParserLinkExtractor: try: url = safe_url_string(url, encoding=response_encoding) except ValueError: - logger.error(f"Skipping extraction of bad link {url}") + logger.debug(f"Skipping extraction of bad link {url}") continue # Disregard badly formatted urls # to fix relative links after process_value From 608b7de582af891a37a3fab60423c847af648db8 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 14:38:06 +0000 Subject: [PATCH 460/532] Skip new test if python version less than 3.8 --- tests/test_linkextractors.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 3673e82cd..78219f642 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -1,6 +1,7 @@ import pickle import re import unittest +import sys from scrapy.http import HtmlResponse, XmlResponse from scrapy.link import Link @@ -816,6 +817,10 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): def test_restrict_xpaths_with_html_entities(self): super().test_restrict_xpaths_with_html_entities() + @unittest.skipIf( + sys.version_info < (3, 8), + reason="Urllib3 is less strict in versions for python 3.7 so does not cause spider to crash", + ) def test_skip_bad_links(self): html = b""" Why would you do this? From 618e82dbe104c4b97cc4f7b37bf9130a76093734 Mon Sep 17 00:00:00 2001 From: Samuel Bartlett Date: Fri, 31 Mar 2023 15:12:47 +0000 Subject: [PATCH 461/532] Exclude test for python versionbs less than 3.8 --- tests/test_linkextractors.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 78219f642..784fdb658 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -819,7 +819,7 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): @unittest.skipIf( sys.version_info < (3, 8), - reason="Urllib3 is less strict in versions for python 3.7 so does not cause spider to crash", + reason="some library for python 3.7 so is less strict so bad links like htis don't crash scrapy", ) def test_skip_bad_links(self): html = b""" From a0e2e36b52743c9bf1cc03408bf4eb66e68a1edc Mon Sep 17 00:00:00 2001 From: Felipe Boff Nunes Date: Thu, 6 Apr 2023 14:23:19 -0300 Subject: [PATCH 462/532] adjustments --- scrapy/extensions/feedexport.py | 2 -- tests/test_feedexport.py | 22 +++++++++------------- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index 67ff26764..0df32083f 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -115,7 +115,6 @@ class BlockingFeedStorage: @implementer(IFeedStorage) class StdoutFeedStorage: - def __init__(self, uri, _stdout=None, *, feed_options=None): if not _stdout: _stdout = sys.stdout.buffer @@ -384,7 +383,6 @@ class FeedExporter: return defer.DeferredList(deferred_list) if deferred_list else None def _close_slot(self, slot, spider): - def get_file(slot_): if isinstance(slot_.file, PostProcessingManager): return slot_.file.file diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 45027171f..3124d9d67 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -1640,15 +1640,13 @@ class FeedExportTest(FeedExportTestBase): @defer.inlineCallbacks def test_storage_file_no_postprocessing(self): - @implementer(IFeedStorage) class Storage: - def __init__(self, uri, *, feed_options=None): pass def open(self, spider): - Storage.open_file = tempfile.NamedTemporaryFile(prefix='feed-') + Storage.open_file = tempfile.NamedTemporaryFile(prefix="feed-") return Storage.open_file def store(self, file): @@ -1656,23 +1654,21 @@ class FeedExportTest(FeedExportTestBase): file.close() settings = { - 'FEEDS': {self._random_temp_filename(): {'format': 'jsonlines'}}, - 'FEED_STORAGES': {'file': Storage}, + "FEEDS": {self._random_temp_filename(): {"format": "jsonlines"}}, + "FEED_STORAGES": {"file": Storage}, } yield self.exported_no_data(settings) self.assertIs(Storage.open_file, Storage.store_file) @defer.inlineCallbacks def test_storage_file_postprocessing(self): - @implementer(IFeedStorage) class Storage: - def __init__(self, uri, *, feed_options=None): pass def open(self, spider): - Storage.open_file = tempfile.NamedTemporaryFile(prefix='feed-') + Storage.open_file = tempfile.NamedTemporaryFile(prefix="feed-") return Storage.open_file def store(self, file): @@ -1680,15 +1676,15 @@ class FeedExportTest(FeedExportTestBase): file.close() settings = { - 'FEEDS': { + "FEEDS": { self._random_temp_filename(): { - 'format': 'jsonlines', - 'postprocessing': [ - 'scrapy.extensions.postprocessing.GzipPlugin', + "format": "jsonlines", + "postprocessing": [ + "scrapy.extensions.postprocessing.GzipPlugin", ], }, }, - 'FEED_STORAGES': {'file': Storage}, + "FEED_STORAGES": {"file": Storage}, } yield self.exported_no_data(settings) self.assertIs(Storage.open_file, Storage.store_file) From 98571eb946e24edfe5b520c0478e72b695d09a9d Mon Sep 17 00:00:00 2001 From: Mojtaba Dashtinejad Date: Mon, 10 Apr 2023 14:14:49 +0200 Subject: [PATCH 463/532] Add missing slash in selecting dynamically-loaded content documentation (#5890) --- docs/topics/dynamic-content.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/dynamic-content.rst b/docs/topics/dynamic-content.rst index d01e0a8d4..a0f4b4411 100644 --- a/docs/topics/dynamic-content.rst +++ b/docs/topics/dynamic-content.rst @@ -276,7 +276,7 @@ The following is a simple snippet to illustrate its usage within a Scrapy spider async with async_playwright() as pw: browser = await pw.chromium.launch() page = await browser.new_page() - await page.goto("https:/example.org") + await page.goto("https://example.org") title = await page.title() return {"title": title} From 23017e6e926116162cc8fbdaf38e02670ad5d5cb Mon Sep 17 00:00:00 2001 From: Felipe Boff Nunes Date: Mon, 10 Apr 2023 12:30:00 -0300 Subject: [PATCH 464/532] adjust --- scrapy/extensions/feedexport.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index 0df32083f..da1a88299 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -385,6 +385,7 @@ class FeedExporter: def _close_slot(self, slot, spider): def get_file(slot_): if isinstance(slot_.file, PostProcessingManager): + slot_.file.close() return slot_.file.file return slot_.file From c7730627a0f99afccca11437b0775757c50ca9e8 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 11 Apr 2023 15:47:41 +0400 Subject: [PATCH 465/532] Typing improvements for some core components (#5889) --- scrapy/core/downloader/__init__.py | 9 ++-- scrapy/core/engine.py | 68 ++++++++++++++++++------------ scrapy/core/scheduler.py | 31 ++++++++------ scrapy/core/scraper.py | 31 +++++++++----- scrapy/core/spidermw.py | 25 ++++++----- scrapy/crawler.py | 33 +++++++++------ scrapy/exceptions.py | 2 +- scrapy/logformatter.py | 32 +++++++++++--- scrapy/middleware.py | 10 ++--- scrapy/pipelines/__init__.py | 10 +++-- scrapy/signalmanager.py | 23 +++++----- scrapy/statscollectors.py | 65 +++++++++++++++++----------- scrapy/utils/log.py | 5 ++- scrapy/utils/misc.py | 9 +++- scrapy/utils/reactor.py | 18 ++++---- scrapy/utils/signal.py | 9 +++- tox.ini | 12 +++--- 17 files changed, 245 insertions(+), 147 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index 1b83c3a8a..dde76a547 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -4,8 +4,9 @@ from datetime import datetime from time import time from twisted.internet import defer, task +from twisted.internet.defer import Deferred -from scrapy import signals +from scrapy import Request, Spider, signals from scrapy.core.downloader.handlers import DownloadHandlers from scrapy.core.downloader.middleware import DownloaderMiddlewareManager from scrapy.resolver import dnscache @@ -86,7 +87,7 @@ class Downloader: self._slot_gc_loop.start(60) self.per_slot_settings = self.settings.getdict("DOWNLOAD_SLOTS", {}) - def fetch(self, request, spider): + def fetch(self, request: Request, spider: Spider) -> Deferred: def _deactivate(response): self.active.remove(request) return response @@ -206,12 +207,12 @@ class Downloader: return dfd.addBoth(finish_transferring) - def close(self): + def close(self) -> None: self._slot_gc_loop.stop() for slot in self.slots.values(): slot.close() - def _slot_gc(self, age=60): + def _slot_gc(self, age: float = 60) -> None: mintime = time() - age for key, slot in list(self.slots.items()): if not slot.active and slot.lastseen + slot.delay < mintime: diff --git a/scrapy/core/engine.py b/scrapy/core/engine.py index c6738b531..3e5a281b2 100644 --- a/scrapy/core/engine.py +++ b/scrapy/core/engine.py @@ -8,13 +8,16 @@ import logging import warnings from time import time from typing import ( + TYPE_CHECKING, Any, Callable, Generator, Iterable, Iterator, + List, Optional, Set, + Type, Union, cast, ) @@ -28,30 +31,36 @@ from scrapy.core.downloader import Downloader from scrapy.core.scraper import Scraper from scrapy.exceptions import CloseSpider, DontCloseSpider, ScrapyDeprecationWarning from scrapy.http import Request, Response -from scrapy.settings import BaseSettings +from scrapy.logformatter import LogFormatter +from scrapy.settings import BaseSettings, Settings +from scrapy.signalmanager import SignalManager from scrapy.spiders import Spider from scrapy.utils.log import failure_to_exc_info, logformatter_adapter from scrapy.utils.misc import create_instance, load_object from scrapy.utils.reactor import CallLaterOnce +if TYPE_CHECKING: + from scrapy.core.scheduler import BaseScheduler + from scrapy.crawler import Crawler + logger = logging.getLogger(__name__) class Slot: def __init__( self, - start_requests: Iterable, + start_requests: Iterable[Request], close_if_idle: bool, nextcall: CallLaterOnce, - scheduler, + scheduler: "BaseScheduler", ) -> None: self.closing: Optional[Deferred] = None self.inprogress: Set[Request] = set() - self.start_requests: Optional[Iterator] = iter(start_requests) - self.close_if_idle = close_if_idle - self.nextcall = nextcall - self.scheduler = scheduler - self.heartbeat = LoopingCall(nextcall.schedule) + self.start_requests: Optional[Iterator[Request]] = iter(start_requests) + self.close_if_idle: bool = close_if_idle + self.nextcall: CallLaterOnce = nextcall + self.scheduler: "BaseScheduler" = scheduler + self.heartbeat: LoopingCall = LoopingCall(nextcall.schedule) def add_request(self, request: Request) -> None: self.inprogress.add(request) @@ -75,25 +84,28 @@ class Slot: class ExecutionEngine: - def __init__(self, crawler, spider_closed_callback: Callable) -> None: - self.crawler = crawler - self.settings = crawler.settings - self.signals = crawler.signals - self.logformatter = crawler.logformatter + def __init__(self, crawler: "Crawler", spider_closed_callback: Callable) -> None: + self.crawler: "Crawler" = crawler + self.settings: Settings = crawler.settings + self.signals: SignalManager = crawler.signals + self.logformatter: LogFormatter = crawler.logformatter self.slot: Optional[Slot] = None self.spider: Optional[Spider] = None - self.running = False - self.paused = False - self.scheduler_cls = self._get_scheduler_class(crawler.settings) - downloader_cls = load_object(self.settings["DOWNLOADER"]) + self.running: bool = False + self.paused: bool = False + self.scheduler_cls: Type["BaseScheduler"] = self._get_scheduler_class( + crawler.settings + ) + downloader_cls: Type[Downloader] = load_object(self.settings["DOWNLOADER"]) self.downloader: Downloader = downloader_cls(crawler) self.scraper = Scraper(crawler) - self._spider_closed_callback = spider_closed_callback + self._spider_closed_callback: Callable = spider_closed_callback + self.start_time: Optional[float] = None - def _get_scheduler_class(self, settings: BaseSettings) -> type: + def _get_scheduler_class(self, settings: BaseSettings) -> Type["BaseScheduler"]: from scrapy.core.scheduler import BaseScheduler - scheduler_cls = load_object(settings["SCHEDULER"]) + scheduler_cls: Type = load_object(settings["SCHEDULER"]) if not issubclass(scheduler_cls, BaseScheduler): raise TypeError( f"The provided scheduler class ({settings['SCHEDULER']})" @@ -115,7 +127,7 @@ class ExecutionEngine: """Gracefully stop the execution engine""" @inlineCallbacks - def _finish_stopping_engine(_) -> Generator[Deferred, Any, None]: + def _finish_stopping_engine(_: Any) -> Generator[Deferred, Any, None]: yield self.signals.send_catch_log_deferred(signal=signals.engine_stopped) self._closewait.callback(None) @@ -141,7 +153,8 @@ class ExecutionEngine: return self.close_spider( self.spider, reason="shutdown" ) # will also close downloader - return succeed(self.downloader.close()) + self.downloader.close() + return succeed(None) def pause(self) -> None: self.paused = True @@ -209,7 +222,7 @@ class ExecutionEngine: extra={"spider": self.spider}, ) ) - d.addBoth(lambda _: cast(Slot, self.slot).remove_request(request)) + d.addBoth(lambda _: cast(Slot, self.slot).remove_request(request)) # type: ignore[arg-type] d.addErrback( lambda f: logger.info( "Error while removing request from slot", @@ -339,6 +352,7 @@ class ExecutionEngine: if isinstance(result, Response): if result.request is None: result.request = request + assert spider is not None logkws = self.logformatter.crawled(result.request, result, spider) if logkws is not None: logger.log(*logformatter_adapter(logkws), extra={"spider": spider}) @@ -350,10 +364,12 @@ class ExecutionEngine: ) return result - def _on_complete(_): + def _on_complete(_: Any) -> Any: + assert self.slot is not None self.slot.nextcall.schedule() return _ + assert spider is not None dwld = self.downloader.fetch(request, spider) dwld.addCallbacks(_on_success) dwld.addBoth(_on_complete) @@ -362,7 +378,7 @@ class ExecutionEngine: @inlineCallbacks def open_spider( self, spider: Spider, start_requests: Iterable = (), close_if_idle: bool = True - ): + ) -> Generator[Deferred, Any, None]: if self.slot is not None: raise RuntimeError(f"No free spider slot when opening {spider.name!r}") logger.info("Spider opened", extra={"spider": spider}) @@ -471,7 +487,7 @@ class ExecutionEngine: return dfd @property - def open_spiders(self) -> list: + def open_spiders(self) -> List[Spider]: warnings.warn( "ExecutionEngine.open_spiders is deprecated, please use ExecutionEngine.spider instead", category=ScrapyDeprecationWarning, diff --git a/scrapy/core/scheduler.py b/scrapy/core/scheduler.py index 3c46e3a5f..3fb0bbaff 100644 --- a/scrapy/core/scheduler.py +++ b/scrapy/core/scheduler.py @@ -2,13 +2,15 @@ import json import logging from abc import abstractmethod from pathlib import Path -from typing import Optional, Type, TypeVar +from typing import Any, Optional, Type, TypeVar, cast from twisted.internet.defer import Deferred from scrapy.crawler import Crawler +from scrapy.dupefilters import BaseDupeFilter from scrapy.http.request import Request from scrapy.spiders import Spider +from scrapy.statscollectors import StatsCollector from scrapy.utils.job import job_dir from scrapy.utils.misc import create_instance, load_object @@ -20,10 +22,10 @@ class BaseSchedulerMeta(type): Metaclass to check scheduler classes against the necessary interface """ - def __instancecheck__(cls, instance): + def __instancecheck__(cls, instance: Any) -> bool: return cls.__subclasscheck__(type(instance)) - def __subclasscheck__(cls, subclass): + def __subclasscheck__(cls, subclass: type) -> bool: return ( hasattr(subclass, "has_pending_requests") and callable(subclass.has_pending_requests) @@ -168,26 +170,26 @@ class Scheduler(BaseScheduler): def __init__( self, - dupefilter, + dupefilter: BaseDupeFilter, jobdir: Optional[str] = None, dqclass=None, mqclass=None, logunser: bool = False, - stats=None, + stats: Optional[StatsCollector] = None, pqclass=None, crawler: Optional[Crawler] = None, ): - self.df = dupefilter - self.dqdir = self._dqdir(jobdir) + self.df: BaseDupeFilter = dupefilter + self.dqdir: Optional[str] = self._dqdir(jobdir) self.pqclass = pqclass self.dqclass = dqclass self.mqclass = mqclass - self.logunser = logunser - self.stats = stats - self.crawler = crawler + self.logunser: bool = logunser + self.stats: Optional[StatsCollector] = stats + self.crawler: Optional[Crawler] = crawler @classmethod - def from_crawler(cls: Type[SchedulerTV], crawler) -> SchedulerTV: + def from_crawler(cls: Type[SchedulerTV], crawler: Crawler) -> SchedulerTV: """ Factory method, initializes the scheduler with arguments taken from the crawl settings """ @@ -242,6 +244,7 @@ class Scheduler(BaseScheduler): self.df.log(request, self.spider) return False dqok = self._dqpush(request) + assert self.stats is not None if dqok: self.stats.inc_value("scheduler/enqueued/disk", spider=self.spider) else: @@ -259,7 +262,8 @@ class Scheduler(BaseScheduler): Increment the appropriate stats, such as: ``scheduler/dequeued``, ``scheduler/dequeued/disk``, ``scheduler/dequeued/memory``. """ - request = self.mqs.pop() + request: Optional[Request] = self.mqs.pop() + assert self.stats is not None if request is not None: self.stats.inc_value("scheduler/dequeued/memory", spider=self.spider) else: @@ -295,6 +299,7 @@ class Scheduler(BaseScheduler): extra={"spider": self.spider}, ) self.logunser = False + assert self.stats is not None self.stats.inc_value("scheduler/unserializable", spider=self.spider) return False else: @@ -351,7 +356,7 @@ class Scheduler(BaseScheduler): if not path.exists(): return [] with path.open(encoding="utf-8") as f: - return json.load(f) + return cast(list, json.load(f)) def _write_dqs_state(self, dqdir: str, state: list) -> None: with Path(dqdir, "active.json").open("w", encoding="utf-8") as f: diff --git a/scrapy/core/scraper.py b/scrapy/core/scraper.py index 8468b8419..a85f6a661 100644 --- a/scrapy/core/scraper.py +++ b/scrapy/core/scraper.py @@ -15,6 +15,7 @@ from typing import ( Optional, Set, Tuple, + Type, Union, ) @@ -26,6 +27,9 @@ from scrapy import Spider, signals from scrapy.core.spidermw import SpiderMiddlewareManager from scrapy.exceptions import CloseSpider, DropItem, IgnoreRequest from scrapy.http import Request, Response +from scrapy.logformatter import LogFormatter +from scrapy.pipelines import ItemPipelineManager +from scrapy.signalmanager import SignalManager from scrapy.utils.defer import ( aiter_errback, defer_fail, @@ -96,16 +100,20 @@ class Slot: class Scraper: def __init__(self, crawler: Crawler) -> None: self.slot: Optional[Slot] = None - self.spidermw = SpiderMiddlewareManager.from_crawler(crawler) - itemproc_cls = load_object(crawler.settings["ITEM_PROCESSOR"]) - self.itemproc = itemproc_cls.from_crawler(crawler) - self.concurrent_items = crawler.settings.getint("CONCURRENT_ITEMS") - self.crawler = crawler - self.signals = crawler.signals - self.logformatter = crawler.logformatter + self.spidermw: SpiderMiddlewareManager = SpiderMiddlewareManager.from_crawler( + crawler + ) + itemproc_cls: Type[ItemPipelineManager] = load_object( + crawler.settings["ITEM_PROCESSOR"] + ) + self.itemproc: ItemPipelineManager = itemproc_cls.from_crawler(crawler) + self.concurrent_items: int = crawler.settings.getint("CONCURRENT_ITEMS") + self.crawler: Crawler = crawler + self.signals: SignalManager = crawler.signals + self.logformatter: LogFormatter = crawler.logformatter @inlineCallbacks - def open_spider(self, spider: Spider): + def open_spider(self, spider: Spider) -> Generator[Deferred, Any, None]: """Open the given spider for scraping and allocate resources for it""" self.slot = Slot(self.crawler.settings.getint("SCRAPER_SLOT_MAX_ACTIVE_SIZE")) yield self.itemproc.open_spider(spider) @@ -135,7 +143,8 @@ class Scraper: raise RuntimeError("Scraper slot not assigned") dfd = self.slot.add_response_request(result, request) - def finish_scraping(_): + def finish_scraping(_: Any) -> Any: + assert self.slot is not None self.slot.finish_response(result, request) self._check_if_closing(spider) self._scrape_next(spider) @@ -205,9 +214,9 @@ class Scraper: else: # result is a Failure # TODO: properly type adding this attribute to a Failure result.request = request # type: ignore[attr-defined] - warn_on_generator_with_return_value(spider, request.errback) dfd = defer_fail(result) if request.errback: + warn_on_generator_with_return_value(spider, request.errback) dfd.addErrback(request.errback) return dfd.addCallback(iterate_spider_output) @@ -338,7 +347,7 @@ class Scraper: def _itemproc_finished( self, output: Any, item: Any, response: Response, spider: Spider - ) -> None: + ) -> Deferred: """ItemProcessor finished for the given ``item`` and returned ``output``""" assert self.slot is not None # typing self.slot.itemproc_size -= 1 diff --git a/scrapy/core/spidermw.py b/scrapy/core/spidermw.py index c21985b18..dcf1a6dbc 100644 --- a/scrapy/core/spidermw.py +++ b/scrapy/core/spidermw.py @@ -13,6 +13,8 @@ from typing import ( Callable, Generator, Iterable, + List, + Optional, Tuple, Union, cast, @@ -25,6 +27,7 @@ from scrapy import Request, Spider from scrapy.exceptions import _InvalidOutput from scrapy.http import Response from scrapy.middleware import MiddlewareManager +from scrapy.settings import BaseSettings from scrapy.utils.asyncgen import as_async_generator, collect_asyncgen from scrapy.utils.conf import build_component_list from scrapy.utils.defer import ( @@ -41,22 +44,22 @@ logger = logging.getLogger(__name__) ScrapeFunc = Callable[[Union[Response, Failure], Request, Spider], Any] -def _isiterable(o) -> bool: +def _isiterable(o: Any) -> bool: return isinstance(o, (Iterable, AsyncIterable)) class SpiderMiddlewareManager(MiddlewareManager): component_name = "spider middleware" - def __init__(self, *middlewares): + def __init__(self, *middlewares: Any): super().__init__(*middlewares) self.downgrade_warning_done = False @classmethod - def _get_mwlist_from_settings(cls, settings): + def _get_mwlist_from_settings(cls, settings: BaseSettings) -> List[Any]: return build_component_list(settings.getwithbase("SPIDER_MIDDLEWARES")) - def _add_middleware(self, mw): + def _add_middleware(self, mw: Any) -> None: super()._add_middleware(mw) if hasattr(mw, "process_spider_input"): self.methods["process_spider_input"].append(mw.process_spider_input) @@ -98,7 +101,7 @@ class SpiderMiddlewareManager(MiddlewareManager): exception_processor_index: int, recover_to: Union[MutableChain, MutableAsyncChain], ) -> Union[Generator, AsyncGenerator]: - def process_sync(iterable: Iterable): + def process_sync(iterable: Iterable) -> Generator: try: for r in iterable: yield r @@ -110,7 +113,7 @@ class SpiderMiddlewareManager(MiddlewareManager): raise recover_to.extend(exception_result) - async def process_async(iterable: AsyncIterable): + async def process_async(iterable: AsyncIterable) -> AsyncGenerator: try: async for r in iterable: yield r @@ -280,7 +283,7 @@ class SpiderMiddlewareManager(MiddlewareManager): if isinstance(recovered, AsyncIterable): recovered_collected = await collect_asyncgen(recovered) recovered = MutableChain(recovered_collected) - return MutableChain(result, recovered) # type: ignore[arg-type] + return MutableChain(result, recovered) def scrape_response( self, @@ -306,7 +309,9 @@ class SpiderMiddlewareManager(MiddlewareManager): ) return dfd - def process_start_requests(self, start_requests, spider: Spider) -> Deferred: + def process_start_requests( + self, start_requests: Iterable[Request], spider: Spider + ) -> Deferred: return self._process_chain("process_start_requests", start_requests, spider) # This method is only needed until _async compatibility methods are removed. @@ -314,9 +319,9 @@ class SpiderMiddlewareManager(MiddlewareManager): def _get_async_method_pair( mw: Any, methodname: str ) -> Union[None, Callable, Tuple[Callable, Callable]]: - normal_method = getattr(mw, methodname, None) + normal_method: Optional[Callable] = getattr(mw, methodname, None) methodname_async = methodname + "_async" - async_method = getattr(mw, methodname_async, None) + async_method: Optional[Callable] = getattr(mw, methodname_async, None) if not async_method: return normal_method if not normal_method: diff --git a/scrapy/crawler.py b/scrapy/crawler.py index 397817d6f..256f6e2c5 100644 --- a/scrapy/crawler.py +++ b/scrapy/crawler.py @@ -4,7 +4,7 @@ import logging import pprint import signal import warnings -from typing import TYPE_CHECKING, Optional +from typing import TYPE_CHECKING, Optional, Type, Union from twisted.internet import defer from zope.interface.exceptions import DoesNotImplement @@ -22,8 +22,10 @@ from scrapy.core.engine import ExecutionEngine from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.extension import ExtensionManager from scrapy.interfaces import ISpiderLoader +from scrapy.logformatter import LogFormatter from scrapy.settings import Settings, overridden_settings from scrapy.signalmanager import SignalManager +from scrapy.statscollectors import StatsCollector from scrapy.utils.log import ( LogCounterHandler, configure_logging, @@ -49,20 +51,25 @@ logger = logging.getLogger(__name__) class Crawler: - def __init__(self, spidercls, settings=None, init_reactor: bool = False): + def __init__( + self, + spidercls: Type[Spider], + settings: Union[None, dict, Settings] = None, + init_reactor: bool = False, + ): if isinstance(spidercls, Spider): raise ValueError("The spidercls argument must be a class, not an object") if isinstance(settings, dict) or settings is None: settings = Settings(settings) - self.spidercls = spidercls - self.settings = settings.copy() + self.spidercls: Type[Spider] = spidercls + self.settings: Settings = settings.copy() self.spidercls.update_settings(self.settings) - self.signals = SignalManager(self) + self.signals: SignalManager = SignalManager(self) - self.stats = load_object(self.settings["STATS_CLASS"])(self) + self.stats: StatsCollector = load_object(self.settings["STATS_CLASS"])(self) handler = LogCounterHandler(self, level=self.settings.get("LOG_LEVEL")) logging.root.addHandler(handler) @@ -80,8 +87,8 @@ class Crawler: self.__remove_handler = lambda: logging.root.removeHandler(handler) self.signals.connect(self.__remove_handler, signals.engine_stopped) - lf_cls = load_object(self.settings["LOG_FORMATTER"]) - self.logformatter = lf_cls.from_crawler(self) + lf_cls: Type[LogFormatter] = load_object(self.settings["LOG_FORMATTER"]) + self.logformatter: LogFormatter = lf_cls.from_crawler(self) self.request_fingerprinter: RequestFingerprinter = create_instance( load_object(self.settings["REQUEST_FINGERPRINTER_CLASS"]), @@ -89,8 +96,8 @@ class Crawler: crawler=self, ) - reactor_class = self.settings["TWISTED_REACTOR"] - event_loop = self.settings["ASYNCIO_EVENT_LOOP"] + reactor_class: str = self.settings["TWISTED_REACTOR"] + event_loop: str = self.settings["ASYNCIO_EVENT_LOOP"] if init_reactor: # this needs to be done after the spider settings are merged, # but before something imports twisted.internet.reactor @@ -104,11 +111,11 @@ class Crawler: if is_asyncio_reactor_installed() and event_loop: verify_installed_asyncio_event_loop(event_loop) - self.extensions = ExtensionManager.from_crawler(self) + self.extensions: ExtensionManager = ExtensionManager.from_crawler(self) self.settings.freeze() - self.crawling = False - self.spider = None + self.crawling: bool = False + self.spider: Optional[Spider] = None self.engine: Optional[ExecutionEngine] = None @defer.inlineCallbacks diff --git a/scrapy/exceptions.py b/scrapy/exceptions.py index 7f202b8b8..fedd02805 100644 --- a/scrapy/exceptions.py +++ b/scrapy/exceptions.py @@ -39,7 +39,7 @@ class DontCloseSpider(Exception): class CloseSpider(Exception): """Raise this from callbacks to request the spider to be closed""" - def __init__(self, reason="cancelled"): + def __init__(self, reason: str = "cancelled"): super().__init__() self.reason = reason diff --git a/scrapy/logformatter.py b/scrapy/logformatter.py index 560006c95..7cb379b46 100644 --- a/scrapy/logformatter.py +++ b/scrapy/logformatter.py @@ -1,8 +1,11 @@ import logging import os +from typing import Any, Dict, Optional, Union from twisted.python.failure import Failure +from scrapy import Request, Spider +from scrapy.http import Response from scrapy.utils.request import referer_str SCRAPEDMSG = "Scraped from %(src)s" + os.linesep + "%(item)s" @@ -52,7 +55,7 @@ class LogFormatter: } """ - def crawled(self, request, response, spider): + def crawled(self, request: Request, response: Response, spider: Spider) -> dict: """Logs a message when the crawler finds a webpage.""" request_flags = f" {str(request.flags)}" if request.flags else "" response_flags = f" {str(response.flags)}" if response.flags else "" @@ -70,8 +73,11 @@ class LogFormatter: }, } - def scraped(self, item, response, spider): + def scraped( + self, item: Any, response: Union[Response, Failure], spider: Spider + ) -> dict: """Logs a message when an item is scraped by a spider.""" + src: Any if isinstance(response, Failure): src = response.getErrorMessage() else: @@ -85,7 +91,9 @@ class LogFormatter: }, } - def dropped(self, item, exception, response, spider): + def dropped( + self, item: Any, exception: BaseException, response: Response, spider: Spider + ) -> dict: """Logs a message when an item is dropped while it is passing through the item pipeline.""" return { "level": logging.WARNING, @@ -96,7 +104,9 @@ class LogFormatter: }, } - def item_error(self, item, exception, response, spider): + def item_error( + self, item: Any, exception, response: Response, spider: Spider + ) -> dict: """Logs a message when an item causes an error while it is passing through the item pipeline. @@ -110,7 +120,9 @@ class LogFormatter: }, } - def spider_error(self, failure, request, response, spider): + def spider_error( + self, failure: Failure, request: Request, response: Response, spider: Spider + ) -> dict: """Logs an error message from a spider. .. versionadded:: 2.0 @@ -124,13 +136,19 @@ class LogFormatter: }, } - def download_error(self, failure, request, spider, errmsg=None): + def download_error( + self, + failure: Failure, + request: Request, + spider: Spider, + errmsg: Optional[str] = None, + ) -> dict: """Logs a download error message from a spider (typically coming from the engine). .. versionadded:: 2.0 """ - args = {"request": request} + args: Dict[str, Any] = {"request": request} if errmsg: msg = DOWNLOADERRORMSG_LONG args["errmsg"] = errmsg diff --git a/scrapy/middleware.py b/scrapy/middleware.py index f82d722fa..03e92b565 100644 --- a/scrapy/middleware.py +++ b/scrapy/middleware.py @@ -1,7 +1,7 @@ import logging import pprint from collections import defaultdict, deque -from typing import Any, Callable, Deque, Dict, Iterable, Tuple, Union, cast +from typing import Any, Callable, Deque, Dict, Iterable, List, Tuple, Union, cast from twisted.internet.defer import Deferred @@ -30,7 +30,7 @@ class MiddlewareManager: self._add_middleware(mw) @classmethod - def _get_mwlist_from_settings(cls, settings: Settings) -> list: + def _get_mwlist_from_settings(cls, settings: Settings) -> List[Any]: raise NotImplementedError @classmethod @@ -67,17 +67,17 @@ class MiddlewareManager: def from_crawler(cls, crawler): return cls.from_settings(crawler.settings, crawler) - def _add_middleware(self, mw) -> None: + def _add_middleware(self, mw: Any) -> None: if hasattr(mw, "open_spider"): self.methods["open_spider"].append(mw.open_spider) if hasattr(mw, "close_spider"): self.methods["close_spider"].appendleft(mw.close_spider) - def _process_parallel(self, methodname: str, obj, *args) -> Deferred: + def _process_parallel(self, methodname: str, obj: Any, *args: Any) -> Deferred: methods = cast(Iterable[Callable], self.methods[methodname]) return process_parallel(methods, obj, *args) - def _process_chain(self, methodname: str, obj, *args) -> Deferred: + def _process_chain(self, methodname: str, obj: Any, *args: Any) -> Deferred: methods = cast(Iterable[Callable], self.methods[methodname]) return process_chain(methods, obj, *args) diff --git a/scrapy/pipelines/__init__.py b/scrapy/pipelines/__init__.py index df574a0a1..c97d71fb6 100644 --- a/scrapy/pipelines/__init__.py +++ b/scrapy/pipelines/__init__.py @@ -3,7 +3,11 @@ Item pipeline See documentation in docs/item-pipeline.rst """ +from typing import Any, List +from twisted.internet.defer import Deferred + +from scrapy import Spider from scrapy.middleware import MiddlewareManager from scrapy.utils.conf import build_component_list from scrapy.utils.defer import deferred_f_from_coro_f @@ -13,15 +17,15 @@ class ItemPipelineManager(MiddlewareManager): component_name = "item pipeline" @classmethod - def _get_mwlist_from_settings(cls, settings): + def _get_mwlist_from_settings(cls, settings) -> List[Any]: return build_component_list(settings.getwithbase("ITEM_PIPELINES")) - def _add_middleware(self, pipe): + def _add_middleware(self, pipe: Any) -> None: super()._add_middleware(pipe) if hasattr(pipe, "process_item"): self.methods["process_item"].append( deferred_f_from_coro_f(pipe.process_item) ) - def process_item(self, item, spider): + def process_item(self, item: Any, spider: Spider) -> Deferred: return self._process_chain("process_item", item, spider) diff --git a/scrapy/signalmanager.py b/scrapy/signalmanager.py index d7e3bce91..f6df191d8 100644 --- a/scrapy/signalmanager.py +++ b/scrapy/signalmanager.py @@ -1,13 +1,16 @@ +from typing import Any, List, Tuple + from pydispatch import dispatcher +from twisted.internet.defer import Deferred from scrapy.utils import signal as _signal class SignalManager: - def __init__(self, sender=dispatcher.Anonymous): - self.sender = sender + def __init__(self, sender: Any = dispatcher.Anonymous): + self.sender: Any = sender - def connect(self, receiver, signal, **kwargs): + def connect(self, receiver: Any, signal: Any, **kwargs: Any) -> None: """ Connect a receiver function to a signal. @@ -22,18 +25,18 @@ class SignalManager: :type signal: object """ kwargs.setdefault("sender", self.sender) - return dispatcher.connect(receiver, signal, **kwargs) + dispatcher.connect(receiver, signal, **kwargs) - def disconnect(self, receiver, signal, **kwargs): + def disconnect(self, receiver: Any, signal: Any, **kwargs: Any) -> None: """ Disconnect a receiver function from a signal. This has the opposite effect of the :meth:`connect` method, and the arguments are the same. """ kwargs.setdefault("sender", self.sender) - return dispatcher.disconnect(receiver, signal, **kwargs) + dispatcher.disconnect(receiver, signal, **kwargs) - def send_catch_log(self, signal, **kwargs): + def send_catch_log(self, signal: Any, **kwargs: Any) -> List[Tuple[Any, Any]]: """ Send a signal, catch exceptions and log them. @@ -43,7 +46,7 @@ class SignalManager: kwargs.setdefault("sender", self.sender) return _signal.send_catch_log(signal, **kwargs) - def send_catch_log_deferred(self, signal, **kwargs): + def send_catch_log_deferred(self, signal: Any, **kwargs: Any) -> Deferred: """ Like :meth:`send_catch_log` but supports returning :class:`~twisted.internet.defer.Deferred` objects from signal handlers. @@ -57,7 +60,7 @@ class SignalManager: kwargs.setdefault("sender", self.sender) return _signal.send_catch_log_deferred(signal, **kwargs) - def disconnect_all(self, signal, **kwargs): + def disconnect_all(self, signal: Any, **kwargs: Any) -> None: """ Disconnect all receivers from the given signal. @@ -65,4 +68,4 @@ class SignalManager: :type signal: object """ kwargs.setdefault("sender", self.sender) - return _signal.disconnect_all(signal, **kwargs) + _signal.disconnect_all(signal, **kwargs) diff --git a/scrapy/statscollectors.py b/scrapy/statscollectors.py index dd3c32737..15193aac5 100644 --- a/scrapy/statscollectors.py +++ b/scrapy/statscollectors.py @@ -3,44 +3,57 @@ Scrapy extension for collecting scraping stats """ import logging import pprint +from typing import TYPE_CHECKING, Any, Dict, Optional + +from scrapy import Spider + +if TYPE_CHECKING: + from scrapy.crawler import Crawler logger = logging.getLogger(__name__) -class StatsCollector: - def __init__(self, crawler): - self._dump = crawler.settings.getbool("STATS_DUMP") - self._stats = {} +StatsT = Dict[str, Any] - def get_value(self, key, default=None, spider=None): + +class StatsCollector: + def __init__(self, crawler: "Crawler"): + self._dump: bool = crawler.settings.getbool("STATS_DUMP") + self._stats: StatsT = {} + + def get_value( + self, key: str, default: Any = None, spider: Optional[Spider] = None + ) -> Any: return self._stats.get(key, default) - def get_stats(self, spider=None): + def get_stats(self, spider: Optional[Spider] = None) -> StatsT: return self._stats - def set_value(self, key, value, spider=None): + def set_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: self._stats[key] = value - def set_stats(self, stats, spider=None): + def set_stats(self, stats: StatsT, spider: Optional[Spider] = None) -> None: self._stats = stats - def inc_value(self, key, count=1, start=0, spider=None): + def inc_value( + self, key: str, count: int = 1, start: int = 0, spider: Optional[Spider] = None + ) -> None: d = self._stats d[key] = d.setdefault(key, start) + count - def max_value(self, key, value, spider=None): + def max_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: self._stats[key] = max(self._stats.setdefault(key, value), value) - def min_value(self, key, value, spider=None): + def min_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: self._stats[key] = min(self._stats.setdefault(key, value), value) - def clear_stats(self, spider=None): + def clear_stats(self, spider: Optional[Spider] = None) -> None: self._stats.clear() - def open_spider(self, spider): + def open_spider(self, spider: Spider) -> None: pass - def close_spider(self, spider, reason): + def close_spider(self, spider: Spider, reason: str) -> None: if self._dump: logger.info( "Dumping Scrapy stats:\n" + pprint.pformat(self._stats), @@ -48,34 +61,38 @@ class StatsCollector: ) self._persist_stats(self._stats, spider) - def _persist_stats(self, stats, spider): + def _persist_stats(self, stats: StatsT, spider: Spider) -> None: pass class MemoryStatsCollector(StatsCollector): - def __init__(self, crawler): + def __init__(self, crawler: "Crawler"): super().__init__(crawler) - self.spider_stats = {} + self.spider_stats: Dict[str, StatsT] = {} - def _persist_stats(self, stats, spider): + def _persist_stats(self, stats: StatsT, spider: Spider) -> None: self.spider_stats[spider.name] = stats class DummyStatsCollector(StatsCollector): - def get_value(self, key, default=None, spider=None): + def get_value( + self, key: str, default: Any = None, spider: Optional[Spider] = None + ) -> Any: return default - def set_value(self, key, value, spider=None): + def set_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: pass - def set_stats(self, stats, spider=None): + def set_stats(self, stats: StatsT, spider: Optional[Spider] = None) -> None: pass - def inc_value(self, key, count=1, start=0, spider=None): + def inc_value( + self, key: str, count: int = 1, start: int = 0, spider: Optional[Spider] = None + ) -> None: pass - def max_value(self, key, value, spider=None): + def max_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: pass - def min_value(self, key, value, spider=None): + def min_value(self, key: str, value: Any, spider: Optional[Spider] = None) -> None: pass diff --git a/scrapy/utils/log.py b/scrapy/utils/log.py index 6ae27dc29..2ce4725f4 100644 --- a/scrapy/utils/log.py +++ b/scrapy/utils/log.py @@ -2,6 +2,7 @@ import logging import sys import warnings from logging.config import dictConfig +from typing import Tuple from twisted.python import log as twisted_log from twisted.python.failure import Failure @@ -14,7 +15,7 @@ from scrapy.utils.versions import scrapy_components_versions logger = logging.getLogger(__name__) -def failure_to_exc_info(failure): +def failure_to_exc_info(failure: Failure): """Extract exc_info from Failure instances""" if isinstance(failure, Failure): return (failure.type, failure.value, failure.getTracebackObject()) @@ -206,7 +207,7 @@ class LogCounterHandler(logging.Handler): self.crawler.stats.inc_value(sname) -def logformatter_adapter(logkws): +def logformatter_adapter(logkws: dict) -> Tuple[int, str, dict]: """ Helper that takes the dictionary output from the methods in LogFormatter and adapts it into a tuple of positional arguments for logger.log calls, diff --git a/scrapy/utils/misc.py b/scrapy/utils/misc.py index f9f9c0d5b..d861c9ab6 100644 --- a/scrapy/utils/misc.py +++ b/scrapy/utils/misc.py @@ -10,6 +10,7 @@ from contextlib import contextmanager from functools import partial from importlib import import_module from pkgutil import iter_modules +from typing import TYPE_CHECKING, Any, Callable, Union from w3lib.html import replace_entities @@ -18,6 +19,10 @@ from scrapy.utils.datatypes import LocalWeakReferencedCache from scrapy.utils.deprecate import ScrapyDeprecationWarning from scrapy.utils.python import flatten, to_unicode +if TYPE_CHECKING: + from scrapy import Spider + + _ITERABLE_SINGLE_VALUES = dict, Item, str, bytes @@ -34,7 +39,7 @@ def arg_to_iter(arg): return [arg] -def load_object(path): +def load_object(path: Union[str, Callable]) -> Any: """Load an object given its absolute object path, and return it. The object can be the import path of a class, function, variable or an @@ -249,7 +254,7 @@ def is_generator_with_return_value(callable): return _generator_callbacks_cache[callable] -def warn_on_generator_with_return_value(spider, callable): +def warn_on_generator_with_return_value(spider: "Spider", callable: Callable) -> None: """ Logs a warning if a callable is a generator function and includes a 'return' statement with a value different than None diff --git a/scrapy/utils/reactor.py b/scrapy/utils/reactor.py index 7f67d036a..f1b9239e6 100644 --- a/scrapy/utils/reactor.py +++ b/scrapy/utils/reactor.py @@ -1,9 +1,11 @@ import asyncio import sys from contextlib import suppress +from typing import Any, Callable, Dict, Optional, Sequence from warnings import catch_warnings, filterwarnings, warn from twisted.internet import asyncioreactor, error +from twisted.internet.base import DelayedCall from scrapy.exceptions import ScrapyDeprecationWarning from scrapy.utils.misc import load_object @@ -34,23 +36,23 @@ class CallLaterOnce: it hasn't been already scheduled since the last time it ran. """ - def __init__(self, func, *a, **kw): - self._func = func - self._a = a - self._kw = kw - self._call = None + def __init__(self, func: Callable, *a: Any, **kw: Any): + self._func: Callable = func + self._a: Sequence[Any] = a + self._kw: Dict[str, Any] = kw + self._call: Optional[DelayedCall] = None - def schedule(self, delay=0): + def schedule(self, delay: float = 0) -> None: from twisted.internet import reactor if self._call is None: self._call = reactor.callLater(delay, self) - def cancel(self): + def cancel(self) -> None: if self._call: self._call.cancel() - def __call__(self): + def __call__(self) -> Any: self._call = None return self._func(*self._a, **self._kw) diff --git a/scrapy/utils/signal.py b/scrapy/utils/signal.py index b95786d35..9e7ddd827 100644 --- a/scrapy/utils/signal.py +++ b/scrapy/utils/signal.py @@ -1,6 +1,8 @@ """Helper functions for working with signals""" import collections.abc import logging +from typing import Any as TypingAny +from typing import List, Tuple from pydispatch.dispatcher import ( Anonymous, @@ -20,7 +22,9 @@ from scrapy.utils.log import failure_to_exc_info logger = logging.getLogger(__name__) -def send_catch_log(signal=Any, sender=Anonymous, *arguments, **named): +def send_catch_log( + signal=Any, sender=Anonymous, *arguments, **named +) -> List[Tuple[TypingAny, TypingAny]]: """Like pydispatcher.robust.sendRobust but it also logs errors and returns Failures instead of exceptions. """ @@ -32,8 +36,9 @@ def send_catch_log(signal=Any, sender=Anonymous, *arguments, **named): ) dont_log += (StopDownload,) spider = named.get("spider", None) - responses = [] + responses: List[Tuple[TypingAny, TypingAny]] = [] for receiver in liveReceivers(getAllReceivers(sender, signal)): + result: TypingAny try: response = robustApply( receiver, signal=signal, sender=sender, *arguments, **named diff --git a/tox.ini b/tox.ini index 5a9d9cf29..d96a278ea 100644 --- a/tox.ini +++ b/tox.ini @@ -37,13 +37,13 @@ install_command = [testenv:typing] basepython = python3 deps = - mypy==1.0.1 + mypy==1.2.0 types-attrs==19.1.0 - types-lxml==2023.2.11 - types-Pillow==9.4.0.16 - types-Pygments==2.14.0.5 - types-pyOpenSSL==23.0.0.4 - types-setuptools==67.4.0.1 + types-lxml==2023.3.28 + types-Pillow==9.4.0.19 + types-Pygments==2.14.0.7 + types-pyOpenSSL==23.1.0.1 + types-setuptools==67.6.0.7 commands = mypy --show-error-codes {posargs: scrapy tests} From d47c732ae9ebda84c689563048919923ddb17383 Mon Sep 17 00:00:00 2001 From: Kartik Kumar <130273246+heppymxm@users.noreply.github.com> Date: Tue, 11 Apr 2023 21:55:42 +0530 Subject: [PATCH 466/532] base64-decode GCS checksums (#5891) --- scrapy/pipelines/files.py | 3 ++- tests/test_pipeline_files.py | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/scrapy/pipelines/files.py b/scrapy/pipelines/files.py index 6e9f661e5..4b594ccb7 100644 --- a/scrapy/pipelines/files.py +++ b/scrapy/pipelines/files.py @@ -3,6 +3,7 @@ Files Pipeline See documentation in topics/media-pipeline.rst """ +import base64 import functools import hashlib import logging @@ -228,7 +229,7 @@ class GCSFilesStore: def stat_file(self, path, info): def _onsuccess(blob): if blob: - checksum = blob.md5_hash + checksum = base64.b64decode(blob.md5_hash).hex() last_modified = time.mktime(blob.updated.timetuple()) return {"checksum": checksum, "last_modified": last_modified} return {} diff --git a/tests/test_pipeline_files.py b/tests/test_pipeline_files.py index 9701e5d4e..c80666586 100644 --- a/tests/test_pipeline_files.py +++ b/tests/test_pipeline_files.py @@ -601,7 +601,7 @@ class TestGCSFilesStore(unittest.TestCase): s = yield store.stat_file(path, info=None) self.assertIn("last_modified", s) self.assertIn("checksum", s) - self.assertEqual(s["checksum"], "zc2oVgXkbQr2EQdSdw3OPA==") + self.assertEqual(s["checksum"], "cdcda85605e46d0af6110752770dce3c") u = urlparse(uri) content, acl, blob = get_gcs_content_and_delete(u.hostname, u.path[1:] + path) self.assertEqual(content, data) From 3f0c2fae5e18c448bd1791920500c976d44fc321 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Wed, 12 Apr 2023 09:28:28 +0200 Subject: [PATCH 467/532] Skip test_skip_bad_links based on the w3lib version --- scrapy/linkextractors/lxmlhtml.py | 6 +++--- tests/test_linkextractors.py | 16 +++++++++++----- tox.ini | 1 + 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/scrapy/linkextractors/lxmlhtml.py b/scrapy/linkextractors/lxmlhtml.py index 0d1b76531..23cbd0116 100644 --- a/scrapy/linkextractors/lxmlhtml.py +++ b/scrapy/linkextractors/lxmlhtml.py @@ -1,8 +1,8 @@ """ Link extractor based on lxml.html """ -import operator import logging +import operator from functools import partial from urllib.parse import urljoin, urlparse @@ -94,8 +94,8 @@ class LxmlParserLinkExtractor: try: url = safe_url_string(url, encoding=response_encoding) except ValueError: - logger.debug(f"Skipping extraction of bad link {url}") - continue # Disregard badly formatted urls + logger.debug(f"Skipping extraction of link with bad URL {url!r}") + continue # to fix relative links after process_value url = urljoin(response_url, url) diff --git a/tests/test_linkextractors.py b/tests/test_linkextractors.py index 784fdb658..e1ec19601 100644 --- a/tests/test_linkextractors.py +++ b/tests/test_linkextractors.py @@ -1,7 +1,10 @@ import pickle import re import unittest -import sys + +from packaging.version import Version +from pytest import mark +from w3lib import __version__ as w3lib_version from scrapy.http import HtmlResponse, XmlResponse from scrapy.link import Link @@ -817,13 +820,16 @@ class LxmlLinkExtractorTestCase(Base.LinkExtractorTestCase): def test_restrict_xpaths_with_html_entities(self): super().test_restrict_xpaths_with_html_entities() - @unittest.skipIf( - sys.version_info < (3, 8), - reason="some library for python 3.7 so is less strict so bad links like htis don't crash scrapy", + @mark.skipif( + Version(w3lib_version) < Version("2.0.0"), + reason=( + "Before w3lib 2.0.0, w3lib.url.safe_url_string would not complain " + "about an invalid port value." + ), ) def test_skip_bad_links(self): html = b""" - Why would you do this? + Why would you do this? Good Link Good Link 2 """ diff --git a/tox.ini b/tox.ini index 5a9d9cf29..873e7662b 100644 --- a/tox.ini +++ b/tox.ini @@ -101,6 +101,7 @@ install_command = python -I -m pip install {opts} {packages} [testenv:pinned] +basepython = python3.7 deps = {[pinned]deps} PyDispatcher==2.0.5 From c2a31974ffc06412a5ab8d87fe070c98cd9c856b Mon Sep 17 00:00:00 2001 From: Serhii A Date: Thu, 13 Apr 2023 12:44:20 +0300 Subject: [PATCH 468/532] Improve get_func_args (#5885) --- scrapy/utils/python.py | 52 +++++++++++++++++++------------------- tests/test_utils_python.py | 10 +++----- 2 files changed, 29 insertions(+), 33 deletions(-) diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index fc50e0f12..818fa5d6b 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -174,33 +174,33 @@ def binary_is_text(data): def get_func_args(func, stripself=False): - """Return the argument name list of a callable""" - if inspect.isfunction(func): - spec = inspect.getfullargspec(func) - func_args = spec.args + spec.kwonlyargs - elif inspect.isclass(func): - return get_func_args(func.__init__, True) - elif inspect.ismethod(func): - return get_func_args(func.__func__, True) - elif inspect.ismethoddescriptor(func): - return [] - elif isinstance(func, partial): - return [ - x - for x in get_func_args(func.func)[len(func.args) :] - if not (func.keywords and x in func.keywords) - ] - elif hasattr(func, "__call__"): - if inspect.isroutine(func): - return [] - if getattr(func, "__name__", None) == "__call__": - return [] - return get_func_args(func.__call__, True) + """Return the argument name list of a callable object""" + if not callable(func): + raise TypeError(f"func must be callable, got '{type(func).__name__}'") + + args = [] + try: + sig = inspect.signature(func) + except ValueError: + return args + + if isinstance(func, partial): + partial_args = func.args + partial_kw = func.keywords + + for name, param in sig.parameters.items(): + if param.name in partial_args: + continue + if partial_kw and param.name in partial_kw: + continue + args.append(name) else: - raise TypeError(f"{type(func)} is not callable") - if stripself: - func_args.pop(0) - return func_args + for name in sig.parameters.keys(): + args.append(name) + + if stripself and args and args[0] == "self": + args = args[1:] + return args def get_spec(func): diff --git a/tests/test_utils_python.py b/tests/test_utils_python.py index 57f40c2e5..80d2e8da1 100644 --- a/tests/test_utils_python.py +++ b/tests/test_utils_python.py @@ -235,20 +235,16 @@ class UtilsPythonTestCase(unittest.TestCase): self.assertEqual(get_func_args(partial_f3), ["c"]) self.assertEqual(get_func_args(cal), ["a", "b", "c"]) self.assertEqual(get_func_args(object), []) + self.assertEqual(get_func_args(str.split, stripself=True), ["sep", "maxsplit"]) + self.assertEqual(get_func_args(" ".join, stripself=True), ["iterable"]) if platform.python_implementation() == "CPython": - # TODO: how do we fix this to return the actual argument names? - self.assertEqual(get_func_args(str.split), []) - self.assertEqual(get_func_args(" ".join), []) + # doesn't work on CPython: https://bugs.python.org/issue42785 self.assertEqual(get_func_args(operator.itemgetter(2)), []) elif platform.python_implementation() == "PyPy": - self.assertEqual( - get_func_args(str.split, stripself=True), ["sep", "maxsplit"] - ) self.assertEqual( get_func_args(operator.itemgetter(2), stripself=True), ["obj"] ) - self.assertEqual(get_func_args(" ".join, stripself=True), ["iterable"]) def test_without_none_values(self): self.assertEqual(without_none_values([1, None, 3, 4]), [1, 3, 4]) From 441ac196e4151765fa424af59f3938e72b8434c1 Mon Sep 17 00:00:00 2001 From: guillermo-bondonno <95530227+guillermo-bondonno@users.noreply.github.com> Date: Thu, 13 Apr 2023 12:46:59 -0300 Subject: [PATCH 469/532] Implement a request_to_curl function (#5892) --- scrapy/utils/request.py | 31 ++++++++++++++++++ tests/test_utils_request.py | 64 +++++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+) diff --git a/scrapy/utils/request.py b/scrapy/utils/request.py index 409ca2e52..6d8be991d 100644 --- a/scrapy/utils/request.py +++ b/scrapy/utils/request.py @@ -327,3 +327,34 @@ def _get_method(obj, name): return getattr(obj, name) except AttributeError: raise ValueError(f"Method {name!r} not found in: {obj}") + + +def request_to_curl(request: Request) -> str: + """ + Converts a :class:`~scrapy.Request` object to a curl command. + + :param :class:`~scrapy.Request`: Request object to be converted + :return: string containing the curl command + """ + method = request.method + + data = f"--data-raw '{request.body.decode('utf-8')}'" if request.body else "" + + headers = " ".join( + f"-H '{k.decode()}: {v[0].decode()}'" for k, v in request.headers.items() + ) + + url = request.url + cookies = "" + if request.cookies: + if isinstance(request.cookies, dict): + cookie = "; ".join(f"{k}={v}" for k, v in request.cookies.items()) + cookies = f"--cookie '{cookie}'" + elif isinstance(request.cookies, list): + cookie = "; ".join( + f"{list(c.keys())[0]}={list(c.values())[0]}" for c in request.cookies + ) + cookies = f"--cookie '{cookie}'" + + curl_cmd = f"curl -X {method} {url} {data} {headers} {cookies}".strip() + return " ".join(curl_cmd.split()) diff --git a/tests/test_utils_request.py b/tests/test_utils_request.py index 6ca272de1..e6d1abe3f 100644 --- a/tests/test_utils_request.py +++ b/tests/test_utils_request.py @@ -1,3 +1,4 @@ +import json import unittest import warnings from hashlib import sha1 @@ -18,6 +19,7 @@ from scrapy.utils.request import ( request_authenticate, request_fingerprint, request_httprepr, + request_to_curl, ) from scrapy.utils.test import get_crawler @@ -666,5 +668,67 @@ class CustomRequestFingerprinterTestCase(unittest.TestCase): self.assertEqual(fingerprint, settings["FINGERPRINT"]) +class RequestToCurlTest(unittest.TestCase): + def _test_request(self, request_object, expected_curl_command): + curl_command = request_to_curl(request_object) + self.assertEqual(curl_command, expected_curl_command) + + def test_get(self): + request_object = Request("https://www.example.com") + expected_curl_command = "curl -X GET https://www.example.com" + self._test_request(request_object, expected_curl_command) + + def test_post(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + 'curl -X POST https://www.httpbin.org/post --data-raw \'{"foo": "bar"}\'' + ) + self._test_request(request_object, expected_curl_command) + + def test_headers(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + headers={"Content-Type": "application/json", "Accept": "application/json"}, + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + "curl -X POST https://www.httpbin.org/post" + ' --data-raw \'{"foo": "bar"}\'' + " -H 'Content-Type: application/json' -H 'Accept: application/json'" + ) + self._test_request(request_object, expected_curl_command) + + def test_cookies_dict(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + cookies={"foo": "bar"}, + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + "curl -X POST https://www.httpbin.org/post" + " --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=bar'" + ) + self._test_request(request_object, expected_curl_command) + + def test_cookies_list(self): + request_object = Request( + "https://www.httpbin.org/post", + method="POST", + cookies=[{"foo": "bar"}], + body=json.dumps({"foo": "bar"}), + ) + expected_curl_command = ( + "curl -X POST https://www.httpbin.org/post" + " --data-raw '{\"foo\": \"bar\"}' --cookie 'foo=bar'" + ) + self._test_request(request_object, expected_curl_command) + + if __name__ == "__main__": unittest.main() From e1f66620ec7341c55f3eb7f44088224b5f68c1ad Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 14 Apr 2023 18:13:21 +0400 Subject: [PATCH 470/532] Fix typo on tutorial.rst (#5893) (#5895) Co-authored-by: Seth Herr --- docs/intro/tutorial.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index 064ce05f8..04d73d95a 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -329,7 +329,7 @@ the :meth:`~scrapy.selector.SelectorList.re` method to extract using >>> response.css("title::text").re(r"(\w+) to (\w+)") ['Quotes', 'Scrape'] -In order to find the proper CSS selectors to use, you might find useful opening +In order to find the proper CSS selectors to use, you might find it useful to open the response page from the shell in your web browser using ``view(response)``. You can use your browser's developer tools to inspect the HTML and come up with a selector (see :ref:`topics-developer-tools`). From 02f3e8d413ccdd6a3f0b5828a9cd94e1fb3662b1 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 17 Apr 2023 10:37:52 +0400 Subject: [PATCH 471/532] Typing for scrapy/core/downloader (#5896) --- scrapy/core/downloader/__init__.py | 95 ++++++++++++--------- scrapy/core/downloader/contextfactory.py | 56 +++++++----- scrapy/core/downloader/handlers/__init__.py | 31 ++++--- scrapy/core/downloader/middleware.py | 29 ++++--- scrapy/core/downloader/tls.py | 26 +++--- scrapy/core/downloader/webclient.py | 41 +++++---- scrapy/utils/python.py | 36 ++++++-- scrapy/utils/ssl.py | 22 +++-- 8 files changed, 211 insertions(+), 125 deletions(-) diff --git a/scrapy/core/downloader/__init__.py b/scrapy/core/downloader/__init__.py index dde76a547..426056dc8 100644 --- a/scrapy/core/downloader/__init__.py +++ b/scrapy/core/downloader/__init__.py @@ -2,45 +2,52 @@ import random from collections import deque from datetime import datetime from time import time +from typing import TYPE_CHECKING, Any, Deque, Dict, Set, Tuple, cast -from twisted.internet import defer, task +from twisted.internet import task from twisted.internet.defer import Deferred from scrapy import Request, Spider, signals from scrapy.core.downloader.handlers import DownloadHandlers from scrapy.core.downloader.middleware import DownloaderMiddlewareManager +from scrapy.http import Response from scrapy.resolver import dnscache +from scrapy.settings import BaseSettings +from scrapy.signalmanager import SignalManager from scrapy.utils.defer import mustbe_deferred from scrapy.utils.httpobj import urlparse_cached +if TYPE_CHECKING: + from scrapy.crawler import Crawler + class Slot: """Downloader slot""" - def __init__(self, concurrency, delay, randomize_delay): - self.concurrency = concurrency - self.delay = delay - self.randomize_delay = randomize_delay + def __init__(self, concurrency: int, delay: float, randomize_delay: bool): + self.concurrency: int = concurrency + self.delay: float = delay + self.randomize_delay: bool = randomize_delay - self.active = set() - self.queue = deque() - self.transferring = set() - self.lastseen = 0 + self.active: Set[Request] = set() + self.queue: Deque[Tuple[Request, Deferred]] = deque() + self.transferring: Set[Request] = set() + self.lastseen: float = 0 self.latercall = None - def free_transfer_slots(self): + def free_transfer_slots(self) -> int: return self.concurrency - len(self.transferring) - def download_delay(self): + def download_delay(self) -> float: if self.randomize_delay: return random.uniform(0.5 * self.delay, 1.5 * self.delay) return self.delay - def close(self): + def close(self) -> None: if self.latercall and self.latercall.active(): self.latercall.cancel() - def __repr__(self): + def __repr__(self) -> str: cls_name = self.__class__.__name__ return ( f"{cls_name}(concurrency={self.concurrency!r}, " @@ -48,7 +55,7 @@ class Slot: f"randomize_delay={self.randomize_delay!r})" ) - def __str__(self): + def __str__(self) -> str: return ( f" Tuple[int, float]: + delay: float = settings.getfloat("DOWNLOAD_DELAY") if hasattr(spider, "download_delay"): delay = spider.download_delay @@ -72,23 +81,29 @@ def _get_concurrency_delay(concurrency, spider, settings): class Downloader: DOWNLOAD_SLOT = "download_slot" - def __init__(self, crawler): - self.settings = crawler.settings - self.signals = crawler.signals - self.slots = {} - self.active = set() - self.handlers = DownloadHandlers(crawler) - self.total_concurrency = self.settings.getint("CONCURRENT_REQUESTS") - self.domain_concurrency = self.settings.getint("CONCURRENT_REQUESTS_PER_DOMAIN") - self.ip_concurrency = self.settings.getint("CONCURRENT_REQUESTS_PER_IP") - self.randomize_delay = self.settings.getbool("RANDOMIZE_DOWNLOAD_DELAY") - self.middleware = DownloaderMiddlewareManager.from_crawler(crawler) - self._slot_gc_loop = task.LoopingCall(self._slot_gc) + def __init__(self, crawler: "Crawler"): + self.settings: BaseSettings = crawler.settings + self.signals: SignalManager = crawler.signals + self.slots: Dict[str, Slot] = {} + self.active: Set[Request] = set() + self.handlers: DownloadHandlers = DownloadHandlers(crawler) + self.total_concurrency: int = self.settings.getint("CONCURRENT_REQUESTS") + self.domain_concurrency: int = self.settings.getint( + "CONCURRENT_REQUESTS_PER_DOMAIN" + ) + self.ip_concurrency: int = self.settings.getint("CONCURRENT_REQUESTS_PER_IP") + self.randomize_delay: bool = self.settings.getbool("RANDOMIZE_DOWNLOAD_DELAY") + self.middleware: DownloaderMiddlewareManager = ( + DownloaderMiddlewareManager.from_crawler(crawler) + ) + self._slot_gc_loop: task.LoopingCall = task.LoopingCall(self._slot_gc) self._slot_gc_loop.start(60) - self.per_slot_settings = self.settings.getdict("DOWNLOAD_SLOTS", {}) + self.per_slot_settings: Dict[str, Dict[str, Any]] = self.settings.getdict( + "DOWNLOAD_SLOTS", {} + ) def fetch(self, request: Request, spider: Spider) -> Deferred: - def _deactivate(response): + def _deactivate(response: Response) -> Response: self.active.remove(request) return response @@ -99,7 +114,7 @@ class Downloader: def needs_backout(self) -> bool: return len(self.active) >= self.total_concurrency - def _get_slot(self, request, spider): + def _get_slot(self, request: Request, spider: Spider) -> Tuple[str, Slot]: key = self._get_slot_key(request, spider) if key not in self.slots: slot_settings = self.per_slot_settings.get(key, {}) @@ -117,9 +132,9 @@ class Downloader: return key, self.slots[key] - def _get_slot_key(self, request, spider): + def _get_slot_key(self, request: Request, spider: Spider) -> str: if self.DOWNLOAD_SLOT in request.meta: - return request.meta[self.DOWNLOAD_SLOT] + return cast(str, request.meta[self.DOWNLOAD_SLOT]) key = urlparse_cached(request).hostname or "" if self.ip_concurrency: @@ -127,11 +142,11 @@ class Downloader: return key - def _enqueue_request(self, request, spider): + def _enqueue_request(self, request: Request, spider: Spider) -> Deferred: key, slot = self._get_slot(request, spider) request.meta[self.DOWNLOAD_SLOT] = key - def _deactivate(response): + def _deactivate(response: Response) -> Response: slot.active.remove(request) return response @@ -139,12 +154,12 @@ class Downloader: self.signals.send_catch_log( signal=signals.request_reached_downloader, request=request, spider=spider ) - deferred = defer.Deferred().addBoth(_deactivate) + deferred = Deferred().addBoth(_deactivate) slot.queue.append((request, deferred)) self._process_queue(spider, slot) return deferred - def _process_queue(self, spider, slot): + def _process_queue(self, spider: Spider, slot: Slot) -> None: from twisted.internet import reactor if slot.latercall and slot.latercall.active(): @@ -172,7 +187,7 @@ class Downloader: self._process_queue(spider, slot) break - def _download(self, slot, request, spider): + def _download(self, slot: Slot, request: Request, spider: Spider) -> Deferred: # The order is very important for the following deferreds. Do not change! # 1. Create the download deferred @@ -180,7 +195,7 @@ class Downloader: # 2. Notify response_downloaded listeners about the recent download # before querying queue for next request - def _downloaded(response): + def _downloaded(response: Response) -> Response: self.signals.send_catch_log( signal=signals.response_downloaded, response=response, @@ -197,7 +212,7 @@ class Downloader: # middleware itself) slot.transferring.add(request) - def finish_transferring(_): + def finish_transferring(_: Any) -> Any: slot.transferring.remove(request) self._process_queue(spider, slot) self.signals.send_catch_log( diff --git a/scrapy/core/downloader/contextfactory.py b/scrapy/core/downloader/contextfactory.py index 53ae78918..909cc273f 100644 --- a/scrapy/core/downloader/contextfactory.py +++ b/scrapy/core/downloader/contextfactory.py @@ -1,4 +1,5 @@ import warnings +from typing import TYPE_CHECKING, Any, List, Optional from OpenSSL import SSL from twisted.internet._sslverify import _setAcceptableProtocols @@ -18,8 +19,12 @@ from scrapy.core.downloader.tls import ( ScrapyClientTLSOptions, openssl_methods, ) +from scrapy.settings import BaseSettings from scrapy.utils.misc import create_instance, load_object +if TYPE_CHECKING: + from twisted.internet._sslverify import ClientTLSOptions + @implementer(IPolicyForHTTPS) class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): @@ -35,25 +40,34 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): def __init__( self, - method=SSL.SSLv23_METHOD, - tls_verbose_logging=False, - tls_ciphers=None, - *args, - **kwargs, + method: int = SSL.SSLv23_METHOD, + tls_verbose_logging: bool = False, + tls_ciphers: Optional[str] = None, + *args: Any, + **kwargs: Any, ): super().__init__(*args, **kwargs) - self._ssl_method = method - self.tls_verbose_logging = tls_verbose_logging + self._ssl_method: int = method + self.tls_verbose_logging: bool = tls_verbose_logging + self.tls_ciphers: AcceptableCiphers if tls_ciphers: self.tls_ciphers = AcceptableCiphers.fromOpenSSLCipherString(tls_ciphers) else: self.tls_ciphers = DEFAULT_CIPHERS @classmethod - def from_settings(cls, settings, method=SSL.SSLv23_METHOD, *args, **kwargs): - tls_verbose_logging = settings.getbool("DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING") - tls_ciphers = settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] - return cls( + def from_settings( + cls, + settings: BaseSettings, + method: int = SSL.SSLv23_METHOD, + *args: Any, + **kwargs: Any, + ): + tls_verbose_logging: bool = settings.getbool( + "DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING" + ) + tls_ciphers: Optional[str] = settings["DOWNLOADER_CLIENT_TLS_CIPHERS"] + return cls( # type: ignore[misc] method=method, tls_verbose_logging=tls_verbose_logging, tls_ciphers=tls_ciphers, @@ -61,7 +75,7 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): **kwargs, ) - def getCertificateOptions(self): + def getCertificateOptions(self) -> CertificateOptions: # setting verify=True will require you to provide CAs # to verify against; in other words: it's not that simple @@ -82,12 +96,12 @@ class ScrapyClientContextFactory(BrowserLikePolicyForHTTPS): # kept for old-style HTTP/1.0 downloader context twisted calls, # e.g. connectSSL() - def getContext(self, hostname=None, port=None): + def getContext(self, hostname: Any = None, port: Any = None) -> SSL.Context: ctx = self.getCertificateOptions().getContext() ctx.set_options(0x4) # OP_LEGACY_SERVER_CONNECT return ctx - def creatorForNetloc(self, hostname, port): + def creatorForNetloc(self, hostname: bytes, port: int) -> "ClientTLSOptions": return ScrapyClientTLSOptions( hostname.decode("ascii"), self.getContext(), @@ -114,7 +128,7 @@ class BrowserLikeContextFactory(ScrapyClientContextFactory): ``SSLv23_METHOD``) which allows TLS protocol negotiation. """ - def creatorForNetloc(self, hostname, port): + def creatorForNetloc(self, hostname: bytes, port: int) -> "ClientTLSOptions": # trustRoot set to platformTrust() will use the platform's root CAs. # # This means that a website like https://www.cacert.org will be rejected @@ -133,13 +147,15 @@ class AcceptableProtocolsContextFactory: negotiation. """ - def __init__(self, context_factory, acceptable_protocols): + def __init__(self, context_factory: Any, acceptable_protocols: List[bytes]): verifyObject(IPolicyForHTTPS, context_factory) - self._wrapped_context_factory = context_factory - self._acceptable_protocols = acceptable_protocols + self._wrapped_context_factory: Any = context_factory + self._acceptable_protocols: List[bytes] = acceptable_protocols - def creatorForNetloc(self, hostname, port): - options = self._wrapped_context_factory.creatorForNetloc(hostname, port) + def creatorForNetloc(self, hostname: bytes, port: int) -> "ClientTLSOptions": + options: "ClientTLSOptions" = self._wrapped_context_factory.creatorForNetloc( + hostname, port + ) _setAcceptableProtocols(options._ctx, self._acceptable_protocols) return options diff --git a/scrapy/core/downloader/handlers/__init__.py b/scrapy/core/downloader/handlers/__init__.py index 39155efe9..6a211aafa 100644 --- a/scrapy/core/downloader/handlers/__init__.py +++ b/scrapy/core/downloader/handlers/__init__.py @@ -1,25 +1,32 @@ """Download handlers for different schemes""" import logging +from typing import TYPE_CHECKING, Any, Callable, Dict, Generator, Union, cast from twisted.internet import defer +from twisted.internet.defer import Deferred -from scrapy import signals +from scrapy import Request, Spider, signals from scrapy.exceptions import NotConfigured, NotSupported from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.misc import create_instance, load_object from scrapy.utils.python import without_none_values +if TYPE_CHECKING: + from scrapy.crawler import Crawler + logger = logging.getLogger(__name__) class DownloadHandlers: - def __init__(self, crawler): - self._crawler = crawler - self._schemes = {} # stores acceptable schemes on instancing - self._handlers = {} # stores instanced handlers for schemes - self._notconfigured = {} # remembers failed handlers - handlers = without_none_values( + def __init__(self, crawler: "Crawler"): + self._crawler: "Crawler" = crawler + self._schemes: Dict[ + str, Union[str, Callable] + ] = {} # stores acceptable schemes on instancing + self._handlers: Dict[str, Any] = {} # stores instanced handlers for schemes + self._notconfigured: Dict[str, str] = {} # remembers failed handlers + handlers: Dict[str, Union[str, Callable]] = without_none_values( crawler.settings.getwithbase("DOWNLOAD_HANDLERS") ) for scheme, clspath in handlers.items(): @@ -28,7 +35,7 @@ class DownloadHandlers: crawler.signals.connect(self._close, signals.engine_stopped) - def _get_handler(self, scheme): + def _get_handler(self, scheme: str) -> Any: """Lazy-load the downloadhandler for a scheme only on the first request for that scheme. """ @@ -42,7 +49,7 @@ class DownloadHandlers: return self._load_handler(scheme) - def _load_handler(self, scheme, skip_lazy=False): + def _load_handler(self, scheme: str, skip_lazy: bool = False) -> Any: path = self._schemes[scheme] try: dhcls = load_object(path) @@ -69,17 +76,17 @@ class DownloadHandlers: self._handlers[scheme] = dh return dh - def download_request(self, request, spider): + def download_request(self, request: Request, spider: Spider) -> Deferred: scheme = urlparse_cached(request).scheme handler = self._get_handler(scheme) if not handler: raise NotSupported( f"Unsupported URL scheme '{scheme}': {self._notconfigured[scheme]}" ) - return handler.download_request(request, spider) + return cast(Deferred, handler.download_request(request, spider)) @defer.inlineCallbacks - def _close(self, *_a, **_kw): + def _close(self, *_a: Any, **_kw: Any) -> Generator[Deferred, Any, None]: for dh in self._handlers.values(): if hasattr(dh, "close"): yield dh.close() diff --git a/scrapy/core/downloader/middleware.py b/scrapy/core/downloader/middleware.py index 56df48b2e..dca13c01e 100644 --- a/scrapy/core/downloader/middleware.py +++ b/scrapy/core/downloader/middleware.py @@ -3,15 +3,16 @@ Downloader Middleware manager See documentation in docs/topics/downloader-middleware.rst """ -from typing import Callable, Union, cast +from typing import Any, Callable, Generator, List, Union, cast -from twisted.internet import defer +from twisted.internet.defer import Deferred, inlineCallbacks from twisted.python.failure import Failure from scrapy import Spider from scrapy.exceptions import _InvalidOutput from scrapy.http import Request, Response from scrapy.middleware import MiddlewareManager +from scrapy.settings import BaseSettings from scrapy.utils.conf import build_component_list from scrapy.utils.defer import deferred_from_coro, mustbe_deferred @@ -20,10 +21,10 @@ class DownloaderMiddlewareManager(MiddlewareManager): component_name = "downloader middleware" @classmethod - def _get_mwlist_from_settings(cls, settings): + def _get_mwlist_from_settings(cls, settings: BaseSettings) -> List[Any]: return build_component_list(settings.getwithbase("DOWNLOADER_MIDDLEWARES")) - def _add_middleware(self, mw): + def _add_middleware(self, mw: Any) -> None: if hasattr(mw, "process_request"): self.methods["process_request"].append(mw.process_request) if hasattr(mw, "process_response"): @@ -31,9 +32,11 @@ class DownloaderMiddlewareManager(MiddlewareManager): if hasattr(mw, "process_exception"): self.methods["process_exception"].appendleft(mw.process_exception) - def download(self, download_func: Callable, request: Request, spider: Spider): - @defer.inlineCallbacks - def process_request(request: Request): + def download( + self, download_func: Callable, request: Request, spider: Spider + ) -> Deferred: + @inlineCallbacks + def process_request(request: Request) -> Generator[Deferred, Any, Any]: for method in self.methods["process_request"]: method = cast(Callable, method) response = yield deferred_from_coro( @@ -50,8 +53,10 @@ class DownloaderMiddlewareManager(MiddlewareManager): return response return (yield download_func(request=request, spider=spider)) - @defer.inlineCallbacks - def process_response(response: Union[Response, Request]): + @inlineCallbacks + def process_response( + response: Union[Response, Request] + ) -> Generator[Deferred, Any, Union[Response, Request]]: if response is None: raise TypeError("Received None in process_response") elif isinstance(response, Request): @@ -71,8 +76,10 @@ class DownloaderMiddlewareManager(MiddlewareManager): return response return response - @defer.inlineCallbacks - def process_exception(failure: Failure): + @inlineCallbacks + def process_exception( + failure: Failure, + ) -> Generator[Deferred, Any, Union[Failure, Response, Request]]: exception = failure.value for method in self.methods["process_exception"]: method = cast(Callable, method) diff --git a/scrapy/core/downloader/tls.py b/scrapy/core/downloader/tls.py index 025575fe1..33cea7263 100644 --- a/scrapy/core/downloader/tls.py +++ b/scrapy/core/downloader/tls.py @@ -1,4 +1,5 @@ import logging +from typing import Any, Dict from OpenSSL import SSL from service_identity.exceptions import CertificateError @@ -20,7 +21,7 @@ METHOD_TLSv11 = "TLSv1.1" METHOD_TLSv12 = "TLSv1.2" -openssl_methods = { +openssl_methods: Dict[str, int] = { METHOD_TLS: SSL.SSLv23_METHOD, # protocol negotiation (recommended) METHOD_TLSv10: SSL.TLSv1_METHOD, # TLS 1.0 only METHOD_TLSv11: SSL.TLSv1_1_METHOD, # TLS 1.1 only @@ -39,11 +40,13 @@ class ScrapyClientTLSOptions(ClientTLSOptions): logging warnings. Also, HTTPS connection parameters logging is added. """ - def __init__(self, hostname, ctx, verbose_logging=False): + def __init__(self, hostname: str, ctx: SSL.Context, verbose_logging: bool = False): super().__init__(hostname, ctx) - self.verbose_logging = verbose_logging + self.verbose_logging: bool = verbose_logging - def _identityVerifyingInfoCallback(self, connection, where, ret): + def _identityVerifyingInfoCallback( + self, connection: SSL.Connection, where: int, ret: Any + ) -> None: if where & SSL.SSL_CB_HANDSHAKE_START: connection.set_tlsext_host_name(self._hostnameBytes) elif where & SSL.SSL_CB_HANDSHAKE_DONE: @@ -55,11 +58,12 @@ class ScrapyClientTLSOptions(ClientTLSOptions): connection.get_cipher_name(), ) server_cert = connection.get_peer_certificate() - logger.debug( - 'SSL connection certificate: issuer "%s", subject "%s"', - x509name_to_string(server_cert.get_issuer()), - x509name_to_string(server_cert.get_subject()), - ) + if server_cert: + logger.debug( + 'SSL connection certificate: issuer "%s", subject "%s"', + x509name_to_string(server_cert.get_issuer()), + x509name_to_string(server_cert.get_subject()), + ) key_info = get_temp_key_info(connection._ssl) if key_info: logger.debug("SSL temp key: %s", key_info) @@ -82,4 +86,6 @@ class ScrapyClientTLSOptions(ClientTLSOptions): ) -DEFAULT_CIPHERS = AcceptableCiphers.fromOpenSSLCipherString("DEFAULT") +DEFAULT_CIPHERS: AcceptableCiphers = AcceptableCiphers.fromOpenSSLCipherString( + "DEFAULT" +) diff --git a/scrapy/core/downloader/webclient.py b/scrapy/core/downloader/webclient.py index 3d103652b..bb1f73805 100644 --- a/scrapy/core/downloader/webclient.py +++ b/scrapy/core/downloader/webclient.py @@ -1,22 +1,25 @@ import re from time import time -from urllib.parse import urldefrag, urlparse, urlunparse +from typing import Optional, Tuple +from urllib.parse import ParseResult, urldefrag, urlparse, urlunparse from twisted.internet import defer from twisted.internet.protocol import ClientFactory from twisted.web.http import HTTPClient +from scrapy import Request from scrapy.http import Headers from scrapy.responsetypes import responsetypes from scrapy.utils.httpobj import urlparse_cached from scrapy.utils.python import to_bytes, to_unicode -def _parsed_url_args(parsed): +def _parsed_url_args(parsed: ParseResult) -> Tuple[bytes, bytes, bytes, int, bytes]: # Assume parsed is urlparse-d from Request.url, # which was passed via safe_url_string and is ascii-only. - path = urlunparse(("", "", parsed.path or "/", parsed.params, parsed.query, "")) - path = to_bytes(path, encoding="ascii") + path_str = urlunparse(("", "", parsed.path or "/", parsed.params, parsed.query, "")) + path = to_bytes(path_str, encoding="ascii") + assert parsed.hostname is not None host = to_bytes(parsed.hostname, encoding="ascii") port = parsed.port scheme = to_bytes(parsed.scheme, encoding="ascii") @@ -26,7 +29,7 @@ def _parsed_url_args(parsed): return scheme, netloc, host, port, path -def _parse(url): +def _parse(url: str) -> Tuple[bytes, bytes, bytes, int, bytes]: """Return tuple of (scheme, netloc, host, port, path), all in bytes except for port which is int. Assume url is from Request.url, which was passed via safe_url_string @@ -132,17 +135,19 @@ class ScrapyHTTPClientFactory(ClientFactory): self.scheme, _, self.host, self.port, _ = _parse(proxy) self.path = self.url - def __init__(self, request, timeout=180): - self._url = urldefrag(request.url)[0] + def __init__(self, request: Request, timeout: float = 180): + self._url: str = urldefrag(request.url)[0] # converting to bytes to comply to Twisted interface - self.url = to_bytes(self._url, encoding="ascii") - self.method = to_bytes(request.method, encoding="ascii") - self.body = request.body or None - self.headers = Headers(request.headers) - self.response_headers = None - self.timeout = request.meta.get("download_timeout") or timeout - self.start_time = time() - self.deferred = defer.Deferred().addCallback(self._build_response, request) + self.url: bytes = to_bytes(self._url, encoding="ascii") + self.method: bytes = to_bytes(request.method, encoding="ascii") + self.body: Optional[bytes] = request.body or None + self.headers: Headers = Headers(request.headers) + self.response_headers: Optional[Headers] = None + self.timeout: float = request.meta.get("download_timeout") or timeout + self.start_time: float = time() + self.deferred: defer.Deferred = defer.Deferred().addCallback( + self._build_response, request + ) # Fixes Twisted 11.1.0+ support as HTTPClientFactory is expected # to have _disconnectedDeferred. See Twisted r32329. @@ -150,7 +155,7 @@ class ScrapyHTTPClientFactory(ClientFactory): # needed to add the callback _waitForDisconnect. # Specifically this avoids the AttributeError exception when # clientConnectionFailed method is called. - self._disconnectedDeferred = defer.Deferred() + self._disconnectedDeferred: defer.Deferred = defer.Deferred() self._set_connection_attributes(request) @@ -166,8 +171,8 @@ class ScrapyHTTPClientFactory(ClientFactory): elif self.method == b"POST": self.headers["Content-Length"] = 0 - def __repr__(self): - return f"<{self.__class__.__name__}: {self.url}>" + def __repr__(self) -> str: + return f"<{self.__class__.__name__}: {self._url}>" def _cancelTimeout(self, result, timeoutCall): if timeoutCall.active(): diff --git a/scrapy/utils/python.py b/scrapy/utils/python.py index 818fa5d6b..27816c0df 100644 --- a/scrapy/utils/python.py +++ b/scrapy/utils/python.py @@ -8,7 +8,16 @@ import sys import weakref from functools import partial, wraps from itertools import chain -from typing import Any, AsyncGenerator, AsyncIterable, Iterable, Union +from typing import ( + Any, + AsyncGenerator, + AsyncIterable, + Iterable, + Mapping, + Optional, + Union, + overload, +) from scrapy.utils.asyncgen import as_async_generator @@ -82,7 +91,9 @@ def unique(list_, key=lambda x: x): return result -def to_unicode(text, encoding=None, errors="strict"): +def to_unicode( + text: Union[str, bytes], encoding: Optional[str] = None, errors: str = "strict" +) -> str: """Return the unicode representation of a bytes object ``text``. If ``text`` is already an unicode object, return it as-is.""" if isinstance(text, str): @@ -97,7 +108,9 @@ def to_unicode(text, encoding=None, errors="strict"): return text.decode(encoding, errors) -def to_bytes(text, encoding=None, errors="strict"): +def to_bytes( + text: Union[str, bytes], encoding: Optional[str] = None, errors: str = "strict" +) -> bytes: """Return the binary representation of ``text``. If ``text`` is already a bytes object, return it as-is.""" if isinstance(text, bytes): @@ -160,11 +173,12 @@ def memoizemethod_noargs(method): return new_method -_BINARYCHARS = {to_bytes(chr(i)) for i in range(32)} - {b"\0", b"\t", b"\n", b"\r"} -_BINARYCHARS |= {ord(ch) for ch in _BINARYCHARS} +_BINARYCHARS = { + i for i in range(32) if to_bytes(chr(i)) not in {b"\0", b"\t", b"\n", b"\r"} +} -def binary_is_text(data): +def binary_is_text(data: bytes) -> bool: """Returns ``True`` if the given ``data`` argument (a ``bytes`` object) does not contain unprintable control characters. """ @@ -258,6 +272,16 @@ def equal_attributes(obj1, obj2, attributes): return True +@overload +def without_none_values(iterable: Mapping) -> dict: + ... + + +@overload +def without_none_values(iterable: Iterable) -> Iterable: + ... + + def without_none_values(iterable): """Return a copy of ``iterable`` with all ``None`` entries removed. diff --git a/scrapy/utils/ssl.py b/scrapy/utils/ssl.py index 3ddceea35..03ae4ba9e 100644 --- a/scrapy/utils/ssl.py +++ b/scrapy/utils/ssl.py @@ -1,24 +1,28 @@ +from typing import Any, Optional, cast + import OpenSSL._util as pyOpenSSLutil import OpenSSL.SSL +import OpenSSL.version +from OpenSSL.crypto import X509Name from scrapy.utils.python import to_unicode -def ffi_buf_to_string(buf): +def ffi_buf_to_string(buf: Any) -> str: return to_unicode(pyOpenSSLutil.ffi.string(buf)) -def x509name_to_string(x509name): +def x509name_to_string(x509name: X509Name) -> str: # from OpenSSL.crypto.X509Name.__repr__ - result_buffer = pyOpenSSLutil.ffi.new("char[]", 512) + result_buffer: Any = pyOpenSSLutil.ffi.new("char[]", 512) pyOpenSSLutil.lib.X509_NAME_oneline( - x509name._name, result_buffer, len(result_buffer) + x509name._name, result_buffer, len(result_buffer) # type: ignore[attr-defined] ) return ffi_buf_to_string(result_buffer) -def get_temp_key_info(ssl_object): +def get_temp_key_info(ssl_object: Any) -> Optional[str]: # adapted from OpenSSL apps/s_cb.c::ssl_print_tmp_key() if not hasattr(pyOpenSSLutil.lib, "SSL_get_server_tmp_key"): # removed in cryptography 40.0.0 @@ -53,8 +57,10 @@ def get_temp_key_info(ssl_object): return ", ".join(key_info) -def get_openssl_version(): - system_openssl = OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION).decode( - "ascii", errors="replace" +def get_openssl_version() -> str: + # https://github.com/python/typeshed/issues/10024 + system_openssl_bytes = cast( + bytes, OpenSSL.SSL.SSLeay_version(OpenSSL.SSL.SSLEAY_VERSION) ) + system_openssl = system_openssl_bytes.decode("ascii", errors="replace") return f"{OpenSSL.version.__version__} ({system_openssl})" From f5447f3b4ca2c91a07bfdd5acad9661061b8bbd7 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 18 Apr 2023 21:31:51 -0500 Subject: [PATCH 472/532] fix: Request.from_curl() with prefixed string literals --- scrapy/utils/curl.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index a2243ae2e..5e095f933 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -1,4 +1,5 @@ import argparse +import re import warnings from http.cookies import SimpleCookie from shlex import split @@ -7,6 +8,15 @@ from urllib.parse import urlparse from w3lib.http import basic_auth_header +class DataAction(argparse.Action): + def __call__(self, parser, namespace, values, option_string=None): + value = str(values).encode("utf-8").decode("utf-8") + if items := re.findall(r"{.+}", value): + value = items[0] + + setattr(namespace, self.dest, value) + + class CurlParser(argparse.ArgumentParser): def error(self, message): error_msg = f"There was an error parsing the curl command: {message}" @@ -17,7 +27,7 @@ curl_parser = CurlParser() curl_parser.add_argument("url") curl_parser.add_argument("-H", "--header", dest="headers", action="append") curl_parser.add_argument("-X", "--request", dest="method") -curl_parser.add_argument("-d", "--data", "--data-raw", dest="data") +curl_parser.add_argument("-d", "--data", "--data-raw", dest="data", action=DataAction) curl_parser.add_argument("-u", "--user", dest="auth") From 88c58a8c9ca6f8149779bfc92d00499a613e5fb3 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 18 Apr 2023 21:49:05 -0500 Subject: [PATCH 473/532] feat: added test_post_data_raw_with_string_prefix --- tests/test_utils_curl.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/tests/test_utils_curl.py b/tests/test_utils_curl.py index fd4612eba..1816db29b 100644 --- a/tests/test_utils_curl.py +++ b/tests/test_utils_curl.py @@ -154,6 +154,15 @@ class CurlToRequestKwargsTest(unittest.TestCase): } self._test_command(curl_command, expected_result) + def test_post_data_raw_with_string_prefix(self): + curl_command = "curl 'https://www.example.org/' --data-raw $'{\"$filters\":\"Filter\u0021\"}'" + expected_result = { + "method": "POST", + "url": "https://www.example.org/", + "body": '{"$filters":"Filter!"}', + } + self._test_command(curl_command, expected_result) + def test_explicit_get_with_data(self): curl_command = "curl httpbin.org/anything -X GET --data asdf" expected_result = { From 69f96b9e96b1399f68cc61db0fe2d2b6cff5484d Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 18 Apr 2023 22:04:34 -0500 Subject: [PATCH 474/532] fix: regex --- scrapy/utils/curl.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index 5e095f933..b873d2bdf 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -11,7 +11,7 @@ from w3lib.http import basic_auth_header class DataAction(argparse.Action): def __call__(self, parser, namespace, values, option_string=None): value = str(values).encode("utf-8").decode("utf-8") - if items := re.findall(r"{.+}", value): + if items := re.findall(r"\$(.+)", value): value = items[0] setattr(namespace, self.dest, value) From 3209eac14f430f9cba522c12a615111bcabaecd5 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 18 Apr 2023 22:35:15 -0500 Subject: [PATCH 475/532] fix: checks --- scrapy/utils/curl.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index b873d2bdf..ecfa292ea 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -11,9 +11,8 @@ from w3lib.http import basic_auth_header class DataAction(argparse.Action): def __call__(self, parser, namespace, values, option_string=None): value = str(values).encode("utf-8").decode("utf-8") - if items := re.findall(r"\$(.+)", value): - value = items[0] - + items = re.findall(r"\$(.+)", value) + value = items[0] if items else value setattr(namespace, self.dest, value) From 7e1814faf836757933afec4c7c394f43f34c3567 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 18 Apr 2023 23:36:51 -0500 Subject: [PATCH 476/532] fix: regex --- scrapy/utils/curl.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index ecfa292ea..9c98e4cb8 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -11,8 +11,7 @@ from w3lib.http import basic_auth_header class DataAction(argparse.Action): def __call__(self, parser, namespace, values, option_string=None): value = str(values).encode("utf-8").decode("utf-8") - items = re.findall(r"\$(.+)", value) - value = items[0] if items else value + value = value[1::] if re.match(r"^\$(.+)", value) else value setattr(namespace, self.dest, value) From ef61fb5698c93178a57a9d4d67760def9a3039d9 Mon Sep 17 00:00:00 2001 From: tstauder <55719290+tstauder@users.noreply.github.com> Date: Wed, 19 Apr 2023 02:33:32 -0400 Subject: [PATCH 477/532] Fix flaky tests involving feed export batches (#5898) Co-authored-by: jmannoop --- tests/test_feedexport.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 3124d9d67..83de0e77e 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -2542,7 +2542,7 @@ class BatchDeliveriesTest(FeedExportTestBase): def test_batch_path_differ(self): """ Test that the name of all batch files differ from each other. - So %(batch_time)s replaced with the current date. + So %(batch_id)d replaced with the current id. """ items = [ self.MyItem({"foo": "bar1", "egg": "spam1"}), @@ -2552,7 +2552,7 @@ class BatchDeliveriesTest(FeedExportTestBase): settings = { "FEEDS": { self._random_temp_filename() - / "%(batch_time)s": { + / "%(batch_id)d": { "format": "json", }, }, @@ -2615,7 +2615,7 @@ class BatchDeliveriesTest(FeedExportTestBase): return super().open(*args, **kwargs) key = "export.csv" - uri = f"s3://{bucket}/{key}/%(batch_time)s.json" + uri = f"s3://{bucket}/{key}/%(batch_id)d.json" batch_item_count = 1 settings = { "AWS_ACCESS_KEY_ID": "access_key", From b7ecec18099ace6ba77161302cca85c3e58a2ae7 Mon Sep 17 00:00:00 2001 From: Jalil SA Date: Wed, 19 Apr 2023 01:04:03 -0600 Subject: [PATCH 478/532] Update scrapy/utils/curl.py MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- scrapy/utils/curl.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index 9c98e4cb8..790c26b1a 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -10,8 +10,9 @@ from w3lib.http import basic_auth_header class DataAction(argparse.Action): def __call__(self, parser, namespace, values, option_string=None): - value = str(values).encode("utf-8").decode("utf-8") - value = value[1::] if re.match(r"^\$(.+)", value) else value + value = str(values) + if value.startswith("$"): + value = value[1:] setattr(namespace, self.dest, value) From f69ba43f8e5b52af51119c682509167f5cf5517f Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Wed, 19 Apr 2023 02:06:00 -0500 Subject: [PATCH 479/532] fix: import re --- scrapy/utils/curl.py | 1 - 1 file changed, 1 deletion(-) diff --git a/scrapy/utils/curl.py b/scrapy/utils/curl.py index 790c26b1a..f5dbbd64e 100644 --- a/scrapy/utils/curl.py +++ b/scrapy/utils/curl.py @@ -1,5 +1,4 @@ import argparse -import re import warnings from http.cookies import SimpleCookie from shlex import split From 87c8c5199902b448e90708e779470494f365c647 Mon Sep 17 00:00:00 2001 From: DeflateAwning <11021263+DeflateAwning@users.noreply.github.com> Date: Thu, 20 Apr 2023 00:23:02 -0600 Subject: [PATCH 480/532] Fix a typo in the FAQ (#5904) --- docs/faq.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 031f4b942..20dd814df 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -231,8 +231,8 @@ Can I return (Twisted) deferreds from signal handlers? Some signals support returning deferreds from their handlers, others don't. See the :ref:`topics-signals-ref` to know which ones. -What does the response status code 999 means? ---------------------------------------------- +What does the response status code 999 mean? +-------------------------------------------- 999 is a custom response status code used by Yahoo sites to throttle requests. Try slowing down the crawling speed by using a download delay of ``2`` (or From 5a37af146f4f036168ac562918fca43adb4ac65f Mon Sep 17 00:00:00 2001 From: Jalil SA Date: Fri, 21 Apr 2023 01:29:57 -0600 Subject: [PATCH 481/532] Update documentation expectations for Parsel 1.8.0 (#5902) --- docs/intro/tutorial.rst | 8 ++++---- pytest.ini | 1 - tox.ini | 11 ++++++++--- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/intro/tutorial.rst b/docs/intro/tutorial.rst index 04d73d95a..19a76fc16 100644 --- a/docs/intro/tutorial.rst +++ b/docs/intro/tutorial.rst @@ -252,7 +252,7 @@ object: .. code-block:: pycon >>> response.css("title") - [] + [] The result of running ``response.css('title')`` is a list-like object called :class:`~scrapy.selector.SelectorList`, which represents a list of @@ -348,7 +348,7 @@ Besides `CSS`_, Scrapy selectors also support using `XPath`_ expressions: .. code-block:: pycon >>> response.xpath("//title") - [] + [] >>> response.xpath("//title/text()").get() 'Quotes to Scrape' @@ -410,8 +410,8 @@ We get a list of selectors for the quote HTML elements with: .. code-block:: pycon >>> response.css("div.quote") - [, - , + [, + , ...] Each of the selectors returned by the query above allows us to run further diff --git a/pytest.ini b/pytest.ini index f5fbf2529..866f0c950 100644 --- a/pytest.ini +++ b/pytest.ini @@ -5,7 +5,6 @@ python_files=test_*.py __init__.py python_classes= addopts = --assert=plain - --doctest-modules --ignore=docs/_ext --ignore=docs/conf.py --ignore=docs/news.rst diff --git a/tox.ini b/tox.ini index 06b52f3dc..9d81ec3e7 100644 --- a/tox.ini +++ b/tox.ini @@ -30,7 +30,7 @@ passenv = #allow tox virtualenv to upgrade pip/wheel/setuptools download = true commands = - pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:--durations=10 docs scrapy tests} + pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:--durations=10 docs scrapy tests} --doctest-modules install_command = python -I -m pip install -ctests/upper-constraints.txt {opts} {packages} @@ -99,6 +99,8 @@ setenv = _SCRAPY_PINNED=true install_command = python -I -m pip install {opts} {packages} +commands = + pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:--durations=10 scrapy tests} [testenv:pinned] basepython = python3.7 @@ -108,6 +110,7 @@ deps = install_command = {[pinned]install_command} setenv = {[pinned]setenv} +commands = {[pinned]commands} [testenv:windows-pinned] basepython = python3 @@ -117,6 +120,7 @@ deps = install_command = {[pinned]install_command} setenv = {[pinned]setenv} +commands = {[pinned]commands} [testenv:extra-deps] basepython = python3 @@ -137,7 +141,7 @@ commands = [testenv:asyncio-pinned] deps = {[testenv:pinned]deps} -commands = {[testenv:asyncio]commands} +commands = {[pinned]commands} --reactor=asyncio install_command = {[pinned]install_command} setenv = {[pinned]setenv} @@ -152,7 +156,8 @@ basepython = {[testenv:pypy3]basepython} deps = {[pinned]deps} PyPyDispatcher==2.1.0 -commands = {[testenv:pypy3]commands} +commands = + pytest --durations=10 scrapy tests install_command = {[pinned]install_command} setenv = {[pinned]setenv} From 67bfb304cdeb19a0b72b0a09542582f718cf07d6 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Fri, 21 Apr 2023 18:52:58 +0400 Subject: [PATCH 482/532] Release notes for the current master. --- docs/news.rst | 105 ++++++++++++++++++++++++++++++++++++++- docs/topics/settings.rst | 2 +- 2 files changed, 104 insertions(+), 3 deletions(-) diff --git a/docs/news.rst b/docs/news.rst index 9b9eeac71..6cf366449 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -3,6 +3,108 @@ Release notes ============= +.. _release-2.9.0: + +Scrapy 2.9.0 (YYYY-MM-DD) +------------------------- + +Highlights: + +- Per-domain request settings. +- Compatibility with new cryptography_ and new parsel_. +- TBD + +New features +~~~~~~~~~~~~ + +- Settings correponding to :setting:`DOWNLOAD_DELAY`, + :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` and + :setting:`RANDOMIZE_DOWNLOAD_DELAY` can now be set on a per domain basis + via the new :setting:`DOWNLOAD_SLOTS` setting. (:issue:`5328`) + +- Added :func:`scrapy.utils.request.request_to_curl`, a function to produce a + curl command from a :class:`~scrapy.Request` object. (:issue:`5892`) + +- Values of :setting:`FILES_STORE` and :setting:`IMAGES_STORE` can now be + :class:`pathlib.Path` instances. (:issue:`5801`) + +- :func:`scrapy.utils.request.request_from_curl` now supports $-prefixed + string values for the curl ``--data-raw`` argument, which are produced by + browsers for data that includes certain symbols. (:issue:`5899`, + :issue:`5901`) + +- The ``scrapy parse`` command now also works with async generator callbacks. + (:issue:`5819`, :issue:`5824`) + +- The ``scrapy genspider`` command now properly works with HTTPS URLs. + (:issue:`3553`, :issue:`5808`) + +- Improved handling of asyncio loops. (:issue:`5831`, :issue:`5832`) + +- :class:`LinkExtractor ` + now skips certain malformed URLs instead of raising an exception. + (:issue:`5881`) + +- :func:`scrapy.utils.python.get_func_args` now supports more types of + callables. (:issue:`5872`, :issue:`5885`) + +Bug fixes +~~~~~~~~~ + +- Fixed an error when using feed postprocessing with S3 storage. + (:issue:`5500`, :issue:`5581`) + +- Added the missing :meth:`scrapy.settings.BaseSettings.setdefault` method. + (:issue:`5811`, :issue:`5821`) + +- Fixed an error when using cryptography_ 40.0.0+ and + :setting:`DOWNLOADER_CLIENT_TLS_VERBOSE_LOGGING` is enabled. + (:issue:`5857`, :issue:`5858`) + +- The checksums returned by :class:`~scrapy.pipelines.files.FilesPipeline` + for files on Google Cloud Storage are no longer Base64-encoded. + (:issue:`5874`, :issue:`5891`) + +- Fixed an error breaking user handling of send failures in + :meth:`scrapy.mail.MailSender.send()`. (:issue:`1611`, :issue:`5880`) + +Documentation +~~~~~~~~~~~~~ + +- Expanded contributing docs. (:issue:`5109`, :issue:`5851`) + +- Added blacken-docs_ to pre-commit and reformatted the docs with it. + (:issue:`5813`, :issue:`5816`) + +- Fixed a JS issue. (:issue:`5875`, :issue:`5877`) + +- Fixed ``make htmlview``. (:issue:`5878`, :issue:`5879`) + +- Fixed typos and other small errors. (:issue:`5827`, :issue:`5839`, + :issue:`5883`, :issue:`5890`, :issue:`5895`, :issue:`5904`) + +Quality assurance +~~~~~~~~~~~~~~~~~ + +- Extended typing hints. (:issue:`5805`, :issue:`5889`, :issue:`5896`) + +- Tests for most of the examples in the docs are now run as a part of CI, + found problems were fixed. (:issue:`5816`, :issue:`5826`) + +- Removed usage of deprecated Python classes. (:issue:`5849`) + +- Silenced ``include-ignored`` warnings from coverage. (:issue:`5820`) + +- Fixed a random failure of the ``test_feedexport.test_batch_path_differ`` + test. (:issue:`5855`, :issue:`5898`) + +- Updated docstrings to match output produced by parsel_ 1.8.1 so that they + don't cause test failures. (:issue:`5902`) + +- Other CI and pre-commit improvements. (:issue:`5802`, :issue:`5823`) + +.. _blacken-docs: https://github.com/adamchainz/blacken-docs + .. _release-2.8.0: Scrapy 2.8.0 (2023-02-02) @@ -4207,8 +4309,6 @@ Relocations + Note: telnet is not enabled on Python 3 (https://github.com/scrapy/scrapy/pull/1524#issuecomment-146985595) -.. _parsel: https://github.com/scrapy/parsel - Bugfixes ~~~~~~~~ @@ -5638,6 +5738,7 @@ First release of Scrapy. .. _LevelDB: https://github.com/google/leveldb .. _lxml: https://lxml.de/ .. _marshal: https://docs.python.org/2/library/marshal.html +.. _parsel: https://github.com/scrapy/parsel .. _parsel.csstranslator.GenericTranslator: https://parsel.readthedocs.io/en/latest/parsel.html#parsel.csstranslator.GenericTranslator .. _parsel.csstranslator.HTMLTranslator: https://parsel.readthedocs.io/en/latest/parsel.html#parsel.csstranslator.HTMLTranslator .. _parsel.csstranslator.XPathExpr: https://parsel.readthedocs.io/en/latest/parsel.html#parsel.csstranslator.XPathExpr diff --git a/docs/topics/settings.rst b/docs/topics/settings.rst index 4412b5c1c..3e06d84f9 100644 --- a/docs/topics/settings.rst +++ b/docs/topics/settings.rst @@ -783,7 +783,7 @@ DOWNLOAD_SLOTS Default: ``{}`` -Allows to define concurrency/delay parameters on per slot(domain) basis: +Allows to define concurrency/delay parameters on per slot (domain) basis: .. code-block:: python From 8c8fb67057609d79a31e76587fc66b162d746906 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 24 Apr 2023 11:34:34 +0400 Subject: [PATCH 483/532] Update tool versions (#5908) --- .bandit.yml | 1 + .pre-commit-config.yaml | 6 +++--- tox.ini | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.bandit.yml b/.bandit.yml index c8e84cc2e..2aae8a0aa 100644 --- a/.bandit.yml +++ b/.bandit.yml @@ -1,5 +1,6 @@ skips: - B101 +- B113 # https://github.com/PyCQA/bandit/issues/1010 - B105 - B301 - B303 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4b90233e5..faf8808f2 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,6 +1,6 @@ repos: - repo: https://github.com/PyCQA/bandit - rev: 1.7.4 + rev: 1.7.5 hooks: - id: bandit args: [-r, -c, .bandit.yml] @@ -9,7 +9,7 @@ repos: hooks: - id: flake8 - repo: https://github.com/psf/black.git - rev: 23.1.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/pycqa/isort @@ -21,4 +21,4 @@ repos: hooks: - id: blacken-docs additional_dependencies: - - black==23.1.0 + - black==23.3.0 diff --git a/tox.ini b/tox.ini index 9d81ec3e7..af8f1f57a 100644 --- a/tox.ini +++ b/tox.ini @@ -58,7 +58,7 @@ commands = basepython = python3 deps = {[testenv:extra-deps]deps} - pylint==2.16.0 + pylint==2.17.2 commands = pylint conftest.py docs extras scrapy setup.py tests From 9af596a6b806a0cd0ba7f0d3bcff9ea6e3a19519 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 25 Apr 2023 10:24:14 -0500 Subject: [PATCH 484/532] feat: Add support for the Parsel JMESPath --- scrapy/http/response/__init__.py | 6 ++++++ scrapy/http/response/text.py | 3 +++ 2 files changed, 9 insertions(+) diff --git a/scrapy/http/response/__init__.py b/scrapy/http/response/__init__.py index 4213d491d..a82ed834a 100644 --- a/scrapy/http/response/__init__.py +++ b/scrapy/http/response/__init__.py @@ -142,6 +142,12 @@ class Response(object_ref): """ raise NotSupported("Response content isn't text") + def jmespath(self, *a, **kw): + """Shortcut method implemented only by responses whose content + is text (subclasses of TextResponse). + """ + raise NotSupported("Response content isn't text") + def xpath(self, *a, **kw): """Shortcut method implemented only by responses whose content is text (subclasses of TextResponse). diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 73bb811de..360d6334e 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -139,6 +139,9 @@ class TextResponse(Response): self._cached_selector = Selector(self) return self._cached_selector + def jmespath(self, query, **kwargs): + return self.selector.jmespath(query, **kwargs) + def xpath(self, query, **kwargs): return self.selector.xpath(query, **kwargs) From b50c032ee9a75d1c9b42f1126637fdc655b141a8 Mon Sep 17 00:00:00 2001 From: guillermo-bondonno <95530227+guillermo-bondonno@users.noreply.github.com> Date: Wed, 26 Apr 2023 03:20:37 -0300 Subject: [PATCH 485/532] Add feed_slot_closed and feed_exporter_closed signals (#5876) --- docs/topics/signals.rst | 27 ++++++++++ scrapy/extensions/feedexport.py | 43 +++++++++++---- scrapy/signals.py | 2 + tests/test_feedexport.py | 92 ++++++++++++++++++++++++++++++--- 4 files changed, 148 insertions(+), 16 deletions(-) diff --git a/docs/topics/signals.rst b/docs/topics/signals.rst index 3400a205a..9bfd1761c 100644 --- a/docs/topics/signals.rst +++ b/docs/topics/signals.rst @@ -307,6 +307,33 @@ spider_error :param spider: the spider which raised the exception :type spider: :class:`~scrapy.Spider` object +feed_slot_closed +~~~~~~~~~~~~~~~~ + +.. signal:: feed_slot_closed +.. function:: feed_slot_closed(slot) + + Sent when a :ref:`feed exports ` slot is closed. + + This signal supports returning deferreds from its handlers. + + :param slot: the slot closed + :type slot: scrapy.extensions.feedexport.FeedSlot + + +feed_exporter_closed +~~~~~~~~~~~~~~~~~~~~ + +.. signal:: feed_exporter_closed +.. function:: feed_exporter_closed() + + Sent when the :ref:`feed exports ` extension is closed, + during the handling of the :signal:`spider_closed` signal by the extension, + after all feed exporting has been handled. + + This signal supports returning deferreds from its handlers. + + Request signals --------------- diff --git a/scrapy/extensions/feedexport.py b/scrapy/extensions/feedexport.py index da1a88299..bcf0b779a 100644 --- a/scrapy/extensions/feedexport.py +++ b/scrapy/extensions/feedexport.py @@ -11,10 +11,11 @@ import warnings from datetime import datetime from pathlib import Path from tempfile import NamedTemporaryFile -from typing import IO, Any, Callable, Optional, Tuple, Union +from typing import IO, Any, Callable, List, Optional, Tuple, Union from urllib.parse import unquote, urlparse from twisted.internet import defer, threads +from twisted.internet.defer import DeferredList from w3lib.url import file_uri_to_path from zope.interface import Interface, implementer @@ -23,6 +24,8 @@ from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.extensions.postprocessing import PostProcessingManager from scrapy.utils.boto import is_botocore_available from scrapy.utils.conf import feed_complete_default_values_from_settings +from scrapy.utils.defer import maybe_deferred_to_future +from scrapy.utils.deprecate import create_deprecated_class from scrapy.utils.ftp import ftp_store_file from scrapy.utils.log import failure_to_exc_info from scrapy.utils.misc import create_instance, load_object @@ -271,7 +274,7 @@ class FTPFeedStorage(BlockingFeedStorage): ) -class _FeedSlot: +class FeedSlot: def __init__( self, file, @@ -309,7 +312,15 @@ class _FeedSlot: self._exporting = False +_FeedSlot = create_deprecated_class( + name="_FeedSlot", + new_class=FeedSlot, +) + + class FeedExporter: + _pending_deferreds: List[defer.Deferred] = [] + @classmethod def from_crawler(cls, crawler): exporter = cls(crawler) @@ -375,12 +386,18 @@ class FeedExporter: ) ) - def close_spider(self, spider): - deferred_list = [] + async def close_spider(self, spider): for slot in self.slots: - d = self._close_slot(slot, spider) - deferred_list.append(d) - return defer.DeferredList(deferred_list) if deferred_list else None + self._close_slot(slot, spider) + + # Await all deferreds + if self._pending_deferreds: + await maybe_deferred_to_future(DeferredList(self._pending_deferreds)) + + # Send FEED_EXPORTER_CLOSED signal + await maybe_deferred_to_future( + self.crawler.signals.send_catch_log_deferred(signals.feed_exporter_closed) + ) def _close_slot(self, slot, spider): def get_file(slot_): @@ -404,6 +421,14 @@ class FeedExporter: d.addErrback( self._handle_store_error, logmsg, spider, type(slot.storage).__name__ ) + self._pending_deferreds.append(d) + d.addCallback( + lambda _: self.crawler.signals.send_catch_log_deferred( + signals.feed_slot_closed, slot=slot + ) + ) + d.addBoth(lambda _: self._pending_deferreds.remove(d)) + return d def _handle_store_error(self, f, logmsg, spider, slot_type): @@ -444,7 +469,7 @@ class FeedExporter: indent=feed_options["indent"], **feed_options["item_export_kwargs"], ) - slot = _FeedSlot( + slot = FeedSlot( file=file, exporter=exporter, storage=storage, @@ -579,7 +604,7 @@ class FeedExporter: self, spider: Spider, uri_params_function: Optional[Union[str, Callable[[dict, Spider], dict]]], - slot: Optional[_FeedSlot] = None, + slot: Optional[FeedSlot] = None, ) -> dict: params = {} for k in dir(spider): diff --git a/scrapy/signals.py b/scrapy/signals.py index 8cf2a4d93..0090f1c8b 100644 --- a/scrapy/signals.py +++ b/scrapy/signals.py @@ -22,6 +22,8 @@ bytes_received = object() item_scraped = object() item_dropped = object() item_error = object() +feed_slot_closed = object() +feed_exporter_closed = object() # for backward compatibility stats_spider_opened = spider_opened diff --git a/tests/test_feedexport.py b/tests/test_feedexport.py index 83de0e77e..b1059099a 100644 --- a/tests/test_feedexport.py +++ b/tests/test_feedexport.py @@ -32,18 +32,19 @@ from zope.interface import implementer from zope.interface.verify import verifyObject import scrapy +from scrapy import signals from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.exporters import CsvItemExporter, JsonItemExporter from scrapy.extensions.feedexport import ( BlockingFeedStorage, FeedExporter, + FeedSlot, FileFeedStorage, FTPFeedStorage, GCSFeedStorage, IFeedStorage, S3FeedStorage, StdoutFeedStorage, - _FeedSlot, ) from scrapy.settings import Settings from scrapy.utils.python import to_unicode @@ -660,8 +661,8 @@ class FeedExportTestBase(ABC, unittest.TestCase): return result -class InstrumentedFeedSlot(_FeedSlot): - """Instrumented _FeedSlot subclass for keeping track of calls to +class InstrumentedFeedSlot(FeedSlot): + """Instrumented FeedSlot subclass for keeping track of calls to start_exporting and finish_exporting.""" def start_exporting(self): @@ -964,7 +965,7 @@ class FeedExportTest(FeedExportTestBase): listener = IsExportingListener() InstrumentedFeedSlot.subscribe__listener(listener) - with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + with mock.patch("scrapy.extensions.feedexport.FeedSlot", InstrumentedFeedSlot): _ = yield self.exported_data(items, settings) self.assertFalse(listener.start_without_finish) self.assertFalse(listener.finish_without_start) @@ -982,7 +983,7 @@ class FeedExportTest(FeedExportTestBase): listener = IsExportingListener() InstrumentedFeedSlot.subscribe__listener(listener) - with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + with mock.patch("scrapy.extensions.feedexport.FeedSlot", InstrumentedFeedSlot): _ = yield self.exported_data(items, settings) self.assertFalse(listener.start_without_finish) self.assertFalse(listener.finish_without_start) @@ -1003,7 +1004,7 @@ class FeedExportTest(FeedExportTestBase): listener = IsExportingListener() InstrumentedFeedSlot.subscribe__listener(listener) - with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + with mock.patch("scrapy.extensions.feedexport.FeedSlot", InstrumentedFeedSlot): _ = yield self.exported_data(items, settings) self.assertFalse(listener.start_without_finish) self.assertFalse(listener.finish_without_start) @@ -1022,7 +1023,7 @@ class FeedExportTest(FeedExportTestBase): listener = IsExportingListener() InstrumentedFeedSlot.subscribe__listener(listener) - with mock.patch("scrapy.extensions.feedexport._FeedSlot", InstrumentedFeedSlot): + with mock.patch("scrapy.extensions.feedexport.FeedSlot", InstrumentedFeedSlot): _ = yield self.exported_data(items, settings) self.assertFalse(listener.start_without_finish) self.assertFalse(listener.finish_without_start) @@ -2651,6 +2652,83 @@ class BatchDeliveriesTest(FeedExportTestBase): stub.assert_no_pending_responses() +# Test that the FeedExporer sends the feed_exporter_closed and feed_slot_closed signals +class FeedExporterSignalsTest(unittest.TestCase): + items = [ + {"foo": "bar1", "egg": "spam1"}, + {"foo": "bar2", "egg": "spam2", "baz": "quux2"}, + {"foo": "bar3", "baz": "quux3"}, + ] + + with tempfile.NamedTemporaryFile(suffix="json") as tmp: + settings = { + "FEEDS": { + f"file:///{tmp.name}": { + "format": "json", + }, + }, + } + + def feed_exporter_closed_signal_handler(self): + self.feed_exporter_closed_received = True + + def feed_slot_closed_signal_handler(self, slot): + self.feed_slot_closed_received = True + + def feed_exporter_closed_signal_handler_deferred(self): + d = defer.Deferred() + d.addCallback(lambda _: setattr(self, "feed_exporter_closed_received", True)) + d.callback(None) + return d + + def feed_slot_closed_signal_handler_deferred(self, slot): + d = defer.Deferred() + d.addCallback(lambda _: setattr(self, "feed_slot_closed_received", True)) + d.callback(None) + return d + + def run_signaled_feed_exporter( + self, feed_exporter_signal_handler, feed_slot_signal_handler + ): + crawler = get_crawler(settings_dict=self.settings) + feed_exporter = FeedExporter.from_crawler(crawler) + spider = scrapy.Spider("default") + spider.crawler = crawler + crawler.signals.connect( + feed_exporter_signal_handler, + signal=signals.feed_exporter_closed, + ) + crawler.signals.connect( + feed_slot_signal_handler, signal=signals.feed_slot_closed + ) + feed_exporter.open_spider(spider) + for item in self.items: + feed_exporter.item_scraped(item, spider) + defer.ensureDeferred(feed_exporter.close_spider(spider)) + + def test_feed_exporter_signals_sent(self): + self.feed_exporter_closed_received = False + self.feed_slot_closed_received = False + + self.run_signaled_feed_exporter( + self.feed_exporter_closed_signal_handler, + self.feed_slot_closed_signal_handler, + ) + self.assertTrue(self.feed_slot_closed_received) + self.assertTrue(self.feed_exporter_closed_received) + + def test_feed_exporter_signals_sent_deferred(self): + self.feed_exporter_closed_received = False + self.feed_slot_closed_received = False + + self.run_signaled_feed_exporter( + self.feed_exporter_closed_signal_handler_deferred, + self.feed_slot_closed_signal_handler_deferred, + ) + self.assertTrue(self.feed_slot_closed_received) + self.assertTrue(self.feed_exporter_closed_received) + + class FeedExportInitTest(unittest.TestCase): def test_unsupported_storage(self): settings = { From 865c36bdbbd7af0e5dd9c5c333d2285e88dfbcfd Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Fri, 28 Apr 2023 08:56:11 -0600 Subject: [PATCH 486/532] update docs --- docs/topics/request-response.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/topics/request-response.rst b/docs/topics/request-response.rst index 99c7915df..407df32d2 100644 --- a/docs/topics/request-response.rst +++ b/docs/topics/request-response.rst @@ -1281,6 +1281,12 @@ TextResponse objects :class:`TextResponse` objects support the following methods in addition to the standard :class:`Response` ones: + .. method:: TextResponse.jmespath(query) + + A shortcut to ``TextResponse.selector.jmespath(query)``:: + + response.jmespath('object.[*]') + .. method:: TextResponse.xpath(query) A shortcut to ``TextResponse.selector.xpath(query)``:: From 3d29f20fc2021efb80d96389dc02c5a2cac9ef62 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Fri, 28 Apr 2023 23:54:09 -0600 Subject: [PATCH 487/532] added tests for jmespath --- tests/test_selector.py | 138 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) diff --git a/tests/test_selector.py b/tests/test_selector.py index febae46ac..b0deb5c99 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -108,3 +108,141 @@ class SelectorTestCase(unittest.TestCase): def test_selector_bad_args(self): with self.assertRaisesRegex(ValueError, "received both response and text"): Selector(TextResponse(url="http://example.com", body=b""), text="") + + +class JMESPathTestCase(unittest.TestCase): + def test_json_has_html(self) -> None: + """Sometimes the information is returned in a json wrapper""" + body = """ + { + "content": [ + { + "name": "A", + "value": "a" + }, + { + "name": { + "age": 18 + }, + "value": "b" + }, + { + "name": "C", + "value": "c" + }, + { + "name": "D", + "value": "
d
" + } + ], + "html": "
def
" + } + """ + resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") + self.assertEqual( + resp.jmespath("html").get(), + "
def
", + ) + self.assertEqual( + resp.jmespath("html").xpath("//div/a/text()").getall(), + ["a", "b", "d"], + ) + self.assertEqual(resp.jmespath("html").css("div > b").getall(), ["f"]) + self.assertEqual(resp.jmespath("content").jmespath("name.age").get(), "18") + + def test_html_has_json(self) -> None: + body = """ +
+

Information

+ + { + "user": [ + { + "name": "A", + "age": 18 + }, + { + "name": "B", + "age": 32 + }, + { + "name": "C", + "age": 22 + }, + { + "name": "D", + "age": 25 + } + ], + "total": 4, + "status": "ok" + } + +
+ """ + resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") + self.assertEqual( + resp.xpath("//div/content/text()").jmespath("user[*].name").getall(), + ["A", "B", "C", "D"], + ) + self.assertEqual( + resp.xpath("//div/content").jmespath("user[*].name").getall(), + ["A", "B", "C", "D"], + ) + self.assertEqual(resp.xpath("//div/content").jmespath("total").get(), "4") + + def test_jmestpath_with_re(self) -> None: + body = """ +
+

Information

+ + { + "user": [ + { + "name": "A", + "age": 18 + }, + { + "name": "B", + "age": 32 + }, + { + "name": "C", + "age": 22 + }, + { + "name": "D", + "age": 25 + } + ], + "total": 4, + "status": "ok" + } + +
+ """ + resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") + self.assertEqual( + resp.xpath("//div/content/text()").jmespath("user[*].name").re(r"(\w+)"), + ["A", "B", "C", "D"], + ) + self.assertEqual( + resp.xpath("//div/content").jmespath("user[*].name").re(r"(\w+)"), + ["A", "B", "C", "D"], + ) + + self.assertEqual( + resp.xpath("//div/content").jmespath("unavailable").re(r"(\d+)"), [] + ) + + self.assertEqual( + resp.xpath("//div/content").jmespath("unavailable").re_first(r"(\d+)"), + None, + ) + + self.assertEqual( + resp.xpath("//div/content") + .jmespath("user[*].age.to_string(@)") + .re(r"(\d+)"), + ["18", "32", "22", "25"], + ) From 578606779d0f127a759f8b1623c1e4be341a17db Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Sat, 29 Apr 2023 00:52:39 -0600 Subject: [PATCH 488/532] update tests --- tests/test_http_response.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/tests/test_http_response.py b/tests/test_http_response.py index dbc9f1fef..cefdb1709 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -32,6 +32,9 @@ class BaseResponseTest(unittest.TestCase): isinstance(self.response_class("http://example.com/"), self.response_class) ) self.assertRaises(TypeError, self.response_class, b"http://example.com") + self.assertRaises( + TypeError, self.response_class, url="http://example.com", body={} + ) # body can be str or None self.assertTrue( isinstance( @@ -192,6 +195,7 @@ class BaseResponseTest(unittest.TestCase): self.assertRaisesRegex(AttributeError, msg, getattr, r, "text") self.assertRaisesRegex(NotSupported, msg, r.css, "body") self.assertRaisesRegex(NotSupported, msg, r.xpath, "//body") + self.assertRaisesRegex(NotSupported, msg, r.jmespath, "body") else: r.text r.css("body") From 8acde511a902515c56f7452f950221657953b92e Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 2 May 2023 12:11:23 -0300 Subject: [PATCH 489/532] fix: non-UTF-8 content-type headers --- scrapy/http/response/text.py | 6 ++++-- scrapy/responsetypes.py | 4 +++- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 73bb811de..d580a7876 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -100,11 +100,13 @@ class TextResponse(Response): @memoizemethod_noargs def _headers_encoding(self): content_type = self.headers.get(b"Content-Type", b"") - return http_content_type_encoding(to_unicode(content_type)) + return http_content_type_encoding(to_unicode(content_type, encoding="latin-1")) def _body_inferred_encoding(self): if self._cached_benc is None: - content_type = to_unicode(self.headers.get(b"Content-Type", b"")) + content_type = to_unicode( + self.headers.get(b"Content-Type", b""), encoding="latin-1" + ) benc, ubody = html_to_unicode( content_type, self.body, diff --git a/scrapy/responsetypes.py b/scrapy/responsetypes.py index f01e9096c..58884f21a 100644 --- a/scrapy/responsetypes.py +++ b/scrapy/responsetypes.py @@ -51,7 +51,9 @@ class ResponseTypes: header""" if content_encoding: return Response - mimetype = to_unicode(content_type).split(";")[0].strip().lower() + mimetype = ( + to_unicode(content_type, encoding="latin-1").split(";")[0].strip().lower() + ) return self.from_mimetype(mimetype) def from_content_disposition(self, content_disposition): From 7b49aa1b019672d4f2ab7a8d75465381cb5705a4 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 2 May 2023 12:53:04 -0300 Subject: [PATCH 490/532] chore: add tests --- tests/test_http_response.py | 11 +++++++++++ tests/test_responsetypes.py | 1 + 2 files changed, 12 insertions(+) diff --git a/tests/test_http_response.py b/tests/test_http_response.py index dbc9f1fef..a05b702aa 100644 --- a/tests/test_http_response.py +++ b/tests/test_http_response.py @@ -448,6 +448,13 @@ class TextResponseTest(BaseResponseTest): body=codecs.BOM_UTF8 + b"\xc2\xa3", headers={"Content-type": ["text/html; charset=cp1251"]}, ) + r9 = self.response_class( + "http://www.example.com", + body=b"\x80", + headers={ + "Content-type": [b"application/x-download; filename=\x80dummy.txt"] + }, + ) self.assertEqual(r1._headers_encoding(), "utf-8") self.assertEqual(r2._headers_encoding(), None) @@ -458,9 +465,12 @@ class TextResponseTest(BaseResponseTest): self.assertEqual(r4._headers_encoding(), None) self.assertEqual(r5._headers_encoding(), None) self.assertEqual(r8._headers_encoding(), "cp1251") + self.assertEqual(r9._headers_encoding(), None) self.assertEqual(r8._declared_encoding(), "utf-8") + self.assertEqual(r9._declared_encoding(), None) self._assert_response_encoding(r5, "utf-8") self._assert_response_encoding(r8, "utf-8") + self._assert_response_encoding(r9, "cp1252") assert ( r4._body_inferred_encoding() is not None and r4._body_inferred_encoding() != "ascii" @@ -470,6 +480,7 @@ class TextResponseTest(BaseResponseTest): self._assert_response_values(r3, "iso-8859-1", "\xa3") self._assert_response_values(r6, "gb18030", "\u2015") self._assert_response_values(r7, "gb18030", "\u2015") + self._assert_response_values(r9, "cp1252", "€") # TextResponse (and subclasses) must be passed a encoding when instantiating with unicode bodies self.assertRaises( diff --git a/tests/test_responsetypes.py b/tests/test_responsetypes.py index 859960518..6e1ed82f0 100644 --- a/tests/test_responsetypes.py +++ b/tests/test_responsetypes.py @@ -42,6 +42,7 @@ class ResponseTypesTest(unittest.TestCase): ("application/octet-stream", Response), ("application/x-json; encoding=UTF8;charset=UTF-8", TextResponse), ("application/json-amazonui-streaming;charset=UTF-8", TextResponse), + (b"application/x-download; filename=\x80dummy.txt", Response), ] for source, cls in mappings: retcls = responsetypes.from_content_type(source) From 1eb44604853e24f7b526853d5e95414949fd88c6 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 2 May 2023 18:49:05 -0600 Subject: [PATCH 491/532] fix: jmespath --- scrapy/http/response/text.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/scrapy/http/response/text.py b/scrapy/http/response/text.py index 360d6334e..dd042a2bd 100644 --- a/scrapy/http/response/text.py +++ b/scrapy/http/response/text.py @@ -140,7 +140,12 @@ class TextResponse(Response): return self._cached_selector def jmespath(self, query, **kwargs): - return self.selector.jmespath(query, **kwargs) + if not hasattr(self.selector, "jmespath"): # type: ignore[attr-defined] + raise AttributeError( + "Please install parsel >= 1.8.1 to get jmespath support" + ) + + return self.selector.jmespath(query, **kwargs) # type: ignore[attr-defined] def xpath(self, query, **kwargs): return self.selector.xpath(query, **kwargs) From a604dfae5c12a55760d0b44d7da06b022cce3615 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 2 May 2023 19:19:00 -0600 Subject: [PATCH 492/532] update tests --- tests/test_selector.py | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/tests/test_selector.py b/tests/test_selector.py index b0deb5c99..274d63d8d 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -1,10 +1,16 @@ import weakref +import packaging.version as version +import parsel +import pytest from twisted.trial import unittest from scrapy.http import HtmlResponse, TextResponse, XmlResponse from scrapy.selector import Selector +PARSEL_VERSION = version.parse(getattr(parsel, "__version__", "0.0")) +PARSEL_18_PLUS = PARSEL_VERSION >= version.parse("1.8.0") + class SelectorTestCase(unittest.TestCase): def test_simple_selection(self): @@ -111,8 +117,12 @@ class SelectorTestCase(unittest.TestCase): class JMESPathTestCase(unittest.TestCase): + @pytest.mark.skipif( + not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" + ) def test_json_has_html(self) -> None: """Sometimes the information is returned in a json wrapper""" + body = """ { "content": [ @@ -150,6 +160,9 @@ class JMESPathTestCase(unittest.TestCase): self.assertEqual(resp.jmespath("html").css("div > b").getall(), ["f"]) self.assertEqual(resp.jmespath("content").jmespath("name.age").get(), "18") + @pytest.mark.skipif( + not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" + ) def test_html_has_json(self) -> None: body = """
@@ -191,6 +204,9 @@ class JMESPathTestCase(unittest.TestCase): ) self.assertEqual(resp.xpath("//div/content").jmespath("total").get(), "4") + @pytest.mark.skipif( + not PARSEL_18_PLUS, reason="parsel < 1.8 doesn't support jmespath" + ) def test_jmestpath_with_re(self) -> None: body = """
@@ -246,3 +262,14 @@ class JMESPathTestCase(unittest.TestCase): .re(r"(\d+)"), ["18", "32", "22", "25"], ) + + @pytest.mark.skipif(PARSEL_18_PLUS, reason="parsel >= 1.8 supports jmespath") + def test_jmespath_not_available(my_json_page) -> None: + body = """ + { + "website": {"name": "Example"} + } + """ + resp = TextResponse(url="http://example.com", body=body, encoding="utf-8") + with pytest.raises(AttributeError): + resp.jmespath("website.name").get() From 4bb99fd2f3a957958ed9ea8fa418b6127a6bebee Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 2 May 2023 19:26:20 -0600 Subject: [PATCH 493/532] fix: pylint --- tests/test_selector.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/test_selector.py b/tests/test_selector.py index 274d63d8d..311c09aba 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -1,8 +1,8 @@ import weakref -import packaging.version as version import parsel import pytest +from packaging import version from twisted.trial import unittest from scrapy.http import HtmlResponse, TextResponse, XmlResponse @@ -11,6 +11,9 @@ from scrapy.selector import Selector PARSEL_VERSION = version.parse(getattr(parsel, "__version__", "0.0")) PARSEL_18_PLUS = PARSEL_VERSION >= version.parse("1.8.0") +print(PARSEL_VERSION) +print(PARSEL_18_PLUS) + class SelectorTestCase(unittest.TestCase): def test_simple_selection(self): From a038faf11c2bc47921f57954a2405279d427f890 Mon Sep 17 00:00:00 2001 From: Jalil SA <61639983+jxlil@users.noreply.github.com> Date: Tue, 2 May 2023 19:40:04 -0600 Subject: [PATCH 494/532] fix: tests/tes_selector.py --- tests/test_selector.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/tests/test_selector.py b/tests/test_selector.py index 311c09aba..85527bba9 100644 --- a/tests/test_selector.py +++ b/tests/test_selector.py @@ -11,9 +11,6 @@ from scrapy.selector import Selector PARSEL_VERSION = version.parse(getattr(parsel, "__version__", "0.0")) PARSEL_18_PLUS = PARSEL_VERSION >= version.parse("1.8.0") -print(PARSEL_VERSION) -print(PARSEL_18_PLUS) - class SelectorTestCase(unittest.TestCase): def test_simple_selection(self): From d907f9e09284367d555c89d2bea862a310f60a19 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Wed, 3 May 2023 22:12:21 -0300 Subject: [PATCH 495/532] fix: Handle Parsel > 1.7.0 warning --- scrapy/selector/unified.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/scrapy/selector/unified.py b/scrapy/selector/unified.py index cff97104a..208dd807f 100644 --- a/scrapy/selector/unified.py +++ b/scrapy/selector/unified.py @@ -4,6 +4,11 @@ XPath selectors based on lxml from parsel import Selector as _ParselSelector +try: + from parsel.selector import _NOT_SET +except ImportError: + _NOT_SET = None + from scrapy.http import HtmlResponse, XmlResponse from scrapy.utils.python import to_bytes from scrapy.utils.trackref import object_ref @@ -63,7 +68,7 @@ class Selector(_ParselSelector, object_ref): __slots__ = ["response"] selectorlist_cls = SelectorList - def __init__(self, response=None, text=None, type=None, root=None, **kwargs): + def __init__(self, response=None, text=None, type=None, root=_NOT_SET, **kwargs): if response is not None and text is not None: raise ValueError( f"{self.__class__.__name__}.__init__() received " From 7317ff11014c4bf20d4e35193cc96a7151d1d5b0 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Thu, 4 May 2023 05:55:25 -0300 Subject: [PATCH 496/532] refactor: use kwargs strategy --- scrapy/selector/unified.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/scrapy/selector/unified.py b/scrapy/selector/unified.py index 208dd807f..caff79e9c 100644 --- a/scrapy/selector/unified.py +++ b/scrapy/selector/unified.py @@ -4,17 +4,14 @@ XPath selectors based on lxml from parsel import Selector as _ParselSelector -try: - from parsel.selector import _NOT_SET -except ImportError: - _NOT_SET = None - from scrapy.http import HtmlResponse, XmlResponse from scrapy.utils.python import to_bytes from scrapy.utils.trackref import object_ref __all__ = ["Selector", "SelectorList"] +_NOT_SET = object() + def _st(response, st): if st is None: @@ -85,4 +82,8 @@ class Selector(_ParselSelector, object_ref): kwargs.setdefault("base_url", response.url) self.response = response - super().__init__(text=text, type=st, root=root, **kwargs) + + if root is not _NOT_SET: + kwargs["root"] = root + + super().__init__(text=text, type=st, **kwargs) From cba891a66c2223745d7b8484550ed54ca1e155ec Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 4 May 2023 15:04:33 +0400 Subject: [PATCH 497/532] Enable doc tests for selectors.rst, fix issues. --- docs/topics/selectors.rst | 81 ++++++++++++++++++++++++++------------- 1 file changed, 55 insertions(+), 26 deletions(-) diff --git a/docs/topics/selectors.rst b/docs/topics/selectors.rst index c25c75d17..4a64d530b 100644 --- a/docs/topics/selectors.rst +++ b/docs/topics/selectors.rst @@ -48,6 +48,8 @@ Constructing selectors .. highlight:: python +.. skip: start + Response objects expose a :class:`~scrapy.Selector` instance on ``.selector`` attribute: @@ -66,6 +68,8 @@ more shortcuts: ``response.xpath()`` and ``response.css()``: >>> response.css("span::text").get() 'good' +.. skip: end + Scrapy selectors are instances of :class:`~scrapy.Selector` class constructed by passing either :class:`~scrapy.http.TextResponse` object or markup as a string (in ``text`` argument). @@ -93,7 +97,7 @@ Constructing from response - :class:`~scrapy.http.HtmlResponse` is one of >>> from scrapy.selector import Selector >>> from scrapy.http import HtmlResponse - >>> response = HtmlResponse(url="http://example.com", body=body) + >>> response = HtmlResponse(url="http://example.com", body=body, encoding="utf-8") >>> Selector(response=response).xpath("//span/text()").get() 'good' @@ -103,6 +107,13 @@ Constructing from response - :class:`~scrapy.http.HtmlResponse` is one of Using selectors --------------- +.. invisible-code-block: python + + html_response = response = load_response( + "https://docs.scrapy.org/en/latest/_static/selectors-sample1.html", + "../_static/selectors-sample1.html", + ) + To explain how to use the selectors we'll use the ``Scrapy shell`` (which provides interactive testing) and an example page located in the Scrapy documentation server: @@ -135,7 +146,7 @@ page, let's construct an XPath for selecting the text inside the title tag: .. code-block:: pycon >>> response.xpath("//title/text()") - [] + [] To actually extract the textual data, you must call the selector ``.get()`` or ``.getall()`` methods, as follows: @@ -363,11 +374,11 @@ too. Here's an example: >>> links = response.xpath('//a[contains(@href, "image")]') >>> links.getall() - ['Name: My image 1
', - 'Name: My image 2
', - 'Name: My image 3
', - 'Name: My image 4
', - 'Name: My image 5
'] + ['Name: My image 1
image1', + 'Name: My image 2
image2', + 'Name: My image 3
image3', + 'Name: My image 4
image4', + 'Name: My image 5
image5'] >>> for index, link in enumerate(links): ... href_xpath = link.xpath("@href").get() @@ -447,11 +458,11 @@ Here's an example used to extract image names from the :ref:`HTML code .. code-block:: pycon >>> response.xpath('//a[contains(@href, "image")]/text()').re(r"Name:\s*(.*)") - ['My image 1', - 'My image 2', - 'My image 3', - 'My image 4', - 'My image 5'] + ['My image 1 ', + 'My image 2 ', + 'My image 3 ', + 'My image 4 ', + 'My image 5 '] There's an additional helper reciprocating ``.get()`` (and its alias ``.extract_first()``) for ``.re()``, named ``.re_first()``. @@ -460,7 +471,7 @@ Use it to extract just the first matching string: .. code-block:: pycon >>> response.xpath('//a[contains(@href, "image")]/text()').re_first(r"Name:\s*(.*)") - 'My image 1' + 'My image 1 ' .. _old-extraction-api: @@ -761,6 +772,8 @@ on `XPath variables`_. Removing namespaces ------------------- +.. skip: start + When dealing with scraping projects, it is often quite convenient to get rid of namespaces altogether and just work with element names, to write more simple/convenient XPaths. You can use the @@ -808,8 +821,8 @@ nodes can be accessed directly by their names: >>> response.selector.remove_namespaces() >>> response.xpath("//link") - [, - , + [, + , ... If you wonder why the namespace removal procedure isn't always called by default @@ -824,6 +837,7 @@ of relevance, are: case some element names clash between namespaces. These cases are very rare though. +.. skip: end Using EXSLT extensions ---------------------- @@ -881,6 +895,8 @@ extracting text elements for example. Example extracting microdata (sample content taken from https://schema.org/Product) with groups of itemscopes and corresponding itemprops: +.. skip: next + .. code-block:: pycon >>> doc = """ @@ -977,26 +993,35 @@ Scrapy selectors also provide a sorely missed XPath extension function ``has-class`` that returns ``True`` for nodes that have all of the specified HTML classes. -.. highlight:: html +For the following HTML: -For the following HTML:: +.. code-block:: pycon -

First

-

Second

-

Third

-

Fourth

- -.. highlight:: python + >>> from scrapy.http import HtmlResponse + >>> response = HtmlResponse( + ... url="http://example.com", + ... body=""" + ... + ... + ...

First

+ ...

Second

+ ...

Third

+ ...

Fourth

+ ... + ... + ... """, + ... encoding="utf-8", + ... ) You can use it like this: .. code-block:: pycon >>> response.xpath('//p[has-class("foo")]') - [, - ] + [, + ] >>> response.xpath('//p[has-class("foo", "bar-baz")]') - [] + [] >>> response.xpath('//p[has-class("foo", "bar")]') [] @@ -1132,6 +1157,8 @@ a :class:`~scrapy.http.HtmlResponse` object like this: Selector examples on XML response --------------------------------- +.. skip: start + Here are some examples to illustrate concepts for :class:`Selector` objects instantiated with an :class:`~scrapy.http.XmlResponse` object: @@ -1154,4 +1181,6 @@ instantiated with an :class:`~scrapy.http.XmlResponse` object: sel.register_namespace("g", "http://base.google.com/ns/1.0") sel.xpath("//g:price").getall() +.. skip: end + .. _Google Base XML feed: https://support.google.com/merchants/answer/160589?hl=en&ref_topic=2473799 From d1d6465ef4ea8987efb08e2f9abfd65b36719e04 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 4 May 2023 17:19:01 +0400 Subject: [PATCH 498/532] Address feedback. --- docs/news.rst | 44 ++++++++++++++++++++++---------------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/news.rst b/docs/news.rst index 6cf366449..5f189760d 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -10,7 +10,7 @@ Scrapy 2.9.0 (YYYY-MM-DD) Highlights: -- Per-domain request settings. +- Per-domain download settings. - Compatibility with new cryptography_ and new parsel_. - TBD @@ -19,7 +19,7 @@ New features - Settings correponding to :setting:`DOWNLOAD_DELAY`, :setting:`CONCURRENT_REQUESTS_PER_DOMAIN` and - :setting:`RANDOMIZE_DOWNLOAD_DELAY` can now be set on a per domain basis + :setting:`RANDOMIZE_DOWNLOAD_DELAY` can now be set on a per-domain basis via the new :setting:`DOWNLOAD_SLOTS` setting. (:issue:`5328`) - Added :func:`scrapy.utils.request.request_to_curl`, a function to produce a @@ -28,26 +28,6 @@ New features - Values of :setting:`FILES_STORE` and :setting:`IMAGES_STORE` can now be :class:`pathlib.Path` instances. (:issue:`5801`) -- :func:`scrapy.utils.request.request_from_curl` now supports $-prefixed - string values for the curl ``--data-raw`` argument, which are produced by - browsers for data that includes certain symbols. (:issue:`5899`, - :issue:`5901`) - -- The ``scrapy parse`` command now also works with async generator callbacks. - (:issue:`5819`, :issue:`5824`) - -- The ``scrapy genspider`` command now properly works with HTTPS URLs. - (:issue:`3553`, :issue:`5808`) - -- Improved handling of asyncio loops. (:issue:`5831`, :issue:`5832`) - -- :class:`LinkExtractor ` - now skips certain malformed URLs instead of raising an exception. - (:issue:`5881`) - -- :func:`scrapy.utils.python.get_func_args` now supports more types of - callables. (:issue:`5872`, :issue:`5885`) - Bug fixes ~~~~~~~~~ @@ -65,6 +45,26 @@ Bug fixes for files on Google Cloud Storage are no longer Base64-encoded. (:issue:`5874`, :issue:`5891`) +- :func:`scrapy.utils.request.request_from_curl` now supports $-prefixed + string values for the curl ``--data-raw`` argument, which are produced by + browsers for data that includes certain symbols. (:issue:`5899`, + :issue:`5901`) + +- The :command:`parse` command now also works with async generator callbacks. + (:issue:`5819`, :issue:`5824`) + +- The :command:`genspider` command now properly works with HTTPS URLs. + (:issue:`3553`, :issue:`5808`) + +- Improved handling of asyncio loops. (:issue:`5831`, :issue:`5832`) + +- :class:`LinkExtractor ` + now skips certain malformed URLs instead of raising an exception. + (:issue:`5881`) + +- :func:`scrapy.utils.python.get_func_args` now supports more types of + callables. (:issue:`5872`, :issue:`5885`) + - Fixed an error breaking user handling of send failures in :meth:`scrapy.mail.MailSender.send()`. (:issue:`1611`, :issue:`5880`) From 636559f1cc652e839ef42522e7168e3ff9d77921 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Thu, 4 May 2023 17:55:07 +0400 Subject: [PATCH 499/532] Add newer changes. --- docs/news.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/docs/news.rst b/docs/news.rst index 5f189760d..cbbb376e5 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -12,7 +12,8 @@ Highlights: - Per-domain download settings. - Compatibility with new cryptography_ and new parsel_. -- TBD +- JMESPath selectors from the new parsel_. +- Bug fixes. New features ~~~~~~~~~~~~ @@ -22,6 +23,12 @@ New features :setting:`RANDOMIZE_DOWNLOAD_DELAY` can now be set on a per-domain basis via the new :setting:`DOWNLOAD_SLOTS` setting. (:issue:`5328`) +- Added :meth:`TextResponse.jmespath`, a shortcut for JMESPath selectors + available since parsel_ 1.8.1. (:issue:`5894`, :issue:`5915`) + +- Added :signal:`feed_slot_closed` and :signal:`feed_exporter_closed` + signals. (:issue:`5876`) + - Added :func:`scrapy.utils.request.request_to_curl`, a function to produce a curl command from a :class:`~scrapy.Request` object. (:issue:`5892`) @@ -31,6 +38,8 @@ New features Bug fixes ~~~~~~~~~ +- Fixed a warning with Parsel 1.8.1+. (:issue:`5903`, :issue:`5918`) + - Fixed an error when using feed postprocessing with S3 storage. (:issue:`5500`, :issue:`5581`) @@ -65,6 +74,9 @@ Bug fixes - :func:`scrapy.utils.python.get_func_args` now supports more types of callables. (:issue:`5872`, :issue:`5885`) +- Fixed an error when processing non-UTF8 values of ``Content-Type`` headers. + (:issue:`5914`, :issue:`5917`) + - Fixed an error breaking user handling of send failures in :meth:`scrapy.mail.MailSender.send()`. (:issue:`1611`, :issue:`5880`) @@ -89,7 +101,7 @@ Quality assurance - Extended typing hints. (:issue:`5805`, :issue:`5889`, :issue:`5896`) - Tests for most of the examples in the docs are now run as a part of CI, - found problems were fixed. (:issue:`5816`, :issue:`5826`) + found problems were fixed. (:issue:`5816`, :issue:`5826`, :issue:`5919`) - Removed usage of deprecated Python classes. (:issue:`5849`) @@ -99,9 +111,10 @@ Quality assurance test. (:issue:`5855`, :issue:`5898`) - Updated docstrings to match output produced by parsel_ 1.8.1 so that they - don't cause test failures. (:issue:`5902`) + don't cause test failures. (:issue:`5902`, :issue:`5919`) -- Other CI and pre-commit improvements. (:issue:`5802`, :issue:`5823`) +- Other CI and pre-commit improvements. (:issue:`5802`, :issue:`5823`, + :issue:`5908`) .. _blacken-docs: https://github.com/adamchainz/blacken-docs From caa66fa15ae5d353434e5bb1d0c1cc2bdf857b6c Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 8 May 2023 13:27:01 +0400 Subject: [PATCH 500/532] Mention deprecating _FeedSlot. --- docs/news.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/news.rst b/docs/news.rst index cbbb376e5..4e198c893 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -15,6 +15,13 @@ Highlights: - JMESPath selectors from the new parsel_. - Bug fixes. +Deprecations +~~~~~~~~~~~~ + +- :class:`scrapy.extensions.feedexport._FeedSlot` is renamed to + :class:`scrapy.extensions.feedexport.FeedSlot` and the old name is + deprecated. (:issue:`5876`) + New features ~~~~~~~~~~~~ From 52c072640aa61884de05214cb1bdda07c2a87bef Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 8 May 2023 14:30:06 +0400 Subject: [PATCH 501/532] =?UTF-8?q?Bump=20version:=202.8.0=20=E2=86=92=202?= =?UTF-8?q?.9.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .bumpversion.cfg | 2 +- docs/news.rst | 2 +- scrapy/VERSION | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 4cfba674d..a00b7cfb3 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.8.0 +current_version = 2.9.0 commit = True tag = True tag_name = {new_version} diff --git a/docs/news.rst b/docs/news.rst index 4e198c893..c7ad11862 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -5,7 +5,7 @@ Release notes .. _release-2.9.0: -Scrapy 2.9.0 (YYYY-MM-DD) +Scrapy 2.9.0 (2023-05-08) ------------------------- Highlights: diff --git a/scrapy/VERSION b/scrapy/VERSION index 834f26295..c8e38b614 100644 --- a/scrapy/VERSION +++ b/scrapy/VERSION @@ -1 +1 @@ -2.8.0 +2.9.0 From c327a92e971411e50e49dded772a73b293f9f0a9 Mon Sep 17 00:00:00 2001 From: bulat Date: Tue, 9 May 2023 18:04:18 +0500 Subject: [PATCH 502/532] add additional requests examples. --- docs/topics/asyncio.rst | 47 +++++++++++++++++++++++++++++++++++++++++ scrapy/utils/defer.py | 10 +++++---- 2 files changed, 53 insertions(+), 4 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 7713b1af1..7aa83f505 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -98,6 +98,53 @@ Futures. Scrapy provides two helpers for this: into your own code. +Async additional requests +===================== + +The spider below shows a single use-case of scraping page and gathering price from a separate url:: + + + class SingleRequestSpider(scrapy.Spider): + name = "single" + start_urls = ["https://example.org/product"] + + async def parse(self, response, **kwargs): + additional_request = scrapy.Request('https://example.org/price') + deferred = self.crawler.engine.download(additional_request) + additional_response = await maybe_deferred_to_future(deferred) + yield { + 'h1': response.css('h1').get(), + 'price': additional_response.css('#price').get(), + } + + +Spider with gathering batch requests:: + + class BatchRequestsSpider(scrapy.Spider): + name = "batch" + start_urls = ["https://example.com/product"] + + async def parse(self, response, **kwargs): + additional_requests = [ + scrapy.Request("https://example.com/price1"), + scrapy.Request("https://example.com/price2"), + ] + coroutines = [] + for r in additional_requests: + deffered = self.crawler.engine.download(r) + coroutines.append(maybe_deferred_to_future(deffered)) + + responses = await asyncio.gather( + *coroutines, return_exceptions=True + ) + yield { + 'h1': response.css('h1::text').get(), + 'price': responses[0].css('.price_color::text').get(), + 'price2': responses[1].css('.price_color::text').get(), + } + + + .. _enforce-asyncio-requirement: Enforcing asyncio as a requirement diff --git a/scrapy/utils/defer.py b/scrapy/utils/defer.py index d25ebbdf4..a46274fef 100644 --- a/scrapy/utils/defer.py +++ b/scrapy/utils/defer.py @@ -340,8 +340,9 @@ def deferred_to_future(d: Deferred) -> Future: class MySpider(Spider): ... async def parse(self, response): - d = treq.get('https://example.com/additional') - additional_response = await deferred_to_future(d) + additional_request = scrapy.Request('https://example.org/price') + deferred = self.crawler.engine.download(additional_request) + additional_response = await deferred_to_future(deferred) """ return d.asFuture(_get_asyncio_event_loop()) @@ -368,8 +369,9 @@ def maybe_deferred_to_future(d: Deferred) -> Union[Deferred, Future]: class MySpider(Spider): ... async def parse(self, response): - d = treq.get('https://example.com/additional') - extra_response = await maybe_deferred_to_future(d) + additional_request = scrapy.Request('https://example.org/price') + deferred = self.crawler.engine.download(additional_request) + additional_response = await maybe_deferred_to_future(deferred) """ if not is_asyncio_reactor_installed(): return d From a75231a1ecd9a08b31ea3c1d5b59e457ac85ccf2 Mon Sep 17 00:00:00 2001 From: bulat Date: Tue, 9 May 2023 18:57:43 +0500 Subject: [PATCH 503/532] fix underline. --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 7aa83f505..d46527cfc 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -99,7 +99,7 @@ Futures. Scrapy provides two helpers for this: Async additional requests -===================== +========================= The spider below shows a single use-case of scraping page and gathering price from a separate url:: From d32c6782347c97086e804da0da01f45622743198 Mon Sep 17 00:00:00 2001 From: bulat Date: Tue, 9 May 2023 19:02:34 +0500 Subject: [PATCH 504/532] Update description. --- docs/topics/asyncio.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index d46527cfc..d439e0ab8 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -101,7 +101,7 @@ Futures. Scrapy provides two helpers for this: Async additional requests ========================= -The spider below shows a single use-case of scraping page and gathering price from a separate url:: +The spider below shows a single use-case of scraping a page and gathering a price from a separate URL:: class SingleRequestSpider(scrapy.Spider): @@ -118,7 +118,7 @@ The spider below shows a single use-case of scraping page and gathering price fr } -Spider with gathering batch requests:: +The spider gathering batch requests:: class BatchRequestsSpider(scrapy.Spider): name = "batch" From 99b0ece165ff27b70a6d7375a86bcc67da111df7 Mon Sep 17 00:00:00 2001 From: bulat Date: Tue, 9 May 2023 20:27:46 +0500 Subject: [PATCH 505/532] remove extra line. --- docs/topics/asyncio.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index d439e0ab8..0dab0ac5e 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -144,7 +144,6 @@ The spider gathering batch requests:: } - .. _enforce-asyncio-requirement: Enforcing asyncio as a requirement From b1f4017788877ba2139f8621ecb5e821c62c111d Mon Sep 17 00:00:00 2001 From: bulat Date: Wed, 10 May 2023 15:34:58 +0500 Subject: [PATCH 506/532] Refactor batch sample. --- docs/topics/asyncio.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 0dab0ac5e..dc83148f5 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -126,8 +126,8 @@ The spider gathering batch requests:: async def parse(self, response, **kwargs): additional_requests = [ - scrapy.Request("https://example.com/price1"), - scrapy.Request("https://example.com/price2"), + scrapy.Request("https://example.com/price"), + scrapy.Request("https://example.com/color"), ] coroutines = [] for r in additional_requests: @@ -139,8 +139,8 @@ The spider gathering batch requests:: ) yield { 'h1': response.css('h1::text').get(), - 'price': responses[0].css('.price_color::text').get(), - 'price2': responses[1].css('.price_color::text').get(), + 'price': responses[0].css('.price::text').get(), + 'color': responses[1].css('color::text').get(), } From 87d10161cd413353eba2abf8ebdc2a8656927c43 Mon Sep 17 00:00:00 2001 From: bulat Date: Wed, 10 May 2023 15:35:48 +0500 Subject: [PATCH 507/532] Add selector as class. --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index dc83148f5..f00ba0ff8 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -140,7 +140,7 @@ The spider gathering batch requests:: yield { 'h1': response.css('h1::text').get(), 'price': responses[0].css('.price::text').get(), - 'color': responses[1].css('color::text').get(), + 'color': responses[1].css('.color::text').get(), } From 57f3140daaa0166f924fcca42d3f3d3ef178bf92 Mon Sep 17 00:00:00 2001 From: Bulat Khabibullin Date: Wed, 10 May 2023 18:31:54 +0500 Subject: [PATCH 508/532] Update docs/topics/asyncio.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- docs/topics/asyncio.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index f00ba0ff8..f9efef108 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -101,8 +101,10 @@ Futures. Scrapy provides two helpers for this: Async additional requests ========================= -The spider below shows a single use-case of scraping a page and gathering a price from a separate URL:: +The spider below shows how to send a request and await its response all from +within a spider callback: +.. code-block:: python class SingleRequestSpider(scrapy.Spider): name = "single" From 26374e21f81eb53f5a21e1cc68a65e54fbb62cb6 Mon Sep 17 00:00:00 2001 From: Bulat Khabibullin Date: Wed, 10 May 2023 18:32:36 +0500 Subject: [PATCH 509/532] Update docs/topics/asyncio.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- docs/topics/asyncio.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index f9efef108..7fe78585a 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -119,8 +119,9 @@ within a spider callback: 'price': additional_response.css('#price').get(), } +You can also send multiple requests in parallel: -The spider gathering batch requests:: +.. code-block:: python class BatchRequestsSpider(scrapy.Spider): name = "batch" From 85103b493289011161731e4fafec4320cd85e0af Mon Sep 17 00:00:00 2001 From: Bulat Khabibullin Date: Thu, 11 May 2023 12:53:43 +0500 Subject: [PATCH 510/532] add proper example MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adrián Chaves --- docs/topics/asyncio.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 7fe78585a..eeec76157 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -123,6 +123,8 @@ You can also send multiple requests in parallel: .. code-block:: python + from twisted.internet.defer import DeferredList + class BatchRequestsSpider(scrapy.Spider): name = "batch" start_urls = ["https://example.com/product"] @@ -132,14 +134,11 @@ You can also send multiple requests in parallel: scrapy.Request("https://example.com/price"), scrapy.Request("https://example.com/color"), ] - coroutines = [] + deferreds = [] for r in additional_requests: - deffered = self.crawler.engine.download(r) - coroutines.append(maybe_deferred_to_future(deffered)) - - responses = await asyncio.gather( - *coroutines, return_exceptions=True - ) + deferred = self.crawler.engine.download(r) + deferreds.append(deferred) + responses = await maybe_deferred_to_future(DeferredList(deferreds)) yield { 'h1': response.css('h1::text').get(), 'price': responses[0].css('.price::text').get(), From 6194db133518b07b92bfdae35332c69e95f5c415 Mon Sep 17 00:00:00 2001 From: bulat Date: Thu, 11 May 2023 12:54:01 +0500 Subject: [PATCH 511/532] Update title. --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 7fe78585a..1b670aaab 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -98,7 +98,7 @@ Futures. Scrapy provides two helpers for this: into your own code. -Async additional requests +Inline requests ========================= The spider below shows how to send a request and await its response all from From fc2d1b217130ebf605636049ea773196a50303a0 Mon Sep 17 00:00:00 2001 From: bulat Date: Thu, 11 May 2023 12:56:29 +0500 Subject: [PATCH 512/532] make example reachable. --- docs/topics/asyncio.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 12bf548df..fcf44c0cb 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -125,8 +125,8 @@ You can also send multiple requests in parallel: from twisted.internet.defer import DeferredList - class BatchRequestsSpider(scrapy.Spider): - name = "batch" + class MultipleRequestsSpider(scrapy.Spider): + name = "multiple" start_urls = ["https://example.com/product"] async def parse(self, response, **kwargs): @@ -141,8 +141,8 @@ You can also send multiple requests in parallel: responses = await maybe_deferred_to_future(DeferredList(deferreds)) yield { 'h1': response.css('h1::text').get(), - 'price': responses[0].css('.price::text').get(), - 'color': responses[1].css('.color::text').get(), + 'price': responses[0][1].css('.price::text').get(), + 'price2': responses[1][1].css('.color::text').get(), } From b62c1263de4b026e8529416d5dede1795d47f7ad Mon Sep 17 00:00:00 2001 From: bulat Date: Thu, 11 May 2023 13:15:30 +0500 Subject: [PATCH 513/532] add import to the example. --- docs/topics/asyncio.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index fcf44c0cb..2ad784335 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -106,6 +106,8 @@ within a spider callback: .. code-block:: python + from scrapy.utils.defer import maybe_deferred_to_future + class SingleRequestSpider(scrapy.Spider): name = "single" start_urls = ["https://example.org/product"] From 4878cc7ef04ae40279d80fec5d5234d17569ce11 Mon Sep 17 00:00:00 2001 From: bulat Date: Thu, 11 May 2023 13:19:40 +0500 Subject: [PATCH 514/532] Add proper imports. --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 2ad784335..a3f45a84b 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -125,7 +125,7 @@ You can also send multiple requests in parallel: .. code-block:: python - from twisted.internet.defer import DeferredList + from scrapy.utils.defer import DeferredList class MultipleRequestsSpider(scrapy.Spider): name = "multiple" From 8de2064ba33d6e0b8e0a22a6b5f6928a35eb44b7 Mon Sep 17 00:00:00 2001 From: bulat Date: Thu, 11 May 2023 13:22:33 +0500 Subject: [PATCH 515/532] add import. --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index a3f45a84b..5e0063be0 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -125,7 +125,7 @@ You can also send multiple requests in parallel: .. code-block:: python - from scrapy.utils.defer import DeferredList + from scrapy.utils.defer import DeferredList, maybe_deferred_to_future class MultipleRequestsSpider(scrapy.Spider): name = "multiple" From 5adada5d19e9e275462330b070b746305115112e Mon Sep 17 00:00:00 2001 From: isabela_catanante Date: Fri, 12 May 2023 12:55:24 +0200 Subject: [PATCH 516/532] Improve the overwrite feed option documentation --- docs/topics/feed-exports.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/topics/feed-exports.rst b/docs/topics/feed-exports.rst index eef0bb5ca..b4ac93b1d 100644 --- a/docs/topics/feed-exports.rst +++ b/docs/topics/feed-exports.rst @@ -175,6 +175,12 @@ FTP supports two different connection modes: `active or passive mode by default. To use the active connection mode instead, set the :setting:`FEED_STORAGE_FTP_ACTIVE` setting to ``True``. +The default value for the ``overwrite`` key in the :setting:`FEEDS` for this +storage backend is: ``True``. + +.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the + previous version of your data. + This storage backend uses :ref:`delayed file delivery `. @@ -209,6 +215,12 @@ You can also define a custom ACL and custom endpoint for exported feeds using th - :setting:`FEED_STORAGE_S3_ACL` - :setting:`AWS_ENDPOINT_URL` +The default value for the ``overwrite`` key in the :setting:`FEEDS` for this +storage backend is: ``True``. + +.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the + previous version of your data. + This storage backend uses :ref:`delayed file delivery `. @@ -236,6 +248,12 @@ You can set a *Project ID* and *Access Control List (ACL)* through the following - :setting:`FEED_STORAGE_GCS_ACL` - :setting:`GCS_PROJECT_ID` +The default value for the ``overwrite`` key in the :setting:`FEEDS` for this +storage backend is: ``True``. + +.. caution:: The value ``True`` in ``overwrite`` will cause you to lose the + previous version of your data. + This storage backend uses :ref:`delayed file delivery `. .. _google-cloud-storage: https://cloud.google.com/storage/docs/reference/libraries#client-libraries-install-python @@ -488,6 +506,8 @@ as a fallback value if that key is not provided for a specific feed definition: - :ref:`topics-feed-storage-s3`: ``True`` (appending `is not supported `_) + - :ref:`topics-feed-storage-gcs`: ``True`` (appending is not supported) + - :ref:`topics-feed-storage-stdout`: ``False`` (overwriting is not supported) .. versionadded:: 2.4.0 From e4cf8fc121fc89d70949a9159bfe67cbd0429e71 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Mon, 15 May 2023 18:51:58 +0200 Subject: [PATCH 517/532] Update asyncio.rst --- docs/topics/asyncio.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index 5e0063be0..efb93c844 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -99,7 +99,7 @@ Futures. Scrapy provides two helpers for this: Inline requests -========================= +=============== The spider below shows how to send a request and await its response all from within a spider callback: From d362699fa3855c7fd6e11204ccd8668128e38a5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A1n=20Chaves?= Date: Tue, 16 May 2023 13:39:02 +0200 Subject: [PATCH 518/532] Move inline request examples to the coroutines documentation --- docs/topics/asyncio.rst | 50 --------------------------------- docs/topics/coroutines.rst | 57 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 50 deletions(-) diff --git a/docs/topics/asyncio.rst b/docs/topics/asyncio.rst index efb93c844..7713b1af1 100644 --- a/docs/topics/asyncio.rst +++ b/docs/topics/asyncio.rst @@ -98,56 +98,6 @@ Futures. Scrapy provides two helpers for this: into your own code. -Inline requests -=============== - -The spider below shows how to send a request and await its response all from -within a spider callback: - -.. code-block:: python - - from scrapy.utils.defer import maybe_deferred_to_future - - class SingleRequestSpider(scrapy.Spider): - name = "single" - start_urls = ["https://example.org/product"] - - async def parse(self, response, **kwargs): - additional_request = scrapy.Request('https://example.org/price') - deferred = self.crawler.engine.download(additional_request) - additional_response = await maybe_deferred_to_future(deferred) - yield { - 'h1': response.css('h1').get(), - 'price': additional_response.css('#price').get(), - } - -You can also send multiple requests in parallel: - -.. code-block:: python - - from scrapy.utils.defer import DeferredList, maybe_deferred_to_future - - class MultipleRequestsSpider(scrapy.Spider): - name = "multiple" - start_urls = ["https://example.com/product"] - - async def parse(self, response, **kwargs): - additional_requests = [ - scrapy.Request("https://example.com/price"), - scrapy.Request("https://example.com/color"), - ] - deferreds = [] - for r in additional_requests: - deferred = self.crawler.engine.download(r) - deferreds.append(deferred) - responses = await maybe_deferred_to_future(DeferredList(deferreds)) - yield { - 'h1': response.css('h1::text').get(), - 'price': responses[0][1].css('.price::text').get(), - 'price2': responses[1][1].css('.color::text').get(), - } - - .. _enforce-asyncio-requirement: Enforcing asyncio as a requirement diff --git a/docs/topics/coroutines.rst b/docs/topics/coroutines.rst index 3916bd295..a65bab3ca 100644 --- a/docs/topics/coroutines.rst +++ b/docs/topics/coroutines.rst @@ -134,6 +134,63 @@ Common use cases for asynchronous code include: .. _aio-libs: https://github.com/aio-libs +.. _inline-requests: + +Inline requests +=============== + +The spider below shows how to send a request and await its response all from +within a spider callback: + +.. code-block:: python + + from scrapy import Spider, Request + from scrapy.utils.defer import maybe_deferred_to_future + + + class SingleRequestSpider(Spider): + name = "single" + start_urls = ["https://example.org/product"] + + async def parse(self, response, **kwargs): + additional_request = Request("https://example.org/price") + deferred = self.crawler.engine.download(additional_request) + additional_response = await maybe_deferred_to_future(deferred) + yield { + "h1": response.css("h1").get(), + "price": additional_response.css("#price").get(), + } + +You can also send multiple requests in parallel: + +.. code-block:: python + + from scrapy import Spider, Request + from scrapy.utils.defer import maybe_deferred_to_future + from twisted.internet.defer import DeferredList + + + class MultipleRequestsSpider(Spider): + name = "multiple" + start_urls = ["https://example.com/product"] + + async def parse(self, response, **kwargs): + additional_requests = [ + Request("https://example.com/price"), + Request("https://example.com/color"), + ] + deferreds = [] + for r in additional_requests: + deferred = self.crawler.engine.download(r) + deferreds.append(deferred) + responses = await maybe_deferred_to_future(DeferredList(deferreds)) + yield { + "h1": response.css("h1::text").get(), + "price": responses[0][1].css(".price::text").get(), + "price2": responses[1][1].css(".color::text").get(), + } + + .. _sync-async-spider-middleware: Mixing synchronous and asynchronous spider middlewares From 49839d6071832aab23093c34fa6ceb961fcdf9d0 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sun, 4 Jun 2023 19:59:58 +0400 Subject: [PATCH 519/532] Don't rely on get_testenv() for running mockserver. --- tests/mockserver.py | 19 +++++++++++++++---- tests/test_crawler.py | 11 ++++++++--- tests/test_proxy_connect.py | 3 --- 3 files changed, 23 insertions(+), 10 deletions(-) diff --git a/tests/mockserver.py b/tests/mockserver.py index eb4f8334e..647b0682e 100644 --- a/tests/mockserver.py +++ b/tests/mockserver.py @@ -1,11 +1,13 @@ import argparse import json +import os import random import sys from pathlib import Path from shutil import rmtree from subprocess import PIPE, Popen from tempfile import mkdtemp +from typing import Dict from urllib.parse import urlencode from OpenSSL import SSL @@ -20,7 +22,6 @@ from twisted.web.static import File from twisted.web.util import redirectTo from scrapy.utils.python import to_bytes, to_unicode -from scrapy.utils.test import get_testenv def getarg(request, name, default=None, type=None): @@ -32,6 +33,16 @@ def getarg(request, name, default=None, type=None): return default +def get_mockserver_env() -> Dict[str, str]: + """Return a OS environment dict suitable to run mockserver processes.""" + + tests_path = Path(__file__).parent.parent + pythonpath = str(tests_path) + os.pathsep + os.environ.get("PYTHONPATH", "") + env = os.environ.copy() + env["PYTHONPATH"] = pythonpath + return env + + # most of the following resources are copied from twisted.web.test.test_webclient class ForeverTakingResource(resource.Resource): """ @@ -264,7 +275,7 @@ class MockServer: self.proc = Popen( [sys.executable, "-u", "-m", "tests.mockserver", "-t", "http"], stdout=PIPE, - env=get_testenv(), + env=get_mockserver_env(), ) http_address = self.proc.stdout.readline().strip().decode("ascii") https_address = self.proc.stdout.readline().strip().decode("ascii") @@ -308,7 +319,7 @@ class MockDNSServer: self.proc = Popen( [sys.executable, "-u", "-m", "tests.mockserver", "-t", "dns"], stdout=PIPE, - env=get_testenv(), + env=get_mockserver_env(), ) self.host = "127.0.0.1" self.port = int( @@ -331,7 +342,7 @@ class MockFTPServer: self.proc = Popen( [sys.executable, "-u", "-m", "tests.ftpserver", "-d", str(self.path)], stderr=PIPE, - env=get_testenv(), + env=get_mockserver_env(), ) for line in self.proc.stderr: if b"starting FTP server" in line: diff --git a/tests/test_crawler.py b/tests/test_crawler.py index 706bfbaa9..ecb9c9b62 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -1,4 +1,5 @@ import logging +import os import platform import subprocess import sys @@ -23,8 +24,8 @@ from scrapy.spiderloader import SpiderLoader from scrapy.utils.log import configure_logging, get_scrapy_root_handler from scrapy.utils.misc import load_object from scrapy.utils.spider import DefaultSpider -from scrapy.utils.test import get_crawler, get_testenv -from tests.mockserver import MockServer +from scrapy.utils.test import get_crawler +from tests.mockserver import MockServer, get_mockserver_env class BaseCrawlerTest(unittest.TestCase): @@ -289,12 +290,16 @@ class CrawlerRunnerHasSpider(unittest.TestCase): class ScriptRunnerMixin: script_dir: Path + cwd = os.getcwd() def run_script(self, script_name: str, *script_args): script_path = self.script_dir / script_name args = [sys.executable, str(script_path)] + list(script_args) p = subprocess.Popen( - args, env=get_testenv(), stdout=subprocess.PIPE, stderr=subprocess.PIPE + args, + env=get_mockserver_env(), + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, ) stdout, stderr = p.communicate() return stderr.decode("utf-8") diff --git a/tests/test_proxy_connect.py b/tests/test_proxy_connect.py index c05f4da91..dc0a82086 100644 --- a/tests/test_proxy_connect.py +++ b/tests/test_proxy_connect.py @@ -21,8 +21,6 @@ class MitmProxy: auth_pass = "scrapy" def start(self): - from scrapy.utils.test import get_testenv - script = """ import sys from mitmproxy.tools.main import mitmdump @@ -46,7 +44,6 @@ sys.exit(mitmdump()) "--ssl-insecure", ], stdout=PIPE, - env=get_testenv(), ) line = self.proc.stdout.readline().decode("utf-8") host_port = re.search(r"listening at http://([^:]+:\d+)", line).group(1) From 493ea435384d4b5891129cbcf61d07b09a00ce7f Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Mon, 12 Jun 2023 21:50:29 +0400 Subject: [PATCH 520/532] Improve finding tests.test_cmdline.settings. --- tests/test_cmdline/__init__.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tests/test_cmdline/__init__.py b/tests/test_cmdline/__init__.py index 15833cd19..25ded143c 100644 --- a/tests/test_cmdline/__init__.py +++ b/tests/test_cmdline/__init__.py @@ -1,4 +1,5 @@ import json +import os import pstats import shutil import sys @@ -14,6 +15,8 @@ from scrapy.utils.test import get_testenv class CmdlineTest(unittest.TestCase): def setUp(self): self.env = get_testenv() + tests_path = Path(__file__).parent.parent + self.env["PYTHONPATH"] += os.pathsep + str(tests_path.parent) self.env["SCRAPY_SETTINGS_MODULE"] = "tests.test_cmdline.settings" def _execute(self, *new_args, **kwargs): From 0adbd210acc9d1af75e42df2b17ee28e3fecdfc8 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Tue, 13 Jun 2023 19:34:26 +0400 Subject: [PATCH 521/532] Fix extra-deps-pinned tests. --- tox.ini | 1 + 1 file changed, 1 insertion(+) diff --git a/tox.ini b/tox.ini index 8a6693a49..5f8bf85f2 100644 --- a/tox.ini +++ b/tox.ini @@ -139,6 +139,7 @@ deps = install_command = {[pinned]install_command} setenv = {[pinned]setenv} +commands = {[pinned]commands} [testenv:asyncio] commands = From 7cfdca8f9b1b1f16aacae958f7a5c8824df056e7 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Wed, 14 Jun 2023 18:23:29 +0400 Subject: [PATCH 522/532] Actually run test_set_asyncio_event_loop(). --- tests/test_utils_asyncio.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/tests/test_utils_asyncio.py b/tests/test_utils_asyncio.py index 01d0ee043..65e352053 100644 --- a/tests/test_utils_asyncio.py +++ b/tests/test_utils_asyncio.py @@ -4,6 +4,7 @@ from unittest import TestCase from pytest import mark +from scrapy.utils.defer import deferred_f_from_coro_f from scrapy.utils.reactor import ( install_reactor, is_asyncio_reactor_installed, @@ -29,6 +30,8 @@ class AsyncioTest(TestCase): assert original_reactor == reactor + @mark.only_asyncio() + @deferred_f_from_coro_f async def test_set_asyncio_event_loop(self): install_reactor("twisted.internet.asyncioreactor.AsyncioSelectorReactor") - assert set_asyncio_event_loop() is asyncio.get_running_loop() + assert set_asyncio_event_loop(None) is asyncio.get_running_loop() From 777a6ea4128cf00d53fa71dc48385bf036cb64fc Mon Sep 17 00:00:00 2001 From: Serhii A Date: Fri, 16 Jun 2023 16:46:06 +0300 Subject: [PATCH 523/532] Make the retry middleware exception list configurable (#5929) --- docs/topics/downloader-middleware.rst | 32 ++++++++++++ scrapy/downloadermiddlewares/retry.py | 63 ++++++++++++------------ scrapy/settings/default_settings.py | 15 ++++++ tests/test_downloadermiddleware_retry.py | 39 +++++++++++++-- 4 files changed, 113 insertions(+), 36 deletions(-) diff --git a/docs/topics/downloader-middleware.rst b/docs/topics/downloader-middleware.rst index 7665a901a..a8e5b23bf 100644 --- a/docs/topics/downloader-middleware.rst +++ b/docs/topics/downloader-middleware.rst @@ -915,6 +915,7 @@ settings (see the settings documentation for more info): * :setting:`RETRY_ENABLED` * :setting:`RETRY_TIMES` * :setting:`RETRY_HTTP_CODES` +* :setting:`RETRY_EXCEPTIONS` .. reqmeta:: dont_retry @@ -966,6 +967,37 @@ In some cases you may want to add 400 to :setting:`RETRY_HTTP_CODES` because it is a common code used to indicate server overload. It is not included by default because HTTP specs say so. +.. setting:: RETRY_EXCEPTIONS + +RETRY_EXCEPTIONS +^^^^^^^^^^^^^^^^ + +Default:: + + [ + 'twisted.internet.defer.TimeoutError', + 'twisted.internet.error.TimeoutError', + 'twisted.internet.error.DNSLookupError', + 'twisted.internet.error.ConnectionRefusedError', + 'twisted.internet.error.ConnectionDone', + 'twisted.internet.error.ConnectError', + 'twisted.internet.error.ConnectionLost', + 'twisted.internet.error.TCPTimedOutError', + 'twisted.web.client.ResponseFailed', + IOError, + 'scrapy.core.downloader.handlers.http11.TunnelError', + ] + +List of exceptions to retry. + +Each list entry may be an exception type or its import path as a string. + +An exception will not be caught when the exception type is not in +:setting:`RETRY_EXCEPTIONS` or when the maximum number of retries for a request +has been exceeded (see :setting:`RETRY_TIMES`). To learn about uncaught +exception propagation, see +:meth:`~scrapy.downloadermiddlewares.DownloaderMiddleware.process_exception`. + .. setting:: RETRY_PRIORITY_ADJUST RETRY_PRIORITY_ADJUST diff --git a/scrapy/downloadermiddlewares/retry.py b/scrapy/downloadermiddlewares/retry.py index 081642a4b..50cbc3111 100644 --- a/scrapy/downloadermiddlewares/retry.py +++ b/scrapy/downloadermiddlewares/retry.py @@ -9,31 +9,36 @@ RETRY_HTTP_CODES - which HTTP response codes to retry Failed pages are collected on the scraping process and rescheduled at the end, once the spider has finished crawling all regular (non failed) pages. """ +import warnings from logging import Logger, getLogger from typing import Optional, Union -from twisted.internet import defer -from twisted.internet.error import ( - ConnectError, - ConnectionDone, - ConnectionLost, - ConnectionRefusedError, - DNSLookupError, - TCPTimedOutError, - TimeoutError, -) -from twisted.web.client import ResponseFailed - -from scrapy.core.downloader.handlers.http11 import TunnelError -from scrapy.exceptions import NotConfigured +from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning from scrapy.http.request import Request +from scrapy.settings import Settings from scrapy.spiders import Spider +from scrapy.utils.misc import load_object from scrapy.utils.python import global_object_name from scrapy.utils.response import response_status_message retry_logger = getLogger(__name__) +class BackwardsCompatibilityMetaclass(type): + @property + def EXCEPTIONS_TO_RETRY(cls): + warnings.warn( + "Attribute RetryMiddleware.EXCEPTIONS_TO_RETRY is deprecated. " + "Use the RETRY_EXCEPTIONS setting instead.", + ScrapyDeprecationWarning, + stacklevel=2, + ) + return tuple( + load_object(x) if isinstance(x, str) else x + for x in Settings().getlist("RETRY_EXCEPTIONS") + ) + + def get_retry_request( request: Request, *, @@ -121,23 +126,7 @@ def get_retry_request( return None -class RetryMiddleware: - # IOError is raised by the HttpCompression middleware when trying to - # decompress an empty response - EXCEPTIONS_TO_RETRY = ( - defer.TimeoutError, - TimeoutError, - DNSLookupError, - ConnectionRefusedError, - ConnectionDone, - ConnectError, - ConnectionLost, - TCPTimedOutError, - ResponseFailed, - IOError, - TunnelError, - ) - +class RetryMiddleware(metaclass=BackwardsCompatibilityMetaclass): def __init__(self, settings): if not settings.getbool("RETRY_ENABLED"): raise NotConfigured @@ -147,6 +136,16 @@ class RetryMiddleware: ) self.priority_adjust = settings.getint("RETRY_PRIORITY_ADJUST") + if not hasattr( + self, "EXCEPTIONS_TO_RETRY" + ): # If EXCEPTIONS_TO_RETRY is not "overriden" + self.exceptions_to_retry = tuple( + load_object(x) if isinstance(x, str) else x + for x in settings.getlist("RETRY_EXCEPTIONS") + ) + else: + self.exceptions_to_retry = self.EXCEPTIONS_TO_RETRY + @classmethod def from_crawler(cls, crawler): return cls(crawler.settings) @@ -160,7 +159,7 @@ class RetryMiddleware: return response def process_exception(self, request, exception, spider): - if isinstance(exception, self.EXCEPTIONS_TO_RETRY) and not request.meta.get( + if isinstance(exception, self.exceptions_to_retry) and not request.meta.get( "dont_retry", False ): return self._retry(request, exception, spider) diff --git a/scrapy/settings/default_settings.py b/scrapy/settings/default_settings.py index 260ec1701..89837b4ab 100644 --- a/scrapy/settings/default_settings.py +++ b/scrapy/settings/default_settings.py @@ -258,6 +258,21 @@ RETRY_ENABLED = True RETRY_TIMES = 2 # initial response + 2 retries = 3 requests RETRY_HTTP_CODES = [500, 502, 503, 504, 522, 524, 408, 429] RETRY_PRIORITY_ADJUST = -1 +RETRY_EXCEPTIONS = [ + "twisted.internet.defer.TimeoutError", + "twisted.internet.error.TimeoutError", + "twisted.internet.error.DNSLookupError", + "twisted.internet.error.ConnectionRefusedError", + "twisted.internet.error.ConnectionDone", + "twisted.internet.error.ConnectError", + "twisted.internet.error.ConnectionLost", + "twisted.internet.error.TCPTimedOutError", + "twisted.web.client.ResponseFailed", + # IOError is raised by the HttpCompression middleware when trying to + # decompress an empty response + IOError, + "scrapy.core.downloader.handlers.http11.TunnelError", +] ROBOTSTXT_OBEY = False ROBOTSTXT_PARSER = "scrapy.robotstxt.ProtegoRobotParser" diff --git a/tests/test_downloadermiddleware_retry.py b/tests/test_downloadermiddleware_retry.py index 63bd61848..97ae1e29a 100644 --- a/tests/test_downloadermiddleware_retry.py +++ b/tests/test_downloadermiddleware_retry.py @@ -1,5 +1,6 @@ import logging import unittest +import warnings from testfixtures import LogCapture from twisted.internet import defer @@ -15,6 +16,7 @@ from twisted.web.client import ResponseFailed from scrapy.downloadermiddlewares.retry import RetryMiddleware, get_retry_request from scrapy.exceptions import IgnoreRequest from scrapy.http import Request, Response +from scrapy.settings.default_settings import RETRY_EXCEPTIONS from scrapy.spiders import Spider from scrapy.utils.test import get_crawler @@ -110,19 +112,48 @@ class RetryTest(unittest.TestCase): == 2 ) - def _test_retry_exception(self, req, exception): + def test_exception_to_retry_added(self): + exc = ValueError + settings_dict = { + "RETRY_EXCEPTIONS": list(RETRY_EXCEPTIONS) + [exc], + } + crawler = get_crawler(Spider, settings_dict=settings_dict) + mw = RetryMiddleware.from_crawler(crawler) + req = Request(f"http://www.scrapytest.org/{exc.__name__}") + self._test_retry_exception(req, exc("foo"), mw) + + def test_exception_to_retry_customMiddleware(self): + exc = ValueError + + with warnings.catch_warnings(record=True) as warns: + + class MyRetryMiddleware(RetryMiddleware): + EXCEPTIONS_TO_RETRY = RetryMiddleware.EXCEPTIONS_TO_RETRY + (exc,) + + self.assertEqual(len(warns), 1) + + mw2 = MyRetryMiddleware.from_crawler(self.crawler) + req = Request(f"http://www.scrapytest.org/{exc.__name__}") + req = mw2.process_exception(req, exc("foo"), self.spider) + assert isinstance(req, Request) + self.assertEqual(req.meta["retry_times"], 1) + + def _test_retry_exception(self, req, exception, mw=None): + if mw is None: + mw = self.mw + # first retry - req = self.mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception, self.spider) assert isinstance(req, Request) self.assertEqual(req.meta["retry_times"], 1) # second retry - req = self.mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception, self.spider) assert isinstance(req, Request) self.assertEqual(req.meta["retry_times"], 2) # discard it - req = self.mw.process_exception(req, exception, self.spider) + req = mw.process_exception(req, exception, self.spider) self.assertEqual(req, None) From 2122278d4bb7177a550bc0b04dd96d1fc1fad1a0 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sun, 18 Jun 2023 18:37:50 +0400 Subject: [PATCH 524/532] Drop Python 3.7 support. --- .github/workflows/tests-macos.yml | 2 +- .github/workflows/tests-ubuntu.yml | 13 +++++-------- .github/workflows/tests-windows.yml | 5 +---- README.rst | 2 +- docs/contributing.rst | 12 ++++++------ docs/intro/install.rst | 2 +- scrapy/__init__.py | 4 ++-- setup.py | 3 +-- tox.ini | 8 +++----- 9 files changed, 21 insertions(+), 30 deletions(-) diff --git a/.github/workflows/tests-macos.yml b/.github/workflows/tests-macos.yml index 174d245ca..3044a1af3 100644 --- a/.github/workflows/tests-macos.yml +++ b/.github/workflows/tests-macos.yml @@ -7,7 +7,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"] + python-version: ["3.8", "3.9", "3.10", "3.11"] steps: - uses: actions/checkout@v3 diff --git a/.github/workflows/tests-ubuntu.yml b/.github/workflows/tests-ubuntu.yml index 96b26a1f8..39e3b0af7 100644 --- a/.github/workflows/tests-ubuntu.yml +++ b/.github/workflows/tests-ubuntu.yml @@ -8,9 +8,6 @@ jobs: fail-fast: false matrix: include: - - python-version: 3.8 - env: - TOXENV: py - python-version: 3.9 env: TOXENV: py @@ -28,19 +25,19 @@ jobs: TOXENV: pypy3 # pinned deps - - python-version: 3.7.13 + - python-version: 3.8.17 env: TOXENV: pinned - - python-version: 3.7.13 + - python-version: 3.8.17 env: TOXENV: asyncio-pinned - - python-version: pypy3.7 + - python-version: pypy3.8 env: TOXENV: pypy3-pinned - - python-version: 3.7.13 + - python-version: 3.8.17 env: TOXENV: extra-deps-pinned - - python-version: 3.7.13 + - python-version: 3.8.17 env: TOXENV: botocore-pinned diff --git a/.github/workflows/tests-windows.yml b/.github/workflows/tests-windows.yml index f60c48841..5bcf74d5e 100644 --- a/.github/workflows/tests-windows.yml +++ b/.github/workflows/tests-windows.yml @@ -8,12 +8,9 @@ jobs: fail-fast: false matrix: include: - - python-version: 3.7 - env: - TOXENV: windows-pinned - python-version: 3.8 env: - TOXENV: py + TOXENV: windows-pinned - python-version: 3.9 env: TOXENV: py diff --git a/README.rst b/README.rst index 970bf2c35..1918850d6 100644 --- a/README.rst +++ b/README.rst @@ -58,7 +58,7 @@ including a list of features. Requirements ============ -* Python 3.7+ +* Python 3.8+ * Works on Linux, Windows, macOS, BSD Install diff --git a/docs/contributing.rst b/docs/contributing.rst index eef92e148..2b3249601 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -265,15 +265,15 @@ To run a specific test (say ``tests/test_loader.py``) use: To run the tests on a specific :doc:`tox ` environment, use ``-e `` with an environment name from ``tox.ini``. For example, to run -the tests with Python 3.7 use:: +the tests with Python 3.10 use:: - tox -e py37 + tox -e py310 You can also specify a comma-separated list of environments, and use :ref:`tox’s parallel mode ` to run the tests on multiple environments in parallel:: - tox -e py37,py38 -p auto + tox -e py39,py310 -p auto To pass command-line options to :doc:`pytest `, add them after ``--`` in your call to :doc:`tox `. Using ``--`` overrides the @@ -283,9 +283,9 @@ default positional arguments (``scrapy tests``) after ``--`` as well:: tox -- scrapy tests -x # stop after first failure You can also use the `pytest-xdist`_ plugin. For example, to run all tests on -the Python 3.7 :doc:`tox ` environment using all your CPU cores:: +the Python 3.10 :doc:`tox ` environment using all your CPU cores:: - tox -e py37 -- scrapy tests -n auto + tox -e py310 -- scrapy tests -n auto To see coverage report install :doc:`coverage ` (``pip install coverage``) and run: @@ -322,4 +322,4 @@ And their unit-tests are in:: .. _pytest-xdist: https://github.com/pytest-dev/pytest-xdist .. _good first issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22 .. _help wanted issues: https://github.com/scrapy/scrapy/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 -.. _test coverage: https://app.codecov.io/gh/scrapy/scrapy \ No newline at end of file +.. _test coverage: https://app.codecov.io/gh/scrapy/scrapy diff --git a/docs/intro/install.rst b/docs/intro/install.rst index 2c2079f68..c90c1d2bf 100644 --- a/docs/intro/install.rst +++ b/docs/intro/install.rst @@ -9,7 +9,7 @@ Installation guide Supported Python versions ========================= -Scrapy requires Python 3.7+, either the CPython implementation (default) or +Scrapy requires Python 3.8+, either the CPython implementation (default) or the PyPy implementation (see :ref:`python:implementations`). .. _intro-install-scrapy: diff --git a/scrapy/__init__.py b/scrapy/__init__.py index a757a9290..cc0e539c4 100644 --- a/scrapy/__init__.py +++ b/scrapy/__init__.py @@ -34,8 +34,8 @@ twisted_version = (_txv.major, _txv.minor, _txv.micro) # Check minimum required Python version -if sys.version_info < (3, 7): - print(f"Scrapy {__version__} requires Python 3.7+") +if sys.version_info < (3, 8): + print(f"Scrapy {__version__} requires Python 3.8+") sys.exit(1) diff --git a/setup.py b/setup.py index c6bcf2439..f1cd4c5e2 100644 --- a/setup.py +++ b/setup.py @@ -80,7 +80,6 @@ setup( "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", @@ -91,7 +90,7 @@ setup( "Topic :: Software Development :: Libraries :: Application Frameworks", "Topic :: Software Development :: Libraries :: Python Modules", ], - python_requires=">=3.7", + python_requires=">=3.8", install_requires=install_requires, extras_require=extras_require, ) diff --git a/tox.ini b/tox.ini index 5f8bf85f2..d5b6118f5 100644 --- a/tox.ini +++ b/tox.ini @@ -16,8 +16,6 @@ deps = #mitmproxy >= 5.3.0; python_version >= '3.9' and implementation_name != 'pypy' # The tests hang with mitmproxy 8.0.0: https://github.com/scrapy/scrapy/issues/5454 mitmproxy >= 4.0.4, < 8; python_version < '3.9' and implementation_name != 'pypy' - # newer markupsafe is incompatible with deps of old mitmproxy (which we get on Python 3.7 and lower) - markupsafe < 2.1.0; python_version < '3.8' and implementation_name != 'pypy' passenv = S3_TEST_FILE_URI AWS_ACCESS_KEY_ID @@ -96,7 +94,7 @@ commands = pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:--durations=10 scrapy tests} [testenv:pinned] -basepython = python3.7 +basepython = python3.8 deps = {[pinned]deps} PyDispatcher==2.0.5 @@ -129,7 +127,7 @@ deps = Twisted[http2] [testenv:extra-deps-pinned] -basepython = python3.7 +basepython = python3.8 deps = {[pinned]deps} boto3==1.20.0 @@ -211,7 +209,7 @@ commands = pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:tests -k s3} [testenv:botocore-pinned] -basepython = python3.7 +basepython = python3.8 deps = {[pinned]deps} botocore==1.4.87 From 1b2c9a3e0ae9766623a06ce7e739a3dfda399159 Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sun, 18 Jun 2023 18:38:56 +0400 Subject: [PATCH 525/532] Bump isort and flake8 versions. --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index faf8808f2..31e9ed1ad 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,7 +5,7 @@ repos: - id: bandit args: [-r, -c, .bandit.yml] - repo: https://github.com/PyCQA/flake8 - rev: 5.0.4 # 6.0.0 drops Python 3.7 support + rev: 6.0.0 hooks: - id: flake8 - repo: https://github.com/psf/black.git @@ -13,7 +13,7 @@ repos: hooks: - id: black - repo: https://github.com/pycqa/isort - rev: 5.11.5 # 5.12 drops Python 3.7 support + rev: 5.12.0 hooks: - id: isort - repo: https://github.com/adamchainz/blacken-docs From 075b89eab5e201246a5bddc4a6ce9c7921de082b Mon Sep 17 00:00:00 2001 From: Andrey Rakhmatullin Date: Sun, 18 Jun 2023 19:08:41 +0400 Subject: [PATCH 526/532] Bump lxml and cryptography to versions with 3.8 wheels available. --- setup.py | 4 ++-- tox.ini | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/setup.py b/setup.py index f1cd4c5e2..ccfe20ae5 100644 --- a/setup.py +++ b/setup.py @@ -20,7 +20,7 @@ def has_environment_marker_platform_impl_support(): install_requires = [ "Twisted>=18.9.0", - "cryptography>=3.4.6", + "cryptography>=36.0.0", "cssselect>=0.9.1", "itemloaders>=1.0.1", "parsel>=1.5.0", @@ -34,7 +34,7 @@ install_requires = [ "setuptools", "packaging", "tldextract", - "lxml>=4.3.0", + "lxml>=4.4.1", ] extras_require = {} cpython_dependencies = [ diff --git a/tox.ini b/tox.ini index d5b6118f5..ec3a59366 100644 --- a/tox.ini +++ b/tox.ini @@ -69,7 +69,7 @@ commands = [pinned] deps = - cryptography==3.4.6 + cryptography==36.0.0 cssselect==0.9.1 h2==3.0 itemadapter==0.1.0 @@ -81,7 +81,7 @@ deps = Twisted[http2]==18.9.0 w3lib==1.17.0 zope.interface==5.1.0 - lxml==4.3.0 + lxml==4.4.1 -rtests/requirements.txt # mitmproxy 4.0.4+ requires upgrading some of the pinned dependencies From 0097b4c0bb4de6e651e8b9d064aae140e11698d5 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 16:40:38 -0300 Subject: [PATCH 527/532] cleanup: Remove `pkg_resources` usage --- docs/topics/components.rst | 2 +- scrapy/cmdline.py | 5 ++--- setup.py | 2 +- tests/test_crawler.py | 2 +- 4 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/topics/components.rst b/docs/topics/components.rst index 1ed55f000..478dd9647 100644 --- a/docs/topics/components.rst +++ b/docs/topics/components.rst @@ -70,7 +70,7 @@ If your requirement is a minimum Scrapy version, you may use .. code-block:: python - from pkg_resources import parse_version + from packaging.version import parse as parse_version import scrapy diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index 730e55350..cfa771104 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -3,8 +3,7 @@ import cProfile import inspect import os import sys - -import pkg_resources +from importlib.metadata import entry_points import scrapy from scrapy.commands import BaseRunSpiderCommand, ScrapyCommand, ScrapyHelpFormatter @@ -49,7 +48,7 @@ def _get_commands_from_module(module, inproject): def _get_commands_from_entry_points(inproject, group="scrapy.commands"): cmds = {} - for entry_point in pkg_resources.iter_entry_points(group): + for entry_point in entry_points(group): obj = entry_point.load() if inspect.isclass(obj): cmds[entry_point.name] = obj() diff --git a/setup.py b/setup.py index ccfe20ae5..f918db09e 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,6 @@ from pathlib import Path -from pkg_resources import parse_version +from packaging.version import parse as parse_version from setuptools import __version__ as setuptools_version from setuptools import find_packages, setup diff --git a/tests/test_crawler.py b/tests/test_crawler.py index ecb9c9b62..d54a2cb7e 100644 --- a/tests/test_crawler.py +++ b/tests/test_crawler.py @@ -6,7 +6,7 @@ import sys import warnings from pathlib import Path -from pkg_resources import parse_version +from packaging.version import parse as parse_version from pytest import mark, raises from twisted import version as twisted_version from twisted.internet import defer From 6afb31b82b5a0a5d2f37962c250fbf34c21d8580 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 16:48:07 -0300 Subject: [PATCH 528/532] chore: Add `packaging` to tests deps --- tests/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/tests/requirements.txt b/tests/requirements.txt index 618949795..72350b216 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -14,3 +14,4 @@ brotli # optional for HTTP compress downloader middleware tests zstandard; implementation_name != 'pypy' # optional for HTTP compress downloader middleware tests ipython pywin32; sys_platform == "win32" +packaging \ No newline at end of file From 6e1af20ac4dd537a4643df5c022f948cf07d05ec Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 17:00:01 -0300 Subject: [PATCH 529/532] fix: add `build-system` --- tox.ini | 3 +++ 1 file changed, 3 insertions(+) diff --git a/tox.ini b/tox.ini index ec3a59366..79d692599 100644 --- a/tox.ini +++ b/tox.ini @@ -218,3 +218,6 @@ setenv = {[pinned]setenv} commands = pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:tests -k s3} + +[build-system] +build-backend = 'setuptools.build_meta' \ No newline at end of file From a93a63c208af1d13d5ea84623d160337c7fec6c5 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 17:05:49 -0300 Subject: [PATCH 530/532] fix: move import to inside function --- setup.py | 3 ++- tests/requirements.txt | 1 - tox.ini | 3 --- 3 files changed, 2 insertions(+), 5 deletions(-) diff --git a/setup.py b/setup.py index f918db09e..dfe5b80ec 100644 --- a/setup.py +++ b/setup.py @@ -1,6 +1,5 @@ from pathlib import Path -from packaging.version import parse as parse_version from setuptools import __version__ as setuptools_version from setuptools import find_packages, setup @@ -15,6 +14,8 @@ def has_environment_marker_platform_impl_support(): it is 18.5, see: https://setuptools.readthedocs.io/en/latest/history.html#id235 """ + from packaging.version import parse as parse_version + return parse_version(setuptools_version) >= parse_version("18.5") diff --git a/tests/requirements.txt b/tests/requirements.txt index 72350b216..618949795 100644 --- a/tests/requirements.txt +++ b/tests/requirements.txt @@ -14,4 +14,3 @@ brotli # optional for HTTP compress downloader middleware tests zstandard; implementation_name != 'pypy' # optional for HTTP compress downloader middleware tests ipython pywin32; sys_platform == "win32" -packaging \ No newline at end of file diff --git a/tox.ini b/tox.ini index 79d692599..ec3a59366 100644 --- a/tox.ini +++ b/tox.ini @@ -218,6 +218,3 @@ setenv = {[pinned]setenv} commands = pytest --cov=scrapy --cov-report=xml --cov-report= {posargs:tests -k s3} - -[build-system] -build-backend = 'setuptools.build_meta' \ No newline at end of file From 0b1da44a05cc64970aa11ccc4d7a4a3bec143443 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 17:14:21 -0300 Subject: [PATCH 531/532] chore: Remove deprecated code --- setup.py | 31 ++++--------------------------- 1 file changed, 4 insertions(+), 27 deletions(-) diff --git a/setup.py b/setup.py index dfe5b80ec..1f214571b 100644 --- a/setup.py +++ b/setup.py @@ -1,24 +1,10 @@ from pathlib import Path -from setuptools import __version__ as setuptools_version from setuptools import find_packages, setup version = (Path(__file__).parent / "scrapy/VERSION").read_text("ascii").strip() -def has_environment_marker_platform_impl_support(): - """Code extracted from 'pytest/setup.py' - https://github.com/pytest-dev/pytest/blob/7538680c/setup.py#L31 - - The first known release to support environment marker with range operators - it is 18.5, see: - https://setuptools.readthedocs.io/en/latest/history.html#id235 - """ - from packaging.version import parse as parse_version - - return parse_version(setuptools_version) >= parse_version("18.5") - - install_requires = [ "Twisted>=18.9.0", "cryptography>=36.0.0", @@ -37,19 +23,10 @@ install_requires = [ "tldextract", "lxml>=4.4.1", ] -extras_require = {} -cpython_dependencies = [ - "PyDispatcher>=2.0.5", -] -if has_environment_marker_platform_impl_support(): - extras_require[ - ':platform_python_implementation == "CPython"' - ] = cpython_dependencies - extras_require[':platform_python_implementation == "PyPy"'] = [ - "PyPyDispatcher>=2.1.0", - ] -else: - install_requires.extend(cpython_dependencies) +extras_require = { + ':platform_python_implementation == "CPython"': ["PyDispatcher>=2.0.5"], + ':platform_python_implementation == "PyPy"': ["PyPyDispatcher>=2.1.0"], +} setup( From 82cf00bbc931723320c9aca3cf0305372027d0a0 Mon Sep 17 00:00:00 2001 From: Laerte Pereira Date: Tue, 20 Jun 2023 18:27:03 -0300 Subject: [PATCH 532/532] fix: default value --- scrapy/cmdline.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scrapy/cmdline.py b/scrapy/cmdline.py index cfa771104..efc9b36ea 100644 --- a/scrapy/cmdline.py +++ b/scrapy/cmdline.py @@ -48,7 +48,7 @@ def _get_commands_from_module(module, inproject): def _get_commands_from_entry_points(inproject, group="scrapy.commands"): cmds = {} - for entry_point in entry_points(group): + for entry_point in entry_points().get(group, {}): obj = entry_point.load() if inspect.isclass(obj): cmds[entry_point.name] = obj()