Dotaz: Shell interface pro komunikaci client-server v Pythonu

[tomes.io]

Ahoj,

dostali jsme ve skole ukol napsat interface pro komunikaci client -server. Tento interface je volan z jine ho souboru. ma z ukol (aspon jak jsem to pochopil) nacist vstup od uzivatele jako klient, ten poslat serveru, ktery vraci zpravu.

Dostali jsme na to nasledujici sablonu:

#!/usr/bin/python

#http://www.networksorcery.com/enp/protocol/irc.htm
import re
import socket
import getpass

class IRCBotInterface(object):
    """Generic interface for working with IRC messages."""

    def read(self):
        raise NotImplemented

    def write(self, msg):
        raise NotImplemented

    def open(self):
        raise NotImplemented

    def close(self):
        raise NotImplemented


class IRCBotShellInterface(IRCBotInterface):

    def __init__(self):
        pass

    def read(self):
        return raw_input("> ")

    def write(self, msg):
        print msg

    def open(self):
        pass

    def close(self):
        pass


class IRCBotTelnetInterface(IRCBotInterface):
    def __init__(self, address = None, port = 8080):
        self._timeout = 60 * 10
        self._listen = None
        self._sfile = None
        self._socket = None

        self._addr = address
        self._port = port

    def client(self):
        return self._sfile

    def disconnected(self):
        self._socket = None
        self._sfile = None

    def read(self):
        pass

    def write(self, msg):
        pass

    def open(self):
        pass

        if self._listen == None:
            raise Exception("No valid address found")

    def close(self):
        pass
 
if __name__ == "__main__":
    x = IRCBotTelnetInterface("::1", 8082)
    x.open()

    while True:
        data = x.read()
        if data == "":
            break

        print "Received:", data
        x.write(data)

Se samotnym sitovym programovanim az takovy problem nemam, ale moc nechapu jak naimplementovat to rozhrani pro komunikaci (shell).

Nevim, k cemu jsou zapotrebi dve tridy IRCBotInterface(object) a IRCBotShellInterface(IRCBotInterface). Je mi jasny, ze IRCBotShellInterface(IRCBotInterface) dedi predchozi tridu IRCBotInterface, jennevim proc.Premyslim, v cem se maji jejich metody lisit. Nejsem zbehly v OOP, vlastne zacinam, takze mi asi neco podstatnyho nedochazi. Ma snad prvni trida byt I/O rozhrani a druha trida rozhrani pro komunikaci se servrem? Ale co potom fce open a close?

As jsem spravne pochopil, ze perace otevreni socketu ma delat fce open. V cem se maji v jednotlivych tridach ale lisit?

Mohl bych pozadat o nejake nakopnuti? Vubec nevim, od ceho se mam odpichnout.

Moc instrukci jsme k ukolu nedostali a me moc nedochazi, jakym zpusobem to rozhrani ma fungovat.

---

---

Odpovědi

[tomes.io]

jen pro upresneni, nechci, aby mi nekdo radil jak kterou fci presne implementovat. spis potrebuji vysvetlit princip, jak by to na zaklade vyse uvedene sablony mohlo fungovat. nejaky algoritmus.

[NN]

Ja hlavne nechapu proc definovat novou tridu kdyz metody mam importovane a muzu je volat primo. Potom jednoduchy echo server vypada takto:

#!/usr/bin/env python 
import socket 

host = '' 
port = 50000 
backlog = 5 
size = 1024 
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 
s.bind((host,port)) 
s.listen(backlog) 
while 1: 
    client, address = s.accept() 
    data = client.recv(size) 
    if data: 
        client.send(data) 
    client.close() 

[mike]

IRCBotInterface, jak docstring rika, je abstraktni trida (interface). IRCBotShellInterface a IRCBotTelnetInterface jsou uz konkretni implementace tohoto interfacu.

[rADOn]

