GitHubじゃ!Pythonじゃ!

GitHubからPython関係の優良リポジトリを探したかったのじゃー、でも英語は出来ないから日本語で読むのじゃー、英語社会世知辛いのじゃー

ManrajGrover

halo – 💫 Pythonの美しい端末スピナー

投稿日:

💫 Pythonの美しい端末スピナー


ハロー

Pythonのための美しい端末のスピナー、 oraに触発された

インストール

$ pip install halo

使用法

from halo import Halo

spinner = Halo(text='Loading', spinner='dots')
spinner.start()

# Run time consuming work here
# You can also change properties for spinner as and when you want

spinner.stop()

あるいは、Pythonのwith文でhaloを使うこともできます:

from halo import Halo

with Halo(text='Loading', spinner='dots'):
    # Run time consuming work here

最後に、ハローをデコレータとして使用できます。

from halo import Halo

@Halo(text='Loading', spinner='dots')
def long_running_function():
    # Run time consuming work here
    pass

long_running_function()

API

Halo([text|spinner|color|interval|stream|enabled])

text

タイプstr

スピナーとともにテキストが表示されます。

spinner

タイプstr|dict

文字列の場合は、指定されたjsonファイルにリストされているスピナーの1つでなければなりません。 dictが渡された場合は、 intervalframesを定義する必要があります。 何かのようなもの:

{
    'interval': 100,
    'frames': ['-', '+', '*', '+', '-']
}

デフォルトはdotsスピナーです。 Windowsユーザの場合、デフォルトではlineスピンナが使用されます。

animation

タイプstr bouncemarquee

テキストが大きすぎて端末に収まらない場合、テキストに適用するアニメーション。 アニメーションが定義されていない場合、テキストは省略されます。

color

タイプstr greyredgreenyellowbluemagentacyanwhite

スピナーの色。 デフォルトはcyanです。

interval

タイプfloat

各フレーム間の間隔。 デフォルトはスピナー間隔(推奨)です。

stream

タイプfile

出力を書き込むストリーム。 デフォルトはsys.stdout

enabled

タイプbool

スピナーを有効または無効にします。 デフォルトはTrueです。

メソッド

使用可能な方法は次のとおりです。

spinner.start([text])

スピナーを開始します。 textが渡されると、スピナーテキストとして設定されます。 インスタンスを返します。

spinner.stop()

スピナーを停止してクリアします。 インスタンスを返します。

spinner.clear()

スピナーをクリアします。 インスタンスを返します。

spinner.render()

新しいフレームを手動でレンダリングします。 インスタンスを返します。

spinner.frame()

レンダリングされる次のフレームを返します。

spinner.succeed([text])

textタイプstr

スピナーを停止し、記号を変更します。 テキストが提供されている場合は、現在のテキストが永続化されていればそれが永続化されます。 インスタンスを返します。

spinner.fail([text])

textタイプstr

スピナーを停止し、記号をtoに変更します。 テキストが提供されている場合は、現在のテキストが永続化されていればそれが永続化されます。 インスタンスを返します。

spinner.warn([text])

textタイプstr

スピナーを停止し、記号を変更し テキストが提供されている場合は、現在のテキストが永続化されていればそれが永続化されます。 インスタンスを返します。

spinner.info([text])

textタイプstr

スピナーを停止し、記号を変更し テキストが提供されている場合は、現在のテキストが永続化されていればそれが永続化されます。 インスタンスを返します。

spinner.stop_and_persist([options])

optionsタイプdict

スピナーを停止し、シンボルとテキストを変更します。 インスタンスを返します。

options
symbol

タイプstr

スピナーを置き換えるシンボル。 デフォルトは ”です。

text

タイプstr

永続化されるテキスト。 デフォルトはインスタンステキストです。

spinner.text

スピナーのテキストを変更します。

spinner.color

スピナーの色を変更する

spinner.spinner

スピナー自体を変更してください。

目的

いいね?

🌟 サポートを示すこのレポ Twitterで気に入ったことを教えてください。 また、 プロジェクトを共有します

関連する

ライセンス

MIT ©Manraj Singh







-ManrajGrover
-, ,

執筆者: