Создавање пријателство со Python и Bash: библиотеки smart-env и python-shell

Добар ден на сите.

Денес, Python е еден од најкористените јазици во областа на создавање не само софтверски производи, туку и обезбедување на нивната инфраструктура. Како резултат на тоа, многу луѓе, без разлика дали по нивна волја или против тоа, мораа да научат нов јазик за подоцнежна употреба како додаток на старите добри баш скрипти. Сепак, Bash и Python исповедаат различни пристапи за пишување код и имаат одредени карактеристики, што значи дека пренесувањето на Bash скриптите на „змискиот јазик“ понекогаш се покажува како обемна и далеку од тривијална задача.

За да се олесни животот на devops, многу корисни библиотеки и алатки во Python се создадени и продолжуваат да се создаваат. Оваа статија опишува две нови библиотеки создадени од авторот на овој пост - паметен-зависен и питон-школка - и дизајниран да го ослободи Девос од потребата да се посвети многу внимание на сложеноста на работата со Python, оставајќи простор за поинтересни задачи. Обемот на активност на библиотеките се променливи на животната средина и лансирање на надворешни комунални услуги.

Секој заинтересиран, ве молиме да ја видите мачка.

Нови „велосипеди“?

Се чини, зошто да се создадат нови пакети за прилично обични операции? Што ве спречува директно да ги користите os.environ и subprocess.<метод или класа по ваш избор>?

Ќе дадам докази во корист на секоја од библиотеките посебно.

smart-env библиотека

Пред да напишете сопствена идеја, корисно е да отидете на интернет и да барате готови решенија. Се разбира, постои ризик да не го најдете она што ви треба, но ова е прилично „осигурителен настан“. Како по правило, овој пристап функционира и заштедува многу време и напор.

Според резултатите пребарување беше откриено следново:

• има пакети кои всушност ги обвиткуваат повиците до os.environ, но во исто време бараат еден куп дејства што го одвлекуваат вниманието (создавање пример од класа, специјални параметри во повиците итн.);
• Има добри пакети, кои, сепак, се строго врзани за специфичен екосистем (главно веб рамки како Django) и затоа не се воопшто универзални без датотека;
• ретки се обидите да се направи нешто ново. На пример, додадете пишување и експлицитно анализирајте ги вредностите на променливите со повикување методи како

  get_<typename>(var_name)

  Или овде уште едно решение, кој, сепак, не го поддржува сега обесчестениот Python 2 (кој, и покрај официјално RIP, сè уште има планини од пишан код и цели екосистеми);

• има училишни занаети кои од некоја непозната причина завршиле во возводно PyPI и создаваат само проблеми со именувањето на новите пакети (особено, името „smart-env“ е неопходна мерка).

И оваа листа може да трае долго време. Сепак, горенаведените точки беа доволни за да ме возбудат околу идејата да направам нешто погодно и универзално.

Барања што беа поставени пред да се напише smart-env:

• Наједноставна шема за користење
• Поддршка за пишување податоци што лесно се конфигурира
• Компатибилен со Python 2.7
• Добра покриеност на кодот со тестови

На крајот, сето ова беше реализирано. Еве пример за употреба:

from smart_env import ENV

print(ENV.HOME)  # Equals print(os.environ['HOME'])

# assuming you set env variable MYVAR to "True"

ENV.enable_automatic_type_cast()

my_var = ENV.MY_VAR  # Equals boolean True

ENV.NEW_VAR = 100  # Sets a new environment variable

Како што можете да видите од примерот, за да работите со нова класа, само треба да ја увезете (не треба да креирате пример - минус дополнителното дејство). Пристапот до која било променлива на околината се постигнува со упатување на неа како променлива од класата ENV, што, всушност, ја прави оваа класа интуитивна обвивка за домашната системска околина, додека истовремено ја претвора во можен конфигурациски објект за речиси секој систем ( сличен пристап, на пример, се постигнува во Django, само таму конфигурацискиот објект е самиот модул/пакет за поставки).

