ツール（xonsh.tools）

その他 xonshツール。

次の実装はIPythonプロジェクトから分岐しました：

• Copyright（c）2008-2014、IPython開発チーム
• 著作権（C）2001-2007 Fernando Perez < fperez @ colorado 。エデュース >
• Copyright（c）2001、Janko Hauser < jhauser @ zscout 。de >
• Copyright（c）2001、Nathaniel Gray < n8gray @ caltech 。エデュース >

実装：

• decode（）
• エンコード（）
• cast_unicode（）
• safe_hasattr（）
• インデント（）

例外xonsh.tools.XonshCalledProcessError（returncode、command、output =なし、stderr =なし、completed_command =なし）

呼び出されたプロセスでエラーが発生した場合に発生します。

XonshErrorとsubprocess.CalledProcessErrorから継承し、どちらかをキャッチするとこのエラーもキャッチされます。

キャプチャされたコマンドの標準出力を反復した後、コマンドのリターンコードがゼロ以外の場合に発生します。

例：

試してください：

ラインイン！（ls）の場合：

印刷（ライン）

エラーとしてsubprocess.CalledProcessErrorを除く：

print（ "処理中のエラー：{}。形式（error.completed_command.pid））

これは、CalledProcessErrorに関するPython3.4と3.5の違いも処理します。

with_traceback（）

Exception.with_traceback（tb） - tbにself .__ traceback__を設定してselfを返します。

args

stdout

stderrに一致する出力属性の別名

例外xonsh.tools.XonshError

with_traceback（）

Exception.with_traceback（tb） - tbにself .__ traceback__を設定してselfを返します。

args

class xonsh.tools.DefaultNotGivenType

デフォルト値が与えられていないときを表すシングルトン。

class xonsh.tools.EnvPath（args = None ）

文字列のリストである環境パスを実装するクラス。関連するenv変数が設定されている場合は、すべてのパスを展開するカスタムメソッドを提供します。

add（data、front = False、replace = False ）

このEnvPathに値を追加し、

path.add（data、front = bool、replace = bool） - >そのパスにkwargsで指定された位置のデータが含まれていることを確認します。

パラメーター：

データ ： 文字列またはバイトまたはpathlib.Path

追加される値

前部 ： ブール

このEnvPathにデータが既に存在し、replaceがFalseの場合、値を前面に追加するかどうかは無視されます。デフォルト：False

置き換える ： bool

Trueの場合、値は削除され、開始または終了に追加されます（フロントの値に応じて）。デフォルト：False

戻り値：

無し

append（値）

S.append（value） - シーケンスの最後に値を追加する

clear（） →None - Sからすべての項目を削除

count（値） →整数 - 値の出現回数を返す

extend（値）

S.extend（iterable） - iterableから要素を追加してシーケンスを拡張する

index（value [、start [、stop ] ] ） →整数 - 最初の値のインデックスを返します。

値が存在しない場合、ValueErrorを発生させます。

insert（インデックス、値）

S.insert（index、value） - インデックスの前に値を挿入する

pop（[ index ] ） →item - インデックスの項目を削除して返します（デフォルトは最後）。

リストが空であるかインデックスが範囲外の場合、IndexErrorを発生させます。

remove（値）

S.remove（value） - 値の最初の出現を削除します。値が存在しない場合は、ValueErrorを発生させます。

reverse（）

S.reverse（） -逆の場所に

paths

このEnvPathに含まれるディレクトリのリストを返します。

クラスxonsh.tools.redirect_stderr（new_target ）

一時的にstderrを別のファイルにリダイレクトするためのコンテキストマネージャー。

クラスxonsh.tools.redirect_stdout（new_target ）

他のファイルにstdoutを一時的にリダイレクトするコンテキストマネージャー：

# How to send help() to stderr
with redirect_stdout(sys.stderr):
    help(dir)

# How to write help() to a file
with open('help.txt', 'w') as f:
    with redirect_stdout(f):
        help(pow)

主に後方互換性のためです。

xonsh.tools.always_false（x ）

戻り値False

xonsh.tools.always_true（x ）

Trueを返します。

xonsh.tools.ansicolors_to_ptk1_names（スタイルマップ）

スタイルマップの色付きの名前を古いPTK1の色名に変換します。

xonsh.tools.argvquote（arg、force = False ）

