openshift-python-wrapper 4.21.0__tar.gz → 4.21.2__tar.gz

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/.gitignore

@@ -131,7 +131,6 @@ package-lock.json
 
 # AI
 .cursor/
-CLAUDE.md
 .agent-os/
 .cursorrules
 .claude/

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/.pre-commit-config.yaml

@@ -2,7 +2,7 @@ minimum_pre_commit_version: 3.3.0
 default_install_hook_types: [pre-commit, commit-msg]
 
 default_language_version:
-  python: python3
+  python: python3.11
 
 ci:
   autofix_prs: false
@@ -45,18 +45,18 @@ repos:
           ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.15.0
+    rev: v0.15.12
     hooks:
       - id: ruff
       - id: ruff-format
 
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.30.0
+    rev: v8.30.1
     hooks:
       - id: gitleaks
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.19.1
+    rev: v1.20.2
     hooks:
       - id: mypy
         exclude: ^(tests/|examples/|docs/)

openshift_python_wrapper-4.21.2/AGENTS.md

@@ -0,0 +1,90 @@
+# openshift-python-wrapper
+
+Python wrapper for kubernetes-python-client providing simplified CRUD and resource-specific methods for Kubernetes/OpenShift resources (233+ wrappers).
+
+## Commands
+
+- **Package manager**: `uv` — NEVER use `python` or `pip` directly
+- Build/sync: `uv sync`
+- Test all: `uv run --group tests pytest`
+- Test specific: `uv run --group tests pytest tests/test_daemonset.py`
+- Lint: `prek run`
+- Pre-commit setup: `prek install`
+- Generate resource: `class-generator --kind Pod --add-tests`
+- Full verify: `prek run && uv run --group tests pytest`
+
+## Definition of Done
+
+A task is complete when ALL pass:
+1. `prek run` exits 0 (ruff, mypy, flake8, detect-secrets, gitleaks)
+2. `uv run --group tests pytest` exits 0 — coverage ≥ 65%
+3. Type hints on all new code (enforced by mypy)
+4. Committed with message: `type(scope): description`
+
+## When Blocked
+
+- Tests fail after 3 attempts → stop, report failing test with full output
+- Missing dependency → `uv add <package>`, never `pip install`
+- Pre-commit fails → read the error, fix the specific violation
+- 🚫 NEVER: skip tests, force push to main, delete files to fix errors
+
+## Project
+
+- Stack: Python 3.11-3.14 (requires-python >=3.11,<3.15), kubernetes-python-client, timeout-sampler, uv
+- Structure: `ocp_resources/` (resource wrappers), `tests/` (pytest), `class_generator/` (code gen), `fake_kubernetes_client/` (mock client)
+- Key deps: `kubernetes` (API client), `timeout-sampler` (polling), `openshift-python-utilities` (shared utils)
+- Docs: `examples/`, inline docstrings (Google style)
+
+## When Adding a Resource
+
+- New resources MUST be generated via `class-generator --kind ResourceName --add-tests` — manual creation is not allowed
+- Reference implementations: `ocp_resources/config_map.py` (namespaced), `ocp_resources/node.py` (cluster-scoped)
+- File naming: `snake_case.py` — class naming: exact Kubernetes `kind` (PascalCase)
+- Namespaced → inherit `NamespacedResource`, cluster-scoped → inherit `Resource`
+- Must implement: `__init__()`, `to_dict()`, `api_group` (if not core v1)
+- Reference: `class_generator/README.md`
+
+## Generated Code Markers
+
+Resource files from `class-generator` use markers to separate generated from manual code:
+- **Start**: `# Generated using https://...class_generator/README.md` (line 1)
+- **End**: `# End of generated code` (inside class)
+
+Code between markers is auto-generated — do NOT modify manually. Use `class-generator --kind <Kind> --overwrite --backup` to regenerate. Custom code (helper methods, overrides) goes BELOW the end marker.
+
+## When Writing Code
+
+- No client-side validation in `to_dict()` — let the K8s/OCP API server return errors. Helper functions in resource classes CAN validate.
+- Context managers for auto-cleanup: `with Pod(name="test", namespace="default") as pod:`
+- Wait utilities: `wait_for_status()`, `wait_for_condition()` via timeout-sampler
+- Sensitive data: add keys to `keys_to_hash` property for automatic log hashing
+- Fake client for tests: `get_client(fake=True)` — no cluster required
+
+## When Reviewing Code
+
+- Verify generated code markers are intact — no manual edits between markers
+- Check type hints on all new functions/parameters
+- Verify tests exist for new helper methods (not needed for generated `__init__`/`to_dict`)
+- Import path: `ocp_resources.resource_name` (snake_case with underscores)
+
+## Boundaries
+
+- ✅ Always: use `uv` for Python ops, run `prek install` before first commit, add typing
+- ⚠️ Ask first: adding new dependencies, modifying base `Resource` class, changing CI
+- 🚫 Never: use `python`/`pip` directly, edit generated code between markers, edit files in `docs/` (regenerate with docsfy instead)
+
+## Environment
+
+```bash
+OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=DEBUG        # DEBUG, INFO, WARNING, ERROR, CRITICAL
+OPENSHIFT_PYTHON_WRAPPER_HASH_LOG_DATA="false"   # Disable log hashing
+HTTPS_PROXY="http://proxy:8080"                  # Proxy support
+```
+
+## Additional References
+
+- Contributing guide: `CONTRIBUTING.md`
+- Class generator details: `class_generator/README.md`
+- MCP server: `mcp_server/README.md`
+- Release process: `CONTRIBUTING.md` + `.release-it.json`
+- Fake client: `fake_kubernetes_client/` (CRUD, selectors, watch, status generation)

