python - Python 中的类 C 结构

Question

有没有办法在 Python 中方便地定义类似 C 的结构？我厌倦了写这样的东西：

class MyStruct():
    def __init__(self, field1, field2, field3):
        self.field1 = field1
        self.field2 = field2
        self.field3 = field3

score 427 · Accepted Answer

更新：数据类

随着Python 3.7中数据类的引入，我们非常接近。

下面的示例类似于下面的NamedTuple示例，但生成的对象是可变的并且它允许使用默认值。

from dataclasses import dataclass


@dataclass
class Point:
    x: float
    y: float
    z: float = 0.0


p = Point(1.5, 2.5)

print(p)  # Point(x=1.5, y=2.5, z=0.0)

如果您想使用更具体的类型注释，这与新的类型模块很好地配合。

我一直在拼命地等待这个！如果你问我，Data Classes和新的NamedTuple声明，结合打字模块是天赐之物！

改进的 NamedTuple 声明

从Python 3.6开始，它变得非常简单和美观（恕我直言），只要您可以忍受immutability。

引入了一种声明 NamedTuples 的新方法，它也允许类型注释：

from typing import NamedTuple


class User(NamedTuple):
    name: str


class MyStruct(NamedTuple):
    foo: str
    bar: int
    baz: list
    qux: User


my_item = MyStruct('foo', 0, ['baz'], User('peter'))

print(my_item) # MyStruct(foo='foo', bar=0, baz=['baz'], qux=User(name='peter'))

score 380 · Accepted Answer

使用命名元组，它被添加到Python 2.6 标准库的集合模块中。如果您需要支持 Python 2.4 ，也可以使用 Raymond Hettinger 的命名元组配方。

这对您的基本示例很好，但也涵盖了您以后可能会遇到的一堆边缘情况。您上面的片段将写为：

from collections import namedtuple
MyStruct = namedtuple("MyStruct", "field1 field2 field3")

新创建的类型可以这样使用：

m = MyStruct("foo", "bar", "baz")

您还可以使用命名参数：

m = MyStruct(field1="foo", field2="bar", field3="baz")

score 102 · Accepted Answer

您可以将元组用于许多在 C 中使用结构的事情（例如 x、y 坐标或 RGB 颜色）。

对于其他所有内容，您可以使用字典或像这样的实用程序类：

>>> class Bunch:
...     def __init__(self, **kwds):
...         self.__dict__.update(kwds)
...
>>> mystruct = Bunch(field1=value1, field2=value2)

我认为“确定性”讨论在这里，在 Python Cookbook 的已发布版本中。

score 86 · Accepted Answer

也许您正在寻找没有构造函数的结构：

class Sample:
  name = ''
  average = 0.0
  values = None # list cannot be initialized here!


s1 = Sample()
s1.name = "sample 1"
s1.values = []
s1.values.append(1)
s1.values.append(2)
s1.values.append(3)

s2 = Sample()
s2.name = "sample 2"
s2.values = []
s2.values.append(4)

for v in s1.values:   # prints 1,2,3 --> OK.
  print v
print "***"
for v in s2.values:   # prints 4 --> OK.
  print v

score 71 · Accepted Answer

字典怎么样？

像这样的东西：

myStruct = {'field1': 'some val', 'field2': 'some val'}

然后您可以使用它来操作值：

print myStruct['field1']
myStruct['field2'] = 'some other values'

并且值不必是字符串。它们几乎可以是任何其他对象。

score 28 · Accepted Answer

dF：这很酷……我不知道我可以使用 dict 访问类中的字段。

马克：我希望我有这种情况正是我想要一个元组但没有像字典那样“沉重”的时候。

您可以使用字典访问类的字段，因为类的字段、其方法和所有属性都使用字典在内部存储（至少在 CPython 中）。

...这导致我们提出您的第二条评论。相信 Python dicts 是“重的”是一个非常非 Pythonistic 的概念。阅读这样的评论会扼杀我的 Python Zen。这不好。

你看，当你声明一个类时，你实际上是在围绕字典创建一个非常复杂的包装器——所以，如果有的话，你会增加比使用简单字典更多的开销。顺便说一句，在任何情况下都是毫无意义的开销。如果您正在处理性能关键的应用程序，请使用 C 或其他东西。

score 24 · Accepted Answer

我还想添加一个使用插槽的解决方案：

class Point:
    __slots__ = ["x", "y"]
    def __init__(self, x, y):
        self.x = x
        self.y = y