WindowsのCommandLineToArgvWが引数文字列を変更しないで返すように引用符で囲まれた引数を返します。これは引数のリストが与えられたときにPopenが行うのと同じことです。コマンドラインの引数はスペースで区切る必要があります。この関数はこれらのスペースを追加しません。この実装は、ここに概説されている提案に従います。https : //blogs.msdn.microsoft.com/twistylittlepassagesallalike/2011/04/23/everyone-quotes-command-line-arguments-the-wrong-way/

xonsh.tools.backup_file（fname ）

既存のファイルを、拡張の直前の現在の時刻を持つ新しい名前に移動します。

xonsh.tools.balanced_parens（行、mincol = 0、maxcol = None、lexer = None ）

式でカッコが釣り合っているかどうかを判定します。

xonsh.tools.bool_or_int_to_str（x ）

ブール値または整数を文字列に変換します。

xonsh.tools.bool_seq_to_csv（x ）

一連のboolをコンマ区切りの文字列に変換します。

xonsh.tools.bool_to_str（x ）

ブール値をFalseの場合は空の文字列に、Trueの場合は文字列 '1'に変換します。

xonsh.tools.carriage_return（）

キャリッジリターンをstdoutに書き出します。

xonsh.tools.cast_unicode（s、encoding = None ）

xonsh.tools.check_bad_str_token（tok ）

トークンが不正な文字列かどうかをチェックします。

xonsh.tools.check_for_partial_string（x ）

入力で見つかった最新のPython文字列の開始インデックス（両端を含む）、終了インデックス（排他）、および開始引用文字列を返します。

check_for_partial_string（x） - >（startix、endix、quote）

パラメーター：

x ： str

チェックされる文字列（端末入力の行を表す）

戻り値：

startix ： int（またはNone）

最新のPython文字列が見つかったインデックス（開始と終了を含む）、入力に文字列が存在しない場合はNone

endix ： int（またはNone）

最後のPython文字列が見つかったインデックス（排他的）、または入力に文字列が存在しない場合はNone、入力がPython文字列の途中で終了した場合はNone

quote ： str（またはNone）

文字列を開始するために使用される引用符を含む文字列（たとえば、b "、"、 '' '）、または文字列が見つからない場合はNone。

xonsh.tools.check_quotes（s ）

引用符で始まる場合は、引用符で終わることを確認するために文字列をチェックします。

xonsh.tools.color_style（）

現在のカラーマップを返します。

xonsh.tools.color_style_names（）

使用可能なすべてのスタイル名の繰り返し可能性を返します。

xonsh.tools.columnize（elems、width = 80、改行= '\ n' ）

文字列を反復可能にし、要素が列に配置された行のリストを返します。各行は最大幅の列になります。改行文字は各行の末尾に追加されます。

xonsh.tools.command_not_found（cmd ）

debian / ubuntu command-not-foundユーティリティを使用して、現在見つからないコマンドのパッケージを提案します。

xonsh.tools.csv_to_bool_seq（x ）

カンマで区切られた文字列を受け取り、それをboolのリストに変換します。

xonsh.tools.csv_to_set（x ）

文字列のコンマ区切りリストを文字列のセットに変換します。

xonsh.tools.decode（s、encoding = None ）

xonsh.tools.decode_bytes（b ）

使用可能な場合はXONSH_ENCODINGを使用してバイトをデコードしようとします。そうでない場合はsys.getdefaultencoding（）を使用します。

xonsh.tools.deprecated（deprecated_in = None、removed_in = None ）

関数を優雅に非難するパラメータ化されたデコレータ。

修飾された関数のdocstringを更新して、廃止予定が発生したバージョンと、これらの値が両方とも渡された場合に削除されるバージョンを示します。

removed_inが現在のリリースと同じかそれより小さいリリースでない場合warnings.warnは、詳細を表示しながら 呼び出しますDeprecationWarning。

removed_inが現在のリリースと同じかそれより小さいリリースの場合は、を引き上げますAssertionError。

パラメーター：

deprecated_in ： str

この関数を廃止したバージョン番号です。

removed_in ： str

この関数が削除されるバージョン番号。

xonsh.tools.dict_to_str（x ）

辞書を文字列に変換する

xonsh.tools.display_error_message（strip_xonsh_error_types = True ）

