Cron descriptor

19.1.2016 19:13 | Přečteno: 1960× | | poslední úprava: 19.1.2016 22:30

Pro jeden Pythoní projekt na kterém pracuji jsem potřeboval převést CRONový zápis (12 9 * * *) na "human readable" string, zde se chci podělit o výsledek.

Po chvilce hledání na google jsem zjistil že nic takového pro Python neexistuje (nebo je projekt ve velmi raném/nepoužitelném stádiu). Po prvních pokusech a zjištění ze to kvůli hromadě vyjímek nebude jen pár řádek kódu, mě napadlo že bych se mohl podívat zda li tohle již někdo neřešil pro jiné jazyky. Nakonec jsem narazil na celkem slušnou .NET implementaci (Rozluštění záhady proč někdo tvoří parser na UNIXový CRON v .NETu necháme pro Akta X) kterou jsem se rozhodl naportovat do Pythonu (+ pár menších vylepšení).

Co to umí ?

• Podpora všech CRON výrazů včetně speciálních znaků * / , - ? L W, #
• Podpora 5, 6 (se sekundou nebo rokem), nebo 7 (se sekundou a rokem) částí CRON výrazu
• Podpora 13 jazyků
• Podpora Pythonu 2.7 - 3.4

Instalace

cron-descriptor je dostupný skrze pip:
(pokud zde mate velke bile misto, tak pokracovani je nize pod pravym sidebarem... nevim jak tento bug z me strany opravit)

pip install cron-descriptor

Příklad použití

from cron_descriptor import Options, CasingTypeEnum, DescriptionTypeEnum, ExpressionDescriptor

# Jednoduše
print(ExpressionDescriptor("*/10 * * * *"))

# Pokročilé nastavení (viz Options.py)
descripter = ExpressionDescriptor("*/10 * * * *", throw_exception_on_parse_error = True, casing_type = CasingTypeEnum.Sentence, use_24hour_time_format = True)
# get_description uses DescriptionTypeEnum.FULL by default:
print(descripter.get_description())
# Nebo
print("{}".format(descripter))

Příklad výstupu en_US

# 24 hodinový formát
17 * * * * -> At 17 minutes past the hour
25 6 * * * -> At 06:25
47 6 * * 7 -> At 06:47, only on Saturday
52 6 1 * * -> At 06:52, on day 1 of the month
# 12 hodinový formát
17 * * * * -> At 17 minutes past the hour
25 6 * * * -> At 06:25 AM
47 6 * * 7 -> At 06:47 AM, only on Saturday
52 6 1 * * -> At 06:52 AM, on day 1 of the month

Výsledek najdete na:

https://github.com/Salamek/cron-descriptor
PR's jsou vítány

       

Komentáře

[smazáno]

Hezky. Pristup prepsat existujici implementaci v jinem jazyce je urcite mnohem lepsi nez zacinat od nuly.

Btw. trochu si se tim .NET nechal unest a zustal ti tam CamelCase ;).

[Salamek]

snake_style je vice mene doporucen pro Python (variable/method names) ale dokud na me kvuli tomu nekvici PEP8...
Navic se to da prevest konverznim scriptem tam a naspatek, nevidim v tom nejaky extremni problem... ale asi to jeste udelam... Pythonazi jsou na tohle haklivi jak kocka na vodu

[kyknos]

hloupost, moje kocka miluje vodu :) jako spousta mainek

[Salamek]

Jo moje taky, ale uz je to takovy vseobecne uznavany FUD

[Salamek]

Ok, predelano tak aby prosel pep8-naming

[Divný host]

Pristup prepsat existujici implementaci v jinem jazyce je urcite mnohem lepsi nez zacinat od nuly.

Ale je to menší zábava (respekt autorovi).

[Halis]

Podpora Pythonu 2.7-3.4

Jak je toho dosaženo? Dle zdrojaku mám dojem, že se prostě nepoužívá žádná kolizní syntaxe. Jak se to dá řešit?

[Bystroushaak]

Většina pythonu je nekolizní. Některé věci taky řeší from future import ..

[Salamek]

Neni tam pouzita zadna kolizni syntaxe, presne tak

[chrono]

Gettext je na preklad takýchto textov viac-menej nepoužiteľný. :)

[pavlix]

Důvod?

[Josef Kufner]

Celá třída ExpressionDescriptor je názorná ukázka toho, jak lokalizaci nedělat. Důvod je prostý, ve všech jazycích to bude mít anglický slovosled.

