Refactor IBEX_upgrade Script #123
Open
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
Reduce the number of pylint warnings found from executing pylint to move codebase closer to PEP8 standards. This mainly involved disabling line-too-long and import warnings
Place retrieval of latest release directory and client version into two new functions as part of refactor. Add descriptive comments to script to better understand script behaviour
Refactor IBEX_upgrade.py to begin moving logic outside of __main__ expression into appropriate functions. Changes to reduce the quantity of logic handled inside __main__ expression involved creating an Argument_config.py file which contains dictionaries detailing arguments to unpack into argument parser.
Refactor handling of latest release directories being set to reduce duplication of logic and place in a function outside of __main__ expression
Update function names, and docstrings and enforce parameter types
Update python dependencies by removing unused import
Reduce the number of pylint warnings and add pylint disable where appropriate to make IBEX_upgrade.py more PEP8 compliant
Clean-up script by cutting down duplication, replacing with function calls and update docstrings
Modify adding of arguments to parse function to fix passing of flags to add_argument method of ArgumentParser
Fix Help key casing in one of the argument dictionaries
Improve PEP8 compliance
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.
Work Completed
Refactoring of
IBEX_upgrade.pyto to begin moving logic outside of__main__expression into more compartmentalised functions.PR Justification
To improve debugging and allow for tests to be written to test logic taking place inside
IBEX_upgrade.pyAcceptance Criteria
__main__expression has been placed in functionsIBEX_upgrade.pystill executes as expected.How to Test
IBEX_upgrade.pyas standalone script or by runninginstrument_deploy.bat