現在の例外のエラーメッセージをstderrに出力します。

xonsh.tools.dynamic_cwd_tuple_to_str（x ）

正規のcwd_widthタプルを文字列に変換します。

xonsh.tools.encode（u、encoding = None ）

xonsh.tools.ensure_slice（x ）

オブジェクトをスライスに変換し、失敗したときに文句を言う

xonsh.tools.ensure_string（x ）

xが文字列でない場合は文字列を返し、すでに存在する場合はxを返します。

xonsh.tools.ensure_timestamp（t、datetime_format = None ）

xonsh.tools.env_path_to_str（x ）

OSセパレータで結合することによって、環境パスを文字列に変換します。

xonsh.tools.escape_windows_cmd_string（s ）

Windowsのcmd.exeで使用可能な文字列を返します。エスケープはここの詳細と経験的テストに基づいています：http : //www.robvanderwoude.com/escapechars.php

xonsh.tools.executables_in（パス）

ユーザーが実行できるパス内のファイルのジェネレータを返します。

xonsh.tools.expand_case_matching（s ）

文字列を大文字と小文字を区別しないglobable文字列に展開します。

xonsh.tools.expand_path（s、expand_user = True ）

EXPAND_ENV_VARSが設定されている場合、expand_userが設定されている場合は環境変数に、〜は文字列パスを取り、〜に展開されます。

xonsh.tools.expanduser_abs_path（inp ）

ユーザーに絶対パスを展開します

xonsh.tools.expandvars（パス）

フォーム$ var、$ {var}、％var％のシェル変数を展開します。未知の変数は変更されません。

xonsh.tools.fallback（cond、backup ）

condがtrueの場合はオブジェクトを返すデコレータ、condがfalseの場合はバックアップを返します。

xonsh.tools.find_next_break（line、mincol = 0、lexer = None ）

サブプロセスモードで次の論理区切りの列番号を返します。この関数は、subproc_toks（）のmaxcol引数を見つけるのに便利です。

xonsh.tools.findfirst（s、substrs ）

指定された文字列の最初に指定された部分文字列のどれかを見つけ、その部分文字列を返します。そうした文字列がない場合はNoneを返します。

xonsh.tools.format_color（文字列、** kwargs ）

色を含む可能性のある文字列を書式設定します。これは、同じ名前のシェルインスタンスメソッドに単純にディスパッチします。この関数の結果は、print_color（）によって直接使用可能でなければなりません。

xonsh.tools.format_datetime（dt ）

$ XONSH_DATETIME_FORMAT Envで、datetimeオブジェクトを文字列ベースにフォーマットします。

xonsh.tools.format_std_prepost（テンプレート、env = None ）

標準バッファのテンプレート接頭辞/接尾辞文字列を書式設定します。プリペンドまたは追加に適した文字列を返します。

xonsh.tools.get_line_continuation（）

サブプロセスモードで使用される行継続文字。Windowsの対話モードでは、バックスラッシュの前にスペースが必要です。これは、Windows上のパスがバックスラッシュで終了する可能性があるためです。

xonsh.tools.get_logical_line（lines、idx ）

行のリストから1つの論理行（行継続がない行）を返します。この行はインデックスidxで始まる必要があります。これは、論理行がまたがる物理行の数も返します。行には改行を入れてはいけません

xonsh.tools.get_portions（それ、スライス）

反復可能な部分からの収穫。

パラメーター：

it：iterable

スライス：スライスまたはスライスオブジェクトのリスト

xonsh.tools.get_sep（）

OSとxonshオプションの設定に応じて、適切なファイルパスの区切り文字を返します。

xonsh.tools.globpath（s、ignore_case = False、return_empty = False、sort_result =なし、include_dotfiles = None ）

グロブを囲むシンプルなラッパーで、家庭やenvを拡張します。

xonsh.tools.hardcode_colors_for_win10（style_map ）

すべてのansiの色をハードコードされた色に置き換えて、conhost.exeの読み込み不能なデフォルトを回避する

xonsh.tools.history_tuple_to_str（x ）

有効な履歴タプルを正規の文字列に変換します。

xonsh.tools.iglobpath（s、ignore_case = False、sort_result =なし、include_dotfiles = None ）

自宅やenvを拡張するiglobの周りの簡単なラッパー。

