bec-qthemes 0.0.2__tar.gz

bec_qthemes-0.0.2/.gitignore

@@ -0,0 +1,177 @@
+**/*_venv
+**/.idea
+*.log
+**/__pycache__
+**/.DS_Store
+**/out
+**/.vscode
+**/.pytest_cache
+**/*.egg*
+
+# file writer data
+**.h5
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/**/_build/
+docs/**/autodoc/
+docs/**/_autosummary/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+**.prof
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

bec_qthemes-0.0.2/.gitlab-ci.yml

@@ -0,0 +1,118 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/python/tags/
+image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:3.11
+#commands to run in the Docker container before starting each job.
+variables:
+  DOCKER_TLS_CERTDIR: ""
+  BEC_CORE_BRANCH: "main"
+  OPHYD_DEVICES_BRANCH: "main"
+  CHILD_PIPELINE_BRANCH: $CI_DEFAULT_BRANCH
+
+workflow:
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "schedule"
+    - if: $CI_PIPELINE_SOURCE == "web"
+    - if: $CI_PIPELINE_SOURCE == "pipeline"
+    - if: $CI_PIPELINE_SOURCE == "parent_pipeline"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS
+      when: never
+    - if: $CI_COMMIT_BRANCH
+
+include:
+  - template: Security/Secret-Detection.gitlab-ci.yml
+  - project: "bec/awi_utils"
+    file: "/templates/check-packages-job.yml"
+    inputs:
+      stage: test
+      path: "."
+      pytest_args: "-v --random-order tests/"
+      exclude_packages: ""
+
+# different stages in the pipeline
+stages:
+  - Formatter
+  - test
+  - AdditionalTests
+  - End2End
+  - Deploy
+
+.clone-repos: &clone-repos
+  - git clone --branch $BEC_CORE_BRANCH https://gitlab.psi.ch/bec/bec.git
+  - git clone --branch $OPHYD_DEVICES_BRANCH https://gitlab.psi.ch/bec/ophyd_devices.git
+  - export OHPYD_DEVICES_PATH=$PWD/ophyd_devices
+
+.install-os-packages: &install-os-packages
+  - apt-get update
+  - apt-get install -y libgl1-mesa-glx libegl1-mesa x11-utils libxkbcommon-x11-0 libdbus-1-3
+
+before_script:
+  - if [[ "$CI_PROJECT_PATH" != "bec/bec_qthemes" ]]; then
+    echo -e "\033[35;1m Using branch $CHILD_PIPELINE_BRANCH of BEC QThemes \033[0;m";
+    test -d bec_qthemes || git clone --branch $CHILD_PIPELINE_BRANCH https://gitlab.psi.ch/bec/bec_qthemes.git; cd bec_qthemes;
+    fi
+
+formatter:
+  stage: Formatter
+  needs: []
+  script:
+    - pip install black isort
+    - isort --check --diff ./
+    - black --check --diff --color ./
+  rules:
+    - if: $CI_PROJECT_PATH == "bec/bec_qthemes"
+
+tests:
+  parallel:
+    matrix:
+      - PYTHON_VERSION:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+        QT_PCKG:
+          - "pyside6"
+          - "pyqt6"
+
+  stage: test
+  needs: []
+  variables:
+    QT_QPA_PLATFORM: "offscreen"
+    PYTHON_VERSION: ""
+    QT_PCKG: ""
+  image: $CI_DEPENDENCY_PROXY_GROUP_IMAGE_PREFIX/python:$PYTHON_VERSION
+  script:
+    - *clone-repos
+    - *install-os-packages
+    - pip install $QT_PCKG
+    - pip install -e .[dev]
+    - pytest -v --junitxml=report.xml --random-order ./tests
+  allow_failure: false
+
+semver:
+  stage: Deploy
+  needs: ["tests"]
+  script:
+    - git config --global user.name "ci_update_bot"
+    - git config --global user.email "ci_update_bot@bec.ch"
+    - git checkout "$CI_COMMIT_REF_NAME"
+    - git reset --hard origin/"$CI_COMMIT_REF_NAME"
+
+    # delete all local tags
+    - git tag -l | xargs git tag -d
+    - git fetch --tags
+    - git tag
+
+    # build and publish package
+    - pip install python-semantic-release==9.* wheel build twine
+    - export GL_TOKEN=$CI_UPDATES
+    - semantic-release -vv version
+
+    # check if any artifacts were created
+    - if [ ! -d dist ]; then echo No release will be made; exit 0; fi
+    - twine upload dist/* -u __token__ -p $CI_PYPI_TOKEN --skip-existing
+    - semantic-release publish
+
+  allow_failure: false
+  rules:
+    - if: '$CI_COMMIT_REF_NAME == "main" && $CI_PROJECT_PATH == "bec/bec_qthemes"'

bec_qthemes-0.0.2/CHANGELOG.md

@@ -0,0 +1,35 @@
+# CHANGELOG
+
+## v0.0.2 (2024-07-22)
+
+### Fix
+
+* fix: removed webengine deps ([`2b887ff`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/2b887ffabc6932ffc3b8518ba065223f828c2f88))
+
+## v0.0.1 (2024-07-22)
+
+### Ci
+
+* ci: fixed install of qt deps ([`ae1eae3`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/ae1eae360cf23e95d81e91fb54b73ca659291d33))
+
+* ci: fixed test job name ([`c1f83d2`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/c1f83d242e585e6be1aef7fdaf660fd3bb2fc38e))
+
+* ci: fixed test stage and removed outdated jobs ([`a33e36d`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/a33e36d660501a4ac785762839872f19d44bd756))
+
+### Fix
+
+* fix: fixed darkdetect dependency ([`93d3561`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/93d35616b6fc4198edc9c5de57e8c7272ecac454))
+
+### Unknown
+
+* wip ([`e26f9a7`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/e26f9a7018d081eda25e0ca874afd2747a420ae7))
+
+* Delete .python-version ([`f8b160a`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/f8b160a5a19ec28360d16980eb2c17d6c219a95a))
+
+* wip ([`ca3f5ab`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/ca3f5abe631739357f91b0040a970a5781347956))
+
+* wip ([`3683415`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/3683415238f9d928eacc11713c2658f642cf5ba9))
+
+* init ([`c654127`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/c6541276953684d529bc97f91362f0b4c3a20481))
+
+* Initial commit ([`9184bdd`](https://gitlab.psi.ch/bec/bec_qthemes/-/commit/9184bdde0f76e0a8af7806e266ea4643414f22f2))

bec_qthemes-0.0.2/LICENSE.txt

@@ -0,0 +1,24 @@
+The project is based on the PyQtDarktheme project with its original license:
+
+MIT License
+
+Copyright (c) 2021-2022 Yunosuke Ohsugi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

bec_qthemes-0.0.2/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.3
+Name: bec_qthemes
+Version: 0.0.2
+Summary: BEC Qt themes
+Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_qthemes/issues
+Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_qthemes
+Project-URL: changelog, https://gitlab.psi.ch/bec/bec_qthemes/blob/main/CHANGELOG.md
+License-File: LICENSE.txt
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.10
+Requires-Dist: darkdetect~=0.8
+Requires-Dist: qtpy~=2.4
+Provides-Extra: dev
+Requires-Dist: black~=24.0; extra == 'dev'
+Requires-Dist: coverage~=7.0; extra == 'dev'
+Requires-Dist: isort>=5.13.2,~=5.13; extra == 'dev'
+Requires-Dist: pylint~=3.0; extra == 'dev'
+Requires-Dist: pytest-qt~=4.4; extra == 'dev'
+Requires-Dist: pytest-random-order~=1.1; extra == 'dev'

bec_qthemes-0.0.2/README.md

@@ -0,0 +1,3 @@
+# BEC QThemes
+
+This project is based on the [PyQtDarktheme](https://github.com/5yutan5/PyQtDarkTheme) project. 

bec_qthemes-0.0.2/bec_qthemes/__init__.py

@@ -0,0 +1,47 @@
+"""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 bec_qthemes._main import enable_hi_dpi, setup_theme, stop_sync
+from bec_qthemes._style_loader import clear_cache, get_themes, load_palette, load_stylesheet

bec_qthemes-0.0.2/bec_qthemes/_color.py

@@ -0,0 +1,236 @@
+"""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))