openshift-python-wrapper 11.0.139__tar.gz → 11.0.141__tar.gz

openshift_python_wrapper-11.0.141/.pr_agent.toml

@@ -0,0 +1,12 @@
+[config]
+add_repo_metadata = true
+ignore_pr_title = ["^chore: bump version"]
+
+[github_app]
+handle_push_trigger = true
+pr_commands = ["/agentic_review", "/agentic_describe"]
+push_commands = ["/agentic_review"]
+
+[review_agent]
+comments_location_policy = "both"
+inline_comments_severity_threshold = 1

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/.pre-commit-config.yaml

@@ -46,7 +46,7 @@ repos:
           ]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.16.0
+    rev: v0.16.5
     hooks:
       - id: ruff
       - id: ruff-format
@@ -57,7 +57,7 @@ repos:
       - id: gitleaks
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v2.3.0
+    rev: v2.3.1
     hooks:
       - id: mypy
         exclude: ^(tests/|examples/|docs/)

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: openshift-python-wrapper
-Version: 11.0.139
+Version: 11.0.141
 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/
@@ -27,7 +27,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

openshift_python_wrapper-11.0.141/REVIEW.md

@@ -0,0 +1,18 @@
+# REVIEW.md
+
+## Out of scope
+
+Do not review generated code blocks inside `**/ocp_resources/**` that fall
+between:
+
+- Start marker: `# Generated using https://github.com/RedHatQE/openshift-python-wrapper/blob/main/class_generator/README.md`
+- End marker: `# End of generated code`
+
+This is auto-generated code from the class-generator tool. Only review code
+outside these markers.
+
+## Repository-specific rules
+
+If someone modifies generated code directly (between the markers above),
+flag it as a violation — changes should be made to the class-generator tool
+instead, not the generated output.

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/common-patterns.md

@@ -27,6 +27,7 @@ Copy-paste recipes for the most common Kubernetes and OpenShift resource operati
 ```python
 # Preamble used by all recipes below
 from ocp_resources.resource import get_client
+
 client = get_client()
 ```
 
@@ -43,11 +44,13 @@ pod = Pod(
     client=client,
     name="my-nginx",
     namespace="default",
-    containers=[{
-        "name": "nginx",
-        "image": "nginx:1.25",
-        "ports": [{"containerPort": 80}],
-    }],
+    containers=[
+        {
+            "name": "nginx",
+            "image": "nginx:1.25",
+            "ports": [{"containerPort": 80}],
+        }
+    ],
     restart_policy="Never",
 )
 pod.deploy()
@@ -69,11 +72,13 @@ with Pod(
     client=client,
     name="test-curl",
     namespace="default",
-    containers=[{
-        "name": "curl",
-        "image": "curlimages/curl:8.5.0",
-        "command": ["sleep", "3600"],
-    }],
+    containers=[
+        {
+            "name": "curl",
+            "image": "curlimages/curl:8.5.0",
+            "command": ["sleep", "3600"],
+        }
+    ],
 ) as pod:
     pod.wait_for_status(status=Pod.Status.RUNNING, timeout=60)
     output = pod.execute(command=["curl", "-s", "http://httpbin.org/get"])
@@ -142,11 +147,13 @@ dep = Deployment(
     template={
         "metadata": {"labels": {"app": "web-app"}},
         "spec": {
-            "containers": [{
-                "name": "app",
-                "image": "nginx:1.25",
-                "ports": [{"containerPort": 80}],
-            }]
+            "containers": [
+                {
+                    "name": "app",
+                    "image": "nginx:1.25",
+                    "ports": [{"containerPort": 80}],
+                }
+            ]
         },
     },
 )
@@ -192,11 +199,13 @@ svc = Service(
     name="web-app-svc",
     namespace="default",
     selector={"app": "web-app"},
-    ports=[{
-        "protocol": "TCP",
-        "port": 80,
-        "targetPort": 80,
-    }],
+    ports=[
+        {
+            "protocol": "TCP",
+            "port": 80,
+            "targetPort": 80,
+        }
+    ],
     type="ClusterIP",
 )
 svc.deploy()
