console — コンソール画面への表示と各種システムサービスのユーティリティー
console モジュールはPythonistaの文字出力画面とキーボード入力をコントロールする関数を提供します。
また、簡易な形式のダイアローグボックスを動作させたり、「Open in...」のようなメニューやQuickLookのようなサービスにアクセスするための関数もあります。
console.clear()
コンソール画面の出力をクリアします。
console.set_font([name, size])
コンソール出力に用いるフォントの種類とサイズを設定します。引数を省略して呼び出すと、デフォルト値にリセットします。
console.set_color(r, g, b)
コンソール出力のRGB色を設定します。引数は、それぞれ0.0〜1.0の間の浮動小数型です。
console.secure_input([prompt])
この関数は、pythonの標準関数であるinputに似ていますが、ユーザーの入力値が画面表示されないので、パスワードやその他の重要な情報の入力に適しています。
console.show_image(image_path)
ファイルから画像を読み込んで、コンソール画面の出力エリアに表示します。
console.alert(title[, message, button1, button2, button3, hide_cancel_button=False])
最大３つのボタンを持った警告ダイヤログボックスを表示します。選んだボタンは整数型で返されます。(ボタン1の時に戻り値1など）hide_cancel_button が真(True）でない場合には、警告ダイヤログボックスのキャンセルボタンは KeyboardInterrupt（キーボード割込）を発生させます。
console.input_alert(title[, message, input, ok_button_title, hide_cancel_button=False])
１行の文字列エリアを持つダイアログボックスを表示します。文字列エリアは予め引数 input で与えた文字列を表示することもできます。この関数はユーザーが入力した文字列を返します。キャンセルボタンを押すとKeyboardInterrupt(キーボード割込）を発生させます。
console.password_alert(title[, message, password, ok_button_title, hide_cancel_button=False])
パスワード入力エリアを持ったダイアログを表示します。パスワード入力エリアは予め引数passwordで与えた文字列を表示することもできます。この関数は、ユーザーが入力したパスワードを返します。キャンセルボタンを押すと通常はスクリプトの実行を止める KeyboardInterrupt(キーボード割込）を発生させます。
console.login_alert(title[, message, login, password, ok_button_title])
ログイン用とパスワード用の２つの文字列エリアを持つダイヤログを表示します。文字列エリアはloginとpasswordの２つの引数で指定した文字列を予め表示させることもできます。この関数は入力したログインとパスワードのタプルを返します。キャンセルボタンを押すと通常はスクリプトの実行を止めるKeyboardInterrupt(キーボード割込）を発生させます。
console.show_activity()
ステータスバーに「ネットワーク・アクティビティ・インジケーター」をアニメーション表示します。回転するインジケーターは、スクリプトが終了すると自動的に隠されます。回転インジケーターが既に表示されている場合には、この関数を呼び出しても変化はありません。
console.hide_activity()
ステータスバーの「ネットワーク・アクティビティ・インジケーター」を隠します。回転するインジケーターは、スクリプトが終了すると自動的に隠されます。回転インジケーターが既に表示されている場合には、この関数を呼び出しても変化はありません。
(注 pythonista3のヘルプ画面には、このように記述されていますが、そもそも「インジケーターを隠す」関数なので、2行目以降は上記のshow_activity()の説明文をうっかりコピペしてしまったものであり、無視すべきだと思います）
console.hud_alert(message[, icon, duration])
引数messageで与えたメッセージ付きのHUD形式の警告表示をします。メッセージの上に表示するアイコンは、「成功」（デフォルトのチェックマーク表示）にも「エラー」（バツの表示）にもできます。
引数durationは画面上にどの位の時間警告表示をするかを決めます。0.25から5.0秒の間で選べます。デフォルトでは1.8秒です。この関数は警告が消えるまで次のスクリプトに進みません。
(例 console.hud_alert('書き込みは禁止されています‘,'error',5.0) )
console.write_link(title, link_url)
コンソール画面に引数titleとlink_urlで指定した、タップ可能なリンクを表示します。このリンクは(httpやhttps、ファイルのURLを)Safariで開くことができるほか、(あれば)他のアプリで開く事も可能です。
set_color()を使って文字の色をカスタマイズすれば、リンク文字の色も変えられます。指定しなければデフォルトの色が使われます。
console.hide_output()
コンソール画面の出力エリアを(右にスワイプするような)スライドするアニメーションで隠します。
console.quicklook(file_path)
引数 file_path で指定したパスにあるファイル(複数あれば複数）の全画面サイズのプレビューを表示します。一度に複数のファイルのプレビューを表示するために、例えばリスト形式で一連のパスを引数として設定することも可能です。この関数はプレビューを消した段階で終了します。
多くのファイル形式をサポートしています：
- iWork 文書
- マイクロソフトオフィス文書(Office ‘97 又はそれ以降)
- リッチ・テキスト・フォーマット(RTF)文書
- PDF ファイル
- 画像
- MacOSデータ識別形式であるUniform Type Identifier(UTI)のテキストファイルで「public.text」タイプに適合させた文書
- CSV形式のファイル
console.open_in(file_path)
特定のファイルに対して iOS の “Open in...” メニューを表示します。
メニューの中からアプリを選ぶと、アプリに関連付けられたIDを返します。(例えば、'com.getdropbox.Dropbox'など）メニューがキャンセルされた場合やそのファイルを開くことのできるアプリがインストールされていない場合には、None値を返します。
console.set_idle_timer_disabled(flag)
一定の時間操作がない場合にiPhone(やiPad)をスリープ状態にする「アイドル・タイマー」をオン／オフします。
console.is_in_background()
アプリがバックグラウンドで実行されている場合に True を返します。その他の場合には False を返します。