Python-ისა და Bash Friendship-ის შექმნა: smart-env და python-shell ბიბლიოთეკები

კარგი დღე ყველას.

დღეს პითონი ერთ-ერთი ყველაზე გამოყენებული ენაა არა მხოლოდ თავად პროგრამული პროდუქტების შექმნის, არამედ მათი ინფრასტრუქტურის უზრუნველყოფის სფეროში. შედეგად, ბევრ დევოპს, თავისი ნებით თუ მის წინააღმდეგ, მოუწია ახალი ენის სწავლა, რათა შემდგომში გამოეყენებინათ ძველი კარგი ბაშის დამწერლობის დამატება. თუმცა, Bash და Python ასწავლიან განსხვავებულ მიდგომებს კოდის დაწერის მიმართ და აქვთ გარკვეული ფუნქციები, რაც იმას ნიშნავს, რომ Bash სკრიპტების პორტირება „გველის ენაზე“ ზოგჯერ ტევადი და ტრივიალური ამოცანასგან შორს არის.

devops-ისთვის ცხოვრების გასაადვილებლად, Python-ში მრავალი სასარგებლო ბიბლიოთეკა და კომუნალური პროგრამა შეიქმნა და აგრძელებს შექმნას. ეს სტატია აღწერს ამ პოსტის ავტორის მიერ შექმნილ ორ ახალ ბიბლიოთეკას - smart-env и პითონი-ჭურვი - და შექმნილია იმისთვის, რომ გაათავისუფლოს დევოპი პითონთან მუშაობის სირთულეებზე დიდი ყურადღების მიქცევის აუცილებლობისგან, რაც ტოვებს ადგილს უფრო საინტერესო ამოცანებისთვის. ბიბლიოთეკების საქმიანობის სფეროა გარემოს ცვლადები და გარე კომუნალური საშუალებების გაშვება.

ვისაც აინტერესებთ, გთხოვთ ნახოთ კატა.

ახალი "ველოსიპედები"?

როგორც ჩანს, რატომ შევქმნათ ახალი პაკეტები საკმაოდ ჩვეულებრივი ოპერაციებისთვის? რა გიშლით ხელს os.environ და subprocess.<თქვენი არჩევანის მეთოდი ან კლასი> პირდაპირ გამოყენებაში?

თითოეულ ბიბლიოთეკის სასარგებლოდ ცალ-ცალკე მოვიყვან მტკიცებულებებს.

smart-env ბიბლიოთეკა

სანამ საკუთარ აზრს დაწერთ, სასარგებლოა ინტერნეტში შესვლა და მზა გადაწყვეტილებების მოძიება. რა თქმა უნდა, არსებობს იმის რისკი, რომ არ იპოვოთ ის, რაც გჭირდებათ, მაგრამ ეს უფრო "სადაზღვევო მოვლენაა". როგორც წესი, ეს მიდგომა მუშაობს და დაზოგავს დიდ დროსა და ძალისხმევას.

შედეგების მიხედვით ძიება გამოვლინდა შემდეგი:

• არის პაკეტები, რომლებიც რეალურად აფუჭებენ ზარებს os.environ-ზე, მაგრამ ამავდროულად საჭიროებენ უამრავ ყურადღების გადატანის მოქმედებებს (კლასის ინსტანციის შექმნა, ზარებში სპეციალური პარამეტრები და ა.შ.);
• არის კარგი პაკეტები, რომლებიც, თუმცა, მკაცრად არის მიბმული კონკრეტულ ეკოსისტემასთან (ძირითადად ვებ ჩარჩოები, როგორიცაა Django) და, შესაბამისად, სულაც არ არის უნივერსალური ფაილის გარეშე;
• იშვიათი მცდელობებია რაიმე ახლის გაკეთების. Მაგალითად, აკრეფის დამატება და აშკარად გააანალიზეთ ცვლადის მნიშვნელობები მსგავსი მეთოდების გამოძახებით

  get_<typename>(var_name)

  ან აქ კიდევ ერთი გამოსავალი, რომელიც, თუმცა, არ უჭერს მხარს ახლა შერცხვენილ პითონ 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-ის მსგავს ობიექტს ან თუნდაც მხოლოდ ლოგიკურ მუდმივობას (Django-ში DEBUG ცვლადის აშკარად დაყენება გარემოს ცვლადის „ვალიდ“ სტრიქონებთან შედარების გზით ერთ-ერთი ყველაზე გავრცელებული შემთხვევაა). მაგრამ ახლა არ არის საჭირო სტრიქონების მკაფიოდ გადაქცევა - აუცილებელი მოქმედებების უმეტესობა უკვე ჩაშენებულია ბიბლიოთეკის სიღრმეში და მხოლოდ სიგნალის მოლოდინშია. 🙂 ზოგადად, აკრეფა მუშაობს გამჭვირვალედ და მხარს უჭერს თითქმის ყველა ჩაშენებულ მონაცემთა ტიპს (გაყინული ნაკრები, კომპლექსი და ბაიტი არ იყო გამოცდილი).