xonsh.tools.indent（instr、nspaces = 4、ntabs = 0、flatten = False ）

指定された数のスペースまたはタブストップをインデントします。

indent（str、nspaces = 4、ntabs = 0） - > indent strをntabs + nspacesでインデントします。

パラメーター：

instr ： ベースストリング

インデントされる文字列。

nspaces ： int（デフォルト：4）

インデントされるスペースの数。

ntabs ： int（デフォルト：0）

インデントするタブの数。

flatten ： bool（デフォルト：False）

既存のインデントをスクラブするかどうか。Trueの場合、すべての行が同じインデントに揃えられます。Falseの場合、既存のインデントが厳密に増加します。

戻り値：

outstr ： ntabsとnspacesによってインデントされた文字列。

xonsh.tools.intensify_colors_for_cmd_exe（style_map ）

暗い色にマップする色がより明るいバージョンに置き換えられるように変更されたスタイルを返します。

xonsh.tools.intensify_colors_on_win_setter（有効）

INTENSIFY_COLORS_ON_WIN環境変数を設定するときにスタイルをリセットします。

xonsh.tools.is_balanced（expr、ltok、rtok ）

式にアンバランスな開閉トークンがあるかどうかを判定します。

xonsh.tools.is_bool（x ）

何かがブール値であるかどうかをテストします。

xonsh.tools.is_bool_or_int（x ）

値がブール値か整数かを返します。

xonsh.tools.is_bool_seq（x ）

オブジェクトがboolのシーケンスであるかどうかをテストします。

xonsh.tools.is_callable（x ）

何かが呼び出し可能かどうかをテストする

xonsh.tools.is_class（x ）

何かがクラスであるかどうかをテストする

xonsh.tools.is_completions_display_value（x ）

xonsh.tools.is_dynamic_cwd_width（x ）

入力がDYNAMIC_CWD_WIDTH環境変数の有効な入力であるかどうかを判別します。

xonsh.tools.is_env_path（x ）

これは、何かが環境パスであるかどうか、つまり文字列のリストをテストします。

xonsh.tools.is_float（x ）

何かがフロートであるかどうかをテストする

xonsh.tools.is_history_backend（x ）

有効な履歴バックエンドがあるかどうかをテストします。

xonsh.tools.is_history_tuple（x ）

何かが適切な履歴値であるかどうかをテストします。単位タプル。

xonsh.tools.is_int（x ）

何かが整数かどうかをテストする

xonsh.tools.is_int_as_str（x ）

文字列xが整数かどうかをテストします。そうでない場合、文字列はFalseを返します。

xonsh.tools.is_logfile_opt（x ）

xが有効な$ XONSH_TRACEBACK_LOGFILEオプションであるかどうかをチェックします。xが書き込み可能/作成可能ファイルでない場合、または空の文字列またはNoneの場合はFalseを返します。

xonsh.tools.is_nonstring_seq_of_strings（x ）

何かが一連の文字列であるかどうかをテストします。最上位のシーケンスは文字列自体ではありません。

xonsh.tools.is_slice（x ）

何かがスライスかどうかをテストする

xonsh.tools.is_slice_as_str（x ）

文字列xがスライスかどうかをテストします。そうでない場合、文字列はFalseを返します。

xonsh.tools.is_str_str_dict（x ）

何かがstr：str辞書かどうかをテストする

xonsh.tools.is_string（x ）

何かが文字列かどうかをテストする

xonsh.tools.is_string_or_callable（x ）

何かが文字列か呼び出し可能かどうかをテストする

xonsh.tools.is_string_seq（x ）

何かが一連の文字列であるかどうかをテストする

xonsh.tools.is_string_set（x ）

何かが文字列のセットであるかどうかをテストする

xonsh.tools.is_writable_file（ファイルパス）

ファイルパスが書き込みに有効かどうかをチェックします。

xonsh.tools.levenshtein（a、b、max_dist = inf ）

aとbの間のLevenshtein距離を計算します。

xonsh.tools.logfile_opt_to_str（x ）

$ XONSH_TRACEBACK_LOGFILEオプションを指定します。

xonsh.tools.normabspath（p ）

正規化された絶対パス、すなわちnormcase（abspath（p））として返します。

xonsh.tools.on_main_thread（）

メインスレッドかどうかをチェックします。

