Coconut¶

Instalace¶

Ve své podstatě je Coconut kompilátor, který převádí kód v Coconut na kód v Pythonu. To znamená, že tam, kde lze použít skript Pythonu, lze také použít skript Coconut. Pro přístup k tomuto kompilátoru poskytuje Coconut utilitu CLI (command line interface), která dovede:

• kompilovat jednotlivé soubory nebo celé projekty,
• překládat za pochodu kód Coconut,
• včlenit se (hook into) do existujících aplikací Pythonu, jako IPython/Jupiter a MyPy.

Instalace Coconut je velmi jednoduchá:

1. instalujte Python,
2. otevřte konzolu s příkazovým řádkem
3. a zadejte:

pip install coconut

Note: Setkáváte-li se s chybami, zkuste spustit výše uvedený příkaz s flagem --user. Ujistěte se, že umístění instalace Coconut (v Unixu /usr/local/bin pokud jste nepoužil --user nebo ${HOME}/.local/bin/) pokud ano je uvedeno v proměnné prostředí PATH. Pokud se při instalaci pomocí pipstále vyskytují chyby, můžete instalovat Coconut pomocí conda podle těchto pokynů.

Pro kontrolu, že instalace proběhla správně, zkuste na příkazový řádek zadat

coconut -h

což by mělo zobrazit nápovědu pro Coconut.

Note: If you're having trouble installing Coconut, or if anything else mentioned in this tutorial doesn't seem to work for you, feel free to ask for help on Gitter and somebody will try to answer your question as soon as possible.

Bez instalace¶

Chcete-li používat Coconut bez jeho instalování, zkuste online interpreter.

Použití překladače¶

Nyní, když máte Coconut nainstalovaný, zkusíme s ním něco provádět. Překladač (interpret) spustíte z příkazového řádku zápisem

coconut

načež byste měl číst něco jako

Coconut Interpreter:
(type 'exit()' or press Ctrl-D to end)
>>>

což je oznámení Coconut, že je připraven pro zadávání a vyhodnocování kódu. Tož pusťme se do toho!

Pro případ, že jste to dříve přehlédli - veškerý platný Python 3 je platný Coconut. To neznamená, že kompilovaný Coconut poběží pouze na Python 3, protože poběží stejně i na Python 2, ale že pouze kód Python 3 je spolehlivě kompilován do kódu Coconut.

Z toho vyplývá, že jste-li důvěrně seznámen s Pythonem, jste již z větší části seznámen se skladbou Coconut a jeho celou standardní knihovnou. Zkusme pro ukázku zadat nějaký jednoduchý kód Pythonu do překladače Coconut:

>>> "hello, world!"
'hello, world!'
>>> 1 + 1
2

Psaní zdrojových souborů¶

Zajisté - být schopen za pochodu interpretovat kód Coconutu, je báječné - bylo by to však málo prospěšné bez schopnosti psát a kompilovat větší programy. Sestavení jednoduchého programu "hello, world!" si nyní ukážeme.

Nejprve vytvoříme soubor, do něhož svůj kód vložíme. Přípona zdrojových souborů pro Coconut je .coco, takže vytvořte soubor hello_world.coco. Poté byste měl věnovat čas nastavení vašeho textového editoru na řádné zvýrazňování kódu Coconut. Příslušné pokyny naleznete v dokumentaci Zvýraznění skladby.

Nyní do našeho souboru hello_world.coco vložíme kód. Na rozdíl od Pythonu, jehož záhlaví jsou obvyklá a často nezbytná,

#!/usr/bin/env python
# -*- coding: UTF-8 -*-
from __future__ import print_function, absolute_import, unicode_literals, division

provede to kompilátor Coconut za nás automaticky, takže se o formální nezbytnosti vůbec nemusíme starat a můžeme se věnovat přímo svému kódu. Vložíme tedy kód našeho programu "hello, world!".

V Python 3 je text programu tento:

print("hello, world!")

Byť tento kód chodí v Coconut také, lze jej specielně pro Coconut napsat v alternativní pojítkové formě (pipeline-style):

>>> "hello, world!" |> print

Na příkladu pěkně vidíme, jak operátor Coconutu |> umožňuje pojítky směrované (pipeline-style) programování: předává objekt z funkce do funkce s postupně odlišnými operacemi. V tomto případě vkládáme objekt "hello, world!" do operace print. Uložme nyní náš jednoduchý program "hello, world!" program a zkusme jej spustit.

Použití kompilátoru¶

Kompilování souborů a projektů utilitou CLI je vemi jednoduché. Nacédujeme (cd) se do adresáře se souborem hello_world.coco a zapíšeme

>>> coconut hello_world.coco

což vytvoří výstup

Coconut: Compiling         hello_world.coco ...
Coconut: Compiled to       hello_world.py .

a nově vytvořený soubor hello_world.py vloží do stejného adresáře jako hello_world.coco. Potom je možné tento soubor spustit příkazem

>>> python hello_world.py

což by mělo v konzole vyprodukovat výstup hello, world!.

_Note: Můžete provést kompilaci a spuštění v jednom kroku, použijete-li flag --run (zkráceně -r).

Kompilování jednotlivých souborů postupně není jediný způsob jejich kompilace. Můžeme také kompilovat všechny soubory v daném adresáři najednou a to pouhým uvedením názvu adresáře jako prvního argumentu. Máme-li například soubory havel.coco a ravel.coco v adresáři F:\codetest\coconut\compil, zařídíme jejich kompilaci příkazem

F:\codetest\coconut\compil> coconut ./
Compiling        havel.coco ...
Compiled to      havel.py
Compiling        ravel.coco ...
Compiled to      ravel.py

V adresáři compil se navíc vytvoří soubor __coconut__.py.

Kompilátor si sám vyhledá všechny kompilovatelné soubory a vytvoří pomocný soubor __coconut__.py, do něhož uloží potřebné informace z jednotlivých souborů.

Kompilátor Coconutu podporuje velké množství různých kompilačních možností - viz nápověda coconut -h. Nejužitečnější z nich je opce --linenumbers (nebo zkráceně -l), která přidává čísla řádků ze zdrojového kódu do kompilovaného kódu, umožňujíce tak při ladění vidět číslo zdrojového kódu, odpovídající chybujícímu řádku kompilovaného kódu.

_Note: Nepotřebujete-li plnou kontrolu kompilátoru, můžete použít automatickou kompilaci.

Použití IPython/Jupyter¶

Coconut usiluje o rozsáhlou podporu zavedených nástrojů pro vědecké výpočty v Pythonu.

Za tím účlem poskytuje Coconut podporu aplikace IPython/Jupiter. Pro spuštění notebooku Jupytera s Coconut jako jádrem, použijete příkaz

coconut --jupyter notebook

Případové studie¶

Protože byl Coconut vytvořen se záměrem aby byl užitečný, bude nejlépe jej předvést v akci při řešení konkrétních problémů, které jsou v tomto tutoriálu označeny jako případové studie.

Tyto případové studie ovšem nepřinášejí úplný přehled všech vlastností Coconut. Ten lze nalézt v obsáhlé dokumentaci.

Imperativní metoda¶

Imperativní přístup bychom při psaní factoriálu použili v jazyce typu C. Imperativní přístupy zahrnují mnohé změny stavu, kdy jsou pravidelně měněny proměnné při procházení smyčkou. Imperativní přístup v Coconut k problému factorial vypadá nějak takto:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    if n `isinstance` int and n >= 0:
        acc = 1
        for x in range(1, n+1):
            acc *= x
        return acc
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

# Test cases:
-1 |> factorial |> print # TypeError
0.5 |> factorial |> print # TypeError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Předtím, než se budeme podrobně zabývat průběhem výpočtu, prověřme si nejprve jeho testovací případy. Kdybychom psali skutečný program, uložili bychom jej do souboru, jenž bychom kompilovali ale protože si jenom zkoušíme věci, vystačíme si s překopírováním kódu do překladače. Měli bychom dostat dvakrát TypeError, potom 1 a 6.

Nyní, když jsme si ověřili, že nám kód chodí správně, pohleďmě o co v něm kráčí. Protože je imperativní přístup zcela nefunkcionální, Coconut nám v tomto případě příliš nepomůže. Avšak i zde použití infixové notace (vložení funkce mezi své argumenty n a int: n `isinstance` int ) činí kód čistší a čitelnější.

Rekurzivní metoda¶

Rekurzivní přístup je první ze zcela funkcionálních přístupů a to v tom, že nezahrnuje změnu stavu a smyčky jako u imperativního přístupu. Rekurzivní přístup se vyhýbá potřebě měnit proměnné tím, že tato změna je implicitně zahrnuta v rekurzivním volání funkce. Zde je rekurzivní přístup k problému factorial:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    case n:
        match 0:
            return 1
        match x is int if x > 0:
            return x * factorial(x-1)
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

# Test cases:
-1 |> factorial |> print # TypeError
0.5 |> factorial |> print # TypeError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Překopírujte si kód a testy do překladače. Měl byste dostat stejné vysledky jako v imperativní verzi.

