qplotter 1.6.0b3__py3-none-any.whl

qplot/configuration/config_schema.json

@@ -0,0 +1,319 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "type": "object",
+    "properties": {
+        
+        "GUI": {
+            "type": "object",
+            "properties": {
+                "plot_frame_fraction": {
+                    "type": "number",
+                    "exclusiveMinimum": 0,
+                    "exclusiveMaximum": 1,
+                    "default": 0.47
+                },
+                "main_frame_size": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer",
+                        "minimum": 1,
+                        "maximum": 16777215
+                    },
+                    "minItems": 2,
+                    "maxItems": 2,
+                    "default": [780, 700]
+                },
+                "preview_size": {
+                    "type": "integer",
+                    "minimum": 50,
+                    "maximum": 1000,
+                    "default": 200
+                },
+                "run_table_column_widths": {
+                    "type": "array",
+                    "items": {
+                        "type": "integer",
+                        "minimum": 32,
+                        "maximum": 16777215
+                    },
+                    "oneOf": [
+                        { "maxItems": 0 },
+                        { "minItems": 12, "maxItems": 12 }
+                    ],
+                    "default": []
+                },
+                "run_table_visible_columns": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "run_id",
+                            "experiment",
+                            "sample",
+                            "measurements",
+                            "setpoints",
+                            "name",
+                            "started",
+                            "completed",
+                            "status",
+                            "duration",
+                            "size",
+                            "guid"
+                        ]
+                    },
+                    "uniqueItems": true,
+                    "maxItems": 12,
+                    "default": [
+                        "run_id",
+                        "measurements",
+                        "setpoints",
+                        "started",
+                        "status",
+                        "duration",
+                        "size"
+                    ]
+                }
+            },
+            "required": [
+                "plot_frame_fraction",
+                "main_frame_size",
+                "preview_size",
+                "run_table_column_widths",
+                "run_table_visible_columns"
+            ],
+            "additionalProperties": false
+        },
+        
+        "file": {
+            "type": "object",
+            "properties": {
+                "default_load_path": {
+                    "type": "string",
+                    "default": ""
+                },
+                "recent_file_paths": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "uniqueItems": true,
+                    "maxItems": 10,
+                    "default": []
+                }
+            },
+            "required": ["default_load_path", "recent_file_paths"],
+            "additionalProperties": false
+        },
+        
+        "user_preference": {
+            "type": "object",
+            "properties": {
+                "theme":{
+                    "type": "string",
+                    "enum": ["light", "dark", "pyqt"],
+                    "default": "light"
+                },
+                "bar_colour" : {
+                    "type": "string",
+                    "default": "viridis"
+                },
+                "colorbar_width": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 500,
+                    "default": 15
+                },
+                "axis_tick_width": {
+                    "type": "number",
+                    "minimum": 0.5,
+                    "maximum": 10,
+                    "default": 2
+                },
+                "axis_major_tick_count": {
+                    "type": "integer",
+                    "minimum": 2,
+                    "maximum": 10,
+                    "default": 3
+                },
+                "bar_colour_include_cet": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_local": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_custom": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_linear": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_divergent": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_cyclic": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_rainbow": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_isoluminant": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_cet_other": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_perceptual": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_sequential": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_divergent": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_cyclic": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_qualitative": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_include_matplotlib_other": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "bar_colour_excluded": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "default": []
+                },
+                "bar_colour_excluded_prefixes": {
+                    "type": "array",
+                    "items": { "type": "string" },
+                    "default": []
+                },
+                "confirm_close": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "confirm_close_all": {
+                    "type": "boolean",
+                    "default": true
+                },
+                "mouse_mode": {
+                    "type": "string",
+                    "enum": ["pan", "rect"],
+                    "default": "pan"
+                },
+                "copy_plot_image_resolution": {
+                    "type": "string",
+                    "enum": ["screen", "dpi_300", "svg"],
+                    "default": "screen"
+                },
+                "auto_plot": {
+                    "type": "boolean",
+                    "default": false
+                },
+                "default_refresh_rate": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 10000,
+                    "default": 1
+                }
+            },
+            "required": [
+                "theme",
+                "bar_colour",
+                "colorbar_width",
+                "axis_tick_width",
+                "axis_major_tick_count",
+                "bar_colour_include_cet",
+                "bar_colour_include_matplotlib",
+                "bar_colour_include_local",
+                "bar_colour_include_custom",
+                "bar_colour_include_cet_linear",
+                "bar_colour_include_cet_divergent",
+                "bar_colour_include_cet_cyclic",
+                "bar_colour_include_cet_rainbow",
+                "bar_colour_include_cet_isoluminant",
+                "bar_colour_include_cet_other",
+                "bar_colour_include_matplotlib_perceptual",
+                "bar_colour_include_matplotlib_sequential",
+                "bar_colour_include_matplotlib_divergent",
+                "bar_colour_include_matplotlib_cyclic",
+                "bar_colour_include_matplotlib_qualitative",
+                "bar_colour_include_matplotlib_other",
+                "bar_colour_excluded",
+                "bar_colour_excluded_prefixes",
+                "confirm_close",
+                "confirm_close_all",
+                "mouse_mode",
+                "copy_plot_image_resolution",
+                "auto_plot",
+                "default_refresh_rate"
+            ],
+            "additionalProperties": false
+        },
+        
+        "runtime_settings": {
+            "type": "object",
+            "properties": {
+                "max_threads": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 999,
+                    "default": 4
+                },
+                "max_full_heatmap_points": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 2000000000,
+                    "default": 2000000
+                },
+                "max_heatmap_grid_cells": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 2000000000,
+                    "default": 250000
+                },
+                "max_heatmap_grid_side": {
+                    "type": "integer",
+                    "minimum": 1,
+                    "maximum": 2000000000,
+                    "default": 800
+                },
+                "del_grace_period": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 300,
+                    "default": 10
+                },
+                "cloud_sync_timeout": {
+                    "type": "number",
+                    "minimum": 1,
+                    "maximum": 3600,
+                    "default": 120
+                }
+             },
+             "required": ["max_threads", "max_full_heatmap_points", "max_heatmap_grid_cells", "max_heatmap_grid_side", "del_grace_period", "cloud_sync_timeout"],
+             "additionalProperties": false 
+        }
+    },
+    "required": ["GUI", "file", "user_preference", "runtime_settings"],
+    "additionalProperties": false
+}

