← 返回首页
bpo-43137: webbrowser: Replace gvfs-open and gnome-open with "gio open" by smcv · Pull Request #29154 · python/cpython · GitHub
Skip to content

Navigation Menu

Toggle navigation
Sign in
Appearance settings
Search or jump to...

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted
Cancel Submit feedback

Saved searches

Use saved searches to filter your results more quickly

Cancel Create saved search
Appearance settings
Resetting focus

bpo-43137: webbrowser: Replace gvfs-open and gnome-open with "gio open"#29154

Merged
miss-islington merged 4 commits into
python:mainfrom
smcv:gio-open
Nov 25, 2021
Merged

bpo-43137: webbrowser: Replace gvfs-open and gnome-open with "gio open"#29154
miss-islington merged 4 commits into
python:mainfrom
smcv:gio-open

Conversation

smcv commented Oct 22, 2021 •
edited by miss-islington
Loading

Copy link
Copy Markdown
Contributor

  • bpo-43137: webbrowser: Prefer gio open over gvfs-open

    gvfs-open(1) was superseded by gio(1) in 2015, and removed from GNOME
    releases in 2018. Debian and its derivatives like Ubuntu currently still
    have a compatibility shim for gvfs-open, but we plan to remove it.

    webbrowser prefers xdg-settings and xdg-open over gvfs-open, so this
    will only have any practical effect on systems where the xdg-utils
    package is not installed.

    Note that we don't check for GNOME_DESKTOP_SESSION_ID before using gio.
    gio does the right thing on any desktop environment that follows
    freedesktop.org specifications, similar to xdg-settings, so it's
    unnecessary to guard in this way. GNOME_DESKTOP_SESSION_ID was deprecated
    in 2008 and removed from upstream gnome-session in 2018 (it's still
    present in Debian/Ubuntu for backward compatibility, but probably
    shouldn't be). The replacement way to detect a desktop environment is
    the XDG_CURRENT_DESKTOP environment variable, which is a colon-separated
    sequence where the first item is the current desktop environment and the
    second and subsequent items (if present) are other desktop environments
    that it resembles or is based on.

    Resolves: https://bugs.python.org/issue43137

  • bpo-43137: webbrowser: Never invoke gnome-open

    gnome-open was part of GNOME 2, which was superseded in around 2010 and
    is unmaintained. The replacement was gvfs-open, which was subsequently
    replaced by gio(1) (as used in the previous commit).

  • bpo-43137: webbrowser: Don't run gvfs-open on GNOME

    gvfs-open was deprecated in 2015 and removed in 2018. The replacement
    is gio(1) (as used in a previous commit).

    GNOME_DESKTOP_SESSION_ID was deprecated in 2008 and removed in 2018.
    The replacement is XDG_CURRENT_DESKTOP (as mentioned in a previous
    commit).

To test this on a typical modern Linux system, it is necessary to disable the xdg-settings and xdg-open code paths, for example with this hack:

Hack to disable use of xdg-settings and xdg-open
diff --git a/Lib/webbrowser.py b/Lib/webbrowser.py index 3244f206aa..8f6c09d1d2 100755 --- a/Lib/webbrowser.py +++ b/Lib/webbrowser.py @@ -459,7 +459,7 @@ def open(self, url, new=0, autoraise=True): def register_X_browsers(): # use xdg-open if around - if shutil.which("xdg-open"): + if 0 and shutil.which("xdg-open"): register("xdg-open", None, BackgroundBrowser("xdg-open")) # Opens an appropriate browser for the URL scheme according to @@ -549,7 +549,7 @@ def register_standard_browsers(): # Prefer X browsers if present if os.environ.get("DISPLAY") or os.environ.get("WAYLAND_DISPLAY"): try: - cmd = "xdg-settings get default-web-browser".split() + cmd = "false xdg-settings get default-web-browser".split() raw_result = subprocess.check_output(cmd, stderr=subprocess.DEVNULL) result = raw_result.decode().strip() except (FileNotFoundError, subprocess.CalledProcessError, PermissionError, NotADirectoryError) :

I haven't attempted to assess which of the specific web browsers such as Galeon are still extant, and which ones disappeared years ago. They could almost certainly be cleaned up, but that's beyond the scope of this PR.

https://bugs.python.org/issue43137

Automerge-Triggered-By: GH:jaraco

smcv added 3 commits October 22, 2021 11:40
bpo-43137: webbrowser: Prefer gio open over gvfs-open …
4fd89aa
gvfs-open(1) was superseded by gio(1) in 2015, and removed from GNOME releases in 2018. Debian and its derivatives like Ubuntu currently still have a compatibility shim for gvfs-open, but we plan to remove it. webbrowser prefers xdg-settings and xdg-open over gvfs-open, so this will only have any practical effect on systems where the xdg-utils package is not installed. Note that we don't check for GNOME_DESKTOP_SESSION_ID before using gio. gio does the right thing on any desktop environment that follows freedesktop.org specifications, similar to xdg-settings, so it's unnecessary to guard in this way. GNOME_DESKTOP_SESSION_ID was deprecated in 2008 and removed from upstream gnome-session in 2018 (it's still present in Debian/Ubuntu for backward compatibility, but probably shouldn't be). The replacement way to detect a desktop environment is the XDG_CURRENT_DESKTOP environment variable, which is a colon-separated sequence where the first item is the current desktop environment and the second and subsequent items (if present) are other desktop environments that it resembles or is based on. Resolves: https://bugs.python.org/issue43137 Signed-off-by: Simon McVittie <smcv@debian.org>
bpo-43137: webbrowser: Never invoke gnome-open …
251ea9c
gnome-open was part of GNOME 2, which was superseded in around 2010 and is unmaintained. The replacement was gvfs-open, which was subsequently replaced by gio(1) (as used in the previous commit). Signed-off-by: Simon McVittie <smcv@debian.org>
bpo-43137: webbrowser: Don't run gvfs-open on GNOME …
aed1ba5
gvfs-open was deprecated in 2015 and removed in 2018. The replacement is gio(1) (as used in a previous commit). GNOME_DESKTOP_SESSION_ID was deprecated in 2008 and removed in 2018. The replacement is XDG_CURRENT_DESKTOP (as mentioned in a previous commit). Signed-off-by: Simon McVittie <smcv@debian.org>

This comment has been minimized.

Sign in to view
FFY00 approved these changes Oct 25, 2021
View reviewed changes

FFY00 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

Thank you! This looks correct and makes the code more portable. I agree with the scope.

github-actions Bot commented Nov 25, 2021

Copy link
Copy Markdown

This PR is stale because it has been open for 30 days with no activity.

github-actions Bot added the stale Stale PR or inactive for long period of time. label Nov 25, 2021

FFY00 commented Nov 25, 2021

Copy link
Copy Markdown
Member

@jaraco could you have a look?

jaraco commented Nov 25, 2021

Copy link
Copy Markdown
Member
  • webbrowser prefers xdg-settings and xdg-open over gvfs-open, so this
    will only have any practical effect on systems where the xdg-utils
    package is not installed.

From a user's perspective, what's the preferred behavior? Is it possible/desirable to give gio-open precedence?

jaraco approved these changes Nov 25, 2021
View reviewed changes

jaraco left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

I looked at the tests and don't see anything relevant for these code paths, so following the pattern of the predecessors seems fine.

smcv commented Nov 25, 2021

Copy link
Copy Markdown
Contributor Author

From a user's perspective, what's the preferred behavior? Is it possible/desirable to give gio-open precedence?

On GNOME, and any other desktop environment that relies on freedesktop.org specifications, there should be little or no practical difference. The GNOME code path in xdg-open uses gio open, and gio open uses the same freedesktop.org configuration/integration stuff as xdg-settings.

For some non-GNOME desktops, there are legacy code paths in xdg-open (and I think xdg-settings) which might use desktop-specific configuration instead of the freedesktop.org specifications. I would hope that all Unix desktop environments standardized on freedesktop.org mechanisms several years ago (like GNOME did, and I think KDE too) but there might be a few that are stuck in the past.

gio open will be somewhat more efficient than xdg-open, because it's C code with a single execution flow, rather than a large shell script with various legacy code paths (although realistically nobody is likely to notice a performance difference). The down side of gio open is that if you were expecting one of those legacy code paths to be entered, you will be disappointed.

smcv commented Nov 25, 2021

Copy link
Copy Markdown
Contributor Author

to give gio-open precedence

Note that there is no gio-open command, only gio, which has several git-style subcommands: the one I use here is gio open, which is the equivalent of the old gvfs-open and gnome-open.

jaraco requested changes Nov 25, 2021
View reviewed changes

jaraco left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality Hide comment

It sounds as if the implications of giving gio precedence may be preferable but might introduce unexpected behaviors. My inclination would be to give it precedence now while the library is in alpha, and if there are problems, it can be corrected in a bugfix. Would you explore that possibility?

bedevere-bot commented Nov 25, 2021

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

smcv commented Nov 25, 2021

Copy link
Copy Markdown
Contributor Author

It sounds as if the implications of giving gio precedence may be preferable but might introduce unexpected behaviors. My inclination would be to give it precedence now while the library is in alpha, and if there are problems, it can be corrected in a bugfix. Would you explore that possibility?

If a Python developer wants to go further than what I've done in this branch, of course that's absolutely fine, but as an outsider I'm not particularly keen to be responsible for changes that I am not personally sure about, particularly knowing that I will not necessarily be available immediately to respond to any regressions that might occur.

Making gio open higher-precedence than xdg-open would be technically straightforward (swap two blocks) and I can add a commit to do that if you want. However, the advantage of doing gio open before xdg-open is fairly small (use less shell script, avoid legacy code paths) and it could result in launching the "wrong" web browser on some desktop environments (if their users expect the legacy code paths to be used), so it is perhaps not such a great tradeoff.

Looking at xdg-open, it seems that XFCE has a non-freedesktop.org web browser configuration mechanism, which is entangled with fd.o web browser handling for compatibility but not really entirely integrated with it; so XFCE (which I don't use) is an environment that is somewhat more likely to regress.

It isn't immediately obvious to me how to make gio open higher-precedence than xdg-settings, and looking at the commit history, I think doing that would reintroduce https://bugs.python.org/issue24241.

jaraco commented Nov 25, 2021

Copy link
Copy Markdown
Member

Sounds good. Appreciate the clarity in rationale.

miss-islington merged commit 97dcab7 into python:main Nov 25, 2021

tiran commented Nov 26, 2021

Copy link
Copy Markdown
Member

I think this changeset causes a regression. gio is not available in old distros like Ubuntu Xenial.

jaraco commented Nov 26, 2021

Copy link
Copy Markdown
Member

Thanks tiran. It's my understanding that Xenial (16.04) went EOL earlier this year. Does Python 3.11 to be released in 2022 need to support environments that went EOL this year? If so, when would Python be able to drop this support?

@smcv Would it be possible to support gio open over gvfs-open and gnome-open without dropping support for the legacy mechanism?

smcv commented Nov 26, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

@smcv Would it be possible to support gio open over gvfs-open and gnome-open without dropping support for the legacy mechanism?

Sure, just revert aed1ba5 (and optionally 251ea9c, but nobody should be using gnome-open in 2021, never mind 2022).

tiran commented Nov 26, 2021

Copy link
Copy Markdown
Member

but nobody should be using gnome-open in 2021, never mind 2022).

You would be surprised how many people complain when latest Python breaks on their ancient distro or hardware. :)