Proberme si specifika syntaxe v tomto příkladu. Příkaz case n: spouští blok se dvěma příkazy match. Každý příkaz match se pokouší porovnat svou deklaraci (pattern) s argumentem bloku case. Příkaz else se provede jen v případě absence jakékoliv shody.

Konkretně v tomto příkladě ověřuje match, zda je n shodné s 0. Pakliže ano, provede se return 1. Pokud ne, prověřuje se druhý match, v němž je zavedena lokální poměnná x s počáteční hodnotou x = n a v níž je opakovaně (rekurzivně) volána funkce factorial(x) pro snižující se hodnotu argumentu. V okamžiku, kdy x=1, vrátí příkaz return součin čísel 1 až n-1. Pokud se neprovede žádný z obou příkazů, příkaz else spustí a provede raise TypeError("argument faktoriálu musí být celé číslo >= 0").

I když je tento příklad velmi prostý, je postup v něm použitý, jedním z nejmocnějších i nejsložitějších postupů v Coconut. Tento postup se nazývá pattern-matching neboli porovnávání s předlohou. Jak jsme viděli, pivotním slovem v tomto konstruktu je klíčové slovo match, které jsme v našem příkladě používali opakovaně pro ověření různých případů (case).

Jako intuitivní vodítko si lze představit přiřazení tam, kde vidíme klíčové slovo match. Případně si lze uvědomit, že všechny příkazy match mohou být konvertovány na ekvivalentní příkazy rozkladného (destructuring) přiřazení, které jsou rovněž platným konstruktem Coconut. V tomto případě by ekvivalentním rozkladným přiřazením k funkcí factorial nahoře bylo:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    try:
    # Jediná hodnota, kterou lze přiřadit k 0 je 0, protože 0
    # je neměnitelná konstanta; proto přiřazení selže pokud n=!0:
       0 = n
    except MatchError:
       pass
    else:
       return 1
    try
    # To se pokusí přiřadit n k x, jež bylo deklarováno jako
    # int; protože k int může být přiřazen pouze int,            # následující  podmínka selže, nebude-li n celým číslem:
       x is int = n
    except MatchError:
       pass
    else: if x > 0:   # v Coconut lze ze else použít if, match, try
       return x * factorial(x-1)
    raise TypeError("argumentem pro faktorial musí být int >= 0")

# Test cases:
-1 |> factorial |> print  # TypeError
0.5 |> factorial |> print  # TypeError
0 |> factorial |> print  # 1
3 |> factorial |> print  # 6    

Nejprve copy and paste! I když by toto rozkladné přiřazení mělo pracovat, je mnohem nemotornější než příkaz match v případě, že očekáváte, že by mohlo dojít k selhání, což je důvod pro existenci příkazu match. Ekvivalent rozkladného (destructuring) přiřazení však objasňuje, co přesně pattern-matching dělá - ukazujíc na to, že příkazy match jsou vlastně něco jako příkazy rozkladného přiřazení.

In fact, to be explicit about using destructuring assignment instead of normal assignment, the match keyword can be put before a destructuring assignment statement to signify it as such.

Při používání příkazů pro pattern-matching a destructuring assignment v dalších uázkách bude užitečné, když si pomyslíme přiřazení pokaždé, když uvidíme klíčové slovo match.

Dalším snadným vylepšením naší funkce factorial je použití žolíkového označení _. Vlastně nepotřebujeme přiřadit x jako novou proměnnou, protože má stejnou hodnotu jako n, takže když použijeme _ místo x, Coconut tuto proměnnou vlastně nikdy nepřiřadí. Naši funkci factorial můžeme tedy přepsat takto:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    case n:
        match 0:
            return 1
        match _ is int if n > 0:
            return n * factorial(n-1)
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

# Test cases:
-1 |> factorial |> print  # TypeError
0.5 |> factorial |> print  # TypeError
0 |> factorial |> print  # 1
3 |> factorial |> print  # 6

Copy, paste! Tato nová funkce factorial by se měla chovat úplně stejně jako předtím.

Až dosud jsme se u rekurzivní metody zabývali pouze porovnáním předlohy (pattern matching) ale ve skutečnosti existuje další způsob, jímž můžeme vylepšit naši funkci factorial. Coconut provádí automatickou optimalizaci koncového volání, což znamená že kdykoli funkce přímo vrací volání jiné funkce, zadrží (optimalizuje) Coconut další volání. Naši funkci factorial tedy přepíšeme pro použití koncového volání (tail call):

def factorial(n, acc=1):
    """Compute n! where n is an integer >= 0."""
    case n:
        match 0:
            return acc
        match _ is int if n > 0:
            return factorial(n-1, acc*n)
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

# Test cases:
-1 |> factorial |> print # TypeError
0.5 |> factorial |> print # TypeError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Copy, paste! Tato nová funkce factorial je ekvivalentní originální verzi s tou výjimkou, že nikdy nevyvolá RuntimeError v důsledku dosažení maximální hloubky rekurze v Pythonu, protože Coconut odstaví (optimalizuje) koncové rekurzivní volání.

Iterativní metoda¶

Tato metoda je dalším funkcionálním přístupem k řešení problému. Iterativní přístupy obcházejí potřebu změny stavu a smyček použitím funkcí vyššího řádu, které jako argumenty přijímají jiné funkce jako map a reduce k vyčlenění základních prováděných operací. Iterativní přístup k factoriálu v Coconut je tento:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    case n:
        match 0:
            return 1
        match _ is int if n > 0:
            return range(1, n+1) |> reduce$(*)
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

# Test cases:
-1 |> factorial |> print # TypeError
0.5 |> factorial |> print # TypeError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Copy, paste! Tato definice se od rekurzivní definice liší pouze v jednom řádku, což je záměrné, protože jak iterativní, tak rekurzivní přístupy jsou funkcionální. Odlišný řádek je tento:

return range(1, n+1) |> reduce$(*)

Rozložme si, co se v tomto řádku odehrává. Nejprve funkce range vytvoří iterátor pro všechna čísla, která mají být mezi sebou vynásobena. Ten je postoupen (piped) funkci reduce$(*), která násobení provede. Ale jak? Co je to reduce$(*)?

Funkce reduce existovala jako vestavěná funkce v Python 2 a Coconut ji nyní přivádí zpět. reduce je funkce vyššího řádu, která přijímá jako svůj první argument funkci pro dva argumenty a iterátor jako svůj druhý argument (viz další ukázka), načež aplikuje přijmutou funkci na daný iterátor počínaje jeho prvním elementem a voláním funkce pro dosud akumulované volání a další element, dokud není iterátor vyčerpán. Zde je vizuální reprezentace:

reduce(f, (a, b, c, d))

acc                 iter
                    (a, b, c, d)
a                   (b, c, d)
f(a, b)             (c, d)
f(f(a, b), c)       (d)
f(f(f(a, b), c), d)

return acc

Nyní pohleďme, jak jsme doplnili funkci reduce aby pronásobila všechna čísla, která ji dodáme. Úplný výraz měl tvar reduce$(*). V tomto zápise jsou použity dva konstrukty Coconut a sice operátorová funkce pro násobení ve tvaru (*) a příkaz k částečné aplikaci ve tvaru $.

Nejprve operátorová funkce. Operátorová funkce se v Coconut vytvoří uzavřením operátoru do závorek. V tomto případě je (*) zhruba ekvivalentní výrazu v Pythonu: lambda x, y: x*y. Ve skladbě lambdy v Coconut je (*) rovněž ekvivalentí zápisu (x, y) -> x*y, jenž budeme odteďka používat pro všechny lambdy, byť obě formy jsou v Coconut legální.

Note: Kdybychom povolili režim --strict, jenž hlídá náš kód z hlediska úpravy textu, dostali bychom chybové hlášení, kdykoliv bychom použili příkaz lambda Pythonu.

Nyní k částečné aplikaci funkce. Lze si myslet, že částečná aplikace je volání líné funkce s operátorem lenosti $, kde lenost znamená: "nevyhodnocuj, dokud nemusíš". Je-li v Coconut volání funkce předznamenáno znakem $, jako v tomto případě, je normální provedení funkce nahrazeno novou funkcí s již poskytnutými argumenty, takže je funkce volána jak pro částečně použité argumenty, tak pro nové argumenty (v tomto pořadí). V tomto případě je reduce$(*) ekvivalentní k (*args, **kwargs) -> reduce((*), *args, **kwargs).

Spojíme-li to vše dohromady, vidíme jak jediný řádek kódu

range(1, n+1) |> reduce$(*)

je schopen spočítat celý faktoriál bez použití stavů či smyček, pouze s použitím funkcí vyššího řádu funkcionálním stylem.

S nástroji Coconut, které zde používáme, jako je částečná aplikace ($), usměrněné (pipeline-style) programování (|>), funkce vyššího řádu (reduce) a operátorové funkce ((*)) je možné sestavovat funkcionální programy snadno a úhledně.

Metoda addpattern¶

I když je iterativní přístup velmi přehledný, je stále zapotřebí tří úrovní odsazení abychom se dostali od záhlaví funkce k vlastnímu vracenému objektu:

def factorial(n):
    """Compute n! where n is an integer >= 0."""
    case n:
        match 0:
            return 1
        match _ is int if n > 0:
            return range(1, n+1) |> reduce$(*)
    else:
        raise TypeError("the argument to factorial must be an integer >= 0")

Použijeme-li vestavěnou funkci addpattern, můžeme zredukovat tři identační úrovně na jednu. Pohleďte:

def factorial(0):
    return 1

@addpattern(factorial)
def factorial(n is int if n > 0):
    """Compute n! where n is an integer >= 0."""
    return range(1, n+1) |> reduce$(*)

# Test cases:
-1 |> factorial |> print # MatchError
0.5 |> factorial |> print # MatchError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Copy, paste! Tato verze by měla pracovat stejně jako předchozí, až nato že místo TypeError vrací hlášení MatchError. Máme zde tři nové koncepty k prodiskutování: addpattern, zápis přiřazovací funkce a definici funkce pro porovnání předlohy (pattern-matching).

Nejprve zápis přiřazovací funkce. To je docela prosté. Je-li funkce definována s rovnítkem = místo dvojtečkou :, musí být poslední řádek výrazem, jenž je také automaticky vracen.

Dále definice porovnávací (pattern-matching) funkce. Tato definice zajišťuje provedení přesně toho, co je uvedeno v názvu - porovnání všech argumentů funkce se zadaným vzorem. Pokud se vzor neshoduje s žádným z argumentů (nebo je-li zadán nesprávný počet argumentů), vyvolá funkce chybové hlášení MatchError. Chcete-li explicitně deklarovat definici p-m funkce, můžete přidat match před def.

Za třetí, addpattern. Dekorátor addpattern přijímá jako argument předtím definovanou p-m funkci a vrací dekorátor, který dekoruje novou m-p funkci přidáním nového vzoru jako další případ (case) ke starým vzorům. Dekorátor addpattern dělá tedy přesně to, co říká - přidává další vzor k existující p-m funkci.

Dekorátorem addpattern můžeme přepsat nejenom imperativní přístup, jak jsme právě provedli, ale můžeme také přepsat rekurzivní přístup, jak vidno zde:

def factorial(0) = 1

@addpattern(factorial)
def factorial(n is int if n > 0):
    """Compute n! where n is an integer >= 0."""
    return n * factorial(n - 1)

# Test cases:
-1 |> factorial |> print # MatchError
0.5 |> factorial |> print # MatchError
0 |> factorial |> print # 1
3 |> factorial |> print # 6

Copy, paste! Mělo by to chodit stejně jako předtím, kromě toho, že (stejně jako předtím) je TypeError nahrazen MatchError.

Třídění sekvence¶

Nejprve quick_sort pro seznamy. Použijeme rekurzivní přístup založený na dekorátoru addpattern - podobný k přístupu, použitého u posledně psané funkce factorial k omezení počtu odsazení. Bez dalších okolků, zde je naše implementace quick_sort pro seznamy:

def quick_sort([]) = []


@addpattern(quick_sort)
def quick_sort([head] + tail) =
    """Sort the input sequence using the quick sort algorithm."""
    
    (quick_sort([x for x in tail if x < head])
        + [head]
        + quick_sort([x for x in tail if x >= head]))

# Test cases:
[] |> quick_sort |> print # []
[3] |> quick_sort |> print # [3]
[0,1,2,3,4] |> quick_sort |> print # [0,1,2,3,4]
[4,3,2,1,0] |> quick_sort |> print # [0,1,2,3,4]
[3,0,4,2,1] |> quick_sort |> print # [0,1,2,3,4]

Copy, paste! Zde jsou pouze dvě nové věci: head-tail pattern-matching a příkazy where.

Příkazy where velmi průzračné a jistě jste jejich působení sami objevili. Příkaz where je způsob výpočtu pro vložené upřesnění.

Head-tail pattern-matching ('porovnání předlohy od čela až po chvost'), zde vidíme jako[head] + tail, jenž má formu seznamu nebo entice přidanou k proměnné. Když se tato forma vyskytne v jakémkoli p-m kontextu, je s porovnávanou hodnotou zacházeno jako se sekvencí, seznamem nebo enticí porovnávanou s počátkem této sekvence, jejiž zbytek je vázán k proměnné. V tomto případě používáme schema head-tail, abychom odstranili čelo, jež můžeme použít jako pivot pro rozštěpení zbytku seznamu.

Třídění iterátoru¶

Nyní vyzkoušíme quick_sort pro iterátory. Náš způsob řešení problému bude kombinace rekurzivního a iterativního přístupu, jež jsme použili u factoriálu, a sice v tom, že budeme lenivě a rekurzivně vytvářet iterátor. Zde je kód:

def quick_sort(l):
    """Sort the input iterator, using the quick sort algorithm"""
    
    match [head] :: tail in l:
        tail = reiterable(tail)
        yield from (quick_sort((x for x in tail if x < head))
            :: (head,)
            :: quick_sort((x for x in tail_ if x >= head))
            )
    # We implicitly return an empty iterator here if the match falls through.           

# Test cases:
[] |> quick_sort |> list |> print # []
[3] |> quick_sort |> list |> print # [3]
[0,1,2,3,4] |> quick_sort |> list |> print # [0,1,2,3,4]
[4,3,2,1,0] |> quick_sort |> list |> print # [0,1,2,3,4]
[3,0,4,2,1] |> quick_sort |> list |> print # [0,1,2,3,4]

Copy, paste! Tento quick_sort algoritmus používá řadu nových konstruktů, takže hrr na ně.

Nejprve je to operátor ::, který se zde objevuje jak v porovnávání shody (pattern-matching), tak samostatně. V podstatě to je líný operátor + pro iterátory, který spojuje nebo řetězí líně dva iterátory, nic nevyhodnocujíc, není-li žádáno; lze jej použít pro vytváření nekonečných iterátorů. V porovnání shody tuto operaci invertuje, rozkládaje (destructuring) počátek iterátoru na předlohu a zbytek, který váže k proměnné.

Což nás přivádí k další nové věci, zápisu match ... in .... Zápis

match pattern in item:
    <body>
else:
    <else>

je zkratka pro

case item:
    match pattern:
        <body>
else:
    <else>

která eliminuje potřebu další úrovně identace při provedení pouze jednoho match.

Třetím novým konstruktem je reiterable. Při realizaci neměnitelného funkcionálního programování s iterátory Pythonu se vyskytuje tento problém: kdykoliv se přistoupí k elementu iterátoru, je ztracen. Procedura reiterable umožňuje, aby byl volaný iterábl iterován opakovaně, poskytujíc pro stejné vstupy stejné výstupy.

Konečně, byť se nejedná o nový konstrukt, protože existuje v Python 3, naše použití yield from si zasluhuje zmínky. V Pythonu se příkaz yield, který pracuje podobně jako return, používá k vytváření iterátorů - s tou výjimkou, že se yield může vyskytnout vícekrát , pokaždé vraceje jiný element. Forma yield from je velmi podobná, až na to, že místo přidání jediného elementu do vytvářeného iterátoru přidává jiný celý iterátor.

Spojíme-li to všechno dohromady, máme zde opět naši funkci quick_sort:

def quick_sort(l):
    """Sort the input iterator, using the quick sort algorithm."""
    match [head] :: tail in l:
        tail = reiterable(tail)
        yield from (quick_sort((x for x in tail if x < head))
            :: (head,)
            :: quick_sort((x for x in tail_ if x >= head))
            )
    # We implicitly return an empty iterator here if the match falls through.       

Funkce se nejprve pokouší rozdělit (split) seznam l na počáteční element a zbývající iterátor. Je-li l prázdným iterátorem, porovnání selže, poskytujíce prázdný iterátor (takto funkce ošetřuje základní případ). V opačném případě vytváříme kopii zbytku iterátoru a poskytujeme (yield) spojení: (quick-sort všech zbývajících elementů menších než počáteční element) + (počáteční element) + (quick-sort všech zbyvajících elementů větších než počáteční element).

Výhody zde použitého základního přístupu s četným použitím iterátorů a rekurzí, v porovnání s klasickým imperativním přístupem, jsou mnohé. Za prvé je náš přístup čistší a čitelnější, protože popisuje co je quick_sort místo jak by měl být použit. Za druhé je náš přístup líný v tom, že náš quick_sort nic nevyhodnocuje bez vyžádání. A konečně, byť to není relevantní pro quick_sort, je to relevantní v mnoha jiných případech, jejichž příklady ještě v tomto tutoriálu uvidíme, náš přístup umožňuje pracovat s nekonečnými řadami jako by byly skutečně nekonečné.

Coconut činí programování s takto výhodným funkcionálním přístupem výrazně snadnější. V tomto příkladě nám pattern-matching Coconutu umožňuje snadné dělení daného iterátoru a jeho slučovací operátor :: nám umožňuje jej vrátit zpět ve srovnaném pořadí.

2-vector¶