openshift_python_wrapper-4.21.2/CLAUDE.md

@@ -0,0 +1 @@
+@AGENTS.md

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/CONTRIBUTING.md

@@ -12,7 +12,7 @@ To get an overview of the project, read the [README](README.md).
 ### Create a new issue
 
 If you find a problem with the code, [search if an issue already exists](https://github.com/RedHatQE/openshift-python-wrapper/issues).  
-If you open a pull request to fix the problem, an issue will ba automatically created.  
+If you open a pull request to fix the problem, an issue will be automatically created.  
 If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/RedHatQE/openshift-python-wrapper/issues/new/choose).
 
 ## Pull requests
@@ -37,13 +37,15 @@ prek install
 
 ## Adding a new module (resource)
 
-##### Using generator script
+##### Using generator script (REQUIRED)
+
+New resources MUST be added via the class generator — manual creation is not allowed.
 
 - [class_generator](class_generator/README.md)
 
-##### Manual
+##### Manual code (below `# End of generated code` only)
 
-A new resource must follow rules:
+Custom helper methods can be added below the end marker. The generated class structure must follow these rules:
 
 - A new file named as the resource under `ocp_resources`; If the resource name is composed of multiple words, separate them with an underscore.
 - A class named as the resource kind.
@@ -56,4 +58,21 @@ A new resource must follow rules:
   Define all the required arguments that are **required** to instantiate the new resource. Optional parameters may be added as well.
 - Implement `to_dict` function.
 
-Check [ConfigMap](ocp_resources/configmap.py) and [Backup](ocp_resources/backup.py) for reference.
+Check [ConfigMap](ocp_resources/config_map.py) and [Node](ocp_resources/node.py) for reference.
+
+### Generated code markers
+
+Resource files created by `class-generator` use markers to separate generated from manual code:
+
+- **Start marker** (line 1): `# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md`
+- **End marker** (inside class): `# End of generated code`
+
+Code between these markers is **auto-generated and must NOT be modified manually**.
+To update generated code, use `class-generator --kind <Kind> --overwrite --backup`.
+Custom code (helper methods, overrides) goes **below** the `# End of generated code` marker.
+
+### No client-side validation on resource creation
+
+When building resource payloads (`to_dict()`), do NOT validate or block at code level (e.g., mutual exclusivity of fields).
+If a payload can be sent to the API, send it — let the Kubernetes/OpenShift API server return the error.
+Helper functions in resource classes (e.g., `wait_for_rollout()`, `restart()`) CAN perform validation and guarding as needed.

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: openshift-python-wrapper
-Version: 4.21.0
+Version: 4.21.2
 Summary: Wrapper around https://github.com/kubernetes-client/python
 Project-URL: homepage, https://github.com/RedHatQE/openshift-python-wrapper
 Project-URL: documentation, https://openshift-python-wrapper.readthedocs.io/en/latest/
@@ -13,21 +13,24 @@ License-File: LICENSE
 Keywords: Kubevirt,Openshift,Openshift Virtualization
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: <3.15,>=3.11
 Requires-Dist: cloup>=3.0.5
 Requires-Dist: colorlog>=6.8.2
 Requires-Dist: deepdiff>=8.0.1
 Requires-Dist: fastmcp>=2.10.4
 Requires-Dist: jinja2>=3.1.4
 Requires-Dist: jsonschema>=4.20.0
