Toome kokku Python'i ja Bash'i: teegid smart-env ja python-shell

Tere kõigile.

Praegu on Python üks enimkasutatavaid keeli mitte ainult tarkvaratoodete arendamisel, vaid ka nende infrastruktuuri haldamisel. Seetõttu on paljudel devopsidel, kas oma soovil või mitte, tulnud õppida uus keel, et seda kasutada vanade heade Bash-skriptide täiendusena. Siiski järgivad Bash ja Python erinevaid lähenemisviise koodi kirjutamisele ning neil on omad eripärad, mistõttu Bash-skriptide portimine "madala keele" peale osutub mõnikord mahukaks ja kaugel sellest, et oleks triviaalne ülesanne.

Devopside elu lihtsamaks tegemiseks on loodud ja luuakse jätkuvalt palju kasulikke Python'i raamatukogusid ja utiliite. Käesolev artikkel kirjeldab kahte uut raamatukogu, mille on loonud käesoleva postituse autor — smart-env ja python-shell — ja mille eesmärk on vabastada devops vajadusest pöörata palju tähelepanu Python'i töö nüanssidele, jättes ruumi huvitavamatele ülesannetele. Raamatukogude tegevusvaldkond on keskkonnamuutujad ja väliste utiliitide käivitamine.

Kellele huvi pakub, palun lugeda edasi.

Uued 'jalgrattad'?

Tundub, et millestki nii tavalise toimingu jaoks uusi pakette luua? Mis takistab otse os.environ'i ja subprocess. kasutamast?

Tõendeid iga raamatukogu kasuks toome eraldi.

Raamatukogu smart-env

Enne kui kirjutada oma loomingut, on kasulik uurida Internetti ja otsida valmislahendusi. Loomulikult on risk, et vajalikku ei leia, kuid see on pigem "kindlustusjuhtum". Reeglina toimib lähenemine ja säästab palju aega ja vaeva.

Uuringute põhjal otsing tuletas välja järgmist:

