The Ultimate Guide to Writing Classes in Python
HTML-код
- Опубликовано: 5 июн 2024
- In this video, I'll share 5 essential tips for writing Python classes that will help you take your object-oriented programming skills to the next level.
Git Repo ➡️ git.arjan.codes/2023/classguide
👷 Join the FREE Code Diagnosis Workshop to help you review code more effectively using my 3-Factor Diagnosis Framework: www.arjancodes.com/diagnosis
💻 ArjanCodes Blog: www.arjancodes.com/blog
✍🏻 Take a quiz on this topic: www.learntail.com/quiz/qcitkg
🎓 Courses:
The Software Designer Mindset: www.arjancodes.com/mindset
The Software Designer Mindset Team Packages: www.arjancodes.com/sas
The Software Architect Mindset: Pre-register now! www.arjancodes.com/architect
Next Level Python: Become a Python Expert: www.arjancodes.com/next-level...
The 30-Day Design Challenge: www.arjancodes.com/30ddc
🛒 GEAR & RECOMMENDED BOOKS: kit.co/arjancodes.
👍 If you enjoyed this content, give this video a like. If you want to watch more of my upcoming videos, consider subscribing to my channel!
💬 Discord: discord.arjan.codes
🐦Twitter: / arjancodes
🌍LinkedIn: / arjancodes
🕵Facebook: / arjancodes
📱Instagram: / arjancodes
♪ Tiktok: / arjancodes
👀 Code reviewers:
- Yoriz
- Ryan Laursen
- Dale Hagglund
🎥 Video edited by Mark Bacskai: / bacskaimark
🔖 Chapters:
0:00 Intro
0:54 Keep your classes small
8:43 Make your classes easy to use
14:18 Use dependency injection
17:46 Make sure a class is actually needed
22:45 Use encapsulation
24:57 Outro
#arjancodes #softwaredesign #python
DISCLAIMER - The links in this description might be affiliate links. If you purchase a product or service through one of those links, I may receive a small commission. There is no additional charge to you. Thanks for supporting my channel so I can continue to provide you with free content each week!
👷 Join the FREE Code Diagnosis Workshop to help you review code more effectively using my 3-Factor Diagnosis Framework: www.arjancodes.com/diagnosis
"Let's split a person in three different parts", "Let's look at the body"... Just normal software developer vocabulary...
Lol
Just when I thought the code couldn't be refactored any further, I looked at the timestamp and realised that I had 20 minutes of the video left.
Thank you. I always learn so much from you.
Loved the video!
Thank you so much Femi!
I could argue on the PhourthPhart "Make sure a class is actually needed" in your example and in my opinion, the class was much simpler, connected, and easy to scale, but with functions, you made it hard to use.
Exactly what I was going to say.
Although I appreciate it's difficult finding a good example in videos like this.
I agree. Using just the class was a more natural way, something anybody who comes expects how to use. The functions approach with the usage of 'partial' is very weird, even if it is a knownthing in the python world.
I really love this kind of videos, where the code is improved while you explain the concepts.
These videos are awesome. Your pragmatic approach to teaching python through practical examples is quite frankly...awesome. Keep up the good work. I am an established programmer but still learning a lot from your dedication to the craft of coding,.
Thank you so much for sharing this! 💗
The leading double underscores (and name mangling) is not at all meant to make things private, but rather to allow child classes to use that attribute as well.
If you want to communicate that a certain method or attribute "is only meant for internal usage", a single leading underscore will do just fine. It will not be shown as part of the `__all__` variable, but it's also accessible. The best thing about not having private attributes in Python? Freedom.
I've been coding Python for 2+ years at work, and these videos still teach me new stuff. Appreciate it.
Great work @Arjan,
I have the impression that people often refuse to learn about OOP or stay away from it as much as possible as its complicated, but you clearly highlight using relevant use cases that this need not be the case. Thanks a lot for your work.
Also, it appears worthwhile to take a deep dive into functools.
Your tutorials are really handy. I cannot get enough of them, even at 3am on a Saturday morning.
Any chance one can inspire you on a course about OOP and advanced concepts like multiple inheritance, the proper way of using ABC's and other advanced decorators?
The double leading underscores are for Private Name Mangling and not for encapsulation, even if the name seems to suggest that. It is intended to avoid name clashes in Multiple-Inheritance scenarios. The leading single underscore is to tell the user of a class that they probably shouldn't use this attribute because it is an implementation detail and may change without notice. Real encapsulation is neither possible not wanted by anyone. As Guido always says: We're all consenting adults.
When writing large applications, I use small classes and a related module with functions. The resulting memory imprint is lighter, because the class instances require only the barely necessary fields, and the modules can be imported once to handle all class instances.
I agree with you that when writing EmailSender = Callable[[str, str, str], None] you lose precious documentation about the arguments. Just by looking at this line, I have no idea what the arguments are, whereas it's perfectly clear using a Protocol.
One way I've dealt with it in the past was doing something like this:
ToEmail = str
EmailSubject = str
EmailBody = str
EmailSender = Callable[[ToEmail, EmailSubject, EmailBody], None]
This way it's clear again what the arguments are. I find it also clearer to define a function using a Callable compared to using a Protocol with __call__. I don't think it's perfect, tough, because I need to define a lot of type aliases here...
What do you think? I'm curious about your opinions :)
I like that suggestion! It does solve the problem nicely. The only issue I see with this is that it’s actuality no longer clear what the types are: you now have to figure out that ToEmail is a string and not something else. Still a nice idea though, I hadn’t thought of this.
Well, you have "ToEmail = str" just three lines above, so in my opinion it's still quite still what the type is. But I agree that this might just "move" the confusion elsewhere :)
"The fourth thing" repetition was awesome. Reminded me of friends of mine in college from Germany, who had to concentrate to make the "th" sound. They even made fun of themselves as you did.
Great lesson. The info is useful, but the way you are explaining the issues is amazing and efficient. Thank you.
I like the "if your class has 2 methods and one of them is init, you should probably just use a function" approach. Ofc if you need multiple instances of sth or are writing interfaces or sth that's another story.
Great class on classes!
Thank you kindly for your dedication to sharing knowledge!
You have made my progress with python so much easier.
Your production value is a clear breath of fresh air in a category mainly dominated by Indian RUclipsrs
Thank you so much!
I don't always write classes in Python, but when I do, I 'init' for the long haul... (Patting myself on the back for that one). Thanks Arjan, for being a one-man university and stopping my Game of Thrones-length classes. (P.S.: I have another Python joke, but I'll have to 'return' to it later.)
Glad to hear you find the content helpful. I eagerly 'await' your next joke!
I'm 'listening' for any new joke events
I’ve ‘yielded’
these jokes are a bit ‘abstract’
Another awesome video by Arjan! I love so much these videos. I’m trying to get my company to do your course for my team :)🎉
Great video! I didn't know about the lru_cache or cached_property that is really cool. Also didn't know you could type hint with a callable or instead use a class with __call__. I had heard of the double underscore attribute but didn't know it changed the naming like that. That is a lot of great information.
Thank you!
Hi Arjan!
Love your videos, im watching 32/244 of your videos right now,
just to thank you for all the content to make!
Thanks a lot!
Thank you, I'm glad that they are helpful!
Great video, thanks! Would really like to see another go into a bit more detail on how to make clever use of ‘partial’
Great content @Arjan. Clear and well explained!
Great video as usual, I do have 2 thoughts I would like some feedback on please.
1. It feels strange to move the bmi out to enable caching, is there no better way to have the method be cached, but invalidated when any property (or the relevant properties) are modified in the object? The @cache only returns the same result for the same input, I guess that does not work for the method (or cached_property) even though the "self" would be modified when the weight/height is modified?
2. It feels like a hack to another kind of uneeded Protocol class with __call__ to be able to use the email service as a function all to avoid another, somewhat unnecessary, class. Would it not be better (if possible) to use the typing library and NewType to make it more clear what the parameters in the Callable should be?
+1 to get a feedback on your questions
Another reason (for me) to use a class in Python, even if I only create a single instance, is when I have to keep track of a lot of state information that is modified by a bunch of methods.
For example, think of an emulator for a microcontroller. You have a bunch of variables representing your registers, and functions implementing the individual opcodes that in turn modify your "registers". Sure, every function could use a bunch of "global" statements to get access to these variables, or you could create some object that contains all the data you need and explicitly pass it to the functions (basically hand-crafting the "self"), but for me, just having an object that keeps track of everything, both data and behavior, internally seems to be a better choice. just having an instruction like "cpu.mov_a_constant(value:int)" load a constant (passed as a parameter) into the internal representation of the a register (whatever that is) seemed to be the cleanest to me.
I am *not* saying you are wrong about creating classes making sense when you plan on creating more than one instance, because I agree that this is the most important reason to do it. But I think there can be other (likely very specific) reasons to do so.
Nice video again. Really liked the part about using a module. One of the reasons I often find for classes are context managers. Do you happen to know if one could implement this in your module example as well. Although while thinking about it I don't see a use case for this 😅
I sincerely like the fact that this example is done using a calculation as an engineer this makes it more relatable for me. I am working to implement your concepts in my code. Thank you Arjan.
Thank you too!
Thanks Arjan. I liked the phorfth fthing the most.
This video is amazing. Great examples that seem a bit more real world vs the
class Car:
Color
Year
Examples that aren't helping me as I write my first program with classes (blackjack). Thank you
Great Job !
U provide so much great insight, i love all ur videos. Im starting to learn rust, but is also nice to see how to design code in the language i understand the best
U have helped me become a much better dev, i just wanted to say thanks 😊
I'm happy to hear that I've been helpful in your learning journey :)
Generally I try to avoid creating function in an object oriented code unless if they are very generic and could be applied to several classes. In your case, I wouldn't create bmi functions since the bmi calculation matches pretty well with the Stats class.
Started using errorlens in vscode which IMO is a nicer way to see errors vs just squiggly lines 👍
Very nice video. I would like to have video about pattern, especially multiton pattern. Thank you !!
Thank so much. I am trying to integrate what he has been teaching and the video is a reminder that I am on the right approach.
Thank you, Aung!
Awesome video. Really liked all the tips. Ive been recently refactoring some code so this is good timing.
Thank you! 💗
Amazing one! Thanks a lot! Especially for the abstraction part :-)
Thank you! ❤️
Great vid! Always love your clarity of examples. One small nit, that pylint helped me stop doing. Whenever you have an if condition: return, there shouldn't be an elif below it for another return, it should just be multiple if statements. See pylint R1705 no-else-return
Idk about cached_property decorator before 12:09. Thanks for share!
Amazing content, learning so much from this and also the first time i see an IRL Syntax error 17:42 😂
Fantastic explanations!
Thanks, I'm happy you enjoyed the content!
Thank you
This is great masterclass!
Thank you! 💗
You just leave me breathless... This video is more exciting than all John Wicks. Thank you for knowledge and inspiration 🙏
Oh wow, thank you!
Smell awesome will look soon!
Misclicked the video lol
Great job Arjan 🎉 tks
Glad you liked it!
Love that you sold this on "Ultimate Class Guide" and low key slipped in "Secret Guide to Functions"
I've written a piece of code that defines a class which I utilize to generate a single instance upon receiving a translation request. I chose to structure this as a class because each request embodies a node topology, where each sub-node carries distinct types, and thus, distinct rules and responsibilities. This class-based design helps maintain the integrity of the structure and its associated rules. However, I'm curious about your opinion on this. Do you think employing modules with methods could be a more effective approach?
20:31 is turning Callable to class EmailSender(protocol) good practice? If i read the typehint then jump to this definition, i would think that variable it's hinting is a class instance, when it's actually a function. Making it a class with __call__ to have better documentation of arguments seems to cause more trouble than it's worth.
21:32 Can i understand partial as analogous to inheritance in classes? If the business logic changes. it feels like more edits are needed to get the partial API correct compared to classes, or isit the same?
Just want to say great video! Subscribed.
❤️
Caching the float values for height/weight/bmi seems ineffective since the cache might be prone to floating point estimation error misses
Great as always, ❤️
Thank you! ❤️
You can enforce encapsulation by doing clever things with custom annotations.
I see you're using VimMotions (or something similar). Imo it's a very good next step to get used to for hour audience (intermediate developers). Maybe you could run through that in a guide / series
Holy crap, a lot to unpack but amazing explanation and code example.
Thank you for the kind words! Just take it one step at a time :)
18:22 you mentioned using modules in case you need just one instance, but what if you need to defer loading the variables for when actually used.
Similar to properties or functions. And you don't want to use functions because those variables store simple objects/strings. Or simple dictionary access. But you really don't want to compute them on import as they could fail. So class it is? Or is there another approach?
Thanks for video.
I love that you don’t edit out the tongue breakers like fourth thing 😂 really great explanations again
Those are the most fun ☺️
Hi Arjan, greetings from Germany! You are doing an amazing job with this channel and I am recommending it a lot:
Regarding the current video with the function bmi_category, I would like to know your opinion or your suggestion. I hate all this if-elif-else stuff, so I try to do something around.
here is my idea:
def bmi_category(bmi_value: float) -> str:
_category = {
'Underweight': lambda __: 0 < __ < 18.5,
'Normal': lambda __: 18.5 < __ < 25.0,
'Overweight': lambda __: 25.0 < __ < 30.0,
'Obese': lambda __: 30.0 < __
}
return ''.join(_k for _k, _v in _category.items() if _v(bmi_value))
print(bmi_category(17)) # Underweight
print(bmi_category(19)) # Normal
print(bmi_category(27)) # Overweight
print(bmi_category(50)) # Obese
print(bmi_category(-14)) # '' => empty string
What do you think?
@ArjanCodes I two questions. Do you speed up the video when you are typing? What's your average WPM typing speed? 😮
Great
Hi Arjan, Great content as always! I have a question for you:
I noticed that VS code sometimes gives you indications when you break rules regarding to type. Im guessing that it's an extension because mine doesn't behave that way. If so, can you please send it's name? thank you!!
Brilliant tutorial as usual.
Thank you, Joel!
Love the vid! what's that slick extension that auto suggests the python code? Seems very handy!
It is handy :). It's called Fig.
@@ArjanCodes Greatly appreciated! Keep up the great vids :)
Thanks from a PayPal engineer refactoring Python code
Thank you so much!
you are too good boss..
Love your videos. NOOB question please: I use dictionaries a lot (I love them) - instead of a dictionary, where relevant, perhaps should I be using a dataclass?
If you are creating dictionaries as a way to get away from creating a structure, definitely. Through classes you get autocomplete, getters and setters and what not but if the purpose is to store 2 values and pass it on I would at least use a named tuple
thnx for the vid, you always query for a known instance of class object in memory, what if you had a huge python list of things (lists are strings, not instantiated objects in memory) and you wanted to pass that list in a for loop to query your class to return attribute info for class objects that match the strings, like querying a database, how do you do that without getting str attribute errors? Not one class tutorial on youtube explains this? Thanks
I've had issues with mypy failing to typecheck partial functions. As a result, I tend to use factories instead - I'll write a function that contains a nested function, and returns the nested function as a closure.
Not sure if I used all those words correctly... :D
def email_sender(smtp_server: str, port: str, email: str password: str) -> EmailSender:
def send_message(to_email: str, subject: str, body: str) -> None:
send_email(smtp_server=smtp_server, port=port, email=email, password=password, to_email=to_email, subject=subject, body=body)
return send_message
Hi Arjan great Video. We should replace "THE" by "beh" :-) No idea where this word "the" comes from ??? CU Leonardo from Germany
Nicee
Here atr some wishes from me ...okay okay it's not christmas time. 1. handling languages (tranalations) in a sw-product an it's maintance 2. Working with Interaces to other products (json, XML, API,direct Access as SAP-BAPIs, ...) 3.Error handling in Python (central vs decentral)? Thanks have a great time in Amsterdam
LOL the thumbnail.
10 Points to Gryffindor...
🪄 😉
What is your opinion of Static methods? Not to be too inflexible, but they seem to violate the principle of creating small, single purpose classes. Maybe they are necessary in other languages?
I would say they are just like any other method; if they "belong to" the class conceptually, implement them instead of factoring them out as functions. By tagging them @staticmethod you are basically communicating: "this method will not change my class state". I would use @property only if the calculation inside is fast, because a user will not expect accesing a property to be taking a long time. If that is the case use static methods.
I thought you’d like the lru_cache and property comment.
I’m glad Python is all open source.
Great video! What do you think about DI frameworks in python?
I use DI, initially I was against it, but after starting to use, it is a must-have for my services.
@@pelissargiosergio yeah, but what lib, or no lib at all?
@@maikwiesmueller python-dependency-injector, I use this lib.
Been hobby coding for two years now and had no idea half of this stuff existed.
Hey man
I just wanted to say
you're so awesome
Thank you for the kind words ahah!
What about methods that span multiple classes, what’s the best way to handle that?
logo looks beautiful
Thank you!
lru_cache on bmi function was a nice joke ;) replace 3 arithmetic operations with wrapper and fiddling cache dict and store all old values for what?
Not sure why the type checker did not pick up on this, but technically your EmailSender Protocol (the __call__ variant) around 21:00 is lying to consumers of that type, because it looks like you can provide positional arguments to the supplied partial function, but you actually need to provide keyword arguments (otherwise running into the crash you showcased in the video). You can enforce keyword-only arguments as follows:
def f(*, a):
...
Here, the function f will take one keyword-only argument a.
What's the autocompletion vscode extension ?
It's called Fig!
Why put the instance of Stats into the Person class if you are going to call it directly?
legend legend legend
Arjan i dont understand your love of neon lights man, anyways long ttime fan here
I was rejected because I used dependency injection instead of instantiating a service class in the main class of a 48hours home work for a tech job. What do you guys think? ( bit stock trading company )
Okay, watched through once. Now to rewatch to let it all sink in. For some reason I get intimidated by the idea of writing classes, I _think_ because I worry I'll choose the wrong cognitive model for a problem and then paint myself into a corner. But every time I see good Python class content, it gets me closer to being comfortable.
Like for video and for video preview))))
Thank you! 😎
Really cool lesson, as always!
One thing I personally like to do in situations like the "bmi_category" example is to actually create a variable to "cache" the value. Something like:
@property(self) -> str:
bmi = self.bmi
if bmi < 18.5:
...
By doing this way we don't need to use the caching approach using decorators... It'd require to be done in each method, yes, but if we have only one (like in this case), I think it's a better solution!
calling a method straight from the stats instance outside the person would lead to unexpected behavior.
Why are you using static information? For create person.
Amazing thumbnail lol
Haha, thanks :)
why not an id attr in Person?
This comment is not a criticism of the purpose of the video -- just a (subjective) suggestion for viewers who read these comments. The name "Biometrics" might be a better name for what Arjan called the "Stats" class, since it's more specific to what the class represents. In most contexts, "stats" often refers to the data which *changes*. In medicine, it's things like heart rate, blood pressure, amounts of stuff in blood tests, etc. It is usually worth the time to think of good class names, since it's a real pain to change them 150 commits later into your project when you realize that "Stats" would be the perfect name for a class containing a set of regularly measured/changing data.
im a bit of a noob but why do your classes not have the constructor method?
I’m often using dataclasses. If you do that, the initializer is generated automatically.
Now try "the sixth toothpick".
TLDR:
No, there's no TLDR to this. Dont miss this brilliant talk 🙂. Its worth it !
Thank you so much!
I find _method is more commonly used for private (even though if you google it you will find articles that say _method is protected and __method is private). I don't think the concept of protected really exists in python in opinion
Great video as always too. I really love your content. I find that watching your video helps me better articulate my opinions to other developers.
_method() means "you probably shouldn't use this unless you know what you're doing", where __method() is very difficult to use outside the class as the name mangling means you have to access it with _ClassName__method(). Nevertheless, it is possible to access it, so it isn't truly private. It's just a super big red flag to use it outside the class.
where is __slots__ :(
I focused on design in this video. Slots is mostly a performance improvement, so I decided to leave it out.
Why did you complicate sending email from a lru_cache method, i appreciate the techniques but this feels unreadable and unnecessary 2x code.