python中的 @dataclass

今天写日志模块时,需求需要将常见的.log格式转为.jsonl格式。由于是封装的标准库logging的东西,原来是简单的字符串formatter格式,现在要转为json格式,同时要传入不同字段并以特定顺序进行打印。

转json-formatter容易,只需要封装logging.Formatter类即可。但是将配置以特定字段顺序打印却很繁琐,要么需要实现类,要么以Dict+大量硬编码实现,同时也伴随着需求的不断变化。最后找到了@dataclass+ asdict方法进行处理,极大的简化了开发效率。

@dataclass是Python3.7引入的标准库功能,位于模块dataclasses中,是用来简化数据类定义的装饰器。

传统上,定义一个只用来存储数据的类时,需要手动实现__init__、__repr__、__eq__等方法。而使用@dataclass能自动生成这些方法。

传统上:

python 复制代码
class Person:
    def __init__(self, name, age):
        self.name = name
        self.age = age

使用@dataclass:

python 复制代码
@dataclass
class Person:
    name: str
    age: int
# 等价于
class Person:
    def __init__(self, name: str, age: int):
        self.name = name
        self.age = age

    def __repr__(self):
        return f'Person(name={self.name!r}, age={self.age!r})'

    def __eq__(self, other):
        return isinstance(other, Person) and self.name == other.name and self.age == other.age

@dataclass的一些参数:

  • init=True:是否自动生成 __init__(默认是)
  • repr=True:是否自动生成 __repr__(默认是)
  • eq=True:是否自动生成 __eq__(默认是)
  • order=True:是否添加比较运算符,如 <、>=(需字段支持)
  • frozen=True:是否生成"不可变类"(类似 namedtuple)
  • slots=True:是否使用 __slots__ 限定字段。

同时也带默认值和字段控制

python 复制代码
@dataclass
class Config:
    host: str
    port: int = 8080
    debug: bool = field(default=False)

@dataclass装饰器要求必须字段必须在可选字段的前面

python 复制代码
@dataclass
class LogEntry:
    # 必选
    a: str
    b: str
    c: str

    # 可选
    d: Optional[str] = None
    e: Dict[str, Any] = field(default_factory=dict)

赋值完数据后,使用asdict将其转换为Dict

python 复制代码
from dataclasses import asdict, dataclass, field
from typing import Dict, Any, Optional
@dataclass
class LogEntry:
    # 必选
    a: str
    b: str
    c: str

    # 可选
    d: Optional[str] = None
    e: Dict[str, Any] = field(default_factory=dict)
logentry = LogEntry(
    a='a',
    b='b',
    c='c',
)
logentry_dict = asdict(logentry)
print(logentry_dict)

在赋值时,由于存在可选字段没有进行赋值,还是默认值,如果想要去掉默认的可选字段可以使用字典变量:

python 复制代码
filtered_log_data = {k: v for k, v in logentry_dict.items() if (v is not None and v != {})}

完整:

python 复制代码
from dataclasses import asdict, dataclass, field
from typing import Dict, Any, Optional
@dataclass
class LogEntry:
    # 必选
    a: str
    b: str
    c: str

    # 可选
    d: Optional[str] = None
    e: Dict[str, Any] = field(default_factory=dict)
logentry = LogEntry(
    a='a',
    b='b',
    c='c',
)
logentry_dict = asdict(logentry)
filtered_log_data = {k: v for k, v in logentry_dict.items() if (v is not None and v != {})}
print(filtered_log_data)
相关推荐
starzy19905 分钟前
深入理解Scala隐式参数:上下文流转
开发语言·python·scala
wuyk5551 小时前
Spider-第16讲-线程池与竞态问题
大数据·爬虫·python·elasticsearch·搜索引擎
feixing_fx1 小时前
JavaScript 是什么:从浏览器脚本到通用编程语言
开发语言·前端·javascript·前端框架·ecmascript
惜.己3 小时前
Java结合idea简单使用Playwright
java·开发语言·自动化
利威尔xu3 小时前
PostgreSQL 索引失效 4 类:函数运算让查询全表扫描拖垮性能
开发语言·数据库·postgresql·性能优化·索引优化
ShineWinsu3 小时前
对于Qt:QSpacerItem常见属性以及方法的解析
开发语言·c++·qt·面试·系统架构·客户端·qspaceritem
ShineWinsu7 小时前
对于Qt:QGripLayout常见属性、方法以及QSizePolicy的解析
开发语言·c++·qt·面试·gui·客户端·网格
艾莉丝努力练剑7 小时前
【AI大模型接入SDK】C++的SessionManager 线程安全
java·开发语言·前端·c++·人工智能·学习·安全
kyle~7 小时前
FastAPI --- 将业务能力以 API 的形式提供给外部系统
python·fastapi·前后端
aiotto资源分享7 小时前
Python 写 JSON 文件,程序中途退出会留下什么?
java·python·json·jsondecodeerror