crawlo 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

crawlo/pipelines/console_pipeline.py

@@ -1,40 +1,40 @@
-#!/usr/bin/python
-# -*- coding:UTF-8 -*-
-from typing import Dict, Any
-
-from crawlo import Item
-from crawlo.spider import Spider
-from crawlo.utils.log import get_logger
-
-
-class ConsolePipeline:
-    """将Item内容输出到控制台的管道"""
-
-    def __init__(self, log_level: str = "DEBUG"):
-        self.logger = get_logger(self.__class__.__name__, log_level)
-
-    @classmethod
-    def from_crawler(cls, crawler):
-        """从crawler实例创建管道"""
-        return cls(
-            log_level=crawler.settings.get('LOG_LEVEL', 'DEBUG')
-        )
-
-    async def process_item(self, item: Item, spider: Spider) -> Item:
-        """处理Item并输出到日志"""
-        try:
-            item_dict = self._convert_to_serializable(item)
-            self.logger.info(f"Item processed: {item_dict}")
-            return item
-        except Exception as e:
-            self.logger.error(f"Error processing item: {e}", exc_info=True)
-            raise
-
-    @staticmethod
-    def _convert_to_serializable(item: Item) -> Dict[str, Any]:
-        """将Item转换为可序列化的字典"""
-        try:
-            return item.to_dict()
-        except AttributeError:
-            # 兼容没有to_dict方法的Item实现
+#!/usr/bin/python
+# -*- coding:UTF-8 -*-
+from typing import Dict, Any
+
+from crawlo import Item
+from crawlo.spider import Spider
+from crawlo.utils.log import get_logger
+
+
+class ConsolePipeline:
+    """将Item内容输出到控制台的管道"""
+
+    def __init__(self, log_level: str = "DEBUG"):
+        self.logger = get_logger(self.__class__.__name__, log_level)
+
+    @classmethod
+    def from_crawler(cls, crawler):
+        """从crawler实例创建管道"""
+        return cls(
+            log_level=crawler.settings.get('LOG_LEVEL', 'DEBUG')
+        )
+
+    async def process_item(self, item: Item, spider: Spider) -> Item:
+        """处理Item并输出到日志"""
+        try:
+            item_dict = self._convert_to_serializable(item)
+            self.logger.info(f"Item processed: {item_dict}")
+            return item
+        except Exception as e:
+            self.logger.error(f"Error processing item: {e}", exc_info=True)
+            raise
+
+    @staticmethod
+    def _convert_to_serializable(item: Item) -> Dict[str, Any]:
+        """将Item转换为可序列化的字典"""
+        try:
+            return item.to_dict()
+        except AttributeError:
+            # 兼容没有to_dict方法的Item实现
             return dict(item)

crawlo/pipelines/csv_pipeline.py

