fix Windows short-circuit in man_pages.is_available#1874
Open
HrachShah wants to merge 1 commit into
Open
Conversation
is_available guarded against Windows with `os.system == 'nt'`. os.system is the built-in function object from the os module, never a string, so the comparison was always False and the function never short-circuited on Windows even though that was clearly the author's intent (the surrounding code is checking whether the running OS has the `man` binary). On Windows the function fell through to `subprocess.run([MAN_COMMAND, ...])`, which is missing from PATH and raised FileNotFoundError that was then swallowed by the bare `except Exception`, so users saw a confusing 'no man pages found' instead of an immediate 'not on Windows' early return.
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
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.
Summary
is_available()guarded against Windows withos.system == 'nt'.os.systemis the built-in function object from theosmodule, never a string, so the comparison was alwaysFalseand the function never short-circuited on Windows even though that was clearly the author's intent (the surrounding code is checking whether the running OS has themanbinary).On Windows the function fell through to
subprocess.run([MAN_COMMAND, ...]), which is missing from PATH and raisedFileNotFoundErrorthat was then swallowed by the bareexcept Exception, so users saw a confusing 'no man pages found' instead of an immediate 'not on Windows' early return.Fix
Replace
os.systemwithos.name— the standard Python idiom for OS detection (returns'nt'on Windows,'posix'on Linux/macOS).Testing
The change is one character; manual verification:
os.system == 'nt'evaluates toFalseon every platform including Windows, whileos.name == 'nt'correctly returnsTrueon Windows andFalseon Linux/macOS.