openshift-python-wrapper 4.20.8__tar.gz → 4.20.9__tar.gz

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/.gitignore

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

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/.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

openshift_python_wrapper-4.20.9/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.20.9/CLAUDE.md

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

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/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.20.8 → openshift_python_wrapper-4.20.9}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: openshift-python-wrapper
-Version: 4.20.8
+Version: 4.20.9
 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,7 +13,11 @@ 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
@@ -27,7 +31,6 @@ 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.20.8 → openshift_python_wrapper-4.20.9}/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.20.8 → openshift_python_wrapper-4.20.9}/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.20.8 → openshift_python_wrapper-4.20.9}/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",
                 },

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/fake_kubernetes_client/status_templates.py

@@ -1,6 +1,6 @@
 """Status template methods for fake Kubernetes resources"""
 
-from datetime import datetime, timezone
+from datetime import UTC, datetime
 from typing import Any
 
 from fake_kubernetes_client.status_schema_parser import StatusSchemaParser
@@ -99,7 +99,7 @@ def get_pod_status_template(body: dict[str, Any]) -> dict[str, Any]:
     ready_message = "All containers are ready"
     container_ready = True
     container_started = True
-    container_state = {"running": {"startedAt": datetime.now(timezone.utc).isoformat()}}
+    container_state = {"running": {"startedAt": datetime.now(UTC).isoformat()}}
 
     # Check pod-specific annotation first
     if "fake-client.io/pod-ready" in annotations:
@@ -133,7 +133,7 @@ def get_pod_status_template(body: dict[str, Any]) -> dict[str, Any]:
             ready_message = "All containers are ready"
             container_ready = True
             container_started = True
-            container_state = {"running": {"startedAt": datetime.now(timezone.utc).isoformat()}}
+            container_state = {"running": {"startedAt": datetime.now(UTC).isoformat()}}
 
     return {
         "phase": "Running",
@@ -142,14 +142,14 @@ def get_pod_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 "type": "Initialized",
                 "status": "True",
                 "lastProbeTime": None,
-                "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                "lastTransitionTime": datetime.now(UTC).isoformat(),
                 "reason": "PodCompleted",
             },
             {
                 "type": "Ready",
                 "status": ready_status,  # Now configurable, defaults to True
                 "lastProbeTime": None,
-                "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                "lastTransitionTime": datetime.now(UTC).isoformat(),
                 "reason": ready_reason,
                 "message": ready_message,
             },
@@ -157,7 +157,7 @@ def get_pod_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 "type": "ContainersReady",
                 "status": ready_status,  # Should match Ready status
                 "lastProbeTime": None,
-                "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                "lastTransitionTime": datetime.now(UTC).isoformat(),
                 "reason": ready_reason,
                 "message": ready_message,
             },
@@ -165,14 +165,14 @@ def get_pod_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 "type": "PodScheduled",
                 "status": "True",
                 "lastProbeTime": None,
-                "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                "lastTransitionTime": datetime.now(UTC).isoformat(),
                 "reason": "PodScheduled",
             },
         ],
         "hostIP": "10.0.0.1",
         "podIP": "10.244.0.2",
         "podIPs": [{"ip": "10.244.0.2"}],
