electricalsim 0.0.8.22.dev0__tar.gz → 0.0.8.22.dev1__tar.gz

{electricalsim-0.0.8.22.dev0 → electricalsim-0.0.8.22.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: electricalsim
-Version: 0.0.8.22.dev0
+Version: 0.0.8.22.dev1
 Summary: Graphical user interface for simulating electrical networks based on the pandapower library
 Project-URL: Homepage, https://github.com/aloytag/electrical-grid-simulator
 Project-URL: Bug Tracker, https://github.com/aloytag/electrical-grid-simulator/issues
@@ -24,7 +24,6 @@ Requires-Dist: platformdirs>=3.0.0
 Requires-Dist: pyarrow<19.0.0,>=15.0.0
 Requires-Dist: pynput>=1.7.6
 Requires-Dist: pyqt-toast-notification>=1.3.2
-Requires-Dist: pyqtdarktheme>=2.1.0
 Requires-Dist: pyshortcuts>=1.8.3
 Requires-Dist: pyside6>=6.6.1
 Requires-Dist: qtawesome>=1.3.1

{electricalsim-0.0.8.22.dev0 → electricalsim-0.0.8.22.dev1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "electricalsim"
-version = "0.0.8.22dev0"
+version = "0.0.8.22dev1"
 author = "Dr. Ing. Ariel S. Loyarte"
 authors = [
   { name="Dr. Ing. Ariel S. Loyarte", email="aloyarte@frsf.utn.edu.ar" },
@@ -16,7 +16,6 @@ dependencies = [
   "PySide6>=6.6.1",
   "pandapower>=3.1.2",
   "numba>=0.56.4",
-  "pyqtdarktheme>=2.1.0",
   "qtawesome>=1.3.1",
   "pynput>=1.7.6",
   "lightsim2grid>=0.7.1",

{electricalsim-0.0.8.22.dev0 → electricalsim-0.0.8.22.dev1}/src/electricalsim/Electrical_Grid_Simulator.py

@@ -7,7 +7,7 @@ import importlib
 
 from PySide6.QtUiTools import QUiLoader
 from PySide6 import QtWidgets, QtGui, QtCore
-import qdarktheme  # Always import after Qt
+import qdarktheme2  # Always import after Qt
 import qtawesome as qta
 
 from lib.electricalGraph import ElectricalGraph
@@ -24,6 +24,8 @@ if sys.version_info < (3, 10):
 else:
     from importlib.metadata import entry_points
 
+APP_ID = 'ar.utnfrsf.egs'
+
 
 def main():
     """
@@ -35,11 +37,11 @@ def main():
     # Reading the config file:
     config, config_file_path = return_config(directory)
     
-    # qdarktheme.enable_hi_dpi()
+    # qdarktheme2.enable_hi_dpi()
     # app = QtWidgets.QApplication(sys.argv)
     # theme = config['general']['theme']
     # if theme in ('dark', 'light', 'auto'):
-    #     qdarktheme.setup_theme(theme)
+    #     qdarktheme2.setup_theme(theme)
     
     ui_file = os.path.join(directory, 'ui', 'main_window.ui')
     ui_file_ = QtCore.QFile(ui_file)
@@ -48,8 +50,9 @@ def main():
     # main_window = loader.load(ui_file_)
     # window = QMainWindow2(main_window)
 
-    qdarktheme.enable_hi_dpi()
+    qdarktheme2.enable_hi_dpi()
     app = QtWidgets.QApplication(sys.argv)
+    app.setDesktopFileName(APP_ID)
 
     # Better font for flatpak app:
     directory_split = directory.split(sep='/')
@@ -78,7 +81,7 @@ def main():
 
     theme = config['general']['theme']
     if theme in ('dark', 'light', 'auto'):
-        qdarktheme.setup_theme(theme, additional_qss="QToolTip { border: 0px; }")
+        qdarktheme2.setup_theme(theme, additional_qss="QToolTip { border: 0px; }")
 
     main_window = loader.load(ui_file_)
     window = QMainWindow2(main_window)

electricalsim-0.0.8.22.dev1/src/electricalsim/egs_create_shortcut.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*
+
+import os
+import sys
+
+from pyshortcuts import make_shortcut
+import electricalsim
+
+
+def create_shortcut():
+    """
+    Creates a shortcut for the Electrical Grid Simulator
+    on the desktop and startmanu.
+    """
+    root_path, _ = os.path.split(electricalsim.__file__)
+    executable_path = os.path.join(root_path, 'egs_run.py')
+    name = 'EGS'
+    if sys.platform.startswith('win'):
+        icon_path = os.path.join(root_path, 'icons', 'app_icon.ico')
+    else:
+        icon_path = os.path.join(root_path, 'icons', 'app_icon.png')
+
+    sct = make_shortcut(executable_path, name=name,
+                        description='Electrical Grid Simulator',
+                        terminal=False, icon=icon_path,
+                        desktop=True, startmenu=True)
+    
+    # In case of Wayland session:
+    session_type = os.environ.get("XDG_SESSION_TYPE")
+    if session_type and session_type.lower() == "wayland":
+        python_root, _ = sct.full_script.split(sep='lib')
+        python_executable = os.path.join(python_root, 'bin', 'python')
+        script = python_executable + ' ' + sct.full_script
+
+        content_desktop = f"""[Desktop Entry]
+Name=EGS
+Type=Application
+Path={sct.working_dir}
+Comment=Electrical Grid Simulator
+Terminal=false
+StartupNotify=false
+StartupWMClass=ar.utnfrsf.egs
+Icon={sct.icon}
+Exec={script}"""
+        
+        os.remove(os.path.join(sct.startmenu_dir, 'EGS.desktop'))
+        desktop_file_path = os.path.join(sct.startmenu_dir, 'ar.utnfrsf.egs.desktop')
+        with open(desktop_file_path, 'w') as file:
+            file.write(content_desktop)
+
+if __name__=='__main__':
+    create_shortcut()

{electricalsim-0.0.8.22.dev0 → electricalsim-0.0.8.22.dev1}/src/electricalsim/lib/auxiliary.py

@@ -46,7 +46,7 @@ def natsort(s):
 
     s: List with strings.
     """
-    return [int(t) if t.isdigit() else t.lower() for t in re.split('(\d+)', s)]
+    return [int(t) if t.isdigit() else t.lower() for t in re.split('(\\d+)', s)]
 
 
 def natsort2(s):
@@ -55,7 +55,7 @@ def natsort2(s):
 
     s: List obtained as enumerate(list with strings).
     """
-    return [int(t) if t.isdigit() else t.lower() for t in re.split('(\d+)', s[1])]
+    return [int(t) if t.isdigit() else t.lower() for t in re.split('(\\d+)', s[1])]
 
 
 def show_WIP(window_parent):

electricalsim-0.0.8.22.dev1/src/electricalsim/qdarktheme2/__init__.py

@@ -0,0 +1,46 @@
+"""PyQtDarkTheme - A flat dark theme for PySide and PyQt.
+
+- Repository: https://github.com/5yutan5/PyQtDarkTheme
+- Documentation: https://pyqtdarktheme.readthedocs.io
+
+
+License Information
+===================
+
+Material design icons
+---------------------
+
+All svg files in PyQtDarkTheme is from Material design icons(which uses an Apache 2.0 license).
+
+- Author: Google
+- Site: https://fonts.google.com/icons
+- Source: https://github.com/google/material-design-icons
+- License: Apache License Version 2.0 | https://www.apache.org/licenses/LICENSE-2.0.txt
+
+Modifications made to each files to change the icon color and angle and remove svg namespace.
+
+The current Material design icons license summary can be viewed at:
+https://github.com/google/material-design-icons/blob/master/LICENSE
+
+
+QDarkStyleSheet(Source code)
+----------------------------
+
+Qt stylesheets are originally fork of QDarkStyleSheet(MIT License).
+
+- Author: Colin Duquesnoy
+- Site: https://github.com/ColinDuquesnoy/QDarkStyleSheet
+- Source: https://github.com/ColinDuquesnoy/QDarkStyleSheet
+- License: MIT License | https://opensource.org/licenses/MIT
+
+Modifications made to a file to change the style.
+
+The current QDarkStyleSheet license summary can be viewed at:
+https://github.com/ColinDuquesnoy/QDarkStyleSheet/blob/master/LICENSE.rst
+
+"""
+# Version of PyQtDarkTheme
+__version__ = "2.1.0"
+
+from qdarktheme2._main import enable_hi_dpi, setup_theme, stop_sync
+from qdarktheme2._style_loader import clear_cache, get_themes, load_palette, load_stylesheet

electricalsim-0.0.8.22.dev1/src/electricalsim/qdarktheme2/_color.py

@@ -0,0 +1,231 @@
+"""Module for color code."""
+from __future__ import annotations
+
+import colorsys
+import math
+
+
+def _round_float(number: float, decimal_points: int = 3) -> float:
+    decimal = 10**decimal_points
+    return round(number * decimal) / decimal
+
+
+class _RGBA:
+    """Class handling RGBA color code."""
+
+    def __init__(self, r: int, g: int, b: int, a: float = 1) -> None:
+        """Initialize rgba value.
+
+        Args:
+            r: Red(0~255).
+            g: Green(0~255).
+            b: Blue(0~255).
+            a: Alpha(0~1). Defaults to 1.
+        """
+        self._r = min(255, max(0, r)) | 0
+        self._g = min(255, max(0, g)) | 0
+        self._b = min(255, max(0, b)) | 0
+        self._a = _round_float(max(min(1, a), 0))
+
+    def __str__(self) -> str:
+        """Format RGBA class.
+
+        e.g. rgba(100, 100, 100, 0.5).
+        """
+        return f"rgba({self.r}, {self.g}, {self.b}, {self.a:.3f})"
+
+    def __getitem__(self, item: int) -> int | float:
+        """Unpack to (r, g, b, a)."""
+        return [self.r, self.g, self.b, self.a][item]
+
+    def __eq__(self, other: _RGBA) -> bool:
+        """Returns true if `r`, `g`, `b` and `a` are all the same."""
+        return [self.r, self.g, self.b, self.a] == [other.r, other.g, other.b, other.a]
+
+    @property
+    def r(self) -> int:
+        return self._r
+
+    @property
+    def g(self) -> int:
+        return self._g
+
+    @property
+    def b(self) -> int:
+        return self._b
+
+    @property
+    def a(self) -> float:
+        return self._a
+
+
+class _HSLA:
+    def __init__(self, h: int, s: float, l: float, a: float = 1) -> None:  # noqa: E741
+        self._h = max(min(360, h), 0) | 0
+        self._s = _round_float(max(min(1, s), 0))
+        self._l = _round_float(max(min(1, l), 0))
+        self._a = _round_float(max(min(1, a), 0))
+
+    def __eq__(self, other: _HSLA) -> bool:
+        """Returns true if `h`, `s`, `l` and `a` are all the same."""
+        return [self.h, self.s, self.l, self.a] == [other.h, other.s, other.l, other.a]
+
+    @property
+    def h(self) -> int:
+        return self._h
+
+    @property
+    def s(self) -> float:
+        return self._s
+
+    @property
+    def l(self) -> float:  # noqa: E741, E743
+        return self._l
+
+    @property
+    def a(self) -> float:
+        return self._a
+
+    @staticmethod
+    def from_rgba(rgba: _RGBA) -> _HSLA:
+        hls = colorsys.rgb_to_hls(rgba.r / 255, rgba.g / 255, rgba.b / 255)
+        return _HSLA(int(hls[0] * 360), hls[2], hls[1], rgba.a)
+
+    def to_rgba(self) -> _RGBA:
+        rgb = colorsys.hls_to_rgb(self.h / 360, self.l, self.s)
+        return _RGBA(round(rgb[0] * 255), round(rgb[1] * 255), round(rgb[2] * 255), self.a)
+
+
+class Color:
+    """Class handling color code(RGBA and HSLA)."""
+
+    def __init__(self, color_code: _RGBA | _HSLA) -> None:
+        """Initialize color code."""
+        self._hsla, self._hsva = None, None
+        if isinstance(color_code, _RGBA):
+            self._rgba = color_code
+        elif isinstance(color_code, _HSLA):
+            self._hsla = color_code
+            self._rgba = self._hsla.to_rgba()
+
+    @property
+    def rgba(self) -> _RGBA:
+        """Return rgba."""
+        return self._rgba
+
+    @property
+    def hsla(self) -> _HSLA:
+        """Return hsla."""
+        return self._hsla if self._hsla else _HSLA.from_rgba(self.rgba)
+
+    def __str__(self) -> str:
+        """Format Color class.
+
+        e.g. rgba(100, 100, 100, 0.5).
+        """
+        return str(self.rgba)
+
+    @staticmethod
+    def _check_hex_format(hex_format: str) -> None:
+        """Check if string is hex format."""
+        try:
+            hex = hex_format.lstrip("#")
+            if not len(hex) in (3, 4, 6, 8):
+                raise ValueError
+            int(hex, 16)
+        except ValueError:
+            raise ValueError(
+                f'invalid hex color format: "{hex_format}". '
+                "Only support following hexadecimal notations: #RGB, #RGBA, #RRGGBB and #RRGGBBAA. "
+                "R (red), G (green), B (blue), and A (alpha) are hexadecimal characters "
+                "(0-9, a-f or A-F)."
+            ) from None
+
+    @staticmethod
+    def from_rgba(r: int, g: int, b: int, a: int) -> Color:
+        """Convert rgba to Color object."""
+        rgba = _RGBA(r, g, b, a / 255)
+        return Color(rgba)
+
+    @staticmethod
+    def from_hex(hex: str) -> Color:
+        """Convert hex string to Color object.
+
+        Args:
+            color_hex: Color hex string.
+
+        Returns:
+            Color: Color object converted from hex.
+        """
+        Color._check_hex_format(hex)
+        hex = hex.lstrip("#")
+        r, g, b, a = 255, 0, 0, 1
+        if len(hex) == 3:  # #RGB format
+            r, g, b = (int(char, 16) for char in hex)
+            r, g, b = 16 * r + r, 16 * g + g, 16 * b + b
+        if len(hex) == 4:  # #RGBA format
+            r, g, b, a = (int(char, 16) for char in hex)
+            r, g, b = 16 * r + r, 16 * g + g, 16 * b + b
+            a = (16 * a + a) / 255
+        if len(hex) == 6:  # #RRGGBB format
+            r, g, b = bytes.fromhex(hex)
+            a = 1
+        elif len(hex) == 8:  # #RRGGBBAA format
+            r, g, b, a = bytes.fromhex(hex)
+            a = a / 255
+        return Color(_RGBA(r, g, b, a))
+
+    def _to_hex(self) -> str:
+        """Convert Color object to hex(#RRGGBBAA).
+
+        Args:
+            color: Color object.
+
+        Returns:
+            str: Hex converted from Color object.
+        """
+        r, g, b, a = self.rgba.r, self.rgba.g, self.rgba.b, self.rgba.a
+        hex_color = f"{math.floor(r):02x}{math.floor(g):02x}{math.floor(b):02x}"
+        if a != 1:
+            hex_color += f"{math.floor(a*255):02x}"
+        return hex_color
+
+    def to_hex_argb(self) -> str:
+        """Convert Color object to hex(#AARRGGBB).
+
+        Args:
+            color: Color object.
+
+        Returns:
+            str: Hex converted from Color object.
+        """
+        r, g, b, a = self.rgba.r, self.rgba.g, self.rgba.b, self.rgba.a
+        hex_color = "" if a == 1 else f"{math.floor(a*255):02x}"
+        hex_color += f"{math.floor(r):02x}{math.floor(g):02x}{math.floor(b):02x}"
+        return hex_color
+
+    def to_svg_tiny_color_format(self) -> str:
+        """Convert Color object to string for svg.
+
+        QtSvg does not support #RRGGBBAA format.
+        Therefore, we need to set the alpha value to `fill-opacity` instead.
+
+        Returns:
+            str: RGBA format.
+        """
+        r, g, b, a = self.rgba
+        if a == 1:
+            return f'fill="#{self._to_hex()}"'
+        return f'fill="rgb({r},{g},{b})" fill-opacity="{a}"'
+
+    def lighten(self, factor: float) -> Color:
+        """Lighten color."""
+        return Color(_HSLA(self.hsla.h, self.hsla.s, self.hsla.l + self.hsla.l * factor, self.hsla.a))
+
+    def darken(self, factor: float) -> Color:
+        """Darken color."""
+        return Color(_HSLA(self.hsla.h, self.hsla.s, self.hsla.l - self.hsla.l * factor, self.hsla.a))
+
+    def transparent(self, factor: float) -> Color:
+        """Make color transparent."""
+        return Color(_RGBA(self.rgba.r, self.rgba.g, self.rgba.b, self.rgba.a * factor))

electricalsim-0.0.8.22.dev1/src/electricalsim/qdarktheme2/_icon/icon_engine.py

@@ -0,0 +1,56 @@
+from qdarktheme2._color import Color
+from qdarktheme2._icon.svg import Svg
+from qdarktheme2.qtpy.QtCore import QPoint, QRect, QRectF, QSize, Qt
+from qdarktheme2.qtpy.QtGui import (
+    QGuiApplication,
+    QIcon,
+    QIconEngine,
+    QImage,
+    QPainter,
+    QPalette,
+    QPixmap,
+)
+from qdarktheme2.qtpy.QtSvg import QSvgRenderer
+
+
+class SvgIconEngine(QIconEngine):
+    """A custom QIconEngine that can render an SVG buffer."""
+
+    def __init__(self, svg: Svg) -> None:
+        """Initialize icon engine."""
+        super().__init__()
+        self._svg = svg
+
+    def paint(self, painter: QPainter, rect: QRect, mode: QIcon.Mode, state):
+        """Paint the icon int ``rect`` using ``painter``."""
+        palette = QGuiApplication.palette()
+
+        if mode == QIcon.Mode.Disabled:
+            rgba = palette.color(QPalette.ColorGroup.Disabled, QPalette.ColorRole.Text).getRgb()
+            color = Color.from_rgba(*rgba)
+        else:
+            rgba = palette.text().color().getRgb()
+            color = Color.from_rgba(*rgba)
+        self._svg.colored(color)
+
+        svg_byte = str(self._svg).encode("utf-8")
+        renderer = QSvgRenderer(svg_byte)  # type: ignore
+        renderer.render(painter, QRectF(rect))
+
+    def clone(self):
+        """Required to subclass abstract QIconEngine."""
+        return SvgIconEngine(self._svg)
+
+    def pixmap(self, size: QSize, mode: QIcon.Mode, state: QIcon.State):
+        """Return the icon as a pixmap with requested size, mode, and state."""
+        # Make size to square.
+        min_size = min(size.width(), size.height())
+        size.setHeight(min_size)
+        size.setWidth(min_size)
+
+        img = QImage(size, QImage.Format.Format_ARGB32)
+        img.fill(Qt.GlobalColor.transparent)
+        pixmap = QPixmap.fromImage(img, Qt.ImageConversionFlag.NoFormatConversion)
+        size.width()
+        self.paint(QPainter(pixmap), QRect(QPoint(0, 0), size), mode, state)
+        return pixmap

electricalsim-0.0.8.22.dev1/src/electricalsim/qdarktheme2/_icon/svg.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+import json
+import re
+from functools import lru_cache
+
+from qdarktheme2 import _resources
+from qdarktheme2._color import Color
+
+
+@lru_cache()
+def _svg_resources() -> dict[str, str]:
+    return json.loads(_resources.svg.SVG_RESOURCES)
+
+
+class Svg:
+    """Class to manage SVG."""
+
+    _SVG_FILL_RE = re.compile(r'fill=".*?"')
+    _SVG_FILL_OPACITY_RE = re.compile(r'fill-opacity=".*?"')
+    _SVG_TRANSFORM_RE = re.compile(r'transform=".*?"')
+
+    def __init__(self, id: str) -> None:
+        """Initialize svg manager."""
+        self._id = id
+        self._color = None
+        self._rotate = None
+        self._source = _svg_resources()[self._id]
+
+    def __str__(self) -> str:
+        """Return the svg source code."""
+        return self._source
+
+    def colored(self, color: Color) -> Svg:
+        """Add or change svg color."""
+        svg_tiny_color_formats = color.to_svg_tiny_color_format().split(" ")
+        if len(svg_tiny_color_formats) == 2:
+            new_svg_color, new_svg_opacity = svg_tiny_color_formats
+        else:
+            new_svg_color = svg_tiny_color_formats[0]
+            new_svg_opacity = None
+
+        current_svg_color = Svg._SVG_FILL_RE.search(self._source)
+        current_svg_opacity = Svg._SVG_FILL_OPACITY_RE.search(self._source)
+
+        # Add or change SVG color.
+        if current_svg_color is None:
+            self._source = self._source.replace("<svg ", f"<svg {new_svg_color} ")
+        else:
+            self._source = self._source.replace(current_svg_color.group(), new_svg_color)
+
+        # Add or change SVG opacity.
+        if new_svg_opacity is not None and current_svg_opacity is None:
+            self._source = self._source.replace("<svg ", f"<svg {new_svg_opacity} ")
+        elif new_svg_opacity is not None and current_svg_opacity is not None:
+            self._source = self._source.replace(current_svg_opacity.group(), new_svg_opacity)
+
+        # Remove SVG opacity
+        if new_svg_opacity is None and current_svg_opacity is not None:
+            self._source = self._source.replace(" " + current_svg_opacity.group(), "")
+        return self
+
+    def rotate(self, rotate: int) -> Svg:
+        """Rotate svg."""
+        if rotate == 0:
+            return self
+
+        current_svg_transform = Svg._SVG_TRANSFORM_RE.search(self._source)
+        new_svg_transform = f'transform="rotate({rotate}, 12, 12)"'
+        if current_svg_transform is None:
+            self._source = self._source.replace("<svg ", f"<svg {new_svg_transform} ")
+        else:
+            self._source = self._source.replace(current_svg_transform.group(), new_svg_transform)
+
+        return self