Скачать или смотреть Accessor and Mutator Methods in Python: A Guide to Naming Conventions

Discover the best practices for naming accessor and mutator methods in Python, especially if you're coming from an object-oriented background.
---
This video is based on the question https://stackoverflow.com/q/68958783/ asked by the user 'Kim Mens' ( https://stackoverflow.com/u/13339955/ ) and on the answer https://stackoverflow.com/a/68959370/ provided by the user 'BatWannaBe' ( https://stackoverflow.com/u/4132144/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Naming convention for accessor methods in Python

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Understanding Accessor and Mutator Methods in Python

If you have a background in object-oriented programming languages like Java, Ruby, or Smalltalk, you may be wondering about the preferred naming conventions for accessor and mutator methods in Python. In this guide, we will clarify the best practices for naming these methods, discuss their relevance, and explore if you need them at all when dealing with public attributes. Let's dive into it!

Naming Accessor Methods

In programming, accessor methods (often referred to as "getters") are used to retrieve the values of private attributes. Depending on your background, you may have different expectations for naming conventions. Here are some key points to consider:

Traditional Approach: In languages like Smalltalk and Ruby, it is common to name the accessor method directly after the attribute it represents. For example, you might name the method that retrieves the __owner attribute simply as owner().

Java Convention: Conversely, Java developers typically use the prefix get_, resulting in method names like get_owner() which follows the naming convention in Java. This typically provides more clarity on the functionality.

Example of Accessor Method

Let's take a look at a sample class to illustrate naming conventions:

[[See Video to Reveal this Text or Code Snippet]]

In Python, however, there is a common sentiment that private attributes aren't emphasized as much, and many developers prefer a more straightforward design.

Naming Mutator Methods

Mutator methods (also known as "setters") are used to modify the values of attributes. The considerations for naming these methods are similar to those for accessors:

You may either use a direct naming approach (e.g., owner() for setting the __owner) or follow the Java convention and opt for set_owner().

Example of Mutator Method

Using a mutator in your class might look like this:

[[See Video to Reveal this Text or Code Snippet]]

Public Attributes and the Need for Methods

If your attributes are public, such as:

[[See Video to Reveal this Text or Code Snippet]]

You might wonder whether it's necessary to define accessor and mutator methods. In Python, public attributes can be accessed and modified directly as follows:

[[See Video to Reveal this Text or Code Snippet]]

Should You Still Write Accessor and Mutator Methods?

Redundancy: Since public attributes can be accessed and modified directly, additional methods can seem redundant.

Use Cases: However, if you need to enforce validation or encapsulate logic when getting or setting an attribute, methods can still be relevant.

When to Use Properties

Python also provides a way to handle attributes and methods elegantly through properties. Properties can be used to create a custom getter and setter while still allowing attribute-like access.

Example of Properties

Here's a practical example using a temperature class:

[[See Video to Reveal this Text or Code Snippet]]

Why Use Properties?

Ease of Access: Properties allow you to access methods in the same way you would attributes, improving readability.

Complex Logic: They provide a convenient way to calculate values on the fly without storing additional data.

Conclusion

In summary, while naming conventions for accessor and mutator methods in Python can differ from other languages, the primary focus should remain on readability, simplicity, and the specific needs of your application. Use properties when you need encapsulation or when implementing logic that enhances the functionality of your attributes.

Feel free to explore these conventions and choose the ones that best suit your programming style and project requirements!