crawlo 1.1.8__py3-none-any.whl → 1.2.0__py3-none-any.whl

crawlo/network/request.py

@@ -1,339 +1,339 @@
-#!/usr/bin/python
-# -*- coding: UTF-8 -*-
-"""
-HTTP Request 封装模块
-====================
-提供功能完善的HTTP请求封装，支持:
-- JSON/表单数据自动处理
-- 优先级排序机制
-- 安全的深拷贝操作
-- 灵活的请求配置
-"""
-import json
-from copy import deepcopy
-from urllib.parse import urlencode
-from w3lib.url import safe_url_string
-from typing import Dict, Optional, Callable, Union, Any, TypeVar, List
-
-from crawlo.utils.url import escape_ajax
-
-
-_Request = TypeVar("_Request", bound="Request")
-
-
-class RequestPriority:
-    """请求优先级常量和工具类"""
-    URGENT = -200      # 紧急任务
-    HIGH = -100        # 高优先级  
-    NORMAL = 0         # 正常优先级(默认)
-    LOW = 100          # 低优先级
-    BACKGROUND = 200   # 后台任务
-    
-    @classmethod
-    def get_all_priorities(cls) -> Dict[str, int]:
-        """获取所有优先级常量"""
-        return {
-            'URGENT': cls.URGENT,
-            'HIGH': cls.HIGH,
-            'NORMAL': cls.NORMAL,
-            'LOW': cls.LOW,
-            'BACKGROUND': cls.BACKGROUND
-        }
-    
-    @classmethod
-    def from_string(cls, priority_str: str) -> int:
-        """从字符串获取优先级值"""
-        priorities = cls.get_all_priorities()
-        if priority_str.upper() not in priorities:
-            raise ValueError(f"不支持的优先级: {priority_str}, 支持: {list(priorities.keys())}")
-        return priorities[priority_str.upper()]
-
-
-class Request:
-    """
-    封装一个 HTTP 请求对象，用于爬虫框架中表示一个待抓取的请求任务。
-    支持 JSON、表单、原始 body 提交，自动处理 Content-Type 与编码。
-    不支持文件上传（multipart/form-data），保持轻量。
-    """
-
-    __slots__ = (
-        '_url',
-        '_meta',
-        'callback',
-        'cb_kwargs',
-        'err_back',
-        'headers',
-        'body',
-        'method',
-        'cookies',
-        'priority',
-        'encoding',
-        'dont_filter',
-        'timeout',
-        'proxy',
-        'allow_redirects',
-        'auth',
-        'verify',
-        'flags',
-        '_json_body',
-        '_form_data',
-        'use_dynamic_loader',
-        'dynamic_loader_options'
-    )
-
-    def __init__(
-        self,
-        url: str,
-        callback: Optional[Callable] = None,
-        method: Optional[str] = 'GET',
-        headers: Optional[Dict[str, str]] = None,
-        body: Optional[Union[bytes, str, Dict[Any, Any]]] = None,
-        form_data: Optional[Dict[Any, Any]] = None,
-        json_body: Optional[Dict[Any, Any]] = None,
-        cb_kwargs: Optional[Dict[str, Any]] = None,
-        cookies: Optional[Dict[str, str]] = None,
-        meta: Optional[Dict[str, Any]] = None,
-        priority: int = RequestPriority.NORMAL,
-        dont_filter: bool = False,
-        timeout: Optional[float] = None,
-        proxy: Optional[str] = None,
-        allow_redirects: bool = True,
-        auth: Optional[tuple] = None,
-        verify: bool = True,
-        flags: Optional[List[str]] = None,
-        encoding: str = 'utf-8',
-        # 动态加载相关参数
-        use_dynamic_loader: bool = False,
-        dynamic_loader_options: Optional[Dict[str, Any]] = None
-    ):
-        """
-        初始化请求对象。
-
-        :param url: 请求 URL（必须）
-        :param callback: 成功回调函数
-        :param method: HTTP 方法，默认 GET
-        :param headers: 请求头
-        :param body: 原始请求体（bytes/str），若为 dict 且未使用 json_body/form_data，则自动转为 JSON
-        :param form_data: 表单数据，自动转为 application/x-www-form-urlencoded
-        :param json_body: JSON 数据，自动序列化并设置 Content-Type
-        :param cb_kwargs: 传递给 callback 的额外参数
-        :param cookies: Cookies 字典
-        :param meta: 元数据（跨中间件传递数据）
-        :param priority: 优先级（数值越小越优先）
-        :param dont_filter: 是否跳过去重
-        :param timeout: 超时时间（秒）
-        :param proxy: 代理地址，如 http://127.0.0.1:8080
-        :param allow_redirects: 是否允许重定向
-        :param auth: 认证元组 (username, password)
-        :param verify: 是否验证 SSL 证书
-        :param flags: 标记（用于调试或分类）
-        :param encoding: 字符编码，默认 utf-8
-        """
-        self.callback = callback
-        self.method = str(method).upper()
-        self.headers = headers or {}
-        self.cookies = cookies or {}
-        self.priority = -priority  # 用于排序：值越小优先级越高
-        
-        # 🔧 安全处理 meta，移除 logger 后再 deepcopy
-        self._meta = self._safe_deepcopy_meta(meta) if meta is not None else {}
-        
-        self.timeout = self._meta.get('download_timeout', timeout)
-        self.proxy = proxy
-        self.allow_redirects = allow_redirects
-        self.auth = auth
-        self.verify = verify
-        self.flags = flags or []
-        self.encoding = encoding
-        self.cb_kwargs = cb_kwargs or {}
-        self.body = body
-        # 保存高层语义参数（用于 copy）
-        self._json_body = json_body
-        self._form_data = form_data
-        
-        # 动态加载相关属性
-        self.use_dynamic_loader = use_dynamic_loader
-        self.dynamic_loader_options = dynamic_loader_options or {}
-
-        # 构建 body
-        if json_body is not None:
-            if 'Content-Type' not in self.headers:
-                self.headers['Content-Type'] = 'application/json'
-            self.body = json.dumps(json_body, ensure_ascii=False).encode(encoding)
-            if self.method == 'GET':
-                self.method = 'POST'
-
-        elif form_data is not None:
-            if self.method == 'GET':
-                self.method = 'POST'
-            if 'Content-Type' not in self.headers:
-                self.headers['Content-Type'] = 'application/x-www-form-urlencoded'
-            query_str = urlencode(form_data)
-            self.body = query_str.encode(encoding)  # ✅ 显式编码为 bytes
-
-
-        else:
-            # 处理原始 body
-            if isinstance(self.body, dict):
-                if 'Content-Type' not in self.headers:
-                    self.headers['Content-Type'] = 'application/json'
-                self.body = json.dumps(self.body, ensure_ascii=False).encode(encoding)
-            elif isinstance(self.body, str):
-                self.body = self.body.encode(encoding)
-
-        self.dont_filter = dont_filter
-        self._set_url(url)
-
-    @staticmethod
-    def _safe_deepcopy_meta(meta: Dict[str, Any]) -> Dict[str, Any]:
-        """安全地 deepcopy meta，移除 logger 后再复制"""
-        import logging
-        
-        def clean_logger_recursive(obj):
-            """递归移除 logger 对象"""
-            if isinstance(obj, logging.Logger):
-                return None
-            elif isinstance(obj, dict):
-                cleaned = {}
-                for k, v in obj.items():
-                    if not (k == 'logger' or isinstance(v, logging.Logger)):
-                        cleaned[k] = clean_logger_recursive(v)
-                return cleaned
-            elif isinstance(obj, (list, tuple)):
-                cleaned_list = []
-                for item in obj:
-                    cleaned_item = clean_logger_recursive(item)
-                    if cleaned_item is not None:
-                        cleaned_list.append(cleaned_item)
-                return type(obj)(cleaned_list)
-            else:
-                return obj
-        
-        # 先清理 logger，再 deepcopy
-        cleaned_meta = clean_logger_recursive(meta)
-        return deepcopy(cleaned_meta)
-
-    def copy(self: _Request) -> _Request:
-        """
-        创建当前请求的副本，保留所有高层语义（json_body/form_data）。
-        """
-        return type(self)(
-            url=self.url,
-            callback=self.callback,
-            method=self.method,
-            headers=self.headers.copy(),
-            body=None,  # 由 form_data/json_body 重新生成
-            form_data=self._form_data,
-            json_body=self._json_body,
-            cb_kwargs=deepcopy(self.cb_kwargs),
-            err_back=self.err_back,
-            cookies=self.cookies.copy(),
-            meta=deepcopy(self._meta),
-            priority=-self.priority,
-            dont_filter=self.dont_filter,
-            timeout=self.timeout,
-            proxy=self.proxy,
-            allow_redirects=self.allow_redirects,
-            auth=self.auth,
-            verify=self.verify,
-            flags=self.flags.copy(),
-            encoding=self.encoding,
-            use_dynamic_loader=self.use_dynamic_loader,
-            dynamic_loader_options=deepcopy(self.dynamic_loader_options)
-        )
-
-    def set_meta(self, key: str, value: Any) -> 'Request':
-        """设置 meta 中的某个键值，支持链式调用。"""
-        self._meta[key] = value
-        return self
-    
-    def add_header(self, key: str, value: str) -> 'Request':
-        """添加请求头，支持链式调用。"""
-        self.headers[key] = value
-        return self
-    
-    def add_headers(self, headers: Dict[str, str]) -> 'Request':
-        """批量添加请求头，支持链式调用。"""
-        self.headers.update(headers)
-        return self
-    
-    def set_proxy(self, proxy: str) -> 'Request':
-        """设置代理，支持链式调用。"""
-        self.proxy = proxy
-        return self
-    
-    def set_timeout(self, timeout: float) -> 'Request':
-        """设置超时时间，支持链式调用。"""
-        self.timeout = timeout
-        return self
-    
-    def add_flag(self, flag: str) -> 'Request':
-        """添加标记，支持链式调用。"""
-        if flag not in self.flags:
-            self.flags.append(flag)
-        return self
-    
-    def remove_flag(self, flag: str) -> 'Request':
-        """移除标记，支持链式调用。"""
-        if flag in self.flags:
-            self.flags.remove(flag)
-        return self
-    
-    def set_dynamic_loader(self, use_dynamic: bool = True, options: Optional[Dict[str, Any]] = None) -> 'Request':
-        """设置使用动态加载器，支持链式调用。"""
-        self.use_dynamic_loader = use_dynamic
-        if options:
-            self.dynamic_loader_options = options
-        # 同时在meta中设置标记，供混合下载器使用
-        self._meta['use_dynamic_loader'] = use_dynamic
-        return self
-    
-    def set_protocol_loader(self) -> 'Request':
-        """强制使用协议加载器，支持链式调用。"""
-        self.use_dynamic_loader = False
-        self._meta['use_dynamic_loader'] = False
-        self._meta['use_protocol_loader'] = True
-        return self
-
-    def _set_url(self, url: str) -> None:
-        """安全设置 URL，确保格式正确。"""
-        if not isinstance(url, str):
-            raise TypeError(f"Request url 必须为字符串，当前类型: {type(url).__name__}")
-        
-        if not url.strip():
-            raise ValueError("URL 不能为空")
-        
-        # 检查危险的 URL scheme
-        dangerous_schemes = ['file://', 'ftp://', 'javascript:', 'data:']
-        if any(url.lower().startswith(scheme) for scheme in dangerous_schemes):
-            raise ValueError(f"URL scheme 不安全: {url[:20]}...")
-
-        s = safe_url_string(url, self.encoding)
-        escaped_url = escape_ajax(s)
-        
-        if not escaped_url.startswith(('http://', 'https://')):
-            raise ValueError(f"URL 缺少 HTTP(S) scheme: {escaped_url[:50]}...")
-        
-        # 检查 URL 长度
-        if len(escaped_url) > 8192:  # 大多数服务器支持的最大 URL 长度
-            raise ValueError(f"URL 过长 (超过 8192 字符): {len(escaped_url)} 字符")
-        
-        self._url = escaped_url
-
-    @property
-    def url(self) -> str:
-        return self._url
-
-    @property
-    def meta(self) -> Dict[str, Any]:
-        return self._meta
-
-    def __str__(self) -> str:
-        return f'<Request url={self.url} method={self.method}>'
-
-    def __repr__(self) -> str:
-        return str(self)
-
-    def __lt__(self, other: _Request) -> bool:
-        """用于按优先级排序"""
+#!/usr/bin/python
+# -*- coding: UTF-8 -*-
+"""
+HTTP Request 封装模块
+====================
+提供功能完善的HTTP请求封装，支持:
+- JSON/表单数据自动处理
+- 优先级排序机制
+- 安全的深拷贝操作
+- 灵活的请求配置
+"""
+import json
+from copy import deepcopy
+from urllib.parse import urlencode
+from w3lib.url import safe_url_string
+from typing import Dict, Optional, Callable, Union, Any, TypeVar, List
+
+from crawlo.utils.url import escape_ajax
+
+
+_Request = TypeVar("_Request", bound="Request")
+
+
+class RequestPriority:
+    """请求优先级常量和工具类"""
+    URGENT = -200      # 紧急任务
+    HIGH = -100        # 高优先级  
+    NORMAL = 0         # 正常优先级(默认)
+    LOW = 100          # 低优先级
+    BACKGROUND = 200   # 后台任务
+    
+    @classmethod
+    def get_all_priorities(cls) -> Dict[str, int]:
+        """获取所有优先级常量"""
+        return {
+            'URGENT': cls.URGENT,
+            'HIGH': cls.HIGH,
+            'NORMAL': cls.NORMAL,
+            'LOW': cls.LOW,
+            'BACKGROUND': cls.BACKGROUND
+        }
+    
+    @classmethod
+    def from_string(cls, priority_str: str) -> int:
+        """从字符串获取优先级值"""
+        priorities = cls.get_all_priorities()
+        if priority_str.upper() not in priorities:
+            raise ValueError(f"不支持的优先级: {priority_str}, 支持: {list(priorities.keys())}")
+        return priorities[priority_str.upper()]
+
+
+class Request:
+    """
+    封装一个 HTTP 请求对象，用于爬虫框架中表示一个待抓取的请求任务。
+    支持 JSON、表单、原始 body 提交，自动处理 Content-Type 与编码。
+    不支持文件上传（multipart/form-data），保持轻量。
+    """
+
+    __slots__ = (
+        '_url',
+        '_meta',
+        'callback',
+        'cb_kwargs',
+        'err_back',
+        'headers',
+        'body',
+        'method',
+        'cookies',
+        'priority',
+        'encoding',
+        'dont_filter',
+        'timeout',
+        'proxy',
+        'allow_redirects',
+        'auth',
+        'verify',
+        'flags',
+        '_json_body',
+        '_form_data',
+        'use_dynamic_loader',
+        'dynamic_loader_options'
+    )
+
+    def __init__(
+        self,
+        url: str,
+        callback: Optional[Callable] = None,
+        method: Optional[str] = 'GET',
+        headers: Optional[Dict[str, str]] = None,
+        body: Optional[Union[bytes, str, Dict[Any, Any]]] = None,
+        form_data: Optional[Dict[Any, Any]] = None,
+        json_body: Optional[Dict[Any, Any]] = None,
+        cb_kwargs: Optional[Dict[str, Any]] = None,
+        cookies: Optional[Dict[str, str]] = None,
+        meta: Optional[Dict[str, Any]] = None,
+        priority: int = RequestPriority.NORMAL,
+        dont_filter: bool = False,
+        timeout: Optional[float] = None,
+        proxy: Optional[str] = None,
+        allow_redirects: bool = True,
+        auth: Optional[tuple] = None,
+        verify: bool = True,
+        flags: Optional[List[str]] = None,
+        encoding: str = 'utf-8',
+        # 动态加载相关参数
+        use_dynamic_loader: bool = False,
+        dynamic_loader_options: Optional[Dict[str, Any]] = None
+    ):
+        """
+        初始化请求对象。
+
+        :param url: 请求 URL（必须）
+        :param callback: 成功回调函数
+        :param method: HTTP 方法，默认 GET
+        :param headers: 请求头
+        :param body: 原始请求体（bytes/str），若为 dict 且未使用 json_body/form_data，则自动转为 JSON
+        :param form_data: 表单数据，自动转为 application/x-www-form-urlencoded
+        :param json_body: JSON 数据，自动序列化并设置 Content-Type
+        :param cb_kwargs: 传递给 callback 的额外参数
+        :param cookies: Cookies 字典
+        :param meta: 元数据（跨中间件传递数据）
+        :param priority: 优先级（数值越小越优先）
+        :param dont_filter: 是否跳过去重
+        :param timeout: 超时时间（秒）
+        :param proxy: 代理地址，如 http://127.0.0.1:8080
+        :param allow_redirects: 是否允许重定向
+        :param auth: 认证元组 (username, password)
+        :param verify: 是否验证 SSL 证书
+        :param flags: 标记（用于调试或分类）
+        :param encoding: 字符编码，默认 utf-8
+        """
+        self.callback = callback
+        self.method = str(method).upper()
+        self.headers = headers or {}
+        self.cookies = cookies or {}
+        self.priority = -priority  # 用于排序：值越小优先级越高
+        
+        # 🔧 安全处理 meta，移除 logger 后再 deepcopy
+        self._meta = self._safe_deepcopy_meta(meta) if meta is not None else {}
+        
+        self.timeout = self._meta.get('download_timeout', timeout)
+        self.proxy = proxy
+        self.allow_redirects = allow_redirects
+        self.auth = auth
+        self.verify = verify
+        self.flags = flags or []
+        self.encoding = encoding
+        self.cb_kwargs = cb_kwargs or {}
+        self.body = body
+        # 保存高层语义参数（用于 copy）
+        self._json_body = json_body
+        self._form_data = form_data
+        
+        # 动态加载相关属性
+        self.use_dynamic_loader = use_dynamic_loader
+        self.dynamic_loader_options = dynamic_loader_options or {}
+
+        # 构建 body
+        if json_body is not None:
+            if 'Content-Type' not in self.headers:
+                self.headers['Content-Type'] = 'application/json'
+            self.body = json.dumps(json_body, ensure_ascii=False).encode(encoding)
+            if self.method == 'GET':
+                self.method = 'POST'
+
+        elif form_data is not None:
+            if self.method == 'GET':
+                self.method = 'POST'
+            if 'Content-Type' not in self.headers:
+                self.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            query_str = urlencode(form_data)
+            self.body = query_str.encode(encoding)  # ✅ 显式编码为 bytes
+
+
+        else:
+            # 处理原始 body
+            if isinstance(self.body, dict):
+                if 'Content-Type' not in self.headers:
+                    self.headers['Content-Type'] = 'application/json'
+                self.body = json.dumps(self.body, ensure_ascii=False).encode(encoding)
+            elif isinstance(self.body, str):
+                self.body = self.body.encode(encoding)
+
+        self.dont_filter = dont_filter
+        self._set_url(url)
+
+    @staticmethod
+    def _safe_deepcopy_meta(meta: Dict[str, Any]) -> Dict[str, Any]:
+        """安全地 deepcopy meta，移除 logger 后再复制"""
+        import logging
+        
+        def clean_logger_recursive(obj):
+            """递归移除 logger 对象"""
+            if isinstance(obj, logging.Logger):
+                return None
+            elif isinstance(obj, dict):
+                cleaned = {}
+                for k, v in obj.items():
+                    if not (k == 'logger' or isinstance(v, logging.Logger)):
+                        cleaned[k] = clean_logger_recursive(v)
+                return cleaned
+            elif isinstance(obj, (list, tuple)):
+                cleaned_list = []
+                for item in obj:
+                    cleaned_item = clean_logger_recursive(item)
+                    if cleaned_item is not None:
+                        cleaned_list.append(cleaned_item)
+                return type(obj)(cleaned_list)
+            else:
+                return obj
+        
+        # 先清理 logger，再 deepcopy
+        cleaned_meta = clean_logger_recursive(meta)
+        return deepcopy(cleaned_meta)
+
+    def copy(self: _Request) -> _Request:
+        """
+        创建当前请求的副本，保留所有高层语义（json_body/form_data）。
+        """
+        return type(self)(
+            url=self.url,
+            callback=self.callback,
+            method=self.method,
+            headers=self.headers.copy(),
+            body=None,  # 由 form_data/json_body 重新生成
+            form_data=self._form_data,
+            json_body=self._json_body,
+            cb_kwargs=deepcopy(self.cb_kwargs),
+            err_back=self.err_back,
+            cookies=self.cookies.copy(),
+            meta=deepcopy(self._meta),
+            priority=-self.priority,
+            dont_filter=self.dont_filter,
+            timeout=self.timeout,
+            proxy=self.proxy,
+            allow_redirects=self.allow_redirects,
+            auth=self.auth,
+            verify=self.verify,
+            flags=self.flags.copy(),
+            encoding=self.encoding,
+            use_dynamic_loader=self.use_dynamic_loader,
+            dynamic_loader_options=deepcopy(self.dynamic_loader_options)
+        )
+
+    def set_meta(self, key: str, value: Any) -> 'Request':
+        """设置 meta 中的某个键值，支持链式调用。"""
+        self._meta[key] = value
+        return self
+    
+    def add_header(self, key: str, value: str) -> 'Request':
+        """添加请求头，支持链式调用。"""
+        self.headers[key] = value
+        return self
+    
+    def add_headers(self, headers: Dict[str, str]) -> 'Request':
+        """批量添加请求头，支持链式调用。"""
+        self.headers.update(headers)
+        return self
+    
+    def set_proxy(self, proxy: str) -> 'Request':
+        """设置代理，支持链式调用。"""
+        self.proxy = proxy
+        return self
+    
+    def set_timeout(self, timeout: float) -> 'Request':
+        """设置超时时间，支持链式调用。"""
+        self.timeout = timeout
+        return self
+    
+    def add_flag(self, flag: str) -> 'Request':
+        """添加标记，支持链式调用。"""
+        if flag not in self.flags:
+            self.flags.append(flag)
+        return self
+    
+    def remove_flag(self, flag: str) -> 'Request':
+        """移除标记，支持链式调用。"""
+        if flag in self.flags:
+            self.flags.remove(flag)
+        return self
+    
+    def set_dynamic_loader(self, use_dynamic: bool = True, options: Optional[Dict[str, Any]] = None) -> 'Request':
+        """设置使用动态加载器，支持链式调用。"""
+        self.use_dynamic_loader = use_dynamic
+        if options:
+            self.dynamic_loader_options = options
+        # 同时在meta中设置标记，供混合下载器使用
+        self._meta['use_dynamic_loader'] = use_dynamic
+        return self
+    
+    def set_protocol_loader(self) -> 'Request':
+        """强制使用协议加载器，支持链式调用。"""
+        self.use_dynamic_loader = False
+        self._meta['use_dynamic_loader'] = False
+        self._meta['use_protocol_loader'] = True
+        return self
+
+    def _set_url(self, url: str) -> None:
+        """安全设置 URL，确保格式正确。"""
+        if not isinstance(url, str):
+            raise TypeError(f"Request url 必须为字符串，当前类型: {type(url).__name__}")
+        
+        if not url.strip():
+            raise ValueError("URL 不能为空")
+        
+        # 检查危险的 URL scheme
+        dangerous_schemes = ['file://', 'ftp://', 'javascript:', 'data:']
+        if any(url.lower().startswith(scheme) for scheme in dangerous_schemes):
+            raise ValueError(f"URL scheme 不安全: {url[:20]}...")
+
+        s = safe_url_string(url, self.encoding)
+        escaped_url = escape_ajax(s)
+        
+        if not escaped_url.startswith(('http://', 'https://')):
+            raise ValueError(f"URL 缺少 HTTP(S) scheme: {escaped_url[:50]}...")
+        
+        # 检查 URL 长度
+        if len(escaped_url) > 8192:  # 大多数服务器支持的最大 URL 长度
+            raise ValueError(f"URL 过长 (超过 8192 字符): {len(escaped_url)} 字符")
+        
+        self._url = escaped_url
+
+    @property
+    def url(self) -> str:
+        return self._url
+
+    @property
+    def meta(self) -> Dict[str, Any]:
+        return self._meta
+
+    def __str__(self) -> str:
+        return f'<Request url={self.url} method={self.method}>'
+
+    def __repr__(self) -> str:
+        return str(self)
+
+    def __lt__(self, other: _Request) -> bool:
+        """用于按优先级排序"""
         return self.priority < other.priority