vantage6 4.2.1__py3-none-any.whl → 4.3.0b3__py3-none-any.whl

vantage6/cli/context.py

@@ -1,416 +0,0 @@
-"""
-The context module in the CLI package contains the definition of the
-ServerContext and NodeContext classes. These contexts are related to the host
-system and therefore part of the CLI package.
-
-Both classes are derived from the abstract AppContext class. And provide the
-node and server with naming conventions, standard file locations, and in the
-case of the node with a local database URIs.
-
-*Server Context*
-    A class to provide context for the server, both for development mode as
-    for production.
-
-*Node Context*
-    In case the node is run in development mode, this context will also used by
-    the node package. Normally the node uses the
-    `vantage6.node.context.DockerNodeContext` which provides the same
-    functionality but is tailored to the Docker environment.
-
-"""
-# TODO BvB 2023-01-10 we should have a look at all context classes and define
-# them in the same place. Now the DockerNodeContext is defined in the node, but
-# the server only has a TestServerContext there. This should be made consistent
-from __future__ import annotations
-
-import os.path
-
-from pathlib import Path
-
-from sqlalchemy.engine.url import make_url
-
-from vantage6.common.context import AppContext
-from vantage6.common.globals import APPNAME
-from vantage6.cli.configuration_manager import (NodeConfigurationManager,
-                                                ServerConfigurationManager)
-from vantage6.cli.globals import (
-    DEFAULT_NODE_SYSTEM_FOLDERS as N_FOL,
-    DEFAULT_SERVER_SYSTEM_FOLDERS as S_FOL
-)
-from vantage6.cli._version import __version__
-
-
-class ServerContext(AppContext):
-    """
-    Server context
-
-    Parameters
-    ----------
-    instance_name : str
-        Name of the configuration instance, corresponds to the filename
-        of the configuration file.
-    system_folders : bool, optional
-        System wide or user configuration, by default S_FOL
-    """
-
-    # The server configuration manager is aware of the structure of the server
-    # configuration file and makes sure only valid configuration can be loaded.
-    INST_CONFIG_MANAGER = ServerConfigurationManager
-
-    def __init__(self, instance_name: str, system_folders: bool = S_FOL):
-        super().__init__("server", instance_name,
-                         system_folders=system_folders)
-        self.log.info(f"vantage6 version '{__version__}'")
-
-    def get_database_uri(self) -> str:
-        """
-        Obtain the database uri from the environment or the configuration. The
-        `VANTAGE6_DB_URI` environment variable is used by the Docker container,
-        but can also be set by the user.
-
-        Returns
-        -------
-        str
-            string representation of the database uri
-        """
-        uri = os.environ.get("VANTAGE6_DB_URI") or self.config['uri']
-        url = make_url(uri)
-
-        if url.host is None and not os.path.isabs(url.database):
-            # We're dealing with a relative path here of a local database, when
-            # we're running the server outside of docker. Therefore we need to
-            # prepend the data directory to the database name, but after the
-            # driver name (e.g. sqlite:////db.sqlite ->
-            # sqlite:////data_dir>/db.sqlite)
-
-            # find index of database name
-            idx_db_name = str(url).find(url.database)
-
-            # add the datadir to the right location in the database uri
-            return str(url)[:idx_db_name] + str(self.data_dir / url.database)
-
-        return uri
-
-    @property
-    def docker_container_name(self) -> str:
-        """
-        Name of the docker container that the server is running in.
-
-        Returns
-        -------
-        str
-            Server's docker container name
-        """
-        return f"{APPNAME}-{self.name}-{self.scope}-server"
-
-    @classmethod
-    def from_external_config_file(
-            cls, path: str, system_folders: bool = S_FOL) -> ServerContext:
-        """
-        Create a server context from an external configuration file. External
-        means that the configuration file is not located in the default folders
-        but its location is specified by the user.
-
-        Parameters
-        ----------
-        path : str
-            Path of the configuration file
-        system_folders : bool, optional
-            System wide or user configuration, by default S_FOL
-
-        Returns
-        -------
-        ServerContext
-            Server context object
-        """
-        cls = super().from_external_config_file(path, "server", system_folders)
-        # if we are running a server in a docker container, the name is taken
-        # from the name of the config file (which is usually a default). Get
-        # the config name from environment if it is given.
-        cls.name = os.environ.get("VANTAGE6_CONFIG_NAME") or cls.name
-        return cls
-
-    @classmethod
-    def config_exists(cls, instance_name: str,
-                      system_folders: bool = S_FOL) -> bool:
-        """
-        Check if a configuration file exists.
-
-        Parameters
-        ----------
-        instance_name : str
-            Name of the configuration instance, corresponds to the filename
-            of the configuration file.
-        system_folders : bool, optional
-            System wide or user configuration, by default S_FOL
-
-        Returns
-        -------
-        bool
-            Whether the configuration file exists or not
-        """
-        return super().config_exists("server", instance_name,
-                                     system_folders=system_folders)
-
-    @classmethod
-    def available_configurations(cls, system_folders: bool = S_FOL) \
-            -> tuple[list, list]:
-        """
-        Find all available server configurations in the default folders.
-
-        Parameters
-        ----------
-        system_folders : bool, optional
-            System wide or user configuration, by default S_FOL
-
-        Returns
-        -------
-        tuple[list, list]
-            The first list contains validated configuration files, the second
-            list contains invalid configuration files.
-        """
-        return super().available_configurations("server", system_folders)
-
-
-class NodeContext(AppContext):
-    """
-    Node context
-
-    See DockerNodeContext for the node instance mounts when running as a
-    dockerized service.
-
-    Parameters
-    ----------
-    instance_name : str
-        Name of the configuration instance, corresponds to the filename
-        of the configuration file.
-    system_folders : bool, optional
-        _description_, by default N_FOL
-    config_file : str, optional
-        _description_, by default None
-    """
-
-    # The server configuration manager is aware of the structure of the server
-    # configuration file and makes sure only valid configuration can be loaded.
-    INST_CONFIG_MANAGER = NodeConfigurationManager
-
-    def __init__(self, instance_name: str, system_folders: bool = N_FOL,
-                 config_file: str = None):
-        super().__init__("node", instance_name, system_folders, config_file)
-        self.log.info(f"vantage6 version '{__version__}'")
-
-    @classmethod
-    def from_external_config_file(cls, path: str,
-                                  system_folders: bool = N_FOL) -> NodeContext:
-        """
-        Create a node context from an external configuration file. External
-        means that the configuration file is not located in the default folders
-        but its location is specified by the user.
-
-        Parameters
-        ----------
-        path : str
-            Path of the configuration file
-        system_folders : bool, optional
-            System wide or user configuration, by default N_FOL
-
-        Returns
-        -------
-        NodeContext
-            Node context object
-        """
-        return super().from_external_config_file(path, "node", system_folders)
-
-    @classmethod
-    def config_exists(cls, instance_name: str,
-                      system_folders: bool = N_FOL) -> bool:
-        """
-        Check if a configuration file exists.
-
-        Parameters
-        ----------
-        instance_name : str
-            Name of the configuration instance, corresponds to the filename
-            of the configuration file.
-        system_folders : bool, optional
-            System wide or user configuration, by default N_FOL
-
-        Returns
-        -------
-        bool
-            Whether the configuration file exists or not
-        """
-        return super().config_exists("node", instance_name,
-                                     system_folders=system_folders)
-
-    @classmethod
-    def available_configurations(cls, system_folders: bool = N_FOL) \
-            -> tuple[list, list]:
-        """
-        Find all available server configurations in the default folders.
-
-        Parameters
-        ----------
-        system_folders : bool, optional
-            System wide or user configuration, by default N_FOL
-
-        Returns
-        -------
-        tuple[list, list]
-            The first list contains validated configuration files, the second
-            list contains invalid configuration files.
-        """
-        return super().available_configurations("node", system_folders)
-
-    @staticmethod
-    def type_data_folder(system_folders: bool = N_FOL) -> Path:
-        """
-        Obtain OS specific data folder where to store node specific data.
-
-        Parameters
-        ----------
-        system_folders : bool, optional
-            System wide or user configuration
-
-        Returns
-        -------
-        Path
-            Path to the data folder
-        """
-        return AppContext.type_data_folder("node", system_folders)
-
-    @property
-    def databases(self) -> dict:
-        """
-        Dictionary of local databases that are available for this node.
-
-        Returns
-        -------
-        dict
-            dictionary with database names as keys and their corresponding
-            paths as values.
-        """
-        return self.config["databases"]
-
-    @property
-    def docker_container_name(self) -> str:
-        """
-        Docker container name of the node.
-
-        Returns
-        -------
-        str
-            Node's Docker container name
-        """
-        return f"{APPNAME}-{self.name}-{self.scope}"
-
-    @property
-    def docker_network_name(self) -> str:
-        """
-        Private Docker network name which is unique for this node.
-
-        Returns
-        -------
-        str
-            Docker network name
-        """
-        return f"{APPNAME}-{self.name}-{self.scope}-net"
-
-    @property
-    def docker_volume_name(self) -> str:
-        """
-        Docker volume in which task data is stored. In case a file based
-        database is used, this volume contains the database file as well.
-
-        Returns
-        -------
-        str
-            Docker volume name
-        """
-        return os.environ.get(
-            'DATA_VOLUME_NAME',
-            f"{self.docker_container_name}-vol"
-        )
-
-    @property
-    def docker_vpn_volume_name(self) -> str:
-        """
-        Docker volume in which the VPN configuration is stored.
-
-        Returns
-        -------
-        str
-            Docker volume name
-        """
-        return os.environ.get(
-            'VPN_VOLUME_NAME',
-            f"{self.docker_container_name}-vpn-vol"
-        )
-
-    @property
-    def docker_ssh_volume_name(self) -> str:
-        """
-        Docker volume in which the SSH configuration is stored.
-
-        Returns
-        -------
-        str
-            Docker volume name
-        """
-        return os.environ.get(
-            'SSH_TUNNEL_VOLUME_NAME',
-            f"{self.docker_container_name}-ssh-vol"
-        )
-
-    @property
-    def docker_squid_volume_name(self) -> str:
-        """
-        Docker volume in which the SSH configuration is stored.
-
-        Returns
-        -------
-        str
-            Docker volume name
-        """
-        return os.environ.get(
-            'SSH_SQUID_VOLUME_NAME',
-            f"{self.docker_container_name}-squid-vol"
-        )
-
-    @property
-    def proxy_log_file(self):
-        return self.log_file_name(type_="proxy_server")
-
-    def docker_temporary_volume_name(self, job_id: int) -> str:
-        """
-        Docker volume in which temporary data is stored. Temporary data is
-        linked to a specific run. Multiple algorithm containers can have the
-        same run id, and therefore the share same temporary volume.
-
-        Parameters
-        ----------
-        job_id : int
-            run id provided by the server
-
-        Returns
-        -------
-        str
-            Docker volume name
-        """
-        return f"{APPNAME}-{self.name}-{self.scope}-{job_id}-tmpvol"
-
-    def get_database_uri(self, label: str = "default") -> str:
-        """
-        Obtain the database URI for a specific database.
-
-        Parameters
-        ----------
-        label : str, optional
-            Database label, by default "default"
-
-        Returns
-        -------
-        str
-            URI to the database
-        """
-        return self.config["databases"][label]

