Migrate most resource logic to our package.

Author: Alexhuszagh

breezestylesheets/config.py

@@ -226,7 +226,7 @@ def decode(self, s: 'str') -> 'JSONValue':  # type: ignore # noqa
         return typing.cast('JSONValue', super().decode('\n'.join(lines)))
 
 
-def load(path: 'os.PathLike') -> 'Config':
+def load(path: 'str | os.PathLike[str]') -> 'Config':
     '''
     Load the stylesheet configuration settings from file.
 
@@ -402,7 +402,7 @@ def _transform_nested(v: 'JSONObject') -> 'dict[str, str]':
 @contextlib.contextmanager
 def _parse_block(
     data: 'str | bytes | bytearray | None' = None,
-    path: 'os.PathLike | None' = None,
+    path: 'str | os.PathLike[str] | None' = None,
 ) -> 'typing.Iterator[None]':
     '''A helper to parse the config data within a context block.'''
     try:

breezestylesheets/constants.py

@@ -0,0 +1,13 @@
+'''
+constants
+
+Constant values and aliases for library definitions.
+'''
+
+import typing
+
+Compression: 'typing.TypeAlias' = 'typing.Literal["zlib", "lzma", "gzip", "default"]'
+'''The valid compression schemes for a QT resource.'''
+
+Framework: 'typing.TypeAlias' = 'typing.Literal["pyqt5", "pyqt6", "pyside2", "pyside6"]'
+'''The valid Qt frameworks (and Python wrappers) used for the stylesheets.'''

breezestylesheets/exception.py

@@ -7,6 +7,8 @@
 
 import typing
 
+from .constants import Framework
+
 if typing.TYPE_CHECKING:
     import os
 
@@ -36,7 +38,7 @@ class ConfigParseError(ConfigError):
     data: 'str | bytes | bytearray'
     '''The input data provided to the parser.'''
 
-    path: 'os.PathLike | None'
+    path: 'str | os.PathLike[str] | None'
     '''The path to the input file that caused the error, if parsing from file.'''
 
     inner: 'Exception | None'
@@ -46,7 +48,7 @@ def __init__(
         self,
         message: 'str',
         data: 'str | bytes | bytearray',
-        path: 'os.PathLike | None' = None,
+        path: 'str | os.PathLike[str] | None' = None,
         inner: 'Exception | None' = None,
     ) -> None:
         '''
@@ -62,3 +64,66 @@ def __init__(
         self.data = data
         self.path = path
         self.inner = inner
+
+
+class InvalidFrameworkError(BreezeStyleSheetError):
+    '''An exception that occurs when the provided framework is unknown.'''
+
+    # NOTE: This is unknown so it's not a valid `Framework` type.
+    framework: 'str'
+    '''The name of the provided Qt framework.'''
+
+    def __init__(self, framework: 'str') -> None:
+        super().__init__(f'Got an unsupported Qt framework of "{framework}".')
+        self.framework = framework
+
+
+class ResourceError(BreezeStyleSheetError):
+    '''The base exception for all Qt resource errors.'''
+
+
+class RccNotFoundError(ResourceError):
+    '''An exception that occurs when the Qt resource compiler cannot be found.'''
+
+    rcc: 'str | os.PathLike[str]'
+    '''The name or path to the Qt resource compiler.'''
+
+    framework: 'Framework'
+    '''The name of the provided Qt framework.'''
+
+    def __init__(self, rcc: 'str | os.PathLike[str]', framework: 'Framework') -> None:
+        super().__init__(f'Unable to find a suitable "{rcc}" executable for framework "{framework}".')
+        self.rcc = rcc
+        self.framework = framework
+
+
+class ResourceCompileError(ResourceError):
+    '''An exception that occurs when there is an external error compiling the Qt resources.'''
+
+    rcc: 'str | os.PathLike[str]'
+    '''The name or path to the Qt resource compiler.'''
+
+    qrc: 'str | os.PathLike[str]'
+    '''The path to the input QRC file.'''
+
+    framework: 'Framework'
+    '''The name of the provided Qt framework.'''
+
+    inner: 'Exception'
+    '''The exception that caused the compilation error.'''
+
+    def __init__(
+        self,
+        rcc: 'str | os.PathLike[str]',
+        qrc: 'str | os.PathLike[str]',
+        framework: 'Framework',
+        inner: 'Exception',
+    ) -> None:
+        super().__init__(
+            f'Unable to find a compile the QRC file "{qrc}" using resource'
+            f' compiler "{rcc}" for framework "{framework}".'
+        )
+        self.rcc = rcc
+        self.qrc = qrc
+        self.framework = framework
+        self.inner = inner