netrc --- netrc ファイルの処理¶
ソースコード: Lib/netrc.py
netrc クラスは、Unix ftp プログラムや他の FTP クライアントで用いられる netrc ファイル形式を解析し、カプセル化 (encapsulate) します。
-
class
netrc.netrc([file])¶ netrcのインスタンスやサブクラスのインスタンスは netrc ファイルのデータをカプセル化します。 初期化の際の引数が存在する場合、解析対象となるファイルの指定になります。 引数がない場合、 (os.path.expanduser()で特定される) ユーザのホームディレクトリ下にある.netrcが読み出されます。ファイルが見付からなかった場合はFileNotFoundError例外が送出されます。 解析エラーが発生した場合、ファイル名、行番号、解析を中断したトークンに関する情報の入ったNetrcParseErrorを送出します。 POSIX システムにおいて引数を指定しない場合、ファイルのオーナシップやパーミッションが安全でない (プロセスを実行しているユーザ以外が所有者であるか、誰にでも読み書き出来てしまう) のに.netrcファイル内にパスワードが含まれていると、NetrcParseErrorを送出します。 このセキュリティ的な振る舞いは、 ftp などの.netrcを使うプログラムと同じものです。バージョン 3.4 で変更: POSIX パーミッションのチェックが追加されました。
バージョン 3.7 で変更: 引数で file が渡されなかったときは、
.netrcファイルの場所を探すのにos.path.expanduser()が使われるようになりました。バージョン 3.10 で変更:
netrcはロケール指定のエンコードを使う前に UTF-8 エンコードを試します。
-
exception
netrc.NetrcParseError¶ ソースファイルのテキスト中で文法エラーに遭遇した場合に
netrcクラスによって送出される例外です。 この例外のインスタンスは 3 つのインスタンス変数を持っています:msgはテキストによるエラーの説明、filenameはソースファイルの名前、そしてlinenoはエラーが発見された行番号です。
netrc オブジェクト¶
netrc インスタンスは以下のメソッドを持っています:
-
netrc.authenticators(host)¶ host の認証情報として、三要素のタプル
(login, account, password)を返します。与えられた host に対するエントリが netrc ファイルにない場合、'default' エントリに関連付けられたタプルが返されます。host に対応するエントリがなく、default エントリもない場合、Noneを返します。
-
netrc.__repr__()¶ クラスの持っているデータを netrc ファイルの書式に従った文字列で出力します。(コメントは無視され、エントリが並べ替えられる可能性があります。)
netrc のインスタンスは以下の public なインスタンス変数を持っています:
-
netrc.hosts¶ ホスト名を
(login, account, password)からなるタプルに対応づけている辞書です。'default' エントリがある場合、その名前の擬似ホスト名として表現されます。
-
netrc.macros¶ マクロ名を文字列のリストに対応付けている辞書です。
注釈
利用可能なパスワードの文字セットは、ASCII のサブセットのみです。全ての ASCII の記号を使用することができます。しかし、空白文字と印刷不可文字を使用することはできません。この制限は .netrc ファイルの解析方法によるものであり、将来解除されます。