crawlo 1.3.4__py3-none-any.whl → 1.3.6__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 (289) hide show
  1. crawlo/__init__.py +87 -87
  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 +341 -341
  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 +45 -45
  16. crawlo/core/engine.py +439 -439
  17. crawlo/core/processor.py +40 -40
  18. crawlo/core/scheduler.py +257 -257
  19. crawlo/crawler.py +638 -638
  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 +228 -228
  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 +61 -61
  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/factories/__init__.py +27 -27
  40. crawlo/factories/base.py +68 -68
  41. crawlo/factories/crawler.py +103 -103
  42. crawlo/factories/registry.py +84 -84
  43. crawlo/filters/__init__.py +154 -154
  44. crawlo/filters/aioredis_filter.py +257 -257
  45. crawlo/filters/memory_filter.py +269 -269
  46. crawlo/framework.py +292 -291
  47. crawlo/initialization/__init__.py +39 -39
  48. crawlo/initialization/built_in.py +425 -425
  49. crawlo/initialization/context.py +141 -141
  50. crawlo/initialization/core.py +193 -193
  51. crawlo/initialization/phases.py +148 -148
  52. crawlo/initialization/registry.py +145 -145
  53. crawlo/items/__init__.py +23 -23
  54. crawlo/items/base.py +23 -23
  55. crawlo/items/fields.py +52 -52
  56. crawlo/items/items.py +104 -104
  57. crawlo/logging/__init__.py +37 -37
  58. crawlo/logging/config.py +96 -96
  59. crawlo/logging/factory.py +128 -128
  60. crawlo/logging/manager.py +111 -111
  61. crawlo/middleware/__init__.py +21 -21
  62. crawlo/middleware/default_header.py +132 -132
  63. crawlo/middleware/download_delay.py +104 -104
  64. crawlo/middleware/middleware_manager.py +135 -135
  65. crawlo/middleware/offsite.py +123 -123
  66. crawlo/middleware/proxy.py +386 -386
  67. crawlo/middleware/request_ignore.py +86 -86
  68. crawlo/middleware/response_code.py +163 -163
  69. crawlo/middleware/response_filter.py +136 -136
  70. crawlo/middleware/retry.py +124 -124
  71. crawlo/middleware/simple_proxy.py +65 -65
  72. crawlo/mode_manager.py +212 -212
  73. crawlo/network/__init__.py +21 -21
  74. crawlo/network/request.py +379 -379
  75. crawlo/network/response.py +359 -359
  76. crawlo/pipelines/__init__.py +21 -21
  77. crawlo/pipelines/bloom_dedup_pipeline.py +156 -156
  78. crawlo/pipelines/console_pipeline.py +39 -39
  79. crawlo/pipelines/csv_pipeline.py +316 -316
  80. crawlo/pipelines/database_dedup_pipeline.py +222 -222
  81. crawlo/pipelines/json_pipeline.py +218 -218
  82. crawlo/pipelines/memory_dedup_pipeline.py +115 -115
  83. crawlo/pipelines/mongo_pipeline.py +131 -131
  84. crawlo/pipelines/mysql_pipeline.py +325 -318
  85. crawlo/pipelines/pipeline_manager.py +76 -76
  86. crawlo/pipelines/redis_dedup_pipeline.py +166 -166
  87. crawlo/project.py +327 -327
  88. crawlo/queue/pqueue.py +42 -42
  89. crawlo/queue/queue_manager.py +503 -503
  90. crawlo/queue/redis_priority_queue.py +326 -326
  91. crawlo/settings/__init__.py +7 -7
  92. crawlo/settings/default_settings.py +321 -321
  93. crawlo/settings/setting_manager.py +214 -214
  94. crawlo/spider/__init__.py +657 -657
  95. crawlo/stats_collector.py +73 -73
  96. crawlo/subscriber.py +129 -129
  97. crawlo/task_manager.py +138 -138
  98. crawlo/templates/crawlo.cfg.tmpl +10 -10
  99. crawlo/templates/project/__init__.py.tmpl +3 -3
  100. crawlo/templates/project/items.py.tmpl +17 -17
  101. crawlo/templates/project/middlewares.py.tmpl +118 -118
  102. crawlo/templates/project/pipelines.py.tmpl +96 -96
  103. crawlo/templates/project/settings.py.tmpl +167 -167
  104. crawlo/templates/project/settings_distributed.py.tmpl +166 -166
  105. crawlo/templates/project/settings_gentle.py.tmpl +166 -166
  106. crawlo/templates/project/settings_high_performance.py.tmpl +167 -167
  107. crawlo/templates/project/settings_minimal.py.tmpl +65 -65
  108. crawlo/templates/project/settings_simple.py.tmpl +164 -164
  109. crawlo/templates/project/spiders/__init__.py.tmpl +9 -9
  110. crawlo/templates/run.py.tmpl +34 -34
  111. crawlo/templates/spider/spider.py.tmpl +143 -143
  112. crawlo/templates/spiders_init.py.tmpl +9 -9
  113. crawlo/tools/__init__.py +200 -200
  114. crawlo/tools/anti_crawler.py +268 -268
  115. crawlo/tools/authenticated_proxy.py +240 -240
  116. crawlo/tools/data_formatter.py +225 -225
  117. crawlo/tools/data_validator.py +180 -180
  118. crawlo/tools/date_tools.py +289 -289
  119. crawlo/tools/distributed_coordinator.py +388 -388
  120. crawlo/tools/encoding_converter.py +127 -127
  121. crawlo/tools/network_diagnostic.py +364 -364
  122. crawlo/tools/request_tools.py +82 -82
  123. crawlo/tools/retry_mechanism.py +224 -224
  124. crawlo/tools/scenario_adapter.py +262 -262
  125. crawlo/tools/text_cleaner.py +232 -232
  126. crawlo/utils/__init__.py +34 -34
  127. crawlo/utils/batch_processor.py +259 -259
  128. crawlo/utils/class_loader.py +25 -25
  129. crawlo/utils/controlled_spider_mixin.py +439 -439
  130. crawlo/utils/db_helper.py +343 -343
  131. crawlo/utils/enhanced_error_handler.py +356 -356
  132. crawlo/utils/env_config.py +142 -142
  133. crawlo/utils/error_handler.py +165 -165
  134. crawlo/utils/func_tools.py +82 -82
  135. crawlo/utils/large_scale_config.py +286 -286
  136. crawlo/utils/large_scale_helper.py +344 -344
  137. crawlo/utils/log.py +80 -44
  138. crawlo/utils/performance_monitor.py +285 -285
  139. crawlo/utils/queue_helper.py +175 -175
  140. crawlo/utils/redis_connection_pool.py +388 -388
  141. crawlo/utils/redis_key_validator.py +198 -198
  142. crawlo/utils/request.py +267 -267
  143. crawlo/utils/request_serializer.py +225 -225
  144. crawlo/utils/spider_loader.py +61 -61
  145. crawlo/utils/system.py +11 -11
  146. crawlo/utils/tools.py +4 -4
  147. crawlo/utils/url.py +39 -39
  148. {crawlo-1.3.4.dist-info → crawlo-1.3.6.dist-info}/METADATA +1126 -1126
  149. crawlo-1.3.6.dist-info/RECORD +290 -0
  150. examples/__init__.py +7 -7
  151. tests/__init__.py +7 -7
  152. tests/advanced_tools_example.py +275 -275
  153. tests/authenticated_proxy_example.py +106 -106
  154. tests/baidu_performance_test.py +108 -108
  155. tests/baidu_test.py +59 -59
  156. tests/cleaners_example.py +160 -160
  157. tests/comprehensive_framework_test.py +212 -212
  158. tests/comprehensive_test.py +81 -81
  159. tests/comprehensive_testing_summary.md +186 -186
  160. tests/config_validation_demo.py +142 -142
  161. tests/controlled_spider_example.py +205 -205
  162. tests/date_tools_example.py +180 -180
  163. tests/debug_configure.py +69 -69
  164. tests/debug_framework_logger.py +84 -84
  165. tests/debug_log_config.py +127 -0
  166. tests/debug_log_levels.py +63 -63
  167. tests/debug_pipelines.py +66 -66
  168. tests/detailed_log_test.py +234 -0
  169. tests/distributed_test.py +66 -66
  170. tests/distributed_test_debug.py +76 -76
  171. tests/dynamic_loading_example.py +523 -523
  172. tests/dynamic_loading_test.py +104 -104
  173. tests/env_config_example.py +133 -133
  174. tests/error_handling_example.py +171 -171
  175. tests/final_comprehensive_test.py +151 -151
  176. tests/final_log_test.py +261 -0
  177. tests/final_validation_test.py +182 -182
  178. tests/fix_log_test.py +143 -0
  179. tests/framework_performance_test.py +202 -202
  180. tests/log_buffering_test.py +112 -0
  181. tests/log_generation_timing_test.py +154 -0
  182. tests/optimized_performance_test.py +211 -211
  183. tests/performance_comparison.py +245 -245
  184. tests/queue_blocking_test.py +113 -113
  185. tests/queue_test.py +89 -89
  186. tests/redis_key_validation_demo.py +130 -130
  187. tests/request_params_example.py +150 -150
  188. tests/response_improvements_example.py +144 -144
  189. tests/scrapy_comparison/ofweek_scrapy.py +138 -138
  190. tests/scrapy_comparison/scrapy_test.py +133 -133
  191. tests/simple_command_test.py +119 -119
  192. tests/simple_crawlo_test.py +127 -127
  193. tests/simple_log_test.py +57 -57
  194. tests/simple_log_test2.py +138 -0
  195. tests/simple_optimization_test.py +128 -128
  196. tests/simple_queue_type_test.py +42 -0
  197. tests/simple_spider_test.py +49 -49
  198. tests/simple_test.py +47 -47
  199. tests/spider_log_timing_test.py +178 -0
  200. tests/test_advanced_tools.py +148 -148
  201. tests/test_all_commands.py +230 -230
  202. tests/test_all_redis_key_configs.py +145 -145
  203. tests/test_authenticated_proxy.py +141 -141
  204. tests/test_batch_processor.py +178 -178
  205. tests/test_cleaners.py +54 -54
  206. tests/test_component_factory.py +174 -174
  207. tests/test_comprehensive.py +146 -146
  208. tests/test_config_consistency.py +80 -80
  209. tests/test_config_merge.py +152 -152
  210. tests/test_config_validator.py +182 -182
  211. tests/test_controlled_spider_mixin.py +79 -79
  212. tests/test_crawlo_proxy_integration.py +108 -108
  213. tests/test_date_tools.py +123 -123
  214. tests/test_default_header_middleware.py +158 -158
  215. tests/test_distributed.py +65 -65
  216. tests/test_double_crawlo_fix.py +207 -207
  217. tests/test_double_crawlo_fix_simple.py +124 -124
  218. tests/test_download_delay_middleware.py +221 -221
  219. tests/test_downloader_proxy_compatibility.py +268 -268
  220. tests/test_dynamic_downloaders_proxy.py +124 -124
  221. tests/test_dynamic_proxy.py +92 -92
  222. tests/test_dynamic_proxy_config.py +146 -146
  223. tests/test_dynamic_proxy_real.py +109 -109
  224. tests/test_edge_cases.py +303 -303
  225. tests/test_enhanced_error_handler.py +270 -270
  226. tests/test_enhanced_error_handler_comprehensive.py +245 -245
  227. tests/test_env_config.py +121 -121
  228. tests/test_error_handler_compatibility.py +112 -112
  229. tests/test_factories.py +252 -252
  230. tests/test_final_validation.py +153 -153
  231. tests/test_framework_env_usage.py +103 -103
  232. tests/test_framework_logger.py +66 -66
  233. tests/test_framework_startup.py +64 -64
  234. tests/test_get_component_logger.py +84 -0
  235. tests/test_integration.py +169 -169
  236. tests/test_item_dedup_redis_key.py +122 -122
  237. tests/test_large_scale_config.py +112 -112
  238. tests/test_large_scale_helper.py +235 -235
  239. tests/test_logging_system.py +283 -0
  240. tests/test_mode_change.py +72 -72
  241. tests/test_mode_consistency.py +51 -51
  242. tests/test_offsite_middleware.py +221 -221
  243. tests/test_parsel.py +29 -29
  244. tests/test_performance.py +327 -327
  245. tests/test_performance_monitor.py +115 -115
  246. tests/test_proxy_api.py +264 -264
  247. tests/test_proxy_health_check.py +32 -32
  248. tests/test_proxy_middleware.py +121 -121
  249. tests/test_proxy_middleware_enhanced.py +216 -216
  250. tests/test_proxy_middleware_integration.py +136 -136
  251. tests/test_proxy_middleware_refactored.py +184 -184
  252. tests/test_proxy_providers.py +56 -56
  253. tests/test_proxy_stats.py +19 -19
  254. tests/test_proxy_strategies.py +59 -59
  255. tests/test_queue_empty_check.py +41 -41
  256. tests/test_queue_manager_double_crawlo.py +173 -173
  257. tests/test_queue_manager_redis_key.py +176 -176
  258. tests/test_queue_type.py +107 -0
  259. tests/test_random_user_agent.py +72 -72
  260. tests/test_real_scenario_proxy.py +195 -195
  261. tests/test_redis_config.py +28 -28
  262. tests/test_redis_connection_pool.py +294 -294
  263. tests/test_redis_key_naming.py +181 -181
  264. tests/test_redis_key_validator.py +123 -123
  265. tests/test_redis_queue.py +224 -224
  266. tests/test_request_ignore_middleware.py +182 -182
  267. tests/test_request_params.py +111 -111
  268. tests/test_request_serialization.py +70 -70
  269. tests/test_response_code_middleware.py +349 -349
  270. tests/test_response_filter_middleware.py +427 -427
  271. tests/test_response_improvements.py +152 -152
  272. tests/test_retry_middleware.py +241 -241
  273. tests/test_scheduler.py +252 -252
  274. tests/test_scheduler_config_update.py +133 -133
  275. tests/test_simple_response.py +61 -61
  276. tests/test_telecom_spider_redis_key.py +205 -205
  277. tests/test_template_content.py +87 -87
  278. tests/test_template_redis_key.py +134 -134
  279. tests/test_tools.py +159 -159
  280. tests/test_user_agents.py +96 -96
  281. tests/tools_example.py +260 -260
  282. tests/untested_features_report.md +138 -138
  283. tests/verify_debug.py +51 -51
  284. tests/verify_distributed.py +117 -117
  285. tests/verify_log_fix.py +111 -111
  286. crawlo-1.3.4.dist-info/RECORD +0 -278
  287. {crawlo-1.3.4.dist-info → crawlo-1.3.6.dist-info}/WHEEL +0 -0
  288. {crawlo-1.3.4.dist-info → crawlo-1.3.6.dist-info}/entry_points.txt +0 -0
  289. {crawlo-1.3.4.dist-info → crawlo-1.3.6.dist-info}/top_level.txt +0 -0
