cgse 2023.38.0__py3-none-any.whl → 2024.1.4__py3-none-any.whl

egse/storage/storage.yaml

@@ -1,72 +0,0 @@
-BaseClass:
-    egse.storage.StorageInterface
-
-ProxyClass:
-    egse.storage.StorageProxy
-
-ControlServerClass:
-    egse.storage.StorageControlServer
-
-ControlServer:
-    egse.storage.storage_cs
-
-Commands:
-
-    # Each of these groups is parsed and used on both the server and the client side.
-    # The group name (e.g. is_simulator) will be monkey patched in the Proxy class for the device or service.
-    # The other field are:
-    #   description:   Used by the doc_string method to generate a help string
-    #   cmd:           Command string that will eventually be send to the hardware controller for the
-    #                  device.
-    #   device_method: The name of the method to be called on the device class.
-    #                  These should all be defined by the base class for the device, i.e. HexapodBase.
-    #   response:      The name of the method to be called from the device protocol.
-    #                  This method should exist in the subclass of the CommandProtocol base class, i.e.
-    #                  in this case it will be the HexapodProtocol class.
-
-    start_observation:
-        description:    Start a new observation aka test.
-        cmd:            '{obsid}, {camera_name}'
-
-    end_observation:
-        description:    End the current observation.
-        cmd:            '{obsid}'
-
-    get_obsid:
-        description:    Return the current observation identifier
-
-    save:
-        description:    Save data. The packet should be of type StoragePacket.
-        cmd:            '{packet}'
-
-    read:
-        description:    Read data from the registered storage.
-        cmd:            '{item}'
-
-    register:
-        description:    Register a client to the Storage Manager.
-        cmd:            '{client_info}'
-
-    unregister:
-        description:    De-register a client from the Storage Manager.
-        cmd:            '{client_info}'
-
-    get_registry_names:
-        description:    Returns the names/identifiers of the registered components.
-
-    cycle_daily_files:
-        description:    Create new daily files for all registered items.
-
-    get_storage_location:
-        description:    Returns the path to the Storage location on the server.
-
-    new_registration:
-        description:    Open a new data file to which the incoming data needs to be written.
-        cmd:            "{item}, {use_counter}"
-
-    get_filenames:
-        description:    Return the filename(s) associated with this registered item.
-        cmd:            "{item}"
-
-    get_disk_usage:
-        description:    Returns the total, used, and free disk space.

egse/storage/storage_cs.py

