otdf-python 0.4.0__tar.gz → 0.4.1__tar.gz

{otdf_python-0.4.0 → otdf_python-0.4.1}/.pre-commit-config.yaml

@@ -34,7 +34,7 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.14.5
+    rev: v0.14.8
     hooks:
       # Run the linter.
       - id: ruff-check

otdf_python-0.4.1/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+    ".": "0.4.1"
+}

{otdf_python-0.4.0 → otdf_python-0.4.1}/.vscode/extensions.json

@@ -1,5 +1,5 @@
 {
     "recommendations": [
-        "golang.go"
+        "charliermarsh.ruff"
     ]
 }

{otdf_python-0.4.0 → otdf_python-0.4.1}/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.4.1](https://github.com/b-long/opentdf-python-sdk/compare/otdf-python-v0.4.0...otdf-python-v0.4.1) (2025-12-09)
+
+
+### Bug Fixes
+
+* preserve exception chain ([#119](https://github.com/b-long/opentdf-python-sdk/issues/119)) ([09984b8](https://github.com/b-long/opentdf-python-sdk/commit/09984b843b369a6d2c76dc8a81d6315f195ea773))
+
 ## [0.4.0](https://github.com/b-long/opentdf-python-sdk/compare/otdf-python-v0.3.5...otdf-python-v0.4.0) (2025-11-20)
 
 

{otdf_python-0.4.0 → otdf_python-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: otdf-python
-Version: 0.4.0
+Version: 0.4.1
 Summary: Unofficial OpenTDF SDK for Python
 Project-URL: Homepage, https://github.com/b-long/opentdf-python-sdk
 Project-URL: Repository, https://github.com/b-long/opentdf-python-sdk

{otdf_python-0.4.0 → otdf_python-0.4.1}/conftest.py

@@ -1,5 +1,4 @@
-"""
-Pytest configuration and fixtures for the OpenTDF Python SDK tests.
+"""Pytest configuration and fixtures for the OpenTDF Python SDK tests.
 
 This module contains pytest hooks and fixtures that will be automatically
 loaded by pytest when running tests.
@@ -14,13 +13,13 @@ from tests.server_logs import log_server_logs_on_failure
 
 @pytest.fixture(scope="session")
 def project_root(request) -> Path:
+    """Get project root directory."""
     return request.config.rootpath  # Project root
 
 
 @pytest.hookimpl(tryfirst=True, hookwrapper=True)
 def pytest_runtest_makereport(item, call):
-    """
-    Hook that runs after each test phase (setup, call, teardown).
+    """Collect server logs when test fails after each test phase.
 
     This hook automatically collects server logs when a test fails.
     """
@@ -53,8 +52,7 @@ def pytest_runtest_makereport(item, call):
 
 @pytest.fixture
 def collect_server_logs():
-    """
-    Fixture that provides a function to manually collect server logs.
+    """Fixture that provides a function to manually collect server logs.
 
     Usage:
         def test_something(collect_server_logs):

{otdf_python-0.4.0 → otdf_python-0.4.1}/otdf-python-proto/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "otdf-python-proto"
-version = "0.4.0"
+version = "0.4.1"
 description = "Generated protobuf files for OpenTDF Python SDK"
 readme = "README.md"
 authors = [

{otdf_python-0.4.0 → otdf_python-0.4.1}/otdf-python-proto/scripts/generate_connect_proto.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
-"""
-Enhanced script to generate Python Connect RPC clients from .proto definitions.
+"""Enhanced script to generate Python Connect RPC clients from .proto definitions.
 
 This script:
 1. Downloads the latest proto files from OpenTDF platform
@@ -200,8 +199,7 @@ def create_init_files(generated_dir: Path) -> None:
 
 
 def _fix_ignore_if_default_value(proto_files_dir):
-    """
-    TODO: Fix buf validation: Updated the proto files to use the correct enum value:
+    """TODO: Fix buf validation: Updated the proto files to use the correct enum value:
 
     Changed IGNORE_IF_DEFAULT_VALUE → IGNORE_IF_ZERO_VALUE in:
         attributes.proto

{otdf_python-0.4.0 → otdf_python-0.4.1}/otdf-python-proto/uv.lock

@@ -601,7 +601,7 @@ wheels = [
 
 [[package]]
 name = "otdf-python-proto"
-version = "0.4.0"
+version = "0.4.1"
 source = { editable = "." }
 dependencies = [
     { name = "connect-python", extra = ["compiler"] },

{otdf_python-0.4.0 → otdf_python-0.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "otdf-python"
-version = "0.4.0"
+version = "0.4.1"
 description = "Unofficial OpenTDF SDK for Python"
 readme = "README.md"
 authors = [
@@ -72,6 +72,7 @@ norecursedirs = ["otdf-python-proto"]
 
 [tool.ruff]
 line-length = 88
+target-version = "py310"
 
 # See https://docs.astral.sh/ruff/rules/
 # for rule information.
@@ -80,28 +81,33 @@ lint.ignore = [
     "E501",
 ]
 lint.select = [
-    # pycodestyle checks.
-    "E",
-    "W",
-    # pyflakes checks.
-    "F",
-    # flake8-bugbear checks.
-    "B0",
-    # flake8-comprehensions checks.
-    "C4",
-    # McCabe complexity
-    "C90",
-    # isort
-    "I",
-    # Performance-related rules
-    "PERF",      # Ruff's performance rules
-    "PTH",       # pathlib (path handling)
-    # Additional useful rules
-    "UP",        # pyupgrade (modern Python features)
-    "SIM",       # flake8-simplify (simplifications)
-    "RUF",       # Ruff-specific rules
-    "FURB",      # refurb (FURB)
-    "PT018",     # flake8-pytest-style (pytest style)
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "C90",    # McCabe complexity
+    "D",      # pydocstyle
+    "DOC",    # pydoclint
+    "E",      # pycodestyle errors
+    "F",      # pyflakes
+    "FURB",   # refurb
+    "I",      # isort
+    "PERF",   # performance
+    "PT018",  # pytest style
+    "PTH",    # pathlib
+    "Q",      # flake8-quotes
+    "RUF",    # ruff-specific
+    "SIM",    # flake8-simplify
+    "UP",     # pyupgrade
+    "W",      # pycodestyle warnings
 ]
 # Ignore generated files
 extend-exclude = ["otdf-python-proto/src/"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["D100", "D101", "D102", "D103", "D107", "D400", "D401", "D415"]
+"otdf-python-proto/**" = ["D"]  # Ignore all D (docstring) rules for generated proto files
+
+# TODO: Remaining work - 4 buckets to fix (140 errors remaining):
+# Bucket #1: D102 (missing method docstrings) - 98 errors
+# Bucket #2: D105 (missing magic method docstrings) - 23 errors
+# Bucket #3: D205 (blank line formatting), D103, D417, D104 - 19 errors
+"src/**" = ["D102", "D105", "D205"]

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/__init__.py

@@ -1,5 +1,4 @@
-"""
-OpenTDF Python SDK
+"""OpenTDF Python SDK.
 
 A Python implementation of the OpenTDF SDK for working with Trusted Data Format (TDF) files.
 Provides both programmatic APIs and command-line interface for encryption and decryption.

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/__main__.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
-"""
-Main entry point for running otdf_python as a module.
+"""Main entry point for running otdf_python as a module.
 
 This allows the package to be run with `python -m otdf_python` and properly
 handles the CLI interface without import conflicts.

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/address_normalizer.py

@@ -1,6 +1,4 @@
-"""
-Address normalization utilities for OpenTDF.
-"""
+"""Address normalization utilities for OpenTDF."""
 
 import logging
 import re
@@ -12,8 +10,7 @@ logger = logging.getLogger(__name__)
 
 
 def normalize_address(url_string: str, use_plaintext: bool) -> str:
-    """
-    Normalize a URL address to ensure it has the correct scheme and port.
+    """Normalize a URL address to ensure it has the correct scheme and port.
 
     Args:
         url_string: The URL string to normalize
@@ -24,6 +21,7 @@ def normalize_address(url_string: str, use_plaintext: bool) -> str:
 
     Raises:
         SDKException: If there's an error parsing or creating the URL
+
     """
     scheme = "http" if use_plaintext else "https"
 
@@ -34,8 +32,8 @@ def normalize_address(url_string: str, use_plaintext: bool) -> str:
         port_str = host_port_pattern.group(2)
         try:
             port = int(port_str)
-        except ValueError:
-            raise SDKException(f"Invalid port in URL [{url_string}]")
+        except ValueError as err:
+            raise SDKException(f"Invalid port in URL [{url_string}]") from err
 
         normalized_url = f"{scheme}://{host}:{port}"
         logger.debug(f"normalized url [{url_string}] to [{normalized_url}]")
@@ -66,8 +64,8 @@ def normalize_address(url_string: str, use_plaintext: bool) -> str:
             _, port_str = parsed_url.netloc.split(":", 1)
             try:
                 port = int(port_str)
-            except ValueError:
-                raise SDKException(f"Invalid port in URL [{url_string}]")
+            except ValueError as err:
+                raise SDKException(f"Invalid port in URL [{url_string}]") from err
 
         # If no port was found or extracted, use the default
         if port is None:
@@ -81,4 +79,4 @@ def normalize_address(url_string: str, use_plaintext: bool) -> str:
     except Exception as e:
         if isinstance(e, SDKException):
             raise e
-        raise SDKException(f"Error normalizing URL [{url_string}]", e)
+        raise SDKException(f"Error normalizing URL [{url_string}]: {e}") from e

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/aesgcm.py

@@ -1,13 +1,18 @@
+"""AES-GCM encryption and decryption functionality."""
+
 import os
 
 from cryptography.hazmat.primitives.ciphers.aead import AESGCM
 
 
 class AesGcm:
+    """AES-GCM encryption and decryption operations."""
+
     GCM_NONCE_LENGTH = 12
     GCM_TAG_LENGTH = 16
 
     def __init__(self, key: bytes):
+        """Initialize AES-GCM cipher with key."""
         if not key or len(key) not in (16, 24, 32):
             raise ValueError("Invalid key size for GCM encryption")
         self.key = key
@@ -17,7 +22,10 @@ class AesGcm:
         return self.key
 
     class Encrypted:
+        """Encrypted data with initialization vector and ciphertext."""
+
         def __init__(self, iv: bytes, ciphertext: bytes):
+            """Initialize encrypted data."""
             self.iv = iv
             self.ciphertext = ciphertext
 

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/assertion_config.py

@@ -1,8 +1,12 @@
+"""Assertion configuration for TDF."""
+
 from enum import Enum, auto
 from typing import Any
 
 
 class Type(Enum):
+    """Assertion type enumeration."""
+
     HANDLING_ASSERTION = "handling"
     BASE_ASSERTION = "base"
 
@@ -11,6 +15,8 @@ class Type(Enum):
 
 
 class Scope(Enum):
+    """Assertion scope enumeration."""
+
     TRUSTED_DATA_OBJ = "tdo"
     PAYLOAD = "payload"
 
@@ -19,12 +25,16 @@ class Scope(Enum):
 
 
 class AssertionKeyAlg(Enum):
+    """Assertion key algorithm enumeration."""
+
     RS256 = auto()
     HS256 = auto()
     NOT_DEFINED = auto()
 
 
 class AppliesToState(Enum):
+    """Assertion applies-to state enumeration."""
+
     ENCRYPTED = "encrypted"
     UNENCRYPTED = "unencrypted"
 
@@ -33,6 +43,8 @@ class AppliesToState(Enum):
 
 
 class BindingMethod(Enum):
+    """Assertion binding method enumeration."""
+
     JWS = "jws"
 
     def __str__(self):
@@ -40,7 +52,10 @@ class BindingMethod(Enum):
 
 
 class AssertionKey:
+    """Assertion signing key configuration."""
+
     def __init__(self, alg: AssertionKeyAlg, key: Any):
+        """Initialize assertion key."""
         self.alg = alg
         self.key = key
 
@@ -49,7 +64,10 @@ class AssertionKey:
 
 
 class Statement:
+    """Assertion statement with format, schema, and value."""
+
     def __init__(self, format: str, schema: str, value: str):
+        """Initialize assertion statement."""
         self.format = format
         self.schema = schema
         self.value = value
@@ -67,6 +85,8 @@ class Statement:
 
 
 class AssertionConfig:
+    """TDF assertion configuration."""
+
     def __init__(
         self,
         id: str,
@@ -76,6 +96,7 @@ class AssertionConfig:
         statement: Statement,
         signing_key: AssertionKey | None = None,
     ):
+        """Initialize assertion configuration."""
         self.id = id
         self.type = type
         self.scope = scope

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/asym_crypto.py

@@ -1,6 +1,4 @@
-"""
-Asymmetric encryption and decryption utilities for RSA keys in PEM format.
-"""
+"""Asymmetric encryption and decryption utilities for RSA keys in PEM format."""
 
 import base64
 import re
@@ -14,8 +12,7 @@ from .sdk_exceptions import SDKException
 
 
 class AsymDecryption:
-    """
-    Provides functionality for asymmetric decryption using an RSA private key.
+    """Provides functionality for asymmetric decryption using an RSA private key.
 
     Supports both PEM string and key object initialization for flexibility.
     """
@@ -25,8 +22,7 @@ class AsymDecryption:
     PRIVATE_KEY_FOOTER = "-----END PRIVATE KEY-----"
 
     def __init__(self, private_key_pem: str | None = None, private_key_obj=None):
-        """
-        Initialize with either a PEM string or a key object.
+        """Initialize with either a PEM string or a key object.
 
         Args:
             private_key_pem: Private key in PEM format (with or without headers)
@@ -34,6 +30,7 @@ class AsymDecryption:
 
         Raises:
             SDKException: If key loading fails
+
         """
         if private_key_obj is not None:
             self.private_key = private_key_obj
@@ -60,13 +57,12 @@ class AsymDecryption:
                         decoded, password=None, backend=default_backend()
                     )
             except Exception as e:
-                raise SDKException(f"Failed to load private key: {e}")
+                raise SDKException(f"Failed to load private key: {e}") from e
         else:
             self.private_key = None
 
     def decrypt(self, data: bytes) -> bytes:
-        """
-        Decrypt data using RSA OAEP with SHA-1.
+        """Decrypt data using RSA OAEP with SHA-1.
 
         Args:
             data: Encrypted bytes to decrypt
@@ -76,6 +72,7 @@ class AsymDecryption:
 
         Raises:
             SDKException: If decryption fails or key is not set
+
         """
         if self.private_key is None:
             raise SDKException("Failed to decrypt, private key is empty")
@@ -89,12 +86,11 @@ class AsymDecryption:
                 ),
             )
         except Exception as e:
-            raise SDKException(f"Error performing decryption: {e}")
+            raise SDKException(f"Error performing decryption: {e}") from e
 
 
 class AsymEncryption:
-    """
-    Provides functionality for asymmetric encryption using an RSA public key or certificate in PEM format.
+    """Provides functionality for asymmetric encryption using an RSA public key or certificate in PEM format.
 
     Supports PEM public keys, X.509 certificates, and pre-loaded key objects.
     Also handles base64-encoded keys without PEM headers.
@@ -105,8 +101,7 @@ class AsymEncryption:
     CIPHER_TRANSFORM = "RSA/ECB/OAEPWithSHA-1AndMGF1Padding"
 
     def __init__(self, public_key_pem: str | None = None, public_key_obj=None):
-        """
-        Initialize with either a PEM string or a key object.
+        """Initialize with either a PEM string or a key object.
 
         Args:
             public_key_pem: Public key in PEM format, X.509 certificate, or base64 string
@@ -114,6 +109,7 @@ class AsymEncryption:
 
         Raises:
             SDKException: If key loading fails or key is not RSA
+
         """
         if public_key_obj is not None:
             self.public_key = public_key_obj
@@ -141,7 +137,7 @@ class AsymEncryption:
                             decoded, backend=default_backend()
                         )
             except Exception as e:
-                raise SDKException(f"Failed to load public key: {e}")
+                raise SDKException(f"Failed to load public key: {e}") from e
         else:
             self.public_key = None
 
@@ -152,8 +148,7 @@ class AsymEncryption:
             raise SDKException("Not an RSA PEM formatted public key")
 
     def encrypt(self, data: bytes) -> bytes:
-        """
-        Encrypt data using RSA OAEP with SHA-1.
+        """Encrypt data using RSA OAEP with SHA-1.
 
         Args:
             data: Plaintext bytes to encrypt
@@ -163,6 +158,7 @@ class AsymEncryption:
 
         Raises:
             SDKException: If encryption fails or key is not set
+
         """
         if self.public_key is None:
             raise SDKException("Failed to encrypt, public key is empty")
@@ -176,17 +172,17 @@ class AsymEncryption:
                 ),
             )
         except Exception as e:
-            raise SDKException(f"Error performing encryption: {e}")
+            raise SDKException(f"Error performing encryption: {e}") from e
 
     def public_key_in_pem_format(self) -> str:
-        """
-        Export the public key to PEM format.
+        """Export the public key to PEM format.
 
         Returns:
             Public key as PEM-encoded string
 
         Raises:
             SDKException: If export fails
+
         """
         try:
             pem = self.public_key.public_bytes(
@@ -195,4 +191,4 @@ class AsymEncryption:
             )
             return pem.decode()
         except Exception as e:
-            raise SDKException(f"Error exporting public key to PEM: {e}")
+            raise SDKException(f"Error exporting public key to PEM: {e}") from e

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/auth_headers.py

@@ -1,10 +1,11 @@
+"""Authentication header management."""
+
 from dataclasses import dataclass
 
 
 @dataclass
 class AuthHeaders:
-    """
-    Represents authentication headers used in token-based authorization.
+    """Represents authentication headers used in token-based authorization.
     This class holds authorization and DPoP (Demonstrating Proof of Possession) headers
     that are used in token-based API requests.
     """
@@ -13,19 +14,19 @@ class AuthHeaders:
     dpop_header: str = ""
 
     def get_auth_header(self) -> str:
-        """Returns the authorization header."""
+        """Get the authorization header."""
         return self.auth_header
 
     def get_dpop_header(self) -> str:
-        """Returns the DPoP header."""
+        """Get the DPoP header."""
         return self.dpop_header
 
     def to_dict(self) -> dict[str, str]:
-        """
-        Convert authentication headers to a dictionary for use with HTTP clients.
+        """Convert authentication headers to a dictionary for use with HTTP clients.
 
         Returns:
             Dictionary with 'Authorization' header and optionally 'DPoP' header
+
         """
         headers = {"Authorization": self.auth_header}
         if self.dpop_header:

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/autoconfigure_utils.py

@@ -1,3 +1,5 @@
+"""Utilities for automatic SDK configuration."""
+
 import re
 import urllib.parse
 from dataclasses import dataclass
@@ -6,6 +8,8 @@ from typing import Any
 
 # RuleType constants
 class RuleType:
+    """Rule type constants for attribute hierarchy."""
+
     HIERARCHY = "hierarchy"
     ALL_OF = "allOf"
     ANY_OF = "anyOf"
@@ -15,6 +19,8 @@ class RuleType:
 
 @dataclass(frozen=True)
 class KeySplitStep:
+    """Key split step information."""
+
     kas: str
     splitID: str
 
@@ -31,21 +37,26 @@ class KeySplitStep:
 
 
 class AutoConfigureException(Exception):
+    """Exception for auto-configuration errors."""
+
     pass
 
 
 class AttributeNameFQN:
+    """Fully qualified attribute name."""
+
     def __init__(self, url: str):
+        """Initialize attribute name from URL."""
         pattern = re.compile(r"^(https?://[\w./-]+)/attr/([^/\s]*)$")
         matcher = pattern.match(url)
         if not matcher or not matcher.group(1) or not matcher.group(2):
             raise AutoConfigureException("invalid type: attribute regex fail")
         try:
             urllib.parse.unquote(matcher.group(2))
-        except Exception:
+        except Exception as err:
             raise AutoConfigureException(
                 f"invalid type: error in attribute name [{matcher.group(2)}]"
-            )
+            ) from err
         self.url = url
         self.key = url.lower()
 
@@ -76,12 +87,15 @@ class AttributeNameFQN:
             raise AutoConfigureException("invalid attribute")
         try:
             return urllib.parse.unquote(matcher.group(1))
-        except Exception:
-            raise AutoConfigureException("invalid type")
+        except Exception as err:
+            raise AutoConfigureException("invalid type") from err
 
 
 class AttributeValueFQN:
+    """Fully qualified attribute value."""
+
     def __init__(self, url: str):
+        """Initialize attribute value from URL."""
         pattern = re.compile(r"^(https?://[\w./-]+)/attr/(\S*)/value/(\S*)$")
         matcher = pattern.match(url)
         if (
@@ -96,8 +110,10 @@ class AttributeValueFQN:
         try:
             urllib.parse.unquote(matcher.group(2))
             urllib.parse.unquote(matcher.group(3))
-        except Exception:
-            raise AutoConfigureException("invalid type: error in attribute or value")
+        except Exception as err:
+            raise AutoConfigureException(
+                "invalid type: error in attribute or value"
+            ) from err
         self.url = url
         self.key = url.lower()
 

{otdf_python-0.4.0 → otdf_python-0.4.1}/src/otdf_python/cli.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
-"""
-OpenTDF Python CLI
+"""OpenTDF Python CLI.
 
 A command-line interface for encrypting and decrypting files using OpenTDF.
 Provides encrypt, decrypt, and inspect commands similar to the otdfctl CLI.
@@ -36,6 +35,7 @@ class CLIError(Exception):
     """Custom exception for CLI errors."""
 
     def __init__(self, level: str, message: str, cause: Exception | None = None):
+        """Initialize CLI error."""
         self.level = level
         self.message = message
         self.cause = cause
@@ -105,11 +105,11 @@ def load_client_credentials(creds_file_path: str) -> tuple[str, str]:
     except json.JSONDecodeError as e:
         raise CLIError(
             "CRITICAL", f"Invalid JSON in credentials file {creds_file_path}: {e}"
-        )
+        ) from e
     except Exception as e:
         raise CLIError(
             "CRITICAL", f"Error reading credentials file {creds_file_path}: {e}"
-        )
+        ) from e
 
 
 def build_sdk(args) -> SDK:
@@ -525,7 +525,7 @@ Where creds.json contains:
 
 
 def main():
-    """Main CLI entry point."""
+    """Execute the CLI entry point."""
     parser = create_parser()
     args = parser.parse_args()