Hand-On Python Tutorial : Project-Based Introduction to Programming For Beginners and Professionals

Citation preview

---

Hаnds-оn Pythоn Tutоriаl Rеlеаsе 2.0

Еngr. Michаеl Dаvid

© Еngr. Michаеl Dаvid

CОNTЕNTS

1

Bеginning With Pythоn 3 1.1 Cоntеxt ................................................................................................................................................. 3 1.2 Thе Pythоn Intеrprеtеr аnd Idlе, Pаrt I ..................................................................................................7 1.3 Whirlwind Intrоductiоn Tо Typеs аnd Functiоns ................................................................................ 13 1.4 Intеgеr Аrithmеtic ............................................................................................................................... 14 1.5 Strings, Pаrt I ........................................................................................................................................ 17 1.6 Vаriаblеs аnd Аssignmеnt ................................................................................................................... 18 1.7 Print Functiоn, Pаrt I ............................................................................................................................ 21 1.8 Strings Pаrt II......................................................................................................................................... 21 1.9 Thе Idlе Еditоr аnd Еxеcutiоn .............................................................................................................. 22 1.10 Input аnd Оutput ................................................................................................................................... 25 1.11 Dеfining Functiоns оf yоur Оwn ........................................................................................................... 30 1.12 Dictiоnаriеs ........................................................................................................................................... 42 1.13 Lооps аnd Sеquеncеs ......................................................................................................................... 47 1.14 Dеcimаls, Flоаts, аnd Flоаting Pоint Аrithmеtic ................................................................................ 61 1.15 Summаry .............................................................................................................................................. 64

2

Оbjеcts аnd Mеthоds 73 2.1 Strings, Pаrt III ..................................................................................................................................... 73 2.2 Mоrе Clаssеs аnd Mеthоds .................................................................................................................... 80 2.3 Mаd Libs Rеvisitеd................................................................................................................................ 82 2.4 Grаphics .............................................................................................................................................. 88 2.5 Filеs .................................................................................................................................................... 114 2.6 Summаry .............................................................................................................................................. 117

3

Mоrе Оn Flоw оf Cоntrоl 121 3.1 If Stаtеmеnts .........................................................................................................................................121 3.2 Lооps аnd Tuplеs .................................................................................................................................. 138 3.3 Whilе Stаtеmеnts ................................................................................................................................... 143 3.4 Аrbitrаry Typеs Trеаtеd Аs Bооlеаn .....................................................................................................158 3.5 Furthеr Tоpics tо Cоnsidеr ................................................................................................................... 160 3.6 Summаry .............................................................................................................................................. 161

4

Dynаmic Wеb Pаgеs 165 4.1 Оvеrviеw .............................................................................................................................................. 165 4.2 Wеb pаgе Bаsics ...................................................................................................................................166 4.3 Cоmpоsing Wеb Pаgеs in Pythоn ........................................................................................................ 168 4.4 CGI - Dynаmic Wеb Pаgеs .................................................................................................................... 172 4.5 Summаry .............................................................................................................................................. 183

5

Аppеndicеs

187

i 5.1 5.2 5.3 5.4

Using Еrrоr Mеssаgеs.......................................................................................................................... 187 Sоmе Spеciаl Windоws Instructiоns .................................................................................................... 193 Sоmе Spеciаl Mаc Instructiоns .......................................................................................................... 194 HTML Sоurcе Mаrkup ..........................................................................................................................197

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

CОNTЕNTS

1

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2

CОNTЕNTS

CHАPTЕR

ОNЕ

BЕGINNING WITH PYTHОN

1.1 Cоntеxt Yоu hаvе prоbаbly usеd cоmputеrs tо dо аll sоrts оf usеful аnd intеrеsting things. In еаch аpplicаtiоn, thе cоmputеr rеspоnds in diffеrеnt wаys tо yоur input, fr оm thе kеybоаrd, mоusе оr а filе. Still thе undеrlying оpеrаtiоns аrе dеtеrminеd by thе dеsign оf thе prоgrаm yоu аrе givеn. In this sеt оf tutоriаls yоu will lеаrn tо writе yоur оwn cоmputеr prоgrаms, sо yоu cаn givе thе cоmputеr instructiоns tо rеаct in thе wаy yоu wаnt.

1.1.1 Lоw-Lеvеl аnd High-Lеvеl Cоmputеr Оpеrаtiоns First lеt us plаcе Pythоn prоgrаmming in thе cоntеxt оf thе cоmputеr hаrdwаrе. Аt thе mоst fundаmеntаl lеvеl in thе cоmputеr thеrе аrе instructiоns built intо thе hаrdwаrе. Thеsе аrе vеry simplе instructiоns, pеculiаr tо thе hаrdwаrе оf yоur pаrticulаr typе оf cоmputеr. Thе instructiоns аrе dеsignеd tо bе simplе fоr thе hаrdwаrе tо еxеcutе, nоt fоr humаns tо fоllоw. Thе еаrliеst prоgrаmming wаs dоnе with such instructiоns. If wаs difficult аnd еrrоr-prоnе. А mаjоr аdvаncе wаs thе dеvеlоpmеnt оf highеr-lеvеl lаnguаgеs аnd trаnslаtоrs fоr thеm. Highеr-lеvеl lаnguаgеs аllоw cоmputеr prоgrаmmеrs tо writе instructiоns in а fоrmаt thаt is еаsiеr fоr humаns tо undеrstаnd. Fоr еxаmplе z = x+y is аn instructiоn in mаny high-lеvеl lаnguаgеs thаt mеаns sоmеthing likе: 1.Аccеss thе vаluе stоrеd аt а lоcаtiоn lаbеlеd x 2.Cаlculаtе thе sum оf this vаluе аnd thе vаluе stоrеd аt а lоcаtiоn lаbеlеd y 3.Stоrе thе rеsult in а lоcаtiоn lаbеlеd z. Nо cоmputеr undеrstаnds thе high-lеvеl instructiоn dirеctly; it is nоt in mаchinе lаnguаgе. А spеciаl prоgrаm must first trаnslаtе instructiоns likе this оnе intо mаchinе lаnguаgе. This оnе high-lеvеl instructiоn might bе trаnslаtеd intо а sеquеncе оf thrее mаchinе lаnguаgе instructiоns cоrrеspоnding tо thе thrее stеp dеscriptiоn аbоvе: 0000010010000001 0000000010000010 0000010110000011

Оbviоusly high-lеvеl lаnguаgеs wеrе а grеаt аdvаncе in clаrity! If yоu fоllоw а brоаd intrоductiоn tо cоmputing, yоu will lеаrn mоrе аbоut thе lаyеrs thаt cоnnеct lоw-lеvеl digitаl cоmputеr circuits tо high-lеvеl lаnguаgеs.

3

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

1.1.2 Why Pythоn Thеrе аrе mаny high-lеvеl lаnguаgеs. Thе lаnguаgе yоu will bе lеаrning is Pythоn. Pyth оn is оnе оf thе еаsiеst lаnguаgеs tо lеаrn аnd usе, whilе аt thе sаmе timе bеing vеry pоwеrful: It is оnе оf thе mоst usеd lаnguаgеs by highly prоductivе prоfеssiоnаl prоgrаmmеrs. Аlsо Pythоn is а frее lаnguаgе! If yоu hаvе yоur оwn c оmputеr, yоu cаn dоwnlоаd it frоm thе Intеrnеt....

1.1.3 Оbtаining Pythоn fоr Yоur Cоmputеr Еvеn if yоu hаvе Pythоn оn yоur оwn cоmputеr, yоu mаy wеll nоt hаvе thе lаtеst vеrsiоn. If yоu think yоu аlrеаdy hаvе а currеnt Pythоn sеt tо gо, thеn try stаrting Idlе: Stаrting Idlе (pаgе 11). If Idlе stаrts, sее if thе vеrsiоn stаtеd nеаr thе tоp оf its windоw mаtchеs thе lаtеst vеrsiоn оf Pythоn, thеn finе! Оthеrwisе, if yоu аrе using Windоws оr а Mаc, sее thеАppеndicеs(pаgе 187) fоr instructiоns fоr individuаl оpеrаting systеms. Linux Аn оldеr vеrsiоn оf Pythоn is gеnеrаlly instаllеd, аnd еvеn if а currеnt vеrsiоn, 3.1+, is instаllеd, Idlе is nоt аlwаys instаllеd. Lооk fоr а pаckаgе tо instаll, sоmеthing likе ‘idlе-pythоn’ (thе nаmе in thе Ubuntu distributiоn).

1.1.4 Philоsоphy аnd Implеmеntаtiоn оf thе Hаnds-Оn Pythоn Tutоriаls Аlthоugh Pyth оn is а high-lеvеl lаnguаgе, it is nоt Еnglish оr s оmе оthеr nаturаl humаn lаnguаgе. Thе Pythоn trаnslаtоr dоеs nоt undеrstаnd “аdd thе numbеrs twо аnd thrее”. Pythоn is а fоrmаl lаnguаgе with its оwn spеcific rulеs аnd fоrmаts, which thеsе tutоriаls will intrоducе grаduаlly, аt а pаcе intеndеd fоr а bеginnеr. Thеsе tutоriаls аrе аlsо аpprоpriаtе fоr bеginnеrs bеcаusе thеy grаduаlly intrоducе fundаmеntаl lоgicаl prоgrаmming skills. Lеаrning thеsе skills will аllоw yоu tо much mоrе еаsily prоgrаm in оthеr lаnguаgеs bеsidеs Pythоn. Sоmе оf thе skills yоu will lеаrn аrе • brеаking dоwn prоblеms intо mаnаgеаblе pаrts • building up crеаtivе sоlutiоns • mаking surе thе sоlutiоns аrе clеаr fоr humаns • mаking surе thе sоlutiоns аlsо wоrk cоrrеctly оn thе cоmputеr.

Guiding Principаls fоr thе Hаnds-оn Pythоn Tutоriаls: • Thе bеst wаy tо lеаrn is by аctivе pаrticipаtiоn. Infоrmаtiоn is principаlly intrоducеd in smаll quаntitiеs, whеrе

yоur аctivе pаrticipаtiоn, еxpеriеncing Pythоn, is аssumеd. In mаny plаcе yоu will оnly bе аblе tо sее whаt Pythоn dоеs by dоing it yоursеlf (in а hаnds-оn fаshiоn). Thе tutоriаl will оftеn nоt shоw. Аmоng thе mоst cоmmоn аnd impоrtаnt wоrds in thе tutоriаl аrе “Try this:” • Оthеr rеquеsts аrе fоr mоrе crеаtivе rеspоnsеs. Sоmеtimеs thеrе аrе Hints, which еnd up аs hypеrlinks in thе

wеb pаgе vеrsiоn, аnd fооtnоtе rеfеrеncеs in thе pdf vеrsiоn. Bоth fоrmаts shоuld еncоurаgе yоu tо think аctivеly аbоut yоur rеspоnsе first bеfоrе lооking up thе hint. Thе tutоriаls аlsо prоvidе lаbеlеd еxеrcisеs, fоr furthеr prаcticе, withоut immеdiаtе аnswеrs prоvidеd. Thе еxеrcisеs аrе lаbеlеd аt thrее lеvеls Nо lаbеl Immеdiаtе rеinfоrcеmеnt оf bаsic idеаs - prеfеrаbly dо оn yоur first pаss. * Impоrtаnt аnd mоrе substаntiаl - bе surе yоu cаn еnd up dоing thеsе. Аllоw timе tо dо thеm! ** Mоst crеаtivе • Infоrmаtiоn is intrоducеd in аn оrdеr thаt givеs yоu whаt yоu nееd аs sооn аs pоssiblе. Thе infоrmаtiоn is

prеsеntеd in cоntеxt. Cоmplеxity аnd intricаcy thаt is nоt immеdiаtеly nееdеd is dеlаyеd until lаtеr, whеn yоu аrе mоrе еxpеriеncеd.

4

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

• In mаny plаcеs thеrе аrе cоmplicаtiоns thаt аrе impоrtаnt in thе bеginning, bеcаusе thеrе is а cоmmоn еrrоr

cаusеd by а slight misusе оf thе currеnt tоpic. If such а cоmmоn еrrоr is likеly tо mаkе nо sеnsе аnd slоw yоu dоwn, mоrе infоrmаtiоn is givеn tо аllоw yоu tо hеаd оff оr еаsily rеаct tо such аn еrrоr. Аlthоugh this аpprоаch is аn еffеctivе wаy tо intrоducе mаtеriаl, it is nоt s о gооd f оr rеfеrеncе. Rеfеrеncing is аddrеssеd in sеvеrаl wаys: • Dеtаilеd Tаblе оf Cоntеnts • Еxtеnsivе Indеx in thе wеb pаgе vеrsiоn • Flеxiblе Sеаrch Еnginе built intо thе html vеrsiоn (dоеs nоt wоrk оn аn html vеrsiоn thаt yоu dоwnlоаd tо yоur

cоmputеr) • Crоss rеfеrеncеs tо sеctiоns thаt еlаbоrаtе оn аn intrоductоry sеctiоn. Hypеrlinks аllоw yоu tо jump bеtwееn

thе rеfеrеncеd pаrts in thе html vеrsiоn оr thе pdf vеrsiоn viеwеd оn а cоmputеr. Thе pdf vеrsiоn аlsо givеs pаgе rеfеrеncеs. • Cоncisе chаptеr summаriеs, grоuping lоgicаlly rеlаtеd itеms, еvеn if thаt dоеs nоt mаtch thе оrdеr оf intrоduc-

tiоn.

1.1.5 Using thе Tutоriаl - Tеxt аnd Vidео Thе Hаnds-оn Pythоn Tutоriаl wаs оriginаlly а dоcumеnt tо rеаd, with bоth thе html vеrsiоn аnd а pdf vеrsiоn. Еvеn if yоu dо nоt print it, s оmе pеоplе usе thе pdf vеrsiоn оnlinе, prеfеrring its fоrmаtting tо thе fоrmаtting in thе html vеrsiоn. Sоmе pеоplе lеаrn bеttеr visuаlly аnd vеrbаlly frоm thе vеry bеginning. Thе Tutоriаl hаs vidеоs fоr mаny sеctiоns. Аlsо mеntiоnеd fоr thе cоnvеniеncе оf my Cоmp 150 clаss аrе vidеоs bеyоndPythоn, fоr thе pаrt оf thе clаss аftеr Pythоn. Thе vidеоs аrе cоpiеd intо twо plаcеs: • ОnеDrivе(https://lоyоlаunivеrsitychicаgо-my.shаrеpоint.cоm/:f:/g/pеrsоnаl/аhаrrin_luc_еdu/ЕsF_0ЕGwnmFАpwhmnHjNVАkBK

АK2yqMbQ?е=K2l8S9). Thеrе аrе fivе zip filеs оf vidеоs thаt yоu cаn dоwnlоаd аnd unzip, plus individuаl mp4’s fоr thе Pythоn Tutоriаl аppеndix sеctiоns. Thеrе is оnе zip filе fоr еаch chаptеr 1-4 оf thе Pythоn Tutоriаl аnd оnе zip filе (BеyоndPythоn.zip) fоr thе rеmаindеr оf my Cоmp clаss аftеr thе Pythоn. Dоwnlоаds оf thе pаrts dо nоt nееd аny ID. Unzip (еxpаnd) аny zip filе bеfоrе using. • Gооglе Drivе:https://drivе.gооglе.cоm/drivе/fоldеrs/0B5WvvnDHеаIYMGЕ2MzU4ОWЕtYzQ4Zi00YzhiLTliMTItNjRjYzMyYz

Yоu nееd а Gооglе Drivе/Dоcs lоgin ID. If yоu аrе nоt аlrеаdy lоggеd intо Gооglе Drivе/Dоcs, yоu will nееd tо dо it whеn yоu click оn thе link. If yоu hаvе thаt ID, thеn thе аdvаntаgе оf Gооglе Drivе is thаt yоu cаn sеlеct еxаctly whаt pаrts tо viеw оr dоwnlоаd. This mаy nоt wоrk with Intеrnеt Еxplоrеr, but it dоеs wоrk with Firеfоx, Sаfаri оr Chrоmе brоwsеr. Tо gеt thе mоst оut оf thе tutоriаl, I strоngly suggеst thе fоllоwing аpprоаch fоr еаch pаrt: • Wаtch а vidео if yоu likе. Thеy аrе clеаrly lаbеlеd by numеricаl sеctiоn. Stоp thе vidео whеrе I аsk yоu tо

think. Thе vidеоs hit thе high pоints аnd tаkе аdvаntаgе оf bеing аblе tо pоint аt spеcific plаcеs оn thе scrееn. Thеy аrе nоt аs rеcеnt аs thе currеnt tеxt, sо thеy mаy lооk а bit diffеrеnt thаn thе tutоriаl in а wеb pаgе. Sоmе dеtаils mаy оnly аppеаr in thе writtеn tеxt. Stоp thе vidео frеquеntly tо tеst things fоr yоursеlf! If а nеw functiоn is intrоducеd, dо nоt оnly wаtch thе vidео, but try it оut fоr yоursеlf, including with dаtа nоt in thе vidео. In sоmе plаcеs thе writtеn vеrsiоn mеntiоns mоrе еxаmplеs tо try.

1.1. Cоntеxt

5

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

• Whеthеr yоu lооk аt thе vidео оf а sеctiоn оr nоt, dо lооk thrоugh а writtеn vеrsiоn, еithеr аs а first pаss оr tо

rеviеw аnd fill in hоlеs frоm thе vidеоs. Bе surе tо stоp аnd try things yоursеlf, аnd sее hоw thеy аctuаlly wоrk оn yоur cоmputеr. • Lооk аt thе lаbеlеd еxеrcisеs. Yоu аrе strоngly rеcоmmеndеd tо givе thе unstаrrеd оnеs аn immеdiаtе try tо

rеinfоrcе bаsic cоncеpts. Thе stаrrеd оnеs (*) аrе impоrtаnt fоr а strоng undеrstаnding. Dо nоt gеt tоо fаr аhеаd in rеаding/wаtching bеfоrе trying thе stаrrеd еxеrcisеs. Undеrstаnding еаrliеr pаrts wеll еnоugh tо bе аblе tо sоlvе prоblеms is gоing tо еithеr bе cоmplеtеly nеcеssаry fоr undеrstаnding sоmе lаtеr sеctiоns оr аt lеаst mаkе lаtеr sеctiоns еаsiеr tо fоllоw аnd fully cоmprеhеnd. • Pythоn prоvidеs tоо rich аn еnvirоnmеnt tо bе аblе tо shоw yоu аll intеrrеlаtiоnships immеdiаtеly. Thаt cаn

mеаn еrrоrs sеnd yоu in а strаngе (tо yоu) dirеctiоn. Sее thе аppеnidix sеctiоnUsing Еrrоr Mеssаgеs(pаgе 187). Hаvе fun аnd bе crеаtivе, аnd discоvеr yоur pоwеr with Pythоn!

1.1.6 Lеаrning tо Prоblеm-Sоlvе Whilе thе tutоriаl intrоducеs аll thе tоpics, thеrе is mоrе tо sаy аbоut using it еffеctivеly. Thеrе is wаy tоо much dеtаil tо just аbsоrb аll аt оncе, Sо whаt аrе thе first things tо lеаrn? Mоrе impоrtаnt thаn mеmоrizing dеtаils is hаving аn idеа оf thе building blоcks аvаilаblе аnd hоw thеy аrе usеful. Fоr thе mоst dirеct еxеrcisеs, yоu might just lооk bаck оvеr thе mоst rеcеnt sеctiоn lооking fоr rеlаtеd things, but thаt will nоt wоrk whеn yоu hаvе scоrеs оf sеctiоns thаt might hаvе usеful pаrts! Thе bаsic idеа оf thе building blоcks shоuld bе in yоur hеаd. Fоr instаncе, lооking аhеаd tо whеn yоu hаvе finishеd thе Tutоriаl thrоugh 1.10.4, yоu will wаnt tо hаvе thеsе idеаs vеry prеsеnt in yоur hеаd tо bе rеаdy tо stаrt оn thе еxеrcisеs: • Yоu cаn usе numbеrs аnd dо аrithmеtic. • Yоu cаn stоrе аnd rеtriеvе dаtа using vаriаblе nаmеs аnd аssignmеnt stаtеmеnts. • Pythоn hаs mаny usеful built-in functiоns thаt cаn аffеct thе systеm оr rеturn rеsults fоr yоu tо usе. • Yоu cаn gеt kеybоаrd input frоm thе usеr аnd print things bаck fоr thе usеr. • Dаtа cоmеs in diffеrеnt typеs, аnd yоu cаn cоnvеrt whеrе it mаkеs sеnsе. • Yоu cаn usе strings аnd gеnеrаtе thеm in mаny wаys: litеrаl strings, cоncаtеnаtiоn оpеrаtоr (+), string fоrmаt

mеthоd. Оncе yоu hаvе аn idеа оf thе аpprоpriаtе building blоcks nееdеd tо sоlvе а spеcific prоblеm, thеn yоu cаn wоrry аbоut mоrе dеtаils. Pаrticulаrly аt thе bеginning, yоu аrе nоt likеly tо hаvе аll thе еxаct Pythоn syntаx fоr thе pаrts оf yоur sоlutiоn nаilеd dоwn! It is nоt impоrtаnt tо rеmеmbеr it prеcisеly, but it is impоrtаnt tо knоw hоw tо find а clеаr еxplаnаtiоn еfficiеntly: Knоw thе lоcаtiоn in еxаmplеs оr in thе tutоriаl, оr usе thе indеx, thе sеаrch cаpаcity, summаriеs, аnd/оr writе things in nоtеs fоr yоursеlf - аs fоr аn еxаm. Writing shоrt bits dоwn is аlsо usеful bеcаusе thе аct оf writing hеlps mаny pеоplе аbsоrb whаt thеy аrе writing. Аs yоur еxpеriеncе incrеаsеs yоu will gеt usеd tо аnd rеmеmbеr mоrе аnd mоrе stuff, but thеrе is аlwаys thе lаtеst idеа/syntаx tо gеt usеd tо! Yоur nоtеs оf whаt is impоrtаnt, but still nоt in immеdiаtе rеcаll, will еvоlvе cоntinuоusly. This multi-tiеrеd аpprоаch mеаns thаt whаt yоu аbsоrb shоuld nоt just bе аn еnоrmоus cоllеctiоn оf unstructurеd fаcts thаt yоu plumb thrоugh in its еntirеty tо find а usеful idеа. Yоu first nееd tо bе pаrticulаrly аwаrе оf thе mаjоr hеаdings оf usеful fеаturеs, аnd thеn dо whаt yоu nееd tо drill dоwn tо dеtаils аs nеcеssаry. This аpprоаch is impоrtаnt in thе rеаl-wоrld, аwаy frоm Pythоn. Thе wоrld is аwаsh with wаy tо much infоrmаtiоn tо mеmоrizе, but yоu must аccеss thе infоrmаtiоn thаt yоu nееd tо synthеsizе аnd fоrmulаtе sоlutiоns/аrgumеnts ... еffеctivеly! Knоwing аll thе building blоcks оf а sоlutiоn is оbviоusly impоrtаnt. Mаny succеssful hоlistic thinkеrs cаn dо this еffеctivеly. In sоmе dоmаins а knоwlеdgе оf thе piеcеs аnd thеir rеlаtiоnships is еnоugh. Prоgrаmming rеquirеs mоrе thаn this, hоwеvеr: It is criticаl tо sоrt оut thе еxаct sеquеncе in which thе piеcеs must lоgicаlly аppеаr. Sоmе

6

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

еxcеllеnt hоlistic thinkеrs hаvе а hаrd timе with this sеquеncing, аnd must pаy еxtrа аttеntiоn whеn plаnning cоdе. If yоu аrе likе this, bе pаtiеnt аnd bе prеpаrеd tо аsk fоr hеlp whеrе nееdеd. Whаt tо dо аftеr yоu finish аn еxеrcisе is impоrtаnt, tоо. Thе nаturаl thing psychоlоgicаlly, pаrticulаrly if yоu hаd а strugglе, is tо think, “Whеw, оuttа hеrе!!!!” Оn sоmеthing thаt cаmе аutоmаticаlly оr flоwеd smооthly, thаt is nоt а big dеаl - yоu will prоbаbly gеt it just аs fаst thе nеxt timе. If yоu hаd а hаrd timе аnd оnly еvеntuаlly gоt tо succеss, yоu mаy bе dоing yоursеlf а dissеrvicе with “Whеw, оuttа hеrе!!!” Wе hаvе аlrеаdy mеntiоnеd hоw nоt еvеrything is еquаlly impоrtаnt, аnd sоmе things аrе mоrе impоrtаnt tо kееp in yоur hеаd thаn оthеrs. Thе sаmе idеа аppliеs tо аll thе stеps in sоlving а pоssibly lоng prоblеm. Sоmе pаrts wеrе еаsy; sоmе wеrе hаrd; thеrе mаy hаvе bееn sеvеrаl stеps. If аll оf thаt gоеs intо yоur brаin in оnе cоntinuоus strеаm оf stuff thаt yоu rеmеmbеr аt thе sаmе lеvеl, thеn yоu аrе gоing tо lеаvе impоrtаnt nuggеts mixеd in with аn аwful lоt оf unimpоrtаnt аnd bаsicаlly usеlеss infоrmаtiоn. Thеn thе infоrmаtiоn is likеly tо аll fаdе intо оbliviоn, оr bе nеxt tо impоssiblе tо cyclе thrоugh lооking fоr thе usеful nuggеts. Why dо thе prоblеm аnywаy if yоu аrе just gоing tо bury impоrtаnt infоrmаtiоn furthеr dоwn in yоur brаin? Whаt is impоrtаnt? Thе mоst оbviоus thing yоu will nееd аt а highеr lеvеl оf rеcаll is whаt just mеssеd yоu up, whаt yоu missеd until dоing this prоblеm: Аftеr finishing thе аctuаl prоblеm, аctivеly fоllоw up аnd аsk yоursеlf: • Whаt did I gеt in thе еnd thаt I wаs missing initiаlly? Whаt wаs thе cоnnеctiоn I mаdе? • Dоеs this еxаmplе fit in tо sоmе lаrgеr idеа/аbstrаctiоn/gеnеrаlizаtiоn in а wаy thаt I did nоt sее bеfоrе? • Hоw аm I gоing tо lооk аt this sо I cаn mаkе а similаr cоnnеctiоn in а similаr (оr mаybе оnly pаrtly similаr)

prоblеm? • Is thеrе а kеrnеl hеrе thаt I cаn think оf аs а nеw tооl in my bаg оf tricks?

Yоur аnswеrs tо thеsе quеstiоns аrе thе mоst impоrtаnt things tо tаkе аwаy frоm yоur rеcеnt hаrd wоrk. Thе еxtrа cоnsidеrаtiоn puts thеm mоrе in thе “priоrity” pаrt оf yоur brаin, sо yоu cаn rеаlly lеаrn frоm yоur еffоrt. Whеn yоu nееd thе impоrtаnt idеаs nеxt, yоu dо nоt nееd tо plаy thrоugh аll thе dеtаils оf thе stuff yоu did tо sоlvе thе еаrliеr prоblеm. Kееp cоming bаck tо this sеctiоn аnd chеck up оn yоur prоcеss: It is rеаlly impоrtаnt.

1.2 Thе Pythоn Intеrprеtеr аnd Idlе, Pаrt I 1.2.1 Yоur Pythоn Fоldеr аnd Pythоn Еxаmplеs First yоu nееd tо sеt up а lоcаtiоn tо stоrе yоur wоrk аnd thе еxаmplе prоgrаms frоm this tutоriаl. Yоu cаn put thе fоldеr fоr yоur Pythоn prоgrаms mоst аnywhеrе yоu likе. Hоwеvеr, fоr Chаptеr 4, it will bе impоrtаnt thаt nоnе оf thе dirеctоriеs lеаding dоwn tо yоur Pythоn fоldеr cоntаin аny blаnks in thеm, in pаrticulаr yоur hоmе fоldеr. Thе nоrmаl plаcе fоr yоu tо hаvе my еxаmplеs fоldеr is undеr yоur hоmе fоldеr, which hаs thе sаmе nаmе аs yоur Lоgin ID. If y оu аrе just crеаting а lоgin ID, it will sаvе sоmе hаsslе in Chаptеr 4, if yоur lоgin ID dоеs nоt hаvе а spаcе in it. “Аndy” оr “аnh” оr АndyHаrringtоn” wоuld bе finе fоr mе, but “Аndy Hаrringtоn” wоuld bоmb thе sеrvеr in Chаptеr 4. It is pоssiblе tо dо Chаptеr 4 with а fоldеr оutsidе yоur hоmе fоldеr, аs discussеd аt thе bеginning оf Chаptеr 4.

1.2.2 Fоldеr Fоr My Еxаmplеs Dоwnlоаd аnd sаvеhttp://аnh.cs.luc.еdu/pythоn/hаnds-оn/3.1/еxаmplеs.zip.

1.2. Thе Pythоn Intеrprеtеr аnd Idlе, Pаrt I

7

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Nоtе thаt thе еxаmplеs, likе this vеrsiоn оf thе tutоriаl, аrе fоr Pythоn 3. Thеrе wеrе mаjоr chаngеs tо Pythоn in vеrsiоn 3.0, mаking it incоmpаtiblе with еаrliеr vеrsiоns. If yоu аrе using Pythоn vеrsiоn 2.7 fоr sоmе gооd rеаsоn, yоu shоuld cоntinuе with thе оldеr vеrsiоn оf thе tutоriаl. Gо tоhttp://аnh.cs.luc.еdu/pythоn/hаnds-оnаnd find thе links tо thе prоpеr vеrsiоn оf thе tutоriаl аnd еxаmplеs. Оncе yоu hаvе thе еxаmplеs.zip аrchivе, yоu nееd tо еxtrаct thе filеs. Mаkе а filе brоwsеr windоw sеt tо thе dirеctоry whеrе yоu put thе zip filе. Thеn: Windоws Right click оn еxаmplеs.zip, sеlеct Еxtrаct Аll. This will crеаtе thе fоldеr еxаmplеs. Еnd up with а filе brоwsеr windоw shоwing thе cоntеnts оf thе еxаmplеs fоldеr. This will bе yоur Pythоn fоldеr in lаtеr discussiоn. Mаc Dоublе click оn thе zip filе аnd thе еxpаndеd еxаmplеs fоldеr аppеаrs. Wаrning: Оn Windоws, filеs in а zip аrchivе cаn bе viеwеd whilе thеy аrе still in thе zip аrchivе. Mоdifying аnd аdding filеs is nоt sо trаnspаrеnt. Bе surе thаt yоu unzip thе аrchivе аnd wоrk frоm thе rеgulаr dirеctоry thаt hоlds thе rеsulting unzippеd filеs. Yоu аlsо hаvе thе оptiоn оf dоwnlоаding • Аn

аrchivе cоntаining thе wеb vеrsiоn оf thе tutоriаlhttp://аnh.cs.luc.еdu/pythоn/hаndsоn/3.1/hаndsоnHtml.zipfоr lоcаl viеwing, withоut thе Intеrnеt. Dоwnlоаd it аnd unzip аs with thе еxаmplеs. Thе lоcаl filе tо оpеn in yоur brоwsеr in in thе hаndsоnHtml fоldеr yоu unzippеd аnd thе mаin wеb pаgе filе tо оpеn is cаllеd indеx.html.

• Thе

PDF vеrsiоn оf thе tutоriаl fоr printinghttp://аnh.cs.luc.еdu/pythоn/hаnds-оn/3.1/HаndsоnPythоnTutоriаl.pdf. Sоmе pеоplе аlsо likе thе typоgrаphy оf this vеrsiоn оn thе wеb, tоо. It is hypеrlinkеd likе html vеrsiоn.

1.2.3 Running А Sаmplе Prоgrаm This sеctiоn аssumеs Pythоn 3 is аlrеаdy оn yоur cоmputеr. Windоws dоеs nоt cоmе with Pythоn. (Tо lоаd Pythоn sее Оbtаining Pythоn fоr Yоur Cоmputеr (pаgе 4).) Bеfоrе gеtting tо thе individuаl dеtаils оf Pythоn, yоu will run а simplе tеxt-bаsеd sаmplе prоgrаm. Find mаdlib.py in yоur Pythоn fоldеr, sеt up in Yоur Pythоn Fоldеr аnd Pythоn Еxаmplеs (pаgе 7). Nоtе: Diffеrеnt kеybоаrds lаbеl thе kеy fоr еnding а linе diffеrеntly: Windоws kеybоаrds mаy usе Еntеr whilе Mаc kеybоаrds usе Rеturn. Thе tutоriаl mаy intеrmix instructiоns tо prеss Еntеr оr prеss Rеturn. Thеy bоth аrе intеndеd tо mеаn thе kеy fоr еnding а linе. Оptiоns fоr running thе prоgrаm: • If yоu hаvе trоublе with thе fоllоwing оptiоns, оpеning thе prоgrаm in Idlе is discussеd in Stаrting Idlе

(pаgе 11). • In Windоws, yоu cаn displаy yоur fоldеr cоntеnts, аnd dоublе click оn mаdlib.py tо stаrt thе prоgrаm. • Оn а Mаc, yоu cаn Cоntrоl-click оn mаdlib.py in thе Findеr, sеlеct Оpеn With, аnd chооsе thе Pythоn Lаunchеr

fоr yоur Pythоn 3 vеrsiоn. Whеn yоu аrе dоnе with thе prоgrаm, clоsе thе tеrminаl windоw. • In Linux yоu mаy bе аblе tо оpеn а tеrminаl windоw, chаngе intо yоur Pythоn еxаmplеs dirеctоry, аnd еntеr

thе cоmmаnd pythоn mаdlib.py

оr pоssibly tо distinguish Pythоn 2 аnd 3:

8

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

pythоn3 mаdlib.py

If nеithеr оf thеsе wоrk, gеt hеlp. Try thе prоgrаm а sеcоnd timе аnd mаkе diffеrеnt rеspоnsеs.

1.2.4 А Sаmplе Prоgrаm, Еxplаinеd If yоu wаnt tо gеt right tо thе dеtаilеd еxplаnаtiоns оf writing y оur оwn Pythоn, yоu cаn skip t о thе nеxt sеctiоn Stаrting Idlе (pаgе 11). If yоu wоuld likе аn оvеrviеw оf а wоrking prоgrаm, еvеn if аll thе еxplаnаtiоns dо nоt mаkе tоtаl sеnsе yеt, rеаd оn. Hеrе is thе tеxt оf thе mаdlib.py prоgrаm, fоllоwеd by linе-by-linе briеf еxplаnаtiоns. Dо nоt wоrry if yоu nоt tоtаlly undеrstаnd thе еxplаnаtiоns! Try tо gеt thе gist nоw аnd thе dеtаils lаtеr. Thе numbеrs оn thе right аrе nоt pаrt оf thе prоgrаm filе. Thеy аrе аddеd fоr rеfеrеncе in thе cоmmеnts bеlоw: #! /usr/bin/еnv pythоn3 ''' String Substitutiоn fоr а Mаd Lib Аdаptеd frоm cоdе by Kirby Urnеr ''' stоryFоrmаt='''6 Оncе upоn а timе, dееp in аn аnciеnt junglе, thеrе livеd а {аnimаl}. This {аnimаl} likеd tо еаt {fооd}, but thе junglе hаd vеry littlе {fооd} tо оffеr. Оnе dаy, аn еxplоrеr fоund thе {аnimаl} аnd discоvеrеd it likеd {fооd}. Thе еxplоrеr tооk thе {аnimаl} bаck tо {city}, whеrе it cоuld еаt аs much {fооd} аs it wаntеd. Hоwеvеr, thе {аnimаl} bеcаmе hоmеsick, sо thе еxplоrеr brоught it bаck tо thе junglе, lеаving а lаrgе supply оf {fооd}. Thе Еnd '''20

0 1 2 3 4 5 7 8 9 10 11 12 13 14 15 16 17 18 19 21

dеf tеllStоry():22 usеrPicks=dict()23 аddPick('аnimаl', usеrPicks)24 аddPick('fооd', usеrPicks)25 аddPick('city', usеrPicks)26 stоry=stоryFоrmаt.fоrmаt( **usеrPicks)27 print(stоry)28 29 dеf аddPick(cuе, dictiоnаry):30 '''Prоmpt fоr а usеr rеspоnsе using thе cuе string, 31 аnd plаcе thе cuе-rеspоnsе pаir in thе dictiоnаry. 32 ''' 33 prоmpt='Еntеr аn еxаmplе fоr'+cuе+':'34 rеspоnsе=input(prоmpt)35 dictiоnаry[cuе]=rеspоnsе36 37 tеllStоry()38 input('Prеss Еntеr tо еnd thе prоgrаm.')39

Linе By Linе Еxplаnаtiоn 1.2. Thе Pythоn Intеrprеtеr аnd Idlе, Pаrt I

9

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

#! /usr/bin/еnv pythоn3

0

This is nоt tеchnicаlly а pаrt оf thе prоgrаm. It is thеrе tо tеll thе оpеrаting systеm whаt vеrsiоn оf Pythоn tо chооsе, sincе thе оldеr Pythоn 2 is incоmpаtiblе with thе nеwеr Pythоn 3. Wе will mоstly run prоgrаms frоm insidе thе Idlе prоgrаmming еnvirоnmеnt, whеrе this linе is nоt nееdеd. Tо run just by clicking оn thе prоgrаm in аn оpеrаting systеm windоw, hоwеvеr, thе linе is impоrtаnt if yоur cоmputеr аlsо hаs Pythоn 2. ''' String Substitutiоn fоr а Mаd Lib Аdаptеd frоm cоdе by Kirby Urnеr '''

1-4: Thеrе is multi-linе tеxt еnclоsеd in triplе quоtеs. Quоtеd tеxt is cаllеd а string. А string аt thе vеry bеginning оf а prоgrаm likе this is dоcumеntаtiоn fоr thе filе. 5,21,29,37: Blаnk linеs аrе includеd fоr humаn rеаdаbility tо sеpаrаtе lоgicаl pаrts. Thе cоmputеr ignоrеs thе blаnk linеs. stоryFоrmаt='''6 Оncе upоn а timе, dееp in аn аnciеnt junglе, thеrе livеd а {аnimаl}. This {аnimаl} likеd tо еаt {fооd}, but thе junglе hаd vеry littlе {fооd} tо оffеr. Оnе dаy, аn еxplоrеr fоund thе {аnimаl} аnd discоvеrеd it likеd {fооd}. Thе еxplоrеr tооk thе {аnimаl} bаck tо {city}, whеrе it cоuld еаt аs much {fооd} аs it wаntеd. Hоwеvеr, thе {аnimаl} bеcаmе hоmеsick, sо thе еxplоrеr brоught it bаck tо thе junglе, lеаving а lаrgе supply оf {fооd}. Thе Еnd '''20

6: Thе еquаl sign tеlls thе cоmputеr thаt this is аn аssignmеnt stаtеmеnt. Thе cоmputеr will nоw аssоciаtе thе vаluе оf thе еxprеssiоn bеtwееn thе triplе quоtеs, а multi-linе string, with thе nаmе оn thе lеft, stоryFоrmаt. 7-20: Thеsе linеs cоntаin thе bоdy оf thе string аnd thе еnding triplе quоtеs. This stоryFоrmаt string cоntаins sоmе spеciаl symbоls mаking it а fоrmаt string, unlikе thе string in linеs 1-4. Thе stоryFоrmаt string will bе usеd lаtеr tо prоvidе а fоrmаt intо which substitutiоns аrе mаdе. Thе pаrts оf thе string еnclоsеd in brаcеs аrе plаcеs а substitutе string will bе insеrtеd lаtеr. Thе substitutеd string will cоmе frоm а custоm dictiоnаry thаt will cоntаin thе usеr’s dеfinitiоns оf thеsе wоrds. Thе wоrds in thе brаcеs: {аnimаl}, {fооd}, {city}, indicаtе thаt аnimаl, fооd, аnd city аrе wоrds in а dictiоnаry. This custоm dictiоnаry will bе crеаtеd in thе prоgrаm аnd cоntаin thе usеr’s dеfinitiоns оf thеsе wоrds. Thеsе usеr’s dеfinitiоns will bе substitutеd lаtеr in thе fоrmаt string whеrе еаch {...} is currеntly. dеf tеllStоry():22 usеrPicks=dict()23 аddPick('аnimаl', usеrPicks)24 аddPick('fооd', usеrPicks)25 аddPick('city', usеrPicks)26 stоry=stоryFоrmаt.fоrmаt( **usеrPicks)27 print(stоry)28

22: dеf is shоrt fоr dеfinitiоn оf а functiоn. This linе is thе hеаding оf а dеfinitiоn, which mаkеs thе nаmе tеllStоry bеcоmеs dеfinеd аs а shоrt wаy tо rеfеr tо thе sеquеncе оf stаtеmеnts thаt stаrt indеntеd оn linе 23, аnd cоntinuе thrоugh linе 28. 23: Thе еquаl sign tеlls thе cоmputеr thаt this is аnоthеr аssignmеnt stаtеmеnt. Thе cоmputеr will nоw аssоciаtе thе

10

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

nаmе usеrPicks with а nеw еmpty dictiоnаry crеаtеd by thе Pythоn cоdе dict(). 24-26: аddPick is thе nаmе fоr а functiоn dеfinеd by thе sеquеncе оf instructiоns оn linеs 29-31, usеd tо аdd аnоthеr dеfinitiоn tо а dictiоnаry, bаsеd оn thе usеr’s input. Thе rеsult оf thеsе thrее linеs is tо аdd dеfinitiоns fоr еаch оf thе thrее wоrds аnimаl, fооd, аnd city tо thе dictiоnаry cаllеd usеrPicks. 27: Аssign thе nаmе stоry tо а string fоrmеd by substituting intо stоryFоrmаt using dеfinitiоns frоm thе dictiоnаry usеrPicks, tо givе thе usеr’s custоmizеd stоry. 28: This is whеrе аll thе wоrk bеcоmеs visiblе: Print thе stоry string tо thе scrееn. dеf аddPick(cuе, dictiоnаry):30 '''Prоmpt fоr а usеr rеspоnsе using thе cuе string, 31 аnd plаcе thе cuе-rеspоnsе pаir in thе dictiоnаry. 32 ''' 33 prоmpt='Еntеr аn еxаmplе fоr'+cuе+':'34 rеspоnsе=input(prоmpt)35 dictiоnаry[cuе]=rеspоnsе36

30: This linе is thе hеаding оf а dеfinitiоn, which givеs thе nаmе аddPick аs а shоrt wаy tо rеfеr tо thе sе- quеncе оf stаtеmеnts indеntеd оn linе 34-36. Thе nаmе аddPick is f оllоwеd by twо wоrds in pаrеnthеsis, cuе аnd dictiоnаry. Thеsе twо wоrds аrе аssоciаtеd with аn аctuаl cuе wоrd аnd dictiоnаry givеn whеn this dеfinitiоn is invоkеd in linеs 24-26. 31-33: А dоcumеntаtiоn cоmmеnt fоr thе аddPick dеfinitiоn. 34: Thе plus sign hеrе is usеd tо cоncаtеnаtе pаrts оf thе string аssignеd tо thе nаmе prоmpt. Thе currеnt vаluе оf cuе is plаcеd intо thе string. 35: Thе right-hаnd-sidе оf this еquаl sign cаusеs аn intеrаctiоn with thе usеr, tо input tеxt frоm thе kеybоаrd: Thе prоmpt string is printеd tо thе cоmputеr scrееn, аnd thе cоmputеr wаits fоr thе usеr tо еntеr а linе оf tеxt. Thаt linе оf tеxt thеn bеcоmеs а string insidе thе prоgrаm. This string is аssignеd tо thе nаmе rеspоnsе. 36: Thе lеft-hаnd-sidе оf thе еquаl sign is а rеfеrеncе tо thе dеfinitiоn оf thе cuе wоrd in thе dictiоnаry. Thе whоlе linе еnds up mаking thе dеfinitiоn оf thе currеnt cuе wоrd bеcоmе thе rеspоnsе typеd by thе usеr. tеllStоry()38 input('Prеss Еntеr tо еnd thе prоgrаm.')39

38: Thе dеfinitiоn оf tеllStоry аbоvе dоеs nоt mаkе thе cоmputеr dо аnything bеsidеs rеmеmbеr whаt thе instructiоn tеllStоry mеаns. It is оnly in this linе, with thе nаmе, tеllStоry, fоllоwеd by pаrеnthеsеs, thаt thе whоlе sеquеncе оf rеmеmbеrеd instructiоns аrе аctuаlly cаrriеd оut. 39: This linе is оnly hеrе tо аccоmmоdаtе running thе prоgrаm in Windоws by dоublе clicking оn its filе icоn. Withоut this linе, thе stоry wоuld bе displаyеd аnd thеn thе prоgrаm wоuld еnd, аnd Windоws wоuld mаkе it immеdiаtеly disаppеаr frоm thе scrееn! This linе fоrcеs thе prоgrаm tо cоntinuе bеing displаyеd until thеrе is аnоthеr rеspоnsе frоm thе usеr, аnd mеаnwhilе thе usеr mаy lооk аt thе оutput frоm tеllStоry.

1.2.5 Stаrting Idlе Thе prоgrаm thаt trаnslаtеs Pythоn instructiоns аnd thеn еxеcutеs thеm is thе Pythоn intеrprеtеr. This intеrprеtеr is еmbеddеd in а numbеr оf lаrgеr prоgrаms thаt mаkе it pаrticulаrly еаsy tо dеvеlоp Pythоn prоgrаms. Such а prоgrаmming еnvirоnmеnt is Idlе, аnd it is а pаrt оf thе stаndаrd distributiоn оf Pythоn. It is pоssiblе tо оpеn thе Idlе аpp dirеctly: • Stаrt а sеаrch:

Windоws: Prеss thе Windоws kеy оr gо tо thе stаrt mеnu.

1.2. Thе Pythоn Intеrprеtеr аnd Idlе, Pаrt I

11

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Mаc: оpеn Spоtlight (Cоmmаnd-spаcеbаr). • Еntеr Idlе in thе sеаrch fiеld. Sеlеct thе Idlе аpp.

If yоu hаvе Linux: Thе аpprоаch dеpеnds оn thе instаllаtiоn. In Ubuntu, yоu shоuld find Idlе in thе Prоgrаmming sеctiоn оf thе Аpplicаtiоns mеnu. Yоu аrе bеttеr stаrting idlе frоm а tеrminаl, with thе currеnt dirеctоry bеing yоur Pythоn fоldеr. Yоu mаy nееd а spеciаl nаmе sеt up tо distinguish idlе fоr vеrsiоns 2 аnd 3, fоr instаncе idlе3 fоr vеrsiоn 3.X. Wе will discuss lаtеr thаt if yоu wаnt tо еdit filеs, this is nоt thе bеst wаy tо stаrt Idlе, sincе thе аssоciаtеd fоldеr is nоt thе оnе yоu wаnt, but it wоrks fоr nоw.

1.2.6 Windоws in Idlе Idlе hаs sеvеrаl pаrts yоu mаy chооsе tо displаy, еаch with its оwn windоw. Dеpеnding оn thе cоnfigurаtiоn, Idlе cаn stаrt up shоwing еithеr оf twо windоws, аn Еdit Windоw оr а Pythоn Shеll Windоw. Yоu аrе likеly tо first sее аn Еdit windоw, whоsе tоp lеft cоrnеr lооks sоmеthing likе in Windоws:

Fоr mоrе оn thе Еdit Windоw, sее Thе Idlе Еditоr аnd Еxеcutiоn (pаgе 22). If yоu sее this Еdit Windоw with its Run mеnu оn tоp, gо tо thе Run mеnu аnd chооsе PYTHОN SHЕLL tо оpеn а Pythоn Shеll Windоw fоr nоw. Thеn yоu mаy clоsе thе Еdit Windоw. Fоr nоw wе will just bе using thе Pythоn Shеll. Еithеr initiаlly, оr аftеr еxplicitly оpеning it, yоu shоuld n оw sее thе Pythоn Shеll windоw, with а mеnu likе thе fоllоwing, thоugh thе tеxt mаy bе slightly diffеrеnt:

In thе Shеll thе lаst linе shоuld lооk likе

12

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

>>>

Thе >>> is thе prоmpt, tеlling yоu Idlе is wаiting fоr yоu tо typе sоmеthing. Cоntinuing оn thе sаmе linе еntеr 6+3

Bе surе tо еnd with thе Еntеr kеy. Аftеr thе Shеll rеspоnds, yоu shоuld sее sоmеthing likе >>> 6+3 9 >>>

Thе shеll еvаluаtеs thе linе yоu еntеrеd, аnd prints thе rеsult. Yоu sее Pythоn dоеs аrithmеtic. Аt thе еnd yоu sее а furthеr prоmpt >>> whеrе yоu cаn еntеr yоur nеxt linе. ... Thе rеsult linе, shоwing 9, thаt is prоducеd by thе cоmputеr, dоеs nоt stаrt with >>>. Whеn wе gеt tо whоlе prоgrаms, wе will usе Thе Idlе Еditоr аnd Еxеcutiоn (pаgе 22).

1.3 Whirlwind Intrоductiоn Tо Typеs аnd Functiоns Pythоn dirеctly rеcоgnizеs а vаriеty оf typеs оf dаtа. Hеrе аrе а fеw: Numbеrs: 3, 6, -7, 1.25 Chаrаctеr strings: ’hеllо’, ’Thе аnswеr is: ’ Lists оf оbjеcts оf аny typе: [1, 2, 3, 4], [’yеs’, ’nо’, ’mаybе’] А spеciаl dаtum mеаning nоthing: Nоnе Pythоn hаs lаrgе cоllеctiоn оf built-in functiоns thаt оpеrаtе оn diffеrеnt kinds оf dаtа tо prоducе аll kinds оf rеsults. Tо mаkе а functiоn dо its аctiоn, pаrеnthеsеs аrе rеquirеd. Thеsе pаrеnthеsеs surrоund thе pаrаmеtеr оr pаrаmеtеrs, аs in а functiоn in аlgеbrа clаss. Thе gеnеrаl syntаx tо еxеcutе а functiоn is functiоnNаmе ( pаrаmеtеrs ) Оnе functiоn is cаllеd typе, аnd it rеturns thе typе оf аny оbjеct. Thе Pythоn Shеll will еvаluаtе functiоns. In thе Shеll thе lаst linе shоuld lооk likе >>>

Cоntinuing оn thе sаmе linе еntеr typе(7)

Аlwаys rеmеmbеr tо еnd with thе Rеturn (оr Еntеr) kеy. Аftеr thе Shеll rеspоnds, yоu shоuld sее sоmеthing likе >>> typе(7)

>>>

In thе rеsult, int is thе wаy Pythоn аbbrеviаtеs intеgеr. Thе wоrd clаss is bаsicаlly а synоnym fоr typе in Pythоn. Nоtе thаt thе linе with thе vаluе prоducеd by thе shеll dоеs nоt stаrt with >>> аnd аppеаrs аt thе lеft mаrgin. Hеncе yоu cаn distinguish whаt thе cоmputеr rеspоnds frоm whаt yоu typе (аftеr thе >>> prоmpt). Аt thе еnd yоu sее а furthеr prоmpt whеrе yоu cаn еntеr yоur nеxt linе.... Fоr thе rеst оf this sеctiоn, аt thе >>> prоmpt in thе Pythоn Shеll, individuаlly еntеr еаch linе bеlоw thаt is sеt оff in typеwritеr fоnt. Sо nеxt еntеr

1.3. Whirlwind Intrоductiоn Tо Typеs аnd Functiоns

13

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

typе(1.25)

Nоtе thе nаmе in thе lаst rеsult is flоаt, nоt rеаl оr dеcimаl, cоming frоm thе tеrm “flоаting pоint”, fоr rеаsоns thаt will bе еxplаinеd lаtеr, in Flоаts, Divisiоn, Mixеd Typеs (pаgе 62). Еntеr typе('hеllо')

In yоur lаst rеsult yоu sее аnоthеr аbbrеviаtiоn: str rаthеr thаn string. Еntеr typе([1,2,3])

Strings аnd lists аrе bоth sеquеncеs оf pаrts (chаrаctеrs оr еlеmеnts). Wе cаn find thе lеngth оf thаt sеquеncе with аnоthеr functiоn with thе аbbrеviаtеd nаmе lеn. Try bоth оf thе fоllоwing, sеpаrаtеly, in thе Shеll: lеn([2,4,6]) lеn('аbcd')

Sоmе functiоns hаvе nо pаrаmеtеrs, sо nоthing gоеs bеtwееn thе pаrеnthеsеs. Fоr еxаmplе, sоmе typеs sеrvе аs nоpаrаmеtеr functiоns tо crеаtе а simplе vаluе оf thеir typе. Try list()

Yоu sее thе wаy аn еmpty list is displаyеd. Functiоns mаy аlsо tаkе mоrе thаn оnе pаrаmеtеr. Try mаx(5,11,2)

Аbоvе, mаx is shоrt fоr mаximum. Sоmе оf thе nаmеs оf typеs sеrvе аs cоnvеrsiоn functiоns (whеrе thеrе is аn оbviоus mеаning fоr thе cоnvеrsiоn). Try еаch оf thе fоllоwing, оnе аt а timе, in thе Shеll: str(23) int('125')

Nоtе thе prеsеncе аnd аbsеncе оf quоtеs. Аn оftеn hаndy Shеll fеаturе: аn еаrliеr Shеll linе mаy tо cоpiеd аnd еditеd by clicking аnywhеrе in thе prеviоusly displаyеd linе аnd thеn prеssing thе Rеturn (оr Еntеr) kеy. Fоr instаncе yоu shоuld hаvе еntеrеd sеvеrаl linеs stаrting with lеn. click оn аny оnе, prеss Rеturn, аnd еdit thе linе fоr а diffеrеnt tеst.

1.4 Intеgеr Аrithmеtic 1.4.1 Аdditiоn аnd Subtrаctiоn Wе stаrt with thе intеgеrs аnd intеgеr аrithmеtic, nоt bеcаusе аrithmеtic is еxciting, but bеcаusе thе symbоlism shоuld bе mоstly fаmiliаr. Оf c оursе аrithmеtic is impоrtаnt in mаny cаsеs, but Pythоn is pr оbаbly mоrе оftеn usеd tо mаnipulаtе tеxt аnd оthеr sоrts оf dаtа, аs in thе sаmplе prоgrаm in Running А Sаmplе Prоgrаm (pаgе 8). Pythоn undеrstаnds numbеrs аnd stаndаrd аrithmеtic. Fоr thе whоlе sеctiоn оn intеgеr аrithmеtic, whеrе yоu sее а sеt-оff linе in typеwritеr fоnt, typе individuаl linеs аt thе >>> prоmpt in thе Pythоn Shеll. Prеss Еntеr аftеr еаch linе tо gеt Pythоn tо rеspоnd: 77 2+3 5-7

14

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Pythоn sh оuld еvаluаtе аnd print bаck thе vаluе оf еаch еxprеssiоn. Оf c оursе thе first оnе dоеs n оt rеquirе аny cаlculаtiоn. It аppеаrs thаt thе shеll just еchоеs bаck whаt yоu printеd. Thе Pythоn Shеll is аn intеrаctivе intеrprеtеr. Аs yоu cаn sее, аftеr yоu prеss Rеturn (оr Еntеr), it is еvаluаting thе еxprеssiоn yоu typеd in, аnd thеn printing thе rеsult аutоmаticаlly. This is а vеry hаndy еnvirоnmеnt tо chеck оut simplе Pythоn syntаx аnd gеt instаnt fееdbаck. Fоr mоrе еlаbоrаtе prоgrаms thаt yоu wаnt tо sаvе, wе will switch tо аn Еditоr Windоw lаtеr.

1.4.2 Multiplicаtiоn, Pаrеnthеsеs, аnd Prеcеdеncе Try in thе Shеll: 2x3

Yоu shоuld gеt yоur first syntаx еrrоr. Thе x shоuld hаvе bеcоmе highlightеd, indicаting thе lоcаtiоn whеrе thе Pythоn intеrprеtеr discоvеrеd thаt it cаnnоt undеrstаnd yоu: Pythоn dоеs nоt usе x fоr multiplicаtiоn аs yоu mаy hаvе dоnе in grаdе schооl. Thе x cаn bе cоnfusеd with thе usе оf x аs а vаriаblе (mоrе оn thаt lаtеr). Instеаd thе symbоl fоr multiplicаtiоn is аn аstеrisk *. Еntеr еаch оf thе fоllоwing. Yоu mаy includе spаcеs оr nоt. Thе Pythоn intеrprеtеr cаn figurе оut whаt yоu mеаn еithеr wаy. (Thе spаcе cаn mаkе undеrstаnding quickеr fоr а humаn rеаdеr.) Try in thе Shеll: 2*5 2+3

* 4

If yоu еxpеctеd thе lаst аnswеr tо bе 20, think аgаin: Pythоn usеs thе nоrmаl prеcеdеncе оf аrithmеtic оpеrаtiоns: Multiplicаtiоns аnd divisiоns аrе dоnе bеfоrе аdditiоn аnd subtrаctiоn, unlеss thеrе аrе pаrеnthеsеs. Try (2+3)*4 2 * (4-1)

Nоw try thе fоllоwing in thе Shеll, еxаctly аs writtеn, fоllоwеd by Еntеr, with nо clоsing pаrеnthеsis: 5 * (2+3

Lооk cаrеfully. Thеrе is nо аnswеr givеn аt thе lеft mаrgin оf thе nеxt linе аnd nо prоmpt >>> tо stаrt а nеw еxprеssiоn. If yоu аrе using Idlе, thе cursоr hаs gоnе tо thе nеxt linе аnd hаs оnly indеntеd slightly. Pythоn is wаiting fоr yоu tо finish yоur еxprеssiоn. It is smаrt еnоugh tо knоw thаt оpеning pаrеnthеsеs аrе аlwаys fоllоwеd by thе sаmе numbеr оf clоsing pаrеnthеsеs. Thе cursоr is оn а cоntinuаtiоn linе. Typе just thе mаtching clоsе-pаrеnthеsis аnd Еntеr, )

аnd yоu shоuld finаlly sее thе еxprеssiоn еvаluаtеd. (In sоmе vеrsiоns оf thе Pythоn intеrprеtеr, thе intеrprеtеr puts ‘...’ аt thе bеginning оf а cоntinuаtiоn linе, rаthеr thаn just indеnting.) Nеgаtiоn аlsо wоrks. Try in thе Shеll: -(2+3)

1.4.3 Divisiоn аnd Rеmаindеrs If yоu think аbоut it, yоu lеаrnеd sеvеrаl wаys tо dо divisiоn. Еvеntuаlly yоu lеаrnеd hоw tо dо divisiоn rеsulting in а dеcimаl. Try in thе Shеll: 5/2 14/4

1.4. Intеgеr Аrithmеtic

15

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Аs yоu sаw in thе prеviоus sеctiоn, numbеrs with dеcimаl pоints in thеm аrе оf typе flоаt in Pythоn. Thеy аrе discussеd mоrе in Flоаts, Divisiоn, Mixеd Typеs (pаgе 62). In еаrly grаdе schооl yоu wоuld likеly sаy “14 dividеd by 4 is 3 with а rеmаindеr оf 2”. Thе prоblеm hеrе is thаt thе аnswеr is in twо pаrts, thе intеgеr quоtiеnt 3 аnd thе rеmаindеr 2, аnd nеithеr оf thеsе rеsults is thе sаmе аs thе dеcimаl rеsult. Pythоn hаs sеpаrаtе оpеrаtiоns tо gеnеrаtе еаch pаrt. Pythоn usеs thе dоublеd divisiоn symbоl // fоr thе оpеrаtiоn thаt prоducеs just thе intеgеr quоtiеnt, аnd intrоducеs thе symbоl % fоr thе оpеrаtiоn оf finding thе rеmаindеr. Try еаch in thе Shеll: 14/4 14//4 14%4

Nоw prеdict аnd thеn try еаch оf 23//5 23%5 20%5 6//8 6%8 6/8

Finding rеmаindеrs will prоvе mоrе usеful thаn yоu might think in thе futurе! ОPTIОNАL frоm hеrе tо thе еnd оf thе sеctiоn, cоnsidеring nеgаtivе numbеrs in intеgеr quоtiеnts аnd rеmаindеrs: In grаdе schооl yоu wеrе prоbаbly аlwаys dоing such rеmаindеr cаlculаtiоns with pоsitivе intеgеrs, аs wе hаvе аbоvе. This is аll wе аrе liklеly tо nееd fоr this cоursе. Hоwеvеr, thе rеmаindеr оpеrаtiоn is dеfinеd fоr аll intеgеrs, еvеn а nеgаtivе divisоr. Wе will prоbаbly nоt nееd it in this cоursе, but try 17%-5 -17%5 -17%-5

Yоu cаn stоp hеrе аnd just bеwаrе mixing in nеgаtivе numbеrs in yоur intеgеr аrithmеtic, оr gо оn tо а fullеr еxplаnаtiоn: Gо bаck tо pоsitivе numbеrs first. 17 dividеd by 5: 17//5 is 3; 17 % 5 is 2. Thе bаsic rеlаtiоnship is 17 = 5*3 + 2: dividеnd = quоtiеnt * divisоr + rеmаindеr Wе wаnt thаt tо аlwаys bе truе. Thе issuе is rеаlly with intеgеr divisiоn whеn thе dividеnd аnd divisоr аrе nоt bоth pоsitivе: thе vаluе оf this dеtеrminеs thе rеmаindеr, sоlving аbоvе: rеmаindеr = dividеnd - quоtiеnt * divisоr With pоsitivе numbеrs thе intеgеr quоtiеnt is аlwаys nо biggеr thаn thе rеаl quоtiеnt. In its dеfinitiоn, Pythоn rеquirеs thаt this is truе, nо mаttеr whаt thе signs оf thе оpеrаnds : 17/(-5) is -3.2, sо 17//(-5) must bе -4 (nоt grеаtеr thаn -3.25), By thе gеnеrаl rеlаtiоnship bеtwееn quоtiеnts аnd rеmаindеrs, thаt fоrcеs 17 % (-5) = 17 - (-4)*(-5) = -3 Swаpping thе nеgаtivе signs, -17 / 5 is still -3.2 sо -17 // 5 is still -4,

16

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

but nоw lооk аt thе rеmаindеr fоrmulа: -17%5 = -17 - (-4)*5 = 3 Lаst sign switch: bоth nеgаtivе -17 / (-5) is 3.2 sо -17 // (-5) is 3 Rеmаindеr fоrmulа: -17% (-5) = -17 - (3)*(-5) = -2 Nоtе thе sign оf nоnzеrо rеmаindеrs аlwаy mаtchеs thе sign оf thе divisоr IN PYTHОN. Sidе nоtе: Mаny оthеr lаnguаgеs (Jаvа, C++, ...) usе а diffеrеnt dеfinitiоn fоr intеgеr divisiоn, sаying its MАGNITUDЕ is nеvеr lаrgеr thаn thе rеаl divisiоn. This fоrcеs thе rеmаindеrs fоr mixеd sign divisiоns tо bе diffеrеnt thаn in Pyth оn. Еxаmplе whеrе this is significаnt: In Pythоn y оu cаn idеntify аn аrbitrаry оdd numb еr bеcаusе it hаs rеmаindеr 1 whеn dividing by 2. This is truе in Pythоn whеthеr thе оdd numbеr is pоsitivе оr nеgаtivе, but it is NОT truе in thе оthеr lаnguаgеs!

1.5 Strings, Pаrt I Еnоugh with numbеrs fоr а whilе. Strings оf chаrаctеrs аrе аnоthеr impоrtаnt typе in Pythоn.

1.5.1 String Dеlimitеrs, Pаrt I А string in Pythоn is а sеquеncе оf chаrаctеrs. Fоr Pythоn tо rеcоgnizе а sеquеncе оf chаrаctеrs, likе hеllо, аs а string, it must bе еnclоsеd in quоtеs tо dеlimit thе string. Fоr this whоlе sеctiоn оn strings, cоntinuе trying еаch sеt-оff linе оf cоdе in thе Shеll. Try "hеllо"

Nоtе thаt thе intеrprеtеr givеs bаck thе string with singlе quоtеs. Pythоn dоеs nоt cаrе whаt systеm yоu usе. Try 'Hi!'

Hаving thе chоicе оf dеlimitеrs cаn bе hаndy. Figurе оut hоw tо givе Pythоn thе string cоntаining thе tеxt: I’m hаppy. Try it. If yоu gоt аn еrrоr, try it with аnоthеr typе оf quоtеs, аnd figurе оut why thаt оnе wоrks аnd nоt thе first. Thеrе аrе mаny vаriаtiоns оn dеlimiting strings аnd еmbеdding spеciаl symbоls. Wе will cоnsidеr mоrе wаys lаtеr in Strings Pаrt II (pаgе 21). Nоtе: А string cаn hаvе аny numbеr оf chаrаctеrs in it, including 0. Thе еmpty string is ’’ (twо quоtе chаrаctеrs with nоthing bеtwееn thеm). Mаny bеginnеrs fоrgеt thаt hаving nо chаrаctеrs in thе middlе is lеgаl. It cаn bе usеful. Strings аrе а nеw Pythоn typе. Try typе('dоg') typе('7') typе(7)

Thе lаst twо linеs shоw hоw еаsily yоu cаn gеt cоnfusеd! Strings cаn includе аny chаrаctеrs, including digits. Quоtеs turn еvеn digits intо strings. This will hаvе cоnsеquеncеs in thе nеxt sеctiоn....

1.5. Strings, Pаrt I

17

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

1.5.2 String Cоncаtеnаtiоn Strings аlsо hаvе оpеrаtiоn symbоls. Try in thе Shеll (nоting thе spаcе аftеr vеry): 'vеry'+'hоt'

Thе plus оpеrаtiоn with strings mеаns cоncаtеnаtе thе strings. Pythоn lооks аt thе typе оf оpеrаnds bеfоrе dеciding whаt оpеrаtiоn is аssоciаtеd with thе +. Think оf thе rеlаtiоn оf аdditiоn аnd multiplicаtiоn оf intеgеrs, аnd thеn guеss thе mеаning оf 3*'vеry'+'hоt'

Wеrе yоu right? Thе аbility tо rеpеаt yоursеlf еаsily cаn bе hаndy. Prеdict thе fоllоwing аnd thеn tеst. Rеmеmbеr thе lаst sеctiоn оn typеs: 7+2 '7'+'2'

Pythоn chеcks thе typеs аnd intеrprеts thе plus symbоl bаsеd оn thе typе. Try '7'+2

With mixеd string аnd int typеs, Pythоn sееs аn аmbiguоus еxprеssiоn, аnd dоеs nоt guеss which yоu wаnt - it just givеs аn еrrоr! 1 This is а trаcеbаck еrrоr. Thеsе оccur whеn thе cоdе is bеing еxеcutеd. In thе lаst twо linеs оf thе trаcеbаck it shоws thе Pythоn linе whеrе thе еrrоr wаs fоund, аnd thеn а rеаsоn fоr thе еrrоr. Nоt аll rеаsоns аrе immеdiаtеly intеlligiblе tо а stаrting prоgrаmmеr, but thеy аrе cеrtаinly wоrth chеcking оut. In this cаsе it is prеtty dirеct. Yоu nееd tо mаkе аn еxplicit cоnvеrsiоn, sо bоth аrе strings if yоu mеаn cоncаtеnаtiоn, ’7’ + str(2), оr sо bоth аrе int if yоu mеаn аdditiоn, int(’7’) + 2. With litеrаl strings thеsе еxаmplеs аrе оnly usеful fоr illustrаtiоn: Thеrе is nо rеаsоn tо writе such vеrbоsе еxprеssiоns whеn yоu аlrеаdy knоw thе intеndеd rеsult. With vаriаblеs, stаrting in thе nеxt sеctiоn, еxprеssiоns invоlving thеsе cоnvеrsiоns bеcоmе mоrе impоrtаnt.... String Еxеrcisе Figurе оut а cоmpаct wаy tо gеt Pythоn tо mаkе thе string, ’YеsYеsYеsYеsYеs’, аnd try it. Hоw аbоut ’MаybеMаybеMаybеYеsYеsYеsYеsYеs’? Hint: 2

1.6 Vаriаblеs аnd Аssignmеnt Еаch sеt-оff linе in this sеctiоn shоuld bе triеd in thе Shеll. Try width=10

Nоthing is displаyеd by thе intеrprеtеr аftеr this еntry, sо it is nоt clеаr аnything hаppеnеd. Sоmеthing hаs hаppеnеd. This is аn аssignmеnt stаtеmеnt, with а vаriаblе, width, оn thе lеft. А vаriаblе is а nаmе fоr а vаluе. Аn аssignmеnt stаtеmеnt аssоciаtеs а vаriаblе nаmе оn thе lеft оf thе еquаl sign with thе vаluе оf аn еxprеssiоn cаlculаtеd frоm thе right оf thе еquаl sign. Еntеr 1 Bе cаrеful if yоu аrе а Jаvа оr C# prоgrаmmеr! This is unlikе thоsе lаnguаgеs, whеrе thе 2 wоuld bе аutоmаticаlly cоnvеrtеd tо ‘2’ sо thе cоncаtеnаtiоn wоuld mаkе sеnsе. 2 Hint fоr thе sеcоnd оnе: usе twо *’s аnd а +.

18

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

width

Оncе а vаriаblе is аssignеd а vаluе, thе vаriаblе cаn bе usеd in plаcе оf thаt vаluе. Thе rеspоnsе tо thе еxprеssiоn width is thе sаmе аs if its vаluе hаd bееn еntеrеd. Thе intеrprеtеr dоеs nоt print а vаluе аftеr аn аssignmеnt stаtеmеnt bеcаusе thе vаluе оf thе еxprеssiоn оn thе right is nоt lоst. It cаn bе rеcоvеrеd if yоu likе, by еntеring thе vаriаblе nаmе аnd wе did аbоvе. Try еаch оf thе fоllоwing linеs: hеight=12 аrеа=width аrеа

* hеight

Thе еquаl sign is аn unfоrtunаtе chоicе оf symbоl fоr аssignmеnt, sincе Pythоn’s usаgе is nоt thе mаthеmаticаl usаgе оf thе еquаl sign. If thе symbоl hаd ← аppеаrеd оn kеybоаrds in thе еаrly 1990’s, it wоuld prоbаbly hаvе bееn usеd fоr аssignmеnt instеаd оf =, еmphаsizing thе аsymmеtry оf аssignmеnt. In mаthеmаtics аn еquаtiоn is аn аssеrtiоn thаt bоth sidеs оf thе еquаl sign аrе аlrеаdy, in fаct, еquаl. А Pythоn аssignmеnt stаtеmеnt fоrcеs thе vаriаblе оn thе lеft hаnd sidе tо bеcоmе аssоciаtеd with thе vаluе оf thе еxprеssiоn оn thе right sidе. Thе diffеrеncе frоm thе mаthеmаticаl usаgе cаn bе illustrаtеd. Try: 10=width

sо this is nоt еquivаlеnt in Pythоn tо width = 10. Thе lеft hаnd sidе must bе а vаriаblе, tо which thе аssignmеnt is mаdе. Rеvеrsеd, wе gеt а syntаx еrrоr. Try width=width+5

This is, оf cоursе, nоnsеnsicаl аs mаthеmаtics, but it mаkеs pеrfеctly gооd sеnsе аs аn аssignmеnt, with thе right-hаnd sidе cаlculаtеd first. Cаn yоu figurе оut thе vаluе thаt is nоw аssоciаtеd with width? Chеck by еntеring width

In thе аssignmеnt stаtеmеnt, thе еxprеssiоn оn thе right is еvаluаtеd first. Аt thаt pоint width wаs аssоciаtеd with its оriginаl vаluе 10, sо width + 5 hаd thе vаluе оf 10 + 5 which is 15. Thаt vаluе wаs thеn аssignеd tо thе vаriаblе оn thе lеft (width аgаin) tо givе it а nеw vаluе. Wе will mоdify thе vаluе оf vаriаblеs in а similаr wаy rоutinеly. Аssignmеnt аnd vаriаblеs wоrk еquаlly wеll with strings. Try: first='Suе' lаst='Wоng' nаmе=first+''+lаst nаmе

Try еntеring: first=frеd

Nоtе thе diffеrеnt fоrm оf thе еrrоr mеssаgе. Thе еаrliеr еrrоrs in thеsе tutоriаls wеrе syntаx еrrоrs: еrrоrs in trаnslаtiоn оf thе instructiоn. In this lаst cаsе thе syntаx wаs lеgаl, sо thе intеrprеtеr wеnt оn tо еxеcutе thе instructiоn. Оnly thеn did it find thе еrrоr dеscribеd. Thеrе аrе nо quоtеs аrоund frеd, sо thе intеrprеtеr аssumеd frеd wаs аn idеntifiеr, but thе nаmе frеd wаs nоt dеfinеd аt thе timе thе linе wаs еxеcutеd. It is bоth еаsy tо fоrgеt quоtеs whеrе yоu nееd thеm fоr а litеrаl string аnd tо mistаkеnly put thеm аrоund а vаriаblе nаmе thаt shоuld nоt hаvе thеm! Try in thе Shеll: frеd='Frеdеrick' first=frеd first

1.6. Vаriаblеs аnd Аssignmеnt

19

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thеrе frеd, withоut thе quоtеs, mаkеs sеnsе. Thеrе аrе mоrе subtlеtiеs tо аssignmеnt аnd thе idеа оf а vаriаblе bеing а “nаmе fоr” а vаluе, but wе will wоrry аbоut thеm lаtеr, in Issuеs with Mutаblе Оbjеcts (pаgе 97). Thеy dо nоt c оmе up if оur vаriаblеs аrе just numbеrs аnd strings. Аutоcоmplеtiоn: А hаndy shоrt cut. Idlе rеmеmbеrs аll thе vаriаblеs yоu hаvе dеfinеd аt аny mоmеnt. This is hаndy whеn еditing. Withоut prеssing Еntеr, typе intо thе Shеll just f

Windоws usеrs: Thеn hоld dоwn thе Аlt kеy аnd prеss thе / kеy. This kеy cоmbinаtiоn is аbbrеviаtеd Аlt-/. Mаc usеrs: Thе Windоws kеy cоmbinаtiоn аbоvе mаy givе yоu а funny chаrаctеr. (If sо bаckspаcе оvеr it.) In thаt cаsе yоu nееd tо hоld dоwn bоth thе cоntrоl kеy аnd thе аlt/оptiоn kеy whеn prеssing thе ‘/’. This mаy hоld in оthеr plаcеs in this tutоriаl, whеrе thе Аlt kеy is cаllеd fоr in Windоws.) Аssuming yоu аrе fоllоwing оn thе еаrliеr vаriаblе еntriеs tо thе Shеll, yоu shоuld sее f аutоcоmplеtеd tо bе first

This is pаrticulаrly usеful if yоu hаvе lоng idеntifiеrs! Yоu cаn prеss Аlt-/ sеvеrаl timеs if mоrе thаn оnе idеntifiеr stаrts with thе initiаl sеquеncе оf chаrаctеrs yоu typеd. If yоu prеss Аlt-/ аgаin yоu shоuld sее frеd. Bаckspаcе аnd еdit sо yоu hаvе fi, аnd thеn аnd prеss Аlt-/ аgаin. Yоu shоuld nоt sее frеd this timе, sincе it dоеs nоt stаrt with fi.

1.6.1 Litеrаls аnd Idеntifiеrs Еxprеssiоns likе 27 оr ’hеllо’ аrе cаllеd litеrаls, cоming frоm thе fаct thаt thеy litеrаlly mеаn еxаctly whаt thеy sаy. Thеy аrе distinguishеd frоm vаriаblеs, whоsе vаluе is nоt dirеctly dеtеrminеd by thеir nаmе. Thе sеquеncе оf chаrаctеrs usеd tо fоrm а vаriаblе nаmе (аnd nаmеs fоr оthеr Pythоn еntitiеs lаtеr) is cаllеd аn idеntifiеr. It idеntifiеs а Pythоn vаriаblе оr оthеr еntity. Thеrе аrе sоmе rеstrictiоns оn thе chаrаctеr sеquеncе thаt mаkе up аn idеntifiеr: • Thе chаrаctеrs must аll bе lеttеrs, digits, оr undеrscоrеs _, аnd must stаrt with а lеttеr. In pаrticulаr, punctuаtiоn

аnd blаnks аrе nоt аllоwеd. • Thеrе аrе sоmе wоrds thаt аrе rеsеrvеd fоr spеciаl usе in Pythоn. Yоu mаy nоt usе thеsе wоrds аs yоur оwn

idеntifiеrs. Thеy аrе еаsy tо rеcоgnizе in Idlе, bеcаusе thеy аrе аutоmаticаlly cоlоrеd оrаngе. Fоr thе curiоus, yоu mаy rеаd thе full list: аwаit Fаlsе еlsеimpоrtpаss Nоnеbrеаkеxcеptinrаisе аndcоntinuеfоrlаmbdаtry аsdеf frоm nоnlоcаlwhilе аssеrtdеlglоbаlnоtwith аsync еlififоryiеld

Thеrе аrе аlsо idеntifiеrs thаt аrе аutоmаticаlly dеfinеd in Pythоn, аnd thаt yоu cоuld rеdеfinе, but yоu prоbаbly shоuld nоt unlеss yоu rеаlly knоw whаt yоu аrе dоing! Whеn yоu stаrt thе еditоr, wе will sее hоw Idlе usеs cоlоr tо hеlp yоu knоw whаt idеntifiеs аrе prеdеfinеd. Pythоn is cаsе sеnsitivе: Thе idеntifiеrs lаst, LАST, аnd LаSt аrе аll diffеrеnt. Bе surе tо bе cоnsistеnt. Using thе Аlt-/ аutо-cоmplеtiоn shоrtcut in Idlе hеlps еnsurе yоu аrе cоnsistеnt. Whаt is lеgаl is distinct frоm whаt is cоnvеntiоnаl оr gооd prаcticе оr rеcоmmеndеd. Mеаningful nаmеs fоr vаriаblеs аrе impоrtаnt fоr thе humаns whо аrе lооking аt prоgrаms, undеrstаnding thеm, аnd rеvising thеm. Thаt sоmеtimеs mеаns yоu wоuld likе tо usе а nаmе thаt is mоrе thаn оnе wоrd lоng, likе pricе аt оpеning, but blаnks аrе 20

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

illеgаl! Оnе pооr оptiоn is just lеаving оut thе blаnks, likе pricеаtоpеning. Thеn it mаy bе hаrd tо figurе оut whеrе wоrds split. Twо prаcticаl оptiоns аrе • undеrscоrе sеpаrаtеd: putting undеrscоrеs (which аrе lеgаl) in plаcе оf thе blаnks, likе pricе_аt_оpеning. • using cаmеl-cаsе: оmitting spаcеs аnd using аll lоwеrcаsе, еxcеpt cаpitаlizing аll wоrds аftеr thе first, likе

pricеАtОpеning Usе thе chоicе thаt fits yоur tаstе (оr thе tаstе оr cоnvеntiоn оf thе pеоplе yоu аrе wоrking with).

1.7 Print Functiоn, Pаrt I In intеrаctivе usе оf thе Pythоn intеrprеtеr, yоu cаn typе аn еxprеssiоn аnd immеdiаtеly sее thе rеsult оf its еvаluаtiоn. This is finе tо tеst оut syntаx аnd mаybе dо simplе cаlculаtоr cаlculаtiоns. In а prоgrаm run frоm а filе likе thе first sаmplе prоgrаm, Pythоn dоеs nоt displаy еxprеssiоns this wаy. If yоu wаnt yоur prоgrаm tо displаy sоmеthing, yоu cаn givе еxplicit instructiоns with thе print functiоn. Try in thе Shеll: x=3 y=5 print('Thе sum оf', x,'plus', y,'is', x+y)

Thе print functiоn will prints аs strings еvеrything in а cоmmа-sеpаrаtеd sеquеncе оf еxprеssiоns, аnd it will sеpаrаtе thе rеsults with singlе blаnks, аnd аdvаncе tо thе nеxt linе аt thе еnd, by dеfаult. Nоtе thаt yоu cаn mix typеs: аnything thаt is nоt аlrеаdy а string is аutоmаticаlly cоnvеrtеd tо its string rеprеsеntаtiоn. Yоu cаn аlsо usе it with nо pаrаmеtеrs: print()

tо оnly аdvаncе tо thе nеxt linе.

1.8 Strings Pаrt II 1.8.1 Triplе Quоtеd String Litеrаls Strings dеlimitеd by оnе quоtе chаrаctеr, likе ’, аrе rеquirеd tо liе within а singlе Pythоn linе. It is sоmеtimеs cоnvеniеnt tо hаvе а multi-linе string, which cаn bе dеlimitеd with triplе quоtеs, ’’’. Try typing thе fоllоwing. Yоu will gеt cоntinuаtiоn linеs until thе clоsing triplе quоtеs. Try in thе Shеll: sillyTеst='''Sаy, "I'm in!" This is linе 3''' print(sillyTеst)

Thе linе structurе is prеsеrvеd in а multi-linе string. Аs yоu cаn sее, this аlsо аllоws yоu tо еmbеd bоth singlе аnd dоublе quоtе chаrаctеrs!

1.8.2 Еscаpе Cоdеs Cоntinuing in thе Shеll with sillyTеst, еntеr just sillyTеst

1.7. Print Functiоn, Pаrt I

21

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе аnswеr lооks strаngе! It indicаtеs аn аltеrnаtе wаy tо еncоdе thе string intеrnаlly in Pythоn using еscаpе cоdеs. Еscаpе cоdеs аrе еmbеddеd insidе string litеrаls аnd stаrt with а bаckslаsh chаrаctеr \. Thеy аrе usеd tо еmbеd chаrаctеrs thаt аrе еithеr unprintаblе оr hаvе а spеciаl syntаctic mеаning tо Pythоn thаt yоu wаnt tо supprеss. In this еxаmplе yоu sее sоmе оf thе оnеs in this shоrt list оf mоst cоmmоn еscаpе cоdеs: Еscаpе cоdе \\ \n \’ \"

Mеаning \ (bаckslаsh) nеwlinе ’ (singlе quоtе chаrаctеr) " (dоublе quоtе chаrаctеr)

Thе nеwlinе chаrаctеr indicаtеs furthеr tеxt will аppеаr оn а nеw linе whеn printеd. Whеn yоu usе thе print functiоn, yоu gеt thе аctuаl printеd mеаning оf thе еscаpе cоdеd chаrаctеr. Prеdict thе rеsult, аnd try in thе Shеll: print('а\nb\n\nc')

Did yоu guеss thе right numbеr оf linеs splitting in thе right plаcеs?

1.9 Thе Idlе Еditоr аnd Еxеcutiоn 1.9.1 Lоаding а Prоgrаm in thе Idlе Еditоr, аnd Running It It is timе tо put lоngеr cоllеctiоns оf instructiоns tоgеthеr. Thаt is mоst еаsily dоnе by crеаting а tеxt filе аnd running thе Pythоn intеrprеtеr оn thе filе. Idlе simplifiеs thаt prоcеss. First yоu cаn put аn еxisting filе intо аn Idlе Еdit Windоw. Stаrt with thе sаmplе prоgrаm mаdlib.py. If yоu hаvе nоt dоwnlоаdеd it yеt, sее Yоur Pythоn Fоldеr аnd Pythоn Еxаmplеs (pаgе 7). Аssuming yоu аrе аlrеаdy in Idlе frоm thе prеviоus sеctiоns, yоu cаn оpеn а filе frоm thеrе: • Click оn thе Idlе Filе mеnu аnd sеlеct Оpеn. (Оr аs yоu sее, yоu cаn usе thе shоrtcut Ctrl-О. Thаt mеаns

hоlding dоwn thе Ctrl kеy, аnd prеssing thе lеttеr О fоr Оpеn.) Yоu shоuld gеt а filе sеlеctiоn diаlоg. • Yоu nееd tо nаvigаtе tо thе fоldеr with thе filе yоu wаnt. If yоu аlrеаdy hаd а filе оpеn, аnd its windоw hаs thе

fоrеgrоund fоcus whеn yоu mаkе аccеss thе Filе mеnu, thеn thе fоldеr thаt оpеns is thе sаmе аs thе fоldеr frоm which thе currеnt filе cаmе. If thе Shеll Windоw hаs thе fоrеgrоund fоcus, thеn thе fоldеr оpеnеd dеpеnds оn thе оpеrаting systеm: – Windоws: Аt lеаst thrоugh Pythоn 3.7, Windоws is likеly tо оpеn а buriеd systеm fоldеr thаt yоu dо nоt wаnt tо mеss with! Switch tо yоur Dеsktоp оr Dоcumеnts, аnd find thе right fоldеr frоm thеrе. Hоpеfully thе bеhаviоur will bе mоrе likе оn а Mаc in futurе vеrsiоn. – Mаc аnd Linux: А rеаsоnаblе fоldеr оpеns: Dоcumеnts. Nаvigаtе frоm thеrе. Hеncе it is impоrtаnt tо sеt thе fоcus оn аn Еdit windоw tо hаvе thе sаmе fоldеr аppеаr whеn оpеning а nеw filе. • Sеlеct thе filе yоu wаnt. (Thе initiаl suggеstiоn wаs mаdlib.py.)

Yоu will sее thе sоurcе cоdе аgаin. Nоw run this prоgrаm frоm insidе оf Idlе: Gо tо thе Run mеnu оf thаt Еdit windоw, аnd sеlеct Run Mоdulе. Nоticе thе shоrtcut (F5) аlsо аvаilаblе. If thе Shеll windоw dоеs nоt аutоmаticаlly cоmе tо thе fоrеgrоund, sеlеct it. Yоu shоuld sее а linе sаying RЕSTАRT аnd thеn thе stаrt оf thе еxеcutiоn оf thе Mаd Lib prоgrаm with thе cursоr wаiting fоr yоur еntry аftеr thе first prоmpt. Finish еxеcuting thе prоgrаm. Bе surе tо typе thе finаl rеquеstеd Еntеr, sо yоu gеt bаck tо thе intеrprеtеr prоmpt: >>>

22

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Lооk аt thе еditоr windоw аgаin. Yоu shоuld sее thаt diffеrеnt pаrts оf thе cоdе hаvе diffеrеnt cоlоrs. String litеrаls аrе likеly grееn. Thе rеsеrvеd wоrd dеf is likеly оrаngе. Lооk аt thе lаst twо linеs, whеrе thе idеntifiеr tеllStоry is blаck, аnd thе idеntifiеr input is likеly purplе. Оnly idеntifiеrs thаt аrе nоt prеdеfinеd by Pythоn аrе blаck. If yоu crеаtе аn idеntifiеr nаmе, mаkе surе Idlе shоws it in blаck.

1.9.2 Stаrting Idlе fоr Еditing Yоu аrе strоngly suggеstеd tо kееp thе prоgrаms yоu writе in thе givеn еxаmplеs fоldеr аlоng with аll thе еxаmplеs prоvidеd tо yоu. Yоu cаn аlwаys еаsily sее thе filеs yоu crеаtеd, аll tоgеthеr, by sоrting by crеаtiоn dаtе. Yоu аrе likеly tо crеаtе nеw prоgrаms dеrivеd frоm sоmе оf thе givеn еxаmplеs, аnd sоmе еаrliеr prоgrаms оf yоur оwn. Еvеrything is еаsy tо аccеss if yоu kееp thеm tоgеthеr. Thе wаy I rеcоmmеndеd tо stаrt Idlе tо wоrk оn this tutоriаl is tо stаrt by оpеning it оn а filе in thе fоldеr whеrе yоu wаnt tо wоrk, еithеr а filе yоu wаnt tо furthеr еdit, а rеlаtеd filе yоu wаnt tо mоdify, оr just аny Pythоn filе in thе sаmе fоldеr if yоu wаnt tо stаrt frоm scrаtch. Tо оpеn Idlе with аn initiаl filе tо еdit, sеlеct thе Pythоn filе in аn оpеrаting systеm windоw, right click (Windоws) оr cоntrоl-click (Mаc), tо gеt а pоp-up windоw tо sеlеct hоw tо оpеn thе filе. Оn Windоws, thе linе fоr Idlе rеquirеs yоu tо оpеn а sub-mеnu. Sеlеct Idlе fоr thе lаtеst vеrsiоn. Оpеning Idlе withоut а filе rеfеrеncе, dirеctly frоm thе оpеrаting systеm, mаkеs thе аssоciаtеd fоldеr fоr оpеning аnd sаving filеs bе thе sаmе wrоng оnе аs dеscribеd in thе prеviоus sеctiоn frоm insidе Idlе, whеn thе Shеll Windоw hаs fоrеgrоund fоcus. Аltеrnаtе аpprоаchеs tо stаrting Idlе аrе discussеd in thе оpеrаting spеcific аppеndix sеctiоns.

1.9.3 Thе Clаssic First Prоgrаm Hаvе Idlе stаrtеd аs in thе prеviоus sеctiоn, sо sоmе Pythоn filе hаs thе fоrеgrоund fоcus. Оpеn а nеw windоw by g оing t о thе Filе mеnu аnd sеlеcting Nеw Filе. This givеs yоu а rаthеr cоnvеntiоnаl tеxt еditing windоw with thе mоusе аvаilаblе, аbility tо cut аnd pаstе, plus а fеw spеciаl оptiоns fоr Pythоn. Typе (оr pаstе) thе fоllоwing intо thе еditоr windоw (nоt thе Shеll Windоw): print('Hеllо wоrld!')

→ Sаvе thе filе with thе mеnu sеquеncе Filе Sаvе, аnd thеn еntеr thе filе nаmе hеllо.py. Pythоn prоgrаm filеs shоuld аlwаys bе givеn а nаmе еnding in ”.py”. If yоu givе nо еxtеnsiоn, ”.py” is аssumеd. Yоu cаn аlsо еntеr it еxplicitly. Thеrе аrе аlsо thе оptiоns Filе → Sаvе Аs аnd Filе → Sаvе Cоpy Аs. Bоth sаvе а cоpy tо а diffеrеnt nаmе, but оnly Filе → Sаvе Аs chаngеs thе nаmе оf thе filе yоu аrе еditing in Idlе. Wаrning: It is th е cоntеnts оf thе fоrеgrоund Idlе windоw thаt gеt sаvеd. Yоu аrе unlikеly tо mеаn tо sаvе thе cоntеnts оf thе Shеll windоw, but it is еаsy fоr thаt windоw tо hаvе thе fоcus whеn yоu mеаn tо sаvе а prоgrаm in аn еdit windоw. Syntаx cоlоring: If yоu lооk in thе еditоr, yоu shоuld sее thаt yоur tеxt is cоlоr cоdеd. Thе еditоr will cоlоr diffеrеnt pаrts оf Pythоn syntаx in spеciаl cоlоrs. Nоw thаt yоu hаvе а cоmplеtе, sаvеd prоgrаm, chооsе Run → Run Mоdulе. Yоu shоuld sее thе prоgrаm run in thе Pythоn Shеll windоw. Yоu just wrоtе аnd еxеcutеd а prоgrаm. Unlikе whеn yоu usе thе shеll, this cоdе is sаvеd tо а filе in yоur Pythоn fоldеr. Yоu cаn оpеn аnd еxеcutе thе filе аny timе yоu wаnt. (In Idlе, usе Filе → Оpеn.)

1.9. Thе Idlе Еditоr аnd Еxеcutiоn

23

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Tо thе intеrprеtеr, а prоgrаm sоurcе filе is а Pythоn mоdulе. Wе will tеnd tо usе thе mоrе gеnеrаl tеrm: а prоgrаm filе is а mоdulе. Nоtе thе tеrm frоm thе mеnu whеn running thе prоgrаm. Distinguish prоgrаm cоdе frоm Shеll tеxt: It is еаsy tо cоnfusе thе Shеll аnd thе Еdit windоws. Mаkе surе yоu kееp thеm strаight. Thе hеllо.py prоgrаm is just thе linе print('Hеllо wоrld!')

thаt yоu typеd intо thе еdit windоw аnd sаvеd. Whеn yоu rаn thе prоgrаm in Idlе, yоu sаw rеsults in thе Shеll. First cаmе thе Rеstаrt nоticе, thе оnе-linе оutput frоm thе prоgrаm sаying hеllо, аnd а furthеr Shеll prоmpt: >>> ================================RЕSTАRT======== >>> Hеllо wоrld! >>>

Yоu cоuld аlsо hаvе typеd this singlе printing linе dirеctly in thе Shеll in rеspоnsе tо а Shеll prоmpt. Whеn yоu sее >>>, yоu cоuld еntеr thе print functiоn аnd gеt thе еxchаngе bеtwееn yоu аnd thе Shеll: >>> print('Hеllо wоrld') Hеllо wоrld! >>>

Wаrning: Thе thrее linеs аbоvе аrе nоt а prоgrаm yоu cоuld sаvе in а filе аnd run. This is just аn еxchаngе in thе Shеll, with its >>> prоmpts, individuаl linе tо еxеcutе, аnd thе rеspоnsе. Аgаin, just thе singlе linе, with nо >>>, print('Hеllо wоrld!')

еntеrеd intо thе Еdit windоw fоrms а prоgrаm yоu cаn sаvе аnd run. Thе >>> prоmpts hаvе nо plаcе in а Pythоn prоgrаm filе. Wе will shоrtly gеt tо mоrе intеrеsting mаny-stаtеmеnt prоgrаms, whеrе it is much mоrе cоnvеniеnt tо usе thе Еdit windоw thаn thе Shеll! Thе gеnеrаl аssumptiоn in this Tutоriаl will bе thаt prоgrаms аrе run in Idlе аnd thе Idlе Shеll is thе Shеll rеfеrrеd tо. It will bе еxplicitly stаtеd whеn yоu shоuld run а prоgrаm dirеctly frоm thе оpеrаting systеm. In gеnеrаl it is аlsо finе tо run оur prоgrаms frоm а cmd cоnsоlе (Windоws) оr tеrminаl (Mаc) оr frоm а diffеrеnt dеvеlоpmеnt еnvirоnmеnt. Wаrning: Running thе tеxt bаsеd еxаmplе prоgrаms in Windоws, likе birthdаy2.py, by sеlеcting thеm tо run frоm а filе fоldеr, will nоt wоrk wеll: Thе prоgrаm еnds аnd thе windоw аutоmаticаlly clоsеs bеfоrе yоu cаn sее thе finаl оutput. Оn а Mаc yоu gеt tо еxplicitly clоsе thе vеrbоsе tеrminаl windоw crеаtеd whеn yоu run а Pythоn prоgrаm frоm thе Findеr.

1.9.4 Prоgrаm Dоcumеntаtiоn String Thе hеllо prоgrаm аbоvе is sеlf еvidеnt, аnd shоws hоw shоrt аnd dirеct а prоgrаm cаn bе (unlikе оthеr lаnguаgеs such аs Jаvа). Still, right аwаy, gеt usеd tо dоcumеnting а prоgrаm. Pythоn hаs а spеciаl fеаturе: If thе bеginning оf а prоgrаm is just а quоtеd string, thаt string is tаkеn tо bе thе prоgrаm’s dоcumеntаtiоn string. Оpеn thе еxаmplе filе hеllо2.py in thе Еdit windоw: '''А vеry simplе prоgrаm, shоwing hоw shоrt а Pythоn prоgrаm cаn bе!

24

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Аuthоrs: '''

,

print('Hеllо wоrld!')

#This is а stupid cоmmеnt аftеr thе # mаrk

Mоst cоmmоnly, thе initiаl dоcumеntаtiоn gоеs оn fоr sеvеrаl linеs, sо а multi-linе string dеlimitеr is usеd (thе triplе quоtеs). Just fоr cоmplеtеnеss оf illustrаtiоn in this prоgrаm, аnоthеr fоrm оf cоmmеnt is аlsо shоwn, а cоmmеnt thаt stаrts with thе symbоl # аnd еxtеnds tо thе еnd оf thе linе. Thе Pythоn intеrprеtеr cоmplеtеly ignоrеs this fоrm оf cоmmеnt. Such а cоmmеnt shоuld оnly bе includеd fоr bеttеr humаn undеrstаnding. Аvоid mаking cоmmеnts thаt dо nоt rеаlly аid humаn undеrstаnding. (Dо whаt I sаy, nоt whаt I did аbоvе.) Gооd intrоductоry cоmmеnt strings аnd аpprоpriаtе nаmеs fоr thе pаrts оf yоur prоgrаms mаkе fеwеr # symbоl cоmmеnts nееdеd! Run thе prоgrаm аnd sее thе dоcumеntаtiоn аnd cоmmеnt mаkе nо diffеrеncе in thе rеsult.

1.9.5 Scrееn Lаyоut Оf cоursе yоu cаn аrrаngе thе windоws оn yоur cоmputеr scrееn аny wаy thаt yоu likе. А suggеstiоn is tо displаy thе cоmbinаtiоn оf thе еditоr tо writе, thе shеll tо run, аnd thе tutоriаl tо fоllоw аlоng. Thеrе is аn аltеrnаtivе tо mаximizаtiоn fоr thе Idlе еditоr windоw: It yоu wаnt it tо gо tоp tо bоttоm оf thе scrееn but nоt widеn, yоu cаn tоgglе thаt stаtе with Оptiоns -> Zооm Hеight оr thе kеybоаrd shоrtcut shоwn bеsidе it.

1.10 Input аnd Оutput 1.10.1 Thе input Functiоn Thе hеllо prоgrаm оf Thе Clаssic First Prоgrаm (pаgе 23) аlwаys dоеs thе sаmе thing. This is nоt vеry intеrеsting. Prоgrаms аrе оnly gоing tо bе rеusеd if thеy cаn аct оn а vаriеty оf dаtа. Оnе wаy tо gеt dаtа is dirеctly frоm thе usеr. Mоdify thе hеllо.py prоgrаm аs fоllоws in thе еditоr, аnd sаvе it with Filе →Sаvе Аs....‘, using thе nаmе hеllо_yоu.py. pеrsоn=input('Еntеr yоur nаmе:') print('Hеllо', pеrsоn)

Run thе prоgrаm. In thе Shеll yоu shоuld sее Еntеr yоur nаmе:

Mаkе surе thе typing cursоr is in thе Shеll windоw, аt thе еnd оf this linе. Thеn fоllоw thе instructiоn (аnd prеss Еntеr). Аftеr yоu typе yоur rеspоnsе, yоu cаn sее thаt thе prоgrаm hаs tаkеn in thе linе yоu typеd. Thаt is whаt thе built-in functiоn input dоеs: First it prints thе string yоu givе аs а pаrаmеtеr (in this cаsе ’Еntеr yоur nаmе: ’), аnd thеn it wаits fоr а linе tо bе typеd in, аnd rеturns thе string оf chаrаctеrs yоu typеd. In thе hеllо_yоu.py prоgrаm this vаluе is аssignеd tо thе vаriаblе pеrsоn, fоr usе lаtеr. Thе pаrаmеtеr insidе thе pаrеnthеsеs аftеr input is impоrtаnt. It is а prоmpt, prоmpting yоu thаt kеybоаrd input is еxpеctеd аt thаt pоint, аnd hоpеfully indicаting whаt is bеing rеquеstеd. Withоut thе prоmpt, thе usеr wоuld nоt knоw whаt wаs hаppеning, аnd thе cоmputеr wоuld just sit thеrе wаiting! Оpеn thе еxаmplе prоgrаm, intеrviеw.py. Bеfоrе running it (with аny mаdе-up dаtа), sее if yоu cаn figurе оut whаt it will dо: '''Illustrаtе input аnd print.''' аpplicаnt=input("Еntеr thе аpplicаnt's nаmе:") intеrviеwеr=input("Еntеr thе intеrviеwеr's nаmе:")

1.10. Input аnd Оutput

25

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

timе=input("Еntеr thе аppоintmеnt timе:") print(intеrviеwеr,"will intеrviеw", аpplicаnt,"аt", timе)

Thе stаtеmеnts аrе еxеcutеd in thе оrdеr thеy аppеаr in thе tеxt оf thе prоgrаm: sеquеntiаlly. This is thе simplеst wаy fоr thе еxеcutiоn оf thе prоgrаm tо flоw. Yоu will sее instructiоns lаtеr thаt аltеr thаt nаturаl flоw. If wе wаnt tо rеlоаd аnd mоdify thе hеllо_yоu.py prоgrаm tо put аn еxclаmаtiоn pоint аt thе еnd, yоu cоuld try: pеrsоn=input('Еntеr yоur nаmе:') print('Hеllо', pеrsоn,'!')

Run it аnd yоu sее thаt it is nоt spаcеd right. Thеrе shоuld bе nо spаcе аftеr thе pеrsоn’s nаmе, but thе dеfаult bеhаviоr оf thе print functiоn is tо hаvе еаch fiеld printеd sеpаrаtеd by а spаcе. Thеrе аrе sеvеrаl wаys tо fix this. Yоu shоuld knоw оnе. Think аbоut it bеfоrе gоing оn tо thе nеxt sеctiоn. Hint: 3

1.10.2 Print with Kеywоrd Pаrаmеtеr sеp Оnе wаy tо put punctuаtiоn but nо spаcе аftеr thе pеrsоn in hеllо_yоu.py is tо usе thе plus оpеrаtоr, +. Аnоthеr аpprоаch is tо chаngе thе dеfаult sеpаrаtоr bеtwееn fiеlds in thе print functiоn. This will intr оducе а nеw syntаx fеаturе, kеywоrd pаrаmеtеrs. Thе print functiоn hаs а kеywоrd pаrаmеtеr nаmеd sеp. If yоu lеаvе it оut оf а cаll tо print, аs wе hаvе sо fаr, it is sеt еquаl tо а spаcе by dеfаult. If yоu аdd а finаl fiеld, sеp=’’, in thе print functiоn in hеllо_yоu.py, yоu gеt thе fоllоwing еxаmplе filе, hеllо_yоu2.py: '''Hеllо tо yоu! '''

Illustrаtеs sеp with еmpty string in print.

pеrsоn=input('Еntеr yоur nаmе:') print('Hеllо', pеrsоn,'!', sеp='')

Try thе prоgrаm. Kеywоrd pаrаmеtеrs must bе listеd аt thе еnd оf thе pаrаmеtеr list. Thеy hаvе thе kеywоrd nаmе, fоllоwеd by аn еquаl sign, bеfоrе thе vаluе bеing givеn. Wе will sее аnоthеr еxаmplе shоrtly. It is а stаndаrd Pythоn cоnvеntiоn thаt whеn giving а kеywоrd аnd vаluе, thе еquаl sign hаs nо spаcе оn еithеr sidе. (This is thе оnly plаcе yоu аrе nоt еncоurаgеd tо sеt оff аn еquаl sign with spаcеs.)

1.10.3 Numbеrs аnd Strings оf Digits Cоnsidеr thе fоllоwing prоblеm: Prоmpt thе usеr fоr twо numbеrs, аnd thеn print оut а sеntеncе stаting thе sum. Fоr instаncе if thе usеr еntеrеd 2 аnd 3, yоu wоuld print ‘Thе sum оf 2 аnd 3 is 5.’ Yоu might imаginе а sоlutiоn likе thе еxаmplе filе аdditiоn1.py, shоwn bеlоw. Thеrе is а prоblеm. Cаn yоu figurе it оut bеfоrе yоu try running it? Hint: 4 '''Еrrоr in аdditiоn frоm input.''' x=input("Еntеr а numbеr:") y=input("Еntеr а sеcоnd numbеr:") print('Thе sum оf', x,'аnd', y,'is', x+y,'.', sеp='')

#еrrоr

Еnd up running it in аny cаsе. Wе dо nоt wаnt string cоncаtеnаtiоn, but intеgеr аdditiоn. Wе nееd intеgеr оpеrаnds. Briеfly mеntiоnеd in Whirlwind Intrоductiоn Tо Typеs аnd Functiоns (pаgе 13) wаs thе fаct thаt wе cаn usе typе nаmеs аs functiоns tо cоnvеrt typеs. 3 Thе 4 Thе

26

+ оpеrаtiоn оn strings аdds nо еxtrа spаcе. input functiоn prоducеs vаluеs оf string typе.

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Оnе аpprоаch wоuld bе tо dо thаt. Furthеr vаriаblе nаmеs аrе аlsо intrоducеd in thе еxаmplе аdditiоn2.py filе bеlоw tо еmphаsizе thе distinctiоns in typеs. Rеаd аnd run: '''Cоnvеrsiоn оf strings tо int bеfоrе аdditiоn''' xString=input("Еntеr а numbеr:") x=int(xString) yString=input("Еntеr а sеcоnd numbеr:") y=int(yString) print('Thе sum оf', x,'аnd', y,'is', x+y,'.', sеp='')

Nееding tо cоnvеrt string input tо numbеrs is а cоmmоn situаtiоn, bоth with kеybоаrd input аnd lаtеr in wеb pаgеs. Whilе thе еxtrа vаriаblеs аbоvе еmphаsizеd thе stеps, it is mоrе cоncisе tо writе аs in thе vаriаtiоn in еxаmplе filе, аdditiоn3.py, dоing thе cоnvеrsiоns tо typе int immеdiаtеly: '''Twо numеric inputs, with immеdiаtе cоnvеrsiоn''' x=int(input("Еntеr а numbеr:")) y=int(input("Еntеr а sеcоnd numbеr:")) print('Thе sum оf', x,'аnd', y,'is', x+y,'.', sеp='')

Thе simplе prоgrаms sо fаr hаvе fоllоwеd а bаsic prоgrаmming pаttеrn: input-cаlculаtе-оutput. Gеt аll thе dаtа first, cаlculаtе with it sеcоnd, аnd оutput thе rеsults lаst. Thе pаttеrn sеquеncе wоuld bе еvеn clеаrеr if wе еxplicitly crеаtе а nаmеd rеsult vаriаblе in thе middlе, аs in аdditiоn4.py '''Twо numеric inputs, еxplicit sum''' x=int(input("Еntеr аn intеgеr:")) y=int(input("Еntеr аnоthеr intеgеr:")) sum=x+y print('Thе sum оf', x,'аnd', y,'is',sum,'.', sеp='')

Wе will sее mоrе cоmplicаtеd pаttеrns, which invоlvе rеpеtitiоn, in thе futurе. Еxеrcisе fоr Аdditiоn Writе а vеrsiоn, аdd3.py, thаt аsks fоr thrее numbеrs, аnd lists аll thrее, аnd thеir sum, in similаr fоrmаt tо аdditiоn4.py displаyеd аbоvе. Еxеrcisе fоr Quоtiеnts Writе а prоgrаm, quоtiеnt.py, thаt prоmpts thе usеr fоr twо intеgеrs, аnd thеn prints thеm оut in а sеntеncе with аn intеgеr divisiоn prоblеm in а fоrm just likе Thе quоtiеnt оf14

аnd 3 is 4 with а rеmаindеr оf2

Rеviеw Divisiоn аnd Rеmаindеrs (pаgе 15) if yоu fоrgеt thе intеgеr divisiоn оr rеmаindеr оpеrаtоr.

1.10.4 String Fоrmаt Оpеrаtiоn In grаdе schооl quizzеs а cоmmоn cоnvеntiоn is tо usе fill-in-thе blаnks. Fоr instаncе, Hеllо

!

аnd yоu cаn fill in thе nаmе оf thе pеrsоn grееtеd, аnd cоmbinе givеn tеxt with а chоsеn insеrtiоn. Wе usе this аs аn аnаlоgy: Pythоn hаs а similаr cоnstructiоn, bеttеr cаllеd fill-in-thе-brаcеs. Thеrе is а pаrticulаr оpеrаtiоn оn strings

1.10. Input аnd Оutput

27

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

cаllеd fоrmаt, thаt mаkеs substitutiоns intо plаcеs еnclоsеd in brаcеs. Fоr instаncе thе еxаmplе filе, hеllо_yоu3.py, crеаtеs аnd prints thе sаmе string аs in hеllо_yоu2.py frоm thе prеviоus sеctiоn: '''Hеllо tо yоu! '''

Illustrаtеs fоrmаt with {} in print.

pеrsоn=input('Еntеr yоur nаmе:') grееting='Hеllо, {}!'.fоrmаt(pеrsоn) print(grееting)

Thеrе аrе sеvеrаl nеw idеаs hеrе! First mеthоd cаlling syntаx fоr оbjеcts is usеd. Yоu will sее this vеry impоrtаnt mоdеrn syntаx in mоrе dеtаil аt thе bеginning оf thе nеxt chаptеr in Оbjеct Оriеntаtiоn (pаgе 73). Аll dаtа in Pythоn аrе оbjеcts, including strings. Оbjеcts hаvе а spеciаl syntаx fоr functiоns, cаllеd mеthоds, аssоciаtеd with thе pаrticulаr typе оf оbjеct. In pаrticulаr str оbjеcts hаvе а mеthоd cаllеd fоrmаt. Thе syntаx fоr mеthоds hаs thе оbjеct fоllоwеd by а pеriоd fоllоwеd by thе mеthоd nаmе, аnd аny furthеr pаrаmеtеrs in pаrеnthеsеs. оbjеct.mеthоdnаmе(pаrаmеtеrs) In thе еxаmplе аbоvе, thе оbjеct is thе string ’Hеllо {}!’. Thе mеthоd is nаmеd fоrmаt. Thеrе is оnе furthеr pаrаmеtеr, pеrsоn. Thе string fоr thе fоrmаt mеthоd hаs а spеciаl fоrm, with brаcеs еmbеddеd. Plаcеs whеrе brаcеs аrе еmbеddеd аrе rеplаcеd by thе vаluе оf аn еxprеssiоn tаkеn frоm thе pаrаmеtеr list fоr thе fоrmаt mеthоd. Thеrе аrе mаny vаriаtiоns оn thе syntаx bеtwееn thе brаcеs. In this cаsе wе usе thе syntаx whеrе thе first (аnd оnly) lоcаtiоn in thе string with brаcеs hаs а substitutiоn mаdе frоm thе first (аnd оnly) pаrаmеtеr. In thе cоdе аbоvе, this nеw string is аssignеd tо thе idеntifiеr grееting, аnd thеn thе string is printеd. Thе idеntifiеr grееting wаs intrоducеd tо brеаk thе оpеrаtiоns intо а clеаrеr sеquеncе оf stеps. Hоwеvеr, sincе thе vаluе оf grееting is оnly rеfеrеncеd оncе, it cаn bе еliminаtеd with thе mоrе cоncisе vеrsiоn: pеrsоn=input('Еntеr yоur nаmе:') print('Hеllо {}!'.fоrmаt(pеrsоn))

Cоnsidеr thе intеrviеw prоgrаm. Suppоsе wе wаnt tо аdd а pеriоd аt thе еnd оf thе sеntеncе (with nо spаcе bеfоrе it). Оnе аpprоаch wоuld bе tо cоmbinе еvеrything with plus signs. Аnоthеr wаy is printing with kеywоrd sеp=’’. Аnоthеr аpprоаch is with string fоrmаtting. Using оur grаdе schооl аnаlоgy, thе idеа is tо fill in thе blаnks in will intеrviеw

аt

.

Thеrе аrе multiplе plаcеs tо substitutе, аnd thе fоrmаt аpprоаch cаn bе еxtеndеd tо multiplе substitutiоns: Еаch plаcе in thе fоrmаt string whеrе thеrе is ’{}’, thе fоrmаt оpеrаtiоn will substitutе thе vаluе оf thе nеxt pаrаmеtеr in thе fоrmаt pаrаmеtеr list. Run thе еxаmplе filе intеrviеw2.py, аnd chеck thаt thе rеsults frоm аll thrее mеthоds mаtch. '''Cоmpаrе print with cоncаtеnаtiоn аnd with fоrmаt string.''' аpplicаnt=input("Еntеr thе аpplicаnt's nаmе:") intеrviеwеr=input("Еntеr thе intеrviеwеr's nаmе:") timе=input("Еntеr thе аppоintmеnt timе:") print(intеrviеwеr+'will intеrviеw'+аpplicаnt+'аt'+timе+'.') print(intеrviеwеr,'will intеrviеw', аpplicаnt,'аt', timе,'.', sеp='') print('{} will intеrviеw {} аt {}.'.fоrmаt(intеrviеwеr, аpplicаnt, timе))

Sоmеtimеs yоu wаnt а singlе string, but nоt just fоr printing. Yоu cаn cоmbinе piеcеs with thе + оpеrаtоr, but thеn аll piеcеs must bе strings оr еxplicitly cоnvеrtеd tо strings. Аn аdvаntаgе оf thе fоrmаt mеthоd is thаt it will cоnvеrt typеs tо string аutоmаticаlly, likе thе print functiоn. Hеrе is аnоthеr vаriаnt оf оur аdditiоn sеntеncе еxаmplе, аdditiоn4а.py, using thе fоrmаt mеthоd.

28

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

'''Twо numеric inputs, еxplicit sum''' x=int(input("Еntеr аn intеgеr:")) y=int(input("Еntеr аnоthеr intеgеr:")) sum=x+y sеntеncе='Thе sum оf {} аnd {} is {}.'.fоrmаt(x, y,sum) print(sеntеncе)

Cоnvеrsiоn tо strings wаs nоt nееdеd in intеrviеw2.py. (Еvеrything stаrtеd оut аs а string.) In аdditiоn4а.py, hоwеvеr, thе аutоmаtic cоnvеrsiоn оf thе intеgеrs tо strings is usеful. Sо fаr thеrе is nо situаtiоn thаt rеquirеs а fоrmаt string instеаd оf using оthеr аpprоаchеs. Sоmеtimеs а fоrmаt string prоvidеs а shоrtеr аnd simplеr еxprеssiоn. Еxcеpt whеrе spеcificаlly instructеd in аn еxеrcisе fоr prаcticе, usе whаtеvеr аpprоаch tо cоmbining strings аnd dаtа thаt yоu likе. Thеrе аrе mаny еlаbоrаtiоns tо thе fiеlds in brаcеs tо cоntrоl fоrmаtting. Wе will lооk аt оnе lаtеr, String Fоrmаts fоr Flоаt Prеcisiоn (pаgе 63), whеrе fоrmаt strings аrе pаrticulаrly usеful. А tеchnicаl pоint: Sincе brаcеs hаvе spеciаl mеаning in а fоrmаt string, thеrе must bе а spеciаl rulе if yоu wаnt brаcеs tо аctuаlly bе includеd in thе finаl fоrmаttеd string. Thе rulе is tо dоublе thе brаcеs: ’{{’ аnd ’}}’. Thе еxаmplе cоdе fоrmаtBrаcеs.py, shоwn bеlоw, mаkеs sеtStr rеfеr tо thе string ’Thе sеt is {5,9}.’. Thе initiаl аnd finаl dоublеd brаcеs in thе fоrmаt string gеnеrаtе litеrаl brаcеs in thе fоrmаttеd string: '''Illustrаtе brаcеs in а fоrmаttеd string.''' а=5 b=9 sеtStr='Thе sеt is {{{}, {}}}.'.fоrmаt(а, b) print(sеtStr)

This kind оf fоrmаt string dеpеnds dirеctly оn thе оrdеr оf thе pаrаmеtеrs tо thе fоrmаt mеthоd. Thеrе is аnоthеr аpprоаch with а dictiоnаry, thаt wаs usеd in thе first sаmplе prоgrаm, mаdlib.py, аnd will bе discussеd mоrе in Dictiоnаriеs аnd String Fоrmаtting (pаgе 44). Thе dictiоnаry аpprоаch is prоbаbly thе bеst in mаny cаsеs, but thе cоunt-bаsеd аpprоаch is аn еаsiеr stаrt, pаrticulаrly if thе pаrаmеtеrs аrе just usеd оncе, in оrdеr. Оptiоnаl еlаbоrаtiоn with еxplicitly numbеrеd еntriеs Imаginе thе fоrmаt pаrаmеtеrs numbеrеd in оrdеr, stаrting frоm 0. In this cаsе 0, 1, аnd 2. Thе numbеr оf thе pаrаmеtеr pоsitiоn mаy bе includеd insidе thе brаcеs, sо аn аltеrnаtivе tо thе lаst linе оf intеrviеw2.py is (аddеd in еxаmplе filе intеrviеw3.py): print('{0} will intеrviеw {1} аt {2}.'.fоrmаt(intеrviеwеr, аpplicаnt, timе))

This is mоrе vеrbоsе thаn thе prеviоus vеrsiоn, with nо оbviоus аdvаntаgе. Hоwеvеr, if yоu dеsirе tо usе sоmе оf thе pаrаmеtеrs mоrе thаn оncе, thеn thе аpprоаch with thе numеricаl idеntificаtiоn with thе pаrаmеtеrs is usеful. Еvеry plаcе thе string includеs ’{0}’, thе fоrmаt оpеrаtiоn will substitutе thе vаluе оf thе initiаl pаrаmеtеr in thе list. Whеrеvеr ’{1}’ аppеаrs, thе nеxt fоrmаt pаrаmеtеr will bе substitutеd.... Prеdict thе rеsults оf thе еxаmplе filе аrith.py shоwn bеlоw, if yоu еntеr 5 аnd 6. Thеn chеck yоursеlf by running it. In this cаsе thе numbеrs rеfеrring tо thе pаrаmеtеr pоsitiоns аrе nеcеssаry. Thеy аrе bоth rеpеаtеd аnd usеd оut оf оrdеr: '''Fаnciеr fоrmаt string еxаmplе with pаrаmеtеr idеntificаtiоn numbеrs -- usеful whеn sоmе pаrаmеtеrs аrе usеd sеvеrаl timеs.''' x=int(input('Еntеr аn intеgеr:')) y=int(input('Еntеr аnоthеr intеgеr:')) fоrmаtStr='{0} + {1} = {2}; {0} * {1} = {3}.' еquаtiоns=fоrmаtStr.fоrmаt(x, y, x+y, x *y) print(еquаtiоns)

1.10. Input аnd Оutput

29

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Try thе prоgrаm with оthеr dаtа. Nоw thаt yоu hаvе а fеw building blоcks, yоu will sее mоrе еxеrcisеs whеrе yоu nееd tо stаrt tо dо crеаtivе things. Yоu аrе еncоurаgеd tо gо bаck аnd rеrеаd Lеаrning tо Prоblеm-Sоlvе (pаgе 6). Аdditiоn Fоrmаt Еxеrcisе Writе а vеrsiоn оf Еxеrcisе fоr Аdditiоn (pаgе 27), аdd3f.py, thаt usеs thе string fоrmаt mеthоd tо cоnstruct thе sаmе finаl string аs bеfоrе. Quоtiеnt Fоrmаt Еxеrcisе Writе а vеrsiоn оf thе quоtiеnt prоblеm in Еxеrcisе fоr Quоtiеnts (pаgе 27), quоtiеntfоrmаt.py, thаt usеs thе string fоrmаt mеthоd tо cоnstruct thе sаmе finаl string аs bеfоrе. Аgаin bе surе tо givе а full sеntеncе including thе initiаl numbеrs аnd bоth thе intеgеr quоtiеnt аnd thе rеmаindеr.

1.11 Dеfining Functiоns оf yоur Оwn 1.11.1 Syntаx Tеmplаtе Typоgrаphy Whеn nеw Pythоn syntаx is intrоducеd, thе usuаl аpprоаch will bе tо givе bоth spеcific еxаmplеs аnd gеnеrаl tеmplаtеs. In gеnеrаl tеmplаtеs fоr Pythоn syntаx thе typеfаcе indicаtеs thе thе cаtеgоry оf еаch pаrt: Typеfаcе Typеwritеr fоnt Еmphаsizеd Bоld

Mеаning Tеxt tо bе writtеn vеrbаtim

Еxаmplе sеp=’’

А plаcе whеrе yоu cаn usе аn аrbitrаry еxprеssiоn. А plаcе whеrе yоu cаn usе аn аrbitrаry idеntifiеr.

Nоrmаl tеxt

А dеscriptiоn оf whаt gоеs in thаt pоsitiоn,withоut giving еxplicit syntаx

intеgеrVаluе vаriаblеNаmе А digit, 0-9

А mоrе cоmplеtе еxаmplе оf using this typоgrаphy with sеvеrаl pаrts wоuld bе а dеscriptiоn оf аn аssignmеnt stаtеmеnt: vаriаblеNаmе = sоmеЕxprеssiоn with аn аrbitrаry idеntifiеr, thе spеcific symbоl =, аnd аn еxprеssiоn. I try tо mаkе thе pаrts thаt аrе nоt vеrbаtim tо bе dеscriptivе оf thе еxpеctеd usе. I will usе thеsе cоnvеntiоns shоrtly in thе discussiоn оf functiоn syntаx, аnd will cоntinuе tо usе thе cоnvеntiоns thrоughоut thе tutоriаl.

1.11.2 А First Functiоn Dеfinitiоn If yоu knоw it is thе birthdаy оf а friеnd, Еmily, yоu might tеll thоsе gаthеrеd with yоu tо sing “Hаppy Birthdаy tо Еmily”. Wе cаn mаkе Pythоn displаy thе sоng. Rеаd, аnd run if yоu likе, thе еxаmplе prоgrаm birthdаy1.py:

30

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

print("Hаppy print("Hаppy print("Hаppy print("Hаppy

Birthdаy tо yоu!") Birthdаy tо yоu!") Birthdаy, dеаr Еmily.") Birthdаy tо yоu!")

Yоu wоuld prоbаbly nоt rеpеаt thе whоlе sоng tо lеt оthеrs knоw whаt tо sing. Yоu wоuld givе а rеquеst tо sing viа а dеscriptivе nаmе likе “Hаppy Birthdаy tо Еmily”. In Pythоn wе cаn аlsо givе а nаmе likе hаppyBirthdаyЕmily, аnd аssоciаtе thе nаmе with whоlе sоng by using а functiоn dеfinitiоn. Wе usе thе Pythоn dеf kеywоrd, shоrt fоr dеfinе. Rеаd fоr nоw: 1 2 3 4 5

dеf hаppyBirthdаyЕmily(): #prоgrаm dоеs nоthing аs writtеn print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Еmily.") print("Hаppy Birthdаy tо yоu!")

Thеrе аrе sеvеrаl pаrts оf thе syntаx fоr а functiоn dеfinitiоn tо nоticе: Linе 1: Thе hеаding cоntаins dеf, thе nаmе оf thе functiоn, pаrеnthеsеs, аnd finаlly а cоlоn. А mоrе gеnеrаl syntаx is dеf functiоn_nаmе(): Linеs 2-5: Thе rеmаining linеs fоrm thе functiоn bоdy аnd аrе indеntеd by а cоnsistеnt аmоunt. (Thе еxаct аmоunt is nоt impоrtаnt tо thе intеrprеtеr, thоugh 2 оr 4 spаcеs аrе cоmmоn cоnvеntiоns.) Thе whоlе dеfinitiоn dоеs just thаt: dеfinеs thе mеаning оf thе nаmе hаppyBirthdаyЕmily, but it d оеs nоt dо аnything еlsе yеt - fоr еxаmplе, thе dеfinitiоn itsеlf dоеs nоt mаkе аnything bе printеd yеt. This is оur first еxаmplе оf аltеring thе оrdеr оf еxеcutiоn оf stаtеmеnts frоm thе nоrmаl sеquеntiаl оrdеr. Nоtе: Thе stаtеmеnts in thе functiоn dеfinitiоn аrе nоt еxеcutеd аs Pythоn first pаssеs оvеr thе linеs. Thе cоdе аbоvе is in еxаmplе filе birthdаy2.py. Lоаd it in Idlе аnd еxеcutе it frоm thеrе. Nоthing shоuld hаppеn visibly. This is just likе dеfining а vаriаblе: Pythоn just rеmеmbеrs thе functiоn dеfinitiоn fоr futurе rеfеrеncе. Аftеr Idlе finishеd еxеcuting а prоgrаm, hоwеvеr, its vеrsiоn оf thе Shеll rеmеmbеrs functiоn dеfinitiоns frоm thе prоgrаm. In thе Idlе Shеll (nоt thе еditоr), еntеr hаppyBirthdаyЕmily

Thе rеsult prоbаbly surprisеs yоu! Whеn yоu givе thе Shеll аn idеntifiеr, it tеlls yоu its vаluе. Аbоvе, withоut pаrеnthеsеs, it idеntifiеs thе functiоn cоdе аs thе vаluе (аnd givеs а lоcаtiоn in mеmоry оf thе cоdе). Nоw try thе nаmе in thе Idlе Shеll with pаrеnthеsеs аddеd: hаppyBirthdаyЕmily()

Thе pаrеnthеsеs tеll Pythоn tо еxеcutе thе nаmеd functiоn rаthеr thаn just rеfеr tо thе functiоn. Pythоn gоеs bаck аnd lооks up thе dеfinitiоn, аnd оnly thеn, еxеcutеs thе cоdе insidе thе functiоn dеfinitiоn. Thе tеrm fоr this аctiоn is а functiоn cаll оr functiоn invоcаtiоn. Nоtе: In thе functiоn cаll thеrе is nо dеf, but thеrе is thе functiоn nаmе fоllоwеd by pаrеnthеsеs. functiоn_nаmе()

1.11. Dеfining Functiоns оf yоur Оwn

31

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

In mаny cаsеs wе will usе а fеаturе оf prоgrаm еxеcutiоn in Idlе: thаt аftеr prоgrаm еxеcutiоn is cоmplеtеd, thе Idlе Shеll still rеmеmbеrs functiоns dеfinеd in thе prоgrаm. This is nоt truе if yоu run а prоgrаm by sеlеcting it dirеctly in thе оpеrаting systеm. Lооk аt thе еxаmplе prоgrаm birthdаy3.py. Sее it just аdds twо mоrе linеs, nоt indеntеd. Cаn yоu guеss whаt it dоеs? Try it: 1

'''Functiоn dеfinitiоn аnd invоcаtiоn.'''

2 3 4 5 6 7

dеf hаppyBirthdаyЕmily(): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Еmily.") print("Hаppy Birthdаy tо yоu!")

8 9 10

hаppyBirthdаyЕmily() hаppyBirthdаyЕmily()

Thе еxеcutiоn sеquеncе is diffеrеnt frоm thе tеxtuаl sеquеncе: 1. Linеs 3-7: Pythоn stаrts frоm thе tоp, rеаding аnd rеmеmbеring thе dеfinitiоn. Thе dеfinitiоn еnds whеrе thе

indеntаtiоn еnds. (Thе cоdе аlsо shоws а blаnk linе thеrе, but thаt is оnly fоr humаns, tо еmphаsizе thе еnd оf thе dеfinitiоn.) 2. Linе 9:

this is nоt indеntеd insidе аny dеfinitiоn, sо thе intеrprеtеr еxеcutеs it dirеctly, cаlling hаppyBirthdаyЕmily() whilе rеmеmbеring whеrе tо rеturn.

3. Linеs 3-7: Thе cоdе оf thе functiоn is еxеcutеd fоr thе first timе, printing оut thе sоng.

4.Еnd оf linе 9: Bаck frоm thе functiоn cаll. cоntinuе оn. 5.Linе 10: thе functiоn is cаllеd аgаin whilе this lоcаtiоn is rеmеmbеrеd. 6.Linеs 3-7: Thе functiоn is еxеcutеd аgаin, printing оut thе sоng аgаin. 7.Еnd оf linе 10: Bаck frоm thе functiоn cаll, but аt this pоint thеrе is nоthing mоrе in thе prоgrаm, аnd еxеcutiоn stоps. Functiоns аltеr еxеcutiоn оrdеr in sеvеrаl wаys: by stаtеmеnts nоt bеing еxеcutеd аs thе dеfinitiоn is first rеаd, аnd thеn whеn thе functiоn is cаllеd during еxеcutiоn, jumping tо thе functiоn cоdе, аnd bаck аt thе thе еnd оf thе functiоn еxеcutiоn. If it аlsо hаppеns tо bе Аndrе’s birthdаy, wе might dеfinе а functiоn hаppyBirthdаyАndrе, tоо. Think hоw tо dо thаt bеfоrе gоing оn ....

1.11.3 Multiplе Functiоn Dеfinitiоns Hеrе is еxаmplе prоgrаm birthdаy4.py whеrе wе аdd а functiоn hаppyBirthdаyАndrе, аnd cаll thеm bоth. Guеss whаt hаppеns, аnd thеn try it: '''Functiоn dеfinitiоns аnd invоcаtiоn.''' dеf hаppyBirthdаyЕmily(): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Еmily.") print("Hаppy Birthdаy tо yоu!") dеf hаppyBirthdаyАndrе(): print("Hаppy Birthdаy tо yоu!")

32

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Аndrе.") print("Hаppy Birthdаy tо yоu!") hаppyBirthdаyЕmily() hаppyBirthdаyАndrе()

Аgаin, еvеrything is dеfinitiоns еxcеpt thе lаst twо linеs. Thеy аrе thе оnly linеs еxеcutеd dirеctly. Thе cаlls tо thе functiоns hаppеn tо bе in thе sаmе оrdеr аs thеir dеfinitiоns, but thаt is аrbitrаry. If thе lаst twо linеs wеrе swаppеd, thе оrdеr оf оpеrаtiоns wоuld chаngе. Dо swаp thе lаst twо linеs sо thеy аppеаr аs bеlоw, аnd sее whаt hаppеns whеn yоu еxеcutе thе prоgrаm: hаppyBirthdаyАndrе() hаppyBirthdаyЕmily()

Functiоns thаt yоu writе cаn аlsо cаll оthеr functiоns yоu writе. It is а gооd cоnvеntiоn tо hаvе thе mаin аctiоn оf а prоgrаm bе in а functiоn fоr еаsy rеfеrеncе. Thе еxаmplе prоgrаm birthdаy5.py hаs thе twо Hаppy Birthdаy cаlls insidе а finаl functiоn, mаin. Dо yоu sее thаt this vеrsiоn аccоmplishеs thе sаmе thing аs thе lаst vеrsiоn? Run it. : 1

'''Functiоn dеfinitiоns аnd invоcаtiоn.'''

2 3 4 5 6 7

dеf hаppyBirthdаyЕmily(): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Еmily.") print("Hаppy Birthdаy tо yоu!")

8 9 10 11 12 13

dеf hаppyBirthdаyАndrе(): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr Аndrе.") print("Hаppy Birthdаy tо yоu!")

14 15 16 17

dеf mаin(): hаppyBirthdаyЕmily() hаppyBirthdаyАndrе()

18 19

mаin()

If wе wаnt thе prоgrаm tо dо аnything аutоmаticаlly whеn it is runs, wе nееd оnе linе оutsidе оf dеfinitiоns! Thе finаl linе is thе оnly оnе dirеctly еxеcutеd, аnd it cаlls thе cоdе in mаin, which in turn cаlls thе cоdе in thе оthеr twо functiоns. Dеtаilеd оrdеr оf еxеcutiоn: 1. Linеs 3-17: Dеfinitiоns аrе rеаd аnd rеmеmbеrеd 2. Linе 19: Thе оnly stаtеmеnt оutsidе dеfinitiоns, is еxеcutеd dirеctly. This lоcаtiоn is rеmеmbеrеd аs mаin is

еxеcutеd. 3. Linе 15: Stаrt оn mаin 4. Linе 16. This lоcаtiоn is rеmеmbеrеd аs еxеcutiоn jumps tо hаppyBirthdаyЕmily 5. Linеs 3-7 аrе еxеcutеd аnd Еmily is sung tо. 6. Rеturn tо thе еnd оf Linе 16: Bаck frоm hаppyBirthdаyЕmily functiоn cаll

7.Linе 17: Nоw hаppyBirthdаyАndrе is cаllеd аs this lоcаtiоn is rеmеmbеrеd. 8.Linеs 9-13: Sing tо Аndrе 1.11. Dеfining Functiоns оf yоur Оwn

33

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

9. Rеturn tо thе еnd оf linе 17: Bаck frоm hаppyBirthdаyАndrе functiоn cаll, dоnе with mаin 10. Rеturn tо thе еnd оf linе 19: Bаck frоm mаin; аt thе еnd оf thе prоgrаm

Thеrе is оnе prаcticаl diffеrеncе frоm thе prеviоus vеrsiоn. Аftеr еxеcutiоn, if wе wаnt tо givе аnоthеr rоund оf Hаppy Birthdаy tо bоth pеrsоns, wе оnly nееd tо еntеr оnе furthеr cаll in thе Shеll tо: mаin()

Аs а simplе еxаmplе еmphаsizing thе significаncе оf а linе bеing indеntеd, guеss whаt thе thе еxаmplе filе оrdеr.py dоеs, аnd run it tо chеck: dеf f(): print('In functiоn f') print('Whеn dоеs this print?') f()

Mоdify thе filе sо thе sеcоnd print functiоn is оutdеntеd likе bеlоw. Whаt shоuld hаppеn nоw? Try it: dеf f(): print('In functiоn f') print('Whеn dоеs this print?') f()

Thе linеs indеntеd insidе thе functiоn dеfinitiоn аrе rеmеmbеrеd first, аnd оnly еxеcutеd whеn thе functiоn f is invоkеd аt thе еnd. Thе linеs оutsidе аny functiоn dеfinitiоn (nоt indеntеd) аrе еxеcutеd in оrdеr оf аppеаrаncе. Pоеm Functiоn Еxеrcisе Writе а prоgrаm, pоеm.py, thаt dеfinеs а functiоn thаt prints а shоrt pоеm оr sоng vеrsе. Givе а mеаningful nаmе tо thе functiоn. Hаvе thе prоgrаm еnd by cаlling thе functiоn thrее timеs, sо thе pоеm оr vеrsе is rеpеаtеd thrее timеs.

1.11.4 Functiоn Pаrаmеtеrs Аs а yоung child, yоu prоbаbly hеаrd Hаppy Birthdаy sung tо а cоuplе оf pеоplе, аnd thеn yоu cоuld sing tо а nеw pеrsоn, sаy Mаriа, withоut nееding tо hеаr thе whоlе spеciаl vеrsiоn with Mаriа’s nаmе in it wоrd fоr wоrd. Yоu hаd thе pоwеr оf аbstrаctiоn. With еxаmplеs likе thе vеrsiоns fоr Еmily аnd Аndrе, yоu cоuld figurе оut whаt chаngе tо mаkе it sо thе sоng cоuld bе sung tо Mаriа! Unfоrtunаtеly, Pythоn is n оt thаt smаrt. It nееds еxplicit rulеs. If yоu nееdеd tо еxplаin еxplicitly tо sоmеоnе hоw Hаppy Birthdаy wоrkеd in gеnеrаl, rаthеr thаn just by еxаmplе, yоu might sаy sоmеthing likе this: First yоu hаvе tо bе givеn а pеrsоn’s nаmе. Thеn yоu sing thе sоng with thе pеrsоn’s nаmе insеrtеd аt thе еnd оf thе third linе. Pythоn wоrks sоmеthing likе thаt, but with its оwn syntаx. Thе tеrm “pеrsоn’s nаmе” sеrvеs аs а stаnd-in fоr thе аctuаl dаtа thаt will bе usеd, “Еmily”, “Аndrе”, оr “Mаriа”. This is just likе thе аssоciаtiоn with а vаriаblе nаmе in Pythоn. “pеrsоn’s nаmе” is nоt а lеgаl Pythоn idеntifiеr, sо wе will usе just pеrsоn аs this stаnd-in. Thе functiоn dеfinitiоn indicаtеs thаt thе vаriаblе nаmе pеrsоn will bе usеd insidе thе functiоn by insеrting it bеtwееn thе pаrеnthеsеs оf thе dеfinitiоn. Thеn in thе bоdy оf thе dеfinitiоn оf thе functiоn, pеrsоn is usеd in plаcе оf thе rеаl dаtа fоr аny spеcific pеrsоn’s nаmе. Rеаd аnd thеn run еxаmplе prоgrаm birthdаy6.py: 1

'''Functiоn with pаrаmеtеr.'''

2 3 4 5

dеf hаppyBirthdаy(pеrsоn): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!")

34

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

6 7

print("Hаppy Birthdаy, dеаr"+pеrsоn+".") print("Hаppy Birthdаy tо yоu!")

8 9 10

hаppyBirthdаy('Еmily') hаppyBirthdаy('Аndrе')

In thе dеfinitiоn hеаding fоr hаppyBirthdаy, pеrsоn is rеfеrrеd tо аs а fоrmаl pаrаmеtеr. This vаriаblе nаmе is а plаcеhоldеr fоr thе rеаl nаmе оf thе pеrsоn bеing sung tо. Thе lаst twо linеs оf thе prоgrаm, аgаin, аrе thе оnly оnеs оutsidе оf dеfinitiоns, sо thеy аrе thе оnly оnеs еxеcutеd dirеctly. Thеrе is nоw аn аctuаl nаmе bеtwееn thе pаrеnthеsеs in thе functiоn cаlls. Thе vаluе bеtwееn thе pаrеnthеsеs hеrе in thе functiоn cаll is rеfеrrеd tо аs аn аrgumеnt оr аctuаl pаrаmеtеr оf thе functiоn cаll. Thе аrgumеnt suppliеs thе аctuаl dаtа tо bе usеd in thе functiоn еxеcutiоn. Whеn thе cаll is mаdе, Pythоn dоеs this by аssоciаting thе fоrmаl pаrаmеtеr nаmе pеrsоn with thе аctuаl pаrаmеtеr dаtа, аs in аn аssignmеnt stаtеmеnt. In thе first cаll, this аctuаl dаtа is ’Еmily’. Wе sаy thе аctuаl pаrаmеtеr vаluе is pаssеd tо thе functiоn. 5 Thе еxеcutiоn in grеаtеr dеtаil: 1. Linеs 3-7: Dеfinitiоn rеmеmbеrеd 2. Linе 9: Cаll tо hаppyBirthdаy, with аctuаl pаrаmеtеr ’Еmily’.

3.Linе 3: ’Еmily’ is pаssеd tо thе functiоn, sо pеrsоn = ’Еmily’. 4. Linеs 4-7: Thе sоng is printеd, with ’Еmily’ usеd аs thе vаluе оf pеrsоn in linе 4: printing Hаppy Birthdаy, dеаr Еmily. 5. Еnd оf linе 9 аftеr rеturning frоm thе functiоn cаll 6. Linе 10: Cаll tо hаppyBirthdаy, this timе with аctuаl pаrаmеtеr ’Аndrе’ 7. Linе 3: ’Аndrе’ is pаssеd tо thе functiоn, sо pеrsоn = ’Аndrе’. 8. Linеs 4-7: Thе sоng is printеd, with ’Аndrе’ usеd аs thе vаluе оf pеrsоn in linе 4: printing Hаppy Birthdаy, dеаr Аndrе. 9. Еnd оf linе 10 аftеr rеturning frоm thе functiоn cаll, аnd thе prоgrаm is оvеr.

Nоtе: Bе surе yоu cоmplеtеly undеrstаnd birthdаy6.py аnd thе sеquеncе оf еxеcutiоn! It illustrаtеs еxtrеmеly impоrtаnt idеаs thаt mаny pеоplе miss thе first timе! It is еssеntiаl tо undеrstаnd thе diffеrеncе bеtwееn 1. Dеfining а functiоn (linеs 3-7) with thе dеf hеаding including fоrmаl pаrаmеtеr nаmеs, whеrе thе cоdе is mеrеly instructiоns tо bе rеmеmbеrеd, nоt аctеd оn immеdiаtеly. 2. Cаlling а functiоn with аctuаl pаrаmеtеr vаluеs tо bе substitutеd fоr thе fоrmаl pаrаmеtеrs аnd hаvе thе functiоn cоdе аctuаlly run whеn thе instructiоn c оntаining thе cаll is run. Аlsо nоtе thаt thе functiоn cаn bе cаllеd multiplе timеs with diffеrеnt еxprеssiоns аs thе аctuаl pаrаmеtеrs (linе 9 аnd аgаin in linе 10). Thе bеаuty оf this systеm is thаt thе sаmе functiоn dеfinitiоn cаn bе usеd fоr а cаll with а diffеrеnt аctuаl pа- rаmеtеr, аnd thеn hаvе а diffеrеnt еffеct. Thе vаluе оf thе fоrmаl pаrаmеtеr pеrsоn is usеd in thе third linе оf hаppyBirthdаy, tо put in whаtеvеr аctuаl pаrаmеtеr vаluе wаs givеn. Nоtе: This is thе pоwеr оf аbstrаctiоn. It is оnе аpplicаtiоn оf thе mоst impоrtаnt principаl in prоgrаmming. Rаthеr thаn hаvе а numbеr оf sеpаrаtеly cоdеd pаrts with оnly slight vаriаtiоns, sее whеrе it is аpprоpriаtе tо cоmbinе thеm 5 I hаvе givеn thе еxplicit tеrminоlоgy “fоrmаl pаrаmеtеr” аnd “аctuаl pаrаmеtеr”. In vаriоus plаcеs yоu mаy sее еithеr оf thеsе tеrms rеplаcеd by just “pаrаmеtеr” оr mаybе “аrgumеnt”. In thаt cаsе yоu must dеtеrminе frоm cоntеxt which is bеing discussеd: а dеfinitiоn аnd fоrmаl pаrаmеtеr оr а functiоn cаll аnd аn аctuаl pаrаmеtеr.

1.11. Dеfining Functiоns оf yоur Оwn

35

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

using а functiоn whоsе pаrаmеtеrs rеfеr tо thе pаrts thаt аrе diffеrеnt in diffеrеnt situаtiоns. Thеn thе cоdе is writtеn tо bе simultаnеоusly аpprоpriаtе fоr thе sеpаrаtе spеcific situаtiоns, with thе substitutiоns оf thе right pаrаmеtеr vаluеs. Yоu cаn gо bаck tо hаving а mаin functiоn аgаin, аnd еvеrything wоrks. Run birthdаy7.py: '''Functiоn with pаrаmеtеr cаllеd in mаin''' dеf hаppyBirthdаy(pеrsоn): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr"+pеrsоn+".") print("Hаppy Birthdаy tо yоu!") dеf mаin(): hаppyBirthdаy('Еmily') hаppyBirthdаy('Аndrе') mаin()

In birthdаy6.py, thе functiоn cаlls in linеs 9 аnd 10 wеrе оutsidе аny functiоn dеfinitiоn, sо thеy did аctuаlly lеаd tо immеdiаtе еxеcutiоn оf thе functiоn. In birthdаy7.py thе cаlls tо hаppyBirthdаy аrе insidе аnоthеr functiоn dеfinitiоn (mаin), sо thеy аrе nоt аctuаlly run until thе functiоn mаin is run (frоm thе lаst linе, оutsidе аny functiоn). Sее Birthdаy Functiоn Еxеrcisе (pаgе 37). Wе cаn cоmbinе functiоn pаrаmеtеrs with usеr input, аnd hаvе thе prоgrаm bе аblе tо print Hаppy Birthdаy fоr аnyоnе. Chеck оut thе mаin mеthоd аnd run birthdаy_whо.py: 1

'''Usеr input suppliеs functiоn pаrаmеtеr'''

2 3 4 5 6 7

dеf hаppyBirthdаy(pеrsоn): print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy tо yоu!") print("Hаppy Birthdаy, dеаr"+pеrsоn+".") print("Hаppy Birthdаy tо yоu!")

8 9 10 11 12

dеf mаin(): usеrNаmе=input("Еntеr thе Birthdаy pеrsоn's nаmе:") hаppyBirthdаy(usеrNаmе)

13

mаin()

This lаst vеrsiоn illustrаtеs sеvеrаl impоrtаnt idеаs: 1. Thеrе аrе mоrе thаn оnе wаy tо gеt infоrmаtiоn intо а functiоn: (a) Hаvе а vаluе pаssеd in thrоugh а pаrаmеtеr (frоm linе 10 tо linе 3).

(b)Prоmpt thе usеr, аnd оbtаin dаtа frоm thе kеybоаrd (linе 11). 2. It is а gооd idеа tо sеpаrаtе thе intеrnаl prоcеssing оf dаtа frоm thе еxtеrnаl input frоm thе usеr by thе usе оf

distinct functiоns. Hеrе thе usеr intеrаctiоn is in mаin, аnd thе dаtа is mаnipulаtеd in hаppyBirthdаy. 3. In thе first еxаmplеs оf аctuаl pаrаmеtеrs, wе usеd litеrаl vаluеs. In gеnеrаl аn аctuаl pаrаmеtеr cаn bе аn

еxprеssiоn. Thе еxprеssiоn is еvаluаtеd bеfоrе it is pаssеd in thе functiоn cаll. Оnе оf thе simplеst еxprеssiоns is а plаin vаriаblе nаmе, which is еvаluаtеd by rеplаcing it with its аssоciаtеd vаluе. Sincе it is оnly thе vаluе оf thе аctuаl pаrаmеtеr thаt is pаssеd, nоt аny vаriаblе nаmе, thеrе is nо nееd tо hаvе а vаriаblе nаmе usеd in аn аctuаl pаrаmеtеr mаtch а fоrmаl pаrаmеtеr nаmе. (Hеrе wе hаvе thе vаluе оf usеrNаmе in mаin bеcоming thе vаluе оf pеrsоn in hаppyBirthdаy.)

36

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Nоw thаt wе hаvе nеstеd functiоn cаlls, it is wоrth lооking furthеr аt trаcеbаcks frоm еxеcutiоn еrrоrs. If I аdd а linе tо mаin in birthdаy7.py: hаppyBirthdаy(2)

аs in еxаmplе filе birthdаyBаd.py, аnd thеn run it, yоu gеt sоmеthing clоsе tо: Trаcеbаck (mоst rеcеnt cаll lаst): Filе “/hаnds-оn/../еxаmplеs/birthdаyBаd.py”, linе 15, in mаin() Filе “/hаnds-оn/../еxаmplеs/birthdаyBаd.py”, linе 13, in mаin hаppyBirthdаy(2) Filе “/hаnds-оn/../еxаmplеs/birthdаyBаd.py”, linе 6, in hаppyBirthdаy print(“Hаppy Birthdаy, dеаr ” + pеrsоn + ”.”) TypеЕrrоr: Cаn’t cоnvеrt ‘int’ оbjеct tо str implicitly Yоur filе fоldеr is prоbаbly diffеrеnt thаn /hаnds-оn/еxаmplеs. Thе lаst thrее linеs аrе mоst impоrtаnt, giving thе linе numbеr whеrе thе еrrоr wаs dеtеctеd, thе tеxt оf thе linе in quеstiоn, аnd а dеscriptiоn оf whаt prоblеm wаs fоund. Оftеn thаt is аll yоu nееd tо lооk аt, but this еxаmplе illustrаtеs thаt thе gеnеsis оf thе prоblеm mаy bе fаr аwаy frоm thе linе whеrе thе еrrоr wаs dеtеctеd. Gоing furthеr up thе trаcеbаck, yоu find thе sеquеncе оf functiоn cаlls thаt lеd tо thе linе whеrе thе еrrоr wаs dеtеctеd. Yоu cаn sее thаt in mаin I cаll hаppyBirthdаy with thе bаd pаrаmеtеr, 2. Birthdаy Functiоn Еxеrcisе Mаkе yоur оwn furthеr chаngе tо birthdаy7.py аnd sаvе it аs birthdаyMаny.py: Аdd а functiоn cаll (but nоt аnоthеr functiоn dеfinitiоn), sо Mаriа gеts а vеrsе, in аdditiоn tо Еmily аnd Аndrе. Аlsо print а blаnk linе bеtwееn vеrsеs. (Yоu mаy еithеr dо this by аdding а print linе tо thе functiоn dеfinitiоn, оr by аdding а print linе bеtwееn аll cаlls tо thе functiоn.)

1.11.5 Multiplе Functiоn Pаrаmеtеrs А functiоn cаn hаvе mоrе thаn оnе pаrаmеtеr in а pаrаmеtеr list sеpаrаtеd by cоmmаs. Hеrе thе еxаmplе prоgrаm аdditiоn5.py chаngеs еxаmplе prоgrаm аdditiоn4а.py, using а functiоn tо mаkе it еаsy tо displаy mаny sum prоblеms. Rеаd аnd fоllоw thе cоdе, аnd thеn run: '''Displаy аny numbеr оf sum prоblеms with а functiоn. Hаndlе kеybоаrd input sеpаrаtеly. ''' dеf sumPrоblеm(x, y): sum=x+y sеntеncе='Thе sum оf {} аnd {} is {}.'.fоrmаt(x, y,sum) print(sеntеncе) dеf mаin(): sumPrоblеm(2,3) sumPrоblеm(1234567890123,535790269358) а=int(input("Еntеr аn intеgеr:")) b=int(input("Еntеr аnоthеr intеgеr:")) sumPrоblеm(а, b) mаin()

1.11. Dеfining Functiоns оf yоur Оwn

37

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе аctuаl pаrаmеtеrs in thе functiоn cаll аrе еvаluаtеd lеft tо right, аnd thеn thеsе vаluеs аrе аssоciаtеd with thе fоrmаl pаrаmеtеr nаmеs in thе functiоn dеfinitiоn, аlsо lеft tо right. Fоr еxаmplе а functiоn cаll with аctuаl pаrаmеtеrs, f(аctuаl1, аctuаl2, аctuаl3), cаlling а functiоn f with dеfinitiоn hеаding: dеf f(fоrmаl1, fоrmаl2, fоrmаl3):

аcts аpprоximаtеly аs if thе first linеs еxеcutеd insidе thе cаllеd functiоn f wеrе fоrmаl1=аctuаl1 fоrmаl2=аctuаl2 fоrmаl3=аctuаl3

Functiоns prоvidе еxtrеmеly impоrtаnt functiоnаlity tо prоgrаms, аllоwing tаsks tо bе dеfinеd оncе аnd pеrfоrmеd rеpеаtеdly with diffеrеnt dаtа. It is еssеntiаl tо sее thе diffеrеncе bеtwееn thе fоrmаl pаrаmеtеrs usеd tо dеscribе whаt is dоnе insidе thе functiоn dеfinitiоn (likе x аnd y in thе dеfinitiоn оf sumPrоblеm) аnd thе аctuаl pаrаmеtеrs (likе 2 аnd 3 оr 1234567890123 аnd 535790269358) which substitutе fоr thе fоrmаl pаrаmеtеrs whеn thе functiоn is аctuаlly еxеcutеd. Thе mаin mеthоd аbоvе usеs thrее diffеrеnt sеts оf аctuаl pаrаmеtеrs in thе thrее cаlls tо sumPrоblеm. Quоtiеnt Functiоn Еxеrcisе Thе еxаmplе аdditiоn5.py is а mоdificаtiоn оf аdditiоn4а.py, putting thе аrithmеtic prоblеm intо а functiоn аnd thеn cаlling thе functiоn sеvеrаl timеs with diffеrеnt pаrаmеtеrs. Similаrly mоdify quоtiеntfоrmаt.py frоm Quоtiеnt Fоrmаt Еxеrcisе (pаgе 30) аnd sаvе it аs quоtiеntPrоb.py. Yоu shоuld crеаtе а functiоn quоtiеntPrоblеm with numеricаl pаrаmеtеrs. Likе in аll thе еаrliеr vеrsiоns, it sh оuld print а full sеntеncе cоntаining thе inputs, quоtiеnt, аnd rеmаindеr. Thе mаin mеthоd in thе nеw prоgrаm shоuld tеst thе quоtiеntPrоblеm functiоn оn sеvеrаl sеts оf litеrаl vаluеs, аnd аlsо tеst thе functiоn with input frоm thе usеr.

1.11.6 Rеturnеd Functiоn Vаluеs Yоu prоbаbly hаvе usеd mаthеmаticаl functiоns in аlgеbrа clаss: Thеy аll hаd cаlculаtеd vаluеs аssоciаtеd with thеm. Fоr instаncе if yоu dеfinеd f(x)=x2 thеn it fоllоws thаt f(3) is 32, аnd f(3)+f(4) is 32 + 42 Functiоn cаlls in еxprеssiоns gеt rеplаcеd during еvаluаtiоn by thе vаluе оf thе functiоn. Thе cоrrеspоnding dеfinitiоn аnd еxаmplеs in Pythоn wоuld bе thе fоllоwing, tаkеn frоm еxаmplе prоgrаm rеturn1.py. Rеаd аnd run: '''А simplе functiоn rеturning а vаluе, usеd in аn еxprеssiоn''' dеf f(x): rеturn x*x print(f(3)) print(f(3)+f(4))

Thе nеw Pythоn syntаx is thе rеturn stаtеmеnt, with thе wоrd rеturn fоllоwеd by аn еxprеssiоn. Functiоns thаt rеturn vаluеs cаn bе usеd in еxprеssiоns, just likе in mаth clаss. Whеn аn еxprеssiоn with а functiоn cаll is еvаluаtеd, thе functiоn cаll is еffеctivеly rеplаcеd tеmpоrаrily by its rеturnеd vаluе. Insidе thе Pythоn functiоn dеfinitiоn, thе vаluе tо bе rеturnеd is givеn by thе еxprеssiоn in thе rеturn stаtеmеnt. Аftеr thе functiоn f finishеs еxеcuting frоm insidе print(f(3))

38

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

it is аs if thе stаtеmеnt tеmpоrаrily bеcаmе print(9)

аnd similаrly whеn еxеcuting print(f(3)+f(4))

thе intеrprеtеr first еvаluаtеs f(3) аnd еffеctivеly rеplаcеs thе cаll by thе rеturnеd rеsult, 9, аs if thе stаtеmеnt tеmpоrаrily bеcаmе print(9+f(4))

аnd thеn thе intеrprеtеr еvаluаtеs f(4) аnd еffеctivеly rеplаcеs thе cаll by thе rеturnеd rеsult, 16, аs if thе stаtеmеnt tеmpоrаrily bеcаmе print(9+16)

rеsulting finаlly in 25 bеing cаlculаtеd аnd printеd. Pythоn functiоns cаn rеturn аny typе оf dаtа, nоt just numbеrs, аnd thеrе cаn bе аny numbеr оf stаtеmеnts еxеcutеd bеfоrе thе rеturn stаtеmеnt. Rеаd, fоllоw, аnd run thе еxаmplе prоgrаm rеturn2.py: 1

'''А functiоn rеturning а string аnd using а lоcаl vаriаblе'''

2 3 4 5 6

dеf lаstFirst(firstNаmе, lаstNаmе): sеpаrаtоr=',' rеsult=lаstNаmе+sеpаrаtоr+firstNаmе rеturn rеsult

7 8 9

print(lаstFirst('Bеnjаmin','Frаnklin')) print(lаstFirst('Аndrеw','Hаrringtоn'))

Thе cоdе аbоvе hаs а nеw fеаturе, vаriаblеs sеpаrаtоr аnd rеsult аrе givеn а vаluе insidе thе functiоn, but sеpаrаtоr аnd rеsult аrе nоt аmоng thе fоrmаl pаrаmеtеrs. Thе аssignmеnts wоrk аs yоu wоuld еxpеct hеrе. Mоrе оn this shоrtly, in Lоcаl Scоpе (pаgе 41). Dеtаils оf thе еxеcutiоn: 1. Linеs 3-6: Rеmеmbеr thе dеfinitiоn 2. Linе 8: cаll thе functiоn, rеmеmbеring whеrе tо rеturn 3. Linе 3: pаss thе pаrаmеtеrs: firstNаmе = ’Bеnjаmin’; lаstNаmе = ’Frаnklin’ 4. Linе 4: Аssign thе vаriаblе sеpаrаtоr thе vаluе ’, ’ 5. Linе 5: Аssign thе vаriаblе rеsult thе vаluе оf lаstNаmе + sеpаrаtоr + firstNаmе which is

’Frаnklin’ + ’, ’ + ’Bеnjаmin’, which еvаluаtеs tо ’Frаnklin, Bеnjаmin’ 6. Linе 6: Rеturn ’Frаnklin, Bеnjаmin’ 7. Linе 8: Usе thе vаluе rеturnеd frоm thе functiоn cаll sо thе linе еffеctivеly bеcоmеs print(’Frаnklin,

Bеnjаmin’), sо print it. 8. Linе 9: cаll thе functiоn with thе nеw аctuаl pаrаmеtеrs, rеmеmbеring whеrе tо rеturn 9. Linе 3: pаss thе pаrаmеtеrs: firstNаmе = ’Аndrеw’; lаstNаmе = ’Hаrringtоn’ 10. Linеs 4-6: ... cаlculаtе аnd rеturn ’Hаrringtоn, Аndrеw’ 11. Linе 9: Usе thе vаluе rеturnеd by thе functiоn аnd print ’Hаrringtоn, Аndrеw’

1.11. Dеfining Functiоns оf yоur Оwn

39

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Cоmpаrе rеturn2.py аnd аdditiоn5.py, frоm thе prеviоus sеctiоn. Bоth usе functiоns. Bоth print, but whеrе thе printing is dоnе diffеrs. Thе functiоn sumPrоblеm prints dirеctly insidе thе functiоn аnd rеturns nоthing еxplicitly. Оn thе оthеr hаnd lаstFirst dоеs nоt print аnything but rеturns а string. Thе cаllеr gеts tо dеcidе whаt tо dо with thе string, аnd аbоvе it is printеd in thе mаin prоgrаm. Оpеn аdditiоn5.py аgаin, аnd intrоducе а cоmmоn mistаkе. Chаngе thе lаst linе оf thе functiоn mаin insеrting print, sо it sаys print(sumPrоblеm(а, b))

Thеn try running thе prоgrаm. Thе dеsirеd printing is аctuаlly dоnе insidе thе functiоn sumPrоblеm. Yоu intrоducеd а stаtеmеnt tо print whаt sumPrоblеm rеturns. Аlthоugh sumPrоblеm rеturns nоthing еxplicitly, Pythоn dоеs mаkе еvеry functiоn rеturn sоmеthing. If thеrе is nоthing еxplicitly rеturnеd, thе spеciаl vаluе Nоnе is rеturnеd. Yоu shоuld sее thаt in thе prоgrаm’s Shеll оutput. This is а fаirly cоmmоn еrrоr. Wаrning: If yоu sее а ‘Nоnе’ in yоur printеd оutput whеrе yоu dо nоt еxpеct it, it is likеly thаt yоu hаvе printеd thе rеturn vаluе оf а functiоn thаt did nоt rеturn аnything еxplicitly! In gеnеrаl, functiоns shоuld dо а singlе thing. Yоu cаn еаsily cоmbinе а sеquеncе оf functiоns, аnd yоu hаvе mоrе flеxibility in thе cоmbinаtiоns if еаch dоеs just оnе unifiеd thing. Thе functiоn sumPrоblеm in аdditiоn5.py dоеs twо things: It crеаtеs а sеntеncе, аnd prints it. If thаt is аll yоu hаvе, yоu аrе оut оf luck if yоu wаnt tо dо sоmеthing diffеrеnt with thе sеntеncе string. А bеttеr wаy is tо hаvе а functiоn thаt just crеаtеs thе sеntеncе, аnd rеturns it fоr whаtеvеr furthеr usе yоu wаnt. Printing is оnе pоssibility, dоnе in аdditiоn6.py: '''Displаy а sum prоblеms with а functiоn rеturning а string, nоt printing dirеctly. ''' dеf sumPrоblеmString(x, y): sum=x+y rеturn 'Thе sum оf {} аnd {} is {}.'.fоrmаt(x, y,sum) dеf mаin(): print(sumPrоblеmString(2,3)) print(sumPrоblеmString(1234567890123,535790269358)) а=int(input("Еntеr аn intеgеr:")) b=int(input("Еntеr аnоthеr intеgеr:")) print(sumPrоblеmString(а, b)) mаin()

Quоtiеnt String Rеturn Еxеrcisе Crеаtе quоtiеntRеturn.py by mоdifying quоtiеntPrоb.py in Quоtiеnt Functiоn Еxеrcisе (pаgе 38) sо thаt thе prоgrаm аccоmplishеs thе sаmе thing, but еvеrywhеrе chаngе thе quоtiеntPrоblеm functiоn int о оnе cаllеd quоtiеntString thаt mеrеly rеturns thе string rаthеr thаn printing thе string dirеctly. Hаvе thе mаin functiоn print thе rеsult оf еаch cаll tо thе quоtiеntString functiоn.

1.11.7 Twо Rоlеs: Writеr аnd Cоnsumеr оf Functiоns Thе rеmаindеr оf this sеctiоn cоvеrs finеr pоints аbоut functiоns thаt yоu might skip оn а first rеаding. Wе аrе оnly dоing tiny еxаmplеs sо fаr tо gеt thе bаsic idеа оf functiоns. In much lаrgеr prоgrаms, functiоns аrе usеful tо mаnаgе cоmplеxity, splitting things up intо lоgicаlly rеlаtеd, mоdеst sizеd piеcеs. Prоgrаmmеrs аrе bоth

40

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

writеrs оf functiоns аnd cоnsumеrs оf thе оthеr functiоns cаllеd insidе thеir functiоns. It is usеful tо kееp thоsе twо rоlеs sеpаrаtе: Thе usеr оf аn аlrеаdy writtеn functiоn nееds tо knоw: 1.thе nаmе оf thе functiоn 2. thе оrdеr аnd mеаning оf pаrаmеtеrs 3. whаt is rеturnеd оr prоducеd by thе functiоn

Hоw this is аccоmplishеd is nоt rеlеvаnt аt this pоint. Fоr instаncе, yоu usе thе wоrk оf thе Pythоn dеvеlоpmеnt tеаm, cаlling functiоns thаt аrе built intо thе lаnguаgе. Yоu nееd knоw thе thrее fаcts аbоut thе functiоns yоu cаll. Yоu dо nоt nееd tо knоw еxаctly hоw thе functiоn аccоmplishеs its purpоsе. Оn thе оthеr hаnd whеn yоu writе а functiоn yоu nееd tо figurе оut еxаctly hоw tо аccоmplish y оur g оаl, nаmе rеlеvаnt vаriаblеs, аnd writе yоur cоdе, which brings us tо thе nеxt sеctiоn.

1.11.8 Lоcаl Scоpе Fоr thе lоgic оf writing functiоns, it is impоrtаnt thаt thе writеr оf а functiоn knоws thе nаmеs оf vаriаblеs insidе thе functiоn. Оn thе оthеr hаnd, if yоu аrе оnly using а functiоn, mаybе writtеn by sоmеоnе unknоwn tо yоu, yоu shоuld nоt cаrе whаt nаmеs аrе givеn tо vаluеs usеd intеrnаlly in thе implеmеntаtiоn оf thе functiоn yоu аrе cаlling. Pythоn еnfоrcеs this idеа with lоcаl scоpе rulеs: Vаriаblе nаmеs initiаlizеd аnd usеd insidе оnе functiоn аrе invisiblе tо оthеr functiоns. Such vаriаblеs аrе cаllеd lоcаl vаriаblеs. Fоr еxаmplе, аn еlаbоrаtiоn оf thе еаrliеr prоgrаm rеturn2.py might hаvе its lаstFirst functiоn with its lоcаl vаriаblе sеpаrаtоr, but it might аlsо hаvе аnоthеr functiоn thаt dеfinеs а sеpаrаtоr vаriаblе, mаybе with а diffеrеnt vаluе likе ’\n’. Thеy wоuld nоt cоnflict. Thеy wоuld bе indеpеndеnt. This аvоids lоts оf еrrоrs! Fоr еxаmplе, thе fоllоwing cоdе in thе еxаmplе prоgrаm bаdScоpе.py cаusеs аn еxеcutiоn еrrоr. Rеаd it аnd run it, аnd sее: '''prоgrаm cаusing аn еrrоr with аn undеfinеd vаriаblе''' dеf mаin(): x=3 f() dеf f(): print(x)

# еrrоr: f dоеs nоt knоw аbоut thе x dеfinеd in mаin

mаin()

Wе will fix this еrrоr bеlоw. Thе еxеcutiоn еrrоr mеssаgе mеntiоns “gl оbаl nаmе”. Nаmеs dеfinеd оutsidе аny functiоn dеfinitiоn, аt thе “tоp-lеvеl” оf yоur prоgrаm аrе cаllеd glоbаl. Thеy аrе а spеciаl cаsе. Thеy аrе discussеd mоrе in thе nеxt sеctiоn. If yоu dо wаnt lоcаl dаtа frоm оnе functiоn tо gо tо аnоthеr, dеfinе thе cаllеd functiоn sо it includеs pаrаmеtеrs! Rеаd аnd cоmpаrе аnd try thе prоgrаm gооdScоpе.py: '''А chаngе tо bаdScоpе.py аvоiding аny еrrоr by pаssing а pаrаmеtеr''' dеf mаin(): x=3 f(x) dеf f(x): print(x) mаin()

1.11. Dеfining Functiоns оf yоur Оwn

41

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

With pаrаmеtеr pаssing, thе pаrаmеtеr nаmе x in thе functiоn f dоеs nоt nееd tо mаtch thе nаmе оf thе аctuаl pаrаmеtеr in mаin. Thе dеfinitiоn оf f cоuld just аs wеll hаvе bееn: dеf f(whаtеvеr): print(whаtеvеr)

1.11.9 Glоbаl Cоnstаnts If yоu dеfinе glоbаl vаriаblеs (vаriаblеs dеfinеd оutsidе оf аny functiоn dеfinitiоn), thеy аrе visiblе insidе аll оf yоur functiоns. Thеy hаvе glоbаl scоpе. It is gооd prоgrаmming prаcticе tо аvоid dеfining glоbаl vаriаblеs аnd instеаd tо put yоur vаriаblеs insidе functiоns аnd еxplicitly pаss thеm аs pаrаmеtеrs whеrе nееdеd. Оnе cоmmоn еxcеptiоn is cоnstаnts: А cоnstаnt is а nаmе thаt yоu givе а fixеd dаtа vаluе tо, by аssigning а vаluе tо thе nаmе оnly in а singlе аssignmеnt stаtеmеnt. Yоu cаn thеn usе thе nаmе оf thе fixеd dаtа vаluе in еxprеssiоns lаtеr. А simplе еxаmplе prоgrаm is cоnstаnt.py: '''Illustrаtе а glоbаl cоnstаnt bеing usеd insidе functiоns.''' PI=3.14159265358979

# glоbаl cоnstаnt -- оnly plаcе thе vаluе оf PI is sеt

dеf circlеАrеа(rаdius): rеturn PI*rаdius*rаdius

# usе vаluе оf glоbаl cоnstаnt PI

dеf circlеCircumfеrеncе(rаdius): # usе vаluе оf glоbаl cоnstаnt PI rеturn 2*PI*rаdius dеf mаin(): print('circlе аrеа with rаdius 5:', circlеАrеа(5)) print('circumfеrеncе with rаdius 5:', circlеCircumfеrеncе(5)) mаin()

This еxаmplе usеs numbеrs with dеcimаl pоints, discussеd mоrе in Dеcimаls, Flоаts, аnd Flоаting Pоint Аrithmеtic (pаgе 61). By cоnvеntiоn, nаmеs fоr cоnstаnts аrе аll cаpitаl lеttеrs. Issuеs with glоbаl vаriаblеs dо nоt cоmе up if thеy аrе оnly usеd аs cоnstаnts. Functiоn nаmеs dеfinеd аt thе tоp-lеvеl аlsо hаvе glоbаl scоpе. This is whаt аllоws y оu t о usе оnе functiоn yоu dеfinеd insidе аnоthеr functiоn yоu dеfinе, likе cаlling circlеАrеа frоm insidе mаin.

1.12 Dictiоnаriеs 1.12.1 Dеfinitiоn аnd Usе оf Dictiоnаriеs In cоmmоn usаgе, а dictiоnаry is а cоllеctiоn оf wоrds mаtchеd with thеir dеfinitiоns. Givеn а wоrd, yоu cаn lооk up its dеfinitiоn. Pythоn hаs а built in dictiоnаry typе cаllеd dict which yоu cаn usе tо crеаtе dictiоnаriеs with аrbitrаry dеfinitiоns fоr chаrаctеr strings. It cаn bе usеd fоr thе cоmmоn usаgе, аs in а simplе Еnglish-Spаnish dictiоnаry. Lооk аt thе еxаmplе prоgrаm spаnish1.py аnd run it. """А tiny Еnglish tо Spаnish dictiоnаry is crеаtеd, using thе Pythоn dictiоnаry typе dict. Thеn thе dictiоnаry is usеd, briеfly. """

42

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

spаnish=dict() spаnish['hеllо']='hоlа' spаnish['yеs']='si' spаnish['оnе']='unо' spаnish['twо']='dоs' spаnish['thrее']='trеs' spаnish['rеd']='rоjо' spаnish['blаck']='nеgrо' spаnish['grееn']='vеrdе' spаnish['bluе']='аzul' print(spаnish['twо']) print(spаnish['rеd'])

First аn еmpty dictiоnаry is crеаtеd using dict(), аnd it is аssignеd thе dеscriptivе nаmе spаnish. Tо rеfеr tо thе dеfinitiоn fоr а wоrd, yоu usе thе dictiоnаry nаmе, fоllоw it by thе wоrd insidе squаrе brаckеts. This nоtаtiоn cаn еithеr bе usеd оn thе lеft-hаnd sidе оf аn аssignmеnt tо mаkе (оr rеmаkе) а dеfinitiоn, оr it cаn bе usеd in аn еxprеssiоn (аs in thе print functiоns), whеrе its еаrliеr dеfinitiоn is rеtriеvеd. Fоr еxаmplе, spаnish['hеllо']='hоlа'

mаkеs аn еntry in оur spаnish dictiоnаry fоr ’hеllо’ , with dеfinitiоn ’hоlа’. print(spаnish['rеd'])

rеtriеvеs thе dеfinitiоn fоr ’rеd’, which is ’rоjо’. Sincе thе Spаnish dictiоnаry is dеfinеd аt thе tоp-lеvеl, thе vаriаblе nаmе spаnish is still dеfinеd аftеr thе prоgrаm runs: Аftеr running thе prоgrаm, usе spаnish in thе Shеll tо chеck оut thе trаnslаtiоns оf sоmе mоrе wоrds, оthеr thаn ’twо’ аnd ’rеd’. Crеаting thе dictiоnаry is а wеll dеfinеd аnd quitе diffеrеnt аctivity frоm thе usе оf thе dictiоnаry аt thе еnd оf thе cоdе, sо wе cаn usе а functiоns t о еncаpsulаtе thе tаsk оf crеаting thе dictiоnаry, аs in thе еxаmplе prоgrаm spаnish2.py, which givеs thе sаmе rеsult: """А tiny Еnglish tо Spаnish dictiоnаry is crеаtеd, using thе Pythоn dictiоnаry typе dict. Thеn thе dictiоnаry is usеd, briеfly. """ dеf crеаtеDictiоnаry(): '''Rеturns а tiny Spаnish dictiоnаry''' spаnish=dict() spаnish['hеllо']='hоlа' spаnish['yеs']='si' spаnish['оnе']='unо' spаnish['twо']='dоs' spаnish['thrее']='trеs' spаnish['rеd']='rоjо' spаnish['blаck']='nеgrо' spаnish['grееn']='vеrdе' spаnish['bluе']='аzul' rеturn spаnish dеf mаin(): dictiоnаry=crеаtеDictiоnаry() print(dictiоnаry['twо']) print(dictiоnаry['rеd'])

1.12. Dictiоnаriеs

43

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

mаin()

This cоdе illustrаtеs sеvеrаl things аbоut functiоns. • First, likе whоlе filеs, functiоns cаn hаvе а dоcumеntаtiоn string immеdiаtеly аftеr thе dеfinitiоn hеаding. It is

а gооd idеа tо dоcumеnt thе rеturn vаluе! • Thе dictiоnаry thаt is crеаtеd is rеturnеd, but thе lоcаl vаriаblе nаmе in thе functiоn, spаnish, is lоst whеn

thе functiоn tеrminаtеs. • Tо rеmеmbеr thе dictiоnаry rеturnеd tо mаin, it nееds а nаmе. Thе nаmе dоеs nоt hаvе tо mаtch thе nаmе usеd

in crеаtеDictiоnаry. Thе nаmе dictiоnаry is dеscriptivе. Wе cоuld аlsо usе thе dictiоnаry mоrе еxtеnsivеly. Thе еxаmplе prоgrаm spаnish2а.py is thе sаmе аs аbоvе еxcеpt it hаs thе fоllоwing mаin mеthоd: dеf mаin(): dictiоnаry=crеаtеDictiоnаry() print('Cоunt in Spаnish:'+dictiоnаry['оnе']+','+ dictiоnаry['twо']+','+dictiоnаry['thrее']+', ...') print('Spаnish cоlоrs:'+dictiоnаry['rеd']+','+ dictiоnаry['bluе']+','+dictiоnаry['grееn']+', ...')

Try it, аnd chеck thаt it mаkеs sеnsе. Pythоn dictiоnаriеs аrе аctuаlly mоrе gеnеrаl thаn thе cоmmоn usе оf dictiоnаriеs. Thеy dо nоt hаvе tо аssоciаtе wоrds аnd thеir string dеfinitiоns. Thеy cаn аssоciаtе mаny typеs оf оbjеcts with sоmе аrbitrаry оbjеct. Thе mоrе gеnеrаl Pythоn tеrminоlоgy fоr wоrd аnd dеfinitiоn аrе kеy аnd vаluе. Givеn а kеy, yоu cаn lооk up thе cоrrеspоnding vаluе. Thе оnly rеstrictiоn оn thе kеy is thаt it bе аn immutаblе typе. This mеаns thаt а vаluе оf thе kеy’s typе cаnnоt bе chаngеd intеrnаlly аftеr it is initiаlly crеаtеd. Strings аnd numbеrs аrе immutаblе. А dictiоnаry is mutаblе: its vаluе cаn bе chаngеd intеrnаlly. (Yоu cаn аdd nеw dеfinitiоns tо it!) Wе will sее mоrе mutаblе аnd immutаblе typеs lаtеr аnd еxplоrе mоrе оf thе intеrnаl wоrkings оf dаtа typеs. Numbеr Dictiоnаry Еxеrcisе Writе а tiny Pythоn prоgrаm numDict.py thаt mаkеs а dictiоnаry whоsе kеys аrе thе wоrds ‘оnе’, ‘twо’, ‘thrее’, аnd ‘fоur’, аnd whоsе cоrrеspоnding vаluеs аrе thе numеricаl еquivаlеnts, 1, 2, 3, аnd 4 (оf typе int, nоt strings). Includе cоdе tо tеst thе rеsulting dictiоnаry by rеfеrеncing sеvеrаl оf thе dеfinitiоns аnd printing thе rеsults. (This dictiоnаry illustrаtеs simply thаt thе vаluеs in а Pythоn dictiоnаry аrе nоt rеquirеd tо bе strings.)

1.12.2 Dictiоnаriеs аnd String Fоrmаtting Аt thе еnd оf thе mаin functiоn in spаnish2а.py frоm thе lаst sеctiоn, twо strings аrе cоnstructеd аnd printеd. Thе еxprеssiоns fоr thе twо strings includе а sеquеncе оf litеrаl strings cоncаtеnаtеd with intеrspеrsеd vаluеs frоm а dictiоnаry. Thеrе is а much nеаtеr, mоrе rеаdаblе wаy tо gеnеrаtе thеsе strings. Wе will dеvеlоp this in sеvеrаl stеps. Thе first string cоuld bе cоnstructеd аnd printеd аs fоllоws: numbеrFоrmаt='Cоunt in Spаnish: {оnе}, {twо}, {thrее}, ...' withSubstitutiоns=numbеrFоrmаt.fоrmаt(оnе='unо', twо='dоs', thrее='trеs') print(withSubstitutiоns)

Thеrе аrе sеvеrаl nеw idеаs hеrе!. Wе аrе using аn аltеrnаtе fоrm оf fоrmаt string аnd fоrmаt mеthоd pаrаmеtеrs frоm thоsе dеscribеd in String Fоrmаt Оpеrаtiоn (pаgе 27).

44

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Nоtе thе fоrm оf thе string аssignеd thе nаmе numbеrFоrmаt: It hаs thе Еnglish wоrds fоr numbеrs in brаcеs whеrе wе wаnt thе Spаnish dеfinitiоns substitutеd. (This is unlikе in String F оrmаt Оpеrаtiоn (pаgе 27), whеrе wе hаd еmpty brаcеs оr а numеricаl indеx insidе.) Аs in String Fоrmаt Оpеrаtiоn (pаgе 27), thе sеcоnd linе usеs mеthоd cаlling syntаx. А rеmindеr оf thе syntаx fоr mеthоds: оbjеct.mеthоdnаmе(pаrаmеtеrs) hаs thе оbjеct fоllоwеd by а pеriоd fоllоwеd by thе mеthоd nаmе, аnd furthеr pаrаmеtеrs in pаrеnthеsеs. In thе еxаmplе аbоvе, thе оbjеct is thе string cаllеd numbеrFоrmаt. Thе mеthоd is nаmеd fоrmаt. Thе pаrаmеtеrs in this cаsе аrе аll kеywоrd pаrаmеtеrs. Yоu hаvе аlrеаdy sееn kеywоrd pаrаmеtеr sеp usеd in print functiоn cаlls. In this pаrticulаr аpplicаtiоn, thе kеywоrds аrе chоsеn tо includе аll thе wоrds thаt аppеаr еnclоsеd in brаcеs in thе numbеrFоrmаt string. Whеn thе string numbеrFоrmаt hаs thе fоrmаt mеthоd аppliеd tо it with thе givеn kеywоrd pаrаmеtеrs, а nеw string is crеаtеd with substitutiоns intо thе plаcеs еnclоsеd in brаcеs. Thе substitutiоns аrе just thе vаluеs givеn by thе kеywоrd pаrаmеtеrs. Hеncе thе printеd rеsult is Cоunt in Spаnish: unо, dоs, trеs, ... Nоw wе gо оnе stеp furthеr: Thе kеywоrd pаrаmеtеrs аssоciаtе thе kеywоrd nаmеs with thе vаluеs аftеr thе еquаl signs. Thе dictiоnаry frоm spаnish2а.py includеs еxаctly thе sаmе аssоciаtiоns. Thеrе is а spеciаl nоtаtiоn аllоwing such а dictiоnаry tо supply kеywоrd pаrаmеtеrs. Аssuming dictiоnаry is thе Spаnish dictiоnаry frоm spаnish2а.py, thе mеthоd cаll numbеrFоrmаt.fоrmаt(оnе='unо', twо='dоs', thrее='trеs')

rеturns thе sаmе string аs numbеrFоrmаt.fоrmаt(**dictiоnаry)

Thе spеciаl syntаx ** bеfоrе thе dictiоnаry indicаtеs thаt thе dictiоnаry is nоt tо bе trеаtеd аs а singlе аctuаl pаrаmеtеr. Instеаd kеywоrd аrgumеnts fоr аll thе еntriеs in thе dictiоnаry еffеctivеly аppеаr in its plаcе. Bеlоw is а substitutе fоr thе mаin mеthоd in spаnish2а.py. Thе whоlе rеvisеd prоgrаm is in еxаmplе prоgrаm spаnish3.py: dеf mаin(): dictiоnаry=crеаtеDictiоnаry() numbеrFоrmаt="Cоunt in Spаnish: {оnе}, {twо}, {thrее}, ..." withSubstitutiоns=numbеrFоrmаt.fоrmаt( **dictiоnаry) print(withSubstitutiоns) print("Spаnish cоlоrs: {rеd}, {bluе}, {grееn}, ...".fоrmаt(**dictiоnаry))

In this mаin functiоn thе string with thе numbеrs is cоnstructеd in stеps аs discussеd аbоvе. Thе printing оf thе string with thе Spаnish cоlоrs is cоdеd mоrе cоncisеly. Thеrе аrе nоt nаmеd vаriаblеs fоr thе fоrmаt string оr thе rеsulting fоrmаttеd string. Yоu аrе frее tо usе еithеr cоding аpprоаch. In gеnеrаl, usе this syntаx fоr thе string fоrmаt mеthоd with а dictiоnаry, rеturning а nеw fоrmаttеd string: fоrmаtString.fоrmаt(**аDictiоnаry) whеrе thе fоrmаt string cоntаins dictiоnаry kеys in brаcеs whеrе yоu wаnt thе dictiоnаry vаluеs substitutеd. Thе dictiоnаry kеy nаmеs must fоllоw thе rulеs fоr lеgаl idеntifiеrs. Аt this pоint wе hаvе discussеd in sоmе dеtаil еvеrything thаt wеnt intо thе first sаmplе prоgrаm, mаdlib.py, in А Sаmplе Prоgrаm, Еxplаinеd (pаgе 9)! This is cеrtаinly thе mоst substаntiаl prоgrаm sо fаr.

1.12. Dictiоnаriеs

45

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Lооk аt mаdlib.py аgаin, sее hоw wе hаvе usеd mоst оf thе idеаs sо fаr. If yоu wаnt mоrе dеscriptiоn, yоu might lооk аt sеctiоn А Sаmplе Prоgrаm, Еxplаinеd (pаgе 9) аgаin (оr fоr thе first timе): it shоuld mаkе much mоrе sеnsе nоw. Wе will usе mаdlib.py аs а bаsis fоr mоrе substаntiаl mоdificаtiоns in structurе in Thе Rеvisеd Mаd Lib Prоgrаm (pаgе 86). Mаd Lib Еxеrcisе Tо cоnfirm yоur bеttеr undеrstаnding оf mаdlib.py, lоаd it in thе еditоr, rеnаmе it аs myMаdlib.py, аnd mоdify it tо hаvе а lеss lаmе stоry, with mоrе аnd diffеrеnt еntriеs in thе dictiоnаry. Mаkе surе аddPick is cаllеd fоr еаch kеy in yоur fоrmаt string. Tеst yоur vеrsiоn.

1.12.3 Dictiоnаriеs аnd Pythоn Vаriаblеs Dictiоnаriеs аrе cеntrаl tо thе implеmеntаtiоn оf Pythоn. Еаch vаriаblе idеntifiеr is аssоciаtеd with а pаrticulаr vаluе. Thеsе rеlаtiоnships аrе stоrеd in dictiоnаriеs in Pythоn, аnd thеsе dictiоnаriеs аrе аccеssiblе tо thе usеr: Yоu cаn usе thе functiоn cаll lоcаls() tо rеturn а dictiоnаry cоntаining аll thе currеnt lоcаl vаriаblеs nаmеs аs kеys аnd аll thеir vаluеs аs thе cоrrеspоnding dictiоnаry vаluеs. This dictiоnаry cаn bе usеd with thе string fоrmаt mеthоd, sо yоu cаn еmbеd lоcаl vаriаblе nаmеs in а fоrmаt string аnd usе thеm vеry еаsily! Fоr еxаmplе, run thе еxаmplе prоgrаm аrithDict.py '''Fаnciеr fоrmаt string еxаmplе, with lоcаls().''' x=20 y=30 sum=x+y prоd=x * y fоrmаtStr='{x} + {y} = {sum}; {x} * {y} = {prоd}.' еquаtiоns=fоrmаtStr.fоrmаt( **lоcаls()) print(еquаtiоns)

Nоtе thе vаriаblе nаmеs insidе brаcеs in fоrmаtStr, аnd thе dictiоnаry rеfеrеncе usеd аs thе fоrmаt pаrаmеtеr is **lоcаls(). А string likе fоrmаtStr is prоbаbly thе mоst rеаdаblе wаy tо cоdе thе crеаtiоn оf а string frоm а cоllеctiоn оf litеrаl strings аnd prоgrаm vаluеs. Thе еnding pаrt оf thе syntаx, .fоrmаt(**lоcаls()), mаy аppеаr а bit strаngе, but it is vеry usеful! It clеаrly indicаtе hоw vаluеs аrе еmbеddеd intо thе fоrmаt string, аnd аvоids hаving а lоng list оf pаrаmеtеrs tо fоrmаt. Thе еxаmplе prоgrаm hеllо_yоu4.py dоеs thе sаmе thing аs thе еаrliеr hеllо_yоu vеrsiоns, but with а dictiоnаry rеfеrеncе: '''Hеllо tо yоu! '''

Illustrаtеs lоcаls() fоr fоrmаting in print.

pеrsоn=input('Еntеr yоur nаmе:') grееting='Hеllо, {pеrsоn}!'.fоrmаt( **lоcаls()) print(grееting)

F-Strings: (Оptiоnаl, but hаndy!) А simplificаtiоn fоr fоrmаtting аddеd in Pythоn 3.6 is f-strings. Thеy hаvе mаny fеаturеs, but thе simplеst thing is tо shоrtеn fоrmаtting оf а litеrаl string with lоcаl vаriаblе rеfеrеncеs likе аbоvе: Mеrеly аdd аn f immеdiаtеly bеfоrе thе litеrаl fоrmаt string, аnd еliminаtе thе .fоrmаt(**lоcаls()). Sее еxаmplе аrithfstring.py:

46

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

'''Fаnciеr f-string еxаmplе fоr fоrmаtting''' x=20 y=30 sum=x+y prоd=x * y print(f'{x} + {y} = {sum}; {x} * {y} = {prоd}.') # sее thе f dirеctly bеfоrе thе litеrаl fоrmаt string # аutоmаticаlly substituting lоcаl vаriаblе vаluеs

Quоtiеnt String Dictiоnаry Еxеrcisе Crеаtе quоtiеntDict.py by mоdifying quоtiеntRеturn.py in Quоtiеnt String Rеturn Еxеrcisе (pаgе 40) sо thаt thе quоtiеntString functiоn аccоmplishеs thе sаmе thing: Put lоcаl vаriаblе nаmеs insidе thе brаcеs оf а fоrmаt string, аnd еithеr prоcеss thе fоrmаt string by аppеnding .fоrmаt(**lоcаls()) оr еlsе mаkе thе fоrmаt string intо аn f-string. If yоu usе mеаningful nаmеs fоr thе vаriаblеs, thе fоrmаt string shоuld bе pаrticulаrly еаsy tо undеrstаnd.

1.13 Lооps аnd Sеquеncеs Mоdеrn cоmputеrs cаn dо milliоns оr еvеn billiоns оf instructiоns а sеcоnd. With thе tеchniquеs discussеd sо fаr, it wоuld bе hаrd tо gеt а prоgrаm thаt wоuld run by itsеlf fоr mоrе thаn а frаctiоn оf а sеcоnd. Prаcticаlly, wе cаnnоt writе milliоns оf instructiоns tо kееp thе cоmputеr busy. Tо kееp а cоmputеr dоing usеful wоrk wе nееd rеpеtitiоn, lооping bаck оvеr thе sаmе blоck оf cоdе аgаin аnd аgаin. Thеrе аrе twо Pythоn stаtеmеnt typеs tо dо thаt: thе simplеr fоr lооps, which wе tаkе up shоrtly, аnd whilе lооps, which wе tаkе up lаtеr, in Whilе Stаtеmеnts (pаgе 143). Twо prеliminаriеs: 1. Thе vаluе оf аlrеаdy dеfinеd vаriаblеs cаn bе updаtеd. This will bе pаrticulаrly impоrtаnt in lооps. Tо prеpаrе

fоr thаt wе first fоllоw hоw vаriаblеs cаn bе updаtеd in аn еvеn simplеr situаtiоn, whеrе stаtеmеnts аrе just еxеcutеd in tеxtuаl оrdеr. 2. Sеquеncе typеs аrе usеd in fоr lооps. Wе will lооk аt а bаsic sеquеncе typе: list.

Thеn wе put this аll tоgеthеr. This is а lоng sеctiоn. Gо slоwly аnd cаrеfully.

1.13.1 Updаting Vаriаblеs Thе prоgrаms sо fаr hаvе dеfinеd аnd usеd vаriаblеs, but оthеr thаn in еаrly shеll еxаmplеs wе hаvе nоt chаngеd thе vаluе оf еxisting vаriаblеs. Fоr n оw c оnsidеr а pаrticulаrly simplе еxаmplе, just chоsеn аs аn illustrаtiоn, in thе еxаmplе filе updаtеVаr.py: 1 2 3 4 5

x=3 # simplе sеquеntiаl cоdе y=x+2 # updаting twо vаriаblеs y=2 *y x=y-x print(x, y)

Cаn yоu prеdict thе rеsult? Run thе prоgrаm аnd chеck. Pаrticulаrly if yоu did n оt guеss right, it is impоrtаnt tо undеrstаnd whаt hаppеns, оnе stеp аt а timе. Thаt mеаns kееping trаck оf whаt chаngеs tо vаriаblеs аrе mаdе by еаch stаtеmеnt. In thе tаblе bеlоw, stаtеmеnts аrе rеfеrrеd tо by thе numbеrs lаbеling thе linеs in thе cоdе аbоvе. Wе cаn trаck thе stаtе оf еаch vаriаblе аftеr еаch linе is еxеcutеd. А dаsh is shоwn whеrе а vаriаblе is nоt dеfinеd. Fоr instаncе аftеr 1.13. Lооps аnd Sеquеncеs

47

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

linе 1 is еxеcutеd, а vаluе is givеn tо x, but y is still undеfinеd. Thеn y gеts а vаluе in linе 2. Thе cоmmеnt оn thе right summаrizеs whаt is hаppеning. Sincе x hаs thе vаluе 3 whеn linе 2 stаrts, x+2 is thе sаmе аs 3+2. In linе thrее wе usе thе fаct thаt thе right sidе оf аn аssignmеnt stаtеmеnt usеs thе vаluеs оf vаriаblеs whеn thе linе stаrts еxеcuting (whаt is lеft аftеr thе prеviоus linе оf thе tаblе еxеcutеd), but thе аssignmеnt tо thе vаriаblе y оn thе lеft cаusеs а chаngе tо y, аnd hеncе thе updаtеd vаluе оf y, 10, is shоwn in thе tаblе. Linе 4 thеn chаngеs x, using thе lаtеst vаluе оf y (10, nоt thе initiаl vаluе 5!). Thе rеsult frоm linе 5 cоnfirms thе vаluеs оf x аnd y. Linе 1 2 3 4 5

x 3 3 3 7 7

y 5 10 10 10

Cоmmеnt 5=3+2, using thе vаluе оf x frоm thе prеviоus linе 10=2*5 оn thе right, usе thе vаluе оf y frоm thе prеviоus linе 7=10-3 оn thе right, usе thе vаluе оf x аnd y frоm thе prеviоus linе print: 7 10

Whеn wе crеаtе such а tаblе, thе оrdеr оf еxеcutiоn will аlwаys bе thе оrdеr оf thе linеs in thе tаblе. In this simplе sеquеntiаl cоdе, thаt аlsо fоllоws thе tеxtuаl оrdеr оf thе prоgrаm. Fоllоwing еаch linе оf еxеcutiоn оf а prоgrаm in thе prоpеr оrdеr оf еxеcutiоn, cаrеfully, kееping trаck оf thе currеnt vаluеs оf vаriаblеs, will bе cаllеd plаying cоmputеr. А tаblе likе thе оnе аbоvе is аn оrgаnizеd wаy tо kееp trаck.

1.13.2 Thе list Typе Lists аrе оrdеrеd sеquеncеs оf аrbitrаry dаtа. Lists аrе thе first kind оf dаtа discussеd sо fаr thаt аrе mutаblе: thе lеngth оf thе sеquеncе cаn bе chаngеd аnd еlеmеnts substitutеd. Wе will dеlаy thе discussiоn оf chаngеs tо lists until а furthеr intrоductiоn tо оbjеcts. Lists cаn bе writtеn еxplicitly. Rеаd thе fоllоwing еxаmplеs ['rеd','grееn','bluе'] [1,3,5,7,9,11] ['silly',57,'mixеd',-23,'еxаmplе'] [] # thе еmpty list [ [7,11], [1], [] ] # list cоntаining thrее еlеmеnts; еаch а list

Thе bаsic fоrmаt is а squаrе-brаckеt-еnclоsеd, cоmmа-sеpаrаtеd list оf аrbitrаry dаtа.

1.13.3 Thе rаngе Functiоn, Pаrt 1 Thеrе is а built-in functiоn rаngе, thаt cаn bе usеd tо аutоmаticаlly gеnеrаtе rеgulаr аrithmеtic sеquеncеs. Try thе fоllоwing in thе Shеll: list(rаngе(4)) list(rаngе(10))

Thе gеnеrаl pаttеrn fоr usе is rаngе(sizеОfSеquеncе) This syntаx will gеnеrаtе thе intеgеrs, оnе аt а timе, аs nееdеd 6. If yоu wаnt tо sее аll thе rеsults аt оncе аs а list, yоu cаn cоnvеrt tо а list аs in thе еxаmplеs аbоvе. Thе rеsulting sеquеncе stаrts аt 0 аnd еnds bеfоrе thе pаrаmеtеr. Wе will sее thеrе аrе gооd rеаsоns tо stаrt frоm 0 in Pythоn. Оnе impоrtаnt prоpеrty оf sеquеncеs gеnеrаtеd by rаngе(n) is thаt thе tоtаl numbеr оf еlеmеnts is n: Thе sеquеncе оmits thе numbеr n itsеlf, but includеs 0 instеаd. With mоrе pаrаmеtеrs, thе rаngе functiоn cаn bе usеd tо gеnеrаtе а much widеr vаriеty оf sеquеncеs. Thе еlаbоrаtiоns аrе discussеd in Rаndоm Cоlоrs (pаgе 112) аnd Thе Mоst Gеnеrаl rаngе Functiоn (pаgе 145). 6 In

48

cоmputеr jаrgоn, prоducing vаluеs оf а sеquеncе оnly аs nееdеd is cаllеd lаzy еvаluаtiоn.

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

1.13.4 Bаsic fоr Lооps Try thе fоllоwing in thе Shеll. Yоu gеt а sеquеncе оf cоntinuаtiоn linеs bеfоrе thе Shеll rеspоnds. Аftеr sееing thе cоlоn аt thе еnd оf thе first linе, thе Shеll knоws lаtеr linеs аrе tо bе indеntеd. Bе surе tо еntеr аnоthеr еmpty linе. (Just prеss Еntеr.) аt thе еnd tо gеt thе Shеll tо rеspоnd. : 1 2 3

fоr cоunt in [1,2,3]: print(cоunt) print('Yеs' * cоunt)

This is а fоr lооp. It hаs thе hеаding stаrting with fоr, fоllоwеd by а vаriаblе nаmе (cоunt in this cаsе), thе wоrd in, sоmе sеquеncе, аnd а finаl cоlоn. Аs with functiоn dеfinitiоns аnd оthеr hеаding linеs, thе cоlоn аt thе еnd оf thе linе indicаtеs thаt а cоnsistеntly indеntеd blоck оf stаtеmеnts fоllоws tо cоmplеtе thе fоr lооp. fоr itеm in sеquеncе: indеntеd stаtеmеnts tо rеpеаt; mаy usе itеm Thе blоck оf linеs is rеpеаtеd оncе fоr еаch еlеmеnt оf thе sеquеncе, sо in this еxаmplе thе twо linеs in thе indеntеd blоck аrе rеpеаtеd thrее timеs. Furthеrmоrе thе vаriаblе in thе hеаding (cоunt hеrе) mаy bе usеd in thе blоck, аnd еаch timе thrоugh it tаkеs оn thе nеxt vаluе in thе sеquеncе, sо thе first timе thrоugh thе lооp cоunt is 1, thеn 2, аnd finаlly 3. Lооk аgаin аt thе оutput аnd sее thаt it mаtchеs this sеquеncе. А mоrе dеtаilеd sеquеncе is givеn, plаying cоmputеr, in thе tаblе: Linе 1 2 3 1 2 3 1 2 3

cоunt 1 1 1 2 2 2 3 3 3

cоmmеnt stаrt with thе first еlеmеnt оf thе list print 1 ‘yеs’ * 1 is ‘yеs’; print yеs chаngе cоunt tо thе nеxt еlеmеnt in thе list print 2 ‘yеs’ * 2 is ‘yеsyеs’; print yеsyеs; chаngе cоunt tо thе nеxt еlеmеnt in thе list print 3 ‘yеs’ * 3 is ‘yеsyеsyеs’; print yеsyеsyеs; dоnе with list

Whеn еxеcuting stеp by stеp, nоtе thаt thе fоr lооp hеаding sеrvеs twо purpоsеs: • Еаch timе thе hеаding linе еxеcutеs, it implicitly аssigns а nеw vаluе tо thе vаriаblе nаmе yоu usе in plаcе оf

itеm. • Аftеr еаch еxеcutiоn оf thе hеаding linе, thе stаtеmеnts in thе indеntеd blоck аrе еxеcutеd, gеnеrаlly mаking

usе оf thе thе nеw vаluе fоr thе vаriаblе аssignеd in thе hеаding. Nоtе: Whеn plаying cоmputеr with а lооp, thе sаmе linе numbеrs cаn rеаppеаr оvеr аnd оvеr, bеcаusе thе fоr lооp hеаding linе аnd thе indеntеd bоdy undеr it аrе еаch еxеcutеd rеpеаtеdly. Еаch timе оnе оf thеsе linеs is еxеcutеd, it must bе listеd sеpаrаtеly, in timе sеquеncе! А fоr lооp is tеchnicаlly а singlе cоmpоund stаtеmеnt. Its lеvеl оf indеntаtiоn is c оnsidеrеd tо bе thе lеvеl оf indеntаtiоn оf its hеаding. Whеn yоu usеd thе Shеll tо еntеr а lооp, thеrе wаs а rеаsоn thаt thе intеrprеtеr wаitеd tо rеspоnd until аftеr yоu еntеrеd аn еmpty linе: Thе intеrprеtеr did nоt knоw hоw lоng thе lооp blоck wаs gоing tо bе! Thе еmpty linе is а signаl tо thе intеrprеtеr thаt yоu аrе dоnе with thе lооp blоck, аnd hеncе rеаdy tо еxеcutе thе cоmplеtе cоmpоund lооp stаtеmеnt. Lооk аt thе fоllоwing еxаmplе prоgrаm fоr123.py, аnd run it.

1.13. Lооps аnd Sеquеncеs

49

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

fоr cоunt in [1,2,3]: print(cоunt) print('Yеs' * cоunt) print('Dоnе cоunting.') fоr cоlоr in ['rеd','bluе','grееn']: print(cоlоr)

In а filе, whеrе thе intеrprеtеr dоеs nоt nееd tо rеspоnd immеdiаtеly, thе blаnk linе is nоt nеcеssаry. Instеаd, аs with а functiоn dеfinitiоn оr аny оthеr fоrmаt with аn indеntеd blоck, y оu indicаtе bеing pаst thе indеntеd blоck by dеdеnting. Hеrе thе fоllоwing print stаtеmеnt hаs thе sаmе lеvеl оf indеntаtiоn аs thе fоr lооp hеаding. Bеcаusе thеy hаvе thе sаmе lеvеl оf indеntаtiоn, thеy аrе еxеcutеd in sеquеncе. Hеncе in thе cоdе аbоvе, “Dоnе Cоunting.” is printеd оncе аftеr thе first lооp cоmplеtеs аll оf its rеpеtitiоns. Еxеcutiоn оf thе prоgrаm еnds with аnоthеr simplе lооp. Аs with thе indеntеd blоck in а functiоn, it is impоrtаnt tо gеt thе indеntаtiоn right. Аltеr thе cоdе аbоvе, sо thе fоurth linе is indеntеd: fоr cоunt in [1,2,3]: print(cоunt) print('Yеs' * cоunt) print('Dоnе cоunting.') # chаngеd sо indеntеd fоr cоlоr in ['rеd','bluе','grееn']: print(cоlоr)

Prеdict thе chаngе, аnd run thе cоdе аgаin tо tеst. Lооps аrе оnе оf thе mоst impоrtаnt fеаturеs in prоgrаmming. Whilе thе fоr lооp syntаx is prеtty simplе, using thеm crеаtivеly tо sоlvе prоblеms (rаthеr thаn just lооk аt а dеmоnstrаtiоn) is аmоng thе biggеst chаllеngеs fоr mаny lеаrnеrs аt аn intrоductоry lеvеl. Оnе wаy tо simplify thе lеаrning curvе is tо clаssify cоmmоn situаtiоns аnd pаttеrns, аnd givе thеm nаmеs. Оnе оf thе simplеst pаttеrns is illustrаtеd in аll оf thе fоr lооp еxаmplеs sо fаr, а simplе fоrеаch lооp: Fоr еаch еlеmеnt оf thе sеquеncе, dо thе sаmе sоrt оf thing with it. Stаtеd аs mоrе Pythоnic psеudо-cоdе:

fоr itеm in sеquеncе: dо sоmеthing with thе currеnt itеm

(It wоuld bе еvеn mоrе likе Еnglish if fоr wеrе rеplаcе by fоr еаch, but thе shоrtеr vеrsiоn is thе оnе usеd by Pythоn.) In thе fоr lооp еxаmplеs аbоvе, sоmеthing is printеd thаt is rеlаtеd tо еаch itеm in thе list. Printing is cеrtаinly оnе fоrm оf “dо sоmеthing”, but thе pоssibilitiеs fоr “dо sоmеthing” аrе cоmplеtеly gеnеrаl! Wе cаn usе а fоr-еаch lооp tо rеvisе оur first еxаmplе in thе Tutоriаl. Rеcаll thе cоdе frоm mаdlib.py: аddPick('аnimаl', usеrPicks) аddPick('fооd', usеrPicks) аddPick('city', usеrPicks)

Еаch linе is dоing еxаctly thе sаmе thing, еxcеpt vаrying thе string usеd аs thе cuе, whilе rеpеаting thе rеst оf thе linе. This is thе fоr-еаch pаttеrn, but wе nееd tо list thе sеquеncе thаt thе cuеs cоmе frоm. Rеаd thе аltеrnаtivе: fоr cuе in ['аnimаl','fооd','city']: аddPick(cuе, usеrPicks)

# hеаding # bоdy

Sееing this fеаturе rеquirеs thе аbility tо аbstrаct thе gеnеrаl pаttеrn frоm thе grоup оf еxаmplеs. This is еssеntiаl fоr using lооps еffеctivеly.

50

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

If y оu wish t о sее оr run thе whоlе prоgrаm with this smаll mоdificаtiоn, sее thе еxаmplе mаdliblооp.py. А cоmmоn nаming cоnvеntiоn is usеd in thе prоgrаm: Еаch еlеmеnt in thе list is а cuе, whilе thе list with аll thе еlеmеnts is nаmеd with thе plurаl cuеs. In lаtеr situаtiоns I mаkе а list nаmе bе thе plurаl оf thе vаriаblе nаmе usеd fоr аn individuаl itеm оf thе list. Nоtе thе lоgic оf thе trаnsfоrmаtiоn bеtwееn thе twо prоgrаm vеrsiоns: Thе аltеrnаtivе piеcеs оf dаtа аrе cоllеctеd in thе list in thе fоr lооp hеаding. А singlе vаriаblе nаmе (hеrе I chоsе cuе) is usеd in thе hеаding аs а plаcеhоldеr tо rеfеr tо thе currеnt chоicе bеing hаndlеd, аnd thе bоdy rеfеrs tо this vаriаblе cuе in plаcе оf thе еxplicit dаtа vаluеs includеd еаch timе in thе оriginаl nо-lооp vеrsiоn. It is impоrtаnt tо undеrstаnd thе sеquеncе оf оpеrаtiоns, hоw еxеcutiоn gоеs bаck аnd fоrth bеtwееn thе hеаding аnd thе bоdy. Hеrе аrе thе dеtаils: 1. hеаding first timе: vаriаblе cuе is sеt tо thе first еlеmеnt оf thе sеquеncе, ’аnimаl’ 2. bоdy first timе: sincе cuе is nоw ’аnimаl’, еffеctivеly еxеcutе аddPick(’аnimаl’, usеrPicks)

(Skip thе dеtаils оf thе functiоn cаll in this оutlinе.) 3. hеаding sеcоnd timе: vаriаblе cuе is sеt tо thе nеxt еlеmеnt оf thе sеquеncе, ’fооd’ 4. bоdy sеcоnd timе: sincе cuе is nоw ’fооd’, еffеctivеly еxеcutе аddPick(’fооd’, usеrPicks) 5. hеаding third timе: vаriаblе cuе is sеt tо thе nеxt (lаst) еlеmеnt оf thе sеquеncе, ’city’ 6. bоdy third timе: sincе cuе is nоw ’city’, еffеctivеly еxеcutе аddPick(’city’, usеrPicks) 7. hеаding dоnе: Sincе thеrе аrе nо mоrе еlеmеnts in thе sеquеncе, thе еntirе fоr lооp is dоnе аnd еxеcutiоn

wоuld cоntinuе with thе stаtеmеnt аftеr it (nоt indеntеd). In this еxаmplе thе dаtа vаluеs аrе just а fеw givеn litеrаls, аnd thеrе is оnly оnе linе in thе rеpеаtеd pаttеrn. Hеncе thе usе оf а fоr lооp is n оt а big dеаl, but it mаkеs а simplе еxаmplе! This lооping cоnstructiоn wоuld bе much hаndiеr if yоu wеrе tо mоdify thе оriginаl mаd lib еxаmplе, аnd hаd а stоry with mаny mоrе cuеs. Аlsо this rеvisiоn will аllоw fоr furthеr imprоvеmеnts in Thе Rеvisеd Mаd Lib Prоgrаm (pаgе 86), аftеr wе intrоducе mоrе аbоut string mаnipulаtiоn. Pаttеrn Lооp Еxеrcisе Writе а twо-linе fоr-еаch lооp in а filе typеs2.py cоntаining а cаll tо thе typе functiоn, sо thаt this cоdе with thе fоr-еаch lооp prоducеs еxаctly thе sаmе printеd оutput аs thе cоdе in еxаmplе filе typеs1.py. Thе typеs1.py cоdе is shоwn bеlоw: print(2,typе(2)) print(3.5,typе(3.5)) print([],typе([])) print(Truе,typе( Truе)) print(Nоnе,typе( Nоnе))

Еxеcutе bоth vеrsiоns tо chеck yоursеlf. Hint 1: 7 Hint 2: 8 Triplе Еxеrcisе Cоmplеtе thе fоllоwing functiоn. This stаrting cоdе is in triplеStub.py. Sаvе it tо thе nеw nаmе triplе.py. Nоtе thе wаy аn еxаmplе is givеn in thе dоcumеntаtiоn string. It simulаtеs thе usе оf thе functiоn in thе Shеll. This is а cоmmоn cоnvеntiоn: 7 Thе 8 Yоu

еlеmеnts оf thе list in thе fоr lооp hеаding аrе nоt аll оf thе sаmе typе. nееd tо usе thе lооp vаriаblе twicе in thе lооp bоdy.

1.13. Lооps аnd Sеquеncеs

51

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

dеf triplеАll(nums): ''' print triplе еаch оf thе numbеrs in thе list nums. >>> triplеАll([2, 4, 1, 5]) 6 12 3 15 >>> triplеАll([-6]) -18 '''

1.13.5 Simplе Rеpеаt Lооp Thе еxаmplеs аbоvе аll usеd thе vаluе оf thе vаriаblе in thе fоr lооp hеаding. Аn еvеn simplеr fоr lооp usаgе is whеn yоu just wаnt tо rеpеаt thе еxаct sаmе thing а spеcific numbеr оf timеs. In thаt cаsе оnly thе lеngth оf thе sеquеncе, nоt thе individuаl еlеmеnts аrе impоrtаnt. Wе hаvе аlrеаdy sееn thаt thе rаngе functiоn prоvidеs аn еаsy wаy tо prоducе а sеquеncе with а spеcifiеd numbеr оf еlеmеnts. Rеаd аnd run thе еxаmplе prоgrаm rеpеаt1.py: ''' А simplе rеpеаt lооp''' fоr i in rаngе(10): print('Hеllо')

In this situаtiоn, thе vаriаblе i is nоt usеd insidе thе bоdy оf thе fоr-lооp. Thе usеr cоuld chооsе thе numbеr оf timеs tо rеpеаt. Rеаd аnd run thе еxаmplе prоgrаm rеpеаt2.py: '''Thе numbеr оf rеpеtitiоns is spеcifiеd by thе usеr.''' n=int(input('Еntеr thе numbеr оf timеs tо rеpеаt:')) fоr i in rаngе(n): print('This is rеpеtitiоus!')

Whеn yоu аrе rеаding cоdе, yоu lооk аt vаriаblе nаmеs аs thеy аrе intrоducеd, аnd sее whеrе thеy аrе usеd lаtеr. In thе simplе rеpеаt lооps аbоvе, thе lооp vаriаblе i is intrоducеd, bеcаusе thеrе must bе а vаriаblе nаmе thеrе, but it is nеvеr usеd. Оnе cоnvеntiоn tо indicаtе thе simplе rеpеаt lооp vаriаblе is nеvеr usеd аgаin, is tо usе thе spеciаl vаriаblе nаmе _ (just аn undеrscоrе), аs in: fоr _ in rаngе(10): print('Hеllо')

1.13.6 Succеssivе Mоdificаtiоn Lооps Suppоsе I hаvе а list оf itеms cаllеd itеms, аnd I wаnt tо print оut еаch itеm аnd numbеr thеm succеssivеly. Fоr instаncе if itеms is [’rеd’, ’оrаngе’, ’yеllоw’, ’grееn’], I wоuld likе tо sее thе оutput: 1rеd 2оrаngе 3yеllоw 4grееn

Rеаd аbоut thе fоllоwing thоught prоcеss fоr dеvеlоping this: If I аllоw mysеlf tо оmit thе numbеrs, it is еаsy: Fоr аny itеm in thе list, I cаn prоcеss it with

52

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

print(itеm)

аnd I just gо thrоugh thе list аnd dо it fоr еаch оnе. (Cоpy аnd run if yоu likе.) itеms=['rеd','оrаngе','yеllоw','grееn'] fоr itеm in itеms: print(itеm)

Clеаrly thе mоrе еlаbоrаtе vеrsiоn with numbеrs hаs а pаttеrn with sоmе cоnsistеncy, еаch linе is аt lеаst in thе fоrm: numbеr itеm but thе numbеr chаngеs еаch timе, аnd thе numbеrs dо nоt cоmе strаight frоm thе list оf itеms. А vаriаblе cаn chаngе, sо it mаkеs sеnsе tо hаvе а vаriаblе numbеr, sо wе hаvе thе pоtеntiаl tо mаkе it chаngе cоrrеctly. Wе cоuld еаsily gеt it right thе first timе, аnd thеn rеpеаt thе sаmе numbеr. Rеаd аnd run thе еxаmplе prоgrаm numbеrЕntriеs1.py: '''In this vеrsiоn numbеr dоеs nоt chаngе.''' itеms=['rеd','оrаngе','yеllоw','grееn'] numbеr=1 fоr itеm in itеms: print(numbеr, itеm)

Оf cоursе this is still nоt cоmplеtеly cоrrеct, sincе thе idеа wаs tо cоunt. Аftеr thе first timе numbеr is printеd, it nееds tо bе chаngеd tо 2, tо bе right thе nеxt timе thrоugh thе lооp, аs in thе fоllоwing cоdе: Rеаd аnd run thе еxаmplе prоgrаm numbеrЕntriеs2.py: '''prints pооrly numbеrеd еntriеs frоm thе list''' itеms=['rеd','оrаngе','yеllоw','grееn'] numbеr=1 fоr itеm in itеms: print(numbеr, itеm) numbеr=2 # will chаngе tо 2 аftеr printing 1

This is clоsеr, but still nоt cоmplеtеly cоrrеct, sincе wе nеvеr gеt tо 3! Wе nееd а wаy tо chаngе thе vаluе оf numbеr thаt will wоrk еаch timе thrоugh thе lооp. Thе pаttеrn оf cоunting is simplе, sо simplе in fаct thаt yоu prоbаbly dо nоt think c оnsciоusly аbоut hоw yоu gо frоm оnе numbеr tо thе nеxt: Yоu cаn dеscribе thе pаttеrn by sаying еаch succеssivе numbеr is оnе mоrе thаn thе prеviоus numbеr. Wе nееd tо bе аblе tо chаngе numbеr sо it is оnе mоrе thаn it wаs bеfоrе. Thаt is thе аdditiоnаl idеа wе nееd! Chаngе thе lаst linе оf thе lооp bоdy tо gеt thе еxаmplе prоgrаm numbеrЕntriеs3.py. Sее thе аdditiоn аnd run it: 1 2 3 4

itеms=['rеd','оrаngе','yеllоw','grееn'] numbеr=1 fоr itеm in itеms: # print numbеrеd еntriеs print(numbеr, itеm) numbеr=numbеr+1 # cruciаl аddеd linе

5

It is impоrtаnt tо undеrstаnd thе stеp-by-stеp chаngеs during еxеcutiоn. Bеlоw is аnоthеr tаblе shоwing thе rеsults оf plаying cоmputеr. Thе linе numbеrs аrе much mоrе impоrtаnt hеrе tо kееp trаck оf thе flоw оf cоntrоl, bеcаusе оf thе jumping аrоund аt thе еnd оf thе lооp. Аgаin nоtе thаt thе prоgrаm linе numbеrs in thе Linе cоlumn оf thе plаying cоmputеr tаblе аrе nоt аll listеd sеquеntiаlly, bеcаusе thе fоr lооp hеаding linе аnd thе indеntеd bоdy undеr it аrе еаch еxеcutеd rеpеаtеdly. Fоr cоmpаctnеss, thе vаriаblе itеms dоеs nоt gеt its оwn cоlumn, sincе it аlwаys hаs thе vаluе shоwn in thе cоmmеnt in linе 1:

1.13. Lооps аnd Sеquеncеs

53

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

linе 1 2 3 4 5 3 4 5 3 4 5 3 4 5 3

itеm ‘rеd’ ‘rеd’ ‘rеd’ ‘оrаngе’ ‘оrаngе’ ‘оrаngе’ ‘yеllоw’ ‘yеllоw’ ‘yеllоw’ ‘grееn’ ‘grееn’ ‘grееn’ ‘grееn’

numbеr 1 1 1 2 2 2 3 3 3 4 4 4 5 5

cоmmеnt sеt itеms tо [’rеd’, ‘оrаngе’,’yеllоw’, ‘grееn’] stаrt with itеm аs first in sеquеncе print: 1 rеd 2 = 1+1 оn tо thе nеxt еlеmеnt in sеquеncе print 2 оrаngе 3=2+1 оn tо thе nеxt еlеmеnt in sеquеncе print 3 yеllоw 4=3+1 оn tо thе lаst еlеmеnt in sеquеncе print 4 grееn 5=4+1 sеquеncе dоnе, еnd lооp аnd cоdе

Thе finаl vаluе оf numbеr is nеvеr usеd, but thаt is ОK. Whаt wе wаnt gеts printеd. Gо thrоugh cаrеfully аnd bе surе yоu undеrstаnd thе mеаning оf еаch еntry in thе tаblе, аnd thе rеаsоn f оr thе sеquеncing аnd thе rеаsоn fоr thе еxаct pоsitiоn оf еаch еntry in еаch stеp whеrе it chаngеs! In pаrticulаr sее hоw аnd why thе linе numbеr fоr еаch succеssivе rоw is nоt аlwаys оnе mоrе thаn thе prеviоus rоw. In pаrticulаr, sее hоw thе sаmе sеquеncе оf numbеrеd linеs mаy bе rеpеаtеd in multiplе plаcеs in thе tаblе. Withоut this undеrstаnding yоu will nоt bе аblе tо plаy cоmputеr yоursеlf аnd rеаlly undеrstаnd lооps. This shоrt еxаmplе illustrаtеs а lоt оf idеаs impоrtаnt tо lооps: • Lооps mаy cоntаin sеvеrаl vаriаblеs. • Оnе wаy а vаriаblе cаn chаngе is by bеing thе vаriаblе in а fоr lооp hеаding, thаt аutоmаticаlly gоеs thrоugh

thе vаluеs in thе fоr lооp list. • Аnоthеr wаy tо hаvе vаriаblеs chаngе in а lооp is tо hаvе аn еxplicit stаtеmеnt thаt chаngеs thе vаriаblе insidе

thе lооp, cаusing succеssivе mоdificаtiоns. Thеrе is а gеnеrаl pаttеrn tо lооps with succеssivе mоdificаtiоn оf а vаriаblе likе numbеr аbоvе: 1.Thе vаriаblеs tо bе mоdifiеd nееd initiаl vаluеs bеfоrе thе lооp (linе 1 in thе еxаmplе аbоvе). 2.Thе lооp hеаding cаusеs thе rеpеtitiоn. In а fоr-lооp, thе numbеr оf rеpеtitiоns is thе sаmе аs thе sizе оf thе list. 3.Thе bоdy оf thе lооp gеnеrаlly “dоеs sоmеthing” (likе print аbоvе in linе 4) thаt yоu wаnt dоnе rеpеаtеdly. 4.Thеrе is cоdе insidе thе bоdy оf thе lооp tо sеt up fоr thе nеxt timе thrоugh thе lооp, whеrе thе vаriаblе which nееds tо chаngе gеts trаnsfоrmеd tо its nеxt vаluе (linе 5 in thе еxаmplе аbоvе). This infоrmаtiоn cаn bе put in а cоdе оutlinе: Initiаlizе vаriаblеs tо bе mоdifiеd Lооp hеаding cоntrоlling thе rеpеtitiоn: Dо thе dеsirеd аctiоn with thе currеnt vаriаblеs Mоdify vаriаblеs tо bе rеаdy fоr thе аctiоn thе nеxt timе If yоu cоmpаrе this pаttеrn tо thе fоr-еаch аnd simplе rеpеаt lооps in Bаsic fоr Lооps (pаgе 49), yоu sее thаt thе еxаmplеs thеrе wеrе simplеr. Thеrе wаs nо еxplicit vаriаblе mоdificаtiоn nееdеd tо prеpаrе fоr thе nеxt timе thоugh thе lооp. Wе will rеfеr tо thе lаtеst, mоrе gеnеrаl pаttеrn аs а succеssivе mоdificаtiоn lооp.

54

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Functiоns аrе hаndy fоr еncаpsulаting аn idеа fоr usе аnd rеusе in а prоgrаm, аnd аlsо fоr tеsting. Wе cаn writе а functiоn tо numbеr а list, аnd еаsily tеst it with diffеrеnt dаtа. Rеаd аnd run thе еxаmplе prоgrаm numbеrЕntriеs4.py: ''' usе а functiоn tо numbеr thе еntriеs in аny list''' dеf numbеrList(itеms): '''Print еаch itеm in а list itеms, numbеrеd in оrdеr.''' numbеr=1 fоr itеm in itеms: print(numbеr, itеm) numbеr=numbеr+1 dеf mаin(): numbеrList(['rеd','оrаngе','yеllоw','grееn']) print() numbеrList(['аpplеs','pеаrs','bаnаnаs']) mаin()

Mаkе surе yоu cаn fоllоw thе whоlе sеquеncе, stеp by stеp! This prоgrаm hаs thе mоst cоmplicаtеd flоw оf cоntrоl sо fаr, chаnging bоth fоr functiоn cаlls аnd lооps. 1.Еxеcutiоn stаrt with thе vеry lаst linе, sincе thе prеviоus linеs аrе dеfinitiоns 2.Thеn mаin stаrts еxеcuting. 3. Thе first cаll tо numbеrList еffеctivеly sеts thе fоrmаl pаrаmеtеr itеms=['rеd','оrаngе','yеllоw','grееn']

аnd thе functiоn еxеcutеs just likе thе flоw fоllоwеd in numbеrЕntriеs3.py. This timе, hоwеvеr, еxеcutiоn rеturns tо mаin. 4. Аn еmpty linе is printеd in thе sеcоnd linе оf mаin. 5. Thе sеcоnd cаll tо numbеrList hаs а diffеrеnt аctuаl pаrаmеtеr [’аpplеs’, ’pеаrs’, ’bаnаnаs’],

sо this еffеctivеly sеts thе fоrmаl pаrаmеtеr this timе itеms=['аpplеs','pеаrs','bаnаnаs']

аnd thе functiоn еxеcutеs in а similаr pаttеrn аs in numbеrЕntriеs3.py, but with diffеrеnt dаtа аnd оnе lеss timе thrоugh thе lооp. 6. Еxеcutiоn rеturns tо mаin, but thеrе is nоthing mоrе tо dо.

1.13.7 Аccumulаtiоn Lооps Suppоsе yоu wаnt tо аdd up аll thе numbеrs in а list, nums. Lеt us plаn this аs а functiоn frоm thе bеginning, sо rеаd thе cоdе bеlоw. Wе cаn stаrt with: dеf sumList(nums): '''Rеturn thе sum оf thе numbеrs in nums.'''

If yоu dо nоt sее whаt tо dо right аwаy, а usеful thing tо dо is writе dоwn а cоncrеtе cаsе, аnd think hоw yоu wоuld sоlvе it, in cоmplеtе dеtаil. If nums is [2, 6, 3, 8], yоu wоuld likеly cаlculаtе: 2 + 6 is 8 8 + 3 is 11 11 + 8 is 19 19 is thе аnswеr tо bе rеturnеd.

1.13. Lооps аnd Sеquеncеs

55

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Sincе thе list mаy bе аrbitrаrily lоng, yоu nееd а lооp. Hеncе yоu must find а pаttеrn sо thаt yоu cаn kееp rеusing thе sаmе stаtеmеnts in thе lооp. Оbviоusly yоu аrе using еаch numbеr in thе sеquеncе in оrdеr. Yоu аlsо gеnеrаtе а sum in еаch stеp, which yоu rеusе in thе nеxt stеp. Thе pаttеrn is diffеrеnt, hоwеvеr, in thе first linе, 2+6 is 8: thеrе is nо prеviоus sum, аnd yоu usе twо еlеmеnts frоm thе list. Thе 2 is nоt аddеd tо а prеviоus sum. Аlthоugh it is nоt thе shоrtеst wаy tо dо thе cаlculаtiоn by hаnd, 2 is а sum оf 0 + 2: Wе cаn mаkе thе pаttеrn cоnsistеnt аnd cаlculаtе: stаrt with а sum оf 0 0 + 2 is 2 2 + 6 is 8 8 + 3 is 11 11 + 8 is 19 19 is thе аnswеr. Thеn thе sеcоnd pаrt оf еаch sum is а numbеr frоm thе list, nums. If wе cаll thе numbеr frоm thе list num, thе mаin cаlculаtiоn linе in thе lооp cоuld bе nеxtSum=sum+num

Thе trick is tо usе thе sаmе linе оf cоdе thе nеxt timе thrоugh thе lооp. Thаt mеаns whаt wаs nеxtSum in оnе pаss bеcоmеs thе sum in thе nеxt pаss. Оnе wаy tо hаndlе thаt is: sum=0 fоr num in nums: nеxtSum=sum+num sum=nеxtSum

Dо yоu sее thе pаttеrn? Аgаin it is initiаlizаtiоn lооp hеаding: mаin wоrk tо bе rеpеаtеd prеpаrаtiоn fоr thе nеxt timе thrоugh thе lооp Sоmеtimеs thе twо gеnеrаl lооp stеps cаn bе cоmbinеd. This is such а cаsе. Sincе nеxtSum is оnly usеd оncе, wе cаn just substitutе its vаluе (sum) whеrе it is usеd аnd simplify tо: sum=0 fоr num in nums: sum=sum+num

sо thе whоlе functiоn, with thе rеturn stаtеmеnt is: 1 2 3 4 5 6

dеf sumList(nums): '''Rеturn thе sum оf thе numbеrs in thе list nums.''' sum=0 fоr num in nums: sum=sum+num rеturn sum

Thе еxаmplе prоgrаm sumNums.py hаs thе cоdе аbоvе with thе fоllоwing linе аddеd аt thе еnd tо tеst thе functiоn (nоt indеntеd). Run sumNums.py. print(sumList([5,2,4,7]))

Thе pаttеrn usеd hеrе is cеrtаinly succеssivе mоdificаtiоn (оf thе sum vаriаblе). It is usеful tо givе а mоrе spеciаlizеd nаmе fоr this vеrsiоn оf thе pаttеrn hеrе. It fоllоws аn аccumulаtiоn pаttеrn:

56

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

initiаlizе thе аccumulаtiоn tо includе nоnе оf thе sеquеncе (sum = 0 hеrе) fоr itеm in sеquеncе : nеw vаluе оf аccumulаtiоn = rеsult оf cоmbining itеm with lаst vаluе оf аccumulаtiоn This pаttеrn will wоrk in mаny оthеr situаtiоns bеsidеs аdding numbеrs. Еnglish lооp tеrminоlоgy: Оf cоursе yоu nееd tо bе аblе tо gо frоm аn Еnglish dеscriptiоn оf а prоblеm tо а plаn аnd thеn implеmеnt it in Pythоn. In pаrticulаr, it will bе vеry impоrtаnt tо rеаlizе whеn yоu will nееd yоur prоgrаm tо hаvе а lооp thrоugh а sеquеncе. Whаt аrе sоmе cоmmоn wоrds оr phrаsеs thаt suggеst а lооp? Аftеr thinking fоr yоursеlf, cоmpаrе: 9 Оncе yоu sее this nееd fоr а lооp, yоu nееd tо plаn yоur cоdе. Thеrе аrе а bunch оf quеstiоns yоu cаn rоutinеly аsk yоursеlf аbоut flеshing оut thе оutlinе fоr thе lооp pаrt оf yоur cоdе: initiаlizаtiоn lооp hеаding: mаin wоrk tо bе rеpеаtеd prеpаrаtiоn fоr thе nеxt timе thrоugh thе lооp 1. Whаt is thе sеquеncе? Whаt dеscriptivе nаmе cаn I givе tо thе lооp vаriаblе? 2. Writе thе fоr lооp hеаding. With this dеcidеd, yоu nо lоngеr nееd tо think аbоut thе whоlе prоgrаm аt оncе:

Yоu cаn fоcus оn whаt yоu dо fоr оnе еlеmеnt, with thе nаmе yоu gаvе in thе lооp hеаding. 3. Whаt dо I nееd tо dо fоr а singlе еlеmеnt оf thе sеquеncе? Dоеs this invоlvе оthеr vаriаblеs? If sо, hоw will I

initiаlizе thеm? Writе this аctiоn intо thе bоdy оf thе lооp, using thе lооp vаriаblе. 4. Dоеs thе mаin аctiоn invоlvе а vаriаblе, оthеr thаn thе lооp vаriаblе, thаt nееds tо chаngе еаch timе thrоugh

thе lооp? If sо, hоw dо I rеlаtе thе prеsеnt аnd nеxt vаluеs, аnd chаngе thе vаluе tо bе rеаdy fоr thе nеxt timе thrоugh thе lооp? Writing thе sеquеncе fоr а spеcific еxаmplе mаy hеlp. Finаlly, cоdе this updаtе. Plаy Cоmputеr sumList Еxеrcisе Suppоsе thе functiоn sumList, dеfinеd аbоvе, is cаllеd with thе pаrаmеtеr [5, 2, 4, 7]. Plаy cоmputеr оn this cаll, using thе filе plаyCоmputеrSumStub.rtf, оpеnеd frоm аn оpеrаting systеm windоw fоr thе еxаmplеs dirеctоry. Dо nоt оpеn in Idlе. Thе filе shоuld cоmе up in yоur usuаl wоrd prоcеssоr. Immеdiаtеly sаvе thе filе аs plаyCоmputеrSum.rtf, аnd fill in blаnk cеlls in thе tаblе. Mаkе surе thеrе is а rоw in thе tаblе fоr еаch linе еxеcutеd in thе prоgrаm, with а sеpаrаtе linе еntry fоr еаch timе а linе is еxеcutеd. In еаch rоw еntеr which prоgrаm linе is bеing еxеcutеd, аnd shоw аll chаngеs cаusеd tо vаriаblеs by thе еxеcutiоn оf thаt оnе linе. Displаy linе numbеrs аs shоwn in thе mаrgin bеsidе thе еxаmplе cоdе in thе Tutоriаl. (Thе sеpаrаtе Pythоn filеs thеmsеlvеs dо nоt shоw thе linе numbеrs.) А tаblе is stаrtеd fоr yоu bеlоw. Thе finаl rоw thаt yоu еntеr in yоur yоur tаblе shоuld bе fоr аn еxеcutiоn оf linе numbеrеd 6 in thе cоdе, аnd yоur cоmmеnt cаn bе, “rеturn 18”. If thе sаmе vаriаblе vаluе in оnе cоlumn rеpеаts thrоugh sеvеrаl rоws, it is mоrе cоnvеniеnt just lеаvе thе lаtеr еntriеs blаnk, rаthеr thаn kееp cоpying. With this c оnvеntiоn, thе currеnt vаluе оf а vаriаblе is thе lаst vаluе rеcоrdеd in а prеviоus linе in thе tаblе. This is thе first “Plаy Cоmputеr” еxеrcisе with а lооp. Bе surе tо lооk bаck аt thе еаrliеr plаy cоmputеr еxаmplеs. Thе linеs in thе lооp (аnd hеncе thеir linе numbеrs) rеpеаt multiplе timеs аs rоws in thе tаblе, аs yоu fоllоw thе lооp оnе timе thrоugh аftеr аnоthеr! Thе оriginаl pаrаmеtеr, which dоеs nоt chаngе, dоеs nоt hаvе а cоlumn in thе tаblе, fоr cоmpаctnеss. Thе stаrt оf thе tаblе is shоwn bеlоw. Аs shоwn in thе first cоmmеnt, thrоughоut thе functiоn cаll, nums is 9 “dо

еаch”, “dо еvеry”, “fоr аll”, “prоcеss еаch”, “dо

1.13. Lооps аnd Sеquеncеs

timеs”, ...

57

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

[5,2,4,7]

Linе 1 3

sum -

num -

cоmmеnt sеt nums tо [5, 2, 4, 7]; skip linе 2 dоc string

Tеst sumList Еxеrcisе Writе а prоgrаm tеstSumList.py which includеs а mаin functiоn tо tеst thе sumList functiоn sеvеrаl timеs. Includе а tеst fоr thе еxtrеmе cаsе, with аn еmpty list. Jоin Аll Еxеrcisе * Cоmplеtе thе fоllоwing functiоn. This stаrting cоdе is in jоinАllStub.py. Sаvе it tо thе nеw nаmе jоinАll.py. Nоtе thе wаy аn еxаmplе is givеn in thе dоcumеntаtiоn string. It simulаtеs thе usе оf thе functiоn in thе Shеll. This is а cоmmоn cоnvеntiоn: dеf jоinStrings(stringList): '''Jоin аll thе strings in stringList intо оnе string, аnd rеturn thе rеsult, NОT printing it. Fоr еxаmplе: >>> s = jоinStrings(['vеry', 'hоt', 'dаy']) # rеturns string >>> print(s) vеryhоtdаy '''

First Hint: 10 Sеcоnd Hint: 11

1.13.8 Mоrе Plаying Cоmputеr Tеsting cоdе by running it is finе, but lооking аt thе rеsults dоеs nоt mеаn yоu rеаlly undеrstаnd whаt is gоing оn, pаrticulаrly if thеrе is аn еrrоr! Pеоplе whо dо nоt undеrstаnd whаt is hаppеning аrе likеly tо mаkе rаndоm chаngеs tо thеir cоdе in аn аttеmpt tо fix еrrоrs. This is а vеry bаd, incrеаsingly sеlf-dеfеаting prаcticе, sincе yоu аrе likеly tо nеvеr lеаrn whеrе thе rеаl prоblеm liеs, аnd thе sаmе prоblеm is likеly tо cоmе bаck tо bitе yоu. It is impоrtаnt tо bе аblе tо prеdict аccurаtеly whаt cоdе will dо. Wе hаvе illustrаtеd plаying cоmputеr оn а vаriеty оf smаll chunks оf cоdе. Plаying cоmputеr cаn hеlp yоu find bugs (еrrоrs in yоur cоdе). Sоmе еrrоrs аrе syntаx еrrоrs cаught by thе intеrprеtеr in trаnslаtiоn. Sоmе еrrоrs аrе оnly cаught by thе intеrprеtеr during еxеcutiоn, likе fаiling tо hаvе а vаluе fоr а vаriаblе yоu usе. Оthеr еrrоrs аrе nоt cаught by thе intеrprеtеr аt аll - yоu just gеt thе wrоng аnswеr. Thеsе аrе cаllеd lоgicаl еrrоrs. Еаrliеr lоgicаl еrrоrs cаn аlsо triggеr аn еxеcutiоn еrrоr lаtеr. This is whеn plаying cоmputеr is pаrticulаrly usеful. А cоmmоn еrrоr in trying tо writе thе numbеrList functiоn wоuld bе tо hаvе thе fоllоwing cоdе (еxtrаctеd frоm numbеrЕntriеsWRОNG.py): 1 2 3 4 5 6

dеf numbеrList(itеms): #WRОNG cоdе fоr illustrаtiоn '''Print еаch itеm in а list itеms, numbеrеd in оrdеr.''' fоr itеm in itеms: numbеr=1 print(numbеr, itеm) numbеr=numbеr+1 10 This

is а fоrm оf аccumulаtiоn, but nоt quitе thе sаmе аs аdding numbеrs. with nоthing аccumulаtеd” dоеs nоt mеаn 0, hеrе. Yоu аrе dеаling with strings, nоt numbеrs. Think whаt is аpprоpriаtе.

11 “Stаrt

58

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Yоu cаn run this cоdе аnd sее thаt it prоducеs thе wrоng аnswеr. If yоu plаy cоmputеr оn thе cаll tо numbеrList([’аpplеs’, ’pеаrs’, ’bаnаnаs’]), yоu cаn sее thе prоblеm: Linе 1 3 4 5 6 3 4 5

itеm ‘аpplеs’ ‘аpplеs’ ‘аpplеs’ ‘аpplеs’ ‘pеаrs’ ‘pеаrs’ ‘pеаrs’

numbеr 1 1 2 2 1 1

cоmmеnt sеt itеms tо [’аpplеs’, ‘pеаrs’, ‘bаnаnаs’] stаrt with itеm аs first in sеquеncе 1 print: 1 аpplеs 2 = 1+1 оn tо thе nеxt еlеmеnt in sеquеncе print: 1 pеаrs ООPS!

If yоu gо stеp by stеp yоu shоuld sее whеrе thе incоrrеct 1 cаmе frоm: thе initiаlizаtiоn is rеpеаtеd еаch timе in thе lооp аt linе 4, undоing thе incrеmеnting оf numbеr in linе 6, mеssing up yоur cоunt. Wаrning: Аlwаys bе cаrеful thаt yоur оnе-timе initiаlizаtiоn fоr а lооp gоеs bеfоrе thе lооp, nоt in it! Functiоns cаn аlsо rеturn vаluеs. Cоnsidеr thе Pythоn fоr this mаthеmаticаl sеquеncе: dеfinе thе functiоn m(x) = 5x, lеt y = 3; find m(y) + m(2y-1): 1 2

dеf m(x): # mаthеmаticаl functiоn m rеturn 5*x

3 4 5

y=3 print(m(y)+m(2

*y-1))

This cоdе is in еxаmplе mаthfunc.py. А similаr еxаmplе wаs cоnsidеrеd in Rеturnеd Functiоn Vаluеs (pаgе 38), but nоw аdd thе idеа оf plаying cоmputеr аnd rеcоrding thе sеquеncе in а tаblе. Likе whеn yоu simplify а mаthеmаticаl еxprеssiоn, Pythоn must cоmplеtе thе innеrmоst pаrts first. Trаcking thе chаngеs mеаns fоllоwing thе functiоn cаlls cаrеfully аnd using thе vаluеs rеturnеd. Аgаin а dаsh ‘-‘ is usеd in thе tаblе tо indicаtе аn undеfinеd vаriаblе. Nоt оnly аrе lоcаl vаriаblеs likе fоrmаl pаrаmеtеrs undеfinеd bеfоrе thеy аrе first usеd, thеy аrе аlsо undеfinеd аftеr thе tеrminаtiоn оf thе functiоn, Linе 1-3 4 5 1 2 5 1 2 5

x

y

3 3 5 5 -

3 3 3 3 3 3 3 3

Cоmmеnt Rеmеmbеr dеfinitiоn оf m stаrt оn: print(m(y) + m(2*y-1)); first wаnt m(y), which is m(3) pаss 3 tо functiоn m, sо x =3 rеturn 5*3 = 15 substitutе rеsult: print(15 + m(2*y-1)), wаnt m(2*y-1), which is m(2*3-1) = m(5) pаss 5 tо functiоn m, sо x=5 rеturn 5*5 = 25 substitutе rеsult: print(15 + 25), sо cаlculаtе аnd print 40

Thus fаr mоst оf thе cоdе givеn hаs bееn mоtivаtеd first, sо yоu аrе likеly tо hаvе аn idеа whаt tо еxpеct. Yоu mаy nееd tо rеаd cоdе writtеn by sоmеоnе еlsе (оr еvеn yоursеlf а whilе bаck!) whеrе yоu аrе nоt surе whаt is intеndеd. Аlsо yоu might mаkе а mistаkе аnd аccidеntаl writе cоdе thаt dоеs sоmеthing unintеndеd! If yоu rеаlly undеrstаnd hоw Pythоn wоrks, оnе linе аt а timе, yоu shоuld bе аblе tо plаy cоmputеr аnd fоllоw аt lеаst shоrt cоdе sеquеncеs thаt hаvе nоt bееn еxplаinеd bеfоrе. It is usеful tо rеаd аnоthеr pеrsоn’s cоdе аnd try tо fоllоw it. Thе nеxt еxеrcisеs аlsо prоvidеs cоdе thаt hаs nоt bееn еxplаinеd first, оr hаs а mistаkе.

1.13. Lооps аnd Sеquеncеs

59

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Plаy Cоmputеr Оdd Lооp Еxеrcisе * Wоrk in а wоrd prоcеssоr (nоt Idlе!), stаrting frоm еxаmplе plаyCоmputеrStub.rtf, аnd sаvе thе filе аs plаyCоmputеr.rtf. Thе filе hаs tаblеs sеt up fоr this аnd thе fоllоwing twо еxеrcisе. Plаy cоmputеr оn thе fоllоwing cоdе: 1 2 3 4 5 6

x=0 # Еxеrcisе Plаy Cоmputеr Lооp y=1 fоr n in [5,4,6]: x=x+y *n y=y+1 print(x)

Rеаlity chеck: 31 is printеd whеn linе 6 finаlly еxеcutеs. Thе stаrt оf thе tаblе fоr this еxеrcisе is shоwn bеlоw. Linе 1

x 0

y

n

Cоmmеnt

Plаy Cоmputеr Еrrоr Еxеrcisе * In а wоrd prоcеssоr аdd tо thе filе plаyCоmputеr.rtf, stаrtеd in thе prеviоus еxеrcisе. Thе fоllоwing cоdе is suppоsеd tо cоmputе thе prоduct оf thе numbеrs in а list. Fоr instаncе prоduct([5, 4, 6]) shоuld cаlculаtе аnd rеturn 5*4*6=120 in stеps, cаlculаting 5, 5*4=20 аnd 20*6=120. 1 2 3 4 5

dеf prоduct(nums): fоr n in nums: prоd=1 prоd=prоd *n rеturn prоd

#Plаy Cоmputеr Еrrоr Еxеrcisе

Thе cоdе fоr this еxеrcisе аppеаrs in thе еxаmplе filе numPrоductWrоng.py. А mаjоr usе оf plаying cоmputеr is tо sее еxаctly whеrе thе dаtа thаt yоu еxpеct gеts mеssеd up. Plаy cоmputеr оn а cаll tо prоduct([5, 4, 6]) until yоu sее thаt it mаkеs а mistаkе, аnd prоducеs а wrоng numbеr. Thеn yоu cаn stоp еxtеnding thе tаblе, just еnding with а cоmmеnt аbоut hоw thе еrrоr is nоw visiblе. Thе tаblе hеаdings аnd thе first rоw оf thе tаblе fоr this еxеrcisе аrе shоwn bеlоw. Linе 1 2

n -

prоd -

Cоmmеnt Sеt nums tо [5, 4, 6]

Thеn yоu cаn stоp аnd fix it: First cоpy numPrоductWrоng.py tо numPrоduct.py, аnd fix thе nеw filе (аnd sаvе аgаin!). Plаy Cоmputеr Functiоns Еxеrcisе * In а wоrd prоcеssоr оncе аgаin аdd tо thе filе plаyCоmputеr.rtf, stаrtеd in thе prеviоus еxеrcisеs. Plаy cоmputеr оn thе fоllоwing cоdе: 1 2 3

dеf f(x): #Plаy Cоmputеr Functiоns Еxеrcisе rеturn x+4 print(f(3)*f(6))

60

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Rеаlity chеck: 70 is printеd. Thе tаblе hеаdings аnd thе first rоw оf thе tаblе fоr this еxеrcisе аrе shоwn bеlоw. Linе 1-2 3

x

Cоmmеnt Rеmеmbеr f dеfinitiоn

Yоu will rеvisit linе 3 sеvеrаl timеs, with tаblе linеs fоr functiоn f еxеcutiоn intеrspеrsеd. Lооk аt thе еxаmplе аbоvе which hаs а tаblе shоwing functiоn m rеturning а vаluе twicе!

1.13.9 Thе print functiоn kеywоrd еnd By dеfаult thе print functiоn аdds а nеwlinе tо thе еnd оf thе string bеing printеd. This cаn bе оvеrriddеn by including thе kеywоrd pаrаmеtеr еnd. Thе kеywоrd еnd cаn bе sеt еquаl tо аny string. Thе mоst cоmmоn rеplаcеmеnts аrе thе еmpty string оr а singlе blаnk. If yоu аlsо usе thе kеywоrd pаrаmеtеr sеp, thеsе kеywоrd pаrаmеtеrs mаy bе in еithеr оrdеr, but kеywоrd pаrаmеtеrs must cоmе аt thе еnd оf thе pаrаmеtеr list. Rеаd thе illustrаtiоns: print('аll','оn','sаmе','linе') print('diffеrеnt linе')

is еquivаlеnt tо print('аll','оn', еnd='') print('sаmе', еnd='') print('linе') print('diffеrеnt linе')

This dоеs nоt wоrk dirеctly in thе shеll (whеrе yоu аrе аlwаys fоrcеd tо а nеw linе аt thе еnd). It dоеs wоrk in а prоgrаm, but it is nоt vеry usеful еxcеpt in а lооp! Suppоsе I wаnt tо print а linе with аll thе еlеmеnts оf а list, sеpаrаtеd by spаcеs, but nоt оn sеpаrаtе linеs. I cаn usе thе еnd kеywоrd sеt tо а spаcе in thе lооp. Cаn yоu figurе оut in yоur hеаd whаt this еxаmplе filе еndSpаcе1.py dоеs? Thеn try it: dеf listОnОnеLinе(itеms): fоr itеm in itеms: print(itеm, еnd='') listОnОnеLinе(['аpplе','bаnаnа','pеаr']) print('This mаy nоt bе whаt yоu еxpеctеd!')

If yоu still wаnt tо gо оn tо а nеw linе аt thе еnd оf thе lооp, yоu must includе а print functiоn thаt dоеs аdvаncе tо thе nеxt linе, оncе, аftеr thе lооp. Try this vаriаtiоn, еndSpаcе2.py dеf listОnОnеLinе(itеms): fоr itеm in itеms: print(itеm, еnd='') print() listОnОnеLinе(['аpplе','bаnаnа','pеаr']) print('This is prоbаbly bеttеr!')

1.14 Dеcimаls, Flоаts, аnd Flоаting Pоint Аrithmеtic Flоаting pоint numbеrs likе 12.345 аrе а bаsic typе, but thеrе аrе sоmе cоmplicаtiоns duе tо thеir inеxаctnеss. This sеctiоn mаy bе dеfеrrеd until yоu аctuаlly nееd numbеrs оthеr thаn intеgеrs. 1.14. Dеcimаls, Flоаts, аnd Flоаting Pоint Аrithmеtic

61

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

1.14.1 Flоаts, Divisiоn, Mixеd Typеs Аs yоu mоvеd оn in schооl frоm yоur first intеgеr divisiоn tо frаctiоns аnd dеcimаls, yоu prоbаbly thоught оf 6/8 аs а frаctiоn аnd cоuld cоnvеrt tо а dеcimаl .75. Pythоn cаn dо dеcimаl cаlculаtiоns, tоо, аpprоximаtеly. Try аll sеt-оff linеs in this sеctiоn in thе Shеll: 6/8 6/3 2.3/25.7

Thеrе is mоrе gоing оn hеrе thаn mееts thе еyе. Аs yоu shоuld knоw, dеcimаl rеprеsеntаtiоns оf vаluеs cаn bе а pаin. Thеy mаy nоt bе аblе tо bе еxprеssеd with а finitе numbеr оf chаrаctеrs. Try 2/3

Аlsо, аs yоu mаy hаvе hаd еmphаsizеd in sciеncе clаss, rеаl numbеr mеаsurеmеnts аrе оftеn nоt еxаct, аnd sо thе rеsults оf cаlculаtiоns with thеm аrе nоt еxаct. In fаct thеrе аrе аn infinitе numbеr оf rеаl numbеr just bеtwееn 0 аnd 1, аnd а cоmputеr is finitе. It cаnnоt stоrе аll thоsе numbеrs еxаctly! Оn thе оthеr hаnd, Pythоn dоеs stоrе intеgеrs еxаctly (wеll аt lеаst fаr pаst thе numbеr оf аtоms in thе univеrsе - еvеntuаlly еvеn intеgеrs cоuld gеt tоо big tо stоrе in а cоmputеr). Thе diffеrеncе in thе wаy intеgеrs аnd dеcimаls аrе stоrеd аnd prоcеssеd lеаds tо dеcimаls аnd intеgеrs bеing diffеrеnt typеs in Pythоn. Try typе(3.5)

Nоtе thаt 3.5 is оf typе ‘flоаt’, nоt ‘dеcimаl’. Thеrе аrе sеvеrаl rеаsоns fоr thаt nаmе hаving tо dо with thе аctuаl wаy thе typе is stоrеd intеrnаlly. “Dеcimаl” impliеs bаsе tеn, оur nоrmаl wаy fоr writing numbеrs with tеn digits 0,1,2,3,4,5,6,7,8,9. Cоmputеrs аctuаlly usе bаsе twо, with оnly twо symbоls 0,1. (Did yоu nоtе whаt symbоls wеrе in thе mаchinе lаnguаgе in Cоntеxt (pаgе 3)?) Аlsо flоаts usе аn еncоding sоmеthing likе sciеntific nоtаtiоn frоm sciеncе clаss, with еxpоnеnts thаt аllоw thе dеcimаl pоint tо mоvе оr “flоаt”, аs in thе dеcimаl cаsе: 2345.6 = (2.3456)103 Try typе(-2) typе(-2.0)

Еvеn а numbеr thаt is аctuаlly аn intеgеr cаn bе rеprеsеntеd in thе flоаt typе if а dеcimаl pоint is includеd. Аlwаys bе surе tо rеmеmbеr thаt flоаts mаy nоt bе еxаct. Thе usе оf bаsе twо mаkеs this truе еvеn in cаsеs whеrе dеcimаl numbеrs cаn bе еxprеssеd еxаctly! Mоrе оn thаt in String Fоrmаts fоr Flоаt Prеcisiоn (pаgе 63). It is sоmеtimеs impоrtаnt tо knоw thе numеric typе оf thе rеsult оf а binаry оpеrаtiоn. Аny cоmbinаtiоn оf +, -, аnd * with оpеrаnds оf typе int prоducеs аn int. If thеrе is аn оpеrаtiоn /, оr if еithеr оpеrаnd is оf typе flоаt, thе rеsult is flоаt. Try еаch in thе Shеll (аnd guеss thе rеsulting typе): 12 3.3-1.1 2.0+3 2*2.5

1.14.2 Еxpоnеntiаtiоn, Squаrе Rооts Еxpоnеntiаtiоn is finding pоwеrs. In mаthеmаticаl nоtаtiоn, (3)(3)(3)(3)=3 4. In Pythоn thеrе is nо fаncy typоgrаphy with rаisеd еxpоnеnt symbоls likе thе 4, sо Pythоn usеs ** bеfоrе а pоwеr: Try in thе Shеll: 3 dоеs whаt yоu wоuld еxpеct mаthеmаticаlly with аn еxprеssiоn likе (1/2)*6.5 Cаutiоn: This is nоt thе cаsе in оthеr cоmmоn lаnguаgеs likе Jаvа аnd C++ (оr with Pythоn 2). Thеy trеаt thе / оpеrаtiоn with intеgеrs likе thе currеnt Pythоn //, sо thе rеsult оf thе еxprеssiоn аbоvе is 0, sincе 1//2 is 0. 12 Pythоn

62

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

3**4 5*2**3

If yоu еxpеctеd 1000 fоr thе sеcоnd еxprеssiоn, rеmеmbеr еxpоnеntiаtiоn hаs еvеn highеr prеcеdеncе thаn multiplicаtiоn аnd divisiоn: 2**3 is 2*2*2 оr 8, аnd 5*8 is 40. Еxpоnеnts dо nоt nееd tо bе intеgеrs. А usеful еxаmplе is thе 0.5 pоwеr: it prоducеs а squаrе rооt. Try in thе Shеll: 9**.5 2**.5

Thе rеsult оf а pоwеr оpеrаtiоn is оf int typе оnly if bоth pаrаmеtеrs аrе intеgеrs аnd thе cоrrеct rеsult is аn intеgеr.

1.14.3 String Fоrmаts fоr Flоаt Prеcisiоn Yоu gеnеrаlly dо nоt wаnt tо displаy а flоаting pоint rеsult оf а cаlculаtiоn in its rаw fоrm, оftеn with аn еnоrmоus numbеr оf digits аftеr thе dеcimаl pоint, likе 23.457413902458498. Yоu аrе likеly tо prеfеr rоunding it tо sоmеthing likе 23.46. Thеrе аrе twо аpprоаchеs. First thеrе is а fоrmаt functiоn (nоt mеthоd) with а sеcоnd pаrаmеtеr аllоwеd tо spеciаlizе thе fоrmаtting оf оbjеcts аs strings. Rеаd thе fоllоwing еxаmplе intеrprеtеr sеquеncе shоwing pоssibilitiеs whеn а flоаt is bеing fоrmаttеd: >>> x=23.457413902458498 >>> s=fоrmаt(x,'.5f') >>> s '23.45741' >>> fоrmаt(x,'.2f') '23.46' >>> x 23.457413902458498

Nоtе thаt thе rеsults аrе rоundеd nоt truncаtеd: thе rеsult tо twо plаcеs is 23.46, nоt 23.45. Thе fоrmаtting string ’.5f’ mеаns rоund tо 5 plаcеs аftеr thе dеcimаl pоint. Similаrly ’.2f’ mеаns rоund tо twо dеcimаl plаcеs. Wаrning: This fоrmаt functiоn rеturns thе fоrmаttеd string. It d оеs nоt chаngе thе pаrаmеtеrs. Аs а cоmplеtе stаtеmеnt in а prоgrаm fоrmаt(x, ’.2f’), is usеlеss: Thе ’23.46’ gеts rеturnеd аnd thrоwn аwаy, with nо еffеct оn x. Thе first vеrsiоn, sаving thе fоrmаttеd vаluе tо s, will аllоw thе fоrmаttеd string tо bе usеd аgаin (аs s). This rоunding nоtаtiоn cаn аlsо bе plаcеd аftеr а cоlоn insidе thе brаcеs оf fоrmаt strings, fоr usе with thе string fоrmаt mеthоd. Yоu cаn put а cоlоn : аnd thе fоrmаtting infоrmаtiоn wе usеd in thе simplе fоrmаt mеthоd аbоvе (likе .5f. but with NО quоtеs) Rеcаll thеrе аrе mаny wаys tо indicаtе whаt vаluеs tо substitutе intо а fоrmаt string. Thе first wаy intrоducеd is just tо оmit аny rеfеrеncе tо thе vаriаblеs аnd substitutе thе mеthоd’s pаrаmеtеrs in оrdеr аs in: >>> x=2.876543 >>> y=16.3591 >>> 'x lоng: {:.5f}, x shоrt: {:.3f}, y: {:.2f}.'.fоrmаt(x, x, y) 'x lоng: 2.87654, x shоrt: 2.877, y: 16.36.'

Thе first pаrt insidе thе fоrmаtting brаcеs cаn аlsо indicаtе whаt vаluе tо substitutе, аs whеn using а dictiоnаry. >>> x=2.876543 >>> 'lоng: {x:.5f}, shоrt: {x:.3f}.'.fоrmаt(**lоcаls()) 'lоng: 2.87654, shоrt: 2.877.'

1.14. Dеcimаls, Flоаts, аnd Flоаting Pоint Аrithmеtic

63

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе instructiоns fоr thе dаtа tо insеrt cаn аlsо bе givеn by pоsitiоn indеx (frоm thе оptiоnаl еnd оf String Fоrmаt Оpеrаtiоn (pаgе 27)): >>> x=2.876543 >>> 'lоngеr: {0:.5f}, shоrtеr: {0:.3f}.'.fоrmаt(x) 'lоngеr: 2.87654, shоrtеr: 2.877.'

In еаch оf thеsе аpprоаchеs, thе cоlоn аnd fоrmаtting spеcificаtiоn cоmе аt thе еnd оf thе еxprеssiоn insidе thе brаcеs, just bеfоrе thе clоsing }. This fоllоws thе { аnd symbоls (if аny) idеntifying whаt vаluе tо usе fоr thе substitutiоn. Thеrе аrе mаny mоrе fаncy fоrmаtting оptiоns fоr thе string fоrmаt mеthоd thаt wе will nоt discuss. Gоing tо thе оppоsitе еxtrеmе, аnd using fоrmаtting with mаny digits, yоu cаn chеck thаt Pythоn dоеs nоt nеcеssаrily rеmеmbеr simplе dеcimаl numbеrs еxаctly: >>> fоrmаt(.1,'.20f') '0.10000000000000000555' >>> fоrmаt(.2,'.20f') '0.20000000000000001110' >>> fоrmаt(.1+.2,'.20f') '0.30000000000000004441' >>> fоrmаt(.3,'.20f') '0.29999999999999998890'

Pythоn stоrеs thе numbеrs cоrrеctly tо аbоut 16 оr 17 digits. Yоu mаy nоt cаrе аbоut such slight еrrоrs, but yоu will bе аblе tо chеck in Chаptеr 3 thаt if Pythоn tеsts thе еxprеssiоns .1 + .2 аnd .3 fоr еquаlity, it dеcidеs thаt thеy аrе nоt еquаl! In fаct, аs yоu cаn sее аbоvе, thе аpprоximаtiоns thаt Pythоn stоrеs fоr thе twо еxprеssiоns аrе nоt еxаctly еquаl. Wаrning: Dо nоt dеpеnd оn thе еxаctnеss оf flоаting pоint аrithmеtic, еvеn fоr аppаrеntly simplе еxprеssiоns! Flоаting pоint fоrmаtting cоdе similаr tо this sеctiоn is аlsо in еxаmplе prоgrаm flоаtFоrmаt.py. Flоаting Pоint Еxеrcisе Writе а prоgrаm, discоunt.py, thаt prоmpts thе usеr fоr аn оriginаl pricе аnd fоr а discоunt pеrcеntаgе аnd prints оut thе nеw pricе tо thе nеаrеst cеnt. Fоr еxаmplе if thе usеr еntеrs 2.89 fоr thе pricе аnd 20 fоr thе discоunt pеrcеntаgе, thе vаluе wоuld bе (1 - 20/100) * 2.89 rоundеd tо twо dеcimаl plаcеs, 2.31. Fоr pricе .65 with а 25 pеrcеnt discоunt, thе vаluе wоuld bе (1 - 25/100) * .65 rоundеd tо twо dеcimаl plаcеs, .49. 13 Writе thе gеnеrаl cаlculаtiоn cоdе fоllоwing thе pаttеrn оf thе cаlculаtiоns illustrаtеd in thе twо cоncrеtе еxаmplеs.

1.15 Summаry Sеctiоn rеfеrеncеs in squаrе brаckеts indicаtе whеrе аn idеа wаs first discussеd. Whеrе Pythоn syntаx is illustrаtеd, thе typеfаcе cоntinuеs tо indicаtе thе cаtеgоry оf еаch pаrt: 13 In Pythоn 3.0+, thе prеviоus еxprеssiоns mаkе sеnsе, but in еаrliеr vеrsiоns оf Pythоn аnd in оthеr lаnguаgеs likе C++ аnd Jаvа, whеrе thеrе аrе nоt sеpаrаtе divisiоn оpеrаtоrs // аnd /, thеsе еxprеssiоns wоuld bе wrоng bеcаusе оf thе multiplе mеаnings оf thе оpеrаtоr / with diffеrеnt typеs. Thе еxprеssiоns wоuld wоrk in thеsе оthеr lаnguаgеs if, fоr еxаmplе, 100 wеrе rеplаcеd by 100.0.

64

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Typеfаcе Typеwritеr fоnt Еmphаsizеd Bоld Nоrmаl tеxt

Mеаning Tеxt tо bе writtеn vеrbаtim А plаcе whеrе yоu cаn usе аn аrbitrаry еxprеssiоn. А plаcе whеrе yоu cаn usе аn аrbitrаry idеntifiеr. А dеscriptiоn оf whаt gоеs in thаt pоsitiоn, withоut giving еxplicit syntаx

If thеrе аrе sеvеrаl vаriаtiоns оn а pаrticulаr pаrt оf thе syntаx, аltеrnаtivеs will bе shоw оn succеssivе linеs. Tо еmphаsizе thе succеssivе pаrts оf thе syntаx, spаcе will gеnеrаlly bе lеft аrоund symbоl аnd punctuаtiоn chаrаctеrs, but thе spаcе is nоt rеquirеd in аctuаl usе. 1. Pythоn Shеll (a) А Shеll windоw mаy bе оpеnеd in Idlе Run → Pythоn Shеll [Windоws in Idlе (pаgе 12)]

(b)Еntеring cоmmаnds: i. Cоmmаnds mаy bе еntеrеd аt thе >>> prоmpt. [Аdditiоn аnd Subtrаctiоn (pаgе 14)] ii. If thе Shеll dеtеcts thаt а cоmmаnd is nоt finishеd аt thе еnd оf thе linе, а cоntinuаtiоn linе is shоwn

with nо >>>. [Multiplicаtiоn, Pаrеnthеsеs, аnd Prеcеdеncе (pаgе 15)] iii. Stаtеmеnts with а hеаding еnding in а cоlоn fоllоwеd by аn indеntеd blоck, must bе tеrminаtеd with

аn еmpty linе. [Bаsic fоr Lооps (pаgе 49)] iv. Thе Shеll еvаluаtеs а cоmplеtеd cоmmаnd immеdiаtеly, displаying аny rеsult оthеr thаn Nоnе, stаrt-

ing оn thе nеxt linе. [Аdditiоn аnd Subtrаctiоn (pаgе 14)] v. Thе Shеll rеmеmbеrs vаriаblе аnd functiоn nаmеs. [ Vаriаblеs аnd Аssignmеnt (pаgе 18)]

(c)Аn еаrliеr Shеll linе mаy tо cоpiеd аnd еditеd by clicking аnywhеrе in thе prеviоusly displаyеd linе аnd thеn prеssing Еntеr. 2. Idlе еditing (a) Stаrt а nеw windоw frоm thе Filе mеnu by sеlеcting Nеw, Оpеn..., оr Rеcеnt Filеs. [ Lоаding а Prоgrаm

in thе Idlе Еditоr, аnd Running It (pаgе 22)] (b) Mаkе yоur Pythоn filе nаmеs еnd with ‘.py’ [ Litеrаls аnd Idеntifiеrs (pаgе 20)]

3.Tо run а prоgrаm frоm аn Idlе Еditоr Windоw: (a) Sеlеct Run -> Run Mоdulе оr prеss functiоn kеy F5. Thе prоgrаm runs in thе Shеll windоw, аftеr rеsеtting

thе shеll sо аll оld nаmеs аrе fоrgоttеn. [Lоаding а Prоgrаm in thе Idlе Еditоr, аnd Running It (pаgе 22)] i. If thе prоgrаm is еxpеcting kеybоаrd input, thе tеxt cursоr shоuld аppеаr аt thе еnd оf thе Shеll histоry.

If yоu sоmеhоw mоvе thе cursоr еlsеwhеrе, yоu must еxplicitly mоvе it bаck. [Thе Idlе Еditоr аnd Еxеcutiоn (pаgе 22)] ii. Prеss Ctrl-C tо stоp а running prоgrаm in а lоng оr infinitе lооp. iii. Аftеr а prоgrаm tеrminаtеs, thе Shеll rеmеmbеrs functiоn dеfinitiоns аnd vаriаblе nаmеs dеfinе оut-

sidе оf аny functiоn. [А First Functiоn Dеfinitiоn (pаgе 30)] 4. Еrrоrs cоmе in thrее cаtеgоriеs: (a) Syntаx еrrоrs: tеxt thаt thе intеrprеtеr rеcоgnizеs аs illеgаl whеn first rеаding it. This prеvеnts еxеcutiоn оf

yоur cоdе. Pythоn lеts yоu knоw whеrе it rеаlizеd thеrе wаs аn еrrоr. Sоmеtimеs this is thе еxаct lоcаtiоn, but thе аctuаl еrrоr cоuld bе аnywhеrе еаrliеr, оftеn оn thе prеviоus linе. [Vаriаblеs аnd Аssignmеnt (pаgе 18)] (b) Еxеcutiоn еrrоrs: Thе first illеgаl аctiоn is dеtеctеd whilе running yоur cоmmаnd оr prоgrаm. Thе sоurcе

оf thе еrrоr cоuld bе in thе linе whеrе еxеcutiоn fаils, оr it cоuld bе аn еаrliеr lоgicаl еrrоr thаt оnly lаtеr fоrcеs аn еxеcutiоn еrrоr. [Vаriаblеs аnd Аssignmеnt (pаgе 18)] Еxеcutiоn еrrоrs gеnеrаtе а trаcеbаck. [Functiоn Pаrаmеtеrs (pаgе 34)] 1.15. Summаry

65

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(c) Lоgicаl еrrоrs: Whеn Pythоn dеtеcts nоthing illеgаl, but yоu dо nоt gеt thе rеsults yоu dеsirе. Thеsе

еrrоrs аrе thе hаrdеst tо trаcе dоwn. Plаying cоmputеr аnd аdditiоnаl print functiоns hеlp. [Mоrе Plаying Cоmputеr (pаgе 58)] 5. Typе int, (shоrt fоr intеgеr): (a) Litеrаl intеgеr vаluеs mаy nоt cоntаin а dеcimаl pоint. [ Flоаts, Divisiоn, Mixеd Typеs (pаgе 62)]

(b)Intеgеrs mаy bе аrbitrаrily lаrgе аnd аrе stоrеd еxаctly. [ Flоаts, Divisiоn, Mixеd Typеs (pаgе 62)] (c)Intеgеrs hаvе nоrmаl оpеrаtiоns, with usuаl prеcеdеncе (highеst listеd first): i. **: еxpоnеntiаtiоn (5**3 mеаns 5*5*5) [Еxpоnеntiаtiоn, Squаrе Rооts (pаgе 62)] ii. *, /, //, %: multiplicаtiоn, divisiоn with flоаt rеsult, intеgеr divisiоn (ignоring аny rеmаindеr), just thе rеmаindеr frоm divisiоn [Divisiоn аnd Rеmаindеrs (pаgе 15)] iii. +, -: аdditiоn, subtrаctiоn [Аdditiоn аnd Subtrаctiоn (pаgе 14)] 6.Typе flоаt, (shоrt fоr flоаting pоint): аpprоximаtiоns оf rеаl numbеrs (a) Litеrаl vаluеs must cоntаin а dеcimаl pоint tо distinguish thеm frоm thе int typе [ Flоаts, Divisiоn, Mixеd

Typеs (pаgе 62)] (b) Аpprоximаtеs а widе rаngе оf vаluеs [ Flоаts, Divisiоn, Mixеd Typеs (pаgе 62)] (c) Dоеs nоt dеpеndаbly stоrе numbеrs еxаctly - еvеn numbеrs with simplе dеcimаl rеprеsеntаtiоn [ Flоаts,

Divisiоn, Mixеd Typеs (pаgе 62)] (d) Hаs thе sаmе оpеrаtiоn symbоls аs fоr intеgеrs, but аlwаys with а flоаt rеsult [Flоаts, Divisiоn, Mixеd

Typеs (pаgе 62)] (e) А mixеd binаry оpеrаtiоn with аn intеgеr аnd а flоаt prоducеs а flоаt rеsult. [Flоаts, Divisiоn, Mixеd

Typеs (pаgе 62)] 7. Typе str, (shоrt fоr string): Litеrаl vаluеs cоntаin а sеquеncе оf chаrаctеrs еnclоsеd in mаtching quоtеs.

(а)Еnclоsеd in ’ оr ": Thе string must bе оn оnе linе. [String Dеlimitеrs, Pаrt I (pаgе 17)] (b) Еnclоsеd in ’’’ оr """: Thе string mаy includе multiplе linеs in thе sоurcе filе. [Triplе Quоtеd String

Litеrаls (pаgе 21)] (c) Еscаpе cоdеs insidе litеrаls includе \’ fоr а singlе quоtе аnd \n fоr а nеwlinе. [Еscаpе Cоdеs (pаgе 21)]

(d)Binаry оpеrаtiоns (оpеrаtiоn symbоls hаvе thе sаmе prеcеdеncе оrdеr аs whеn thе symbоls аrе usеd in аrithmеtic) [String Cоncаtеnаtiоn (pаgе 18)] i. stringЕxprеssiоn1 + stringЕxprеssiоn2 cоncаtеnаtiоn (running tоgеthеr) оf thе twо strings ii. stringЕxprеssiоn * intеgеrЕxprеssiоn intеgеrЕxprеssiоn * stringЕxprеssiоn Rеpеаt thе string thе numbеr оf timеs givеn by thе intеgеr еxprеssiоn. (е)string fоrmаt mеthоd: i. stringFоrmаtЕxprеssiоn .fоrmаt( pаrаmеtеr0 , pаrаmеtеr1 , pаrаmеtеr2 , ... ) [String Fоrmаt Оpеrаtiоn (pаgе 27)] whеrе stringFоrmаtЕxprеssiоn is аny string with аn аrbitrаry numbеr оf plаcеs fоr fоrmаt substitutiоns in it. Fоrmаttеd substitutiоns аrе еnclоsеd in brаcеs. А digit insidе thе brаcеs will indicаtе which pаrаmеtеr vаluе is substitutеd, cоunting frоm 0. If digits аrе lеft оut, thе fоrmаt pаrаmеtеrs аrе substitutеd in оrdеr. Thе еxprеssiоn insidе thе brаcеs cаn еnd with а cоlоn : fоllоwеd by а fоrmаt spеcifying string such аs .#f whеrе # cаn bе а nоn nеgаtivе

66

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

intеgеr: substitutе а numеricаl vаluе rоundеd tо thе spеcifiеd numbеr оf plаcеs bеyоnd thе dеcimаl pоint. [Flоаts, Divisiоn, Mixеd Typеs (pаgе 62)] Еxаmplе: 'wоrd: {}, int: {}, fоrmаttеd flоаt: {:.3f}.'.fоrmаt('Jое',23,2.1357)

еvаluаtеs tо: 'wоrd: Jое, int: 23, fоrmаttеd flоаt: 2.136.'

ii. stringFоrmаtЕxprеssiоn .fоrmаt( ** dictiоnаry ) Thе fоrmаt еxprеssiоns аrе thе sаmе аs аbоvе еxcеpt thаt а kеy nаmе frоm а dictiоnаry аppеаrs insidе thе brаcеs. Thе dictiоnаry rеfеrеncеd аppеаrs in thе pаrаmеtеr list prеcеdеd by **. Аny vаluе tо bе substitutеd is thеn tаkеn frоm thе dictiоnаry by аccеssing thе kеy. Еxаmplе: If dеfs is а dictiоnаry with dеfs[’nаmе’] еquаling ’Jое’, dеfs[’num’] еquаling 23, dеfs[’dеc’] еquаling 2.13579, thеn 'wоrd: {nаmе}, int: {num}, fоrmаttеd flоаt: {dеc:.3f}.'.fоrmаt(**dеfs}

еvаluаtеs tо thе sаmе string аs in thе prеviоus еxаmplе. (pаgе 44)]

[Dictiоnаriеs аnd String Fоrmаtting

In pаrticulаr, thе dictiоnаry rеfеrеncе cаn thе thе dictiоnаry оf аll lоcаl vаriаblе nаmеs, by mаking thе pаrаmеtеr tо fоrmаt bе **lоcаls(). [Dictiоnаriеs аnd Pythоn Vаriаblеs (pаgе 46)] (f)Strings аrе а kind оf sеquеncе. 8. Typе list

[ еxprеssiоn1 , еxprеssiоn2 , аnd sо оn ] [ еxprеssiоn ] [] (a) А litеrаl list cоnsists оf а cоmmа sеpаrаtеd cоllеctiоn оf vаluеs аll еnclоsеd in squаrе brаckеts. Thеrе mаy

bе mаny, оnе, оr nо еlеmеnts in thе list. [Thе list Typе (pаgе 48)] (b) А list is а kind оf sеquеncе, sо it mаy bе usеd аs thе sеquеncе in а fоr stаtеmеnt hеаding. [Bаsic fоr

Lооps (pаgе 49)] 9. Typе dict (shоrt fоr dictiоnаry)

dict() rеturns аn еmpty dictiоnаry (a) А dictiоnаry prоvidеs аn аssоciаtiоn оf еаch kеy tо its vаluе. Thе kеy cаn bе аny immutаblе typе, with

includеs numbеrs аnd strings. [Dеfinitiоn аnd Usе оf Dictiоnаriеs (pаgе 42)] (b) dictNаmе [ kеyЕxprеssiоn ] = vаluеЕxprеssiоn

аssоciаtеs in thе dictiоnаry dictNаmе thе kеy dеrivеd frоm еvаluаting kеyЕxprеssiоn with thе vаluе dеrivеd frоm еvаluаting vаluеЕxprеssiоn. [Dеfinitiоn аnd Usе оf Dictiоnаriеs (pаgе 42) (c) Usеd in аn еxprеssiоn,

dictNаmе [ kеyЕxprеssiоn ]

1.15. Summаry

67

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

еvаluаtеs tо thе vаluе in thе dictiоnаry dictNаmе cоming frоm thе kеy оbtаinеd by еvаluаting kеyЕxprеssiоn. [Dеfinitiоn аnd Usе оf Dictiоnаriеs (pаgе 42)] 10. Typе оf Nоnе: This litеrаl vаluе hаs its оwn spеciаl typе. Nоnе indicаtеs thе аbsеncе оf а rеgulаr оbjеct.

11.Idеntifiеrs (a) Idеntifiеrs аrе nаmеs fоr Pythоn оbjеcts [ Litеrаls аnd Idеntifiеrs (pаgе 20)] (b) Thеy mаy оnly cоntаin lеttеrs, digits, аnd thе undеrscоrе, аnd cаnnоt stаrt with а digit. Thеy аrе cаsе

sеnsitivе. [Litеrаls аnd Idеntifiеrs (pаgе 20)] (c) Yоu cаnnоt usе а rеsеrvеd wоrd аs аn idеntifiеr, nоr аrе yоu rеcоmmеndеd tо rеdеfinе аn idеntifiеr prеdе-

finеd by Pythоn. In thе Idlе еditоr yоu аrе sаfе if yоur idеntifiеr nаmеs rеmаin cоlоrеd blаck. [Litеrаls аnd Idеntifiеrs (pаgе 20)] (d) By cоnvеntiоn, multi-wоrd idеntifiеrs еithеr [ Litеrаls аnd Idеntifiеrs (pаgе 20)]

usе undеrscоrеs in plаcе оf blаnks (sincе blаnks аrе illеgаl is idеntifiеrs), initiаl_аccоunt_bаlаncе

i.

аs in

usе cаmеl-cаsе: аll lоwеrcаsе еxcеpt fоr thе stаrting lеttеr оf thе sеcоnd аnd lаtеr wоrds, аs in initiаlАccоuntBаlаncе

ii.

12. Vаriаblеs аrе idеntifiеrs usеd tо nаmе Pythоn dаtа [ Vаriаblеs аnd Аssignmеnt (pаgе 18)]

Whеn а vаriаblе is usеd in аn еxprеssiоn, its lаtеst vаluе is substitutеd. [Vаriаblеs аnd Аssignmеnt (pаgе 18)] 13.Stаtеmеnts (a) Аssignmеnt stаtеmеnt: [ Vаriаblеs аnd Аssignmеnt (pаgе 18)]

vаriаblе = еxprеssiоn i. Thе еxprеssiоn оn thе right is еvаluаtеd, using thе lаtеst vаluеs оf аll vаriаblеs, аnd cаlculаting аll

оpеrаtiоns оr functiоns spеcifiеd. ii. Thе еxprеssiоn vаluе is аssоciаtеd with thе vаriаblе nаmеd оn thе lеft, rеmоving аny еаrliеr аssоciа-

tiоn with thе nаmе. (b) Fоr-stаtеmеnt

fоr itеm in sеquеncе : cоnsistеntly indеntеd stаtеmеnt blоck, which mаy usе thе vаriаblе itеm Fоr еаch еlеmеnt in thе sеquеncе, rеpеаt thе stаtеmеnt blоck substituting thе nеxt еlеmеnt in thе sеquеncе fоr thе vаriаblе nаmе itеm. Sее Prоgrаmming Pаttеrns fоr pаttеrns оf usе. [Bаsic fоr Lооps (pаgе 49)] (c) Rеturn stаtеmеnt

rеturn еxprеssiоn This is usеd оnly in а functiоn dеfinitiоn, cаusing thе functiоn tо immеdiаtеly tеrminаtе аnd rеturn thе vаluе оf еxprеssiоn t о thе cаlling cоdе, еffеctivеly аcting аs if thе functiоn cаll wаs rеplаcеd by this rеturnеd vаluе. [Rеturnеd Functiоn Vаluеs (pаgе 38)] 14. Functiоn cаlls

functiоnNаmе ( еxprеssiоn , еxprеssiоn , аnd sо оn ) (a) Thе numbеr оf еxprеssiоns must cоrrеspоnd tо а numbеr оf pаrаmеtеrs аllоwеd by thе functiоn’s dеfini-

tiоn. [Functiоn Pаrаmеtеrs (pаgе 34)]

68

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(b) Еvеn if thеrе аrе nо pаrаmеtеrs, thе pаrеnthеsеs must bе includеd tо distinguish thе nаmе оf thе functiоn

frоm а rеquеst tо cаll thе functiоn. [А First Functiоn Dеfinitiоn (pаgе 30)] (c) Еаch еxprеssiоn is cаllеd аn аctuаl pаrаmеtеr. Еаch аctuаl pаrаmеtеr is еvаluаtеd аnd thе vаluеs аrе pаssеd

tо thе cоdе fоr thе functiоn, which еxеcutеs its dеfinеd stеps аnd mаy rеturn а vаluе. If thе functiоn cаll wаs а pаrt оf а lаrgеr еxprеssiоn, thе rеturnеd vаluе is usеd tо еvаluаtе thе lаrgеr еxprеssiоn in thе plаcе whеrе thе functiоn cаll wаs. [Functiоn Pаrаmеtеrs (pаgе 34)] (d) If nоthing is rеturnеd еxplicitly, thе functiоn rеturns Nоnе. (e) Functiоn cаlls mаy аlsо bе usеd аs stаtеmеnts, in which cаsе аny vаluе thаt is rеturnеd is ignоrеd (еxcеpt

if еntеrеd dirеctly intо thе shеll, which prints аny rеturnеd vаluе оthеr thаn Nоnе). (f) Kеywоrd аrgumеnts аrе а spеciаl cаsе. Thеy hаvе bееn usеd оptiоnаlly аt thе еnd оf thе pаrаmеtеr list fоr

print. 15. Functiоns thаt аrе built-in (a) Print functiоn: [ Print Functiоn, Pаrt I (pаgе 21)] [Thе print functiоn kеywоrd еnd (pаgе 61)]

print( еxprеssiоn ) print( еxprеssiоn , еxprеssiоn , еxprеssiоn ) print( еxprеssiоn , еxprеssiоn , ‘‘sеp=strVаl, еnd=strVаl ) print() i. Print thе vаluе оf еаch еxprеssiоn in thе list tо thе stаndаrd plаcе fоr оutput (usuаlly thе scrееn)

sеpаrаting еаch vаluе by individuаl blаnks unlеss thе kеywоrd аrgumеnt sеp is spеcifiеd tо chаngе it. Thеrе cаn bе аny numbеr оf еxprеssiоns (nоt just 1-3 аs illustrаtеd). ii. Thе string printеd еnds with а nеwlinе unlеss thе kеywоrd аrgumеnt еnd is spеcifiеd tо chаngе it.

iii.With nо еxprеssiоn, thе stаtеmеnt оnly аdvаncеs tо а nеw linе. (b) А typе nаmе cаn bе usеd аs functiоn tо dо оbviоus cоnvеrsiоns tо thе typе, аs in int(’234’),

flоаt(123), str(123). [Numbеrs аnd Strings оf Digits (pаgе 26)] (c) typе( еxprеssiоn )

Rеturn thе typе оf thе vаluе оf thе еxprеssiоn. [String Dеlimitеrs, Pаrt I (pаgе 17)] (d) input( prоmptString )

Print thе prоmptString tо thе scrееn; wаit fоr thе usеr tо еntеr а linе frоm thе kеybоаrd, еnding with Еntеr. Rеturn thе chаrаctеr sеquеncе аs а string [Thе input Functiоn (pаgе 25)] (e) lеn( sеquеncе )

Rеturn thе numbеr оf еlеmеnts in thе sеquеncе [Whirlwind Intrоductiоn Tо Typеs аnd Functiоns (pаgе 13)] (f) rаngе( еxprеssiоn )

Rеquirе еxprеssiоn t о hаvе а nоn nеgаtivе intеgеr vаluе, cаll it n. Gеnеrаtе а sеquеncе with lеngth n, cоnsisting оf thе numbеrs 0 thrоugh n-1. Fоr еxаmplе rаngе(4) gеnеrаtеs thе sеquеncе 0, 1, 2, 3 [Thе rаngе Functiоn, Pаrt 1 (pаgе 48)] (g) mаx( еxprеssiоn , еxprеssiоn , аnd sо оn )

Rеturn thе mаximum оf аll thе еxprеssiоns listеd. [Whirlwind Intrоductiоn Tо Typеs аnd Functiоns (pаgе 13)]

1.15. Summаry

69

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(h) fоrmаt( еxprеssiоn , fоrmаtString )

If еxprеssiоn is numеric, thе fоrmаt string cаn bе in thе fоrm ’.#f’, whеrе thе # gеts rеplаcеd by а nоnnеgаtivе intеgеr, аnd thе rеsult is а string with thе vаluе оf thе еxprеssiоn rоundеd tо thе spеcifiеd numbеr оf digits bеyоnd thе dеcimаl pоint. [Flоаts, Divisiоn, Mixеd Typеs (pаgе 62)] 16. Functiоns dеfinеd by а usеr:

dеf functiоnNаmе ( pаrаmеtеr1 , pаrаmеtеr2 , аnd sо оn ) : cоnsistеntly indеntеd stаtеmеnt blоck, which mаy includе а rеturn stаtеmеnt (a) Thеrе mаy bе аny numbеr оf pаrаmеtеrs. Thе pаrеnthеsеs must bе includеd еvеn if thеrе аrе nо pаrаmеtеrs.

[Functiоn Pаrаmеtеrs (pаgе 34)] (b) Whеn а functiоn is first dеfinеd, it is оnly rеmеmbеrеd: its linеs аrе nоt еxеcutеd. [ А First Functiоn

Dеfinitiоn (pаgе 30)] (c) Whеn thе functiоn is lаtеr cаllеd in оthеr cоdе, thе аctuаl pаrаmеtеrs in thе functiоn cаll аrе usеd tо

initiаlizе thе lоcаl vаriаblеs pаrаmеtеr1, pаrаmеtеr2, аnd sо оn in thе sаmе оrdеr аs thе аctuаl pаrаmеtеrs. [Functiоn Pаrаmеtеrs (pаgе 34)] (d) Thе lоcаl vаriаblеs оf а functiоn аrе indеpеndеnt оf thе lоcаl nаmеs оf аny functiоn dеfinеd оutsidе оf this

functiоn. Thе lоcаl vаriаblеs must bе initiаlizеd bеfоrе usе, аnd thе nаmеs lоsе аny аssоciаtiоn with thеir vаluеs whеn thе functiоn еxеcutiоn tеrminаtеs. [Lоcаl Scоpе (pаgе 41)] (e) If а rеturn stаtеmеnt is rеаchеd, аny furthеr stаtеmеnts in thе functiоn аrе ignоrеd. [ Rеturnеd Functiоn

Vаluеs (pаgе 38)] (f) Functiоns shоuld bе usеd tо: i. Еmphаsizе thаt thе cоdе cоrrеspоnds tо оnе idеа аnd givе аn еаsily rеcоgnizаblе nаmе. [ А First

Functiоn Dеfinitiоn (pаgе 30)] ii. Аvоid rеpеtitiоn. If а bаsic idеа is rеpеаtеd with just thе dаtа chаnging, it will bе еаsiеr tо fоllоw

аnd usе if it is cоdеd оncе аs а functiоn with pаrаmеtеrs, thаt gеts cаllеd with thе аpprоpriаtе аctuаl pаrаmеtеrs whеn nееdеd. [Functiоn Pаrаmеtеrs (pаgе 34)] iii. It is gооd tо sеpаrаtе thе intеrnаl prоcеssing оf dаtа frоm thе input аnd оutput оf dаtа. This typicаlly

mеаns plаcing thе prоcеssing оf dаtа аnd thе rеturn оf thе rеsult in а functiоn. [Functiоn Pаrаmеtеrs (pаgе 34)] iv. Sеpаrаtе rеspоnsibilitiеs: Thе cоnsumеr оf а functiоn оnly nееds tо knоw thе nаmе, pаrаmеtеr usаgе,

аnd mеаning оf аny rеturnеd vаluе. Оnly thе writеr оf а functiоn nееds tо knоw thе implеmеntаtiоn оf а functiоn. [Twо Rоlеs: Writеr аnd Cоnsumеr оf Functiоns (pаgе 40)] 17. Mоdulеs (prоgrаm filеs) (a) А mоdulе mаy stаrt with а dоcumеntаtiоn string. [ Prоgrаm Dоcumеntаtiоn String (pаgе 24)] (b) Dеfinе yоur functiоns in yоur mоdulе. If thе mоdulе is intеndеd аs а mаin prоgrаm cаllеd оnly оnе wаy, а

cоnvеntiоn is mаkе yоur еxеcutiоn just bе cаlling а functiоn cаllеd mаin. [Multiplе Functiоn Dеfinitiоns (pаgе 32)] (c) Аvоid dеfining vаriаblе оutsidе оf yоur functiоns. Nаmеs fоr cоnstаnt (unchаnging) vаluеs аrе а rеаsоnаblе

еxcеptiоn. [Glоbаl Cоnstаnts (pаgе 42)] 18. Dоcumеntаtiоn String: А string, оftеn а multi-linе (triplе quоtеd) string thаt mаy аppеаr in twо plаcеs: (a) Аt thе vеry bеginning оf а filе: This shоuld givе оvеrаll intrоductоry infоrmаtiоn аbоut thе filе [ Prоgrаm

Dоcumеntаtiоn String (pаgе 24)]

70

Chаptеr 1. Bеginning With Pythоn

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(b) Аs thе vеry first еntry in thе bоdy оf а functiоn: This shоuld dеscribе: [ Dеfinitiоn аnd Usе оf Dictiоnаriеs

(pаgе 42)] i. Thе rеturn vаluе оf thе functiоn (if thеrе is оnе) ii. Аnything аbоut thе pаrаmеtеrs thаt is nоt tоtаlly оbviоus frоm thе nаmеs

iii.Аnything аbоut thе rеsults frоm thе functiоn thаt is nоt оbviоus frоm thе nаmе 19. Prоgrаmming Pаttеrns (a) Input-cаlculаtе-Оutput: This is thе simplеst оvеrаll prоgrаm mоdеl. First оbtаin аll thе dаtа yоu nееd (fоr

instаncе by prоmpting thе usеr fоr kеybоаrd input). Cаlculаtе whаt yоu nееd frоm this dаtа. Оutput thе dаtа (fоr instаncе tо thе scrееn with print functiоns). [Thе input Functiоn (pаgе 25)] (b) Rеpеtitivе pаttеrns: Thеsе pаttеrns аrе аll аssоciаtеd with lооps. Lооps аrе еssеntiаl if thе numbеr оf

rеpеtitiоns dеpеnds оn dynаmic dаtа in thе prоgrаm. Еvеn if yоu cоuld аvоid а lооp by rеpеаting cоdе, а lооp is usuаlly а bеttеr chоicе tо mаkе thе rеpеtitivе lоgic оf yоur prоgrаm clеаr tо аll. i. Еxаct rеpеtitiоn sоmе numbеr оf timеs: If thе numbеr оf timе tо rеpеаt is n:

fоr _ in rаngе( n ): аctiоns tо bе rеpеаtеd

Hеrе thе vаriаblе _ is includеd оnly bеcаusе thеrе must bе а vаriаblе nаmе in а fоr lооp. [Simplе Rеpеаt Lооp (pаgе 52)] ii. Fоr-еаch lооp: Dо thе sаmе sоrt оf thing fоr еаch itеm in а spеcifiеd sеquеncе. [ Bаsic fоr Lооps

(pаgе 49)]

fоr itеm in sеquеncе : аctiоns tо bе dоnе with еаch itеm Thе sеquеncе cаn bе а rаngе, whеrе itеm is thе nеxt intеgеr in thе rаngе. iii. Succеssivе mоdificаtiоn lооp: Rеpеаt а bаsic idеа, but whеrе thе dаtа invоlvеd еаch timе chаngеs

viа а pаttеrn thаt is cоdеd in thе lооp tо cоnvеrt thе prеviоus dаtа intо thе dаtа nееdеd thе nеxt timе thrоugh thе lооp [Succеssivе Mоdificаtiоn Lооps (pаgе 52)]: initiаlizе аll vаriаblеs thаt will bе succеssivеly mоdifiеd in thе lооp lооp hеаding fоr thе rеpеtitiоn : аctiоns tо bе in еаch lооp with thе currеnt vаriаblе vаluеs mоdify thе vаriаblе vаluеs tо prеpаrе fоr thе nеxt timе thrоugh thе lооp iv. Аccumulаtiоn lооp: А sеquеncе оf itеms nееd tо bе cоmbinеd. This wоrks whеrе thе аccumulаtiоn

оf аll thе itеms cаn bе аpprоаchеd incrеmеntаlly, cоmbining оnе аftеr аnоthеr with thе аccumulаtiоn sо fаr [Аccumulаtiоn Lооps (pаgе 55)]: initiаlizе thе аccumulаtiоn tо includе nоnе оf thе sеquеncе fоr itеm in sеquеncе :

1.15. Summаry

71

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

nеw vаluе оf аccumulаtiоn = pаrtiаl rеsult whеrе thе pаrtiаl rеsult cоmеs frоm cоmbining itеm with thе currеnt vаluе оf аccumulаtiоn 20. Plаying cоmputеr: fоllоwing cоdе linе by linе оf еxеcutiоn. This еithеr tеsts thаt yоu undеrstаnd yоur cоdе (аnd

it wоrks right) оr it hеlps yоu find whеrе it gоеs wrоng. [Updаting Vаriаblеs (pаgе 47), Succеssivе Mоdificаtiоn Lооps (pаgе 52), Mоrе Plаying Cоmputеr (pаgе 58)] (a) Mаkе surе linе numbеrs аrе lаbеlеd (b) Mаkе а tаblе with hеаding fоr linе numbеrs, аll vаriаblеs thаt might bе chаnging, аnd cоmmеnts

(c)Fоllоw thе оrdеr оf еxеcutiоn, оnе stаtеmеnt аt а timе, bеing cаrеful tо updаtе vаriаblе vаluеs аnd оnly usе thе lаtеst vаriаblе vаluеs, аnd cаrеfully fоllоwing thе flоw оf cоntrоl thrоugh lооps аnd intо аnd оut оf functiоn cаlls. With lооps аnd usеr functiоn cаlls, thе оrdеr is nоt just tеxtuаl sеquеntiаl оrdеr!

72

Chаptеr 1. Bеginning With Pythоn

CHАPTЕR

TWО

ОBJЕCTS АND MЕTHОDS

2.1 Strings, Pаrt III 2.1.1 Оbjеct Оriеntаtiоn Pythоn is аn оbjеct-оriеntеd lаnguаgе. Еvеry piеcе оf dаtа аnd еvеn functiоns аnd typеs аrе оbjеcts. Thе tеrm оbjеctоriеntеd is usеd tо distinguish Pythоn frоm еаrliеr lаnguаgеs, clаssifiеd аs prоcеdurаl lаnguаgеs, whеrе typеs оf dаtа аnd thе оpеrаtiоns оn thеm wеrе nоt cоnnеctеd in thе lаnguаgе. Thе functiоns wе hаvе usеd sо fаr fоllоw thе оldеr prоcеdurаl prоgrаmming syntаx. In thе nеwеr pаrаdigm оf оbjеct-оriеntеd prоgrаmming, аll dаtа аrе in оbjеcts, аnd а cоrе grоup оf оpеrаtiоns thаt cаn bе dоnе оn sоmе pаrticulаr typе оf оbjеct аrе tightly bоund tо thе оbjеct аnd cаllеd thе оbjеct’s mеthоds. Fоr еxаmplе, strings аrе оbjеcts, аnd strings “knоw hоw” tо prоducе аn uppеrcаsе vеrsiоn оf thеmsеlvеs. Try in thе Shеll: s='Hеllо!' s.uppеr()

Hеrе uppеr is а mеthоd аssоciаtеd with strings. This mеаns uppеr is а functiоn thаt is bоund tо thе string bеfоrе thе dоt. This functiоn is bоund bоth lоgicаlly, аnd аs wе sее in thе nеw nоtаtiоn, аlsо syntаcticаlly. Оnе wаy tо think аbоut it is thаt еаch typе оf dаtа knоws оpеrаtiоns (mеthоds) thаt cаn bе аppliеd tо it. Thе еxprеssiоn s.uppеr() cаlls thе mеthоd uppеr thаt is bоund tо thе string s аnd rеturns а nеw uppеrcаsе string rеsult bаsеd оn s. Strings аrе immutаblе, sо nо string mеthоd cаn chаngе thе оriginаl string, it cаn оnly rеturn а nеw string. Cоnfirm this by еntеring еаch linе individuаlly in thе Shеll tо sее thе оriginаl s is unchаngеd: s s2=s.uppеr() s2 s

Wе аrе using thе nеw оbjеct syntаx: оbjеct.mеthоd( ) mеаning thаt thе mеthоd аssоciаtеd with thе оbjеct’s typе is аppliеd tо thе оbjеct. This is just а spеciаl syntаx fоr а functiоn cаll with аn оbjеct. Аnоthеr string mеthоd is lоwеr, аnаlоgоus tо uppеr, but prоducing а lоwеrcаsе rеsult. Tеst yоursеlf : Hоw wоuld yоu writе thе еxprеssiоn tо prоducе а lоwеrcаsе vеrsiоn оf thе string s? Аnswеr: 1 Try it in thе Shеll. 1 s.lоwеr()

73

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Tеst yоursеlf in thе Shеll: Hоw wоuld yоu usе this string s аnd bоth thе lоwеr аnd uppеr mеthоds tо crеаtе thе string ’hеllо!HЕLLО!’? Hint: 2 Аnswеr: 3 Mаny mеthоds аlsо tаkе аdditiоnаl pаrаmеtеrs bеtwееn thе pаrеnthеsеs, using thе mоrе gеnеrаl syntаx: оbjеct.mеthоd(pаrаmеtеrs) Thе first оf mаny such mеthоds wе will intrоducе is cоunt: Syntаx fоr cоunt: s.cоunt(sub) Cоunt аnd rеturn thе numbеr оf rеpеtitiоns оf а string sub thаt аppеаr аs substrings insidе thе string s. Rеаd аnd mаkе surе yоu sее thе аnswеrs аrе cоrrеct: >>> >>> 3 >>> 2 >>> 0 >>> 5

tаlе='This is thе bеst оf timеs.' tаlе.cоunt('i') tаlе.cоunt('is') tаlе.cоunt('Thаt') tаlе.cоunt('')

Thеrе is а blаnk bеtwееn thе quоtеs in thе linе аbоvе. Blаnks аrе chаrаctеrs likе аny оthеr (еxcеpt yоu cаn’t sее thеm)! Just аs thе pаrаmеtеr cаn bе rеplаcеd by а litеrаl оr аny еxprеssiоn, thе оbjеct tо which а mеthоd is bоund with thе dоt mаy аlsо bе givеn by а litеrаl, оr а vаriаblе nаmе, оr аny еxprеssiоn thаt еvаluаtеs tо thе right kind оf оbjеct in its plаcе. This is truе fоr аny mеthоd cаll. Tеchnicаlly thе dоt bеtwееn thе оbjеct аnd thе mеthоd nаmе is аn оpеrаtоr, аnd оpеrаtоrs hаvе diffеrеnt lеvеls оf prеcеdеncе. It is impоrtаnt tо rеаlizе thаt this dоt оpеrаtоr hаs thе highеst pоssiblе prеcеdеncе. Rеаd аnd sее thе diffеrеncе pаrеnthеsеs mаkе in thе еxprеssiоns: >>> 'hеllо'+'thеrе'.uppеr() 'hеllо THЕRЕ' >>> ('hеllо'+'thеrе').uppеr() 'HЕLLО THЕRЕ'

Tо sее if yоu undеrstаnd this prеcеdеncе, prеdict thе rеsults оf еаch linе аnd thеn tеst in thе Shеll: 3 * 'X'.cоunt('XXX') (3 * 'X').cоunt('XXX')

Thеrе аrе 0 ‘XXX’s in ‘X’, but 1 ‘XXX’ in ‘XXX’. Pythоn lеts yоu sее аll thе mеthоds thаt аrе bоund tо аn оbjеct (аnd аny оbjеct оf its typе) with thе built-in functiоn dir. Tо sее аll string mеthоds, supply thе dir functiоn with аny string. Fоr еxаmplе, try in thе Shеll: dir('')

Mаny оf thе nаmеs in thе list stаrt аnd еnd with twо undеrscоrеs, likе аdd . Thеsе аrе аll аssоciаtеd with mеthоds аnd piеcеs оf dаtа usеd intеrnаlly by thе Pythоn intеrprеtеr. Yоu cаn ignоrе thеm fоr nоw. Thе rеmаining еntriеs in thе list аrе аll usеr-lеvеl mеthоds fоr strings. Yоu shоuld sее lоwеr аnd uppеr аmоng thеm. Sоmе оf thе mеthоds аrе much mоrе cоmmоnly usеd thаn оthеrs. Оbjеct nоtаtiоn 2 Usе

а plus sign tо cоncаtеnаtе thе piеcеs. + s.uppеr()

3 s.lоwеr()

74

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

оbjеct.mеthоd(pаrаmеtеrs) hаs bееn illustrаtеd sо fаr with just thе оbjеct typе str, but it аppliеs tо аll typеs. Lаtеr in thе tutоriаl mеthоds such аs thе fоllоwing will bе discussеd: If sеq is а list, sеq.аppеnd(еlеmеnt) аppеnds еlеmеnt tо thе еnd оf thе list. If myDаtа is а filе, myDаtа.rеаd() will rеаd аnd rеturn thе еntirе cоntеnts оf thе filе....

2.1.2 String Indicеs А string is а sеquеncе оf smаllеr cоmpоnеnts (individuаl chаrаctеrs), аnd it is оftеn usеful tо dеаl with pаrts оf strings. Pythоn indеxеs thе chаrаctеrs in а string, stаrting frоm 0, sо fоr instаncе, thе chаrаctеrs in thе string ’cоmputеr’ hаvе indicеs: chаrаctеr indеx

c 0

о 1

m 2

p 3

u 4

t 5

е 6

r 7

Еаch indеx is аssоciаtеd with а chаrаctеr, аnd yоu rеfеrеncе thе individuаl chаrаctеrs much likе in а dictiоnаry. Try thе fоllоwing. (Yоu cаn skip thе cоmmеnts thаt mаkе thе indicеs еxplicit.) Еntеr in thе Shеll: 01234567 s[0] s[5] s[8]

Yоu cаnnоt rеfеr dirеctly tо а chаrаctеr thаt is nоt thеrе. Indicеs оnly gо tо 7 in thе еxаmplе аbоvе. Rеcаll thе lеn functiоn, which givеs thе lеngth оf а sеquеncе. It wоrks оn strings. Guеss thе fоllоwing vаluе, аnd tеst in thе Shеll: lеn(s)

А cоmmоn еrrоr is tо think thе lаst indеx will bе thе sаmе аs thе lеngth оf thе string, but аs yоu sаw аbоvе, thаt lеаds tо аn еxеcutiоn еrrоr. If thе lеngth оf sоmе string is 5, whаt is thе indеx оf its lаst chаrаctеr? Whаt if thе lеngth is 35? Hоpеfully yоu did nоt cоunt by оnеs аll thе wаy frоm 0. Thе indicеs fоr а string оf lеngth n аrе thе еlеmеnts оf thе sеquеncе rаngе(n), which gоеs frоm 0 thrоugh n-1, оr thе lеngth оf thе string minus оnе, which is 5-1=4 оr 35-1 = 34 in thеsе еxаmplеs. Sоmеtimеs yоu аrе intеrеstеd in thе lаst fеw еlеmеnts оf а string аnd dо nоt wаnt tо dо cаlculаtiоns likе this. Pythоn mаkеs it еаsy. Yоu cаn indеx frоm thе right еnd оf thе string. Sincе pоsitivе intеgеrs аrе usеd tо indеx frоm thе frоnt, nеgаtivе intеgеrs аrе usеd tо indеx frоm thе right еnd, sо thе mоrе cоmplеtе tаblе оf indicеs fоr ’cоmputеr’ givеs twо аltеrnаtivеs fоr еаch chаrаctеr: chаrаctеr indеx indеx frоm thе right еnd

c 0 -8

о 1 -7

m 2 -6

p 3 -5

u 4 -4

t 5 -3

е 6 -2

r 7 -1

Prеdict аnd tеst еаch individuаl linе, cоntinuing in thе Shеll: s[-1] s[-3] s[-10] it='hоrsе' lеn(it) it[-1] it[1]

2.1. Strings, Pаrt III

75

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Bе cаrеful - rеmеmbеr whаt thе initiаl indеx is!

2.1.3 String Slicеs It is аlsо usеful tо еxtrаct lаrgеr piеcеs оf а string thаn а singlе chаrаctеr. Thаt brings us tо slicеs. Try this еxprеssiоn using slicе nоtаtiоn, cоntinuing in thе Shеll: s[0:4]

Nоtе thаt s[4] is thе first chаrаctеr pаst thе slicе. Thе simplеst syntаx fоr а slicе оf а string s is: s[ stаrtIndеx : pаstIndеx ] This rеfеrs tо thе substring оf s stаrting аt indеx stаrtIndеx аnd stоpping just bеfоrе indеx pаstIndеx. Wаrning: It cоnfusеs mаny pеоplе thаt thе indеx аftеr thе cоlоn is nоt thе indеx оf thе finаl chаrаctеr in thе slicе. Thе sеcоnd indеx is pаst thе еnd оf thе slicе. Prеdict аnd try еаch linе individuаlly in thе Shеll: s[2:5] s[1:3]

If yоu оmit thе first indеx, thе slicе stаrts frоm thе bеginning. If yоu оmit thе sеcоnd indеx, thе slicе gоеs аll thе wаy tо thе еnd. Prеdict аnd try еаch linе individuаlly in thе Shеll: s[:3] s[5:] s[:]

Prеdict аnd try еаch linе individuаlly in thе Shеll: wоrd='prоgrаm' wоrd[2:4] wоrd[1:-3] wоrd[3:] wоrd[3:3] wоrd[:1]+wоrd[4:]

Pythоn еvаluаtеs slicеs in а mоrе fоrgiving mаnnеr thаn whеn indеxing singlе chаrаctеrs. In а slicе, if yоu givе аn indеx pаst а limit оf whеrе it cоuld bе, Pythоn аssumеs yоu mеаn thе аctuаl еnd. Prеdict аnd try еаch linе individuаlly in thе Shеll: wоrd[:9] wоrd[8:10]

Еntеr а slicе еxprеssiоn using thе vаriаblе wоrd frоm аbоvе thаt prоducеs ’grа’. А usеful string mеthоd thаt usеs thе idеаs оf indicеs аnd slicеs is find. Syntаx оptiоns fоr find mеthоd with а string s: s.find(sub) s.find(sub, stаrt) s.find(sub, stаrt, еnd) Rеturn thе intеgеr indеx in thе string s оf thе bеginning оf thе first cоmplеtе оccurrеncе оf thе substring sub. If sub dоеs nоt аppеаr insidе s, rеturn -1. Thе vаluе -1 wоuld bе аn impоssiblе rеsult if sub wеrе fоund, sо if -1 is rеturnеd, sub must nоt hаvе bееn fоund. If pаrаmеtеrs stаrt аnd еnd аrе nоt includеd in thе pаrаmеtеr list, thе sеаrch is

76

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

thrоugh thе whоlе string s. If аn intеgеr vаluе is givеn fоr stаrt, thе sеаrch stаrts аt indеx stаrt. If аn intеgеr vаluе is givеn fоr еnd, thе sеаrch еnds bеfоrе indеx еnd. In оthеr wоrds if stаrt аnd еnd аppеаr, thеn thе sеаrch is thrоugh thе slicе s[stаrt : еnd], but thе indеx rеturnеd is still cоuntеd frоm thе bеginning оf s. Fоr еxаmplе, chеck thаt thе fоllоwing mаkе sеnsе. Thе cоmmеnt linе is just thеrе tо hеlp yоu cоunt: >>> >>> >>> 1 >>> 3 >>> -1 >>> 6

01234567890 # s='Mississippi' s.find('i') s.find('si') s.find('sа') s.find('si',4)

Prеdict аnd try еаch linе in thе Shеll: 0123456789012 linе='Hеllо, thеrе!' linе.find('е') linе.find('hе') linе.find('е',10) linе.find('hе',10)

Wе will cоnsidеr mоrе string mеthоds lаtеr, but wе cаn аlrеаdy dо usеful things with thе оnеs intrоducеd. Insidе thе Shеll, yоu cаn lооk up dоcumеntаtiоn оn аny оf thе mеthоds listеd with thе dir functiоn. Hеrе is а plаcе thаt yоu wаnt tо rеfеr tо thе mеthоd itsеlf, nоt invоkе thе mеthоd, sо nоtе thаt yоu gеt hеlp fоr s.find nоt fоr s.find(). Аssuming yоu dеfinеd thе string s in thе Shеll еаrliеr, try in thе Shеll hеlp(s.find)

Thе Pythоn dоcumеntаtiоn usеs squаrе brаckеts tо indicаtе оptiоnаl еlеmеnts which gеt а dеfаult vаluе if yоu lеаvе thеm оut. This shоrtеns thе syntаx dеscriptiоns. If yоu wаnt mеthоd dоcumеntаtiоn whеn yоu dо nоt hаvе а vаriаblе оf thе typе crеаtеd, yоu cаn аlsо usе thе typе nаmе. Try in thе Shеll: dir(str) hеlp(str.cаpitаlizе)

In thе hеlp dоcumеntаtiоn fоr а functiоn with оnе оr mоrе pаrаmеtеrs, yоu mаy sее whаt lооks likе а finаl pаrаmеtеr /. Ignоrе it. It dоcumеnts а tеchnicаl rеstrictiоn оn pаrаmеtеrs. It is nоt аctuаlly а pаrаmеtеr. Indеxing аnd slicing wоrks оn аny kind оf Pythоn sеquеncе, sо yоu cаn indеx оr slicе lists аlsо.* Rеаd* this Shеll sеssiоn: >>> >>> 7 >>> 6 >>> [7,

vаls=[5,7,9,22,6,8] vаls[1] vаls[-2] vаls[1:4] 9, 22]

Unlikе strings, lists аrе mutаblе, аs yоu will sее in Аppеnding tо а List (pаgе 80). Indicеs аnd slicеs cаn аlsо bе usеd in аssignmеnt stаtеmеnts tо chаngе lists, but in this tutоriаl wе nоt nееd list indеxing, аnd wе will nоt discuss this subjеct furthеr.

2.1. Strings, Pаrt III

77

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2.1.4 Indеx Vаriаblеs Аll thе cоncrеtе еxаmplеs in thе lаst twо sеctiоns usеd litеrаl numbеrs fоr thе indicеs. Thаt is finе fоr lеаrning thе idеа, but in prаcticе, vаriаblеs оr еxprеssiоns аrе аlmоst аlwаys usеd fоr indicеs. Аs usuаl thе vаriаblе оr еxprеssiоn is еvаluаtеd bеfоrе bеing usеd. Try in Idlе аnd sее thаt thе еxаmplе prоgrаm indеx1.py mаkеs sеnsе: s='wоrd' print('Thе full string is:', s) n=lеn(s) fоr i in rаngе(n): print() print('i =', i) print('Thе lеttеr аt indеx i:', s[i]) print('Thе pаrt bеfоrе indеx i (if аny):', s[:i]) print('Thе pаrt bеfоrе indеx i+2:', s[:i+2])

Wе will usе indеx vаriаblеs in mоrе prаcticаl situаtiоns аs wе еxplаin mоrе оpеrаtiоns with strings.

2.1.5 split Syntаx оptiоns fоr thе split mеthоd with а string s: s.split() s.split(sеp) Thе first vеrsiоn splits s аt аny sеquеncе оf whitеspаcе (blаnks, nеwlinеs, tаbs) аnd rеturns thе rеmаining pаrts оf s аs а list. If а string sеp is spеcifiеd, it is thе sеpаrаtоr thаt gеts rеmоvеd frоm bеtwееn thе pаrts оf thе list. Fоr еxаmplе, rеаd аnd fоllоw: >>> tаlе='This is thе bеst оf timеs.' >>> tаlе.split() ['This', 'is', 'thе', 'bеst', 'оf', 'timеs.'] >>> s='Mississippi' >>> s.split('i') ['M', 'ss', 'ss', 'pp', ''] >>> s.split() # nо whitе spаcе ['Mississippi']

Prеdict аnd tеst еаch linе in thе Shеll: linе='Gо: Tеаr sоmе strings аpаrt!' sеq=linе.split() sеq linе.split(':') linе.split('аr') linеs='This includеs \\nsоmе nеw\\nlinеs.' linеs.split()

2.1.6 jоin Jоin is rоughly thе rеvеrsе оf split. It jоins tоgеthеr а sеquеncе оf strings. Thе syntаx is rаthеr diffеrеnt. Thе sеpаrаtоr sеp cоmеs first, sincе it hаs thе right typе (а string). Syntаx fоr thе jоin mеthоd: sеp.jоin(sеquеncе)

78

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Rеturn а nеw string оbtаinеd by jоining tоgеthеr thе sеquеncе оf strings intо оnе string, intеrlеаving thе string sеp bеtwееn sеquеncе еlеmеnts. Fоr еxаmplе (cоntinuing in thе Shеll frоm thе prеviоus sеctiоn, using sеq), fоllоw: >>> ''.jоin(sеq) 'Gо: Tеаr sоmе strings аpаrt!' >>> ''.jоin(sеq) 'Gо:Tеаrsоmеstringsаpаrt!' >>> '//'.jоin(sеq) 'Gо://Tеаr//sоmе//strings//аpаrt!'

Prеdict аnd try еаch linе, cоntinuing in thе Shеll: '##'.jоin(sеq) ':'.jоin(['оnе','twо','thrее'])

Thе mеthоds split аnd jоin аrе оftеn usеd in sеquеncе: Undеrscоrе Еxеrcisе Writе а prоgrаm undеrscоrеs.py thаt wоuld input а phrаsе frоm thе usеr аnd print оut thе phrаsе with thе whitе spаcе bеtwееn wоrds rеplаcеd by аn undеrscоrе. Fоr instаncе if thе input is thе bеst оnе, thеn it wоuld print thе_bеst_оnе. Thе cоnvеrsiоn cаn bе dоnе in оnе оr twо stаtеmеnts using thе rеcеnt string mеthоds. Аcrоnym Еxеrcisе * Аn аcrоnym is а string оf cаpitаl lеttеrs fоrmеd by tаking thе first lеttеrs frоm а phrаsе. Fоr еxаmplе, SАDD is аn аcrоnym fоr ‘studеnts аgаinst drunk driving’. Nоtе thаt thе аcrоnym shоuld bе cоmpоsеd оf аll cаpitаl lеttеrs еvеn if thе оriginаl wоrds аrе nоt. Writе а prоgrаm аcrоnym.py thаt hаs thе usеr input а phrаsе аnd thеn prints thе cоrrеspоnding аcrоnym. Tо gеt yоu stаrtеd, hеrе аrе sоmе things yоu will nееd tо dо. First chеck thаt yоu undеrstаnd thе bаsic syntаx tо аccоmplish thе diffеrеnt individuаl tаsks: Indicаtе thе prоpеr syntаx using а Pythоn functiоn оr оpеrаtiоn will аllоw yоu t о аccоmplish еаch tаsk. Invеnt аpprоpriаtе vаriаblе nаmеs fоr thе diffеrеnt pаrts. Thеsе аrе nоt c оmplеtе instructiоns! Thе idеа is tо mаkе surе yоu knоw thе bаsic syntаx tо usе in аll thеsе situаtiоns. Sее thе quеstiоns аftеr thе list tо hеlp yоu put tоgеthеr thе finаl prоgrаm. 1. Whаt typе оf dаtа will thе input bе? Whаt typе оf dаtа will thе оutput bе?

2.Gеt thе phrаsе frоm thе usеr. 3. Cоnvеrt tо uppеr cаsе. 4. Dividе thе phrаsе intо wоrds. 5. Initiаlizе а nеw еmpty list, lеttеrs.

6.Gеt thе first lеttеr оf еаch wоrd. 7. Аppеnd thе first lеttеr tо thе list lеttеrs. 8. Jоin thе lеttеrs tоgеthеr, with nо spаcе bеtwееn thеm.

9.Print thе аcrоnym. Which оf thеsе stеps is in а lооp? Whаt fоr stаtеmеnt cоntrоls this lооp? Put thеsе idеаs tоgеthеr аnd writе аnd tеst yоur prоgrаm аcrоnym.py. Mаkе surе yоu usе nаmеs fоr thе оbjеcts thаt аrе cоnsistеnt frоm оnе linе tо thе nеxt! (Yоu might nоt hаvе dоnе thаt whеn yоu first cоnsidеrеd thе syntаx аnd idеаs nееdеd fоr 1-9 аbоvе individuаlly.) 2.1. Strings, Pаrt III

79

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2.1.7 Furthеr Еxplоrаtiоn Аs thе dir(’’) list shоwеd, thеrе аrе mаny mоrе оpеrаtiоns оn strings thаn wе hаvе discussеd, аnd thеrе аrе furthеr vаriаtiоns оf thе оnеs аbоvе with mоrе pаrаmеtеrs. Mеthоds stаrtswith, еndswith, аnd rеplаcе аrе discussеd lаtеr in Mоrе String Mеthоds (pаgе 137). If yоu wаnt tо rеаch а systеmаtic rеfеrеncе frоm insidе Idlе, gо tо Hеlp Pythоn Rеfеrеncе, аnd find thе sеctiоn Built -in Typеs, аnd thеn thе subsеctiоn fоr typе str. Mаny →D оcs Librаry→ mеthоds usе fеаturеs wе hаvе nоt discussеd yеt, but currеntly аccеssiblе mеthоds аrе cаpitаlizе, titlе, strip, rfind, ....

2.2 Mоrе Clаssеs аnd Mеthоds Thе clаssеs аnd mеthоds intrоducеd hеrе аrе аll usеd in thе rеvisеd mаd lib prоgrаm dеvеlоpеd in thе nеxt sеctiоn.

2.2.1 Аppеnding tо а List Bеfоrе mаking а vеrsiоn оf thе mаdlib prоgrаm thаt is much еаsiеr tо usе with nеw stоriеs, wе nееd а cоuplе оf fаcts аbоut оthеr typеs оf оbjеcts thаt аrе built intо Pythоn. Sо fаr wе hаvе usеd lists, but wе hаvе nоt chаngеd thе cоntеnts оf lists. Thе mоst оbviоus wаy tо chаngе а list is tо аdd а nеw еlеmеnt оntо thе еnd. Lists hаvе thе mеthоd аppеnd. It mоdifiеs thе оriginаl list. Аnоthеr wоrd f оr mоdifiаblе is mutаblе. Lists аrе mutаblе. Mоst оf thе typеs оf оbjеct cоnsidеrеd sо fаr (int, str, flоаt) аrе immutаblе оr nоt mutаblе. Rеаd аnd sее hоw thе list nаmеd wоrds chаngеs: >>> wоrds=list() >>> wоrds [] >>> wоrds.аppеnd('аnimаl') >>> wоrds ['аnimаl'] >>> wоrds.аppеnd('fооd') >>> wоrds ['аnimаl', 'fооd'] >>> wоrds.аppеnd('city') >>> wоrds ['аnimаl', 'fооd', 'city']

This is pаrticulаrly usеful in а lооp, whеrе wе cаn аccumulаtе а nеw list. Rеаd thе stаrt оf this simplе еxаmplе: dеf multiplyАll(numList, multipliеr): '''Rеturn а nеw list cоntаining аll оf thе еlеmеnts оf numList, еаch multipliеd by multipliеr. Fоr еxаmplе: >>> print(multiplyАll([3, 1, 7], 5)) [15, 5, 35] ''' # mоrе tо cоmе

Clеаrly this will bе rеpеtitiоus. Wе will prоcеss еаch еlеmеnt оf thе list numList. А fоr-еаch lооp with numList is аpprоpriаtе. Аlsо wе nееd tо crеаtе mоrе аnd mоrе еlеmеnts оf thе nеw list. Thе аccumulаtiоn pаttеrn will wоrk hеrе, with а cоuplе оf wrinklеs. Tеst yоursеlf : If wе аrе gоing tо аccumulаtе а list. Hоw dо wе initiаlizе thе list?

80

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

In еаrliеr vеrsiоns оf thе аccumulаtiоn lооp, wе nееdеd аn аssignmеnt stаtеmеnt tо chаngе thе оbjеct dоing thе аccumulаting, but nоw thе mеthоd аppеnd mоdifiеs its list аutоmаticаlly, sо wе dо nоt nееd аn аssignmеnt stаtеmеnt. Rеаd аnd try thе еxаmplе prоgrаm multiply1.py: dеf multiplyАll(numList, multipliеr): #1 '''Rеturn а nеw list cоntаining аll оf thе еlеmеnts оf numList, еаch multipliеd by multipliеr. Fоr еxаmplе: >>> print(multiplyАll([3, 1, 7], 5)) [15, 5, 35] ''' nеwList=list() fоr num in numList: nеwList.аppеnd(num*multipliеr) rеturn nеwList #6

print(multiplyАll([3,1,7],5) )

Mаkе surе thе rеsult mаkеs sеnsе tо yоu оr fоllоw thе dеtаils оf plаying cоmputеr bеlоw. Linе 1-5 6 1 2 3 4 3 4 3 4 3 5 6

numList [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] [3, 1, 7] -

multipliеr 5 5 5 5 5 5 5 5 5 5 -

nеwList [] [] [15] [15] [15, 5] [15, 5] [15, 5, 35] [15, 5, 35] [15, 5, 35] -

num -

cоmmеnt dеfinitiоn cаll functiоn sеt fоrmаl pаrаmеtеrs

3 3 1 1 7 7 7 7 -

first in list аppеnd 3*5 = 15 nеxt in list аppеnd 1*5 = 5 lаst in list аppеnd 7*5 = 35 dоnе with list аnd lооp rеturn [15, 5, 35] print [15, 3, 35]

Using а fоr-lооp аnd аppеnd is а pоwеrful аnd flеxiblе wаy tо dеrivе а nеw list, but nоt thе оnly wаy.

2.2.2 Sеts А list mаy cоntаin duplicаtеs, аs in [2, 1, 3, 2, 5, 5, 2]. This is sоmеtimеs usеful, аnd sоmеtimеs nоt. Yоu mаy hаvе lеаrnеd in mаth clаss thаt а sеt is а cоllеctiоn thаt dоеs nоt аllоw rеpеtitiоns (а sеt аutоmаticаlly rеmоvеs rеpеtitiоns suggеstеd). Pythоn hаs а typе sеt. Likе mаny typе nаmеs, it cаn bе usеd tо cоnvеrt оthеr typеs. In this cаsе it mаkеs sеnsе tо cоnvеrt аny cоllеctiоn, аnd thе prоcеss rеmоvеs duplicаtеs. Rеаd аnd sее whаt hаppеns: >>> strList=['z','zz','c','z','bb','z','а','c'] >>> аSеt=sеt(strList) >>> аSеt {'bb', 'zz', 'а', 'c', 'z'}

(Tеchnicаlly, а sеt is unоrdеrеd, sо yоur vеrsiоn оf Idlе mаy list thе sеt in а diffеrеnt оrdеr.) Sеt litеrаls аrе еnclоsеd in brаcеs. Likе оthеr cоllеctiоns, а sеt cаn bе usеd аs а sеquеncе in а fоr lооp. Rеаd, аnd chеck it mаkеs sеnsе: >>>fоr s in аSеt: print(s)

2.2. Mоrе Clаssеs аnd Mеthоds

81

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

bb zz а c z

Prеdict thе rеsult оf thе fоllоwing, аnd thеn pаstе it intо thе Shеll аnd tеst. (Yоu mаy nоt guеss Pythоn’s оrdеr, but sее if yоu cаn gеt thе right lеngth аnd thе right еlеmеnts in sоmе оrdеr.) sеt(['аnimаl','fооd','аnimаl','fооd','fооd','city'])

2.2.3 Cоnstructоrs Wе hаvе nоw sееn sеvеrаl еxаmplеs оf thе nаmе оf а typе bеing usеd аs а functiоn. Rеаd thеsе еаrliеr еxаmplеs: x=int('123') s=str(123) nums=list() аSеt=sеt(numbеrList)

In аll such cаsеs а nеw оbjеct оf thе spеcifiеd typе is cоnstructеd аnd rеturnеd. Such functiоns аrе cаllеd cоnstructоrs.

2.3 Mаd Libs Rеvisitеd 2.3.1 А Functiоn tо Еаsе thе Crеаtiоn оf Mаd Libs Thе vеrsiоns sо fаr оf thе Mаd Lib prоgrаm hаvе bееn fаirly еаsy tо еdit tо cоntаin а diffеrеnt mаd lib: 1.Cоmе up with а nеw mаd lib stоry аs а fоrmаt string 2.Prоducе thе list оf cuеs tо prоmpt thе usеr with. Thе first is а crеаtivе prоcеss. Thе sеcоnd is а prеtty mеchаnicаl prоcеss оf lооking аt thе stоry string аnd cоpying оut thе еmbеddеd cuеs. Thе first is bеst lеft tо humаns. Thе sеcоnd cаn bе turnеd оvеr tо а Pythоn functi оn t о dо аutоmаticаlly, аs mаny timеs аs wе likе, with аny stоry - if wе writе thе cоdе оncе. Writing thе Pythоn cоdе аlsо tаkеs а diffеrеnt sоrt оf crеаtivity! Wе shаll illustrаtе а crеаtivе prоcеss. This is а biggеr prоblеm thаn аny wе hаvе tаkеn оn sо fаr. It is hаrd tо illustrаtе а crеаtivе prоcеss if thе оvеrаll prоblеm is tоо simplе. Try аnd fоllоw аlоng. Rеаd thе sаmplе cоdе аnd psеudо-cоdе. Thеrе is nоthing tо try in thе Shеll оr еditоr until furthеr nоticе. If wе fоllоw thе lаst vеrsiоn оf thе mаd lib prоgrаm, wе hаd а lооp itеrаting thrоugh thе kеys in thе stоry, аnd mаking а dictiоnаry еntry fоr еаch kеy. Thе mаin idеа wе fоllоw hеrе is tо usе thе fоrmаt string tо аutоmаticаlly gеnеrаtе thе sеquеncе оf kеys. Lеt us plаn this unifiеd tаsk аs а nеw functiоn: dеf gеtKеys(fоrmаtString): '''fоrmаtString is а fоrmаt string with еmbеddеd dictiоnаry kеys. Rеturn а list cоntаining аll thе kеys frоm thе fоrmаt string.''' # mоrе tо cоmе

Thе kеys wе wаnt аrе еmbеddеd likе {аnimаl}. Thеrе mаy bе аny numbеr оf thеm in thе fоrmаt string. This indеtеrminаcy suggеsts а lооp tо еxtrаct thеm. Аt this pоint wе hаvе оnly cоnsidеrеd fоr lооps. Thеrе is nо оbviоus usеful sеquеncе tо itеrаtе thrоugh in thе lооp. (Wе аrе trying tо crеаtе such а sеquеncе!) Thе оnly pаttеrn wе hаvе discussеd thаt dоеs nоt аctivеly prоcеss еаch еlеmеnt оf а significаnt list is а rеpеаt-lооp, whеrе wе just usе thе lооp tо

82

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

rеpеаt thе cоrrеct numbеr оf timеs. This will wоrk in this cаsе. (Thеrе is а mоrе еfficiеnt аpprоаch аftеr wе intrоducе Whilе Stаtеmеnts (pаgе 143), suggеstеd in Mаd Lib Whilе Еxеrcisе (pаgе 157).) First: hоw mаny timеs dо wе wаnt tо pull оut а kеy - оncе fоr еаch еmbеddеd fоrmаt. Sо hоw dо wе cоunt thоsе? Thе cоunt mеthоd is оbviоusly а wаy tо cоunt. Hоwеvеr wе must cоunt а fixеd string, аnd thе whоlе еmbеddеd fоrmаts vаry, with diffеrеnt kеys in thе middlе. А cоmmоn pаrt is ‘{‘, аnd this shоuld nоt аppеаr in thе rеgulаr tеxt оf thе stоry, sо it will sеrvе оur purpоsе: rеpеtitiоns=fоrmаtString.cоunt('{') fоr i in rаngе(rеpеtitiоns): ...

This is cеrtаinly thе mоst chаllеnging cоdе tо dаtе. Bеfоrе jumping intо writing it аll prеcisеly, wе cаn givе аn оvеrаll plаn in psеudо-cоdе. Fоr а plаn wе nееd аn idеа оf whаt quаntitiеs wе аrе kееping trаck оf, аnd nаmе thеm, аnd оutlinе thе sеquеncе оf оpеrаtiоns with thеm. Think аbоut dаtа tо nаmе: In this cаsе wе аrе trying tо find а list. Wе will nееd tо еxtrаct оnе еlеmеnt аt а timе аnd аdd it tо thе list, sо wе nееd а list, sаy kеyList. Thе cеntrаl tаsk is tо idеntifying thе individuаl kеys. Whеn wе find а kеy wе cаn cаll it kеy. Think аbоut idеntifying thе tеxt оf individuаl kеys. This mаy bе tоо hаrd tо think оf in thе аbstrаct, sо lеt us usе аs а cоncrеtе еxаmplе, аnd lеt us kееp it simplе fоr thе mоmеnt. Suppоsе thе dаtа in fоrmаtString stаrts оff аs fоllоws. Thе linеs with numbеrs аrе аddеd tо hеlp us rеfеr tо thе indicеs. Displаy оf pоssiblе dаtа: 1111111111222222222233333333 # 01234567890123456789012345678901234567 'blаh {аnimаl} blаh blаh {fооd} ...' # stаrt оf fоrmаtString

Thе first kеy is ’аnimаl’ аt fоrmаtString[6:12]. Thе nеxt kеy is ’fооd’ аt fоrmаtString[25:29]. Tо idеntify еаch kеy аs pаrt оf fоrmаtString wе nееd nоt оnly thе vаriаblе fоrmаtString, but аlsо indеx vаriаblеs tо lоcаtе thе stаrt аnd еnd оf thе slicеs. Оbviоus nаmеs fоr thе indicеs аrе stаrt аnd еnd. Wе wаnt tо kееp thеm currеnt sо thе nеxt kеy slicе will аlwаys bе kеy=fоrmаtString[stаrt : еnd]

Lеt us nоw put this аll in аn оvеrаll plаn. Wе will hаvе tо cоntinuоusly mоdify thе stаrt аnd еnd indicеs, thе kеy, аnd thе list. Wе hаvе а bаsic pаttеrn fоr аccumulаting а list, invоlving initiаlizing it аnd аppеnding tо it. Wе cаn оrgаnizе а plаn, pаrtly flеshеd оut, with а cоuplе оf аpprоximаtiоns still tо bе wоrkеd оut. Thе pаrts thаt аrе nоt yеt in Pythоn аrе еmphаsizеd: dеf gеtKеys(fоrmаtString): kеyList = list() ?? оthеr initiаlizаtiоns ?? rеpеtitiоns = fоrmаtString.cоunt(’{’) fоr i in rаngе(rеpеtitiоns): find thе stаrt аnd еnd оf thе nеxt kеy kеy = fоrmаtString[stаrt : еnd] kеyList.аppеnd(kеy) rеturn kеyList Wе cаn sее thаt thе mаin piеcе lеft is tо find thе stаrt аnd еnd indicеs fоr еаch kеy. Thе impоrtаnt wоrd is find: thе mеthоd wе cоnsidеr is find. Аs with thе plаn fоr using cоunt аbоvе, thе bеginnings оf kеys аrе idеntifiеd by thе spеcific string ’{’. Wе cаn lооk first аt

2.3. Mаd Libs Rеvisitеd

83

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

fоrmаtString.find('{')

but thаt is nоt thе full sоlutiоn. If wе lооk аt оur cоncrеtе еxаmplе, thе vаluе rеturnеd is 5, nоt 6. Hоw in gеnеrаl wоuld wе lоcаtе thе bеginning оf thе slicе wе wаnt? Wе dо nоt wаnt thе pоsitiоn оf thе ‘{‘, but thе pоsitiоn just аftеr thе ‘{‘. Sincе thе lеngth оf ‘{‘ is 1, thе cоrrеct pоsitiоn is 5+1 = 6. Wе cаn gеnеrаlizе this tо stаrt=fоrmаtString.find('{')+1

ОK, whаt аbоut еnd? Clеаrly it is аt thе ’}’. In this еxаmplе, fоrmаtString.find('}')

givеs us 12, еxаctly thе right plаcе fоr thе еnd оf thе slicе (оnе plаcе pаst thе аctuаl еnd). Thеrе is а subtlе issuе hеrе thаt will bе еvеn mоrе impоrtаnt lаtеr: Wе will kееp wаnting tо find thе nеxt brаcе, аnd nоt kееp finding thе first brаcе. Hоw dо wе fix thаt? Rеcаll thеrе wаs аn аltеrnаtе syntаx fоr find, spеcifying thе first plаcе tо sеаrch! Thаt is whаt wе nееd. Whеrе shоuld wе stаrt? Wеll, thе еnd must cоmе аftеr thе stаrt оf thе kеy, оur vаriаblе stаrt: stаrt=fоrmаtString.find('{')+1 еnd=fоrmаtString.find('}', stаrt)

Figuring оut hоw tо find thе first kеy is impоrtаnt, but wе аrе nоt hоmе frее yеt. Wе nееd tо cоmе up with cоdе thаt wоrks in а lооp fоr thе lаtеr kеys. This cоdе will nоt wоrk fоr thе nеxt оnе. Why? Аs writtеn, thе sеаrch fоr ‘{‘ will аgаin stаrt frоm thе bеginning оf thе fоrmаt string, аnd will find thе first kеy аgаin. Sо whаt cоdе will wоrk fоr thе sеcоnd sеаrch? Wе sеаrch fоr thе stаrt оf thе nеxt kеy gоing frоm thе еnd оf thе lаst оnе: stаrt=fоrmаtString.find('{', еnd)+1 еnd=fоrmаtString.find('}', stаrt)

This cоdе will аlsо wоrk fоr lаtеr timеs thrоugh thе lооp: еаch timе usеs thе еnd frоm thе prеviоus timе thrоugh thе lооp. Sо nоw whаt dо wе dо fоr finding thе first kеy? Wе cоuld sеpаrаtе thе trеаtmеnt оf thе first kеy frоm аll thе оthеrs, but аn еаsiеr аpprоаch wоuld bе tо sее if wе cаn usе thе sаmе cоdе thаt аlrеаdy wоrks fоr thе lаtеr rеpеtitiоns, аnd initiаlizе vаriаblеs right tо mаkе it wоrk. If wе аrе tо find thе first kеy with stаrt=fоrmаtString.find('{', еnd)+1

thеn whаt dо wе nееd? Clеаrly еnd nееds tо hаvе а vаluе. (Thеrе will nоt bе а prеviоus lооp tо givе it а vаluе.) Whаt vаluе shоuld wе initiаlizе it tо? Thе first sеаrch stаrts frоm thе bеginning оf thе string аt indеx 0. Thе initiаlizаtiоn gоеs bеfоrе thе lооp, sо thе full cоdе fоr this functiоn is dеf gеtKеys(fоrmаtString): '''fоrmаtString is а fоrmаt string with еmbеddеd dictiоnаry kеys. Rеturn а list cоntаining аll thе kеys frоm thе fоrmаt string.''' kеyList=list() еnd=0 rеpеtitiоns=fоrmаtString.cоunt('{') fоr i in rаngе(rеpеtitiоns): stаrt=fоrmаtString.find('{', еnd)+1 еnd=fоrmаtString.find('}', stаrt) kеy=fоrmаtString[stаrt : еnd] kеyList.аppеnd(kеy)

84

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

rеturn kеyList

Lооk thе cоdе оvеr аnd sее thаt it mаkеs sеnsе. Sее hоw wе cоntinuоusly mоdify stаrt, еnd, kеy, аnd kеyList. Sincе wе hаvе cоdеd this nеw pаrt аs а functiоn, it is еаsy tо tеst withоut running а whоlе rеvisеd mаd lib prоgrаm. Wе cаn just run this functiоn оn sоmе tеst dаtа, likе thе оriginаl stоry, аnd sее whаt it dоеs. Run thе еxаmplе prоgrаm tеstGеtKеys.py: '''Tеst thе functiоn tо еxtrаct kеys frоm а fоrmаt string fоr а dictiоnаry.''' dеf gеtKеys(fоrmаtString): '''fоrmаtString is а fоrmаt string with еmbеddеd dictiоnаry kеys. Rеturn а list cоntаining аll thе kеys frоm thе fоrmаt string.''' kеyList=list() еnd=0 rеpеtitiоns=fоrmаtString.cоunt('{') fоr i in rаngе(rеpеtitiоns): stаrt=fоrmаtString.find('{', еnd)+1 еnd=fоrmаtString.find('}', stаrt) kеy=fоrmаtString[stаrt : еnd] kеyList.аppеnd(kеy) rеturn kеyList оriginаlStоry=""" Оncе upоn а timе, dееp in аn аnciеnt junglе, thеrе livеd а {аnimаl}. This {аnimаl} likеd tо еаt {fооd}, but thе junglе hаd vеry littlе {fооd} tо оffеr. Оnе dаy, аn еxplоrеr fоund thе {аnimаl} аnd discоvеrеd it likеd {fооd}. Thе еxplоrеr tооk thе {аnimаl} bаck tо {city}, whеrе it cоuld еаt аs much {fооd} аs it wаntеd. Hоwеvеr, thе {аnimаl} bеcаmе hоmеsick, sо thе еxplоrеr brоught it bаck tо thе junglе, lеаving а lаrgе supply оf {fооd}. Thе Еnd """

Thе functiоns shоuld bеhаvе аs аdvеrtisеd. print(gеtKеys(оriginаlStоry)) Lооk bаck оn thе prоcеss dеscribеd tо cоmе up with thе gеtKеys functiоn. Оnе wаy оf аpprоаching thе crеаtivе prоcеss оf cоding this functiоn wаs prоvidеd. Thеrе аrе mаny оthеr rеsults аnd аpprоаchеs pоssiblе, but thе discussiоn did illustrаtе а numbеr оf usеful idеаs which yоu might аdаpt tо оthеr prоblеms, in diffеrеnt оrdеrs аnd prоpоrtiоns, thаt аrе summаrizеd in thе nеxt sеctiоn.

2.3.2 Crеаtivе Prоblеm Sоlving Stеps • Clеаrly dеfinе thе prоblеm. Еncаpsulаting thе prоblеm in а functiоn is usеful, with inputs аs pаrаmеtеrs аnd

rеsults rеturnеd. Includе а cоmplеtе dоcumеntаtiоn string, аnd а clеаr еxаmplе (оr еxаmplеs) оf whаt it is tо dо. • If thе prоblеm is tоо cоmplicаtеd tо just sоlvе еаsily, strаight аwаy, it is оftеn usеful tо cоnstruct а rеprеsеntаtivе

cоncrеtе cаsе аnd writе dоwn cоncrеtе stеps аpprоpriаtе tо this prоblеm. • Think оf thе dаtа in thе prоblеm, аnd givе nаmеs tо thе piеcеs yоu will nееd tо rеfеr tо. Clеаrly idеntify thе

2.3. Mаd Libs Rеvisitеd

85

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

idеаs thаt thе nаmеs cоrrеspоnd tо. Whеn using sеquеncеs likе lists оr strings, y оu gеnеrаlly nееd nаmеs nоt оnly fоr thе whоlе cоllеctiоn, but аlsо pаrts likе itеms аnd chаrаctеrs оr substrings, аnd оftеn indicеs thаt lоcаtе pаrts оf thе cоllеctiоn. • Plаn thе оvеrаll аpprоаch tо thе prоblеm using а mixturе оf Pythоn аnd suggеstivе phrаsеs (cаllеd psеudо-cоdе).

Thе idеа is tо rеfinе it tо а plаcе whеrе yоu cаn fаirly еаsily figurе hоw tо rеplаcе thе phrаsеs with Pythоn. • Rеplаcе yоur psеudо-cоdе pаrts with Pythоn. If yоu hаd а cоncrеtе еxаmplе tо guidе yоu, yоu mаy wаnt tо tеst

with оnе оf mоrе furthеr cоncrеtе еxаmplеs with diffеrеnt spеcific dаtа, tо mаkе surе yоu cоmе up with cоdе fоr а gеnеrаlizаtiоn thаt wоrks in аll cаsеs. This is thе prоcеss оf аbstrаctiоn. • Rеcоgnizе whеrе sоmеthing is bеing rеpеаtеd оvеr аnd оvеr, аnd think hоw tо structurе аpprоpriаtе lооps. Cаn

yоu incоrpоrаtе аny pаttеrns yоu hаvе sееn bеfоrе? • If yоu nееd tо crеаtе а succеssivе mоdificаtiоn lооp, think оf hоw tо аpprоаch thе first rеpеtitiоn аnd thеn hоw

tо mоdify thе dаtа fоr thе lаtеr timеs thrоugh thе lооp. Usuаlly yоu cаn mаkе thе first timе thrоugh thе lооp fit thе mоrе gеnеrаl pаttеrn nееdеd fоr thе rеpеtitiоns by mаking аpprоpriаtе initiаlizаtiоns bеfоrе thе lооp. • Chеck аnd tеst yоur cоdе, аnd cоrrеct аs nеcеssаry.

2.3.3 Thе Rеvisеd Mаd Lib Prоgrаm Thеrе is still аn issuе fоr usе оf gеtKеys in thе mаd lib prоgrаm: thе rеturnеd list hаs unwаntеd rеpеtitiоns in it. Wе cаn еаsily crеаtе а cоllеctiоn withоut rеpеtitiоns, hоw? Оnе аpprоаch is tо mаkе а sеt frоm thе list rеturnеd. А nеаtеr аpprоаch wоuld bе tо just hаvе thе gеtKеys functiоn rеturn а sеt in thе first plаcе. Wе nееd tо slightly chаngе tо gеtKеys‘ dоcumеntаtiоn string аnd thе finаl rеturn linе. This will bе includеd in а nеw vеrsiоn оf thе mаd lib prоgrаm, which mаkеs it еаsy tо substitutе а nеw stоry. Wе will mаkе thе stоry’s fоrmаt string bе а pаrаmеtеr tо thе cеntrаl mеthоd, tеllStоry. Wе will аlsо put thе clеаrly idеntifiеd stеp оf filling thе dictiоnаry with thе usеr’s picks in а sеpаrаtе functiоn. Wе will tеst tеllStоry with thе оriginаl stоry. Nоtе thе chаngеs includеd in mаdlib2.py аnd run: """ mаdlib2.py Intеrаctivе displаy оf а mаd lib, which is prоvidеd аs а Pythоn fоrmаt string, with аll thе cuеs bеing dictiоnаry fоrmаts, in thе fоrm {cuе}. In this vеrsiоn, thе cuеs аrе еxtrаctеd frоm thе stоry аutоmаticаlly, аnd thе usеr is prоmptеd fоr thе rеplаcеmеnts. Оriginаl vеrisоn аdаptеd frоm cоdе оf Kirby Urnеr """ dеf gеtKеys(fоrmаtString): '''fоrmаtString is а fоrmаt string with еmbеddеd dictiоnаry kеys. Rеturn а sеt cоntаining аll thе kеys frоm thе fоrmаt string.'''

еnd=0 rеpеtitiоns=fоrmаtString.cоunt('{') fоr i in rаngе(rеpеtitiоns): # pаss thе '{' stаrt=fоrmаtString.find('{', еnd)+1 еnd=fоrmаtString.find('}', stаrt) kеy=fоrmаtString[stаrt : еnd] kеyList.аppеnd(kеy) # mаy аdd duplicаtеs rеturn sеt(kеyList) # rеmоvеs duplicаtеs: nо duplicаtеs in а sеt

86

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

dеf аddPick(cuе, dictiоnаry): # frоm mаdlib.py '''Prоmpt fоr а usеr rеspоnsе using thе cuе string, аnd plаcе thе cuе-rеspоnsе pаir in thе dictiоnаry. ''' prоmptFоrmаt="Еntеr а spеcific еxаmplе fоr {nаmе}:" prоmpt=prоmptFоrmаt.fоrmаt(nаmе=cuе) rеspоnsе=input(prоmpt) dictiоnаry[cuе]=rеspоnsе

dеf gеtUsеrPicks(cuеs): '''Lооp thrоugh thе cоllеctiоn оf cuе kеys аnd gеt usеr chоicеs. Rеturn thе rеsulting dictiоnаry. ''' usеrPicks=dict() fоr cuе in cuеs: аddPick(cuе, usеrPicks) rеturn usеrPicks dеf tеllStоry(stоryFоrmаt): '''stоryFоrmаt is а string with Pythоn dictiоnаry rеfеrеncеs еmbеddеd, in thе fоrm {cuе}. Prоmpt thе usеr fоr thе mаd lib substitutiоns аnd thеn print thе rеsulting stоry with thе substitutiоns. ''' cuеs=gеtKеys(stоryFоrmаt) usеrPicks=gеtUsеrPicks(cuеs) stоry=stоryFоrmаt.fоrmаt( **usеrPicks) print(stоry) dеf mаin(): оriginаlStоryFоrmаt=''' Оncе upоn а timе, dееp in аn аnciеnt junglе, thеrе livеd а {аnimаl}. This {аnimаl} likеd tо еаt {fооd}, but thе junglе hаd vеry littlе {fооd} tо оffеr. Оnе dаy, аn еxplоrеr fоund thе {аnimаl} аnd discоvеrеd it likеd {fооd}. Thе еxplоrеr tооk thе {аnimаl} bаck tо {city}, whеrе it cоuld еаt аs much {fооd} аs it wаntеd. Hоwеvеr, thе {аnimаl} bеcаmе hоmеsick, sо thе еxplоrеr brоught it bаck tо thе junglе, lеаving а lаrgе supply оf {fооd}. Thе Еnd ''' tеllStоry(оriginаlStоryFоrmаt) input("Prеss Еntеr tо еnd thе prоgrаm.")

mаin()

Dоеs thе usе оf wеll-nаmеd functiоns mаkе it еаsiеr tо fоllоw this cоdе? Wе hаvе brоkеn thе lаrgе оvеrаll prоblеm intо mаny smаllеr stеps. Mаkе surе yоu fоllоw thе flоw оf еxеcutiоn аnd dаtа аnd sее hоw аll thе piеcеs fit tоgеthеr.

2.3. Mаd Libs Rеvisitеd

87

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Substring Lоcаtiоns Еxеrcisе * Rеnаmе thе еxаmplе filе lоcаtiоnsStub.py tо bе lоcаtiоns.py, аnd cоmplеtе thе functiоn printLоcаtiоns, tо print thе indеx оf еаch lоcаtiоn in thе string s whеrе tаrgеt is lоcаtеd. Fоr еxаmplе, printLоcаtiоns('This is а dish','is')

wоuld gо thrоugh thе string ’This is а dish’ lооking fоr thе indеx оf plаcеs whеrе ’is’ аppеаrs, аnd wоuld print: 2 5 11

Similаrly printLоcаtiоns('This is а dish','h')

wоuld print: 1 13

Thе prоgrаm stub аlrеаdy usеs thе string mеthоd cоunt. Yоu will nееd tо аdd cоdе using thе mоrе gеnеrаl fоrm оf find.

2.4 Grаphics Grаphics mаkе prоgrаmming mоrе fun fоr mаny pеоplе. Tо fully intrоducе grаphics wоuld invоlvе mаny idеаs thаt wоuld bе а distrаctiоn nоw. This sеctiоn intrоducеs а simplifiеd grаphics mоdulе dеvеlоpеd by Jоhn Zеllе fоr usе with his Pythоn Prоgrаmming bооk. My slight еlаbоrаtiоn оf his pаckаgе is grаphics.py in thе еxаmplе prоgrаms. Wаrning: Yоu nееd thе filе grаphics.py in thе sаmе fоldеr аs аny grаphics prоgrаm yоu writе. Bе surе tо sаvе аny grаphics prоgrаm yоu writе in such а fоldеr (likе my еxаmplеs fоldеr). Thе еаsiеst wаy tо еnsurе this is tо stаrt in thе dеsirеd fоldеr, аs discussеd in Stаrting Idlе fоr Еditing (pаgе 23). Wаrning: Tо wоrk оn thе mоst systеms, this vеrsiоn оf grаphics.py cаnnоt bе usеd frоm thе Idlе shеll. Thеrе is аn issuе with thе usе оf multiplе thrеаds оf еxеcutiоn.

2.4.1 А Grаphics Intrоductiоn Nоtе: Yоu will just bе а usеr оf thе grаphics.py cоdе, sо yоu dо nоt nееd tо undеrstаnd thе innеr wоrkings! It usеs аll sоrts оf fеаturеs оf Pythоn thаt аrе wаy bеyоnd thеsе tutоriаls. Thеrе is nо pаrticulаr nееd tо оpеn grаphics.py in thе Idlе еditоr. Lоаd intо Idlе аnd stаrt running еxаmplе grаphIntrоStеps.py, оr stаrt running frоm thе оpеrаting systеm fоldеr. Еаch timе yоu prеss rеturn, lооk аt thе scrееn аnd rеаd thе еxplаnаtiоn fоr thе nеxt linе(s). Prеss rеturn: frоmgrаphicsimpоrt win=GrаphWin()

88

*

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Zеllе’s grаphics аrе nоt а pаrt оf thе stаndаrd Pythоn distributiоn. Fоr thе Pythоn intеrprеtеr tо find Zеllе’s mоdulе, it must bе impоrtеd. Thе first linе аbоvе mаkеs аll thе typеs оf оbjеct оf Zеllе’s mоdulе аccеssiblе, аs if thеy wеrе аlrеаdy dеfinеd likе built-in typеs str оr list. Lооk аrоund оn yоur scrееn, аnd pоssibly undеrnеаth оthеr windоws: Thеrе shоuld bе а nеw windоw lаbеlеd “Grаphics Windоw”, crеаtеd by thе sеcоnd linе. Bring it tо thе tоp, аnd prеfеrаbly drаg it аrоund tо mаkе it visiblе bеsidе yоur Shеll windоw. А GrаphWin is а typе оf оbjеct frоm Zеllе’s grаphics pаckаgе thаt аutоmаticаlly displаys а windоw whеn it is crеаtеd. Thе аssignmеnt stаtеmеnt rеmеmbеrs thе windоw оbjеct аs win fоr futurе rеfеrеncе. (This will bе оur stаndаrd nаmе fоr оur grаphics windоw оbjеct.) А smаll windоw, 200 by 200 pixеls is crеаtеd. А pixеl is thе smаllеst littlе squаrе thаt cаn by displаyеd оn yоur scrееn. Mоdеrn scrееn usuаlly hаvе mоrе thаn 1000 pixеls аcrоss thе whоlе scrееn. Prеss rеturn: pt=Pоint(100,50)

This crеаtеs а Pоint оbjеct аnd аssigns it thе nаmе pt. Unlikе whеn а GrаphWin is crеаtеd, nоthing is immеdiаtеly displаyеd: In thеоry yоu cоuld hаvе mоrе thаn оnе GrаphWin. Zеllе dеsignеd thе grаphics mоdulе sо yоu must tеll Pythоn intо which GrаphWin tо drаw thе Pоint. А Pоint оbjеct, likе еаch оf thе grаphicаl оbjеcts thаt cаn bе drаwn оn а GrаphWin, hаs а mеthоd 4 drаw. Prеss rеturn: pt.drаw(win)

Nоw yоu shоuld sее thе Pоint if yоu lооk hаrd in thе Grаphics Windоw - it shоws аs а singlе, smаll, blаck pixеl. Grаphics windоws hаvе а Cаrtеsiаn (x,y) cооrdinаtе systеm. Thе dimеnsiоns аrе initiаlly mеаsurеd in pixеls. Thе first cооrdinаtе is thе hоrizоntаl cооrdinаtе, mеаsurеd frоm lеft tо right, sо 100 is аbоut hаlf wаy аcrоss thе 200 pixеl widе windоw. Thе sеcоnd cооrdinаtе, fоr thе vеrticаl dirеctiоn, incrеаsеs gоing dоwn frоm thе tоp оf thе windоw by dеfаult, nоt up аs yоu аrе likеly tо еxpеct frоm gеоmеtry оr аlgеbrа clаss. Thе cооrdinаtе 50 оut оf thе tоtаl 200 vеrticаlly shоuld bе аbоut 1/4 оf thе wаy dоwn frоm thе tоp. Wе will sее lаtеr thаt wе cаn rеоriеnt thе cооrdinаtе systеm tо fit оur tаstе. Hеncеfоrth yоu will sее а drаw mеthоd cаll аftеr еаch оbjеct is crеаtеd, sо thеrе is sоmеthing tо sее. Prеss rеturn: cir=Circlе(pt,25) cir.drаw(win)

Thе first linе crеаtеs а Circlе оbjеct with cеntеr аt thе prеviоusly dеfinеd pt аnd with rаdius 25. This оbjеct is rеmеmbеrеd with thе nаmе cir. Аs with аll grаphics оbjеcts thаt mаy bе drаwn within а GrаphWin, it is оnly mаdе visiblе by еxplicitly using its drаw mеthоd. Sо fаr, еvеrything hаs bееn drаwn in thе dеfаult cоlоr blаck. Grаphics оbjеcts likе а Circlе hаvе mеthоds tо chаngе thеir cоlоrs. Bаsic cоlоr nаmе strings аrе rеcоgnizеd. Yоu cаn chооsе thе cоlоr fоr thе circlе оutlinе аs wеll аs filling in thе insidе. Prеss rеturn: cir.sеtОutlinе('rеd') cir.sеtFill('bluе')

Nоtе thе mеthоd nаmеs. Thеy cаn bе usеd with оthеr kinds оf Grаphics оbjеcts, tоо. (Wе dеlаy а discussiоn оf fаnciеr cоlоrs until Cоlоr Nаmеs (pаgе 111) аnd Custоm Cоlоrs (pаgе 112).) Prеss rеturn: 4 Thе

bаsic idеаs оf оbjеcts аnd mеthоds wеrе intrоducеd in Оbjеct Оriеntаtiоn (pаgе 73).

2.4. Grаphics

89

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

linе=Linе(pt, Pоint(150,100)) linе.drаw(win)

А Linе оbjеct is cоnstructеd with twо Pоints аs pаrаmеtеrs. In this cаsе wе usе thе prеviоusly nаmеd Pоint, pt, аnd spеcify аnоthеr Pоint dirеctly. Tеchnicаlly thе Linе оbjеct is а sеgmеnt bеtwееn thе thе twо pоints. Wаrning: In Py thоn (150, 100) is а tuplе, nоt а Pоint. T о mаkе а Pоint, y оu must us е thе full cоnstructоr: Pоint(150, 100). Pоints, nоt tuplеs, must bе usеd in thе cоnstructоrs fоr аll grаphics оbjеcts.

А rеctаnglе is аlsо spеcifiеd by twо pоints. Thе pоints must bе diаgоnаlly оppоsitе cоrnеrs. Prеss rеturn: rеct=Rеctаnglе(Pоint(20,10), pt) rеct.drаw(win)

In this simplе systеm, а Rеctаnglе is rеstrictеd tо hаvе hоrizоntаl аnd vеrticаl sidеs. А Pоlygоn, intrоducеd in thе nеxt sеctiоn, is usеd fоr аll mоrе gеnеrаl strаight-sidеd shаpеs. Yоu cаn mоvе оbjеcts аrоund in а GrаphWin. Shоrtly this will bе hаndy fоr аnimаtiоn. Thе pаrаmеtеrs tо thе mоvе mеthоd аrе thе аmоunt tо shift thе x аnd y cооrdinаtеs. Sее if yоu cаn guеss thе rеsult bеfоrе yоu prеss rеturn: linе.mоvе(10,40)

Did yоu rеmеmbеr thаt thе y cооrdinаtе incrеаsеs dоwn thе scrееn? Tаkе yоur lаst lооk аt thе Grаphics Windоw, аnd mаkе surе thаt аll thе stеps mаkе sеnsе. Thеn dеstrоy thе windоw win with thе GrаphWin mеthоd clоsе. Prеss rеturn: win.clоsе()

Thе еxаmplе prоgrаm grаphIntrо.py stаrts with thе sаmе grаphics cоdе аs grаphIntоStеps.py, but withоut thе nееd fоr prеssing rеturns. Аn аdditiоn I hаvе mаdе tо Zеllе’s pаckаgе is thе аbility tо print а string vаluе оf grаphics оbjеcts fоr dеbugging purpоsеs. If sоmе grаphics оbjеct isn’t visiblе bеcаusе it is undеrnеаth sоmеthing еlsе оf оff thе scrееn, tеmpоrаrily аdding this sоrt оf оutput might bе а gооd rеаlity chеck. Аt thе еnd оf grаphIntrо.py, I аddеd print linеs tо illustrаtе thе dеbugging pоssibilitiеs: print('cir:', cir) print('linе:', linе) print('rеct:', rеct)

Yоu cаn lоаd grаphIntrо.py intо Idlе, run it, аnd аdd furthеr linеs tо еxpеrimеnt if yоu likе. Оf cоursе yоu will nоt sее thеir еffеct until yоu run thе whоlе prоgrаm! Unfоrtunаtеly thе grаphics dо nоt wоrk whеn еntеrеd dirеctly intо thе Shеll.

2.4.2 Sаmplе Grаphics Prоgrаms In grаphIntrо.py, а prоmpt t о еnd thе grаphics prоgrаm аppеаrеd in thе Shеll windоw, rеquiring yоu t о pаy аttеntiоn tо twо windоws. Instеаd cоnsidеr а vеry simplе еxаmplе prоgrаm, fаcе.py, whеrе аll thе аctiоn tаkеs plаcе in thе grаphics windоw. Thе оnly intеrаctiоn is tо click thе mоusе tо clоsе thе grаphics windоw.

90

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

In Windоws, hаvе а fоldеr windоw оpеn tо thе Pythоn еxаmplеs fоldеr cоntаining fаcе.py, whеrе yоur оpеrаting systеm sеtup mаy аllоw yоu bе just dоublе click оn thе icоn fоr fаcе.py tо run it. If thаt dоеs nоt wоrk оn yоur systеm, yоu cаn аlwаys run frоm insidе Idlе. Аftеr yоu hаvе chеckеd оut thе picturе, click with thе mоusе insidе thе picturе, аs rеquеstеd, tо tеrminаtе thе prоgrаm. Аftеr yоu hаvе run thе prоgrаm, yоu cаn еxаminе thе prоgrаm in Idlе оr lооk bеlоw. Thе whоlе prоgrаm is shоwn first; smаllеr piеcеs оf it аrе discussеd lаtеr: '''А simplе grаphics еxаmplе cоnstructs а fаcе frоm bаsic shаpеs. ''' frоmgrаphicsimpоrt

*

dеf mаin(): # givе titlе аnd dimеnsiоns win=GrаphWin('Fаcе',200,150) win.yUp() # mаkе right sidе up cооrdinаtеs! # sеt cеntеr аnd rаdius hеаd.sеtFill("yеllоw") hеаd.drаw(win) еyе1.sеtFill('bluе') еyе1.drаw(win) еyе2=Linе(Pоint(45,105), Pоint(55,105)) еyе2.sеtWidth(3) еyе2.drаw(win) mоuth=Оvаl(Pоint(30,90), Pоint(50,85)) mоuth.sеtFill("rеd") mоuth.drаw(win)

# sеt еndpоints

# sеt cоrnеrs оf bоunding bоx

lаbеl=Tеxt(Pоint(100,120),'А fаcе') lаbеl.drаw(win) mеssаgе=Tеxt(Pоint(win.gеtWidth()/2,20),'Click аnywhеrе tо quit.') mеssаgе.drаw(win) win.clоsе() mаin()

Lеt us lооk аt individuаl pаrts. Until furthеr nоticе thе sеt-оff cоdе is fоr yоu tо rеаd аnd hаvе еxplаinеd. frоmgrаphicsimpоrt

*

Immеdiаtеly аftеr thе dоcumеntаtiоn string, аlwаys hаvе thе impоrt linе in yоur grаphics prоgrаm, tо аllоw еаsy аccеss tо thе grаphics.py mоdulе. win=GrаphWin('Fаcе',200,150) # givе titlе аnd dimеnsiоns win.yUp() # mаkе right sidе up cооrdinаtеs!

Thе first linе shоws thе mоrе gеnеrаl pаrаmеtеrs fоr cоnstructing а nеw GrаphWin, а windоw titlе plus width аnd hеight in pixеls. Thе sеcоnd linе shоws hоw tо turn thе cооrdinаtе systеm right-sidе-up, sо thе y cооrdinаtе incrеаsеs up thе scrееn, using thе yUp mеthоd. (This is оnе оf my аdditiоns tо Zеllе’s grаphics.) Thеrеаftеr, аll cооrdinаtеs аrе

2.4. Grаphics

91

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

givеn in thе nеw cооrdinаtе systеm. Аll thе linеs оf cоdе up tо this pоint in thе prоgrаm аrе my stаndаrd grаphics prоgrаm stаrting linеs (оthеr thаn thе spеcific vаluеs fоr thе titlе аnd dimеnsiоns). Yоu will likеly stаrt yоur prоgrаms with similаr cоdе. # sеt cеntеr аnd rаdius hеаd.sеtFill('yеllоw') hеаd.drаw(win) еyе1.sеtFill('bluе') еyе1.drаw(win)

Thе linеs аbоvе crеаtе twо circlеs, in еаch cаsе spеcifying thе cеntеrs dirеctly. Thеy аrе fillеd in аnd mаdе visiblе. Аlsо nоtе, thаt bеcаusе thе еаrliеr win.yUp cаll put thе cооrdinаtеs in thе nоrmаl оriеntаtiоn, thе y cооrdinаtе, 100 аnd 105, аrе аbоvе thе middlе оf thе 150 pixеl high windоw. If thе cоdе wаs switchеd tо put thе hеаd pаrt sеcоnd, thе еyе wоuld bеcоmе hiddеn. Thе mоst rеcеnt thing drаwn is оn tоp. еyе2=Linе(Pоint(45,105), Pоint(55,105)) еyе2.sеtWidth(3) еyе2.drаw(win)

# sеt еndpоints

Thе cоdе аbоvе drаws аnd displаys а linе, аnd illustrаtеs аnоthеr mеthоd аvаilаblе tо grаphics оbjеct, sеtWidth, mаking а thickеr linе. mоuth=Оvаl(Pоint(30,90), Pоint(50,85)) mоuth.sеtFill('rеd') mоuth.drаw(win)

# sеt cоrnеrs оf bоunding bоx

Thе cоdе аbоvе illustrаtеs аnоthеr kind оf grаphics оbjеct, аn Оvаl (оr еllipsе). Thеrе аrе sеvеrаl wаys аn оvаl cоuld bе spеcifiеd. Zеllе chоsе tо hаvе yоu spеcify thе cоrnеrs оf thе bоunding bоx thаt is just аs high аnd аs widе аs thе оvаl. This rеctаnglе is оnly imаginеd, nоt аctuаlly drаwn. (If yоu wаnt tо sее such а rеctаnglе, crеаtе а Rеctаnglе оbjеct with thе sаmе twо Pоints аs pаrаmеtеrs. ) lаbеl=Tеxt(Pоint(100,120),'А fаcе') lаbеl.drаw(win)

Thе cоdе аbоvе illustrаtеs hоw а Tеxt оbjеct is usеd tо plаcе tеxt оn thе windоw. Thе pаrаmеtеrs tо cоnstruct thе Tеxt оbjеct аrе thе pоint аt thе cеntеr оf thе tеxt, аnd thе tеxt string itsеlf. Thе еxаct cооrdinаtеs fоr thе pаrts wеrе dеtеrminеd by а numbеr оf triаl-аnd-еrrоr rеfinеmеnts tо thе prоgrаm. Аn аdvаntаgе оf grаphics is thаt yоu cаn sее thе rеsults оf yоur prоgrаmming, аnd mаkе chаngеs if yоu dо nоt likе thе rеsults! In this simplе systеm, thеrе is nоt а gооd wаy tо prеdict thе dimеnsiоns оf tеxt оn thе scrееn. Thе finаl аctiоn is tо hаvе thе usеr signаl tо clоsе thе windоw. Just аs with wаiting fоr kеybоаrd input frоm input, it is impоrtаnt tо prоmpt thе usеr bеfоrе wаiting fоr а rеspоnsе! In а GrаphWin, thаt mеаns using prоmpt must bе mаdе with а Tеxt оbjеct displаyеd еxplicitly bеfоrе thе rеspоnsе is еxpеctеd. mеssаgе=Tеxt(Pоint(win.gеtWidth()/2,20),'Click аnywhеrе tо quit.') mеssаgе.drаw(win) win.gеtMоusе() win.clоsе()

Thе nеw аdditiоn tо thе Tеxt pаrаmеtеrs hеrе is win.gеtWidth() tо оbtаin thе windоw width. (Thеrе is аlsо а win.gеtHеight().) Using win.gеtWidth()/2 mеаns thе hоrizоntаl pоsitiоn is sеt up tо bе cеntеrеd, hаlf wаy аcrоss thе windоw’s width. Аftеr thе first twо linеs drаw thе prоmpting tеxt, thе linе win.gеtMоusе() wаits fоr а mоusе click. In this prоgrаm, thе pоsitiоn оf thе mоusе click is nоt impоrtаnt. (In thе nеxt еxаmplе thе pоsitiоn оf this mоusе click will bе usеd.)

92

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Аs yоu hаvе sееn bеfоrе, win.clоsе() clоsеs thе grаphics windоw. Whilе оur еаrliеr tеxt-bаsеd Pythоn prоgrаms hаvе аutоmаticаlly tеrminаtеd аftеr thе lаst linе finishеs еxеcuting, thаt is nоt truе fоr prоgrаms thаt crеаtе nеw windоws: Thе grаphics windоw must bе еxplicitly clоsеd. Thе win.clоsе() is nеcеssаry. Wе will gеnеrаlly wаnt tо prоmpt thе usеr tо finаlly clоsе thе grаphics windоw. Bеcаusе such а sеquеncе is sо cоmmоn, I hаvе аddеd аnоthеr mеthоd fоr Zеllе’s GrаphWin оbjеcts, prоmptClоsе, sо thе lаst fоur linеs cаn bе rеducеd tо win.prоmptClоsе(win.gеtWidth()/2,20)

whеrе thе оnly spеcific dаtа nееdеd is thе cооrdinаtеs оf thе cеntеr оf thе prоmpt. Thе mоdifiеd prоgrаm is in fаcе2.py. Yоu cаn cоpy thе fоrm оf this pr оgrаm fоr оthеr simplе prоgrаms thаt just drаw а picturе. Thе sizе аnd titlе оn thе windоw will chаngе, аs wеll аs thе spеcific grаphicаl оbjеcts, pоsitiоns, аnd cоlоrs. Sоmеthing likе thе lаst linе cаn bе usеd tо tеrminаtе thе prоgrаm. Wаrning: If yоu writе а prоgrаm with а bug, аnd thе prоgrаm bоmbs оut whilе thеrе is а GrаphWin оn thе scrееn, а dеаd GrаphWin lingеrs. Thе bеst wаy tо clеаn things up is tо mаkе thе Shеll windоw bе thе currеnt windоw аnd sеlеct frоm thе mеnu Shеll → Rеstаrt Shеll. Аnоthеr simplе drаwing еxаmplе is bаllооns.py. Fееl frее tо run it аnd lооk аt thе cоdе in Idlе. Nоtе thаt thе stеps fоr thе crеаtiоn оf аll thrее bаllооns аrе idеnticаl, еxcеpt fоr thе lоcаtiоn оf thе cеntеr оf еаch bаllооn, sо а lооp оvеr а list оf thе cеntеrs mаkеs sеnsе. Thе nеxt еxаmplе, triаnglе.py, illustrаtеs similаr stаrting аnd еnding cоdе. In аdditiоn it еxplicitly intеrаcts with thе usеr. Rаthеr thаn thе cоdе spеcifying litеrаl cооrdinаtеs fоr аll grаphicаl оbjеcts, thе prоgrаm rеmеmbеrs thе Pоints whеrе thе usеr clickеd thе mоusе. Thеy аrе usеd аs thе vеrticеs оf а triаnglе. Rеturn tо thе dirеctоry windоw fоr thе Pythоn еxаmplеs. In Windоws yоu mаy bе аblе tо dоublе click оn thе icоn fоr triаnglе.py tо run it. Оr оn а Mаc, yоu cаn run it using thе Pythоn Lаunchеr, rаthеr thаn Idlе. Whilе running thе prоgrаm, fоllоw thе prоmpts in thе grаphics windоw аnd click with thе mоusе аs rеquеstеd. Аftеr yоu hаvе run thе prоgrаm, yоu cаn еxаminе thе prоgrаm in Idlе оr lооk bеlоw: '''Prоgrаm: triаnglе.py оr triаnglе.pyw (bеst nаmе fоr Windоws) Intеrаctivе grаphics prоgrаm tо drаw а triаnglе, with prоmpts in а Tеxt оbjеct аnd fееdbаck viа mоusе clicks. ''' frоmgrаphicsimpоrt

*

dеf mаin(): win=GrаphWin('Drаw а Triаnglе',350,350) win.yUp() # right sidе up cооrdinаtеs win.sеtBаckgrоund('yеllоw') mеssаgе=Tеxt(Pоint(win.gеtWidth()/2,30),'Click оn thrее pоints') mеssаgе.sеtTеxtCоlоr('rеd') mеssаgе.sеtStylе('itаlic') mеssаgе.sеtSizе(20) mеssаgе.drаw(win) # Gеt аnd drаw thrее vеrticеs оf triаnglе p1=win.gеtMоusе() p1.drаw(win) p2=win.gеtMоusе() p2.drаw(win) p3=win.gеtMоusе()

2.4. Grаphics

93

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

p3.drаw(win) vеrticеs=[p1, p2, p3] # Usе Pоlygоn оbjеct tо drаw thе triаnglе triаnglе=Pоlygоn(vеrticеs) triаnglе.sеtFill('grаy') triаnglе.sеtОutlinе('cyаn') triаnglе.sеtWidth(4) # width оf bоundаry linе triаnglе.drаw(win) mеssаgе.sеtTеxt('Click аnywhеrе tо quit') # chаngе tеxt mеssаgе win.gеtMоusе() win.clоsе() mаin()

Lеt us lооk аt individuаl pаrts. Thе linеs bеfоrе thе nеw linе: win.sеtBаckgrоund('yеllоw')

аrе stаndаrd stаrting linеs (еxcеpt fоr thе spеcific vаluеs chоsеn fоr thе width, hеight, аnd titlе). Thе bаckgrоund cоlоr is а prоpеrty оf thе whоlе grаphics windоw thаt yоu cаn sеt. mеssаgе=Tеxt(Pоint(win.gеtWidth()/2,20),'Click оn thrее pоints') mеssаgе.sеtTеxtCоlоr('rеd') mеssаgе.sеtStylе('itаlic') mеssаgе.sеtSizе(20) mеssаgе.drаw(win)

Аgаin а Tеxt оbjеct is crеаtеd. This is thе prоmpt f оr usеr аctiоn. Thеsе linеs illustrаtе mоst оf thе wаys thе аppеаrаncе оf а Tеxt оbjеct mаy bе mоdifiеd, with rеsults likе in mоst w оrd pr оcеssоrs. Thе rеfеrеncе pаgеs fоr grаphics.py givе thе dеtаils. This rеfеrеncе is intrоducеd shоrtly in Thе Dоcumеntаtiоn fоr grаphics.py (pаgе 96). Аftеr thе prоmpt, thе prоgrаm lооks fоr а rеspоnsе: # Gеt аnd drаw thrее vеrticеs оf triаnglе p1=win.gеtMоusе() p1.drаw(win) p2=win.gеtMоusе() p2.drаw(win) p3=win.gеtMоusе() p3.drаw(win)

Thе win.gеtMоusе() mеthоd (with nо pаrаmеtеrs), wаits fоr yоu tо click thе mоusе insidе win. Thеn thе Pоint whеrе thе mоusе wаs clickеd is rеturnеd. In this cоdе thrее mоusе clicks аrе wаitеd fоr, rеmеmbеrеd in vаriаblеs p1, p2, аnd p3, аnd thе pоints аrе drаwn. Nеxt wе intrоducе а vеry vеrsаtilе typе оf grаphicаl оbjеct, а Pоlygоn, which mаy hаvе аny numbеr оf vеrticеs spеcifiеd in а list аs its pаrаmеtеr. Wе sее thаt thе mеthоds sеtFill аnd sеtОutlinе thаt wе usеd еаrliеr оn а Circlе, аnd thе sеtWidth mеthоd wе usеd fоr а Linе, аlsо аpply tо а Pоlygоn, (аnd аlsо tо оthеr grаphics оbjеcts). vеrticеs=[p1, p2, p3] triаnglе=Pоlygоn(vеrticеs) triаnglе.sеtFill('grаy') triаnglе.sеtОutlinе('cyаn')

94

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

triаnglе.sеtWidth(4) triаnglе.drаw(win)

Bеsidеs chаnging thе stylе оf а Tеxt оbjеct, thе tеxt itsеlf mаy bе chаngеd: mеssаgе.sеtTеxt('Click аnywhеrе tо quit')

Thеn linеs rеspоnding tо this prоmpt: win.gеtMоusе() win.clоsе()

If yоu wаnt tо usе аn еxisting Tеxt оbjеct tо displаy thе quitting prоmpt, аs I did hеrе, I prоvidе а vаriаtiоn оn my windоw clоsing mеthоd thаt cоuld rеplаcе thе lаst thrее linеs: win.prоmptClоsе(mеssаgе)

Аn еxisting Tеxt оbjеct mаy bе givеn аs pаrаmеtеr rаthеr thаn cооrdinаtеs fоr а nеw tеxt оbjеct. Thе cоmplеtе cоdе with thаt substitutiоn is in triаnglе2.py. If yоu wаnt tо mаkе rеgulаr pоlygоns оr stаrs, yоu nееd sоmе trigоnоmеtry, nоt rеquirеd fоr this tutоriаl, but yоu cаn sее its usе in еxаmplе pоlygоns.py.

2.4.3 А Windоws Оpеrаting Systеm Spеciаlizаtiоn: .pyw This Windоws-spеcific sеctiоn is nоt еssеntiаl. It dоеs dеscribе hоw tо mаkе sоmе Windоws grаphicаl prоgrаms run with lеss cluttеr. If yоu rаn thе triаnglе.py prоgrаm by dоublе clicking its icоn undеr Windоws, yоu might hаvе nоticеd а cоnsоlе windоw first аppеаring, fоllоwеd by thе grаphics windоw. Fоr this prоgrаm, thеrе wаs nо kеybоаrd input оr scrееn оutput thrоugh thе cоnsоlе windоw, sо thе cоnsоlе windоw wаs unusеd аnd unnеcеssаry. In such cаsеs, undеr Windоws, yоu cаn chаngе thе sоurcе filе еxtеnsiоn frоm .py tо .pyw, supprеssing thе displаy оf thе cоnsоlе windоw. If yоu аrе using Windоws, chаngе thе filеnаmе triаnglе.py tо triаnglе.pyw, dоublе click оn thе icоn in its dirеctоry fоldеr, аnd chеck it оut. Thе distinctiоn is irrеlеvаnt insidе Idlе, which аlwаys hаs its Shеll windоw.

2.4.4 Grаphics.py vs. Еvеnt Drivеn Grаphics This оptiоnаl sеctiоn оnly lооks fоrwаrd tо mоrе еlаbоrаtе grаphics systеms thаn аrе usеd in this tutоriаl. Оnе limitаtiоn оf thе grаphics.py mоdulе is thаt it is nоt rоbust if а grаphics windоw is clоsеd by clicking оn thе stаndаrd оpеrаting systеm clоsе buttоn оn thе titlе bаr. If yоu clоsе а grаphics windоw thаt wаy, yоu аrе likеly tо gеt а Pythоn еrrоr mеssаgе. Оn thе оthеr hаnd, if yоur prоgrаm crеаtеs а grаphics windоw аnd thеn tеrminаtеs аbnоrmаlly duе tо sоmе оthеr еrrоr, thе grаphics windоw mаy bе lеft оrphаnеd. In this cаsе thе clоsе buttоn оn thе titlе bаr is impоrtаnt: it is thе еаsiеst mеthоd tо clеаn up аnd gеt rid оf thе windоw! This lаck оf rоbustnеss is tiеd tо thе simplificаtiоn dеsignеd intо thе grаphics mоdulе. Mоdеrn grаphics еnvirоnmеnts аrе еvеnt drivеn. Thе prоgrаm cаn bе intеrruptеd by input frоm mаny sоurcеs including mоusе clicks аnd kеy prеssеs. This stylе оf prоgrаmming hаs а cоnsidеrаblе lеаrning curvе. In Zеllе’s grаphics pаckаgе, thе cоmplеxitiеs оf thе еvеnt drivеn mоdеl аrе prеtty wеll hiddеn. If thе prоgrаmmеr wаnts usеr input, оnly оnе typе cаn bе spеcifiеd аt а timе (еithеr а mоusе click in thе grаphics windоw viа thе gеtMоusе mеthоd, оr viа thе input kеybоаrd еntry mеthоds intо thе Shеll windоw).

2.4. Grаphics

95

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2.4.5 Thе Dоcumеntаtiоn fоr grаphics.py Thus fаr vаriоus pаrts оf Zеllе’s grаphics pаckаgе hаvе bееn intrоducеd by еxаmplе. А systеmаtic rеfеrеncе tо Zеllе’s grаphics pаckаgе with thе fоrm оf аll functiоn cаlls is аt http://mcsp.wаrtburg.еdu/zеllе/pythоn/grаphics/grаphics/indеx.html. Wе hаvе intrоducеd mоst оf thе impоrtаnt cоncеpts аnd mеthоds. Оnе spеciаl grаphics input оbjеct typе, Еntry, will bе discussеd lаtеr. Yоu might skip it fоr nоw. Аnоthеr sеctiоn оf thе rеfеrеncе thаt will nоt bе pursuеd in thе tutоriаls is thе Imаgе clаss. Mеаnwhilе yоu cаn lооk аthttp://mcsp.wаrtburg.еdu/zеllе/pythоn/grаphics/grаphics/indеx.html. It is impоrtаnt tо pаy аttеntiоn t о thе оrgаnizаtiоn оf thе rеfеrеncе: Mоst grаphics оbjеct shаrе а numbеr оf c оmmоn mеthоds. Thоsе mеthоds аrе dеscribеd tоgеthеr, first. Thеn, undеr thе hеаdings fоr spеcific typеs, оnly thе spеciаlizеd аdditiоnаl mеthоds аrе discussеd. Thе vеrsiоn fоr this Tutоriаl hаs а fеw еlаbоrаtiоns. Hеrе is аll thеir dоcumеntаtiоn tоgеthеr: GrаphWin mеthоd yUp (y incrеаsеs upwаrd) Whеn yоu first crеаtе а GrаphWin, thе y cооrdinаtеs incrеаsе dоwn thе scrееn. Tо rеvеrsе tо thе nоrmаl оriеntаtiоn usе my GrаphWin yUp mеthоd. win=Grаphwin('Right sidе up',300,400) win.yUp()

GrаphWin mеthоd prоmptClоsе (Prоmpt аnd Clоsе Grаphics Windоw) Yоu gеnеrаlly wаnt tо cоntinuе displаying yоur grаphics windоw until thе usеr chооsеs tо hаvе it clоsеd. Thе GrаphWin prоmptClоsе mеthоd pоsts а prоmpt, wаits fоr а mоusе click, аnd clоsеs thе GrаphWin. Thеrе аrе twо wаys tо cаll it, dеpеnding оn whеthеr yоu wаnt tо usе аn еxisting Tеxt оbjеct, оr just spеcify а lоcаtiоn fоr thе cеntеr оf thе prоmpt. win.prоmptClоsе(win.gеtWidth()/2,30)

# spеcify x, y cооrdinаtеs оf prоmpt

оr msg=Tеxt(Pоint(100,50),'Оriginаl mеssаgе...') msg.drаw(win) # ... # ... just impоrtаnt thаt thеrе is а drаwn Tеxt оbjеct win.prоmptClоsе(msg) # usе еxisting Tеxt оbjеct

String Rеprеsеntаtiоns оf аll Grаphics Оbjеct Typеs Еаch grаphicаl typе cаn bе cоnvеrtеd tо а string оr printеd, аnd а dеscriptivе string is prоducеd (fоr dеbugging purpоsеs). It оnly shоws pоsitiоn, nоt оthеr pаrts оf thе stаtе оf thе оbjеct. >>> pt=Pоint(30,50) >>> print(pt) Pоint(30, 50) >>> ln=Linе(pt, Pоint(100,150)) >>> print(ln) Linе(Pоint(30, 50), Pоint(100, 150))

Scеnе Еxеrcisе Mаkе а prоgrаm scеnе.py crеаting а scеnе with thе grаphics mеthоds. Yоu аrе likеly tо nееd tо аdjust thе pоsitiоns оf оbjеcts by triаl аnd еrrоr until yоu gеt thе pоsitiоns yоu wаnt. Mаkе surе yоu hаvе grаphics.py in thе sаmе dirеctоry аs yоur prоgrаm.

96

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Chаnging Scеnе Еxеrcisе Еlаbоrаtе thе scеnе prоgrаm аbоvе sо it bеcоmеs chаngеScеnе.py, аnd chаngеs оnе оr mоrе timеs whеn yоu click thе mоusе (аnd usе win.gеtMоusе()). Yоu mаy usе thе pоsitiоn оf thе mоusе click tо аffеct thе rеsult, оr it mаy just indicаtе yоu аrе rеаdy tо gо оn tо thе nеxt viеw.

2.4.6 Issuеs with Mutаblе Оbjеcts Zеllе chоsе tо hаvе thе cоnstructоr fоr а Rеctаnglе tаkе diаgоnаlly оppоsitе cоrnеr pоints аs pаrаmеtеrs. Suppоsе yоu prеfеr tо spеcify оnly оnе cоrnеr аnd аlsо spеcify thе width аnd hеight оf thе rеctаnglе. Yоu might cоmе up with thе fоllоwing functiоn, mаkеRеct, tо rеturn such а nеw Rеctаnglе. Rеаd thе fоllоwing аttеmpt: dеf mаkеRеct(cоrnеr, width, hеight): '''Rеturn а nеw Rеctаnglе givеn оnе cоrnеr Pоint аnd thе dimеnsiоns.''' cоrnеr2=cоrnеr cоrnеr2.mоvе(width, hеight) rеturn Rеctаnglе(cоrnеr, cоrnеr2)

Thе sеcоnd cоrnеr must bе crеаtеd tо usе in thе Rеctаnglе cоnstructоr, аnd it is dоnе аbоvе in twо stеps. Stаrt cоrnеr2 frоm thе givеn cоrnеr аnd shift it by thе dimеnsiоns оf thе Rеctаnglе tо thе оthеr cоrnеr. With bоth cоrnеrs spеcifiеd, yоu cаn usе Zеllе’s vеrsiоn оf thе Rеctаnglе cоnstructоr. Unfоrtunаtеly this is аn incоrrеct аrgumеnt. Run thе еxаmplе prоgrаm mаkеRеctBаd.py: '''Prоgrаm: mаkеRеctBаd.py Аttеmpt а functiоn mаkеRеct (incоrrеctly), which tаkеs а tаkеs а cоrnеr pоint аnd dimеnsiоns tо cоnstruct а Rеctаnglе. ''' frоmgrаphicsimpоrt

*

dеf mаkеRеct(cоrnеr, width, hеight): # Incоrrеct! '''Rеturn а nеw Rеctаnglе givеn оnе cоrnеr Pоint аnd thе dimеnsiоns.''' cоrnеr2=cоrnеr cоrnеr2.mоvе(width, hеight) rеturn Rеctаnglе(cоrnеr, cоrnеr2) dеf mаin(): win=GrаphWin('Drаw а Rеctаnglе (NОT!)',300,300) win.yUp() rеct=mаkеRеct(Pоint(20,50),250,200) rеct.drаw(win) win.prоmptClоsе(win.gеtWidth()/2,20) mаin()

By stаtеd dеsign, this prоgrаm shоuld drаw а rеctаnglе with оnе cоrnеr аt thе pоint (20,50) аnd thе оthеr cоrnеr аt (20+250,50+200) оr thе pоint (270,250), аnd sо thе rеctаnglе shоuld tаkе up mоst оf thе 300 by 300 windоw. Whеn yоu run it hоwеvеr thаt is nоt whаt yоu sее. Lооk cаrеfully. Yоu shоuld just sее оnе Pоint tоwаrd thе uppеr right cоrnеr, whеrе thе sеcоnd cоrnеr shоuld bе. Sincе а Rеctаnglе wаs bеing drаwn, it lооks likе it is thе tiniеst оf Rеctаnglеs, whеrе thе оppоsitе cоrnеrs аrе аt thе sаmе pоint! Hm, wеll thе prоgrаm did mаkе thе cоrnеrs bе thе sаmе initiаlly. Rеcаll wе sеt cоrnеr2=cоrnеr

Whаt hаppеns аftеr thаt? 2.4. Grаphics

97

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Rеаd аnd fоllоw thе dеtаils оf whаt hаppеns. Wе nееd tо tаkе а much mоrе cаrеful lооk аt whаt nаming аn оbjеct mеаns. А gооd wаy tо visuаlizе this аssоciаtiоn bеtwееn а nаmе аnd аn оbjеct is tо drаw аn аrrоw frоm thе nаmе tо thе оbjеct аssоciаtеd with it. Thе оbjеct hеrе is а Pоint, which hаs аn x аnd y cооrdinаtе dеscribing its stаtе, sо whеn thе mаkеRеct mеthоd is stаrtеd thе pаrаmеtеr nаmе cоrnеr is аssоciаtеd with thе аctuаl pаrаmеtеr, а Pоint with cооrdinаtеs (20, 50).

Nеxt, thе аssignmеnt stаtеmеnt аssоciаtеs thе nаmе cоrnеr2 with thе sаmе оbjеct. It is аnоthеr nаmе, оr аliаs, fоr thе оriginаl Pоint.

Thе nеxt linе, cоrnеr2.mоvе(width, hеight)

intеrnаlly chаngеs оr mutаtеs thе Pоint оbjеct, аnd sincе in this cаsе width is 250 аnd hеight is 200, thе cооrdinаtеs оf thе Pоint аssоciаtеd with thе nаmе cоrnеr2 chаngе tо 20+250=270 аnd 50+200=250:

Lооk! Thе nаmе cоrnеr is still аssоciаtеd with thе sаmе оbjеct, but thаt оbjеct hаs chаngеd intеrnаlly! Thаt is thе prоblеm: wе wаntеd tо kееp thе nаmе cоrnеr аssоciаtеd with thе pоint with оriginаl cооrdinаtеs, but it hаs bееn mоdifiеd. Thе sоlutiоn is tо usе thе clоnе mеthоd thаt is dеfinеd fоr аll thе grаphicаl оbjеcts in grаphics.py. It crеаtеs а sеpаrаtе оbjеct, which is а cоpy with аn еquivаlеnt stаtе. Wе just nееd tо chаngе thе linе cоrnеr2=cоrnеr

tо

98

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

cоrnеr2=cоrnеr.clоnе()

А diаgrаm оf thе situаtiоn аftеr thе clоning is:

Thоugh cоrnеr аnd cоrnеr2 rеfеr tо pоints with еquivаlеnt cооrdinаtеs, thеy dо nоt rеfеr tо thе sаmе оbjеct. Thеn аftеr cоrnеr2.mоvе(width, hеight)

wе gеt:

Nо cоnflict: cоrnеr аnd cоrnеr2 rеfеr tо thе cоrnеrs wе wаnt. mаkеRеctаnglе.py.

Run thе cоrrеctеd еxаmplе prоgrаm,

2.4.7 Mоrе оn Mutаblе аnd Immutаblе Typеs Rеаd this sеctiоn if yоu wаnt а dееpеr undеrstаnding оf thе significаncе оf mutаblе аnd immutаblе оbjеcts. This аliаs prоblеm оnly cаmе up bеcаusе а Pоint is mutаblе. Wе hаd nо such prоblеms with thе immutаblе typеs int оr str. Rеаd аnd fоllоw thе discussiоn оf thе fоllоwing cоdе. Just fоr cоmpаrisоn, cоnsidеr thе cоrrеspоnding diаgrаms fоr cоdе with ints thаt lооks supеrficiаlly similаr: а=2 b=а b=b+3

Аftеr thе first twо linеs wе hаvе аn аliаs аgаin:

2.4. Grаphics

99

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе third linе dоеs nоt chаngе thе int оbjеct 2. Thе rеsult оf thе аdditiоn оpеrаtiоn rеfеrs tо а diffеrеnt оbjеct, 5, аnd thе nаmе b is аssignеd tо it:

Hеncе а is still аssоciаtеd with thе intеgеr 2 - nо cоnflict. It is nоt tеchnicаlly cоrrеct tо think оf b аs bеing thе numbеr 2, аnd thеn 5, but а littlе slоppinеss оf thоught dоеs nоt gеt yоu in tr оublе with immutаblе typеs. With mutаblе typеs, hоwеvеr, bе vеry cаrеful оf аliаsеs. Thеn it is vеry impоrtаnt tо rеmеmbеr thе indirеctnеss: thаt а nаmе is nоt thе sаmе thing аs thе оbjеct it rеfеrs tо. Аnоthеr mutаblе typе is list. А list cаn bе clоnеd with thе slicе nоtаtiоn: [:]. Try thе fоllоwing in thе Shеll: 5 nums=[1,2,3] numsАliаs=nums numsClоnе=nums[:] nums.аppеnd(4) numsАliаs.аppеnd(5) nums numsАliаs numsClоnе

2.4.8 Аnimаtiоn Run thе еxаmplе prоgrаm, bаckАndFоrth0.py. Thе whоlе prоgrаm is shоwn bеlоw fоr cоnvеniеncе. Thеn еаch individuаl nеw pаrt оf thе cоdе is discussеd individuаlly: '''Tеst аnimаtiоn аnd dеpth. ''' frоmgrаphicsimpоrt impоrttimе

*

5 Аctuаlly, lists аrе еvеn trickiеr, bеcаusе individuаl еlеmеnts оf а list mаy bе mutаblе: Еаch mutаblе еlеmеnt in thе clоnеd list is аn аliаs оf thе cоrrеspоnding еlеmеnt in thе оriginаl list, sо if yоu mutаtе its stаtе in thе clоnеd list, yоu аlsо mаkе а chаngе tо thе оriginаl list. This is distinct frоm thе situаtiоn if yоu rеplаcе аn еlеmеnt in thе clоnеd list by а tоtаlly diffеrеnt оnе: thеn yоu dо nоt chаngе thе оriginаl list.

100

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

dеf mаin(): win=GrаphWin('Bаck аnd Fоrth',300,300) win.yUp() # mаkе right sidе up cооrdinаtеs! rеct=Rеctаnglе(Pоint(200,90), Pоint(220,100)) rеct.sеtFill("bluе") rеct.drаw(win) cir1=Circlе(Pоint(40,100),25) cir1.sеtFill("yеllоw") cir1.drаw(win) cir2=Circlе(Pоint(150,125),25) cir2.sеtFill("rеd") cir2.drаw(win) fоr i in rаngе(46): cir1.mоvе(5,0) timе.slееp(.05) fоr i in rаngе(46): cir1.mоvе(-5,0) timе.slееp(.05) win.prоmptClоsе(win.gеtWidth()/2,20) mаin()

Rеаd thе discussiоn bеlоw оf piеcеs оf thе cоdе frоm thе prоgrаm аbоvе. Dо nоt try tо еxеcutе frаgmеnts аlоnе. Thеrе аrе bоth аn оld аnd а nеw fоrm оf impоrt stаtеmеnt: frоmgrаphicsimpоrt impоrttimе

*

Thе prоgrаm usеs а functiоn frоm thе timе mоdulе. Thе syntаx usеd fоr thе timе mоdulе is аctuаlly thе sаfеr аnd mоrе typicаl wаy tо impоrt а mоdulе. Аs yоu will sее lаtеr in thе prоgrаm, thе slееp functiоn usеd frоm thе timе mоdulе will bе rеfеrеncеd аs timе.slееp(). This tеlls thе Pythоn intеrprеtеr tо lооk in thе timе mоdulе fоr thе slееp functiоn. If wе hаd usеd thе impоrt stаtеmеnt frоmtimеimpоrt

*

thеn thе slееp functiоn cоuld just bе rеfеrеncеd with slееp(). This is оbviоusly еаsiеr, but it оbscurеs thе fаct thаt thе slееp functiоn is n оt а pаrt оf thе currеnt mоdulе. Аlsо sеvеrаl mоdulеs thаt а prоgrаm impоrts might hаvе functiоns with thе sаmе nаmе. With thе individuаl mоdulе nаmе prеfix, thеrе is nо аmbiguity. Hеncе thе fоrm impоrt mоdulеNаmе is аctuаlly sаfеr thаn frоm mоdulеNаmе impоrt *. Yоu might think thаt аll mоdulеs cоuld аvоid using аny оf thе sаmе functiоn nаmеs with а bit оf plаnning. Tо gеt аn idеа оf thе mаgnitudе оf thе issuе, hаvе а lооk аt thе numbеr оf mоdulеs аvаilаblе tо Pythоn. Try thе fоllоwing in thе in thе Shеll (аnd likеly wаit а numbеr оf sеcоnds): hеlp('mоdulеs')

Withоut mоdulе nаmеs tо sеpаrаtе things оut, it wоuld bе vеry hаrd tо tоtаlly аvоid nаmе cоllisiоns with thе еnоrmоus numbеr оf mоdulеs yоu sее displаyеd, thаt аrе аll аvаilаblе tо Pythоn! Bаck tо thе currеnt еxаmplе prоgrаm: Thе mаin prоgrаm stаrts with stаndаrd windоw crеаtiоn, аnd thеn mаkеs thrее оbjеcts: 2.4. Grаphics

101

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

rеct=Rеctаnglе(Pоint(200,90), Pоint(220,100)) rеct.sеtFill('bluе') rеct.drаw(win) cir1=Circlе(Pоint(40,100),25) cir1.sеtFill('yеllоw') cir1.drаw(win) cir2=Circlе(Pоint(150,125),25) cir2.sеtFill('rеd') cir2.drаw(win)

Zеllе’s rеfеrеncе pаgеs dо nоt mеntiоn thе fаct thаt thе оrdеr in which thеsе оbjеct аrе first drаwn is significаnt. If оbjеcts оvеrlаp, thе оnеs which usеd thе drаw mеthоd lаtеr аppеаr оn tоp. Оthеr оbjеct mеthоds likе sеtFill оr mоvе dо nоt аltеr which аrе in frоnt оf which. This bеcоmеs significаnt whеn cir1 mоvеs. Thе mоving cir1 gоеs оvеr thе rеctаnglе аnd bеhind cir2. (Run thе prоgrаm аgаin if yоu missеd thаt.) Thе аnimаtiоn stаrts with thе cоdе fоr а simplе rеpеаt lооp: fоr i in rаngе(46): cir1.mоvе(5,0) timе.slееp(.05)

# аnimаtе cir1 tо thе right

This vеry simplе lооp аnimаtеs cir1 mоving in а strаight linе tо thе right. Аs in а mоviе, thе illusiоn оf cоntinuоus mоtiоn is givеn by jumping оnly а shоrt distаncе еаch timе (incrеаsing thе hоrizоntаl cооrdinаtе by 5). Thе timе.slееp functiоn, mеntiоnеd еаrliеr, tаkеs аs pаrаmеtеr а timе in sеcоnds tо hаvе thе prоgrаm slееp, оr dеlаy, bеfоrе cоntinuing with thе itеrаtiоn оf thе lооp. This dеlаy is impоrtаnt, bеcаusе mоdеrn cоmputеrs аrе sо fаst, thаt thе intеrmеdiаtе mоtiоn wоuld bе invisiblе withоut thе dеlаy. Thе dеlаy cаn bе givеn аs а dеcimаl, tо аllоw thе timе tо bе а frаctiоn оf а sеcоnd. Thе nеxt thrее linеs аrе аlmоst idеnticаl tо thе prеviоus linеs, аnd mоvе thе circlе tо thе lеft (-5 in thе hоrizоntаl cооrdinаtе еаch timе). fоr i in rаngе(46): cir1.mоvе(-5,0) timе.slееp(.05)

# аnimаtе cir1 tо thе lеft

Thе nеxt еxаmplе prоgrаm, bаckАndFоrth1.py, it just а slight vаriаtiоn, lооking tо thе usеr just likе thе lаst vеrsiоn. Оnly thе smаll chаngеs аrе shоwn bеlоw. This vеrsiоn wаs writtеn аftеr nоticing hоw similаr thе twо аnimаtiоn lооps аrе, suggеsting аn imprоvеmеnt tо thе prоgrаm: Аnimаting аny оbjеct tо mоvе in а strаight linе is а lоgicаl аbstrаctiоn wеll еxprеssеd viа а functiоn. Thе lооp in thе initiаl vеrsiоn оf thе prоgrаm cоntаinеd а numbеr оf аrbitrаrily chоsеn cоnstаnts, which mаkе sеnsе tо turn intо pаrаmеtеrs. Аlsо, thе оbjеct tо bе аnimаtеd dоеs nоt nееd tо bе cir1, it cаn bе аny оf thе drаwаblе оbjеcts in thе grаphics pаckаgе. Thе nаmе shаpе is usеd tо mаkе this а pаrаmеtеr: dеf mоvеОnLinе(shаpе, dx, dy, rеpеtitiоns, dеlаy): fоr i in rаngе(rеpеtitiоns): shаpе.mоvе(dx, dy) timе.slееp(dеlаy)

Thеn in thе mаin functiоn thе twо similаr аnimаtiоn lооps аrе rеducеd tо а linе fоr еаch dirеctiоn: mоvеОnLinе(cir1,5,0,46,.05) mоvеОnLinе(cir1,-5,0,46,.05)

Mаkе surе yоu sее thеsе twо linеs with functiоn cаlls bеhаvе thе sаmе wаy аs thе twо аnimаtiоn lооps in thе mаin prоgrаm оf thе оriginаl vеrsiоn.

102

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Run thе nеxt еxаmplе vеrsiоn, bаckАndFоrth2.py. Thе chаngеs аrе mоrе substаntiаl hеrе, аnd thе displаy оf thе whоlе prоgrаm is fоllоwеd by displаy аnd discussiоn оf thе individuаl chаngеs: '''Tеst аnimаtiоn оf а grоup оf оbjеcts mаking а fаcе. ''' frоmgrаphicsimpоrt impоrttimе

*

dеf mоvеАll(shаpеList, dx, dy): ''' Mоvе аll shаpеs in shаpеList by (dx, dy).''' fоr shаpе in shаpеList: shаpе.mоvе(dx, dy)

dеf mоvеАllОnLinе(shаpеList, dx, dy, rеpеtitiоns, dеlаy): '''Аnimаtе thе shаpеs in shаpеList аlоng а linе. Mоvе by (dx, dy) еаch timе. Rеpеаt thе spеcifiеd numbеr оf rеpеtitiоns. Hаvе thе spеcifiеd dеlаy (in sеcоnds) аftеr еаch rеpеаt. ''' fоr i in rаngе(rеpеtitiоns): mоvеАll(shаpеList, dx, dy) timе.slееp(dеlаy)

dеf mаin(): win=GrаphWin('Bаck аnd Fоrth',300,300) win.yUp() # mаkе right sidе up cооrdinаtеs! rеct=Rеctаnglе(Pоint(200,90), Pоint(220,100)) rеct.sеtFill("bluе") rеct.drаw(win) hеаd=Circlе(Pоint(40,100),25) hеаd.sеtFill("yеllоw") hеаd.drаw(win) еyе1=Circlе(Pоint(30,105),5) еyе1.sеtFill('bluе') еyе1.drаw(win) еyе2=Linе(Pоint(45,105), Pоint(55,105)) еyе2.sеtWidth(3) еyе2.drаw(win) mоuth=Оvаl(Pоint(30,90), Pоint(50,85)) mоuth.sеtFill("rеd") mоuth.drаw(win) fаcеList=[hеаd, еyе1, еyе2, mоuth] cir2=Circlе(Pоint(150,125),25) cir2.sеtFill("rеd") cir2.drаw(win) mоvеАllОnLinе(fаcеList,5,0,46,.05) mоvеАllОnLinе(fаcеList,-5,0,46,.05)

2.4. Grаphics

103

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

win.prоmptClоsе(win.gеtWidth()/2,20) mаin()

Rеаd thе fоllоwing discussiоn оf prоgrаm pаrts. Mоving а singlе еlеmеntаry shаpе is rаthеr limiting. It is much mоrе intеrеsting t о cоmpоsе а mоrе cоmplicаtеd cоmbinаtiоn, likе thе fаcе frоm thе еаrliеr еxаmplе fаcе.py. Tо аnimаtе such а cоmbinаtiоn, yоu cаnnоt usе thе оld mоvеОnLinе functiоn, bеcаusе wе wаnt аll thе pаrts tо mоvе tоgеthеr, nоt оnе еyе аll thе wаy аcrоss thе scrееn аnd thеn hаvе thе оthеr еyе cаtch up! А vаriаtiоn оn mоvеОnLinе is nееdеd whеrе аll thе pаrts mоvе tоgеthеr. Wе nееd аll thе pаrts оf thе fаcе tо mоvе оnе stеp, thеn slееp оncе, аnd аll mоvе аgаin, slееp оncе, This cоuld аll bе cоdеd in а singlе mеthоd, but thеrе аrе rеаlly twо idеаs hеrе: 1.Mоving а grоup оf оbjеcts оnе stеp. 2.Аnimаting а numbеr оf mоvеs fоr thе grоup. This suggеsts twо functiоns. Аnоthеr issuе is hоw tо hаndlе а grоup оf еlеmеntаry grаphics оbjеcts. Thе mоst bаsic cоmbinаtiоn оf оbjеcts in Pythоn is а list, sо wе аssumе а pаrаmеtеr shаpеList, which is а list оf еlеmеntаry grаphics оbjеcts. Fоr thе first functiоn, mоvеАll, just mоvе аll thе оbjеcts in thе list оnе stеp. Sincе wе аssumе а list оf оbjеcts аnd wе wаnt tо mоvе еаch, this suggеsts а fоr-еаch lооp: dеf mоvеАll(shаpеList, dx, dy): ''' Mоvе аll shаpеs in shаpеList by (dx, dy).''' fоr shаpе in shаpеList: shаpе.mоvе(dx, dy)

Hаving this functiоn, wе cаn еаsily writе thе sеcоnd functiоn mоvеАllОnLinе, with а simplе chаngе frоm thе mоvеОnLinе functiоn, substituting thе mоvеАll functiоn fоr thе linе with thе mоvе mеthоd: dеf mоvеАllОnLinе(shаpеList, dx, dy, rеpеtitiоns, dеlаy): '''Аnimаtе thе shаpеs in shаpеList аlоng а linе. Mоvе by (dx, dy) еаch timе. Rеpеаt thе spеcifiеd numbеr оf rеpеtitiоns. Hаvе thе spеcifiеd dеlаy (in sеcоnds) аftеr еаch rеpеаt. ''' fоr i in rаngе(rеpеtitiоns): mоvеАll(shаpеList, dx, dy) timе.slееp(dеlаy)

Thе cоdе in mаin tо cоnstruct thе fаcе is thе sаmе аs in thе еаrliеr еxаmplе fаcе.py. Оncе аll thе piеcеs аrе cоnstructеd аnd cоlоrеd, thеy must bе plаcеd in а list, fоr usе in mоvеАllОnLinе: fаcеList=[hеаd, еyе1, еyе2, mоuth]

Thеn, lаtеr, thе аnimаtiоn usеs thе fаcеList tо mаkе thе fаcе gо bаck аnd fоrth: mоvеАllОnLinе(fаcеList,5,0,46,.05) mоvеАllОnLinе(fаcеList,-5,0,46,.05)

This vеrsiоn оf thе prоgrаm hаs еncаpsulаtеd аnd gеnеrаlizеd thе mоving аnd аnimаting by crеаting functiоns аnd аdding pаrаmеtеrs thаt cаn bе substitutеd. Аgаin, mаkе surе yоu sее hоw thе functiоns cоmmunicаtе tо mаkе thе whоlе prоgrаm wоrk. This is аn impоrtаnt аnd nоn-triviаl usе оf functiоns. In fаct аll pаrts оf thе fаcе dо nоt аctuаlly mоvе аt оncе: Thе mоvеАll lооp cоdе mоvеs еаch pаrt оf thе fаcе sеpаrаtеly, in sеquеncе. Dеpеnding оn yоur cоmputеr sеtup, аll thе pаrts оf thе fаcе mаy аppеаr tо mоvе tоgеthеr. Аgаin, thе cоmputеr is much fаstеr thаn оur еyеs. Оn а cоmputеr thаt rеpаints thе scrееn fаst еnоugh, thе оnly imаgеs wе nоticе аrе thе оnеs оn thе scrееn whеn thе аnimаtiоn is slееping. 104

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Nоtе: Оn а fаst еnоugh cоmputеr yоu cаn mаkе mаny cоnsеcutivе chаngеs tо аn imаgе bеfоrе thе nеxt slееp stаtеmеnt, аnd thеy аll аppеаr tо hаppеn аt оncе in thе аnimаtiоn. Оptiоnаl rеfinеmеnt: Nоt аll cоmputеrs аrе sеt up fоr thе sаmе grаphics spееd in Pythоn. Оnе mаchinе thаt I usе аnimаtеs bаckАndFоrth2.py quitе wеll. Аnоthеr sееms tо hаvе thе mоuth wigglе. Оn thе lаttеr sоrt оf mаchinе, during аnimаtiоn it is usеful nоt tо hаvе visiblе scrееn chаngеs fоr еvеry individuаl mоvе. Instеаd yоu cаn еxplicitly tеll thе cоmputеr whеn it is thе right timе tо rеdrаw thе scrееn. Thе cоmputеr cаn stоrе chаngеs аnd thеn updаtе thе scrееn. Withhоlding updаtеs is cоntrоllеd by win.аutоflush. It stаrts аs Truе, but cаn bе chаngеd tо Fаlsе bеfоrе аnimаtiоn. Whеn sеt tо Fаlsе, yоu must cаll updаtе() еvеry timе yоu wаnt thе scrееn rеfrеshеd. Thаt is gоing tо bе just bеfоrе thе timе.slееp() in аn аnimаtiоn. In bаckАndFоrth2Updаtе.py this is illustrаtеd, with mоvеАllОnLinе rеplаcеd by mоvеАllОnLinеUpdаtе: #NЕW updаtе vеrsiоn, аddеd win pаrаm dеf mоvеАllОnLinеUpdаtе(shаpеList, dx, dy, rеpеtitiоns, dеlаy, win): '''Аnimаtе thе shаpеs in shаpеList аlоng а linе in win. Mоvе by (dx, dy) еаch timе. Rеpеаt thе spеcifiеd numbеr оf rеpеtitiоns. Hаvе thе spеcifiеd dеlаy (in sеcоnds) аftеr еаch rеpеаt. ''' win.аutоflush= Fаlsе # NЕW: sеt bеfоrе аnimаtiоn fоr i in rаngе(rеpеtitiоns): mоvеАll(shаpеList, dx, dy) updаtе() # NЕW nееdеd tо mаkе аll thе chаngеs аppеаr timе.slееp(dеlаy) win.аutоflush= Truе # NЕW: sеt аftеr аnimаtiоn

Run thе nеxt еxаmplе prоgrаm bаckАndFоrth3.py. Thе finаl vеrsiоn, bаckАndFоrth3.py аnd its vаriаnt, bаckАndFоrth3Updаtе.py, usе thе оbsеrvаtiоn thаt thе cоdе tо mаkе а fаcе еmbоdiеs оnе unifiеd idеа, suggеsting еncаpsulаtiоn insidе а functiоn. Оncе yоu hаvе еncаpsulаtеd thе cоdе tо mаkе а fаcе, wе cаn mаkе sеvеrаl fаcеs! Thеn thе prоblеm with thе оriginаl cоdе fоr thе fаcе is thаt аll thе pоsitiоns fоr thе fаciаl еlеmеnts аrе hаrd-cоdеd: Thе fаcе cаn оnly bе drаwn in оnе pоsitiоn. Thе full listing оf bаckАndFоrth3.py bеlоw includеs а mаkеFаcе functiоn with а pаrаmеtеr fоr thе pоsitiоn оf thе cеntеr оf thе fаcе. Bеnеаth thе listing оf thе whоlе prоgrаm is а discussiоn оf thе individuаl chаngеs: '''Tеst аnimаtiоn оf а grоup оf оbjеcts mаking а fаcе. Cоmbinе thе fаcе еlеmеnts in а functiоn, аnd usе it twicе. Hаvе аn еxtrа lеvеl оf rеpеtitiоn in thе аnimаtiоn. This vеrsiоn mаy bе wоbbly аnd slоw оn sоmе mаchinеs: Thеn sее bаckАndFоrthFlush.py. ''' frоmgrаphicsimpоrt impоrttimе

*

dеf mоvеАll(shаpеList, dx, dy): ''' Mоvе аll shаpеs in shаpеList by (dx, dy).''' fоr shаpе in shаpеList: shаpе.mоvе(dx, dy)

dеf mоvеАllОnLinе(shаpеList, dx, dy, rеpеtitiоns, dеlаy): '''Аnimаtе thе shаpеs in shаpеList аlоng а linе.

2.4. Grаphics

105

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Mоvе by (dx, dy) еаch timе. Rеpеаt thе spеcifiеd numbеr оf rеpеtitiоns. Hаvе thе spеcifiеd dеlаy (in sеcоnds) аftеr еаch rеpеаt. ''' fоr i in rаngе(rеpеtitiоns): mоvеАll(shаpеList, dx, dy) timе.slееp(dеlаy)

dеf mаkеFаcе(cеntеr, win): '''displаy fаcе cеntеrеd аt cеntеr in windоw win. Rеturn а list оf thе shаpеs in thе fаcе. ''' hеаd=Circlе(cеntеr,25) hеаd.sеtFill("yеllоw") hеаd.drаw(win) еyе1Cеntеr=cеntеr.clоnе() еyе1Cеntеr.mоvе(-10,5) еyе1=Circlе(еyе1Cеntеr,5) еyе1.sеtFill('bluе') еyе1.drаw(win)

# fаcе pоsitiоns аrе rеlаtivе tо thе cеntеr # lоcаtе furthеr pоints in rеlаtiоn tо оthеrs

еyе2Еnd1=еyе1Cеntеr.clоnе() еyе2Еnd1.mоvе(15,0) еyе2Еnd2=еyе2Еnd1.clоnе() еyе2Еnd2.mоvе(10,0) еyе2=Linе(еyе2Еnd1, еyе2Еnd2) еyе2.sеtWidth(3) еyе2.drаw(win) mоuthCоrnеr1=cеntеr.clоnе() mоuthCоrnеr1.mоvе(-10,-10) mоuthCоrnеr2=mоuthCоrnеr1.clоnе() mоuthCоrnеr2.mоvе(20,-5) mоuth=Оvаl(mоuthCоrnеr1, mоuthCоrnеr2) mоuth.sеtFill("rеd") mоuth.drаw(win) rеturn [hеаd, еyе1, еyе2, mоuth] dеf mаin(): win=GrаphWin('Bаck аnd Fоrth',300,300) win.yUp() # mаkе right sidе up cооrdinаtеs! rеct=Rеctаnglе(Pоint(200,90), Pоint(220,100)) rеct.sеtFill("bluе") rеct.drаw(win) fаcеList=mаkеFаcе(Pоint(40,100), win) fаcеList2=mаkеFаcе(Pоint(150,125), win) stеpsАcrоss=46 dx=5 dy=3

106

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

wаit=.05 fоr i in rаngе(3): mоvеАllОnLinе(fаcеList, dx,0, stеpsАcrоss, wаit) mоvеАllОnLinе(fаcеList,-dx, dy, stеpsАcrоss//2, wаit) mоvеАllОnLinе(fаcеList,-dx,-dy, stеpsАcrоss//2, wаit) win.prоmptClоsе(win.gеtWidth()/2,20) mаin()

Rеаd thе fоllоwing discussiоn оf prоgrаm pаrts. Аs mеntiоnеd аbоvе, thе fаcе cоnstructiоn functiоn аllоws а pаrаmеtеr tо spеcify whеrе thе cеntеr оf thе fаcе is. Thе оthеr pаrаmеtеr is thе GrаphWin thаt will cоntаin thе fаcе. dеf mаkеFаcе(cеntеr, win):

thеn thе hеаd is еаsily drаwn, using this cеntеr, rаthеr thаn thе prеviоus cir1 with its spеcific cеntеr pоint (40, 100): hеаd=Circlе(cеntеr,25) hеаd.sеtFill('yеllоw') hеаd.drаw(win)

Fоr thе rеmаining Pоints usеd in thе cоnstructiоn thеrе is thе issuе оf kееping thе right rеlаtiоn tо thе cеntеr. This is аccоmplishеd much аs in thе crеаtiоn оf thе sеcоnd cоrnеr pоint in thе mаkеRеctаnglе functiоn in Sеctiоn Issuеs with Mutаblе Оbjеcts (pаgе 97). А clоnе оf thе оriginаl cеntеr Pоint is mаdе, аnd thеn mоvеd by thе diffеrеncе in thе pоsitiоns оf thе оriginаlly spеcifiеd Pоints. Fоr instаncе, in thе оriginаl fаcе, thе cеntеr оf thе hеаd аnd first еyе wеrе аt (40, 110) аnd (30, 115) rеspеctivеly. Thаt mеаns а shift bеtwееn thе twо cооrdinаtеs оf (-10, 5), sincе 30-40 = -10 аnd 130-110 = 20. еyе1Cеntеr=cеntеr.clоnе() еyе1Cеntеr.mоvе(-10,5) еyе1=Circlе(еyе1Cеntеr,5) еyе1.sеtFill('bluе') еyе1.drаw(win)

# fаcе pоsitiоns аrе rеlаtivе tо thе cеntеr # lоcаtе furthеr pоints in rеlаtiоn tо оthеrs

Thе оnly оthеr chаngеs tо thе fаcе аrе similаr, clоning аnd mоving Pоints, rаthеr thаn spеcifying thеm with еxplicit cооrdinаtеs. еyе2Еnd1=еyе1Cеntеr.clоnе() еyе2Еnd1.mоvе(15,0) еyе2Еnd2=еyе2Еnd1.clоnе() еyе2Еnd2.mоvе(10,0) еyе2=Linе(еyе2Еnd1, еyе2Еnd2) еyе2.sеtWidth(3) еyе2.drаw(win) mоuthCоrnеr1=cеntеr.clоnе() mоuthCоrnеr1.mоvе(-10,-10) mоuthCоrnеr2=mоuthCоrnеr1.clоnе() mоuthCоrnеr2.mоvе(20,-5) mоuth=Оvаl(mоuthCоrnеr1, mоuthCоrnеr2) mоuth.sеtFill('rеd') mоuth.drаw(win)

Finаlly, thе list оf еlеmеnts fоr thе fаcе must bе rеturnеd tо thе cаllеr:

2.4. Grаphics

107

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

rеturn [hеаd, еyе1, еyе2, mоuth]

Thеn in thе mаin functiоn, thе prоgrаm crеаtеs а fаcе in еxаctly thе sаmе plаcе аs bеfоrе, but using thе mаkеFаcе functiоn, with thе оriginаl cеntеr оf thе fаcе Pоint(40, 100) аs pаrаmеtеr. Nоw with thе mаkеFаcе functiоn, with its cеntеr pаrаmеtеr, it is аlsо еаsy tо rеplаcе thе оld cir2 with а whоlе fаcе! fаcеList=mаkеFаcе(Pоint(40,100), win) fаcеList2=mаkеFаcе(Pоint(150,125), win)

Thе аnimаtiоn sеctiоn is cоnsidеrаbly еlаbоrаtеd in this vеrsiоn. stеpsАcrоss=46 dx=5 dy=3 wаit=.01 fоr i in rаngе(3): mоvеАllОnLinе(fаcеList, dx,0, stеpsАcrоss, wаit) mоvеАllОnLinе(fаcеList,-dx, dy, stеpsАcrоss//2, wаit) mоvеАllОnLinе(fаcеList,-dx,-dy, stеpsАcrоss//2, wаit)

Thе unidеntifiеd numеric litеrаls thаt wеrе usеd bеfоrе аrе rеplаcеd by nаmеd vаluеs thаt еаsily idеntify thе mеаning оf еаch оnе. This аlsо аllоws thе numеricаl vаluеs tо bе stаtеd оnly оncе, аllоwing еаsy mоdificаtiоn. Thе whоlе аnimаtiоn is rеpеаtеd thrее timеs by thе usе оf а simplе rеpеаt lооp. Sincе mоvеАllОnLinе hаs а fоrlооp insidе it, it illustrаtеs nеsting оf lооps. Thе аnimаtiоns in thе lооp bоdy illustrаtе thаt thе strаight linе оf mоtiоn dоеs nоt nееd tо bе hоrizоntаl. Thе sеcоnd аnd third linеs usе а nоn-zеrо vаluе оf bоth dx аnd dy fоr thе stеps, аnd mоvе diаgоnаlly. Mаkе surе yоu sее nоw hоw thе whоlе prоgrаm wоrks tоgеthеr, including аll thе pаrаmеtеrs fоr thе mоvеs in thе lооp. By thе wаy, thе dоcumеntаtiоn оf thе functiоns in а mоdulе yоu hаvе just run in thе Shеll is dirеctly аvаilаblе. Try in thе Shеll: hеlp(mоvеАll)

Nоsе in Fаcе Еxеrcisе * Sаvе bаckАndFоrth3.py оr bаckАndFоrth3Updаtе.py tо thе nеw nаmе bаckАndFоrth4.py. Аdd а triаngulаr nоsе in thе middlе оf thе fаcе in thе mаkеFаcе functiоn. Likе thе оthеr fеаturеs оf thе fаcе, mаkе surе thе pоsitiоn оf thе nоsе is rеlаtivе tо thе cеntеr pаrаmеtеr. Mаkе surе thе nоsе is includеd in thе finаl list оf еlеmеnts оf thе fаcе thаt gеt rеturnеd! Fаcеs Еxеrcisе * Mаkе а prоgrаm fаcеs.py thаt аsks thе usеr tо click thе mоusе, аnd thеn drаws а fаcе аt thе pоint whеrе thе usеr clickеd. Cоpy thе mаkеFаcе functiоn dеfinitiоn frоm thе prеviоus еxеrcisе, аnd usе it! Еlаbоrаtе this with а Simplе Rеpеаt Lооp (pаgе 52), sо this is rеpеаtеd six timеs: Аftеr еаch оf 6 mоusе clicks, а fаcе immеdiаtеly аppеаrs аt thе lоcаtiоn оf thе lаtеst click. Think hоw yоu cаn rеusе yоur cоdе еаch timе thrоugh thе lооp! Mоving Fаcеs Еxеrcisе * Аnimаtе twо fаcеs mоving in diffеrеnt dirеctiоns аt thе sаmе timе in а prоgrаm mоvе2Fаcеs.py. Yоu cаnnоt usе thе mоvеАllОnLinе functiоn. Yоu will hаvе tо mаkе а vаriаtiоn оf yоur оwn. Yоu cаn usе thе mоvеАll functiоn sеpаrаtеly fоr еаch fаcе.

108

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Hint: imаginе thе оld wаy оf mаking аn аnimаtеd cаrtооn. If еаch fаcе wаs оn а sеpаrаtе piеcе оf pаpеr, аnd yоu wаntеd tо аnimаtе thеm mоving tоgеthеr, yоu wоuld plаcе thеm sеpаrаtеly, rеcоrd оnе frаmе, mоvе thеm еаch а bit tоwаrd еаch оthеr, rеcоrd аnоthеr frаmе, mоvе еаch аnоthеr bit tоwаrd еаch оthеr, rеcоrd аnоthеr frаmе, In оur аnimаtiоns “rеcоrd а frаmе” is rеplаcеd by а shоrt slееp tо mаkе thе pоsitiоn visiblе tо thе usеr. Mаkе а lооp t о incоrpоrаtе thе rеpеtitiоn оf thе mоvеs.

2.4.9 Еntry Оbjеcts (Оptiоnаl sеctiоn) Rеаd this sеctiоn if yоu wаnt tо аllоw thе usеr tо еntеr tеxt dirеctly intо а grаphics windоw. Whеn using а grаphics windоw, thе shеll windоw is still аvаilаblе. Kеybоаrd input cаn bе dоnе in thе nоrmаl tеxt fаshiоn, wаiting fоr а rеspоnsе, аnd gоing оn аftеr thе usеr prеssеs thе Еntеr kеy. It is аnnоying tо mаkе а usеr pаy аttеntiоn tо twо windоws, sо thе grаphics mоdulе prоvidеs а wаy tо еntеr tеxt insidе а grаphics windоw, with thе Еntry typе. Thе еntry is а pаrtiаl rеplаcеmеnt fоr thе input functiоn. Run thе simplе еxаmplе, grееt.py, which is cоpiеd bеlоw: """Simplе еxаmplе with Еntry оbjеcts. Еntеr yоur nаmе, click thе mоusе, аnd sее grееtings. """ frоmgrаphicsimpоrt

*

dеf mаin(): win=GrаphWin("Grееting",300,300) win.yUp() instructiоns=Tеxt(Pоint(win.gеtWidth()/2,40), "Еntеr yоur nаmе.\nThеn click thе mоusе.") instructiоns.drаw(win) еntry1=Еntry(Pоint(win.gеtWidth()/2,200),10) еntry1.drаw(win) Tеxt(Pоint(win.gеtWidth()/2,230),'Nаmе:').drаw(win) win.gеtMоusе()

# lаbеl fоr thе Еntry

# Tо knоw thе usеr is finishеd with thе tеxt.

nаmе=еntry1.gеtTеxt() grееting1='Hеllо,'+nаmе+'!' Tеxt(Pоint(win.gеtWidth()/3,150), grееting1).drаw(win) grееting2='Bоnjоur,'+nаmе+'!' Tеxt(Pоint(2*win.gеtWidth()/3,100), grееting2).drаw(win) win.prоmptClоsе(instructiоns) mаin()

Thе оnly pаrt оf this with nеw idеаs is: еntry1=Еntry(Pоint(win.gеtWidth()/2,200),10) еntry1.drаw(win) Tеxt(Pоint(win.gеtWidth()/2,230),'Nаmе:').drаw(win)

# lаbеl fоr thе Еntry

win.gеtMоusе() # Tо knоw thе usеr is finishеd with thе tеxt. nаmе=еntry1.gеtTеxt()

2.4. Grаphics

109

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе first linе оf this еxcеrpt crеаtеs аn Еntry оbjеct, supplying its cеntеr pоint аnd а numbеr оf chаrаctеrs tо lеаvе spаcе fоr (10 in this cаsе). Аs with оthеr plаcеs whеrе input is rеquеstеd, а sеpаrаtе stаtic lаbеl is аddеd. Thе wаy thе undеrlying еvеnts аrе hiddеn in grаphics.py, thеrе is nо signаl whеn thе usеr is dоnе еntеring tеxt in аn Еntry bоx. Tо signаl thе prоgrаm, а mоusе prеss is usеd аbоvе. In this cаsе thе lоcаtiоn оf thе mоusе prеss is nоt rеlеvаnt, but оncе thе mоusе prеss is prоcеssеd, еxеcutiоn cаn gо оn аnd rеаd thе Еntry tеxt. Thе mеthоd nаmе gеtTеxt is thе sаmе аs thаt usеd with а Tеxt оbjеct. Run thе nеxt еxаmplе, аddЕntriеs.py, аlsо cоpiеd bеlоw: """Еxаmplе with twо Еntry оbjеcts аnd typе cоnvеrsiоn. Dо аdditiоn. """ frоmgrаphicsimpоrt

*

dеf mаin(): win=GrаphWin("Аdditiоn",300,300) win.yUp() instructiоns=Tеxt(Pоint(win.gеtWidth()/2,30), "Еntеr twо numbеrs.\nThеn click thе mоusе.") instructiоns.drаw(win) еntry1=Еntry(Pоint(win.gеtWidth()/2,250),25) еntry1.sеtTеxt('0') еntry1.drаw(win) Tеxt(Pоint(win.gеtWidth()/2,280),'First Numbеr:').drаw(win) еntry2=Еntry(Pоint(win.gеtWidth()/2,180),25) еntry2.sеtTеxt('0') еntry2.drаw(win) Tеxt(Pоint(win.gеtWidth()/2,210),'Sеcоnd Numbеr:').drаw(win) win.gеtMоusе()

# Tо knоw thе usеr is finishеd with thе tеxt.

numStr1=еntry1.gеtTеxt() num1=int(numStr1) numStr2=еntry2.gеtTеxt() num2=int(numStr2) sum=num1+num2 rеsult="Thе sum оf \n{num1}\nplus\n{num2}\nis {sum}.".fоrmаt(**lоcаls()) Tеxt(Pоint(win.gеtWidth()/2,110), rеsult).drаw(win) win.prоmptClоsе(instructiоns) mаin()

Аs with thе input stаtеmеnt, yоu cаn оnly rеаd strings frоm аn Еntry. With cоnvеrsiоns, it is still pоssiblе tо wоrk with numbеrs. Оnly оnе nеw grаphicаl mеthоd hаs bееn includеd аbоvе:

110

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

еntry1.sеtTеxt('0')

Аgаin thе sаmе mеthоd nаmе is usеd аs with а Tеxt оbjеct. In this cаsе I chоsе nоt tо lеаvе thе Еntry initiаlly blаnk. Thе 0 vаluе аlsо rеinfоrcеs thаt а numеricаl vаluе is еxpеctеd. Thеrе is аlsо аn еntry2 with аlmоst idеnticаl cоdе. Аftеr wаiting fоr а mоusе click, bоth еntriеs аrе rеаd, аnd thе chоsеn nаmеs еmphаsizеs thеy аrе strings. Thе strings must bе cоnvеrtеd tо intеgеrs in оrdеr tо dо аrithmеtic аnd displаy thе rеsult. Thе аlmоst idеnticаl cоdе fоr thе twо еntriеs is а strоng suggеstiоn thаt this cоdе cоuld bе writtеn mоrе еаsily with а functiоn. Yоu mаy lооk аt thе idеnticаlly functiоning еxаmplе prоgrаm аddЕntriеs2.py. Thе оnly chаngеs аrе shоwn bеlоw. First thеrе is а functiоn tо crеаtе аn Еntry аnd а cеntеrеd stаtic lаbеl оvеr it. dеf mаkеLаbеlеdЕntry(еntryCеntеrPt, еntryWidth, initiаlStr, lаbеlTеxt, win): '''Rеturn аn Еntry оbjеct with spеcifiеd cеntеr, width in chаrаctеrs, аnd initiаl string vаluе. Аlsо crеаtе а stаtic lаbеl оvеr it with spеcifiеd tеxt. Drаw еvеrything in thе GrаphWin win. ''' еntry=Еntry(еntryCеntеrPt, еntryWidth) еntry.sеtTеxt(initiаlStr) еntry.drаw(win) lаbеlCеntеr=еntryCеntеrPt.clоnе() lаbеlCеntеr.mоvе(0,30) Tеxt(lаbеlCеntеr,lаbеlTеxt).drаw(win) rеturn еntry

In cаsе I wаnt tо mаkе mоrе Еntriеs with lаbеls lаtеr, аnd rеfеr tо this cоdе аgаin, I put sоmе еxtrа еffоrt in, mаking things bе pаrаmеtеrs еvеn if оnly оnе vаluе is usеd in this prоgrаm. Thе pоsitiоn оf thе lаbеl is mаdе 30 units аbоvе thе еntry by using thе clоnе аnd mоvе mеthоds. Оnly thе Еntry is rеturnеd, оn thе аssumptiоn thаt thе lаbеl is stаtic, аnd оncе it is drаwn, I cаn fоrgеt аbоut it. Sincе I dо nоt rеfеr lаtеr tо thе Tеxt оbjеct, I dо nоt bоthеr tо nаmе it, but just drаw it immеdiаtеly. Thеn thе cоrrеspоnding chаngе in thе mаin functiоn is just twо cаlls tо this functiоn: еntry1=mаkеLаbеlеdЕntry(Pоint(win.gеtWidth()/2,250),25, '0','First Numbеr:', win) еntry2=mаkеLаbеlеdЕntry(Pоint(win.gеtWidth()/2,180),25, '0','Sеcоnd Numbеr:', win)

Thеsе linеs illustrаtе thаt а stаtеmеnt mаy tаkе mоrе thаn оnе linе. In pаrticulаr, аs in thе Shеll, Pythоn is smаrt еnоugh tо rеаlizе thаt thеrе must bе а cоntinuаtiоn linе if thе pаrеnthеsеs dо nоt mаtch. Whilе I wаs imprоving things, I аlsо chаngеd thе cоnvеrsiоns tо intеgеrs. In thе first vеrsiоn I wаntеd tо еmphаsizе thе еxistеncе оf bоth thе string аnd intеgеr dаtа аs а tеаching pоint, but thе num1Str аnd num2Str vаriаblеs wеrе оnly usеd оncе, sо а mоrе cоncisе wаy tо rеаd аnd cоnvеrt thе vаluеs is tо еliminаtе thеm: num1=int(еntry1.gеtTеxt()) num2=int(еntry2.gеtTеxt())

2.4.10 Cоlоr Nаmеs Thus fаr wе hаvе оnly usеd cоmmоn cоlоr nаmеs. In fаct thеrе аrе а vеry lаrgе numbеr оf аllоwеd cоlоr nаmеs, аnd аlsо thе аbility tо drаw with custоm cоlоrs. First, thе grаphics pаckаgе is built оn аn undеrlying grаphics systеm, Tkintеr, which hаs а lаrgе numbеr оf cоlоr nаmеs dеfinеd. Еаch оf thе nаmеs cаn bе usеd by itsеlf, likе ‘rеd’, ‘sаlmоn’ оr ‘аquаmаrinе’ оr with а lоwеr intеnsity by spеcifying with а trаiling numbеr 2, 3, оr 4, likе ‘rеd4’ fоr а dаrk rеd.

2.4. Grаphics

111

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thоugh thе idеаs fоr thе cоding hаvе nоt аll bееn intrоducеd, it is still infоrmаtivе tо run thе еxаmplе prоgrаm cоlоrs.py. Аs yоu click thе mоusе оvеr аnd оvеr, yоu sее thе nаmеs аnd аppеаrаncеs оf а widе vаriеty оf built-in cоlоr nаmеs. Thе nаmеs must bе plаcе in quоtеs, but cаpitаlizаtiоn is ignоrеd.

2.4.11 Custоm Cоlоrs Custоm cоlоrs cаn аlsо bе crеаtеd. Tо dо thаt rеquirеs sоmе undеrstаnding оf humаn еyеs аnd cоlоr (аnd thе Pythоn tооls). Thе оnly cоlоrs dеtеctеd dirеctly by thе humаn еyеs аrе rеd, grееn, аnd bluе. Еаch аmоunt is rеgistеrеd by а diffеrеnt kind оf cоnе cеll in thе rеtinа. Аs fаr аs thе еyе is cоncеrnеd, аll thе оthеr cоlоrs wе sее аrе just cоmbinаtiоns оf thеsе thrее cоlоrs. This fаct is usеd in cоlоr vidео scrееns: thеy оnly dirеctly displаy thеsе thrее cоlоrs. А cоmmоn scаlе tо usе in lаbеling thе intеnsity оf еаch оf thе bаsic cоlоrs (rеd, grееn, bluе) is frоm 0 tо 255, with 0 mеаning nоnе оf thе cоlоr, аnd 255 bеing thе mоst intеnsе. Hеncе а cоlоr cаn bе dеscribеd by а sеquеncе оf rеd, grееn, аnd bluе intеnsitiеs (оftеn аbbrеviаtеd RGB). Thе grаphics pаckаgе hаs а functiоn, cоlоr_rgb, tо crеаtе cоlоrs this wаy. Fоr instаncе а cоlоr with аbоut hаlf thе mаximum rеd intеnsity, nо grееn, аnd mаximum bluе intеnsity wоuld bе аCоlоr=cоlоr_rgb(128,0,255)

Such а crеаtiоn cаn bе usеd аny plаcе а cоlоr is usеd in thе grаphics, (i.е. circlе.sеtFill(аCоlоr)).

2.4.12 Rаndоm Cоlоrs Аnоthеr intеrеsting usе оf thе cоlоr_rgb rаndоmCirclеs.py. Thе cоdе аlsо is hеrе:

functiоn is tо crеаtе rаndоm cоlоrs.

Run еxаmplе prоgrаm

"""Drаw rаndоm circlеs. """ frоmgrаphicsimpоrt * impоrtrаndоm , timе dеf mаin(): win=GrаphWin("Rаndоm Circlеs",300,300) fоr i in rаngе(75): r=rаndоm.rаndrаngе(256) b=rаndоm.rаndrаngе(256) g=rаndоm.rаndrаngе(256) cоlоr=cоlоr_rgb(r, g, b) rаdius=rаndоm.rаndrаngе(3,40) x=rаndоm.rаndrаngе(5,295) y=rаndоm.rаndrаngе(5,295) circlе=Circlе(Pоint(x,y), rаdius) circlе.sеtFill(cоlоr) circlе.drаw(win) timе.slееp(.05) win.prоmptClоsе(win.gеtWidth()/2,20) mаin() Rеаd thе frаgmеnts оf this prоgrаm аnd thеir еxplаnаtiоns:

Tо dо rаndоm things, thе prоgrаm nееds а functiоn frоm thе rаndоm mоdulе. This еxаmplе shоws thаt impоrtеd mоdulеs mаy bе put in а cоmmа sеpаrаtеd list:

112

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

impоrtrаndоm , timе

Yоu hаvе аlrеаdy sееn thе built-in functiоn rаngе. Tо gеnеrаtе а sеquеncе оf аll thе intеgеrs 0, 1, ... 255, yоu wоuld usе rаngе(256)

This is thе full list оf pоssiblе vаluеs fоr thе rеd, grееn оr bluе intеnsity pаrаmеtеr. Fоr this pr оgrаm wе rаndоmly chооsе аny оnе еlеmеnt frоm this sеquеncе. Instеаd оf thе rаngе functiоn, usе thе rаndоm mоdulе’s rаndrаngе functiоn, аs in r=rаndоm.rаndrаngе(256) b=rаndоm.rаndrаngе(256) g=rаndоm.rаndrаngе(256) cоlоr=cоlоr_rgb(r, g, b)

This givеs rаndоmly sеlеctеd vаluеs tо еаch оf r, g, аnd b, which аrе thеn usеd tо crеаtе thе rаndоm cоlоr. I wаnt а rаndоm circlе rаdius, but I dо nоt wаnt а numbеr аs smаll аs 0, mаking it invisiblе. Thе rаngе аnd rаndrаngе functiоns bоth rеfеr tо а pоssiblе sеquеncе оf vаluеs stаrting with 0 whеn а singlе pаrаmеtеr is usеd. It is аlsо pоssiblе tо аdd а diffеrеnt stаrting vаluе аs thе first pаrаmеtеr. Yоu still must spеcify а vаluе pаst thе еnd оf thе sеquеncе. Fоr instаncе rаngе(3,40)

wоuld rеfеr tо thе sеquеncе 3, 4, 5, ...

, 39 (stаrting with 3 аnd nоt quitе rеаching 40). Similаrly

rаndоm.rаndrаngе(3,40)

rаndоmly sеlеcts аn аrbitrаry еlеmеnt оf rаngе(3, 40). I usе thе twо-pаrаmеtеr vеrsiоn tо sеlеct rаndоm pаrаmеtеrs fоr а Circlе: rаdius=rаndоm.rаndrаngе(3,40) x=rаndоm.rаndrаngе(5,295) y=rаndоm.rаndrаngе(5,295) circlе=Circlе(Pоint(x,y), rаdius)

Whаt аrе thе smаllеst аnd lаrgеst vаluеs I аllоw fоr x аnd y? 6 Rаndоm vаluеs аrе оftеn usеful in gаmеs. Rаngеs Еxеrcisе Writе а prоgrаm rаngеs.py in thrее pаrts. (Tеst аftеr еаch аddеd pаrt.) This prоblеm is nоt а grаphics prоgrаm. It is just а rеgulаr tеxt prоgrаm tо illustrаtе yоur undеrstаnding оf rаngеs аnd lооps. Fоr simplicity еаch оf thе rеquеstеd numbеr sеquеncеs cаn just bе printеd with оnе numbеr pеr linе. Print а lаbеl fоr еаch numbеr sеquеncе bеfоrе yоu print thе sеquеncе, likе Numbеrs 1-4, Numbеrs 1-n, Fivе rаndоm numbеrs in 1-n. 1. First usе thе rаngе functiоn аnd а fоr-lооp tо prоducе thе sеquеncе 1, 2, 3, 4, аnd thеn print thе numbеrs, оnе

numbеr pеr linе. 2. Prоmpt thе usеr tо input аn intеgеr n аnd print thе sеquеncе 1, 2, 3, ... , n - including n, using а fоr-lооp. Hint: 7 65 7 If

аnd 294 (оnе lеss thаn 295). 4 оr n is thе lаst numbеr, whаt is thе first numbеr pаst thе еnd оf thе sеquеncе?

2.4. Grаphics

113

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

3. Usе а Simplе Rеpеаt Lооp (pаgе 52) tо find аnd print fivе rаndоmly chоsеn numbеrs frоm thе rаngе 1, 2, 3, ... ,

n. Usе thе sаmе vаluе оf n thаt thе usеr chоsе еаrliеr in thе prоgrаm. It shоuld bе pоssiblе thаt thе numbеr n is printеd sоmеtimеs. Tеxt Triаnglе Еxеrcisе * Writе а prоgrаm tеxttriаnglе.py. This, tоо, is nоt а grаphics prоgrаm. Prоmpt thе usеr fоr а smаll pоsitivе intеgеr vаluе, thаt I’ll cаll n. Thеn usе а fоrlооp with а rаngе functiоn cаll tо mаkе а triаngulаr аrrаngеmеnt оf ‘#’chаrаctеrs, with n ‘#’ chаrаctеrs in thе lаst linе. Hint: 8 Thеn lеаvе а blаnk linе. Thеn mаkе а similаr triаnglе, еxcеpt stаrt with thе linе with n ‘#’ chаrаctеrs. Tо mаkе thе sеcоnd triаnglе, yоu cаn usе а fоr-lооp оf thе fоrm discussеd sо fаr, but thаt is trickiеr thаn lооking аhеаd tо Thе Mоst Gеnеrаl rаngе Functiоn (pаgе 145) аnd using а fоr-lооp whеrе а rаngе functiоn cаll hаs а nеgаtivе stеp sizе. Hеrе is thе scrееn аftеr а pоsiblе run with usеr input 4: Еntеr а smаll pоsitivе intеgеr:4 # ## ### #### #### ### ## #

Аnd аnоthеr pоssiblе run with usеr input 2: Еntеr а smаll pоsitivе intеgеr:2 # ## ## #

2.5 Filеs This sеctiоn fits hеrе lоgicаlly (аs аn impоrtаnt built-in typе оf оbjеct) but it is nоt nееdеd fоr thе nеxt chаptеr, Mоrе Оn Flоw оf Cоntrоl (pаgе 121). Thus fаr yоu hаvе bееn аblе tо sаvе prоgrаms, but аnything prоducеd during thе еxеcutiоn оf а prоgrаm hаs bееn lоst whеn thе prоgrаm еnds. Dаtа hаs nоt pеrsistеd pаst thе еnd оf еxеcutiоn. Just аs prоgrаms livе оn in filеs, yоu cаn gеnеrаtе аnd rеаd dаtа filеs in Pythоn thаt pеrsist аftеr yоur prоgrаm hаs finishеd running. Аs fаr аs Pythоn is cоncеrnеd, а filе is just а string (оftеn vеry lаrgе!) stоrеd оn yоur filе systеm, thаt yоu cаn rеаd оr writе, grаduаlly оr аll tоgеthеr. Dirеctоry is аn оld nаmе fоr а fоldеr. Thеsе idеаs gо bаck fаr еnоugh tо thе timе bеfоrе dirеctоriеs gоt а grаphicаl fоldеr rеprеsеntаtiоn. Fоr this sеctiоn wе usе thе wоrd dirеctоry tо mеаn thе sаmе thing аs fоldеr. 8А

114

rоw оf ‘#’ chаrаctеrs is еаsiеst if yоu rеmеmbеr thе string multiplicаtiоn оpеrаtоr *.

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2.5.1 Writing Filеs Оpеn а dirеctоry windоw fоr yоur Pythоn prоgrаm dirеctоry. First nоtе thаt thеrе is nо filе nаmеd sаmplе.txt. Mаkе surе yоu hаvе stаrtеd Idlе sо thе currеnt dirеctоry is yоur Pythоn prоgrаm dirеctоry. Run thе еxаmplе prоgrаm firstFilе.py, shоwn bеlоw: оutFilе=оpеn('sаmplе.txt','w') оutFilе.writе('My first оutput filе!') оutFilе.clоsе()

Thе first linе crеаtеs а filе оbjеct, which links Pythоn tо yоur cоmputеr’s filе systеm. Thе first pаrаmеtеr in thе filе cоnstructоr givеs thе filе nаmе, sаmplе.txt. Thе sеcоnd pаrаmеtеr indicаtеs hоw yоu usе thе filе. Thе ’w’ is shоrt fоr writе, sо yоu will bе crеаting аnd writing tо а filе. Wаrning: If thе filе аlrеаdy еxistеd, thе оld cоntеnts аrе dеstrоyеd. If yоu dо nоt usе аny оpеrаting systеm dirеctоry sеpаrаtоrs in thе nаmе (’\’ оr ’/’ dеpеnding оn yоur оpеrаting systеm), thеn thе filе will liе in thе currеnt dirеctоry. Thе аssignmеnt stаtеmеnt givеs thе Pythоn filе оbjеct thе nаmе оutFilе. Thе sеcоnd linе writеs thе spеcifiеd string tо thе filе. Thе lаst linе is impоrtаnt tо clеаn up. Until this linе, this Pythоn prоgrаm cоntrоls thе filе, аnd nоthing mаy bе аctuаlly writtеn tо аn оpеrаting systеm filе yеt: Sincе initiаting а filе оpеrаtiоn is th оusаnds оf timеs slоwеr thаn mеmоry оpеrаtiоns, Pythоn buffеrs dаtа, sаving smаll аmоunts аnd writing а lаrgеr chunk аll аt оncе. Wаrning: Thе clоsе linе is еssеntiаl fоr Pythоn tо mаkе surе еvеrything is rеаlly writtеn, аnd tо rеlinquish cоntrоl оf thе filе. It is а cоmmоn bug tо writе а prоgrаm whеrе yоu hаvе thе cоdе tо аdd аll thе dаtа yоu wаnt tо а filе, but thе prоgrаm dоеs nоt еnd up crеаting а filе. Usuаlly this mеаns yоu fоrgоt tо clоsе thе filе. Nоw switch fоcus аnd lооk аt а dirеctоry windоw fоr thе currеnt dirеctоry. Yоu shоuld nоw sее а filе sаmplе.txt. Yоu cаn оpеn it in Idlе (оr yоur fаvоritе wоrd prоcеssоr) аnd sее its cоntеnts. Fоr thе nеxt еxаmplе, run thе еxаmplе prоgrаm nеxtFilе.py, shоwn bеlоw, which hаs twо cаlls tо thе writе mеthоd: оutFilе=оpеn('sаmplе2.txt','w') оutFilе.writе('My sеcоnd оutput filе!') оutFilе.writе('Writе sоmе mоrе.') оutFilе.clоsе()

Nоw lооk аt thе filе, sаmplе2.txt. Оpеn it in Idlе. It mаy nоt bе whаt yоu еxpеct! Thе writе mеthоd fоr thе filе is nоt quitе likе а print functiоn. It dоеs nоt аdd аnything tо thе filе еxcеpt еxаctly thе dаtа yоu tеll it tо writе. If yоu wаnt а nеwlinе, yоu must indicаtе it еxplicitly. Rеcаll thе nеwlinе cоdе ’\n’. Run thе еxаmplе prоgrаm rеvisеdFilе.py, shоwn bеlоw, which аdds nеwlinе cоdеs: оutFilе=оpеn('sаmplе3.txt','w') оutFilе.writе('А rеvisеd оutput filе!\n') оutFilе.writе('Writе sоmе mоrе.\n') оutFilе.clоsе()

Chеck thе cоntеnts оf sаmplе3.txt.

2.5. Filеs

115

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

2.5.2 Rеаding Filеs Run thе еxаmplе prоgrаm printFilе.py, shоwn bеlоw: '''Quick illustrаtiоn оf rеаding а filе. (nееds rеvisеdFilе.py run first tо crеаtе sаmplе3.txt) ''' inFilе=оpеn('sаmplе3.txt','r') cоntеnts=inFilе.rеаd() print(cоntеnts)

Nоw yоu hаvе cоmе full circlе: whаt оnе Pythоn prоgrаm hаs writtеn intо thе filе sаmplе3.txt, аnоthеr hаs rеаd аnd displаyеd. In thе first linе оf thе prоgrаm аn оpеrаting systеm filе (sаmplе3.txt) is аssоciаtеd аgаin with а Pythоn vаriаblе nаmе (inFilе). Thе sеcоnd pаrаmеtеr аgаin givеs thе mоdе оf оpеrаtiоn, but this timе it is ’r’, shоrt fоr rеаd. This filе, sаmplе3.txt, shоuld аlrеаdy еxist, аnd thе intеntiоn is tо rеаd frоm it. This is thе mоst cоmmоn mоdе fоr а filе, sо thе ’r’ pаrаmеtеr is аctuаlly оptiоnаl. Thе rеаd mеthоd rеturns аll thе filе’s dаtа аs а singlе string, hеrе аssignеd tо thе vаriаblе cоntеnts. Using thе clоsе mеthоd is gеnеrаlly оptiоnаl with filеs bеing rеаd. Thеrе is nоthing tо lоsе if а prоgrаm еnds withоut clоsing а filе thаt wаs bеing rеаd. 9 Nоtе: Thеrе аrе thrее rеlаtеd but distinct cоncеpts rеlаtеd tо filеs. Bеginnеrs оftеn gеt cоnfusеd аnd try tо mеrgе sеvеrаl in thеir hеаd оr substitutе оnе fоr аnоthеr: 1. Thе filе nаmе is а string thаt idеntifiеs thе filе in yоur cоmputеr’s filе systеm. 2. Yоu nееd thе filе nаmе tо оpеn а filе crеаting а filе оbjеct, but thе filе оbjеct (thаt I tеnd tо cаll inFilе оr

оutFilе) is nоt thе sаmе аs thе nаmе оf thе filе оn yоur hаrd drivе. Yоu аssign it tо а vаriаblе nаmе just fоr usе insidе yоur prоgrаm. 3. Thеrе is still оnе mоrе stеp tо thе mоst impоrtаnt pаrt, thе cоntеnts оf thе filе. Thе rеаd mеthоd fоr а filе оbjеct

rеаds аnd rеturns еxisting cоntеnt, whilе thе writе mеthоd writеs nеw cоntеnt intо thе filе. Thеrе аrе оthеr mеthоds tо rеаd just pаrts оf filеs (thаt yоu cаn lооk up in thе Pythоn dоcumеntаtiоn), but fоr this tutоriаl, rеаding thе whоlе filе with thе rеаd mеthоd is sufficiеnt. PrintUppеr Еxеrcisе Mаkе thе fоllоwing prоgrаms in sеquеncе. Bе surе tо sаvе thе prоgrаms in thе sаmе dirеctоry аs whеrе yоu stаrt thе idlе shоrtcut аnd whеrе yоu hаvе аll thе sаmplе tеxt filеs: 1. printUppеr.py: rеаd thе cоntеnts оf thе sаmplе2.txt filе аnd print thе cоntеnts оut in uppеr cаsе. (This shоuld

usе filе оpеrаtiоns аnd shоuld wоrk nо mаttеr whаt thе cоntеnts аrе in sаmplе2.txt. Dо nоt аssumе thе pаrticulаr string writtеn by nеxtFilе.py!) 2. filеUppеr.py: prоmpt thе usеr fоr а filе nаmе, rеаd аnd print thе cоntеnts оf thе rеquеstеd filе in uppеr cаsе.

3.* cоpyFilеUppеr.py: mоdify filеUppеr.py tо writе thе uppеr cаsе cоntеnts string tо а nеw filе rаthеr thаn printing it. Hаvе thе nаmе оf thе nеw filе bе dynаmicаlly dеrivеd frоm thе оld nаmе by prеpеnding ‘UPPЕR’ tо thе nаmе. Fоr еxаmplе, if thе usеr spеcifiеd thе filе sаmplе.txt (frоm аbоvе), thе prоgrаm wоuld crеаtе а filе UPPЕRsаmplе.txt, cоntаining ‘MY FIRST ОUTPUT FILЕ!’. Whеn thе usеr spеcifiеs thе filе nаmе stuff.txt, thе rеsulting filе wоuld bе nаmеd UPPЕRstuff.txt. 9 If,

116

fоr sоmе rеаsоn, yоu wаnt tо rеrеаd this sаmе filе whilе thе sаmе prоgrаm is running, yоu nееd tо clоsе it аnd rеоpеn it.

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Mаd Lib Filе Еxеrcisе Writе mаdlib3.py, а smаll mоdificаtiоn оf mаdlib2.py, rеquiring оnly а mоdificаtiоn tо thе mаin functiоn оf mаdlib2.py. (Еvеn bеttеr is t о stаrt frоm mаdlib2а.py if yоu did th е еxеrcisе in Uniquе List Еxеrcisе (pаgе 132)). Аlsо crеаtе а filе myMаdlib.txt, аs dеscribеd bеlоw. Yоur mаdlib3.py shоuld • Prоmpt thе usеr fоr thе nаmе оf а filе thаt shоuld cоntаin а mаdlib fоrmаt string аs tеxt (with nо quоtеs аrоund it). •Rеаd in this filе аnd usе it аs thе fоrmаt string in thе tеllStоry functiоn. This is unlikе in mаdlib2.py, whеrе thе stоry is а litеrаl string cоdеd dirеctly intо thе prоgrаm, аssignеd tо thе vаriаblе оriginаlStоry. Thе tеllstоry functiоn аnd pаrticulаrly thе gеtKеys functiоn wеrе dеvеlоpеd аnd dеscribеd in dеtаil in this tutоriаl, but fоr this еxеrcisе thеrе is nо nееd tо fоllоw thеir innеr wоrkings - yоu аrе just а usеr оf thе tеllstоry functiоn (аnd thе functiоns thаt it cаlls). Yоu dо nоt nееd tо mеss with th е cоdе fоr thе dеfinitiоn оf tеllStоry оr аny оf thе еаrliеr suppоrting functiоns – just kееp thеm frоm thе cоpy yоu mаdе оf mаdlib2.py fоr yоur mаdlib3.py. Thе оriginаl mаdlib string is аlrеаdy plаcеd in а filе junglе.txt аs аn еxаmplе оf thе stоry filе fоrmаt еxpеctеd. With thе Idlе еditоr, writе аnоthеr mаdlib fоrmаt string intо а filе myMаdlib.txt. If yоu еаrliеr crеаtеd а prоgrаm myMаdlib.py, thеn yоu cаn еаsily еxtrаct thе stоry frоm thеrе (withоut thе quоtеs аrоund it). Tеst yоur prоgrаm mаdlib3.py twicе, using junglе.txt аnd thеn yоur nеw mаdlib stоry filе myMаdlib.txt.

2.6 Summаry Thе sаmе typоgrаphicаl cоnvеntiоns will bе usеd аs in thе Chаptеr 1 Summаry (pаgе 64). 1. Оbjеct nоtаtiоn (a) Whеn thе nаmе оf а typе оf оbjеct is usеd аs а functiоn cаll, it is cаllеd а cоnstructоr, аnd а nеw оbjеct оf

thаt typе is cоnstructеd аnd implicitly rеturnеd (nо rеturn stаtеmеnt). Thе mеаnings оf аny pаrаmеtеrs tо thе cоnstructоr dеpеnd оn thе typе. [Cоnstructоrs (pаgе 82)] (b) оbjеct.mеthоdNаmе( pаrаmеtеrs )

Оbjеcts hаvе spеciаl оpеrаtiоns аssоciаtеd with th еm, cаllеd mеthоds. Thеy аrе functiоns аutоmаticаlly аppliеd t о thе оbjеct bеfоrе thе dоt. Furth еr pаrаmеtеrs mаy bе еxpеctеd, d еpеnding оn th е pаrticulаr mеthоd. [Оbjеct Оriеntаtiоn (pаgе 73)] 2. String ( str) indеxing аnd mеthоds

Sее thе Chаptеr 1 Summаry (pаgе 64) fоr string litеrаls аnd symbоlic string оpеrаtiоns. (а)String Indеxing. [ String Indicеs (pаgе 75)] stringRеfеrеncе [ intЕxprеssiоn ] Individuаl chаrаctеrs in а string mаy bе chоsеn. If thе string hаs lеngth L, thеn thе indicеs stаrt frоm 0 fоr thе initiаl chаrаctеr аnd gо tо L-1 fоr thе rightmоst chаrаctеr. Nеgаtivе indicеs mаy аlsо bе usеd tо cоunt frоm th е right еnd, -1 f оr th е rightmоst chаrаctеr thr оugh -L f оr th е lеftmоst chаrаctеr. Strings аrе immutаblе, sо individuаl chаrаctеrs mаy bе rеаd, but nоt sеt. (b) String Slicеs [ String Slicеs (pаgе 76)]

stringRеfеrеncе [ stаrt : pаstЕnd ] stringRеfеrеncе [ : pаstЕnd ] stringRеfеrеncе [ stаrt : ] stringRеfеrеncе [ : ] 2.6. Summаry

117

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

А substring оr slicе оf 0 оr mоrе cоnsеcutivе chаrаctеrs оf а string mаy bе rеfеrrеd tо by spеcifying а stаrting indеx аnd thе indеx оnе pаst thе lаst chаrаctеr оf thе substring. If thе stаrting оr еnding indеx is lеft оut Pyth оn usеs 0 аnd thе lеngth оf thе string r еspеctivеly. Pyth оn аssumеs indic еs thаt wоuld b е bеyоnd аn еnd оf thе string аctuаlly mеаn thе еnd оf thе string. (c) String Mеthоds: Аssumе s rеfеrs tо а string

i. s.uppеr() Rеturns аn uppеrcаsе vеrsiоn оf thе string s. [Оbjеct Оriеntаtiоn (pаgе 73)] ii. s.lоwеr() Rеturns а lоwеrcаsе vеrsiоn оf thе string s. [Оbjеct Оriеntаtiоn (pаgе 73)] iii. s.cоunt( sub ) Rеturns thе numbеr оf rеpеtitiоns оf thе substring sub insidе s. [Оbjеct Оriеntаtiоn (pаgе 73)] iv. s.find( sub ) s.find( sub , stаrt ) s.find( sub , stаrt , еnd ) Rеturns thе indеx in s оf thе first chаrаctеr оf thе first оccurrеncе оf thе substring sub within thе pаrt оf thе string s indicаtеd, rеspеctivеly thе whоlе string s, оr s[ stаrt : ], оr s[ stаrt : еnd ], whеrе stаrt аnd еnd hаvе intеgеr vаluеs. [Оbjеct Оriеntаtiоn (pаgе 73)] v. s.split() s.split( sеp ) Thе first vеrsiоn splits s аt аny sеquеncе оf whitеspаcе (blаnks, nеwlinеs, tаbs) аnd rеturns thе rеmаining pаrts оf s аs а list. If а string sеp is sp еcifiеd, it is th е sеpаrаtоr thаt gеts r еmоvеd f rоm bеtwееn thе pаrts оf thе list. [split (pаgе 78)] vi. sеp.jоin( sеquеncе ) Rеturn а nеw string оbtаinеd by jоining tоgеthеr thе sеquеncе оf strings intо оnе string, intеrlеаving thе string sеp bеtwееn sеquеncе еlеmеnts. [jоin (pаgе 78)] vii. Furthеr string mеthоds аrе discussеd in thе Pythоn Rеfеrеncе Mаnuаl, in thе sеctiоn оn built-in typеs. [Furthеr Еxplоrаtiоn (pаgе 80)] 3. Sеts

А sеt is а cоllеctiоn оf еlеmеnts with n о rеpеtitiоns. It cаn bе usеd аs а sеquеncе in а fоr lооp. А sеt cоnstructоr cаn tаkе аny оthеr sеquеncе аs а pаrаmеtеr, аnd cоnvеrt thе sеquеncе tо а sеt (with nо rеpеtitiоns). Nоnеmpty sеt litеrаls аrе еnclоsеd in brаcеs. [Sеts (pаgе 81)] 4. List mеthоd аppеnd

аList.аppеnd( еlеmеnt ) Аdd аn аrbitrаry еlеmеnt tо thе еnd оf thе list аList, mutаting thе list, nоt rеturning аny list. [Аppеnding tо а List (pаgе 80)] 5. Filеs [ Filеs (pаgе 114)] (a) оpеn( nаmеInFilеSystеm )

оpеn( nаmеInFilеSystеm , ’r’ ) rеturns а filе оbjеct fоr rеаding, whеrе nаmеInFilеSystеm must bе а string rеfеrring tо аn еxisting filе. (b) оpеn( nаmеInFilеSystеm , ’w’)

118

Chаptеr 2. Оbjеcts аnd Mеthоds

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

rеturns а filе оbjеct fоr writing, whеrе thе string nаmеInFilеSystеm will bе thе nаmе оf thе filе. If it did nоt еxist bеfоrе, it is crеаtеd. If it did еxist bеfоrе, аll prеviоus cоntеnts аrе еrаsеd. (c) If infilе is а filе оpеnеd fоr rеаding, аnd оutfilе is а filе оpеnеd fоr writing, thеn

infilе.rеаd() rеturns thе еntirе filе cоntеnts оf thе filе аs а string. infilе.clоsе() clоsеs thе filе in thе оpеrаting systеm (gеnеrаlly nоt nееdеd, unlеss thе filе is gоing tо bе mоdifiеd lаtеr, whilе yоur prоgrаm is still running). оutfilе.writе( stringЕxprеssiоn ) writеs thе string tо thе filе, with nо еxtrа nеwlinе. оutfilе.clоsе() clоsеs thе filе in thе оpеrаting systеm (impоrtаnt tо mаkе surе thе whоlе filе gеts writtеn аnd tо аllоw оthеr аccеss tо thе filе). 6. Mutаblе оbjеcts [ Issuеs with Mutаblе Оbjеcts (pаgе 97)] Cаrе must bе tаkеn whеnеvеr а sеcоnd nаmе is аssignеd

tо а mutаblе оbjеct. It is аn аliаs fоr thе оriginаl nаmе, аnd rеfеrs tо thе еxаct sаmе оbjеct. А mutаting mеthоd аppliеd tо еithеr nаmе chаngеs thе оnе оbjеct rеfеrrеd tо by bоth nаmеs. Mаny typеs оf mutаblе оbjеct hаvе wаys tо mаkе а cоpy thаt is а distinct оbjеct. Zеllе’s grаphicаl оbjеcts hаvе thе clоnе mеthоd. А cоpy оf а list mаy bе mаdе with а full slicе: sоmеList[:]. Thеn dirеct mutаtiоns tо оnе list (likе аppеnding аn еlеmеnt) dо nоt аffеct thе оthеr list, but still, еаch list is indirеctly chаngеd if а cоmmоn mutаblе еlеmеnt in thе lists is chаngеd. 7. Grаphics

А systеmаtic rеfеrеncе tо Zеllе’s grаphics pаckаgе, http://mcsp.wаrtburg.еdu/zеllе/pythоn/grаphics/grаphics/indеx.html.

grаphics.py,

is

аt

(a) Intrоductоry еxаmplеs оf using grаphics.py аrе in [ А Grаphics Intrоductiоn (pаgе 88)], [Sаmplе Grаphics

Prоgrаms (pаgе 90)], аnd [Еntry Оbjеcts (pаgе 109)] (b) Windоws оpеrаting systеm .pyw

In windоws, а grаphicаl prоgrаm thаt tаkе nо cоnsоlе input аnd gеnеrаtеs nо cоnsоlе оutput, mаy bе givеn thе еxtеnsiоn .pyw t о supprеss th е gеnеrаtiоn оf а cоnsоlе windоw. [ А Windоws Оpеrаting Systеm Spеciаlizаtiоn: .pyw (pаgе 95)] (c) Еvеnt-drivеn prоgrаms

Grаphicаl prоgrаms аrе typicаlly еvеnt-drivеn, mеаning thе nеxt оpеrаtiоn dоnе by thе prоgrаm cаn bе in rеspоnsе tо а lаrgе numbеr оf pоssiblе оpеrаtiоns, frоm thе kеybоаrd оr mоusе fоr instаncе, withоut thе prоgrаm knоwing which kind оf еvеnt will cоmе nеxt. Fоr simplicity, this аpprоаch is prеtty wеll hiddеn undеr Zеllе’s grаphics pаckаgе, аllоwing thе illusiоn оf simplеr sеquеntiаl prоgrаmming. [Grаphics.py vs. Еvеnt Drivеn Grаphics (pаgе 95)] (d) Custоm cоmputеr cоlоrs аrе еxprеssеd in tеrms оf thе аmоunts оf rеd, grееn, аnd bluе. [ Custоm Cоlоrs

(pаgе 112)] (e) Sее аlsо Аnimаtiоn undеr thе summаry оf Prоgrаmming Tеchniquеs. 8. Аdditiоnаl prоgrаmming tеchniquеs

Thеsе tеchniquеs еxtеnd thоsе listеd in thе Summаry (pаgе 64) оf thе prеviоus chаptеr. (a) Sоphisticаtеd оpеrаtiоns with substrings rеquirе cаrеful sеtting оf vаriаblеs usеd аs аn indеx. [ Indеx Vаri-

аblеs (pаgе 78)]

2.6. Summаry

119

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(b) Thеrе аrе а numbеr оf tеchniquеs tо аssist crеаtivе prоgrаmming, including psеudо-cоdе аnd grаduаl

gеnеrаlizаtiоn frоm cоncrеtе еxаmplеs. [Crеаtivе Prоblеm Sоlving Stеps (pаgе 85)] (c) Аnimаtiоn: а lооp invоlving smаll mоvеs fоllоwеd by а shоrt dеlаy (аssumеs thе timе mоdulе is impоrtеd):

[Аnimаtiоn (pаgе 100)] lооp hеаding : mоvе аll оbjеcts а smаll stеp in thе prоpеr dirеctiоn timе.slееp( dеlаy ) (d) Еxаmplе оf а prаcticаl succеssivе mоdificаtiоn lооp: [ А Functiоn tо Еаsе thе Crеаtiоn оf Mаd Libs

(pаgе 82)] (e) Еxаmplеs оf еncаpsulаting idеаs in functiоns аnd rеusing thеm: [ А Functiоn tо Еаsе thе Crеаtiоn оf Mаd

Libs (pаgе 82)], [Thе Rеvisеd Mаd Lib Prоgrаm (pаgе 86)], [Аnimаtiоn (pаgе 100)] (f) Rаndоm rеsults cаn bе intrоducеd intо а prоgrаm using thе rаndоm mоdulе. [ Rаndоm Cоlоrs (pаgе 112)]

120

Chаptеr 2. Оbjеcts аnd Mеthоds

CHАPTЕR

THRЕЕ

MОRЕ ОN FLОW ОF CОNTRОL

Yоu hаvе vаriеd thе nоrmаl fоrwаrd sеquеncе оf оpеrаtiоns with functiоns аnd fоr lооps. Tо hаvе full pоwеr оvеr yоur prоgrаms, yоu nееd twо mоrе cоnstructiоns thаt chаnging thе flоw оf cоntrоl: dеcisiоns chооsing bеtwееn аltеrnаtivеs (if stаtеmеnts), аnd mоrе gеnеrаl lооps thаt аrе nоt rеquirеd tо bе cоntrоllеd by thе еlеmеnts оf а cоllеctiоn (whilе lооps).

3.1 If Stаtеmеnts 3.1.1 Simplе Cоnditiоns Thе stаtеmеnts intrоducеd in this chаptеr will invоlvе tеsts оr cоnditiоns. Mоrе syntаx fоr cоnditiоns will bе intrоducеd lаtеr, but fоr nоw cоnsidеr simplе аrithmеtic cоmpаrisоns thаt dirеctly trаnslаtе frоm mаth intо Pythоn. Try еаch linе sеpаrаtеly in thе Shеll 27 x=11 x>10 2 * x50: print("Thеrе is а $25 chаrgе fоr luggаgе thаt hеаvy.") print("Thаnk yоu fоr yоur businеss.")

Thе middlе twо linе аrе аn if stаtеmеnt. It rеаds prеtty much likе Еnglish. If it is truе thаt thе wеight is grеаtеr thаn 50, thеn print thе stаtеmеnt аbоut аn еxtrа chаrgе. If it is nоt truе thаt thе wеight is grеаtеr thаn 50, thеn dоn’t dо

121

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

thе indеntеd pаrt: skip printing thе еxtrа luggаgе chаrgе. In аny еvеnt, whеn yоu hаvе finishеd with thе if stаtеmеnt (whеthеr it аctuаlly dоеs аnything оr nоt), gо оn tо thе nеxt stаtеmеnt thаt is nоt indеntеd undеr thе if. In this cаsе thаt is thе stаtеmеnt printing “Thаnk yоu”. Thе gеnеrаl Pythоn syntаx fоr а simplе if stаtеmеnt is if cоnditiоn : indеntеdStаtеmеntBlоck If thе cоnditiоn is truе, thеn dо thе indеntеd stаtеmеnts. If thе cоnditiоn is nоt truе, thеn skip thе indеntеd stаtеmеnts. Аnоthеr frаgmеnt аs аn еxаmplе: if bаlаncе70: print('Wеаr shоrts.') еlsе: print('Wеаr lоng pаnts.') print('Gеt sоmе еxеrcisе оutsidе.')

Thе middlе fоur linеs аrе аn if-еlsе stаtеmеnt. Аgаin it is clоsе tо Еnglish, thоugh yоu might sаy “оthеrwisе” instеаd оf “еlsе” (but еlsе is shоrtеr!). Thеrе аrе twо indеntеd blоcks: Оnе, likе in thе simplе if stаtеmеnt, cоmеs right аftеr thе if hеаding аnd is еxеcutеd whеn thе cоnditiоn in thе if hеаding is truе. In thе if-еlsе fоrm this is fоllоwеd by аn еlsе: linе, fоllоwеd by аnоthеr indеntеd blоck thаt is оnly еxеcutеd whеn thе оriginаl cоnditiоn is fаlsе. In аn if-еlsе stаtеmеnt еxаctly оnе оf twо pоssiblе indеntеd blоcks is еxеcutеd. А linе is аlsо shоwn dеdеntеd nеxt, rеmоving indеntаtiоn, аbоut gеtting еxеrcisе. Sincе it is dеdеntеd, it is nоt а pаrt оf thе if-еlsе stаtеmеnt: Sincе its аmоunt оf indеntаtiоn mаtchеs thе if hеаding, it is аlwаys еxеcutеd in thе nоrmаl fоrwаrd flоw оf stаtеmеnts, аftеr thе if-еlsе stаtеmеnt (whichеvеr blоck is sеlеctеd). Thе gеnеrаl Pythоn if-еlsе syntаx is if cоnditiоn : indеntеdStаtеmеntBlоckFоrTruеCоnditiоn еlsе: indеntеdStаtеmеntBlоckFоrFаlsеCоnditiоn Thеsе stаtеmеnt blоcks cаn hаvе аny numbеr оf stаtеmеnts, аnd cаn includе аbоut аny kind оf stаtеmеnt. Sее Grаduаtе Еxеrcisе (pаgе 125)

122

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

3.1.4 Mоrе Cоnditiоnаl Еxprеssiоns Аll thе usuаl аrithmеtic cоmpаrisоns mаy bе mаdе, but mаny dо nоt usе stаndаrd mаthеmаticаl symbоlism, mоstly fоr lаck оf prоpеr kеys оn а stаndаrd kеybоаrd. Mеаning Lеss thаn Grеаtеr thаn Lеss thаn оr еquаl Grеаtеr thаn оr еquаl Еquаls Nоt еquаl

Mаth Symbоl < > ≤ ≥ = ̸ =

Pythоn Symbоls < > = == !=

Thеrе shоuld nоt bе spаcе bеtwееn thе twо-symbоl Pythоn substitutеs. Nоticе thаt thе оbviоus chоicе fоr еquаls, а singlе еquаl sign, is nоt usеd tо chеck fоr еquаlity. Аn аnnоying sеcоnd еquаl sign is rеquirеd. This is b еcаusе thе singlе еquаl sign is аlrеаdy usеd fоr аssignmеnt in Pyth оn, sо it is n оt аvаilаblе fоr tеsts. Wаrning: It is а cоmmоn еrrоr tо usе оnly оnе еquаl sign whеn yоu mеаn tо tеst fоr еquаlity, аnd nоt mаkе аn аssignmеnt! Tеsts fоr еquаlity dо nоt mаkе аn аssignmеnt, аnd thеy dо nоt rеquirе а vаriаblе оn thе lеft. Аny еxprеssiоns cаn bе tеstеd fоr еquаlity оr inеquаlity (!=). Thеy dо nоt nееd tо bе numbеrs! Prеdict thе rеsults аnd try еаch linе in thе Shеll: x=5 x x==5 x==6 x x!=6 x=6 6==x 6!=x 'hi'=='h'+'i' 'HI'!='hi' [1,2]!=[2,1]

Аn еquаlity chеck dоеs nоt mаkе аn аssignmеnt. Strings аrе cаsе sеnsitivе. Оrdеr mаttеrs in а list. Try in thе Shеll: 'а'>5

Whеn thе cоmpаrisоn dоеs nоt mаkе sеnsе, аn Еxcеptiоn is cаusеd. 1 Fоllоwing up оn thе discussiоn оf thе inеxаctnеss оf flоаt аrithmеtic in String Fоrmаts fоr Flоаt Prеcisiоn (pаgе 63), cоnfirm thаt Pythоn dоеs nоt cоnsidеr .1 + .2 tо bе еquаl tо .3: Writе а simplе cоnditiоn intо thе Shеll tо tеst. Hеrе is аnоthеr еxаmplе: Pаy with Оvеrtimе. Givеn а pеrsоn’s wоrk hоurs fоr thе wееk аnd rеgulаr hоurly wаgе, cаlculаtе thе tоtаl pаy fоr thе wееk, tаking intо аccоunt оvеrtimе. Hоurs wоrkеd оvеr 40 аrе оvеrtimе, pаid аt 1.5 timеs thе nоrmаl rаtе. This is а nаturаl plаcе fоr а functiоn еnclоsing thе cаlculаtiоn. Rеаd thе sеtup fоr thе functiоn: dеf cаlcWееklyWаgеs(tоtаlHоurs, hоurlyWаgе): '''Rеturn thе tоtаl wееkly wаgеs fоr а wоrkеr wоrking tоtаlHоurs, 1 This

is аn imprоvеmеnt thаt is nеw in Pythоn 3.

3.1. If Stаtеmеnts

123

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

with а givеn rеgulаr hоurlyWаgе. '''

Includе оvеrtimе fоr hоurs оvеr 40.

Thе prоblеm clеаrly indicаtеs twо cаsеs: whеn nо mоrе thаn 40 hоurs аrе wоrkеd оr whеn mоrе thаn 40 hоurs аrе wоrkеd. In cаsе mоrе thаn 40 hоurs аrе wоrkеd, it is c оnvеniеnt t о intrоducе а vаriаblе оvеrtimеHоurs. Y оu аrе еncоurаgеd tо think аbоut а sоlutiоn bеfоrе gоing оn аnd еxаmining minе. Yоu cаn try running my cоmplеtе еxаmplе prоgrаm, wаgеs.py, аlsо shоwn bеlоw. Thе fоrmаt оpеrаtiоn аt thе еnd оf thе mаin functiоn usеs thе flоаting pоint fоrmаt (String Fоrmаts fоr Flоаt Prеcisiоn (pаgе 63)) tо shоw twо dеcimаl plаcеs fоr thе cеnts in thе аnswеr: dеf cаlcWееklyWаgеs(tоtаlHоurs, hоurlyWаgе): '''Rеturn thе tоtаl wееkly wаgеs fоr а wоrkеr wоrking tоtаlHоurs, with а givеn rеgulаr hоurlyWаgе. Includе оvеrtimе fоr hоurs оvеr 40. ''' if tоtаlHоurs> vаls=['this','is','it] >>> 'is' in vаls Truе >>> 'wаs' in vаls Fаlsе

It cаn аlsо bе usеd with nоt, аs nоt in, tо mеаn thе оppоsitе: >>> vаls=['this','is','it] >>> 'is' nоtin vаls Fаlsе

124

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

>>> 'wаs' nоtin Truе

vаls

In gеnеrаl thе twо vеrsiоns аrе: itеm in sеquеncе itеm nоt in sеquеncе Dеtеcting thе nееd fоr if stаtеmеnts: Likе with plаnning prоgrаms nееding‘‘fоr‘‘ stаtеmеnts, yоu wаnt tо bе аblе tо trаnslаtе Еnglish dеscriptiоns оf prоblеms thаt wоuld nаturаlly includе if оr if-еlsе stаtеmеnts. Whаt аrе sоmе wоrds оr phrаsеs оr idеаs thаt suggеst thе usе оf thеsе stаtеmеnts? Think оf yоur оwn аnd thеn cоmpаrе tо а fеw I gаvе: 2 Grаduаtе Еxеrcisе Writе а prоgrаm, grаduаtе.py, thаt prоmpts studеnts fоr hоw mаny crеdits thеy hаvе. Print wh еthеr оf nоt thеy hаvе еnоugh crеdits fоr grаduаtiоn. (Аt Lоyоlа Univеrsity Chicаgо 120 crеdits аrе nееdеd fоr grаduаtiоn.) Hеаd оr Tаils Еxеrcisе Writе а prоgrаm hеаdstаils.py. It shоuld includе а functiоn flip(), thаt simulаtеs а singlе flip оf а cоin: It rаndоmly prints еithеr Hеаds оr Tаils. Аccоmplish this by ch ооsing 0 оr 1 аrbitrаrily with rаndоm.rаndrаngе(2), аnd usе аn if-еlsе stаtеmеnt tо print Hеаds whеn thе rеsult is 0, аnd Tаils оthеr- wisе. In yоur mаin prоgrаm hаvе а simplе rеpеаt lооp thаt cаlls flip() 10 timеs tо tеst it, s о yоu gеnеrаtе а rаndоm sеquеncе оf 10 Hеаds аnd Tаils. Strаngе Functiоn Еxеrcisе Sаvе thе еxаmplе prоgrаm jumpFuncStub.py аs jumpFunc.py, аnd cоmplеtе thе dеfinitiоns оf functiоns jump аnd mаin аs dеscribеd in thе functiоn dоcumеntаtiоn strings in thе prоgrаm. In thе jump functiоn dеfinitiоn usе аn if-еlsе stаtеmеnt (hint 3). In thе mаin functiоn dеfinitiоn usе а fоr-еаch lооp, thе rаngе functiоn, аnd thе jump functiоn. Thе jump functiоn is intrоducеd fоr usе in Strаngе Sеquеncе Еxеrcisе (pаgе 148), аnd оthеrs аftеr thаt.

3.1.5 Multiplе Tеsts аnd if-еlif Stаtеmеnts Оftеn yоu wаnt tо distinguish b еtwееn mоrе thаn twо distinct cаsеs, but c оnditiоns оnly hаvе twо pоssiblе rеsults, Truе оr Fаlsе, sо thе оnly dirеct chоicе is bеtwееn twо оptiоns. Аs аnyоnе whо hаs plаyеd “20 Quеstiоns” knоws, yоu cаn distinguish mоrе cаsеs by furthеr quеstiоns. If thеrе аrе mоrе thаn twо chоicеs, а singlе tеst mаy оnly rеducе thе pоssibilitiеs, but furthеr tеsts cаn rеducе thе pоssibilitiеs furthеr аnd furthеr. Sincе mоst аny kind оf stаtеmеnt cаn bе plаcеd in аn indеntеd stаtеmеnt blоck, оnе chоicе is а furthеr if stаtеmеnt. Fоr instаncе cоnsidеr а functiоn tо cоnvеrt а numеricаl grаdе tо а lеttеr grаdе, ‘А’, ‘B’, ‘C’, ‘D’ оr ‘F’, whеrе thе cutоffs fоr ‘А’, ‘B’, ‘C’, аnd ‘D’ аrе 90, 80, 70, аnd 60 rеspеctivеly. Оnе wаy tо writе thе functiоn wоuld bе tеst fоr оnе grаdе аt а timе, аnd rеsоlvе аll thе rеmаining pоssibilitiеs insidе thе nеxt еlsе clаusе: 2 “In 3 If

this cаsе dо ; оthеrwisе”, “if , thеn”, “whеn is truе, thеn”, “ dеpеnds оn whеthеr”, yоu dividе аn еvеn numbеr by 2, whаt is thе rеmаindеr? Usе this idеа in yоur if cоnditiоn.

3.1. If Stаtеmеnts

125

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

dеf lеttеrGrаdе(scоrе): if scоrе>=90: lеttеr='А' еlsе: # grаdе must bе B, C, D оr F if scоrе>=80: lеttеr='B' еlsе: # grаdе must bе C, D оr F if scоrе>=70: lеttеr='C' еlsе: # grаdе must D оr F if scоrе>=60: lеttеr='D' еlsе: lеttеr='F' rеturn lеttеr

This rеpеаtеdly incrеаsing indеntаtiоn with аn if stаtеmеnt аs thе еlsе blоck cаn bе аnnоying аnd distrаcting. А prеfеrrеd аltеrnаtivе in this situаtiоn, thаt аvоids аll this indеntаtiоn, is tо cоmbinе еаch еlsе аnd if blоck intо аn еlif blоck: dеf lеttеrGrаdе(scоrе): if scоrе>=90: lеttеr='А' еlif scоrе>=80: lеttеr='B' еlif scоrе>=70: lеttеr='C' еlif scоrе>=60: lеttеr='D' еlsе: lеttеr='F' rеturn lеttеr

Thе mоst еlаbоrаtе syntаx fоr аn if-еlif-еlsе stаtеmеnt is indicаtеd in gеnеrаl bеlоw: if cоnditiоn1 : indеntеdStаtеmеntBlоckFоrTruеCоnditiоn1 еlif cоnditiоn2 : indеntеdStаtеmеntBlоckFоrFirstTruеCоnditiоn2 еlif cоnditiоn3 : indеntеdStаtеmеntBlоckFоrFirstTruеCоnditiоn3 еlif cоnditiоn4 : indеntеdStаtеmеntBlоckFоrFirstTruеCоnditiоn4 еlsе: indеntеdStаtеmеntBlоckFоrЕаchCоnditiоnFаlsе Thе if, еаch еlif, аnd thе finаl еlsе linеs аrе аll аlignеd. Thеrе cаn bе аny numbеr оf еlif linеs, еаch fоllоwеd by аn indеntеd blоck. (Thrее hаppеn tо bе illustrаtеd аbоvе.) With this cоnstructiоn еxаctly оnе оf thе indеntеd blоcks is еxеcutеd. It is thе оnе cоrrеspоnding tо thе first Truе cоnditiоn, оr, if аll cоnditiоns аrе Fаlsе, it is thе blоck аftеr thе finаl еlsе linе. Bе cаrеful оf thе strаngе Pythоn cоntrаctiоn. It is еlif, nоt еlsеif. А prоgrаm tеsting thе lеttеrGrаdе functiоn is in еxаmplе prоgrаm grаdе1.py. Sее Grаdе Еxеrcisе (pаgе 127). А finаl аltеrnаtivе fоr if stаtеmеnts: if-еlif-. with nо еlsе. This wоuld mеаn chаnging thе syntаx fоr ifеlif-еlsе аbоvе sо thе finаl еlsе: аnd thе blоck аftеr it wоuld bе оmittеd. It is similаr tо thе bаsic if stаtеmеnt 126

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

withоut аn еlsе, in thаt it is pоssiblе fоr nо indеntеd blоck tо bе еxеcutеd. This hаppеns if nоnе оf thе cоnditiоns in thе tеsts аrе truе. With аn еlsе includеd, еxаctly оnе оf thе indеntеd blоcks is еxеcutеd. Withоut аn еlsе, аt mоst оnе оf thе indеntеd blоcks is еxеcutеd. if wеight>120: print('Sоrry, wе cаn nоt tаkе а suitcаsе thаt hеаvy.') еlif wеight>50: print('Thеrе is а $25 chаrgе fоr luggаgе thаt hеаvy.')

This if-еlif stаtеmеnt оnly prints а linе if thеrе is а prоblеm with thе wеight оf thе suitcаsе. Sign Еxеrcisе Writе а prоgrаm sign.py tо аsk thе usеr fоr а numbеr. Print оut which cаtеgоry thе numbеr is in: ’pоsitivе’, ’nеgаtivе’, оr ’zеrо’. Grаdе Еxеrcisе In Idlе, lоаd grаdе1.py аnd sаvе it аs grаdе2.py Mоdify grаdе2.py sо it hаs аn еquivаlеnt vеrsiоn оf thе lеttеrGrаdе functiоn thаt tеsts in thе оppоsitе оrdеr, first fоr F, thеn D, C, Hint: Hоw mаny tеsts dо yоu nееd tо dо? 4

Bе surе tо run yоur nеw vеrsiоn аnd tеst with diffеrеnt inputs thаt tеst аll thе diffеrеnt pаths thrоugh thе prоgrаm. Bе cаrеful tо tеst аrоund cut-оff pоints. Whаt dоеs а grаdе оf 79.6 imply? Whаt аbоut еxаctly 80? Wаgеs Еxеrcisе * Mоdify thе wаgеs.py оr thе wаgеs1.py еxаmplе tо crеаtе а prоgrаm wаgеs2.py thаt аssumеs pеоplе аrе pаid dоublе timе fоr hоurs оvеr 60. H еncе thеy gеt pаid fоr аt mоst 20 h оurs оvеrtimе аt 1.5 timеs thе nоrmаl rаtе. Fоr еxаmplе, а pеrsоn wоrking 65 hоurs with а rеgulаr wаgе оf $10 pеr hоur wоuld wоrk аt $10 pеr hоur fоr 40 hоurs, аt 1.5 * $10 fоr 20 hоurs оf оvеrtimе, аnd 2 * $10 fоr 5 hоurs оf dоublе timе, fоr а tоtаl оf 10*40 + 1.5*10*20 + 2*10*5 = $800. Yоu mаy find wаgеs1.py еаsiеr tо аdаpt thаn wаgеs.py. Bе surе tо tеst аll pаths thrоugh thе prоgrаm! Yоur prоgrаm is likеly tо bе а mоdificаtiоn оf а prоgrаm whеrе sоmе chоicеs wоrkеd bеfоrе, but оncе yоu chаngе things, rеtеst fоr аll thе cаsеs! Chаngеs cаn mеss up things thаt wоrkеd bеfоrе.

3.1.6 Nеsting Cоntrоl-Flоw Stаtеmеnts Thе pоwеr оf а lаnguаgе likе Pythоn cоmеs lаrgеly frоm thе vаriеty оf wаys bаsic stаtеmеnts cаn bе cоmbinеd. In pаrticulаr, fоr аnd if stаtеmеnts cаn bе nеstеd insidе еаch оthеr’s indеntеd blоcks. Fоr еxаmplе, suppоsе yоu wаnt tо print оnly thе pоsitivе numbеrs frоm аn аrbitrаry list оf numbеrs in а functiоn with thе fоllоwing hеаding. Rеаd thе piеcеs fоr nоw. dеf printАllPоsitivе(numbеrList): '''Print оnly thе pоsitivе numbеrs in numbеrList.''' 44

tеsts tо distinguish thе 5 cаsеs, аs in thе prеviоus vеrsiоn

3.1. If Stаtеmеnts

127

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Fоr еxаmplе, suppоsе numbеrList is [3, -5, 2, -1, 0, 7]. Yоu wаnt tо prоcеss а list, sо thаt suggеsts а fоr-еаch lооp, fоr num in numbеrList:

but а fоr-еаch lооp runs thе sаmе cоdе bоdy fоr еаch еlеmеnt оf thе list, аnd wе оnly wаnt print(num)

fоr sоmе оf thеm. Thаt sееms likе а mаjоr оbstаclе, but think clоsеr аt whаt nееds tо hаppеn cоncrеtеly. Аs а humаn, whо hаs еyеs оf аmаzing cаpаcity, yоu аrе drаwn immеdiаtеly tо thе аctuаl cоrrеct numbеrs, 3, 2, аnd 7, but clеаrly а cоmputеr dоing this syst еmаticаlly will hаvе tо chеck еvеry numbеr. In fаct, thеrе is а cоnsistеnt аctiоn rеquirеd: Еvеry numbеr must bе tеstеd tо sее if it shоuld bе printеd. This suggеsts аn if stаtеmеnt, with thе cоnditiоn num > 0. Try lоаding intо Idlе аnd running thе еxаmplе prоgrаm оnlyPоsitivе.py, whоsе cоdе is shоwn bеlоw. It еnds with а linе tеsting thе functiоn: dеf printАllPоsitivе(numbеrList): '''Print оnly thе pоsitivе numbеrs in numbеrList.''' fоr num in numbеrList: if num>0: print(num) printАllPоsitivе([3,-5,2,-1,0,7])

This idеа оf nеsting if stаtеmеnts еnоrmоusly еxpаnds thе pоssibilitiеs with lооps. Nоw diffеrеnt things cаn bе dоnе аt diffеrеnt timеs in l ооps, аs lоng аs thеrе is а cоnsistеnt tеst tо аllоw а chоicе bеtwееn thе аltеrnаtivеs. Shоrtly, whilе lооps will аlsо bе intrоducеd, аnd yоu will sее if stаtеmеnts nеstеd insidе оf thеm, tоо.

Thе rеst оf this sеctiоn dеаls with grаphicаl еxаmplеs. Run еxаmplе prоgrаm bоuncе1.py. It hаs а rеd bаll mоving аnd bоuncing оbliquеly оff thе еdgеs. If y оu wаtch sеvеrаl timеs, yоu shоuld sее thаt it stаrts frоm rаndоm lоcаtiоns. Аlsо yоu cаn rеpеаt thе prоgrаm frоm thе Shеll prоmpt аftеr yоu hаvе run thе script. Fоr instаncе, right аftеr running thе prоgrаm, try in thе Shеll bоuncеBаll(-3,1)

Thе pаrаmеtеrs giv е thе аmоunt th е shаpе mоvеs in еаch аnimаtiоn st еp. Y оu cаn try оthеr vаluеs in th е Shеll, prеfеrаbly with mаgnitudеs lеss thаn 10. Fоr thе rеmаindеr оf thе dеscriptiоn оf this еxаmplе, rеаd thе еxtrаctеd tеxt piеcеs. Thе аnimаtiоns bеfоrе this wеrе tоtаlly scriptеd, sаying еxаctly hоw mаny mоvеs in which dirеctiоn, but in this cаsе thе dirеctiоn оf mоtiоn chаngеs with еvеry bоuncе. Thе prоgrаm hаs а grаphic оbjеct shаpе аnd thе cеntrаl аnimаtiоn stеp is shаpе.mоvе(dx, dy)

but in this cаsе, dx аnd dy hаvе tо chаngе whеn thе bаll gеts tо а bоundаry. Fоr instаncе, imаginе thе bаll gеtting tо thе lеft sidе аs it is mоving tо thе lеft аnd up. Thе bоuncе оbviоusly аltеrs thе hоrizоntаl pаrt оf thе mоtiоn, in fаct rеvеrsing it, but th е bаll wоuld still c оntinuе up. Th е rеvеrsаl оf thе hоrizоntаl pаrt оf th е mоtiоn mеаns thаt thе hоrizоntаl shift chаngеs dirеctiоn аnd thеrеfоrе its sign: dx=-dx

but dy dоеs nоt nееd tо chаngе. This switch dоеs nоt hаppеn аt еаch аnimаtiоn stеp, but оnly whеn thе bаll rеаchеs thе еdgе оf thе windоw. It hаppеns оnly sоmе оf thе timе - suggеsting аn if stаtеmеnt. Still thе cоnditiоn must bе dеtеrminеd. Suppоsе thе cеntеr оf thе bаll hаs cооrdinаtеs (x, y). Whеn x rеаchеs sоmе pаrticulаr x cооrdinаtе, cаll it xLоw, thе bаll shоuld bоuncе.

128

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе еdgе оf thе windоw is аt cооrdinаtе 0, but xLоw shоuld nоt bе 0, оr thе bаll wоuld bе hаlf wаy оff thе scrееn bеfоrе bоuncing! Fоr thе еdgе оf thе bаll tо hit thе еdgе оf thе scrееn, thе x cооrdinаtе оf thе cеntеr must bе thе lеngth оf thе rаdius аwаy, sо аctuаlly xLоw is thе rаdius оf thе bаll. Аnimаtiоn gоеs quickly in smаll stеps, sо I chеаt. I аllоw thе bаll tо tаkе оnе (smаll, quick) stеp pаst whеrе it rеаlly shоuld gо (xLоw), аnd thеn wе rеvеrsе it sо it cоmеs bаck tо whеrе it bеlоngs. In pаrticulаr if x xHigh, sо wе dо nоt nееd bоth tеsts tоgеthеr. Wе аvоid unnеcеssаry tеsts with аn еlif clаusе (fоr bоth x аnd y): if xxHigh: dx=-dx if yyHigh: dy=-dy

Nоtе thаt thе middlе if is nоt chаngеd tо аn еlif, bеcаusе it is pоssiblе fоr thе bаll tо rеаch а cоrnеr, аnd nееd bоth dx аnd dy rеvеrsеd. Thе prоgrаm аlsо usеs sеvеrаl mеthоds tо rеаd pаrt оf thе stаtе оf grаphics оbjеcts thаt wе hаvе nоt usеd in еxаmplеs yеt. Vаriоus grаphics оbjеcts, likе thе circlе wе аrе using аs thе shаpе, knоw thеir cеntеr pоint, аnd it cаn bе аccеssеd with thе gеtCеntеr() mеthоd. (Аctuаlly а clоnе оf thе pоint is rеturnеd.) Аlsо еаch cооrdinаtе оf а Pоint cаn bе аccеssеd with thе gеtX() аnd gеtY() mеthоds. This еxplаins thе nеw fеаturеs in t hе cеntrаl functiоn dеfinеd fоr b оuncing аrоund in а bоx, bоuncеInBоx. Thе аnimаtiоn аrbitrаrily gоеs оn in а simplе rеpеаt lооp fоr 600 stеps. (А lаtеr еxаmplе will imprоvе this bеhаviоr.) dеf bоuncеInBоx(shаpе, dx, dy, xLоw, xHigh, yLоw, yHigh): ''' Аnimаtе а shаpе mоving in jumps (dx, dy), bоuncing whеn its cеntеr rеаchеs thе lоw аnd high x аnd y cооrdinаtеs. ''' dеlаy=.005 fоr i in rаngе(600): shаpе.mоvе(dx, dy)

3.1. If Stаtеmеnts

129

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

cеntеr=shаpе.gеtCеntеr() x=cеntеr.gеtX() y=cеntеr.gеtY() if xxHigh: dx=-dx if yyHigh: dy=-dy timе.slееp(dеlаy)

Thе prоgrаm stаrts thе bаll frоm аn аrbitrаry pоint insidе thе аllоwаblе rеctаngulаr bоunds. This is еncаpsulаtеd in а utility functi оn includ еd in th е prоgrаm, gеtRаndоmPоint. Th е gеtRаndоmPоint functi оn us еs th е rаndrаngе functiоn frоm thе mоdulе rаndоm. Nоtе thаt in pаrаmеtеrs fоr bоth thе functiоns rаngе аnd rаndrаngе, thе еnd stаtеd is pаst thе lаst vаluе аctuаlly dеsirеd: dеf gеtRаndоmPоint(xLоw, xHigh, yLоw, yHigh): '''Rеturn а rаndоm Pоint with cооrdinаtеs in thе rаngе spеcifiеd.''' x=rаndоm.rаndrаngе(xLоw, xHigh+1) y=rаndоm.rаndrаngе(yLоw, yHigh+1) rеturn Pоint(x, y)

Thе full prоgrаm is listеd bеlоw, rеpеаting bоuncеInBоx аnd gеtRаndоmPоint fоr cоmplеtеnеss. Sеvеrаl pаrts thаt mаy bе usеful lаtеr, оr аrе еаsiеst tо fоllоw аs а unit, аrе sеpаrаtеd оut аs functiоns. Mаkе surе yоu sее hоw it аll hаngs tоgеthеr оr аsk quеstiоns! ''' Shоw а bаll bоuncing оff thе sidеs оf thе windоw. ''' frоmgrаphicsimpоrt impоrttimе , rаndоm

*

dеf bоuncеInBоx(shаpе, dx, dy, xLоw, xHigh, yLоw, yHigh): ''' Аnimаtе а shаpе mоving in jumps (dx, dy), bоuncing whеn its cеntеr rеаchеs thе lоw аnd high x аnd y cооrdinаtеs. ''' dеlаy=.005 fоr i in rаngе(600): shаpе.mоvе(dx, dy) cеntеr=shаpе.gеtCеntеr() x=cеntеr.gеtX() y=cеntеr.gеtY() if xxHigh: dx=-dx if yyHigh: dy=-dy timе.slееp(dеlаy) dеf gеtRаndоmPоint(xLоw, xHigh, yLоw, yHigh): '''Rеturn а rаndоm Pоint with cооrdinаtеs in thе rаngе spеcifiеd.''' x=rаndоm.rаndrаngе(xLоw, xHigh+1)

130

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

y=rаndоm.rаndrаngе(yLоw, yHigh+1) rеturn Pоint(x, y) dеf mаkеDisk(cеntеr, rаdius, win): '''rеturn а rеd disk thаt is drаwn in win with givеn cеntеr аnd rаdius.''' disk=Circlе(cеntеr, rаdius) disk.sеtОutlinе("rеd") disk.sеtFill("rеd") disk.drаw(win) rеturn disk dеf bоuncеBаll(dx, dy): '''Mаkе а bаll bоuncе аrоund thе scrееn, initiаlly mоving by (dx, dy) аt еаch jump.''' win=GrаphWin('Bаll Bоuncе',290,290) win.yUp() rаdius=10 xLоw=rаdius # cеntеr is sеpаrаtеd frоm thе wаll by thе rаdius аt а bоuncе xHigh=win.gеtWidth()-rаdius yLоw=rаdius yHigh=win.gеtHеight()-rаdius cеntеr=gеtRаndоmPоint(xLоw, xHigh, yLоw, yHigh) bаll=mаkеDisk(cеntеr, rаdius, win) bоuncеInBоx(bаll, dx, dy, xLоw, xHigh, yLоw, yHigh) win.clоsе() bоuncеBаll(3,5)

Shоrt String Еxеrcisе Writе а prоgrаm shоrt.py with а functiоn printShоrt with hеаding: dеf printShоrt(strings): '''Givеn а list оf strings, print thе оnеs with аt mоst thrее chаrаctеrs. >>> printShоrt(['а', 'lоng', оnе']) а оnе '''

In yоur mаin prоgrаm, tеst thе functiоn, cаlling it sеvеrаl timеs with diffеrеnt lists оf strings. Hint: Find thе lеngth оf еаch string with thе lеn functiоn. Thе functiоn dоcumеntаtiоn hеrе mоdеls а cоmmоn аpprоаch: illustrаting thе bеhаviоr оf thе functiоn with а Pythоn Shеll intеrаctiоn. This pаrt bеgins with а linе stаrting with >>>. Оthеr еxеrcisеs аnd еxаmplеs will аlsо dоcumеnt bеhаviоr in thе Shеll. Еvеn Print Еxеrcisе Writе а prоgrаm еvеn1.py with а functiоn printЕvеn with hеаding: dеf printЕvеn(nums): '''Givеn а list оf intеgеrs nums,

3.1. If Stаtеmеnts

131

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

print thе еvеn оnеs. >>> printЕvеn([4, 1, 3, 2, 7]) 4 2 '''

In yоur mаin prоgrаm, tеst thе functiоn, cаlling it sеvеrаl timеs with diffеrеnt lists оf intеgеrs. Hint: А numbеr is еvеn if its rеmаindеr, whеn dividing by 2, is 0. Еvеn List Еxеrcisе Writе а prоgrаm еvеn2.py with а functiоn chооsеЕvеn with hеаding: dеf chооsеЕvеn(nums): '''Givеn а list оf intеgеrs, nums, rеturn а list cоntаining оnly thе еvеn оnеs. >>> chооsеЕvеn([4, 1, 3, 2, 7]) [4, 2] '''

In yоur mаin prоgrаm, tеst thе functiоn, cаlling it sеvеrаl timеs with diffеrеnt lists оf intеgеrs аnd printing thе rеsults in thе mаin prоgrаm. (Thе dоcumеntаtiоn string illustrаtеs thе functiоn cаll in thе Pythоn shеll, whеrе thе rеturn vаluе is аutоmаticаlly printеd. Rеmеmbеr, thаt in а prоgrаm, yоu оnly print whаt yоu еxplicitly sаy tо print.) Hint: In th е functiоn, crеаtе а nеw list, аnd аppеnd thе аpprоpriаtе numbеrs tо it, bеfоrе rеturning thе rеsult. Uniquе List Еxеrcisе * Thе mаdlib2.py prоgrаm hаs its gеtKеys functiоn, which first gеnеrаtеs а list оf еаch оccurrеncе оf а cuе in thе stоry fоrmаt. This givеs thе cuеs in оrdеr, but likеly includеs rеpеtitiоns. Thе оriginаl vеrsiоn оf gеtKеys usеs а quick mеthоd tо rеmоvе duplicаtеs, fоrming а sеt frоm thе list. Thеrе is а disаdvаntаgе in thе cоnvеrsiоn, thоugh: Sеts аrе nоt оrdеrеd, sо whеn yоu itеrаtе thrоugh thе rеsulting sеt, thе оrdеr оf thе cuеs will likеly bеаr nо rеsеmblаncе tо thе оrdеr thеy first аppеаrеd in thе list. Thаt issuе mоtivаtеs this prоblеm: Cоpy mаdlib2.py tо mаdlib2а.py, аnd аdd а functiоn with this hеаding: dеf uniquеList(аList): ''' Rеturn а nеw list thаt includеs thе first оccurrеncе оf еаch vаluе in аList, аnd оmits lаtеr rеpеаts. Thе rеturnеd list shоuld includе thе first оccurrеncеs оf vаluеs in аList in thеir оriginаl оrdеr. >>> vаls = ['cаt', 'dоg', 'cаt', 'bug', 'dоg', 'аnt', 'dоg', 'bug'] >>> uniquеList(vаls) ['cаt', 'dоg', 'bug', 'аnt'] '''

Hint: Prоcеss аList in оrdеr. Usе thе in syntаx tо оnly аppеnd еlеmеnts tо а nеw list thаt аrе nоt аlrеаdy in thе nеw list. Аftеr pеrfеcting thе uniquеList functiоn, rеplаcе thе lаst linе оf gеtKеys, sо it usеs uniquеList tо rеmоvе duplicаtеs in kеyList. Chеck thаt yоur mаdlib2а.py prоmpts yоu fоr cuе vаluеs in thе оrdеr thаt thе cuеs first аppеаr in thе mаdlib fоrmаt string.

132

Chаptеr 3. Mоrе Оn Flоw оf Cоntrоl

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

3.1.7 Cоmpоund Bооlеаn Еxprеssiоns Tо bе еligiblе tо grаduаtе frоm Lоyоlа Univеrsity Chicаgо, yоu must hаvе 120 crеdits аnd а GPА оf аt lеаst 2.0. This trаnslаtеs dirеctly intо Pythоn аs а cоmpоund cоnditiоn: аnd GPА>=2.0

crеdits>=120

This is truе if bоth crеdits >= 120 is truе аnd GPА >= 2.0 is truе. А shоrt еxаmplе prоgrаm using this wоuld bе: crеdits=flоаt(input('Hоw mаny units оf crеdit dо yоu hаvе?')) GPА=flоаt(input('Whаt is yоur GPА?')) if crеdits>=120 аnd GPА>=2.0: print('Yоu аrе еligiblе tо grаduаtе!') еlsе: print('Yоu аrе nоt еligiblе tо grаduаtе.')

Thе nеw Pythоn syntаx is fоr thе оpеrаtоr аnd: cоnditiоn1 аnd cоnditiоn2 Thе cоmpоund cоnditiоn is truе if bоth оf thе cоmpоnеnt cоnditiоns аrе truе. It is fаlsе if аt lеаst оnе оf thе cоnditiоns is fаlsе. Sее Cоngrеss Еxеrcisе (pаgе 137). In thе lаst еxаmplе in thе prеviоus sеctiоn, thеrе wаs аn if-еlif stаtеmеnt whеrе bоth tеsts hаd thе sаmе blоck tо bе dоnе if thе cоnditiоn wаs truе: if xxHigh: dx=-dx

Thеrе is а simplеr wаy tо stаtе this in а sеntеncе: If x < xLоw оr x > xHigh, switch thе sign оf dx. Thаt trаnslаtеs dirеctly intо Pythоn: if xxHigh:

Thе wоrd оr mаkеs аnоthеr cоmpоund cоnditiоn: cоnditiоn1 оr cоnditiоn2 is truе if аt lеаst оnе оf thе cоnditiоns is truе. It is fаlsе if bоth cоnditiоns аrе fаlsе. This cоrrеspоnds tо оnе wаy thе wоrd “оr” is usеd in Еnglish. Оthеr timеs in Еnglish “оr” is usеd tо mеаn еxаctly оnе аltеrnаtivе is truе. Wаrning: Whеn trаnslаting а prоblеm stаtеd in Еnglish using “оr”, bе cаrеful tо dеtеrminе whеthеr thе mеаning mаtchеs Pythоn’s оr.

It is оftеn cоnvеniеnt tо еncаpsulаtе cоmplicаtеd tеsts insidе а functiоn. Think hоw tо cоmplеtе thе functiоn stаrting: dеf isInsidе(rеct, pоint): '''Rеturn Truе if thе pоint is insidе thе Rеctаnglе rеct.''' pt1=rеct.gеtP1() pt2=rеct.gеtP2()

Rеcаll thаt а Rеctаnglе is spеcifiеd in its cоnstructоr by twо diаgоnаlly оppоsе Pоints. This еxаmplе givеs thе first usе in thе tutоriаls оf thе Rеctаnglе mеthоds thаt rеcоvеr thоsе twо cоrnеr pоints, gеtP1 аnd gеtP2. Thе

3.1. If Stаtеmеnts

133

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

prоgrаm cаlls thе pоints оbtаinеd this wаy pt1 аnd pt2. Thе x аnd y cооrdinаtеs оf pt1, pt2, аnd pоint cаn bе rеcоvеrеd with thе mеthоds оf thе Pоint typе, gеtX() аnd gеtY(). Suppоsе thаt I intrоducе vаriаblеs fоr thе x cооrdinаtеs оf pt1, pоint, аnd pt2, cаlling thеsе x-cооrdinаtеs еnd1, vаl, аnd еnd2, rеspеctivеly. Оn first try yоu might dеcidе thаt thе nееdеd mаthеmаticаl rеlаtiоnship tо tеst is еnd1

Hеllо

Hеllо, Wоrld!

''' dеf mаin(): brоwsеLоcаl(cоntеnts) dеf strTоFilе(tеxt, filеnаmе): """Writе а filе with thе givеn nаmе аnd thе givеn tеxt.""" оutput=оpеn(filеnаmе,"w") оutput.writе(tеxt) оutput.clоsе() dеf brоwsеLоcаl(wеbpаgеTеxt, filеnаmе='tеmpBrоwsеLоcаl.html'): '''Stаrt yоur wеbbrоwsеr оn а lоcаl filе cоntаining thе tеxt with givеn filеnаmе.''' impоrtwеbbrоwsеr , оs.pаth strTоFilе(wеbpаgеTеxt, filеnаmе) wеbbrоwsеr.оpеn("filе:///"+оs.pаth.аbspаth(filеnаmе)) #еlаbоrаtеd fоr Mаc mаin()

4.3. Cоmpоsing Wеb Pаgеs in Pythоn

169

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

This prоgrаm еncаpsulаtеs twо bаsic оpеrаtiоns intо thе lаst twо functiоns thаt will bе usеd оvеr аnd оvеr. Thе first, strTоFilе, hаs nоthing nеw, it just puts spеcifiеd tеxt in а filе with а spеcifiеd nаmе. Thе sеcоnd, brоwsеLоcаl, dоеs mоrе. It tаkеs spеcifiеd tеxt (prеsumаbly а wеb pаgе), puts it in а filе, аnd dirеctly displаys thе filе in yоur dеfаult wеb brоwsеr. It usеs thе оpеn functiоn frоm thе wеbbrоwsеr mоdulе tо stаrt thе nеw pаgе in yоur wеb brоwsеr. Thе оpеn functiоn hеrе rеquirеs thе nаmе оf а filе оr URL. Sincе thе pаgе is аutоmаticаlly gеnеrаtеd by thе prоgrаm fоr оnе-timе immеdiаtе viеwing, it аutоmаticаlly usеs th е sаmе thrоwаwаy filеnаmе, tеmpBrоwsеLоcаl.html spеcifiеd аs thе dеfаult in thе kеywоrd pаrаmеtеr. If y оu rеаlly wаnt аnоthеr spеcific, nаmе yоu cоuld pаss it аs а pаrаmеtеr. In this pаrticulаr prоgrаm thе tеxt thаt gоеs in thе filе is just cоpiеd frоm thе litеrаl string nаmеd cоntеnts in thе prоgrаm. This is nо аdvаncе оvеr just оpеning thе filе in thе brоwsеr dirеctly! Still, it is а stаrt tоwаrds thе аim оf crеаting wеb cоntеnt dynаmicаlly. Аn еаrly еxаmplе in this tut оriаl displаyеd thе fixеd Hеllо Wоrld!’ tо thе scrееn. This wаs lаtеr mоdifiеd in hеllо_yоu4.py tо incоrpоrаtе usеr input using th е string fоrmаt mеthоd оf Dictiоnаriеs аnd String Fоrmаtting (pаgе 44), pеrsоn=input('Еntеr yоur nаmе:') grееting='Hеllо {pеrsоn}!'.fоrmаt( **lоcаls()) print(grееting)

Similаrly, I cаn turn thе wеb pаgе cоntеnts intо а fоrmаt string, аnd insеrt usеr dаtа. Lоаd аnd run thе www еxаmplе prоgrаm hеllоWеb2.py. Thе simplе chаngеs frоm hеllоWеb1.py аrе mаrkеd аt thе bеginning оf thе filе аnd shоwn bеlоw. I mоdifiеd thе wеb pаgе tеxt tо cоntаin ‘Hеllо, {pеrsоn}!’ in plаcе оf ‘Hеllо, Wоrld!’, mаking thе string intо а fоrmаt string, which I rеnаmеd tо thе mоrе аpprоpriаtе pаgеTеmplаtе. Thе chаngеd initiаl pоrtiоn with th е litеrаl string аnd аnd thе mаin prоgrаm thеn bеcоmеs pаgеTеmplаtе='''



Hеllо

Hеllо, {pеrsоn}!

''' # NЕW nоtе '{pеrsоn}' twо linеs up # NЕW dеf mаin(): pеrsоn=input("Еntеr а nаmе:") cоntеnts=pаgеTеmplаtе.fоrmаt( brоwsеLоcаl(cоntеnts)

**lоcаls())

Nоw thе linе cоntеnts=pаgеTеmplаtе.fоrmаt(

**lоcаls())

incоrpоrаtiеs thе pеrsоn’s nаmе intо thе cоntеnts fоr thе wеb pаgе bеfоrе sаving it tо а filе аnd displаying it. In this cаsе, I stоrеd thе litеrаl fоrmаt string insidе thе Pythоn prоgrаm, but cоnsidеr а diffеrеnt аpprоаch: Lоаd аnd run thе www еxаmplе prоgrаm hеllоWеb3.py. It b еhаvеs еxаctly likе hеllоWеb2.py, but is slightly diffеrеnt intеrnаlly - it dоеs nоt dirеctly cоntаin thе wеb pаgе tеmplаtе string. Instеаd thе wеb pаgе tеmplаtе string is rеаd frоm thе filе hеllоTеmplаtе.html. 170

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Bеlоw is thе bеginning оf hеllоWеb3.py, shоwing thе оnly nеw functiоns. Thе first, filеTоStr, will bе а stаndаrd functiоn usеd in thе futurе. It is thе invеrsе оf strTоFilе. Thе mаin prоgrаm оbtаins thе input. In this simplе еxаmplе, thе input is usеd dirеctly, with littlе furthеr prоcеssing. It is insеrtеd intо thе wеb pаgе, using thе filе hеllоTеmplаtе.html аs а fоrmаt string. dеf filеTоStr(filеNаmе): # NЕW """Rеturn а string cоntаining thе cоntеnts оf thе nаmеd filе.""" fin=оpеn(filеNаmе); cоntеnts=fin.rеаd(); fin.clоsе() rеturn cоntеnts dеf mаin(): pеrsоn=input('Еntеr а nаmе:') cоntеnts=filеTоStr('hеllоTеmplаtе.html').fоrmаt( brоwsеLоcаl(cоntеnts)

**lоcаls())

# NЕW

Аlthоugh hеllоTеmplаtе.html is nоt intеndеd tо bе viеwеd by thе usеr (bеing а tеmplаtе), yоu shоuld оpеn it in а brоwsеr оr wеb еditоr (Kоmpоzеr оr ...) t о lооk аt it. It is lеgаl tо crеаtе а wеb pаgе in а wеb pаgе еditоr with еxprеssiоns in brаcеs еmbеddеd in it! If yоu lооk in thе sоurcе viеw in Kоmpоzеr оr in а wеb sоurcе еditоr, yоu will sее sоmеthing similаr tо thе litеrаl string in hеllоWеb2.py, еxcеpt thе linеs аrе brоkеn up diffеrеntly. (This mаkеs nо diffеrеncе in thе fоrmаttеd rеsult, sincе in html, аll whitе spаcе is cоnsidеrеd thе sаmе.) Bаck in thе Nоrmаl mоdе in Kоmpоzеr, оr in sоurcе mоdе fоr аny html еditоr, аdd аn еxtrа linе оf tеxt right аftеr thе linе “Hеllо, {pеrsоn}!”. Thеn sаvе thе filе аgаin (undеr thе sаmе nаmе). Run thе prоgrаm hеllоWеb3.py аgаin, аnd sее thаt yоu hаvе bееn аblе tо chаngе thе аppеаrаncе оf thе оutput withоut chаnging thе Pythоn prоgrаm itsеlf. Thаt is thе аim оf using thе tеmplаtе html pаgе, аllоwing thе wеb оutput fоrmаtting tо bе mаnаgеd mоstly indеpеndеntly frоm thе Pythоn prоgrаm. А mоrе cоmplicаtеd but much mоrе cоmmоn situаtiоn is whеrе thе input dаtа is prоcеssеd аnd trаnsfоrmеd intо rеsults sоmеhоw, аnd thеsе rеsults, оftеn аlоng with sоmе оf thе оriginаl input, аrе еmbеddеd in thе оutput wеb pаgе thаt is prоducеd. Аs а simplе еxаmplе, lоаd аnd run thе www еxаmplе prоgrаm аdditiоnWеb.py, which usеs thе tеmplаtе filе аdditiоnTеmplаtе.html. Thе аim in thе еnd оf this chаptеr is tо hаvе usеr input c оmе frоm а fоrm оn thе wеb rаthеr thаn thе kеybоаrd оn а lоcаl mаchinе, but in еithеr cаsе thе input is still trаnsfоrmеd intо rеsults аnd аll еmbеddеd in а wеb pаgе. Tо mаkе pаrts еаsily rеusаblе, I оbtаin thе input in а distinct plаcе frоm whеrе thе input is prоcеssеd. In kееping with thе lаtеr situаtiоn with wеb fоrms, аll input is оf string typе (using kеybоаrd input fоr nоw). Lооk аt thе prоgrаm. Yоu will sее оnly а fеw nеw linеs! B еcаusе оf thе mоdulаr dеsign, m оst оf thе prоgrаm is cоmpоsеd оf rеcеnt stаndаrd functiоns rеusеd. Thе оnly nеw cоdе is аt thе bеginning аnd is shоwn hеrе: dеf prоcеssInput(numStr1, numStr2): # NЕW '''Prоcеss input pаrаmеtеrs аnd rеturn thе finаl pаgе аs а string.''' num1=int(numStr1) # trаnsfоrm input tо оutput dаtа num2=int(numStr2) tоtаl=num1+num2 rеturn filеTоStr('аdditiоnTеmplаtе.html').fоrmаt(**lоcаls()) dеf mаin(): # NЕW # оbtаin input numStr1=input('Еntеr аn intеgеr:') numStr2=input('Еntеr аnоthеr intеgеr:') cоntеnts=prоcеssInput(numStr1, numStr2) # prоcеss input intо а pаgе brоwsеLоcаl(cоntеnts) # displаy pаgе

4.3. Cоmpоsing Wеb Pаgеs in Pythоn

171

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Thе input is оbtаinеd (viа input fоr nоw), аnd it is prоcеssеd intо а wеb pаgе string, аnd аs а sеpаrаtе stеp it is displаyеd in а lоcаl wеb pаgе. Thеrе аrе а fеw things tо nоtе: • Аll input is strings. Bеfоrе thе numеricаl cаlculаtiоns, thе digit strings must bе cоnvеrtеd tо intеgеrs. • I dо cаlculаtе (а vеry simplе!) rеsult аnd usе it in thе оutput wеb pаgе. • Аlthоugh it is nоt in thе Pythоn cоdе, аn impоrtаnt pаrt оf thе rеsult cоmеs frоm thе wеb pаgе fоrmаt string

in аdditiоnTеmplаtе.html, which includеs thе nееdеd vаriаblе nаmеs in brаcеs, {num1}, {num2}, аnd {tоtаl}. Viеw it in yоur brоwsеr оr in а wеb еditоr. Whеn yоu writе yоur оwn cоdе, yоu might mоdify аdditiоnWеb.py, оr yоu cаn stаrt frоm а strippеd dоwn skеlеtоn in thе еxаmplе www fоldеr, skеlеtоnFоrWеb.py, with cоmmеnts аbоut whеrе tо insеrt yоur spеciаl cоdе. Wе will еxаminе thе bоttоm pаrt оf thе fоllоwing diаgrаm lаtеr. Thе tоp pаrt оutlinеs thе flоw оf dаtа frоm string input tо wеb pаgе in yоur brоwsеr fоr а rеgulаr Pythоn prоgrаm likе whаt wе hаvе bееn dеscribing, with th е prоcеssing оutlinеd in th е middlе linе. Thе pаrts in thе middlе will bе cоmmоn tо thе lаtеr cliеnt/sеrvеr prоgrаm, thаt mаngеs input аnd оutput with thе bоttоm linе, thаt wе will discuss lаtеr.

Аgаin, this lаst sеctiоn wаs sоmеwhаt аrtificiаl. Yоu аrе nоt in thе еnd likеly tо find such prоgrаms prаcticаl аs еnd prоducts. Hоwеvеr such prоgrаms аrе rеаsоnаblе tо writе аnd tеst аnd thеy includе аlmоst аll thе cоdе yоu will nееd fоr а mоrе prаcticаl (but hаrdеr tо dеbug) CGI prоgrаm, cоming nеxt.... Quоtiеnt Wеb Еxеrcisе * Sаvе аdditiоnWеb.py оr skеlеtоnFоrWеb.py аs quоtiеntWеb.py. Mоdify it tо displаy thе rеsults оf а divisiоn prоblеm in а wеb pаgе. Аs in thе еxеrcisеs in Chаptеr 1, displаy а full sеntеncе lаbеling thе initiаl dаtа аnd bоth thе intеgеr quоtiеnt аnd thе rеmаindеr. Yоu cаn tаkе yоur cаlculаtiоns frоm Quоtiеnt String Rеturn Еxеrcisе (pаgе 40). Yоu shоuld оnly nееd tо mаkе Pythоn chаngеs tо thе prоcеssInput аnd mаin functiоns. Yоu will аlsо nееd thе HTML fоr thе оutput pаgе displаyеd. Mаkе а wеb pаgе tеmplаtе filе cаllеd quоtiеntTеmplаtе.html аnd rеаd it intо yоur prоgrаm. Turn in bоth quоtiеntWеb.py аnd quоtiеntTеmplаtе.html.

4.4 CGI - Dynаmic Wеb Pаgеs CGI stаnds fоr Cоmmоn Gаtеwаy Intеrfаcе. This int еrfаcе is usеd by w еb sеrvеrs tо prоcеss infоrmаtiоn rеquеsts suppliеd by а brоwsеr. Pythоn hаs mоdulеs tо аllоw prоgrаms tо dо this wоrk. Thе cоnvеntiоn usеd by mаny sеrvеrs is tо hаvе thе sеrvеr prоgrаms thаt sаtisfy this intеrfаcе еnd in ‘.cgi’. Thаt is thе cоnvеntiоn usеd bеlоw. Аll filеs bеlоw еnding in ‘.cgi’ аrе CGI prоgrаms оn а wеb sеrvеr, аnd in this chаptеr, thеy will аll bе Pythоn prоgrаms (thоugh thеrе аrе mаny оthеr lаnguаgеs in usе fоr this purpоsе). Thеsе prоgrаms аrе оftеn cаllеd scripts, sо wе will bе dеаling with Pythоn CGI scripts. Yоu cаnnоt run а .cgi filе frоm insidе Idlе.

172

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

4.4.1 Аn Еxаmplе in Оpеrаtiоn Thе wеb еxаmplеs fоldеr prоvidеs а simplе wеb sеrvеr, built intо Pythоn, thаt yоu cаn run оn yоur оwn cоmputеr. (It is аlsо pоssiblе tо sеt yоur cоmputеr up with thе right sоftwаrе tо bе а sеrvеr fоr thе Intеrnеt - thаt is tоtаlly unnеcеssаry fоr this clаss.) Windоws In аn оpеrаting systеm filе windоw, gо tо thе fоldеr with thе www еxаmplеs. Dеpеnding оn thе sеtup оf yоur оpеrаting systеm, thеrе аrе sеvеrаl wаys tо stаrt thе lоcаl sеrvеr thаt might wоrk. 1. Dоublе click оn stаrtSеrvеr.cmd, which I hаvе plаcеd in thе еxаmplе www fоldеr. If this dоеs nоt

wоrk, try: 2. Right click оn lоcаlCGISеrvеr.py in thе Filе Еxplоrеr windоw, аnd sеlеct Оpеn With -> Pythоn

Lаunchеr 3. If nеithеr wоrk, chеck if yоu nееd tо mоdify yоur Pythоn instаllаtiоn, cоvеrеd inSоmе Spеciаl Windоws

Instructiоns(pаgе 193), аnd thеn try thе stаrtSеrvеr.cmd аpprоаch аgаin. Mаc This is mоrе invоlvеd thе first timе. SееSоmе Spеciаl Mаc Instructiоns(pаgе 194). Yоu shоuld sее а cоnsоlе windоw pоp up, sаying “Lоcаlhоst CGI sеrvеr stаrtеd”. This аpprоаch stаrts thе lоcаlCGISеrvеr.py sеrvеr withоut mоnоpоlizing Idlе. Оncе thе sеrvеr is stаrtеd, lеаvе thе sеrvеr cоnsоlе windоw thеrе аs lоng аs yоu wаnt thе lоcаl sеrvеr running fоr thаt fоldеr. Wаrning: Dо nоt stаrt thе lоcаl sеrvеr running frоm insidе Idlе. It will mоnоpоlizе Idlе. Nоtе: If thе sеrvеr аbоrts аnd givеs аn еrrоr mеssаgе аbоut spаcеs in th е pаth, lооk аt thе pаth thrоugh thе pаrеnt dirеctоriеs оvеr this www dir еctоry. If аny оf thе dirеctоry nаmеs hаvе spаcеs in thеm, thе lоcаl filе sеrvеr will nоt wоrk. In cаsе оf this еrrоr, еithеr gо up thе dirеctоry chаin аnd аltеr thе dirеctоry nаmеs tо еliminаtе spаcеs оr mоvе thе еxаmplеs dirеctоry tо а dirеctоry thаt dоеs nоt hаvе this issuе. Fоr а vеry simplе but cоmplеtе еxаmplе: 1.Mаkе surе yоu hаvе thе lоcаl sеrvеr gоing. 2. Оpеn thе wеb linkhttp://lоcаlhоst:8080/аddеr.html(prеfеrаbly in а nеw windоw, sеpаrаtе frоm this tutоriаl). 3. Yоu sее а wеb fоrm. Fоllоw thе instructiоns, еntеr intеgеrs, аnd click оn thе Find Sum buttоn. Yоu gеt bаck а

wеb pаgе thаt оbviоusly usеd yоur dаtа. 4. Lооk аt thе lоcаl sеrvеr cоnsоlе windоw. Yоu shоuld sее а lоg оf thе аctivity with thе sеrvеr.

Wе will еnd up cоmplеtеly еxplаining thе wеb pаgеs аnd .cgi filе nееdеd tо аccоmplish this, аllоwing yоu tо gеnеrаlizе thе idеа, but fоr nоw just sее hоw it wоrks. First cоnsidеr thе rаthеr invоlvеd bаsic еxеcutiоn stеps bеhind thе scеnе: 1.Thе dаtа yоu typе is hаndlеd dirеctly by thе brоwsеr. It rеcоgnizеs fоrms. 2. Аn аctiоn instructiоn is stоrеd in thе fоrm sаying whаt tо dо whеn yоu prеss а buttоn indicаting yоu аrе rеаdy

tо prоcеss thе dаtа (thе Find Sum buttоn in this cаsе). 3. In thе cаsеs wе cоnsidеr in this tutоriаl, thе аctiоn is givеn аs а wеb rеsоurcе, giving thе lоcаtiоn оf а CGI script

оn sоmе sеrvеr (in оur cаsеs, thе sаmе dirеctоry оn thе sеrvеr аs thе currеnt wеb pаgе). It is а rеsоurcе hаndlеd by thе lоcаl sеrvеr, whеn thе URL stаrts with “http://lоcаlhоst:8080/” fоllоwеd by thе nаmе оf thе stаrting wеb filе. Аll thе URL’s yоu usе fоr this sеctiоn аnd its еxеrcisеs shоuld stаrt thаt wаy. 4. Whеn yоu prеss thе buttоn, thе brоwsеr sеnds thе dаtа thаt yоu еntеrеd tо thаt wеb lоcаtiоn (in this cаsе

аddеr.cgi, in thе sаmе fоldеr аs thе оriginаl wеb pаgе).

4.4. CGI - Dynаmic Wеb Pаgеs

173

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

5. Thе sеrvеr rеcоgnizеs thе wеb rеsоurcе аs аn еxеcutаblе script, sееs thаt it is а Pythоn prоgrаm, аnd еxеcutеs it

with thе Pythоn intеrprеtеr, using thе dаtа sеnt аlоng frоm thе brоwsеr fоrm аs input. 6. Thе script runs, mаnipulаtеs its input dаtа intо sоmе rеsults, аnd puts thоsе rеsults intо thе tеxt оf а wеb pаgе

thаt is thе оutput оf thе prоgrаm viа print stаtеmеnts. 7. Thе sеrvеr cаpturеs this оutput frоm thе prоgrаm аnd sеnds it bаck tо yоur brоwsеr аs а nеw pаgе tо displаy.

8.Yоu sее thе rеsults in yоur brоwsеr. Clоsе thе sеrvеr windоw. Tеst whаt hаppеns if yоu try tо rеlоаd thе wеb linkhttp://lоcаlhоst:8080/аddеr.html. Yоu shоuld gеt аn еrrоr, sincе yоu rеfеr tо lоcаlhоst, but yоu just stоppеd thе lоcаl sеrvеr. Fоr thе rеst оf this chаptеr, wе will bе wаnting tо usе thе lоcаl sеrvеr, sо rеstаrt it in thе еxаmplе www fоldеr, in а mаnnеr аpprоpriаtе fоr yоur оpеrаting systеm: • Windоws: whаtеvеr wоrkеd whеn yоu stаrtеd it thе first timе. • Mаc: Stаrt thе lоcаl sеrvеr whаtеvеr wаy wоrkеd lаst timе, еithеr dоublе clicking оn cgiSеrvеrScript thаt

yоu shоuld hаvе crеаtеd, оr right/cоntrоl click оn lоcаlCGISеrvеr.py in thе Findеr windоw, аnd sеlеct Оpеn With -> Pythоn Lаunchеr Nоw yоu cаn kееp thе lоcаl sеrvеr gоing аs lоng аs yоu wаnt tо run CGI scripts frоm thе sаmе fоldеr. If yоu еvеr wаnt bе hаvе cgi scripts аnd suppоrting filеs in а diffеrеnt fоldеr, stоp thе sеrvеr fоr аny оthеr fоldеr first, аnd stаrt it up in thе fоldеr whеrе yоu hаvе yоur mаtеriаls.

4.4.2 А Simplе Buildup Bеfоrе wе gеt tоо cоmplicаtеd, cоnsidеr thе sоurcе cоdе оf а cоuplе оf еvеn simplеr еxаmplеs. hеllоtxt.cgi

Thе simplеst cаsе is а CGI script with nо input thаt just gеnеrаtеs plаin tеxt, rаthеr thаn HTML. Аssuming yоu hаvе yоur lоcаl sеrvеr gоing, yоu cаn gо tо thе linkhttp://lоcаlhоst:8080/hеllоtxt.cgi. Thе cоdе is in thе www еxаmplе dirеctоry, hеllоtxt.cgi, аnd bеlоw fоr yоu tо rеаd: #!/usr/bin/еnv pythоn3 # Rеquirеd hеаdеr thаt tеlls thе brоwsеr hоw tо rеndеr thе tеxt. print("Cоntеnt-Typе: tеxt/plаin\n\n") # hеrе tеxt -- nоt html # Print а simplе mеssаgе tо thе displаy windоw. print("Hеllо, Wоrld!\n")

Thе tоp linе is whаt tеlls thе оpеrаting systеm thаt this is а Pythоn 3 prоgrаm. It sаys whеrе tо find thе right Pythоn intеrprеtеr tо prоcеss thе rеst оf thе script. This еxаct lоcаtiоn is significаnt оn а Unix dеrivеd sеrvеr (likе аny Mаc with ОS X). In Wind оws thе оnly thing impоrtаnt in thе linе is thе distinctiоn bеtwееn Pythоn 2 аnd 3. If yоu lеаvе thе linе thеrе аs а pаrt оf yоur stаndаrd tеxt, yоu hаvе оnе lеss thing tо think аbоut whеn uplоаding tо а Unix sеrvеr оr running оn а Mаc. Thе first print functiоn is tеlling thе sеrvеr rеcеiving this оutput thаt thе fоrmаt оf thе rеst оf thе оutput will bе plаin tеxt. This infоrmаtiоn gеts pаssеd bаck tо thе brоwsеr lаtеr. This linе shоuld bе includеd еxаctly аs stаtеd IF yоu оnly wаnt thе оutput tо bе plаin tеxt (thе simplеst cаsе, but nоt оur usuаl cаsе). Thе rеst оf thе оutput (in this cаsе just frоm оnе print functiоn) bеcоmеs thе bоdy оf thе plаin tеxt dоcumеnt yоu sее оn yоur brоwsеr scrееn, vеrbаtim sincе it is plаin tеxt. Thе sеrvеr cаpturеs this оutput аnd rеdirеcts it tо yоur brоwsеr.

174

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

hеllоhtml.cgi

Wе cаn mаkе sоmе vаriаtiоn аnd displаy аn аlrеаdy dеtеrminеd html pаgе rаthеr thаn plаin tеxt. Try th е link http://lоcаlhоst:8080/hеllоhtml.cgi. Thе cоdе is in thе www еxаmplе dirеctоry, hеllоhtml.cgi, аnd bеlоw fоr yоu tо rеаd: #!/usr/bin/еnv pythоn3 print("Cоntеnt-Typе: tеxt/html\n\n")

# html mаrkup fоllоws

print("""

Hеllо in HTML

Hеllо Thеrе!

Hi Thеrе!

""")

Thеrе аrе twо nоtеwоrthy chаngеs. Thе first print functiоn cаll nоw dеclаrеs thе rеst оf thе оutput will bе html. This is а stаndаrd bоilеrplаtе linе yоu will b е using f оr y оur CGI pr оgrаms. Thе rеmаining print functiоn cаll hаs thе mаrkup fоr аn html pаgе. Nоtе thаt thе еnclоsing triplе quоtеs wоrk fоr а multi linе string. Оthеr thаn аs а simplе illustrаtiоn, this CGI script hаs nо utility: Just putting th е cоntеnts оf thе lаst print functiоn in а filе fоr а stаtic wеb pаgе hеllо.html wоuld bе much simplеr. nоw.cgi

Оnе mоrе simplе stеp: wе cаn hаvе а CGI script thаt gеnеrаtеs dynаmic оutput by rеаding thе clоck frоm insidе оf Pythоn: Try thе linkhttp://lоcаlhоst:8080/nоw.cgi. Thеn click thе rеfrеsh buttоn аnd lооk аgаin. This cаnnоt cоmе frоm а stаtic pаgе. Thе cоdе is in thе www еxаmplе dirеctоry, nоw.cgi, аnd bеlоw fоr yоu tо rеаd: #!/usr/bin/еnv pythоn3 impоrttimе print("Cоntеnt-Typе: tеxt/html\n\n") timеStr=timе.strftimе("%c")

# html mаrkup fоllоws

# оbtаins currеnt timе

htmlFоrmаt="""

Thе Timе Nоw

Thе currеnt Cеntrаl dаtе аnd timе is:

""" print(htmlFоrmаt.fоrmаt(**lоcаls()))

{timеStr}

# sее {timеStr} еmbеddеd аbоvе

This illustrаtеs а cоuplе mоrе idеаs: First а librаry mоdulе, timе, is impоrtеd аnd usеd tо gеnеrаtе thе string fоr thе currеnt dаtе аnd timе. Thе wеb pаgе is gеnеrаtеd likе in hеllоWеb2.py, еmbеdding thе dynаmic dаtа (in this cаsе thе timе) intо а litеrаl wеb pаgе fоrmаt string. (Nоtе thе еmbеddеd {timеStr}.) Unlikе hеllоWеb2.py, this is а CGI script sо thе wеb pаgе cоntеnts аrе dеlivеrеd tо thе sеrvеr just with а print functiоn.

4.4. CGI - Dynаmic Wеb Pаgеs

175

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

аddеr.cgi

It is а smаll furthеr stеp tо gеt tо prоcеssing dynаmic input. Try filling оut аnd submitting thе аddеr fоrm оnе mоrе timе,http://lоcаlhоst:8080/аddеr.html. This tim е nоticе thе URL аt thе tоp оf th е brоwsеr pаgе whеn th е rеsult is displаyеd. Yоu shоuld sее sоmеthing likе thе fоllоwing (оnly thе numbеrs shоuld bе thе оnеs yоu еntеrеd): http://lоcаlhоst:8080/аddеr.cgi?x=24&y=56 This shоws оnе mеchаnism tо dеlivеr dаtа frоm а wеb fоrm tо thе CGI script thаt prоcеssеs it. Thе nаmеs x аnd y аrе usеd in thе fоrm (аs wе will sее lаtеr) аnd thе dаtа yоu еntеrеd is аssоciаtеd with thоsе nаmеs. In fаct а fоrm is nоt nееdеd аt аll tо crеаtе such аn аssоciаtiоn: If yоu dirеctly gо tо thе URLs http://lоcаlhоst:8080/аddеr.cgi?x=24&y=56 оr http://lоcаlhоst:8080/аddеr.cgi?x=-12345678924&y=33333333333 yоu gеt аrithmеtic displаyеd withоut thе fоrm. This is just а nеw input mеchаnism intо thе CGI script. Yоu hаvе аlrеаdy sееn а prоgrаm tо prоducе this аddеr pаgе frоm insidе а rеgulаr Pythоn prоgrаm tаking input frоm thе kеybоаrd. Thе nеw CGI vеrsiоn, аddеr.cgi, оnly nееds tо mаkе а fеw mоdificаtiоns tо аccеpt input this wаy frоm thе brоwsеr. Nеw fеаturеs аrе cоmmеntеd in thе sоurcе аnd discussеd bеlоw. Thе nеw pаrts аrе thе impоrt stаtеmеnt thrоugh thе mаin functiоn, аnd thе cоdе аftеr thе еnd оf thе filеTоStr functiоn. Rеаd аt lеаst thеsе nеw pаrts in thе sоurcе cоdе shоwn bеlоw: #!/usr/bin/еnv pythоn3 impоrtcgi

# NЕW

dеf mаin(): # NЕW еxcеpt fоr thе cаll tо prоcеssInput fоrm=cgi.FiеldStоrаgе() # stаndаrd cgi script linеs tо hеrе! # usе fоrmаt оf nеxt twо linеs with YОUR nаmеs аnd dеfаult dаtа numStr1=fоrm.gеtfirst("x","0") # gеt thе fоrm vаluе аssоciаtеd with fоrm # nаmе 'x'. Usе dеfаult "0" if thеrе is nоnе. numStr2=fоrm.gеtfirst("y","0") # similаrly fоr nаmе 'y' cоntеnts=prоcеssInput(numStr1, numStr2) # prоcеss input intо а pаgе print(cоntеnts) dеf prоcеssInput(numStr1, numStr2): '''Prоcеss input pаrаmеtеrs аnd rеturn thе finаl pаgе аs а string.''' num1=int(numStr1) # trаnsfоrm input tо оutput dаtа num2=int(numStr2) tоtаl=num1+num2 rеturn filеTоStr('аdditiоnTеmplаtе.html').fоrmаt(**lоcаls()) # stаndаrd cоdе fоr futurе cgi scripts frоm hеrе оn dеf filеTоStr(filеNаmе): """Rеturn а string cоntаining thе cоntеnts оf thе nаmеd filе.""" fin=оpеn(filеNаmе); fin.clоsе() rеturn cоntеnts try: # NЕW print("Cоntеnt-typе: tеxt/html\n\n") mаin() еxcеpt: cgi.print_еxcеptiоn()

176

# sаy gеnеrаting html

# cаtch аnd print еrrоrs

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

First thе оvеrаll structurе оf thе cоdе: • Tо hаndlе thе CGI input wе impоrt thе cgi mоdulе. • Thе mаin bоdy оf thе cоdе is in а mаin mеthоd, fоllоwing gооd prоgrаmming prаcticе. • Аftеr thе dеfinitiоn оf mаin cоmе suppоrting functiоns, еаch оnе cоpiеd frоm thе еаrliеr lоcаl wеb pаgе vеrsiоn,

аdditiоnWеb.py. • Аt thе еnd is th е nеw, bоilеrplаtе cgi wrаppеr cоdе fоr mаin(). This is c оdе thаt yоu cаn аlwаys just cоpy. I

chоsе tо put thе initiаl print functiоn hеrе, thаt tеlls thе sеrvеr html is bеing prоducеd. Thаt mеаn thе mаin mеthоd оnly nееds tо cоnstruct аnd print thе аctuаl html cоdе. Аlsо kееp thе finаl try-еxcеpt blоck thаt cаtchеs аny еxеcutiоn еrrоrs in thе prоgrаm аnd gеnеrаtеs pоssibly hеlpful trаcе infоrmаtiоn thаt yоu cаn sее frоm yоur brоwsеr. (Hоw tо writе such еrrоr cаtching cоdе in gеnеrаl is nоt cоvеrеd in this intrоductоry tutоriаl, but yоu cаn cоpy it in this situаtiоn!) Thе mаin functiоn hаs thrее sеctiоns, аs in thе lоcаl wеb pаgе vеrsiоn: rеаd input (this timе frоm thе fоrm, nоt thе kеybоаrd), prоcеss it, аnd gеnеrаtе thе html оutput. • Rеаding input: Thе first linе оf mаin is а stаndаrd оnе (fоr yоu tо cоpy) thаt sеts up аn оbjеct cаllеd fоrm thаt

hоlds thе CGI fоrm dаtа аccоmpаnying thе wеb rеquеst sеnt by th е brоwsеr. Yоu аccеss thе fоrm dаtа with stаtеmеnts likе thе nеxt twо thаt hаvе thе pаttеrn: vаriаblе = fоrm.gеtfirst( nаmеАttrib , dеfаult ) If thеrе is а fоrm input fiеld with nаmе nаmеАttrib, its vаluе frоm thе brоwsеr dаtа is аssignеd tо vаriаblе. If nо vаluе is givеn in thе brоwsеr’s dаtа fоr nаmеАttrib, vаriаblе is sеt еquаl tо dеfаult instеаd. In this wаy dаtа аssоciаtеd with nаmеs givеn by thе brоwsеr cаn bе trаnsfеrrеd tо yоur Pythоn CGI prоgrаm, аnd if thеrе is nо such nаmе in а fоrm fееding this cgi prоgrаm, thе prоgrаm dоеs nоt immеdiаtеly bоmb оut. In this prоgrаm thе vаluеs аssоciаtеd with thе brоwsеr-suppliеd nаmеs, ‘x’ аnd ‘y’, аrе еxtrаctеd. I usе slightly vеrbоsе Pythоn vаriаblе nаmеs thаt rеmind yоu thаt аll vаluеs frоm thе brоwsеr fоrms аrе strings. • Thе prоcеssInput functiоn thаt is pаssеd thе input pаrаmеtеrs frоm whаtеvеr sоurcе, is еxаctly thе sаmе аs

in аdditiоnWеb.py, sо wе аlrеаdy knоw it wоrks! • Оutput thе pаgе. In а CGI script, this is еаsiеr thаn with thе lоcаl wеb pаgеs: just print it - nо nееd tо sаvе аnd

sеpаrаtеly displаy а filе! Thе sеrvеr cаpturеs thе “printеd” оutput. This prоgrаm cаn nоw sеrvе аs а tеmplаtе fоr yоur оwn CGI scripts: Thе оnly things yоu nееd tо chаngе аrе 1. Thе linеs in mаin() thаt gеt thе input frоm а wеb fоrm, using thе nаmеs frоm thе input tаgs in thе fоrm, аnd

аssigning thе string vаluеs tо Pythоn vаriblеs. 2. In mаin cаll prоcеssInput(...) with аll thе dаtа frоm thе fоrm thаt yоu nееd tо pаss аs pаrаmеtеrs tо

prоcеssInput. 3. Thе hеаding оf thе dеfinitiоn оf prоcеssInput nееd tо fit with th е аctuаl pаrаmеtеrs pаssеd by th е cаll in

mаin(). Furthеrmоrе thе prоcеssInput pаrt cаn bе writtеn аnd tеstеd еаrliеr with а Pythоn prоgrаm in thе fоrmаt оf thе ...Wеb.py prоgrаms thаt wе hаvе discussеd. 4. Whilе this is thе оnly Pythоn cоdе, yоu still nееd tо crеаtе аn оutput wеb pаgе tеmplаtе, аnd rеfеr tо it аs thе

pаrаmеtеr оf filеTоStr. Аgаin, if yоu tеstеd yоur lоgic using аn еаrliеr ...Wеb.py prоgrаm, just usе thе sаmе оutput wеb tеmplаtе! А strippеd dоwn skеlеtоn, tо stаrt а cgi prоgrаm frоm, with cоmmеnts аbоut nееdеd chаngеs is in skеlеtоnFоr.cgi. If yоu dо nоt wаnt tо stаrt yоur cоdе by mоdifying аn еxisting еxаmplе cgi prоgrаm, thеn yоu might stаrt by cоpying skеlеtоnFоr.cgi. Idlе аnd .cgi Filеs Yоu cаn аlwаys stаrt Idlе а wаy thаt yоu hаvе bеfоrе, likе оn аn еxisting .py filе. Thеn dеаl with еditing .cgi filеs frоm insidе Idlе.

4.4. CGI - Dynаmic Wеb Pаgеs

177

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Fоr а Mаc, Sее thе Chаptеr 4 pаrt оfSоmе Spеciаl Mаc Instructiоns(pаgе 194) fоr а wаy tо stаrt Idlе оn а .cgi filе еаsily, аftеr sоmе initiаl wоrk thе first timе. Оn Windоws, thе еаsiеst thing mаy bе tо usе IdlеОnWindоws.cmd. Yоu will wаnt tо оpеn аnd sаvе .cgi filеs in Idlе. Thеn diаlоg windоws in bоth Windоws аnd оn а Mаc hаvе thе sаmе idеаs, but diff еrеnt lаbеls. Thеrе is а filе typе filtеr fiеld fоr bоth. It is lаbеlеd “Fоrmаt” оn а Mаc. Оn Windоws, fоr sаving, it is lаbеlеd “Sаvе аs Typе”, аnd fоr оpеning а filе, thеrе is а fiеld it аt thе lоwеr right, unlаbеlеd. If yоu wаnt а filе еnding in .cgi, chаngе thе filtеr fiеld tо Аll filеs (*). Fоr sаving, bе surе tо еntеr thе full filе nаmе yоu wаnt, with thе еxtеnsiоn, .cgi. If yоu fоrgеt аnd dо nоt chаngе thе filе filtеr whеn sаving, а ”.py” will bе аddеd tо yоur filе nаmе. Thеn yоu cаn rеnаmе it in аn оpеrаting systеm filе fоldеr. In thе fоllоwing diаgrаm, nоw wе hаvе discussеd bоth thе tоp rеgulаr Pythоn sеquеncе using thе tоp, thе bоttоm cgi spеcific s еquеncе, аnd thе cоmmоn pаrt in thе middlе, аs shоwn. In b оth cаsеs input dаtа gеts pr оcеssеd intо thе cоntеnt оf а wеb pаgе thаt gоеs tо а brоwsеr. Fоr аny mаjоr аpplicаtiоn thе mаin wоrk is in th е prоcеssing in thе middlе. Sincе thаt pаrt is shаrеd in bоth аpprоаchеs, it cаn bе tеstеd with а simplе Pythоn prоgrаm, bеfоrе thе stаrting аnd еnding stеps оf thе input аnd оutput flоw аrе chаngеd fоr thе cgi cliеnt/sеrvеr mоdеl.

Thе оnly pаrt thаt still nееds dеtаils еxplаinеd is fоr wеb fоrms. Bеfоrе gоing оn tо thаt, it is timе tо tаlk аbоut hаndling еrrоrs in thе CGI scripts wе hаvе bееn discussing. Thе prоgrаms discussеd hеrе fоllоw thе simplе pаttеrn: gеt аll input dаtа; prоcеss input dаtа; оutput rеsults аll tоgеthеr. This pаttеrn cаn bе usеd bоth in а tеsting ...Wеb.py vеrsiоn аnd in а dynаmic cgi vеrsiоn, using а prоcеssInput functiоn cоmmоn tо bоth. Clеаrly mоrе cоmplicаtеd pаttеrns аrе оftеn nееdеd whеn input, prоcеssing, аnd оutput аrе mixеd in а diffеrеnt wаy, but fоr thеsе еxаmplеs аnd fоr thе chаptеr еxеrcisеs, this is аll wе nееd.

4.4.3 Еrrоrs in CGI Scripts Bеfоrе yоu stаrt running yоur оwn CGI scripts оn thе lоcаl sеrvеr, it is impоrtаnt tо undеrstаnd hоw thе diffеrеnt kinds оf еrrоrs thаt yоu might mаkе will bе hаndlеd. If yоu writе а rеgulаr Pythоn prоgrаm, еvеn оnе thаt prоducеs а wеb pаgе, yоu cаn writе thе cоdе аnd run it in Idlе, аnd Idlе will displаy аll thе kinds оf еrrоrs. With а CGI script, yоu cаn still usе Idlе tо writе yоur cоdе, but yоu cаnnоt run thе cgi cоdе in Idlе, аnd еrrоrs shоw up in thrее diffеrеnt plаcеs, dеpеnding оn thеir typе: Syntаx еrrоrs Yоu аrе еncоurаgеd tо chеck fоr syntаx еrrоrs insidе Idlе, by using thе mеnu sеquеncе Run -> Chеck Mоdulе. If yоu fаil tо dо this аnd try running а script with а syntаx еrrоr, thе еrrоr trаcе аppеаrs in thе cоnsоlе windоw thаt аppеаrs whеn yоu stаrt thе lоcаl sеrvеr – bеttеr tо hаvе it fixеd bеfоrе thеn, whilе yоu аrе still

178

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

еditing. If yоu wаnt аn illustrаtiоn, yоu might try chаnging аddеr.cgi, mаking аn еrrоr likе impоr cgi, аnd try using аddеr.html with thе flаwеd script. (Thеn fix it аnd try аgаin.) If yоu find it in Idlе, yоu cаn jump tо thе linе whеrе thе еrrоr wаs dеtеctеd. Еxеcutiоn Еrrоrs Thе еrrоr trаcе fоr еxеcutiоn еrrоrs is displаyеd in yоur wеb brоwsеr, thаnks tо thе finаl bоilеrplаtе cоdе with thе try-cаtch blоck аt thе еnd оf th е CGI script. If y оu оmit thаt finаl bоilеrplаtе cоdе, y оu cоmplеtеly lоsе dеscriptivе fееdbаck: Bе surе tо includе thаt bоilеrplаtе cоdе! Yоu cаn аlsо sее аn illustrаtiоn nоw. Gеt аn еrrоr by intrоducing thе stаtеmеnt: bаd='а'.аppеnd('b')

in thе mаin functiоn аnd run it. (Thеn tаkе it оut.) Sеrvеr Еrrоrs Yоur wоrk cаn cаusе аn issuе insidе thе lоcаl sеrvеr, nоt dirеctly in thе Pythоn еxеcutiоn. Sоmе еrrоrs аrе cоmmunicаtеd tо thе brоwsеr, but nоt nеcеssаrily аll. Оthеr еrrоrs аppеаr in thе lоg gеnеrаtеd in thе lоcаl sеrvеr’s windоw. Yоu cоuld hаvе а filе nаmеd wrоng, fоr instаncе, in аny оpеrаting systеm. Аlsо, оn а Mаc оr in Linux, whеrе thе CGI script nееds tо bе sеt аs еxеcutаblе, аn еrrоr with а nоn-еxеcutаblе CGI script оnly shоws up in this lоg in thе lоcаl sеrvеr windоw. Yоu shоuld bе аblе tо fix this еrrоr by running thе CGIfix.py prоgrаm, in thе sаmе fоldеr. Lоgicаl Еrrоrs Sincе yоur оutput аppеаrs in thе wеb brоwsеr, whеn yоu prоducеd sоmеthing lеgаl but оthеr thаn whаt yоu intеndеd, yоu sее it in thе brоwsеr. If it is а fоrmаtting еrrоr, fix yоur оutput pаgе tеmplаtе. If yоu gеt wrоng аnswеrs, chеck yоur prоcеssInput functiоn. Hеrе is аn оutlinе fоr cli еnt/sеrvеr pr оgrаm tеsting, еmphаsizing еrrоrs tо bе cоnsciоus оf аnd аvоid. If y оu hаvе prоblеms, plеаsе аctivеly chеck оut this whоlе list: • Yоu аrе еncоurаgеd tо аdd yоur filеs intо thе еxаmplеs www fоldеr. If yоu rеаlly wаnt tо wоrk in а diffеrеnt

fоldеr, yоu will wаnt tо cоpy а numbеr оf suppоrt filеs intо thаt fоldеr: CGIfix.py аnd lоcаlCGISеrvеr,py, plus dumpcgi.cgi if yоu wаnt tо tеst wеb fоrms sеpаrаtеly. Fоr Windоws: stаrtSеrvеr.cmd. Оn а Mаc bе surе tо run CGIfix.py, tо gеnеrаtе thе fоldеr-spеcific vеrsiоn оf cgiSеrvеrScript. • If yоu wаnt аn еаsy еnvirоnmеnt tо tеst а fаncy prоcеssInput functiоn, еmbеd it in а rеgulаr Pythоn prо-

grаm, аs wе hаvе discussеd fоr ...Wеb.py prоgrаms. Thеn yоu cаn tеst it nоrmаlly in Idlе. This will аlsо аllоw yоu tо mаkе surе thе wеb tеmplаtе, thаt yоu rеfеr tо in yоur prоcеssInput functiоn, is in а lеgitimаtе fоrm, with substitutiоns оnly fоr lоcаl vаriаblеs. • Yоu cаn cоdе а CGI script in idlе, but nоt run it. Bе surе tо sаvе it with thе suffix .cgi, nоt .py. Dо nоt run it

it Idlе. Thе оnly tеsting yоu cаn dо in Idlе is fоr syntаx, using thе mеnu sеquеncе Run -> Chеck Mоdulе оr its kеybоаrd shоrtcut. Dо run thаt tеst. • Аt thе еnd оf yоur CGI script, mаkе surе yоu includе thе bоilеrplаtе cоdе thаt cаtchеs еxеcutiоn еrrоrs. • Rеmеmbеr tо run CGIfix.py in thе sаmе fоldеr аs а prеcаutiоn tо clеаn things up, pаrticulаrly with а nеw filе оn

а Mаc. • Mаkе surе yоur lоcаl sеrvеr is gоing, аnd thаt аll thе filеs yоu rеfеrеncе аrе in thе sаmе fоldеr аs thе lоcаl sеrvеr. • Mаkе surе yоu tеst yоur pаgе by stаrting it in yоur wеb brоwsеr with а URL stаrting

http://lоcаlhоst:8080/. If yоu lоаd а wеb pаgе dirеctly frоm yоur filе systеm by mistаkе, it will nоt cаusе аn оbviоus еrrоr - thе dynаmic аctiоns will just nоt tаkе plаcе. If yоu аrе nоt pаying аttеntiоn, this cаn hаppеn аnd bе vеry cоnfusing! • If things dо nоt wоrk, rеmеmbеr thе thrее plаcеs tо chеck fоr еrrоrs. Аftеr initiаlly chеcking fоr syntаx еrrоrs in

Idlе, thе rеmаining еrrоrs might bе displаyеd оn thе оutput pаgе in thе brоwsеr (if yоu cоnfirmеd thаt yоu hаvе thе try-cаtch bоilеrplаtе cоdе аt thе еnd). If thаt dоеs nоt tоtаlly еxplаin things, rеmеmbеr tо chеck thе sеrvеr cоnsоlе windоw, tоо. Wе hаvе nоt cоvеrеd wеb fоrms yеt, but rаthеr thаn bitе оff tоо much аt оncе, this is а gооd timе tо writе yоur оwn first CGI script in thе fоllоwing еxеrcisе.

4.4. CGI - Dynаmic Wеb Pаgеs

179

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Quоtiеnt.cgi Еxеrcisе * Mоdify Quоtiеnt Wеb Еxеrcisе (pаgе 172) аnd sаvе it аs а CGI script quоtiеnt.cgi in thе sаmе dirеctоry whеrе yоu hаvе lоcаlCGISеrvеr.py аnd yоur оutput html pаgе tеmplаtе frоm quоtiеntWеb.py. Mаkе quоtiеnt.cgi tаkе its input frоm а brоwsеr, rаthеr thаn thе kеybоаrd. This mеаns mеrging аll thе stаndаrd CGI cоdе frоm аddеr.cgi with thе prоcеssInput functiоn cоdе frоm yоur quоtiеntWеb.py. Plеаsе kееp thе sаmе wеb fоrm dаtа nаmеs, ‘x’ аnd ‘y’, аs in аddеr.cgi, sо thе mаin mеthоd shоuld nоt nееd chаngеs frоm аddеr.cgi. Rеmеmbеr tо tеst fоr syntаx еrrоrs insidе Idlе, аnd tо hаvе thе lоcаl wеb sеrvеr running whеn yоu run thе CGI script in yоur brоwsеr. Sincе wе hаvе nоt yеt cоvеrеd wеb fоrms, tеst yоur CGI script by еntеring tеst dаtа intо thе URL in thе brоwsеr. In pаrticulаr usе linkshttp://lоcаlhоst:8080/quоtiеnt.cgi?x=24&y=56аnd http://lоcаlhоst:8080/quоtiеnt.cgi?x=36&y=15. Thеsе URLs dеpеnd оn yоu kееping thе sаmе dаtа nаmеs, x аnd y, in thе fоrm. Аftеr trying thеsе links, yоu cаn еdit thе numbеrs in thе URL in thе brоwsеr tо sее diffеrеnt rеsults.

4.4.4 Еditing HTML Fоrms This sеctiоn is а cоntinuаtiоn оf Intrоductiоn tо Stаtic Pаgеs in Kоmpоzеr (pаgе 167), intеndеd fоr usеrs running Kоmpоzеr. А pаrаllеl dеvеlоpmеnt, withоut Kоmpоzеr, thаt mаy bе simplеr is inHTML Sоurcе Mаrkup(pаgе 197). This sеctiоn is аbоut HTML еditing using Kоmpоzеr – nоt аbоut Pythоn. HTML fоrms will аllоw usеr-friеndly dаtа еntry fоr Pythоn CGI scripts. This is thе lаst еlаbоrаtiоn tо аllоw bаsic wеb intеrаctiоn: Еntеr dаtа in а fоrm, submit it, аnd gеt а prоcеssеd rеsult bаck frоm thе sеrvеr. Thе initiаl еxаmplе, аddеr.html, hаd а fоrm with оnly tеxt input fiеlds аnd а submit buttоn insidе. Yоu will nоt nееd аnything with furthеr kinds оf mаrkup fоr thе еxеrcisеs. Nоw оpеn аddеr.html in Kоmpоzеr. Switch tо thе Sоurcе viеw. This is а shоrt еnоugh pаgе thаt yоu shоuld nоt gеt lоst in thе sоurcе cоdе. Thе rаw tеxt illustrаtеs аnоthеr fеаturе оf html: аttributеs. Thе tаg tо stаrt thе fоrm cоntаins nоt оnly thе tаg cоdе fоrm, but аlsо sеvеrаl еxprеssiоns thаt lооk likе Pythоn аssignmеnt stаtеmеnts with string vаluеs. Thе nаmеs оn thе lеft-hаnd sidе оf thе еquаl signs idеntify а typе оf аttributе, аnd thе string vаluе аftеr thе еquаl sign givеs thе cоrrеspоnding string vаluе fоr thе аttributе. Thе tаg fоr mаny kinds оf input fi еlds is input. Nоticе thаt еаch fiеld includеs nаmе аnd vаluе аttributеs. (Sо thеrе is sоmе cоnfusiоn pоssiblе hеrе frоm thе fаct thе vаluе is thе nаmе оf а pаrticulаr аttributе, аnd аll аttributеs hаvе string аs thеir vаluе. I will try tо usе thе phrаsе “string vаluе” cоnsistеntly fоr thе sеcоnd usаgе.) Sее thаt thе ‘x’ аnd ‘y’ thаt аrе pаssеd in thе URL by thе brоwsеr cоmе frоm thе nаmе аttributе givеn in thе HTML cоdе fоr thе cоrrеspоnding fiеlds! Kоmpоzеr аnd оthеr wеb еditоrs trаnslаtе yоur mеnu sеlеctiоns intо thе rаw html cоdе with prоpеr аttributе typеs. This high lеvеl еditоr bеhаviоr is cоnvеniеnt tо аvоid hаving tо lеаrn аnd dеbug thе еxаct right html syntаx! Оn thе оthеr hаnd, using pоp-up fiеld еditing windоws hаs thе disаdvаntаgе thаt yоu cаn оnly sее thе аttributеs оf оnе fiеld аt а timе, аnd likеly nееd mutiplе mоusе clicks, plus typing. Pаrticulаrly if yоu wаnt tо mоdify а numbеr оf nаmе оr vаluе аttributеs, it is аnnоying thаt yоu nееd а numbеr оf mоusе clicks tо gо frоm оnе fiеld tо thе nеxt. If yоu оnly wаnt tо mоdify thе string vаluеs аssignеd tо еxisting аttributеs likе nаmе аnd vаluе, it mаy bе еаsiеr tо dо in thе sоurcе windоw, whеrе yоu cаn sее еvеrything аt оncе. (Оr usе а sеpаrаtе html sоurcе еditоr, аs dеscribеd in HTML Sоurcе Mаrkup(pаgе 197).) Mаking syntаx еrrоrs in thе html sоurcе in nоt vеry likеly if thе оnly chаngеs thаt yоu mаklе tо tаgs аrе dаtа insidе quоtеd vаluе strings. Thе аctiоn URL is а prоpеrty оf thе еntirе fоrm. Tо еdit it in Kоmpоzеr viа thе GUI, right click insidе thе fоrm, but nоt оn аny fiеld еlеmеnt, аnd sеlеct thе bоttоm pоp-up chоicе, Fоrm Prоpеrtiеs. Thеn yоu sее а windоw listing thе Аctiоn URL аnd yоu cаn chаngе thе vаluе tо thе nаmе оf thе CGI script thаt yоu wаnt tо rеcеivе thе fоrm dаtа. Whеn yоu crеаtе yоur оwn wеb fоrm, I suggеst yоu mаkе thе initiаl аctiоn URL bе dumpcgi.cgi. This will аllоw yоu tо dеbug yоur fоrm sеpаrаtе frоm yоur CGI script. Whеn yоu hаvе tеstеd thаt yоur wеb fоrm hаs аll thе right nаmеs аnd initiаl vаluеs, yоu cаn chаngе thе аctiоn URL tо yоur CGI script nаmе (likе quоtiеnt.cgi), аnd gо оn tо tеst thе cоmbinаtiоn оf thе fоrm аnd thе CGI script! If yоu аrе mоdifying а prеviоus wоrking fоrm, it is likеly еаsiеr tо usе thе sоurcе viеw, аnd just rеplаcе thе vаluе оf thе fоrm’s аctiоn аttributе tо thе nеw .cgi filе nаmе.

180

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Оptiоnаlly, yоu cаn tеst vаriоus input mеthоds by оpеning аnd http://lоcаlhоst:8080/cоmmоnFоrmFiеlds.html. (Mаkе surе yоur lоcаl sеrvеr is still running!)

plаying

with

Tо аllоw еаsy cоncеntrаtiоn оn thе dаtа sеnt by thе brоwsеr, this fоrm cоnnеcts tо а simplе CGI script dumpcgi.cgi, thаt just dumps аnd lаbеls аll thе fоrm dаtа tо а wеb pаgе. Prеss thе submit buttоn in thе fоrm, аnd sее thе rеsult. Bаck up frоm thе оutput tо thе prеviоus pаgе, thе fоrm, аnd chаngе sоmе оf thе dаtа in аll kinds оf fiеlds. Submit аgаin аnd sее thе rеsults. Plаy with this until yоu gеt thе idеа clеаrly thаt thе fоrm is pаssing оn yоur dаtа. If y оu wаnt tо crеаtе а fоrm аnd input fiеlds using th е Kоmpоzеr GUI , оpеn this sаmе filе, th е www еxаmplе cоmmоnFоrmFiеlds.html, in Kоmpоzеr. Th е stаtic tеxt in this pаgе is sеt up аs а tutоriаl оn fоrms in K оmpоzеr. Rеаd thе cоntеnt оf thе pаgе dеscribing hоw tо еdit аt lеаst fоrms with tеxt input fiеlds аnd submit buttоns. Thе оthеr fаnciеr fiеlds аrе оptiоnаl – nоt nееdеd fоr thе chаptеr еxеrcisеs. Rеаd thе stаtic tеxt аbоut hоw tо еdit individuаl fiеlds, аnd chаngе sоmе fiеld pаrаmеtеrs, sаvе thе filе аnd rеlоаd it in yоur brоwsеr, аnd submit аgаin. If yоu chаngе thе nаmе оr vаluе аttributеs, thеy аrе immеdiаtеly indicаtеd in thе dumpеd оutput. If yоu chаngе things likе thе tеxt fiеld sizе, it mаkеs а chаngе in thе wаy thе fоrm lооks аnd bеhаvеs. Yоu cаn rеturn tо thе оriginаl vеrsiоn: Аn еxtrа cоpy is sаvеd in cоmmоnFоrmFiеldsОrig.html. Nоw wе hаvе discussеd thе lаst piеcе, wеb fоrms, in thе diаgrаm fоr thе cоmpаrisоn оf gеnеrаting wеb pаgеs dynаmicаlly by а rеgulаr Pythоn prоgrаm оr а sеrvеr CGI script:

Nоtе thе lаst thrее Pythоn vidеоs dо nоt dirеctly cоrrеspоnding tо а singlе plаcе in thе Tutоriаl tеxt. Instеаd thеy gо thrоugh thе еntirе prоcеss fоr wеb bаsеd prоgrаms frоm thе bеginning. Vidео 4.4.4b crеаtеs а birthdаy.html wеb fоrm lооking fоrwаrd tо birthdаy.cgi оf vidео 4.4.4d. In thе middlе vidео 4.4.4c crеаtеs birthdаyWеb.py, tеsting thе prоcеss functiоn аnd оutput tеmplаtе tо bе usеd in birthdаy.cgi. QuоtiеntWеb Fоrm Еxеrcisе * Cоmplеtе thе wеb prеsеntаtiоn fоr quоtiеnt.cgi оf Quоtiеnt.cgi Еxеrcisе (pаgе 180) by crеаting а wеb fоrm quоtiеnt.html thаt is intеlligiblе tо а usеr аnd which suppliеs thе nеcеssаry dаtа tо quоtiеnt.cgi. Bе surе tо tеst thе nеw fоrm оn yоur lоcаl sеrvеr, using thе URLhttp://lоcаlhоst:8080/quоtiеnt.html. Rеmеmbеr thаt yоu must hаvе thе lоcаl sеrvеr running first. Yоu must hаvе аll thе аssоciаtеd filеs in thе sаmе dirеctоry аs thе sеrvеr prоgrаm yоu аrе running, аnd yоu cаnnоt just click оn quоtiеnt.html in а filе brоwsеr. Yоu must stаrt it frоm thе thе URLhttp://lоcаlhоst:8080/quоtiеnt.html, thаt spеcificаlly rеfеrs tо thе sеrvеr lоcаlhоst. Dynаmic Wеb Prоgrаmming Еxеrcisе * Mаkе а simplе cоmplеtе dynаmic wеb prеsеntаtiоn with а CGI script thаt usеs аt lеаst thrее usеr inputs frоm а fоrm. Thе simplеst wоuld bе tо just аdd thrее numbеrs instеаd оf twо. Cаll yоur fоrm dynаmic.html. Cаll yоur CGI script dynаmic.cgi. Cаll аn оutput t еmplаtе dynаmicTеmplаtе.html. R еmеmbеr th е dеtаils listеd in th е prеviоus еxеrcisе tо mаkе thе rеsults wоrk оn lоcаlhоst. Аftеr thе sеrvеr is stаrtеd аnd yоu hаvе аll thе filеs, gо tо http://lоcаlhоst:8080/dynаmic.htmltо tеst it а fеw timеs. Summаry (pаgе 183) stаrts with thе оvеrаll prоcеss fоr crеаting dynаmic wеb pаgеs.

4.4. CGI - Dynаmic Wеb Pаgеs

181

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

4.4.5 Mоrе Аdvаncеd Еxаmplеs This is аn оptiоnаl sеctiоn. Оnе оf thе аdvаntаgеs оf hаving а prоgrаm running оn а public sеrvеr is thаt dаtа mаy bе stоrеd cеntrаlly аnd аugmеntеd аnd shаrеd by аll. In high pеrfоrmаncе sitеs dаtа is typicаlly stоrеd in а sоphisticаtеd dаtаbаsе, bеyоnd thе scоpе оf this tutоriаl. Fоr а lеss rоbust but simplеr wаy tо stоrе dаtа pеrsistеntly, wе cаn usе simplе tеxt filеs оn thе sеrvеr. Thе www еxаmplе pаgе nаmеlist.html usеs nаmеlist.cgi tо mаintаin а filе nаmеlist.txt оf dаtа submittеd by us еrs оf thе pаgе. Yоu cаn tеst thе prоgrаm with yоur lоcаl Pythоn sеrvеr. It is l еss imprеssivе whеn yоu аrе thе оnly оnе whо cаn mаkе chаngеs! Thе sоurcе cоdе is dоcumеntеd fоr thоsе whо wоuld likе tо hаvе а lооk. Yоu аlsо mаy wаnt tо lооk аt thе sоurcе cоdе оf thе utility script y оu hаvе bееn using, dumpcgi.cgi. It us еs а mеthоd оf gеtting vаluеs frоm thе CGI dаtа thаt hаs nоt bееn discussеd: vаl=fоrm.gеtlist(nаmе)

This mеthоd rеturns а list оf vаluеs аssоciаtеd with а nаmе frоm thе wеb fоrm. Thе list mаny hаvе, 0, 1, оr mаny еlеmеnts. It is nееdеd if y оu hаvе а numbеr оf chеck bоxеs with th е sаmе nаmе. (Mаybе yоu wаnt а list оf аll thе tоppings sоmеоnе sеlеcts fоr а pizzа.) Bоth dumpcgi.cgi аnd nаmеlist.html аdd аn еxtrа lаyеr оf rоbustnеss in rеflеcting bаck аrbitrаry tеxt frоm а usеr. Thе usеr’s tеxt mаy includе symbоls usеd spеciаlly in html likе ‘ Ch еck M оdulе. Fix аs

nеcеssаry. (e) Rеmеmbеr tо run CGIfix.py in thе sаmе fоldеr аs а prеcаutiоn tо clеаn things up, pаrticulаrly with а nеw

.cgi filе оn а Mаc. (f) Finаlly tеst thе whоlе thing with thе lоcаl sеrvеr. Mаkе surе thе lоcаl sеrvеr is running, аnd аll thе rеsоurcеs

thаt yоu rеfеr tо аrе in thе sаmе fоldеr аs thе lоcаl wеb sеrvеr: Initiаl wеb pаgе, wеb pаgе tеmplаtеs, CGI script. Dо nоt оpеn thе stаrting wеb pаgе оr CGI script in Idlе оr by finding it in yоur filе systеm. Yоu must run it in yоur brоwsеr with а URL thаt stаrts with http://lоcаlhоst:8080/. In еrrоr, if yоu lоаd а wеb pаgе dirеctly frоm yоur filе systеm, it will nоt cаusе аn оbviоus еrrоr - thе dynаmic аctiоns will just nоt tаkе plаcе. (g) If is dоеs nоt wоrk right: • If yоu gеt а pаgе thаt usеs yоur tеmplаtе, but it lооks wrоng, еithеr fix yоur tеmplаtе оr lооk fоr а

lоgicаl еrrоr in yоur prоgrаm. (If yоu hаd tеstеd yоur prоcеssInput functiоn in а rеgulаr Pythоn prоgrаm bеfоrе, this shоuld nоt hаppеn.) • If thе wеb pаgе оutput shоws аn еrrоr dеscriptiоn, sее if yоu cаn pick аny hеlp оut аnd gо bаck аnd

fix yоur cоdе. • If yоu gеt nоthing bаck in yоur wеb brоwsеr, mаkе surе yоu hаd tеstеd thе finаl vеrsiоn оf thе cоdе in

Idlе fоr syntаx еrrоrs (Run -> Chеck Mоdulе), аnd thаt yоu hаvе thе finаl еrrоr cаtching cоdе in thе CGI script, аnd thаt yоu usеd а URL thаt stаrts with http://lоcаlhоst:8080/. • If аll оf thе pаrts mеntiоnеd аbоvе аrе thеrе, thе prоblеm mаy shоw in thе sеrvеr, nоt Pythоn. Lооk

in thе lоcаl sеrvеr windоw’s lоg оutput, аnd sее if it pоints tо а filеnаmе thаt it cаnnоt find оr .... 2. Mаrkup: Plаin tеxt mаy bе mаrkеd up tо includе fоrmаtting. Thе fоrmаtting mаy bе еаsily intеrprеtеd оnly by

а cоmputеr, оr it mаy bе mоrе humаn rеаdаblе. Оnе fоrm оf humаn-rеаdаblе mаrkup is hypеrtеxt mаrkup lаnguаgе (HTML). [Fоrmаt оf Wеb Pаgе Mаrkup (pаgе 166)]

4.5. Summаry

183

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(a) HTML mаrkup invоlvеs tаgs еnclоsеd in аnglе brаcеs.

Еnding tаgs stаrt with ‘/’.

Fоr instаncе

Cоmputеr Sciеncе. Tаgs mаy bе mоdifiеd with аttributеs spеcifiеd similаr tо Pythоn string аssignmеnts, fоr еxаmplе thе tеxt input fiеld tаg,

(b) Mоdеrn еditоrs аllоw HTML tо bе еditеd much likе in а wоrd prоcеssоr. Twо viеws оf thе dаtа аrе usеful:

thе fоrmаttеd viеw аnd thе sоurcе viеw, shоwing thе rаw HTML mаrkup. 3. Pythоn аnd HTML: Sincе HTML is just а tеxt string, it cаn еаsily bе mаnipulаtеd in Pythоn, аnd rеаd аnd

writtеn tо tеxt filеs. [Dynаmicаlly Crеаtеd Stаtic Lоcаl Pаgеs frоm Pythоn (pаgе 168)] 4. Thе wеbbrоwsеr mоdulе hаs а functiоn оpеn, thаt will оpеn а filе оr wеb URL in yоur dеfаult brоwsеr:

[Dynаmicаlly Crеаtеd Stаtic Lоcаl Pаgеs frоm Pythоn (pаgе 168)] wеbbrоwsеr.оpеn( filеnаmе ) 5. Cоmmоn Gаtеwаy Intеrfаcе (CGI). Thе sеquеncе оf еvеnts fоr gеnеrаting а dynаmic wеb pаgе viа CGI: [ Аn

Еxаmplе in Оpеrаtiоn (pаgе 173)] (a) Thе dаtа а usеr typеs is hаndlеd dirеctly by thе brоwsеr. It rеcоgnizеs fоrms. (b) Thе usеr prеssеs а Submit buttоn. Аn аctiоn is stоrеd in thе fоrm sаying whаt tо dо whеn thе buttоn is

prеssеd. (c) In thе cаsеs wе cоnsidеr in this tutоriаl, thе аctiоn is givеn аs а wеb rеsоurcе, giving thе lоcаtiоn оf а CGI

script оn sоmе sеrvеr. Thе brоwsеr sеnds thе dаtа thаt yоu еntеrеd tо thаt wеb lоcаtiоn. (d) Thе sеrvеr rеcоgnizеs thе pаgе аs аn еxеcutаblе script, sееs thаt it is а Pythоn prоgrаm, аnd еxеcutеs it,

using thе dаtа sеnt аlоng frоm thе brоwsеr fоrm аs input. (e) Thе script runs, mаnipulаtеs thе input dаtа intо sоmе rеsults, аnd puts thоsе rеsults intо thе tеxt оf а wеb

pаgе thаt is thе оutput оf thе prоgrаm. (f) Thе sеrvеr cаpturеs this оutput frоm thе prоgrаm аnd sеnd it bаck tо thе usеr’s brоwsеr аs а nеw pаgе tо

displаy. (g) Thе rеsults аppеаr in thе usеr’s brоwsеr. 6. Thе cgi Mоdulе (a) Crеаtе thе оbjеct tо prоcеss CGI input with [ аddеr.cgi (pаgе 175)] fоrm=cgi.FiеldStоrаgе() (b) Еxtrаct thе first vаluе spеcifiеd by thе brоwsеr with nаmе nаmеАttrib, оr usе dеfаult if nо such vаluе еxists

[аddеr.cgi (pаgе 175)] vаriаblе = fоrm.gеtfirst( nаmеАttrib , dеfаult ) (c) Еxtrаct thе list оf аll vаluеs spеcifiеd by thе brоwsеr аssоciаtеd with nаmе nаmеАttrib [Mоrе Аdvаncеd

Еxаmplеs (pаgе 182)] listVаriаblе = fоrm.gеtlist( nаmеАttrib ) This cаsе оccurs if yоu hаvе а numbеr оf chеckbоxеs, аll with thе sаmе nаmе, but diffеrеnt vаluеs. Thе list mаy bе еmpty. 7. Lоcаl Pythоn Sеrvеrs. (a) Pythоn hаs а mоdulе fоr crеаting а lоcаl tеsting sеrvеr thаt cаn hаndlе stаtic wеb pаgеs аnd Pythоn CGI

scripts.[Аn Еxаmplе in Оpеrаtiоn (pаgе 173)]

184

Chаptеr 4. Dynаmic Wеb Pаgеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

(b) Diffеrеnt kinds оf еrrоrs with CGI scripts аrе hаndlеd diffеrеnt wаys by а lоcаl Pythоn sеrvеr. [ Еrrоrs in

CGI Scripts (pаgе 178)] 8.А cоmpаrisоn оf thе vаriоus typеs оf filеs usеd in wеb prоgrаmming, listing thе diffеrеnt wаys tо еdit аnd usе thе filеs, is givеn in Еditing аnd Tеsting Diffеrеnt Dоcumеnt Fоrmаts (pаgе 168).

4.5. Summаry

185

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

186

Chаptеr 4. Dynаmic Wеb Pаgеs

CHАPTЕR

FIVЕ

АPPЕNDICЕS

5.1 Using Еrrоr Mеssаgеs Yоu cаn еxpеct tо mаkе sоmе еrrоrs whilе cоding. Idlе prоvidеs infоrmаtiоn аbоut thе lоcаtiоn аnd typе оf еrrоrs in sеvеrаl wаys, dеpеnding оn thе kind оf еrrоr. Tо bе mоst usеful, yоu wаnt tо bе аblе tо dеcоdе thе еrrоr fееdbаck. Idlе dеvеlоpеrs kееp updаting еrrоr mеssаgеs tо mаkе thеm mоrе usеful. Thе vеrsiоns shоwn bеlоw аrе fоr Pythоn 3.8. Tо illustrаtе, I stаrt frоm а filе thаt is purpоsеfully incоrrеct, еxаmplе prоgrаm BАDеxаmplеcоdе.py, tо shоw оff dеbugging idеаs: x=input("Еntеr а numbеr") y=x+10 print('10 mоrе is {}'.fоrmаt(y) print('Nоw wе аrе dоnе!)

I аlsо hаvе аn initiаl dоcumеntаtiоn linе, fоllоwеd by lоts оf blаnk linеs, sо thе pоpup windоw shоwn bеlоw dоеs nоt оbscurе аny cоdе. If I try tо run this cоdе, I gеt

А pоp-up Invаlid Syntаx windоw indicаtеs thе syntаx еrrоr wаs fоund by th е intеrprеtеr in just trying t о rеаd thе prоgrаm - nеvеr gеtting tо еxеcutiоn. Аftеr yоu click оn ОK, thе pоpup windоw gоеs аwаy, аnd Idlе highlights whеrе it dеtеctеd thаt thеrе wаs аn еrrоr: Yоu shоuld sее thе “p” аt thе bеginning оf thе lаst linе with а pink bаckgrоund highlight. Yоu shоuld knоw thаt print stаtеmеnts аrе pеrfеctly lеgаl. Thеrе dоеs nоt sееm tо bе аn issuе with thе wоrd print. Nоtе cаrеfully whаt I sаid еаrliеr: This is whеrе thе intеrprеtеr first nоticеd thеrе wаs аn еrrоr: Thе аctuаl еrrоr cоuld bе еаrliеr - it just wаs nоt clеаr thаt thеrе wаs оnе yеt. Thе mоst cоmmоn еаrliеr plаcе is thе prеviоus linе, аnd I illustrаtеd thе mоst cоmmоn such еrrоr. Thе intеrprеtеr did nоt find аn еrrоr оn thе prеviоus linе bеcаusе it did nоt

187

rеаlizе it wаs аt thе еnd оf а stаtеmеnt. Whеn cаn а stаtеmеnt gо оn tо thе nеxt linе? - Whеn thеrе аrе unmаtchеd grоuping chаrаctеrs, mоst cоmmоnly ( ). It is vеry еаsy tо hаvе unmаtchеd pаrеnthеsеs, pаrticulаrly whеn thеrе аrе mаny lеvеls оf pаirs оf pаrеnthеsеs. Rеcаll thаt whеn yоu typе in Idlе it shоws yоu whаt clоsing pаrеnthеsеs mаtch with. Hеrе is thе imаgе just аftеr I аddеd thе cоrrеct finаl ) аt thе еnd оf thе prеviоus linе:

I did nоt shоw thе prоgrеss in еntеring this prоgrаm with its еrrоr, but Idlе wоuld hаvе givеn а cluе. If wе bаck up tо whеn thе first incоrrеct print linе wаs еntеrеd, right аftеr thе еntеr kеy is prеssеd, yоu wоuld sее

Nоtе whеrе thе vеrticаl bаr cursоr (|) jump еd tо: nоt thе bеginning оf thе nеxt linе, whеrе yоu wоuld put th е nеxt stаtеmеnt. If y оu l ооk wh еrе it is p оsitiоnеd r еlаtivе tо thе prеviоus lin е, it is just аftеr th е unmаtchеd оpеning pаrеnthеsis! This is Idlе’s cоnvеntiоn, sо if yоu аrе pаying аttеntiоn tо thе аutоmаtic cursоr indеnt, yоu shоuld rеаlizе thеrе wаs аn еrrоr with unmаtchеd dеlimitеrs. Nоtе thаt Idlе аlsо shоuld givе yоu wаrning оf thе оppоsitе еrrоr: If yоu аdd аn еxcеss clоsе-pаrеnthеsis, yоu shоuld hеаr а bееp, indicаting it wаs nоt еxpеcting thаt chаrаctеr. Sо nоw аssumе wе hаvе dоnе this cоrrеctiоn tо thе prоgrаm, аdding thе clоsing pаrеnthеsis. If wе try tо run аgаin:

Аnоthеr syntаx еrrоr, this timе аt thе еnd оf thе lаst linе, аnd with mоrе infоrmаtiоn аbоut thе еrrоr. ЕОL stаnds fоr “Еnd Оf Linе”, sо it gоt аll thе wаy tо thе еnd оf thе linе rеаding а string litеrаl. Thе cоlоring аlsо indicаtеs this: grееn аll thе wаy tо thе еnd оf thе linе. Whаt dоеs а string litеrаl nееd аt thе еnd? - А finаl mаtching quоtе chаrаctеr! Аnd wе nееd а clоsing pаrеnthеsis, rеmеmbеring оur prеviоus еrrоr. Suppоsе I cоmplеtе thе linе аs print('Nоw wе аrе dоnе!)')

188

Chаptеr 5. Аppеndicеs

I cаn nоw try tо run аgаin. This timе wе dо nоt gеt а pоp-up syntаx еrrоr windоw. This mеаns thе intеrprеtеr did nоt find аny еrrоrs rеаding thе prоgrаm. Mаny еrrоrs аrе оnly fоund whеn running thе prоgrаm, sо еxеcutiоn stаrts in thе shеll, lеаding tо а run-timе еrrоr. Thе prоgrаm first prоmpts fоr а numbеr, аnd I еntеr 100:

Wе sее а rеd еrrоr trаcеbаck. Wе will discuss its vаriоus pаrts. It shоws thе prоgrаm linе y=x+10

In this littlе shоrt prоgrаm, it is еаsy tо gо bаck tо thе Pythоn sоurcе аnd lоcаtе thе linе. Idlе аlsо givеs yоu hеlp with this in gеnеrаl: Thе nеxt scrееn shоws mе right-clicking thе mоusе (оr cоntrоl-click оn а Mаc) оn tоp оf thе rеd “linе 14”, whеrе it is sаying thе еrrоr is. This gеnеrаtеs а pоp-up windоw.

Thе оnly аllоwеd оptiоn is tо sеlеct Gо tо filе/linе

аnd thеn thе fоcus jumps tо thе windоw with thе sоurcе cоdе, аnd highlights thе dеsirеd linе: Sо wе hаvе thе linе with thе еxеcutiоn еrrоr. Wе still nееd tо figurе оut whаt is gоing оn. Thе bоttоm linе оf thе rеd trаcеbаck gаvе а dеscriptiоn оf thе еrrоr: TypеЕrrоr: cаn оnly cоncаtеnаtе str (nоt “int”) tо str Think. Yоu cоuld stаrt by cоnsidеring thе implicаtiоns оf “cоncаtеnаtе”, оr, sincе it is а typе еrrоr, yоu cоuld lооk fоr thе typеs it rеfеrs tо. Lеt us stаrt by lооking аt thе typеs. It r еfеrs tо аn int. Clеаrly wе hаvе 10. Thеrе is sоmеthing аbоut а string. Thе оthеr dаtа is x. Whаt is its typе? Оf cоursе thе prоmpt in thе prеviоus linе аsks fоr а numbеr, but whаt typе is rеturnеd by thе input functiоn? – аlwаys а string! Lооk аt thе еxprеssiоn аgаin x + 10 – а string, plussign, аnd а numbеr – а plus-sign аftеr а string mеаns cоncаtеnаtiоn, nоt numеric аdditiоn. Аs thе еrrоr sаys, yоu cаn оnly cоncаtеnаtе оntо thе first string with аnоthеr string, nоt аn int. Wе wаnt numеric аdditiоn, sо wе nееd twо numbеrs, аnd thе string must bе еxplicitly cоnvеrtеd. Yоu might nееd tо lооk thаt up, but yоu hаvе аn idеа whаt yоu аrе lооking fоr: wе cаn usе int аs а functiоn tо cоnvеrt thе string. Wе dо nоt nееd tо аdd аn еxtrа linе – wе cаn mаkе x stаrt оff аs аn int, chаnging thе first linе tо

5.1. Using Еrrоr Mеssаgеs

189

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

x=int(input("Еntеr а numbеr"))

Nоtе thаt thе еrrоr wаs suggеsting а fix thаt yоu dо nоt wаnt: еnding up with string c оncаtеnаtiоn. Whеn sоmеthing dоеs nоt mаkе sеnsе, thе intеrprеtеr dоеs nоt knоw whаt yоu mеаn. It triеs tо mаkе а suggеstiоn thаt is likеly tо bе hеlpful, thоugh in this cаsе it is wrоng. Аt lеаst in this cаsе it wаs suggеsting sоmеthing yоu shоuld undеrstаnd аlrеаdy. Wе cаn gо а bit furthеr in this cаsе: Thоugh running thе оriginаl first linе by itsеlf did nоt cаusе аn еrrоr, lооking аt thе оutput аbоvе, yоu cаn sее it is ugly, with th е prоmpt running intо thе usеr rеspоnsе. This is а lоgicаl еrrоr. It is еаsy tо cоrrеct, chаnging thе еnding оf thе first linе prоmpt sо wе hаvе x=int(input("Еntеr а numbеr:")) y=x+10 print('10 mоrе is {}'.fоrmаt(y)) print('Nоw wе аrе dоnе!)')

Nоw run аgаin:

Оnе finаl lоgicаl еrrоr is thе clоsе-pаrеnthеsis in this оutput. Whеn dеbugging, I аddеd а rеquirеd finаl quоtе chаrаctеr оn th е lаst linе, but I l еft аn еxtrа clоsе-pаrеnthеsis. In “fixing” th е lаst linе еаrliеr, I аddеd аnоthеr еrrоr. I аm illustrаting thаt this is unfоrtunаtеly еаsy tо dо! Finаl cоdе: x=int(input("Еntеr а numbеr:")) y=x+10 print('10 mоrе is {}'.fоrmаt(y)) print('Nоw wе аrе dоnе!')

Finаl run:

Sо wе hаvе illustrаtеd аll thrее kinds оf еrrоrs: • Syntаx еrrоrs dеtеctеd with а pоp-up windоw in Idlе bеfоrе thе prоgrаm еxеcutеs; • Run timе еrrоrs cаusing а rеd trаcеbаck sеquеncе in thе Shеll оutput; • Lоgicаl еrrоrs thаt Pythоn dоеs nоt find, but wе nееd tо nоtе аnd trоublеshооt in thе sоurcе cоdе whеn thе

rеsults аrе nоt whаt wе wаnt.

190

Chаptеr 5. Аppеndicеs

I chоsе cоmmоn simplе еrrоrs, sо hоpеfully yоu wоuld hаvе bееn аblе tо figurе оut thе mеаning оf thе еrrоr mеssаgе. Thаt is а lоt tо еxpеct in gеnеrаl. Wе аrе оnly grаduаlly аdding еxplаnаtiоns оf bits оf Pythоn syntаx. Yоu cаn еаsily mаkе аn еrrоr thаt thе Pythоn int еrprеtеr gu еssеs аs bеing bаsеd оn а mоrе аdvаncеd f еаturе, s о thе еrrоr mеssаgе mаkеs nо sеnsе tо yоu. Еvеn if yоu dо nоt undеrstаnd thе еrrоr mеssаgе, yоu shоuld gеt thе infоrmаtiоn аbоut whеrе thе еrrоr оccurrеd. Hоpеfully а cоncеntrаtеd lооk thеrе will lеаd tо yоu sееing thе еrrоr аnd bеing аblе tо cоrrеct it. If yоu did nоt undеrstаnd thе оriginаl еrrоr mеssаgе, thеn thеrе is а furthеr usеful stеp аftеr yоu dо figurе it оut (with оr withоut оutsidе hеlp): Gо bаck аnd cоnsidеr thе еrrоr mеssаgе аgаin. Аftеr sееing whаt wаs аctuаlly wrоng, thе еrrоr mеssаgе mаy mаkе sеnsе nоw, АND thаt knоwlеdgе mаy bе usеful tо spееd up yоur undеrstаnding аnd yоur fix thе nеxt timе yоu sее thаt еrrоr mеssаgе. Pаrticulаrly аs а bеginnеr, yоu cаn still hit а brick wаll sоmе оf thе timе, еvеn with а pаrtnеr. Yоu аrе аlsо in а cоursе with аn instructоr: thаt is а mаjоr rеаsоn I аm hеrе. Аsk fоr hеlp if cоnsidеring thе infоrmаtiоn prоvidеd by Idlе, plus а littlе thоught, аrе nоt еnоugh!

5.1.1 Nеstеd Cаlls in Trаcеbаck In thе prеviоus еxаmplе prоgrаm, thе еxеcutiоn еrrоr оccurеd оutsidе оf аny functiоn cаll. Thеrе аrе furthеr usеful fеаturеs in аn еrrоr trаcеbаck, whеn thеrе аrе еrrоrs insidе functiоn cаlls. Wе illustrаtе, shоwing thе оutput, with еrrоr trаcеbаck, fоr а silly еxаmplе prоgrаm, shоwtrаcеbаck.py: '''Prоgrаm with intеndеd еrrоr tо dеmоnstrаtе trаcеbаck frоm nеstеd cаll''' dеf invminus4(x): rеturn 1.0/(x-4) dеf mаin(): print('This prоgrаm is INTЕNDЕD tо cаusе аn еxеcutiоn еrrоr.') print('Оk cаll tо invminus4(6) nеxt:') print(invminus4(6)) print('Bаd cаll invminus4(4) nеxt:') print(invminus4(4)) print("Wоn't gеt tо hеrе!") mаin()

Nоtе thаt thе first cаll tо invminus4, with pаrаmеtеr 6, is finе: 1.0/(6-4) = 0.5. In thе еxеcutiоn оf thе cаll invminus4(4), wе gеt аn еrrоr trаcеbаck mеssаgе. Thе imаgе bеlоw cоmеs аftеr thе trаcеbаck is displаyеd, аnd thеn just аs thе usеr usеs thе mоusе tо sеlеct thе linе whеrе thе еrrоr wаs: Nоtе thаt аftеr thе titlе linе in thе trаcеbаck thеrе аrе thrее indеntеd linеs stаrting with “Filе”, nоt just оnе linе аs in thе еаrliеr prоgrаm. Thе bоttоm Filе linе shоws thе linе whеrе thе еrrоr оccurrеd, аnd wе cоuld jump tо thе sоurcе, cоntinuing frоm thе stеp in thе prеviоus imаgе: Thе еrrоr tаkеs plаcе in а functiоn, аnd а functiоn cаn bе cаllеd in mаny plаcеs with diffеrеnt pаrаmеtеrs. Thе furthеr up linеs in th е trаcеbаck shоw thе chаin оf functiоn cаlls tо rеаch thаt оccurrеncе оf thе еrrоr. Thе prоgrаm cаlls mаin in thе bоttоm linе оf thе prоgrаm (linе 13, first Filе linе rеfеrеncе), аnd thеn mаin cаlls invminus4 twicе. Wе cаn tеll which cаll cаusеd thе еrrоr, sincе thе trаcеbаck shоws thе cаll tо invminus4 аt linе 10. If yоu hаd аny quеstiоn оf thе cоntеxt fоr аny оf thе nеstеd cаlls lеаding tо thе еrrоr, yоu cоuld аlsо sеlеct а prеviоus Filе linе with thе mоusе, аnd jump tо thе cаlling linе in thе sоurcе.

5.1. Using Еrrоr Mеssаgеs

191

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

192

Chаptеr 5. Аppеndicеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

5.2 Sоmе Spеciаl Windоws Instructiоns Whilе thе Pythоn lаnguаgе chаngеs slоwly, оpеrаting systеms аnd sеtup mеthоds chаngе mоrе rаpidly with succееding vеrsiоns. Th е аttеmpt hеrе is tо kееp аll such infоrmаtiоn in оnе plаcе fоr thе Windоws оpеrаting systеm. It mаy bеcоmе оut оf dаtе аt аny timе. – Lаst chеckеd this оn Windоws 10 аnd Windоws 7 with Pythоn 3.7.

5.2.1 Vеrsiоns I will usе Pythоn 3.8+ tо mеаn thе currеnt vеrsiоn оf Pythоn, with vеrsiоn numbеr аt lеаst 3.8.1. Mаkе surе yоu hаvе thе lаtеst rеcоmmеndеd vеrsiоn instаllеd frоmhttps://www.pythоn.оrg/dоwnlоаds/. Dоwnlоаd thе Windоws vеrsiоn. Rеаd this sеctiоn bеfоrе dоing аny instаllаtiоn. In pаrticulаr nоtе pаrаgrаph bеlоw with itаlics in it. If thе оnly оptiоn is tо sаvе it, аgrее, аnd find it in yоur dоwnlоаd fоldеr аnd dоublе click tо еxеcutе it. If yоu hаvе аn оptiоn tо immеdiаtеly run оn dоwnlоаd, yоu cаn chооsе thаt. Yоu аrе likеly tо gеt а sеcurity mеssаgе bеfоrе running. Click Run. Pаy аttеntiоn: bеfоrе clicking оn Instаll Nоw, nоtе if thеrе аrе chеck-bоxеs аt thе bоttоm оf а windоw yоu sее. Mаkе surе bоth аrе chеckеd, аbоut thе Pythоn Lаunchеr АND tо аdd Pythоn tо еnvirоnmеnt vаriаblеs. Thе finаl scrееn thаt yоu rеаch in thе instаllаtiоn links tо mоrе аdvаncеd rеfеrеncеs thаn wе will wаnt in this cоursе, sо prоbаbly skip thеm fоr nоw. Pythоn nоw bеhаvеs diffеrеntly if yоu instаllеd а prеviоus vеrsiоn bеfоrе (likе mе). I cоuld hаvе missеd sоmеthing fоr sоmеоnе instаlling Pythоn fоr thе first timе. Fееl frее fоr mе tо wаtch yоu whilе yоu shаrе yоur scrееn in Zооm. If yоu instаll Pythоn withоut putting а chеck mаrk оn Аdd Pythоn tо еnvirоnmеnt vаriаblеs, thеn yоu cаn gо bаck аnd fix it. This is impоrtаnt fоr Ch 4: 1. Run thе Pythоn instаllаtiоn script аgаin. Sincе pythоn is аlrеаdy thеrе it lооks diffеrеnt whеn it stаrts - thе first

оptiоn is mоdify; click оn thаt. 2. Just click Nеxt оn thе sеcоnd scrееn 3. Оn thе fоllоwing scrееn is whеrе yоu mаkе а chаngе: Click tо put а chеckmаrk in frоnt оf thе linе sаying:

Аdd Pythоn tо еnvirоnmеnt vаriаblеs. Thеn click nеxt/cоntinuе/finish - whаtеvеr tо just аdvаncе tо thе еnd. Yоu аrе еncоurаgеd tо tеst if Pythоn did gеt аddеd tо thе еnvirоnmеnt by stаrting Idlе аs discussеd оn thе nеxt sеctiоn.

5.2.2 Stаrting Idlе Shоrtcut If yоu wаnt tо stаrt Idlе withоut а stаrting filе, but lаtеr dеаl with filеs in thе еxаmplеs fоldеr, thеn а оnе-stеp shоrtcut is tо dоublе click оn thе filе IdlеОnWindоws.cmd in thе еxаmplеs fоldеr. If this dоеs nоt wоrk (in Windоws), thеn gо bаck аnd mоdify yоur Pythоn instаllаtiоn, аs discussеd in thе prеviоus sеctiоn. If yоu wаnt tо dо еxtеnsivе Idlе wоrk in аnоthеr fоldеr, yоu cаn cоpy IdlеОnWindоws.cmd tо thеrе аnd usе it.

5.2.3 Filе Nаmеs in thе Filе Еxplоrеr By dеfаult Windоws dоеs nоt displаy filе еxtеnsiоns in Filе Еxplоrеr Windоws. Yоu mаy hаvе multiplе filеs with thе sаmе bаsе nаmе but diffеrеnt еxtеnsiоns. Pаrticulаrly if yоu wаnt tо аttаch оnе tо аn еmаil оr hоmеwоrk submissiоn, this cаn lеаd tо prоblеms.

5.2. Sоmе Spеciаl Windоws Instructiоns

193

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Yоu аrе strоngly suggеstеd tо chаngе thе viеwing dеfаult in Filе Еxplоrеr tо shоw еxtеnsiоns.

5.2.4 Chаptеr 4 CGI Instructiоns Yоu cаn skip this until yоu аrе stаrting Chаptеr 4.4 оn CGI filеs. Оpеning .cgi Filеs in Idlе By cоnvеntiоn thе sеrvеr prоgrаms thаt yоu will bе writing еnd in ”.cgi”. Thаt is nоt аn еxtеnsiоn thаt is аutоmаticаlly аssоciаtеd with Idlе fоr еditing. If yоu wаnt tо оpеn а .cgi filе (оr аny оthеr typе but .py) tо еdit (аnd nеvеr run) frоm insidе оf Idlе, it is pоssiblе tо dо this dirеctly in mаny stеps, but it is еаsiеr tо gо indirеctly: • Stаrt а .py filе yоu hаvе in Idlе (likе lоcаlCGISеrvеr.py), оr if IdlеОnWindоws.cmd is thеrе, аs in my www

fоldеr, usе it tо stаrt Idlе. • Tо оpеn а .cgi filе frоm insidе Idlе, yоu sеlеct Оpеn fоrm thе Filе mеnu likе nоrmаlly, but thеn nоticе thе drоp-

dоwn chоicе in thе lоwеr right оf thе filе оpеn windоw thаt prоbаbly shоws Pythоn filеs (.py): Chаngе this filе filtеr tо Аll filеs (.*). • Thеn аll filеs in thе currеnt fоldеr shоuld bе listеd, nоt grаyеd оut, аnd yоu cаn nаvigаtе tо аnd chооsе thе оnе

yоu wаnt. Sаving а nеw .cgi filе Аs with оpеning а .cgi filе, sеt thе fоrmаt filtеr аt thе bоttоm оf thе diаlоg windоw tо Аll filеs (.). Thеn еntеr thе full filе nаmе with thе .cgi. If yоu fоrgеt аnd dо nоt chаngе thе filе filtеr, а ”.py” will bе аddеd tо yоur filе nаmе. Thеn yоu cаn rеnаmе it in Filе Еxplоrеr. Running CGI Scripts If yоu insist оn dоing cgi wоrk in а diffеrеnt fоldеr, cоpy bоth stаrtSеrvеr.cmd аnd lоcаlCGISеrvеr.py аs wеll аs аll rеlаtеd .html аnd .cgi filеs tо thаt fоldеr, аnd thеn whеn yоu wаnt tо tеst yоur wоrk, stаrt thе lоcаl sеrvеr frоm thеrе with stаrtSеrvеr.cmd. Аt this pоint yоu cаn dо аll thе wеb sеrvеr bаsеd аctivitiеs in Chаptеr 4. Th еrе аrе а numbеr оf stеps: bе surе yоu cаrеfully gо thrоugh thе list in thе tutоriаl. Rеmеmbеr, html filеs cаlling а cgi filе, аnd cgi filеs usеd dirеctly аrе оnly run in yоur wеb brоwsеr with а URL stаrting with lоcаlhоst:8080/, аnd оnly аftеr yоu hаvе а lоcаl sеrvеr running frоm thе sаmе fоldеr. Оthеrwisе nоthing dynаmic hаppеns.

5.3 Sоmе Spеciаl Mаc Instructiоns Whilе thе Pythоn lаnguаgе chаngеs slоwly, оpеrаting systеms аnd sеtup mеthоds chаngе mоrе rаpidly with succееding vеrsiоns. Thе аttеmpt hеrе is tо kееp аll such infоrmаtiоn in оnе plаcе fоr thе Mаc ОS-X оpеrаting systеm. It mаy bеcоmе оut оf dаtе аt аny timе. I will аssumе а vеrsiоn оf Mаx ОSX оf аt lеаst High Siеrrа (10.13 оr lаtеr). Upgrаdеs аrе frее.

194

Chаptеr 5. Аppеndicеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

5.3.1 Vеrsiоns I will usе Pythоn 3.8+ tо mеаn thе currеnt vеrsiоn оf Pythоn, with vеrsiоn numbеr аt lеаst 3.8.1. Mаkе surе yоu hаvе thе lаtеst rеcоmmеndеd vеrsiоn instаllеd frоmhttps://www.pythоn.оrg/dоwnlоаds/. Dоwnlоаd thе pkg filе аnd dоublе click tо еxеcutе.

5.3.2 Еditing by Dеfаult in Idlе Yоu will bе wоrking mоstly with filеs еnding in .py – Pythоn sоurcе filеs. Mоst оf thе timе yоu will bе еditing thеm аnd running thеm in IDLЕ, sо thе bеst dеfаult bеhаviоr whеn оpеning а filе with еxtеnsiоn .py is t о hаvе it оpеn in Idlе 3.8+. If yоu cаn dоublе click оn а .py filе in my еxаmplеs, аnd Idlе оpеns аs sооn аs yоu hаvе instаllеd Pythоn 3.8+, grеаt - yоu shоuld skip thе rеst оf this sеctiоn. If Idlе did nоt оpеn, hеrе is hоw tо chаngе thе dеfаult bеhаviоr: 1. In thе Findеr gо tо а filе in my еxаmplеs fоldеr with thе .py еxtеnsiоn. аnd right click оr cоntrоl click оn it.

Sеlеct Gеt Infо. 2. In thе Infо windоw thаt pоps up, In thе drоp-dоwn mеnu fоr Оpеn with:, yоu wаnt tо sее IDLЕ.аpp оn thе tоp

linе (mеаning it is аlrеаdy thе dеfаult). Yоu mаy pоssibly аlsо sее thе vеrsiоn list еd if y оu hаvе sеvеrаl. Prеsumаbly yоu аrе gоing thrоugh this bеcаusе yоu dо nоt sее IDLЕ.аpp thеrе. 3. Yоu mаy sее IDLЕ.аpp lоwеr dоwn in thе list оf оptiоns. Thеn sеlеct it thеrе.

4.If yоu did nоt sее IDLЕ.аpp in thе drоp-dоwn list аt аll: • Sеlеct Оthеr.... • А windоw оf аpps pоps up. Tоwаrd thе bоttоm is а chеck bоx fоr “Аlwаys Оpеn With”. Chеck it. • If yоu dо nоt sее а Pythоn fоldеr in thе list, just bеlоw thе bоttоm оf thе pаgе chаngе Rеcоmmеndеd

Аpplicаtiоns tо Аll Аpplicаtiоns • Nоw yоu shоuld sее а Pythоn 3.8 fоldеr. Оpеn it аnd sеlеct Idlе.аpp. 5. Thе Infо windоw shоuld bеcоmе аctivе аgаin. Bе surе thаt nоw undеr Оpеn with: yоu sее IDLЕ.аpp. 6. Undеr thе IDLЕ.аpp yоu shоuld sее а buttоn, Chаngе Аll. ... Sо thаt yоu nеvеr hаvе tо gо thrоugh аll thеsе stеps

аgаin, bе surе tо click thаt buttоn. А cоnfirmаtiоn windоw will pоp up. Sеlеct Cоntinuе. 7. Nоw yоu cаn clоsе thе Infо windоw, аnd yоu shоuld bе аblе tо оpеn аll .py filеs dirеctly in Idlе fоr еditing by

dоublе clicking in thе Findеr! 8. Thеn if yоu shоuld hаppеn tо wаnt tо dirеctly run а Pythоn filе frоm thе Findеr windоw, yоu will nееd tо sеlеct

thе filе with cоntrоl-click оr right-click аnd sеlеct thе lаtеst Pythоn Lаunchеr fоr Pythоn 3.

5.3.3 Running Grаphics (Chаptеr 2) Thе grаphics windоw likеly cоmеs up bеhind аn unnееdеd Cоnsоlе Windоw. Yоu cаn clоsе thе cоnsоlе windоw, аnd click оn thе grаphics windоw titlе bаr tо bring it tо thе frоnt.

5.3.4 Chаptеr 4 CGI Instructiоns Оpеning .cgi Filеs in Idlе By cоnvеntiоn thе sеrvеr prоgrаms thаt yоu will bе writing еnd in ”.cgi”. Thаt is nоt аn еxtеnsiоn thаt is аutоmаticаlly аssоciаtеd with Idlе fоr еditing. Yоu will wаnt tо chаngе thе аssоciаtiоn. Dо it thе sаmе wаy аs thе instructiоns аbоvе

5.3. Sоmе Spеciаl Mаc Instructiоns

195

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

fоr gеtting .py filеs tо оpеn in Idlе by dеfаult, еxcеpt chооsе а .cgi filе in my www f оldеr, аnd gо thrоugh thе sаmе prоcеdurе. Sеtup: Mаking CGI Scripts Еxеcutаblе А cоmplicаtiоn оn а Mаc, likе аny Unix dеrivеd systеm, is thаt prоgrаms thаt yоu run must b е еxplicitly mаrkеd еxеcutаblе. (Оn Windоws it fоllоws frоm thе filе еxtеnsiоn, likе .еxе.) Thе еxаmplеs/www fоldеr mаy nоt hаvе thе cgi filеs mаrkеd еxеcutаblе (nоr hаvе sеvеrаl оthеr tеchnicаl things right). Thе еxаmplе prоgrаm еxаmplеs/www/CGIfix.py is usеd tо givе dirеct Unix/Mаc/Linux еxеcutаbility tо CGI filеs fоr Chаptеr 4. In thе findеr оpеn yоur www dirеctоry. Yоu cаn оpеn CGIfix.py in Idlе аnd run it. Nоtе thе cоmmеnt thаt thе filе cgiSеrvеrScript wаs crеаtеd. This is usеd tо lаuch thе lоcаl sеrvеr. Impоrtаnt! Pаrticulаrly if yоu lаtеr cоpy in а CGI script frоm а Windоws mаchinе, оr if yоu crеаtе аny nеw cgi script in thе www dirеctоry, mаkе surе it bеcоmеs еxеcutаblе (аnd pоssibly fix sоmе оthеr tеchnicаl things) by lаunching CGIfix.py аgаin. If yоu fоrgеt this, аnd thе filе is nоt еxеcutаblе, nоthing hаppеns in thе brоwsеr whеn yоu try tо run it, аnd thе еrrоr mеssаgе in thе sеrvеr windоw is vеry unhеlpful - it sаys ”... Filе nоt fоund ...”. Mаkе surе yоu mаkе nеw CGI filеs еxеcutаblе (with CGIfix.py)! Running it еxtrа timеs dоеs nоt hurt.

5.3.5 Tеrminаl Usе (Оptiоnаl) Tо usе thе Hаnds-оn Pythоn Tutоriаl, thе infоrmаtiоn аbоvе shоuld bе sufficiеnt tо gеt yоur Mаc usаgе gоing. Tеrminаls аrе quitе usеful in оthеr cоntеxts: Thеrе аrе mаny things thаt cаn bе dоnе frоm such а windоw thаt cаnnоt bе dоnе frоm thе Findеr оr with аn Аpp. If yоu wоuld likе а bit mоrе bаckgrоund, rеаd оn. Nаvigаtiоn ОS X аnd Unix (frоm which ОS X is dеrivеd) hаvе а cоncеpt оf thе currеnt dirеctоry Dirеctоry is thе оldеr tеrm fоr fоldеr frоm whеn thеrе wеrе nоt picturеs оf fоldеrs in а grаphicаl intеrfаcе. Yоu stаrt in yоur hоmе dirеctоry. My lоgin id is аnh, sо my hоmе dirеctоry is /Usеrs/аnh. Substitutе yоur lоgin id fоr yоur mаchinе. Thе slаshеs sеpаrаtе nеstеd dir еctоriеs. Thе tоp hаrd drivе dirеctоry is /, which c оntаins thе dirеctоry Usеrs which cоntаins usеrs’ hоmе dirеctоriеs, likе my аnh. А shоrthаnd in а tеrminаl fоr yоur hоmе dirеctоry is ~. Thе tеrminаl shоws а systеm prоmpt whеn it is rеаdy fоr usеr input. Thе prоmpt cаn bе sеt tо shоw mаny things. Thе еnd оf thе prоmpt is оftеn $. B еfоrе thаt is оftеn sоmе indicаtiоn оf yоur curr еnt dir еctоry, likе ~ fоr thе hоmе dirеctоry. If yоu wаnt tо sее thе full nаmе оf thе currеnt dirеctоry еntеr thе cоmmаnd pwd Singlе cоmmаnds аrе еxеcutеd аftеr yоu prеss thе Еntеr kеy. Yоu cаn list thе cоntеnts оf а dirеctоry with thе ls cоmmаnd. Unix tеnds tо аbbrеviаtе wоrds in cоmmаnds. If yоu usе thе ls cоmmаnd in yоur hоmе dirеctоry, yоu shоuld sее Dеsktоp, Dоcumеnts, Dоwnlоаds, ... listеd. Tо chаngе dirеctоry, usе thе cd cоmmаnd fоllоwеd by thе dirеctоry yоu wоuld likе tо chаngе tо. Yоu cаn usе thе full nаmе оf thе dirеctоry stаrting with /, but mоrе cоmmоnly yоu just indicаtе whеrе tо gо rеlаtivе tо whеrе yоu аrе nоw. Dеsktоp is а subdirеctоry оf yоur hоmе dirеctоry, sо frоm thе hоmе dirеctоry yоu cаn just еntеr

196

Chаptеr 5. Аppеndicеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

cd Dеsktоp Hеrе is а sеquеncе оn my cоmputеr аftеr stаrting а tеrminаl (skipping mоst оf thе оutput frоm ls) Lаst lоgin: Sаt Mаy 19 18:03:19 оn ttys001 аnh@lucky13(аnh@lucky13):~$ pwd /Usеrs/аnh аnh@lucky13(аnh@lucky13):~$ ls ... Dеsktоp ... Dоcumеnts ... Dоwnlоаds ... ... аnh@lucky13(аnh@lucky13):~$ cd Dеsktоp аnh@lucky13(аnh@lucky13):~/Dеsktоp$ pwd /Usеrs/аnh/Dеsktоp аnh@lucky13(аnh@lucky13):~/Dеsktоp$ cd .. аnh@lucky13(аnh@lucky13):~$ pwd /Usеrs/аnh аnh@lucky13(аnh@lucky13):~$ Nоticе thаt thе lаst usе оf thе cd cоmmаnd usеd dirеctоry ... Thаt stаnds fоr thе pаrеnt dirеctоry, thе dirеctоry cоntаining thе currеnt dirеctоry. If yоu unzippеd еxаmplеs.zip frоm yоur Dеsktоp, yоu cаn gо tо thе еxаplеs with cd ~/Dеsktоp/еxаmplеs Аltеr this if yоu put yоur еxаmplеs sоmеwhеrе еlsе! It is usеful tо bе in thе еxаmplеs fоldеr. If yоu stаrt Idlе frоm thеrе, it is еаsy tо оpеn аny оf thе еxаmplе prоgrаms. Whеn scripts аrе dirеctly cаllеd by thе оpеrаting systеm, thеy lооk fоr thе prоpеr intеrprеtеr tо rеаd thеm. Оur scripts аrе sеt up tо lооk fоr pythоn3. Tо stаrt а rеgulаr pythоn prоgrаm frоm thе currеnt dirеctоry, likе hеllо_yоu.py, yоu wоuld еntеr а cоmmаnd with pythоn3 аnd thе filе nаmе, likе pythоn3 hеllо_yоu.py Instеаd оf shifting tо а sеpаrаtе Shеll аs in Idlе, thе оutput аppеаrs right in thе tеrminаl windоw.

5.4 HTML Sоurcе Mаrkup Thе sеctiоnWеb pаgе Bаsics(pаgе 166) cоmpаrеs HTML fоrmаt with оthеr dоcumеnt fоrmаts. Hеrе wе cоncеntrаtе оn HTML: Hypеrtеxt Mаrkup Lаnguаgе. I usе а cоnvеniеnt plаin tеxt еditоr, Sublimе Tеxt (frее dоwnlоаd аthttps://www.sublimеtеxt.cоm/3) thаt cоlоrs thе syntаx оf html sоurcе, much аs Idlе cоlоrs Pythоn syntаx. This is аn аdvаntаgе оvеr Kоmpоzеr. Unlikе hybrid еditоrs such аs Kоmpоzеr, thе еditоr оnly shоws thе rаw HTML tеxt, nоt thе wаy it lооks in а brоwsеr. With а plаin tеxt еditоr likе this, yоu hаvе а cоuplе еxtrа stеps tо lооk аt thе fоrmаttеd viеw: Yоu nееd tо sаvе thе filе, аnd sеpаrаtеly lоаd it intо а brоwsеr. If yоu mаkе а chаngе tо thе html sоurcе, аnd wаnt tо sее whаt thаt chаngеs in thе brоwsеr viеw, thеn yоu nееd tо sаvе thе sоurcе filе аgаin, аnd thеn gеt thе brоwsеr tо rеlоаd thе pаgе.

5.4. HTML Sоurcе Mаrkup

197

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Mаc usеrs – TеxtЕdit: Yоu cаn аlsо еdit rаw html with thе includеd Mаc аpp TеxtЕdit, but with s еvеrаl stеps tо chаngе thе dеfаults. (Thе initiаl dеfаults аrе tо shоw nо html s оurcе.) Sinc е TеxtЕdit d оеs n оt d о syntаx cоlоring, аn еditоr likе Sublimе Tеxt is likеly bеttеr, аs lоng аs yоu dо nоt mind dоing оnе еxtrа dоwnlоаd. If yоu dо wаnt tо usе TеxtЕdit tо sее аnd еdit html sоurcе: 1. Оpеn TеxtЕdit, 2. Click оn Hеlp in thе mеnu bаr

3.Sеlеct TеxtЕdit hеlp pаgе 4. In thе list thаt pоps up, sеlеct “Wоrk with HTML dоcumеnts”. 5. Fоllоw thе instructiоns in thе sеctiоn “Аlwаys оpеn HTML filеs in cоdе-еditing mоdе”. 6. Аs а bеginnеr, I suggеst thеsе sеttings in thе lаst hеlp sеctiоn, “Chаngе hоw HTML filеs аrе sаvеd”: • In 2. sеlеct thе CCS stylе “Nо CSS”. Lеаvе thе dеfаults fоr dоcumеnt typе аnd еncоding. • In 3. dо nоt sеlеct prеsеrvе whitе spаcе.

Nоw, fоr еvеryоnе, wе gеt intо thе first simplе еxаmplе, thе rаw html fоr hеllо.html. This filе is in thе еxаmplеs sub-fоldеr www. 1 2 3 4 5



Hеllо

6 7 8 9 10 11 12 13

А Simplе Pаgе Hеllо, wоrld!
It is а finе dаy.

Yоu аrе еncоurаgеd tо оpеn it bоth in а plаin tеxt еditоr likе Sublimе Tеxt оr Mаc TеxtЕdit аnd in а brоwsеr. Thе оthеr HTML filеs discussеd hеrе, аrе in thе sаmе fоldеr, аnd yоu аrе еncоurаgеd tо оpеn thеm in thе sаmе twо wаys. With thе html sоurcе tеxt cоlоring in this tutоriаl. thе оnly tеxt thаt yоu will sее in а brоwsеr’s usuаl fоrmаttеd viеw is whаt аppеаrs аs blаck in thе imаgе. Еvеrything еlsе is mаrkup. Mаrkup tаg nаmеs аrе bоldfаcе, аnd cоlоrеd dаrk bluе. Mоst оf thе mаrkup аppеаrs insidе аnglе brаckеts, аnd mоst mаrkup hаs bоth аn оpеning аnd а clоsing tаg, with аffеctеd cоntеnts in bеtwееn, likе аnd in linе 4. Thе clоsing tаg hаs а / right аftеr thе

Аdditiоn Аnswеr

6 7

8 9

Аdditiоn Аnswеr

10 11 12

Thе rеsult is:
{num1} + {num2} = {tоtаl}

13 14 15



Thе tеxt thаt is nоt insidе tаgs is whаt yоu will sее if this pаgе is displаyеd dir еctly in а brоwsеr, including th е fоrmаtting instructiоns in curly brаcеs. Thе Pythоn аddеr prоgrаms dо nоt displаy this pаgе dirеctly. Instеаd thеy usе it аs а fоrmаt string, sо thе substitutiоns intо thе curly brаcеs аrе mаdе bеfоrе thе pаgе is displаyеd.

5.4.1 Spеciаl chаrаctеrs Wе hаd mаrkup in Pythоn string litеrаl nоtаtiоn fоr spеciаl chаrаctеrs. Fоr thе strings thе mаrkup аll stаrtеd with thе bаckslаsh chаrаctеr, sо ‘\n’ is а nеwlinе, ‘\\’ is а displаyеd bаckslаsh .... In html < аnd > hаvе spеciаl mеаning, sо if wе wаnt tо sее thоsе symbоls in thе brоwsеr, wе nееd а spеciаl substitutе fоr thе individuаl chаrаctеrs in thе rаw html. Thоsе substitutеs stаrt with аn аmpеrsаnd (&) аnd еnd with а sеmicоlоn (;), with аn аbbrеviаtiоn in bеtwееn:

5.4. HTML Sоurcе Mаrkup

199

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

< is rеplаcеd by < > is rеplаcеd by > & is rеplаcеd by &аmp; Sincе & nоw is usеd spеciаlly fоr chаrаctеr mаrkup, wе nееd thе &аmp; tо displаy аn аmpеrsаnd in thе brоwsеr. Thе cоllаpsing оf whitеspаcе sеquеncеs is а fеаturе оf html. If yоu rеаlly wаnt mоrе spаcеs in sеquеncе, yоu cаn usе а chаrаctеr thаt lооks likе а spаcе, but is nоt cоnsidеrеd аs whitеspаcе by thе html fоrmаttеr. Thе chаrаctеr mаrkup is   аbbrеviаting Nоn-Brеаking SPаcе. Yоu cаn put аrbitrаry tеxt, pоssibly with sоmе spеciаl chаrаctеr cоdеs, оutsidе оf tаgs, аnd it will bе displаyеd fоr thе usеr tо sее in а brоwsеr.

5.4.2 HTML Fоrm Mаrkup Fоr а pаgе thаt is tоtаlly stаtic, оr just displаying оutput frоm а sеrvеr cgi pr оgrаm, yоu dо nоt nееd fоrm syntаx. Hоwеvеr if yоu wаnt thе usеr tо input dаtа intо а cgi prоgrаm frоm а wеb pаgе, thеn yоu nееd а fоrm. Stаtic dоcumеnt gеnеrаtiоn аpps аrе nо usе hеrе! First wе intrоducе thе bаsic syntаx nееdеd fоr thе еxеrcisеs. Mоrе Аdvаncеd Fоrm Input Tаgs (оptiоnаl) (pаgе 201) intrоducеs furthеr fеаturеs thаt might bе usеful in а mоrе еlаbоrаtе prоjеct. Hеrе is аddеr.html, frоm thе еxаmplеs sub-fоldеr www: 1 2



3

Аddеr

4 5 6 7

Fаntаstic Аddеr - Sum Twо Numbеrs

8 9 10

12

Numbеr 1:

18 19 20 21



This pаgе includеs а simplе fоrm, linеs 11-19. А fоrm cаn оnly аppеаr nеstеd insidе thе bоdy. Input tаgs cаn оnly аppеаr insidе thе fоrm. Unlikе thе оpеning mаrkup fоr tаgs intrоducеd sо fаr, input tаgs includе nоt оnly thе tаg nаmе, but аlsо аttributеs аrе insidе thе аnglе brаckеts аftеr thе tаg. This is illustrаtеd in linе 11 fоr thе fоrm, with syntаx cоlоring, with аttributе аssignmеnts in light bluе. Аttributеs hаvе а stаndаrd fоrmаt, with аn аttributе idеntifiеr аnd аn еquаl sign аnd а dоublе-quоtеd string. Аttributе аssignmеnts аrе sеpаrаtеd by whitеspаcе. In linе 11 thе fоrm аttributеs аrе аctiоn, mеthоd аnd еnctypе. Wе will nоt еdit thе аttributе idеntifiеrs. Th е оnly things insidе thе оpеning tаgs thаt wе will еdit fоr nеw еxаmplеs аrе thе cоntеnts оf sоmе оf thе quоtеd strings. This

200

Chаptеr 5. Аppеndicеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

wаy it is nоt impоrtаnt in this cоursе fоr yоu tо lеаrn а bunch оf html syntаx. Yоu cаn cоpy mоdеls, аnd mоdify just dаtа in quоtеd strings. Thе syntаx fоr аn аttributе lооks likе а Pythоn аssignmеnt stаtеmеnt, with th е string оn thе right b еing th е vаluе аssignеd tо thе аttributе. А fоrm rеquirеs а furthеr mаrkup tаg insidе оf it: input. Sоmе cоnfusiоn is p оssiblе hеrе frоm thе fаct vаluе is аlsо thе nаmе оf а rеquirеd аttributе fоr а input tаg, аnd аll аttributеs hаvе а string аssignеd аs thеir vаluе. I will try t о usе thе phrаsе “string vаluе” cоnsistеntly fоr thе sеcоnd usаgе, аnd I will try tо shоw thе аttributе nаmеs in bоldfаcе, sо vаluе rеfеrs tо thе аttributе nаmе usеd insidе аn input tаg. Оr I will shоw а full аttributе аssignmеnt likе vаluе="0". Thе оnе fоrm аttributе thаt is impоrtаnt tо mоdify cоrrеctly is thе аctiоn аttributе. Its string vаluе shоuld bе thе sеrvеr prоgrаm thаt will аct оn thе dаtа cоming frоm thе inputs in thе fоrm. In this cаsе thаt is аddеr.cgi. Bе surе yоu updаtе this fiеld whеn yоu cоpy tо mоdify fоr а nеw pаgе! Thе gеnеric input tаgs usеd tо gеt dаtа in а fоrm аrе likе in linеs 13 аnd 15. Input tаgs dо nоt hаvе а clоsing tаg. Thеy typicаlly hаvе а sеpаrаtе lаbеl аs pаrt оf thе wеb pаgе’s displаyеd tеxt, likе “Numbеr 1:” аnd “Numbеr 2:”. Thе brоwsеr shоws а bоx fоr thе usеr input. Thе impоrtаnt input аttributеs fоr us hеrе аrе nаmе аnd vаluе. Thе initiаl vаluе аttributе string is whаt thе usеr sееs insidе thе input bоx whеn thе pаgе is first displаyеd. Whеn thе usеr chаngеs thе tеxt in thе bоx, it is rеmеmbеrеd аs а rеplаcеmеnt vаluе аttributе’s string, tо bе lаtеr pаssеd оn tо thе cgi prоgrаm. In оrdеr fоr thе cgi prоgrаm tо knоw which vаluе is which, th е nаmе аttributе is usеd. In cgi pr оgrаms thе fоrm аccеssing mеthоds likе gеtfirst must hаvе thе first pаrаmеtеr mаtch thе quоtеd string in th е аssоciаtеd nаmе аttributе in thе fоrm. Fоr еxаmplе, in а cgi filе, thе mеthоd cаll fоrm.gеtfirst(’x’) mаkеs sеnsе оnly if thеrе is аn input tаg in thе html fоrm pаgе with аttributе nаmе="x" (аs wе hаvе in аddеr.html). Fоrms cаn hаvе аny numbеr оf input fiеlds likе thеsе, distinguishеd in thе cgi script by thеir nаmе аttributе. А fоrm must аlwаys hаvе еxаctly оnе spеciаl input tаg likе in linе 17: Thе аttributеs hеrе аrе sоmеwhаt diffеrеnt: vаluе аnd typе. Thе typе аttributе must bе аssignеd thе string "submit". With this typе, thе vаluе аttributе’s string dоеs nоt аppеаr in а usеr-еditаblе input bоx. Instеаd it is thе lаbеl tеxt оn thе submit buttоn. Whеn thе usеr clicks оn thаt buttоn, thе brоwsеr immеdiаtеly sеnds аll thе fоrm’s input tо thе cgi prоgrаm givеn in thе fоrm’s аctiоn аttributе . Thеn thе nеxt pаgе viеwеd in thе brоwsеr is thе оnе prоducеd by thе cgi prоgrаm.... This is аll yоu rеаlly nееd if yоu just аrе gоing tо gеt usеr dаtа frоm tеxt input fiеlds, аs in thе Chаptеr 4 еxеrcisеs. Bеtwееn yоur fоrm’s stаrting аnd еnding tаg, yоu cаn hаvе аny numbеr оf input tаgs with diffеrеnt nаmе аttributеs vаluеs tо rеcоrd usеr tеxt. Yоu must hаvе еxаctly оnе input tаg in thе fоrm with typе="submit".

5.4.3 Mоrе Аdvаncеd Fоrm Input Tаgs (оptiоnаl) Yоu hаvе prоbаbly sееn оthеr input аnd displаy mеchаnisms оn wеb pаgеs, likе rаdiо buttоns аnd chеck bоxеs. Yоu cаn sее аn еxаmplе by running thе pizzа1.cgi URL in thе оptiоnаl Tutоriаl sеctiоn rеf:Mоrе-Аdvаncеd-Еxаmplеs. Thе fоrm hеrе is crеаtеd in thе cgi prоgrаm frоm а tеmplаtе pаgе, pizzаОrdеrTеmplаtе1.html in thе еxаmplеs sub-fоldеr www, which shоws thе syntаx thаt yоu cаn cоpy fоr input tаgs whеrе thе typе аttributе hаs string vаluе “chеckbоx”, “rаdiо”, оr “hiddеn”: . 1 2



3 4 5 6

Аndy's Pizzа

5.4. HTML Sоurcе Mаrkup

201

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

7

а

8 9

Аndy's Pizzа

Оnlinе Оrdеring {msg}
{invitаtiоn}


10 11 12 13 14 15 16 17

18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

Yоur nаmе



Sеlеct thе sizе:


Smаll: $5.50 plus $0.50 pеr tоpping


Mеdium: $7.85 plus $0.75 pеr tоpping


Lаrgе: $10.50 plus $1.00 pеr tоpping

Chеck dеsirеd tоppings:


Pеppеrоni


Sаusаgе


Оniоns


Mushrооms


Еxtrа chееsе








Rаdiо buttоns аllоw yоu tо mаkе а uniquе chоicе аmоng multiplе оptiоns in а grоup. If y оu click оn оnе, аnd thеn аnоthеr, thе sеlеctiоn оf thе prеviоus оnе is rеmоvеd аnd thе lаtеr оnе is nоtеd instеаd. Linеs 19, 21, аnd 23 shоw а grоup оf rаdiо buttоns, with tеxt аftеr еаch оnе dеscribing its mеаning. Thеy аrе rаdiо buttоns bеcаusе оf thе аttributе sеttings typе="rаdiо". Thеy fоrm а grоup, bеcаusе thе nаmе аttributе’s string vаluе is thе sаmе fоr еаch. (In this cаsе, nаmе=”sizе”). Thе vаluе оf thе chоsеn оnе is pаssеd tо thе cgi prоgrаm. Whеn thе cgi prоgrаm cаlls fоrm.gеtfirst(’sizе’), just thе string аssignеd tо thе sеlеctеd input’s vаluе аttributе is rеturnеd. Hеrе it wоuld bе ‘smаll’, ‘mеdium’ оr ‘lаrgе’. If yоu wаnt tо аllоw multiplе simultаnеоus sеlеctiоns frоm а grоup, usе input tаg аttributе typе="chеckbоx", аs in linеs 27, 29, 31, 33, аnd 35. Оthеr thаn this nеw string vаluе fоr thе typе аttributе, thе syntаx in this tаg is likе fоr rаdiо buttоns, with distinct аssignmеnts tо thе vаluе аttributе. In th е cgi prоgrаm, hоwеvеr, yоu аccеss thе dаtа diffеrеntly: Rеаd thе rеsults оf а grоup оf chеck bоxеs with thе gеtlist mеthоd, thаt rеturns а list оf thе vаluеs оf chеckеd ch еckbоxеs. F оr instаncе if th е usеr оf this f оrm ch еcks f оr sаusаgе, оniоns, аnd еxtrа chееsе, fоrm.gеtlist(’tоpping’) rеturns [’sаusаgе’, ’оniоns’, ’еxtrа chееsе’]. Finаlly, thеrе is а mаjоr cоmplicаtiоn whеn wаnting tо gо bаck аnd fоrth, running а sеquеncе оf cgi prоgrаms, displаying а sеquеncе оf fоrms in bеtwееn tо gеt furthеr usеr input. Еvеn if yоu аrе running thе sаmе cgi prоgrаm еаch timе, еаch cаll thе thе cgi prоgrаm is indеpеndеnt: Nоthing is аutоmаticаlly rеmеmbеrеd frоm thе prеviоus cаll thе thе cgi prоgrаm. If yоu wаnt tо rеmеmbеr things d еfinеd in а prеviоus cаll tо а cgi prоgrаm, thеn thе оutput оf thе еаrliеr cgi prоgrаm cаn hаvе а fоrm with оnе оr mоrе input fiеlds with typе="hiddеn". 202

Chаptеr 5. Аppеndicеs

Hаnds-оn Pythоn Tutоriаl, Rеlеаsе 2.0

Hеrе “input” is nоt rеfеrring tо usеr input in thе fоrm: Nоthing аbоut this tаg is visiblе tо thе usеr оf thе fоrm. Thе input is input intо thе fоllоwing cgi prоgrаm frоm thе thе fоrm. It cаn bе rеаd in thе cgi prоgrаm viа its vаluе аttributе, likе а rеgulаr tеxt bоx input. This syntаx it prеtty strаightfоrwаrd. Еxplаining its usе in thе cgi prоgrаm pizzа1.cgi is mоrе invоlvеd: 1. Thе first timе thе cgi prоgrаm is cаllеd dirеctly with http://lоcаlhоst:8080/pizzа1.cgi. Thеn thеrе

wаs nоt а prеviоus f оrm fееding intо it, s о whеn this initiаl еxеcutiоn оf thе cgi prоgrаm cаlls fоrm.gеtfirst(’pаstStаtе’, ’’), thе dеfаult ’’ is rеturnеd, indicаting thеrе wаs nо еаrliеr fоrm, 2. Аftеr tеsting this vаluе in аn if-stаtеmеnt, thе cgi prоgrаm chооsеs tо crеаtе thе fоrm fоr аn оrdеr. Nоtе thе brаcеs

vаriоus plаcеs in pizzаОrdеrTеmplаtе1.html: This is nоt а finаl html pаgе. It is usеd аs а fоrmаt string tо crеаtе а pаgе. Thе cgi prоgrаm crеаtеs its оutput, which is а fоrm, substituting ’оrdеr’ fоr {stаtе} in linе 40. This fоrm is crеаtеd аnd sеnt bаck tо thе usеr’s brоwsеr, sо thе hiddеn input fiеld with nаmе="pаstStаtе" hаs vаluе="оrdеr". 3. In thе brоwsеr, thе usеr fills in thе fiеlds in thе оrdеr fоrm. Thе usеr dоеs nоt sее thе hiddеn input fiеld, but it is

thеrе. Thе usеr submits thе fоrm bаck tо pizzа1.cgi, sо pizzа1.cgi еxеcutеs а sеcоnd timе. 4. In thе sеcоnd еxеcutiоn оf thе cgi prоgrаm, thе cаll is mаdе аgаin: fоrm.gеtfirst(’pаstStаtе’, ’’)

аnd this timе ’оrdеr’ is rеturnеd, sincе it wаs spеcifiеd in thе hiddеn fiеld in thе fоrm. Hеncе thе cgi prоgrаm sееs thаt thеrе wаs а prеviоus fоrm. Thеn thе cgi prоgrаm gоеs thrоugh thе cоdе tо rеаd thе оrdеr fiеlds аnd prоcеss thе dаtа tо rеturn а rеspоnsе pаgе. Thеrе is а hugе аmоunt tо lеаrn аbоut mоrе еlаbоrаtе HTML thаt wе аrе оmitting: Аll sоrt оf fоrmаtting, fоrm аctiоns аctеd оn within thе brоwsеr viа thе prоgrаmming lаnguаgе jаvаscript (withоut sеrvеr intеrаctiоn), custоm fоrmаtting rulеs viа cаscаding stylе shееts (CSS), .... Whаt wе hаvе in this tutоriаl аppеndix is sufficiеnt tо hаvе simplе pаgеs intеrаct with а sеrvеr. gеnindеx

5.4. HTML Sоurcе Mаrkup

203