Create a Java getter-setter generator using Python
Python's getters and setters are unique. They allow data encapsulation while others have hidden fields for private variables. <!--more--> Several object-oriented programming (OOP) languages use getters and setters to store data. We conceal an object class's attributes so other classes' methods do not alter data accidentally.
In object-oriented programming languages, these methods get and change data. Setting an object's attribute value is called setting. In this article, we will learn how to use Python's getter and setter methods.
Prerequisites
To follow along with this tutorial, you need to:
- Download the Python IDE or use an online compiler to run the code.
- Have a basic knowledge of Python and Java programming languages.
Table of contents
- Understanding getters and setters
- Get getters and setters behavior using normal functions
- Get getters and setters behavior using @Property decorators
- Get getters and setters behavior using the
property()function - Project algorithm
- Implementation of the algorithms
- Conclusion
Understanding getters and setters
The value which a getter method returns is its argument. This is useful for object-oriented programming private property access. A setter modifies a property's value.
It helps establish private class characteristics in object-oriented programming. Using getters and setters ensures there is data encapsulation.
Why we use setters and getters:
- To promote encapsulation.
- To keep the interface even if the internals change.
- To add validation logic to value acquisition and setting.
- To externalize the property's internal representation.
- To ensure there is no direct access or change to a class field.
- Access levels are configured using getters and setters.
Get getters and setters behavior using normal functions
If we use the standard get() and set() methods to get the getters and setters property, there will be no need for any extra specific implementation code.
class section:
def __init__(ascetic, span = 0):
ascetic._span = span
def get_span(ascetic):
return ascetic._span
def set_span(ascetic, k):
ascetic._span = k
kelvin = section()
kelvin.set_span(34)
print(kelvin.get_span())
print(kelvin._span)
Output:
34
34
In the above code functions get_span() and set_span() act as normal functions and don’t have any impact as getters and setters. To achieve such functionality Python has a special function called property().
Get getters and setters behavior using @Property decorators
To accomplish getters and setters behavior in the preceding approach, we utilized the property() function. Getters and setters are also used for verifying the getting and setting of attribute values, as stated before in this article.
Another option for implementing property functions is to use a decorator. One of the built-in decorators in Python is @property.
Any decorator's major goal is to update your class's methods or attributes in such a manner that your class's users don't have to change their code.
Below is an example code:
class Section:
def __init__(ascetic):
ascetic._span = 0
def get_span(ascetic):
print("The getters method")
return ascetic._span
def set_span(ascetic, k):
print("The setters method")
ascetic._span = k
def del_span(ascetic):
del ascetic._span
span = property(get_span, set_span, del_span)
kelvin = Section()
kelvin.span = 23
print(kelvin.span)
Output:
The setters method
The getters method
23
The above program has one print statement. The output has three lines since the setter method set_span() and the getter function get_span() were both invoked. So span is a property object that helps secure private variable access.
Get getters and setters behavior using the property() function
The prior technique used the property() method to achieve getters and setters. Getters and setters are used to check attribute values.
A decorator may impose property function, @property decorates Python. The main goal of a decorator is to change class methods or attributes without modifying user code.
class Section:
def __init__(ascetic):
ascetic._span = 0
@property
def span(ascetic):
print("The getters method")
return ascetic._span
@span.setter
def span(ascetic, k):
if(k < 20):
raise ValueError("the span is ineligible")
print("The setters method")
ascetic._span = k
kelvin = Section()
kelvin.span = 32
print(kelvin.span)
Output:
The setters method
The getters method
32
The @property decorator is used to construct Python getters and setters as shown in the code above. A ValueError is raised if the span is set to less than 32 in the previous example, which acts as validation code.
Project algorithm
In this project, we have a list of variable names and data types and must display all their getter-setter functions while adhering to fundamental Java programming rules.
To be able to do this, we follow the algorithm below:
- Transform the first character of each variable into an uppercase letter.
- Add the word "get" to the beginning of each variable that has been updated and put them in a list.
- Add the word "set" at the beginning of each variable that has been updated and save them in a list.
- Print the getter and setter methods for each variable and its corresponding datatype via string concatenation for each variable and its corresponding datatype.
Implementation of the algorithms
# Print getter and setter methods
def print_getter_setter(variables, datatypes):
# store the get and set variables
getters = []
setters = []
for var in variables:
# Prefix each variable with "get" and turn the initial character to uppercase.
getter = "get" + var[0].capitalize() + var[1:]
getters.append(getter)
# Prefix each variable with "set" and turn the initial character to uppercase.
setter = "set" + var[0].capitalize() + var[1:]
setters.append(setter)
for k in range(len(variables)):
# Print out the getter method
print("public " + datatypes[k] + " " + getters[k] +
"() {\n\treturn " + variables[k] + ";\n}\n")
# Print out the setter method
print("public void " + setters[k] + "(" + datatypes[k] +
" " + variables[k] + ") {\n\tthis." + variables[k] +
" = " + variables[k] + ";\n}\n")
if __name__=="__main__":
# A list of variables
variables = ["cdf", "stdID", "section", "y"]
# A list of datatypes
datatypes = ["int", "float", "double" , "String"]
print_getter_setter(variables, datatypes)
Output:
public int getCdf() {
return cdf;
}
public void setCdf(int cdf) {
this.cdf = cdf;
}
public float getStdID() {
return stdID;
}
public void setStdID(float stdID) {
this.stdID = stdID;
}
public double getSection() {
return section;
}
public void setSection(double section) {
this.section = section;
}
public String getY() {
return y;
}
public void setY(String y) {
this.y = y;
}
We can break down the program as shown below:
def print_getter_setter(variables, datatypes):- is a function that prints getter and setter methods for variables according to Java.getter = []andsetter = []- are used to store the set and get variables respectively.- After storing the variables, we prepend
getandsetin every variable and turn the initial character to uppercase. print("public " + datatypes[i] + " " + getters[i] + "() {\n\treturn " + variables[i] + ";\n}\n")- prints out the getter method.print("public void " + setters[i] + "(" + datatypes[i] + " " + variables[i] + ") {\n\tthis." + variables[i] + " = " + variables[i] + ";\n}\n")- prints out the setter method.if __name__=="__main__":- is the driver function.variables = ["abc", "empId", "GFG", "x"]- lists all the variables that are re-used as the output variables whiledatatypes = ["int", "float", "double" , "String"]lists the datatypes corresponding to the list of the variables.
Conclusion
In this article, we have learned what getters and setters are in the python programming language. We have also learned how to get getters and setters behavior using the property() function, @Property decorators, and finally using normal functions.
I urge the reader to use the knowledge gained to advance into getters and setters in other programming languages.
Happy coding!
Peer Review Contributions by: Dawe Daniel