qplot/configuration/scripts.py

@@ -0,0 +1,255 @@
+import json
+import sys
+
+from jsonschema import ValidationError
+
+from qplot._metadata import package_version
+
+from .config import config
+
+
+class sysHandle:
+    """
+    Entry point for terminal/console based commands. Called through scripts, 
+    which is set up in pyproject.toml.
+    
+    This is somewhat Jerry-Rigged, fetching string following qplot-cfg and 
+    converts them to command matching functions here.
+    """
+    def __init__(self, command, *args):
+        
+        # Find valid commands by checking against class attributes which are callable
+        self.valid_args = [f"-{str(method_name)}" for method_name in dir(sysHandle)
+                      if callable(getattr(sysHandle, method_name))
+                      and method_name[0] != "_"]
+
+        # Convert command str to callable
+        if command in self.valid_args:
+            func = getattr(self, command[1:])
+        else:
+            key = f"Command: ({command}), not found. Valid options: {self.valid_args}"
+            raise KeyError(key)
+        
+        self._config = None
+        func(*args) # Pass other arguments to func
+
+    @property
+    def config(self):
+        """Create the configuration only for commands that access it."""
+        if self._config is None:
+            self._config = config()
+        return self._config
+
+    def dump(self):
+        """
+        -dump
+        -----
+        Prints the location of the config.json file along with its full 
+        contents
+        
+        """
+        self.config.dump()
+        
+    def reset(self):
+        """
+        -reset
+        ------
+        Reset all config.json values to their defaults and prints new config
+        file
+
+
+        """
+        self.config.reset_to_defaults()
+        print("Config reset:")
+        self.dump()
+        
+    def find(self, key : str):
+        """
+        -find
+        -----
+        Returns the key and the value assiated with that key.
+        key must be laid out as a dot (.) seperated path, i.e.
+            qplot-cfg -find GUI.main_frame_size
+
+        Parameters
+        ----------
+        key : str
+            Location of value to fetch.
+        
+        Raises
+        ------
+        KeyError
+            Key not found in file
+
+        """
+        print(f"{key}:\t{self.config.get(key)}")
+        
+    def set_value(
+            self,
+            key : str, 
+            value: str,
+            ):
+        """
+        -set_value
+        ----------
+        Sets the value in the config.json file, located at key.
+        
+        > key must be laid out as a dot (.) seperated path, i.e.
+             qplot-cfg -set_value user_preference.theme dark
+          or
+             qplot-cfg -set_value GUI.plot_frame_fraction 0.25
+            
+        > If value has spaces in it, speech marks are required around it
+             qplot-cfg -set_value file.default_load_path "./file/with space"
+
+        Parameters
+        ----------
+        key : str
+            Location of the value to change.
+        value : [str, list, int, float]
+            Value to be changed to.
+
+        Raises
+        ------
+        KeyError
+            Key passed is not located in config.json
+        ValidationError
+            Value type is incorrect for corresponding key.
+
+        """
+        
+        #check if key is valid
+        self.config.get(key)
+
+        try:
+            convrt_value = _config_value(value, self.config.schema_for(key))
+            self.config.update(key, convrt_value)
+        except (TypeError, ValueError, json.JSONDecodeError, ValidationError) as error:
+            err_key = f"Value: {value}, is invalid."
+            err_key += str(error)
+            raise ValidationError(err_key) from error
+        print(f"set '{key}' to '{value}'")
+        
+        
+    def info(self, attr: str | None = None):
+        """
+        -info
+        -----
+        Gets infomation about callable functions.
+        
+        'qplot-cfg -info' lists all callable functions
+        'qplot-cfg -info <attr>' produces the docstring of the function
+            Note: the '-' before <attr> can be ommited
+
+        Parameters
+        ----------
+        attr : callable, optional
+            Produces the docstring of command attr. If none are given, prints 
+            all commands
+
+        Raises
+        ------
+        KeyError
+            Invalid command was given.
+            
+        """
+        if not attr:
+            print(f"Valid Commands:\n\t{self.valid_args}\nUse 'qplot-cfg -info <command>' for more info")
+            return
+        elif attr in self.valid_args:
+            func = getattr(self, attr[1:])
+        elif ("-"+attr) in self.valid_args: 
+            func = getattr(self, attr)
+        else:
+            raise KeyError(f"Command: ({attr}), not found. Valid options: {self.valid_args}, '-' may be ommited")
+        
+        print(func.__doc__)
+
+
+    def version(self):
+        """
+        -version
+        --------
+        Prints the installed qPlot package version.
+
+        """
+        print(package_version())
+
+
+def try_as_num(item):
+    """
+    Attempts to convert str to float or int.
+
+    Parameters
+    ----------
+    item : str
+        item to be converted.
+
+    Returns
+    -------
+    item : int, float, str
+        The item after conversions.
+
+    """
+    try:
+        item = item.strip()
+        if "." in item or "e" in item.lower():
+            item = float(item)
+        else:
+            item = int(item)
+    except ValueError: #if cannot conver to int or float
+        item = str(item)
+    return item
+
+
+def _config_value(value, schema):
+    """Parse a command-line value according to its target config schema."""
+
+    value_type = schema.get("type")
+    stripped = value.strip()
+
+    if value_type == "string":
+        return value
+    if value_type == "boolean":
+        if stripped.lower() == "true":
+            return True
+        if stripped.lower() == "false":
+            return False
+        raise ValueError("expected true or false")
+    if value_type == "integer":
+        return int(stripped, 10)
+    if value_type == "number":
+        return float(stripped)
+    if value_type == "array":
+        if not (
+                (stripped.startswith("[") and stripped.endswith("]"))
+                or (stripped.startswith("(") and stripped.endswith(")"))
+                ):
+            raise ValueError("expected a bracketed list")
+        json_list = f"[{stripped[1:-1]}]"
+        try:
+            return json.loads(json_list)
+        except json.JSONDecodeError:
+            inner = stripped[1:-1].strip()
+            if not inner:
+                return []
+            item_schema = schema.get("items", {})
+            return [
+                _config_value(item.strip(), item_schema)
+                for item in inner.split(",")
+                ]
+
+    return try_as_num(value)
+
+
+def scripts():
+    """
+    The actual entry point which call sysHandle to manage commands
+
+    """
+    # Fetch str based command from command line
+    args=sys.argv
+    if len(args) == 1:
+        sysHandle("-info")
+    else:
+        sysHandle(*args[1:])

qplot/configuration/themes/__init__.py

@@ -0,0 +1,13 @@
+"""
+Files within here contain code in CSS to format the stylesheet of the windows.
+"""
+
+from .blank import blank as pyqt
+from .dark import dark
+from .light import light
+
+__all__=[
+    "light",
+    "dark",
+    "pyqt",
+    ]