5.16.1 RawConfigParser オブジェクト

RawConfigParserクラスのインスタンスは以下のメソッドを持ちます:

defaults( ): インスタンス全体で使われるデフォルト値の辞書を返します。

sections( ): 利用可能なセクションのリストを返します。DEFAULTはこのリストに含まれません。

add_section( section): sectionという名前のセクションをインスタンスに追加します。同名のセクションが存在した場合、DuplicateSectionErrorが発生します。

has_section( section): 指定したセクションがコンフィグレーションファイルに存在するかを返します。 DEFAULTセクションは存在するとみなされません。

options( section): sectionで指定したセクションで利用できるオプションのリストを返します。

has_option( section, option): 与えられたセクションが存在してかつオプションが与えられていれば True を返し、そうでなければ False を返します。バージョン 1.6 で新たに追加された仕様です。

read( filenames)

ファイル名のリストを読んで解析をこころみ、うまく解析できたファイル名のリストを返します。もしfilenamesが文字列かユニコード文字列なら、1つのファイル名として扱われます。filenamesで指定されたファイルが開けない場合、そのファイルは無視されます。この挙動は設定ファイルが置かれる可能性のある場所(例えば、カレントディレクトリ、ホームディレクトリ、システム全体の設定を行うディレクトリ)を設定して、そこに存在する設定ファイルを読むことを想定して設計されています。設定ファイルが存在しなかった場合、ConfigParser のインスタンスは空のデータセットを持ちます。初期値の設定ファイルを先に読み込んでおく必要があるアプリケーションでは、readfp())を read()の前に呼び出すことでそのような動作を実現できます:

import ConfigParser, os

config = ConfigParser.ConfigParser()
config.readfp(open('defaults.cfg'))
config.read(['site.cfg', os.path.expanduser('~/.myapp.cfg')])

バージョン 2.4 で変更された仕様: うまく解析できたファイル名のリストを返す

readfp( fp[, filename]): fpで与えられるファイルかファイルのようなオブジェクトを読み込んで構文解析します(readline()メソッドだけを使います)。もし filenameが省略されてfpがname属性を持っていれば filenameの代わりに使われます。ファイル名の初期値は"<???>"です。

get( section, option): sectionのoption変数を取得します。

getint( section, option): sectionのoptionを整数として評価する関数です。

getfloat( section, option): sectionのoptionを浮動小数点数として評価する関数です。

getboolean( section, option): 指定した section の option 値をブール値に型強制する便宜メソッドです。option として受理できる値は、真 (True) としては "1"、 "yes"、 "true"、 "on" 、偽 (False) としては "0"、 "no"、 "false"、 "off" です。これらの文字列値に対しては大文字小文字の区別をしません。その他の値の場合には ValueError を送出します。

items( section): 与えられたsectionのそれぞれのオプションについて (name, value)ペアのリストを返します。

set( section, option, value): 与えられたセクションが存在していれば、オプションを指定された値に設定します。セクションが存在しなければ NoSectionError を発生させます。 RawConfigParser (あるいはraw パラメータをセットした ConfigParser) を文字列型でない値の 内部的な 格納場所として使うことは可能ですが、すべての機能 (置換やファイルへの出力を含む) がサポートされるのは文字列を値として使った場合だけです。バージョン 1.6 で新たに追加された仕様です。

write( fileobject): 設定を文字列表現に変換してファイルオブジェクトに書き出します。この文字列表現はread()で読み込むことができます。バージョン 1.6 で新たに追加された仕様です。

remove_option( section, option): 指定されたsectionから指定されたoptionを削除します。セクションが存在しなければ、NoSectionError を起こします。存在するオプションを削除した時は True を、そうでない時は False を返します。バージョン 1.6 で新たに追加された仕様です。

remove_section( section): 指定されたsectionを設定から削除します。もし指定されたセクションが存在すればTrue、そうでなければ Falseを返します。

optionxform( option): 入力ファイル中に見つかったオプション名か，クライアントコードから渡されたオプション名 option を，内部で利用する形式に変換します。デフォルトではoptionを全て小文字に変換した名前が返されます。サブルクラスではこの関数をオーバーライドすることでこの振舞いを替えることができます。たとえば、このメソッドをstr()に設定することで大小文字の差を区別するように変更することができます。

ご意見やご指摘をお寄せになりたい方は、 このドキュメントについて... をご覧ください。