יצירת ידידות של Python ו-Bash: ספריות smart-env ו-python-shell

יום טוב לכולם.

כיום, Python היא אחת השפות הנפוצות ביותר בתחום של יצירת לא רק מוצרי תוכנה בעצמם, אלא גם אספקת התשתית שלהם. כתוצאה מכך, נאלצו devops רבים, בין אם מרצונם או נגדו, ללמוד שפה חדשה לשימוש מאוחר יותר כתוספת לתסריטים הישנים והטובים של בש. עם זאת, Bash ו-Python מצהירים על גישות שונות לכתיבת קוד ויש להם תכונות מסוימות, כלומר העברה של סקריפטים של Bash ל"שפת הנחש" מתגלה לפעמים כמשימה רחבת היקף ורחוקה מלהיות טריוויאלית.

כדי להקל על החיים של devops, ספריות וכלי עזר שימושיים רבים ב-Python נוצרו וממשיכים להיווצר. מאמר זה מתאר שתי ספריות חדשות שנוצרו על ידי מחבר הפוסט הזה - smart-env и מעטפת פיתון - ונועד לפטור את ה-devops מהצורך להקדיש תשומת לב רבה למורכבות העבודה עם 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).

ספריית python-shell

עכשיו אני אספר לכם על הספרייה השנייה (אני אשמיט את התיאור של החסרונות של האנלוגים הקיימים - זה דומה לזה שמתואר עבור אנלוגים חכמים-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. מחלקה יחידה המייצגת את Bash בעולם Python;
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. ערוץ טלגרם עדכוני ספרייה

UPD23.02.2020:
* המאגרים הועברו, הקישורים המתאימים עודכנו
* גרסת python-shell==1.0.1 מתכוננת לשחרור ב-29.02.2020/XNUMX/XNUMX. השינויים כוללים תמיכה בהשלמה אוטומטית של פקודות ובפקודה dir(Shell), פקודות הרצת עם מזהה Python לא חוקי ותיקוני באגים.

מקור: www.habr.com