feat: fail import if OS version unsupported

.flake8

@@ -15,4 +15,5 @@
 [flake8]
 max-line-length = 120
 per-file-ignores =
-  *.py: E203, E501
+  *.py: E501
+  src/windows_toasts/__init__.py: E402

CHANGELOG.rst

@@ -1,5 +1,6 @@
 Unversioned
 ===========
+- Importing the module now throws an exception if the Windows version is unsupported (#122)
 - Replaced toasts_winrt with winrt-Namespace packages (#113)
 - Dropped Python 3.8 support (#113)
 

scripts/publish_gh_release_notes.py

@@ -80,7 +80,9 @@ def main(argv):
             print("tag_name not given and $GITHUB_REF not set", file=sys.stderr)
             return 1
         if tag_name.startswith("refs/tags/"):
-            tag_name = tag_name[len("refs/tags/") :]
+            # fmt: off
+            tag_name = tag_name[len("refs/tags/"):]
+            # fmt: on
 
     token = os.environ.get("GH_RELEASE_NOTES_TOKEN")
     if not token:

src/windows_toasts/__init__.py

@@ -1,3 +1,14 @@
+import platform
+
+from .exceptions import UnsupportedOSVersionException
+
+# We'll assume it's Windows since if it's on another OS it should be self-explanatory
+MIN_VERSION = 10240
+if platform.system() == "Windows" and (osVersion := int(platform.version().split(".")[2])) < MIN_VERSION:
+    raise UnsupportedOSVersionException(
+        f"Platform version {osVersion} is not supported. Required minimum is {MIN_VERSION}"
+    )
+
 from ._version import __author__, __description__, __license__, __title__, __url__, __version__  # noqa: F401
 from .events import ToastActivatedEventArgs, ToastDismissalReason, ToastDismissedEventArgs, ToastFailedEventArgs
 from .exceptions import InvalidImageException, ToastNotFoundError
@@ -36,6 +47,7 @@
     # exceptions.py
     "InvalidImageException",
     "ToastNotFoundError",
+    "UnsupportedOSVersionException",
     # toast_audio.py
     "AudioSource",
     "ToastAudio",

src/windows_toasts/exceptions.py

@@ -4,3 +4,7 @@ class InvalidImageException(Exception):
 
 class ToastNotFoundError(Exception):
     """The toast could not be found"""
+
+
+class UnsupportedOSVersionException(ImportError):
+    """The operating system version is not supported"""

tests/test_import.py

@@ -0,0 +1,17 @@
+from unittest.mock import patch
+
+from pytest import raises
+
+
+# noinspection PyUnresolvedReferences
+def test_import_current():
+    import importlib
+
+    # Successful import
+    import src.windows_toasts
+
+    # 6.1.7601 = Windows 7
+    with patch("platform.version", return_value="6.1.7601"):
+        with raises(src.windows_toasts.UnsupportedOSVersionException):
+            # Reload
+            importlib.reload(src.windows_toasts)

tests/test_toasts.py

@@ -1,5 +1,3 @@
-import copy
-
 from pytest import raises, warns
 
 from src.windows_toasts import InteractableWindowsToaster, Toast, WindowsToaster
@@ -150,6 +148,8 @@ def test_custom_timestamp_toast():
 
 
 def test_input_toast():
+    import copy
+
     from src.windows_toasts import ToastInputSelectionBox, ToastInputTextBox, ToastSelection
 
     toastTextBoxInput = ToastInputTextBox("question", "How are you today?", "Enter here!")