Navíc pokud budeš mít stejné slovo použité v jiném kontextu jinde v aplikaci, tak to ani nebude dávat smysl. Například takové:

#: ExpressionDescriptor.py:218
#, python-brace-format
msgid "at {0}"
msgstr "v {0}"

Pokud by stejným stylem bylo udělaných vět více, může být v některých použita špatná předložka. Letmý pohled do slovníku rychle ukáže, kolik možností překladu podle kontextu se nabízí – úryvek ze slovnik.cz:

at - k
at - na (místo, čas, stav, pohyb, cíl)
at - po (cena, množství, např.o ceně k)s
at - v (místo, čas, stav)
at - z
at - u (těsně)
at - o (čas, stav)
at - při (čas, stav, činnost)
at - za (čas, stav)
at - alespoň
at - jak budete mít čas
at - jak to je
at - ke
at - těsně u (2. p.)
at - ve

Správný přístup je mít jeden řetězec s celou větou se zástupnými symboly a tu přeložit. Nikoliv slepovat krátké samostatně překládané řetězce do věty s anglickým slovosledem.

Naneštěstí v tomto případě to je tak trochu pointa celého toho programu. Dalo by se to zlepšit použitím delších fragmentů, ale ani to ideální nebude. Proto například Osmand má hlasovou navigaci implementovanou v Prologu a každý jazyk má vlastní pravidla, jak skládat věty pro různá oznámení. Pak můžeš mít správně slovosled podle daného jazyka, ale i skloňování, časování a další vymoženosti.

[pavlix]

Na to jsem se ale neptal. Ptal jsem se na důvod, proč je Gettext pro daný účel nepoužitelný. Chápu, že skládání vět není jeho doménou, ale na první pohled z toho kódu není vidět, že by zrovna tento program potřeboval nějaké komplexnější skládání. Proto mě zajímalo nějaké vodítko, jestli je ten „výkřik do tmy“ založený na nějakých konkrétních argumentech nebo příkladech.

[chrono]

Práve preto, že nie všetky jazyky využívajú anglický slovosled. Tiež nemajú len dva tvary pre jednotné a množné číslo, ale to sa dá opraviť aj s použitím gettext. Ďalší problém je s vyjadrením radových čísloviek, takže teraz to vypisuje niečo ako "on day 1, 5, and 6 of the month".

Nedávno som niečo podobné robil pre recurrence rule a podobných problémov je tam dosť veľa a časť z nich je rovnaká pre všetky projekty ktoré vyjadrujú čas/dátum v ľudsky zrozumiteľnom tvare (ak má ísť naozaj o tvar, ktorému majú bez problémov rozumieť ľudia).

[pavlix]

Nedávno som niečo podobné robil pre recurrence rule a podobných problémov je tam dosť veľa a časť z nich je rovnaká pre všetky projekty ktoré vyjadrujú čas/dátum v ľudsky zrozumiteľnom tvare (ak má ísť naozaj o tvar, ktorému majú bez problémov rozumieť ľudia).

Vždycky když něco takového čtu, tak si říkám, že asi nejsem člověk. Nejlépe se mi používá tvar, který víceméně standardizuje ISO. Všechno vyjádřeno číselně. Všechna čísla doplněná zleva nulami do jednotného zarovnání. Všechna čísla seřazena podle váhy od největší po nejmenší. Paradoxně je takový způsob ze všech řetězcových zápisů nejvýhodnější i pro počítač.

[chrono]

To "on day 1 of the month", s prižmúrením očí, dáva v angličtine zmysel, ale český preklad "v 1 den v měsíci" má iný význam.

PS: A len tak pre zaujímavosť, ako by vyzeralo vyjadrenie crontab v "ISO" formáte (a prípadne aj s príkladom pre recurrence rule).

[pavlix]

To "on day 1 of the month", s prižmúrením očí, dáva v angličtine zmysel, ale český preklad "v 1 den v měsíci" má iný význam.

To bude asi reakce na úplně jiný komentář.

PS: A len tak pre zaujímavosť, ako by vyzeralo vyjadrenie crontab v "ISO" formáte (a prípadne aj s príkladom pre recurrence rule).

Oni definují formát data a času. Musel bys tam doplnit nějaké ty zápisy s crontab. Já osobně nemám problém používat crontab zápis tak jak je, bez nějakých přepisů.

[smazáno]

Tam by to fakt chtelo predelat na "v 1. den v měsíci"

[Petr]