-Requires-Dist: kubernetes>=31.0.0
+Requires-Dist: kubernetes!=36.0.0,>=31.0.0
 Requires-Dist: packaging>=24.1
 Requires-Dist: pyhelper-utils>=0.0.42
 Requires-Dist: python-benedict>=0.33.2
 Requires-Dist: python-simple-logger>=1.0.40
 Requires-Dist: requests>=2.32.2
 Requires-Dist: rich>=13.9.2
-Requires-Dist: ruff>=0.6.9
 Requires-Dist: timeout-sampler>=0.0.46
 Requires-Dist: xmltodict>=0.13.0
 Description-Content-Type: text/markdown
@@ -61,6 +64,8 @@ Resource manifests and logs can be easily collected.
 
 ## Installation
 
+Requires Python 3.11-3.14.
+
 From source:
 
 ```bash

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/README.md

@@ -27,6 +27,8 @@ Resource manifests and logs can be easily collected.
 
 ## Installation
 
+Requires Python 3.11-3.14.
+
 From source:
 
 ```bash

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/class_generator/cli.py

@@ -489,7 +489,7 @@ def handle_test_generation(add_tests: bool) -> None:
         # Run the generated test file
         LOGGER.info("Running generated tests...")
         test_file = "class_generator/tests/test_class_generator.py"
-        exit_code = os.system(f"uv run pytest {test_file}")
+        exit_code = os.system(f"uv run --group tests pytest {test_file}")
 
         # os.system returns the exit status shifted left by 8 bits
         if exit_code != 0:

openshift_python_wrapper-4.21.2/class_generator/formatters/file_writer.py

@@ -0,0 +1,71 @@
+"""File writing utilities for generated code."""
+
+from pathlib import Path
+
+from pyhelper_utils.shell import run_command
+from simple_logger.logger import get_logger
+
+LOGGER = get_logger(name=__name__)
+
+# Project root directory (contains pyproject.toml and .pre-commit-config.yaml)
+_PROJECT_ROOT = Path(__file__).resolve().parent.parent.parent
+
+
+def write_and_format_rendered(filepath: str, output: str) -> None:
+    """
+    Write rendered content to file and format with prek, falling back to ruff.
+
+    Args:
+        filepath: Path to write the file to
+        output: Content to write
+    """
+    with open(filepath, "w", encoding="utf-8") as fd:
+        fd.write(output)
+
+    pre_commit_config = str(_PROJECT_ROOT / ".pre-commit-config.yaml")
+    pyproject_toml = str(_PROJECT_ROOT / "pyproject.toml")
+
+    # Try prek first (runs all pre-commit hooks including ruff)
+    prek_success = False
+    try:
+        rc, stdout, stderr = run_command(
+            command=["uvx", "prek", "-c", pre_commit_config, "run", "--files", filepath],
+            verify_stderr=False,
+            check=False,
+            log_errors=False,
+        )
+        if not rc:
+            if stderr:
+                LOGGER.warning(f"Prek hooks failed for {filepath}, falling back to ruff.")
+                LOGGER.debug(f"prek stderr: {stderr}")
+            else:
+                prek_success = True
+
+            if stdout:
+                LOGGER.info(f"{filepath} fixed by prek")
+                LOGGER.debug(f"prek stdout: {stdout}")
+    except Exception as e:
+        LOGGER.warning(f"Failed to run prek for {filepath}, falling back to ruff: {e}")
+
+    if not prek_success:
+        _run_ruff_fallback(filepath=filepath, pyproject_toml=pyproject_toml)
+
+
+def _run_ruff_fallback(filepath: str, pyproject_toml: str) -> None:
+    """Run ruff check --fix and ruff format as fallback when prek fails."""
+    for ruff_cmd in (
+        ["uvx", "ruff", "check", "--fix", "--config", pyproject_toml, filepath],
+        ["uvx", "ruff", "format", "--config", pyproject_toml, filepath],
+    ):
+        try:
+            _, stdout, _ = run_command(
+                command=ruff_cmd,
+                verify_stderr=False,
+                check=False,
+                log_errors=False,
+            )
+            if stdout:
+                LOGGER.info(f"{filepath} fixed by ruff")
+                LOGGER.debug(f"ruff stdout: {stdout}")
+        except Exception as e:
+            LOGGER.error(f"Ruff fallback failed for {filepath}: {e}")

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/class_generator/manifests/class_generator_template.j2

