How to create a read-only class property in Python? [duplicate]

by

This will make Foo.number a read-only property:

class MetaFoo(type):
    @property
    def number(cls):
        return cls.x

class Foo(object, metaclass=MetaFoo):
    x = 4

print(Foo.number)
# 4

Foo.number = 6
# AttributeError: can't set attribute

Explanation: The usual scenario when using @property looks like this:

class Foo(object):
    @property
    def number(self):
        ...
foo = Foo()

A property defined in Foo is read-only with respect to its instances. That is, foo.number = 6 would raise an AttributeError.

Analogously, if you want Foo.number to raise an AttributeError you would need to setup a property defined in type(Foo). Hence the need for a metaclass.

Note that this read-onlyness is not immune from hackers.
The property can be made writable by changing Foo’s
class:

class Base(type): pass
Foo.__class__ = Base

# makes Foo.number a normal class attribute
Foo.number = 6   
print(Foo.number)

prints

6

or, if you wish to make Foo.number a settable property,

class WritableMetaFoo(type): 
    @property
    def number(cls):
        return cls.x
    @number.setter
    def number(cls, value):
        cls.x = value
Foo.__class__ = WritableMetaFoo

# Now the assignment modifies `Foo.x`
Foo.number = 6   
print(Foo.number)

also prints

6

More Related Contents:

  1. Python class @property: use setter but evade getter?
  2. Python – Class.function().function()
  3. What is the purpose of the word ‘self’?
  4. How to print instances of a class using print()?
  5. Printing all instances of a class
  6. How would I access variables from one class to another?
  7. How do Python properties work?
  8. List all base classes in a hierarchy of given class?
  9. Properties file in python (similar to Java Properties)
  10. Python Class Members
  11. Assigning (instead of defining) a __getitem__ magic method breaks indexing [duplicate]
  12. Tkinter example code for multiple windows, why won’t buttons load correctly?
  13. Why is a class __dict__ a mappingproxy?
  14. How to refer to the class from within it (like a recursive function)
  15. difference between variables inside and outside of __init__() (class and instance attributes)
  16. Define a method outside of class definition?
  17. Making a python user-defined class sortable, hashable
  18. Using Properties in Python classes cause “maximum recursion depth exceeded” [duplicate]
  19. Is there a way to circumvent Python list.append() becoming progressively slower in a loop as the list grows?
  20. Get name of current class?
  21. Importing a function from a class in another file? [duplicate]
  22. “Enabling” comparison for classes [duplicate]
  23. Dynamically creating classes – Python
  24. Access .mat file containing matlab classes in python
  25. Python Tkinter PhotoImage
  26. TypeError: attack() missing 1 required positional argument: ‘self’
  27. How to extend a class in python?
  28. Using Python class as a data container [closed]
  29. How to declare a static attribute in Python?
  30. How to find instance of a bound method in Python?

Leave a Comment