No a proto gettext nabízí možnost doplnit kontext u stejných řetězců, které se pak překládají jinak.

[Salamek]

Pro zatim je to dostacujici, je treba aby BFU pochopil onen text, ne aby prosel pres Grammarnazzi

[smazáno]

Jojo, s timto urcite nema cenu se babrat dokud nebude potreba.

[chrono]

Mohlo sa aspoň použiť ngettext, aby aspoň tvary pre množné čísla vyzerali rozumne (a nie ako teraz: každých 2 sekund).

[Salamek]

Je tam 13! prekladu ktere jsem natahnul importnim scriptem z puvodni implementace, kdyz to jakkoliv predelam tak ztratim vsechny preklady krome anglictiny a cestiny, dale jsou tam unitesty kontrolujici validitu vystupniho stringu EN ktere bych musel take predelat... jsou to TUNY zbytecne ("detaily") prace pro kterou ted nemam prostor... mozna by sel implementovat ngettext bez rozbyti cehokoliv ale ted to proste nestoji za to...
Samozrejme je to OSS, pokud se na to citis, udelej fork a dodelej to tam, s radosti prijmu tvuj PR

[Bystroushaak]

Budu trochu hnidopich a vypíšu pár myšlenek, které mě napadají, když čtu ten zdroják. Rozhodně to nemyslím jako kritiku, jen jako návrhy k vylepšení dobrého projektu.

"""
 Converts a Cron Expression into a human readable string
"""


class ExpressionDescriptor(object):
    m_special_characters = ['/', '-', ',', '*']
    m_expression = ''
    m_options = None
    m_expression_parts = []
    m_parsed = False

Proč jsi použil tyhle divné docstringy? V pythonu bývá zvykem používat jako docstring první řetězec v těle funkce. Ty používáš všechny před tělem funkce. Nápověda tak nefunguje:

bystrousak:~/Plocha/cron-descriptor,0$ python
Python 2.7.6 (default, Jun 22 2015, 17:58:13) 
[GCC 4.8.2] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from cron_descriptor.ExpressionDescriptor import ExpressionDescriptor
>>> help(ExpressionDescriptor)

Help on class ExpressionDescriptor in module cron_descriptor.ExpressionDescriptor:

class ExpressionDescriptor(__builtin__.object)
 |  Methods defined here:
 |  
 |  __init__(self, expression, options=None, **kwargs)
 |  
 |  __repr__(self)
 |  
 |  __str__(self)
 |  
 |  format_time(self, hour_expression, minute_expression, second_expression='')
 |  
 |  get_day_of_month_description(self)
 |  
 |  get_day_of_week_description(self)
 |  
 |  get_description(self, type=1)
 |  
 |  get_full_description(self)
 |  
 |  get_hours_description(self)

Správně by to mělo vypadat takhle:

class ExpressionDescriptor(object):
    """
    Converts a Cron Expression into a human readable string
    """

    m_special_characters = ['/', '-', ',', '*']
    m_expression = ''
    m_options = None
    m_expression_parts = []
    m_parsed = False

Což pak v help()u vypadá:

Help on class ExpressionDescriptor in module cron_descriptor.ExpressionDescriptor:

class ExpressionDescriptor(__builtin__.object)
 |  Converts a Cron Expression into a human readable string
 |  
 |  Methods defined here:

Nejde o problém jen u interní funkce help(), ale i různých nápověd v IDE a generování dokumentace. Když už se s tou dokumentací píšeš, tak mi přijde docela škoda jí takhle „zahodit“.

Pak taky vidím, že používáš vlastní Enum:

class DescriptionTypeEnum(object):
    FULL = 1
    TIMEOFDAY = 2
    SECONDS = 3
    MINUTES = 4
    HOURS = 5
    DAYOFWEEK = 6
    MONTH = 7
    DAYOFMONTH = 8
    YEAR = 9

Což by pro budoucí úpravy bylo lepší zapsat spíš jako:

class DescriptionTypeEnum(object):
    _cnt = (x for x in range(100))
    FULL = next(_cnt)
    TIMEOFDAY = next(_cnt)
    SECONDS = next(_cnt)
    MINUTES = next(_cnt)
    HOURS = next(_cnt)
    DAYOFWEEK = next(_cnt)
    MONTH = next(_cnt)
    DAYOFMONTH = next(_cnt)
    YEAR = next(_cnt)

Není to sice nutnost, ale může ti to ušetřit nepříjemné bugy, protože se to stará o unikátnost hodnoty.

