tkinifile プログラム仕様
INIファイル操作のためのユーティリティクラスを提供します。
このモジュールは、INIファイル形式のデータを読み書きするための tkIniFile クラスを定義しています。 セクションやキー/値ペアの検索、追加、更新、削除などの機能を提供し、 既存のINIファイルの操作や新しいファイルの作成をサポートします。
tkinifile.py Technical Documentation
- tklib.tkinifile.main()[ソース]
tkinifileモジュールの基本的な使用例を示すメイン関数です。
tkIniFile クラスのインスタンス化、ファイルの読み込み、 特定のキーの値の取得、セクション全体の取得、および値の書き込みのデモンストレーションを行います。
- class tklib.tkinifile.tkIniFile(path=None, mode='r', OpenFile=1, IsPrint=True, **args)[ソース]
ベースクラス:
tkFileINIファイルを読み書きするためのクラスです。
tkFileクラスを継承し、INIファイル特有のセクションやキーの操作機能を提供します。 ファイルパスの管理、オープン/クローズ、行単位の読み書きなどの基本機能に加えて、 INIファイルの構造（セクション、キー、値）に基づいた高度な操作が可能です。
- FindKeyFromSectionRange(i0, i1, key, lines=None)[ソース]
指定されたセクション範囲内で、特定のキーの行インデックスを検索します。
INIファイルのセクション内の特定のキーを検索し、そのキーが存在する行のインデックスを返します。
- FindLastNonBlankLine(lines=None)[ソース]
指定された行リスト内で、最後の空白ではない行のインデックスを検索します。
ファイルに内容がある場合、ファイルの末尾から逆順に検索し、 空白ではない行（空白文字以外の文字を含む行）のインデックスを返します。
- FindSectionFromStr(section, lines=None)[ソース]
指定された行リスト内で、特定のセクションの開始、挿入、終了インデックスを検索します。
セクションが見つかった場合、そのセクションの開始行インデックス (i0)、 新しいキーを挿入するのに適したインデックス (iins)、およびセクションの最終行インデックス (i1) を返します。 挿入ポイント (iins) は、セクション内の最後の空白ではない行の次です。
- GetNextSection()[ソース]
現在のファイルポインタ位置から次のセクションを読み込みます。
ファイルの先頭から順に次のセクションヘッダを検索し、そのセクション名と そのセクションに属する行のリストを返します。 ファイルポインタは次のセクションの開始位置、またはファイルの終端に移動します。
- GetSection(section)[ソース]
INIファイルから指定されたセクションのすべての行を取得します。
指定されたセクションヘッダを検索し、次のセクションヘッダまたはファイルの終端までの行をリストで返します。 セクションのタイトル行は含まれません。
- GetString(section=None, key=None, defstr=None, IsPrint=False)[ソース]
INIファイルから文字列値を取得します（get_stringのエイリアス）。
このメソッドは get_string メソッドのラッパーです。 defstr パラメータは def_val として、IsPrint パラメータは is_print として get_string に渡されます。
- ReadAll(path=None, AddSection=0, ignore_keys=[], IsPrint=False, encoding=None)[ソース]
INIファイルからすべてのキーと値を読み込みます（read_allのエイリアス）。
このメソッドは read_all メソッドのラッパーです。 AddSection パラメータは、内部的にbool型に変換されて read_all に渡されます。
- パラメータ:
- 戻り値:
INIファイルから読み込まれたキーと値の辞書。
- 戻り値の型:
- WriteString(section, key, value, outfile=None, IsPrint=False)[ソース]
INIファイルにキーと値を書き込みます（write_stringのエイリアス）。
このメソッドは write_string メソッドのラッパーです。 IsPrint パラメータは、内部的に is_print として write_string に渡されます。
- get_string(section=None, key=None, def_val=None, is_print=False)[ソース]
INIファイルから指定されたセクションとキーの文字列値を取得します。
section と key の組み合わせによって、ファイル全体、特定のセクション、または特定のキーの値を読み込みます。 ファイルが開かれていない場合は、読み込みモードでファイルを開きます。
- パラメータ:
- 戻り値:
取得された文字列値、またはデフォルト値。 section のみが指定された場合、そのセクションの行リストが返されます。 section も key も指定されない場合、ファイル全体の行リストが返されます。 キーが見つからなかった場合、def_val が返されます。ファイルが開けない場合は def_val。
- 戻り値の型:
- read_all(path=None, section=None, AddSection=False, ignore_keys=[], IsPrint=False, encoding=None)[ソース]
INIファイルからすべてのキーと値を読み込みます。
特定のセクションのみを読み込むことも、返される辞書のキーにセクション名を含めることも可能です。 ファイルが開かれていない場合は読み込みモードでファイルを開きます。
- パラメータ:
path (str, optional) -- 読み込むINIファイルのパス。省略した場合、現在のファイルパスを使用します。
section (str, optional) -- 読み込む対象のセクション名。指定した場合、そのセクション内のキーのみを返します。
AddSection (bool, optional) -- 返される辞書のキーにセクション名を含めるかどうか。Trueの場合、「セクション名/キー」の形式になります。
IsPrint (bool, optional) -- デバッグ情報を出力するかどうかのフラグ。デフォルトはFalse。
encoding (str, optional) -- ファイルのエンコーディング。デフォルトはNone（chardetで自動判定）。
- 戻り値:
INIファイルから読み込まれたキーと値の辞書。ファイルが開けない場合はNone。
- 戻り値の型:
dict or None
- var = {}
- write_from_scratch(outfile, section, **kwargs)[ソース]
新しいINIファイルをゼロから作成し、指定されたセクションとキー/値を書き込みます。
outfile で指定されたファイルが存在する場合、その内容は上書きされます。 指定されたセクションと、キーワード引数で与えられたキー/値ペアが書き込まれます。