b09-classes

import%20marimo%0A%0A__generated_with%20%3D%20%220.25.0%22%0Aapp%20%3D%20marimo.App()%0A%0A%0A%40app.cell%0Adef%20_()%3A%0A%20%20%20%20import%20marimo%20as%20mo%0A%0A%20%20%20%20return%20(mo%2C)%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%20Object%20Orientation%20and%20Classes%0A%0A%20%20%20%20Leverage%20the%20power%20of%20Python%20by%20writing%20new%20classes.%0A%0A%20%20%20%20%23%23%20The%20Class%20of%20Classes%0A%0A%20%20%20%20Python%20is%20an%20inherently%20object-oriented%20language%20and%20makes%20the%20deployment%20of%20classes%20and%20objects%20extremely%20easy.%20This%20chapter%20introduces%20the%20concept%20of%20Python%20classes%2C%20starting%20with%20essential%20definitions.%0A%0A%20%20%20%20%23%23%23%20What%20is%20Object-Oriented%20Programming%20(OOP)%3F%0A%0A%20%20%20%20Object-Oriented%20Programming%20(OOP)%20is%20a%20programming%20paradigm%20that%20aligns%20the%20architecture%20of%20software%20with%20reality.%20Object%20orientation%20starts%20with%20the%20design%20of%20software%2C%20where%20a%20structured%20model%20is%20established.%20The%20structured%20model%20contains%20information%20about%20objects%20and%20their%20abstractions.%20The%20development%20and%20implementation%20of%20object-oriented%20software%20require%20a%20structured%20way%20of%20thinking%20and%20a%20conceptual%20understanding%20of%20classes%2C%20inheritance%2C%20polymorphism%2C%20and%20encapsulation.%0A%0A%20%20%20%20%23%23%23%20Objects%20and%20Classes%0A%0A%20%20%20%20In%20computer%20language%2C%20an%20**object**%20is%20an%20instance%20that%20contains%20data%20in%20the%20form%20of%20fields%20(called%20**attributes**%20or%20**properties**)%20and%20code%20in%20the%20form%20of%20features%20(**functions**%20or%20**methods**).%20In%20Python%2C%20an%20object%20is%20an%20instance%20of%20a%20class.%20A%20class%20defines%20behavior%20and%20can%20act%20as%20a%20blueprint%20for%20its%20instances.%20Attributes%20store%20object%20state%2C%20and%20methods%20are%20functions%20defined%20on%20the%20class%20that%20operate%20on%20instances.%20By%20convention%2C%20an%20instance%20method's%20first%20parameter%20is%20named%20%60self%60%3B%20Python%20supplies%20the%20instance%20for%20that%20argument%20when%20the%20method%20is%20called%20through%20an%20instance.%0A%0A%20%20%20%20Classes%20themselves%20are%20objects%20and%20consume%20memory.%20A%20class%20may%20define%20%60__init__%60%20to%20initialize%20a%20new%20instance%2C%20but%20an%20explicit%20%60__init__%60%20method%20is%20not%20required.%0A%0A%20%20%20%20!%5Bimg%5D(https%3A%2F%2Fraw.githubusercontent.com%2Fhydro-informatics%2Fmedia%2Fmain%2Fimg%2Fclasses-objects.png)%0A%0A%20%20%20%20The%20simplest%20form%20of%20a%20class%20in%20Python%20includes%20a%20few%20fundamental%20statements%20only%2C%20and%20it%20is%20highly%20recommended%20to%20add%20an%20%60__init__%60%20statement%20in%20which%20class%20variables%20are%20defined.%20We%20will%20come%20back%20to%20the%20%60__init__%60%20statement%20later%20in%20the%20section%20on%20*magic*%20methods.%20The%20following%20example%20shows%20one%20of%20the%20simplest%20possible%20class%20structures%20with%20an%20%60__init__%60%20method.%20Note%20the%20usage%20of%20%60self%60%20in%20the%20class%2C%20which%20becomes%20%60object_name.attribute%60%20for%20instances%20of%20the%20%60IceCream%60%20class.%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_()%3A%0A%20%20%20%20class%20IceCream%3A%0A%20%20%20%20%20%20%20%20def%20__init__(self%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.flavors%20%3D%20%5B%22vanilla%22%2C%20%22chocolate%22%2C%20%22bread%22%5D%0A%0A%20%20%20%20%20%20%20%20def%20add_flavor(self%2C%20flavor)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.flavors.append(flavor)%0A%20%20%20%20%0A%20%20%20%20%20%20%20%20def%20print_flavors(self)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20print(%22%2C%20%22.join(self.flavors))%0A%0A%20%20%20%20%23%20create%20an%20instance%20of%20IceCream%20and%20use%20the%20print_flavors%20method%0A%20%20%20%20some_scoops%20%3D%20IceCream()%0A%20%20%20%20some_scoops.add_flavor(%22lemon%22)%0A%0A%20%20%20%20%23%20the%20following%20statements%20have%20similar%20effects%0A%20%20%20%20some_scoops.print_flavors()%0A%20%20%20%20print(some_scoops.flavors)%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%23%23%20Inheritance%0A%20%20%20%20The%20%5BCambridge%20Dictionary%5D(https%3A%2F%2Fdictionary.cambridge.org%2F)%20defines%20inheritance%20(biology)%20as%20%22particular%20characteristics%20received%20from%20parents%20through%20genes%22.%20Similarly%2C%20inheritance%20in%20OOP%20describes%20the%20hierarchical%20relationship%20between%20classes%20with%20is-a-type-of%20relationships.%20For%20instance%2C%20a%20class%20called%20%60Salmon%60%20may%20inherit%20from%20a%20class%20called%20%60Fish%60.%20In%20this%20case%2C%20%60Fish%60%20is%20the%20parent%20class%20(or%20super-class)%20and%20%60Salmon%60%20is%20the%20child%20class%20(or%20sub-class)%2C%20where%20%60Fish%60%20might%20define%20attributes%20like%20%60preferred_flow_depth%60%20or%20%60preferred_flow_velocity%60%20with%20fuzzification%20methods%20describing%20other%20habitat%20preferences.%20Such%20class%20inheritance%20could%20look%20like%20this%3A%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_()%3A%0A%20%20%20%20%23%20define%20the%20parent%20class%20Fish%0A%20%20%20%20class%20Fish%3A%0A%20%20%20%20%20%20def%20__init__(self%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.preferred_flow_depth%20%3D%20float()%0A%20%20%20%20%20%20%20%20%20%20%20%20self.preferred_flow_velocity%20%3D%20float()%0A%20%20%20%20%20%20%20%20%20%20%20%20self.species%20%3D%20%22%22%0A%20%20%20%20%20%20%20%20%20%20%20%20self.xy_position%20%3D%20tuple()%0A%20%20%20%20%0A%20%20%20%20%20%20def%20print_habitat(self)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20print(%22The%20species%20%7B0%7D%20prefers%20%7B1%7Dm%20deep%20and%20%7B2%7Dm%2Fs%20fast%20flowing%20waters.%22.format(self.species%2C%20str(self.preferred_flow_depth)%2C%20str(self.preferred_flow_velocity)))%0A%20%20%20%20%0A%20%20%20%20%20%20def%20swim_to_position(self%2C%20new_position%3D())%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.xy_position%20%3D%20new_position%0A%0A%0A%20%20%20%20%23%20define%20the%20child%20class%20Salmon%2C%20which%20inherits%20(is-a-type-of)%20from%20Fish%0A%20%20%20%20class%20Salmon(Fish)%3A%0A%20%20%20%20%20%20def%20__init__(self%2C%20species%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%09%20%20super().__init__(*args%2C%20**kwargs)%0A%20%20%20%20%09%20%20self.family%20%3D%20%22Salmonidae%22%0A%20%20%20%20%09%20%20self.species%20%3D%20species%0A%0A%20%20%20%20%0A%20%20%20%20%20%20def%20habitat_function(self%2C%20depth%2C%20velocity)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.preferred_flow_depth%20%3D%20depth%0A%20%20%20%20%20%20%20%20%20%20%20%20self.preferred_flow_velocity%20%3D%20velocity%0A%0A%0A%20%20%20%20atlantic_salmon%20%3D%20Salmon(%22Salmo%20salar%22)%0A%20%20%20%20atlantic_salmon.habitat_function(depth%3D0.4%2C%20velocity%3D0.5)%0A%20%20%20%20atlantic_salmon.print_habitat()%0A%0A%20%20%20%20pacific_salmon%20%3D%20Salmon(%22Oncorhynchus%20tshawytscha%22)%0A%20%20%20%20pacific_salmon.habitat_function(depth%3D0.6%2C%20velocity%3D0.8)%0A%20%20%20%20pacific_salmon.print_habitat()%0A%20%20%20%20return%20(Fish%2C)%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%3E%20When%20a%20subclass%20defines%20%60__init__%60%2C%20call%20%60super().__init__(...)%60%20when%20the%20base%20class%20also%20needs%20initialization.%20This%20supports%20cooperative%20initialization%20and%20follows%20Python's%20method-resolution%20order.%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%23%23%20Polymorphism%0A%20%20%20%20Polymorphism%20allows%20different%20object%20types%20to%20support%20the%20same%20interface.%20A%20subclass%20that%20overrides%20an%20inherited%20method%20is%20one%20example.%20Python%20also%20commonly%20uses%20duck%20typing%3A%20unrelated%20classes%20can%20be%20used%20through%20the%20same%20operation%20when%20they%20provide%20the%20required%20methods%20or%20attributes.%20For%20instance%2C%20polymorphism%20in%20Python%20is%20when%20we%20re-define%20the%20%60swim_to_position%60%20function%20of%20the%20above-shown%20%60Fish%60%20parent%20class%20in%20the%20%60Salmon%60%20child%20class.%0A%0A%20%20%20%20%23%23%23%20Encapsulation%20(Public%20and%20Non-public%20Attributes)%0A%20%20%20%20The%20concept%20of%20encapsulation%20combines%20data%20and%20functions%20to%20manipulate%20data%2C%20whereby%20both%20(data%20and%20functions)%20are%20protected%20against%20external%20interference%20and%20manipulation.%20Encapsulation%20is%20also%20the%20baseline%20of%20%5Bdata%20hiding%5D(https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FInformation_hiding)%20in%20computer%20science%2C%20which%20segregates%20design%20decisions%20in%20software%20regarding%20objects%20that%20are%20likely%20to%20change.%0A%0A%20%20%20%20One%20of%20the%20most%20important%20aspects%20of%20encapsulation%20is%20the%20differentiation%20between%20%60private%60%20and%20%60public%60%20class%20variables.%20A%20%60private%60%20attribute%20cannot%20be%20modified%20from%20outside%20(i.e.%2C%20it%20is%20protected%20and%20cannot%20be%20changed%20for%20an%20instance%20of%20a%20class).%20Python%20does%20not%20enforce%20truly%20private%20instance%20attributes.%20A%20name%20such%20as%20%60_family%60%20is%20non-public%20by%20convention.%20A%20name%20such%20as%20%60__family%60%20is%20name-mangled%20to%20include%20the%20class%20name%2C%20mainly%20to%20reduce%20accidental%20clashes%20in%20subclasses%3B%20it%20can%20still%20be%20accessed%20deliberately.%20Properties%20can%20provide%20managed%20read%2C%20write%2C%20and%20delete%20behavior%20through%20getter%2C%20setter%2C%20and%20deleter%20functions.%0A%0A%20%20%20%20In%20the%20above%20example%20of%20the%20%60Salmon%60%20class%2C%20we%20use%20a%20public%20variable%20called%20%60self.family%60.%20However%2C%20the%20family%20attribute%20of%20the%20%60Salmon%60%20class%20is%20an%20attribute%20that%20should%20not%20be%20modifiable.%20Similar%20behavior%20would%20be%20desirable%20for%20an%20attribute%20called%20%60self.aggregate_state%20%3D%20%22frozen%22%60%20of%20the%20%60IceCream%60%20class.%20To%20familiarize%20with%20the%20concept%2C%20the%20following%20code%20block%20defines%20another%20child%20of%20the%20%60Fish%60%20class%20with%20a%20non-public%20%60__family%60%20attribute.%20The%20%60__family%60%20attribute%20is%20not%20directly%20accessible%20for%20instances%20of%20the%20new%20child%20class%20called%20%60Carp%60.%20Still%2C%20we%20want%20the%20%60Carp%60%20class%20to%20have%20a%20%60family%60%20attribute%20and%20we%20want%20to%20be%20able%20to%20print%20its%20value.%20This%20is%20why%20we%20need%20a%20special%20method%20%60def%20family(self)%60%2C%20which%20has%20the%20same%20name%20as%20the%20protected%20attribute%20and%20an%20%60%40property%60%20decorator.%20The%20below%20example%20features%20an%20additional%20special%20method%20called%20%60def%20family(self%2C%20value)%60%20that%20is%20embraced%20with%20a%20%60%40property.setter%60%20decorator%20and%20that%20enables%20re-defining%20the%20non-public%20%60__family%60%20property%20(even%20though%20this%20is%20logically%20nonsense%20because%20we%20do%20not%20want%20to%20enable%20renaming%20the%20%60__family%60%20property).%0A%0A%20%20%20%20%3E%20**What%20are%20decorators%20and%20wrappers%20again%3F**%20If%20you%20are%20hesitating%20to%20answer%20this%20question%2C%20refresh%20your%20memory%20in%20the%20chapter%20on%20%5Bfunctions%5D(https%3A%2F%2Fhydro-informatics.com%2Fpyfun%23wrappers).%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_(Fish)%3A%0A%20%20%20%20class%20Carp(Fish)%3A%0A%20%20%20%20%20%20%20%20def%20__init__(self%2C%20species%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20Fish.__init__(self)%0A%20%20%20%20%20%20%20%20%20%20%20%20self.__family%20%3D%20%22cyprinidae%22%0A%20%20%20%20%20%20%20%20%20%20%20%20self.species%20%3D%20species%0A%20%20%20%20%0A%20%20%20%20%20%20%20%20%40property%0A%20%20%20%20%20%20%20%20def%20family(self)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20self.__family%0A%0A%20%20%20%20%20%20%20%20%40family.setter%0A%20%20%20%20%20%20%20%20def%20family(self%2C%20value)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.__family%20%3D%20value%0A%20%20%20%20%20%20%20%20%20%20%20%20print(%22family%20set%20to%20%5C'%25s%5C'%22%20%25%20self.__family)%0A%20%20%20%20%0A%20%20%20%20%0A%20%20%20%20european_carp%20%3D%20Carp(%22Cyprinus%20carpio%20carpio%22)%0A%20%20%20%20print(european_carp.family)%0A%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20print(european_carp.__family)%0A%20%20%20%20except%20AttributeError%3A%0A%20%20%20%20%20%20%20%20print(%22__family%20is%20not%20directly%20accessible.%22)%0A%0A%20%20%20%20%23%20re-definition%20of%20__family%20through%20%40family.setter%20method%0A%20%20%20%20european_carp.family%3D%22lamnidae%22%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%23%20Decorators%0A%0A%20%20%20%20The%20%60%40property%60%20decorator%20defines%20a%20getter%2C%20so%20%60european_carp.family%60%20reads%20the%20value%20returned%20by%20the%20method.%20The%20%60%40family.setter%60%20decorator%20defines%20what%20happens%20when%20client%20code%20executes%20an%20assignment%20such%20as%20%60european_carp.family%20%3D%20%22Lamnidae%22%60.%0A%0A%20%20%20%20Until%20here%2C%20we%20only%20know%20decorators%20as%20an%20efficient%20way%20to%20simplify%20functions.%20However%2C%20decorators%20are%20an%20even%20more%20powerful%20tool%20in%20object-oriented%20programming%20of%20classes%2C%20in%20which%20decorators%20can%20be%20used%20to%20wrap%20class%20methods%20similar%20to%20functions.%20Let's%20define%20another%20child%20of%20the%20%60Fish%60%20class%20to%20explore%20the%20%60%40property%60%20decorator%20with%20its%20%60deleter%60%2C%20%60getter%60%2C%20and%20%60setter%60%20methods.%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_(Fish)%3A%0A%20%20%20%20class%20Bullhead(Fish)%3A%0A%20%20%20%20%20%20def%20__init__(self%2C%20species%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%09%20%20Fish.__init__(self)%0A%20%20%20%20%09%20%20self.__family%20%3D%20%22cottidae%22%0A%20%20%20%20%09%20%20self.species%20%3D%20species%0A%20%20%20%20%09%20%20self.__length%20%3D%207.0%0A%20%20%20%20%0A%20%20%20%20%20%20%40property%0A%20%20%20%20%20%20def%20length(self)%3A%0A%20%20%20%20%09%20%20return%20self.__length%0A%0A%20%20%20%20%20%20%40length.setter%0A%20%20%20%20%20%20def%20length(self%2C%20value)%3A%0A%20%20%20%20%09%20%20try%3A%0A%20%20%20%20%09%09%20%20self.__length%20%3D%20float(value)%0A%20%20%20%20%09%20%20except%20(TypeError%2C%20ValueError)%3A%0A%20%20%20%20%09%09%20%20print(%22Error%3A%20Value%20is%20not%20a%20real%20number.%22)%0A%0A%20%20%20%20%20%20%40length.deleter%0A%20%20%20%20%20%20def%20length(self)%3A%0A%20%20%20%20%09%20%20del%20self.__length%0A%0A%20%20%20%20%23%20Read%20through%20the%20getter%2C%20assign%20through%20the%20setter%2C%20and%20delete%20through%20the%20deleter%0A%20%20%20%20%0A%20%20%20%20european_bullhead%20%3D%20Bullhead(%22Cottus%20gobio%22)%0A%0A%20%20%20%20%23%20make%20use%20of%20%40property.getter%2C%20which%20directly%20results%20from%20the%20%40property-embraced%20def%20length%20method%0A%20%20%20%20print(european_bullhead.length)%0A%0A%20%20%20%20%23%20make%20use%20of%20%40property.setter%20method%0A%20%20%20%20european_bullhead.length%20%3D%206.5%0A%20%20%20%20print(european_bullhead.length)%0A%0A%20%20%20%20%23%20make%20use%20of%20%40property.delete%20method%0A%20%20%20%20del%20european_bullhead.length%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20print(european_bullhead.length)%0A%20%20%20%20except%20AttributeError%3A%0A%20%20%20%20%20%20%20%20print(%22Error%3A%20You%20cannot%20print%20a%20nonexistent%20property.%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%23%20Overloading%20and%20Magic%20Methods%0A%0A%20%20%20%20The%20above%20examples%20introduced%20a%20special%20or%20**magic**%20method%20called%20%60__init__%60.%20We%20have%20already%20seen%20that%20%60__init__%60%20is%20nothing%20magical%20itself%20and%20there%20are%20many%20more%20of%20such%20predefined%20methods%20in%20Python.%20Before%20we%20get%20to%20magic%20methods%2C%20it%20is%20important%20to%20understand%20the%20concept%20of%20overloading%20in%20Python.%20Did%20you%20already%20wonder%20why%20the%20same%20operator%20can%20have%20different%20effects%20depending%20on%20the%20data%20type%3F%20For%20instance%2C%20the%20%60%2B%60%20operator%20concatenates%20*strings*%2C%20but%20sums%20up%20numeric%20data%20types%3A%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_()%3A%0A%20%20%20%20a_string%20%3D%20%22vanilla%22%0A%20%20%20%20b_string%20%3D%20%22cream%22%0A%20%20%20%20print(%22%2B%20operator%20applied%20to%20strings%3A%20%22%20%2B%20str(a_string%20%2B%20b_string))%0A%0A%20%20%20%20a_number%20%3D%2050%0A%20%20%20%20b_number%20%3D%2030%0A%20%20%20%20print(%22%2B%20operator%20applied%20to%20integers%3A%20%22%20%2B%20str(a_number%20%2B%20b_number))%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20This%20behavior%20is%20called%20**operator%20(or%20function)%20overloading**%20in%20Python%20and%20overloading%20is%20possible%20because%20of%20pre-defined%20names%20of%20magic%20methods%20in%20Python.%20Now%2C%20we%20are%20ready%20to%20dive%20into%20the%20*magic*%20methods%20pool.%0A%0A%20%20%20%20Magic%20methods%20are%20one%20of%20the%20key%20elements%20that%20make%20Python%20easy%20and%20clear%20to%20use.%20Because%20of%20their%20declaration%20using%20double%20underscores%20(%60__this_is_magic__%60)%2C%20magic%20methods%20are%20also%20called%20**dunder**%20(**d**ouble%20**under**score)%20methods.%20Magic%20methods%20are%20special%20methods%20with%20fixed%20names%20and%20their%20*magic*%20name%20is%20because%20they%20do%20not%20need%20to%20be%20directly%20invoked.%20Behind%20the%20scenes%2C%20Python%20constantly%20uses%20magic%20methods%2C%20for%20example%2C%20when%20a%20new%20instance%20of%20a%20class%20is%20assigned%3A%20When%20%60var%20%3D%20MyClass()%60%20is%20evaluated%2C%20Python%20calls%20%60MyClass.__new__%60%20to%20create%20an%20instance.%20If%20%60__new__%60%20returns%20an%20instance%20of%20%60MyClass%60%2C%20Python%20then%20calls%20%60MyClass.__init__%60%20to%20initialize%20it.%20For%20%60a%20%2B%20b%60%2C%20Python%20first%20tries%20%60a.__add__(b)%60%3B%20if%20that%20returns%20%60NotImplemented%60%2C%20Python%20may%20try%20the%20reflected%20operation%20%60b.__radd__(a)%60%20before%20raising%20%60TypeError%60.%0A%0A%20%20%20%20The%20following%20sections%20list%20some%20documented%20magic%20methods%20for%20use%20in%20classes%20and%20packages.%20These%20are%20only%20some%20of%20the%20most%20common%20magic%20methods%20and%20more%20documented%20magic%20objects%20or%20attributes%20exist.%0A%0A%20%20%20%20%23%23%23%20Operator%20(binary)%20and%20Assignment%20Methods%0A%0A%20%20%20%20For%20any%20new%20class%20that%20we%20want%20to%20be%20able%20to%20deal%20with%20an%20operator%20(e.g.%2C%20to%20enable%20summing%20up%20objects%20with%20%60result%20%3D%20object1%20%2B%20object2%60)%2C%20we%20need%20to%20implement%20(overload)%20the%20following%20methods.%0A%0A%20%20%20%20%7C%20Operator%20(1)%20%7C%20Method%20%20(1)%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20Operator%20(2)%20%7C%20Method%20%20%20%20(2)%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C----------%7C--------------------------------------------%7C--%7C------------%7C---------------------------------------------%7C%0A%20%20%20%20%7C%20%60%2B%60%20%20%20%20%20%20%7C%20%60object.__add__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20%60%2B%3D%60%20%20%20%20%20%20%20%7C%20%60object.__iadd__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60-%60%20%20%20%20%20%20%7C%20%60object.__sub__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20%60-%3D%60%20%20%20%20%20%20%20%7C%20%60object.__isub__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60*%60%20%20%20%20%20%20%7C%20%60object.__mul__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20%60*%3D%60%20%20%20%20%20%20%20%7C%20%60object.__imul__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%2F%2F%60%20%20%20%20%20%7C%20%60object.__floordiv__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20%60%2F%2F%3D%60%20%20%20%20%20%20%7C%20%60object.__ifloordiv__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%2F%60%20%20%20%20%20%20%7C%20%60object.__truediv__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20%60%2F%3D%60%20%20%20%20%20%20%20%7C%20%60object.__itruediv__(self%2C%20other)%60%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%25%60%20%20%20%20%20%20%7C%20%60object.__mod__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%20%20%7C%20%60%25%3D%60%20%20%20%20%20%20%20%7C%20%60object.__imod__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%0A%20%20%20%20%7C%20%60**%60%20%20%20%20%20%7C%20%60object.__pow__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%20%20%7C%20%60**%3D%60%20%20%20%20%20%20%7C%20%60object.__ipow__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%3C%3C%60%20%20%20%20%20%7C%20%60object.__lshift__(self%2C%20*args%2C%20**kwargs)%60%20%7C%20%20%7C%20%60%3C%3C%3D%60%20%20%20%20%20%20%7C%20%60object.__ilshift__(self%2C%20*args%2C%20**kwargs)%60%20%7C%0A%20%20%20%20%7C%20%60%3E%3E%60%20%20%20%20%20%7C%20%60object.__rshift__(self%2C%20*args%2C%20**kwargs)%60%20%7C%20%20%7C%20%60%3E%3E%3D%60%20%20%20%20%20%20%7C%20%60object.__irshift__(self%2C%20*args%2C%20**kwargs)%60%20%7C%0A%20%20%20%20%7C%20%60%26%60%20%20%20%20%20%20%7C%20%60object.__and__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%20%20%7C%20%60%26%3D%60%20%20%20%20%20%20%20%7C%20%60object.__iand__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%5E%60%20%20%20%20%20%20%7C%20%60object.__xor__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%20%20%7C%20%60%5E%3D%60%20%20%20%20%20%20%20%7C%20%60object.__ixor__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%7C%0A%20%20%20%20%7C%20%60%5C%7C%60%20%20%20%20%20%7C%20%60object.__or__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%20%7C%20%20%7C%20%60%5C%7C%3D%60%20%20%20%20%20%20%7C%20%60object.__ior__(self%2C%20*args%2C%20**kwargs)%60%20%20%20%20%20%7C%0A%0A%20%20%20%20%23%23%23%20Operator%20(unary)%20and%20Comparator%20Methods%0A%0A%20%20%20%20Also%20unary%20or%20comparative%20operators%20can%20be%20defined%20or%20overloaded.%20Unary%20operators%20deal%20with%20only%20one%20input%20in%20contrast%20to%20the%20above-listed%20binary%20operators.%20A%20unary%20operator%20acts%20on%20a%20single%20operand%2C%20such%20as%20negation%20%60-x%60%2C%20unary%20plus%20%60%2Bx%60%2C%20or%20bitwise%20inversion%20%60~x%60%20(note%20that%20Python%20has%20no%20%60%2B%2B%60%20or%20%60--%60%20increment%2Fdecrement%20operators).%20In%20addition%2C%20comparative%20operators%20(comparators)%20involve%20magic%20methods%2C%20such%20as%20%60__ne__%60%2C%20as%20a%20synonym%20for%20**n**ot%20**e**qual.%0A%0A%20%20%20%20%7C%20%20Operator%20%20%20%20%20%7C%20%20Method%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%7C%20Comparator%20%20%20%7C%20%20Method%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C---------------%7C------------------------------%7C--%7C--------------%7C------------------------------------------%7C%0A%20%20%20%20%7C%20%20%60-%60%20%20%20%20%20%20%20%20%20%20%7C%20%20%60object.__neg__(self)%60%20%20%20%20%20%20%7C%20%20%7C%20%20%60%3C%60%20%20%20%20%20%20%20%20%20%7C%20%20%60object.__lt__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60%2B%60%20%20%20%20%20%20%20%20%20%20%7C%20%20%60object.__pos__(self)%60%20%20%20%20%20%20%7C%20%20%7C%20%20%60%3C%3D%60%20%20%20%20%20%20%20%20%7C%20%20%60object.__le__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60abs()%60%20%20%20%20%20%20%7C%20%20%60object.__abs__(self)%60%20%20%20%20%20%20%7C%20%20%7C%20%20%60%3D%3D%60%20%20%20%20%20%20%20%20%7C%20%20%60object.__eq__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60~%60%20%20%20%20%20%20%20%20%20%20%7C%20%20%60object.__invert__(self)%60%20%20%20%7C%20%20%7C%20%20%60!%3D%60%20%20%20%20%20%20%20%20%7C%20%20%60object.__ne__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60complex()%60%20%20%7C%20%20%60object.__complex__(self)%60%20%20%7C%20%20%7C%20%20%60%3E%3D%60%20%20%20%20%20%20%20%20%7C%20%20%60object.__ge__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60int()%60%20%20%20%20%20%20%7C%20%20%60object.__int__(self)%60%20%20%20%20%20%20%7C%20%20%7C%20%20%60%3E%60%20%20%20%20%20%20%20%20%20%7C%20%20%60object.__gt__(self%2C%20*args%2C%20**kwargs)%60%20%20%7C%0A%20%20%20%20%7C%20%20%60float()%60%20%20%20%20%7C%20%20%60object.__float__(self)%60%20%20%20%20%7C%20%20%7C%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%0A%20%20%20%20A%20comprehensive%20and%20inclusive%20summary%20of%20magic%20methods%20is%20provided%20in%20the%20%5BPython%20docs%5D(https%3A%2F%2Fdocs.python.org%2F3%2Freference%2Fdatamodel.html%23emulating-numeric-types).%0A%0A%20%20%20%20Still%2C%20you%20may%20wonder%20how%2C%20in%20practice%2C%20does%20a%20class%20look%20like%20that%20is%20capable%20of%20using%2C%20for%20example%2C%20the%20%60%2B%60%20operator%20with%20an%20%60__add__%60%20method%3F%20To%20this%20end%2C%20let's%20define%20another%20child%20of%20the%20%60Fish%60%20class%20to%20build%20a%20swarm%3A%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_(Fish)%3A%0A%20%20%20%20class%20Mackerel(Fish)%3A%0A%20%20%20%20%20%20%20%20def%20__init__(self%2C%20species%2C%20*args%2C%20**kwargs)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20Fish.__init__(self)%0A%20%20%20%20%20%20%20%20%20%20%20%20self.__family%20%3D%20%22scombridae%22%0A%20%20%20%20%20%20%20%20%20%20%20%20self.species%20%3D%20species%0A%20%20%20%20%20%20%20%20%20%20%20%20self.count%20%3D%201%0A%20%20%20%20%0A%20%20%20%20%20%20%20%20def%20__add__(self%2C%20value)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.count%20%2B%3D%20value%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20self.count%0A%0A%20%20%20%20%20%20%20%20def%20__mul__(self%2C%20multiplier)%3A%0A%20%20%20%20%20%20%20%20%20%20%20%20self.count%20*%3D%20multiplier%0A%20%20%20%20%20%20%20%20%20%20%20%20return%20self.count%0A%20%20%20%20%0A%20%20%20%20atlantic_mackerel%20%3D%20Mackerel(%22Scomber%20scombrus%22)%0A%20%20%20%20print(atlantic_mackerel%20%2B%201)%0A%20%20%20%20print(atlantic_mackerel%20*%2010)%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%23%23%20Custom%20Python%20Class%20Template%0A%0A%20%20%20%20This%20section%20features%20a%20template%20for%20a%20custom%20Python3%20class.%20The%20template%20can%20be%20extended%20with%20public%20and%20non-public%20properties%2C%20and%20customizations%20of%20magic%20methods%20to%20enable%20the%20use%20of%20operators%20such%20as%20%60%2B%60%20or%20%60%3C%3D%60.%20Ultimately%2C%20there%20are%20many%20options%20for%20writing%20a%20custom%20class%2C%20but%20all%20custom%20classes%20should%20at%20least%20incorporate%20the%20following%20methods%3A%0A%0A%20%20%20%20*%20%60__init__(self%2C%20%5B...)%60%20is%20the%20(magic)%20class%20initializer%2C%20which%20is%20called%20when%20an%20instance%20of%20the%20class%20is%20created.%20More%20precisely%2C%20it%20is%20called%20along%20with%20the%20%60__new__(cls%2C%20%5B...)%60%20method%2C%20which%2C%20in%20contrast%2C%20is%20rarely%20used%20(read%20more%20at%20%5Bpython.org%5D(https%3A%2F%2Fdocs.python.org%2F3%2Freference%2Fdatamodel.html%3Fhighlight%3D__new__%2520method%23object.__new__)).%20The%20initializer%20gets%20the%20arguments%20passed%20with%20which%20the%20object%20was%20called.%20For%20example%2C%20when%20%60var%20%3D%20MyClass(1%2C%20'vanilla'%20)%60%2C%20the%20%60__init__(self%2C%20%5B...)%60%20method%20receives%20%601%60%20and%20%60'vanilla'%60.%0A%20%20%20%20*%20%60__call__(self%2C%20%5B...)%60%20enables%20to%20call%20a%20class%20instance%20directly.%20For%20example%2C%20%60var('cherry')%60%20(corresponds%20to%20%60var.__call__('cherry')%60)%20may%20be%20used%20to%20change%20from%20%60'vanilla'%60%20to%20%60'cherry'%60.%0A%0A%20%20%20%20Thus%2C%20a%20robust%20class%20template%20skeleton%20looks%20like%20this%3A%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.class_definition%0Aclass%20NewClass%3A%0A%20%20def%20__init__(self%2C%20*args%2C%20**kwargs)%3A%0A%09%20%20%23%20Initialize%20instance%20attributes%20here.%0A%09%20%20pass%0A%0A%20%20def%20method_1(self%2C%20*args%2C%20**kwargs)%3A%0A%09%20%20pass%0A%0A%20%20def%20__call__(self%2C%20*args%2C%20**kwargs)%3A%0A%09%20%20print(f%22Class%20info%3A%20%7Btype(self).__name__%7D%22)%0A%09%20%20print(dir(self))%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20Understanding%20the%20power%20and%20structure%20of%20classes%20and%20object%20orientation%20takes%20time%20and%20requires%20practice.%20To%20this%20end%2C%20the%20chapters%20on%20%5BGraphical%20User%20Interfaces%5D(https%3A%2F%2Fhydro-informatics.com%2Fjupyter%2Fgui.html)%20and%20%5BGeospatial%20Python%5D(https%3A%2F%2Fhydro-informatics.com%2Fgeopy%2Fgeo-python.html)%20provide%20more%20examples%20of%20classes%20to%20familiarize%20with%20the%20concepts.%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell(hide_code%3DTrue)%0Adef%20_(mo)%3A%0A%20%20%20%20mo.md(r%22%22%22%0A%20%20%20%20%3E%20**Exercise**%3A%20Familiarize%20with%20object%20orientation%20in%20the%20%5BSediment%20transport%20(1d)%20exercise%5D(https%3A%2F%2Fhydro-informatics.com%2Fexercises%2Fex-sediment).%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0Aif%20__name__%20%3D%3D%20%22__main__%22%3A%0A%20%20%20%20app.run()%0A