webbrowser ---方便的网络浏览器控制器

源代码: Lib/webbrowser.py


这个 webbrowser 模块提供了一个高级界面,允许向用户显示基于Web的文档。在大多数情况下,只需调用 open() 这个模块的功能可以做正确的事情。

在UNIX下,图形浏览器在x11下是首选的,但如果图形浏览器不可用或x11显示器不可用,则将使用文本模式浏览器。如果使用文本模式浏览器,调用过程将被阻止,直到用户退出浏览器。

如果环境变量 BROWSER 存在,它被解释为 os.pathsep -要先于平台默认值尝试的浏览器的分隔列表。当列表部分的值包含字符串时 %s ,然后将其解释为文本浏览器命令行,以替换参数url %s ;如果零件不包含 %s ,它只是简单地解释为要启动的浏览器的名称。 1

对于非UNIX平台,或者当远程浏览器在UNIX上可用时,控制进程不会等待用户完成浏览器,而是允许远程浏览器在显示器上维护自己的窗口。如果远程浏览器在Unix上不可用,控制进程将启动新的浏览器并等待。

剧本 webbrowser 可以用作模块的命令行接口。它接受一个URL作为参数。它接受以下可选参数: -n 如果可能,在新的浏览器窗口中打开URL; -t 在新的浏览器页面(“选项卡”)中打开URL。这些选择自然是相互排斥的。使用实例:

python -m webbrowser -t "http://www.python.org"

定义了以下异常:

exception webbrowser.Error

发生浏览器控件错误时引发异常。

定义了以下功能:

webbrowser.open(url, new=0, autoraise=True)

显示 url 使用默认浏览器。如果 new 是0, url 如果可能,将在同一浏览器窗口中打开。如果 new 如果可能,将打开一个新的浏览器窗口。如果 new 如果可能,将打开新的浏览器页面(“选项卡”)。如果 自动调整True ,如果可能,将引发窗口(请注意,在许多窗口管理器下,无论此变量的设置如何,都会发生这种情况)。

请注意,在某些平台上,尝试使用此函数打开文件名可能会工作并启动操作系统的关联程序。但是,这既不受支持,也不可移植。

提出一个 auditing event webbrowser.open 带着论证 url .

webbrowser.open_new(url)

正常开放 url 在默认浏览器的新窗口中,如果可能,否则打开 url 在唯一的浏览器窗口中。

webbrowser.open_new_tab(url)

正常开放 url 在默认浏览器的新页面(“选项卡”)中(如果可能),否则等同于 open_new() .

webbrowser.get(using=None)

返回浏览器类型的控制器对象 使用 . 如果 使用None ,返回一个适合调用者环境的默认浏览器的控制器。

webbrowser.register(name, constructor, instance=None, *, preferred=False)

注册浏览器类型 name . 注册浏览器类型后, get() 函数可以返回该浏览器类型的控制器。如果 实例 未提供,或 Noneconstructor 将在需要时不带参数调用以创建实例。如果 实例 提供, constructor 永远不会被召唤,也可能 None .

设置 首选True 使此浏览器成为 get() 不带参数调用。否则,只有当您计划将 BROWSER 变量或调用 get() 使用一个与您声明的处理程序名称匹配的非空参数。

在 3.7 版更改: 首选 只添加关键字参数。

许多浏览器类型是预先定义的。此表提供可以传递给 get() 函数和控制器类的相应实例化,均在此模块中定义。

类型名

类名

笔记

'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)

'macosx'

MacOSX('default')

(3)

'safari'

MacOSX('safari')

(3)

'google-chrome'

Chrome('google-chrome')

'chrome'

Chrome('chrome')

'chromium'

Chromium('chromium')

'chromium-browser'

Chromium('chromium-browser')

笔记:

  1. “konkeror”是用于UNIX的kde桌面环境的文件管理器,仅在kde正在运行时才有意义。某种可靠地检测kde的方法是很好的; KDEDIR 变量不足。还要注意,即使在使用 konqueror 使用kde 2命令——实现选择运行konkeror的最佳策略。

  2. 仅在Windows平台上。

  3. 仅在Mac OS X平台上。

3.3 新版功能: 增加了对铬/铬的支持。

以下是一些简单的例子:

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

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

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

浏览器控制器对象

浏览器控制器提供的这些方法与模块级的三个便利功能并行:

controller.open(url, new=0, autoraise=True)

显示 url 使用此控制器处理的浏览器。如果 new 如果可能,将打开一个新的浏览器窗口。如果 new 如果可能,将打开新的浏览器页面(“选项卡”)。

controller.open_new(url)

正常开放 url 在该控制器处理的浏览器的新窗口中,如果可能,否则打开 url 在唯一的浏览器窗口中。别名 open_new() .

controller.open_new_tab(url)

正常开放 url 在由该控制器处理的浏览器的新页面(“选项卡”)中,如果可能,否则等同于 open_new() .

脚注

1

此处命名的没有完整路径的可执行文件将在 PATH 环境变量。