https://github.com/python/cpython/commit/0b6acfee04b30e7993314723c614625ddd90ae6e
commit: 0b6acfee04b30e7993314723c614625ddd90ae6e
branch: main
author: Aarni Koskela <a...@iki.fi>
committer: AA-Turner <9087854+aa-tur...@users.noreply.github.com>
date: 2024-09-01T06:17:03+01:00
summary:
gh-123494: Improve documentation for ``webbrowser`` return types (#123495)
Document the return value for ``webbrowser.open*()``.
files:
M Doc/library/webbrowser.rst
M Lib/webbrowser.py
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 252ca92337e272..d2efc72113a917 100644
--- a/Lib/webbrowser.py
+++ b/Lib/webbrowser.py
@@ -80,6 +80,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:
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
