Align our subprocess usage with current best practices. #12940
Merged
Conversation
This file contains 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
fauxpark
requested changes
May 18, 2021
There was a problem hiding this comment.
pytest on MSYS2 fails with:
======================================================================
FAIL: qmk.tests.test_cli_commands.test_c2json
----------------------------------------------------------------------
Traceback (most recent call last):
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/tests/test_cli_commands.py", line 198, in test_c2json
check_returncode(result)
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/tests/test_cli_commands.py", line 31, in check_returncode
assert result.returncode in expected
AssertionError
qmk.tests.test_cli_commands.test_c2json ... DEBUG:MILC:Running command: ['C:/msys64/usr/bin/zsh', '-c', 'qmk c2json -kb handwired/pytest/has_template -km default keyboards/handwired/pytest/has_template/keymaps/default/keymap.c']
`C:/msys64/usr/bin/zsh -c qmk c2json -kb handwired/pytest/has_template -km default keyboards/handwired/pytest/has_template/keymaps/default/keymap.c` stdout:
<class 'TypeError'>
ERROR expected string or bytes-like object
Traceback (most recent call last):
File "C:/msys64/mingw64/lib/python3.8/site-packages/milc/milc.py", line 467, in __call__
return self.__call__()
File "C:/msys64/mingw64/lib/python3.8/site-packages/milc/milc.py", line 472, in __call__
return self._entrypoint(self)
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/cli/c2json.py", line 40, in c2json
keymap_json = qmk.keymap.c2json(cli.args.keyboard, cli.args.keymap, cli.args.filename, use_cpp=cli.args.no_cpp)
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/keymap.py", line 545, in c2json
keymap_json = parse_keymap_c(keymap_file, use_cpp)
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/keymap.py", line 519, in parse_keymap_c
keymap_file = _c_preprocess(keymap_file)
File "C:/msys64/home/fauxpark/git/qmk_firmware_develop/lib/python/qmk/keymap.py", line 374, in _c_preprocess
pre_processed_keymap = cli.run(cmd, stdin=stdin)
File "C:/msys64/mingw64/lib/python3.8/site-packages/milc/milc.py", line 125, in run
safecmd = ' '.join(safecmd)
File "C:/msys64/mingw64/lib/python3.8/shlex.py", line 325, in quote
if _find_unsafe(s) is None:
TypeError: expected string or bytes-like object
returncode: 255
FAIL
(I'm not sure whether it's related, though)
Co-authored-by: Ryan <fauxpark@gmail.com>
fauxpark
approved these changes
May 19, 2021
skullydazed
commented
May 19, 2021
fauxpark
reviewed
May 19, 2021
| @@ -371,7 +370,9 @@ def _c_preprocess(path, stdin=None): | |||
| Returns: | |||
| the stdout of the pre-processor | |||
| """ | |||
| pre_processed_keymap = qmk.commands.run(['cpp', path] if path else ['cpp'], stdin=stdin, stdout=subprocess.PIPE, stderr=subprocess.PIPE, universal_newlines=True) | |||
| cmd = ['cpp', str(path)] if path else ['cpp'] | |||
There was a problem hiding this comment.
If path is always an object of type Path then I think this should use .as_posix() instead, otherwise LGTM 👍
fauxpark
approved these changes
May 19, 2021
14 tasks
leland-kwong
pushed a commit
to leland-kwong/qmk_firmware
that referenced
this pull request
May 23, 2021
* Align our subprocess usage with current best practices. * remove unused import * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * fix the cpp invocation for older python * allow for unprompted installation * make sure qmk new-keyboard works on windows Co-authored-by: Ryan <fauxpark@gmail.com>
14 tasks
HokieGeek
pushed a commit
to HokieGeek/qmk_firmware
that referenced
this pull request
Jul 11, 2021
* Align our subprocess usage with current best practices. * remove unused import * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * fix the cpp invocation for older python * allow for unprompted installation * make sure qmk new-keyboard works on windows Co-authored-by: Ryan <fauxpark@gmail.com>
nhongooi
pushed a commit
to nhongooi/qmk_firmware
that referenced
this pull request
Dec 5, 2021
* Align our subprocess usage with current best practices. * remove unused import * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * fix the cpp invocation for older python * allow for unprompted installation * make sure qmk new-keyboard works on windows Co-authored-by: Ryan <fauxpark@gmail.com>
BorisTestov
pushed a commit
to BorisTestov/qmk_firmware
that referenced
this pull request
May 23, 2024
* Align our subprocess usage with current best practices. * remove unused import * Apply suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * fix the cpp invocation for older python * allow for unprompted installation * make sure qmk new-keyboard works on windows Co-authored-by: Ryan <fauxpark@gmail.com>
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.
Description
This switches most of our subprocess usage to MILC's
cli.run(). There are still a couple places that use subprocess.run which I didn't want to change just now.I added
stdin=DEVNULLto most commands because this fixes a bug on windows where input is no longer accepted after a subprocess is run.Types of Changes
Checklist