Python 2-ის მხარდაჭერის მოთხოვნა განხორციელდა პრაქტიკულად მსხვერპლის გარეშე (აკრეფის მიტოვება და Python 3-ის უახლესი ვერსიების ზოგიერთი „შაქრის ტკბილეული“), კერძოდ, ყველგან გავრცელებული ექვსის წყალობით (მეტაკლასების გამოყენების პრობლემების გადასაჭრელად. ).

მაგრამ არსებობს გარკვეული შეზღუდვები:

• Python 3-ის მხარდაჭერა ნიშნავს 3.5 და უფრო მაღალ ვერსიას (თქვენს პროექტში მათი ყოფნა ან სიზარმაცის ან გაუმჯობესების საჭიროების არარსებობის შედეგია, რადგან ძნელია მოიფიქრო ობიექტური მიზეზი, თუ რატომ ხარ ჯერ კიდევ 3.4-ზე);
• Python 2.7-ში ბიბლიოთეკა არ უჭერს მხარს კომპლექტის ლიტერალების დესერიალიზაციას. აღწერა აქ. ოღონდ თუ ვინმეს მოუნდება მისი განხორციელება, მობრძანდით :);

ბიბლიოთეკას ასევე აქვს გამონაკლისის მექანიზმი ანალიზების შეცდომების შემთხვევაში. თუ სტრიქონი ვერ იქნა ამოცნობილი რომელიმე ხელმისაწვდომი ანალიზატორის მიერ, მნიშვნელობა რჩება სტრიქონად (უფრო მეტიც, მოხერხებულობისა და უკან თავსებადობის გამო, ჩვეულებრივ ლოგიკასთან, თუ როგორ მუშაობს ცვლადები Bash-ში).

python-shell ბიბლიოთეკა

ახლა მე მოგიყვებით მეორე ბიბლიოთეკის შესახებ (გამოვტოვებ არსებული ანალოგების ნაკლოვანებების აღწერას - მსგავსია 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-ზე (იხ. ქვემოთ).

ორივე ბიბლიოთეკა განვითარდება დაინტერესებული პირებისგან შეგროვებული გამოხმაურების გათვალისწინებით. და თუ შეიძლება რთული იყოს სმარტ-env-ში სხვადასხვა ახალი ფუნქციების გამომუშავება, მაშინ პითონ-შელში ნამდვილად არის კიდევ რაღაც დასამატებელი:

• დაუბლოკავი ზარების მხარდაჭერა;
• გუნდთან ინტერაქტიული კომუნიკაციის შესაძლებლობა (სტდინთან მუშაობა);
• ახალი თვისებების დამატება (მაგალითად, თვისება stderr-დან გამოსავლის მისაღებად);
• ხელმისაწვდომი ბრძანებების დირექტორიას განხორციელება (dir() ფუნქციით გამოსაყენებლად);
• ა.შ.

ლიტერატურა

1. smart-env ბიბლიოთეკა: Github и PyPI
2. python-shell ბიბლიოთეკა: Github и PyPI
3. ტელეარხი ბიბლიოთეკის განახლებები

UPD 23.02.2020/XNUMX/XNUMX:
* საცავები გადატანილია, შესაბამისი ბმულები განახლებულია
* ვერსია python-shell==1.0.1 მზადდება გამოსაშვებად 29.02.2020/XNUMX/XNUMX. ცვლილებები მოიცავს ბრძანების ავტომატური შევსების და dir(Shell) ბრძანების მხარდაჭერას, პითონის არასწორი იდენტიფიკატორის მქონე ბრძანებების გაშვებას და შეცდომების გამოსწორებას.

წყარო: www.habr.com