summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorHugo van Kemenade <hugovk@users.noreply.github.com>2023-05-26 13:54:15 (GMT)
committerGitHub <noreply@github.com>2023-05-26 13:54:15 (GMT)
commit5ab4bc05c459f25c9d1dcb9b20f10bbd7e6eae5e (patch)
treed6f51ba5e12659c321f11d9d75ec0390ed561d6f /Doc
parentafa759fb800be416f69e3e9c9b3efe68006316f5 (diff)
downloadcpython-5ab4bc05c459f25c9d1dcb9b20f10bbd7e6eae5e.zip
cpython-5ab4bc05c459f25c9d1dcb9b20f10bbd7e6eae5e.tar.gz
cpython-5ab4bc05c459f25c9d1dcb9b20f10bbd7e6eae5e.tar.bz2
gh-104804: Remove webbrowser.MacOSX class, deprecated in Python 3.11 (#104816)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Victor Stinner <vstinner@python.org>
Diffstat (limited to 'Doc')
-rw-r--r--Doc/library/webbrowser.rst52
-rw-r--r--Doc/tools/.nitignore1
-rw-r--r--Doc/whatsnew/3.13.rst5
3 files changed, 32 insertions, 26 deletions
diff --git a/Doc/library/webbrowser.rst b/Doc/library/webbrowser.rst
index 61db804..2f0b5fe 100644
--- a/Doc/library/webbrowser.rst
+++ b/Doc/library/webbrowser.rst
@@ -20,7 +20,7 @@ will be used if graphical browsers are not available or an X11 display isn't
available. If text-mode browsers are used, the calling process will block until
the user exits the browser.
-If the environment variable :envvar:`BROWSER` exists, it is interpreted as the
+If the environment variable :envvar:`!BROWSER` exists, it is interpreted as the
:data:`os.pathsep`-separated list of browsers to try ahead of the platform
defaults. When the value of a list part contains the string ``%s``, then it is
interpreted as a literal browser command line to be used with the argument URL
@@ -97,7 +97,7 @@ The following functions are defined:
Setting *preferred* to ``True`` makes this browser a preferred result for
a :func:`get` call with no argument. Otherwise, this entry point is only
- useful if you plan to either set the :envvar:`BROWSER` variable or call
+ useful if you plan to either set the :envvar:`!BROWSER` variable or call
:func:`get` with a nonempty argument matching the name of a handler you
declare.
@@ -111,41 +111,41 @@ for the controller classes, all defined in this module.
+------------------------+-----------------------------------------+-------+
| Type Name | Class Name | Notes |
+========================+=========================================+=======+
-| ``'mozilla'`` | :class:`Mozilla('mozilla')` | |
+| ``'mozilla'`` | ``Mozilla('mozilla')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'firefox'`` | :class:`Mozilla('mozilla')` | |
+| ``'firefox'`` | ``Mozilla('mozilla')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'epiphany'`` | :class:`Epiphany('epiphany')` | |
+| ``'epiphany'`` | ``Epiphany('epiphany')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'kfmclient'`` | :class:`Konqueror()` | \(1) |
+| ``'kfmclient'`` | ``Konqueror()`` | \(1) |
+------------------------+-----------------------------------------+-------+
-| ``'konqueror'`` | :class:`Konqueror()` | \(1) |
+| ``'konqueror'`` | ``Konqueror()`` | \(1) |
+------------------------+-----------------------------------------+-------+
-| ``'kfm'`` | :class:`Konqueror()` | \(1) |
+| ``'kfm'`` | ``Konqueror()`` | \(1) |
+------------------------+-----------------------------------------+-------+
-| ``'opera'`` | :class:`Opera()` | |
+| ``'opera'`` | ``Opera()`` | |
+------------------------+-----------------------------------------+-------+
-| ``'links'`` | :class:`GenericBrowser('links')` | |
+| ``'links'`` | ``GenericBrowser('links')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'elinks'`` | :class:`Elinks('elinks')` | |
+| ``'elinks'`` | ``Elinks('elinks')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'lynx'`` | :class:`GenericBrowser('lynx')` | |
+| ``'lynx'`` | ``GenericBrowser('lynx')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'w3m'`` | :class:`GenericBrowser('w3m')` | |
+| ``'w3m'`` | ``GenericBrowser('w3m')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'windows-default'`` | :class:`WindowsDefault` | \(2) |
+| ``'windows-default'`` | ``WindowsDefault`` | \(2) |
+------------------------+-----------------------------------------+-------+
-| ``'macosx'`` | :class:`MacOSXOSAScript('default')` | \(3) |
+| ``'macosx'`` | ``MacOSXOSAScript('default')`` | \(3) |
+------------------------+-----------------------------------------+-------+
-| ``'safari'`` | :class:`MacOSXOSAScript('safari')` | \(3) |
+| ``'safari'`` | ``MacOSXOSAScript('safari')`` | \(3) |
+------------------------+-----------------------------------------+-------+
-| ``'google-chrome'`` | :class:`Chrome('google-chrome')` | |
+| ``'google-chrome'`` | ``Chrome('google-chrome')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'chrome'`` | :class:`Chrome('chrome')` | |
+| ``'chrome'`` | ``Chrome('chrome')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'chromium'`` | :class:`Chromium('chromium')` | |
+| ``'chromium'`` | ``Chromium('chromium')`` | |
+------------------------+-----------------------------------------+-------+
-| ``'chromium-browser'`` | :class:`Chromium('chromium-browser')` | |
+| ``'chromium-browser'`` | ``Chromium('chromium-browser')`` | |
+------------------------+-----------------------------------------+-------+
Notes:
@@ -153,7 +153,7 @@ Notes:
(1)
"Konqueror" is the file manager for the KDE desktop environment for Unix, and
only makes sense to use if KDE is running. Some way of reliably detecting KDE
- would be nice; the :envvar:`KDEDIR` variable is not sufficient. Note also that
+ would be nice; the :envvar:`!KDEDIR` variable is not sufficient. Note also that
the name "kfm" is used even when using the :program:`konqueror` command with KDE
2 --- the implementation selects the best strategy for running Konqueror.
@@ -163,6 +163,11 @@ Notes:
(3)
Only on macOS platform.
+.. versionadded:: 3.2
+ A new :class:`!MacOSXOSAScript` class has been added
+ and is used on Mac instead of the previous :class:`!MacOSX` class.
+ This adds support for opening browsers not currently set as the OS default.
+
.. versionadded:: 3.3
Support for Chrome/Chromium has been added.
@@ -171,9 +176,6 @@ Notes:
Removed browsers include Grail, Mosaic, Netscape, Galeon,
Skipstone, Iceape, and Firefox versions 35 and below.
-.. deprecated-removed:: 3.11 3.13
- :class:`MacOSX` is deprecated, use :class:`MacOSXOSAScript` instead.
-
Here are some simple examples::
url = 'https://docs.python.org/'
@@ -222,4 +224,4 @@ module-level convenience functions:
.. rubric:: Footnotes
.. [1] Executables named here without a full path will be searched in the
- directories given in the :envvar:`PATH` environment variable.
+ directories given in the :envvar:`!PATH` environment variable.
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index fb29690..2617026 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -229,7 +229,6 @@ Doc/library/urllib.request.rst
Doc/library/uuid.rst
Doc/library/wave.rst
Doc/library/weakref.rst
-Doc/library/webbrowser.rst
Doc/library/winreg.rst
Doc/library/winsound.rst
Doc/library/wsgiref.rst
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index 28c9855..6e8f02b 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -115,6 +115,11 @@ Removed
are now removed. The items in those namespaces can be imported directly
from :mod:`typing`. (Contributed by Sebastian Rittau in :gh:`92871`.)
+* Remove the untested and undocumented :mod:`webbrowser` :class:`!MacOSX` class,
+ deprecated in Python 3.11.
+ Use the :class:`!MacOSXOSAScript` class (introduced in Python 3.2) instead.
+ (Contributed by Hugo van Kemenade in :gh:`104804`.)
+
* Remove support for using :class:`pathlib.Path` objects as context managers.
This functionality was deprecated and made a no-op in Python 3.9.