绝对检查插槽的文档，但对插槽的快速解释是它是 python 的说法：“如果您可以将这些属性和仅这些属性锁定到类中，这样您就不会在类中添加任何新属性被实例化（是的，您可以向类实例添加新属性，请参见下面的示例）然后我将取消允许向类实例添加新属性并使用这些插槽属性所需的大内存分配”。

向类实例添加属性的示例（因此不使用插槽）：

class Point:
    def __init__(self, x, y):
        self.x = x
        self.y = y

p1 = Point(3,5)
p1.z = 8
print(p1.z)

输出：8

尝试将属性添加到使用插槽的类实例的示例：

class Point:
    __slots__ = ["x", "y"]
    def __init__(self, x, y):
        self.x = x
        self.y = y

p1 = Point(3,5)
p1.z = 8

输出：AttributeError：“Point”对象没有属性“z”

这可以有效地作为一个结构工作，并且比一个类使用更少的内存（就像一个结构一样，虽然我没有研究到底有多少）。如果您将创建大量对象实例并且不需要添加属性，建议使用插槽。点对象就是一个很好的例子，因为它可能会实例化许多点来描述数据集。

score 21 · Accepted Answer

您可以对标准库中可用的 C 结构进行子类化。ctypes模块提供了一个Structure类。文档中的示例：

>>> from ctypes import *
>>> class POINT(Structure):
...     _fields_ = [("x", c_int),
...                 ("y", c_int)]
...
>>> point = POINT(10, 20)
>>> print point.x, point.y
10 20
>>> point = POINT(y=5)
>>> print point.x, point.y
0 5
>>> POINT(1, 2, 3)
Traceback (most recent call last):
  File "<stdin>", line 1, in ?
ValueError: too many initializers
>>>
>>> class RECT(Structure):
...     _fields_ = [("upperleft", POINT),
...                 ("lowerright", POINT)]
...
>>> rc = RECT(point)
>>> print rc.upperleft.x, rc.upperleft.y
0 5
>>> print rc.lowerright.x, rc.lowerright.y
0 0
>>>

score 19 · Accepted Answer

您还可以通过位置将初始化参数传递给实例变量

# Abstract struct class       
class Struct:
    def __init__ (self, *argv, **argd):
        if len(argd):
            # Update by dictionary
            self.__dict__.update (argd)
        else:
            # Update by position
            attrs = filter (lambda x: x[0:2] != "__", dir(self))
            for n in range(len(argv)):
                setattr(self, attrs[n], argv[n])

# Specific class
class Point3dStruct (Struct):
    x = 0
    y = 0
    z = 0

pt1 = Point3dStruct()
pt1.x = 10

print pt1.x
print "-"*10

pt2 = Point3dStruct(5, 6)

print pt2.x, pt2.y
print "-"*10

pt3 = Point3dStruct (x=1, y=2, z=3)
print pt3.x, pt3.y, pt3.z
print "-"*10

score 13 · Accepted Answer

每当我需要一个“也像字典一样的即时数据对象”（我不认为 C 结构！）时，我都会想到这个可爱的 hack：

class Map(dict):
    def __init__(self, **kwargs):
        super(Map, self).__init__(**kwargs)
        self.__dict__ = self

现在你可以说：

struct = Map(field1='foo', field2='bar', field3=42)

self.assertEquals('bar', struct.field2)
self.assertEquals(42, struct['field3'])

当你需要一个“不是一个类的数据包”的时候，以及当命名元组难以理解的时候，非常方便......

score 10 · Accepted Answer

这里的一些答案非常详尽。我发现的最简单的选项是（来自： http: //norvig.com/python-iaq.html）：

class Struct:
    "A structure that can have any fields defined."
    def __init__(self, **entries): self.__dict__.update(entries)

初始化：

>>> options = Struct(answer=42, linelen=80, font='courier')
>>> options.answer
42

添加更多：

>>> options.cat = "dog"
>>> options.cat
dog

编辑：抱歉没有看到这个例子已经更远了。

score 9 · Accepted Answer

您可以通过以下方式在 python 中访问 C-Style 结构。

class cstruct:
    var_i = 0
    var_f = 0.0
    var_str = ""

如果你只想使用 cstruct 的对象

obj = cstruct()
obj.var_i = 50
obj.var_f = 50.00
obj.var_str = "fifty"
print "cstruct: obj i=%d f=%f s=%s" %(obj.var_i, obj.var_f, obj.var_str)

如果你想创建一个 cstruct 对象数组

obj_array = [cstruct() for i in range(10)]
obj_array[0].var_i = 10
obj_array[0].var_f = 10.00
obj_array[0].var_str = "ten"

#go ahead and fill rest of array instaces of struct