@@ -1,214 +0,0 @@
-"""
-The Storage Control Server, aka Storage Manager, is the service which saves all data coming
-from any component in the Common-EGSE.
-
-The Storage manager is implemented as a standard control server.
-
-"""
-import logging
-import multiprocessing
-import sys
-from pathlib import Path
-
-import click
-import zmq
-from apscheduler.schedulers.background import BackgroundScheduler
-from prometheus_client import start_http_server
-from pytz import utc
-
-from egse.bits import humanize_bytes
-from egse.control import ControlServer
-from egse.env import get_data_storage_location
-from egse.settings import Settings
-from egse.storage import StorageProtocol
-from egse.storage import StorageProxy
-from egse.storage import cycle_daily_files
-from egse.storage import is_storage_manager_active
-from egse.system import replace_environment_variable
-
-# Use explicit name here otherwise the logger will probably be called __main__
-
-logger = logging.getLogger("egse.storage.storage_cs")
-
-CTRL_SETTINGS = Settings.load("Storage Control Server")
-SITE = Settings.load("SITE")
-
-
-class StorageControlServer(ControlServer):
-    """
-    The Storage Control Server (aka Storage Manager) saves information from registered components.
-    """
-
-    def __init__(self):
-        super().__init__()
-
-        self.device_protocol = StorageProtocol(self)
-
-        self.logger = logger
-        self.logger.debug(f"Binding ZeroMQ socket to {self.device_protocol.get_bind_address()}")
-
-        self.device_protocol.bind(self.dev_ctrl_cmd_sock)
-
-        self.poller.register(self.dev_ctrl_cmd_sock, zmq.POLLIN)
-
-    def before_serve(self):
-
-        self.scheduler = BackgroundScheduler(timezone=utc)
-        self.scheduler.start()
-        self.scheduler.add_job(cycle_daily_files, "cron", day="*")
-
-        start_http_server(CTRL_SETTINGS.METRICS_PORT)
-
-    def after_serve(self):
-        self.scheduler.shutdown()
-
-    def get_communication_protocol(self):
-        return CTRL_SETTINGS.PROTOCOL
-
-    def get_commanding_port(self):
-        return CTRL_SETTINGS.COMMANDING_PORT
-
-    def get_service_port(self):
-        return CTRL_SETTINGS.SERVICE_PORT
-
-    def get_monitoring_port(self):
-        return CTRL_SETTINGS.MONITORING_PORT
-
-
-@click.group()
-def cli():
-    pass
-
-
-@cli.command()
-def start():
-    """Start the Storage Manager."""
-
-    multiprocessing.current_process().name = "storage_cs"
-
-    # We import this class such that the class name is
-    # 'egse.storage.storage_cs.StorageControlServer' and we
-    # can compare self with isinstance inside the Control.
-    # If this import is not done, the class name for the
-    # StorageControlServer would be '__main__.StorageControlServer'.
-
-    from egse.storage.storage_cs import StorageControlServer
-
-    try:
-        check_prerequisites()
-    except RuntimeError as exc:
-        logger.info(exc)
-        return 0
-
-    try:
-        control_server = StorageControlServer()
-        control_server.serve()
-    except KeyboardInterrupt:
-        print("Shutdown requested...exiting")
-    except SystemExit as exit_code:
-        print("System Exit with code {}.".format(exit_code))
-        sys.exit(exit_code)
-    except Exception:
-        import traceback
-
-        traceback.print_exc(file=sys.stdout)
-
-    return 0
-
-
-@cli.command()
-def stop():
-    """Send a 'quit_server' command to the Storage Manager."""
-    with StorageProxy() as sm:
-        sp = sm.get_service_proxy()
-        sp.quit_server()
-
-
-@cli.command()
-@click.option("--full", is_flag=True, help="Give a full status report")
-def status(full):
-    """Print the status of the control server."""
-
-    import rich
-
-    rich.print("Storage Manager:")
-    if is_storage_manager_active():
-        rich.print("  Status: [green]active")
-        with StorageProxy() as sm:
-            rich.print(f"  Hostname: {sm.get_ip_address()}")
-            rich.print(f"  Monitoring port: {sm.get_monitoring_port()}")
-            rich.print(f"  Commanding port: {sm.get_commanding_port()}")
-            rich.print(f"  Service port: {sm.get_service_port()}")
-            rich.print(f"  Storage location: {sm.get_storage_location()}")
-            rich.print(f"  Registrations: {sm.get_registry_names()}")
-            if full:
-                rich.print("Filenames for all registered items:")
-                for origin in sm.get_registry_names():
-                    fn = [x for x in sm.get_filenames({"origin": origin})]
-                    rich.print(f"  {origin:10s} ->  {fn}")
-                if obsid := sm.get_obsid():
-                    rich.print(f"An observation is registered: {obsid}")
-                else:
-                    rich.print("No observation is registered.")
-
-                total, used, free = sm.get_disk_usage()
-                rich.print(f"Total disk space: {humanize_bytes(total)}")
-                rich.print(f"Used disk space: {humanize_bytes(used)} ({(used / total * 100):.2f}%)")
-                rich.print(f"Free disk space: {humanize_bytes(free)} ({(free / total * 100):.2f}%)")
-
-    else:
-        rich.print("  Status: [red]not active")
-
-
-def check_prerequisites():
-    """Checks if all prerequisites for running the Storage Manager are met.
-
-    Raises:
-        RuntimeError when one or more of the prerequisites is not met.
-    """
-
-    fails = 0
-
-    # We need a proper location for storing the data, this directory shall contain
-    # two subfolders: 'daily' and 'obs'.
-
-    location = get_data_storage_location(site_id=SITE.ID)
-
-    if not location:
-        raise RuntimeError(
-            "The environment variable referenced in the Settings.yaml file for the "
-            "FILE_STORAGE_LOCATION does not exist, please set the environment variable."
-        )
-
-    location = Path(location)
-
-    if not location.exists():
-        logger.error(
-            f"The directory {location} does not exist, provide a writable location for "
-            f"storing the data."
-        )
-        fails += 1
-
-    logger.debug(f"location = {location}")
-
-    daily_dir = location / "daily"
-    obs_dir = location / "obs"
-
-    if not daily_dir.exists():
-        logger.error("The data storage location shall have a 'daily' sub-folder.")
-        fails += 1
-    if not obs_dir.exists():
-        logger.error("The data storage location shall have a 'obs' sub-folder.")
-        fails += 1
-
-    # now raise the final verdict
-
-    if fails:
-        raise RuntimeError(
-            "Some of the prerequisites for the Storage Manager haven't met. "
-            "Please check the logs."
-        )
-
-
-if __name__ == "__main__":
-    sys.exit(cli())

