pyadorn 1.0.0__py3-none-any.whl

pyadorn/__init__.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+# @author: firstelfin
+# @time: 2026/05/31 10:01:29
+# @description: 用于记录错误信息的模块, 完整记录所有的错误信息
+
+__version__ = "1.0.0"

pyadorn/errConfig.py

@@ -0,0 +1,15 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+# @author: firstelfin
+# @time: 2026/05/23 11:46:29
+
+import os
+import sys
+import warnings
+from pathlib import Path
+from dataclasses import dataclass
+
+
+
+class ErrorInfo: ...
+

pyadorn/errDecorator.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+# @author: firstelfin
+# @time: 2026/05/23 11:43:15
+
+import inspect
+import warnings
+import functools
+from loguru import logger
+from typing import List, Optional
+from .tools import error_handler
+
+
+def error_factory(
+    error_debug: bool,
+    error_response: Optional[list] = None,
+    error_key: Optional[str] = None,
+    *,
+    methods: Optional[List[str]] = None,
+    filters: Optional[List[str]] = None,
+):
+    """装饰器工厂
+
+    Args:
+        error_debug (bool): 是否是debug模式, 用于调试时打印详细错误信息。
+        error_response (list, optional): 错误响应列表. Defaults to None.
+        error_key (str, optional): 返回体存放错误的关键字. Defaults to None.
+        methods (List[str], optional): 需要封装的类方法. Defaults to None.
+        filters (List[str], optional): 不需要封装的类方法. Defaults to None.
+
+    Returns:
+        Callable: 装饰器对象
+    """
+
+    def decorator(target):
+        # 判断是类还是函数, target是装饰对象本身
+        if inspect.isclass(target):
+            return _decorate_class(target, methods, filters, error_debug, error_response, error_key)
+        else:
+            # 普通函数或方法（实际上如果直接装饰方法, target 已经是函数）
+            return _wrap_function(target, error_debug, error_response, error_key)
+
+    # 如果直接 @intercept 不带参数, handler 可能是被装饰对象, 此时需要特殊处理
+    # 但我们要求必须显式调用 intercept(handler) 或 intercept(handler=...)
+    # 为了使用简单, 这里省略了无参数情况, 你可以通过 intercept() 带默认 handler 来支持。
+    # 更健壮的写法：检测第一个参数是否可调用, 如果是则当作 handler。
+    # 但为了清晰, 这里要求必须带 handler。
+    return decorator
+
+
+def _decorate_class(cls, methods, filters, error_debug, error_response, error_key):
+    """装饰类的所有符合条件的方法"""
+    for name, method in inspect.getmembers(cls, predicate=inspect.isfunction):
+        # 如果指定了 methods 列表, 只处理列表中的方法
+        if methods is not None and name not in methods:
+            continue
+        # 如果指定了 filters 列表, 排除列表中的方法
+        if filters is not None and name in filters:
+            continue
+        # 包装该方法
+        wrapped = _wrap_function(method, error_debug, error_response, error_key)
+        setattr(cls, name, wrapped)
+    return cls
+
+
+def _wrap_function(func, error_debug=False, error_response: Optional[list] = None, error_key: Optional[str] = None):
+    """包装单个函数, 自动适配同步/异步"""
+
+    assert error_response is not None or error_key is not None, "error_response and error_key cannot be both None."
+    
+    if inspect.iscoroutinefunction(func):
+        @functools.wraps(func)
+        async def async_wrapper(*args, **kwargs):
+            try:
+                res = await func(*args, **kwargs)
+            except Exception as e:
+                if error_debug:
+                    logger.exception("捕获异常:")
+                res = {error_key: []} if error_key is not None else None
+                error_handler(e, error_response, res[error_key] if isinstance(res, dict) else None)  # type: ignore
+            return res
+        return async_wrapper
+    else:
+        @functools.wraps(func)
+        def sync_wrapper(*args, **kwargs):
+            try:
+                res = func(*args, **kwargs)
+            except Exception as e:
+                if error_debug:
+                    logger.exception("捕获异常:")
+                res = {error_key: []} if error_key is not None else None
+                error_handler(e, error_response, res[error_key] if isinstance(res, dict) else None)  # type: ignore
+            return res
+        return sync_wrapper

pyadorn/tools.py

