From 5dcc8b6c8b5621fea7bfabe3cf37f91c3a68c196 Mon Sep 17 00:00:00 2001 From: Aarni Koskela Date: Sun, 1 Sep 2024 08:17:03 +0300 Subject: [PATCH] gh-123494: Improve documentation for ``webbrowser`` return types (GH-123495) Document the return value for ``webbrowser.open*()``. (cherry picked from commit 0b6acfee04b30e7993314723c614625ddd90ae6e) Co-authored-by: Aarni Koskela --- Doc/library/webbrowser.rst | 7 +++++++ Lib/webbrowser.py | 3 +++ 2 files changed, 10 insertions(+) diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst index 334f21f01c14c0..4a155974dbd2f5 100644 --- a/Doc/library/webbrowser.rst +++ b/Doc/library/webbrowser.rst @@ -72,6 +72,8 @@ The following functions are defined: (note that under many window managers this will occur regardless of the setting of this variable). + Returns ``True`` if a browser was successfully launched, ``False`` otherwise. + Note that on some platforms, trying to open a filename using this function, may work and start the operating system's associated program. However, this is neither supported nor portable. @@ -84,11 +86,16 @@ The following functions are defined: Open *url* in a new window of the default browser, if possible, otherwise, open *url* in the only browser window. + Returns ``True`` if a browser was successfully launched, ``False`` otherwise. + + .. function:: open_new_tab(url) Open *url* in a new page ("tab") of the default browser, if possible, otherwise equivalent to :func:`open_new`. + Returns ``True`` if a browser was successfully launched, ``False`` otherwise. + .. function:: get(using=None) diff --git a/Lib/webbrowser.py b/Lib/webbrowser.py index b7fbc41853ea65..3101afad362a37 100755 --- a/Lib/webbrowser.py +++ b/Lib/webbrowser.py @@ -81,6 +81,9 @@ def open(url, new=0, autoraise=True): - 1: a new browser window. - 2: a new browser page ("tab"). If possible, autoraise raises the window (the default) or not. + + If opening the browser succeeds, return True. + If there is a problem, return False. """ if _tryorder is None: with _lock: