django-boss

django-sef este o punere în aplicare a ideilor expuse în meu post pe blog pe comenzile de management Django. Cu acesta, puteți specifica comenzi în aplicații individuale și apoi executați-le folosind djboss linie de comandă interfață.
Instalarea django-sef
În momentul de față, instalare se face prin easy_install django-sef sau pip instala django-sef. Singurele premisele sunt argparse, a căror instalare este manipulat de către setuptools, și Django, care trebuie să aveți instalat până acum, oricum.
Scriere Comenzi
Comenzile sunt definite ca instanțe de djboss.commands.Command, prezente într-un submodul comenzi în interiorul unei aplicații instalate. De exemplu, să ia următoarele structura app:
echoapp /
| - __init__.py
| - Commands.py
`- Models.py
Fișierul commands.py este un submodule care pot fi importate ca echoapp.commands.
cu decoratori
Următoarele este un exemplu complet de fișier commands.py valid:
din djboss.commands import *
command
def salut (argumente):
& Nbsp; "" "Print un clișeu pentru consola." ""
& Nbsp; print "Hello, World!"
Acest exemplu utilizează decoratorcommand să declare că funcția este o comanda django-sef. Puteți adăuga argumente la comenzi prea; utilizați doar decoratorargument (asigurați-vă că au venit dupăcommand):
command
argument ("- n ',' --no-newline ', acțiune =' store_true ',
& Nbsp; de ajutor = "Nu adăuga o linie nouă la final.")
def salut (argumente):
& Nbsp; "" "Print un clișeu pentru consola." ""
& Nbsp; dacă args.no_newline:
& nbsp; sys import
& Nbsp; sys.stdout.write ("! Hello, World")
& Nbsp; altfel:
& Nbsp; print "Hello, World!"
argument Decorator acceptă orice argparse.ArgumentParser.add_argument () nu; consulta docs argparse pentru mai multe informații.
Puteți, de asemenea, adnota comenzi dând argumente cuvinte cheie lacommand:
command (name = "ceva", descriere = "face ceva.")
def do_something (args):
& Nbsp; "" ". Fă ceva" ""
& Nbsp; de imprimare "ceva a fost făcut."
În acest caz, comanda va fi numit "ceva" în loc de auto-generat "do-ceva", iar descrierea va diferi de docstring sa. Pentru mai multe informații cu privire la ceea ce poate fi trecut aici, consultați Docs argparse.ArgumentParser.
Fara decoratori
API este foarte asemănătoare, fără decorațiuni. Clasa de comandă este folosit pentru a încheia funcții, și vă pot da argumente cuvinte cheie atunci când invocă și cucommand:
def ECHO (args):
& Nbsp; ...
echo = Command (ecou, ​​name = '...', descrierea = '...')
Adăugarea argumente utilizează (metoda Command.add_argument), care este doar o referință la sub-parser & rsquo generate; s add_argument () metoda:
def ECHO (args):
& Nbsp; ...
echo = Command (ecou, ​​name = '...', descrierea = '...')
echo.add_argument ("- n ',' --no-linie noua", ...)
echo.add_argument ("cuvinte", nargs = '*')
Rularea comenzilor
Comenzile sunt executate prin intermediul djboss linie de comandă interfață. Pentru aceasta pentru a rula corect, ai nevoie de unul din două lucruri:
* O variabilă de mediu DJANGO_SETTINGS_MODULE care se referă la un modul valid, Python importable.
* O, modul setările la import valabil în directorul de lucru curent.
Odată ce unul dintre acestea este acoperit, puteți rula:
djboss help
Utilizarea: djboss [-h] [-v] [LEVEL -l] COMMAND ...
Comenzile de gestionare a django-boss conduse.
argumente opționale:
& Nbsp; -h, help arată acest mesaj de ajutor și de ieșire
& Nbsp; -v, numărul versiunii version spectacol de program și de ieșire
& Nbsp; LEVEL -l, la nivel --log LEVEL
& Nbsp; Alege un nivel jurnal de depanare, INFO, WARN (implicit)
& Nbsp; sau eroare.
Comenzi:
& Nbsp; COMMAND
& Nbsp; ecou Echo argumentele înapoi la consola.
& Nbsp; salut Tipărește un clișeu la consola.
Pentru a descoperi sub-comenzi, primele descoperiri și importurile djboss setările Django.
Variabila de mediu DJANGO_SETTINGS_MODULE are prioritate, dar dacă nespecificată, djboss va uita pentru o `modul settings` în directorul curent. Comenzi ar trebui definite într-un `submodul commands` de fiecare aplicație. djboss va căuta fiecare INSTALLED_APPS dvs. pentru comenzile de management.
Fiecare subcomanda devine o opțiune --help prea:
djboss ecou help
utilizare: djboss ecou [-h] [-n] [cuvinte [cuvinte ...]]
Ecou argumentele înapoi la consola.
argumente poziționale:
& nbsp; de cuvinte
argumente opționale:
& Nbsp; -h, help arată acest mesaj de ajutor și de ieșire
& Nbsp; -n, --no-newline Nu imprimați o linie nouă după aceea.
Și apoi puteți rula:
djboss ecou câteva cuvinte aici
câteva cuvinte aici
Mai mult de aceeași:
djboss salut help
Utilizarea: djboss salut [-h]
Imprima o clișeu la consola.
argumente opționale:
& Nbsp; -h, help arată acest mesaj de ajutor și de ieșire
Și în final:
djboss salut
Buna ziua, World

Cerințe :

• Django
• Python