Příkaz data v Coconut přivádí do Pythonu mocnou utilitu neměnitelných algebraických datových typů. Skladbu příkazu data si ukážeme na definici jednoduchého dvouprvkového vektoru. Tento vektor bude mít specielní metodu __abs__, která spočítá jeho délku, definovanou jako odmocninu součtu čtverců jeho prvků. Zde je:

data vector2(x, y):
    """Immutable 2-vector."""
    def __abs__(self):
        """Return the magnitude of the 2-vector."""
        return (self.x**2 + self.y**2)**0.5

# Test cases:
vector2(1, 2) |> print # vector2(x=1, y=2)
vector2(3, 4) |> abs |> print # 5
vector2(1, 2) |> fmap$(x -> x*2) |> print  # vector2(x=2, y=4)
v = vector2(2, 3)
v.x = 7 # AttributeError

Copy, paste! Tento příklad ukazuje základní skladbu příkazů data:

data <name>(<attributes>):
    <body>

kde <name> a <body> znamenají totéž jako v ekvivalentní definici class, avšak <attributes> jsou zde různé atributy definovaného datového typu, jež může konstruktor přijmout jako argumenty. V tomto případě je vector2 datový typ se dvěma atributy x a y, s jednou metodou __abs__, která počítá jeho délku. Jak ukazují testovací případy, instance datového typu vector2 lze vytvářet, tisknout, nikoliv však měnit.

Další věcí, na kterou je zde zapotřebí upozornit, je použití funkce fmap. fmap umožňuje mapovat funkce po algebraických datových typech. Datové typy Coconut podporují iteraci, takže standardní map s nimi může pracovat ale nevrací jiný objekt téhož datového typu. Konstrukt fmap je jednoduše map plus volání konstruktoru objektu.

Konstruktor pro n-Vector¶

Nyní, když jsme vyřídili 2-vector, vraťme se zpět k našemu původnímu, více komplikovanému problému s n-vektory, to jest s vektory libovolné délky. Pokusíme se, aby náš n-vektor podporoval všechny základní vektorové operace ale začneme pouze s definicí data a konstruktorem:

data vector(*pts):
    """Immutable n-vector."""
    def __new__(cls, *pts):
        """Create a new vector from the given pts."""
        match [v is vector] in pts:     
            return v  # vector(v) where v is a vector should return v
        else:
            return pts |*> makedata$(cls)  # accesses base constructor

# Test cases:
vector(1, 2, 3) |> print # vector(*pts=(1, 2, 3))
vector(4, 5) |> vector |> print # vector(*pts=(4, 5))

Copy, paste! Nově se zde dozvídáme, jak psát konstruktory data. Protože jsou typy data neměnitelné, nebude zde chodit konstrukce __init__. Místo toho je použita jiná specielní metoda __new__, která musí vrátit nově vytvořenou instanci a na rozdíl od většiny metod přijímá jako první argument class, nikoliv objekt. Protože __new__ potřebuje vrátit úplnou instanci, bude ve většině případů nezbytný přístup k výchozímu konstruktoru data. Pro tento účel poskytuje Coconut vestavěnou funkci makedata, která přijímá datový typ a volá jeho výchozí konstruktor pro zbytek argumentů.

V tomto případě konstruktor kontroluje, zda nebylo zadáno nic jiného než další vector, v kterémžto případě jej vrací. Jinak vrací výsledek volání výchozího konstruktoru, jehož formou je vector(pts), neboť takto jsme deklarovali datový typ. Používáme sekvenční p-m ke zjištění, zda jsme zadali jediný vektor, což je pouze seznam nebo entice vzorů, s nimiž je porovnáván obsah sekvence.

Dalším novým konstruktem zde použitým je operátor |*> neboli star-pipe, který funguje úplně stejně jako normální pojítko, kromě toho, že místo volání funkce s jedním argumentem, volá ji tolika argumenty, kolik je elementů v zadané sekvenci. Rozdíl mezi |*> a |> je analogický rozdílu mezi f(args) a f(*args).

Metody pro n-vector¶

Nyní, když máme konstruktor pro náš n-vektor, je čas napsat jeho metody. První je metoda __abs__, která má počítat velikost vektoru. To bude mírně složitější než u 2-vektoru, protože musí chodit pro libovolný počet pts. Naštěstí můžeme použít pojítkový (pipeline) styl Coconutu a jeho částečnou aplikaci funkce:

    def __abs__(self) =
        """Return the magnitude of the vector."""
        self.pts |> map$(pow$(?, 2)) |> sum |> pow$(?, 0.5)

Základním algoritmem zde je 'mapování' mocniny pro každý prvek, jejich celkový součet a druhá odmocnina výsledku. Novým konstruktem zde je znak ? v částečné aplikaci, který jednoduše umožňuje přeskočení jednoho argumentu a odložení jeho použití na volání funkce. V tomto případě nám ? umožňuje částečně aplikovat exponent místo základu ve funkci pow - mohli jsme rovněž ekvivalentně použít (**).

Dále je sčítání vektorů. Cílem je sečíst dva vektory stejné délky sečtením jejich komponent. Za tím účelem využijeme schopnost Coconutu provést pattern-matching (nebo v tomto případě rozkladné přiřazení) pro datové typy a to takto:

    def __add__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Add two vectors together."""
        map((+), self.pts, other_pts) |*> vector

Máme zde několik nových konstruktů ale nejvýznamnějším je pattern-matching pro vector(*other_pts), na němž vidíme skladbu pro porovnávání shody s datovými typy: přesně napodobuje originální deklaraci data pro daný datový typ. V tomto případě se vector(*other_pts) bude shodovat pouze s vektorem, přičemž přiřadí atribut pts vektoru proměnné other_pts. Pokud se nebude shodovat, vyvolá chybu MatchError.

Další metodou je podíl vektorů, což je vlastně součet vektorů se znaménkem (-) místo (+):

    def __sub__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Subtract one vector from another."""
        map((-), self.pts, other_pts) |*> vector

Za povšimnutí zde stojí to, že na rozdíl od jiných operátorových funkcí, může (-) znamenat buď odečtení nebo negaci. Konkretní význam závisí na počtu poskytnutých argumentů - jeden pro negaci, dva pro odečtení. Abychom si to demonstrovali, použijeme stejnou funkci (-) k zavedení negace vektoru, což by mělo negovat každý jeho prvek:

    def __neg__(self) =
        """Retrieve the negative of the vector."""
        self.pts |> map$(-) |*> vector

Poslední metodou, kterou zavedeme, je násobení vektorů. To je poněkud komplikované, neboť matematicky existuje více způsobů. Pro naše účely se soustředíme na dva: na (skalární) součin dvou vektorů stejné délky, což se součet součinů příslušných elementů a na násobení vektoru skalárem, což je násobení všech elementů stejným skalárem. Zde je naše implementace:

    def __mul__(self, other):
        """Scalar multiplication and dot product."""
        match vector(*other_pts) in other:
            assert len(other_pts) == len(self.pts)
            return map((*), self.pts, other_pts) |> sum # dot product
        else:
            return self.pts |> map$((*)$(other)) |*> vector # scalar multiple
    def __rmul__(self, other):
        """Necessary to make scalar multiplication commutative."""
        return self * other

Za pozornost zde stojí za prvé, že na rozdíl od součtu a podílu, kde jsme chtěli hlásit chybu při selhání shody vektoru, zde chceme při selhání shody provést násobení skalárem - takže místo použití rozloženého přiřazení použijeme příkaz match.

Za druhé si povšimneme použití kombinace pojítkového (pipeline) stylu programování, částečné aplikace, operátorových funkcí a funkcí vyššího řádu pro výpočet skalárního součinu a pro násobení skalárem. U skalárového součinu mapujeme násobení na dva vektory a sečteme výsledky. U násobení skalárem vytváříme nový vektor násobením všech prvků původního vektoru stejným číslem.

Nakonec to vše dáme dohromady:

data vector(*pts):
    """Immutable n-vector."""
    def __new__(cls, *pts):
        """Create a new vector from the given pts."""
        match [v is vector] in pts:
            return v  # vector(v) where v is a vector should return v
        else:
            return pts |*> makedata$(cls)  # accesses base constructor
    def __abs__(self) =
        """Return the magnitude of the vector."""
        self.pts |> map$(pow$(?, 2)) |> sum |> pow$(?, 0.5)
    def __add__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Add two vectors together."""
        map((+), self.pts, other_pts) |*> vector
    def __sub__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Subtract one vector from another."""
        map((-), self.pts, other_pts) |*> vector
    def __neg__(self) =
        """Retrieve the negative of the vector."""
        self.pts |> map$(-) |*> vector
    def __mul__(self, other):
        """Scalar multiplication and dot product."""
        match vector(*other_pts) in other:
            assert len(other_pts) == len(self.pts)
            return map((*), self.pts, other_pts) |> sum  # dot product
        else:
            return self.pts |> map$((*)$(other)) |*> vector  # scalar multiplication
    def __rmul__(self, other) =
        """Necessary to make scalar multiplication commutative."""
        self * other