-        "startTime": datetime.now(timezone.utc).isoformat(),
+        "startTime": datetime.now(UTC).isoformat(),
         "containerStatuses": [
             {
                 "name": container_name,
@@ -207,16 +207,16 @@ def get_deployment_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 {
                     "type": "Available",
                     "status": "True",
-                    "lastUpdateTime": datetime.now(timezone.utc).isoformat(),
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastUpdateTime": datetime.now(UTC).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "MinimumReplicasAvailable",
                     "message": "Deployment has minimum availability.",
                 },
                 {
                     "type": "Progressing",
                     "status": "True",
-                    "lastUpdateTime": datetime.now(timezone.utc).isoformat(),
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastUpdateTime": datetime.now(UTC).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "NewReplicaSetAvailable",
                     "message": "ReplicaSet has successfully progressed.",
                 },
@@ -235,16 +235,16 @@ def get_deployment_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 {
                     "type": "Available",
                     "status": "False",
-                    "lastUpdateTime": datetime.now(timezone.utc).isoformat(),
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastUpdateTime": datetime.now(UTC).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "MinimumReplicasUnavailable",
                     "message": "Deployment does not have minimum availability.",
                 },
                 {
                     "type": "Progressing",
                     "status": "False",
-                    "lastUpdateTime": datetime.now(timezone.utc).isoformat(),
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastUpdateTime": datetime.now(UTC).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ProgressDeadlineExceeded",
                     "message": "ReplicaSet has timed out progressing.",
                 },
@@ -270,14 +270,14 @@ def get_namespace_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 {
                     "type": "NamespaceDeletionDiscoveryFailure",
                     "status": "False",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ResourcesDiscovered",
                     "message": "All resources successfully discovered",
                 },
                 {
                     "type": "NamespaceDeletionContentFailure",
                     "status": "False",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ContentDeleted",
                     "message": "All content successfully deleted",
                 },
@@ -291,14 +291,14 @@ def get_namespace_status_template(body: dict[str, Any]) -> dict[str, Any]:
                 {
                     "type": "NamespaceDeletionDiscoveryFailure",
                     "status": "True",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "DiscoveryFailed",
                     "message": "Discovery failed for some resources",
                 },
                 {
                     "type": "NamespaceDeletionContentFailure",
                     "status": "True",
-                    "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                    "lastTransitionTime": datetime.now(UTC).isoformat(),
                     "reason": "ContentDeletionFailed",
                     "message": "Failed to delete all content",
                 },
@@ -316,7 +316,7 @@ def get_generic_status_template(body: dict[str, Any]) -> dict[str, Any]:
             {
                 "type": "Ready",
                 "status": ready_status,
-                "lastTransitionTime": datetime.now(timezone.utc).isoformat(),
+                "lastTransitionTime": datetime.now(UTC).isoformat(),
                 "reason": ready_reason,
                 "message": ready_message,
             }

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/ocp_resources/migration.py

@@ -54,4 +54,4 @@ class Migration(NamespacedResource):
             })
 
             if self.cut_over:
-                self.res["spec"]["cutover"] = self.cut_over.strftime(format="%Y-%m-%dT%H:%M:%SZ")
+                self.res["spec"]["cutover"] = self.cut_over.strftime("%Y-%m-%dT%H:%M:%SZ")

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/ocp_resources/virtual_machine_import.py

@@ -162,7 +162,7 @@ class VirtualMachineImport(NamespacedResource):
             if self.warm:
                 spec["warm"] = self.warm
             if self.finalize_date:
-                spec["finalizeDate"] = self.finalize_date.strftime(format="%Y-%m-%dT%H:%M:%SZ")
+                spec["finalizeDate"] = self.finalize_date.strftime("%Y-%m-%dT%H:%M:%SZ")
 
             provider_source = spec.setdefault("source", {}).setdefault(self.provider_type, {})
             vm = provider_source.setdefault("vm", {})

{openshift_python_wrapper-4.20.8 → openshift_python_wrapper-4.20.9}/pyproject.toml

@@ -90,15 +90,19 @@ include = [
 ]
 
 [project]
-requires-python = ">=3.10"
+requires-python = ">=3.11,<3.15"
 name = "openshift-python-wrapper"
-version = "4.20.8"
+version = "4.20.9"
 description = "Wrapper around https://github.com/kubernetes-client/python"
 readme = "README.md"
 license = "Apache-2.0"
 keywords = ["Openshift", "Kubevirt", "Openshift Virtualization"]
 classifiers = [
   "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Operating System :: OS Independent",
 ]
 dependencies = [
@@ -114,7 +118,6 @@ dependencies = [
   "python-simple-logger>=1.0.40",
   "requests>=2.32.2",
   "rich>=13.9.2",
-  "ruff>=0.6.9",
   "timeout-sampler>=0.0.46",
   "xmltodict>=0.13.0",
   "fastmcp>=2.10.4",
@@ -152,4 +155,4 @@ build-backend = "hatchling.build"
 
 [dependency-groups]
 tests = ["pytest>=8.3.5", "pytest-cov>=6.1.1"]
-dev = ["ipdb>=0.13.13", "ipython>=8.12.3"]
+dev = ["ipdb>=0.13.13", "ipython>=8.12.3", "ruff>=0.6.9"]