Decorator Getters and Setters in Python
One type of decorators are property getters and setters. These decorators allow for controlled access to variables in class instances.
Property getters and setters are designed specifically for the control of attributes in object-oriented programming. These are different from function decorators in that they are used for class attributes (check out my post on function decorators here).
Both function decorators and property getter and setter decorators modify code with reusable code and use '@' syntax. They both change functionality of the code.
Okay, let's get into it.
Property getters and setters are applied to methods within a class to define various behaviors. A setter sets the attribute to a value, and a getter grabs an attribute from a class. The attribute is set first.
Let's take a look at an example, and then we'll break it down:
class Shoe:
def __init__(self, brand = "Adidas", size = 9):
self.brand = brand
self.size = size
self._condition = "New"
@property
def size(self):
"""The size property"""
return self._size
@size.setter
def size(self, size):
"""size must be an integer"""
if isinstance(size, int):
self._size = size
else:
print("size must be an integer")
def cobble(self):
"""Repairs the shoe and sets the condition to 'New'."""
self.condition = "New"
print("Your shoe is as good as new!")
@property
def condition(self):
"""The condition property"""
return self._condition
@condition.setter
def condition(self, condition):
self._condition = condition
Let's go through some of this code:
The underscores before some of the attributes (condition, size) indicate to the developer that they are private; they are specific to each instance of the Shoe class (each shoe, lowercase).
You might notice that condition and size are instantiated differently. self._condition = "New" means that each instance (or object) of the shoe class is instantiated with a condition of "New". The same is done for the size attribute, but it is not written as self._size = 9 so that it will trigger the setter property validation, because size needs to be an integer (this is a process called validation). We are setting the condition of each individual shoe object directly, instead of running it through the property setter and getter methods.
The cobble method doesn't need a decorator because it is simply performing an action, not getting/setting an attribute of each shoe object.
Let's do one final change to our code. For example, what if we want to ensure that the size attribute cannot be changed later? After all, a shoe doesn't really change its size, does it?
We can use the hasattr() function to perform a check on each shoe object. Does it have a private attribute of size, indicated by the presence of '_size'? If so, it cannot be changed. Here is the code implemented:
@size.setter
def size(self, size):
"""size must be an integer and can't be changed once set"""
if hasattr(self, '_size'):
raise AttributeError("Can't change size once set")
if isinstance(size, int):
self._size = size
else:
raise ValueError("size must be an integer")
Property setters and getters are a bit challenging to grasp, but once understood, you will be coding Python like a pro!
Sources:
Flatiron school material
The above is the detailed content of Decorator Getters and Setters in Python. For more information, please follow other related articles on the PHP Chinese website!
Hot AI Tools
Undress AI Tool
Undress images for free
Undresser.AI Undress
AI-powered app for creating realistic nude photos
AI Clothes Remover
Online AI tool for removing clothes from photos.
Clothoff.io
AI clothes remover
Video Face Swap
Swap faces in any video effortlessly with our completely free AI face swap tool!
Hot Article
Hot Tools
Notepad++7.3.1
Easy-to-use and free code editor
SublimeText3 Chinese version
Chinese version, very easy to use
Zend Studio 13.0.1
Powerful PHP integrated development environment
Dreamweaver CS6
Visual web development tools
SublimeText3 Mac version
God-level code editing software (SublimeText3)
How to handle API authentication in Python
Jul 13, 2025 am 02:22 AM
The key to dealing with API authentication is to understand and use the authentication method correctly. 1. APIKey is the simplest authentication method, usually placed in the request header or URL parameters; 2. BasicAuth uses username and password for Base64 encoding transmission, which is suitable for internal systems; 3. OAuth2 needs to obtain the token first through client_id and client_secret, and then bring the BearerToken in the request header; 4. In order to deal with the token expiration, the token management class can be encapsulated and automatically refreshed the token; in short, selecting the appropriate method according to the document and safely storing the key information is the key.
Explain Python assertions.
Jul 07, 2025 am 12:14 AM
Assert is an assertion tool used in Python for debugging, and throws an AssertionError when the condition is not met. Its syntax is assert condition plus optional error information, which is suitable for internal logic verification such as parameter checking, status confirmation, etc., but cannot be used for security or user input checking, and should be used in conjunction with clear prompt information. It is only available for auxiliary debugging in the development stage rather than substituting exception handling.
What are Python type hints?
Jul 07, 2025 am 02:55 AM
TypehintsinPythonsolvetheproblemofambiguityandpotentialbugsindynamicallytypedcodebyallowingdeveloperstospecifyexpectedtypes.Theyenhancereadability,enableearlybugdetection,andimprovetoolingsupport.Typehintsareaddedusingacolon(:)forvariablesandparamete
How to iterate over two lists at once Python
Jul 09, 2025 am 01:13 AM
A common method to traverse two lists simultaneously in Python is to use the zip() function, which will pair multiple lists in order and be the shortest; if the list length is inconsistent, you can use itertools.zip_longest() to be the longest and fill in the missing values; combined with enumerate(), you can get the index at the same time. 1.zip() is concise and practical, suitable for paired data iteration; 2.zip_longest() can fill in the default value when dealing with inconsistent lengths; 3.enumerate(zip()) can obtain indexes during traversal, meeting the needs of a variety of complex scenarios.
What are python iterators?
Jul 08, 2025 am 02:56 AM
InPython,iteratorsareobjectsthatallowloopingthroughcollectionsbyimplementing__iter__()and__next__().1)Iteratorsworkviatheiteratorprotocol,using__iter__()toreturntheiteratorand__next__()toretrievethenextitemuntilStopIterationisraised.2)Aniterable(like
Python FastAPI tutorial
Jul 12, 2025 am 02:42 AM
To create modern and efficient APIs using Python, FastAPI is recommended; it is based on standard Python type prompts and can automatically generate documents, with excellent performance. After installing FastAPI and ASGI server uvicorn, you can write interface code. By defining routes, writing processing functions, and returning data, APIs can be quickly built. FastAPI supports a variety of HTTP methods and provides automatically generated SwaggerUI and ReDoc documentation systems. URL parameters can be captured through path definition, while query parameters can be implemented by setting default values for function parameters. The rational use of Pydantic models can help improve development efficiency and accuracy.
How to test an API with Python
Jul 12, 2025 am 02:47 AM
To test the API, you need to use Python's Requests library. The steps are to install the library, send requests, verify responses, set timeouts and retry. First, install the library through pipinstallrequests; then use requests.get() or requests.post() and other methods to send GET or POST requests; then check response.status_code and response.json() to ensure that the return result is in compliance with expectations; finally, add timeout parameters to set the timeout time, and combine the retrying library to achieve automatic retry to enhance stability.
Python variable scope in functions
Jul 12, 2025 am 02:49 AM
In Python, variables defined inside a function are local variables and are only valid within the function; externally defined are global variables that can be read anywhere. 1. Local variables are destroyed as the function is executed; 2. The function can access global variables but cannot be modified directly, so the global keyword is required; 3. If you want to modify outer function variables in nested functions, you need to use the nonlocal keyword; 4. Variables with the same name do not affect each other in different scopes; 5. Global must be declared when modifying global variables, otherwise UnboundLocalError error will be raised. Understanding these rules helps avoid bugs and write more reliable functions.
