标签: python-dataclasses

我注意到 Sphinx 呈现类描述的行为发生了变化。鉴于此代码

# my example happens to be a dataclass, but the behavior for 
# regular classes is the same
@dataclass
class TestClass:
    """This is a test class for dataclasses.

    This is the body of the docstring description.
    """
    var_int: int
    var_str: str

加上一些通用的狮身人面像设置，我大约两年前就得到了这个

现在我得到了这个

有没有办法告诉 Sphinx 不要将类变量添加到类定义的底部？尤其令人烦恼的是，它假设它们的值为None，只是因为它们没有默认值。

这个问题是在这篇文章的讨论中出现的，其中还包含有关 Sphinx 配置等的评论中的更多上下文。

如何创建具有自定义字典表示形式的数据类？

字典输出示例：

{
    '$1': 'foo',
    '$2': 'bar',
    '$3': 'baz'
}

显然我不能有数据类

@dataclass
class Foo:
    $1: str
    ...

我需要它表示为

@dataclass
class Foo:
    one: str
    ...

例如，但我想dataclasses.asdict(foo)返回“$1”等键名。

如果

x = {
    '$1': 'foo',
    '$2': 'bar',
    '$3': 'baz'
}
foo = Foo(**x)
assert foo.one == 'foo'
assert foo.two == 'bar'
assert foo.three == 'baz'

工作过

我可以将 python 类转换为 numpy 吗array？

from dataclasses import dataclass
import numpy as np
@dataclass
class X:
    x: float = 0
    y: float = 0
x = X()
x_array = np.array(x) # would like to get an numpy array np.array([X.x,X.y])

在最后一步中，我想获得一个数组np.array([X.x, X.y])。相反，我得到了array(X(x=0, y=0), dtype=object)。

我可以提供 的方法，dataclass以便根据需要进行转换（或重载 的现有方法之一dataclass）吗？

我有很多使用post_init嵌套的数据类

from dataclasses import dataclass
from typing import List
from typing import Optional
from typing import Union


@dataclass
class MyClass:
    signed_key: str
    signature: str


@dataclass
class Message:
    signature: str
    my_class: Union[MyClass, dict]
    protocol_version: str
    signed_message: str

    def __post_init__(self):
        self.my_class = MyClass(**self.my_class)

它工作得很好，但问题是，如果我想将 Message 转换为 dict，如下所示：

#create a message object before
print(message.__dict__)

我得到的输出：

{'signature': 'test', 'my_class': Myclass(signed_key='test', signature='test'), 'protocol_version': 'test', 'signed_message': 'test'}

我想要什么（嵌套字典）：

{'signature': 'test', 'my_class': {'signed_key': 'test', 'signature': 'test'}, 'protocol_version': 'test', 'signed_message': 'test'}

我可以使用像 attrs 或 pydantic 这样的库，但这里的目标是只使用纯 python

我有以下数据类：

import os
import dataclasses

@dataclasses.dataclass
class Example:
    host: str = os.environ.get('SERVICE_HOST', 'localhost')
    port: str = os.environ.get('SERVICE_PORT', 30650)

我该如何为此编写测试？我尝试了以下看起来应该有效的方法：

from stackoverflow import Example
import os


def test_example(monkeypatch):
    # GIVEN environment variables are set for host and port
    monkeypatch.setenv('SERVICE_HOST', 'server.example.com')
    monkeypatch.setenv('SERVICE_PORT', '12345')
    #   AND a class instance is initialized without specifying a host or port
    example = Example()
    # THEN the instance should reflect the host and port specified in the environment variables
    assert example.host == 'server.example.com'
    assert example.port == '12345' …