qt-material/qt_material/__init__.py

511 lines
18 KiB
Python
Raw Normal View History

2020-12-05 21:38:34 -05:00
import os
import sys
import logging
2021-04-23 17:51:27 -05:00
import base64
2021-05-07 19:37:20 +02:00
from pathlib import Path
import platform
from xml.dom.minidom import parse
2020-12-05 21:38:34 -05:00
2021-04-23 17:51:27 -05:00
from qt_material.resources import ResourseGenerator, RESOURCES_PATH
GUI = True
2020-12-05 21:38:34 -05:00
if 'PySide2' in sys.modules:
from PySide2.QtGui import QFontDatabase, QColor, QGuiApplication, QPalette
2020-12-13 14:40:16 -05:00
from PySide2.QtWidgets import QAction, QColorDialog
from PySide2.QtUiTools import QUiLoader
from PySide2.QtCore import Qt, QDir
2020-12-11 11:41:13 -05:00
elif 'PySide6' in sys.modules:
from PySide6.QtGui import QFontDatabase, QAction, QColor, QGuiApplication, QPalette
2020-12-13 14:40:16 -05:00
from PySide6.QtWidgets import QColorDialog
from PySide6.QtUiTools import QUiLoader
from PySide6.QtCore import Qt, QDir
2020-12-11 11:41:13 -05:00
2020-12-05 21:38:34 -05:00
elif 'PyQt5' in sys.modules:
from PyQt5.QtGui import QFontDatabase, QColor, QGuiApplication, QPalette
2020-12-13 14:40:16 -05:00
from PyQt5.QtWidgets import QAction, QColorDialog
from PyQt5.QtCore import Qt, QDir
from PyQt5 import uic
elif 'PyQt6' in sys.modules:
from PyQt6.QtGui import QFontDatabase, QColor, QGuiApplication, QPalette, QAction
from PyQt6.QtWidgets import QColorDialog
from PyQt6.QtCore import Qt, QDir
from PyQt6 import uic
2020-12-11 11:41:13 -05:00
else:
2021-04-23 17:51:27 -05:00
GUI = False
2020-12-12 14:18:24 -05:00
logging.warning("qt_material must be imported after PySide or PyQt!")
2020-12-05 21:38:34 -05:00
import jinja2
template = 'material.css.template'
# ----------------------------------------------------------------------
2021-05-09 14:21:25 -05:00
def export_theme(theme='', qss=None, rcc=None, invert_secondary=False, extra={}, output='theme', prefix='icon:/'):
2021-04-23 17:51:27 -05:00
""""""
if not os.path.isabs(output) and not output.startswith('.'):
output = f'.{output}'
stylesheet = build_stylesheet(
theme, invert_secondary, extra, output)
with open(qss, 'w') as file:
file.writelines(stylesheet.replace('icon:/', prefix))
if rcc:
with open(rcc, 'w') as file:
file.write('<RCC>\n')
file.write(f' <qresource prefix="{prefix[:-2]}">\n')
if output.startswith('.'):
output = output[1:]
for subfolder in ['disabled', 'primary']:
files = os.listdir(os.path.join(
os.path.abspath(output), subfolder))
files = filter(lambda s: s.endswith('svg'), files)
for filename in files:
file.write(
f' <file>{output}/{subfolder}/{filename}</file>\n')
file.write(' </qresource>\n')
file.write(f' <qresource prefix="file">\n')
if qss:
file.write(f' <file>{qss}</file>\n')
file.write(' </qresource>\n')
file.write('</RCC>\n')
2021-04-23 17:51:27 -05:00
# ----------------------------------------------------------------------
def build_stylesheet(theme='', invert_secondary=False, extra={}, parent='theme'):
2020-12-05 21:38:34 -05:00
""""""
try:
add_fonts()
except Exception as e:
logging.warning(e)
2021-09-03 15:08:00 -05:00
theme = get_theme(theme, invert_secondary)
2020-12-05 21:38:34 -05:00
if theme is None:
return None
set_icons_theme(theme, parent=parent)
2020-12-05 21:38:34 -05:00
loader = jinja2.FileSystemLoader(os.path.join(
os.path.dirname(os.path.abspath(__file__))))
2021-04-23 17:51:27 -05:00
env = jinja2.Environment(autoescape=False, loader=loader)
2020-12-05 21:38:34 -05:00
theme['icon'] = None
env.filters['opacity'] = opacity
env.filters['density'] = density
2021-04-23 17:51:27 -05:00
# env.filters['as_base64'] = as_base64
2020-12-05 21:38:34 -05:00
# env.filters['load'] = load
stylesheet = env.get_template(template)
theme.setdefault('font_family', 'Roboto')
theme.setdefault('danger', '#dc3545')
theme.setdefault('warning', '#ffc107')
theme.setdefault('success', '#17a2b8')
theme.setdefault('density_scale', '0')
theme.setdefault('button_shape', 'default')
2021-12-22 11:46:38 -05:00
theme.setdefault('font_size', '13px')
2020-12-05 21:38:34 -05:00
theme.update(extra)
if GUI:
default_palette = QGuiApplication.palette()
color = QColor(*[int(theme['primaryColor'][i:i + 2], 16)
for i in range(1, 6, 2)] + [92])
try:
if hasattr(QPalette, 'PlaceholderText'): # pyqt5, pyside2, pyside6
default_palette.setColor(QPalette.PlaceholderText, color)
else: # pyqt6
default_palette.setColor(QPalette.ColorRole.Text, color)
QGuiApplication.setPalette(default_palette)
except: # pyside6 & snake_case, true_property
default_palette.set_color(QPalette.ColorRole.Text, color)
QGuiApplication.set_palette(default_palette)
environ = {
'linux': platform.system() == 'Linux',
'windows': platform.system() == 'Windows',
'darwin': platform.system() == 'Darwin',
'pyqt5': 'PyQt5' in sys.modules,
'pyqt6': 'PyQt6' in sys.modules,
'pyside2': 'PySide2' in sys.modules,
'pyside6': 'PySide6' in sys.modules,
}
return stylesheet.render(**{**theme, **environ})
2020-12-05 21:38:34 -05:00
# ----------------------------------------------------------------------
def get_theme(theme_name, invert_secondary=False):
2020-12-05 21:38:34 -05:00
if theme_name in ['default.xml', 'default_dark.xml', 'default', 'default_dark']:
theme = os.path.join(os.path.dirname(
os.path.abspath(__file__)), 'themes', 'dark_teal.xml')
elif theme_name in ['default_light.xml', 'default_light']:
invert_secondary = True
2020-12-05 21:38:34 -05:00
theme = os.path.join(os.path.dirname(
os.path.abspath(__file__)), 'themes', 'light_blue.xml')
2020-12-11 22:48:04 -05:00
elif not os.path.exists(theme_name):
2020-12-05 21:38:34 -05:00
theme = os.path.join(os.path.dirname(
os.path.abspath(__file__)), 'themes', theme_name)
2020-12-11 22:48:04 -05:00
else:
theme = theme_name
2020-12-05 21:38:34 -05:00
if not os.path.exists(theme):
logging.warning(f"{theme} not exist!")
return None
document = parse(theme)
theme = {child.getAttribute(
'name'): child.firstChild.nodeValue for child in document.getElementsByTagName('color')}
2020-12-05 21:38:34 -05:00
for k in theme:
os.environ[str(k)] = theme[k]
if invert_secondary:
2020-12-05 21:38:34 -05:00
theme['secondaryColor'], theme['secondaryLightColor'], theme['secondaryDarkColor'] = theme[
'secondaryColor'], theme['secondaryDarkColor'], theme['secondaryLightColor']
for color in ['primaryColor',
'primaryLightColor',
'secondaryColor',
'secondaryLightColor',
'secondaryDarkColor',
'primaryTextColor',
'secondaryTextColor']:
os.environ[f'QTMATERIAL_{color.upper()}'] = theme[color]
os.environ['QTMATERIAL_THEME'] = theme_name
2020-12-05 21:38:34 -05:00
return theme
# ----------------------------------------------------------------------
def add_fonts():
""""""
fonts_path = os.path.join(os.path.dirname(__file__), 'fonts')
2020-12-27 13:17:28 -05:00
2021-04-14 09:02:23 -05:00
for font_dir in ['roboto']:
for font in filter(lambda s: s.endswith('.ttf'), os.listdir(os.path.join(fonts_path, font_dir))):
2021-12-23 15:29:40 -05:00
try:
QFontDatabase.addApplicationFont(
os.path.join(fonts_path, font_dir, font))
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
QFontDatabase.add_application_font(
os.path.join(fonts_path, font_dir, font))
2020-12-05 21:38:34 -05:00
# ----------------------------------------------------------------------
2021-04-23 17:51:27 -05:00
def apply_stylesheet(app, theme='', style=None, save_as=None, invert_secondary=False, extra={}, parent='theme'):
2020-12-05 21:38:34 -05:00
""""""
if style:
try:
2021-12-23 15:29:40 -05:00
try:
app.setStyle(style)
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
app.style = style
2020-12-05 21:38:34 -05:00
except:
logging.error(f"The style '{style}' does not exist.")
2020-12-05 21:38:34 -05:00
pass
2021-12-23 15:29:40 -05:00
2021-02-08 08:37:54 -05:00
stylesheet = build_stylesheet(
2021-04-23 17:51:27 -05:00
theme, invert_secondary, extra, parent)
2020-12-05 21:38:34 -05:00
if stylesheet is None:
return
if save_as:
with open(save_as, 'w') as file:
file.writelines(stylesheet)
return app.setStyleSheet(stylesheet)
# ----------------------------------------------------------------------
def opacity(theme, value=0.5):
""""""
r, g, b = theme[1:][0:2], theme[1:][2:4], theme[1:][4:]
r, g, b = int(r, 16), int(g, 16), int(b, 16)
return f'rgba({r}, {g}, {b}, {value})'
2020-12-05 22:54:28 -05:00
# ----------------------------------------------------------------------
def density(value, density_scale, border=0, scale=1):
""""""
# https://material.io/develop/web/supporting/density
if isinstance(value, str) and value.startswith('@'):
return value[1:] * scale
density_interval = 4
2021-12-23 15:29:40 -05:00
density = (value + (density_interval * int(density_scale))
- (border * 2)) * scale
if density < 4:
density = 4
return density
2020-12-11 11:41:13 -05:00
# ----------------------------------------------------------------------
def set_icons_theme(theme, parent='theme'):
2020-12-05 21:38:34 -05:00
""""""
2021-01-23 14:37:30 -05:00
source = os.path.join(os.path.dirname(__file__), 'resources', 'source')
2021-02-08 08:37:54 -05:00
resources = ResourseGenerator(primary=theme['primaryColor'], secondary=theme['secondaryColor'],
disabled=theme['secondaryLightColor'], source=source, parent=parent)
resources.generate()
2021-04-23 17:51:27 -05:00
if GUI:
2021-12-23 15:29:40 -05:00
try:
QDir.addSearchPath('icon', resources.index)
QDir.addSearchPath('qt_material', os.path.join(
os.path.dirname(__file__), 'resources'))
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
QDir.add_search_path('icon', resources.index)
QDir.add_search_path('qt_material', os.path.join(
os.path.dirname(__file__), 'resources'))
2020-12-05 21:38:34 -05:00
# ----------------------------------------------------------------------
def list_themes():
""""""
themes = os.listdir(os.path.join(
os.path.dirname(os.path.abspath(__file__)), 'themes'))
themes = filter(lambda a: a.endswith('xml'), themes)
return sorted(list(themes))
# ----------------------------------------------------------------------
def deprecated(replace):
""""""
# ----------------------------------------------------------------------
def wrap1(fn):
# ----------------------------------------------------------------------
def wrap2(*args, **kwargs):
logging.warning(
f'This function is deprecated, please use "{replace}" instead.')
fn(*args, **kwargs)
return wrap2
return wrap1
2020-12-05 21:38:34 -05:00
########################################################################
2020-12-13 14:40:16 -05:00
class QtStyleTools:
2020-12-05 21:38:34 -05:00
""""""
extra_values = {}
2020-12-05 21:38:34 -05:00
2020-12-11 22:48:04 -05:00
# ----------------------------------------------------------------------
@deprecated('set_extra')
2020-12-13 14:40:16 -05:00
def set_extra_colors(self, extra):
2020-12-05 21:38:34 -05:00
""""""
self.extra_values = extra
# ----------------------------------------------------------------------
def set_extra(self, extra):
""""""
self.extra_values = extra
2020-12-13 14:40:16 -05:00
# ----------------------------------------------------------------------
2020-12-13 16:36:56 -05:00
def add_menu_theme(self, parent, menu):
2020-12-13 14:40:16 -05:00
""""""
2020-12-05 21:38:34 -05:00
for theme in ['default'] + list_themes():
action = QAction(parent)
2021-02-08 08:37:54 -05:00
action.triggered.connect(self._wrapper(
parent, theme, self.extra_values, self.update_buttons))
2021-12-23 15:29:40 -05:00
try:
action.setText(theme)
menu.addAction(action)
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
action.text = theme
menu.add_action(action)
2020-12-05 21:38:34 -05:00
# ----------------------------------------------------------------------
def _wrapper(self, parent, theme, extra, callable_):
2020-12-05 21:38:34 -05:00
""""""
def iner():
self._apply_theme(parent, theme, extra, callable_)
2020-12-05 21:38:34 -05:00
return iner
# ----------------------------------------------------------------------
def _apply_theme(self, parent, theme, extra={}, callable_=None):
2020-12-11 22:48:04 -05:00
""""""
self.apply_stylesheet(parent, theme=theme, invert_secondary=theme.startswith(
'light'), extra=extra, callable_=callable_)
2020-12-11 22:48:04 -05:00
# ----------------------------------------------------------------------
2020-12-13 16:36:56 -05:00
def apply_stylesheet(self, parent, theme, invert_secondary=False, extra={}, callable_=None):
2020-12-05 21:38:34 -05:00
""""""
if theme == 'default':
parent.setStyleSheet('')
return
2021-02-08 08:37:54 -05:00
apply_stylesheet(parent, theme=theme,
invert_secondary=invert_secondary, extra=extra)
if callable_:
callable_()
2020-12-13 14:40:16 -05:00
# ----------------------------------------------------------------------
def update_buttons(self):
""""""
if not hasattr(self, 'colors'):
return
2021-02-08 08:37:54 -05:00
theme = {color_: os.environ[f'QTMATERIAL_{color_.upper()}']
for color_ in self.colors}
2020-12-13 14:40:16 -05:00
if 'light' in os.environ['QTMATERIAL_THEME']:
2020-12-13 14:40:16 -05:00
self.dock_theme.checkBox_ligh_theme.setChecked(True)
elif 'dark' in os.environ['QTMATERIAL_THEME']:
2020-12-13 14:40:16 -05:00
self.dock_theme.checkBox_ligh_theme.setChecked(False)
2021-12-23 15:29:40 -05:00
try:
if self.dock_theme.checkBox_ligh_theme.isChecked():
theme['secondaryColor'], theme['secondaryLightColor'], theme['secondaryDarkColor'] = theme[
'secondaryColor'], theme['secondaryDarkColor'], theme['secondaryLightColor']
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
if self.dock_theme.checkBox_ligh_theme.checked:
theme['secondaryColor'], theme['secondaryLightColor'], theme['secondaryDarkColor'] = theme[
'secondaryColor'], theme['secondaryDarkColor'], theme['secondaryLightColor']
2020-12-13 14:40:16 -05:00
for color_ in self.colors:
button = getattr(self.dock_theme, f'pushButton_{color_}')
color = theme[color_]
2021-12-23 15:29:40 -05:00
try:
if self.get_color(color).getHsv()[2] < 128:
text_color = '#ffffff'
else:
text_color = '#000000'
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
if self.get_color(color).get_hsv()[2] < 128:
text_color = '#ffffff'
else:
text_color = '#000000'
2020-12-13 14:40:16 -05:00
button.setStyleSheet(f"""
*{{
background-color: {color};
color: {text_color};
border: none;
}}""")
self.custom_colors[color_] = color
# ----------------------------------------------------------------------
def get_color(self, color):
""""""
return QColor(*[int(color[s:s + 2], 16) for s in range(1, 6, 2)])
# ----------------------------------------------------------------------
def update_theme(self, parent):
""""""
with open('my_theme.xml', 'w') as file:
file.write("""
<resources>
<color name="primaryColor">{primaryColor}</color>
<color name="primaryLightColor">{primaryLightColor}</color>
<color name="secondaryColor">{secondaryColor}</color>
<color name="secondaryLightColor">{secondaryLightColor}</color>
<color name="secondaryDarkColor">{secondaryDarkColor}</color>
<color name="primaryTextColor">{primaryTextColor}</color>
<color name="secondaryTextColor">{secondaryTextColor}</color>
</resources>
""".format(**self.custom_colors))
2021-12-23 15:29:40 -05:00
try:
light = self.dock_theme.checkBox_ligh_theme.isChecked()
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
light = self.dock_theme.checkBox_ligh_theme.checked
2021-02-08 08:37:54 -05:00
self.apply_stylesheet(parent, 'my_theme.xml', invert_secondary=light,
extra=self.extra_values, callable_=self.update_buttons)
2020-12-13 14:40:16 -05:00
# ----------------------------------------------------------------------
def set_color(self, parent, button_):
""""""
def iner():
initial = self.get_color(self.custom_colors[button_])
color_dialog = QColorDialog(parent=parent)
2021-12-23 15:29:40 -05:00
try:
color_dialog.setCurrentColor(initial)
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
color_dialog.current_color = initial
2020-12-13 14:40:16 -05:00
done = color_dialog.exec_()
2021-12-23 15:29:40 -05:00
try:
color_ = color_dialog.currentColor()
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
color_ = color_dialog.current_color
try:
if done and color_.isValid():
rgb_255 = [color_.red(), color_.green(), color_.blue()]
color = '#' + ''.join([hex(v)[2:].ljust(2, '0')
for v in rgb_255])
self.custom_colors[button_] = color
self.update_theme(parent)
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
if done and color_.is_valid():
rgb_255 = [color_.red(), color_.green(), color_.blue()]
color = '#' + ''.join([hex(v)[2:].ljust(2, '0')
for v in rgb_255])
self.custom_colors[button_] = color
self.update_theme(parent)
2020-12-13 14:40:16 -05:00
return iner
# ----------------------------------------------------------------------
def show_dock_theme(self, parent):
""""""
self.colors = ['primaryColor',
'primaryLightColor',
'secondaryColor',
'secondaryLightColor',
'secondaryDarkColor',
'primaryTextColor',
'secondaryTextColor']
2021-02-08 08:37:54 -05:00
self.custom_colors = {
v: os.environ[f'QTMATERIAL_{v.upper()}'] for v in self.colors}
if 'PySide2' in sys.modules or 'PySide6' in sys.modules:
2021-02-08 08:37:54 -05:00
self.dock_theme = QUiLoader().load(os.path.join(
os.path.dirname(__file__), 'dock_theme.ui'))
elif 'PyQt5' in sys.modules or 'PyQt6' in sys.modules:
2021-02-08 08:37:54 -05:00
self.dock_theme = uic.loadUi(os.path.join(
os.path.dirname(__file__), 'dock_theme.ui'))
2021-12-23 15:29:40 -05:00
try:
parent.addDockWidget(
Qt.DockWidgetArea.LeftDockWidgetArea, self.dock_theme)
self.dock_theme.setFloating(True)
except: # snake_case, true_property
2021-12-23 15:29:40 -05:00
parent.add_dock_widget(
Qt.DockWidgetArea.LeftDockWidgetArea, self.dock_theme)
self.dock_theme.floating = True
2020-12-13 14:40:16 -05:00
self.update_buttons()
2021-02-08 08:37:54 -05:00
self.dock_theme.checkBox_ligh_theme.clicked.connect(
lambda: self.update_theme(self.main))
2020-12-13 14:40:16 -05:00
for color in self.colors:
button = getattr(self.dock_theme, f'pushButton_{color}')
button.clicked.connect(self.set_color(parent, color))
2021-05-07 19:37:20 +02:00
# ----------------------------------------------------------------------
def get_hook_dirs():
package_folder = Path(__file__).parent
2021-09-03 15:08:00 -05:00
return [str(package_folder.absolute())]