Me to pripada ze hlavni ukol tridy IRCBotInterface je udelat nekomu hezkej vlhkej pocit ze programuje v Jave. Takto je to Abstraktni Trida, coz je ve statickych jazycich zpusob jak popsat rozhrani a vynutit jeho implementaci. Tady mas dve tridy ktere implementuji irc pres prikazovou radku a pres tcp port. Abstraktni bazova trida rika kompileru ze jeji potomoci maji mit urcite metody a atributy. Pokud ne, kompiler te zjebe. Pokud ano, nejaka jina komponenta muze dostat referenci na "nejaky irc objekt" a mit jistotu ze kdyz zavola metodu read() tak dostane neco zpet, pritom nemusi resit jestli ten objekt v realu komunikuje pres radku nebo po tcp.

Drobna vada ktera to kazi je ze python neni kompilovany jazyk takze cely tenhle koncept tu valne postrada smyslu. Coz je videt z toho, ze autor prasacky simuluje jebani (statickou kontrolu) v kompileru rucne napsanymi vyjimkami. Python pouziva "kvakaci" pristup k tvorbe API (a k identite objektu obecne). Tohle neni ani tak ukazka jak delat API, jako spis ukazka proc by javisti nemeli strkat nos do veci kterym nerozumi

[mike]

Nejsem javista a javu v tomto fakt nevidim :). Tento pristup v pythonu mi prijde normalni. Mam base class, ktera muze plne implementovat nejake metody a nektere metody "implementovat" prazdne. Odvozena trida ma k dispozici vsechny metody base tridy a nektere si muze redefinovat.

Tak nam rekni ten zarucene nejspravnejsi pythonisticky pristup?

[rADOn]

…nektere si muze redefinovat

To co popisujes je proste dedeni a ne abstraktni predek. "Abstraktni" trida se tak jmenuje proto ze fyzicky nemuze existovat - kdyz se ji pokusis instanciovat tak te kompiler vyfakuje. Metody mit teoreticky muze, prakticky to ale vetsinou nema smysl a treba javovske interfacy to ani nedovoluji.

Pythonisticky pristup je duck-typing neboli "kdyz to kvaka jako kacena, tak to asi bude kacena" a mas ho v ruce pokazde kdyz zavolas open . Ve standartni knihovne je spousta kodu ktery pracuje se "souborovym" objektem, aniz by existovalo nejake pevne dane api nerkuli interface/abstraktni predek. Proste pokud ma neco metodu read(), je to citelny "soubor". Pokud ma write(), je zapisovatelny. Desne slozity tohleto

BTW nechci aby to vyznelo ze je definice api pomoci abstraktni tridy spatna. Proste to jen nedava smysl v jazyce ktery nema nema zadnou kompilacni fazi. Coz je v priklade vyse dobre patrne, jedine ceho ta uzasna bazova trida dosahuje je ze z nedostatecne implementace budou za behu (!) misto AtrributeErroru padat NotImplemented vyjimky.

(Ve standartni knihovne je i modul abc na tvorbu abstraktnich trid, ale to je nedavny pridavek zamerenyna ruzne zajimavejsi pripady, vetsinou kolem kontroly dynamicky tvoreneho nebo natahovaneho kodu. Predpokladam ze autor vyse uvedeneho kodu se mu vyhnul aby nematl studentum hlavy jeste navic metatridami a dekoratory)

[l4m4]

Metody mit teoreticky muze, prakticky to ale vetsinou nema smysl a treba javovske interfacy to ani nedovoluji.

Kdes' toto vzal? Abstraktní třídy s metodami i datovými členy jsou běžné, mají smysl a není na nich nic špatného.

Interface je něco jiného než abstraktní třída; existuje normálně pouze ve statických objektových systémech bez vícenásobné dědičnosti, kterou supluje.

[tomes.io]

Zajimalo by me, co s tema not implemented vyjimkama? nebylo by jednodussi to v te abstraktni tride zmenit na

pass

?

[tomes.io]

Hmmm tak pokud to zmenim na pass tak funkce jako read() se ve tride IRCBotSHellInterface vubec neprovedou. vubec se tam nedostanou.

Vygooglil jsem si, ze by asi bylo lepsi tam NotImplemented nechat s tim, ze je prepisuje "potomek" te abstraktni tridy.

