webbrowser — 方便的 Web 浏览器控制器 — Python 文档

来自菜鸟教程
Python/docs/3.7/library/webbrowser
跳转至:导航、​搜索

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

源代码: :source:`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 为 1,则可能会打开一个新的浏览器窗口。 如果 new 为 2,则可能会打开一个新的浏览器页面(“选项卡”)。 如果 autoraiseTrue,则尽可能提升窗口(请注意,在许多窗口管理器中,无论此变量的设置如何,都会发生这种情况)。

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

webbrowser.open_new(url)
如果可能,在默认浏览器的新窗口中打开 url,否则,在唯一的浏览器窗口中打开 url
webbrowser.open_new_tab(url)
如果可能,在默认浏览器的新页面(“标签”)中打开 url,否则等效于 open_new()
webbrowser.get(using=None)
使用 返回浏览器类型 的控制器对象。 如果 usingNone,则返回适合调用者环境的默认浏览器的控制器。
webbrowser.register(name, constructor, instance=None, *, preferred=False)

注册浏览器类型名称。 注册浏览器类型后,get() 函数可以返回该浏览器类型的控制器。 如果未提供 instance,或者是 None,则将在需要时不带参数调用 constructor 以创建实例。 如果提供了 instance,则永远不会调用 constructor,并且可能是 None

preferred 设置为 True 使该浏览器成为无参数的 get() 调用的首选结果。 否则,此入口点仅在您计划设置 BROWSER 变量或使用与您的处理程序名称匹配的非空参数调用 get() 时才有用宣布。

3.7 版更改:添加了 preferred 仅关键字参数。

预定义了多种浏览器类型。 该表给出了可以传递给 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. “Konqueror”是 Unix 的 KDE 桌面环境的文件管理器,只有在 KDE 运行时才有意义。 某种可靠地检测 KDE 的方法会很好; KDEDIR 变量是不够的。 另请注意,即使在 KDE 2 中使用 konqueror 命令时,也会使用名称“kfm”——该实现会选择运行 Konqueror 的最佳策略。
  2. 仅在 Windows 平台上。
  3. 仅在 Mac OS X 平台上。

3.3 新功能: 增加了对 Chrome/Chromium 的支持。


下面是一些简单的例子:

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 为 1,则可能会打开一个新的浏览器窗口。 如果 new 为 2,则可能会打开一个新的浏览器页面(“选项卡”)。
controller.open_new(url)
如果可能,在此控制器处理的浏览器的新窗口中打开 url,否则,在唯一的浏览器窗口中打开 url。 别名 open_new()
controller.open_new_tab(url)
如果可能,在此控制器处理的浏览器的新页面(“选项卡”)中打开 url,否则等效于 open_new()

脚注

1
此处命名的没有完整路径的可执行文件将在 PATH 环境变量中给出的目录中搜索。