xonsh.tools.pathsep_to_seq（x ）

os.pathsepで区切られた文字列を一連の文字列に変換します。

xonsh.tools.pathsep_to_set（x ）

os.pathsepで区切られた文字列を一連の文字列に変換します。

xonsh.tools.pathsep_to_upper_seq（x ）

os.pathsepで区切られた文字列を大文字の文字列に変換します。

xonsh.tools.print_color（文字列、** kwargs ）

色を含む文字列を出力します。これは同じ名前のシェルメソッドにディスパッチされます。色がまだフォーマットされていない場合は、フォーマットされます。

xonsh.tools.print_exception（msg = None ）

トレースバックあり/なしの例外を出力します。

xonsh.tools.ptk2_color_depth_setter（x ）

$ PROMPT_TOOLKIT_COLOR_DEPTHのセッター機能。また、プロンプトツールキットが値を取得できるようにos.environを更新します。

xonsh.tools.replace_logical_line（lines、logical、idx、n ）

行末に続く行idxの行をn行にまたがる論理行に置き換えます。

xonsh.tools.safe_hasattr（obj、attr ）

最近のPythonのバージョンでは、hasattr（）はAttributeErrorしか捕まえません。これはすべてのエラーをキャッチします。

xonsh.tools.seq_to_pathsep（x ）

シーケンスをos.pathsepで区切られた文字列に変換します。

xonsh.tools.seq_to_upper_pathsep（x ）

シーケンスを大文字のos.pathsepで区切られた文字列に変換します。

xonsh.tools.set_to_csv（x ）

文字列のセットをカンマ区切りの文字列リストに変換します。

xonsh.tools.set_to_pathsep（x、sort = False ）

セットをos.pathsepで区切られた文字列に変換します。ソートkwargは、str変換の前にセットをソートするかどうかを指定します。

xonsh.tools.setup_win_unicode_console（有効）

msgstr "" "ウィンドウでユニコード表示を有効または無効にします。

xonsh.tools.str_to_env_path（x ）

文字列を環境セパレーター上で分割する環境パス、つまり文字列のリストに変換します。

xonsh.tools.strip_simple_quotes（s ）

文字列の前と後ろにある場合、一重引用符、二重引用符、単一の三重引用符、および単一の二重引用符を文字列から取り除きます。それ以外は何もしません。

xonsh.tools.subexpr_before_unbalanced（expr、ltok、rtok ）

最後のアンバランスな左トークンより前の式を取得します。

xonsh.tools.subexpr_from_unbalanced（expr、ltok、rtok ）

開始トークンに基づいて不均衡なグループ分けのための有効な部分式を引き出す試み、例えば。'（'、および閉じるトークン、例えば '）' これは完全なトークン化を行うものではありませんが、タブの補完に十分なはずです。

xonsh.tools.subproc_toks（line、mincol = -1、maxcol = None、lexer = None、returnline = False、greedy = False ）

キャプチャされていないサブプロセス[]のソースコード行のトークンを最小列からカプセル化します。トークンがない場合（つまりコメント行にある場合）、Noneを返します。greedyがTrueの場合、通常のカッコがカプセル化されます。GreedyはデフォルトでFalseです。

xonsh.tools.suggest_commands（cmd、env、aliases ）

環境とエイリアスを考慮した代替コマンドを提案します。

xonsh.tools.suggestion_sort_helper（x、y ）

yとどれほど似ているかに基づいてxのスコアを返します（低い方が良い）。提案のランク付けに使用されます。

xonsh.tools.swap（名前空間、名前、値、デフォルト= <オブジェクトオブジェクト> ）

名前空間内の現在の変数名を別の値にスワップし、コンテキストが終了したときに変数名を置き換えます。

xonsh.tools.swap_values（d、更新、デフォルト= <オブジェクトオブジェクト> ）

別のマッピングからの値で辞書（またはその他のマッピング）を更新し、コンテキストが終了したときに元のマッピングを復元します。

xonsh.tools.to_bool（x ）

意味的に意味のある方法でブール値に変換します。

xonsh.tools.to_bool_or_break（x ）

xonsh.tools.to_bool_or_int（x ）

値をブール値または整数に変換します。

xonsh.tools.to_completions_display_value（x ）

xonsh.tools.to_dict（x ）

