Zakončíme třídílný seriál o objektovém programováním malou ukázkou toho, jak v objektech vytvořit oblíbený telefonní seznam. Současně s tím rozeberu podrobněji dokumentační řetězce v Pythonu.

Telefonní seznam objektově

Soudě podle počtu odevzdávaných úkolů, OOP u vás moc v oblibě není. Rozhodl jsem se proto předčasně ukončit tuto část kurzu. Dnes se tedy budeme naposledy věnovat objektovému programování a příště již budeme dělat něco jiného.

Telefonní seznamy jsme již dělali několikrát, pokaždé jinak. Dnes si ukážeme objektovou verzi, která v jednoduchosti používání předčí ty dosavadní na sto honů. Alespoň podle mne.

Výsledek

Když chci vytvářet nějaký program, začínám tím, jak by se mohl program používat (laikem) a podle toho pak volím programátorský přístup. Podle předchozích zkušeností a podle pythonovské syntaxe by použití mohlo být i takové:

pratele=telseznam()
programujte=telseznam()

pratele.pridej("Jirka", 248478965)
pratele.pridej("Maruska", 635879148)
programujte.pridej("curo", 723415478)
programujte.pridej("frosty",125789456)

pratele.vypis()
... tady bude vypis dosavadnich kontaktu pratel
programujte.vypis()
... tady bude vypis dosavadnich kontaktu programujte

pratele.uloz("seznam1.txt")  ... ulozeni do souboru

Kód

Uveřejním napřed celý kód, který pak budu komentovat.

01 class telseznam:
02     "Trida telefonnich seznamu. Implementace pomoci seznamu."
03     
04     def __init__(self):
05         "Inicializacni metoda"
06         
07         self.jmena=[]
08         self.cisla=[]
09 
10     def pridej(self, jmeno, cislo):
11         "Metoda na pridavani do seznamu."
12         
13         self.jmena.append(jmeno)
14         self.cisla.append(cislo)
15         
16     def vypis(self):
17         "Vypis dosavadniho seznamu, vcetne minimalni kontroly na spravnost dat."
18         
19         if len(self.jmena)!=len(self.cisla):
20             print "Nekde se stala chyba, pocet jmen nesouhlasi s poctem cisel."
21             print "Jmena:", self.jmena
22             print "Cisla:", self.cisla
23 
24         delka=len(self.jmena)
25         if not delka:
26             print "V seznamu nejsou zadna cisla."
27             return
28         for poradi in range(delka):
29             print poradi,".: ", self.jmena[poradi],"-", self.cisla[poradi]

class

Začínáme definicí třídy. Hned pod tím (podle slušného vychování) píšeme, o čem to vlastně je. Říká se tomu dokumentační řetězec a jeho využití je větší než obyčejné komentáře. Využití toho jsou dvě. První je v IDLE, když budeme tuto třídu používat, IDLE nám bude tento řetězec ukazovat jako bublinovou nápovědu:

Druhé použití je na promptu, nebo klidně i v programu. Je to hezké, že?

>>> x=telseznam()
>>> x.__doc__
'Trida telefonnich seznamu. Implementace pomoci seznamu.'
>>> x.vypis.__doc__
'Vypis dosavadniho seznamu, vcetne minimalni kontroly na spravnost dat.'

__init__

Na řádku č. 4 definujeme metodu __init__. Je to velmi zvláštní metoda a všechny takové zvláštní metody se v Pythonu poznají tak, že začínají a končí dvěma podtržítky. Tato metoda se spouští automaticky vždy při inicializaci nového seznamu. Nemusíme ji tedy volat, volá se sama (nebo spíše volá ji Python sám – stejně jako ostatní „podtržítkové“ metody). K jejímu volání dochází v těchto případech:

>>> pratele=telseznam()
>>> rodina=telseznam()
>>> ... a podobně

V této metodě se inicializují seznamy jmena a cisla, které se pak využívají dále. Kouzelné slovíčko self je u nich proto, že … viz předchozí lekce.

pridej

Tato metoda je také vcelku krátká. Přijímá dva argumenty – jmeno a cislo (pozor, nepleťte s proměnnými self.jmena a self.cisla!) a jediné, co s nimi dělá je, že je přidá do patřičných seznamů na řádcích 13 a 14.

vypis

V metodě vypis (řádek 16) děláme malé kontroly. Na řádcích 19–22 kontrolujeme, jestli se délka seznamu jmen rovná délce seznamu čísel. Jestli jsme prostě nějak omylem nezapsali jméno bez čísla anebo naopak. Stát by se to nemělo, ale pokud se to stane, je lepší o tom vědět. Možná by bylo lepší tuto část volat i po přidání jména a čísla. No ale nechme to tak.

Na řádcích 25–27 kontroluje, zda jsme již do seznamu vůbec něco zapsali. Abychom to dali uživateli jasněji najevo, než když uděláme výpis seznamu, kde nebude nic. Rád bych se zastavil u řádky 27 – return. Je zbytečné, a i nevhodné, aby se po vypsání hlášky, že v seznamu nic není, tento seznam ještě vypisoval. return udělá to, že předčasně funkci (metodu) ukončí/opustí. Akční část této metody je na posledních dvou řádcích (28–29). Zde se vypisuje seznam jmen i čísel.

Závěr

Jsme na konci OOP. Tedy spíše na začátku – jak se to vezme. Pro někoho na konci, pro někoho na začátku. Ať tak či tak, je to tak ;-)

Úkol

Nedělám si velké iluze, že někdo úkol odevzdá (přestože úkoly opravuji rád a jsem :-( , když žádný nedostanu), přesto ho zadám: vytvořte metodu uloz, která telefonní seznam uloží do souboru, který jí zadáte v argumentu (použití viz výše na začátku lekce).