Skip to main content

When is it necessary to define __getattr__() and __setattr()__ methods for a class?

The official Python Programming FAQ advises the programmer to define the methods object.__getattr__(self, name) and object.__setattr__(self, name, value) under certain circumstances when implementing the OOP concept of delegation. However, I can't find good general advice on when defining these two methods is necessary, customary, or useful.


The Python Programming FAQ's example is the following code

class UpperOut:

    def __init__(self, outfile):
        self._outfile = outfile

    def write(self, s):
        self._outfile.write(s.upper())

    def __getattr__(self, name):
        return getattr(self._outfile, name)

"to implement[] a class that behaves like a file but converts all written data to uppercase". The accompanying text also contains a vague note telling the programmer to define __setattr__ in a careful way whenever attributes need to be set/modified (as opposed to just being read).

One question about this code is why their example doesn't use inheritance, which would presumably take care of what __getattr__ does. However, as one commenter kindly pointed out, file doesn't exist as a distinct type in Python 3, which may point us to an answer: Maybe they wanted to illustrate pure delegation (that is: delegation without inheritance) as one use case of overwriting __getattr__ and __setattr__. (If one uses plain inheritance, attributes are inherited by default and hence don't need to be accessed explicitly via calls to __getattr__ or __setattr__.)

For reference, a definition of "delegation" from Wikipedia is the following:

In object-oriented programming, delegation refers to evaluating a member [...] of one object [...] in the context of another [...] object [...]. Delegation can be done explicitly [...]; or implicitly, by the member lookup rules of the language [...]. Implicit delegation is the fundamental method for behavior reuse in prototype-based programming, corresponding to inheritance in class-based programming.

Even though the two concepts are often discussed together, delegation is not the same as inheritance:

The term "inheritance" is loosely used for both class-based and prototype-based programming, but in narrow use the term is reserved for class-based programming (one class inherits from another), with the corresponding technique in prototype-based programming being instead called delegation (one object delegates to another).

Note that delegation is uncommon in Python.


Note that this question on this site is about use cases of vanilla getattr(object, name) and setattr(object, name, value) and is not directly related.



source https://stackoverflow.com/questions/75531642/when-is-it-necessary-to-define-getattr-and-setattr-methods-for-a-cla

Comments

Popular posts from this blog

Confusion between commands.Bot and discord.Client | Which one should I use?

Whenever you look at YouTube tutorials or code from this website there is a real variation. Some developers use client = discord.Client(intents=intents) while the others use bot = commands.Bot(command_prefix="something", intents=intents) . Now I know slightly about the difference but I get errors from different places from my code when I use either of them and its confusing. Especially since there has a few changes over the years in discord.py it is hard to find the real difference. I tried sticking to discord.Client then I found that there are more features in commands.Bot . Then I found errors when using commands.Bot . An example of this is: When I try to use commands.Bot client = commands.Bot(command_prefix=">",intents=intents) async def load(): for filename in os.listdir("./Cogs"): if filename.endswith(".py"): client.load_extension(f"Cogs.{filename[:-3]}") The above doesnt giveany response from my Cogs ...

How to show number of registered users in Laravel based on usertype?

i'm trying to display data from the database in the admin dashboard i used this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count(); echo $users; ?> and i have successfully get the correct data from the database but what if i want to display a specific data for example in this user table there is "usertype" that specify if the user is normal user or admin i want to user the same code above but to display a specific usertype i tried this: <?php use Illuminate\Support\Facades\DB; $users = DB::table('users')->count()->WHERE usertype =admin; echo $users; ?> but it didn't work, what am i doing wrong? source https://stackoverflow.com/questions/68199726/how-to-show-number-of-registered-users-in-laravel-based-on-usertype

Where and how is this Laravel kernel constructor called? [closed]

Where and how is this Laravel kernel constructor called? public fucntion __construct(Application $app, $Router $roouter) { } I have read the documentation and some online tutorial but I can find any clear explanation. I am learning Laravel and I am wondering where does this kernel constructor receives its arguments from. "POSTMOTERM" CLARIFICATION: Here is more clarity.I have checked the boostrap/app.php and it is only used for boostrapping the interfaces into the container class. What is not clear to me is where and how the Kernel class is instatiated and the arguments passed to the object calling the constructor.Something similar to; obj = new kernel(arg1,arg2) or, is the framework using some magic functions somewhere? Special gratitude to those who burn their eyeballs and brain cells on this trivia before it goes into a full blown menopause alias "MARKED AS DUPLICATE". To some of the itchy-finger keyboard warriors, a.k.a The mods,because I believe in th...