crawlo 1.2.5__py3-none-any.whl → 1.2.7__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of crawlo might be problematic. Click here for more details.

Files changed (209) hide show
  1. crawlo/__init__.py +61 -61
  2. crawlo/__version__.py +1 -1
  3. crawlo/cleaners/__init__.py +60 -60
  4. crawlo/cleaners/data_formatter.py +225 -225
  5. crawlo/cleaners/encoding_converter.py +125 -125
  6. crawlo/cleaners/text_cleaner.py +232 -232
  7. crawlo/cli.py +75 -88
  8. crawlo/commands/__init__.py +14 -14
  9. crawlo/commands/check.py +594 -594
  10. crawlo/commands/genspider.py +151 -151
  11. crawlo/commands/help.py +138 -144
  12. crawlo/commands/list.py +155 -155
  13. crawlo/commands/run.py +323 -323
  14. crawlo/commands/startproject.py +436 -436
  15. crawlo/commands/stats.py +187 -187
  16. crawlo/commands/utils.py +186 -186
  17. crawlo/config.py +312 -312
  18. crawlo/config_validator.py +251 -251
  19. crawlo/core/__init__.py +2 -2
  20. crawlo/core/engine.py +365 -354
  21. crawlo/core/processor.py +40 -40
  22. crawlo/core/scheduler.py +251 -143
  23. crawlo/crawler.py +1099 -1110
  24. crawlo/data/__init__.py +5 -5
  25. crawlo/data/user_agents.py +107 -107
  26. crawlo/downloader/__init__.py +266 -266
  27. crawlo/downloader/aiohttp_downloader.py +228 -221
  28. crawlo/downloader/cffi_downloader.py +256 -256
  29. crawlo/downloader/httpx_downloader.py +259 -259
  30. crawlo/downloader/hybrid_downloader.py +212 -212
  31. crawlo/downloader/playwright_downloader.py +402 -402
  32. crawlo/downloader/selenium_downloader.py +472 -472
  33. crawlo/event.py +11 -11
  34. crawlo/exceptions.py +81 -81
  35. crawlo/extension/__init__.py +39 -38
  36. crawlo/extension/health_check.py +141 -141
  37. crawlo/extension/log_interval.py +57 -57
  38. crawlo/extension/log_stats.py +81 -81
  39. crawlo/extension/logging_extension.py +43 -43
  40. crawlo/extension/memory_monitor.py +104 -104
  41. crawlo/extension/performance_profiler.py +133 -133
  42. crawlo/extension/request_recorder.py +107 -107
  43. crawlo/filters/__init__.py +154 -154
  44. crawlo/filters/aioredis_filter.py +234 -281
  45. crawlo/filters/memory_filter.py +269 -269
  46. crawlo/items/__init__.py +23 -23
  47. crawlo/items/base.py +21 -21
  48. crawlo/items/fields.py +52 -52
  49. crawlo/items/items.py +104 -104
  50. crawlo/middleware/__init__.py +21 -21
  51. crawlo/middleware/default_header.py +131 -131
  52. crawlo/middleware/download_delay.py +104 -104
  53. crawlo/middleware/middleware_manager.py +136 -135
  54. crawlo/middleware/offsite.py +114 -114
  55. crawlo/middleware/proxy.py +367 -367
  56. crawlo/middleware/request_ignore.py +86 -86
  57. crawlo/middleware/response_code.py +163 -163
  58. crawlo/middleware/response_filter.py +136 -136
  59. crawlo/middleware/retry.py +124 -124
  60. crawlo/mode_manager.py +211 -211
  61. crawlo/network/__init__.py +21 -21
  62. crawlo/network/request.py +338 -338
  63. crawlo/network/response.py +359 -359
  64. crawlo/pipelines/__init__.py +21 -21
  65. crawlo/pipelines/bloom_dedup_pipeline.py +156 -156
  66. crawlo/pipelines/console_pipeline.py +39 -39
  67. crawlo/pipelines/csv_pipeline.py +316 -316
  68. crawlo/pipelines/database_dedup_pipeline.py +222 -222
  69. crawlo/pipelines/json_pipeline.py +218 -218
  70. crawlo/pipelines/memory_dedup_pipeline.py +115 -115
  71. crawlo/pipelines/mongo_pipeline.py +131 -131
  72. crawlo/pipelines/mysql_pipeline.py +317 -317
  73. crawlo/pipelines/pipeline_manager.py +62 -61
  74. crawlo/pipelines/redis_dedup_pipeline.py +166 -165
  75. crawlo/project.py +314 -279
  76. crawlo/queue/pqueue.py +37 -37
  77. crawlo/queue/queue_manager.py +377 -337
  78. crawlo/queue/redis_priority_queue.py +306 -299
  79. crawlo/settings/__init__.py +7 -7
  80. crawlo/settings/default_settings.py +219 -217
  81. crawlo/settings/setting_manager.py +122 -122
  82. crawlo/spider/__init__.py +639 -639
  83. crawlo/stats_collector.py +59 -59
  84. crawlo/subscriber.py +129 -129
  85. crawlo/task_manager.py +30 -30
  86. crawlo/templates/crawlo.cfg.tmpl +10 -10
  87. crawlo/templates/project/__init__.py.tmpl +3 -3
  88. crawlo/templates/project/items.py.tmpl +17 -17
  89. crawlo/templates/project/middlewares.py.tmpl +118 -118
  90. crawlo/templates/project/pipelines.py.tmpl +96 -96
  91. crawlo/templates/project/settings.py.tmpl +288 -324
  92. crawlo/templates/project/settings_distributed.py.tmpl +157 -154
  93. crawlo/templates/project/settings_gentle.py.tmpl +101 -128
  94. crawlo/templates/project/settings_high_performance.py.tmpl +135 -150
  95. crawlo/templates/project/settings_simple.py.tmpl +99 -103
  96. crawlo/templates/project/spiders/__init__.py.tmpl +5 -5
  97. crawlo/templates/run.py.tmpl +45 -47
  98. crawlo/templates/spider/spider.py.tmpl +143 -143
  99. crawlo/tools/__init__.py +182 -182
  100. crawlo/tools/anti_crawler.py +268 -268
  101. crawlo/tools/authenticated_proxy.py +240 -240
  102. crawlo/tools/data_validator.py +180 -180
  103. crawlo/tools/date_tools.py +35 -35
  104. crawlo/tools/distributed_coordinator.py +386 -386
  105. crawlo/tools/retry_mechanism.py +220 -220
  106. crawlo/tools/scenario_adapter.py +262 -262
  107. crawlo/utils/__init__.py +35 -35
  108. crawlo/utils/batch_processor.py +259 -259
  109. crawlo/utils/controlled_spider_mixin.py +439 -439
  110. crawlo/utils/date_tools.py +290 -290
  111. crawlo/utils/db_helper.py +343 -343
  112. crawlo/utils/enhanced_error_handler.py +356 -356
  113. crawlo/utils/env_config.py +143 -106
  114. crawlo/utils/error_handler.py +123 -123
  115. crawlo/utils/func_tools.py +82 -82
  116. crawlo/utils/large_scale_config.py +286 -286
  117. crawlo/utils/large_scale_helper.py +344 -344
  118. crawlo/utils/log.py +128 -128
  119. crawlo/utils/performance_monitor.py +285 -285
  120. crawlo/utils/queue_helper.py +175 -175
  121. crawlo/utils/redis_connection_pool.py +351 -334
  122. crawlo/utils/redis_key_validator.py +198 -198
  123. crawlo/utils/request.py +267 -267
  124. crawlo/utils/request_serializer.py +218 -218
  125. crawlo/utils/spider_loader.py +61 -61
  126. crawlo/utils/system.py +11 -11
  127. crawlo/utils/tools.py +4 -4
  128. crawlo/utils/url.py +39 -39
  129. {crawlo-1.2.5.dist-info → crawlo-1.2.7.dist-info}/METADATA +764 -764
  130. crawlo-1.2.7.dist-info/RECORD +209 -0
  131. examples/__init__.py +7 -7
  132. tests/DOUBLE_CRAWLO_PREFIX_FIX_REPORT.md +81 -81
  133. tests/__init__.py +7 -7
  134. tests/advanced_tools_example.py +275 -275
  135. tests/authenticated_proxy_example.py +236 -236
  136. tests/cleaners_example.py +160 -160
  137. tests/config_validation_demo.py +102 -102
  138. tests/controlled_spider_example.py +205 -205
  139. tests/date_tools_example.py +180 -180
  140. tests/dynamic_loading_example.py +523 -523
  141. tests/dynamic_loading_test.py +104 -104
  142. tests/env_config_example.py +133 -133
  143. tests/error_handling_example.py +171 -171
  144. tests/redis_key_validation_demo.py +130 -130
  145. tests/response_improvements_example.py +144 -144
  146. tests/test_advanced_tools.py +148 -148
  147. tests/test_all_redis_key_configs.py +145 -145
  148. tests/test_authenticated_proxy.py +141 -141
  149. tests/test_cleaners.py +54 -54
  150. tests/test_comprehensive.py +146 -146
  151. tests/test_config_consistency.py +81 -0
  152. tests/test_config_validator.py +193 -193
  153. tests/test_crawlo_proxy_integration.py +172 -172
  154. tests/test_date_tools.py +123 -123
  155. tests/test_default_header_middleware.py +158 -158
  156. tests/test_double_crawlo_fix.py +207 -207
  157. tests/test_double_crawlo_fix_simple.py +124 -124
  158. tests/test_download_delay_middleware.py +221 -221
  159. tests/test_downloader_proxy_compatibility.py +268 -268
  160. tests/test_dynamic_downloaders_proxy.py +124 -124
  161. tests/test_dynamic_proxy.py +92 -92
  162. tests/test_dynamic_proxy_config.py +146 -146
  163. tests/test_dynamic_proxy_real.py +109 -109
  164. tests/test_edge_cases.py +303 -303
  165. tests/test_enhanced_error_handler.py +270 -270
  166. tests/test_env_config.py +121 -121
  167. tests/test_error_handler_compatibility.py +112 -112
  168. tests/test_final_validation.py +153 -153
  169. tests/test_framework_env_usage.py +103 -103
  170. tests/test_integration.py +356 -356
  171. tests/test_item_dedup_redis_key.py +122 -122
  172. tests/test_mode_consistency.py +52 -0
  173. tests/test_offsite_middleware.py +221 -221
  174. tests/test_parsel.py +29 -29
  175. tests/test_performance.py +327 -327
  176. tests/test_proxy_api.py +264 -264
  177. tests/test_proxy_health_check.py +32 -32
  178. tests/test_proxy_middleware.py +121 -121
  179. tests/test_proxy_middleware_enhanced.py +216 -216
  180. tests/test_proxy_middleware_integration.py +136 -136
  181. tests/test_proxy_providers.py +56 -56
  182. tests/test_proxy_stats.py +19 -19
  183. tests/test_proxy_strategies.py +59 -59
  184. tests/test_queue_manager_double_crawlo.py +173 -173
  185. tests/test_queue_manager_redis_key.py +176 -176
  186. tests/test_real_scenario_proxy.py +195 -195
  187. tests/test_redis_config.py +28 -28
  188. tests/test_redis_connection_pool.py +294 -294
  189. tests/test_redis_key_naming.py +181 -181
  190. tests/test_redis_key_validator.py +123 -123
  191. tests/test_redis_queue.py +224 -224
  192. tests/test_request_ignore_middleware.py +182 -182
  193. tests/test_request_serialization.py +70 -70
  194. tests/test_response_code_middleware.py +349 -349
  195. tests/test_response_filter_middleware.py +427 -427
  196. tests/test_response_improvements.py +152 -152
  197. tests/test_retry_middleware.py +241 -241
  198. tests/test_scheduler.py +252 -241
  199. tests/test_scheduler_config_update.py +134 -0
  200. tests/test_simple_response.py +61 -61
  201. tests/test_telecom_spider_redis_key.py +205 -205
  202. tests/test_template_content.py +87 -87
  203. tests/test_template_redis_key.py +134 -134
  204. tests/test_tools.py +153 -153
  205. tests/tools_example.py +257 -257
  206. crawlo-1.2.5.dist-info/RECORD +0 -206
  207. {crawlo-1.2.5.dist-info → crawlo-1.2.7.dist-info}/WHEEL +0 -0
  208. {crawlo-1.2.5.dist-info → crawlo-1.2.7.dist-info}/entry_points.txt +0 -0
  209. {crawlo-1.2.5.dist-info → crawlo-1.2.7.dist-info}/top_level.txt +0 -0
