CLI: allow setting options for config without profiles #5544
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/5543/verdi-config-empty-config
branch
2 times, most recently
from
39651b6
to
8d94ecc
Compare
ltalirz
reviewed
May 30, 2022
|
|
||
| This parameter type requires the command that uses it to define the ``context_class`` class attribute to be the | ||
| :class:`aiida.cmdline.groups.verdi.VerdiContext` class, as that is responsible for creating the user defined object | ||
| ``obj`` on the context and loads the instance config. |
There was a problem hiding this comment.
Is there a way to validate this?
If this is straightforward (even if just indirect by checking the ctx.obj) a check + exception might be a more effective way of enforcing this than via documentation.
There was a problem hiding this comment.
Can do, will add it.
The `verdi config set` command would except if the config had no configured profiles. The reason is that the command would attempt to retrieve the `Config` instance from the `ctx.obj` object. The problem is however that this is created and set on the context in the `convert` method of the `ProfileParamType`, which is used for the `--profile` option. The option specifies a default, which is the default profile, but if that is not defined, it doesn't provide anything and so the `convert` method is never called, resulting in the `ctx.obj` never being initialized and the `config` not being set. Since the config should always be present for all `verdi` comments, we should ensure that it is always loaded and set on `ctx.obj`. Therefore it is removed from `ProfileParamType.convert` and added to the constructor of a custom implementation of the `click.Context` class, called `VerdiContext`. The `VerdiCommandGroup` is updated to set the `context_class` attribute to this `VerdiContext` which will ensure that all commands will be invoked using a context that has the user defined object constructure with the config loaded and added to it. Since all commands in `verdi` will implement this class, this should guarantee that the config will always be initialized.
sphuber
force-pushed
the
fix/5543/verdi-config-empty-config
branch
from
8d94ecc
to
3238125
Compare
|
Thanks for the review @ltalirz . I have added the check |
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 #5543
The
verdi config setcommand would except if the config had noconfigured profiles. The reason is that the command would attempt to
retrieve the
Configinstance from thectx.objobject. The problem ishowever that this is created and set on the context in the
convertmethod of the
ProfileParamType, which is used for the--profileoption.
The option specifies a default, which is the default profile, but if
that is not defined, it doesn't provide anything and so the
convertmethod is never called, resulting in the
ctx.objnever beinginitialized and the
confignot being set.Since the config should always be present for all
verdicomments, weshould ensure that it is always loaded and set on
ctx.obj. Thereforeit is removed from
ProfileParamType.convertand added to theconstructor of a custom implementation of the
click.Contextclass,called
VerdiContext. TheVerdiCommandGroupis updated to set thecontext_classattribute to thisVerdiContextwhich will ensure thatall commands will be invoked using a context that has the user defined
object constructure with the config loaded and added to it. Since all
commands in
verdiwill implement this class, this should guaranteethat the config will always be initialized.