webbrowser — Удобный контроллер веб-браузера

Исходный код: Lib/webbrowser.py

Модуль webbrowser предоставляет интерфейс высокого уровня для отображения веб-документов пользователям. В большинстве случаев, просто вызов функции 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, открывается новая страница браузера («вкладка»), если возможно. Если autoraise равно True, окно поднимается, если возможно (обратите внимание, что во многих менеджерах окон это произойдёт независимо от настройки этой переменной).

Обратите внимание, что на некоторых платформах попытка открыть файл с помощью этой функции может сработать и запустить связанную программу операционной системы. Однако это не поддерживается и не является переносимым.

Вызывает событие аудита auditing event webbrowser.open с аргументом url.

webbrowser.open_new(url)

Открывает url в новом окне браузера по умолчанию, если возможно, в противном случае открывает url в единственном окне браузера.

webbrowser.open_new_tab(url)

Открывает url в новой странице («вкладке») браузера по умолчанию, если возможно, в противном случае эквивалентно open_new().

webbrowser.get(using=None)

Возвращает объект-контроллер для типа браузера using. Если using равно None, возвращает контроллер для браузера по умолчанию, соответствующего среде вызывающего элемента.

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

Регистрирует тип браузера name. После регистрации типа браузера функция get() может вернуть контроллер для этого типа браузера. Если instance не указан или равен None, constructor будет вызван без параметров для создания экземпляра при необходимости. Если instance предоставлен, constructor никогда не будет вызван и может быть None.

Установление preferred в True делает этот браузер предпочтительным результатом для вызова get() без аргумента. В противном случае эта точка входа полезна только в том случае, если вы планируете установить переменную BROWSER или вызвать get() с непустым аргументом, соответствующим имени обработчика, который вы объявляете.

Изменено в версии 3.7: Параметр preferred добавлен в качестве ключевого параметра.

Несколько типов браузеров предварительно определены. В этой таблице приведены имена типов, которые могут передаваться функции get(), и соответствующие экземпляры для классов-контроллеров, все определённые в этом модуле.

Примечания:

1. «Konqueror» — это файловый менеджер для настольной среды KDE в Unix, и его целесообразно использовать только при запуске KDE. Было бы неплохо иметь надёжный способ определения KDE; переменная KDEDIR недостаточна. Также обратите внимание, что имя «kfm» используется даже при использовании команды konqueror с KDE 2 — реализация выбирает наилучшую стратегию запуска Konqueror.
2. Только на платформах Windows.
3. Только на платформе Mac OS X.

Вот несколько простых примеров:

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)