文字列を辞書に変換する

xonsh.tools.to_dynamic_cwd_tuple（x ）

正規のcwd_widthタプルに変換します。

xonsh.tools.to_history_tuple（x ）

canonical history tupleに変換します。

xonsh.tools.to_itself（x ）

変換なし、それ自体を返します。

xonsh.tools.to_logfile_opt（x ）

$ XONSH_TRACEBACK_LOGFILEオプションを、書込み可能ファイルの場合はファイルパスを含むstrに、ファイルパスが有効でない場合はNoneに変換し、無効な選択についてstderrに通知します。

xonsh.tools.to_str_str_dict（x ）

文字列をstr：str辞書に変換する

xonsh.tools.uncapturable（f ）

呼び出し可能なエイリアスをキャプチャで実行しないことを指定するDecorator。これは、エイリアスがページャやテキストエディタのようなインタラクティブサブプロセスを呼び出す場合によく必要になります。

xonsh.tools.unthreadable（f ）

呼び出し可能なエイリアスがメインスレッドプロセス上でのみ実行されるように指定するデコレータ。これは、デバッガとプロファイラにしばしば必要です。

xonsh.tools.HISTORY_UNITS''、 ''、 ''、 ''、 ''、 ''、 '、'、 ' ）、 'cmd'：（ 'コマンド'、 'クラス' int '）、'バイト '：（' b '、' > '）'、 'cmds' :( 'コマンド'、 'クラス' int '>）、'コマンド '：（'コマンド '、'クラス 'int'>）、 'コマンド'：（ 'コマンド'、<クラス 'int （ 's'、<function <lambda >>）、 'days'：（ 's'、<function < lambda >>）、 'f'：（ 'files'、 'class' int '>）、' files '：（''gb' :( 'b'、<function <lambda>）、 'gig' :( 'b'、<function <lambda >>）、 'gigabyte'：（ ' 'b'、<function <lambda>、 'g'、 '関数'、 '関数'、 '関数' （ 's'、<function <lambda >>）、 'hour' :( 's'、<function <lambda >>）、 'hours' :( 's'、<function <lambda >>）、 'hr' （ 'b'、<function <lambda >>）、 'kilobyte'：（ 'b'、<function <lambda >>）、 'キロバイト'：（' b '、<function <lambda >>）、' m '：（' s '、<関数 'lambda'、関数 'lambda'）、 'メガバイト'：（ 'b'、関数 ' <関数> <関数> <関数> <関数> <関数> <関数> <関数> （ 's'、<function <lambda >>）、 'month'：（ 's'、<function <lambda >>）、 ' '、'関数 '、'関数 '、'関数 '、'関数 '、'関数 '、'関数 ' s '、<class' float '>）、' second '：（' s '、<class' float '>）、'b'、<function <lambda >>）、 'テラバイト'：（ 'b'、<function <lambda >>） '秒' :( 's'、<class 'float'>） （ 's'、<function <lambda >>、 '関数'、 '関数'、 '関数'、 '関数' （ 's'、<function <lambda >>）、 'yrs'：（ 's'、<function <lambda>）、 '年' >）}（ 's'、<function <lambda >>）、 'yr'、 '年'、 '年'、 ' ：（ 's'、<function <lambda >>）、 'yrs'：（ 's'、<function <lambda >>）}（ 's'、<function <lambda >>）、 'yr'、 '年'、 '年'、 ' ：（ 's'、<function <lambda >>）、 'yrs'：（ 's'、<function <lambda >>）}

小文字のユニット名を標準名と変換ユーティリティにマップします。

xonsh.tools.RE_BEGIN_STRING= re.compile（ '（[bBprRuUf] *（ "" | \' \ '\' | "| \ '）'））

引用符と先頭の文字（r、b、またはu）を含む文字列の先頭に一致する正規表現。

xonsh.tools.RE_STRING_CONT= <xonsh.lazyasd.LazyDictオブジェクト>

これらの引用符で始まる文字列の内容と一致する正規表現に開始引用符シーケンスをマッピングする辞書（引用符を含まない）

xonsh.tools.RE_STRING_START= re.compile（ '[bBprRuUf] *'）

文字列を始めるときに引用符の前の文字と一致する正規表現（r、b、またはu、大文字小文字を区別しない）

xonsh.tools.is_superuser