{"id":2579,"date":"2021-10-17T09:07:59","date_gmt":"2021-10-17T09:07:59","guid":{"rendered":"https:\/\/www.pythontutorial.net\/?page_id=2579"},"modified":"2025-03-31T10:11:00","modified_gmt":"2025-03-31T10:11:00","slug":"python-delete-property","status":"publish","type":"page","link":"https:\/\/www.pythontutorial.net\/python-oop\/python-delete-property\/","title":{"rendered":"Python Delete Property"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to use the property() class to delete the property of an object.<\/p>\n\n\n\n

To create a property<\/a> of a class, you use the @property decorator<\/a>. Underhood, the @property<\/code> decorator uses the property<\/code> class that has three methods: setter, getter, and deleter.<\/p>\n\n\n\n

By using the deleter, you can delete a property from an object. Notice that the deleter()<\/code> method deletes a property of an object, not a class<\/a>.<\/p>\n\n\n\n

The following defines the Person<\/code> class with the name<\/code> property:<\/p>\n\n\n

from<\/span> pprint import<\/span> pprint\n\n\nclass<\/span> Person<\/span>:<\/span>\n    def<\/span> __init__<\/span>(self, name)<\/span>:<\/span>\n        self._name = name\n\n    @property<\/span>\n    def<\/span> name<\/span>(self)<\/span>:<\/span>\n        return<\/span> self._name\n\n    @name.setter<\/span>\n    def<\/span> name<\/span>(self, value)<\/span>:<\/span>\n        if<\/span> value.strip() == ''<\/span>:\n            raise<\/span> ValueError('name cannot be empty'<\/span>)\n        self._name = value\n\n    @name.deleter<\/span>\n    def<\/span> name<\/span>(self)<\/span>:<\/span>\n        del<\/span> self._name<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
In the Person<\/code> class, we use the @name.deleter<\/code> decorator. Inside the deleter, we use the del<\/code> keyword to delete the _name<\/code> attribute of the Person<\/code> instance.<\/p>\n\n\n\n
The following shows the __dict__<\/code> of the Person<\/code> class:<\/p>\n\n\n
pprint(Person.__dict__)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
mappingproxy({'__dict__'<\/span>: <attribute '__dict__'<\/span> of 'Person'<\/span> objects>,\n              '__doc__'<\/span>: None<\/span>,\n              '__init__'<\/span>: <function Person.__init__ at 0x000001DC41D62670<\/span>>,\n              '__module__'<\/span>: '__main__'<\/span>,\n              '__weakref__'<\/span>: <attribute '__weakref__'<\/span> of 'Person'<\/span> objects>,\n              'name'<\/span>: <property object at 0x000001DC41C89130<\/span>>})<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The Person.__dict__<\/code> class has the name<\/code> variable. The following creates a new instance of the Person<\/code> class:<\/p>\n\n\n
person = Person('John'<\/span>)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The person.__dict__<\/code> has the _name<\/code> attribute:<\/p>\n\n\n
pprint(person.__dict__)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
{'_name'<\/span>: 'John'<\/span>}<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
The following uses the del<\/code> keyword to delete the name<\/code> property:<\/p>\n\n\n
del<\/span> person.name<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Internally, Python will execute the deleter<\/code> method that deletes the _name<\/code> attribute from the person<\/code> object. The person.__dict__<\/code> will be empty like this:<\/p>\n\n\n
{}<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
And if you attempt to access name<\/code> property again, you’ll get an error:<\/p>\n\n\n
print(person.name)<\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Error:<\/p>\n\n\n
AttributeError: 'Person'<\/span> object has no attribute '_name'<\/span><\/code><\/span>Code language:<\/span> Python<\/span> (<\/span>python<\/span>)<\/span><\/small><\/pre>\n\n\n
Summary #<\/a><\/h2>\n\n\n\n