@@ -0,0 +1,317 @@
+# -*- coding: utf-8 -*-
+import csv
+import asyncio
+from pathlib import Path
+from typing import Optional, List
+from datetime import datetime
+from crawlo.utils.log import get_logger
+from crawlo.exceptions import ItemDiscard
+
+
+class CsvPipeline:
+    """CSV文件输出管道"""
+    
+    def __init__(self, crawler):
+        self.crawler = crawler
+        self.settings = crawler.settings
+        self.logger = get_logger(self.__class__.__name__, self.settings.get('LOG_LEVEL'))
+        
+        # 配置文件路径
+        self.file_path = self._get_file_path()
+        self.file_handle = None
+        self.csv_writer = None
+        self.headers_written = False
+        self.lock = asyncio.Lock()  # 异步锁保证线程安全
+        
+        # CSV配置
+        self.delimiter = self.settings.get('CSV_DELIMITER', ',')
+        self.quotechar = self.settings.get('CSV_QUOTECHAR', '"')
+        self.include_headers = self.settings.get_bool('CSV_INCLUDE_HEADERS', True)
+        
+        # 注册关闭事件
+        crawler.subscriber.subscribe(self.spider_closed, event='spider_closed')
+        
+    @classmethod
+    def from_crawler(cls, crawler):
+        return cls(crawler)
+    
+    def _get_file_path(self) -> Path:
+        """获取输出文件路径"""
+        file_path = (
+            self.settings.get('CSV_FILE') or
+            getattr(self.crawler.spider, 'csv_file', None) or
+            f"output/{self.crawler.spider.name}_{datetime.now().strftime('%Y%m%d_%H%M%S')}.csv"
+        )
+        
+        path = Path(file_path)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        return path
+    
+    async def _ensure_file_open(self):
+        """确保文件已打开"""
+        if self.file_handle is None:
+            self.file_handle = open(self.file_path, 'w', newline='', encoding='utf-8')
+            self.csv_writer = csv.writer(
+                self.file_handle,
+                delimiter=self.delimiter,
+                quotechar=self.quotechar,
+                quoting=csv.QUOTE_MINIMAL
+            )
+            self.logger.info(f"CSV文件已创建: {self.file_path}")
+    
+    async def _write_headers(self, item_dict: dict):
+        """写入CSV表头"""
+        if not self.headers_written and self.include_headers:
+            headers = list(item_dict.keys())
+            self.csv_writer.writerow(headers)
+            self.headers_written = True
+            self.logger.debug(f"CSV表头已写入: {headers}")
+    
+    async def process_item(self, item, spider) -> Optional[dict]:
+        """处理item的核心方法"""
+        try:
+            async with self.lock:
+                await self._ensure_file_open()
+                
+                # 转换为字典
+                item_dict = dict(item)
+                
+                # 写入表头（仅第一次）
+                await self._write_headers(item_dict)
+                
+                # 写入数据行
+                values = [str(v) if v is not None else '' for v in item_dict.values()]
+                self.csv_writer.writerow(values)
+                self.file_handle.flush()  # 立即刷新到磁盘
+                
+                # 统计
+                self.crawler.stats.inc_value('csv_pipeline/items_written')
+                self.logger.debug(f"写入CSV行: {len(item_dict)} 字段")
+                
+            return item
+            
+        except Exception as e:
+            self.crawler.stats.inc_value('csv_pipeline/items_failed')
+            self.logger.error(f"CSV写入失败: {e}")
+            raise ItemDiscard(f"CSV Pipeline处理失败: {e}")
+    
+    async def spider_closed(self):
+        """关闭爬虫时清理资源"""
+        if self.file_handle:
+            self.file_handle.close()
+            self.logger.info(f"CSV文件已关闭: {self.file_path}")
+
+
+class CsvDictPipeline:
+    """CSV字典写入器管道（使用DictWriter，支持字段映射）"""
+    
+    def __init__(self, crawler):
+        self.crawler = crawler
+        self.settings = crawler.settings
+        self.logger = get_logger(self.__class__.__name__, self.settings.get('LOG_LEVEL'))
+        
+        self.file_path = self._get_file_path()
+        self.file_handle = None
+        self.csv_writer = None
+        self.fieldnames = None
+        self.headers_written = False
+        self.lock = asyncio.Lock()
+        
+        # 配置选项
+        self.delimiter = self.settings.get('CSV_DELIMITER', ',')
+        self.quotechar = self.settings.get('CSV_QUOTECHAR', '"')
+        self.include_headers = self.settings.get_bool('CSV_INCLUDE_HEADERS', True)
+        self.extrasaction = self.settings.get('CSV_EXTRASACTION', 'ignore')  # ignore, raise
+        
+        crawler.subscriber.subscribe(self.spider_closed, event='spider_closed')
+        
+    @classmethod
+    def from_crawler(cls, crawler):
+        return cls(crawler)
+    
+    def _get_file_path(self) -> Path:
+        """获取输出文件路径"""
+        file_path = (
+            self.settings.get('CSV_DICT_FILE') or
+            getattr(self.crawler.spider, 'csv_dict_file', None) or
+            f"output/{self.crawler.spider.name}_{datetime.now().strftime('%Y%m%d_%H%M%S')}_dict.csv"
+        )
+        
+        path = Path(file_path)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        return path
+    
+    def _get_fieldnames(self, item_dict: dict) -> List[str]:
+        """获取字段名列表"""
+        # 优先使用配置的字段名
+        configured_fields = self.settings.get('CSV_FIELDNAMES')
+        if configured_fields:
+            return configured_fields if isinstance(configured_fields, list) else configured_fields.split(',')
+        
+        # 使用爬虫定义的字段名
+        spider_fields = getattr(self.crawler.spider, 'csv_fieldnames', None)
+        if spider_fields:
+            return spider_fields if isinstance(spider_fields, list) else spider_fields.split(',')
+        
+        # 使用item的字段名
+        return list(item_dict.keys())
+    
+    async def _ensure_file_open(self, item_dict: dict):
+        """确保文件已打开"""
+        if self.file_handle is None:
+            self.fieldnames = self._get_fieldnames(item_dict)
+            
+            self.file_handle = open(self.file_path, 'w', newline='', encoding='utf-8')
+            self.csv_writer = csv.DictWriter(
+                self.file_handle,
+                fieldnames=self.fieldnames,
+                delimiter=self.delimiter,
+                quotechar=self.quotechar,
+                quoting=csv.QUOTE_MINIMAL,
+                extrasaction=self.extrasaction
+            )
+            
+            # 写入表头
+            if self.include_headers:
+                self.csv_writer.writeheader()
+                self.headers_written = True
+            
+            self.logger.info(f"CSV字典文件已创建: {self.file_path}，字段: {self.fieldnames}")
+    
+    async def process_item(self, item, spider) -> Optional[dict]:
+        """处理item方法"""
+        try:
+            async with self.lock:
+                item_dict = dict(item)
+                await self._ensure_file_open(item_dict)
+                
+                # 写入数据行
+                self.csv_writer.writerow(item_dict)
+                self.file_handle.flush()
+                
+                self.crawler.stats.inc_value('csv_dict_pipeline/items_written')
+                self.logger.debug(f"写入CSV字典行，字段数: {len(item_dict)}")
+                
+            return item
+            
+        except Exception as e:
+            self.crawler.stats.inc_value('csv_dict_pipeline/items_failed')
+            self.logger.error(f"CSV字典写入失败: {e}")
+            raise ItemDiscard(f"CSV Dict Pipeline处理失败: {e}")
+    
+    async def spider_closed(self):
+        """资源清理"""
+        if self.file_handle:
+            self.file_handle.close()
+            self.logger.info(f"CSV字典文件已关闭: {self.file_path}")
+
+
+class CsvBatchPipeline:
+    """CSV批量写入管道（内存缓存，批量写入，提高性能）"""
+    
+    def __init__(self, crawler):
+        self.crawler = crawler
+        self.settings = crawler.settings
+        self.logger = get_logger(self.__class__.__name__, self.settings.get('LOG_LEVEL'))
+        
+        self.file_path = self._get_file_path()
+        self.file_handle = None
+        self.csv_writer = None
+        self.batch_buffer = []
+        self.headers_written = False
+        self.lock = asyncio.Lock()
+        
+        # 批量配置
+        self.batch_size = self.settings.get_int('CSV_BATCH_SIZE', 100)
+        self.delimiter = self.settings.get('CSV_DELIMITER', ',')
+        self.quotechar = self.settings.get('CSV_QUOTECHAR', '"')
+        self.include_headers = self.settings.get_bool('CSV_INCLUDE_HEADERS', True)
+        
+        crawler.subscriber.subscribe(self.spider_closed, event='spider_closed')
+        
+    @classmethod
+    def from_crawler(cls, crawler):
+        return cls(crawler)
+    
+    def _get_file_path(self) -> Path:
+        """获取输出文件路径"""
+        file_path = (
+            self.settings.get('CSV_BATCH_FILE') or
+            getattr(self.crawler.spider, 'csv_batch_file', None) or
+            f"output/{self.crawler.spider.name}_{datetime.now().strftime('%Y%m%d_%H%M%S')}_batch.csv"
+        )
+        
+        path = Path(file_path)
+        path.parent.mkdir(parents=True, exist_ok=True)
+        return path
+    
+    async def _ensure_file_open(self):
+        """确保文件已打开"""
+        if self.file_handle is None:
+            self.file_handle = open(self.file_path, 'w', newline='', encoding='utf-8')
+            self.csv_writer = csv.writer(
+                self.file_handle,
+                delimiter=self.delimiter,
+                quotechar=self.quotechar,
+                quoting=csv.QUOTE_MINIMAL
+            )
+            self.logger.info(f"CSV批量文件已创建: {self.file_path}")
+    
+    async def _flush_batch(self):
+        """刷新批量缓存到文件"""
+        if not self.batch_buffer:
+            return
+        
+        await self._ensure_file_open()
+        
+        for row in self.batch_buffer:
+            self.csv_writer.writerow(row)
+        
+        self.file_handle.flush()
+        items_count = len(self.batch_buffer)
+        self.batch_buffer.clear()
+        
+        self.crawler.stats.inc_value('csv_batch_pipeline/batches_written')
+        self.crawler.stats.inc_value('csv_batch_pipeline/items_written', count=items_count)
+        self.logger.info(f"批量写入 {items_count} 行到CSV文件")
+    
+    async def process_item(self, item, spider) -> Optional[dict]:
+        """处理item方法"""
+        try:
+            async with self.lock:
+                item_dict = dict(item)
+                
+                # 写入表头（仅第一次）
+                if not self.headers_written and self.include_headers:
+                    headers = list(item_dict.keys())
+                    self.batch_buffer.append(headers)
+                    self.headers_written = True
+                
+                # 添加数据到缓存
+                values = [str(v) if v is not None else '' for v in item_dict.values()]
+                self.batch_buffer.append(values)
+                
+                # 检查是否需要刷新批量缓存
+                if len(self.batch_buffer) >= self.batch_size:
+                    await self._flush_batch()
+                
+            return item
+            
+        except Exception as e:
+            self.crawler.stats.inc_value('csv_batch_pipeline/items_failed')
+            self.logger.error(f"CSV批量处理失败: {e}")
+            raise ItemDiscard(f"CSV Batch Pipeline处理失败: {e}")
+    
+    async def spider_closed(self):
+        """关闭时刷新剩余缓存"""
+        try:
+            # 刷新剩余的批量数据
+            async with self.lock:
+                await self._flush_batch()
+            
+            if self.file_handle:
+                self.file_handle.close()
+                self.logger.info(f"CSV批量文件已关闭: {self.file_path}")
+                
+        except Exception as e:
+            self.logger.error(f"关闭CSV批量管道时出错: {e}")

