refactor: clean up automq_release.py for PEP 8 compliance and maintainability#3239
Open
SujayPro wants to merge 1 commit intoAutoMQ:mainfrom
Open
refactor: clean up automq_release.py for PEP 8 compliance and maintainability#3239SujayPro wants to merge 1 commit intoAutoMQ:mainfrom
SujayPro wants to merge 1 commit intoAutoMQ:mainfrom
Conversation
…nability ## What's this about? I went through `automq_release.py` and cleaned up a bunch of small things that had been bugging me. Nothing changes how the script actually works -- it's all cosmetic / quality-of-life stuff. ## What changed? - **Fixed the shebang line** — had a stray space (`# !` → `#!`) that broke it - **Renamed `regexReplace` → `regex_replace`** — Python convention is snake_case - **Renamed `cmd_output` → `run_cmd`** — the old name shadowed the `cmd()` function, which is confusing - **Added type hints** to every function so IDEs can actually help you - **Switched from `print()` to `logging`** — proper log levels, easier to filter - **Removed dead code** — `get_project_path()` was defined but never called, and there was a leftover `# from whichcraft import which` comment - **Moved `from shutil import which`** to the top of the file where imports belong - **Added a module docstring** so people know what this file does at a glance ## Does this break anything? Nope. Zero behavioral changes. Every git command, tag validation, and retry logic works exactly the same as before. Signed-off-by: SUJAY <[email protected]>
SujayPro
requested review from
1sonofqiu,
Gezi-lzq,
superhx and
woshigaopp
as code owners
|
|
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
2 participants
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.
…nability
What's this about?
I went through
automq_release.pyand cleaned up a bunch of small things that had been bugging me. Nothing changes how the script actually works -- it's all cosmetic / quality-of-life stuff.What changed?
# !→#!) that broke itregexReplace→regex_replace— Python convention is snake_casecmd_output→run_cmd— the old name shadowed thecmd()function, which is confusingprint()tologging— proper log levels, easier to filterget_project_path()was defined but never called, and there was a leftover# from whichcraft import whichcommentfrom shutil import whichto the top of the file where imports belongDoes this break anything?
Nope. Zero behavioral changes. Every git command, tag validation, and retry logic works exactly the same as before.
More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.
Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.
Committer Checklist (excluded from commit message)