compatibility 2.1.0__tar.gz → 2.2.0__tar.gz

{compatibility-2.1.0 → compatibility-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: compatibility
-Version: 2.1.0
+Version: 2.2.0
 Summary: A library that checks whether the running version of Python is compatible and tested. Remind the user to check for updates of the library.
 License-Expression: Apache-2.0
 License-File: LICENSE
@@ -26,11 +26,11 @@ Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Provides-Extra: dev
-Requires-Dist: coverage[toml] (>=7.14,<8) ; extra == "dev"
-Requires-Dist: mypy (>=2.1,<3) ; extra == "dev"
-Requires-Dist: pytest (>=9.0,<10) ; extra == "dev"
-Requires-Dist: pytest-cov (>=7.1,<8) ; extra == "dev"
-Requires-Dist: ruff (>=0.15,<0.16) ; extra == "dev"
+Requires-Dist: coverage[toml] (>=7.14.1,<8) ; extra == "dev"
+Requires-Dist: mypy (>=2.1.0,<3) ; extra == "dev"
+Requires-Dist: pytest (>=9.0.3,<10) ; extra == "dev"
+Requires-Dist: pytest-cov (>=7.1.0,<8) ; extra == "dev"
+Requires-Dist: ruff (>=0.15.16,<0.16) ; extra == "dev"
 Project-URL: Bug Tracker, https://github.com/RuedigerVoigt/compatibility/issues
 Project-URL: Changelog, https://github.com/RuedigerVoigt/compatibility/blob/main/CHANGELOG.md
 Project-URL: Documentation, https://github.com/RuedigerVoigt/compatibility

{compatibility-2.1.0 → compatibility-2.2.0}/compatibility/__main__.py

@@ -20,7 +20,7 @@ import platform
 import random
 import re
 import sys
-from typing import Literal, Optional, TypedDict, Union
+from typing import Literal, TypedDict
 
 from compatibility import err
 
@@ -54,7 +54,7 @@ class SystemSupport(TypedDict, total=False):
     incompatible: set[str]
 
 
-class Check():
+class Check:
     """Main Class of the compatibility package: check Python version
        and time since release."""
 
@@ -63,14 +63,21 @@ class Check():
     VERSION_REGEX = re.compile(
         r"(?P<major>\d+)\.(?P<minor>\d+)(\.(?P<releaselevel>\b(alpha|beta|candidate|final)\b))?")
 
+    # Plausibility bounds for release_date. A date well into the future is
+    # almost always a typo (e.g. a wrong year); a very old date suggests
+    # release_date was never updated. Both only warn -- a near-future date is
+    # legitimate while developing toward a planned release.
+    FUTURE_LIMIT_DAYS = 60
+    PAST_LIMIT_YEARS = 8
+
     def __init__(self,
                  package_name: str,
                  package_version: str,
-                 release_date: Union[datetime.date, str],
-                 python_version_support: Optional[PythonVersionSupport] = None,
-                 nag_over_update: Optional[NagOverUpdate] = None,
+                 release_date: datetime.date | str,
+                 python_version_support: PythonVersionSupport | None = None,
+                 nag_over_update: NagOverUpdate | None = None,
                  language_messages: str = 'en',
-                 system_support: Optional[SystemSupport] = None,
+                 system_support: SystemSupport | None = None,
                  on_incompatible: Literal['raise', 'warn', 'ignore'] = 'raise'):
         """Initialize compatibility checker and perform all validation checks.
 
@@ -134,6 +141,7 @@ class Check():
         self._ = self._translation.gettext
         self.release_date = self.__coerce_date(release_date)
         self.check_params()
+        self.__warn_implausible_release_date()
         self.check_python_version(python_version_support)
         self.check_system(system_support)
         self.log_version_info()
@@ -141,7 +149,7 @@ class Check():
             self.check_version_age(nag_over_update)
 
     def __coerce_date(
-            self, date_to_coerce: Union[str, datetime.date]) -> datetime.date:
+            self, date_to_coerce: str | datetime.date) -> datetime.date:
         """Convert a string to datetime.date and validate.
 
         Accepts either a datetime.date object (returned as-is) or a string
@@ -172,6 +180,25 @@ class Check():
         raise err.BadDateType(
             self._('date_to_coerce must be either string or datetime.date'))
 
+    def __warn_implausible_release_date(self) -> None:
+        """Warn (never raise) if release_date is implausibly far off.
+
+        A date more than ``FUTURE_LIMIT_DAYS`` ahead is almost always a typo
+        (e.g. a wrong year), and a date more than ``PAST_LIMIT_YEARS`` old
+        suggests release_date was not updated. Neither is fatal: a near-future
+        date is legitimate while developing toward a planned release, so both
+        cases only log a warning and leave the date usable.
+        """
+        days_from_today = (self.release_date - datetime.date.today()).days
+        if days_from_today > self.FUTURE_LIMIT_DAYS:
+            logger.warning(
+                self._("The release_date %s is more than %s days in the future. Please check it is correct."),
+                self.release_date, self.FUTURE_LIMIT_DAYS)
+        elif days_from_today < -(self.PAST_LIMIT_YEARS * 365):
+            logger.warning(
+                self._("The release_date %s is more than %s years in the past. Please check it is correct."),
+                self.release_date, self.PAST_LIMIT_YEARS)
+
     def check_params(self) -> None:
         """Validate that required parameters are non-empty and valid.
 
@@ -199,7 +226,7 @@ class Check():
             raise ValueError(self._('Invalid value for on_incompatible!'))
 
     def check_python_version(self,
-                             python_version_support: Optional[PythonVersionSupport] = None
+                             python_version_support: PythonVersionSupport | None = None
                              ) -> None:
         """Validate that the running Python version is supported.
 
@@ -213,8 +240,8 @@ class Check():
                 no version checking is performed.
 
         Raises:
-            ValueError: If python_version_support dict is malformed or
-                contains invalid version strings.
+            ValueError: If python_version_support is not a dict, is malformed,
+                or contains invalid version strings.
             err.ParameterContradiction: If 'min_version' is higher than
                 'max_tested_version'.
             RuntimeError: If running Python version is below minimum or is
@@ -224,6 +251,9 @@ class Check():
         if not python_version_support:
             # Setting python_version_support is not required
             return None
+        if not isinstance(python_version_support, dict):
+            raise ValueError(
+                self._('Parameter python_version_support must be a dictionary'))
 
         min_version, max_version = self.__validate_python_version_support(
             python_version_support)
@@ -256,7 +286,8 @@ class Check():
             re-parse (and assert-guard) the strings in the comparison helpers.
 
         Raises:
-            ValueError: If the dict has the wrong keys, or any of the version
+            ValueError: If the dict has the wrong keys, if
+                'incompatible_versions' is not a list, or any of the version
                 strings ('min_version', 'max_tested_version', or any entry of
                 'incompatible_versions') cannot be parsed.
             err.ParameterContradiction: If 'min_version' is higher than
@@ -287,6 +318,12 @@ class Check():
                                  python_version_support['max_tested_version'])
         if not max_match:
             raise ValueError(self._('Value for key max_tested_version incorrect.'))