@@ -14,8 +14,12 @@
 {% endfor %}
 
 from typing import Any
-from ocp_resources.resource import {{ base_class }}
+
+{% if all_required_args %}
 from ocp_resources.exceptions import MissingRequiredArgumentError
+{% endif %}
+from ocp_resources.resource import {{ base_class }}
+
 
 class {{ kind }}({{ base_class }}):
     """

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/class_generator/tests/manifests/test_parse_explain.j2

@@ -1,16 +1,15 @@
 # Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/scripts/resource/README.md#adding-tests
 
 import filecmp
+import traceback
 from pathlib import Path
-import pytest
-from typing import List, Tuple, Optional
 
 from class_generator.constants import TESTS_MANIFESTS_DIR
 from class_generator.core.generator import class_generator
 from class_generator.utils import execute_parallel_tasks
 
 
-def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]]:
+def _test_single_resource(kind: str, tmp_path: Path) -> tuple[str, str] | None:
     """
     Test a single resource kind and return failure info if test fails.
 
@@ -45,9 +44,9 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
             if not filecmp.cmp(output_file, expected_file):
                 try:
                     # Read both files to show diff details
-                    with open(output_file, "r") as f:
+                    with open(output_file) as f:
                         generated_content = f.read()
-                    with open(expected_file, "r") as f:
+                    with open(expected_file) as f:
                         expected_content = f.read()
 
                     # Find first difference for debugging
@@ -60,7 +59,7 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
                     diff_info += f"\nGenerated lines: {len(generated_lines)}, Expected lines: {len(expected_lines)}"
 
                     # Find first differing line
-                    for i, (gen_line, exp_line) in enumerate(zip(generated_lines, expected_lines)):
+                    for i, (gen_line, exp_line) in enumerate(zip(generated_lines, expected_lines, strict=True)):
                         if gen_line != exp_line:
                             diff_info += f"\nFirst difference at line {i + 1}:"
                             diff_info += f"\nGenerated: {repr(gen_line[:100])}..."
@@ -81,8 +80,6 @@ def _test_single_resource(kind: str, tmp_path: Path) -> Optional[Tuple[str, str]
         return None
 
     except Exception as e:
-        import traceback
-
         error_details = f"Exception during generation: {str(e)}\n"
         error_details += f"Traceback:\n{traceback.format_exc()}"
         return (kind, error_details)
@@ -97,17 +94,17 @@ def test_parse_explain(tmp_path: Path) -> None:
     {% endfor %}
     ]
 
-    failures: List[Tuple[str, str]] = []
+    failures: list[tuple[str, str]] = []
 
     # Process test results and collect failures
-    def process_test_result(kind: str, result: Optional[Tuple[str, str]]) -> None:
+    def process_test_result(kind: str, result: tuple[str, str] | None) -> None:
         if result is not None:
             failures.append(result)
 
     def handle_test_error(kind: str, exc: Exception) -> None:
         failures.append((kind, f"Task execution failed: {str(exc)}"))
 
-    def create_test_task(kind: str) -> Optional[Tuple[str, str]]:
+    def create_test_task(kind: str) -> tuple[str, str] | None:
         return _test_single_resource(kind, tmp_path / f"test-{kind}")
 
     # Run tests in parallel
@@ -136,12 +133,10 @@ def test_parse_explain(tmp_path: Path) -> None:
 
         # Create a concise failure message for pytest
         failed_kinds = [kind for kind, _ in failures]
-        failure_summary = f"{len(failures)} resource(s) failed: {', '.join(failed_kinds[:5])}"
-        if len(failed_kinds) > 5:
-            failure_summary += f" and {len(failed_kinds) - 5} more"
+        failure_summary = f"{len(failures)} resource(s) failed: {','.join(failed_kinds)}"
 
         # Fail the test with summary - detailed output is already printed above
-        assert False, failure_summary
+        raise AssertionError(failure_summary)
 
     # If we get here, all tests passed
     print(f"\nAll {len(resource_kinds)} resource generation tests passed successfully!")

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/class_generator/tests/test_class_generator.py

@@ -96,15 +96,15 @@ def test_parse_explain(tmp_path: Path) -> None:
         "Deployment",
         "ImageContentSourcePolicy",
         "Machine",
+        "NMState",
         "Pod",
         "Secret",
-        "NMState",
         "ServiceMeshMember",
-        "ServingRuntime",
+        "Ingress",
         "OAuth",
         "Pipeline",
