Python: property() function

Last update on May 28 2022 12:43:31 (UTC/GMT +8 hours)

property() function

The property() function return a property attribute.

Version:

(Python 3.2.5)

Syntax:

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

Parameter:

Name	Description	Required / Optional
fget	function for getting the attribute value	Optional
fset	function for setting the attribute value	Optional
fdel	function for deleting the attribute value	Optional
doc	string that contains the documentation for the attribute.	Optional

Example: Python property() function

class Example:
    def __init__(self, name):
        self._name = name

    @property
    def name(self):
        print('Getting name')
        return self._name

    @name.setter
    def name(self, value):
        print('Setting name to ' + value)
        self._name = value

    @name.deleter
    def name(self):
        print('Deleting name')
        del self._name

x = Example('Bishop')
print('The name is:', x.name)

x.name = 'Anthony'

del x.name

Output:

Getting name
The name is: Bishop
Setting name to Anthony
Deleting name

Python Code Editor:

Previous: print()
Next: range()

Test your Python skills with w3resource's quiz

Python: Tips of the Day

Find current directory and file's directory:

To get the full path to the directory a Python file is contained in, write this in that file:

import os 
dir_path = os.path.dirname(os.path.realpath(__file__))

(Note that the incantation above won't work if you've already used os.chdir() to change your current working directory, since the value of the __file__ constant is relative to the current working directory and is not changed by an os.chdir() call.)

To get the current working directory use

import os
cwd = os.getcwd()

Documentation references for the modules, constants and functions used above:

The os and os.path modules.
The __file__ constant
os.path.realpath(path) (returns "the canonical path of the specified filename, eliminating any symbolic links encountered in the path")
os.path.dirname(path) (returns "the directory name of pathname path")
os.getcwd() (returns "a string representing the current working directory")
os.chdir(path) ("change the current working directory to path")

Ref: https://bit.ly/3fy0R6m