# Test cases:
vector(1, 2, 3) |> print  # vector(*pts=(1, 2, 3))
vector(4, 5) |> vector |> print  # vector(*pts=(4, 5))
vector(3, 4) |> abs |> print  # 5
vector(1, 2) + vector(2, 3) |> print  # vector(*pts=(3, 5))
vector(2, 2) - vector(0, 1) |> print  # vector(*pts=(2, 1))
-vector(1, 3) |> print  # vector(*pts=(-1, -3))
(vector(1, 2) == "string") |> print  # False
(vector(1, 2) == vector(3, 4)) |> print  # False
(vector(2, 4) == vector(2, 4)) |> print  # True
2*vector(1, 2) |> print  # vector(*pts=(2, 4))
vector(1, 2) * vector(1, 3) |> print  # 7

Copy, paste! Je to pěkná řádka řádků. Když si to však poučeně procházíme, je to čisté, čitelné a stručné a dělá to přesně to, co jsme chtěli aby to dělalo: vytvořit algebraický datový typ pro neměnitelný n-vektor, který podporuje základní vektorové operace. Celou záležitost jsme přitom provedli čistě funkcionálně bez potřeby imperativních konstruktů, jako jsou stavy nebo smyčky.

diagonal_line¶

Naše první funkce diagonal_line(n) by tedy měla vytvořít iterátor všech bodů, reprezentovaných jako souřadnicové entice v n-té diagonále, počínaje v bodě (0, 0) jako 0th diagonála. Jak jsme si řekli na počátku případové studie, o řešení se pokusíte nejdřív sami s použitím všech nástrojů funkcionálního programování, které Coconut poskytuje. Až budete hotovi, posuňte se dále.

Zde je několik testů, které můžete použít:

diagonal_line(0) `isinstance` (list, tuple) |> print # False (should be an iterator)
diagonal_line(0) |> list |> print # [(0, 0)]
diagonal_line(1) |> list |> print # [(0, 1), (1, 0)]

Nápověda: n-tá diagonála by měla obsahovat n+1 prvků, zkuste tedy začít s funkcí range(n+1) a posléze ji nějak přetvořit.

Nebylo to tak hrozné, že ne? Nyní se podívejme na mé řešení:

def diagonal_line(n) = range(n+1) |> map$((i) -> (i, n-i))

Prostinké, což? Vezmeme range(n+1) a použijeme map k její transformaci na potřebnou sekvenci entic.

linearized_plane¶

Nyní, když jsme vytvořili naše diagonální přímky, potřebujeme je spojit dohromady abychom sestavili plně linearizovanou rovinu a za tím účelem napíšeme funkci linearized_plane(). Funkce linearized_plane by měla vytvořit iterátor, který prochází všemi body roviny po diagonálách, počínaje nultou, prvou, atd. Tento iterátor musí být nezbytně nekonečný, protože musí procházet všemi body dané roviny.

Nápovědou pro sestavování funkce budiž připomínka, že operátor :: je líný a nevyhodnotí své operandy bez požádání, což znamená, že může být použit k vytvoření nekonečných iterátorů. Až budete hotovi, posuňte se v textu dále.

Testy:

# Note: tyto testy používají označení $[], které jsme dosud neuvedli
#  ale bude uvedeno později ještě v této případové studii; prozatím proveďte 
#  testy a ujistěte se, že dostáváte stejný výsledek jako je v komentáři:
linearized_plane()$[0] |> print # (0, 0)
linearized_plane()$[:3] |> list |> print # [(0, 0), (0, 1), (1, 0)]

Nápověda: místo definování funkce linearized_plane(), zkuste ji definovat jako linearized_plane(n=0), kde n je označení počáteční diagonály a pro rozvinutí funkce použijte rekurzi.

To bylo poněkud náročnější než předtím ale doufejme, že ne příliš. Nyní se podívejme na mé řešení:

def linearized_plane(n=0) = diagonal_line(n) :: linearized_plane(n+1)

Jak vidíte, je to v základě jednoduché řešení: prostě ke spojení diagonál za sebou použijete :: a rekurzi.

vector_field¶

Nyní, když máme funkci, která vytvoří všechny potřebné body, je čas přeměnit je na vektory a za tím účelem si definujeme novou funkci vector_field(), která přemění všechny entice v linearized_plane na vektory s použitím třídy n-vector, kterou jsme definovali dříve.

Testy:

# Budete potřebovat sem přenést třádu vektoru z předchozích textů aby vám chodilo následující:
vector_field()$[0] |> print # vector(*pts=(0, 0))
vector_field()$[2:3] |> list |> print # [vector(*pts=(1, 0))]

Nápověda: Vzpomeňte si, že vektor, který jsme definovali, přijímá komponenty jako separátní argumenty, nikoliv jako jedinou entici. Při řešení vám může být nápomocný text Coconut built-in starmap.

Děláme velký pokrok! Než pokročíme dál, srovnejte si řešení se mnou:

def vector_field() = linearized_plane() |> starmap$(vector)

Vše, co jsme učinili, bylo to, že jsme mapovali vector přes funkci linearized_plane, avšak s použitím starmap místo map, takže je vector volán s každým elementem entice jako separátním argumentem.

Applikace¶

Nyní, když máme všechny funkce, potřebné pro naše vektorové pole, dáme je všechny dohromady a otestujeme je. Nezdráhejte se dosadit vlastní verze funkcí:

data vector(*pts):
    """Immutable n-vector."""
    def __new__(cls, *pts):
        """Create a new vector from the given pts."""
        match [v is vector] in pts:
            return v  # vector(v) where v is a vector should return v
        else:
            return pts |*> makedata$(cls)  # accesses base constructor
    def __abs__(self) =
        """Return the magnitude of the vector."""
        self.pts |> map$(pow$(?, 2)) |> sum |> pow$(?, 0.5)
    def __add__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Add two vectors together."""
        map((+), self.pts, other_pts) |*> vector
    def __sub__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Subtract one vector from another."""
        map((-), self.pts, other_pts) |*> vector
    def __neg__(self) =
        """Retrieve the negative of the vector."""
        self.pts |> map$(-) |*> vector
    def __mul__(self, other):
        """Scalar multiplication and dot product."""
        match vector(*other_pts) in other:
            assert len(other_pts) == len(self.pts)
            return map((*), self.pts, other_pts) |> sum  # dot product
        else:
            return self.pts |> map$((*)$(other)) |*> vector  # scalar multiplication
    def __rmul__(self, other) =
        """Necessary to make scalar multiplication commutative."""
        self * other

def diagonal_line(n) = range(n+1) |> map$(i -> (i, n-i))
def linearized_plane(n=0) = diagonal_line(n) :: linearized_plane(n+1)
def vector_field() = linearized_plane() |> starmap$(vector)

# Test cases:
diagonal_line(0) `isinstance` (list, tuple) |> print  # False (should be an iterator)
diagonal_line(0) |> list |> print  # [(0, 0)]
diagonal_line(1) |> list |> print  # [(0, 1), (1, 0)]
linearized_plane()$[0] |> print  # (0, 0)
linearized_plane()$[:3] |> list |> print  # [(0, 0), (0, 1), (1, 0)]
vector_field()$[0] |> print  # vector(*pts=(0, 0))
vector_field()$[2:3] |> list |> print  # [vector(*pts=(1, 0))]

Copy, paste! Poté, co jste se ujistili, že po dosazení svých funkcí chodí vše jak má, zaměřte se na poslední čtyři testy. Zjistíte, že používají novou notaci, podobnou notaci pro částečnou aplikaci, již jsme viděli dříve - ale s hranatými závorkami místo kulatých. To je notace pro krájení (slicing) iterátoru. Podobně jako byla částečná aplikace líným voláním funkce, je dělení iterátoru línym dělením sekvence. Podobně jako u částečné aplikace, je užitečné považovat znak $ za zlenivějící (lazy-ify) operátor, v tomto případě přetvářející normální (ihned prováděné) krájení (slicing) Pythonu na líné krájení iterátoru, které se provádí jen tehdy, jsou-li prvky v řízcích (slice) potřebné.

Maje toto na mysli, nyní když jsme sestavili naše vektorové pole, je čas si s krájením iterátoru trochu pohrát. Zkuste něco smělého, jako například

• vytvořit magnitude-field, kde každý bod reprezentuje délku příslušného vektoru
• zkombinovat celá vektorová pole aplikací funkce match na dříve vytvořené metody dělení a násobení

potom použít krájení iterátoru pro vynětí a přezkoušení úseků.

__truediv__¶

Dělení vektorů je pouhé skalární dělení, pročež napíšeme metodu __truediv__, která přijímá self jako první argument a other jako druhý argument, vracejíc nový vektor téže velikosti jako self, s prvky dělenými vektorem other. Jako specielní výzvu, zkuste to zapsat v jediném řádku s použitím notace přiřazovací funkce.

Testy:

vector(3, 4) / 1 |> print # vector(*pts=(3.0, 4.0))
vector(2, 4) / 2 |> print # vector(*pts=(1.0, 2.0))

Nápověda: Podívejte se zpět, jak jsme zaváděli násobení skalárem.

Zde je mé řešení pro vaši kontrolu:

    def __truediv__(self, other) = self.pts |> map$(x -> x/other) |*> vector

