API: Add the aiida.engine.processes.control module
#5630
Merged
+772
−498
Conversation
This file contains hidden or 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
feature/5258/process-control-api
branch
from
e1e6506 to
cd0a626
Compare
sphuber
force-pushed
the
feature/5258/process-control-api
branch
5 times, most recently
from
c18d524 to
dd2e88d
Compare
These utilities are useful not only for the CLI but also in user applications, such as notebooks or in plugins. It makes more sense to have these in `aiida.tools`. The original locations import the new modules to keep backwards compatibility and a deprecation warning is added to the `aiida.cmdline` modules. The choices and default of the `--project` option of the `process list` had to be made indirect because of the move. The reason is that they rely on the `CalculationQueryBuilder` class, which now has moved to the `aiida.tools` module. This means that it should be imported on the top level of the `aiida.cmdline`, however, this is not permissible as the load time of this is significant and it will slow down tab-completion, which will have to load the cmdline module. The work around is to make the import of the class indirect by using the `LazyChoice` class as the type of the option and by making the default a lambda that calls a function that performs the actual import.
sphuber
force-pushed
the
feature/5258/process-control-api
branch
from
dd2e88d to
b83ecb8
Compare
|
Docs build is failing but I haven't been able to fix it yet. The problem is coming from the type hints. Adding a rule to the ignore nitpicks didn't seem to help. |
|
looks good cheers 👍 |
ltalirz
approved these changes
Sep 13, 2022
This module abstracts functionality that was implemented directly in the `aiida.cmdline.commands.cmd_process` module that allows to interact with active processes. By extracting it to a separate module, this functionality can now also be easily used by users from interfaces other than the CLI, such as the shell, or a notebook.
sphuber
force-pushed
the
feature/5258/process-control-api
branch
from
8fc9d14 to
76561cf
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 #5258
This module abstracts functionality that was implemented directly in the
aiida.cmdline.commands.cmd_processmodule that allows to interact withactive processes. By extracting it to a separate module, this
functionality can now also be easily used by users from interfaces other
than the CLI, such as the shell, or a notebook.