remykarem pushed a commit to remykarem/cpython that referenced this pull request Dec 7, 2021
bpo-43137: webbrowser: Replace gvfs-open and gnome-open with "gio ope… …
eca248d
…n" (pythonGH-29154) * [bpo-43137](): webbrowser: Prefer gio open over gvfs-open gvfs-open(1) was superseded by gio(1) in 2015, and removed from GNOME releases in 2018. Debian and its derivatives like Ubuntu currently still have a compatibility shim for gvfs-open, but we plan to remove it. webbrowser prefers xdg-settings and xdg-open over gvfs-open, so this will only have any practical effect on systems where the xdg-utils package is not installed. Note that we don't check for GNOME_DESKTOP_SESSION_ID before using gio. gio does the right thing on any desktop environment that follows freedesktop.org specifications, similar to xdg-settings, so it's unnecessary to guard in this way. GNOME_DESKTOP_SESSION_ID was deprecated in 2008 and removed from upstream gnome-session in 2018 (it's still present in Debian/Ubuntu for backward compatibility, but probably shouldn't be). The replacement way to detect a desktop environment is the XDG_CURRENT_DESKTOP environment variable, which is a colon-separated sequence where the first item is the current desktop environment and the second and subsequent items (if present) are other desktop environments that it resembles or is based on. Resolves: * [bpo-43137](): webbrowser: Never invoke gnome-open gnome-open was part of GNOME 2, which was superseded in around 2010 and is unmaintained. The replacement was gvfs-open, which was subsequently replaced by gio(1) (as used in the previous commit). * [bpo-43137](): webbrowser: Don't run gvfs-open on GNOME gvfs-open was deprecated in 2015 and removed in 2018. The replacement is gio(1) (as used in a previous commit). GNOME_DESKTOP_SESSION_ID was deprecated in 2008 and removed in 2018. The replacement is XDG_CURRENT_DESKTOP (as mentioned in a previous commit). --- To test this on a typical modern Linux system, it is necessary to disable the `xdg-settings` and `xdg-open` code paths, for example with this hack: <details><summary>Hack to disable use of xdg-settings and xdg-open</summary> ```diff diff --git a/Lib/webbrowser.py b/Lib/webbrowser.py index 3244f20..8f6c09d1d2 100755 --- a/Lib/webbrowser.py +++ b/Lib/webbrowser.py @@ -459,7 +459,7 @@ def open(self, url, new=0, autoraise=True): def register_X_browsers(): # use xdg-open if around - if shutil.which("xdg-open"): + if 0 and shutil.which("xdg-open"): register("xdg-open", None, BackgroundBrowser("xdg-open")) # Opens an appropriate browser for the URL scheme according to @@ -549,7 +549,7 @@ def register_standard_browsers(): # Prefer X browsers if present if os.environ.get("DISPLAY") or os.environ.get("WAYLAND_DISPLAY"): try: - cmd = "xdg-settings get default-web-browser".split() + cmd = "false xdg-settings get default-web-browser".split() raw_result = subprocess.check_output(cmd, stderr=subprocess.DEVNULL) result = raw_result.decode().strip() except (FileNotFoundError, subprocess.CalledProcessError, PermissionError, NotADirectoryError) : ``` </details> I haven't attempted to assess which of the specific web browsers such as Galeon are still extant, and which ones disappeared years ago. They could almost certainly be cleaned up, but that's beyond the scope of this PR.
smcv mentioned this pull request Jan 5, 2022
Merged

smcv commented Jan 5, 2022

Copy link
Copy Markdown
Contributor Author

Sure, just revert aed1ba5 (and optionally 251ea9c, but nobody should be using gnome-open in 2021, never mind 2022).

#30417 reverts aed1ba5, if that's what you want.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jaraco jaraco approved these changes
FFY00 FFY00 approved these changes

Assignees

No one assigned

Labels

stale Stale PR or inactive for long period of time.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

Footer

© 2026 GitHub, Inc.