crawlo 1.3.2__py3-none-any.whl → 1.3.3__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 (219) hide show
  1. crawlo/__init__.py +63 -63
  2. crawlo/__version__.py +1 -1
  3. crawlo/cli.py +75 -75
  4. crawlo/commands/__init__.py +14 -14
  5. crawlo/commands/check.py +594 -594
  6. crawlo/commands/genspider.py +151 -151
  7. crawlo/commands/help.py +138 -138
  8. crawlo/commands/list.py +155 -155
  9. crawlo/commands/run.py +322 -314
  10. crawlo/commands/startproject.py +436 -436
  11. crawlo/commands/stats.py +187 -187
  12. crawlo/commands/utils.py +196 -196
  13. crawlo/config.py +312 -312
  14. crawlo/config_validator.py +277 -277
  15. crawlo/core/__init__.py +2 -2
  16. crawlo/core/engine.py +365 -365
  17. crawlo/core/processor.py +40 -40
  18. crawlo/core/scheduler.py +256 -256
  19. crawlo/crawler.py +1166 -1168
  20. crawlo/data/__init__.py +5 -5
  21. crawlo/data/user_agents.py +194 -194
  22. crawlo/downloader/__init__.py +273 -273
  23. crawlo/downloader/aiohttp_downloader.py +226 -226
  24. crawlo/downloader/cffi_downloader.py +245 -245
  25. crawlo/downloader/httpx_downloader.py +259 -259
  26. crawlo/downloader/hybrid_downloader.py +212 -212
  27. crawlo/downloader/playwright_downloader.py +402 -402
  28. crawlo/downloader/selenium_downloader.py +472 -472
  29. crawlo/event.py +11 -11
  30. crawlo/exceptions.py +81 -81
  31. crawlo/extension/__init__.py +39 -39
  32. crawlo/extension/health_check.py +141 -141
  33. crawlo/extension/log_interval.py +57 -57
  34. crawlo/extension/log_stats.py +81 -81
  35. crawlo/extension/logging_extension.py +52 -45
  36. crawlo/extension/memory_monitor.py +104 -104
  37. crawlo/extension/performance_profiler.py +133 -133
  38. crawlo/extension/request_recorder.py +107 -107
  39. crawlo/filters/__init__.py +154 -154
  40. crawlo/filters/aioredis_filter.py +234 -234
  41. crawlo/filters/memory_filter.py +269 -269
  42. crawlo/items/__init__.py +23 -23
  43. crawlo/items/base.py +21 -21
  44. crawlo/items/fields.py +52 -52
  45. crawlo/items/items.py +104 -104
  46. crawlo/middleware/__init__.py +21 -21
  47. crawlo/middleware/default_header.py +132 -132
  48. crawlo/middleware/download_delay.py +104 -104
  49. crawlo/middleware/middleware_manager.py +135 -135
  50. crawlo/middleware/offsite.py +123 -123
  51. crawlo/middleware/proxy.py +386 -386
  52. crawlo/middleware/request_ignore.py +86 -86
  53. crawlo/middleware/response_code.py +163 -163
  54. crawlo/middleware/response_filter.py +136 -136
  55. crawlo/middleware/retry.py +124 -124
  56. crawlo/middleware/simple_proxy.py +65 -65
  57. crawlo/mode_manager.py +187 -187
  58. crawlo/network/__init__.py +21 -21
  59. crawlo/network/request.py +379 -379
  60. crawlo/network/response.py +359 -359
  61. crawlo/pipelines/__init__.py +21 -21
  62. crawlo/pipelines/bloom_dedup_pipeline.py +156 -156
  63. crawlo/pipelines/console_pipeline.py +39 -39
  64. crawlo/pipelines/csv_pipeline.py +316 -316
  65. crawlo/pipelines/database_dedup_pipeline.py +222 -222
  66. crawlo/pipelines/json_pipeline.py +218 -218
  67. crawlo/pipelines/memory_dedup_pipeline.py +115 -115
  68. crawlo/pipelines/mongo_pipeline.py +131 -131
  69. crawlo/pipelines/mysql_pipeline.py +318 -318
  70. crawlo/pipelines/pipeline_manager.py +75 -75
  71. crawlo/pipelines/redis_dedup_pipeline.py +166 -166
  72. crawlo/project.py +325 -297
  73. crawlo/queue/pqueue.py +37 -37
  74. crawlo/queue/queue_manager.py +379 -379
  75. crawlo/queue/redis_priority_queue.py +306 -306
  76. crawlo/settings/__init__.py +7 -7
  77. crawlo/settings/default_settings.py +225 -225
  78. crawlo/settings/setting_manager.py +198 -198
  79. crawlo/spider/__init__.py +639 -639
  80. crawlo/stats_collector.py +59 -59
  81. crawlo/subscriber.py +129 -129
  82. crawlo/task_manager.py +30 -30
  83. crawlo/templates/crawlo.cfg.tmpl +10 -10
  84. crawlo/templates/project/__init__.py.tmpl +3 -3
  85. crawlo/templates/project/items.py.tmpl +17 -17
  86. crawlo/templates/project/middlewares.py.tmpl +118 -118
  87. crawlo/templates/project/pipelines.py.tmpl +96 -96
  88. crawlo/templates/project/settings.py.tmpl +266 -266
  89. crawlo/templates/project/settings_distributed.py.tmpl +179 -179
  90. crawlo/templates/project/settings_gentle.py.tmpl +60 -60
  91. crawlo/templates/project/settings_high_performance.py.tmpl +130 -130
  92. crawlo/templates/project/settings_minimal.py.tmpl +34 -34
  93. crawlo/templates/project/settings_simple.py.tmpl +101 -101
  94. crawlo/templates/project/spiders/__init__.py.tmpl +5 -5
  95. crawlo/templates/run.py.tmpl +38 -38
  96. crawlo/templates/spider/spider.py.tmpl +143 -143
  97. crawlo/tools/__init__.py +200 -200
  98. crawlo/tools/anti_crawler.py +268 -268
  99. crawlo/tools/authenticated_proxy.py +240 -240
  100. crawlo/tools/data_formatter.py +225 -225
  101. crawlo/tools/data_validator.py +180 -180
  102. crawlo/tools/date_tools.py +289 -289
  103. crawlo/tools/distributed_coordinator.py +388 -388
  104. crawlo/tools/encoding_converter.py +127 -127
  105. crawlo/tools/request_tools.py +82 -82
  106. crawlo/tools/retry_mechanism.py +224 -224
  107. crawlo/tools/scenario_adapter.py +262 -262
  108. crawlo/tools/text_cleaner.py +232 -232
  109. crawlo/utils/__init__.py +34 -34
  110. crawlo/utils/batch_processor.py +259 -259
  111. crawlo/utils/controlled_spider_mixin.py +439 -439
  112. crawlo/utils/db_helper.py +343 -343
  113. crawlo/utils/enhanced_error_handler.py +356 -356
  114. crawlo/utils/env_config.py +142 -142
  115. crawlo/utils/error_handler.py +123 -123
  116. crawlo/utils/func_tools.py +82 -82
  117. crawlo/utils/large_scale_config.py +286 -286
  118. crawlo/utils/large_scale_helper.py +344 -344
  119. crawlo/utils/log.py +199 -146
  120. crawlo/utils/performance_monitor.py +285 -285
  121. crawlo/utils/queue_helper.py +175 -175
  122. crawlo/utils/redis_connection_pool.py +351 -351
  123. crawlo/utils/redis_key_validator.py +198 -198
  124. crawlo/utils/request.py +267 -267
  125. crawlo/utils/request_serializer.py +218 -218
  126. crawlo/utils/spider_loader.py +61 -61
  127. crawlo/utils/system.py +11 -11
  128. crawlo/utils/tools.py +4 -4
  129. crawlo/utils/url.py +39 -39
  130. {crawlo-1.3.2.dist-info → crawlo-1.3.3.dist-info}/METADATA +1020 -1020
  131. crawlo-1.3.3.dist-info/RECORD +219 -0
  132. examples/__init__.py +7 -7
  133. tests/DOUBLE_CRAWLO_PREFIX_FIX_REPORT.md +81 -81
  134. tests/__init__.py +7 -7
  135. tests/advanced_tools_example.py +275 -275
  136. tests/authenticated_proxy_example.py +107 -107
  137. tests/cleaners_example.py +160 -160
  138. tests/config_validation_demo.py +142 -142
  139. tests/controlled_spider_example.py +205 -205
  140. tests/date_tools_example.py +180 -180
  141. tests/debug_pipelines.py +66 -66
  142. tests/dynamic_loading_example.py +523 -523
  143. tests/dynamic_loading_test.py +104 -104
  144. tests/env_config_example.py +133 -133
  145. tests/error_handling_example.py +171 -171
  146. tests/redis_key_validation_demo.py +130 -130
  147. tests/request_params_example.py +150 -150
  148. tests/response_improvements_example.py +144 -144
  149. tests/test_advanced_tools.py +148 -148
  150. tests/test_all_redis_key_configs.py +145 -145
  151. tests/test_authenticated_proxy.py +141 -141
  152. tests/test_cleaners.py +54 -54
  153. tests/test_comprehensive.py +146 -146
  154. tests/test_config_consistency.py +80 -80
  155. tests/test_config_merge.py +152 -152
  156. tests/test_config_validator.py +182 -182
  157. tests/test_crawlo_proxy_integration.py +108 -108
  158. tests/test_date_tools.py +123 -123
  159. tests/test_default_header_middleware.py +158 -158
  160. tests/test_distributed.py +65 -65
  161. tests/test_double_crawlo_fix.py +207 -207
  162. tests/test_double_crawlo_fix_simple.py +124 -124
  163. tests/test_download_delay_middleware.py +221 -221
  164. tests/test_downloader_proxy_compatibility.py +268 -268
  165. tests/test_dynamic_downloaders_proxy.py +124 -124
  166. tests/test_dynamic_proxy.py +92 -92
  167. tests/test_dynamic_proxy_config.py +146 -146
  168. tests/test_dynamic_proxy_real.py +109 -109
  169. tests/test_edge_cases.py +303 -303
  170. tests/test_enhanced_error_handler.py +270 -270
  171. tests/test_env_config.py +121 -121
  172. tests/test_error_handler_compatibility.py +112 -112
  173. tests/test_final_validation.py +153 -153
  174. tests/test_framework_env_usage.py +103 -103
  175. tests/test_integration.py +169 -169
  176. tests/test_item_dedup_redis_key.py +122 -122
  177. tests/test_mode_consistency.py +51 -51
  178. tests/test_offsite_middleware.py +221 -221
  179. tests/test_parsel.py +29 -29
  180. tests/test_performance.py +327 -327
  181. tests/test_proxy_api.py +264 -264
  182. tests/test_proxy_health_check.py +32 -32
  183. tests/test_proxy_middleware.py +121 -121
  184. tests/test_proxy_middleware_enhanced.py +216 -216
  185. tests/test_proxy_middleware_integration.py +136 -136
  186. tests/test_proxy_middleware_refactored.py +184 -184
  187. tests/test_proxy_providers.py +56 -56
  188. tests/test_proxy_stats.py +19 -19
  189. tests/test_proxy_strategies.py +59 -59
  190. tests/test_queue_manager_double_crawlo.py +173 -173
  191. tests/test_queue_manager_redis_key.py +176 -176
  192. tests/test_random_user_agent.py +72 -72
  193. tests/test_real_scenario_proxy.py +195 -195
  194. tests/test_redis_config.py +28 -28
  195. tests/test_redis_connection_pool.py +294 -294
  196. tests/test_redis_key_naming.py +181 -181
  197. tests/test_redis_key_validator.py +123 -123
  198. tests/test_redis_queue.py +224 -224
  199. tests/test_request_ignore_middleware.py +182 -182
  200. tests/test_request_params.py +111 -111
  201. tests/test_request_serialization.py +70 -70
  202. tests/test_response_code_middleware.py +349 -349
  203. tests/test_response_filter_middleware.py +427 -427
  204. tests/test_response_improvements.py +152 -152
  205. tests/test_retry_middleware.py +241 -241
  206. tests/test_scheduler.py +252 -252
  207. tests/test_scheduler_config_update.py +133 -133
  208. tests/test_simple_response.py +61 -61
  209. tests/test_telecom_spider_redis_key.py +205 -205
  210. tests/test_template_content.py +87 -87
  211. tests/test_template_redis_key.py +134 -134
  212. tests/test_tools.py +159 -159
  213. tests/test_user_agents.py +96 -96
  214. tests/tools_example.py +260 -260
  215. tests/verify_distributed.py +117 -117
  216. crawlo-1.3.2.dist-info/RECORD +0 -219
  217. {crawlo-1.3.2.dist-info → crawlo-1.3.3.dist-info}/WHEEL +0 -0
  218. {crawlo-1.3.2.dist-info → crawlo-1.3.3.dist-info}/entry_points.txt +0 -0
  219. {crawlo-1.3.2.dist-info → crawlo-1.3.3.dist-info}/top_level.txt +0 -0
