Učíme se programovat v jazyce Python: Kap.10 Moduly a soubory

Modul je soubor, obsahujicí definice a příkazy určené pro použití v jiných programech Pythonu. Mnohé moduly jsou standardní součástí Pythonu a jsou uloženy v jeho standardní knihovně. Dosud jsme poznali dva, modul doctest a modul string.

10.2 pydoc

K prohledávání knihoven Pythonu, instalovaných na počítači, slouží příkaz pydoc. Na příkazový řádek napíšeme:

Stiskem tlačítka open browser otevřeme okno webového prohlížeče, které obsahuje seznam modulů a jejich objektů:

Je to výčet všech knihoven Pythonu na vašem počítači. Klikem na jménu modulu otevřeme novou stránku s dokumentací o vybraném modulu. Například, klik na slovu keyword otevře následující stánku:

Modul keyword obsahuje jedinou funkci iskeyword, která - jak její jméno naznačuje - je booleovskou funkcí, vracející True je-li zadaný řetězec klíčovým slovem:

Datový prvek kwlist obsahuje seznam všech současných klíčovych slov Pythonu:

Doporučujeme časté používání služby pydoc ke zkoumání rozsáhlých knihoven Pythonu. Mnoho pokladů čeká na své objevení!

10.3 Vytváření modulů

Náš modul můžeme nyní používat jak ve skriptech, tak v interaktivním rozhraní. Nejprve musíme modul importovat. Jsou tři způsoby:

V prvním příkladě je fce remove_at volána již známým způsobem. Ve druhém příkladě je před funkcí napsáno jméno modulu s tečkou (.) Třetí je podoben prvnímu, ale nebývá doporučován.

Přesto, že přípona .py je součástí jména, při importu modulu ji neuvádíme, neboť ji Python předjímá.

Použití modulů umožňuje rozložení velkých programů na zvládnutelné malé části a souvislé části ukládat pohromadě.

10.4 Jmenné prostory

Jmenný prostor (namespace) je syntaktický kontejner, který umožňuje použití stejného jména v různých modulech nebo funkcích - a jak brzy uvidíme, také v třídách a metodách.

Každý modul vymezuje svůj vlastní jmenný prostor, takže můžeme totéž jméno použít ve více modulech bez vyvolání problémů s identifikací.

Můžeme nyní oba moduly importovat a zajistit si v každém přístup k proměnným question a answer :

Kdybychom byli použili from module1 import* a from module2 import*, dospěli bychom k jmenné kolizi (naming collision) a neměli bychom přístup ke jménu question a answer z modulu module1.

Ona tři n zde nezpůsobí kolizi, protože každé n je z jiného jmenného prostoru.

Jmenné prostory umožňují pracovat více programátorům na stejném projektu bez obavy ze jmenných kolizí.

10.5 Atributy a tečkové operátory

Proměnné, definované uvnitř modulu, se nazývají atributy modulu. Jsou dostupné s použitím tečkového operátoru (.). Atributy question modulu module1 a module2 jsou přístupné použitím příkazu module1.question a module2.question.

Moduly obsahují funkce stejně jako atributy a jsou rovněž dostupné použitím tečkového operátoru. Zápis seqtools.remove_at ukazuje na funkci remove_at v modulu seqtools.

V kapitole 7 jsme uvedli funkci find z modulu string. Modul string obsahuje mnoho dalších užitečných funkcí:

Měli bychom využít pydoc k prohlížení dalších funkcí a atributů v modulu string.

10.5 Metody na řetězcích a seznamech

Během vývoje jazyka Python byla většina funkcí z modulu string uvedena také jako metoda na řetězcích coby objektech. Metoda působí téměř stejně jako funkce, ale syntaxe jejího volání je malinko odlišná:

Metody na řetězcích jsou invokovány (volány) zápisem řetězce s tečkovým operátorem a jménem metody .

V pozdějších kapitolách se naučíme vytvářet vlastní objekty s vlastními metodami. Prozatím se spokojíme s metodami, které jsou součástí vestavěných objektů.

Tečkový operátor může být také použit pro přístup k vestavěným metodám seznamů:

Append je metoda seznamu (metoda objektu typu seznam), která připojí zadaný argument na jeho konec. Následují ukázky několika dalších metod seznamu:

Pohrávej si s uvedenými metodami seznamu tak dlouho, dokud nebudeš mít pocit, že rozumíš tomu jak pracují.

