man: Remove FileType argument types in parser standard options arguments #5561
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
The argparse FileType argument type will be deprecated in Python 3.14. It does not properly close files if a subsequent error in another FileType argument occurs when parsing. The suggestion is to use context managers after parsing the arguments. The implementation of the changes is inspired by a PR doing the same in the CPython repo.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| if args.output is not None | ||
| else contextlib.nullcontext(sys.stdout) | ||
| ) as outfile, | ||
| open(args.text) if args.text is not None else urlopen(args.url) as cfile, |
Check warning
Code scanning / Bandit
Audit url open for permitted schemes. Allowing use of file:/ or custom schemes is often unexpected. Warning
wenzeslaus
reviewed
Apr 20, 2025
| @@ -351,48 +360,51 @@ def _repr_html_(self): | |||
| "--html_params", | |||
| default="border=1", | |||
| type=str, | |||
| dest="htmlparmas", | |||
| dest="htmlparams", | |||
There was a problem hiding this comment.
Would using underscore be a better standard here helping to avoid misspellings?
There was a problem hiding this comment.
I don't think so, code spelling checking (cspell) in my IDE was already pointing it out.
The underscore would be in between html and params, and it was params that had a typo.
There was a problem hiding this comment.
I didn't see problems with the other argument destinations by the way
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.
There was another ResourceWarning error in manual generation that I solved after #5560. The unclosed files were defined in the argparse arguments with FileType type.
The argparse FileType argument type will be deprecated in Python 3.14. It does not properly close files if a subsequent error in another FileType argument occurs when parsing. The suggestion is to use context managers after parsing the arguments. The implementation of the changes is inspired by a PR doing the same in the CPython repo.
Other small changes included in (wasn't worth a separate PR):
urlopen()'s proxies argument. It was for the old interface. Default proxy handling is used now. It allowed correct type checking.res.append(line) if res is not None else None, replaced withelif res is not None:andres.append(line), as intended 10+ years ago.optnamevariable in functionsplit_in_groupsif ever the first condition wasn't executed for a previous line (for type checking, as it was unbounded otherwise)htmlparmastohtmlparams(two occurrences only, used once)if line.startswith("/*"):continuethat was not required because of the condition above, that already checked for this situation just above.Type checking was added to touched/impacted functions to validate correct usages.