Python と Bash の友好関係を築く: Smart-env ライブラリと Python-Shell ライブラリ

全てにおいて良い日。

今日、Python はソフトウェア製品自体の作成だけでなく、そのインフラストラクチャを提供する分野でも最もよく使用されている言語の XNUMX つです。 その結果、多くの開発者は、自らの意志であろうと、それに反して、後で古き良き Bash スクリプトの補足として使用するために新しい言語を学習する必要がありました。 ただし、Bash と Python は、コードを記述するアプローチが異なり、特定の機能を備えていると公言しています。つまり、Bash スクリプトを「スネーク言語」に移植することは、時には多大な作業であり、決して簡単な作業ではないことが判明します。

Devops の作業を容易にするために、Python で多くの便利なライブラリとユーティリティが作成され、今後も作成され続けます。 この記事では、この投稿の著者が作成した XNUMX つの新しいライブラリについて説明します。 スマート環境 и Pythonシェル - そして、DevOps が Python の操作の複雑さに多くの注意を払う必要性を軽減し、より興味深いタスクのための余地を残すように設計されています。 ライブラリの活動範囲は、環境変数と外部ユーティリティの起動です。

興味のある方はぜひ猫をご覧ください。

新しい「自転車」？

ごく普通の操作のためになぜ新しいパッケージを作成するのでしょうか? os.environ と subprocess.<選択したメソッドまたはクラス> を直接使用できないのはなぜですか?

それぞれの図書館に有利な証拠を個別に提供します。

スマート環境ライブラリ

自分で発案する前に、オンラインにアクセスして既製のソリューションを探すと便利です。 もちろん、必要なものが見つからないリスクはありますが、これはむしろ「保険」です。 原則として、このアプローチはうまく機能し、時間と労力を大幅に節約できます。

結果によると 検索する 次のことが明らかになりました。

• 実際に os.environ への呼び出しをラップするパッケージもありますが、同時に多数の気が散るアクション (クラスのインスタンスの作成、呼び出し内の特別なパラメーターなど) が必要です。
• 優れたパッケージもありますが、特定のエコシステム (主に Django などの Web フレームワーク) に厳密に関連付けられているため、ファイルなしではまったく汎用性がありません。
• 何か新しいことをしようとする試みはまれです。 例えば、 タイピングを追加 そして、次のようなメソッドを呼び出して変数値を明示的に解析します。

  get_<typename>(var_name)

  またはここ もうXNUMXつの解決策ただし、これは今や不名誉な Python 2 をサポートしていません ( 公式RIP、書かれたコードとエコシステム全体がまだ山のようにあります）。

• 何らかの理由で上流の PyPI に行き着き、新しいパッケージの命名に関してのみ問題を引き起こす学生の作品もあります (特に、「smart-env」という名前は必要な対策です)。

そして、このリストは長期間続く可能性があります。 しかし、上記の点は、何か便利で普遍的なものを作るというアイデアに興奮するのに十分でした。

Smart-env を作成する前に設定された要件:

• 最もシンプルな使用スキーム
• 簡単に設定可能なデータ型入力のサポート
• Python2.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() の XNUMX つのメソッドを使用して実現されます。 これは、環境変数にシリアル化された JSON のようなオブジェクト、または単なるブール定数が含まれている場合に便利です (環境変数を「有効な」文字列と比較することによって Django で DEBUG 変数を明示的に設定するのが最も一般的なケースの XNUMX つです)。 しかし、現在は文字列を明示的に変換する必要はありません。必要なアクションのほとんどはすでにライブラリの奥深くに埋め込まれており、シグナルが動作するのを待っているだけです。 🙂 一般に、入力は透過的に機能し、利用可能なほぼすべての組み込みデータ型をサポートします (frozenset、complex、bytes はテストされていません)。

Python 2 をサポートする要件は、特にユビキタスな 3 つのおかげで (メタクラス使用の問題を解決するため)、ほとんど犠牲 (タイピングの放棄と Python XNUMX の最新バージョンの一部の「砂糖菓子」) なしで実装されました。 ）。

ただし、いくつかの制限があります。

• Python 3 のサポートとは、バージョン 3.5 以降を意味します (プロジェクト内に Python 3.4 が存在するのは、怠惰か改善の必要性が欠如しているためです。XNUMX がまだ使用されている客観的な理由を思いつくのは難しいためです)。
• Python 2.7 では、ライブラリはセット リテラルの逆シリアル化をサポートしません。 説明 ここで。 しかし、それを実装したい人がいたら、大歓迎です :);

このライブラリには、解析エラーが発生した場合の例外メカニズムもあります。 利用可能なアナライザーのいずれでも文字列を認識できなかった場合、値は文字列のままになります (利便性と、Bash での変数の動作に関する通常のロジックとの下位互換性のため)。

Pythonシェルライブラリ

次に、XNUMX 番目のライブラリについて説明します (既存の類似体の欠点についての説明は省略します。これは、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. Python の世界で Bash を表す単一のクラス。
2. 各 Bash コマンドは、Shell クラスの関数として呼び出されます。
3. 各関数呼び出しのパラメーターは、対応する Bash コマンド呼び出しに渡されます。
4. 各コマンドは、呼び出された瞬間に「今ここで」実行されます。 同期アプローチは機能します。
5. 標準出力のコマンドの出力とその戻りコードにアクセスすることができます。
6. コマンドがシステムにない場合は、例外がスローされます。

Smart-env と同様に、Python 2 はサポートされていますが (ただし、もう少し犠牲が必要でした)、Python 3.0 ～ 3.4 はサポートされていません。

図書館整備計画

これらのライブラリは今すぐ使用できます。両方とも公式 PyPI に掲載されています。 ソースは Github で入手できます (下記を参照)。

どちらのライブラリも、関心のある人から収集したフィードバックを考慮して開発されます。 また、smart-env でさまざまな新機能を思いつくのが難しい場合は、python-shell で間違いなく他に追加できるものがあります。

• ノンブロッキング呼び出しのサポート。
• チームとの対話型コミュニケーションの可能性 (標準入力での作業)。
• 新しいプロパティを追加します (たとえば、stderr からの出力を受け取るプロパティ)。
• 利用可能なコマンドのディレクトリの実装 (dir() 関数で使用するため)。
• 等

リファレンス

1. スマート環境ライブラリ: githubの и PyPI
2. Pythonシェルライブラリ: githubの и PyPI
3. 電報チャンネル ライブラリの更新

UPD 23.02.2020：
* リポジトリが移動され、対応するリンクが更新されました
* バージョン python-shell==1.0.1 は、29.02.2020 年 XNUMX 月 XNUMX 日のリリースに向けて準備中です。 変更には、コマンドのオートコンプリートと dir(Shell) コマンドのサポート、無効な Python 識別子を使用したコマンドの実行、バグ修正が含まれます。

出所： habr.com