How can I create a Python class with a member named 'class'

Question

I want to create a Python class that represents a dictionary my_dict that I want to convert as follows

my_class = MyClass(**my_dict)

The issues is that one of the dicts keys is called 'class'

So when I do as follows Python complains:

class MyClass(BaseModel)
  name: str
  address: str
  id: int
  class: str                  <-- Python does not like me using the keyword class

How can I get around this?

A class is also an object and an attribute of an object can be set with setattr. — Michael Butscher
– Michael Butscher, Commented Jan 20, 2023 at 5:42
you can use __annotations__['class'] = str -- though every metaprogramming class I tried crashed in some other way later on with a SyntaxError building their __init__ or __new__ method — anthony sottile
– anthony sottile, Commented Jan 20, 2023 at 5:44
Usually you name it klass or cls or class_ because of this restriction. — deceze
– deceze ♦, Commented Jan 20, 2023 at 5:45
What is BaseModel? Is that from some framework, whose solution for this issue you should thus use? — Kelly Bundy
– Kelly Bundy, Commented Jan 20, 2023 at 6:09

BrokenBenchmark · Accepted Answer · 2023-01-20 05:54:00Z

1

As deceze states in their comment, the conventional way of resolving this issue is to suffix the name of the attribute with an underscore. I'm sure there's probably some hacky way of getting an attribute named class, but it's probably not worth the pain of setting up and maintaining.

This is described in PEP8, which outlines style guidelines for Python code:

single_trailing_underscore_: used by convention to avoid conflicts with Python keyword, e.g.
tkinter.Toplevel(master, class_='ClassName')

answered Jan 20, 2023 at 5:54

BrokenBenchmark

19.4k7 gold badges26 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How can I create a Python class with a member named 'class'

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related