• on pakette, mis tõepoolest ümbritsevad os.environ'i kutseid, kuid samas nõuavad palju segavaid tegevusi (klasside loomine, spetsiaalsetele parameetritele vastamine jne);
• on häid pakette, kuid need on rangelt seotud kindla ökosüsteemiga (peamiselt veebiraamistike nagu Django) ning seetõttu ei ole nad üldiselt universaalsed;
• on haruldasi katseid midagi uut teha. Näiteks, lisada tüübihindamine ja analüüsida muutujaid selgelt, kutsudes esile meetodeid tüüpi

  get_(var_name)

  Või veel üks lahendus , mis siiski ei toeta praegu tagakiusatavat Python 2 (millel, vaatamata sellele,, mis siiski ei toeta enam kasutuses olevat Python 2 (millel, vaatamata sellele, ametlik R.I.P., koodimägedest ja tervetest ökosüsteemidest, mis on endiselt alles);

• on olemas kooli-üliõpilaste teosed, millel pole selget eesmärki, et nad on sattunud upstream'i PyPI'sse ja ainult segavad uute pakettide nimetamisel (eriti, nimi „smart-env” — sunnitud meede).

Ja seda nimekirja võiks jätkata pikalt. Siiski, juba eespool nimetatud punktide järgi tekkis idee luua midagi mugavat ja universaalset.

Nõuded, mis esitleti smart-env'i kirjutamiseks:

• Maksimaalselt lihtne kasutusmudel
• Kergesti konfigureeritav andmetüüpide tugi
• Ühildub Python 2.7-ga
• Hea koodikatete testidega

Lõpuks suudeti kõik see ellu viia. Siin on kasutusnäide:

from smart_env import ENV

print(ENV.HOME)  # Üksikasju: print(os.environ['HOME'])

# eeldades, et seadistate keskkonnamuutuja MYVAR väärtuseks "True"

ENV.enable_automatic_type_cast()

my_var = ENV.MY_VAR  # Üksikasju: boolean True

ENV.NEW_VAR = 100  # Seab uue keskkonnamuutuja

Nagu näha näites, on uue klassiga töötamiseks piisav selle importimine (instantsi loomine pole vajalik — vähem tarbetuid toiminguid). Juurdepääs mis tahes keskkonnamuutujale toimub klassi ENV muutuja kaudu, mis tegelikult teeb sellest klassist intuitiivselt arusaadava mähise native süsteemi keskkonnale, samal ajal muutes selle võimalikuks konfigureerimise objektiks peaaegu iga süsteemi jaoks (sarnane lähenemine saavutatakse näiteks Django's, kus konfigureerimise objektiks on otse moodul/pakett settings).

Automaatse tüpiseerimise režiimi sisselülitamine/väljalülitamine saavutatakse kahe meetodi abil — enable_automatic_type_cast() ja disable_automatic_type_cast(). See võib olla kasulik, kui keskkonnamuutuja sisaldab序列ititud JSON-sarnast objekti või isegi lihtsalt booleset konstanti (Django's DEBUG muutuja selge määramine, võrreldes keskkonnamuutujat „lubatud” stringidega — üks sagedamini esinevaid juhtumeid). Kuid nüüd pole enam vajadust stringe selgelt konverteerida — enamik nõutavaid toiminguid on juba raamatukogu sisemuses ja ootavad lihtsalt signaali tegutsemiseks. 🙂 Üldiselt töötab tüpiseerimine läbipaistvalt ja toetab peaaegu kõiki olemasolevaid sisseehitatud andmetüüpe (frozenset, complex ja bytes ei ole testitud).

Python 2 toe toetamine toimus peaaegu ilma ohvriteta (looduslike elementide ja mõnede viimaste Python 3 versioonide „suhkru kommide” mahajätmine), eelkõige tänu laialdaselt kasutatavale six (metaklasside kasutamise probleemide lahendamiseks).

Kuid piiranguid on ka veidi:

• Python 3 tugi tähendab versiooni 3.5 ja uuemat (nende olemasolu teie projektis on kas laiskuse või vajaduse puudumise tulemus, sest on raske leida objektiivset põhjendust, miks te veel 3.4 peal olete);
• Python 2.7-s ei toeta teek hulga literiaalide deseraliseerimist. Kirjeldus siit. Kuid kui keegi soovib seda ellu viia - tere tulemast:);

Teek toetab ka erandite mehhanismi parsimise viga korral. Kui stringi ei õnnestu ühtegi olemasolevat analüsaatorit pidi tuvastada, jääb väärtus stringiks (peamiselt mugavuse ja Bash'i muude tavade tagamiseks).

Python-shell teek

Nüüd räägin teisest teegist (nimetamise puudused olevate analoogide suhtes jäetakse kõrvale - see on sarnane smart-env'i omadustega. Analooge - siit ja siit).

Üldiselt on rakenduse idee ja nõuded sarnased smart-env'i omadustega, mida illustreerib järgmine näide:

from python_shell import Shell

Shell.ls('-l', '$HOME')  # Võrdub "ls -l $HOME"

command = Shell.whoami()  # Võrdub "whoami"
print(command.output)  # prindib teie praeguse kasutajanime

print(command.command)  # prindib "whoami"
print(command.return_code)  # prindib "0"
print(command.arguments)  # prindib ""

Shell.mkdir('-p', '\/tmp\/new_folder')  # loob uue kausta

Idee on järgmine:

1. Üksainus klass, mis kehastab Bash'i Python'i maailmas;
2. Iga Bash'i käsk kutsutakse välja klassi Shell funktsioonina;
3. Iga funktsiooni kutsumise parameetrid edastatakse edasi vastava Bash'i käsu kutsumisse;
4. Iga käsk käivitatakse "siin ja nüüd" hetkel, mil seda kutsutakse, st kasutatakse sünkront lähenemist;
5. on võimalik saada juurdepääs käsu väljundile stdout, samuti selle tagastamiskoodile;
6. Kui käsku ei leitud süsteemist – visatakse erand.

Nagu ka smart-env'i puhul, on tagatud Python 2 tugi (kuigi ohvrit on veidi rohkem nõutud) ja puudub tugi Python 3.0-3.4 jaoks.

Teekide arendamise plaanid

Raamatukogusid saab kasutada juba praegu: mõlemad on avalikult saadaval PyPI-l. Algkood on saadaval Githubis (vt allpool).

Mõlemad teegid arenevad tagasisidet arvesse võttes, mis on saadud huvitatud osalistelt. Ja kui smart-env'i puhul võib uute funktsioonide mitmekesisuse väljamõtlemine olla keeruline, siis python-shelli puhul on kindlasti veel mida lisada:

• mittesüvaliseerivate kõnede tugi;
• võimalus interaktiivseks suhtlemiseks meeskonnaga (töötamine stdin-iga);
• uususte lisamine (näiteks omadus, et saada stderr väljund);
• kõigi saadavalolevate käskude katalooge loomine (kasutamiseks funktsiooniga dir());
• jne.

Viidatud lingid

1. Teek smart-env: Github ja PyPI
2. Teek python-shell: Github ja PyPI
3. Telegrami kanal teekide värskendused

UPD 23.02.2020:
* Reposid on üle viidud, vastavad lingid on värskendatud
* Versioon python-shell==1.0.1 on valmimas 29.02.2020. Muudatuste seas on käskude automaatse täitmise tugi ja käsk dir(Shell), käskude käivitamine Python'i kehtetu identifikaatoriga, veaparandused.

Allikas: habr.com