Prerequisite : Underscore in Python
In Python, there is no existence of “Private” instance variables which cannot be accessed except inside an object. However, a convention is being followed by most Python code and coders i.e., a name prefixed with an underscore, For e.g. _geek should be treated as a non-public part of the API or any Python code, whether it is a function, a method or a data member. While going through this we would also try to understand the concept of various forms of trailing underscores, for eg., for _ in range(10), __init__(self).
Mangling and how it works
In Python, there is something called name mangling, which means that there is a limited support for a valid use-case for class-private members basically to avoid name clashes of names with names defined by subclasses. Any identifier of the form __geek (at least two leading underscores or at most one trailing underscore) is replaced with _classname__geek, where classname is the current class name with leading underscore(s) stripped. As long as it occurs within the definition of the class, this mangling is done. This is helpful for letting subclasses override methods without breaking intraclass method calls.
Let’s look at this example and try to find out how this underscore works:
The mangling rules are designed mostly to avoid accidents but it is still possible to access or modify a variable that is considered private. This can even be useful in special circumstances, such as in the debugger.
_Single Leading Underscores
So basically one underline in the beginning of a method, function or data member means you shouldn’t access this method because it’s not part of the API. Let’s look at this snippet of code:
The snippet is taken from Django source code (django/forms/forms.py). This suggests that errors is a property, and it’s also a part of the API, but the method, _get_errors, is “private”, so one shouldn’t access it.
__Double Leading Underscores
Two underlines, in the beginning, cause a lot of confusion. This is about syntax rather than a convention. double underscore will mangle the attribute names of a class to avoid conflicts of attribute names between classes. For example:
__Double leading and Double trailing underscores__
There’s another case of double leading and trailing underscores. We follow this while using special variables or methods (called “magic method”) such as__len__, __init__. These methods provide special syntactic features to the names. For example, __file__ indicates the location of Python file, __eq__ is executed when a == b expression is executed.
This article is contributed by Chinmoy Lenka. If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to email@example.com. See your article appearing on the GeeksforGeeks main page and help other Geeks.
I have referred Python Docs, hackernoon.com and igorsobreira.com
Please write comments if you find anything incorrect, or you want to share more information about the topic discussed above.
- Private Methods in Python
- Access Modifiers in Python : Public, Private and Protected
- Python Variables
- Python Scope of Variables
- Class or Static Variables in Python
- Python | Extract key-value of dictionary in variables
- Python | Unpack whole list into variables
- Global and Local Variables in Python
- Python Program to Swap Two Variables
- Tracing Tkinter variables in Python
- How to assign values to variables in Python and other languages
- Swap two variables in one line in C/C++, Python, PHP and Java
- Inserting variables to database table using Python
- Python | Set 2 (Variables, Expressions, Conditions and Functions)
- How are variables stored in Python - Stack or Heap?
- Python - Pearson Correlation Test Between Two Variables
- Python - Construct variables of list elements
- Python | Assign multiple variables with list values
- Python | Difference between Pandas.copy() and copying through variables
- Python program to find number of local variables in a function