.unit¶

Další je .unit. Napíšeme metodu unit, která přijímá jako argument pouze self a vrací nový vektor téže velikosti jako self, s každým prvkem děleným velikostí self, jež můžeme získat pomocí funkce abs. To by měl být velmi jednoduchý jedořádkový zápis.

Testy:

vector(0, 1).unit() |> print # vector(*pts=(0.0, 1.0))
vector(5, 0).unit() |> print # vector(*pts=(1.0, 0.0))

Zde je mé řešení:

    def unit(self) = self / abs(self)

.angle¶

Tato metoda bude poněkud složitější. Připomeňme, že matematicky se úhel mezi dvěma vektory vyjádří jako math.acos skalárního součinu obou vektorů, připadně jejich jednotkových vektorů a připomeňme si, že jsme již zavedli skalární součin dvou vektorů, když jsme napsali metodu __mul__. Takže, metoda .angle má přijmout self jako první argument a other jako druhý - a je-li other vektorem, použít tuto formuli k výpočtu úhlu mezi self other, nebo není-li other vektorem, má metoda .angle ohlásit MatchError. Abychom to zajistili, budeme potřebovat rozložené přiřazení k ověření, že other je skutečně vektor.

Testy:

import math
vector(2, 0).angle(vector(3, 0)) |> print # 0.0
print(vector(1, 0).angle(vector(0, 2)), math.pi/2) # should be the same
vector(1, 2).angle(5) # MatchError

Nápověda: Podívejte se zpět, jak jsme s použitím rozloženého přiřazení kontrolovali, zda argument pro factorial bylo celé číslo.

Pohleďte na mé řešení:

    def angle(self, other is vector) = math.acos(self.unit() * other.unit())

A nyní je čas to dát všechno dohromady. Nezdráhejte se dosadit své vlastní verze posledně definovaných metod.

import math # necessary for math.acos in .angle