crawlo/network/request.py CHANGED
@@ -1,380 +1,380 @@
1
- #!/usr/bin/python
2
- # -*- coding: UTF-8 -*-
3
- """
4
- HTTP Request 封装模块
5
- ====================
6
- 提供功能完善的HTTP请求封装,支持:
7
- - JSON/表单数据自动处理
8
- - GET请求参数处理
9
- - 优先级排序机制
10
- - 安全的深拷贝操作
11
- - 灵活的请求配置
12
- """
13
- import json
14
- from copy import deepcopy
15
- from urllib.parse import urlencode, urlparse, urlunparse, parse_qsl
16
- from w3lib.url import safe_url_string
17
- from typing import Dict, Optional, Callable, Union, Any, TypeVar, List
18
-
19
- from crawlo.utils.url import escape_ajax
20
-
21
-
22
- _Request = TypeVar("_Request", bound="Request")
23
-
24
-
25
- class RequestPriority:
26
- """请求优先级常量和工具类"""
27
- URGENT = -200 # 紧急任务
28
- HIGH = -100 # 高优先级
29
- NORMAL = 0 # 正常优先级(默认)
30
- LOW = 100 # 低优先级
31
- BACKGROUND = 200 # 后台任务
32
-
33
- @classmethod
34
- def get_all_priorities(cls) -> Dict[str, int]:
35
- """获取所有优先级常量"""
36
- return {
37
- 'URGENT': cls.URGENT,
38
- 'HIGH': cls.HIGH,
39
- 'NORMAL': cls.NORMAL,
40
- 'LOW': cls.LOW,
41
- 'BACKGROUND': cls.BACKGROUND
42
- }
43
-
44
- @classmethod
45
- def from_string(cls, priority_str: str) -> int:
46
- """从字符串获取优先级值"""
47
- priorities = cls.get_all_priorities()
48
- if priority_str.upper() not in priorities:
49
- raise ValueError(f"不支持的优先级: {priority_str}, 支持: {list(priorities.keys())}")
50
- return priorities[priority_str.upper()]
51
-
52
-
53
- class Request:
54
- """
55
- 封装一个 HTTP 请求对象,用于爬虫框架中表示一个待抓取的请求任务。
56
- 支持 JSON、表单、GET参数、原始 body 提交,自动处理 Content-Type 与编码。
57
- 不支持文件上传(multipart/form-data),保持轻量。
58
- """
59
-
60
- __slots__ = (
61
- '_url',
62
- '_meta',
63
- 'callback',
64
- 'cb_kwargs',
65
- 'err_back',
66
- 'headers',
67
- 'body',
68
- 'method',
69
- 'cookies',
70
- 'priority',
71
- 'encoding',
72
- 'dont_filter',
73
- 'timeout',
74
- 'proxy',
75
- 'allow_redirects',
76
- 'auth',
77
- 'verify',
78
- 'flags',
79
- '_json_body',
80
- '_form_data',
81
- '_params',
82
- 'use_dynamic_loader',
83
- 'dynamic_loader_options'
84
- )
85
-
86
- def __init__(
87
- self,
88
- url: str,
89
- callback: Optional[Callable] = None,
90
- method: Optional[str] = 'GET',
91
- headers: Optional[Dict[str, str]] = None,
92
- body: Optional[Union[bytes, str, Dict[Any, Any]]] = None,
93
- form_data: Optional[Dict[str, Any]] = None,
94
- json_body: Optional[Dict[str, Any]] = None,
95
- params: Optional[Dict[str, Any]] = None,
96
- cb_kwargs: Optional[Dict[str, Any]] = None,
97
- cookies: Optional[Dict[str, str]] = None,
98
- meta: Optional[Dict[str, Any]] = None,
99
- priority: int = RequestPriority.NORMAL,
100
- dont_filter: bool = False,
101
- timeout: Optional[float] = None,
102
- proxy: Optional[str] = None,
103
- allow_redirects: bool = True,
104
- auth: Optional[tuple] = None,
105
- verify: bool = True,
106
- flags: Optional[List[str]] = None,
107
- encoding: str = 'utf-8',
108
- # 动态加载相关参数
109
- use_dynamic_loader: bool = False,
110
- dynamic_loader_options: Optional[Dict[str, Any]] = None
111
- ):
112
- """
113
- 初始化请求对象。
114
-
115
- :param url: 请求 URL(必须)
116
- :param callback: 成功回调函数
117
- :param method: HTTP 方法,默认 GET
118
- :param headers: 请求头
119
- :param body: 原始请求体(bytes/str),若为 dict 且未使用 json_body/form_data,则自动转为 JSON
120
- :param form_data: 表单数据,POST请求时自动转为 application/x-www-form-urlencoded
121
- :param json_body: JSON 数据,自动序列化并设置 Content-Type
122
- :param params: GET请求参数,会自动附加到URL上
123
- :param cb_kwargs: 传递给 callback 的额外参数
124
- :param cookies: Cookies 字典
125
- :param meta: 元数据(跨中间件传递数据)
126
- :param priority: 优先级(数值越小越优先)
127
- :param dont_filter: 是否跳过去重
128
- :param timeout: 超时时间(秒)
129
- :param proxy: 代理地址,如 http://127.0.0.1:8080
130
- :param allow_redirects: 是否允许重定向
131
- :param auth: 认证元组 (username, password)
132
- :param verify: 是否验证 SSL 证书
133
- :param flags: 标记(用于调试或分类)
134
- :param encoding: 字符编码,默认 utf-8
135
- """
136
- self.callback = callback
137
- self.method = str(method).upper()
138
- self.headers = headers or {}
139
- self.cookies = cookies or {}
140
- self.priority = -priority # 用于排序:值越小优先级越高
141
-
142
- # 安全处理 meta,移除 logger 后再 deepcopy
143
- self._meta = self._safe_deepcopy_meta(meta) if meta is not None else {}
144
-
145
- self.timeout = self._meta.get('download_timeout', timeout)
146
- self.proxy = proxy
147
- self.allow_redirects = allow_redirects
148
- self.auth = auth
149
- self.verify = verify
150
- self.flags = flags or []
151
- self.encoding = encoding
152
- self.cb_kwargs = cb_kwargs or {}
153
- self.body = body
154
- # 保存高层语义参数(用于 copy)
155
- self._json_body = json_body
156
- self._form_data = form_data
157
- self._params = params
158
-
159
- # 动态加载相关属性
160
- self.use_dynamic_loader = use_dynamic_loader
161
- self.dynamic_loader_options = dynamic_loader_options or {}
162
-
163
- # 处理GET参数
164
- if params is not None and self.method == 'GET':
165
- # 将GET参数附加到URL上
166
- self._url = self._add_params_to_url(url, params)
167
- else:
168
- self._url = url
169
-
170
- # 构建 body
171
- if json_body is not None:
172
- if 'Content-Type' not in self.headers:
173
- self.headers['Content-Type'] = 'application/json'
174
- self.body = json.dumps(json_body, ensure_ascii=False).encode(encoding)
175
- if self.method == 'GET':
176
- self.method = 'POST'
177
-
178
- elif form_data is not None:
179
- if self.method == 'GET':
180
- # 对于GET请求,将form_data作为GET参数处理
181
- self._url = self._add_params_to_url(self._url, form_data)
182
- else:
183
- # 对于POST等请求,将form_data作为请求体处理
184
- if 'Content-Type' not in self.headers:
185
- self.headers['Content-Type'] = 'application/x-www-form-urlencoded'
186
- query_str = urlencode(form_data)
187
- self.body = query_str.encode(encoding) # 显式编码为 bytes
188
-
189
-
190
- else:
191
- # 处理原始 body
192
- if isinstance(self.body, dict):
193
- if 'Content-Type' not in self.headers:
194
- self.headers['Content-Type'] = 'application/json'
195
- self.body = json.dumps(self.body, ensure_ascii=False).encode(encoding)
196
- elif isinstance(self.body, str):
197
- self.body = self.body.encode(encoding)
198
-
199
- self.dont_filter = dont_filter
200
- self._set_url(self._url)
201
-
202
- @staticmethod
203
- def _add_params_to_url(url: str, params: Dict[str, Any]) -> str:
204
- """将参数添加到URL中"""
205
- if not params:
206
- return url
207
-
208
- # 解析URL
209
- parsed = urlparse(url)
210
- # 解析现有查询参数
211
- query_params = parse_qsl(parsed.query, keep_blank_values=True)
212
- # 添加新参数
213
- for key, value in params.items():
214
- query_params.append((str(key), str(value)))
215
- # 重新构建查询字符串
216
- new_query = urlencode(query_params)
217
- # 构建新的URL
218
- return urlunparse((
219
- parsed.scheme,
220
- parsed.netloc,
221
- parsed.path,
222
- parsed.params,
223
- new_query,
224
- parsed.fragment
225
- ))
226
-
227
- @staticmethod
228
- def _safe_deepcopy_meta(meta: Dict[str, Any]) -> Dict[str, Any]:
229
- """安全地 deepcopy meta,移除 logger 后再复制"""
230
- import logging
231
-
232
- def clean_logger_recursive(obj):
233
- """递归移除 logger 对象"""
234
- if isinstance(obj, logging.Logger):
235
- return None
236
- elif isinstance(obj, dict):
237
- cleaned = {}
238
- for k, v in obj.items():
239
- if not (k == 'logger' or isinstance(v, logging.Logger)):
240
- cleaned[k] = clean_logger_recursive(v)
241
- return cleaned
242
- elif isinstance(obj, (list, tuple)):
243
- cleaned_list = []
244
- for item in obj:
245
- cleaned_item = clean_logger_recursive(item)
246
- if cleaned_item is not None:
247
- cleaned_list.append(cleaned_item)
248
- return type(obj)(cleaned_list)
249
- else:
250
- return obj
251
-
252
- # 先清理 logger,再 deepcopy
253
- cleaned_meta = clean_logger_recursive(meta)
254
- return deepcopy(cleaned_meta)
255
-
256
- def copy(self: _Request) -> _Request:
257
- """
258
- 创建当前请求的副本,保留所有高层语义(json_body/form_data/params)。
259
- """
260
- return type(self)(
261
- url=self.url,
262
- callback=self.callback,
263
- method=self.method,
264
- headers=self.headers.copy(),
265
- body=None, # 由 form_data/json_body/params 重新生成
266
- form_data=self._form_data,
267
- json_body=self._json_body,
268
- params=self._params,
269
- cb_kwargs=deepcopy(self.cb_kwargs),
270
- err_back=self.err_back,
271
- cookies=self.cookies.copy(),
272
- meta=deepcopy(self._meta),
273
- priority=-self.priority,
274
- dont_filter=self.dont_filter,
275
- timeout=self.timeout,
276
- proxy=self.proxy,
277
- allow_redirects=self.allow_redirects,
278
- auth=self.auth,
279
- verify=self.verify,
280
- flags=self.flags.copy(),
281
- encoding=self.encoding,
282
- use_dynamic_loader=self.use_dynamic_loader,
283
- dynamic_loader_options=deepcopy(self.dynamic_loader_options)
284
- )
285
-
286
- def set_meta(self, key: str, value: Any) -> 'Request':
287
- """设置 meta 中的某个键值,支持链式调用。"""
288
- self._meta[key] = value
289
- return self
290
-
291
- def add_header(self, key: str, value: str) -> 'Request':
292
- """添加请求头,支持链式调用。"""
293
- self.headers[key] = value
294
- return self
295
-
296
- def add_headers(self, headers: Dict[str, str]) -> 'Request':
297
- """批量添加请求头,支持链式调用。"""
298
- self.headers.update(headers)
299
- return self
300
-
301
- def set_proxy(self, proxy: str) -> 'Request':
302
- """设置代理,支持链式调用。"""
303
- self.proxy = proxy
304
- return self
305
-
306
- def set_timeout(self, timeout: float) -> 'Request':
307
- """设置超时时间,支持链式调用。"""
308
- self.timeout = timeout
309
- return self
310
-
311
- def add_flag(self, flag: str) -> 'Request':
312
- """添加标记,支持链式调用。"""
313
- if flag not in self.flags:
314
- self.flags.append(flag)
315
- return self
316
-
317
- def remove_flag(self, flag: str) -> 'Request':
318
- """移除标记,支持链式调用。"""
319
- if flag in self.flags:
320
- self.flags.remove(flag)
321
- return self
322
-
323
- def set_dynamic_loader(self, use_dynamic: bool = True, options: Optional[Dict[str, Any]] = None) -> 'Request':
324
- """设置使用动态加载器,支持链式调用。"""
325
- self.use_dynamic_loader = use_dynamic
326
- if options:
327
- self.dynamic_loader_options = options
328
- # 同时在meta中设置标记,供混合下载器使用
329
- self._meta['use_dynamic_loader'] = use_dynamic
330
- return self
331
-
332
- def set_protocol_loader(self) -> 'Request':
333
- """强制使用协议加载器,支持链式调用。"""
334
- self.use_dynamic_loader = False
335
- self._meta['use_dynamic_loader'] = False
336
- self._meta['use_protocol_loader'] = True
337
- return self
338
-
339
- def _set_url(self, url: str) -> None:
340
- """安全设置 URL,确保格式正确。"""
341
- if not isinstance(url, str):
342
- raise TypeError(f"Request url 必须为字符串,当前类型: {type(url).__name__}")
343
-
344
- if not url.strip():
345
- raise ValueError("URL 不能为空")
346
-
347
- # 检查危险的 URL scheme
348
- dangerous_schemes = ['file://', 'ftp://', 'javascript:', 'data:']
349
- if any(url.lower().startswith(scheme) for scheme in dangerous_schemes):
350
- raise ValueError(f"URL scheme 不安全: {url[:20]}...")
351
-
352
- s = safe_url_string(url, self.encoding)
353
- escaped_url = escape_ajax(s)
354
-
355
- if not escaped_url.startswith(('http://', 'https://')):
356
- raise ValueError(f"URL 缺少 HTTP(S) scheme: {escaped_url[:50]}...")
357
-
358
- # 检查 URL 长度
359
- if len(escaped_url) > 8192: # 大多数服务器支持的最大 URL 长度
360
- raise ValueError(f"URL 过长 (超过 8192 字符): {len(escaped_url)} 字符")
361
-
362
- self._url = escaped_url
363
-
364
- @property
365
- def url(self) -> str:
366
- return self._url
367
-
368
- @property
369
- def meta(self) -> Dict[str, Any]:
370
- return self._meta
371
-
372
- def __str__(self) -> str:
373
- return f'<Request url={self.url} method={self.method}>'
374
-
375
- def __repr__(self) -> str:
376
- return str(self)
377
-
378
- def __lt__(self, other: _Request) -> bool:
379
- """用于按优先级排序"""
1
+ #!/usr/bin/python
2
+ # -*- coding: UTF-8 -*-
3
+ """
4
+ HTTP Request 封装模块
5
+ ====================
6
+ 提供功能完善的HTTP请求封装,支持:
7
+ - JSON/表单数据自动处理
8
+ - GET请求参数处理
9
+ - 优先级排序机制
10
+ - 安全的深拷贝操作
11
+ - 灵活的请求配置
12
+ """
13
+ import json
14
+ from copy import deepcopy
15
+ from urllib.parse import urlencode, urlparse, urlunparse, parse_qsl
16
+ from w3lib.url import safe_url_string
17
+ from typing import Dict, Optional, Callable, Union, Any, TypeVar, List
18
+
19
+ from crawlo.utils.url import escape_ajax
20
+
21
+
22
+ _Request = TypeVar("_Request", bound="Request")
23
+
24
+
25
+ class RequestPriority:
26
+ """请求优先级常量和工具类"""
27
+ URGENT = -200 # 紧急任务
28
+ HIGH = -100 # 高优先级
29
+ NORMAL = 0 # 正常优先级(默认)
30
+ LOW = 100 # 低优先级
31
+ BACKGROUND = 200 # 后台任务
32
+
33
+ @classmethod
34
+ def get_all_priorities(cls) -> Dict[str, int]:
35
+ """获取所有优先级常量"""
36
+ return {
37
+ 'URGENT': cls.URGENT,
38
+ 'HIGH': cls.HIGH,
39
+ 'NORMAL': cls.NORMAL,
40
+ 'LOW': cls.LOW,
41
+ 'BACKGROUND': cls.BACKGROUND
42
+ }
43
+
44
+ @classmethod
45
+ def from_string(cls, priority_str: str) -> int:
46
+ """从字符串获取优先级值"""
47
+ priorities = cls.get_all_priorities()
48
+ if priority_str.upper() not in priorities:
49
+ raise ValueError(f"不支持的优先级: {priority_str}, 支持: {list(priorities.keys())}")
50
+ return priorities[priority_str.upper()]
51
+
52
+
53
+ class Request:
54
+ """
55
+ 封装一个 HTTP 请求对象,用于爬虫框架中表示一个待抓取的请求任务。
56
+ 支持 JSON、表单、GET参数、原始 body 提交,自动处理 Content-Type 与编码。
57
+ 不支持文件上传(multipart/form-data),保持轻量。
58
+ """
59
+
60
+ __slots__ = (
61
+ '_url',
62
+ '_meta',
63
+ 'callback',
64
+ 'cb_kwargs',
65
+ 'err_back',
66
+ 'headers',
67
+ 'body',
68
+ 'method',
69
+ 'cookies',
70
+ 'priority',
71
+ 'encoding',
72
+ 'dont_filter',
73
+ 'timeout',
74
+ 'proxy',
75
+ 'allow_redirects',
76
+ 'auth',
77
+ 'verify',
78
+ 'flags',
79
+ '_json_body',
80
+ '_form_data',
81
+ '_params',
82
+ 'use_dynamic_loader',
83
+ 'dynamic_loader_options'
84
+ )
85
+
86
+ def __init__(
87
+ self,
88
+ url: str,
89
+ callback: Optional[Callable] = None,
90
+ method: Optional[str] = 'GET',
91
+ headers: Optional[Dict[str, str]] = None,
92
+ body: Optional[Union[bytes, str, Dict[Any, Any]]] = None,
93
+ form_data: Optional[Dict[str, Any]] = None,
94
+ json_body: Optional[Dict[str, Any]] = None,
95
+ params: Optional[Dict[str, Any]] = None,
96
+ cb_kwargs: Optional[Dict[str, Any]] = None,
97
+ cookies: Optional[Dict[str, str]] = None,
98
+ meta: Optional[Dict[str, Any]] = None,
99
+ priority: int = RequestPriority.NORMAL,
100
+ dont_filter: bool = False,
101
+ timeout: Optional[float] = None,
102
+ proxy: Optional[str] = None,
103
+ allow_redirects: bool = True,
104
+ auth: Optional[tuple] = None,
105
+ verify: bool = True,
106
+ flags: Optional[List[str]] = None,
107
+ encoding: str = 'utf-8',
108
+ # 动态加载相关参数
109
+ use_dynamic_loader: bool = False,
110
+ dynamic_loader_options: Optional[Dict[str, Any]] = None
111
+ ):
112
+ """
113
+ 初始化请求对象。
114
+
115
+ :param url: 请求 URL(必须)
116
+ :param callback: 成功回调函数
117
+ :param method: HTTP 方法,默认 GET
118
+ :param headers: 请求头
119
+ :param body: 原始请求体(bytes/str),若为 dict 且未使用 json_body/form_data,则自动转为 JSON
120
+ :param form_data: 表单数据,POST请求时自动转为 application/x-www-form-urlencoded
121
+ :param json_body: JSON 数据,自动序列化并设置 Content-Type
122
+ :param params: GET请求参数,会自动附加到URL上
123
+ :param cb_kwargs: 传递给 callback 的额外参数
124
+ :param cookies: Cookies 字典
125
+ :param meta: 元数据(跨中间件传递数据)
126
+ :param priority: 优先级(数值越小越优先)
127
+ :param dont_filter: 是否跳过去重
128
+ :param timeout: 超时时间(秒)
129
+ :param proxy: 代理地址,如 http://127.0.0.1:8080
130
+ :param allow_redirects: 是否允许重定向
131
+ :param auth: 认证元组 (username, password)
132
+ :param verify: 是否验证 SSL 证书
133
+ :param flags: 标记(用于调试或分类)
134
+ :param encoding: 字符编码,默认 utf-8
135
+ """
136
+ self.callback = callback
137
+ self.method = str(method).upper()
138
+ self.headers = headers or {}
139
+ self.cookies = cookies or {}
140
+ self.priority = -priority # 用于排序:值越小优先级越高
141
+
142
+ # 安全处理 meta,移除 logger 后再 deepcopy
143
+ self._meta = self._safe_deepcopy_meta(meta) if meta is not None else {}
144
+
145
+ self.timeout = self._meta.get('download_timeout', timeout)
146
+ self.proxy = proxy
147
+ self.allow_redirects = allow_redirects
148
+ self.auth = auth
149
+ self.verify = verify
150
+ self.flags = flags or []
151
+ self.encoding = encoding
152
+ self.cb_kwargs = cb_kwargs or {}
153
+ self.body = body
154
+ # 保存高层语义参数(用于 copy)
155
+ self._json_body = json_body
156
+ self._form_data = form_data
157
+ self._params = params
158
+
159
+ # 动态加载相关属性
160
+ self.use_dynamic_loader = use_dynamic_loader
161
+ self.dynamic_loader_options = dynamic_loader_options or {}
162
+
163
+ # 处理GET参数
164
+ if params is not None and self.method == 'GET':
165
+ # 将GET参数附加到URL上
166
+ self._url = self._add_params_to_url(url, params)
167
+ else:
168
+ self._url = url
169
+
170
+ # 构建 body
171
+ if json_body is not None:
172
+ if 'Content-Type' not in self.headers:
173
+ self.headers['Content-Type'] = 'application/json'
174
+ self.body = json.dumps(json_body, ensure_ascii=False).encode(encoding)
175
+ if self.method == 'GET':
176
+ self.method = 'POST'
177
+
178
+ elif form_data is not None:
179
+ if self.method == 'GET':
180
+ # 对于GET请求,将form_data作为GET参数处理
181
+ self._url = self._add_params_to_url(self._url, form_data)
182
+ else:
183
+ # 对于POST等请求,将form_data作为请求体处理
184
+ if 'Content-Type' not in self.headers:
185
+ self.headers['Content-Type'] = 'application/x-www-form-urlencoded'
186
+ query_str = urlencode(form_data)
187
+ self.body = query_str.encode(encoding) # 显式编码为 bytes
188
+
189
+
190
+ else:
191
+ # 处理原始 body
192
+ if isinstance(self.body, dict):
193
+ if 'Content-Type' not in self.headers:
194
+ self.headers['Content-Type'] = 'application/json'
195
+ self.body = json.dumps(self.body, ensure_ascii=False).encode(encoding)
196
+ elif isinstance(self.body, str):
197
+ self.body = self.body.encode(encoding)
198
+
199
+ self.dont_filter = dont_filter
200
+ self._set_url(self._url)
201
+
202
+ @staticmethod
203
+ def _add_params_to_url(url: str, params: Dict[str, Any]) -> str:
204
+ """将参数添加到URL中"""
205
+ if not params:
206
+ return url
207
+
208
+ # 解析URL
209
+ parsed = urlparse(url)
210
+ # 解析现有查询参数
211
+ query_params = parse_qsl(parsed.query, keep_blank_values=True)
212
+ # 添加新参数
213
+ for key, value in params.items():
214
+ query_params.append((str(key), str(value)))
215
+ # 重新构建查询字符串
216
+ new_query = urlencode(query_params)
217
+ # 构建新的URL
218
+ return urlunparse((
219
+ parsed.scheme,
220
+ parsed.netloc,
221
+ parsed.path,
222
+ parsed.params,
223
+ new_query,
224
+ parsed.fragment
225
+ ))
226
+
227
+ @staticmethod
228
+ def _safe_deepcopy_meta(meta: Dict[str, Any]) -> Dict[str, Any]:
229
+ """安全地 deepcopy meta,移除 logger 后再复制"""
230
+ import logging
231
+
232
+ def clean_logger_recursive(obj):
233
+ """递归移除 logger 对象"""
234
+ if isinstance(obj, logging.Logger):
235
+ return None
236
+ elif isinstance(obj, dict):
237
+ cleaned = {}
238
+ for k, v in obj.items():
239
+ if not (k == 'logger' or isinstance(v, logging.Logger)):
240
+ cleaned[k] = clean_logger_recursive(v)
241
+ return cleaned
242
+ elif isinstance(obj, (list, tuple)):
243
+ cleaned_list = []
244
+ for item in obj:
245
+ cleaned_item = clean_logger_recursive(item)
246
+ if cleaned_item is not None:
247
+ cleaned_list.append(cleaned_item)
248
+ return type(obj)(cleaned_list)
249
+ else:
250
+ return obj
251
+
252
+ # 先清理 logger,再 deepcopy
253
+ cleaned_meta = clean_logger_recursive(meta)
254
+ return deepcopy(cleaned_meta)
255
+
256
+ def copy(self: _Request) -> _Request:
257
+ """
258
+ 创建当前请求的副本,保留所有高层语义(json_body/form_data/params)。
259
+ """
260
+ return type(self)(
261
+ url=self.url,
262
+ callback=self.callback,
263
+ method=self.method,
264
+ headers=self.headers.copy(),
265
+ body=None, # 由 form_data/json_body/params 重新生成
266
+ form_data=self._form_data,
267
+ json_body=self._json_body,
268
+ params=self._params,
269
+ cb_kwargs=deepcopy(self.cb_kwargs),
270
+ err_back=self.err_back,
271
+ cookies=self.cookies.copy(),
272
+ meta=deepcopy(self._meta),
273
+ priority=-self.priority,
274
+ dont_filter=self.dont_filter,
275
+ timeout=self.timeout,
276
+ proxy=self.proxy,
277
+ allow_redirects=self.allow_redirects,
278
+ auth=self.auth,
279
+ verify=self.verify,
280
+ flags=self.flags.copy(),
281
+ encoding=self.encoding,
282
+ use_dynamic_loader=self.use_dynamic_loader,
283
+ dynamic_loader_options=deepcopy(self.dynamic_loader_options)
284
+ )
285
+
286
+ def set_meta(self, key: str, value: Any) -> 'Request':
287
+ """设置 meta 中的某个键值,支持链式调用。"""
288
+ self._meta[key] = value
289
+ return self
290
+
291
+ def add_header(self, key: str, value: str) -> 'Request':
292
+ """添加请求头,支持链式调用。"""
293
+ self.headers[key] = value
294
+ return self
295
+
296
+ def add_headers(self, headers: Dict[str, str]) -> 'Request':
297
+ """批量添加请求头,支持链式调用。"""
298
+ self.headers.update(headers)
299
+ return self
300
+
301
+ def set_proxy(self, proxy: str) -> 'Request':
302
+ """设置代理,支持链式调用。"""
303
+ self.proxy = proxy
304
+ return self
305
+
306
+ def set_timeout(self, timeout: float) -> 'Request':
307
+ """设置超时时间,支持链式调用。"""
308
+ self.timeout = timeout
309
+ return self
310
+
311
+ def add_flag(self, flag: str) -> 'Request':
312
+ """添加标记,支持链式调用。"""
313
+ if flag not in self.flags:
314
+ self.flags.append(flag)
315
+ return self
316
+
317
+ def remove_flag(self, flag: str) -> 'Request':
318
+ """移除标记,支持链式调用。"""
319
+ if flag in self.flags:
320
+ self.flags.remove(flag)
321
+ return self
322
+
323
+ def set_dynamic_loader(self, use_dynamic: bool = True, options: Optional[Dict[str, Any]] = None) -> 'Request':
324
+ """设置使用动态加载器,支持链式调用。"""
325
+ self.use_dynamic_loader = use_dynamic
326
+ if options:
327
+ self.dynamic_loader_options = options
328
+ # 同时在meta中设置标记,供混合下载器使用
329
+ self._meta['use_dynamic_loader'] = use_dynamic
330
+ return self
331
+
332
+ def set_protocol_loader(self) -> 'Request':
333
+ """强制使用协议加载器,支持链式调用。"""
334
+ self.use_dynamic_loader = False
335
+ self._meta['use_dynamic_loader'] = False
336
+ self._meta['use_protocol_loader'] = True
337
+ return self
338
+
339
+ def _set_url(self, url: str) -> None:
340
+ """安全设置 URL,确保格式正确。"""
341
+ if not isinstance(url, str):
342
+ raise TypeError(f"Request url 必须为字符串,当前类型: {type(url).__name__}")
343
+
344
+ if not url.strip():
345
+ raise ValueError("URL 不能为空")
346
+
347
+ # 检查危险的 URL scheme
348
+ dangerous_schemes = ['file://', 'ftp://', 'javascript:', 'data:']
349
+ if any(url.lower().startswith(scheme) for scheme in dangerous_schemes):
350
+ raise ValueError(f"URL scheme 不安全: {url[:20]}...")
351
+
352
+ s = safe_url_string(url, self.encoding)
353
+ escaped_url = escape_ajax(s)
354
+
355
+ if not escaped_url.startswith(('http://', 'https://')):
356
+ raise ValueError(f"URL 缺少 HTTP(S) scheme: {escaped_url[:50]}...")
357
+
358
+ # 检查 URL 长度
359
+ if len(escaped_url) > 8192: # 大多数服务器支持的最大 URL 长度
360
+ raise ValueError(f"URL 过长 (超过 8192 字符): {len(escaped_url)} 字符")
361
+
362
+ self._url = escaped_url
363
+
364
+ @property
365
+ def url(self) -> str:
366
+ return self._url
367
+
368
+ @property
369
+ def meta(self) -> Dict[str, Any]:
370
+ return self._meta
371
+
372
+ def __str__(self) -> str:
373
+ return f'<Request url={self.url} method={self.method}>'
374
+
375
+ def __repr__(self) -> str:
376
+ return str(self)
377
+
378
+ def __lt__(self, other: _Request) -> bool:
379
+ """用于按优先级排序"""
380
380
  return self.priority < other.priority