18.1 `webbrowser` -- 便利なウェブブラウザコントローラー

webbrowserモジュールにはウェブベースのドキュメントを表示するための、とてもハイレベルなインターフェースが定義されています。たいていの環境では、このモジュールのopen()を呼び出すだけで正しく動作します。

Unixでは、X11上でグラフィカルなブラウザが選択されますが、グラフィカルなブラウザが利用できなかったり、X11が利用できない場合はテキストモードのブラウザが使われます。もしテキストモードのブラウザが使われたら、ユーザがブラウザから抜け出すまでプロセスの呼び出しはブロックされます。

環境変数BROWSERが存在するならプラットフォームのデフォルトであるブラウザのリストをオーバーライドし、os.pathsepで区切られたリストの順にブラウザの起動を試みます。リストの中の値に%sが含まれていたら、テキストモードのブラウザのコマンドラインとして%sの代わりにURLが引数として解釈されます；もし%sが含まれなければ、起動するブラウザの名前として単純に解釈されます。

非UnixプラットフォームあるいはUnix上でリモートブラウザが利用可能な場合、制御プロセスはユーザがブラウザを終了するのを待ちませんが、ディスプレイにブラウザのウィンドウを表示させたままにします。Unix上でリモートブラウザが利用可能でない場合、制御プロセスは新しいブラウザを立ち上げ、待ちます。

webbrowser スクリプトをこのモジュールのコマンドラインインタフェースとして使うことができます。スクリプトは引数に一つの URL を受け付けます。また次のオプション引数を受け付けます。 -n により可能ならば新しいブラウザウィンドウで指定された URL を開きます。一方、-t では新しいブラウザのページ(「タブ」) で開きます。当然ながらこれらのオプションは排他的です。

以下の例外が定義されています：

exception Error: ブラウザのコントロールエラーが起こると発生する例外。

以下の関数が定義されています：

open( url[, new=0[, autoraise=1]]): デフォルトのブラウザでurlを表示します。 newが 0 なら、urlはブラウザの今までと同じウィンドウで開きます。 newが 1 なら、可能であればブラウザの新しいウィンドウが開きます。 newが 2 なら、可能であればブラウザの新しいタブが開きます。 autoraiseがtrueなら、可能であればウィンドウが前面に表示されます（多くのウィンドウマネージャではこの変数の設定に関わらず、前面に表示されます）。バージョン 2.5 で変更された仕様: new を 2 にもできるようになりました

open_new( url): 可能であれば、デフォルトブラウザの新しいウィンドウでurlを開きますが、そうでない場合はブラウザのただ１つのウィンドウでurlを開きます。

open_new_tab( url): 可能であれば、デフォルトブラウザの新しいページ(「タブ」)でurlを開きますが、そうでない場合はopen_newと同様に振る舞います。バージョン 2.5 で新たに追加された仕様です。

get( [name]): ブラウザの種類nameのコントローラーオブジェクトを返します。もしnameが空文字列なら、呼び出した環境に適したデフォルトブラウザのコントローラーを返します。

register( name, constructor[, instance]): ブラウザの種類nameを登録します。ブラウザの種類が登録されたら、get()でそのブラウザのコントローラーを呼び出すことができます。 instanceが指定されなかったり、Noneなら、インスタンスが必要な時にはconstructorがパラメータなしに呼び出されて作られます。 instanceが指定されたら、constructorは呼び出されないので、 Noneでかまいません。
この登録は、変数BROWSERを設定するか、getを空文字列でなく、宣言したハンドラの名前と一致する引数とともに呼び出すときだけ、役に立ちます。

いくつかの種類のブラウザがあらかじめ定義されています。このモジュールで定義されている、関数get()に与えるブラウザの名前と、それぞれのコントローラークラスのインスタンスを以下の表に示します。

Type Name	Class Name	Notes
`'mozilla'`	`Mozilla('mozilla')`
`'firefox'`	`Mozilla('mozilla')`
`'netscape'`	`Mozilla('netscape')`
`'galeon'`	`Galeon('galeon')`
`'epiphany'`	`Galeon('epiphany')`
`'skipstone'`	`BackgroundBrowser('skipstone')`
`'kfmclient'`	`Konqueror()`	(1)
`'konqueror'`	`Konqueror()`	(1)
`'kfm'`	`Konqueror()`	(1)
`'mosaic'`	`BackgroundBrowser('mosaic')`
`'opera'`	`Opera()`
`'grail'`	`Grail()`
`'links'`	`GenericBrowser('links')`
`'elinks'`	`Elinks('elinks')`
`'lynx'`	`GenericBrowser('lynx')`
`'w3m'`	`GenericBrowser('w3m')`
`'windows-default'`	`WindowsDefault`	(2)
`'internet-config'`	`InternetConfig`	(3)
`'macosx'`	`MacOSX('default')`	(4)

Notes:

(1): ``Konqueror''はUnixのKDEデスクトップ環境のファイルマネージャで、KDEが動作している時にだけ意味を持ちます。何か信頼できる方法でKDEを検出するのがいいでしょう；変数KDEDIRでは十分ではありません。また、KDE 2でkonquerorコマンドを使うときにも、``kfm''が使われます -- Konquerorを動作させるのに最も良い方法が実装によって選択されます。
(2): Windowsプラットフォームのみ。
(3): MacOSプラットフォームのみ；Macintosh Library Modulesマニュアルに解説されている標準MacPythonモジュールic を必要とします。
(4): MacOS X プラットフォームのみ。

簡単な例を示します。

url = 'http://www.python.org'

# Open URL in a new tab, if a browser window is already open. 
webbrowser.open_new_tab(url + '/doc')

# Open URL in new window, raising the window if possible.
webbrowser.open_new(url)

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

18.1 webbrowser -- 便利なウェブブラウザコントローラー

18.1 `webbrowser` -- 便利なウェブブラウザコントローラー