crawlo 1.2.7__py3-none-any.whl → 1.2.9__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 +63 -61
  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 +323 -323
  10. crawlo/commands/startproject.py +436 -436
  11. crawlo/commands/stats.py +187 -187
  12. crawlo/commands/utils.py +186 -186
  13. crawlo/config.py +312 -312
  14. crawlo/config_validator.py +277 -251
  15. crawlo/core/__init__.py +2 -2
  16. crawlo/core/engine.py +366 -365
  17. crawlo/core/processor.py +40 -40
  18. crawlo/core/scheduler.py +256 -251
  19. crawlo/crawler.py +1103 -1100
  20. crawlo/data/__init__.py +5 -5
  21. crawlo/data/user_agents.py +194 -107
  22. crawlo/downloader/__init__.py +273 -266
  23. crawlo/downloader/aiohttp_downloader.py +226 -228
  24. crawlo/downloader/cffi_downloader.py +245 -256
  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 +43 -43
  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 +136 -136
  50. crawlo/middleware/offsite.py +114 -114
  51. crawlo/middleware/proxy.py +386 -368
  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 -0
  57. crawlo/mode_manager.py +211 -211
  58. crawlo/network/__init__.py +21 -21
  59. crawlo/network/request.py +379 -338
  60. crawlo/network/response.py +359 -359
  61. crawlo/pipelines/__init__.py +21 -21
  62. crawlo/pipelines/bloom_dedup_pipeline.py +157 -157
  63. crawlo/pipelines/console_pipeline.py +39 -39
  64. crawlo/pipelines/csv_pipeline.py +316 -316
  65. crawlo/pipelines/database_dedup_pipeline.py +223 -223
  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 +317 -317
  70. crawlo/pipelines/pipeline_manager.py +62 -62
  71. crawlo/pipelines/redis_dedup_pipeline.py +167 -167
  72. crawlo/project.py +290 -315
  73. crawlo/queue/pqueue.py +37 -37
  74. crawlo/queue/queue_manager.py +379 -378
  75. crawlo/queue/redis_priority_queue.py +306 -306
  76. crawlo/settings/__init__.py +7 -7
  77. crawlo/settings/default_settings.py +216 -220
  78. crawlo/settings/setting_manager.py +163 -122
  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 +261 -288
  89. crawlo/templates/project/settings_distributed.py.tmpl +174 -157
  90. crawlo/templates/project/settings_gentle.py.tmpl +95 -100
  91. crawlo/templates/project/settings_high_performance.py.tmpl +125 -134
  92. crawlo/templates/project/settings_minimal.py.tmpl +30 -0
  93. crawlo/templates/project/settings_simple.py.tmpl +96 -98
  94. crawlo/templates/project/spiders/__init__.py.tmpl +5 -5
  95. crawlo/templates/run.py.tmpl +47 -45
  96. crawlo/templates/spider/spider.py.tmpl +143 -143
  97. crawlo/tools/__init__.py +200 -182
  98. crawlo/tools/anti_crawler.py +268 -268
  99. crawlo/tools/authenticated_proxy.py +240 -240
  100. crawlo/{cleaners → tools}/data_formatter.py +225 -225
  101. crawlo/tools/data_validator.py +180 -180
  102. crawlo/tools/date_tools.py +290 -36
  103. crawlo/tools/distributed_coordinator.py +388 -387
  104. crawlo/{cleaners → tools}/encoding_converter.py +127 -126
  105. crawlo/tools/request_tools.py +83 -0
  106. crawlo/tools/retry_mechanism.py +224 -221
  107. crawlo/tools/scenario_adapter.py +262 -262
  108. crawlo/{cleaners → tools}/text_cleaner.py +232 -232
  109. crawlo/utils/__init__.py +35 -35
  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 +187 -128
  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.2.7.dist-info → crawlo-1.2.9.dist-info}/METADATA +1011 -764
  131. crawlo-1.2.9.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 -237
  137. tests/cleaners_example.py +160 -160
  138. tests/config_validation_demo.py +143 -103
  139. tests/controlled_spider_example.py +205 -205
  140. tests/date_tools_example.py +180 -180
  141. tests/debug_pipelines.py +67 -0
  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 +151 -0
  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 +153 -0
  156. tests/test_config_validator.py +182 -193
  157. tests/test_crawlo_proxy_integration.py +109 -173
  158. tests/test_date_tools.py +123 -123
  159. tests/test_default_header_middleware.py +158 -158
  160. tests/test_distributed.py +65 -0
  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 -357
  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 +185 -0
  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 +73 -0
  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 +112 -0
  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 -153
  213. tests/test_user_agents.py +97 -0
  214. tests/tools_example.py +260 -257
  215. tests/verify_distributed.py +117 -0
  216. crawlo/cleaners/__init__.py +0 -61
  217. crawlo/utils/date_tools.py +0 -290
  218. crawlo-1.2.7.dist-info/RECORD +0 -209
  219. {crawlo-1.2.7.dist-info → crawlo-1.2.9.dist-info}/WHEEL +0 -0
  220. {crawlo-1.2.7.dist-info → crawlo-1.2.9.dist-info}/entry_points.txt +0 -0
  221. {crawlo-1.2.7.dist-info → crawlo-1.2.9.dist-info}/top_level.txt +0 -0
