b02-pyerror

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%20Errors%2C%20Logging%2C%20and%20Debugging%0A%0A%20%20%20%20Handle%20error%20types%20and%20troubleshoot%20(debug).%0A%0A%20%20%20%20%3E%20**Requirements%3A**%20Make%20sure%20to%20complete%20the%20Python%20introduction%20on%20data%20types%20before%20diving%20into%20this%20tutorial.%0A%0A%20%20%20%20%23%23%20Errors%20%26%20Exceptions%0A%0A%20%20%20%20%23%23%23%20Error%20Types%0A%0A%20%20%20%20To%20err%20is%20human%20and%20Python%20helps%20us%20to%20find%20our%20mistakes%20by%20providing%20%5Berror%5D(https%3A%2F%2Fdocs.python.org%2F3%2Ftutorial%2Ferrors.html)%20type%20descriptions.%20Here%20is%20a%20list%20of%20common%20errors%20that%20may%20occur%20when%20writing%2Frunning%20Python%20code%3A%0A%0A%20%20%20%20%7C%20Error%20Type%20%20%20%20%20%20%20%20%20%20%7C%20Description%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%20%20%20%20%20%20%20%7C%20Example%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%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C---------------------%7C-------------------------------------------------------------%7C-----------------------------------------------------------%7C%0A%20%20%20%20%7C%20%60KeyError%60%20%20%20%20%20%20%20%20%20%20%7C%20A%20mapping%20key%20is%20not%20found.%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%20May%20occur%20when%20referencing%20a%20non-existing%20dictionary%20key.%20%7C%0A%20%20%20%20%7C%20%60ImportError%60%20%20%20%20%20%20%20%7C%20Importing%20a%20module%20that%20does%20not%20exist%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20%60import%20the-almighty-module%60%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%20%60IndentationError%60%20%20%7C%20The%20code%20block%20indentation%20is%20not%20correct.%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%20See%20%5Bcode%20style%20descriptions%5D(https%3A%2F%2Fhydro-informatics.com%2Fpython-basics%2Fpystyle.html%23indentation)%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60IndexError%60%20%20%20%20%20%20%20%20%7C%20An%20index%20outside%20the%20range%20of%20a%20variable%20is%20used.%20%20%20%20%20%20%20%20%20%20%20%7C%20%60nums%20%3D%20%5B1%2C%202%5D%3B%20print(nums%5B2%5D)%60%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%20%60NameError%60%20%20%20%20%20%20%20%20%20%7C%20An%20undefined%20variable%20is%20referenced.%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%60print(a)%60%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%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60TypeError%60%20%20%20%20%20%20%20%20%20%7C%20Incompatible%20data%20types%20and%2For%20operators%20are%20used%20together.%20%7C%20%60%22my_string%22%20%2F%2010%60%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%20%60ValueError%60%20%20%20%20%20%20%20%20%7C%20Right%20data%20type%2C%20but%20an%20inappropriate%20value.%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%60int(input(%22Number%3A%22))%60%20answered%20with%20%60t%60%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%7C%0A%20%20%20%20%7C%20%60ZeroDivisionError%60%20%7C%20Division%20by%20zero.%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%20%7C%20%603%20%2F%200%60%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%20%20%20%20%20%20%20%20%20%7C%0A%0A%20%20%20%20Still%2C%20there%20are%20many%20more%20error%20types%20that%20can%20occur%2C%20and%20Python%20developers%20maintain%20comprehensive%20descriptions%20of%20built-in%20exceptions%20on%20the%20%5BPython%20documentation%20web%20site%5D(https%3A%2F%2Fdocs.python.org%2F3%2Flibrary%2Fexceptions.html).%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%20Exception%20Handling%20with%20%60try%60%20-%20%60except%60%0A%0A%20%20%20%20%60try%60%20and%20%60except%60%20keywords%20test%20a%20code%20block%20and%20if%20it%20crashes%2C%20an%20%60exception%60%20is%20raised%2C%20but%20the%20script%20itself%20will%20not%20crash%20(unless%20otherwise%20defined%20in%20the%20%60except%60%20statement).%20The%20basic%20structure%20is%3A%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%60%60%60python%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20%23%20code%20block%0A%20%20%20%20except%20ErrorType%3A%0A%20%20%20%20%20%20%20%20print(%22Error%20%2F%20warning%20message.%22)%0A%20%20%20%20%60%60%60%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%20The%20%60ErrorType%60%20is%20technically%20not%20necessary%20(i.e.%2C%20%60except%3A%60%20does%20the%20job%2C%20too)%2C%20but%20adding%20an%20%60ErrorType%60%20is%20good%20practice%20to%20enable%20efficient%20debugging%20or%20making%20other%20users%20understand%20the%20origin%20of%20an%20error%20or%20warning.%20The%20following%20example%20illustrates%20the%20implementation%20of%20a%20%60ValueError%60%20in%20an%20interactive%20console%20script%20that%20requires%20users%20to%20type%20an%20integer%20value.%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%20try%3A%0A%20%20%20%20%20%20%20%20x%20%3D%20int(input(%22How%20many%20scoops%20of%20ice%20cream%20do%20you%20want%3F%20%22))%0A%20%20%20%20except%20ValueError%3A%0A%20%20%20%20%20%20%20%20print(%22What's%20that%3F%20sorry%2C%20please%20try%20again.%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%20The%20%60try%60%20statement%20can%20also%20have%20an%20%60else%60%20clause%2C%20which%20runs%20only%20if%20the%20%60try%60%20block%20raised%20no%20exception%20(here%20using%20helper%20functions%20such%20as%20%60key_not_found%60%20or%20%60handle_value%60)%3A%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%60%60%60python%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20value%20%3D%20a_dictionary%5Bkey%5D%0A%20%20%20%20except%20KeyError%3A%0A%20%20%20%20%20%20%20%20return%20key_not_found(key)%0A%20%20%20%20else%3A%0A%20%20%20%20%20%20%20%20return%20handle_value(value)%0A%20%20%20%20%60%60%60%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%20The%20%60pass%60%20Statement%0A%20%20%20%20When%20we%20start%20writing%20code%2C%20we%20are%20often%20facing%20a%20complex%20challenge%20that%20cannot%20be%20coded%20all%20at%20a%20time.%20For%20these%20challenges%2C%20Python%20helps%20us%20with%20the%20%60pass%60%20statement%20that%20enables%20the%20implementation%20of%20empty%20(void)%20code%20blocks%20and%20running%20code%20incrementally%20(i.e.%2C%20to%20debug%20the%20code).%20In%20addition%2C%20the%20above%20error%20type%20definitions%20aid%20to%20understand%20errors%20that%20we%20made%20in%20already%20written%20code.%20For%20instance%2C%20to%20define%20later%20what%20happens%20when%20Python%20runs%20into%20a%20%60NameError%60%2C%20a%20%60pass%60%20statement%20can%20be%20implemented%20as%20follows%3A%0A%20%20%20%20%22%22%22)%0A%20%20%20%20return%0A%0A%0A%40app.cell%0Adef%20_(b)%3A%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20_a%20%3D%205%0A%20%20%20%20%20%20%20%20c%20%3D%20_a%20%2B%20b%20%20%23%20we%20want%20to%20define%20b%20later%20on%20with%20a%20complex%20formula%0A%20%20%20%20except%20NameError%3A%0A%20%20%20%20%20%20%20%20pass%20%20%23%20we%20know%20that%20we%20did%20not%20define%20b%20yet%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%20The%20%60pass%60%20statement%20should%20only%20be%20temporary%20and%20it%20has%20a%20much%20broader%20application%20range%2C%20for%20example%2C%20in%20%5Bfunctions%5D(https%3A%2F%2Fhydro-informatics.com%2Fjupyter%2Fpyfun.html)%20and%20%5Bclasses%5D(https%3A%2F%2Fhydro-informatics.com%2Fjupyter%2Fclasses.html).%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%20Logging%0A%0A%20%20%20%20The%20%60print()%60%20function%20is%20useful%20to%20print%20variables%20or%20computation%20progress%20to%20the%20console%20(not%20too%20often%20though%3B%20printing%20takes%20time%20and%20slows%20down%20calculations).%20For%20robust%20reporting%20of%20errors%20or%20other%20important%20messages%2C%20however%2C%20a%20log%20file%20represents%20a%20better%20choice.%20So%20what%20is%20a%20log%20file%20or%20the%20act%20of%20logging%3F%20We%20know%20logbooks%20from%20discoverers%20or%20adventurers%2C%20who%20write%20down%20their%20experiences%20ordered%20by%20dates.%20Similarly%2C%20a%20code%20can%20write%20down%20(*log*)%20its%20%22experiences%22%2C%20but%20in%20a%20file%20instead%20of%20a%20book.%20For%20this%20purpose%2C%20Python%20has%20the%20standard%20%5B*logging*%20library%5D(https%3A%2F%2Fdocs.python.org%2F3%2Fhowto%2Flogging.html).%20For%20the%20moment%2C%20it%20is%20sufficient%20to%20know%20that%20the%20*logging*%20library%20can%20be%20imported%20in%20any%20Python%20script%20with%20%60import%20logging%60%20(more%20information%20about%20packages%2C%20modules%2C%20and%20libraries%20is%20provided%20in%20the%20%5BPackage%2C%20Modules%20and%20Libraries%5D(https%3A%2F%2Fhydro-informatics.com%2Fjupyter%2Fpypckg.html)%20section).%0A%0A%20%20%20%20The%20below%20code%20block%20imports%20the%20*logging*%20module%2C%20and%20uses%20the%20following%20keyword%20arguments%20to%20set%20the%20%60logging.basicConfig%60%3A%0A%0A%20%20%20%20*%20%60filename%3D%22my-logfile.log%22%60%20makes%20the%20logging%20module%20write%20messages%20to%20a%20file%20named%20%60%22my-logfile.log%22%60%20in%20the%20same%20directory%20where%20the%20Python%20script%20is%20running.%0A%20%20%20%20*%20%60format%3D%22%25(asctime)s%20-%20%25(message)s%60%20sets%20the%20logging%20format%20to%20%60YYYY-MM-DD%20HH%3AMM%3ASS.sss%20-%20%60*Message%20text*%20(more%20format%20options%20are%20listed%20in%20the%20%5BPython%20docs%5D(https%3A%2F%2Fdocs.python.org%2F3%2Fhowto%2Flogging.html%23displaying-the-date-time-in-messages)).%0A%20%20%20%20*%20%60filemode%3D%22w%22%60%20overwrites%20previous%20messages%20in%20the%20log%20file%20(remove%20this%20argument%20to%20append%20messages%20instead%20of%20overwriting).%0A%20%20%20%20*%20%60level%3Dlogging.DEBUG%60%20defines%20the%20severity%20of%20messages%20written%20to%20the%20log%20file%2C%20where%20%60DEBUG%60%20is%20adequate%20for%20problem%20diagnoses%20in%20codes%3B%20other%20levels%20of%20event%20severity%20are%3A%0A%20%20%20%20%20%20%20%20-%20%60logging.INFO%60%20to%20write%20all%20confirmation%20messages%20of%20events%20that%20worked%20as%20expected.%0A%20%20%20%20%20%20%20%20-%20%60logging.WARNING%60%20(**default**)%20to%20indicate%20when%20an%20unexpected%20event%20happened%20or%20when%20an%20event%20may%20cause%20an%20error%20in%20the%20future%20(e.g.%2C%20because%20of%20insufficient%20disk%20space).%0A%20%20%20%20%20%20%20%20-%20%60logging.ERROR%60%20to%20report%20serious%20problems%20that%20make%20the%20code%20crashing%20or%20not%20produce%20the%20desired%20result.%0A%20%20%20%20%20%20%20%20-%20%60logging.CRITICAL%60%20is%20a%20broader%20serious%20problem%20indicator%2C%20where%20the%20program%20itself%20may%20not%20be%20able%20to%20continue%20running%20(e.g.%2C%20not%20only%20the%20code%20but%20also%20Python%20crashes).%0A%0A%20%20%20%20Until%20here%2C%20messages%20are%20only%20written%20to%20the%20log%20file%2C%20but%20we%20cannot%20see%20any%20message%20in%20the%20console.%20To%20enable%20simultaneous%20logging%20to%20a%20log%20file%20and%20the%20console%20(Python%20terminal)%2C%20use%20%60logging.getLogger().addHandler(logging.StreamHandler())%60%20that%20appends%20an%20*io*%20stream%20handler.%0A%0A%20%20%20%20To%20write%20a%20message%20to%20the%20log%20file%20(and%20Python%20terminal)%2C%20use%0A%20%20%20%20*%20%60logging.debug(%22message%22)%60%20for%20code%20diagnoses%2C%0A%20%20%20%20*%20%60logging.info(%22message%22)%60%20for%20progress%20information%20(just%20like%20we%20used%20%60print(%22message%22)%60%20before)%2C%0A%20%20%20%20*%20%60logging.warning(%22warning-message%22)%60%20for%20unexpected%20event%20documentation%20(without%20the%20program%20being%20interrupted)%2C%0A%20%20%20%20*%20%60logging.error(%22error-message%22)%60%20for%20errors%20that%20entail%20malfunction%20of%20the%20code%2C%20and%0A%20%20%20%20*%20%60logging.critical(%22message%22)%60%20for%20critical%20errors%20that%20may%20lead%20to%20program%20(Python)%20crashes.%0A%0A%20%20%20%20*Warning*%2C%20*error*%2C%20and%20*critical*%20messages%20should%20be%20implemented%20in%20exception%20raises%20(see%20above%20%60try%60%20-%20%60except%60%20statements).%0A%0A%20%20%20%20At%20the%20end%20of%20a%20script%2C%20logging%20should%20be%20stopped%20with%20%60logging.shutdown()%60%20because%20otherwise%20the%20log%20file%20is%20locked%20by%20Python%20and%20the%20Python%20Kernel%20needs%20to%20be%20stopped%20to%20make%20modifications%20(e.g.%2C%20removing)%20to%20the%20log%20file.%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%20import%20logging%0A%20%20%20%20logging.basicConfig(filename%3D'my-logfile.log'%2C%20format%3D'%25(asctime)s%20-%20%25(message)s'%2C%20filemode%3D'w'%2C%20level%3Dlogging.DEBUG)%0A%20%20%20%20logging.getLogger().addHandler(logging.StreamHandler())%0A%20%20%20%20logging.debug('This%20message%20is%20logged%20to%20the%20file.')%0A%20%20%20%20logging.info('Less%20severe%20information%20is%20also%20logged%20to%20the%20file.')%0A%20%20%20%20logging.warning('Warning%20messages%20are%20logged%2C%20too.')%0A%20%20%20%20_a%20%3D%20'text'%0A%20%20%20%20try%3A%0A%20%20%20%20%20%20%20%20logging.info(str(_a%20**%202))%0A%20%20%20%20except%20TypeError%3A%0A%20%20%20%20%20%20%20%20logging.error('The%20variable%20is%20not%20numeric.')%0A%20%20%20%20%23%20stop%20logging%0A%20%20%20%20logging.shutdown()%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%20And%20this%20is%20how%20%60my-logfile.log%60%20looks%20like%3A%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%60%60%60%0A%20%20%20%202025-05-25%2018%3A51%3A46%2C657%20-%20This%20message%20is%20logged%20to%20the%20file.%0A%20%20%20%202025-05-25%2018%3A51%3A46%2C666%20-%20Less%20severe%20information%20is%20also%20logged%20to%20the%20file.%0A%20%20%20%202025-05-25%2018%3A51%3A46%2C667%20-%20Warning%20messages%20are%20logged%2C%20too.%0A%20%20%20%202025-05-25%2018%3A51%3A46%2C669%20-%20The%20variable%20is%20not%20numeric.%0A%20%20%20%20%60%60%60%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%20Events%20can%20also%20be%20documented%20by%20instantiating%20a%20logger%20object%20with%20%60logger%20%3D%20logging.getLogger(__name__)%60.%20This%20favorable%20solution%20is%20recommended%20for%20advanced%20coding%20such%20as%20writing%20a%20new%20%5B(custom)%20Python%20library%5D(https%3A%2F%2Fhydro-informatics.com%2Fjupyter%2Fpypckg.html))%20(read%20more%20in%20the%20%5BPython%20docs%20on%20advanced%20logging%5D(https%3A%2F%2Fdocs.python.org%2F3%2Fhowto%2Flogging.html%23advanced-logging-tutorial)).%20An%20example%20script%20with%20a%20more%20sophisticated%20logger%20is%20provided%20with%20the%20%5BLogger%20script%20at%20the%20course%20repository%5D(https%3A%2F%2Fgithub.com%2Fhydro-informatics%2Fmaterial-py-codes%2Fraw%2Fmaster%2Flogging%2FLogger.py).%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%20Debugging%0A%0A%20%20%20%20Once%20you%20wrote%20more%20or%20less%20complex%20code%2C%20the%20ultimate%20question%20is%3A%20*Will%20it%20run%3F*%20The%20disappointing%20answer%20is%20no%20(in%20most%20cases)%2C%20but%20there%20is%20a%20remedy%20called%20*debugging*%2C%20which%20is%20the%20act%20of%20removing%20bugs%20(errors)%20from%20code.%20Still%2C%20large%20code%20blocks%20can%20be%20a%20nightmare%20for%20debugging%20and%20this%20section%20provides%20some%20principles%20to%20reduce%20the%20factor%20of%20scariness%20that%20debugging%20may%20involve.%0A%0A%20%20%20%20%23%23%23%20Use%20Exceptions%20Precisely%0A%20%20%20%20Embrace%20critical%20code%20blocks%20precisely%20with%20%60try%60%20-%20%60except%60%20keywords%20and%20possible%20errors.%20This%20will%20help%20later%20to%20identify%20possible%20error%20origins.%0A%0A%20%20%20%20%3E%20Document%20self-written%20error%20messages%20in%20%60except%60%20statements%20from%20the%20beginning%20on%20(e.g.%2C%20in%20a%20markdown%20document)%20and%20establish%20a%20developer%20%5Bwiki%5D(https%3A%2F%2Fhydro-informatics.com%2Fdocumentation%2Fdocumentation.html%23wikis)%20including%20possible%20error%20sources%20and%20remedy%20descriptions.%0A%0A%20%20%20%20%23%23%23%20Use%20Descriptive%20Variable%20Names%0A%20%20%20%20Give%20variables%2C%20functions%2C%20and%20other%20objects%20descriptive%20and%20meaningful%20names.%20Abbreviations%20will%20always%20be%20necessary%2C%20but%20those%20should%20be%20descriptive%20(e.g.%2C%20use%20acronyms).%20For%20variables%20and%20functions%2C%20use%20small%20letters%20only.%20For%20classes%20use%20CamelCase.%0A%0A%20%20%20%20%23%23%23%20Deal%20with%20Errors%0A%20%20%20%20If%20an%20error%20message%20is%20raised%2C%20**read%20the%20error%20message%20thoroughly**%20and%20several%20times%20to%20**understand%20the%20origin**%20of%20the%20error.%20Error%20messages%20often%20indicate%20the%20particular%20script%20and%20the%20line%20number%20where%20the%20error%20was%20raised.%20In%20the%20case%20that%20the%20error%20is%20not%20an%20apparent%20result%20of%20misused%20data%20types%20or%20any%20of%20the%20above%20error%20messages%20(e.g.%2C%20an%20error%20raised%20within%20an%20external%20module%2Fpackage)%2C%20use%20your%20favorite%20search%20engine%20to%20troubleshoot%20the%20error.%0A%0A%20%20%20%20%23%23%23%20Verify%20Output%0A%20%20%20%20The%20fact%20that%20code%20runs%20does%20not%20inherently%20imply%20that%20the%20result%20(output)%20is%20the%20desired%20output.%20Therefore%2C%20run%20the%20code%20with%20input%20parameters%20that%20yield%20existing%20output%20from%20another%20source%20(e.g.%20manual%20calculation)%20and%20verify%20that%20the%20code-produced%20output%20corresponds%20to%20the%20existing%20(desired)%20output.%0A%0A%20%20%20%20%23%23%23%20Code%20with%20a%20Structured%20Approach%0A%20%20%20%20Think%20about%20the%20code%20structure%20before%20starting%20with%20punching%20in%20a%20bunch%20of%20code%20blocks%20and%20storing%20them%20in%20some%20Python%20files.%20Structural%20and%2For%20behavior%20diagrams%20aid%20in%20developing%20a%20sophisticated%20code%20framework.%20The%20developers%20of%20the%20Unified%20Modeling%20Language%20(UML)%20provide%20solid%20guidelines%20for%20developing%20structure%20and%20behavior%20%5BUML%20diagrams%5D(https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FUnified_Modeling_Language%23Diagrams)%20in%20software%20engineering.%0A%0A%20%20%20%20%3E%20Take%20a%20sheet%20of%20paper%20and%20a%20pencil%20before%20you%20start%20to%20engineer%20code%20and%20sketch%20how%20the%20code%20will%20produce%20the%20desired%20output.%0A%0A%20%20%20%20%23%23%23%20Soft%20Alternatives%0A%0A%20%20%20%20Explain%20your%20problem%20to%20a%20friend%20or%20just%20speak%20it%20out%20loud%3A%20Rephrasing%20and%20trying%20to%20explain%20a%20problem%20to%20another%20person%20(even%20if%20it%20is%20just%20an%20imaginary%20person%20or%20group%20of%20people)%20often%20represents%20a%20troubleshot%20itself.%0A%0A%20%20%20%20Take%20a%20walk%2C%20sleep%20on%20the%20problem%2C%20or%20do%20other%20things%20with%20low%20brain%20occupation.%20While%20you%20are%20dealing%20with%20other%20things%2C%20your%20brain%20continues%20to%20think%20about%20the%20problem%20(Wikipedia%20even%20devoted%20a%20page%20to%20this%20so-called%20process%20of%20%5B*incubation*%5D(https%3A%2F%2Fen.wikipedia.org%2Fwiki%2FIncubation_(psychology))).%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