crawlo/pipelines/database_dedup_pipeline.py

@@ -0,0 +1,225 @@
+#!/usr/bin/python
+# -*- coding:UTF-8 -*-
+"""
+基于数据库的数据项去重管道
+=======================
+提供持久化去重功能，适用于需要长期运行或断点续爬的场景。
+
+特点:
+- 持久化存储: 重启爬虫后仍能保持去重状态
+- 可靠性高: 数据库事务保证一致性
+- 适用性广: 支持多种数据库后端
+- 可扩展: 支持自定义表结构和字段
+"""
+
+import hashlib
+from typing import Dict, Any, Optional
+import aiomysql
+
+from crawlo import Item
+from crawlo.spider import Spider
+from crawlo.utils.log import get_logger
+from crawlo.exceptions import DropItem
+
+
+class DatabaseDedupPipeline:
+    """基于数据库的数据项去重管道"""
+
+    def __init__(
+            self,
+            db_host: str = 'localhost',
+            db_port: int = 3306,
+            db_user: str = 'root',
+            db_password: str = '',
+            db_name: str = 'crawlo',
+            table_name: str = 'item_fingerprints',
+            log_level: str = "INFO"
+    ):
+        """
+        初始化数据库去重管道
+        
+        :param db_host: 数据库主机地址
+        :param db_port: 数据库端口
+        :param db_user: 数据库用户名
+        :param db_password: 数据库密码
+        :param db_name: 数据库名称
+        :param table_name: 存储指纹的表名
+        :param log_level: 日志级别
+        """
+        self.logger = get_logger(self.__class__.__name__, log_level)
+        
+        # 数据库连接参数
+        self.db_config = {
+            'host': db_host,
+            'port': db_port,
+            'user': db_user,
+            'password': db_password,
+            'db': db_name,
+            'autocommit': False
+        }
+        
+        self.table_name = table_name
+        self.dropped_count = 0
+        self.connection = None
+        self.pool = None
+
+    @classmethod
+    def from_crawler(cls, crawler):
+        """从爬虫配置创建管道实例"""
+        settings = crawler.settings
+        
+        return cls(
+            db_host=settings.get('DB_HOST', 'localhost'),
+            db_port=settings.getint('DB_PORT', 3306),
+            db_user=settings.get('DB_USER', 'root'),
+            db_password=settings.get('DB_PASSWORD', ''),
+            db_name=settings.get('DB_NAME', 'crawlo'),
+            table_name=settings.get('DB_DEDUP_TABLE', 'item_fingerprints'),
+            log_level=settings.get('LOG_LEVEL', 'INFO')
+        )
+
+    async def open_spider(self, spider: Spider) -> None:
+        """
+        爬虫启动时初始化数据库连接
+        
+        :param spider: 爬虫实例
+        """
+        try:
+            # 创建连接池
+            self.pool = await aiomysql.create_pool(
+                **self.db_config,
+                minsize=2,
+                maxsize=10
+            )
+            
+            # 创建去重表（如果不存在）
+            await self._create_dedup_table()
+            
+            self.logger.info(f"数据库去重管道初始化完成: {self.db_config['host']}:{self.db_config['port']}/{self.db_config['db']}.{self.table_name}")
+        except Exception as e:
+            self.logger.error(f"数据库去重管道初始化失败: {e}")
+            raise RuntimeError(f"数据库去重管道初始化失败: {e}")
+
+    async def _create_dedup_table(self) -> None:
+        """创建去重表"""
+        create_table_sql = f"""
+        CREATE TABLE IF NOT EXISTS `{self.table_name}` (
+            `id` BIGINT AUTO_INCREMENT PRIMARY KEY,
+            `fingerprint` VARCHAR(64) NOT NULL UNIQUE,
+            `created_at` TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+            INDEX `idx_fingerprint` (`fingerprint`)
+        ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci
+        """
+        
+        async with self.pool.acquire() as conn:
+            async with conn.cursor() as cursor:
+                await cursor.execute(create_table_sql)
+                await conn.commit()
+
+    async def process_item(self, item: Item, spider: Spider) -> Item:
+        """
+        处理数据项，进行去重检查
+        
+        :param item: 要处理的数据项
+        :param spider: 爬虫实例
+        :return: 处理后的数据项或抛出 DropItem 异常
+        """
+        try:
+            # 生成数据项指纹
+            fingerprint = self._generate_item_fingerprint(item)
+            
+            # 检查指纹是否已存在
+            exists = await self._check_fingerprint_exists(fingerprint)
+            
+            if exists:
+                # 如果已存在，丢弃这个数据项
+                self.dropped_count += 1
+                self.logger.debug(f"丢弃重复数据项: {fingerprint[:20]}...")
+                raise DropItem(f"重复的数据项: {fingerprint}")
+            else:
+                # 记录新数据项的指纹
+                await self._insert_fingerprint(fingerprint)
+                self.logger.debug(f"处理新数据项: {fingerprint[:20]}...")
+                return item
+                
+        except Exception as e:
+            self.logger.error(f"处理数据项时出错: {e}")
+            # 在错误时继续处理，避免丢失数据
+            return item
+
+    async def _check_fingerprint_exists(self, fingerprint: str) -> bool:
+        """
+        检查指纹是否已存在
+        
+        :param fingerprint: 数据项指纹
+        :return: 是否存在
+        """
+        check_sql = f"SELECT 1 FROM `{self.table_name}` WHERE `fingerprint` = %s LIMIT 1"
+        
+        async with self.pool.acquire() as conn:
+            async with conn.cursor() as cursor:
+                await cursor.execute(check_sql, (fingerprint,))
+                result = await cursor.fetchone()
+                return result is not None
+
+    async def _insert_fingerprint(self, fingerprint: str) -> None:
+        """
+        插入新指纹
+        
+        :param fingerprint: 数据项指纹
+        """
+        insert_sql = f"INSERT INTO `{self.table_name}` (`fingerprint`) VALUES (%s)"
+        
+        async with self.pool.acquire() as conn:
+            async with conn.cursor() as cursor:
+                try:
+                    await cursor.execute(insert_sql, (fingerprint,))
+                    await conn.commit()
+                except aiomysql.IntegrityError:
+                    # 指纹已存在（并发情况下可能发生）
+                    await conn.rollback()
+                    raise DropItem(f"重复的数据项: {fingerprint}")
+                except Exception:
+                    await conn.rollback()
+                    raise
+
+    def _generate_item_fingerprint(self, item: Item) -> str:
+        """
+        生成数据项指纹
+        
+        基于数据项的所有字段生成唯一指纹，用于去重判断。
+        
+        :param item: 数据项
+        :return: 指纹字符串
+        """
+        # 将数据项转换为可序列化的字典
+        try:
+            item_dict = item.to_dict()
+        except AttributeError:
+            # 兼容没有to_dict方法的Item实现
+            item_dict = dict(item)
+        
+        # 对字典进行排序以确保一致性
+        sorted_items = sorted(item_dict.items())
+        
+        # 生成指纹字符串
+        fingerprint_string = '|'.join([f"{k}={v}" for k, v in sorted_items if v is not None])
+        
+        # 使用 SHA256 生成固定长度的指纹
+        return hashlib.sha256(fingerprint_string.encode('utf-8')).hexdigest()
+
+    async def close_spider(self, spider: Spider) -> None:
+        """
+        爬虫关闭时的清理工作
+        
+        :param spider: 爬虫实例
+        """
+        try:
+            if self.pool:
+                self.pool.close()
+                await self.pool.wait_closed()
+                
+            self.logger.info(f"爬虫 {spider.name} 关闭:")
+            self.logger.info(f"  - 丢弃的重复数据项: {self.dropped_count}")
+        except Exception as e:
+            self.logger.error(f"关闭爬虫时出错: {e}")