-        "Ingress",
         "RouteAdvertisements",
+        "ServingRuntime",
     ]
 
     failures: list[tuple[str, str]] = []
@@ -146,9 +146,7 @@ def test_parse_explain(tmp_path: Path) -> None:
 
         # Create a concise failure message for pytest
         failed_kinds = [kind for kind, _ in failures]
-        failure_summary = f"{len(failures)} resource(s) failed: {', '.join(failed_kinds[:5])}"
-        if len(failed_kinds) > 5:
-            failure_summary += f" and {len(failed_kinds) - 5} more"
+        failure_summary = f"{len(failures)} resource(s) failed: {','.join(failed_kinds)}"
 
         # Fail the test with summary - detailed output is already printed above
         raise AssertionError(failure_summary)

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/class_generator/tests/test_cli.py

@@ -170,7 +170,9 @@ class TestCLIFunctionality:
 
             assert result.exit_code == 0
             mock_test_gen.assert_called_once()
-            mock_os_system.assert_called_once_with("uv run pytest class_generator/tests/test_class_generator.py")
+            mock_os_system.assert_called_once_with(
+                "uv run --group tests pytest class_generator/tests/test_class_generator.py"
+            )
 
     def test_add_tests_requires_kind(self):
         """Test that --add-tests cannot be used alone."""

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/fake_kubernetes_client/resource_instance.py

@@ -4,7 +4,7 @@ import copy
 import time
 import uuid
 from collections.abc import Iterator
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import TYPE_CHECKING, Any, Union
 
 from fake_kubernetes_client.exceptions import ConflictError, MethodNotAllowedError, NotFoundError
@@ -66,7 +66,7 @@ class FakeResourceInstance:
 
     def _generate_timestamp(self) -> str:
         """Generate current UTC timestamp in ISO format"""
-        return datetime.now(timezone.utc).isoformat()
+        return datetime.now(UTC).isoformat()
 
     def create(
         self, body: dict[str, Any] | None = None, namespace: str | None = None, **_kwargs: Any
@@ -208,7 +208,7 @@ class FakeResourceInstance:
                 "namespace": resource_namespace or "default",
                 "uid": str(uuid.uuid4()),
                 "resourceVersion": str(int(time.time() * 1000)),
-                "creationTimestamp": datetime.now(timezone.utc).isoformat(),
+                "creationTimestamp": datetime.now(UTC).isoformat(),
                 "generation": 1,
             },
             "involvedObject": {
@@ -222,8 +222,8 @@ class FakeResourceInstance:
             "reason": reason,
             "message": f"{resource_kind} {resource_name} has been {action}",
             "source": {"component": "fake-client", "host": "fake-cluster.example.com"},
-            "firstTimestamp": datetime.now(timezone.utc).isoformat(),
-            "lastTimestamp": datetime.now(timezone.utc).isoformat(),
+            "firstTimestamp": datetime.now(UTC).isoformat(),
+            "lastTimestamp": datetime.now(UTC).isoformat(),
             "count": 1,
             "type": "Normal",
         }

{openshift_python_wrapper-4.21.0 → openshift_python_wrapper-4.21.2}/fake_kubernetes_client/status_schema_parser.py

@@ -3,7 +3,7 @@
 import json
 import os
 import random
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import Any
 
 
@@ -302,7 +302,7 @@ class StatusSchemaParser:
     def _generate_string_value(self, field_name: str, is_ready: bool = True) -> str:
         """Generate a string value based on field name"""
         if "time" in field_name.lower() or "timestamp" in field_name.lower():
-            return datetime.now(timezone.utc).isoformat()
+            return datetime.now(UTC).isoformat()
         elif field_name == "message":
             return "Resource is ready" if is_ready else "Resource is not ready"
         elif field_name == "reason":
@@ -424,14 +424,14 @@ class StatusSchemaParser:
                 {
                     "type": "Ready",
                     "status": "True",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ResourceReady",
                     "message": "Resource is ready",
                 },
                 {
                     "type": "Available",
                     "status": "True",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ResourceAvailable",
                     "message": "Resource is available",
                 },
@@ -441,14 +441,14 @@ class StatusSchemaParser:
                 {
                     "type": "Ready",
                     "status": "False",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ResourceNotReady",
                     "message": "Resource is not ready",
                 },
                 {
                     "type": "Available",
                     "status": "False",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ResourceUnavailable",
                     "message": "Resource is unavailable",
                 },