10.7 Čtení a zápis textových souborů

Při běhu programu jsou data ukládána v prostoru RAM (náhodně přístupná paměť). Paměť RAM je rychlá a laciná, ale je také nestálá, čímž je míněno to, že když program skončí nebo se vypne počítač, RAM zmizí. Abychom měli data k disposici i při příštím spuštění počítače a programu, musíme je zapsat na stálejší záznamové medium, jako je pevný disk, USB nebo CD-RW.

Data na těchto nosičích jsou uložena v pojmenovaných souhrnech, zvaných soubory (files). Do těchto souborů mohou programy informace zapisovat a z nich je také načítat.

Práce se soubory je velmi podobná práci se sešitem. Před použitím sešitu jej musíme otevřít. Po ukončení práce jej musíme zavřít. Když je sešit otevřen, můžeme do něho psát, nebo z něho číst. V obou případech vždy víme na kterém místě sešitu se nalézáme. Sešit můžeme číst celý popořádku nebo napřeskáčku.

Totéž platí i pro soubory. Pro otevření souboru zadáme jeho jméno a udáme, zda chceme soubor číst nebo zapisovat.

Otevření souboru vytvoří objekt typu soubor. V naší ukázce odkazuje proměnná myfile na nový objekt test.dat.

Funkce open přijímá dva argumenty. První je jméno souboru, druhý je mód činnosti. Mód 'w' říká, že otevíráme soubor pro zápis.

Neexistuje-li soubor se jménem test.dat, bude vytvořen. Jestliže takový soubor již existuje, bude nahrazen souborem, který píšeme.

Zavření souboru říká systému, že jsme skončili zapisování a soubor je možné číst:

Nyní můžeme soubor opět otevřít, tentokrát pro čtení, a přenést obsah do řetězce v našem programu. Argumentem pro parametr mód je 'r', od slova reading (čtení):

Pokusíme-li se otevřít soubor, který neexistuje, dostaneme chybové hlášení:

Nepřekvapí nás, že metoda read čte data ze souboru. Bez zadaných argumentů přečte celý obsah souboru do jediného řetězce:

Metoda read může také přijmout argument, který říká kolik znaků má být čteno:

Zadáme-li číslo větší než je počet znaků v souboru, vrátí read jen zbývající znaky. Došlo-li se na konec souboru, vrátí read prázdný řetězec:

Následující funkce kopíruje soubor tak, že přečte a zapíše nejvíce 50 znaků najednou. První argument je jméno originálního souboru, druhý argument je jméno nového souboru:

Tato funkce cyklicky čte 50 znaků z infile a zapisuje je do outfile až je dosaženo konce a text je prázdný řetězec, čímž se vyvolá provedení příkazu break.

10.8 Textové soubory

Textový soubor je soubor, který obsahuje tisknutelné znaky a mezery uspořádané do řádků, oddělených znaky pro nový řádek (newline characters). Protože Python byl navržen zejména pro zpracování textových souborů, poskytuje metody, které tento úkol usnadňují.

Pro ukázku vytvoříme textový soubor se třemi řádky textu, oddělenými znaky pro newlines:

Metoda readline přečte všechny znaky z prvního řádku včetně znaku newline:

Řetězce v seznamu jsou uvedeny v uvozovkách (či apostrofech) a znaky newline jsou tisknuty jako escape sequence: \\012.

Na konci souboru vrací readline prázdný řetězec a readlines prázdný seznam:

Následuje ukázka programu, který zpracovává řádky textu. Funkce filter vytvoří kopii oldfile, přičemž vypustí všechny řádky, které začínají znakem #:

Příkaz continue končí aktuální průchod smyčkou (iteraci), ale nekončí cyklování. Tok provádění se přesune na vrchol smyčky, přezkoumá podmínku a pokračuje příslušnou cestou.

