DataExcept 0.4.2__tar.gz → 1.0.0__tar.gz

{dataexcept-0.4.2 → dataexcept-1.0.0}/CHANGELOG.md

@@ -7,6 +7,86 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.0.0] - 2026-08-25
+
+First stable release. The public API is frozen; see the
+[stability policy](https://diogoribeiro7.github.io/DataExcept/stability/)
+and the [migration guide](https://diogoribeiro7.github.io/DataExcept/migration/).
+
+### Added
+
+- A [migration guide](https://diogoribeiro7.github.io/DataExcept/migration/)
+  covering every rename between 0.1 and 1.0, with the one-line check for
+  whether any of it applies to you:
+  `python -W error::DeprecationWarning -m pytest` on 0.4.3.
+
+### Changed
+
+- **The public API is frozen.** The stability policy no longer carries a
+  pre-1.0 caveat: nothing public is renamed or removed outside a major release,
+  and anything that will be removed is deprecated first.
+
+### Removed
+
+- **`dataexcept.job_exceptions`**, deprecated since 0.1.0. Every name it
+  exported is available from `dataexcept.exceptions` and from the top-level
+  package, and they are the same class objects, so this is a change of import
+  line only.
+- **The four aliases introduced in 0.2.0**: `ConnectionError`,
+  `TimeoutError`, `datascience_exceptions.SerializationError` and
+  `pipeline_exceptions.FeatureEngineeringError`. Each has emitted a
+  `DeprecationWarning` naming 1.0.0 as its removal since 0.2.0.
+  `SerializationError` and `FeatureEngineeringError` remain exported — the
+  rename applied to the *duplicate* in each pair, and the original kept its
+  name.
+- The deprecation machinery itself (`dataexcept._deprecation`), which nothing
+  uses now.
+
+### Fixed
+
+- The release workflow's `verify-wheel` job installed a hand-written list of
+  test requirements, which went stale the moment `hypothesis` was added — the
+  suite could not even be collected against the built wheel. It now installs
+  the dev group from the lock, so the list cannot drift again. The job did its
+  job: it failed, and publishing was skipped.
+- `test_no_module_imports_tomllib_without_a_fallback` walked the whole tree, so
+  it picked up any virtualenv sitting in it. It now scans the project's own
+  source directories by name; site-packages is not ours to police.
+
+## [0.4.3] - 2026-08-25
+
+### Added
+
+- Property-based tests over the logging helpers and the CLI: generated context
+  values, including hostile ones, must never make `log_exception` raise; the
+  normalised context must be strict-JSON encodable; `log_and_raise` must
+  re-raise the *same* exception with its traceback intact; and the CLI must
+  raise nothing but `SystemExit` for any argument list.
+- **Property-based tests over the exception hierarchy**, using Hypothesis.
+  Generated text is fed to every class and four properties are asserted for
+  each: construction raises nothing but `TypeError`, a message built from real
+  input is non-empty, the exception survives a pickle round trip with its type,
+  message and cause intact, and a credential-bearing URL is never rendered.
+  Every constructor defect the reviews found — `MergeKeyError("id")` becoming
+  `['i', 'd']`, `is_number(True)`, and the one below — was in argument
+  handling and was found by inspection rather than by a test.
+
+### Fixed
+
+- **`log_exception` could raise, replacing the caller's error with its own.**
+  A context value whose `__repr__` raises propagated straight out of the
+  logging helper — so a helper called while handling a failure made the failure
+  worse. Nothing in context normalisation can raise now; a value that cannot be
+  described at all becomes `<unrepresentable TypeName>`.
+- **`NaN` and `Infinity` in a log context produced invalid JSON.**
+  `json.dumps` emits them bare, which a strict consumer downstream rejects.
+  They are stringified instead.
+- `ApiError`, `DatabaseConnectionError` and `WebhookError` raised
+  `AttributeError: 'object' object has no attribute 'decode'` when given a
+  non-string, because the redaction helpers passed whatever they were given to
+  `urlsplit`. That masked the caller's actual mistake with a message about
+  `.decode`. The helpers now return a non-string untouched.
+
 ## [0.4.2] - 2026-08-25
 
 ### Changed
@@ -429,7 +509,9 @@ First public release.
 - Published to PyPI via OIDC trusted publishing; no long-lived API token is
   involved in a release.
 
-[Unreleased]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.4.2...HEAD
+[Unreleased]: https://github.com/DiogoRibeiro7/DataExcept/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.4.3...v1.0.0
+[0.4.3]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.4.2...v0.4.3
 [0.4.2]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.4.1...v0.4.2
 [0.4.1]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/DiogoRibeiro7/DataExcept/compare/v0.3.0...v0.4.0

{dataexcept-0.4.2 → dataexcept-1.0.0}/CITATION.cff

@@ -1,7 +1,7 @@
 cff-version: 1.2.0
 message: "If you use this software, please cite it using the following metadata."
 title: "DataExcept"
-version: "0.4.2"
+version: "1.0.0"
 authors:
   - family-names: "Ribeiro"
     given-names: "Diogo"

{dataexcept-0.4.2 → dataexcept-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: DataExcept
-Version: 0.4.2
+Version: 1.0.0
 Summary: A Python package providing structured, easily-extendable custom exception types.
 License-Expression: MIT
 License-File: LICENSE
@@ -225,7 +225,7 @@ BiasDetectionError
 
 # Check version
 $ dataexcept --version
-dataexcept 0.4.2
+dataexcept 1.0.0
 ```
 
 ## 🎯 Use Cases
@@ -362,6 +362,7 @@ through [SECURITY.md](SECURITY.md), not the public issue tracker.
 - **Full Documentation**: [diogoribeiro7.github.io/DataExcept](https://diogoribeiro7.github.io/DataExcept/)
 - **API Reference**: [API Docs](https://diogoribeiro7.github.io/DataExcept/api/)
 - **API Stability**: [What is public and what may change](https://diogoribeiro7.github.io/DataExcept/stability/)
+- **Upgrading from 0.x**: [Migration guide](https://diogoribeiro7.github.io/DataExcept/migration/)
 - **Advanced Usage**: [Advanced Guide](https://diogoribeiro7.github.io/DataExcept/advanced_usage/)
 - **CLI Reference**: [CLI Guide](https://diogoribeiro7.github.io/DataExcept/cli/)
 - **Changelog**: [CHANGELOG.md](CHANGELOG.md)
@@ -375,7 +376,7 @@ If you use DataExcept in your research, please cite it:
   author = {Ribeiro, Diogo},
   title = {DataExcept: Structured Exception Handling for Data Science},
   url = {https://github.com/DiogoRibeiro7/DataExcept},
-  version = {0.4.2},
+  version = {1.0.0},
   year = {2026},
   publisher = {GitHub}
 }

{dataexcept-0.4.2 → dataexcept-1.0.0}/README.md

@@ -198,7 +198,7 @@ BiasDetectionError
 
 # Check version
 $ dataexcept --version
-dataexcept 0.4.2
+dataexcept 1.0.0
 ```
 
 ## 🎯 Use Cases
@@ -335,6 +335,7 @@ through [SECURITY.md](SECURITY.md), not the public issue tracker.
 - **Full Documentation**: [diogoribeiro7.github.io/DataExcept](https://diogoribeiro7.github.io/DataExcept/)
 - **API Reference**: [API Docs](https://diogoribeiro7.github.io/DataExcept/api/)
 - **API Stability**: [What is public and what may change](https://diogoribeiro7.github.io/DataExcept/stability/)
+- **Upgrading from 0.x**: [Migration guide](https://diogoribeiro7.github.io/DataExcept/migration/)
 - **Advanced Usage**: [Advanced Guide](https://diogoribeiro7.github.io/DataExcept/advanced_usage/)
 - **CLI Reference**: [CLI Guide](https://diogoribeiro7.github.io/DataExcept/cli/)
 - **Changelog**: [CHANGELOG.md](CHANGELOG.md)
@@ -348,7 +349,7 @@ If you use DataExcept in your research, please cite it:
   author = {Ribeiro, Diogo},
   title = {DataExcept: Structured Exception Handling for Data Science},
   url = {https://github.com/DiogoRibeiro7/DataExcept},
-  version = {0.4.2},
+  version = {1.0.0},
   year = {2026},
   publisher = {GitHub}
 }

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/__init__.py

@@ -4,8 +4,8 @@ Every exception the package defines is importable straight from here::
 
     from dataexcept import ValidationError, ModelTrainingError
 
-They all derive from :class:`DataExceptError`, so one clause catches anything
-this package raises::
+They all derive from :class:`DataExceptError`, so one clause catches every
+operational exception this package raises::
 
     except DataExceptError:
         ...
@@ -22,8 +22,7 @@ try:  # Python >=3.11
 except ModuleNotFoundError:  # pragma: no cover - fallback for Python <3.11
     import tomli as tomllib  # type: ignore
 
-from importlib import import_module, metadata
-from typing import Any
+from importlib import metadata
 
 from . import (  # noqa: F401
     database_exceptions,
@@ -37,7 +36,6 @@ from . import (  # noqa: F401
     pipeline_exceptions,
     security_exceptions,
 )
-from ._deprecation import resolve_deprecated
 from .base import DataExceptError, UnpicklableCause, UnpicklableValue
 from .database_exceptions import (
     DatabaseConnectionError,
@@ -274,9 +272,6 @@ __all__ = [
     "log_exception",
     "log_then_raise",
     # Domain modules, for callers who prefer a qualified import.
-    # job_exceptions is deliberately absent: it is deprecated, and listing it
-    # makes `from dataexcept import *` emit a DeprecationWarning, which turns
-    # into an error under -W error::DeprecationWarning. It stays importable.
     "database_exceptions",
     "dataengineering_exceptions",
     "datascience_exceptions",
@@ -295,19 +290,3 @@ except metadata.PackageNotFoundError:  # pragma: no cover - fallback during dev
     _root = Path(__file__).resolve().parents[1]
     with open(_root / "pyproject.toml", "rb") as _f:
         __version__ = tomllib.load(_f)["project"]["version"]
-
-
-#: Renamed in 0.2.0 because they shadowed Python builtins without inheriting
-#: from them. Each alias is the same class object as its replacement.
-_DEPRECATED_ALIASES = {
-    "ConnectionError": ServiceConnectionError,
-    "TimeoutError": OperationTimeoutError,
-}
-
-
-def __getattr__(name: str) -> Any:
-    if name == "job_exceptions":
-        module = import_module("dataexcept.job_exceptions")
-        globals()[name] = module
-        return module
-    return resolve_deprecated(__name__, _DEPRECATED_ALIASES, name)

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/__main__.py

@@ -12,14 +12,9 @@ from typing import Iterable
 from . import __path__ as _PKG_PATH
 from . import __version__
 
-#: Deprecated compatibility shims. Listing these would advertise names that are
-#: scheduled for removal, and importing them emits a DeprecationWarning at
-#: anyone who merely wanted to see what the package offers.
-_DEPRECATED_MODULES = frozenset({"dataexcept.job_exceptions"})
-
 
 def _iter_exception_modules() -> Iterable[ModuleType]:
-    """Yield every non-deprecated submodule that explicitly defines ``__all__``."""
+    """Yield every submodule that explicitly defines ``__all__``."""
     allowed_suffixes = ("exceptions", "_exceptions")
     # dataexcept.base holds DataExceptError, the root of the hierarchy, and
     # does not match the suffix rule.
@@ -33,8 +28,6 @@ def _iter_exception_modules() -> Iterable[ModuleType]:
             and module_info.name not in always_include
         ):
             continue
-        if module_info.name in _DEPRECATED_MODULES:
-            continue
         try:
             module = import_module(module_info.name)
         except ImportError as exc:  # pragma: no cover - defensive guard

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/datascience_exceptions/__init__.py

@@ -1,8 +1,5 @@
 """Custom exceptions for data science workflows."""
 
-from typing import Any
-
-from .._deprecation import resolve_deprecated
 from .base import DataScienceError
 from .ingestion import (
     DataAugmentationError,
@@ -86,11 +83,3 @@ __all__ = [
     "FeatureScalingError",
     "ModelCompatibilityError",
 ]
-
-#: Renamed in 0.2.0: this named the same thing as
-#: ``dataexcept.exceptions.SerializationError`` while being a different class.
-_DEPRECATED_ALIASES = {"SerializationError": ModelSerializationError}
-
-
-def __getattr__(name: str) -> Any:
-    return resolve_deprecated(__name__, _DEPRECATED_ALIASES, name)

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/exceptions/__init__.py

@@ -1,7 +1,5 @@
 # __init__.py
-from typing import Any
 
-from .._deprecation import resolve_deprecated
 from .authentication import AuthenticationError, AuthorizationError
 from .base import JobError
 from .configuration import ConfigurationError
@@ -37,14 +35,3 @@ __all__ = [
     "WebhookError",
     "JobCancellationError",
 ]
-
-#: Renamed in 0.2.0 because they shadowed Python builtins without inheriting
-#: from them. The alias is the same class object, so ``except`` keeps working.
-_DEPRECATED_ALIASES = {
-    "ConnectionError": ServiceConnectionError,
-    "TimeoutError": OperationTimeoutError,
-}
-
-
-def __getattr__(name: str) -> Any:
-    return resolve_deprecated(__name__, _DEPRECATED_ALIASES, name)

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/logging_helpers.py

@@ -12,6 +12,9 @@ from .redaction import redact_urls_in_text
 
 Context = Mapping[str, Any]
 
+#: Sentinel: the value could not be coerced into anything JSON will take.
+_UNCOERCIBLE = object()
+
 __all__ = [
     "Context",
     "log_and_raise",
@@ -20,15 +23,61 @@ __all__ = [
 ]
 
 
-def _normalize_context_value(value: Any) -> Any:
+def _is_json_safe(value: Any) -> bool:
+    """True if a strict JSON encoder will accept *value* as it stands.
+
+    ``allow_nan=False`` because ``json.dumps`` otherwise emits bare ``NaN`` and
+    ``Infinity``, which are not valid JSON and will be rejected downstream.
+    """
     try:
-        json.dumps(value)
-        return value
-    except TypeError:
+        json.dumps(value, allow_nan=False)
+    except (TypeError, ValueError):
+        return False
+    return True
+
+
+def _coerced(value: Any) -> Any:
+    """Round-trip *value* through JSON, stringifying whatever will not encode.
+
+    Returns ``_UNCOERCIBLE`` rather than raising: this runs while the caller is
+    already handling a failure.
+    """
+    try:
+        return json.loads(json.dumps(value, default=str, allow_nan=False))
+    except Exception:
+        return _UNCOERCIBLE
+
+
+def _described(value: Any) -> str:
+    """Describe *value* without letting it raise.
+
+    An object may define a ``__repr__`` that raises. Naming the type is the
+    most that can be said without invoking anything the object controls.
+    """
+    try:
+        return repr(value)
+    except Exception:
         try:
-            return json.loads(json.dumps(value, default=str))
-        except Exception:  # pragma: no cover - extremely defensive
-            return repr(value)
+            return f"<unrepresentable {type(value).__name__}>"
+        except Exception:  # pragma: no cover - a type with a hostile __name__
+            return "<unrepresentable>"
+
+
+def _normalize_context_value(value: Any) -> Any:
+    """Return *value* in a form a strict JSON log encoder will accept.
+
+    Nothing here may raise. This runs while the caller is already handling a
+    failure, and an exception escaping would replace their error with one about
+    logging it -- so even a hostile ``__repr__`` has to be survivable.
+    """
+    if _is_json_safe(value):
+        return value
+
+    coerced = _coerced(value)
+    if coerced is not _UNCOERCIBLE:
+        return coerced
+
+    return _described(value)
 
 
 def _build_extra(context: Context | None) -> dict[str, Any] | None:

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/pipeline_exceptions.py

@@ -4,7 +4,6 @@ from __future__ import annotations
 
 from typing import Any, Optional
 
-from ._deprecation import resolve_deprecated
 from .base import DataExceptError
 from .redaction import redact_if_url, redact_url
 
@@ -210,12 +209,3 @@ __all__ = [
     "TypeCheckError",
     "DataFetchError",
 ]
-
-#: Renamed in 0.2.0: this named the same thing as
-#: ``dataexcept.datascience_exceptions.FeatureEngineeringError`` while being a
-#: different class, so catching one silently missed the other.
-_DEPRECATED_ALIASES = {"FeatureEngineeringError": FeaturePreprocessingError}
-
-
-def __getattr__(name: str) -> Any:
-    return resolve_deprecated(__name__, _DEPRECATED_ALIASES, name)

{dataexcept-0.4.2 → dataexcept-1.0.0}/dataexcept/redaction.py

@@ -170,7 +170,10 @@ def redact_url(url: Optional[str], *, keep_path: bool = True) -> Optional[str]:
     incoming webhook URL is the common case -- Slack, Discord and others put
     the secret in the path, so preserving it would defeat the point.
     """
-    if not url:
+    if not url or not isinstance(url, str):
+        # Anything that is not a string is handed back untouched. urlsplit
+        # would raise AttributeError from inside urllib, masking whatever the
+        # caller's real mistake was with a message about `.decode`.
         return url
 
     try:

{dataexcept-0.4.2 → dataexcept-1.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "DataExcept"
-version = "0.4.2"
+version = "1.0.0"
 description = "A Python package providing structured, easily-extendable custom exception types."
 readme = "README.md"
 license = "MIT"
@@ -43,6 +43,7 @@ include = [
 black = "*"
 coverage = "*"
 flake8 = "*"
+hypothesis = "*"
 isort = "*"
 mypy = "*"
 pre-commit = "*"

dataexcept-0.4.2/dataexcept/_deprecation.py

@@ -1,38 +0,0 @@
-"""Internal support for names that have been renamed.
-
-A rename keeps the old name working as an alias bound to the *same* class
-object, so an existing ``except OldName:`` keeps catching exactly what it
-caught before -- the alias is not a separate class.
-
-Access goes through a PEP 562 module ``__getattr__`` rather than a plain
-``OldName = NewName`` assignment, because an assignment cannot warn. This is
-private; see the stability policy for the user-facing contract.
-"""
-
-from __future__ import annotations
-
-import warnings
-from typing import Any, Mapping
-
-#: Version in which every currently deprecated alias is removed.
-REMOVED_IN = "1.0.0"
-
-
-def resolve_deprecated(module: str, aliases: Mapping[str, Any], name: str) -> Any:
-    """Return the target of the deprecated *name*, warning first.
-
-    Raises ``AttributeError`` for anything not in *aliases*, so normal
-    attribute lookup on the module keeps behaving normally.
-    """
-    try:
-        target = aliases[name]
-    except KeyError:
-        raise AttributeError(f"module {module!r} has no attribute {name!r}") from None
-    warnings.warn(
-        f"{module}.{name} is deprecated and will be removed in {REMOVED_IN}; "
-        f"use {target.__name__} instead",
-        DeprecationWarning,
-        # resolve_deprecated -> __getattr__ -> the caller we want to blame.
-        stacklevel=3,
-    )
-    return target

dataexcept-0.4.2/dataexcept/job_exceptions.py

@@ -1,71 +0,0 @@
-"""Backward compatible job-related exceptions.
-
-.. deprecated:: 0.1.0
-    Use :mod:`dataexcept.exceptions` instead. This module is scheduled for
-    removal in 1.0.0; see the stability policy in the documentation.
-
-This module re-exports the core job exceptions defined in
-:mod:`dataexcept.exceptions`. Importing it emits a :class:`DeprecationWarning`.
-Every name it exports is available from :mod:`dataexcept.exceptions` and from
-the top-level :mod:`dataexcept` package, so the migration is a change of import
-line only -- the classes are identical objects, not replacements, so existing
-``except`` clauses keep working during the transition.
-"""
-
-from __future__ import annotations
-
-import warnings
-
-from .exceptions import (
-    AuthenticationError,
-    AuthorizationError,
-    ConfigurationError,
-    CronExpressionError,
-    DependencyError,
-    DeserializationError,
-    EmailError,
-    JobCancellationError,
-    JobError,
-    NotificationError,
-    OperationTimeoutError,
-    ParsingError,
-    ResourceNotFoundError,
-    ScheduleConflictError,
-    SerializationError,
-    ServiceConnectionError,
-    ValidationError,
-    WebhookError,
-)
-
-# This module is itself deprecated, so it binds the pre-0.2.0 names directly
-# rather than going through the alias machinery and warning a second time.
-ConnectionError = ServiceConnectionError
-TimeoutError = OperationTimeoutError
-
-__all__ = [
-    "JobError",
-    "ValidationError",
-    "ConfigurationError",
-    "ConnectionError",
-    "TimeoutError",
-    "ResourceNotFoundError",
-    "DependencyError",
-    "AuthenticationError",
-    "AuthorizationError",
-    "ParsingError",
-    "SerializationError",
-    "DeserializationError",
-    "ScheduleConflictError",
-    "CronExpressionError",
-    "NotificationError",
-    "EmailError",
-    "WebhookError",
-    "JobCancellationError",
-]
-
-warnings.warn(
-    "dataexcept.job_exceptions is deprecated and will be removed in 1.0.0; "
-    "use dataexcept.exceptions instead",
-    DeprecationWarning,
-    stacklevel=2,
-)