crawlo 1.2.3__py3-none-any.whl → 1.2.5__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 (222) 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 +88 -81
  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 +144 -142
  12. crawlo/commands/list.py +155 -155
  13. crawlo/commands/run.py +323 -292
  14. crawlo/commands/startproject.py +436 -417
  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 +354 -354
  21. crawlo/core/processor.py +40 -40
  22. crawlo/core/scheduler.py +143 -143
  23. crawlo/crawler.py +1110 -1027
  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 +220 -220
  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 +37 -37
  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 +280 -280
  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 +135 -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 +61 -61
  74. crawlo/pipelines/redis_dedup_pipeline.py +165 -165
  75. crawlo/project.py +279 -187
  76. crawlo/queue/pqueue.py +37 -37
  77. crawlo/queue/queue_manager.py +337 -337
  78. crawlo/queue/redis_priority_queue.py +298 -298
  79. crawlo/settings/__init__.py +7 -7
  80. crawlo/settings/default_settings.py +217 -226
  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 +324 -325
  92. crawlo/templates/project/settings_distributed.py.tmpl +154 -121
  93. crawlo/templates/project/settings_gentle.py.tmpl +127 -94
  94. crawlo/templates/project/settings_high_performance.py.tmpl +149 -151
  95. crawlo/templates/project/settings_simple.py.tmpl +102 -68
  96. crawlo/templates/project/spiders/__init__.py.tmpl +5 -5
  97. crawlo/templates/{project/run.py.tmpl → run.py.tmpl} +47 -45
  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 +105 -105
  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 +334 -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.3.dist-info → crawlo-1.2.5.dist-info}/METADATA +764 -692
  130. crawlo-1.2.5.dist-info/RECORD +206 -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_validator.py +193 -193
  152. tests/test_crawlo_proxy_integration.py +172 -172
  153. tests/test_date_tools.py +123 -123
  154. tests/test_default_header_middleware.py +158 -158
  155. tests/test_double_crawlo_fix.py +207 -207
  156. tests/test_double_crawlo_fix_simple.py +124 -124
  157. tests/test_download_delay_middleware.py +221 -221
  158. tests/test_downloader_proxy_compatibility.py +268 -268
  159. tests/test_dynamic_downloaders_proxy.py +124 -124
  160. tests/test_dynamic_proxy.py +92 -92
  161. tests/test_dynamic_proxy_config.py +146 -146
  162. tests/test_dynamic_proxy_real.py +109 -109
  163. tests/test_edge_cases.py +303 -303
  164. tests/test_enhanced_error_handler.py +270 -270
  165. tests/test_env_config.py +121 -121
  166. tests/test_error_handler_compatibility.py +112 -112
  167. tests/test_final_validation.py +153 -153
  168. tests/test_framework_env_usage.py +103 -103
  169. tests/test_integration.py +356 -356
  170. tests/test_item_dedup_redis_key.py +122 -122
  171. tests/test_offsite_middleware.py +221 -221
  172. tests/test_parsel.py +29 -29
  173. tests/test_performance.py +327 -327
  174. tests/test_proxy_api.py +264 -264
  175. tests/test_proxy_health_check.py +32 -32
  176. tests/test_proxy_middleware.py +121 -121
  177. tests/test_proxy_middleware_enhanced.py +216 -216
  178. tests/test_proxy_middleware_integration.py +136 -136
  179. tests/test_proxy_providers.py +56 -56
  180. tests/test_proxy_stats.py +19 -19
  181. tests/test_proxy_strategies.py +59 -59
  182. tests/test_queue_manager_double_crawlo.py +173 -173
  183. tests/test_queue_manager_redis_key.py +176 -176
  184. tests/test_real_scenario_proxy.py +195 -195
  185. tests/test_redis_config.py +28 -28
  186. tests/test_redis_connection_pool.py +294 -294
  187. tests/test_redis_key_naming.py +181 -181
  188. tests/test_redis_key_validator.py +123 -123
  189. tests/test_redis_queue.py +224 -224
  190. tests/test_request_ignore_middleware.py +182 -182
  191. tests/test_request_serialization.py +70 -70
  192. tests/test_response_code_middleware.py +349 -349
  193. tests/test_response_filter_middleware.py +427 -427
  194. tests/test_response_improvements.py +152 -152
  195. tests/test_retry_middleware.py +241 -241
  196. tests/test_scheduler.py +241 -241
  197. tests/test_simple_response.py +61 -61
  198. tests/test_telecom_spider_redis_key.py +205 -205
  199. tests/test_template_content.py +87 -87
  200. tests/test_template_redis_key.py +134 -134
  201. tests/test_tools.py +153 -153
  202. tests/tools_example.py +257 -257
  203. crawlo-1.2.3.dist-info/RECORD +0 -222
  204. examples/aiohttp_settings.py +0 -42
  205. examples/curl_cffi_settings.py +0 -41
  206. examples/default_header_middleware_example.py +0 -107
  207. examples/default_header_spider_example.py +0 -129
  208. examples/download_delay_middleware_example.py +0 -160
  209. examples/httpx_settings.py +0 -42
  210. examples/multi_downloader_proxy_example.py +0 -81
  211. examples/offsite_middleware_example.py +0 -55
  212. examples/offsite_spider_example.py +0 -107
  213. examples/proxy_spider_example.py +0 -166
  214. examples/request_ignore_middleware_example.py +0 -51
  215. examples/request_ignore_spider_example.py +0 -99
  216. examples/response_code_middleware_example.py +0 -52
  217. examples/response_filter_middleware_example.py +0 -67
  218. examples/tong_hua_shun_settings.py +0 -62
  219. examples/tong_hua_shun_spider.py +0 -170
  220. {crawlo-1.2.3.dist-info → crawlo-1.2.5.dist-info}/WHEEL +0 -0
  221. {crawlo-1.2.3.dist-info → crawlo-1.2.5.dist-info}/entry_points.txt +0 -0
  222. {crawlo-1.2.3.dist-info → crawlo-1.2.5.dist-info}/top_level.txt +0 -0
