Skip to content

run_shell_command() with check=True to avoid silent failures #343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

run_shell_command() with check=True to avoid silent failures #343

wants to merge 1 commit into from

Conversation

cclauss
Copy link
Member

@cclauss cclauss commented Mar 17, 2025 •
edited
Loading

% ruff rule PLW1510 # https://docs.astral.sh/ruff/rules/subprocess-run-without-check

By default, subprocess.run() does not check the return code of the process it runs. This can lead to silent failures.

We have 17 silent failures in our tests.

def run_shell_command(cmd: str, args: str, cwd="."):
-   proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=False)
+   proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=True)

@cclauss cclauss mentioned this pull request Mar 17, 2025
Merged
@cclauss cclauss mentioned this pull request Mar 17, 2025
Merged
aaronliu0130
aaronliu0130 requested changes Mar 17, 2025
View reviewed changes
Copy link
Member

@aaronliu0130 aaronliu0130 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

cpplint is supposed to have a return code of 1 when it collects any error from the input files. There is no problem nor typo here.

In fact the return code is already checked against the expected return code in the .def file in check_def(), which would throw an uncaught OSError if the given .def file was not found.

@cclauss
Copy link
Member Author

cclauss commented Mar 18, 2025

Thanks for clarifying... Closing.

@cclauss cclauss closed this Mar 18, 2025
@cclauss cclauss deleted the run_shell_command-check=True branch March 18, 2025 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronliu0130 aaronliu0130 aaronliu0130 requested changes

Assignees

@aaronliu0130 aaronliu0130

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cclauss @aaronliu0130