pydoc > builtins.property

man perldoc info pydoc3 ri search

📘 Help on class property in builtins:

🚀 Quick Reference

Use Case	Command	Description
Define a property with getter/setter/deleter	property(getx, setx, delx, "doc")	Create a managed attribute with explicit get, set, delete functions
Define a property using decorator	@property	Simplified property definition; getter returns an attribute
Define a setter for a property	@x.setter	Decorate a method to act as the property’s setter
Define a deleter for a property	@x.deleter	Decorate a method to act as the property’s deleter

📖 Description

builtins.property = class property(object)

builtins.property(fget=None, fset=None, fdel=None, doc=None)

Property attribute.

• fget – function to be used for getting an attribute value
• fset – function to be used for setting an attribute value
• fdel – function to be used for del’ing an attribute
• doc – docstring

📝 Typical Use

Define a managed attribute x:

class C(object):
    def getx(self): return self._x
    def setx(self, value): self._x = value
    def delx(self): del self._x
    x = property(getx, setx, delx, "I'm the 'x' property.")

🎨 Decorator Syntax

Decorators make defining new properties or modifying existing ones easy:

class C(object):
    @property
    def x(self):
        "I am the 'x' property."
        return self._x
    @x.setter
    def x(self, value):
        self._x = value
    @x.deleter
    def x(self):
        del self._x

🛠️ Methods

• __delete__(self, instance, /) – Delete an attribute of instance.
• __get__(self, instance, owner=None, /) – Return an attribute of instance, which is of type owner.
• __getattribute__(self, name, /) – Return getattr(self, name).
• __init__(self, /, *args, **kwargs) – Initialize self. See help(type(self)) for accurate signature.
• __set__(self, instance, value, /) – Set an attribute of instance to value.
• __set_name__(...) – Method to set name of a property.
• deleter(...) – Descriptor to obtain a copy of the property with a different deleter.
• getter(...) – Descriptor to obtain a copy of the property with a different getter.
• setter(...) – Descriptor to obtain a copy of the property with a different setter.

---

⚙️ Static Methods

• __new__(*args, **kwargs) from builtins.type – Create and return a new object. See help(type) for accurate signature.

---

📊 Data Descriptors

• __isabstractmethod__
• fdel
• fget
• fset

🚀 Quick Reference 📖 Description 🛠️ Methods ⚙️ Static Methods 📊 Data Descriptors