CLI: update to be compatible with aiida-core==2.1
#136
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
sphuber
force-pushed
the
fix/130/cli-verdi-context
branch
2 times, most recently
from
6d10f63 to
9e4eb40
Compare
Currently the CLI is broken with `aiida-core==2.1`. The reason is that we are using the `PROFILE` option, which relies on the command that it is attached to configure certain things, such as the context. In v2.1, the behavior was changed causing the commands to except because the `PROFILE` option cannot find certain attributes it expects in the context. For the `PROFILE` option to work, the root command should use the class `aiida.cmdline.groups.VerdiCommandGroup` as its `cls`. This class defines a custom context class that is necessary. It also automatically provides the verbosity option for all subcommands, so the explicit declaration can now be removed. The problem was not detected in the unit tests because they only show up when the root command is invoked. The unit tests call the subcommands directly though, and this circumvents the root command. This is documented behavior of `click` and there is no way around it. The only solution is to call the commands through the command line interface exactly as they would be called normally. This is now done in the `test_commands.py` file. The test parametrizes over all existing (sub)commands and directly calls it as a subprocess. This guarantees that the root command is called including its specific context that needs to be setup. The `VerdiCommandGroup` also automatically adds the `-v/--verbosity` option to all commands. This is useful as it automatically controls the logging configuration setup by `aiida-core`. However, the `-v` short flag overlaps with our `-v/--version` option that is used to designate pseudo potential family versions. To solve this the `VerdiCommandGroup` clas is subclassed to override the `add_verbosity_option` method so that we can change the `VERBOSITY` option for a custom one, that only defines the `--verbosity` long option.
sphuber
force-pushed
the
fix/130/cli-verdi-context
branch
from
9e4eb40 to
14baf9b
Compare
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.
Fixes #130
Currently the CLI is broken with
aiida-core==2.1. The reason is that we are using thePROFILEoption, which relies on the command that it is attached to configure certain things, such as the context. In v2.1, the behavior was changed causing the commands to except because thePROFILEoption cannot find certain attributes it expects in the context.For the
PROFILEoption to work, the root command should use the classaiida.cmdline.groups.VerdiCommandGroupas itscls. This class defines a custom context class that is necessary. It also automatically provides the verbosity option for all subcommands, so the explicit declaration can now be removed.The problem was not detected in the unit tests because they only show up when the root command is invoked. The unit tests call the subcommands directly though, and this circumvents the root command. This is documented behavior of
clickand there is no way around it. The only solution is to call the commands through the command line interface exactly as they would be called normally.This is now done in the
test_commands.pyfile. The test parametrizes over all existing (sub)commands and directly calls it as a subprocess. This guarantees that the root command is called including its specific context that needs to be setup.