asreviewcontrib.simulation.api.extending

Functionality to help extend asreview-simulation through plugins. For example implementations, see https://github.com/asreview-simulation/asreview-simulation-my-plugin

 1"""
 2Functionality to help extend `asreview-simulation` through plugins. For example implementations,
 3see https://github.com/asreview-simulation/asreview-simulation-my-plugin
 4"""
 5from asreviewcontrib.simulation._private.cli.cli_epilog import epilog
 6from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_bal_msg
 7from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_clr_msg
 8from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_fex_msg
 9from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_ofn_msg
10from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_qry_msg
11from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_sam_msg
12from asreviewcontrib.simulation._private.cli.cli_msgs import dont_reassign_stp_msg
13from asreviewcontrib.simulation._private.lib.extending.plugin_quad import PluginQuad
14
15
16__all__ = [
17    "PluginQuad",
18    "dont_reassign_bal_msg",
19    "dont_reassign_clr_msg",
20    "dont_reassign_fex_msg",
21    "dont_reassign_ofn_msg",
22    "dont_reassign_qry_msg",
23    "dont_reassign_sam_msg",
24    "dont_reassign_stp_msg",
25    "epilog",
26]
class PluginQuad: 
10class PluginQuad:
11    def __init__(self, *, default_params: DefaultParams, impl, pyll, subcommand):
12        """
13        Args:
14            default_params: TODO
15            impl: TODO
16            pyll: TODO
17            subcommand: TODO
18
19        Synopsis:
20            TODO
21        """
22        self.default_params = default_params
23        self.impl = impl
24        self.pyll = pyll
25        self.subcommand = subcommand
26
27    @property
28    def impl(self):
29        return self._impl
30
31    @impl.setter
32    def impl(self, impl):
33        self._impl = impl
34
35    @property
36    def default_params(self):
37        return self._default_params
38
39    @default_params.setter
40    def default_params(self, default_params):
41        self._default_params = default_params
42
43    @property
44    def pyll(self):
45        return self._pyll
46
47    @pyll.setter
48    def pyll(self, pyll):
49        self._pyll = pyll
50
51    @property
52    def subcommand(self):
53        return self._subcommand
54
55    @subcommand.setter
56    def subcommand(self, subcommand):
57        self._subcommand = subcommand
PluginQuad( *, default_params: Callable[[str], Dict[str, Any]], impl, pyll, subcommand) 
11    def __init__(self, *, default_params: DefaultParams, impl, pyll, subcommand):
12        """
13        Args:
14            default_params: TODO
15            impl: TODO
16            pyll: TODO
17            subcommand: TODO
18
19        Synopsis:
20            TODO
21        """
22        self.default_params = default_params
23        self.impl = impl
24        self.pyll = pyll
25        self.subcommand = subcommand
Arguments:
  • default_params: TODO
  • impl: TODO
  • pyll: TODO
  • subcommand: TODO
Synopsis:

TODO

default_params 
35    @property
36    def default_params(self):
37        return self._default_params
impl 
27    @property
28    def impl(self):
29        return self._impl
pyll 
43    @property
44    def pyll(self):
45        return self._pyll
subcommand 
51    @property
52    def subcommand(self):
53        return self._subcommand
dont_reassign_bal_msg = "Attempted reassignment of 'bal' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_clr_msg = "Attempted reassignment of 'clr' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_fex_msg = "Attempted reassignment of 'fex' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_ofn_msg = "Attempted reassignment of 'ofn' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_qry_msg = "Attempted reassignment of 'qry' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_sam_msg = "Attempted reassignment of 'sam' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
dont_reassign_stp_msg = "Attempted reassignment of 'stp' model. Use the --force flag if you mean to overwrite the configuration from previous steps. "
epilog = "\nThis command is chainable with other commands. Chained commands\nare evaluated left to right; make sure to end the chain with\nthe 'start' command, otherwise it may appear like nothing is happening.\n\nPlease report any issues at:\n\nhttps://github.com/asreview-simulation/asreview-simulation/issues.\n"