#print all the value
for i in range(10):
    print "cstruct: obj_array i=%d f=%f s=%s" %(obj_array[i].var_i, obj_array[i].var_f, obj_array[i].var_str)

注意：请使用您的结构名称代替 'cstruct' 名称，而不是 var_i、var_f、var_str，请定义您的结构的成员变量。

score 5 · Accepted Answer

这可能有点晚了，但我使用 Python 元类（下面也是装饰器版本）做了一个解决方案。

在__init__运行时调用时，它会获取每个参数及其值，并将它们作为实例变量分配给您的类。通过这种方式，您可以创建一个类似结构的类，而无需手动分配每个值。

我的示例没有错误检查，因此更容易理解。

class MyStruct(type):
    def __call__(cls, *args, **kwargs):
        names = cls.__init__.func_code.co_varnames[1:]

        self = type.__call__(cls, *args, **kwargs)

        for name, value in zip(names, args):
            setattr(self , name, value)

        for name, value in kwargs.iteritems():
            setattr(self , name, value)
        return self

这是在行动。

>>> class MyClass(object):
    __metaclass__ = MyStruct
    def __init__(self, a, b, c):
        pass


>>> my_instance = MyClass(1, 2, 3)
>>> my_instance.a
1
>>>

我在 reddit 上发布了它，/u/matchu发布了一个更简洁的装饰器版本。除非您想扩展元类版本，否则我鼓励您使用它。

>>> def init_all_args(fn):
    @wraps(fn)
    def wrapped_init(self, *args, **kwargs):
        names = fn.func_code.co_varnames[1:]

        for name, value in zip(names, args):
            setattr(self, name, value)

        for name, value in kwargs.iteritems():
            setattr(self, name, value)

    return wrapped_init

>>> class Test(object):
    @init_all_args
    def __init__(self, a, b):
        pass


>>> a = Test(1, 2)
>>> a.a
1
>>>

score 5 · Accepted Answer

我写了一个装饰器，你可以在任何方法上使用它，以便将所有传入的参数或任何默认值分配给实例。

def argumentsToAttributes(method):
    argumentNames = method.func_code.co_varnames[1:]

    # Generate a dictionary of default values:
    defaultsDict = {}
    defaults = method.func_defaults if method.func_defaults else ()
    for i, default in enumerate(defaults, start = len(argumentNames) - len(defaults)):
        defaultsDict[argumentNames[i]] = default

    def newMethod(self, *args, **kwargs):
        # Use the positional arguments.
        for name, value in zip(argumentNames, args):
            setattr(self, name, value)

        # Add the key word arguments. If anything is missing, use the default.
        for name in argumentNames[len(args):]:
            setattr(self, name, kwargs.get(name, defaultsDict[name]))

        # Run whatever else the method needs to do.
        method(self, *args, **kwargs)

    return newMethod

快速演示。请注意，我使用位置参数a、使用默认值b和命名参数c。然后我打印所有 3 个引用self，以表明在输入方法之前它们已被正确分配。

class A(object):
    @argumentsToAttributes
    def __init__(self, a, b = 'Invisible', c = 'Hello'):
        print(self.a)
        print(self.b)
        print(self.c)

A('Why', c = 'Nothing')

请注意，我的装饰器应该使用任何方法，而不仅仅是__init__.

score 5 · Accepted Answer

这是一个使用类（从未实例化）来保存数据的解决方案。我喜欢这种方式涉及很少的打字并且不需要任何额外的包等。

class myStruct:
    field1 = "one"
    field2 = "2"

您可以稍后根据需要添加更多字段：

myStruct.field3 = 3

要获取值，请照常访问字段：

>>> myStruct.field1
'one'

score 5 · Accepted Answer

我在这里看不到这个答案，所以我想我会添加它，因为我现在正在学习 Python 并且刚刚发现它。Python 教程（本例中为 Python 2）提供了以下简单有效的示例：

class Employee:
    pass

john = Employee()  # Create an empty employee record

# Fill the fields of the record
john.name = 'John Doe'
john.dept = 'computer lab'
john.salary = 1000

即创建一个空的类对象，然后实例化，动态添加字段。

这样做的好处是非常简单。缺点是它不是特别自记录（预期的成员没有在类“定义”的任何地方列出），并且未设置的字段在访问时可能会导致问题。这两个问题可以通过以下方式解决：

class Employee:
    def __init__ (self):
        self.name = None # or whatever
        self.dept = None
        self.salary = None

现在一目了然，您至少可以看到程序将期待哪些字段。

两者都容易出现拼写错误，john.slarly = 1000都会成功。尽管如此，它仍然有效。

score 3 · Accepted Answer