Potom tohle

            if type == DescriptionTypeEnum.FULL:
                description = self.get_full_description()
            elif type == DescriptionTypeEnum.TIMEOFDAY:
                description = self.get_time_of_day_description()
            elif type == DescriptionTypeEnum.HOURS:
                description = self.get_hours_description()
            elif type == DescriptionTypeEnum.MINUTES:
                description = self.get_minutes_description()
            elif type == DescriptionTypeEnum.SECONDS:
                description = self.get_seconds_description()
            elif type == DescriptionTypeEnum.DAYOFMONTH:
                description = self.get_day_of_month_description()
            elif type == DescriptionTypeEnum.MONTH:
                description = self.get_month_description()
            elif type == DescriptionTypeEnum.DAYOFWEEK:
                description = self.get_day_of_week_description()
            elif type == DescriptionTypeEnum.YEAR:
                description = self.get_year_description()
            else:
                description = self.get_seconds_description()

By bylo asi elegantněji zapsáno jako:

            choices = {
                DescriptionTypeEnum.FULL: self.get_full_description,
                DescriptionTypeEnum.TIMEOFDAY: self.get_time_of_day_description,
                DescriptionTypeEnum.HOURS: self.get_hours_description,
                Descrip
tionTypeEnum.MINUTES: self.get_minutes_description,
                DescriptionTypeEnum.SECONDS: self.get_seconds_description,
                DescriptionTypeEnum.DAYOFMONTH: self.get_day_of_month_description,
                DescriptionTypeEnum.MONTH: self.get_month_description,
                DescriptionTypeEnum.DAYOFWEEK: self.get_day_of_week_description,
                DescriptionTypeEnum.YEAR: self.get_year_description,
            }
            
            description = choices.get(type, self.get_seconds_description)()

Nehledě tedy na to, že si tím názvem proměnné shadowuješ interní funkci type().

for i in range(0, len(hour_parts)):

Range jede vždy od nuly. Sice to ničemu nevadí, ale ani to nic nepřidává.

if len(description) > 0:

Obecně všechny tyhle kontroly se dají přepsat na elegantnější

if description:

Tohle

        return self.get_segment_description(self.m_expression_parts[0],
                                            _("every second"),
                                            lambda s: s.zfill(2),
                                            lambda s: _(
                                            "every {0} seconds").format(s),
                                            lambda s: _(
                                            "seconds {0} through {1} past the minute"),
                                            lambda s: _("at {0} seconds past the minute"))

by asi vypadalo podstatně líp, kdybys to rozepsal takhle:

        return self.get_segment_description(
            self.m_expression_parts[0],
            _("every second"),
            lambda s: s.zfill(2),
            lambda s: _("every {0} seconds").format(s),
            lambda s: _("seconds {0} through {1} past the minute"),
            lambda s: _("at {0} seconds past the minute")
        )

Já vím, je to čistě otázka vkusu, ale fakt mi to přijde podstatně čitelnější a nemusíš pak zbytečně zalamovat ty výrazy, protože se ti nevešly na konec řádku.

Asi by se toho našlo víc, tohle mě napadlo jen tak v rychlosti.

[Radek Novacek]

Ješte bych doplnil, že místo:

for i in range(0, len(hour_parts)):
    ...
    hour_parts[i]
    ...

je lepší (pythoničtější) psát:

for i, hour_part in enumerate(hour_parts):
    ...
    hour_part
    ...

[Bystroushaak]

Mě to napadlo, ale byl jsem líný vzpomínat / znova otevírat soubor, jestli tam někde používá i samotnou hodnotu, nebo jen indexy. Ono těhle optimalizací bych tam našel víc, už samotná ta architektura je místy docela zbytečně rozobjektovaná, jak mají právě ve zvyku lidi z javy / C#.

[Salamek]

Tak jsem to jeste trochu poupravil, vicemene vse krome upravy Enum, tve reseni se mi moc nelibi a vice uprav tam asi stejne jen tak nebude... Python3 tohle resi a je i pip balicek pro 2.7 ale nechci pridavat dalsi zbytecnou zavyslost, takze to necham tak jak to je...

Jo a misto psani sem jsi mohl rovnou udelat fork a poslat PR

[Bystroushaak]

Jo a misto psani sem jsi mohl rovnou udelat fork a poslat PR

Nerad dělám stylistické pull requesty, protože nemusí být začleněny, protože se ti něco nemusí líbit. Pak je to kopa práce k ničemu. Tohle byly spíš rady, než že by šlo o něco podstatného.