data vector(*pts):
    """Immutable n-vector."""
    def __new__(cls, *pts):
        """Create a new vector from the given pts."""
        match [v is vector] in pts:
            return v  # vector(v) where v is a vector should return v
        else:
            return pts |*> makedata$(cls)  # accesses base constructor
    def __abs__(self) =
        """Return the magnitude of the vector."""
        self.pts |> map$(pow$(?, 2)) |> sum |> pow$(?, 0.5)
    def __add__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Add two vectors together."""
        map((+), self.pts, other_pts) |*> vector
    def __sub__(self, vector(*other_pts)
                if len(other_pts) == len(self.pts)) =
        """Subtract one vector from another."""
        map((-), self.pts, other_pts) |*> vector
    def __neg__(self) =
        """Retrieve the negative of the vector."""
        self.pts |> map$(-) |*> vector
    def __mul__(self, other):
        """Scalar multiplication and dot product."""
        match vector(*other_pts) in other:
            assert len(other_pts) == len(self.pts)
            return map((*), self.pts, other_pts) |> sum  # dot product
        else:
            return self.pts |> map$((*)$(other)) |*> vector  # scalar multiplication
    def __rmul__(self, other) =
        """Necessary to make scalar multiplication commutative."""
        self * other
     # New one-line functions necessary for finding the angle between vectors:
    def __truediv__(self, other) = self.pts |> map$(x -> x/other) |*> vector
    def unit(self) = self / abs(self)
    def angle(self, other is vector) = math.acos(self.unit() * other.unit())

# Test cases:
vector(3, 4) / 1 |> print  # vector(*pts=(3.0, 4.0))
vector(2, 4) / 2 |> print  # vector(*pts=(1.0, 2.0))
vector(0, 1).unit() |> print  # vector(*pts=(0.0, 1.0))
vector(5, 0).unit() |> print  # vector(*pts=(1.0, 0.0))
vector(2, 0).angle(vector(3, 0)) |> print  # 0.0
print(vector(1, 0).angle(vector(0, 2)), math.pi/2)  # should be the same
vector(1, 2).angle(5)  # MatchError

Jedna důležitá poznámka: dejte si pozor abyste nenechali prázdný řádek při dosazování vlastních metod, neboť v tom případě by interpret roztrhl kód. V normálním zápisu Coconut to není žádný problém, pouze zde, protože provádíme kopírování-vkládání do příkazového řádku

Copy, paste! Jestliže všechno chodí jak má, doporučuji se vrátit ke hrátkám s aplikacemi vector_field s použitím našich nových metod.

Líné seznamy¶

Líné seznamy jsou líně vyhodnocované iterátorové literály, podobné ve své lenosti operátoru :: - a to v tom, že jakýkoli výraz uvnitř líného seznamu není vyhodnocen, dokud jej není zapotřebí. Syntaxe pro líné seznamy je přesně táž jako syntaxe pro normální seznamy, až na "banánové závorky" ((| and |)) místo normálních závorek, takto:

abc = (| a, b, c |)

Jako u všech iterátorů Pythonu, lze volat next k získání následného objektu v iterátoru. S použitím líného seznamu je možné definovat hodnoty, použité ve výrazech dle potřeby bez vyvolání hlášení NameError:

abcd = (| d(a), d(b), d(c) |)  # a, b, c, and d are not defined yet
def d(n) = n + 1

a = 1
next(abcd)  # 2
b = 2
next(abcd)  # 3
c = 3
next(abcd)  # 4

Skladba funkcí¶

Skladba funkcí v Coconut se zajišťuje operátorem .., který přijímá dvě funkce a spojí je do nové funkce, ekvivalentní zápisu (*args, **kwargs) -> f1(f2(*args, **kwargs)). To může být užitečné u částečné aplikace při spojování několika funkcí vyššího řádu, jako zde:

zipsum = map$(sum)..zip

Jsou-li skládané funkce uzavřeny v závorkách, lze do nich vložit argumenty:

def plus1(x) = x + 1
def square(x) = x * x

(plus1..square)(3) == 10  # True

Funkce s různými aritami lze skládat dohromady, pokud jsou uvedeny ve správném pořadí. Při nesprávném pořadí je vyvoláno hlášení TypeError. V tomto příkladu spojíme unární funkci s binární:

def add(n, m) = n + m  # binary function
def square(n) = n * n  # unary function

(add..square)(3, 1)    # Raises TypeError: square() takes exactly 1 argument (2 given)
(square..add)(3, 1)    # 16

Jiný důležitý trik zahrnuje skládání funkce s funkcí vyššího řádu:

def inc_or_dec(t):
    # Our higher-order function, which returns another function
    if t:
        return x -> x+1
    else:
        return x -> x-1

def square(n) = n * n

square_inc = square..inc_or_dec(True)
square_dec = square..inc_or_dec(False)
square_inc(4)  # 25
square_dec(4)  # 9

Note: Coconut také podporuje skladebné pojítkové (pipe) operátory ..>, <.., ..*> a <*...

Implicitní parciály¶

Coconut podporuje řadu různých "neúplných" výrazů, jež se rozvinou do funkce, která přijme jen část argumentů, nezbytných pro dokončení, to jest do funkce s implicitně částečnou aplikací. Různé přípustné výrazy jsou:

.attr
.method(args)
obj.
func$
seq[]
iter$[]
.[slice]
.$[slice]

Úplné vysvětlení co každý implicitní parciál dělá lze nalézt v části implicit partials.

Anotace typů¶

Pro mnoho lidí je velkou nevýhodou Pythonu skutečnost, že je to dynamicky typovaný jazyk. V Pythonu je tento problém osloven v MyPy, což je analyzátor statických typů v Pythonu, který umí kontrolovat anotace typu, zavedené v Python 3, například:

def plus1(x: int) -> int:
    return x + 1
a: int = plus1(10)

Bohužel, tyto anotace typu existují pouze v Python 3. Coconut ovšem kompiluje tyto anotace na univerzálně kompatibilní komentáře typu. Kromě toho má Coconut vestavěnou MyPy integraci pro automatické ověřování typu v kódu a vlastní vylepšenou skladbu pro anotaci typu pro snadnější vyjádření složitých typů.

Další čtení¶

Všechny vlastnosti popsané v tomto tutoriálu, stejně jako řada dalších, jsou podrobně dokumentovány v podrobné dokumentaci.

Also, if you have any other questions not covered in this tutorial, feel free to ask around at Coconut's Gitter, a GitHub-integrated chat room for Coconut developers.

Finally, Coconut is a new, growing language, and if you'd like to get involved in the development of Coconut, all the code is available completely open-source on Coconut's GitHub. Contributing is a simple as forking the code, making your changes, and proposing a pull request. See Coconuts contributing guidelines for more information.

Instalace¶

pip install coconut

conda config --add channels conda-forge
conda install coconut

Volitelné závislosti¶

Coconut má také volitelné dependence, instalovatelné zadáním

pip install coconut [název volitelné závislosti]

nebo pro instalaci více dependencí,

pip install coconut [opt_dep_1, opt_dep_2]

Úplný seznam volitelných depencencí:

• all: alias pro jupyter, watch, jobs, mypy (doporučný způsobinstalace úplné verze Coconut)
• jupyter/ipython: umožňuje použití flagu --jupyter / --ipython
• watch: umožňuje flag --watch
• jobs: umožňuje flag --jobs
• mypy: umožňuje flag mypy
• cPyparsing: výrazně urychluje kompilaci (pokud to vaše platformapodporuje) použitím [cPyparsing](https://github.com/evhub/ cpyparsing)
• tests: všechno nezbytné pro používání sestovací soupravy Coconutu
• docs: všechno nezbytné pro vytváření dokumentace Coconutu
• dev: všechno nezbytné pro vyvíjení Coconutu, včetně všech výše uvedených dependencí

Vývojářská verze¶

Případně, chcete-li si vyzkoušet poslední a nejlepší Coconut, zapište

pip install coconut-develop

což nainstaluje nejposlednější chodící verzi Coconutu z develop branch. Volitelná instalace závislostí je podporována stejným způsobem, jak popsáno výše. Více informací o aktuální vývojové sestavě najdete na development version of this documentation. Buďte varováni: coconut-develop může být nestabilní — narazíte-li na chybu, prosím ohlašte ji vytvořením nového issue.

Použití¶

coconut [-h] [-v] [-t version] [-i] [-l] [-k] [-p] [-a] [-w] [-r] [-n]
        [-d] [-q] [-s] [-f] [-c code] [-j processes] [--no-tco]
        [--minify] [--jupyter ...] [--mypy ...] [--argv ...] 
        [--tutorial] [--documentation] [--style name] 
        [--recursion-limit limit] [--verbose] [--trace]
        [source] [dest]

source          cesta k souboru coconut, který má být kompilován
dest            cílová složka pro compilované soubory (implicitně jí je zdrojový adresář)

-h, --help              show this help message and exit
-v, --version           print Coconut and Python version information
-t version, --target version
                        specify target Python version (defaults to
                        universal)
-i, --interact          force the interpreter to start (otherwise starts if no
                        other command is given) (implies --run)
-p, --package           compile source as part of a package (defaults to only
                        if source is a directory)
-a, --standalone        compile source as standalone files (defaults to only
                        if source is a single file)
-l, --line-numbers      add line number comments for ease of debugging
-k, --keep-lines        include source code in comments for ease of debugging
-w, --watch             watch a directory and recompile on changes 
-r, --run               run compiled Python (often used with --nowrite)
-n, --no-write          disable writing compiled Python
-d, --display           print compiled Python
-q, --quiet             suppress all informational output (combine with 
                        --display to write runnable code to stdout)
-s, --strict            enforce code cleanliness standards
--no-tco, --notco       disable tail call optimization                       
-c code, --code code    run Coconut passed in as a string (can also be piped
                        into stdin)
-j, --jobs processes    number of additional processes to use (defaults to 
                        0) (pass 'sys' to use machine default)
-f, --force             force overwriting of compiled Python (otherwise only
                        overwrites when source code or compilation
                        parameters change)
--minify                compress compiled Python                        
--jupyter, --ipython    run Jupyter/IPython with Coconut as the kernel (
                        remaining args passed to Jupyter)
--mypy ...              run MyPy on compiled Python (remaining args passe to
                        MyPy) (implies --package--no-tco)
--argv ...              set sys.argv to source plus remaining args for use
                        in Coconut script being run                     
--tutorial              open the Coconut tutorial in the default web browser

--style name            Pygments syntax highlighting style (or 'none' to
                        disable) (defaults to COCONUT_STYLE environment
                        variable, if it exists, otherwise 'default')
--recursion-limit limit
                        set maximum recursion depth in compiler (defaults to
                        2000)
--verbose               print verbose debug output
--trace                 print verbose parsing data (only available in
                        coconut-develop)

Skripty Coconutu¶

Ke spuštění souboru Coconut jako skriptu poskytuje Coconut příkaz

coconut-run

jako alias pro

coconut --run --quiet --target sys --argv

který se potichu zkompiluje a spustí `<source>`, předávajíc skriptu jakýkoliv dodatečný argument, napodobujíc tak práci příkazu pythonu.

`coconut-run` může být použit v řádku s shebangem Unixu pro vytvoření skriptu Coconut přidáním následujícího řádku na začátek skriptu:
```bash
#!/usr/bin/env coconut-run

Názvy zdrojových souborů¶

Zdrojové soubory používají extenze .coco (upřednostněno), .coc nebo .coconut. Soubor .coco (či .coc/.coconut) je kompilován do souboru s příponou .py. Je-li požadována jiná extenze než .py, například .pyde pro Python Processing, může být vložena před .coco a tato složená extenze bude použita místo .py. Například, name.coco bude kompilovat na name.py, zatímco name.pyde.coco bude kompilovat na name.pyde.

Kompilační režimy¶

Soubory, kompilované konzolou coconut se mohou lišit v závislosti na kompilačních parametrech. Je-li kompilována celá složka souborů (ve které bude kompilátor rekurzivně vyhledávat soubory s extenzí .coco, .coc nebo .coconut), vytvoří se soubor __coconut__.py, pro ukládání nezbytných funkcí (package mode), zatímco při kompilaci jediného souboru se nezbytné informace ukládají v záhlaví uvnitř souboru (standalone mode). Standalone mode je lepší pro jednotlivé soubory, protože se obejde bez nadbytečného importování __coconut__.py, avšak package mode je lepší pro velké pakety, protože se nemusí v každém souboru spouštět kód v záhlaví, jelikož může být jednoduše importován z __coconut__.py.

Je-li zdrojovým argumentem pro CLI konzolu soubor, provede se implicitně samostatná kompilace, zatímco je-li jím složka, provede se rekurzivní vyhledávání všech souborů .coco (nebo .coc či .coconut), pro něž se provede paketová kompilace. Coconut takto ve většině provede správnou volbu režimů. Je-li však důležité aby se nevytvářely žádné dodatečné soubory jako např. __coconut__.py, potom lze přinutit CLI konzolu aby použila určený režim použitím flagů --package (-p) a --standalone (-a).

Kompatibilní verze Pythonu¶

Protože je skladba Coconut založena na Python3, měl by kód Coconut, kompilovaný kompilátorem Coconut v univerzálním režimu (implicitní --target) běžet v libovolné verzi Pythonu >= 2.6 nebo >= 3.2.

Poznámka: Vyzkoušené implementace jsou CPython 2.6, 2.7, 3.2, 3.3, 3.4, 3.5, 3.6 a PyPy 2.7, 3.2.

Aby byly nativní objekty (built-ins) Coconut univerzálně přístupné pro různé verze Pythonu, přepisuje Coconut automaticky built-iny Pythonu 2 na příslušné protějšky Pythonu3. Navíc, Coconut také přepisuje některé built-iny Pythonu3 z optimalizačních důvodů. Je-li žádán přístup k původním verzím přepsaných built-inů, lze je získat s použitím prefixu py_.

Pro kompatibilitu se standardní knihovnou mapuje Coconut automaticky importy pod názvy Python3 s importy pod názvy Python2. Takto se Coconut automaticky postará o všechny moduly standardní knihovny, které byly přejmenovány z Python2 na Python3, pokud je použit pouze Python3. Ovšem, pro moduly nebo objekty, které existují pouze v Python3, neumí Coconut kompatibilitu zajistit.

Konečně, zatímco se Coconut pokusí kompilovat skladbu Python3 na jeho univerzální ekvivalent, následující konstrukty nemají žádný ekvivalent v Python2 a vyžadují specifikaci alespoň 3 před svým použitím:

• destructuring assignment with *s (use Coconut pattern-matching instead),
• the nonlocal keyword,
• exec used in a context where it must be a function,
• keyword class definition,
• tuples and lists with * unpacking or dicts with ** unpacking (requires --target 3.5),
• @ as matrix multiplication (requires --target 3.5),
• async and await statements (requires --target 3.5), and
• formatting f strings by prefixing them with f(requires --target 3.6).

Přípustné cíle¶

Je-li verze Pythonu, v níž bude kompilovaný kód běžet, známa předem, měl by být cíl určen flagem --target. Daný cíl (target) ovlivní pouze kompilovaný kód a zda je určitá syntaxe Pythonu3 (viz výše) povolena. Tam, kde se standardy skladeb pro Python3 a Python2 liší, bude skladba Coconut vždy používat skladbu Python3 pro všechny cíle. Podporované cíle jsou:

• universal (default) (will work on any of the below),
• 2, 2.6 (will work on any Python >= 2.6 but < 3),
• 2.7 (will work on any Python >= 2.7 but < 3),
• 3, 32 (will work on any Python >= 3.2),
• 3.3, 34 (will work on any Python >= 3.3),
• 3.5 (will work on any Python >= 3.5),
• 3.6 (will work on any Python >= 3.6),
• sys (chooses the specific target corresponding to the current version).

Note: Tečky jsou ve specifikacích cíle ignorovány, takže cíl 2.7 je ekvivalentní cíli 27.

Režim strict¶

Je-li povolen flag --strict (or -s), ohlásí Coconut chyby pro různé problémy stylu. Jsou jimi

• mixing of tabs and spaces (without --strict will show a Warning),
• use of from __future__ imports (without --strict will show a Warning)
• missing new line at end of file ),
• trailing whitespace at end of lines,
• semicolons at end of lines,
• use of the Python-style lambda statement,
• inheriting from object in classes (Coconut does this automatically)
• use of u to denote Unicode strings (all Coconut strings aru Unicode strings)
• use of backslash continuations (use [parenthetical continuation](# pokracovani-v-zavorkach) instead).

Navíc, --strict zneplatňuje (disables) zavrhnuté vlastnosti, činíce je zcela nedostupnými při kompilaci s flagem --strict. Doporučuje se při práci na novém projektu používat flag --strict (nebo -s) protože vám bude nápomocen při psaní čistšího kódu.

Zvýraznění syntaxe¶

Textové editory, které podporují zvýraznění syntaxe Coconut, jsou tyto:

• SublimeText: Viz sekci SublimeText níže.
• Vim: Viz coconut.vim.
• Emacs: Viz coconut-mode.
• Atom: Viz language-coconut.
• Každý editor, který podporuje Pygments (např. Spyder): Viz sekci Pygments níže.

Případně, pokud žádný z výše uvedený editorů vám nevyhovuje, můžete v Coconut pracovat jako v Pythonu. Jednoduše nastavte svůj editor tak, aby interpretoval všechny souboury .coco jako soubory Pythonu, čímž by mělo být zvýraznění vašeho kódu vyhovující.

highlight_language = "coconut"

Podpora pro IPython Jupyter¶

Dáváte-li přednost prostředí IPython (jádro Pythonu pro framework Jupyter ) před normální konzolou Pythonu, lze použít Coconut jako extenzi IPythonu nebo jádro Jupyteru.

Integrace s MyPy¶

Coconut se umí integrovat s MyPy za účelem optimální statické kontroly typů, včetně všech vestavěných nástrojů Coconut. Jednoduše zadejte --mypy abyste umožnili integraci s MyPy, ale dejte si pozor abyste to zadali jako poslední argument, protože všechny argumenty po --mypy jsou poslány do mypy, nikoliv do Coconut.

_Note: Protože optimalizace koncového volání vylučuje řádnou typovou kontrolu, --mypy ji implicitně vypíná.

Pro explicitní typovou kontrolu kódu v MyPy podporuje Coconut anotace typu funkcí v Python 3, anotace typu proměnných v Python 3.6 a dokonce vlastní vylepšenou skladbu anotace typů. Implicintě jsou všechny anotace typu kompilovány na signaturu typu, kompatibilní s Python 2, což znamená že všechny anotace chodí ve všech verzích Pythonu.

Coconut dokonce podporuje --mypy v interpretu, který inteligentně skenuje každý nový řádek kódu, číhaje na nově zavedené chyby MyPy. Na příklad:

Coconut dokonce podporuje --mypy v překladači, jenž skenuje inteligentně každý nový řádek kódu v kontextu s předchozím řádkem zda neobjeví nově zavedené chyby MyPy. Na příklad:

>>> a: str = count()[0]
<string>:14: error: Incompatible types in assignment (expression has type "int", variable has type "str")

:Note: Někdy si MyPy nebude vědět rady s jistými konstrukty Coconut, např. s adaptern. V tom případě jednoduše zadejte # type: ignore na řádek Coconut, na jehož kompilaci si MyPy stěžuje (o který řádek se jedná, zjistíte použitím flagu --line-numbers).

Lambdy¶

Coconut poskytuje jednoduchý, čistý operátor -> jako alternativu k příkazu lambda v Pythonu. Skladba s operátorem -> je (parameters) -> expression (nebo parameter -> expression pro lambdy s jedním argumentem). Operátor má stejné pořadí důležitosti jako starý příkaz, což znamená, že bude často nezbytné uzavřít lambdu do závorek a je asociativní vpravo.

Navíc, Coconut také podporuje implicitní použití operátoru -> ve formě (-> expression), jež je ekvivalentní k ((_=None) -> expression), což umožňuje použití implicitní lambdy když nejsou vyžadovány žádné argumenty nebo když je vyžadován jen jeden argument (vyjádřený znakem _).

Note: Je-li normální skladba lambdy nedostatečná, Coconut také podporuje rozšířenou skladbu lambdy ve formě příkazu lambda.

def <lambda>(arguments):
    return expression

dubsums = map((x, y) -> 2*(x+y), range(0, 10), range(10, 20))
dubsums |> list |> print

dubsums = map(lambda x, y: 2*(x+y), range(0, 10), range(10, 20))
print(list(dubsums))

Částečná aplikace¶

Coconut používá znak $ hned za názvem funkce, však před závorkou, použitou k volání funkce.

Částečná aplikace Coconutu také podporuje použití ? a by se přeskočilo částečné použití argumentu, odkládajíc použití tohoto argumentu až na volání částečtě aplikované funkce. To je důležité, chcete-li částečně aplikovat argumenty, které nejsou první v pořadí argumentů.

def partial(func, *args, **keywords):
    def newfunc(*fargs, **fkeywords):
        newkeywords = keywords.copy()
        newkeywords.update(fkeywords)
        return func(*(args + fargs), **newkeywords)
    newfunc.func = func
    newfunc.args = args
    newfunc.keywords = keywords
    return newfunc

expnums = range(5) |> map$(pow$(?, 2))
expnums |> list |> print

# unlike this simple lambda, $ produces a pickleable object
expnums = map(lambda x: pow(x, 2), range(5))
print(list(expnums))

Spojovník (pipeline)¶

Coconut používá spojovníky (|) pro usměrnění průběhu aplikace funkcí. Všechny operátory mají precedenci infixových evokací a jsou levostranně asociativní. Všechny operátory také podporují 'in-place versions'. Těmito operátory jsou:

(|>)    => pipe forward
(|*>)   => multiple-argument pipe forward
(<|)    => pipe backward
(<*|)   => multiple-argument pipe backward

Navíc, všechny spojovníkové operátory podporují lambdu jako poslední argument, přesto že má lambda nižší precedenci. Takže, a |> x -> b |> c je ekvivalentní s a |> (x -> b |> c), nikoliv s a |> (x -> b) |> c.

Note: Pro vizuální rozložení operací přes několik řádek použijte parenthetical continuation.

obj |> .attribute |> .method(args) |> func$(args) |> .[index]

func(args, obj.attribute.method(args))[index]

def sq(x) = x**2
(1, 2) |*> (+) |> sq |> print

import operator
def sq(x): return x**2
print(sq(operator.add(1, 2)))

Skladba funkcí¶

Coconut má tři základní operátory pro skladbu funkcí: .., ..> a <... Jak .., tak <.. používají "zpětnou" skladbu funkcí, kdy je první funkce volána jako poslední, zatímco ..> používá "dopřednou" skladbu funkcí, kde je první funkce volaná jako první.

Spojovníkové operátory ..> a <.. mají také formu ..*> a <*.., která je ekvivalentní k operátorům |*> a <*|. Zpětné a dopředné spojovníkové operátory nemohou být použitý společně v jednom výrazu (na rozdíl od normálních spojovníků) a jeich precedence je mezi spojovníkem None a normálním spojovníkem.

Operátor .. má nižší precedenci než přístup k atributu (.), slicing ([]), atd, kromě volání funkce, vůči níž má precedenci vyšší. Takže je a.b..c.d ekvivalentní k (a.b)..(c.d), zatímco f..g(x) je ekvivalentní k (f.g)(x).

'In-place' operátory pro skladbu funkcí jsou ..=, ..>=, <..=, ..*>= a <*..=.

fog = f..g
f_into_g = f ..> g

# unlike this simple lambda, Coconut produces a pickleable object
fog = lambda *args, **kwargs: f(g(*args, **kwargs))
f_into_g = lambda *args, **kwargs: g(f(*args, **kwargs))

Řetězení¶

Coconut používá operátor :: pro řetězení iterátoru. Toto řetězení je prováděno líně - to jest tak, že argumenty se nevyhodnocují, pokud jich není zapotřebí. Tato forma má precedenci 'in-between bitwise or and infix calls'. 'In-place' operátorem je ::=.

def chain(*iterables):
    # chain('ABC', 'DEF') --> A B C D E F
    for it in iterables:
        for element in it:
            yield element

def N(n=0) = (n,) :: N(n+1) # no infinite loop because :: is lazy

(range(-10, 0) :: N())$[5:15] |> list |> print

Krájení (slicing) iterátoru¶

K provedení iterátorového členění používá Coconut znak $ mezi iterátorem a označením jeho úseku. Iterátorové členění pracuje stejně jako sekvenční členění v Pythonu a vypadá stejně jako částečná aplikace, avšak s hranatymi místo kulatých závorek.

Iterátorové členění pracuje stejně jako sekvenční členění, včetně podpory negativních indexů a úseků (slices) a podpory pro objekty úseků stejně jako u normálního členění. Iterátorové členění však nezaručuje, že bude zachován původní iterátor (pro jeho zachování použijte funkcitee nebo reiterable).