@@ -310,11 +319,13 @@ job = Job(
     namespace="default",
     backoff_limit=3,
     restart_policy="Never",
-    containers=[{
-        "name": "migrate",
-        "image": "my-app:latest",
-        "command": ["python", "manage.py", "migrate"],
-    }],
+    containers=[
+        {
+            "name": "migrate",
+            "image": "my-app:latest",
+            "command": ["python", "manage.py", "migrate"],
+        }
+    ],
 )
 job.deploy()
 job.wait_for_condition(
@@ -363,7 +374,11 @@ dv = DataVolume(
     client=client,
     name="fedora-disk",
     namespace="default",
-    source_dict={"http": {"url": "https://download.fedoraproject.org/pub/fedora/linux/releases/40/Cloud/x86_64/images/Fedora-Cloud-Base-40-1.14.x86_64.qcow2"}},
+    source_dict={
+        "http": {
+            "url": "https://download.fedoraproject.org/pub/fedora/linux/releases/40/Cloud/x86_64/images/Fedora-Cloud-Base-40-1.14.x86_64.qcow2"
+        }
+    },
     size="30Gi",
     storage_class="ocs-storagecluster-ceph-rbd-virtualization",
     access_modes=DataVolume.AccessMode.RWX,
@@ -408,12 +423,14 @@ netpol = NetworkPolicy(
     namespace="default",
     pod_selector={"matchLabels": {"app": "web-app"}},
     policy_types=["Ingress"],
-    ingress=[{
-        "ports": [{"protocol": "TCP", "port": 80}],
-        "from": [
-            {"namespaceSelector": {"matchLabels": {"env": "production"}}},
-        ],
-    }],
+    ingress=[
+        {
+            "ports": [{"protocol": "TCP", "port": 80}],
+            "from": [
+                {"namespaceSelector": {"matchLabels": {"env": "production"}}},
+            ],
+        }
+    ],
 )
 netpol.deploy()
 ```
@@ -468,11 +485,13 @@ role = Role(
     client=client,
     name="pod-reader",
     namespace="default",
-    rules=[{
-        "apiGroups": [""],
-        "resources": ["pods", "pods/log"],
-        "verbs": ["get", "list", "watch"],
-    }],
+    rules=[
+        {
+            "apiGroups": [""],
+            "resources": ["pods", "pods/log"],
+            "verbs": ["get", "list", "watch"],
+        }
+    ],
 )
 role.deploy()
 
@@ -504,11 +523,13 @@ from ocp_resources.cluster_role_binding import ClusterRoleBinding
 cr = ClusterRole(
     client=client,
     name="node-viewer",
-    rules=[{
-        "apiGroups": [""],
-        "resources": ["nodes"],
-        "verbs": ["get", "list", "watch"],
-    }],
+    rules=[
+        {
+            "apiGroups": [""],
+            "resources": ["nodes"],
+            "verbs": ["get", "list", "watch"],
+        }
+    ],
 )
 cr.deploy()
 
@@ -516,11 +537,13 @@ crb = ClusterRoleBinding(
     client=client,
     name="app-sa-node-viewer",
     cluster_role="node-viewer",
-    subjects=[{
-        "kind": "ServiceAccount",
-        "name": "app-sa",
-        "namespace": "default",
-    }],
+    subjects=[
+        {
+            "kind": "ServiceAccount",
+            "name": "app-sa",
+            "namespace": "default",
+        }
+    ],
 )
 crb.deploy()
 ```
@@ -600,10 +623,12 @@ dep = Deployment(
             "template": {
                 "metadata": {"labels": {"app": "from-dict"}},
                 "spec": {
-                    "containers": [{
-                        "name": "app",
-                        "image": "nginx:1.25",
-                    }],
+                    "containers": [
+                        {
+                            "name": "app",
+                            "image": "nginx:1.25",
+                        }
+                    ],
                 },
             },
         },
@@ -647,16 +672,20 @@ from ocp_resources.ingress_networking_k8s_io import Ingress as K8sIngress
 k8s_ingress = K8sIngress(
     client=client,
     name="my-app-ingress",
-    rules=[{
-        "host": "app.example.com",
-        "http": {
-            "paths": [{
-                "path": "/",
-                "pathType": "Prefix",
-                "backend": {"service": {"name": "web-app-svc", "port": {"number": 80}}},
-            }],
-        },
-    }],
+    rules=[
+        {
+            "host": "app.example.com",
+            "http": {
+                "paths": [
+                    {
+                        "path": "/",
+                        "pathType": "Prefix",
+                        "backend": {"service": {"name": "web-app-svc", "port": {"number": 80}}},
+                    }
+                ],
+            },
+        }
+    ],
 )
 ```
 
@@ -770,10 +799,12 @@ pod = Pod(
     client=client,
     name="validated-pod",
     namespace="default",
-    containers=[{
-        "name": "app",
-        "image": "nginx:1.25",
-    }],
+    containers=[
+        {
+            "name": "app",
+            "image": "nginx:1.25",
+        }
+    ],
     schema_validation_enabled=True,  # Auto-validate on create()
 )
 

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/connecting-to-clusters.md

@@ -339,6 +339,7 @@ The Kubernetes Python client reads `KUBECONFIG` at module import time. If you se
 
 ```python
 import os
+
 # Don't rely on: os.environ["KUBECONFIG"] = "/path/to/config"
 # Instead, pass it explicitly:
 client = get_client(config_file=os.environ.get("KUBECONFIG", "/path/to/config"))

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/creating-and-managing-resources.md

@@ -203,9 +203,11 @@ cm = ConfigMap(
     ensure_exists=True,
 )
 
-cm.update(resource_dict={
-    "data": {"new_key": "new_value"},
-})
+cm.update(
+    resource_dict={
+        "data": {"new_key": "new_value"},
+    }
+)
 ```
 
 ### Replacing with `update_replace()`
@@ -397,9 +399,7 @@ from ocp_resources.resource import ResourceEditor
 
 ns = Namespace(client=client, name="my-namespace", ensure_exists=True)
 
-with ResourceEditor(
-    patches={ns: {"metadata": {"labels": {"temporary-label": "true"}}}}
-):
+with ResourceEditor(patches={ns: {"metadata": {"labels": {"temporary-label": "true"}}}}):
     # Label is applied
     assert ns.labels["temporary-label"] == "true"
 # Label is automatically removed

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/editing-resources-temporarily.md

@@ -36,9 +36,7 @@ from ocp_resources.node import Node
 
 node = Node(name="worker-0")
 
-with ResourceEditor(
-    patches={node: {"metadata": {"labels": {"test-label": "true"}}}}
-):
+with ResourceEditor(patches={node: {"metadata": {"labels": {"test-label": "true"}}}}):
     # The node now has the label "test-label": "true"
     # Run your test logic here...
     pass
@@ -113,9 +111,7 @@ from ocp_resources.config_map import ConfigMap
 
 cm = ConfigMap(name="app-config", namespace="default")
 
-editor = ResourceEditor(
-    patches={cm: {"data": {"mode": "maintenance"}}}
-)
+editor = ResourceEditor(patches={cm: {"data": {"mode": "maintenance"}}})
 
 # Apply the patch and create backups
 editor.update(backup_resources=True)
@@ -175,9 +171,7 @@ with ResourceEditor(
 Access the automatically generated backup data through the `backups` property:
 
 ```python
-editor = ResourceEditor(
-    patches={my_resource: {"metadata": {"labels": {"env": "staging"}}}}
-)
+editor = ResourceEditor(patches={my_resource: {"metadata": {"labels": {"env": "staging"}}}})
 editor.update(backup_resources=True)
 
 # See what was backed up

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/environment-variables.md

@@ -127,6 +127,7 @@ export OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL=DEBUG
 
 ```python
 import os
+
 os.environ["OPENSHIFT_PYTHON_WRAPPER_LOG_LEVEL"] = "DEBUG"
 
 from ocp_resources.pod import Pod
@@ -156,6 +157,7 @@ export OPENSHIFT_PYTHON_WRAPPER_LOG_FILE=/var/log/ocp-wrapper.log
 
 ```python
 import os
+
 os.environ["OPENSHIFT_PYTHON_WRAPPER_LOG_FILE"] = "/tmp/ocp-wrapper.log"
 
 from ocp_resources.namespace import Namespace
@@ -200,6 +202,7 @@ export OPENSHIFT_PYTHON_WRAPPER_HASH_LOG_DATA=false
 
 ```python
 import os
+
 os.environ["OPENSHIFT_PYTHON_WRAPPER_HASH_LOG_DATA"] = "false"
 
 from ocp_resources.secret import Secret

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/error-handling.md

@@ -289,8 +289,7 @@ Validation error: Field is required
 from ocp_resources.pod import Pod
 from ocp_resources.exceptions import ValidationError
 
-pod = Pod(client=client, name="my-pod", namespace="default",
-          containers=[{"name": "nginx", "image": "nginx:latest"}])
+pod = Pod(client=client, name="my-pod", namespace="default", containers=[{"name": "nginx", "image": "nginx:latest"}])
 
 try:
     pod.validate()
@@ -589,9 +588,13 @@ from ocp_resources.exceptions import (
 )
 
 try:
-    with Pod(client=client, name="worker", namespace="default",
-             containers=[{"name": "app", "image": "myapp:latest"}],
-             schema_validation_enabled=True) as pod:
+    with Pod(
+        client=client,
+        name="worker",
+        namespace="default",
+        containers=[{"name": "app", "image": "myapp:latest"}],
+        schema_validation_enabled=True,
+    ) as pod:
         pod.execute(command=["python", "run_task.py"])
 except ValidationError as e:
     print(f"Invalid resource spec: {e}")

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/generating-resource-classes.md

@@ -80,6 +80,7 @@ Example generated output for `ConfigMap`:
 from typing import Any
 from ocp_resources.resource import NamespacedResource
 
+
 class ConfigMap(NamespacedResource):
     """
     ConfigMap holds configuration data for pods to consume.
@@ -93,8 +94,7 @@ class ConfigMap(NamespacedResource):
         data: dict[str, Any] | None = None,
         immutable: bool | None = None,
         **kwargs: Any,
-    ) -> None:
-        ...
+    ) -> None: ...
 ```
 
 ### 4. Generate multiple kinds at once
@@ -145,11 +145,12 @@ Both files define a class named `DNS` but with different `api_group` attributes.
 Any code you add **below** the `# End of generated code` marker is preserved when you regenerate the file with `--overwrite`. This is how built-in resources like `ConfigMap` include custom properties:
 
 ```python
-    # End of generated code
+# End of generated code
+
 
-    @property
-    def keys_to_hash(self):
-        return ["data", "binaryData"]
+@property
+def keys_to_hash(self):
+    return ["data", "binaryData"]
 ```
 
 Custom imports you add at the top of the file are also preserved during regeneration.

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/managing-resource-lists.md

@@ -186,7 +186,7 @@ namespaces = ResourceList(resource_class=Namespace, num_resources=2, client=clie
 namespaces.deploy(wait=True)
 
 # Later...
-namespaces.clean_up(wait=True)   # wait=True is the default
+namespaces.clean_up(wait=True)  # wait=True is the default
 namespaces.clean_up(wait=False)  # Skip waiting for deletion
 ```
 

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/mcp-server-integration.md

@@ -98,12 +98,7 @@ Prompt: "List all pods in the openshift-monitoring namespace with label app=prom
 The AI will call the `list_resources` tool, which maps to:
 
 ```python
-list_resources(
-    resource_type="pod",
-    namespace="openshift-monitoring",
-    label_selector="app=prometheus",
-    limit=20
-)
+list_resources(resource_type="pod", namespace="openshift-monitoring", label_selector="app=prometheus", limit=20)
 ```
 
 Returned data includes name, namespace, UID, creation timestamp, labels, phase, and conditions for each matched resource.
@@ -125,7 +120,7 @@ get_resource(
     resource_type="deployment",
     name="api-server",
     namespace="production",
-    output_format="yaml"    # also accepts "json" or "info"
+    output_format="yaml",  # also accepts "json" or "info"
 )
 ```
 
@@ -148,7 +143,7 @@ create_resource(
     name="app-settings",
     namespace="staging",
     spec={"data": {"database_host": "db.staging.svc", "log_level": "debug"}},
-    labels={"managed-by": "mcp-server"}
+    labels={"managed-by": "mcp-server"},
 )
 ```
 
@@ -170,7 +165,7 @@ spec:
     image: nginx:1.27
     ports:
     - containerPort: 80
-"""
+""",
 )
 ```
 
@@ -187,7 +182,8 @@ Prompt: "Apply this manifest to create a namespace, deployment, and service for
 The AI calls:
 
 ```python
-apply_yaml(yaml_content="""
+apply_yaml(
+    yaml_content="""
 ---
 apiVersion: v1
 kind: Namespace
@@ -226,7 +222,8 @@ spec:
   ports:
   - port: 80
     targetPort: 8080
-""")
+"""
+)
 ```
 
 The response includes a summary with `total_resources`, `successful`, and `failed` counts, plus per-resource results. Each YAML document is parsed and deployed independently.
@@ -247,7 +244,7 @@ update_resource(
     name="web-frontend",
     namespace="production",
     patch={"spec": {"replicas": 5}},
-    patch_type="merge"       # or "strategic"
+    patch_type="merge",  # or "strategic"
 )
 ```
 
@@ -264,13 +261,7 @@ Prompt: "Delete the pod 'debug-pod' in namespace 'default' and wait for it to be
 The AI calls:
 
 ```python
-delete_resource(
-    resource_type="pod",
-    name="debug-pod",
-    namespace="default",
-    wait=True,
-    timeout=60
-)
+delete_resource(resource_type="pod", name="debug-pod", namespace="default", wait=True, timeout=60)
 ```
 
 If the resource doesn't exist, the server returns a success response with a warning rather than an error, making the operation idempotent.
@@ -287,12 +278,7 @@ in namespace 'production'"
 The AI calls:
 
 ```python
-get_pod_logs(
-    name="api-server-7f8b9c",
-    namespace="production",
-    container="app",
-    tail_lines=200
-)
+get_pod_logs(name="api-server-7f8b9c", namespace="production", container="app", tail_lines=200)
 ```
 
 - Use `since_seconds=3600` to get logs from the last hour
@@ -310,12 +296,7 @@ Prompt: "Check the nginx config in pod 'web-server' namespace 'production'"
 The AI calls:
 
 ```python
-exec_in_pod(
-    name="web-server",
-    namespace="production",
-    command=["nginx", "-t"],
-    container="nginx"
-)
+exec_in_pod(name="web-server", namespace="production", command=["nginx", "-t"], container="nginx")
 ```
 
 The response includes `stdout`, `stderr`, and `returncode`. If the command fails, the exit code and error output are captured rather than raising an exception.
@@ -333,12 +314,7 @@ Prompt: "Show me the events for pod 'crashloop-pod' in 'default' namespace"
 The AI calls:
 
 ```python
-get_resource_events(
-    resource_type="pod",
-    name="crashloop-pod",
-    namespace="default",
-    limit=10
-)
+get_resource_events(resource_type="pod", name="crashloop-pod", namespace="default", limit=10)
 ```
 
 Events are filtered using field selectors on `involvedObject.name`, `involvedObject.namespace`, and `involvedObject.kind`. Each event includes type (Normal/Warning), reason, message, count, timestamps, and source component.

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/pod-execution-and-logs.md

@@ -143,10 +143,10 @@ from ocp_resources.exceptions import ExecOnPodError
 try:
     pod.execute(command=["ls", "/nonexistent"])
 except ExecOnPodError as e:
-    print(f"Command: {e.cmd}")      # ['ls', '/nonexistent']
-    print(f"Return code: {e.rc}")   # Non-zero exit code (or -1 for stream errors)
-    print(f"Stdout: {e.out}")       # Standard output captured before failure
-    print(f"Stderr: {e.err}")       # Standard error or error channel details
+    print(f"Command: {e.cmd}")  # ['ls', '/nonexistent']
+    print(f"Return code: {e.rc}")  # Non-zero exit code (or -1 for stream errors)
+    print(f"Stdout: {e.out}")  # Standard output captured before failure
+    print(f"Stderr: {e.err}")  # Standard error or error channel details
 ```
 
 `ExecOnPodError` attributes:
@@ -318,11 +318,13 @@ with Pod(
     client=client,
     name="debug-pod",
     namespace="default",
-    containers=[{
-        "name": "debug",
-        "image": "registry.access.redhat.com/ubi9/ubi:latest",
-        "command": ["sleep", "3600"],
-    }],
+    containers=[
+        {
+            "name": "debug",
+            "image": "registry.access.redhat.com/ubi9/ubi:latest",
+            "command": ["sleep", "3600"],
+        }
+    ],
 ) as pod:
     pod.wait_for_status(status=Pod.Status.RUNNING, timeout=120)
     output = pod.execute(command=["cat", "/etc/os-release"])

{openshift_python_wrapper-11.0.139 → openshift_python_wrapper-11.0.141}/docs/querying-resources.md

@@ -336,7 +336,7 @@ from ocp_resources.pod import Pod
 pod = Pod(client=client, name="my-pod", namespace="default")
 
 for event in pod.watcher(timeout=60):
-    print(f"Event type: {event['type']}")       # ADDED, MODIFIED, DELETED
+    print(f"Event type: {event['type']}")  # ADDED, MODIFIED, DELETED
     print(f"Object: {event['object'].metadata.name}")
     print(f"Raw: {event['raw_object']}")
 ```