Овозможувањето/оневозможувањето на режимот за поддршка за автоматско пишување се постигнува со користење на два методи - enable_automatic_type_cast() и disable_automatic_type_cast(). Ова може да биде погодно ако променливата на околината содржи сериски објект сличен на JSON или дури и само Булова константа (експлицитното поставување на променливата DEBUG во Django со споредување на променливата на околината со низи „валидни“ е еден од најчестите случаи). Но, сега нема потреба експлицитно да се конвертираат низите - повеќето од потребните дејства се веќе вградени во длабочините на библиотеката и само чекаат сигнал за дејствување. 🙂 Општо земено, пишувањето функционира транспарентно и ги поддржува речиси сите достапни вградени типови на податоци (замрзнати, сложени и бајти не беа тестирани).

Условот за поддршка на Python 2 беше имплементиран практично без никакви жртви (напуштање на пишување и некои од „шеќерните бонбони“ од најновите верзии на Python 3), особено благодарение на сеприсутните шест (за решавање на проблемите со користење на метакласите ).

Но, постојат некои ограничувања:

• Поддршката за Python 3 значи верзија 3.5 и повисока (нивното присуство во вашиот проект е резултат или на мрзеливост или на недостаток на потреба од подобрувања, бидејќи е тешко да се дојде до објективна причина зошто сè уште сте на 3.4);
• Во Python 2.7, библиотеката не поддржува десериализација на множества буквали. Опис тука. Но, ако некој сака да го спроведе, добредојден сте :);

Библиотеката има и механизам за исклучок во случај на грешки при парсирање. Ако низата не може да се препознае од ниту еден од достапните анализатори, вредноста останува низа (напротив, поради практичност и компатибилност наназад со вообичаената логика за тоа како функционираат променливите во Bash).

библиотека со питон-школка

Сега ќе ви кажам за втората библиотека (ќе го испуштам описот на недостатоците на постоечките аналози - тој е сличен на оној опишан за smart-env. Аналози - тука и тука).

Во принцип, идејата за имплементација и барањата за тоа се слични на оние опишани за smart-env, како што може да се види од примерот:

from python_shell import Shell

Shell.ls('-l', '$HOME')  # Equals "ls -l $HOME"

command = Shell.whoami()  # Equals "whoami"
print(command.output)  # prints your current user name

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

Shell.mkdir('-p', '/tmp/new_folder')  # makes a new folder

Идејата е оваа:

1. Една класа што го претставува Баш во светот на Пајтон;
2. Секоја команда на Bash се повикува како функција од класата Shell;
3. Параметрите за секој повик на функција потоа се пренесуваат во соодветниот команден повик Bash;
4. Секоја команда се извршува „овде и сега“ во моментот кога ќе се повика, т.е. функционира синхрониот пристап;
5. можно е да се пристапи до излезот на командата во stdout, како и нејзиниот повратен код;
6. Ако командата не е во системот, се фрла исклучок.

Како и кај smart-env, има поддршка за Python 2 (иако беше потребна малку повеќе жртвена крв) и нема поддршка за Python 3.0-3.4.

Планови за развој на библиотеката

Можете да ги користите библиотеките сега: и двете се објавени на официјалниот PyPI. Изворите се достапни на Github (види подолу).

Двете библиотеки ќе бидат развиени земајќи ги предвид повратните информации собрани од заинтересираните. И, ако можеби е тешко да се дојде до различни нови функции во smart-env, тогаш во python-shell дефинитивно има уште нешто да се додаде:

• поддршка за неблокирани повици;
• можност за интерактивна комуникација со тимот (работа со stdin);
• додавање нови својства (на пример, својство за примање излез од stderr);
• имплементација на директориум со достапни команди (за употреба со функцијата dir());
• итн

референци

1. smart-env библиотека: Github и PyPI
2. библиотека python-shell: Github и PyPI
3. Телеграмски канал ажурирања на библиотеката

УПД 23.02.2020:
* Складиштата се преместени, соодветните врски се ажурирани
* Верзијата python-shell==1.0.1 се подготвува за објавување на 29.02.2020 година. Промените вклучуваат поддршка за автоматско комплетирање на командата и командата dir(Shell), извршување команди со неважечки идентификатор на Python и поправени грешки.

Извор: www.habr.com