有一个专门用于此目的的 python 包。见cstruct2py

cstruct2py是一个纯 python 库，用于从 C 代码生成 python 类并使用它们来打包和解包数据。该库可以解析 C 头文件（结构、联合、枚举和数组声明）并在 python 中模拟它们。生成的 pythonic 类可以解析和打包数据。

例如：

typedef struct {
  int x;
  int y;
} Point;

after generating pythonic class...
p = Point(x=0x1234, y=0x5678)
p.packed == "\x34\x12\x00\x00\x78\x56\x00\x00"

如何使用

首先我们需要生成pythonic结构：

import cstruct2py
parser = cstruct2py.c2py.Parser()
parser.parse_file('examples/example.h')

现在我们可以从 C 代码中导入所有名称：

parser.update_globals(globals())

我们也可以直接这样做：

A = parser.parse_string('struct A { int x; int y;};')

使用 C 代码中的类型和定义

a = A()
a.x = 45
print a
buf = a.packed
b = A(buf)
print b
c = A('aaaa11112222', 2)
print c
print repr(c)

输出将是：

{'x':0x2d, 'y':0x0}
{'x':0x2d, 'y':0x0}
{'x':0x31316161, 'y':0x32323131}
A('aa111122', x=0x31316161, y=0x32323131)

克隆

对于克隆cstruct2py运行：

git clone https://github.com/st0ky/cstruct2py.git --recursive

score 3 · Accepted Answer

就个人而言，我也喜欢这个变种。它扩展了@dF 的答案。

class struct:
    def __init__(self, *sequential, **named):
        fields = dict(zip(sequential, [None]*len(sequential)), **named)
        self.__dict__.update(fields)
    def __repr__(self):
        return str(self.__dict__)

它支持两种初始化模式（可以混合）：

# Struct with field1, field2, field3 that are initialized to None.
mystruct1 = struct("field1", "field2", "field3") 
# Struct with field1, field2, field3 that are initialized according to arguments.
mystruct2 = struct(field1=1, field2=2, field3=3)

此外，它打印得更好：

print(mystruct2)
# Prints: {'field3': 3, 'field1': 1, 'field2': 2}

score 3 · Accepted Answer

NamedTuple很舒服。但是没有人分享性能和存储。

from typing import NamedTuple
import guppy  # pip install guppy
import timeit


class User:
    def __init__(self, name: str, uid: int):
        self.name = name
        self.uid = uid


class UserSlot:
    __slots__ = ('name', 'uid')

    def __init__(self, name: str, uid: int):
        self.name = name
        self.uid = uid


class UserTuple(NamedTuple):
    # __slots__ = ()  # AttributeError: Cannot overwrite NamedTuple attribute __slots__
    name: str
    uid: int


def get_fn(obj, attr_name: str):
    def get():
        getattr(obj, attr_name)
    return get

if 'memory test':
    obj = [User('Carson', 1) for _ in range(1000000)]      # Cumulative: 189138883
    obj_slot = [UserSlot('Carson', 1) for _ in range(1000000)]          # 77718299  <-- winner
    obj_namedtuple = [UserTuple('Carson', 1) for _ in range(1000000)]   # 85718297
    print(guppy.hpy().heap())  # Run this function individually. 
    """
    Index  Count   %     Size   % Cumulative  % Kind (class / dict of class)
     0 1000000    24 112000000 34 112000000  34 dict of __main__.User
     1 1000000    24 64000000  19 176000000  53 __main__.UserTuple
     2 1000000    24 56000000  17 232000000  70 __main__.User
     3 1000000    24 56000000  17 288000000  87 __main__.UserSlot
     ...
    """

if 'performance test':
    obj = User('Carson', 1)
    obj_slot = UserSlot('Carson', 1)
    obj_tuple = UserTuple('Carson', 1)

    time_normal = min(timeit.repeat(get_fn(obj, 'name'), repeat=20))
    print(time_normal)  # 0.12550550000000005

    time_slot = min(timeit.repeat(get_fn(obj_slot, 'name'), repeat=20))
    print(time_slot)  # 0.1368690000000008

    time_tuple = min(timeit.repeat(get_fn(obj_tuple, 'name'), repeat=20))
    print(time_tuple)  # 0.16006120000000124

    print(time_tuple/time_slot)  # 1.1694481584580898  # The slot is almost 17% faster than NamedTuple on Windows. (Python 3.7.7)

如果您__dict__不使用，请在__slots__（更高性能和存储）和NamedTuple（清除阅读和使用）之间进行选择

您可以查看此链接（插槽的使用）以获取更多__slots__信息。