@@ -1,62 +1,62 @@
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
- # 恢复INFO级别日志,保留关键的启用信息
46
- self.logger.info(f"enabled pipelines: \n {pformat(pipelines)}")
47
-
48
- def _add_methods(self):
49
- for pipeline in self.pipelines:
50
- if hasattr(pipeline, 'process_item'):
51
- self.methods.append(pipeline.process_item)
52
-
53
- async def process_item(self, item):
54
- try:
55
- for method in self.methods:
56
- item = await common_call(method, item, self.crawler.spider)
57
- if item is None:
58
- raise InvalidOutputError(f"{method.__qualname__} return None is not supported.")
59
- except ItemDiscard as exc:
60
- create_task(self.crawler.subscriber.notify(item_discard, item, exc, self.crawler.spider))
61
- else:
62
- 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
+ # 恢复INFO级别日志,保留关键的启用信息
46
+ self.logger.info(f"enabled pipelines: \n {pformat(pipelines)}")
47
+
48
+ def _add_methods(self):
49
+ for pipeline in self.pipelines:
50
+ if hasattr(pipeline, 'process_item'):
51
+ self.methods.append(pipeline.process_item)
52
+
53
+ async def process_item(self, item):
54
+ try:
55
+ for method in self.methods:
56
+ item = await common_call(method, item, self.crawler.spider)
57
+ if item is None:
58
+ raise InvalidOutputError(f"{method.__qualname__} return None is not supported.")
59
+ except ItemDiscard as exc:
60
+ create_task(self.crawler.subscriber.notify(item_discard, item, exc, self.crawler.spider))
61
+ else:
62
+ create_task(self.crawler.subscriber.notify(item_successful, item, self.crawler.spider))
@@ -1,167 +1,167 @@
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
- # INFO级别日志改为DEBUG级别,避免冗余输出
62
- self.logger.debug(f"Redis 连接成功: {redis_host}:{redis_port}/{redis_db}")
63
- except Exception as e:
64
- self.logger.error(f"Redis 连接失败: {e}")
65
- raise RuntimeError(f"Redis 连接失败: {e}")
66
-
67
- self.redis_key = redis_key
68
- self.dropped_count = 0
69
-
70
- @classmethod
71
- def from_crawler(cls, crawler):
72
- """从爬虫配置创建管道实例"""
73
- settings = crawler.settings
74
-
75
- # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
76
- project_name = settings.get('PROJECT_NAME', 'default')
77
- redis_key = f"crawlo:{project_name}:item:fingerprint"
78
-
79
- return cls(
80
- redis_host=settings.get('REDIS_HOST', 'localhost'),
81
- redis_port=settings.get_int('REDIS_PORT', 6379),
82
- redis_db=settings.get_int('REDIS_DB', 0),
83
- redis_password=settings.get('REDIS_PASSWORD') or None,
84
- redis_key=redis_key,
85
- log_level=settings.get('LOG_LEVEL', 'INFO')
86
- )
87
-
88
- def process_item(self, item: Item, spider: Spider) -> Item:
89
- """
90
- 处理数据项,进行去重检查
91
-
92
- :param item: 要处理的数据项
93
- :param spider: 爬虫实例
94
- :return: 处理后的数据项或抛出 DropItem 异常
95
- """
96
- try:
97
- # 生成数据项指纹
98
- fingerprint = self._generate_item_fingerprint(item)
99
-
100
- # 使用 Redis 的 SADD 命令检查并添加指纹
101
- # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
102
- is_new = self.redis_client.sadd(self.redis_key, fingerprint)
103
-
104
- if not is_new:
105
- # 如果指纹已存在,丢弃这个数据项
106
- self.dropped_count += 1
107
- self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
108
- raise DropItem(f"重复的数据项: {fingerprint}")
109
- else:
110
- # 如果是新数据项,继续处理
111
- self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
112
- return item
113
-
114
- except redis.RedisError as e:
115
- self.logger.error(f"Redis 错误: {e}")
116
- # 在 Redis 错误时继续处理,避免丢失数据
117
- return item
118
- except Exception as e:
119
- self.logger.error(f"处理数据项时出错: {e}")
120
- # 在其他错误时继续处理
121
- return item
122
-
123
- def _generate_item_fingerprint(self, item: Item) -> str:
124
- """
125
- 生成数据项指纹
126
-
127
- 基于数据项的所有字段生成唯一指纹,用于去重判断。
128
-
129
- :param item: 数据项
130
- :return: 指纹字符串
131
- """
132
- # 将数据项转换为可序列化的字典
133
- try:
134
- item_dict = item.to_dict()
135
- except AttributeError:
136
- # 兼容没有to_dict方法的Item实现
137
- item_dict = dict(item)
138
-
139
- # 对字典进行排序以确保一致性
140
- sorted_items = sorted(item_dict.items())
141
-
142
- # 生成指纹字符串
143
- fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
144
-
145
- # 使用 SHA256 生成固定长度的指纹
146
- return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
147
-
148
- def close_spider(self, spider: Spider) -> None:
149
- """
150
- 爬虫关闭时的清理工作
151
-
152
- :param spider: 爬虫实例
153
- """
154
- try:
155
- # 获取去重统计信息
156
- total_items = self.redis_client.scard(self.redis_key)
157
- self.logger.info(f"爬虫 {spider.name} 关闭:")
158
- self.logger.info(f" - 丢弃的重复数据项: {self.dropped_count}")
159
- self.logger.info(f" - Redis 中存储的指纹数: {total_items}")
160
-
161
- # 注意:默认情况下不清理 Redis 中的指纹
162
- # 如果需要清理,可以在设置中配置
163
- if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
164
- deleted = self.redis_client.delete(self.redis_key)
165
- self.logger.info(f" - 清理的指纹数: {deleted}")
166
- except Exception as e:
167
- self.logger.error(f"关闭爬虫时出错: {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
+ # Change INFO level log to DEBUG level to avoid redundant output
62
+ # self.logger.debug(f"Redis connection successful: {redis_host}:{redis_port}/{redis_db}") # 注释掉重复的日志
63
+ except Exception as e:
64
+ self.logger.error(f"Redis connection failed: {e}")
65
+ raise RuntimeError(f"Redis 连接失败: {e}")
66
+
67
+ self.redis_key = redis_key
68
+ self.dropped_count = 0
69
+
70
+ @classmethod
71
+ def from_crawler(cls, crawler):
72
+ """从爬虫配置创建管道实例"""
73
+ settings = crawler.settings
74
+
75
+ # 使用统一的Redis key命名规范: crawlo:{project_name}:item:fingerprint
76
+ project_name = settings.get('PROJECT_NAME', 'default')
77
+ redis_key = f"crawlo:{project_name}:item:fingerprint"
78
+
79
+ return cls(
80
+ redis_host=settings.get('REDIS_HOST', 'localhost'),
81
+ redis_port=settings.get_int('REDIS_PORT', 6379),
82
+ redis_db=settings.get_int('REDIS_DB', 0),
83
+ redis_password=settings.get('REDIS_PASSWORD') or None,
84
+ redis_key=redis_key,
85
+ log_level=settings.get('LOG_LEVEL', 'INFO')
86
+ )
87
+
88
+ def process_item(self, item: Item, spider: Spider) -> Item:
89
+ """
90
+ 处理数据项,进行去重检查
91
+
92
+ :param item: 要处理的数据项
93
+ :param spider: 爬虫实例
94
+ :return: 处理后的数据项或抛出 DropItem 异常
95
+ """
96
+ try:
97
+ # 生成数据项指纹
98
+ fingerprint = self._generate_item_fingerprint(item)
99
+
100
+ # 使用 Redis 的 SADD 命令检查并添加指纹
101
+ # 如果指纹已存在,SADD 返回 0;如果指纹是新的,SADD 返回 1
102
+ is_new = self.redis_client.sadd(self.redis_key, fingerprint)
103
+
104
+ if not is_new:
105
+ # 如果指纹已存在,丢弃这个数据项
106
+ self.dropped_count += 1
107
+ # self.logger.debug(f"Dropping duplicate item: {fingerprint[:20]}...") # 注释掉重复的日志
108
+ raise DropItem(f"Duplicate item: {fingerprint}")
109
+ else:
110
+ # 如果是新数据项,继续处理
111
+ # self.logger.debug(f"Processing new item: {fingerprint[:20]}...") # 注释掉重复的日志
112
+ return item
113
+
114
+ except redis.RedisError as e:
115
+ self.logger.error(f"Redis error: {e}")
116
+ # 在 Redis 错误时继续处理,避免丢失数据
117
+ return item
118
+ except Exception as e:
119
+ self.logger.error(f"Error processing item: {e}")
120
+ # 在其他错误时继续处理
121
+ return item
122
+
123
+ def _generate_item_fingerprint(self, item: Item) -> str:
124
+ """
125
+ 生成数据项指纹
126
+
127
+ 基于数据项的所有字段生成唯一指纹,用于去重判断。
128
+
129
+ :param item: 数据项
130
+ :return: 指纹字符串
131
+ """
132
+ # 将数据项转换为可序列化的字典
133
+ try:
134
+ item_dict = item.to_dict()
135
+ except AttributeError:
136
+ # 兼容没有to_dict方法的Item实现
137
+ item_dict = dict(item)
138
+
139
+ # 对字典进行排序以确保一致性
140
+ sorted_items = sorted(item_dict.items())
141
+
142
+ # 生成指纹字符串
143
+ fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
144
+
145
+ # 使用 SHA256 生成固定长度的指纹
146
+ return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
147
+
148
+ def close_spider(self, spider: Spider) -> None:
149
+ """
150
+ 爬虫关闭时的清理工作
151
+
152
+ :param spider: 爬虫实例
153
+ """
154
+ try:
155
+ # 获取去重统计信息
156
+ total_items = self.redis_client.scard(self.redis_key)
157
+ self.logger.info(f"Spider {spider.name} closed:")
158
+ self.logger.info(f" - Dropped duplicate items: {self.dropped_count}")
159
+ self.logger.info(f" - Fingerprints stored in Redis: {total_items}")
160
+
161
+ # 注意:默认情况下不清理 Redis 中的指纹
162
+ # 如果需要清理,可以在设置中配置
163
+ if spider.crawler.settings.getbool('REDIS_DEDUP_CLEANUP', False):
164
+ deleted = self.redis_client.delete(self.redis_key)
165
+ self.logger.info(f" - Cleaned fingerprints: {deleted}")
166
+ except Exception as e:
167
+ self.logger.error(f"Error closing spider: {e}")