@@ -1,61 +1,61 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- from typing import List
4
- from pprint import pformat
5
- from asyncio import create_task
6
-
7
-
8
- from crawlo.utils.log import get_logger
9
- from crawlo.event import item_successful, item_discard
10
- from crawlo.project import load_class, common_call
11
- from crawlo.exceptions import PipelineInitError, ItemDiscard, InvalidOutputError
12
-
13
-
14
- class PipelineManager:
15
-
16
- def __init__(self, crawler):
17
- self.crawler = crawler
18
- self.pipelines: List = []
19
- self.methods: List = []
20
-
21
- self.logger = get_logger(self.__class__.__name__, self.crawler.settings.get('LOG_LEVEL'))
22
- pipelines = self.crawler.settings.get_list('PIPELINES')
23
- self._add_pipelines(pipelines)
24
- self._add_methods()
25
-
26
- @classmethod
27
- def from_crawler(cls, *args, **kwargs):
28
- o = cls(*args, **kwargs)
29
- return o
30
-
31
- def _add_pipelines(self, pipelines):
32
- for pipeline in pipelines:
33
- try:
34
- pipeline_cls = load_class(pipeline)
35
- if not hasattr(pipeline_cls, 'from_crawler'):
36
- raise PipelineInitError(
37
- f"Pipeline init failed, must inherit from `BasePipeline` or have a `create_instance` method"
38
- )
39
- self.pipelines.append(pipeline_cls.from_crawler(self.crawler))
40
- except Exception as e:
41
- self.logger.error(f"Failed to load pipeline {pipeline}: {e}")
42
- # 可以选择继续加载其他管道或抛出异常
43
- raise
44
- if pipelines:
45
- self.logger.info(f"enabled pipelines: \n {pformat(pipelines)}")
46
-
47
- def _add_methods(self):
48
- for pipeline in self.pipelines:
49
- if hasattr(pipeline, 'process_item'):
50
- self.methods.append(pipeline.process_item)
51
-
52
- async def process_item(self, item):
53
- try:
54
- for method in self.methods:
55
- item = await common_call(method, item, self.crawler.spider)
56
- if item is None:
57
- raise InvalidOutputError(f"{method.__qualname__} return None is not supported.")
58
- except ItemDiscard as exc:
59
- create_task(self.crawler.subscriber.notify(item_discard, item, exc, self.crawler.spider))
60
- else:
61
- create_task(self.crawler.subscriber.notify(item_successful, item, self.crawler.spider))
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ from typing import List
4
+ from pprint import pformat
5
+ from asyncio import create_task
6
+
7
+
8
+ from crawlo.utils.log import get_logger
9
+ from crawlo.event import item_successful, item_discard
10
+ from crawlo.project import load_class, common_call
11
+ from crawlo.exceptions import PipelineInitError, ItemDiscard, InvalidOutputError
12
+
13
+
14
+ class PipelineManager:
15
+
16
+ def __init__(self, crawler):
17
+ self.crawler = crawler
18
+ self.pipelines: List = []
19
+ self.methods: List = []
20
+
21
+ self.logger = get_logger(self.__class__.__name__, self.crawler.settings.get('LOG_LEVEL'))
22
+ pipelines = self.crawler.settings.get_list('PIPELINES')
23
+ self._add_pipelines(pipelines)
24
+ self._add_methods()
25
+
26
+ @classmethod
27
+ def from_crawler(cls, *args, **kwargs):
28
+ o = cls(*args, **kwargs)
29
+ return o
30
+
31
+ def _add_pipelines(self, pipelines):
32
+ for pipeline in pipelines:
33
+ try:
34
+ pipeline_cls = load_class(pipeline)
35
+ if not hasattr(pipeline_cls, 'from_crawler'):
36
+ raise PipelineInitError(
37
+ f"Pipeline init failed, must inherit from `BasePipeline` or have a `create_instance` method"
38
+ )
39
+ self.pipelines.append(pipeline_cls.from_crawler(self.crawler))
40
+ except Exception as e:
41
+ self.logger.error(f"Failed to load pipeline {pipeline}: {e}")
42
+ # 可以选择继续加载其他管道或抛出异常
43
+ raise
44
+ if pipelines:
45
+ self.logger.info(f"enabled pipelines: \n {pformat(pipelines)}")
46
+
47
+ def _add_methods(self):
48
+ for pipeline in self.pipelines:
49
+ if hasattr(pipeline, 'process_item'):
50
+ self.methods.append(pipeline.process_item)
51
+
52
+ async def process_item(self, item):
53
+ try:
54
+ for method in self.methods:
55
+ item = await common_call(method, item, self.crawler.spider)
56
+ if item is None:
57
+ raise InvalidOutputError(f"{method.__qualname__} return None is not supported.")
58
+ except ItemDiscard as exc:
59
+ create_task(self.crawler.subscriber.notify(item_discard, item, exc, self.crawler.spider))
60
+ else:
61
+ create_task(self.crawler.subscriber.notify(item_successful, item, self.crawler.spider))
@@ -1,166 +1,166 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- """
4
- 基于 Redis 的数据项去重管道
5
- ========================
6
- 提供分布式环境下的数据项去重功能,防止保存重复的数据记录。
7
-
8
- 特点:
9
- - 分布式支持: 多节点共享去重数据
10
- - 高性能: 使用 Redis 集合进行快速查找
11
- - 可配置: 支持自定义 Redis 连接参数
12
- - 容错设计: 网络异常时不会丢失数据
13
- """
14
- import redis
15
- import hashlib
16
- from typing import Optional
17
-
18
- from crawlo import Item
19
- from crawlo.spider import Spider
20
- from crawlo.exceptions import DropItem
21
- from crawlo.utils.log import get_logger
22
-
23
-
24
- class RedisDedupPipeline:
25
- """基于 Redis 的数据项去重管道"""
26
-
27
- def __init__(
28
- self,
29
- redis_host: str = 'localhost',
30
- redis_port: int = 6379,
31
- redis_db: int = 0,
32
- redis_password: Optional[str] = None,
33
- redis_key: str = 'crawlo:item_fingerprints',
34
- log_level: str = "INFO"
35
- ):
36
- """
37
- 初始化 Redis 去重管道
38
-
39
- :param redis_host: Redis 主机地址
40
- :param redis_port: Redis 端口
41
- :param redis_db: Redis 数据库编号
42
- :param redis_password: Redis 密码
43
- :param redis_key: 存储指纹的 Redis 键名
44
- :param log_level: 日志级别
45
- """
46
- self.logger = get_logger(self.__class__.__name__, log_level)
47
-
48
- # 初始化 Redis 连接
49
- try:
50
- self.redis_client = redis.Redis(
51
- host=redis_host,
52
- port=redis_port,
53
- db=redis_db,
54
- password=redis_password,
55
- decode_responses=True,
56
- socket_connect_timeout=5,
57
- socket_timeout=5
58
- )
59
- # 测试连接
60
- self.redis_client.ping()
61
- self.logger.info(f"Redis 连接成功: {redis_host}:{redis_port}/{redis_db}")
62
- except Exception as e:
63
- self.logger.error(f"Redis 连接失败: {e}")
64
- raise RuntimeError(f"Redis 连接失败: {e}")
65
-
66
- self.redis_key = redis_key
67
- self.dropped_count = 0
68
-
69
- @classmethod
70
- def from_crawler(cls, crawler):
71
- """从爬虫配置创建管道实例"""
72
- settings = crawler.settings
73
-
74
- # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
75
- project_name = settings.get('PROJECT_NAME', 'default')
76
- redis_key = f"crawlo:{project_name}:item:fingerprint"
77
-
78
- return cls(
79
- redis_host=settings.get('REDIS_HOST', 'localhost'),
80
- redis_port=settings.get_int('REDIS_PORT', 6379),
81
- redis_db=settings.get_int('REDIS_DB', 0),
82
- redis_password=settings.get('REDIS_PASSWORD') or None,
83
- redis_key=redis_key,
84
- log_level=settings.get('LOG_LEVEL', 'INFO')
85
- )
86
-
87
- def process_item(self, item: Item, spider: Spider) -> Item:
88
- """
89
- 处理数据项,进行去重检查
90
-
91
- :param item: 要处理的数据项
92
- :param spider: 爬虫实例
93
- :return: 处理后的数据项或抛出 DropItem 异常
94
- """
95
- try:
96
- # 生成数据项指纹
97
- fingerprint = self._generate_item_fingerprint(item)
98
-
99
- # 使用 Redis 的 SADD 命令检查并添加指纹
100
- # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
101
- is_new = self.redis_client.sadd(self.redis_key, fingerprint)
102
-
103
- if not is_new:
104
- # 如果指纹已存在,丢弃这个数据项
105
- self.dropped_count += 1
106
- self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
107
- raise DropItem(f"重复的数据项: {fingerprint}")
108
- else:
109
- # 如果是新数据项,继续处理
110
- self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
111
- return item
112
-
113
- except redis.RedisError as e:
114
- self.logger.error(f"Redis 错误: {e}")
115
- # 在 Redis 错误时继续处理,避免丢失数据
116
- return item
117
- except Exception as e:
118
- self.logger.error(f"处理数据项时出错: {e}")
119
- # 在其他错误时继续处理
120
- return item
121
-
122
- def _generate_item_fingerprint(self, item: Item) -> str:
123
- """
124
- 生成数据项指纹
125
-
126
- 基于数据项的所有字段生成唯一指纹,用于去重判断。
127
-
128
- :param item: 数据项
129
- :return: 指纹字符串
130
- """
131
- # 将数据项转换为可序列化的字典
132
- try:
133
- item_dict = item.to_dict()
134
- except AttributeError:
135
- # 兼容没有to_dict方法的Item实现
136
- item_dict = dict(item)
137
-
138
- # 对字典进行排序以确保一致性
139
- sorted_items = sorted(item_dict.items())
140
-
141
- # 生成指纹字符串
142
- fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
143
-
144
- # 使用 SHA256 生成固定长度的指纹
145
- return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
146
-
147
- def close_spider(self, spider: Spider) -> None:
148
- """
149
- 爬虫关闭时的清理工作
150
-
151
- :param spider: 爬虫实例
152
- """
153
- try:
154
- # 获取去重统计信息
155
- total_items = self.redis_client.scard(self.redis_key)
156
- self.logger.info(f"爬虫 {spider.name} 关闭:")
157
- self.logger.info(f" - 丢弃的重复数据项: {self.dropped_count}")
158
- self.logger.info(f" - Redis 中存储的指纹数: {total_items}")
159
-
160
- # 注意:默认情况下不清理 Redis 中的指纹
161
- # 如果需要清理,可以在设置中配置
162
- if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
163
- deleted = self.redis_client.delete(self.redis_key)
164
- self.logger.info(f" - 清理的指纹数: {deleted}")
165
- except Exception as e:
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ """
4
+ 基于 Redis 的数据项去重管道
5
+ ========================
6
+ 提供分布式环境下的数据项去重功能,防止保存重复的数据记录。
7
+
8
+ 特点:
9
+ - 分布式支持: 多节点共享去重数据
10
+ - 高性能: 使用 Redis 集合进行快速查找
11
+ - 可配置: 支持自定义 Redis 连接参数
12
+ - 容错设计: 网络异常时不会丢失数据
13
+ """
14
+ import redis
15
+ import hashlib
16
+ from typing import Optional
17
+
18
+ from crawlo import Item
19
+ from crawlo.spider import Spider
20
+ from crawlo.exceptions import DropItem
21
+ from crawlo.utils.log import get_logger
22
+
23
+
24
+ class RedisDedupPipeline:
25
+ """基于 Redis 的数据项去重管道"""
26
+
27
+ def __init__(
28
+ self,
29
+ redis_host: str = 'localhost',
30
+ redis_port: int = 6379,
31
+ redis_db: int = 0,
32
+ redis_password: Optional[str] = None,
33
+ redis_key: str = 'crawlo:item_fingerprints',
34
+ log_level: str = "INFO"
35
+ ):
36
+ """
37
+ 初始化 Redis 去重管道
38
+
39
+ :param redis_host: Redis 主机地址
40
+ :param redis_port: Redis 端口
41
+ :param redis_db: Redis 数据库编号
42
+ :param redis_password: Redis 密码
43
+ :param redis_key: 存储指纹的 Redis 键名
44
+ :param log_level: 日志级别
45
+ """
46
+ self.logger = get_logger(self.__class__.__name__, log_level)
47
+
48
+ # 初始化 Redis 连接
49
+ try:
50
+ self.redis_client = redis.Redis(
51
+ host=redis_host,
52
+ port=redis_port,
53
+ db=redis_db,
54
+ password=redis_password,
55
+ decode_responses=True,
56
+ socket_connect_timeout=5,
57
+ socket_timeout=5
58
+ )
59
+ # 测试连接
60
+ self.redis_client.ping()
61
+ self.logger.info(f"Redis 连接成功: {redis_host}:{redis_port}/{redis_db}")
62
+ except Exception as e:
63
+ self.logger.error(f"Redis 连接失败: {e}")
64
+ raise RuntimeError(f"Redis 连接失败: {e}")
65
+
66
+ self.redis_key = redis_key
67
+ self.dropped_count = 0
68
+
69
+ @classmethod
70
+ def from_crawler(cls, crawler):
71
+ """从爬虫配置创建管道实例"""
72
+ settings = crawler.settings
73
+
74
+ # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
75
+ project_name = settings.get('PROJECT_NAME', 'default')
76
+ redis_key = f"crawlo:{project_name}:item:fingerprint"
77
+
78
+ return cls(
79
+ redis_host=settings.get('REDIS_HOST', 'localhost'),
80
+ redis_port=settings.get_int('REDIS_PORT', 6379),
81
+ redis_db=settings.get_int('REDIS_DB', 0),
82
+ redis_password=settings.get('REDIS_PASSWORD') or None,
83
+ redis_key=redis_key,
84
+ log_level=settings.get('LOG_LEVEL', 'INFO')
85
+ )
86
+
87
+ def process_item(self, item: Item, spider: Spider) -> Item:
88
+ """
89
+ 处理数据项,进行去重检查
90
+
91
+ :param item: 要处理的数据项
92
+ :param spider: 爬虫实例
93
+ :return: 处理后的数据项或抛出 DropItem 异常
94
+ """
95
+ try:
96
+ # 生成数据项指纹
97
+ fingerprint = self._generate_item_fingerprint(item)
98
+
99
+ # 使用 Redis 的 SADD 命令检查并添加指纹
100
+ # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
101
+ is_new = self.redis_client.sadd(self.redis_key, fingerprint)
102
+
103
+ if not is_new:
104
+ # 如果指纹已存在,丢弃这个数据项
105
+ self.dropped_count += 1
106
+ self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
107
+ raise DropItem(f"重复的数据项: {fingerprint}")
108
+ else:
109
+ # 如果是新数据项,继续处理
110
+ self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
111
+ return item
112
+
113
+ except redis.RedisError as e:
114
+ self.logger.error(f"Redis 错误: {e}")
115
+ # 在 Redis 错误时继续处理,避免丢失数据
116
+ return item
117
+ except Exception as e:
118
+ self.logger.error(f"处理数据项时出错: {e}")
119
+ # 在其他错误时继续处理
120
+ return item
121
+
122
+ def _generate_item_fingerprint(self, item: Item) -> str:
123
+ """
124
+ 生成数据项指纹
125
+
126
+ 基于数据项的所有字段生成唯一指纹,用于去重判断。
127
+
128
+ :param item: 数据项
129
+ :return: 指纹字符串
130
+ """
131
+ # 将数据项转换为可序列化的字典
132
+ try:
133
+ item_dict = item.to_dict()
134
+ except AttributeError:
135
+ # 兼容没有to_dict方法的Item实现
136
+ item_dict = dict(item)
137
+
138
+ # 对字典进行排序以确保一致性
139
+ sorted_items = sorted(item_dict.items())
140
+
141
+ # 生成指纹字符串
142
+ fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
143
+
144
+ # 使用 SHA256 生成固定长度的指纹
145
+ return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
146
+
147
+ def close_spider(self, spider: Spider) -> None:
148
+ """
149
+ 爬虫关闭时的清理工作
150
+
151
+ :param spider: 爬虫实例
152
+ """
153
+ try:
154
+ # 获取去重统计信息
155
+ total_items = self.redis_client.scard(self.redis_key)
156
+ self.logger.info(f"爬虫 {spider.name} 关闭:")
157
+ self.logger.info(f" - 丢弃的重复数据项: {self.dropped_count}")
158
+ self.logger.info(f" - Redis 中存储的指纹数: {total_items}")
159
+
160
+ # 注意:默认情况下不清理 Redis 中的指纹
161
+ # 如果需要清理,可以在设置中配置
162
+ if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
163
+ deleted = self.redis_client.delete(self.redis_key)
164
+ self.logger.info(f" - 清理的指纹数: {deleted}")
165
+ except Exception as e:
166
166
  self.logger.error(f"关闭爬虫时出错: {e}")