score 3 · Accepted Answer

这是一个快速而肮脏的技巧：

>>> ms = Warning()
>>> ms.foo = 123
>>> ms.bar = 'akafrit'

它是如何工作的？它只是重新使用内置类Warning（派生自Exception）并像您自己定义的类一样使用它。

好处是您不需要先导入或定义任何东西，“警告”是一个简短的名称，并且它还清楚地表明您正在做一些肮脏的事情，除了您的小脚本之外不应该在其他地方使用。

顺便说一句，我试图找到更简单的东西，ms = object()但找不到（最后一个例子不起作用）。如果你有的话，我很感兴趣。

score 2 · Accepted Answer

https://stackoverflow.com/a/32448434/159695在 Python3 中不起作用。

https://stackoverflow.com/a/35993/159695适用于 Python3。

我扩展它以添加默认值。

class myStruct:
    def __init__(self, **kwds):
        self.x=0
        self.__dict__.update(kwds) # Must be last to accept assigned member variable.
    def __repr__(self):
        args = ['%s=%s' % (k, repr(v)) for (k,v) in vars(self).items()]
        return '%s(%s)' % ( self.__class__.__qualname__, ', '.join(args) )

a=myStruct()
b=myStruct(x=3,y='test')
c=myStruct(x='str')

>>> a
myStruct(x=0)
>>> b
myStruct(x=3, y='test')
>>> c
myStruct(x='str')

score 2 · Accepted Answer

以下结构的解决方案受到 namedtuple 实现和一些先前答案的启发。但是，与 namedtuple 不同的是，它的值是可变的，但就像 c 样式的结构在名称/属性中不可变一样，而普通类或 dict 则不是。

_class_template = """\
class {typename}:
def __init__(self, *args, **kwargs):
    fields = {field_names!r}

    for x in fields:
        setattr(self, x, None)            

    for name, value in zip(fields, args):
        setattr(self, name, value)

    for name, value in kwargs.items():
        setattr(self, name, value)            

def __repr__(self):
    return str(vars(self))

def __setattr__(self, name, value):
    if name not in {field_names!r}:
        raise KeyError("invalid name: %s" % name)
    object.__setattr__(self, name, value)            
"""

def struct(typename, field_names):

    class_definition = _class_template.format(
        typename = typename,
        field_names = field_names)

    namespace = dict(__name__='struct_%s' % typename)
    exec(class_definition, namespace)
    result = namespace[typename]
    result._source = class_definition

    return result

用法：

Person = struct('Person', ['firstname','lastname'])
generic = Person()
michael = Person('Michael')
jones = Person(lastname = 'Jones')


In [168]: michael.middlename = 'ben'
Traceback (most recent call last):

  File "<ipython-input-168-b31c393c0d67>", line 1, in <module>
michael.middlename = 'ben'

  File "<string>", line 19, in __setattr__

KeyError: 'invalid name: middlename'

score 1 · Accepted Answer

The best way I found to do this was to use a custom dictionary class as explained in this post: https://stackoverflow.com/a/14620633/8484485

If iPython autocompletion support is needed, simply define the dir() function like this:

class AttrDict(dict):
    def __init__(self, *args, **kwargs):
        super(AttrDict, self).__init__(*args, **kwargs)
        self.__dict__ = self
    def __dir__(self):
        return self.keys()

You then define your pseudo struct like so: (this one is nested)

my_struct=AttrDict ({
    'com1':AttrDict ({
        'inst':[0x05],
        'numbytes':2,
        'canpayload':False,
        'payload':None
    })
})

You can then access the values inside my_struct like this:

print(my_struct.com1.inst)

=>[5]

score 1 · Accepted Answer

如果您没有 3.7 for @dataclass 并且需要可变性，则以下代码可能适合您。它非常自记录且对 IDE 友好（自动完成），防止重复写入，易于扩展，并且测试所有实例变量是否已完全初始化非常简单：

class Params():
    def __init__(self):
        self.var1 : int = None
        self.var2 : str = None

    def are_all_defined(self):
        for key, value in self.__dict__.items():
            assert (value is not None), "instance variable {} is still None".format(key)
        return True


params = Params()
params.var1 = 2
params.var2 = 'hello'
assert(params.are_all_defined)

score 0 · Accepted Answer

我认为 Python 结构字典适合这个要求。

d = dict{}
d[field1] = field1
d[field2] = field2
d[field2] = field3

python - Python 中的类 C 结构

25 回答 25

更新：数据类

改进的 NamedTuple 声明

如果你只想使用 cstruct 的对象

如果你想创建一个 cstruct 对象数组

Related

Reference