Tedy, je-li text prázdný řetězec, smyčka končí. Je-li prvním znakem řetězce dvojitý křížek (#), tok provádění přechází na počátek smyčky. Pouze při nesplnění obou podmínek je text kopírován do nového souboru.

10.10 Počítání písmen

Tento příklad vysvětluje, proč se 'Apple' < 'apple' vyhodnotí jako True.

Funkce chr je inverzní k fci ord. Přijme jako argument celé číslo a vrátí jeho písmennou presentaci:

Následující program countletters.py počítá množství výskytů jednotlivých písmen v knize Alice in Wonderland (Alenka v říši divů):

Spusť si tento program a prohlédni si výstupní soubor v textovém editoru. V závěrečných cvičeních bude žádána analýza programu.

10.11 Modul sys a proměnná argv

Modul sys obsahuje funkce a proměnné, které poskytují přístup k prostředí, ve kterém běží překladač Pythonu. Následující příklad ukazuje výstupní hodnoty několika příkazů, zadaných na některém z našich počítačů:

Funkce argv vytvoří seznam položek, načtených z příkazové řádky při spuštění skriptu. Tyto argumenty příkazové řádky mohou být použity k zadání informace pro program ve stejném okamžiku, kdy tento program je invokován.

Spustíme jej z unixové příkazové řádky zároveň s argumenty (viz), obdržíme:

Případně z příkazové řádky Windows (Start > Spustit> cmd; d: > cd PyScripter):

Funkce argv ve skriptu vytvoří seznam řetězců. Všimneme si, že první položka je jméno programu. Argumenty jsou odděleny mezerou a uspořádány do seznamu stejným způsobem jako při operaci string.split. Chceme-li zadat argumenty s mezerami, použijeme uvozovky:

Pomocí argv můžeme psát užitečné programy, které přijímají vstupy přímo z příkazové řádky. Zde je například program, který určí součet zadané řady čísel:

V tomto programu používáme způsob importu from <module> import <attribute>, při kterém je funkce argv přenesena do hlavního jmenného prostoru modulu.

10.12 Glosář

10.13 Cvičení

Proveď následující:
- Spusť server pydoc příkazem pydoc -g na příkazovém řádku.
- Stiskni tlačítko open browser v okně pydoc tk.
- Vyber modul calendar.
- Ze sektoru Funkctions vyber a vyzkoušej:
```
>>> import calendar
>>> year = calendar.calendar(2008)
>>> print year  # What happens here?
```
- Experimentuj s funkcí calendar.isleap. Co očekává jako argument? Co vrací jako výsledek? O jaký druh funkce se jedná?
Zapiš si poznatky, získané z tohoto cvičení.
Nemáš-li na svém počítači instalován Tkinter, potom pydoc -g vrátí chybové hlášení, protože k otevření grafického okna Tkinter potřebuje. Jinou možnosí je spustit webový server přímo:
```
$ pydoc -p 7464
```
Toto spustí webový server pydoc na portu 7464. Nyní nasměruj svůj webový prohlížeč na:
```
http://localhost:7464
```
a budeš si moci prohlížet knihovny Pythonu instalované na svém pořítači.

Použij tento postup ke spuštění pydoc a vyhledej modul math.
1. Kolik funkcí je v modulu math?
2. Co dělá math.ceil? A co dělá math.floor? (nápověda: jak floor tak ceil očekávají argument v plovoucí čárce.)
3. Popiš, jak jsme počítali stejnou hodnotu jako math.sqrt bez použití modulu math.
4. Jaké jsou dvě datové konstanty v modulu math?
Dělej si podrobné poznámky o svém zkoumání v tomto cvičení.
Použj pydoc k prozkoumání modulu copy. Co dělá deepcopy? Ve kterém cvičení z předchozí kapitoly by se nám deepcopy hodila?
Vytvoř modul mymodule1.py. Přidej atribut myage se zadaným vlastním věkem a year se zadaným současným letopočtem. Vytvoř další modul mymodule2.py. Přidej atribut myage s nastavenou nulou a year s rokem tvého narození.

Nyní vytvoř soubor namespace_test.py. Importuj oba výše uvedené moduly a napiš následující příkaz:
```
print (mymodule2.myage - mymodule1.myage) == (mymodule2.year - mymodule1.year
Spustíš-li namespace_test.py, dostaneš jako výstup buď True nebo False podle toho, zda jsi letos již narozeniny měl nebo neměl .
```
Do modulů mymodule1.py, mymodule2.py a namespace_test.py přidej následující příkaz:
```
print "My name is %s" % __name__
```
Spusť namespace_test.py. Co se stane? Proč? Nyní přidej následující kód na konec mymodule1.py:
```
if __name__ == '__main__':
    print "This won't run if I'm  imported."
```
Opět spusť mymodule1.py a namespace_test.py. Ve kterém případě vidíš nový příkaz k tisku?
V prostředí IRP si vykoušej následující:
```
>>> import this
```
Co říká Tim Peter o jmenných prostorech? (english only)
Použij pydoc k vyhledání a vyzkoušení tří dalších funkcí z modulu string. Zapiš si své poznatky.
Přepiš matrix_mult z předchozí kapitoly s využitím znalostí o metodách na seznamech.
Funkce dir, kterou jsme poznali v kapitole 7, vytiskne seznam atributů objektu zadaného jako argument. Jinými slovy, dir vrátí obsah jmenného prostoru argumentu.
Použij dir(str) a dir(list) k nalezení nejméně tří metod na řetězci a seznamu, které nebyly dosud uvedeny. Prozatím ignoruj všechno, co začíná dvojitým podtržítkem (__). Pečlivě si zapisuj své poznatky včetně jmen nových metod a příkladů jejich použití.
(nápověda: Vytiskni si dokumentační řetězec funkce, kteru chceš zkoumat. Například, abychom zjistili, jak pracuje str.join, zadáme příkaz print str.join.__doc__)

V souvislé seanci vyvolej odezvy IRP k následujícím příkazům:

>>> s = "If we took the bones out, it wouldn't be crunchy, would it?"
>>> s.split()

```
>>> type(s.split())
```
```
>>> s.split('o')
```
```
>>> s.split('i')
```
```
>>> '0'.join(s.split('o'))
```

Je důležité, abys každému výsledku porozuměl. Získané poznatky aplikuj při doplnění následující funkce s použitím metod split a join na objektech str:

def myreplace(old, new, s ):
    """
    Replace all occurances of old with new in the string s.

       >>> myreplace(',', ';', 'this, that, and, some, other, thing')
       'this; that; and; some; other; thing'
       >>> myreplace(' ', '**', 'Words will now be separated by stars.')
       'Words**will**now**be**seperated**by**stars.'
    """

Tvé řešení má projít oběma doctesty.

Vytvoř modul wordtools.py s následujcím ukončením:

if__name__ == '__main__':
    import doctest
    doctest.testmod()

Vysvětli proč tento příkaz usnadňuje užití a testování vytvořeného modulu. Jaká bude hodnota __name__ při importu wordtools.py z jiného modulu? A jaká bude při spuštění wordtools.py jako hlavního programu? Ve kterém případě budou aktivovány doctesty?

Nyní přidej těla ke každé z následujících funkcí tak, aby bylo vyhověno doctestům:

def cleanword(word):
    """
      >>> cleanword('what?')
      'what'
      >>> cleanword('"now!"')
      'now'
      >>> cleanword('?+="word!,@$()"')
      'word'
    """

def has_dashdash(s):
    """
      >>> has_dashdash('distance--but')
      True
      >>> has_dashdash('several')
      False
      >>> has_dashdash('critters')
      False
      >>> has_dashdash('spoke--fancy')
      True
      >>> has_dashdash('yo-yo')
      False
    """

def extract_words(s):
    """
      >>> extract_words('Now is the time!  "Now", is the time? Yes, now.')
      ['now', 'is', 'the', 'time', 'now', 'is', 'the', 'time', 'yes', 'now']
      >>> extract_words('she tried to curtsey as she spoke--fancy')
      ['she', 'tried', 'to', 'curtsey', 'as', 'she', 'spoke', 'fancy']
    """

def wordcount(word, wordlist):
    """
      >>> wordcount('now', ['now', 'is', 'time', 'is', 'now', 'is', 'is'])
      ['now', 2]
      >>> wordcount('is', ['now', 'is', 'time', 'is', 'now', 'is', 'the', 'is'])
      ['is', 4]
      >>> wordcount('time', ['now', 'is', 'time', 'is', 'now', 'is', 'is'])
      ['time', 1]
      >>> wordcount('frog', ['now', 'is', 'time', 'is', 'now', 'is', 'is'])
      ['frog', 0]
    """

def wordset(wordlist):
    """
      >>> wordset(['now', 'is', 'time', 'is', 'now', 'is', 'is'])
      ['is', 'now', 'time']
      >>> wordset(['I', 'a', 'a', 'is', 'a', 'is', 'I', 'am'])
      ['I', 'a', 'am', 'is']
      >>> wordset(['or', 'a', 'am', 'is', 'are', 'be', 'but', 'am'])
      ['a', 'am', 'are', 'be', 'but', 'is', 'or']
    """

def longestword(wordset):
    """
      >>> longestword(['a', 'apple', 'pear', 'grape'])
      5
      >>> longestword(['a', 'am', 'I', 'be'])
      2
      >>> longestword(['this', 'that', 'supercalifragilisticexpialidocious'])
      34
    """

Modul si ulož pro použití nástrojů v jiných programech.

Soubor unsorted_fruits.txt obsahuje seznam 26 druhů ovoce, přičemž každé jméno začíná jiným písmenem abecedy.
Napiš program sort_fruits.py, který načte ovoce z unsorted_fruits.txt a zapíše je v abecedním pořádku do sorted_fruits.txt.
Odpověz na následující otázky, týkající se countletters.py:
1. Podrobně vysvětli činnost následujících tří řádků:
```
infile = open('alice_in_wonderland.txt', 'r')
text = infile.read()
infile.close()
```
  Co vrátí příkaz type(text) po provedení oněch tří řádků?
2. Jaký bude výsledek výrazu 128 * [0]? (Read about ASCII in Wikipedia) a vysvětli proč si myslíš že proměnná counts je přiřazena k 128 * [0] (in light of what you read).
3. Co činí
```
for letter in text:
    counts[ord(letter)] += 1
```
  s counts?
4. Vysvětli účel funkce display. Proč kontroluje hodnoty 10, 13, a 32? Co je na nich zvláštního?
5. Popiš podrobně, co dělají řádky:
```
outfile = open('alice_counts.dat', 'w')
outfile.write("%-12s%s\n" % ("Character", "Count"))
outfile.write("=================\n")
```
  Co bude obsahovat alice_counts.dat po jejich provedení?
6. Konečně, vysvětli podrobně co
```
for i in range(len(counts)):
    if counts[i]:
        outfile.write("%-12s%d\n" % (display(i), counts[i]))
```
  dělá. Jaký je účel if counts[i]?
Napiš program alice_words.py, který vytvoří textový soubor alice_words.txt obsahující abecedně uspořádaný výpis slov z alice_in_wonderland.txt spolu s počtem výskytů každého slova. Prvních 10 řádek tvého výstupu by mohlo vypadat nějak takto:
```
Word              Count
=======================
a                 631
a-piece           1
abide             1
able              1
about             94
above             3
absence           1
absurd            2
```
Kolikrát se v knize objeví slovo alice?
Které je nejdelší slovo v Alice in Wonderland? Kolik má písmen?
Napiš program mean.py, který na příkazovém řádku přijme číselné pořadí a vrátí jeho střední hodnotu.
```
$ python mean.py 3 4
3.5
$ python mean.py 3 4 5
4.0
$ python mean.py 11 15 94.5 22
35.625
```
Vztah mezi vstupy a výstupy u tvého programu by měl být stejný jako v uvedené ukázce.
Napiš program median.py který na příkazovém řádku přijme číselné pořadí a vrátí jeho prostřední hodnotu.
```
$ python median.py 3 7 11
7
$ python median.py 19 85 121
85
$ python median.py 11 15 16 22
15.5
```
Uprav program countletters.py tak, že soubor k otevření přijme jako argument z příkazové řádky. Jak ošetříš pojmenování výstupního souboru?

10. Moduly a soubory

10.1 Moduly

10.2 pydoc

10.3 Vytváření modulů

10.4 Jmenné prostory

10.5 Atributy a tečkové operátory

10.5 Metody na řetězcích a seznamech

10.7 Čtení a zápis textových souborů

10.8 Textové soubory

10.9 Adresáře

10.10 Počítání písmen

10.11 Modul `sys` a proměnná `argv`

10.12 Glosář

10.13 Cvičení

10. Moduly a soubory

10.1 Moduly

10.2 pydoc

10.3 Vytváření modulů

10.4 Jmenné prostory

10.5 Atributy a tečkové operátory

10.5 Metody na řetězcích a seznamech

10.7 Čtení a zápis textových souborů

10.8 Textové soubory

10.9 Adresáře

10.10 Počítání písmen

10.11 Modul sys a proměnná argv

10.12 Glosář

10.13 Cvičení

10.11 Modul `sys` a proměnná `argv`