vantage6-4.2.1.dist-info/RECORD

@@ -1,58 +0,0 @@
-tests_cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests_cli/test_example.py,sha256=TV8JA52UR-Yh1WeVwx8g8ngA9ZTiRCwsJkUKxsXUXMg,147
-tests_cli/test_node_cli.py,sha256=8tfCNvdZT7uMgOJ0QbBlY73kox7RUIDHhxQWVtJiSiA,15454
-tests_cli/test_server_cli.py,sha256=hWnGEV6JnXN_SqpUiQxCzITBlbYKRykb8B4MkFX7aEU,5798
-tests_cli/test_wizard.py,sha256=dRrOScN79z8nKGNWmn6tPAVfnDOmCsGckiDJMKufhms,3580
-vantage6/cli/__build__,sha256=X-zrZv_IbzjZUnhsbWlsecLbwjndTpG0ZynXOif7V-k,1
-vantage6/cli/__init__.py,sha256=dEbhLHe9VfU3otY3CQkMVrj39uPGWjqzAvHW2B2Flgs,62
-vantage6/cli/_version.py,sha256=YNVmlpiuEjYqo5Qo08oPbrp_LIjTk2VfPO8LA_Z2sr0,684
-vantage6/cli/cli.py,sha256=Tz7dj6X8GVPrzHd9GehURdbPFIDzGvyYW2MXRUJwFs4,4875
-vantage6/cli/configuration_manager.py,sha256=4EHlOW16nfIiplzA0sw9udc4-VLKcmdKgWzzFa5Nw7A,3841
-vantage6/cli/configuration_wizard.py,sha256=c8L4xm9_HYjAkyTmRmLDMwzTDqdKdgnBZy915TAIfRI,11569
-vantage6/cli/context.py,sha256=dJZWmOZGqQ3MazrPu8HbnXbNC2tzHcLjns9KoIHGpFk,13045
-vantage6/cli/globals.py,sha256=yDYhbzWgwrd549lTkVH7g59orQuN30zwP60VHiUiMD4,1027
-vantage6/cli/utils.py,sha256=Lx1xYKXDBeHjJpXGkVAhidy79P-zV3TOQYfa2nMbvSs,2353
-vantage6/cli/algorithm/create.py,sha256=cUjehkwRa6eWRSnWLPk9iLk4_qf8x_MI2WxmaAUMVT0,1496
-vantage6/cli/algorithm/update.py,sha256=0GCkFIRGV-HWHWagTSqkE9_SPuVrTMQQhtytpitMiQc,821
-vantage6/cli/dev/create.py,sha256=Xij_DOunyjzoDulpIrL00kasHiXbjp_YJWR3OjScCZc,13249
-vantage6/cli/dev/remove.py,sha256=m5Yjt7U3pTmlZm1f8G8JsxMm9k-CWTgoy-sCZ7GTnZA,2211
-vantage6/cli/dev/start.py,sha256=IJbXzezMx4MK7rO9nx3AvidEZfdUL5mX0gA7AlwETLU,1629
-vantage6/cli/dev/stop.py,sha256=XDvjyxxU4gVnC9sKHxYMLYPmDwRq_4lnpXE9imO614Q,993
-vantage6/cli/node/attach.py,sha256=n7mJaDJq7tngMVigXe0_JBAdueV_5YEz8FmVOvAF-PU,2152
-vantage6/cli/node/clean.py,sha256=1C0bTEuc6UO-GBIWUsp9YgO_sK5O5Mg-zZYnsCmd2OE,1088
-vantage6/cli/node/create_private_key.py,sha256=U0kuXmB-POneJzB8rxQ9AHRaqrmp_S54isRkG2a7rhg,4988
-vantage6/cli/node/files.py,sha256=ELpTvGKiPsfSH8kiYrnHfM4Fb8AES8uJF3L2sGQJ27c,1331
-vantage6/cli/node/list.py,sha256=b8ht09bvzVFiQx909r8zeTruCWC2uLyrNVeiipCjgAI,1707
-vantage6/cli/node/new.py,sha256=01sp9005TidvHA_awuaahBHV1-LImspStLTYhruek_A,1858
-vantage6/cli/node/remove.py,sha256=kLMK2Xsfgwrb3FuqRc9cKCadc8p0P3dLTLt9wN1_sBg,3564
-vantage6/cli/node/set_api_key.py,sha256=cJXWe1G5m2LTlyhBX85KFlCcL7voO-YNHUvhnsrwHhE,1796
-vantage6/cli/node/start.py,sha256=ojv2csH0PcqfoT9rZNJpmuGerqBN74Ypt5bta6caLic,12404
-vantage6/cli/node/stop.py,sha256=08SWafKBpCY_pnMopRkcIcHNaBoxqRHmlDSfQDzWjuQ,2704
-vantage6/cli/node/version.py,sha256=HD0iCf2VGZK8HVYfNcMpDAQdxYQ--5ff10XYCsX7Hf4,1843
-vantage6/cli/node/common/__init__.py,sha256=nUDpIehzfX9Zd3tL2Wa9nP5940SH27gcXGRiCHcxjrA,3166
-vantage6/cli/rabbitmq/__init__.py,sha256=0cuoLZ3V1199PKI-Ew37leZmh77SOAYa8CKMLUUBgBs,737
-vantage6/cli/rabbitmq/definitions.py,sha256=aGFdwxzi7R28uaDS60iW3a-JCkV2F5w_T3oede0kWds,536
-vantage6/cli/rabbitmq/queue_manager.py,sha256=CG2Lx5RCpf2AjzaCvj9vrwrqJOlWbEqf89auX2iuXcU,7613
-vantage6/cli/rabbitmq/rabbitmq.config,sha256=LYAQAEoXaF472XeJDYXc9JfWSETIzPRIR2W-JB2i7fU,136
-vantage6/cli/server/attach.py,sha256=TKibcEhqeMrTX3MQ5OkKlkqBs2pSSsZDh_yiaAoNOpw,1930
-vantage6/cli/server/files.py,sha256=owBO6lj_ucHY00MxJUOOdacz4NbdOqp-vrfkVrGjPUE,481
-vantage6/cli/server/import_.py,sha256=Up3IAK3c9jyFpr7y9_zl4HNViFj6jT9OLh_S6v6t5Hs,4611
-vantage6/cli/server/list.py,sha256=p5SRRGsz6G83Hc53eYoySWi32egm7jie_lo1gkS0NCk,1734
-vantage6/cli/server/new.py,sha256=ZHnjWlEKXOMdu6WYHDcrD62Qc2au-YuYIv2SW2KXS7M,1913
-vantage6/cli/server/remove.py,sha256=1Ogw2npPA9QsExVforzLe3dI3eTwxuBd9oasviX4Z_g,1182
-vantage6/cli/server/shell.py,sha256=SRw-CrD_ro9DRfqCI6IlifJk_UDr6EIke5ypN4-85yo,1384
-vantage6/cli/server/start.py,sha256=-qD1rB5dRXWLL13OVWFb4DwdshGF708bL19WOlO9uUo,10952
-vantage6/cli/server/stop.py,sha256=aEOqa2hYPLTGPkMBzFrFI4FLP0zMskjYD1vqzDyKEog,4005
-vantage6/cli/server/version.py,sha256=upvy6VdO3XGfovEW-2Ybc0c0niM2ieCOrz1SlsBrqkw,1743
-vantage6/cli/server/common/__init__.py,sha256=kUcDOfGuNvf8j7g5er9D_7z8IHRk53QBQ2E0NcZ_1iE,4818
-vantage6/cli/template/node_config.j2,sha256=ebTifJuRlfUhjtI8jm9A2SWXGpUcg8L-XUBInSwAppA,522
-vantage6/cli/template/server_config.j2,sha256=rKXMky8rA7Lnf5USlPx0Es9AskwmL4bILWfACPvygv4,394
-vantage6/cli/template/server_import_config.j2,sha256=PRB0ym_FYjx9vhkmY9C0xzlv_85Y5kBfWdUYs089bNQ,1844
-vantage6/cli/test/feature_tester.py,sha256=8MJGotRonEje6GVTkqOr5u1LbZi3W4A4gQnf5OYt-2I,2368
-vantage6/cli/test/integration_test.py,sha256=GpYG0uHoD1lVKwtSFk_QhdR1e_AYzKWIVPDI5CSwJ8o,3669
-vantage6/cli/test/common/diagnostic_runner.py,sha256=j6MWV0_dKZScYBwd--3_dv_JSeWyeUmp8T7E-7ZSjs8,6755
-vantage6-4.2.1.dist-info/METADATA,sha256=avZTkR4zvPMBuGWLJUc9ve0V56OlqeUbRxwYe9r6R2A,9758
-vantage6-4.2.1.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-vantage6-4.2.1.dist-info/entry_points.txt,sha256=YFBvwjxoeAGxYyPC-YevEgOBBYRGaXkS6jiOGGCLNy0,157
-vantage6-4.2.1.dist-info/top_level.txt,sha256=CYDIBS8jEfFq5YCs_Fuit54K9-3wdosZppTrsymIoUk,19
-vantage6-4.2.1.dist-info/RECORD,,