Jenze muj pokus selhal, zksil jsem to v "dedicne" tride takto:

class IRCBotInterface(object):
    """Generic interface for working with IRC messages."""


    def read(self):
        raise NotImplemented

#########dalsi metody##########


class IRCBotShellInterface(IRCBotInterface):

    
	
    def __init__(self):
        pass

    def read(self):
        
        try:
            super().read(self)
        except NotImplementedError:
            pass        
        
        return raw_input("> ")
        

Ale pri spusteni mi to nadava porad:

raise NotImplemented
TypeError: exceptions must be old-style classes or derived from BaseException, not NotImplementedType

Nevite nekdo co s tim?

[tomes.io]

Mno tak jsem to obesel tim, ze jsem rovnou volal IRCBotShellInterface, ale nevim, zda jsem tim problem vyresil. ono je to slozitejsi, radeji zalozim novy vlakno

[Michal Vyskočil]

Tady je Python trochu záludný. Jde o to, že NotImplemented je hodnota typu NotImplementedType, která se dá vracet třeba return, ale ne vyhazovat jako vyjímka. Ta se totiž jmenuje NotImplementedError. Mimochodem, vracet lze i vyjímka a je to naprosto korektní obrat.

>>> def foo(): return NotImplemented
>>> x = foo
>>> x == None
False
>>> x == NotImplemented
True
>>> def bar(): raise NotImplementedError()
>>> y = bar()
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<stdin>", line 1, in bar
NotImplementedError
>>> def ham(): return NotImplementedError
>>> z = ham()
>>> z == NotImplemented
False
>>> z == NotImplementedError
True
>>> raise z('aaa')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
NotImplementedError: aaa

[rADOn]

Zrovna na to koukám… jsem se nehezky unáhlil a kecal pěkný kraviny, NotImplemented je něco dost jiného než NotImplementedError. Ale vzhledem k tomu že se to tam snaží střílet jako výjimku se zřejmě stejně spletl i autor predmětného kódu a má tam být NotImplementedError.

[rADOn]

Zajimalo by me, co s tema not implemented vyjimkama? nebylo by jednodussi to v te abstraktni tride zmenit na

pass ?

Předpokládám že ve skutečnosti tam má být NotImplementedError , viz níže. Česky ta výjimka znamená "vole, zapoměl jsi implementovat tuhle metodu, koukej ji dodělat. šupem.". To je právě ten jemný rozdíl mezi abstraktní třídou která popisuje rozhraní, a nějakou tvojí třídou která to rozhraní skutečně implementuje. Ve staticky kompilovaném jazyce prostě jen napíšeš jméno metody a označíš jí jako abstraktní a kompiler to bere tak že nějaký potomek tu metodu přetíží a dodá potřebnou funkčnost. Čili v hotovým kódu taková metoda fakticky neexistuje, je to jen dodatečná informace pro kompiler aby tě zjebal když na to při psaní potomka zapomeneš.

Jenže. V pythonu není žádná "kompilace" takže není (jednoduchý) způsob jak něco takového vynutit. Takže se to hákuje tak že se udělá skutečná, existující metoda, ale implementace uvnitř je jen pahýl který vždy vystřelí výjimku. Může to být jakákoliv výjimka, ale je taková praxe že se střílí NotImplementedError. Drobný, ale zásadní rozdíl je, že ta výjimka vystřelí až v okamžiku kdy ten kód běží. Když by ta zapomenutá metoda byla v nějaké nepoužívané větvi kódu tak na to vůbec nemusíš přijít, což tak nějak popírá důvod proč se s tím vůbec matlat.

[tomes.io]

No, me by vubec nenapadlo, ze by mel Python mit abstraktni tridy, ale evidentne je to tak :) Potom to uz dava smysl. No, mohli nam dat mene slozite API, ale treba to bude mit v budoucnu v tom skolnim projektu treba smysl jeste, kdovi :)

[tomes.io]

Akorat by me jeste zajimalo, jak na zaklade toho vyse uvedeneho API komunikovat. Tedy jak predat clientskemu socketu zpravu z toho ShellInterface?