Skip to content

gh-125231: register firefox channels as Mozilla controller #149255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
durawat wants to merge 1 commit into
base: main
Choose a base branch
from
+46 −10
Open

gh-125231: register firefox channels as Mozilla controller #149255

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions Doc/library/webbrowser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,13 +152,15 @@ for the controller classes, all defined in this module.
+------------------------+-----------------------------------------+-------+
| ``'firefox'`` | ``Mozilla('mozilla')`` | |
+------------------------+-----------------------------------------+-------+
| ``'firefox-*'`` | ``Mozilla('mozilla')`` | \(1) |
+------------------------+-----------------------------------------+-------+
| ``'epiphany'`` | ``Epiphany('epiphany')`` | |
+------------------------+-----------------------------------------+-------+
| ``'kfmclient'`` | ``Konqueror()`` | \(1) |
| ``'kfmclient'`` | ``Konqueror()`` | \(2) |
+------------------------+-----------------------------------------+-------+
| ``'konqueror'`` | ``Konqueror()`` | \(1) |
| ``'konqueror'`` | ``Konqueror()`` | \(2) |
+------------------------+-----------------------------------------+-------+
| ``'kfm'`` | ``Konqueror()`` | \(1) |
| ``'kfm'`` | ``Konqueror()`` | \(2) |
+------------------------+-----------------------------------------+-------+
| ``'opera'`` | ``Opera()`` | |
+------------------------+-----------------------------------------+-------+
Expand All @@ -170,11 +172,11 @@ for the controller classes, all defined in this module.
+------------------------+-----------------------------------------+-------+
| ``'w3m'`` | ``GenericBrowser('w3m')`` | |
+------------------------+-----------------------------------------+-------+
| ``'windows-default'`` | ``WindowsDefault`` | \(2) |
| ``'windows-default'`` | ``WindowsDefault`` | \(3) |
+------------------------+-----------------------------------------+-------+
| ``'macosx'`` | ``MacOSXOSAScript('default')`` | \(3) |
| ``'macosx'`` | ``MacOSXOSAScript('default')`` | \(4) |
+------------------------+-----------------------------------------+-------+
| ``'safari'`` | ``MacOSXOSAScript('safari')`` | \(3) |
| ``'safari'`` | ``MacOSXOSAScript('safari')`` | \(4) |
+------------------------+-----------------------------------------+-------+
| ``'google-chrome'`` | ``Chrome('google-chrome')`` | |
+------------------------+-----------------------------------------+-------+
Expand All @@ -184,25 +186,30 @@ for the controller classes, all defined in this module.
+------------------------+-----------------------------------------+-------+
| ``'chromium-browser'`` | ``Chromium('chromium-browser')`` | |
+------------------------+-----------------------------------------+-------+
| ``'iosbrowser'`` | ``IOSBrowser`` | \(4) |
| ``'iosbrowser'`` | ``IOSBrowser`` | \(5) |
+------------------------+-----------------------------------------+-------+


Notes:

(1)
firefox-* are Firefox channels, such as firefox-dev, firefox-aurora,
firefox-beta, firefox-nightly, etc.

(2)
"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
the name "kfm" is used even when using the :program:`konqueror` command with KDE
2 --- the implementation selects the best strategy for running Konqueror.

(2)
(3)
Only on Windows platforms.

(3)
(4)
Only on macOS.

(4)
(5)
Only on iOS.

.. versionadded:: 3.2
Expand All @@ -221,6 +228,11 @@ Notes:
.. versionchanged:: 3.13
Support for iOS has been added.

.. versionchanged:: 3.15
Support for firefox-* has been added, which includes Firefox
channels such as firefox-dev, firefox-aurora, firefox-beta,
firefox-nightly, etc.

Here are some simple examples::

url = 'https://docs.python.org/'
Expand Down
16 changes: 16 additions & 0 deletions Lib/test/test_webbrowser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -526,6 +526,22 @@ def test_environment_preferred(self):
webbrowser = import_helper.import_fresh_module('webbrowser')
self.assertEqual(webbrowser.get().name, sys.executable)

@unittest.skipIf(
is_apple_mobile,
"Apple mobile doesn't allow modifying browser with environment"
)
def test_environment_firefox_channels_mocked_return_mozilla(self):
"""Test with mocked shutil.which that firefox channels yield Mozilla controller."""
firefox_channels = ["firefox-aurora", "firefox-nightly", "firefox-beta"]
for channel in firefox_channels:
with self.subTest(channel=channel):
with mock.patch("shutil.which") as mock_which:
mock_which.side_effect = lambda exe: exe == channel
with os_helper.EnvironmentVarGuard() as env:
env["BROWSER"] = channel
webbrowser = import_helper.import_fresh_module('webbrowser')
controller = webbrowser.get()
self.assertIsInstance(controller, webbrowser.Mozilla)

@force_not_colorized_test_class
class CliTest(unittest.TestCase):
Expand Down
4 changes: 4 additions & 0 deletions Lib/webbrowser.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -583,6 +583,10 @@ def register_standard_browsers():
_tryorder.insert(0, cmdline.lower())
continue

if cmdline.startswith("firefox-") and shutil.which(cmdline):
register(cmdline, None, Mozilla(cmdline), preferred=True)
continue

if cmdline != '':
cmd = _synthesize(cmdline, preferred=True)
if cmd[1] is None:
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/Library/2026-05-03-18-44-17.gh-issue-125231.Orj7KB.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
``register_standard_browsers`` in :mod:`webbrowser` registers firefox
channels (e.g. firefox-dev, firefox-aurora, firefox-beta, firefox-nightly,
etc.) as Mozilla controllers when BROWSER environment variable is set to
``"firefox-*"``.
Loading