Check if we're using GNU sed instead of macOS #263
Merged
Conversation
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
AA-Turner
approved these changes
Apr 11, 2025
Comment on lines
+660
to
+673
| def is_gnu_sed() -> bool: | ||
| """Check if we are using GNU sed.""" | ||
| try: | ||
| subprocess.run( | ||
| ["sed", "--version"], | ||
| stdout=subprocess.DEVNULL, | ||
| stderr=subprocess.DEVNULL, | ||
| check=True, | ||
| ) | ||
| return True | ||
| except subprocess.CalledProcessError: | ||
| return False | ||
| except FileNotFoundError: | ||
| return False |
There was a problem hiding this comment.
This could be a module-level function?
There was a problem hiding this comment.
Could be! This is the only place its used, so I think it's okay here, but happy to move if you like.
Sure, feel free to do a followup, Windows support would be nice. There's at least two other |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
By default, macOS comes with an old FreeBSD version of sed which doesn't have as many options as GNU sed you find elsewhere.
Default:
Instead, I use GNU sed installed via Homebrew:
However, we assume macOS is using default sed (#177) and
[""] if sys.platform == "xdarwin" else []fails with GNU sed:2025-04-11 12:56:30,069 ERROR en/3.13: Run: 'sed -i 's/ *-A switchers=1//' /private/tmp/build_root/cpython-only-html-en/Doc/Makefile' KO: sed: 1: "/private/tmp/build_root ...": undefined label 'mp/build_root/cpython-only-html-en/Doc/Makefile' 2025-04-11 12:56:30,071 ERROR en/3.13: Badly handled exception, human, please help. Traceback (most recent call last): File "/Users/hugo/github/docsbuild-scripts/./build_docs.py", line 554, in run self.build() ~~~~~~~~~~^^ File "/Users/hugo/github/docsbuild-scripts/./build_docs.py", line 662, in build run( ~~~^ ["sed", "-i"] ^^^^^^^^^^^^^ + ([""] if sys.platform == "xdarwin" else []) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + ["s/ *-A switchers=1//", self.checkout / "Doc" / "Makefile"] ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ) ^ File "/Users/hugo/github/docsbuild-scripts/./build_docs.py", line 296, in run result.check_returncode() ~~~~~~~~~~~~~~~~~~~~~~~^^ File "/Library/Frameworks/Python.framework/Versions/3.13/lib/python3.13/subprocess.py", line 508, in check_returncode raise CalledProcessError(self.returncode, self.args, self.stdout, self.stderr) subprocess.CalledProcessError: Command '['sed', '-i', 's/ *-A switchers=1//', '/private/tmp/build_root/cpython-only-html-en/Doc/Makefile']' returned non-zero exit status 1.So this PR instead checks if we're using GNU sed by confirming if
--versionexists (similar to https://stackoverflow.com/a/65497543/724176).