@@ -1,105 +1,105 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- """
4
- DownloadDelayMiddleware 中间件
5
- 用于控制请求之间的延迟时间,支持固定延迟和随机延迟
6
- """
7
-
8
- from asyncio import sleep
9
- from random import uniform
10
- from crawlo.utils.log import get_logger
11
- from crawlo.exceptions import NotConfiguredError
12
-
13
-
14
- class DownloadDelayMiddleware(object):
15
- """
16
- DownloadDelayMiddleware 中间件
17
- 用于控制请求之间的延迟时间,支持固定延迟和随机延迟
18
-
19
- 功能特性:
20
- - 支持固定延迟时间
21
- - 支持随机延迟时间
22
- - 提供详细的日志信息
23
- - 记录延迟统计信息
24
- """
25
-
26
- def __init__(self, settings, log_level, stats=None):
27
- """
28
- 初始化中间件
29
-
30
- Args:
31
- settings: 设置管理器
32
- log_level: 日志级别
33
- stats: 统计信息收集器(可选)
34
- """
35
- self.delay = settings.get_float("DOWNLOAD_DELAY")
36
- if not self.delay:
37
- raise NotConfiguredError("DOWNLOAD_DELAY not set or is zero")
38
-
39
- self.randomness = settings.get_bool("RANDOMNESS", False)
40
-
41
- # 安全地获取随机范围配置
42
- random_range = settings.get_list("RANDOM_RANGE")
43
- if len(random_range) >= 2:
44
- try:
45
- self.floor = float(random_range[0])
46
- self.upper = float(random_range[1])
47
- except (ValueError, TypeError):
48
- # 如果配置无效,使用默认值
49
- self.floor, self.upper = 0.5, 1.5
50
- else:
51
- # 如果配置不完整,使用默认值
52
- self.floor, self.upper = 0.5, 1.5
53
-
54
- self.logger = get_logger(self.__class__.__name__, log_level)
55
- self.stats = stats
56
-
57
- @classmethod
58
- def create_instance(cls, crawler):
59
- """
60
- 创建中间件实例
61
-
62
- Args:
63
- crawler: 爬虫实例
64
-
65
- Returns:
66
- DownloadDelayMiddleware: 中间件实例
67
- """
68
- o = cls(
69
- settings=crawler.settings,
70
- log_level=crawler.settings.get('LOG_LEVEL'),
71
- stats=getattr(crawler, 'stats', None)
72
- )
73
- return o
74
-
75
- async def process_request(self, _request, _spider):
76
- """
77
- 处理请求,添加延迟
78
-
79
- Args:
80
- _request: 请求对象
81
- _spider: 爬虫实例
82
- """
83
- if self.randomness:
84
- # 计算随机延迟时间
85
- delay_time = uniform(self.delay * self.floor, self.delay * self.upper)
86
- await sleep(delay_time)
87
-
88
- # 记录统计信息
89
- if self.stats:
90
- self.stats.inc_value('download_delay/random_count')
91
- self.stats.inc_value('download_delay/random_total_time', delay_time)
92
-
93
- # 记录日志
94
- self.logger.debug(f"应用随机延迟: {delay_time:.2f}秒 (范围: {self.delay * self.floor:.2f} - {self.delay * self.upper:.2f})")
95
- else:
96
- # 应用固定延迟
97
- await sleep(self.delay)
98
-
99
- # 记录统计信息
100
- if self.stats:
101
- self.stats.inc_value('download_delay/fixed_count')
102
- self.stats.inc_value('download_delay/fixed_total_time', self.delay)
103
-
104
- # 记录日志
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ """
4
+ DownloadDelayMiddleware 中间件
5
+ 用于控制请求之间的延迟时间,支持固定延迟和随机延迟
6
+ """
7
+
8
+ from asyncio import sleep
9
+ from random import uniform
10
+ from crawlo.utils.log import get_logger
11
+ from crawlo.exceptions import NotConfiguredError
12
+
13
+
14
+ class DownloadDelayMiddleware(object):
15
+ """
16
+ DownloadDelayMiddleware 中间件
17
+ 用于控制请求之间的延迟时间,支持固定延迟和随机延迟
18
+
19
+ 功能特性:
20
+ - 支持固定延迟时间
21
+ - 支持随机延迟时间
22
+ - 提供详细的日志信息
23
+ - 记录延迟统计信息
24
+ """
25
+
26
+ def __init__(self, settings, log_level, stats=None):
27
+ """
28
+ 初始化中间件
29
+
30
+ Args:
31
+ settings: 设置管理器
32
+ log_level: 日志级别
33
+ stats: 统计信息收集器(可选)
34
+ """
35
+ self.delay = settings.get_float("DOWNLOAD_DELAY")
36
+ if not self.delay:
37
+ raise NotConfiguredError("DOWNLOAD_DELAY not set or is zero")
38
+
39
+ self.randomness = settings.get_bool("RANDOMNESS", False)
40
+
41
+ # 安全地获取随机范围配置
42
+ random_range = settings.get_list("RANDOM_RANGE")
43
+ if len(random_range) >= 2:
44
+ try:
45
+ self.floor = float(random_range[0])
46
+ self.upper = float(random_range[1])
47
+ except (ValueError, TypeError):
48
+ # 如果配置无效,使用默认值
49
+ self.floor, self.upper = 0.5, 1.5
50
+ else:
51
+ # 如果配置不完整,使用默认值
52
+ self.floor, self.upper = 0.5, 1.5
53
+
54
+ self.logger = get_logger(self.__class__.__name__, log_level)
55
+ self.stats = stats
56
+
57
+ @classmethod
58
+ def create_instance(cls, crawler):
59
+ """
60
+ 创建中间件实例
61
+
62
+ Args:
63
+ crawler: 爬虫实例
64
+
65
+ Returns:
66
+ DownloadDelayMiddleware: 中间件实例
67
+ """
68
+ o = cls(
69
+ settings=crawler.settings,
70
+ log_level=crawler.settings.get('LOG_LEVEL'),
71
+ stats=getattr(crawler, 'stats', None)
72
+ )
73
+ return o
74
+
75
+ async def process_request(self, _request, _spider):
76
+ """
77
+ 处理请求,添加延迟
78
+
79
+ Args:
80
+ _request: 请求对象
81
+ _spider: 爬虫实例
82
+ """
83
+ if self.randomness:
84
+ # 计算随机延迟时间
85
+ delay_time = uniform(self.delay * self.floor, self.delay * self.upper)
86
+ await sleep(delay_time)
87
+
88
+ # 记录统计信息
89
+ if self.stats:
90
+ self.stats.inc_value('download_delay/random_count')
91
+ self.stats.inc_value('download_delay/random_total_time', delay_time)
92
+
93
+ # 记录日志
94
+ self.logger.debug(f"应用随机延迟: {delay_time:.2f}秒 (范围: {self.delay * self.floor:.2f} - {self.delay * self.upper:.2f})")
95
+ else:
96
+ # 应用固定延迟
97
+ await sleep(self.delay)
98
+
99
+ # 记录统计信息
100
+ if self.stats:
101
+ self.stats.inc_value('download_delay/fixed_count')
102
+ self.stats.inc_value('download_delay/fixed_total_time', self.delay)
103
+
104
+ # 记录日志
105
105
  self.logger.debug(f"应用固定延迟: {self.delay:.2f}秒")
