Expose ipc_main with arguments instead of argparse
#175
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
facebook-github-bot
added
the
CLA Signed
Codecov Report
@@ Coverage Diff @@
## master #175 +/- ##
==========================================
+ Coverage 85.04% 85.88% +0.84%
==========================================
Files 89 90 +1
Lines 3623 3691 +68
==========================================
+ Hits 3081 3170 +89
+ Misses 542 521 -21
Continue to review full report at Codecov.
|
aehernandez
force-pushed
the
master
branch
5 times, most recently
from
4a96daf to
68e21db
Compare
jimmylai
reviewed
Mar 4, 2021
fixit/cli/__init__.py
Outdated
Comment on lines
243
to
262
| def ipc_main(opts: LintOpts) -> IPCResult: | ||
| """ | ||
| Like `run_ipc` instead this function expects arguments to be collected through argparse. | ||
| This IPC helper takes paths of source files from either a path file (with @paths arg) | ||
| or a list of paths as args. | ||
|
|
||
| Returns an IPCResult object. | ||
| """ | ||
| parser = argparse.ArgumentParser( | ||
| description="Runs Fixit lint rules and print results as console output.", | ||
| fromfile_prefix_chars="@", | ||
| parents=[get_multiprocessing_parser()], | ||
| ) | ||
| parser.add_argument("paths", nargs="*", help="List of paths to run lint rules on.") | ||
| parser.add_argument("--prefix", help="A prefix to be added to all paths.") | ||
| args: argparse.Namespace = parser.parse_args() | ||
|
|
||
| return run_ipc( | ||
| opts=opts, paths=args.paths, prefix=args.prefix, workers=args.workers | ||
| ) |
There was a problem hiding this comment.
👍 Added a deprecation warning using python's standard warnings.warn functionality.
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
Refactored
ipc_mainintorun_ipcwhich takes in arguments instead of relying on argparse.ipc_mainstill exists for backwards compatibility.Test Plan
Added a test verifying that
Ran
tox -e py38to verify tests were running and green.