Improve CLI handling of configuration file arguments #131
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
This updates the stylist CLI to make the -configuration compulsory. This will cause the command to fail early if the configuration is incorrect, allowing ArgumentParser to display a meaningful error message.
This updates the CLI to check whether the configuration file exists and whether it has a valid python extension. This allows ArgumentParser to display a meaningful error if the configuration is not valid.
As per the guidance, I have added my name to the list of contributors.
|
I have created issue #132 to capture potential future requirements. |
MatthewHambley
requested changes
Sep 1, 2023
There was a problem hiding this comment.
I'm not a big fan of making optional (starting with a hyphen) arguments compulsory but given that #132 exists and we therefore might make it optional again I think it is acceptable.
I have one request which is that you look into using PyTest's magic fixtures as they may tidy up the test code a little.
Create an overload method which shallow merges the pipes and styles attributes of a second Configuration into the current instance. This is intended to be used to allow per-site, per-user, and per-project configurations to be combined into a single entity.
Reviewer has suggested changing the argument handling to prevent the user from having to specify an option because this is contrary to spirit of making the flag voluntary. Instead, the code checks a variety of locations before raising an exception if the configuration cannot be found. This also improves temporary directory handling in tests as recommended by the reviewer, replacing clunky custom code with a function provide pytest.
The __configure() function return value in the main script had the wrong type hinting. This changes the hinting to match None in the event of a configuration problem.
MatthewHambley
approved these changes
Dec 13, 2023
MatthewHambley
deleted the
129-is-configuration-argument-always-needed
branch
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.
A combination of issues #129 and #130, this makes the
-configurationcommand line argument compulsory, checks that that file passed as an argument exists, and confirms that the suffix matches a valid python file. This allows the CLI's ArgumentParser to return an error to the user fairly early on, rather than allowing a StylistException to propagate to the top level as happened previously.