@@ -1,135 +1,136 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- from pprint import pformat
4
- from types import MethodType
5
- from asyncio import create_task
6
- from collections import defaultdict
7
- from typing import List, Dict, Callable, Optional
8
-
9
- from crawlo import Request, Response
10
- from crawlo.utils.log import get_logger
11
- from crawlo.project import load_class
12
- from crawlo.middleware import BaseMiddleware
13
- from crawlo.project import common_call
14
- from crawlo.event import ignore_request, response_received
15
- from crawlo.exceptions import MiddlewareInitError, InvalidOutputError, RequestMethodError, IgnoreRequestError, \
16
- NotConfiguredError
17
-
18
-
19
- class MiddlewareManager:
20
-
21
- def __init__(self, crawler):
22
- self.crawler = crawler
23
- self.logger = get_logger(self.__class__.__name__, crawler.settings.get('LOG_LEVEL'))
24
- self.middlewares: List = []
25
- self.methods: Dict[str, List[MethodType]] = defaultdict(list)
26
- middlewares = self.crawler.settings.get_list('MIDDLEWARES')
27
- self._add_middleware(middlewares)
28
- self._add_method()
29
-
30
- self.download_method: Callable = crawler.engine.downloader.download
31
- self._stats = crawler.stats
32
-
33
- async def _process_request(self, request: Request):
34
- for method in self.methods['process_request']:
35
- result = await common_call(method, request, self.crawler.spider)
36
- if result is None:
37
- continue
38
- if isinstance(result, (Request, Response)):
39
- return result
40
- raise InvalidOutputError(
41
- f"{method.__self__.__class__.__name__}. must return None or Request or Response, got {type(result).__name__}"
42
- )
43
- return await self.download_method(request)
44
-
45
- async def _process_response(self, request: Request, response: Response):
46
- for method in reversed(self.methods['process_response']):
47
- try:
48
- response = await common_call(method, request, response, self.crawler.spider)
49
- except IgnoreRequestError as exp:
50
- create_task(self.crawler.subscriber.notify(ignore_request, exp, request, self.crawler.spider))
51
- if isinstance(response, Request):
52
- return response
53
- if isinstance(response, Response):
54
- continue
55
- raise InvalidOutputError(
56
- f"{method.__self__.__class__.__name__}. must return Request or Response, got {type(response).__name__}"
57
- )
58
- return response
59
-
60
- async def _process_exception(self, request: Request, exp: Exception):
61
- for method in self.methods['process_exception']:
62
- response = await common_call(method, request, exp, self.crawler.spider)
63
- if response is None:
64
- continue
65
- if isinstance(response, (Request, Response)):
66
- return response
67
- if response:
68
- break
69
- raise InvalidOutputError(
70
- f"{method.__self__.__class__.__name__}. must return None or Request or Response, got {type(response).__name__}"
71
- )
72
- else:
73
- raise exp
74
-
75
- async def download(self, request) -> Optional[Response]:
76
- """ called in the download method. """
77
- try:
78
- response = await self._process_request(request)
79
- except KeyError:
80
- raise RequestMethodError(f"{request.method.lower()} is not supported")
81
- except IgnoreRequestError as exp:
82
- create_task(self.crawler.subscriber.notify(ignore_request, exp, request, self.crawler.spider))
83
- response = await self._process_exception(request, exp)
84
- except Exception as exp:
85
- self._stats.inc_value(f'download_error/{exp.__class__.__name__}')
86
- response = await self._process_exception(request, exp)
87
- else:
88
- create_task(self.crawler.subscriber.notify(response_received, response, self.crawler.spider))
89
- # self.crawler.stats.inc_value('response_received_count')
90
- if isinstance(response, Response):
91
- response = await self._process_response(request, response)
92
- if isinstance(response, Request):
93
- await self.crawler.engine.enqueue_request(request)
94
- return None
95
- return response
96
-
97
- @classmethod
98
- def create_instance(cls, *args, **kwargs):
99
- return cls(*args, **kwargs)
100
-
101
- def _add_middleware(self, middlewares):
102
- enabled_middlewares = [m for m in middlewares if self._validate_middleware(m)]
103
- if enabled_middlewares:
104
- self.logger.info(f'enabled middleware:\n {pformat(enabled_middlewares)}')
105
-
106
- def _validate_middleware(self, middleware):
107
- middleware_cls = load_class(middleware)
108
- if not hasattr(middleware_cls, 'create_instance'):
109
- raise MiddlewareInitError(
110
- f"Middleware init failed, must inherit from `BaseMiddleware` or have a `create_instance` method"
111
- )
112
- try:
113
- instance = middleware_cls.create_instance(self.crawler)
114
- self.middlewares.append(instance)
115
- return True
116
- except NotConfiguredError:
117
- return False
118
-
119
- def _add_method(self):
120
- for middleware in self.middlewares:
121
- if hasattr(middleware, 'process_request'):
122
- if self._validate_middleware_method(method_name='process_request', middleware=middleware):
123
- self.methods['process_request'].append(middleware.process_request)
124
- if hasattr(middleware, 'process_response'):
125
- if self._validate_middleware_method(method_name='process_response', middleware=middleware):
126
- self.methods['process_response'].append(middleware.process_response)
127
- if hasattr(middleware, 'process_exception'):
128
- if self._validate_middleware_method(method_name='process_exception', middleware=middleware):
129
- self.methods['process_exception'].append(middleware.process_exception)
130
-
131
- @staticmethod
132
- def _validate_middleware_method(method_name, middleware) -> bool:
133
- method = getattr(type(middleware), method_name)
134
- base_method = getattr(BaseMiddleware, method_name)
135
- return False if method == base_method else True
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ from pprint import pformat
4
+ from types import MethodType
5
+ from asyncio import create_task
6
+ from collections import defaultdict
7
+ from typing import List, Dict, Callable, Optional
8
+
9
+ from crawlo import Request, Response
10
+ from crawlo.utils.log import get_logger
11
+ from crawlo.project import load_class
12
+ from crawlo.middleware import BaseMiddleware
13
+ from crawlo.project import common_call
14
+ from crawlo.event import ignore_request, response_received
15
+ from crawlo.exceptions import MiddlewareInitError, InvalidOutputError, RequestMethodError, IgnoreRequestError, \
16
+ NotConfiguredError
17
+
18
+
19
+ class MiddlewareManager:
20
+
21
+ def __init__(self, crawler):
22
+ self.crawler = crawler
23
+ self.logger = get_logger(self.__class__.__name__, crawler.settings.get('LOG_LEVEL'))
24
+ self.middlewares: List = []
25
+ self.methods: Dict[str, List[MethodType]] = defaultdict(list)
26
+ middlewares = self.crawler.settings.get_list('MIDDLEWARES')
27
+ self._add_middleware(middlewares)
28
+ self._add_method()
29
+
30
+ self.download_method: Callable = crawler.engine.downloader.download
31
+ self._stats = crawler.stats
32
+
33
+ async def _process_request(self, request: Request):
34
+ for method in self.methods['process_request']:
35
+ result = await common_call(method, request, self.crawler.spider)
36
+ if result is None:
37
+ continue
38
+ if isinstance(result, (Request, Response)):
39
+ return result
40
+ raise InvalidOutputError(
41
+ f"{method.__self__.__class__.__name__}. must return None or Request or Response, got {type(result).__name__}"
42
+ )
43
+ return await self.download_method(request)
44
+
45
+ async def _process_response(self, request: Request, response: Response):
46
+ for method in reversed(self.methods['process_response']):
47
+ try:
48
+ response = await common_call(method, request, response, self.crawler.spider)
49
+ except IgnoreRequestError as exp:
50
+ create_task(self.crawler.subscriber.notify(ignore_request, exp, request, self.crawler.spider))
51
+ if isinstance(response, Request):
52
+ return response
53
+ if isinstance(response, Response):
54
+ continue
55
+ raise InvalidOutputError(
56
+ f"{method.__self__.__class__.__name__}. must return Request or Response, got {type(response).__name__}"
57
+ )
58
+ return response
59
+
60
+ async def _process_exception(self, request: Request, exp: Exception):
61
+ for method in self.methods['process_exception']:
62
+ response = await common_call(method, request, exp, self.crawler.spider)
63
+ if response is None:
64
+ continue
65
+ if isinstance(response, (Request, Response)):
66
+ return response
67
+ if response:
68
+ break
69
+ raise InvalidOutputError(
70
+ f"{method.__self__.__class__.__name__}. must return None or Request or Response, got {type(response).__name__}"
71
+ )
72
+ else:
73
+ raise exp
74
+
75
+ async def download(self, request) -> Optional[Response]:
76
+ """ called in the download method. """
77
+ try:
78
+ response = await self._process_request(request)
79
+ except KeyError:
80
+ raise RequestMethodError(f"{request.method.lower()} is not supported")
81
+ except IgnoreRequestError as exp:
82
+ create_task(self.crawler.subscriber.notify(ignore_request, exp, request, self.crawler.spider))
83
+ response = await self._process_exception(request, exp)
84
+ except Exception as exp:
85
+ self._stats.inc_value(f'download_error/{exp.__class__.__name__}')
86
+ response = await self._process_exception(request, exp)
87
+ else:
88
+ create_task(self.crawler.subscriber.notify(response_received, response, self.crawler.spider))
89
+ # self.crawler.stats.inc_value('response_received_count')
90
+ if isinstance(response, Response):
91
+ response = await self._process_response(request, response)
92
+ if isinstance(response, Request):
93
+ await self.crawler.engine.enqueue_request(request)
94
+ return None
95
+ return response
96
+
97
+ @classmethod
98
+ def create_instance(cls, *args, **kwargs):
99
+ return cls(*args, **kwargs)
100
+
101
+ def _add_middleware(self, middlewares):
102
+ enabled_middlewares = [m for m in middlewares if self._validate_middleware(m)]
103
+ if enabled_middlewares:
104
+ # 恢复INFO级别日志,保留关键的启用信息
105
+ self.logger.info(f'enabled middleware:\n {pformat(enabled_middlewares)}')
106
+
107
+ def _validate_middleware(self, middleware):
108
+ middleware_cls = load_class(middleware)
109
+ if not hasattr(middleware_cls, 'create_instance'):
110
+ raise MiddlewareInitError(
111
+ f"Middleware init failed, must inherit from `BaseMiddleware` or have a `create_instance` method"
112
+ )
113
+ try:
114
+ instance = middleware_cls.create_instance(self.crawler)
115
+ self.middlewares.append(instance)
116
+ return True
117
+ except NotConfiguredError:
118
+ return False
119
+
120
+ def _add_method(self):
121
+ for middleware in self.middlewares:
122
+ if hasattr(middleware, 'process_request'):
123
+ if self._validate_middleware_method(method_name='process_request', middleware=middleware):
124
+ self.methods['process_request'].append(middleware.process_request)
125
+ if hasattr(middleware, 'process_response'):
126
+ if self._validate_middleware_method(method_name='process_response', middleware=middleware):
127
+ self.methods['process_response'].append(middleware.process_response)
128
+ if hasattr(middleware, 'process_exception'):
129
+ if self._validate_middleware_method(method_name='process_exception', middleware=middleware):
130
+ self.methods['process_exception'].append(middleware.process_exception)
131
+
132
+ @staticmethod
133
+ def _validate_middleware_method(method_name, middleware) -> bool:
134
+ method = getattr(type(middleware), method_name)
135
+ base_method = getattr(BaseMiddleware, method_name)
136
+ return False if method == base_method else True