crawlo/stats_collector.py CHANGED
@@ -1,73 +1,73 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- """
4
- # @Time : 2025-05-17 09:57
5
- # @Author : crawl-coder
6
- # @Desc : 统计信息收集器
7
- """
8
- from pprint import pformat
9
- from crawlo.utils.log import get_logger
10
-
11
-
12
- class StatsCollector(object):
13
-
14
- def __init__(self, crawler):
15
- self.crawler = crawler
16
- self._dump = self.crawler.settings.get_bool('STATS_DUMP')
17
- self._stats = {}
18
- self.logger = get_logger(self.__class__.__name__, "INFO")
19
-
20
- def inc_value(self, key, count=1, start=0):
21
- self._stats[key] = self._stats.setdefault(key, start) + count
22
-
23
- def get_value(self, key, default=None):
24
- return self._stats.get(key, default)
25
-
26
- def get_stats(self):
27
- return self._stats
28
-
29
- def set_stats(self, stats):
30
- self._stats = stats
31
-
32
- def clear_stats(self):
33
- self._stats.clear()
34
-
35
- def close_spider(self, spider, reason):
36
- self._stats['reason'] = reason
37
-
38
- # 首选:使用 spider.name
39
- # 次选:使用实例的类名
40
- # 最后:使用一个完全未知的占位符
41
- spider_name = (
42
- getattr(spider, 'name', None) or
43
- spider.__class__.__name__ or
44
- '<Unknown>'
45
- )
46
-
47
- self._stats['spider_name'] = spider_name
48
-
49
- def __getitem__(self, item):
50
- return self._stats[item]
51
-
52
- def __setitem__(self, key, value):
53
- self._stats[key] = value
54
-
55
- def __delitem__(self, key):
56
- del self._stats[key]
57
-
58
- def close(self):
59
- """关闭统计收集器并输出统计信息"""
60
- if self._dump:
61
- # 获取爬虫名称
62
- spider_name = self._stats.get('spider_name', 'unknown')
63
-
64
- # 如果还没有设置爬虫名称,尝试从crawler中获取
65
- if spider_name == 'unknown' and hasattr(self, 'crawler') and self.crawler:
66
- spider = getattr(self.crawler, 'spider', None)
67
- if spider and hasattr(spider, 'name'):
68
- spider_name = spider.name
69
- # 同时更新_stats中的spider_name
70
- self._stats['spider_name'] = spider_name
71
-
72
- # 输出统计信息(这是唯一输出统计信息的地方)
73
- self.logger.info(f'{spider_name} stats: \n{pformat(self._stats)}')
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ """
4
+ # @Time : 2025-05-17 09:57
5
+ # @Author : crawl-coder
6
+ # @Desc : 统计信息收集器
7
+ """
8
+ from pprint import pformat
9
+ from crawlo.utils.log import get_logger
10
+
11
+
12
+ class StatsCollector(object):
13
+
14
+ def __init__(self, crawler):
15
+ self.crawler = crawler
16
+ self._dump = self.crawler.settings.get_bool('STATS_DUMP')
17
+ self._stats = {}
18
+ self.logger = get_logger(self.__class__.__name__, "INFO")
19
+
20
+ def inc_value(self, key, count=1, start=0):
21
+ self._stats[key] = self._stats.setdefault(key, start) + count
22
+
23
+ def get_value(self, key, default=None):
24
+ return self._stats.get(key, default)
25
+
26
+ def get_stats(self):
27
+ return self._stats
28
+
29
+ def set_stats(self, stats):
30
+ self._stats = stats
31
+
32
+ def clear_stats(self):
33
+ self._stats.clear()
34
+
35
+ def close_spider(self, spider, reason):
36
+ self._stats['reason'] = reason
37
+
38
+ # 首选:使用 spider.name
39
+ # 次选:使用实例的类名
40
+ # 最后:使用一个完全未知的占位符
41
+ spider_name = (
42
+ getattr(spider, 'name', None) or
43
+ spider.__class__.__name__ or
44
+ '<Unknown>'
45
+ )
46
+
47
+ self._stats['spider_name'] = spider_name
48
+
49
+ def __getitem__(self, item):
50
+ return self._stats[item]
51
+
52
+ def __setitem__(self, key, value):
53
+ self._stats[key] = value
54
+
55
+ def __delitem__(self, key):
56
+ del self._stats[key]
57
+
58
+ def close(self):
59
+ """关闭统计收集器并输出统计信息"""
60
+ if self._dump:
61
+ # 获取爬虫名称
62
+ spider_name = self._stats.get('spider_name', 'unknown')
63
+
64
+ # 如果还没有设置爬虫名称,尝试从crawler中获取
65
+ if spider_name == 'unknown' and hasattr(self, 'crawler') and self.crawler:
66
+ spider = getattr(self.crawler, 'spider', None)
67
+ if spider and hasattr(spider, 'name'):
68
+ spider_name = spider.name
69
+ # 同时更新_stats中的spider_name
70
+ self._stats['spider_name'] = spider_name
71
+
72
+ # 输出统计信息(这是唯一输出统计信息的地方)
73
+ self.logger.info(f'{spider_name} stats: \n{pformat(self._stats)}')
crawlo/subscriber.py CHANGED
@@ -1,130 +1,130 @@
1
- #!/usr/bin/python
2
- # -*- coding:UTF-8 -*-
3
- import asyncio
4
- from collections import defaultdict
5
- from inspect import iscoroutinefunction
6
- from typing import Dict, Callable, Coroutine, Any, TypeAlias, List, Tuple
7
-
8
-
9
- class ReceiverTypeError(TypeError):
10
- """当订阅的接收者不是一个协程函数时抛出。"""
11
- pass
12
-
13
-
14
- ReceiverCoroutine: TypeAlias = Callable[..., Coroutine[Any, Any, Any]]
15
-
16
-
17
- class Subscriber:
18
- """
19
- 一个支持异步协程的发布/订阅(Pub/Sub)模式实现。
20
-
21
- 这个类允许你注册(订阅)协程函数来监听特定事件,并在事件发生时
22
- 以并发的方式异步地通知所有订阅者。
23
- """
24
-
25
- def __init__(self):
26
- """初始化一个空的订阅者字典。"""
27
- # 使用弱引用字典避免内存泄漏
28
- self._subscribers: Dict[str, Dict[ReceiverCoroutine, int]] = defaultdict(dict)
29
- # 用于缓存排序后的订阅者列表,提高频繁事件的处理性能
30
- self._sorted_subscribers_cache: Dict[str, List[Tuple[ReceiverCoroutine, int]]] = {}
31
-
32
- def subscribe(self, receiver: ReceiverCoroutine, *, event: str, priority: int = 0) -> None:
33
- """
34
- 订阅一个事件。
35
-
36
- Args:
37
- receiver: 一个协程函数 (例如 async def my_func(...))。
38
- event: 要订阅的事件名称。
39
- priority: 订阅者优先级,数值越小优先级越高,默认为0。
40
-
41
- Raises:
42
- ReceiverTypeError: 如果提供的 `receiver` 不是一个协程函数。
43
- """
44
- if not iscoroutinefunction(receiver):
45
- raise ReceiverTypeError(f"接收者 '{receiver.__qualname__}' 必须是一个协程函数。")
46
-
47
- # 使用弱引用避免内存泄漏
48
- self._subscribers[event][receiver] = priority
49
- # 清除缓存
50
- self._sorted_subscribers_cache.pop(event, None)
51
-
52
- def unsubscribe(self, receiver: ReceiverCoroutine, *, event: str) -> None:
53
- """
54
- 取消订阅一个事件。
55
-
56
- 如果事件或接收者不存在,将静默处理。
57
-
58
- Args:
59
- receiver: 要取消订阅的协程函数。
60
- event: 事件名称。
61
- """
62
- if event in self._subscribers:
63
- self._subscribers[event].pop(receiver, None)
64
- # 清除缓存
65
- self._sorted_subscribers_cache.pop(event, None)
66
-
67
- def _get_sorted_subscribers(self, event: str) -> List[Tuple[ReceiverCoroutine, int]]:
68
- """
69
- 获取按优先级排序的订阅者列表。
70
-
71
- Args:
72
- event: 事件名称。
73
-
74
- Returns:
75
- 按优先级排序的订阅者列表。
76
- """
77
- # 检查缓存
78
- if event in self._sorted_subscribers_cache:
79
- return self._sorted_subscribers_cache[event]
80
-
81
- # 获取有效的订阅者(使用弱引用检查)
82
- valid_subscribers = {}
83
- for receiver, priority in list(self._subscribers[event].items()):
84
- # 检查弱引用是否仍然有效
85
- if isinstance(receiver, Callable):
86
- valid_subscribers[receiver] = priority
87
-
88
- # 更新订阅者字典
89
- self._subscribers[event] = valid_subscribers
90
-
91
- # 按优先级排序(数值小的优先级高)
92
- sorted_subscribers = sorted(valid_subscribers.items(), key=lambda x: x[1])
93
- # 缓存结果
94
- self._sorted_subscribers_cache[event] = sorted_subscribers
95
-
96
- return sorted_subscribers
97
-
98
- async def notify(self, event: str, *args, **kwargs) -> List[Any]:
99
- """
100
- 异步地、并发地通知所有订阅了该事件的接收者。
101
-
102
- 此方法会等待所有订阅者任务完成后再返回,并收集所有结果或异常。
103
- 订阅者按优先级顺序执行,优先级高的先执行。
104
-
105
- Args:
106
- event: 要触发的事件名称。
107
- *args: 传递给接收者的位置参数。
108
- **kwargs: 传递给接收者的关键字参数。
109
-
110
- Returns:
111
- 一个列表,包含每个订阅者任务的返回结果或在执行期间捕获的异常。
112
- """
113
- sorted_subscribers = self._get_sorted_subscribers(event)
114
- if not sorted_subscribers:
115
- return []
116
-
117
- # 为频繁触发的事件重用任务对象以提高性能
118
- tasks = []
119
- for receiver, _ in sorted_subscribers:
120
- try:
121
- # 创建任务并添加到列表
122
- task = asyncio.create_task(receiver(*args, **kwargs))
123
- tasks.append(task)
124
- except Exception as e:
125
- # 如果创建任务失败,记录异常并继续处理其他订阅者
126
- tasks.append(asyncio.Future()) # 添加一个已完成的Future表示错误
127
- tasks[-1].set_exception(e)
128
-
129
- # 并发执行所有任务并返回结果列表(包括异常)
1
+ #!/usr/bin/python
2
+ # -*- coding:UTF-8 -*-
3
+ import asyncio
4
+ from collections import defaultdict
5
+ from inspect import iscoroutinefunction
6
+ from typing import Dict, Callable, Coroutine, Any, TypeAlias, List, Tuple
7
+
8
+
9
+ class ReceiverTypeError(TypeError):
10
+ """当订阅的接收者不是一个协程函数时抛出。"""
11
+ pass
12
+
13
+
14
+ ReceiverCoroutine: TypeAlias = Callable[..., Coroutine[Any, Any, Any]]
15
+
16
+
17
+ class Subscriber:
18
+ """
19
+ 一个支持异步协程的发布/订阅(Pub/Sub)模式实现。
20
+
21
+ 这个类允许你注册(订阅)协程函数来监听特定事件,并在事件发生时
22
+ 以并发的方式异步地通知所有订阅者。
23
+ """
24
+
25
+ def __init__(self):
26
+ """初始化一个空的订阅者字典。"""
27
+ # 使用弱引用字典避免内存泄漏
28
+ self._subscribers: Dict[str, Dict[ReceiverCoroutine, int]] = defaultdict(dict)
29
+ # 用于缓存排序后的订阅者列表,提高频繁事件的处理性能
30
+ self._sorted_subscribers_cache: Dict[str, List[Tuple[ReceiverCoroutine, int]]] = {}
31
+
32
+ def subscribe(self, receiver: ReceiverCoroutine, *, event: str, priority: int = 0) -> None:
33
+ """
34
+ 订阅一个事件。
35
+
36
+ Args:
37
+ receiver: 一个协程函数 (例如 async def my_func(...))。
38
+ event: 要订阅的事件名称。
39
+ priority: 订阅者优先级,数值越小优先级越高,默认为0。
40
+
41
+ Raises:
42
+ ReceiverTypeError: 如果提供的 `receiver` 不是一个协程函数。
43
+ """
44
+ if not iscoroutinefunction(receiver):
45
+ raise ReceiverTypeError(f"接收者 '{receiver.__qualname__}' 必须是一个协程函数。")
46
+
47
+ # 使用弱引用避免内存泄漏
48
+ self._subscribers[event][receiver] = priority
49
+ # 清除缓存
50
+ self._sorted_subscribers_cache.pop(event, None)
51
+
52
+ def unsubscribe(self, receiver: ReceiverCoroutine, *, event: str) -> None:
53
+ """
54
+ 取消订阅一个事件。
55
+
56
+ 如果事件或接收者不存在,将静默处理。
57
+
58
+ Args:
59
+ receiver: 要取消订阅的协程函数。
60
+ event: 事件名称。
61
+ """
62
+ if event in self._subscribers:
63
+ self._subscribers[event].pop(receiver, None)
64
+ # 清除缓存
65
+ self._sorted_subscribers_cache.pop(event, None)
66
+
67
+ def _get_sorted_subscribers(self, event: str) -> List[Tuple[ReceiverCoroutine, int]]:
68
+ """
69
+ 获取按优先级排序的订阅者列表。
70
+
71
+ Args:
72
+ event: 事件名称。
73
+
74
+ Returns:
75
+ 按优先级排序的订阅者列表。
76
+ """
77
+ # 检查缓存
78
+ if event in self._sorted_subscribers_cache:
79
+ return self._sorted_subscribers_cache[event]
80
+
81
+ # 获取有效的订阅者(使用弱引用检查)
82
+ valid_subscribers = {}
83
+ for receiver, priority in list(self._subscribers[event].items()):
84
+ # 检查弱引用是否仍然有效
85
+ if isinstance(receiver, Callable):
86
+ valid_subscribers[receiver] = priority
87
+
88
+ # 更新订阅者字典
89
+ self._subscribers[event] = valid_subscribers
90
+
91
+ # 按优先级排序(数值小的优先级高)
92
+ sorted_subscribers = sorted(valid_subscribers.items(), key=lambda x: x[1])
93
+ # 缓存结果
94
+ self._sorted_subscribers_cache[event] = sorted_subscribers
95
+
96
+ return sorted_subscribers
97
+
98
+ async def notify(self, event: str, *args, **kwargs) -> List[Any]:
99
+ """
100
+ 异步地、并发地通知所有订阅了该事件的接收者。
101
+
102
+ 此方法会等待所有订阅者任务完成后再返回,并收集所有结果或异常。
103
+ 订阅者按优先级顺序执行,优先级高的先执行。
104
+
105
+ Args:
106
+ event: 要触发的事件名称。
107
+ *args: 传递给接收者的位置参数。
108
+ **kwargs: 传递给接收者的关键字参数。
109
+
110
+ Returns:
111
+ 一个列表,包含每个订阅者任务的返回结果或在执行期间捕获的异常。
112
+ """
113
+ sorted_subscribers = self._get_sorted_subscribers(event)
114
+ if not sorted_subscribers:
115
+ return []
116
+
117
+ # 为频繁触发的事件重用任务对象以提高性能
118
+ tasks = []
119
+ for receiver, _ in sorted_subscribers:
120
+ try:
121
+ # 创建任务并添加到列表
122
+ task = asyncio.create_task(receiver(*args, **kwargs))
123
+ tasks.append(task)
124
+ except Exception as e:
125
+ # 如果创建任务失败,记录异常并继续处理其他订阅者
126
+ tasks.append(asyncio.Future()) # 添加一个已完成的Future表示错误
127
+ tasks[-1].set_exception(e)
128
+
129
+ # 并发执行所有任务并返回结果列表(包括异常)
130
130
  return await asyncio.gather(*tasks, return_exceptions=True)