boris-behav-obs 8.27.9__py2.py3-none-any.whl → 9.0.1__py2.py3-none-any.whl

boris/qdarkstyle/utils/images.py

@@ -1,449 +0,0 @@
-# -*- coding: utf-8 -*-
-"""
-Utilities to process and convert svg images to png using palette colors.
-"""
-
-# Standard library imports
-import logging
-import os
-import re
-import sys
-import tempfile
-import subprocess
-
-# Third party imports
-from qtpy.QtCore import QSize
-from qtpy.QtGui import QIcon
-from qtpy.QtWidgets import QApplication
-
-# Local imports
-from qdarkstyle import (IMAGES_PATH, PACKAGE_PATH, QRC_FILE_SUFFIX, QSS_FILE_SUFFIX, QSS_PATH,
-                        STYLES_SCSS_FILE, SVG_PATH)
-
-
-IMAGE_BLACKLIST = ['base_palette']
-
-TEMPLATE_QRC_HEADER = '''
-<RCC warning="WARNING! File created programmatically. All changes made in this file will be lost!">
-  <qresource prefix="{resource_prefix}">
-'''
-
-TEMPLATE_QRC_FILE = '    <file>rc/{fname}</file>'
-
-TEMPLATE_QRC_FOOTER = '''
-  </qresource>
-  <qresource prefix="{style_prefix}">
-      <file>{qss_file}</file>
-  </qresource>
-</RCC>
-'''
-
-_logger = logging.getLogger(__name__)
-
-
-def _get_file_color_map(fname, palette):
-    """
-    Return map of files (i.e states) to color from given palette.
-    """
-    color_disabled = palette.COLOR_BACKGROUND_4
-    color_focus = palette.COLOR_ACCENT_5
-    color_pressed = palette.COLOR_ACCENT_2
-    color_normal = palette.COLOR_TEXT_1
-
-    name, ext = fname.split('.')
-    file_colors = {
-        fname: color_normal,
-        name + '_disabled.' + ext: color_disabled,
-        name + '_focus.' + ext: color_focus,
-        name + '_pressed.' + ext: color_pressed,
-    }
-
-    return file_colors
-
-
-def _create_colored_svg(svg_path, temp_svg_path, color):
-    """
-    Replace base svg with fill color.
-    """
-    with open(svg_path, 'r') as fh:
-        data = fh.read()
-
-    base_color = '#ff0000'  # Hardcoded in base svg files
-    new_data = data.replace(base_color, color)
-
-    with open(temp_svg_path, 'w') as fh:
-        fh.write(new_data)
-
-
-def convert_svg_to_png(svg_path, png_path, height, width):
-    """
-    Convert svg files to png files using Qt.
-    """
-    size = QSize(height, width)
-    icon = QIcon(svg_path)
-    pixmap = icon.pixmap(size)
-    img = pixmap.toImage()
-    dirname = os.path.dirname(png_path)
-
-    if not os.path.exists(dirname):
-        os.makedirs(dirname)
-
-    img.save(os.path.abspath(png_path))
-
-
-def create_palette_image(base_svg_path=SVG_PATH, path=IMAGES_PATH,
-                         palette=None):
-    """
-    Create palette image svg and png image on specified path.
-    """
-    # Needed to use QPixmap
-    _ = QApplication([])
-
-    if palette is None:
-        _logger.error("Please pass a palette class in order to create its "
-                      "associated images")
-        sys.exit(1)
-
-    if palette.ID is None:
-        _logger.error("A QDarkStyle palette requires an ID!")
-        sys.exit(1)
-
-    base_palette_svg_path = os.path.join(base_svg_path, 'base_palette.svg')
-    palette_svg_path = os.path.join(path, palette.ID, 'palette.svg')
-    palette_png_path = os.path.join(path, palette.ID, 'palette.png')
-
-    _logger.info("Creating palette image ...")
-    _logger.info(f"Base SVG: {base_palette_svg_path}")
-    _logger.info(f"To SVG: {palette_svg_path}")
-    _logger.info(f"To PNG: {palette_png_path}")
-
-    with open(base_palette_svg_path, 'r') as fh:
-        data = fh.read()
-
-    color_palette = palette.color_palette()
-
-    for color_name, color_value in color_palette.items():
-        data = data.replace('{{ ' + color_name + ' }}', color_value.lower())
-
-    with open(palette_svg_path, 'w+') as fh:
-        fh.write(data)
-
-    convert_svg_to_png(palette_svg_path, palette_png_path, 4000, 4000)
-
-    return palette_svg_path, palette_png_path
-
-
-def create_images(base_svg_path=SVG_PATH, rc_path=None, palette=None):
-    """Create resources `rc` png image files from base svg files and palette.
-
-    Search all SVG files in `base_svg_path` excluding IMAGE_BLACKLIST,
-    change its colors using `palette` creating temporary SVG files, for each
-    state generating PNG images for each size `heights`.
-
-    Args:
-        base_svg_path (str, optional): [description]. Defaults to SVG_PATH.
-        rc_path (str, optional): [description].
-        palette (Palette, optional): Palette.
-    """
-
-    # Needed to use QPixmap
-    _ = QApplication([])
-
-    if palette is None:
-        _logger.error("Please pass a palette class in order to create its "
-                      "associated file")
-        sys.exit(1)
-
-    if palette.ID is None:
-        _logger.error("A QDarkStyle palette requires an ID!")
-        sys.exit(1)
-
-    if not rc_path:
-        rc_path = os.path.join(PACKAGE_PATH, palette.ID, 'rc')
-
-    temp_dir = tempfile.mkdtemp()
-    svg_fnames = [f for f in os.listdir(base_svg_path) if f.endswith('.svg')]
-    base_height = 32
-
-    # See: https://doc.qt.io/qt-5/scalability.html
-    heights = {
-        32: '.png',
-        64: '@2x.png',
-    }
-
-    _logger.info("Creating images ...")
-    _logger.info(f"SVG folder: {base_svg_path}")
-    _logger.info(f"TMP folder: {temp_dir}")
-    _logger.info(f"PNG folder: {rc_path}")
-
-    num_svg = len(svg_fnames)
-    num_png = 0
-    num_ignored = 0
-    num_ignored_list = []
-
-    # Get rc links from scss to check matches
-    rc_list = get_rc_links_from_scss()
-    num_rc_list = len(rc_list)
-
-    for height, ext in heights.items():
-        width = height
-
-        _logger.debug(f" Size HxW (px): {height} X {width}")
-
-        for svg_fname in svg_fnames:
-            svg_name = svg_fname.split('.')[0]
-
-            # Skip blacklist
-            if svg_name not in IMAGE_BLACKLIST:
-                svg_path = os.path.join(base_svg_path, svg_fname)
-                color_files = _get_file_color_map(svg_fname, palette=palette)
-
-                _logger.log(logging.NOTSET, f"  Working on: {os.path.basename(svg_fname)}")
-
-                # Replace colors and create all file for different states
-                for color_svg_name, color in color_files.items():
-                    temp_svg_path = os.path.join(temp_dir, color_svg_name)
-                    _create_colored_svg(svg_path, temp_svg_path, color)
-
-                    png_fname = color_svg_name.replace('.svg', ext)
-                    png_path = os.path.join(rc_path, png_fname)
-                    convert_svg_to_png(temp_svg_path, png_path, height, width)
-                    num_png += 1
-                    _logger.log(logging.NOTSET, f"   Creating: {os.path.basename(png_fname)}")
-
-                    # Check if the rc_name is in the rc_list from scss
-                    # only for the base size
-                    if height == base_height:
-                        rc_base = os.path.basename(rc_path)
-                        png_base = os.path.basename(png_fname)
-                        rc_name = '/' + rc_base + '/' + png_base
-                        try:
-                            rc_list.remove(rc_name)
-                        except ValueError:
-                            pass
-            else:
-                num_ignored += 1
-                _logger.debug(f"  Ignored blacklist: {os.path.basename(svg_fname)}")
-                num_ignored_list.append(svg_fname)
-
-    _logger.info(f"# SVG files: {num_svg}")
-    _logger.info(f"# SVG ignored: {num_ignored}")
-    _logger.info(f"SVG ignored: {num_ignored_list}")
-    _logger.info(f"# PNG files: {num_png}")
-    _logger.info(f"# RC links: {num_rc_list}")
-    _logger.info(f"# RC links in _style.scss not in RC: {len(rc_list)}")
-    _logger.info(f"RC links in _style.scss not in RC: {rc_list}")
-
-
-def generate_qrc_file(resource_prefix='qss_icons', style_prefix='qdarkstyle',
-                      palette=None):
-    """
-    Generate the QRC file programmatically.
-
-    Search all RC folder for PNG images and create a QRC file.
-
-    Args:
-        resource_prefix (str, optional): Prefix used in resources.
-            Defaults to 'qss_icons'.
-        style_prefix (str, optional): Prefix used to this style.
-            Defaults to 'qdarkstyle'.
-        palette (Palette, optional): Palette.
-    """
-
-    files = []
-
-    if palette is None:
-        _logger.error("Please pass a palette class in order to create its "
-                      "qrc file")
-        sys.exit(1)
-
-    if palette.ID is None:
-        _logger.error("A QDarkStyle palette requires an ID!")
-        sys.exit(1)
-
-    palette_path = os.path.join(PACKAGE_PATH, palette.ID)
-    rc_path = os.path.join(palette_path, 'rc')
-    qss_file = palette.ID + QSS_FILE_SUFFIX
-    qrc_file = palette.ID + QRC_FILE_SUFFIX
-    qrc_filepath = os.path.join(palette_path, qrc_file)
-    resource_prefix = resource_prefix + '/' + palette.ID
-    style_prefix = style_prefix + '/' + palette.ID
-
-    _logger.info("Generating QRC file ...")
-    _logger.info(f"Resource prefix: {resource_prefix}")
-    _logger.info(f"Style prefix: {style_prefix}")
-
-    _logger.info(f"Searching in: {rc_path}")
-
-    # Search by png images
-    for fname in sorted(os.listdir(rc_path)):
-        if os.path.splitext(fname)[1] == '.png':
-            files.append(TEMPLATE_QRC_FILE.format(fname=fname))
-
-    # Join parts
-    qrc_content = (TEMPLATE_QRC_HEADER.format(resource_prefix=resource_prefix)
-                   + '\n'.join(files)
-                   + TEMPLATE_QRC_FOOTER.format(style_prefix=style_prefix, qss_file=qss_file))
-
-    _logger.info(f"Writing in: {qrc_filepath}")
-
-    # Write qrc file
-    with open(qrc_filepath, 'w') as fh:
-        fh.write(qrc_content)
-
-
-def get_rc_links_from_scss(pattern=r"\/rc.*\.png"):
-    """
-    Get all rc links from scss file returning the list of unique links.
-
-    Args:
-        pattern (str): regex pattern to find the links.
-
-    Returns:
-        list(str): list of unique links found.
-    """
-
-    style_scss_filepath = os.path.join(QSS_PATH, STYLES_SCSS_FILE)
-
-    with open(style_scss_filepath, 'r') as fh:
-        data = fh.read()
-
-    lines = data.split("\n")
-    compiled_exp = re.compile('(' + pattern + ')')
-
-    rc_list = []
-
-    for line in lines:
-        match = re.search(compiled_exp, line)
-        if match:
-            path = match.group(1)
-            rc_list.append(match.group(1))
-
-    rc_list = list(set(rc_list))
-
-    return rc_list
-
-
-def compile_qrc_file(compile_for='qtpy', qrc_path=None, palette=None):
-    """
-    Compile the QRC file converting it to _rc.py nad/or .rcc.
-
-    When using an abstraction layer (QtPy/pyqtgraph) over a binging
-    (PySide/PyQt), in the end, it changes the importing name.
-
-    For all other `compile_for` that not 'qtpy', it prefixes the file name
-    with `compile_for` value.
-
-    Args:
-        compile_for (list, optional): Prefix used in resources.
-            Defaults to 'qtpy'. Possible values are 'qtpy', 'pyqtgraph',
-            'pyqt', 'pyqt5', 'pyside', 'pyside2', 'qt', 'qt5', 'all'.
-        qrc_path (str, optional): .qrc folder path.
-            Defaults to None.
-        palette (Palette, optional): Palette.
-    """
-
-    if palette is None:
-        _logger.error("Please pass a palette class in order to create its "
-                      "associated file")
-        sys.exit(1)
-
-    if palette.ID is None:
-        _logger.error("A QDarkStyle palette requires an ID!")
-        sys.exit(1)
-
-    if not qrc_path:
-        qrc_path = os.path.join(PACKAGE_PATH, palette.ID)
-
-    qrc_file = palette.ID + QRC_FILE_SUFFIX
-
-    # get name without extension
-    filename = os.path.splitext(qrc_file)[0]
-
-    ext = '_rc.py'
-    ext_c = '.rcc'
-
-    # creating names
-    py_file_pyqt6 = 'pyqt6_' + filename + ext
-    py_file_pyqt5 = 'pyqt5_' + filename + ext
-    py_file_pyqt = 'pyqt_' + filename + ext
-    py_file_pyside6 = 'pyside6_' + filename + ext
-    py_file_pyside2 = 'pyside2_' + filename + ext
-    py_file_pyside = 'pyside_' + filename + ext
-    py_file_qtpy = '' + filename + ext
-    py_file_pyqtgraph = 'pyqtgraph_' + filename + ext
-
-    # it is simple to change the directory, otherwise we need to add
-    # more arguments for each compiler
-    old_cwd = os.getcwd()
-    os.chdir(qrc_path)
-
-    # Shell kwarg to pass to subprocess
-    shell = True if os.name == 'nt' else False
-
-    # calling external commands
-    if compile_for in ['pyqt', 'pyqtgraph', 'all']:
-        _logger.info("Compiling using PyQt4 ...")
-        try:
-            subprocess.call(['pyrcc4', '-py3', qrc_file, '-o', py_file_pyqt], shell=shell)
-        except FileNotFoundError:
-            _logger.error("You must install pyrcc4")
-
-    if compile_for in ['pyqt5', 'qtpy','all']:
-        _logger.info("Compiling using PyQt5 ...")
-        try:
-            subprocess.call(['pyrcc5', qrc_file, '-o', py_file_pyqt5], shell=shell)
-        except FileNotFoundError:
-            _logger.error("You must install pyrcc5")
-
-    if compile_for in ['pyside', 'all']:
-        _logger.info("Compiling using PySide ...")
-        try:
-            subprocess.call(['pyside-rcc', '-py3', qrc_file, '-o', py_file_pyside], shell=shell)
-        except FileNotFoundError:
-            _logger.error("You must install pyside-rcc")
-
-    if compile_for in ['pyside2', 'all']:
-        _logger.info("Compiling using PySide 2...")
-        try:
-            subprocess.call(['pyside2-rcc', qrc_file, '-o', py_file_pyside2], shell=shell)
-        except FileNotFoundError:
-            _logger.error("You must install pyside2-rcc")
-
-    if compile_for in ['pyside6', 'all']:
-        _logger.info("Compiling using PySide 6...")
-        try:
-            subprocess.call(['pyside6-rcc', '-g', 'python', qrc_file, '-o', py_file_pyside6], shell=shell)
-        except FileNotFoundError:
-            _logger.error("You must install pyside6-rcc")
-
-    if compile_for in ['qtpy', 'all']:
-        _logger.info("Converting for QtPy ...")
-        # special case - qtpy - syntax is PyQt5
-        with open(py_file_pyqt5, 'r') as file:
-            filedata = file.read()
-
-        # replace the target string
-        filedata = filedata.replace('from PyQt5', 'from qtpy')
-
-        with open(py_file_qtpy, 'w+') as file:
-            # write the file out again
-            file.write(filedata)
-
-        if compile_for not in ['pyqt5']:
-            os.remove(py_file_pyqt5)
-
-    if compile_for in ['pyqtgraph', 'all']:
-        _logger.info("Converting for PyQtGraph ...")
-        # special case - pyqtgraph - syntax is PyQt4
-        with open(py_file_pyqt, 'r') as file:
-            filedata = file.read()
-
-        # replace the target string
-        filedata = filedata.replace('from PyQt4', 'from pyqtgraph.Qt')
-
-        with open(py_file_pyqtgraph, 'w+') as file:
-            # write the file out again
-            file.write(filedata)
-
-    os.chdir(old_cwd)