egse/styles/dark.qss

@@ -1,343 +0,0 @@
-QToolTip{
-  color:#ffffff;
-  background-color:palette(base);
-  border:1px solid palette(highlight);
-  border-radius:4px;
-}
-QStatusBar{
-  background-color:qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  color:palette(mid);
-}
-QMenuBar{
-  background-color:qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-bottom:2px solid rgba(25,25,25,75);
-}
-QMenuBar::item{
-  spacing:2px;
-  padding:3px 4px;
-  background:transparent;
-}
-QMenuBar::item:selected{
-  background-color:qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(106,106,106,255),stop:1 rgba(106,106,106,75));
-  border-left:1px solid rgba(106,106,106,127);
-  border-right:1px solid rgba(106,106,106,127);
-}
-QMenuBar::item:pressed{
-  background-color:palette(highlight);
-  border-left:1px solid rgba(25,25,25,127);
-  border-right:1px solid rgba(25,25,25,127);
-}
-QMenu{
-  background-color:palette(window);
-  border:1px solid palette(shadow);
-}
-QMenu::item{
-  padding:3px 25px 3px 25px;
-  border:1px solid transparent;
-}
-QMenu::item:disabled{
-  background-color:rgba(35,35,35,127);
-  color:palette(disabled);
-}
-QMenu::item:selected{
-  border-color:rgba(147,191,236,127);
-  background:palette(highlight);
-}
-QMenu::icon:checked{
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border:1px solid palette(highlight);
-  border-radius:2px;
-}
-QMenu::separator{
-  height:1px;
-  background:palette(alternate-base);
-  margin-left:5px;
-  margin-right:5px;
-}
-QMenu::indicator{
-  width:18px;
-  height:18px;
-}
-QMenu::indicator:non-exclusive:checked{
-  image:url(:/darkstyle/icon_checkbox_checked.png);
-  padding-left:2px;
-}
-QMenu::indicator:non-exclusive:unchecked{
-  image:url(:/darkstyle/icon_checkbox_unchecked.png);
-  padding-left:2px;
-}
-QMenu::indicator:exclusive:checked{
-  image:url(:/darkstyle/icon_radiobutton_checked.png);
-  padding-left:2px;
-}
-QMenu::indicator:exclusive:unchecked{
-  image:url(:/darkstyle/icon_radiobutton_unchecked.png);
-  padding-left:2px;
-}
-QToolBar::top{
-  background-color:qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-bottom:3px solid qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-}
-QToolBar::bottom{
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-top:3px solid qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-}
-QToolBar::left{
-  background-color:qlineargradient(x1:0,y1:0,x2:1,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-right:3px solid qlineargradient(x1:0,y1:0,x2:1,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-}
-QToolBar::right{
-  background-color:qlineargradient(x1:1,y1:0,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-left:3px solid qlineargradient(x1:1,y1:0,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-}
-QMainWindow::separator{
-  width:6px;
-  height:5px;
-  padding:2px;
-}
-QSplitter::handle:horizontal{
-  width:10px;
-}
-QSplitter::handle:vertical{
-  height:10px;
-}
-QMainWindow::separator:hover,QSplitter::handle:hover{
-  background:palette(highlight);
-}
-QDockWidget::title{
-  padding:4px;
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border:1px solid rgba(25,25,25,75);
-  border-bottom:2px solid rgba(25,25,25,75);
-}
-QDockWidget{
-  titlebar-close-icon:url(:/darkstyle/icon_close.png);
-  titlebar-normal-icon:url(:/darkstyle/icon_restore.png);
-}
-QDockWidget::close-button,QDockWidget::float-button{
-  subcontrol-position:top right;
-  subcontrol-origin:margin;
-  position:absolute;
-  top:3px;
-  bottom:0px;
-  width:20px;
-  height:20px;
-}
-QDockWidget::close-button{
-  right:3px;
-}
-QDockWidget::float-button{
-  right:25px;
-}
-QGroupBox{
-  background-color:rgba(66,66,66,50%);
-  margin-top:27px;
-  border:1px solid rgba(25,25,25,127);
-  border-radius:4px;
-}
-QGroupBox::title{
-  subcontrol-origin:margin;
-  subcontrol-position:left top;
-  padding:4px 6px;
-  margin-left:3px;
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border:1px solid rgba(25,25,25,75);
-  border-bottom:2px solid rgb(127,127,127);
-  border-top-left-radius:4px;
-  border-top-right-radius:4px;
-}
-QTabWidget::pane{
-  background-color:rgba(66,66,66,50%);
-  border-top:1px solid rgba(25,25,25,50%);
-}
-QTabWidget::tab-bar{
-  left:3px;
-  top:1px;
-}
-QTabBar{
-  background-color:transparent;
-  qproperty-drawBase:0;
-  border-bottom:1px solid rgba(25,25,25,50%);
-}
-QTabBar::tab{
-  padding:4px 6px;
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border:1px solid rgba(25,25,25,75);
-  border-top-left-radius:4px;
-  border-top-right-radius:4px;
-}
-QTabBar::tab:selected,QTabBar::tab:hover{
-  background-color:qlineargradient(x1:0,y1:0,x2:0,y2:1,stop:0 rgba(53,53,53,127),stop:1 rgba(66,66,66,50%));
-  border-bottom-color:rgba(66,66,66,75%);
-}
-QTabBar::tab:selected{
-  border-bottom:2px solid palette(highlight);
-}
-QTabBar::tab::selected:disabled{
-  border-bottom:2px solid rgb(127,127,127);
-}
-QTabBar::tab:!selected{
-  margin-top:2px;
-}
-QCheckBox::indicator{
-  width:18px;
-  height:18px;
-}
-QCheckBox::indicator:checked,QTreeView::indicator:checked,QTableView::indicator:checked,QGroupBox::indicator:checked{
-  image:url(:/darkstyle/icon_checkbox_checked.png);
-}
-QCheckBox::indicator:checked:pressed,QTreeView::indicator:checked:pressed,QTableView::indicator:checked:pressed,QGroupBox::indicator:checked:pressed{
-  image:url(:/darkstyle/icon_checkbox_checked_pressed.png);
-}
-QCheckBox::indicator:checked:disabled,QTreeView::indicator:checked:disabled,QTableView::indicator:checked:disabled,QGroupBox::indicator:checked:disabled{
-  image:url(:/darkstyle/icon_checkbox_checked_disabled.png);
-}
-QCheckBox::indicator:unchecked,QTreeView::indicator:unchecked,QTableView::indicator:unchecked,QGroupBox::indicator:unchecked{
-  image:url(:/darkstyle/icon_checkbox_unchecked.png);
-}
-QCheckBox::indicator:unchecked:pressed,QTreeView::indicator:unchecked:pressed,QTableView::indicator:unchecked:pressed,QGroupBox::indicator:unchecked:pressed{
-  image:url(:/darkstyle/icon_checkbox_unchecked_pressed.png);
-}
-QCheckBox::indicator:unchecked:disabled,QTreeView::indicator:unchecked:disabled,QTableView::indicator:unchecked:disabled,QGroupBox::indicator:unchecked:disabled{
-  image:url(:/darkstyle/icon_checkbox_unchecked_disabled.png);
-}
-QCheckBox::indicator:indeterminate,QTreeView::indicator:indeterminate,QTableView::indicator:indeterminate,QGroupBox::indicator:indeterminate{
-  image:url(:/darkstyle/icon_checkbox_indeterminate.png);
-}
-QCheckBox::indicator:indeterminate:pressed,QTreeView::indicator:indeterminate:pressed,QTableView::indicator:indeterminate:pressed,QGroupBox::indicator:indeterminate:pressed{
-  image:url(:/darkstyle/icon_checkbox_indeterminate_pressed.png);
-}
-QCheckBox::indicator:indeterminate:disabled,QTreeView::indicator:indeterminate:disabled,QTableView::indicator:indeterminate:disabled,QGroupBox::indicator:indeterminate:disabled{
-  image:url(:/darkstyle/icon_checkbox_indeterminate_disabled.png);
-}
-QRadioButton::indicator{
-  width:18px;
-  height:18px;
-}
-QRadioButton::indicator:checked{
-  image:url(:/darkstyle/icon_radiobutton_checked.png);
-}
-QRadioButton::indicator:checked:pressed{
-  image:url(:/darkstyle/icon_radiobutton_checked_pressed.png);
-}
-QRadioButton::indicator:checked:disabled{
-  image:url(:/darkstyle/icon_radiobutton_checked_disabled.png);
-}
-QRadioButton::indicator:unchecked{
-  image:url(:/darkstyle/icon_radiobutton_unchecked.png);
-}
-QRadioButton::indicator:unchecked:pressed{
-  image:url(:/darkstyle/icon_radiobutton_unchecked_pressed.png);
-}
-QRadioButton::indicator:unchecked:disabled{
-  image:url(:/darkstyle/icon_radiobutton_unchecked_disabled.png);
-}
-QTreeView, QTableView{
-  alternate-background-color:palette(window);
-  background:palette(base);
-}
-QTreeView QHeaderView::section, QTableView QHeaderView::section{
-  background-color:qlineargradient(x1:0,y1:1,x2:0,y2:0,stop:0 rgba(25,25,25,127),stop:1 rgba(53,53,53,75));
-  border-style:none;
-  border-bottom:1px solid palette(dark);
-  padding-left:5px;
-  padding-right:5px;
-}
-QTreeView::item:selected:disabled, QTableView::item:selected:disabled{
-  background:rgb(80,80,80);
-}
-QTreeView::branch{
-  background-color:palette(base);
-}
-QTreeView::branch:has-siblings:!adjoins-item{
-  border-image:url(:/darkstyle/icon_vline.png) 0;
-}
-QTreeView::branch:has-siblings:adjoins-item{
-  border-image:url(:/darkstyle/icon_branch_more.png) 0;
-}
-QTreeView::branch:!has-children:!has-siblings:adjoins-item{
-  border-image:url(:/darkstyle/icon_branch_end.png) 0;
-}
-QTreeView::branch:has-children:!has-siblings:closed,
-QTreeView::branch:closed:has-children:has-siblings{
-  border-image:none;
-  image:url(:/darkstyle/icon_branch_closed.png);
-}
-QTreeView::branch:open:has-children:!has-siblings,
-QTreeView::branch:open:has-children:has-siblings{
-  border-image:none;
-  image:url(:/darkstyle/icon_branch_open.png);
-}
-QScrollBar:vertical{
-  background:palette(base);
-  border-top-right-radius:2px;
-  border-bottom-right-radius:2px;
-  width:16px;
-  margin:0px;
-}
-QScrollBar::handle:vertical{
-  background-color:palette(alternate-base);
-  border-radius:2px;
-  min-height:20px;
-  margin:2px 4px 2px 4px;
-}
-QScrollBar::handle:vertical:hover{
-  background-color:palette(highlight);
-}
-QScrollBar::add-line:vertical{
-  background:none;
-  height:0px;
-  subcontrol-position:right;
-  subcontrol-origin:margin;
-}
-QScrollBar::sub-line:vertical{
-  background:none;
-  height:0px;
-  subcontrol-position:left;
-  subcontrol-origin:margin;
-}
-QScrollBar:horizontal{
-  background:palette(base);
-  height:16px;
-  margin:0px;
-}
-QScrollBar::handle:horizontal{
-  background-color:palette(alternate-base);
-  border-radius:2px;
-  min-width:20px;
-  margin:4px 2px 4px 2px;
-}
-QScrollBar::handle:horizontal:hover{
-  background-color:palette(highlight);
-}
-QScrollBar::add-line:horizontal{
-  background:none;
-  width:0px;
-  subcontrol-position:bottom;
-  subcontrol-origin:margin;
-}
-QScrollBar::sub-line:horizontal{
-  background:none;
-  width:0px;
-  subcontrol-position:top;
-  subcontrol-origin:margin;
-}
-QSlider::handle:horizontal{
-  border-radius:4px;
-  border:1px solid rgba(25,25,25,255);
-  background-color:palette(alternate-base);
-  min-height:20px;
-  margin:0 -4px;
-}
-QSlider::handle:horizontal:hover{
-  background:palette(highlight);
-}
-QSlider::add-page:horizontal{
-  background:palette(base);
-}
-QSlider::sub-page:horizontal{
-  background:palette(highlight);
-}
-QSlider::sub-page:horizontal:disabled{
-  background:rgb(80,80,80);
-}

egse/styles/default.qss

@@ -1,48 +0,0 @@
-/*css stylesheet file that contains all the style information*/
-
-
-QGroupBox {
-    border: 1px solid lightGray;
-    border-radius: 0px;
-    margin-top: 0px;
-    padding-top: 10px;
-}
-
-QGroupBox::title {
-    background-color: transparent;
-    padding-top: 0px;
-    padding-left: 0px;
-}
-
-/*
-QGroupBox#ManualModeGroupBox {
-    border: 1px solid lightGray;
-}
-
-QFrame#AppFrame {
-  border: 1px solid black;
-}
-
-QFrame#StatusFrame {
-  border: 1px solid red;
-}
-
-QFrame#TabsFrame {
-  border: 1px solid red;
-}
-
-QWidget#ManualPositions {
-  border: 0px solid green;
-}
-*/
-
-/*
-tabs_frame.setStyleSheet("border: 1px solid orange; ")
-states_frame.setStyleSheet("border: 1px solid green; ")
-positions_frame.setStyleSheet("border: 1px solid blue; ")
-toolbar_widget.setStyleSheet("border: 1px solid black; ")
-states_widget.setStyleSheet("border: 1px solid magenta; ")
-user_positions_widget.setStyleSheet("border: 1px solid cyan; ")
-mach_positions_widget.setStyleSheet("border: 1px solid cyan; ")
-atcuator_length_widget.setStyleSheet("border: 1px solid cyan; ")
-*/