python-sendparcel 0.3.1__tar.gz → 0.3.2__tar.gz

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.3.2 (2026-07-09)
+
+- `DummyProvider.cancel_shipment` returns a structured `CancelOutcome`
+  (configurable via `cancel_success` / `cancel_reason` settings) instead of a
+  bare bool — aligning core's own provider with the 0.3.1 cancel trait that
+  `ShipmentFlow.cancel_shipment` already requires.
+- `ShipmentFlow`: typed returns for `cancel_shipment` / `search_points`
+  (mypy no-any-return).
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/),

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-sendparcel
-Version: 0.3.1
+Version: 0.3.2
 Summary: Framework-agnostic parcel shipping core for Python.
 Project-URL: Homepage, https://github.com/python-sendparcel/python-sendparcel
 Project-URL: Repository, https://github.com/python-sendparcel/python-sendparcel

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "python-sendparcel"
-version = "0.3.1"
+version = "0.3.2"
 description = "Framework-agnostic parcel shipping core for Python."
 readme = "README.md"
 license = { text = "MIT" }

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/src/sendparcel/flow.py

@@ -3,7 +3,7 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Any
+from typing import Any, cast
 
 import httpx
 
@@ -227,7 +227,10 @@ class ShipmentFlow:
         - ``AUTH_ERROR`` → re-raises provider auth error.
         """
         provider = self._get_provider(shipment)
-        outcome = await self._call_provider(provider.cancel_shipment(**kwargs))
+        outcome = cast(
+            "CancelOutcome",
+            await self._call_provider(provider.cancel_shipment(**kwargs)),
+        )
         if outcome.get("reason") == CancelReason.TRANSIENT_ERROR:
             raise CommunicationError(
                 outcome.get("detail") or "Cancel failed with transient error",
@@ -281,15 +284,18 @@ class ShipmentFlow:
             provider_class,
             provider_config,
         )
-        return await self._call_provider(
-            provider.search_points(
-                query=query,
-                near=near,
-                radius_m=radius_m,
-                point_type=point_type,
-                limit=limit,
-                **kwargs,
-            )
+        return cast(
+            "list[PickupPoint]",
+            await self._call_provider(
+                provider.search_points(
+                    query=query,
+                    near=near,
+                    radius_m=radius_m,
+                    point_type=point_type,
+                    limit=limit,
+                    **kwargs,
+                )
+            ),
         )
 
     def _get_provider(self, shipment: Shipment) -> BaseProvider:

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/src/sendparcel/providers/dummy.py

@@ -12,6 +12,8 @@ from sendparcel.provider import BaseProvider
 from sendparcel.types import (
     AddressInfo,
     CallbackContext,
+    CancelOutcome,
+    CancelReason,
     LabelInfo,
     ParcelInfo,
     ShipmentCreateResult,
@@ -78,6 +80,23 @@ class DummyProvider(BaseProvider):
             status=self.get_setting("status_override", self.shipment.status)
         )
 
-    async def cancel_shipment(self, **kwargs: Any) -> bool:
+    async def cancel_shipment(self, **kwargs: Any) -> CancelOutcome:
+        """Cancel with a configurable structured outcome.
+
+        Settings: ``cancel_success`` (bool, default True) and
+        ``cancel_reason`` (a :class:`CancelReason` value used when the
+        cancel is configured to fail; defaults to ``not_cancellable``).
+        """
         await self._simulate_latency()
-        return bool(self.get_setting("cancel_success", True))
+        if bool(self.get_setting("cancel_success", True)):
+            return CancelOutcome(
+                cancelled=True, reason=CancelReason.CANCELLED, retryable=False
+            )
+        reason = CancelReason(
+            self.get_setting("cancel_reason", CancelReason.NOT_CANCELLABLE)
+        )
+        return CancelOutcome(
+            cancelled=False,
+            reason=reason,
+            retryable=reason == CancelReason.TRANSIENT_ERROR,
+        )

{python_sendparcel-0.3.1 → python_sendparcel-0.3.2}/tests/test_builtin_dummy_provider.py

@@ -8,7 +8,12 @@ import pytest
 from sendparcel.enums import ConfirmationMethod
 from sendparcel.exceptions import InvalidCallbackError
 from sendparcel.providers.dummy import DummyProvider
-from sendparcel.types import AddressInfo, CallbackContext, ParcelInfo
+from sendparcel.types import (
+    AddressInfo,
+    CallbackContext,
+    CancelReason,
+    ParcelInfo,
+)
 
 _SENDER = AddressInfo(
     name="Test Sender",
@@ -166,19 +171,38 @@ class TestFetchShipmentStatus:
 
 class TestCancelShipment:
     @pytest.mark.asyncio
-    async def test_cancel_returns_true_by_default(self) -> None:
+    async def test_cancel_returns_outcome_by_default(self) -> None:
         provider = DummyProvider(DummyShipment(), config={})
 
-        result = await provider.cancel_shipment()
+        outcome = await provider.cancel_shipment()
 
-        assert result is True
+        assert outcome["cancelled"] is True
+        assert outcome["reason"] == CancelReason.CANCELLED
+        assert outcome["retryable"] is False
 
     @pytest.mark.asyncio
-    async def test_cancel_can_be_configured_to_fail(self) -> None:
+    async def test_cancel_can_be_configured_to_refuse(self) -> None:
         provider = DummyProvider(
             DummyShipment(), config={"cancel_success": False}
         )
 
-        result = await provider.cancel_shipment()
+        outcome = await provider.cancel_shipment()
+
+        assert outcome["cancelled"] is False
+        assert outcome["reason"] == CancelReason.NOT_CANCELLABLE
+        assert outcome["retryable"] is False
+
+    @pytest.mark.asyncio
+    async def test_cancel_reason_is_configurable(self) -> None:
+        provider = DummyProvider(
+            DummyShipment(),
+            config={
+                "cancel_success": False,
+                "cancel_reason": "refused_in_transit",
+            },
+        )
+
+        outcome = await provider.cancel_shipment()
 
-        assert result is False
+        assert outcome["cancelled"] is False
+        assert outcome["reason"] == CancelReason.REFUSED_IN_TRANSIT