@@ -0,0 +1,85 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+# @author: firstelfin
+# @time: 2026/05/31 11:37:15
+
+import functools
+import inspect
+import traceback
+from datetime import datetime
+from traceback import FrameSummary
+from types import TracebackType
+from dataclasses import dataclass, field
+from typing import Callable, List, Optional, Union
+
+
+def is_async_function(func):
+    return func.__code__.co_flags & 0x80  # 检查CO_ASYNC标志
+
+
+def traceback_info(e: Union[Exception, TracebackType]):
+    """根据TracebackType或Exception对象获取异常信息
+
+    traceback.print_exception()会直接打印完整异常信息到标准输出
+
+    Args:
+        e (Union[Exception, TracebackType]): 报错信息对象或者主动通过sys获取的调用栈对象
+
+    Returns:
+        list[FrameSummary]: 异常信息列表,每个元素是一个FrameSummary对象,包含文件名、行号、函数名和代码片段
+    
+    Example:
+        >>> import traceback
+        >>> trace_info = traceback_info(e)
+        ... [<FrameSummary file /Users/elfindan/project/errguard/test.py, line 21 in <module>>, <FrameSummary file /Users/elfindan/project/errguard/test.py, line 16 in __call__>]
+        >>> traceback.print_exception(type(e), e, e.__traceback__, file=sys.stdout)
+        ... Traceback (most recent call last):
+        ... File "/Users/elfindan/project/errguard/test.py", line 23, in <module>
+        ...     elfin(25)
+        ... File "/Users/elfindan/project/errguard/test.py", line 18, in __call__
+        ...     raise KeyError(f"Num: {num} should be less than 10.")
+        ... KeyError: 'Num: 25 should be less than 10.'
+    """
+    tb_obj = e.__traceback__ if isinstance(e, Exception) else e
+    results: list[FrameSummary] = traceback.extract_tb(tb_obj)
+    return results
+
+
+def format_frame_summary(fs) -> str:
+    s = f'  File "{fs.filename}", line {fs.lineno}, in {fs.name}'
+    if fs.line:
+        s += f'\n    {fs.line.strip()}'
+    return s
+
+
+def get_last_traceback_info(e: Union[Exception, TracebackType]) -> str:
+    """获取最后一个异常信息的字符串表示"""
+    tb_info = traceback_info(e)
+    last_tb = tb_info[-1]
+    res_str = format_frame_summary(last_tb)
+    return res_str
+
+
+@dataclass
+class ErrorInfo:
+
+    code: int            # 错误编码
+    msg: str             # 错误信息
+    traceback: list      # 调用栈（字符串格式）
+    timestamp: str = field(default_factory=lambda: datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
+
+
+def error_handler(e: Exception, error_response: Optional[list] = None, error_inject_list: Optional[list] = None):
+    """处理异常并返回错误响应"""
+    error_item = ErrorInfo(
+        code=int(getattr(e, 'code', 599)),
+        msg=str(e),
+        traceback=[get_last_traceback_info(e)]
+    )
+    if error_response is not None:
+        # 将错误对象传入指定对象error_response中
+        error_response.append(error_item)
+    else:
+        # 将错误分配给指定的对象关键字error_key中
+        error_inject_list.append(error_item)  # type: ignore
+

pyadorn-1.0.0.dist-info/METADATA

@@ -0,0 +1,145 @@
+Metadata-Version: 2.4
+Name: pyadorn
+Version: 1.0.0
+Summary: Add your description here
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: loguru>=0.7.3
+Dynamic: license-file
+
+# errguard
+
+python错误管理工具, 保护接口异常中断, 实现错误的监管与分类
+
+
+## 错误装饰器
+
+错误管理使用工厂进行了装饰器的封装。工厂(`error_factory`)对以下功能进行了构建：
+
+| 功能                       | 参数名             | 类型                    |
+| -------------------------- | ------------------ | ----------------------- |
+| 是否打印错误堆栈信息       | `error_debug`    | `bool`                |
+| 全局错误记录               | `error_response` | `Optional[list]`      |
+| 通过函数返回体注入错误信息 | `error_key`      | `Optional[str]`       |
+| 待装饰的类方法             | `methods`        | `Optional[List[str]]` |
+| 不装饰的类方法             | `filters`        | `Optional[List[str]]` |
+
+其中，error_debug参数是控制是否想终端打印错误信息，这里是使用exception函数将错误堆栈完整打印，一般情况下会自动提示/填充变量的值；error_response参数不是None时，出现错误会将错误放到error_response列表内，被装饰函数返回None；error_key是函数返回体接受错误信息的关键字，返回的值是list[ErrorInfo]对象, error_response非None时会优先使用。methods和filters都是对装饰类方法的配置参数，一个指定要装饰哪些方法，另一个是排除哪些方法。
+
+注：
+
+1. 错误装饰器需要指定上面的参数得到实例化对象
+2. 错误装饰器可以装饰类和函数
+3. 错误装饰器可以装饰同步、异步函数
+
+先定义装饰器
+
+```Python
+from pyadorn.errDecorator import error_factory
+error_status = []
+error_decorator0 = error_factory(error_debug=True, error_response=None, error_key="elfinError")
+error_decorator1 = error_factory(error_debug=False, error_response=None, error_key="elfinError")
+error_decorator2 = error_factory(error_debug=False, error_response=error_status, error_key="error3")
+```
+
+### 打印错误信息
+
+```Python
+@error_decorator0
+class Elfin:
+
+    class_name = "Elfin"
+
+    def __call__(self, num, **kwargs):
+        if num < 10:
+            raise MatchError(f"Num: {num} should be greater than 10.", code=500)
+        else:
+            raise KeyError(f"Num: {num} should be less than 10.")
+
+elfin = Elfin()
+res1 = elfin(9)
+print("-*-"*12, "\n",res1)
+```
+
+输出内容:
+
+```python
+2026-06-30 23:11:52.169 | ERROR    | pyadorn.errDecorator:sync_wrapper:90 - 捕获异常:
+Traceback (most recent call last):
+
+  File "/Users/elfindan/project/pyadorn/test.py", line 50, in <module>
+    res1 = elfin(9)
+           └ <__main__.Elfin object at 0x108260410>
+
+> File "/Users/elfindan/project/pyadorn/pyadorn/errDecorator.py", line 87, in sync_wrapper
+    res = func(*args, **kwargs)
+          │     │       └ {}
+          │     └ (<__main__.Elfin object at 0x108260410>, 9)
+          └ <function Elfin.__call__ at 0x108265760>
+
+  File "/Users/elfindan/project/pyadorn/test.py", line 25, in __call__
+    raise MatchError(f"Num: {num} should be greater than 10.", code=500)
+          │                  └ 9
+          └ <class '__main__.MatchError'>
+
+MatchError: Num: 9 should be greater than 10.
+-*--*--*--*--*--*--*--*--*--*--*--*- 
+ {'elfinError': [ErrorInfo(code=500, msg='Num: 9 should be greater than 10.', traceback=['  File "/Users/elfindan/project/pyadorn/test.py", line 25, in __call__\n    raise MatchError(f"Num: {num} should begreater than 10.", code=500)'], timestamp='2026-06-30 23:15:34')]}
+```
+
+### 不打印错误信息
+
+```Python
+@error_decorator1
+class Elfin:
+
+    class_name = "Elfin"
+
+    def __call__(self, num, **kwargs):
+        if num < 10:
+            raise MatchError(f"Num: {num} should be greater than 10.", code=500)
+        else:
+            raise KeyError(f"Num: {num} should be less than 10.")
+
+elfin = Elfin()
+res2 = elfin(9)
+print("-*-"*12, "\n",res2)
+```
+
+输出结果:
+
+```python
+-*--*--*--*--*--*--*--*--*--*--*--*- 
+ {'elfinError': [ErrorInfo(code=500, msg='Num: 9 should be greater than 10.', traceback=['  File "/Users/elfindan/project/pyadorn/test.py", line 25, in __call__\n    raise MatchError(f"Num: {num} should begreater than 10.", code=500)'], timestamp='2026-06-30 23:18:22')]}
+```
+
+所以`error_response=None, error_key="elfinError"`会返回带有指定的error_key的字典。
+
+### 装饰函数
+
+```Python
+@error_decorator2
+def test_error2():
+    if sys.version_info < (3, 8):
+        raise Exception("Python version must be 3.8 or later.")
+    else:
+        raise MatchError("Python version must be 3.8 or later.", code=500)
+
+res3 = test_error2()
+print("-*-"*12, "\n","res3\n", res3)
+print("error_status\n", error_status)
+```
+
+输出结果:
+
+```python
+-*--*--*--*--*--*--*--*--*--*--*--*- 
+ res3
+ {'error3': []}
+error_status
+ [ErrorInfo(code=500, msg='Python version must be 3.8 or later.', traceback=['  File "/Users/elfindan/project/pyadorn/test.py", line 43, in test_error2\n    raise MatchError("Python version must be 3.8 or later.", code=500)'], timestamp='2026-06-30 23:25:30')]
+```
+
+---
+

pyadorn-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyadorn/__init__.py,sha256=zmBL5ntBECCn_h_HU1lG_44k1QXCpRuHY6XBmWAnQBw,200
+pyadorn/errConfig.py,sha256=gboXbfEvzPV8gXXQnddDXa1-LZt_Eea5CxkrUtAsQTE,214
+pyadorn/errDecorator.py,sha256=3x5aoyBbinpbKqh3yZOrXuTylwT25vQAvGhMemXg76s,3887
+pyadorn/tools.py,sha256=1E38z_os2KTSPjTLmOjDDQqcFJDHmpLMTaV3PWxIqZE,3045
+pyadorn-1.0.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyadorn-1.0.0.dist-info/METADATA,sha256=_FLfPyXmeA2l1qXCIUjZtGU_3GlQk9FO4rJYbR2867Q,5248
+pyadorn-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+pyadorn-1.0.0.dist-info/top_level.txt,sha256=e_dEM4r_xQEOJm4qn-Y5UZm8i_g16eJgGgkpzPmrbMw,8
+pyadorn-1.0.0.dist-info/RECORD,,

pyadorn-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

pyadorn-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pyadorn-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+pyadorn