[pavel]

Zrovna "Descriptor" je dost nešťastný název, neboť v kontextu pythonu je deskriptor třída, která implementuje metody __get__, __set__, __delete__.

Vhodnější by byl "Decoder".

[Salamek]

Wow to jsem si vubec neuvedomil, asi to jeste rychle prejmenuji dokud je cas...

[Odin1918]

Zajimave, libi se mi to. Ale marne si lamu hlavu nad use cases tohoto projektu. Cron resim jednou za rok a kdyz, tak mi nedela problem klasicky crontab zapis. Faktem je, ze s timto to bude asi pohodlnejsi, ale nevim, jestli nebudu liny poustet dalsi software.

[Salamek]

No use case je SW kde je treba konfigurovat cron nebo cron like zapis uzivateli kteri neovladaji cron syntaxi:

• V prehledu cronem spoustenych prikazu chteji videt kdy se dany prikaz spousti
• Overeni ze jimi zapsany cron se spousti tak jak si predstavovali

To se muze hodit napriklad:

• vsem webhosterum kteri umoznuji editovat crontab z weboveho rozhrani (a ted zobrazuji pouze cron zapis v prehledu)
• v aplikacich pro spravu serveru jako ISPmanager/ISPconfug, Webmin a podobne
• v aplikaci co ted tvorim :-P

[Dreit]

Já se v takových případech zeptám Googlu, jsou stránky kde není problém naklikat si chování a vyplivne to zápis pro CRON. Nevím ale jistě jestli to jde i obráceně, tedy vložit a nechat si vypsat co se bude dít

[Salamek]

No k tomu druhemu slouzi tenhle projekt

[Petr Tomášek]

Nebylo by jednodušší si přečíst dokumentaci?

[Josef Kufner]

To naráží na základní problém. Uživatelé neumí číst.

[Salamek]

A nebylo by lepsi kdyby jsme vsichni byli IT guru ? No jasne ze bylo, zkus si zakaznikovi ale rict, "Nastudujte si dokomentaci ke CRONU" pak to ale uz s nejvetsi pravdepodobnosti nebude tvuj zakaznik

[pavlix]

Typická zákazník nepotřebuje ani to, o čem se tu bavíme.

[Salamek]

Zakaznik nepotrebuje na svem hostingu stavovat cron sluzby ? Ok to jim priste reknu, urcite budou velmi nadseni

[pavlix]

Tvůj sarkasmus bohužel není na místě. Člověk, který nezvládá nastavit cron není technik. Člověk, který není technik, nemá zasahovat do serverů. Mimochodem na opravování systémů, do kterých hrabal kdekdo, jsem už taky v životě něco málo vydělal, takže je to spíše takové přátelské doporučení, pokud bych se někdy zase věnoval více businessu, tak samozřejmě budu rád, že to tak lidi dělají. :)

[Salamek]

Zrovna konfigurator CRONu se da napsat tak aby uzivatel nic nerozbyl... protoze se tam dostane jen to co tam sam v te aplikaci pustis... Hromada lidi co potrebuje provozovat nejaky web za par supu potrebuje i pridat nejake cron sluzby... to je proste kruta realita, podivej se na jakykoliv webhosting, vsude je moznost nastavit si cron sluzby z weboveho rozhrani... a zrovna k tomuhle tyto cron "zjednodusovaky" slouzi... Nikdo kdo provozuje web hosting nebude nastavovat CRON na pozadani, stejne jako zakaznici budou vyhledavat hosting kde si tohle mohou co nejjednodušeji nastavit.

[pavlix]

Zrovna konfigurator CRONu se da napsat tak aby uzivatel nic nerozbyl... protoze se tam dostane jen to co tam sam v te aplikaci pustis...

To ovšem pak není konfigurátor cronu, ale custom plánovač na vybrané akce. Jestli na spouštění úloh používá vlastní proces nebo cron je jen implementační detail. Webhosting tady asi řešit nebudeme. :)

[Salamek]

Prijde mi ze uz resis ptakoviny...

[pavlix]

Tak to jsem ve správné diskuzi.

[xxx]

Ja to mam pres dalsi level. Aneb zkus obchodnikov rict, at zakaznikovi zkusi rict, ze kdyz si porizuje Linuxovy produkt, ze musi mit i Linuxoveho admina.

[Salamek]

Mit k linuxovemu produktu linuxoveho admina je samozrejme nejlepsi reseni :)