crawlo 1.1.9__py3-none-any.whl → 1.2.1__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 (221) 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 +65 -65
  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 +142 -132
  12. crawlo/commands/list.py +155 -155
  13. crawlo/commands/run.py +292 -292
  14. crawlo/commands/startproject.py +418 -418
  15. crawlo/commands/stats.py +188 -188
  16. crawlo/commands/utils.py +186 -186
  17. crawlo/config.py +312 -312
  18. crawlo/config_validator.py +252 -252
  19. crawlo/core/__init__.py +2 -2
  20. crawlo/core/engine.py +354 -345
  21. crawlo/core/processor.py +40 -40
  22. crawlo/core/scheduler.py +143 -136
  23. crawlo/crawler.py +1027 -1027
  24. crawlo/downloader/__init__.py +266 -266
  25. crawlo/downloader/aiohttp_downloader.py +220 -220
  26. crawlo/downloader/cffi_downloader.py +256 -256
  27. crawlo/downloader/httpx_downloader.py +259 -259
  28. crawlo/downloader/hybrid_downloader.py +213 -213
  29. crawlo/downloader/playwright_downloader.py +402 -402
  30. crawlo/downloader/selenium_downloader.py +472 -472
  31. crawlo/event.py +11 -11
  32. crawlo/exceptions.py +81 -81
  33. crawlo/extension/__init__.py +37 -37
  34. crawlo/extension/health_check.py +141 -141
  35. crawlo/extension/log_interval.py +57 -57
  36. crawlo/extension/log_stats.py +81 -81
  37. crawlo/extension/logging_extension.py +43 -43
  38. crawlo/extension/memory_monitor.py +104 -104
  39. crawlo/extension/performance_profiler.py +133 -133
  40. crawlo/extension/request_recorder.py +107 -107
  41. crawlo/filters/__init__.py +154 -154
  42. crawlo/filters/aioredis_filter.py +280 -280
  43. crawlo/filters/memory_filter.py +269 -269
  44. crawlo/items/__init__.py +23 -23
  45. crawlo/items/base.py +21 -21
  46. crawlo/items/fields.py +53 -53
  47. crawlo/items/items.py +104 -104
  48. crawlo/middleware/__init__.py +21 -21
  49. crawlo/middleware/default_header.py +132 -32
  50. crawlo/middleware/download_delay.py +105 -28
  51. crawlo/middleware/middleware_manager.py +135 -135
  52. crawlo/middleware/offsite.py +116 -0
  53. crawlo/middleware/proxy.py +366 -272
  54. crawlo/middleware/request_ignore.py +88 -30
  55. crawlo/middleware/response_code.py +164 -18
  56. crawlo/middleware/response_filter.py +138 -26
  57. crawlo/middleware/retry.py +124 -124
  58. crawlo/mode_manager.py +211 -211
  59. crawlo/network/__init__.py +21 -21
  60. crawlo/network/request.py +338 -338
  61. crawlo/network/response.py +359 -359
  62. crawlo/pipelines/__init__.py +21 -21
  63. crawlo/pipelines/bloom_dedup_pipeline.py +156 -156
  64. crawlo/pipelines/console_pipeline.py +39 -39
  65. crawlo/pipelines/csv_pipeline.py +316 -316
  66. crawlo/pipelines/database_dedup_pipeline.py +224 -224
  67. crawlo/pipelines/json_pipeline.py +218 -218
  68. crawlo/pipelines/memory_dedup_pipeline.py +115 -115
  69. crawlo/pipelines/mongo_pipeline.py +131 -131
  70. crawlo/pipelines/mysql_pipeline.py +316 -316
  71. crawlo/pipelines/pipeline_manager.py +61 -61
  72. crawlo/pipelines/redis_dedup_pipeline.py +167 -167
  73. crawlo/project.py +187 -187
  74. crawlo/queue/pqueue.py +37 -37
  75. crawlo/queue/queue_manager.py +337 -334
  76. crawlo/queue/redis_priority_queue.py +298 -298
  77. crawlo/settings/__init__.py +7 -7
  78. crawlo/settings/default_settings.py +226 -219
  79. crawlo/settings/setting_manager.py +122 -122
  80. crawlo/spider/__init__.py +639 -639
  81. crawlo/stats_collector.py +59 -59
  82. crawlo/subscriber.py +130 -130
  83. crawlo/task_manager.py +30 -30
  84. crawlo/templates/crawlo.cfg.tmpl +10 -10
  85. crawlo/templates/project/__init__.py.tmpl +3 -3
  86. crawlo/templates/project/items.py.tmpl +17 -17
  87. crawlo/templates/project/middlewares.py.tmpl +118 -109
  88. crawlo/templates/project/pipelines.py.tmpl +96 -96
  89. crawlo/templates/project/run.py.tmpl +45 -45
  90. crawlo/templates/project/settings.py.tmpl +327 -326
  91. crawlo/templates/project/settings_distributed.py.tmpl +119 -119
  92. crawlo/templates/project/settings_gentle.py.tmpl +94 -94
  93. crawlo/templates/project/settings_high_performance.py.tmpl +151 -151
  94. crawlo/templates/project/settings_simple.py.tmpl +68 -68
  95. crawlo/templates/project/spiders/__init__.py.tmpl +5 -5
  96. crawlo/templates/spider/spider.py.tmpl +143 -141
  97. crawlo/tools/__init__.py +182 -182
  98. crawlo/tools/anti_crawler.py +268 -268
  99. crawlo/tools/authenticated_proxy.py +240 -240
  100. crawlo/tools/data_validator.py +180 -180
  101. crawlo/tools/date_tools.py +35 -35
  102. crawlo/tools/distributed_coordinator.py +386 -386
  103. crawlo/tools/retry_mechanism.py +220 -220
  104. crawlo/tools/scenario_adapter.py +262 -262
  105. crawlo/utils/__init__.py +35 -35
  106. crawlo/utils/batch_processor.py +260 -260
  107. crawlo/utils/controlled_spider_mixin.py +439 -439
  108. crawlo/utils/date_tools.py +290 -290
  109. crawlo/utils/db_helper.py +343 -343
  110. crawlo/utils/enhanced_error_handler.py +359 -359
  111. crawlo/utils/env_config.py +105 -105
  112. crawlo/utils/error_handler.py +125 -125
  113. crawlo/utils/func_tools.py +82 -82
  114. crawlo/utils/large_scale_config.py +286 -286
  115. crawlo/utils/large_scale_helper.py +343 -343
  116. crawlo/utils/log.py +128 -128
  117. crawlo/utils/performance_monitor.py +284 -284
  118. crawlo/utils/queue_helper.py +175 -175
  119. crawlo/utils/redis_connection_pool.py +334 -334
  120. crawlo/utils/redis_key_validator.py +199 -199
  121. crawlo/utils/request.py +267 -267
  122. crawlo/utils/request_serializer.py +219 -219
  123. crawlo/utils/spider_loader.py +62 -62
  124. crawlo/utils/system.py +11 -11
  125. crawlo/utils/tools.py +4 -4
  126. crawlo/utils/url.py +39 -39
  127. crawlo-1.2.1.dist-info/METADATA +692 -0
  128. crawlo-1.2.1.dist-info/RECORD +220 -0
  129. examples/__init__.py +7 -7
  130. examples/aiohttp_settings.py +42 -0
  131. examples/curl_cffi_settings.py +41 -0
  132. examples/default_header_middleware_example.py +107 -0
  133. examples/default_header_spider_example.py +129 -0
  134. examples/download_delay_middleware_example.py +160 -0
  135. examples/httpx_settings.py +42 -0
  136. examples/multi_downloader_proxy_example.py +81 -0
  137. examples/offsite_middleware_example.py +55 -0
  138. examples/offsite_spider_example.py +107 -0
  139. examples/proxy_spider_example.py +166 -0
  140. examples/request_ignore_middleware_example.py +51 -0
  141. examples/request_ignore_spider_example.py +99 -0
  142. examples/response_code_middleware_example.py +52 -0
  143. examples/response_filter_middleware_example.py +67 -0
  144. examples/tong_hua_shun_settings.py +62 -0
  145. examples/tong_hua_shun_spider.py +170 -0
  146. tests/DOUBLE_CRAWLO_PREFIX_FIX_REPORT.md +81 -81
  147. tests/__init__.py +7 -7
  148. tests/advanced_tools_example.py +275 -275
  149. tests/authenticated_proxy_example.py +236 -236
  150. tests/cleaners_example.py +160 -160
  151. tests/config_validation_demo.py +102 -102
  152. tests/controlled_spider_example.py +205 -205
  153. tests/date_tools_example.py +180 -180
  154. tests/dynamic_loading_example.py +523 -523
  155. tests/dynamic_loading_test.py +104 -104
  156. tests/env_config_example.py +133 -133
  157. tests/error_handling_example.py +171 -171
  158. tests/redis_key_validation_demo.py +130 -130
  159. tests/response_improvements_example.py +144 -144
  160. tests/test_advanced_tools.py +148 -148
  161. tests/test_all_redis_key_configs.py +145 -145
  162. tests/test_authenticated_proxy.py +141 -141
  163. tests/test_cleaners.py +54 -54
  164. tests/test_comprehensive.py +146 -146
  165. tests/test_config_validator.py +193 -193
  166. tests/test_crawlo_proxy_integration.py +173 -0
  167. tests/test_date_tools.py +123 -123
  168. tests/test_default_header_middleware.py +159 -0
  169. tests/test_double_crawlo_fix.py +207 -207
  170. tests/test_double_crawlo_fix_simple.py +124 -124
  171. tests/test_download_delay_middleware.py +222 -0
  172. tests/test_downloader_proxy_compatibility.py +269 -0
  173. tests/test_dynamic_downloaders_proxy.py +124 -124
  174. tests/test_dynamic_proxy.py +92 -92
  175. tests/test_dynamic_proxy_config.py +146 -146
  176. tests/test_dynamic_proxy_real.py +109 -109
  177. tests/test_edge_cases.py +303 -303
  178. tests/test_enhanced_error_handler.py +270 -270
  179. tests/test_env_config.py +121 -121
  180. tests/test_error_handler_compatibility.py +112 -112
  181. tests/test_final_validation.py +153 -153
  182. tests/test_framework_env_usage.py +103 -103
  183. tests/test_integration.py +356 -356
  184. tests/test_item_dedup_redis_key.py +122 -122
  185. tests/test_offsite_middleware.py +222 -0
  186. tests/test_parsel.py +29 -29
  187. tests/test_performance.py +327 -327
  188. tests/test_proxy_api.py +265 -0
  189. tests/test_proxy_health_check.py +32 -32
  190. tests/test_proxy_middleware.py +122 -0
  191. tests/test_proxy_middleware_enhanced.py +217 -0
  192. tests/test_proxy_middleware_integration.py +136 -136
  193. tests/test_proxy_providers.py +56 -56
  194. tests/test_proxy_stats.py +19 -19
  195. tests/test_proxy_strategies.py +59 -59
  196. tests/test_queue_manager_double_crawlo.py +174 -231
  197. tests/test_queue_manager_redis_key.py +176 -176
  198. tests/test_real_scenario_proxy.py +196 -0
  199. tests/test_redis_config.py +28 -28
  200. tests/test_redis_connection_pool.py +294 -294
  201. tests/test_redis_key_naming.py +181 -181
  202. tests/test_redis_key_validator.py +123 -123
  203. tests/test_redis_queue.py +224 -224
  204. tests/test_request_ignore_middleware.py +183 -0
  205. tests/test_request_serialization.py +70 -70
  206. tests/test_response_code_middleware.py +350 -0
  207. tests/test_response_filter_middleware.py +428 -0
  208. tests/test_response_improvements.py +152 -152
  209. tests/test_retry_middleware.py +242 -0
  210. tests/test_scheduler.py +241 -241
  211. tests/test_simple_response.py +61 -61
  212. tests/test_telecom_spider_redis_key.py +205 -205
  213. tests/test_template_content.py +87 -87
  214. tests/test_template_redis_key.py +134 -134
  215. tests/test_tools.py +153 -153
  216. tests/tools_example.py +257 -257
  217. crawlo-1.1.9.dist-info/METADATA +0 -626
  218. crawlo-1.1.9.dist-info/RECORD +0 -190
  219. {crawlo-1.1.9.dist-info → crawlo-1.2.1.dist-info}/WHEEL +0 -0
  220. {crawlo-1.1.9.dist-info → crawlo-1.2.1.dist-info}/entry_points.txt +0 -0
  221. {crawlo-1.1.9.dist-info → crawlo-1.2.1.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,168 +1,168 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- """
4
- 基于 Redis 的数据项去重管道
5
- ========================
6
- 提供分布式环境下的数据项去重功能,防止保存重复的数据记录。
7
-
8
- 特点:
9
- - 分布式支持: 多节点共享去重数据
10
- - 高性能: 使用 Redis 集合进行快速查找
11
- - 可配置: 支持自定义 Redis 连接参数
12
- - 容错设计: 网络异常时不会丢失数据
13
- """
14
-
15
- import hashlib
16
- from typing import Optional
17
-
18
- import redis
19
-
20
- from crawlo import Item
21
- from crawlo.exceptions import DropItem
22
- from crawlo.spider import Spider
23
- from crawlo.utils.log import get_logger
24
-
25
-
26
- class RedisDedupPipeline:
27
- """基于 Redis 的数据项去重管道"""
28
-
29
- def __init__(
30
- self,
31
- redis_host: str = 'localhost',
32
- redis_port: int = 6379,
33
- redis_db: int = 0,
34
- redis_password: Optional[str] = None,
35
- redis_key: str = 'crawlo:item_fingerprints',
36
- log_level: str = "INFO"
37
- ):
38
- """
39
- 初始化 Redis 去重管道
40
-
41
- :param redis_host: Redis 主机地址
42
- :param redis_port: Redis 端口
43
- :param redis_db: Redis 数据库编号
44
- :param redis_password: Redis 密码
45
- :param redis_key: 存储指纹的 Redis 键名
46
- :param log_level: 日志级别
47
- """
48
- self.logger = get_logger(self.__class__.__name__, log_level)
49
-
50
- # 初始化 Redis 连接
51
- try:
52
- self.redis_client = redis.Redis(
53
- host=redis_host,
54
- port=redis_port,
55
- db=redis_db,
56
- password=redis_password,
57
- decode_responses=True,
58
- socket_connect_timeout=5,
59
- socket_timeout=5
60
- )
61
- # 测试连接
62
- self.redis_client.ping()
63
- self.logger.info(f"Redis 连接成功: {redis_host}:{redis_port}/{redis_db}")
64
- except Exception as e:
65
- self.logger.error(f"Redis 连接失败: {e}")
66
- raise RuntimeError(f"Redis 连接失败: {e}")
67
-
68
- self.redis_key = redis_key
69
- self.dropped_count = 0
70
-
71
- @classmethod
72
- def from_crawler(cls, crawler):
73
- """从爬虫配置创建管道实例"""
74
- settings = crawler.settings
75
-
76
- # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
77
- project_name = settings.get('PROJECT_NAME', 'default')
78
- redis_key = f"crawlo:{project_name}:item:fingerprint"
79
-
80
- return cls(
81
- redis_host=settings.get('REDIS_HOST', 'localhost'),
82
- redis_port=settings.get_int('REDIS_PORT', 6379),
83
- redis_db=settings.get_int('REDIS_DB', 0),
84
- redis_password=settings.get('REDIS_PASSWORD') or None,
85
- redis_key=redis_key,
86
- log_level=settings.get('LOG_LEVEL', 'INFO')
87
- )
88
-
89
- def process_item(self, item: Item, spider: Spider) -> Item:
90
- """
91
- 处理数据项,进行去重检查
92
-
93
- :param item: 要处理的数据项
94
- :param spider: 爬虫实例
95
- :return: 处理后的数据项或抛出 DropItem 异常
96
- """
97
- try:
98
- # 生成数据项指纹
99
- fingerprint = self._generate_item_fingerprint(item)
100
-
101
- # 使用 Redis 的 SADD 命令检查并添加指纹
102
- # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
103
- is_new = self.redis_client.sadd(self.redis_key, fingerprint)
104
-
105
- if not is_new:
106
- # 如果指纹已存在,丢弃这个数据项
107
- self.dropped_count += 1
108
- self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
109
- raise DropItem(f"重复的数据项: {fingerprint}")
110
- else:
111
- # 如果是新数据项,继续处理
112
- self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
113
- return item
114
-
115
- except redis.RedisError as e:
116
- self.logger.error(f"Redis 错误: {e}")
117
- # 在 Redis 错误时继续处理,避免丢失数据
118
- return item
119
- except Exception as e:
120
- self.logger.error(f"处理数据项时出错: {e}")
121
- # 在其他错误时继续处理
122
- return item
123
-
124
- def _generate_item_fingerprint(self, item: Item) -> str:
125
- """
126
- 生成数据项指纹
127
-
128
- 基于数据项的所有字段生成唯一指纹,用于去重判断。
129
-
130
- :param item: 数据项
131
- :return: 指纹字符串
132
- """
133
- # 将数据项转换为可序列化的字典
134
- try:
135
- item_dict = item.to_dict()
136
- except AttributeError:
137
- # 兼容没有to_dict方法的Item实现
138
- item_dict = dict(item)
139
-
140
- # 对字典进行排序以确保一致性
141
- sorted_items = sorted(item_dict.items())
142
-
143
- # 生成指纹字符串
144
- fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
145
-
146
- # 使用 SHA256 生成固定长度的指纹
147
- return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
148
-
149
- def close_spider(self, spider: Spider) -> None:
150
- """
151
- 爬虫关闭时的清理工作
152
-
153
- :param spider: 爬虫实例
154
- """
155
- try:
156
- # 获取去重统计信息
157
- total_items = self.redis_client.scard(self.redis_key)
158
- self.logger.info(f"爬虫 {spider.name} 关闭:")
159
- self.logger.info(f" - 丢弃的重复数据项: {self.dropped_count}")
160
- self.logger.info(f" - Redis 中存储的指纹数: {total_items}")
161
-
162
- # 注意:默认情况下不清理 Redis 中的指纹
163
- # 如果需要清理,可以在设置中配置
164
- if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
165
- deleted = self.redis_client.delete(self.redis_key)
166
- self.logger.info(f" - 清理的指纹数: {deleted}")
167
- 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
+
15
+ import hashlib
16
+ from typing import Optional
17
+
18
+ import redis
19
+
20
+ from crawlo import Item
21
+ from crawlo.exceptions import DropItem
22
+ from crawlo.spider import Spider
23
+ from crawlo.utils.log import get_logger
24
+
25
+
26
+ class RedisDedupPipeline:
27
+ """基于 Redis 的数据项去重管道"""
28
+
29
+ def __init__(
30
+ self,
31
+ redis_host: str = 'localhost',
32
+ redis_port: int = 6379,
33
+ redis_db: int = 0,
34
+ redis_password: Optional[str] = None,
35
+ redis_key: str = 'crawlo:item_fingerprints',
36
+ log_level: str = "INFO"
37
+ ):
38
+ """
39
+ 初始化 Redis 去重管道
40
+
41
+ :param redis_host: Redis 主机地址
42
+ :param redis_port: Redis 端口
43
+ :param redis_db: Redis 数据库编号
44
+ :param redis_password: Redis 密码
45
+ :param redis_key: 存储指纹的 Redis 键名
46
+ :param log_level: 日志级别
47
+ """
48
+ self.logger = get_logger(self.__class__.__name__, log_level)
49
+
50
+ # 初始化 Redis 连接
51
+ try:
52
+ self.redis_client = redis.Redis(
53
+ host=redis_host,
54
+ port=redis_port,
55
+ db=redis_db,
56
+ password=redis_password,
57
+ decode_responses=True,
58
+ socket_connect_timeout=5,
59
+ socket_timeout=5
60
+ )
61
+ # 测试连接
62
+ self.redis_client.ping()
63
+ self.logger.info(f"Redis 连接成功: {redis_host}:{redis_port}/{redis_db}")
64
+ except Exception as e:
65
+ self.logger.error(f"Redis 连接失败: {e}")
66
+ raise RuntimeError(f"Redis 连接失败: {e}")
67
+
68
+ self.redis_key = redis_key
69
+ self.dropped_count = 0
70
+
71
+ @classmethod
72
+ def from_crawler(cls, crawler):
73
+ """从爬虫配置创建管道实例"""
74
+ settings = crawler.settings
75
+
76
+ # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
77
+ project_name = settings.get('PROJECT_NAME', 'default')
78
+ redis_key = f"crawlo:{project_name}:item:fingerprint"
79
+
80
+ return cls(
81
+ redis_host=settings.get('REDIS_HOST', 'localhost'),
82
+ redis_port=settings.get_int('REDIS_PORT', 6379),
83
+ redis_db=settings.get_int('REDIS_DB', 0),
84
+ redis_password=settings.get('REDIS_PASSWORD') or None,
85
+ redis_key=redis_key,
86
+ log_level=settings.get('LOG_LEVEL', 'INFO')
87
+ )
88
+
89
+ def process_item(self, item: Item, spider: Spider) -> Item:
90
+ """
91
+ 处理数据项,进行去重检查
92
+
93
+ :param item: 要处理的数据项
94
+ :param spider: 爬虫实例
95
+ :return: 处理后的数据项或抛出 DropItem 异常
96
+ """
97
+ try:
98
+ # 生成数据项指纹
99
+ fingerprint = self._generate_item_fingerprint(item)
100
+
101
+ # 使用 Redis 的 SADD 命令检查并添加指纹
102
+ # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
103
+ is_new = self.redis_client.sadd(self.redis_key, fingerprint)
104
+
105
+ if not is_new:
106
+ # 如果指纹已存在,丢弃这个数据项
107
+ self.dropped_count += 1
108
+ self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
109
+ raise DropItem(f"重复的数据项: {fingerprint}")
110
+ else:
111
+ # 如果是新数据项,继续处理
112
+ self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
113
+ return item
114
+
115
+ except redis.RedisError as e:
116
+ self.logger.error(f"Redis 错误: {e}")
117
+ # 在 Redis 错误时继续处理,避免丢失数据
118
+ return item
119
+ except Exception as e:
120
+ self.logger.error(f"处理数据项时出错: {e}")
121
+ # 在其他错误时继续处理
122
+ return item
123
+
124
+ def _generate_item_fingerprint(self, item: Item) -> str:
125
+ """
126
+ 生成数据项指纹
127
+
128
+ 基于数据项的所有字段生成唯一指纹,用于去重判断。
129
+
130
+ :param item: 数据项
131
+ :return: 指纹字符串
132
+ """
133
+ # 将数据项转换为可序列化的字典
134
+ try:
135
+ item_dict = item.to_dict()
136
+ except AttributeError:
137
+ # 兼容没有to_dict方法的Item实现
138
+ item_dict = dict(item)
139
+
140
+ # 对字典进行排序以确保一致性
141
+ sorted_items = sorted(item_dict.items())
142
+
143
+ # 生成指纹字符串
144
+ fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
145
+
146
+ # 使用 SHA256 生成固定长度的指纹
147
+ return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
148
+
149
+ def close_spider(self, spider: Spider) -> None:
150
+ """
151
+ 爬虫关闭时的清理工作
152
+
153
+ :param spider: 爬虫实例
154
+ """
155
+ try:
156
+ # 获取去重统计信息
157
+ total_items = self.redis_client.scard(self.redis_key)
158
+ self.logger.info(f"爬虫 {spider.name} 关闭:")
159
+ self.logger.info(f" - 丢弃的重复数据项: {self.dropped_count}")
160
+ self.logger.info(f" - Redis 中存储的指纹数: {total_items}")
161
+
162
+ # 注意:默认情况下不清理 Redis 中的指纹
163
+ # 如果需要清理,可以在设置中配置
164
+ if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
165
+ deleted = self.redis_client.delete(self.redis_key)
166
+ self.logger.info(f" - 清理的指纹数: {deleted}")
167
+ except Exception as e:
168
168
  self.logger.error(f"关闭爬虫时出错: {e}")