tkargs プログラム仕様

コマンドライン引数を管理するための tkArgs クラスを提供するモジュール。

このモジュールは、argparse.ArgumentParser と tklib.tkobject.tkObject を継承した tkArgs クラスを定義します。これにより、コマンドライン引数の追加と解析を容易にし、 プログラムに関するメタ情報（ファイル名、バージョン、作者など）の管理も行います。 プログラムの引数処理を簡素化し、共通のオブジェクトプロパティを統合するのに役立ちます。

関連リンク:

tkargs.py 技術ドキュメント

class tklib.tkargs.tkArgs(program_file=None, program_path=None, version=None, author=None, creation_date=None, last_update_date=None, **kwargs)

ベースクラス: ArgumentParser, tkObject

コマンドライン引数を処理するためのクラス。

このクラスは、argparse.ArgumentParser の機能と tklib.tkobject.tkObject の共通プロパティを組み合わせ、 プログラムの引数解析と情報管理を簡素化します。 ファイル名、バージョン、作者、作成日、最終更新日などのプログラム情報を保持できます。

add_arg(key1, key2=None, nargs='?', **kwargs)

コマンドライン引数を追加します。

argparse.ArgumentParser.add_argument のラッパーであり、引数に 'nargs' を デフォルトで設定する機能を提供します。

パラメータ:

• key1 -- str: 引数の名前。例: "-f" または "--file"。

• key2 -- str, optional: 引数の名前（ショートオプションなど）。None の場合、key1 のみが使用されます。

• nargs -- str, optional: 引数の予想される数。デフォルトは '?'。

• kwargs -- dict: argparse.ArgumentParser.add_argument に渡される追加キーワード引数。

戻り値:

None

add_floatarg(key1, key2=None, nargs='?', type=<class 'float'>, **kwargs)

float型のコマンドライン引数を追加します。

argparse.ArgumentParser.add_argument を呼び出しますが、 引数の type を float に設定します。

パラメータ:

• key1 -- str: 引数の名前。例: "-v" または "--value"。

• key2 -- str, optional: 引数の名前。None の場合、key1 のみが使用されます。

• nargs -- str, optional: 引数の予想される数。デフォルトは '?'。

• type -- type, optional: 引数の型。デフォルトは float。

• kwargs -- dict: argparse.ArgumentParser.add_argument に渡される追加キーワード引数。

戻り値:

None

add_intarg(key1, key2=None, nargs='?', type=<class 'int'>, **kwargs)

int型のコマンドライン引数を追加します。

argparse.ArgumentParser.add_argument を呼び出しますが、 引数の type を int に設定します。

パラメータ:

• key1 -- str: 引数の名前。例: "-c" または "--count"。

• key2 -- str, optional: 引数の名前。None の場合、key1 のみが使用されます。

• nargs -- str, optional: 引数の予想される数。デフォルトは '?'。

• type -- type, optional: 引数の型。デフォルトは int。

• kwargs -- dict: argparse.ArgumentParser.add_argument に渡される追加キーワード引数。

戻り値:

None

checkkwargs(nargs='?', **kwargs)

add_arg メソッドに渡されるキーワード引数をチェックし、修正します。

特に 'action' が 'version' に設定されている場合は 'nargs' を変更せず、 それ以外の場合は指定されたデフォルトの 'nargs' を設定します。

パラメータ:

• nargs -- str, optional: 'nargs' のデフォルト値。デフォルトは '?'。

• kwargs -- dict: チェック対象のキーワード引数。

戻り値:

dict: 修正されたキーワード引数。

initialize(**kwargs)

argparse.ArgumentParser の初期化を行います。

tkArgs クラスのインスタンスが作成された後、追加の argparse.ArgumentParser 固有の 引数で初期化が必要な場合に使用されます。

パラメータ:

kwargs -- dict: argparse.ArgumentParser のコンストラクタに渡されるキーワード引数。

戻り値:

None

print_args(print_attributes=0, print_args=1)

プログラムの属性と解析されたコマンドライン引数を出力します。

tkObject の print_attributes メソッドと argparse.ArgumentParser.parse_args の結果を組み合わせて表示します。

パラメータ:

• print_attributes -- int, optional: オブジェクトの属性を出力するかどうかを示すフラグ。1 の場合出力します。デフォルトは 0。

• print_args -- int, optional: 解析された引数を出力するかどうかを示すフラグ。1 の場合出力します。デフォルトは 1。

戻り値:

None