+        # A bare string here would otherwise be iterated character by character
+        # (yielding a misleading "cannot be parsed" error), and an empty string
+        # would pass silently. Require an actual list.
+        if not isinstance(python_version_support['incompatible_versions'], list):
+            raise ValueError(
+                self._('Value for key incompatible_versions must be a list.'))
         for version_string in python_version_support['incompatible_versions']:
             if not re.fullmatch(self.VERSION_REGEX, version_string):
                 raise ValueError(
@@ -368,7 +405,7 @@ class Check():
                 )
 
     def check_system(self,
-                     system_support: Optional[SystemSupport]) -> None:
+                     system_support: SystemSupport | None) -> None:
         """Validate operating system compatibility.
 
         Checks whether the current OS (Linux, MacOS, or Windows) is fully
@@ -527,10 +564,13 @@ class Check():
                 (int 0-100, percentage chance of showing nag message).
 
         Raises:
-            ValueError: If a key is missing, if a value is not an int, if
-                nag_days_after_release is negative, or if nag_in_hundred is
-                not between 0 and 100.
+            ValueError: If nag_over_update is not a dict, a key is missing, a
+                value is not an int, nag_days_after_release is negative, or
+                nag_in_hundred is not between 0 and 100.
         """
+        if not isinstance(nag_over_update, dict):
+            raise ValueError(
+                self._('Parameter nag_over_update must be a dictionary'))
         nag_days_after_release, nag_in_hundred = self.__validate_nag_over_update(
             nag_over_update)
         if nag_in_hundred == 0:
@@ -557,8 +597,8 @@ class Check():
             A tuple of (nag_days_after_release, nag_in_hundred).
 
         Raises:
-            ValueError: If a key is missing, if a value is not an int (floats
-                and strings are rejected rather than coerced), if
+            ValueError: If a key is missing, if a value is not an int (bool,
+                floats, and strings are rejected rather than coerced), if
                 nag_days_after_release is negative, or if nag_in_hundred is
                 not between 0 and 100.
         """
@@ -568,8 +608,11 @@ class Check():
         nag_days_after_release = nag_over_update['nag_days_after_release']
         nag_in_hundred = nag_over_update['nag_in_hundred']
         # Reject non-int values explicitly: int() would silently truncate a
-        # float (3.7 -> 3) or accept a numeric string.
-        if (not isinstance(nag_days_after_release, int)
+        # float (3.7 -> 3) or accept a numeric string. bool is checked first
+        # because it is a subclass of int (True would otherwise pass as 1).
+        if (isinstance(nag_days_after_release, bool)
+                or isinstance(nag_in_hundred, bool)
+                or not isinstance(nag_days_after_release, int)
                 or not isinstance(nag_in_hundred, int)):
             raise ValueError(self._('Some key in nag_over_update has wrong type!'))
         if nag_days_after_release < 0:

{compatibility-2.1.0 → compatibility-2.2.0}/compatibility/locales/de/LC_MESSAGES/compatibility.po

@@ -60,6 +60,10 @@ msgstr "Wert für Schlüssel min_version ist inkorrekt."
 msgid "Value for key max_tested_version incorrect."
 msgstr "Wert für Schlüssel max_tested_version ist inkorrekt."
 
+#: compatibility/__main__.py:326
+msgid "Value for key incompatible_versions must be a list."
+msgstr "Wert für Schlüssel incompatible_versions muss eine Liste sein."
+
 #: compatibility/__main__.py:294
 msgid "min_version (%(min)s) is higher than max_tested_version (%(max)s)."
 msgstr "min_version (%(min)s) ist höher als max_tested_version (%(max)s)."
@@ -143,3 +147,19 @@ msgstr "nag_days_after_release darf nicht negativ sein."
 #: compatibility/__main__.py:546
 msgid "nag_in_hundred must be int between 0 and 100."
 msgstr "nag_in_hundred muss ein Integer zwischen 0 und 100 sein."
+
+#: compatibility/__main__.py:195
+msgid "The release_date %s is more than %s days in the future. Please check it is correct."
+msgstr "Das release_date %s liegt mehr als %s Tage in der Zukunft. Bitte prüfen Sie, ob es korrekt ist."
+
+#: compatibility/__main__.py:199
+msgid "The release_date %s is more than %s years in the past. Please check it is correct."
+msgstr "Das release_date %s liegt mehr als %s Jahre in der Vergangenheit. Bitte prüfen Sie, ob es korrekt ist."
+
+#: compatibility/__main__.py:256
+msgid "Parameter python_version_support must be a dictionary"
+msgstr "Parameter python_version_support muss ein Dictionary sein"
+
+#: compatibility/__main__.py:566
+msgid "Parameter nag_over_update must be a dictionary"
+msgstr "Parameter nag_over_update muss ein Dictionary sein"

{compatibility-2.1.0 → compatibility-2.2.0}/compatibility/locales/es/LC_MESSAGES/compatibility.po

@@ -62,6 +62,10 @@ msgstr "El valor de la clave min_version es incorrecto."
 msgid "Value for key max_tested_version incorrect."
 msgstr "El valor de la clave max_tested_version es incorrecto."
 
+#: compatibility/__main__.py:326
+msgid "Value for key incompatible_versions must be a list."
+msgstr "El valor de la clave incompatible_versions debe ser una lista."
+
 #: compatibility/__main__.py:294
 msgid "min_version (%(min)s) is higher than max_tested_version (%(max)s)."
 msgstr "min_version (%(min)s) es mayor que max_tested_version (%(max)s)."
@@ -145,3 +149,19 @@ msgstr "nag_days_after_release no debe ser negativo."
 #: compatibility/__main__.py:546
 msgid "nag_in_hundred must be int between 0 and 100."
 msgstr "nag_in_hundred debe ser un entero entre 0 y 100."
+
+#: compatibility/__main__.py:195
+msgid "The release_date %s is more than %s days in the future. Please check it is correct."
+msgstr "La release_date %s está a más de %s días en el futuro. Compruebe que sea correcta."
+
+#: compatibility/__main__.py:199
+msgid "The release_date %s is more than %s years in the past. Please check it is correct."
+msgstr "La release_date %s es de hace más de %s años. Compruebe que sea correcta."
+
+#: compatibility/__main__.py:256
+msgid "Parameter python_version_support must be a dictionary"
+msgstr "El parámetro python_version_support debe ser un diccionario"
+
+#: compatibility/__main__.py:566
+msgid "Parameter nag_over_update must be a dictionary"
+msgstr "El parámetro nag_over_update debe ser un diccionario"

{compatibility-2.1.0 → compatibility-2.2.0}/compatibility/locales/fr/LC_MESSAGES/compatibility.po

@@ -62,6 +62,10 @@ msgstr "La valeur de la clé min_version est incorrecte."
 msgid "Value for key max_tested_version incorrect."
 msgstr "La valeur de la clé max_tested_version est incorrecte."
 
+#: compatibility/__main__.py:326
+msgid "Value for key incompatible_versions must be a list."
+msgstr "La valeur de la clé incompatible_versions doit être une liste."
+
 #: compatibility/__main__.py:294
 msgid "min_version (%(min)s) is higher than max_tested_version (%(max)s)."
 msgstr "min_version (%(min)s) est supérieur à max_tested_version (%(max)s)."
@@ -145,3 +149,19 @@ msgstr "nag_days_after_release ne doit pas être négatif."
 #: compatibility/__main__.py:546
 msgid "nag_in_hundred must be int between 0 and 100."
 msgstr "nag_in_hundred doit être un entier entre 0 et 100."
+
+#: compatibility/__main__.py:195
+msgid "The release_date %s is more than %s days in the future. Please check it is correct."
+msgstr "La release_date %s est à plus de %s jours dans le futur. Veuillez vérifier qu'elle est correcte."
+
+#: compatibility/__main__.py:199
+msgid "The release_date %s is more than %s years in the past. Please check it is correct."
+msgstr "La release_date %s remonte à plus de %s ans. Veuillez vérifier qu'elle est correcte."
+
+#: compatibility/__main__.py:256
+msgid "Parameter python_version_support must be a dictionary"
+msgstr "Le paramètre python_version_support doit être un dictionnaire"
+
+#: compatibility/__main__.py:566
+msgid "Parameter nag_over_update must be a dictionary"
+msgstr "Le paramètre nag_over_update doit être un dictionnaire"

{compatibility-2.1.0 → compatibility-2.2.0}/compatibility/locales/nl/LC_MESSAGES/compatibility.po

@@ -62,6 +62,10 @@ msgstr "De waarde voor sleutel min_version is onjuist."
 msgid "Value for key max_tested_version incorrect."
 msgstr "De waarde voor sleutel max_tested_version is onjuist."
 
+#: compatibility/__main__.py:326
+msgid "Value for key incompatible_versions must be a list."
+msgstr "De waarde voor sleutel incompatible_versions moet een lijst zijn."
+
 #: compatibility/__main__.py:294
 msgid "min_version (%(min)s) is higher than max_tested_version (%(max)s)."
 msgstr "min_version (%(min)s) is hoger dan max_tested_version (%(max)s)."
@@ -145,3 +149,19 @@ msgstr "nag_days_after_release mag niet negatief zijn."
 #: compatibility/__main__.py:546
 msgid "nag_in_hundred must be int between 0 and 100."
 msgstr "nag_in_hundred moet een geheel getal tussen 0 en 100 zijn."
+
+#: compatibility/__main__.py:195
+msgid "The release_date %s is more than %s days in the future. Please check it is correct."
+msgstr "De release_date %s ligt meer dan %s dagen in de toekomst. Controleer of deze juist is."
+
+#: compatibility/__main__.py:199
+msgid "The release_date %s is more than %s years in the past. Please check it is correct."
+msgstr "De release_date %s ligt meer dan %s jaar in het verleden. Controleer of deze juist is."
+
+#: compatibility/__main__.py:256
+msgid "Parameter python_version_support must be a dictionary"
+msgstr "Parameter python_version_support moet een dictionary zijn"
+
+#: compatibility/__main__.py:566
+msgid "Parameter nag_over_update must be a dictionary"
+msgstr "Parameter nag_over_update moet een dictionary zijn"

{compatibility-2.1.0 → compatibility-2.2.0}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "poetry.core.masonry.api"
 # [tool.poetry] below.
 [project]
 name = "compatibility"
-version = "2.1.0"
+version = "2.2.0"
 description = "A library that checks whether the running version of Python is compatible and tested. Remind the user to check for updates of the library."
 readme = "README.md"
 license = "Apache-2.0"
@@ -41,11 +41,11 @@ dependencies = []
 # same set so local and CI tooling stay aligned.
 [project.optional-dependencies]
 dev = [
-    "pytest>=9.0,<10",
-    "pytest-cov>=7.1,<8",
-    "mypy>=2.1,<3",
-    "ruff>=0.15,<0.16",
-    "coverage[toml]>=7.14,<8",
+    "pytest>=9.0.3,<10",
+    "pytest-cov>=7.1.0,<8",
+    "mypy>=2.1.0,<3",
+    "ruff>=0.15.16,<0.16",
+    "coverage[toml]>=7.14.1,<8",
 ]
 
 [project.urls]