crossplane-function-sdk-python 0.4.0__tar.gz → 0.5.0__tar.gz

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/.github/workflows/ci.yml

@@ -27,14 +27,15 @@ concurrency:
 
 env:
   # Common versions
-  PYTHON_VERSION: '3.11.5'
+  PYTHON_VERSION: '3.11'
+  HATCH_VERSION: '1.12.0'
 
   # The PyPi project version to push. The default is v0.0.0+gitdate-gitsha.
   PYPI_VERSION: ${{ inputs.version }}
 
 jobs:
   lint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -45,13 +46,13 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Setup Hatch
-        run: pipx install hatch==1.7.0
+        run: pipx install hatch==${{ env.HATCH_VERSION }}
 
       - name: Lint
-        run: hatch run lint:check
+        run: hatch fmt
 
   unit-test:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -62,14 +63,14 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Setup Hatch
-        run: pipx install hatch==1.7.0
+        run: pipx install hatch==${{ env.HATCH_VERSION }}
 
       - name: Run Unit Tests
-        run: hatch run test:unit
+        run: hatch test --all --randomize
 
 
   build:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -80,7 +81,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Setup Hatch
-        run: pipx install hatch==1.7.0
+        run: pipx install hatch==${{ env.HATCH_VERSION }}
 
       # If a version wasn't explicitly passed as a workflow_dispatch input we
       # default to version v0.0.0+<git-commit-date>-<git-short-sha>, for example
@@ -110,7 +111,7 @@ jobs:
     if: ${{ inputs.version != '' }}
     needs:
       - build
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Download Sdist and Wheel from GitHub
         uses: actions/download-artifact@v4
@@ -119,7 +120,7 @@ jobs:
           path: "dist"
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.10.1
+        uses: pypa/gh-action-pypi-publish@v1.10.3
         with:
           # Note that this is currently being pushed to the 'crossplane' PyPI
           # user (not org). See @negz if you need access - PyPI requires 2FA to
@@ -132,7 +133,7 @@ jobs:
     # The simple docs tool we're using doesn't support versions, so our docs
     # will only reflect what's in main.
     if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -143,7 +144,7 @@ jobs:
           python-version: ${{ env.PYTHON_VERSION }}
 
       - name: Setup Hatch
-        run: pipx install hatch==1.7.0
+        run: pipx install hatch==${{ env.HATCH_VERSION }}
 
       - name: Build Documentation
         run: hatch run docs:pdoc -d google crossplane/function -o docs

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: crossplane-function-sdk-python
-Version: 0.4.0
+Version: 0.5.0
 Summary: The Python SDK for Crossplane composition functions
 Project-URL: Documentation, https://github.com/crossplane/function-sdk-python#readme
 Project-URL: Issues, https://github.com/crossplane/function-sdk-python/issues
@@ -15,6 +15,7 @@ Requires-Python: >=3.11
 Requires-Dist: grpcio-reflection==1.*
 Requires-Dist: grpcio==1.*
 Requires-Dist: protobuf==5.27.2
+Requires-Dist: pydantic==2.*
 Requires-Dist: structlog==24.*
 Description-Content-Type: text/markdown
 
@@ -54,11 +55,11 @@ Some useful commands:
 # Generate gRPC stubs.
 hatch run generate:protoc
 
-# Lint the code.
-hatch run lint:check
+# Format and lint the code.
+hatch fmt
 
 # Run unit tests.
-hatch run test:unit
+hatch test
 
 # Build an sdist and wheel.
 hatch build

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/README.md

@@ -34,11 +34,11 @@ Some useful commands:
 # Generate gRPC stubs.
 hatch run generate:protoc
 
-# Lint the code.
-hatch run lint:check
+# Format and lint the code.
+hatch fmt
 
 # Run unit tests.
-hatch run test:unit
+hatch test
 
 # Build an sdist and wheel.
 hatch build

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/crossplane/function/__version__.py

@@ -15,4 +15,4 @@
 """The version of function-sdk-python."""
 
 # This is set at build time, using "hatch version"
-__version__ = "0.4.0"
+__version__ = "0.5.0"

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/crossplane/function/resource.py

@@ -17,12 +17,39 @@
 import dataclasses
 import datetime
 
+import pydantic
 from google.protobuf import struct_pb2 as structpb
 
+import crossplane.function.proto.v1.run_function_pb2 as fnv1
+
 # TODO(negz): Do we really need dict_to_struct and struct_to_dict? They don't do
 # much, but are perhaps useful for discoverability/"documentation" purposes.
 
 
+def update(r: fnv1.Resource, source: dict | structpb.Struct | pydantic.BaseModel):
+    """Update a composite or composed resource.
+
+    Use update to add or update the supplied resource. If the resource doesn't
+    exist, it'll be added. If the resource does exist, it'll be updated. The
+    update method semantics are the same as a dictionary's update method. Fields
+    that don't exist will be added. Fields that exist will be overwritten.
+
+    The source can be a dictionary, a protobuf Struct, or a Pydantic model.
+    """
+    match source:
+        case pydantic.BaseModel():
+            r.resource.update(source.model_dump(exclude_defaults=True, warnings=False))
+        case structpb.Struct():
+            # TODO(negz): Use struct_to_dict and update to match other semantics?
+            r.resource.MergeFrom(source)
+        case dict():
+            r.resource.update(source)
+        case _:
+            t = type(source)
+            msg = f"Unsupported type: {t}"
+            raise TypeError(msg)
+
+
 def dict_to_struct(d: dict) -> structpb.Struct:
     """Create a Struct well-known type from the supplied dict.
 

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/pyproject.toml

@@ -16,7 +16,13 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
 ]
 
-dependencies = ["grpcio==1.*", "grpcio-reflection==1.*", "protobuf==5.27.2", "structlog==24.*"]
+dependencies = [
+  "grpcio==1.*",
+  "grpcio-reflection==1.*",
+  "protobuf==5.27.2",
+  "pydantic==2.*",
+  "structlog==24.*",
+]
 
 dynamic = ["version"]
 
@@ -32,34 +38,17 @@ validate-bump = false                       # Allow going from 0.0.0.dev0+x to 0
 [tool.hatch.envs.default]
 type = "virtual"
 path = ".venv-default"
-dependencies = ["ipython==8.27.0"]
+dependencies = ["ipython==8.28.0"]
 
 [tool.hatch.envs.generate]
 type = "virtual"
 detached = true
 path = ".venv-generate"
-dependencies = ["grpcio-tools==1.66.1"]
+dependencies = ["grpcio-tools==1.66.2"]
 
 [tool.hatch.envs.generate.scripts]
 protoc = "python -m grpc_tools.protoc --proto_path=. --python_out=. --pyi_out=. --grpc_python_out=. crossplane/function/proto/v1beta1/run_function.proto crossplane/function/proto/v1/run_function.proto"
 
-[tool.hatch.envs.lint]
-type = "virtual"
-detached = true
-path = ".venv-lint"
-dependencies = ["ruff==0.6.5"]
-
-[tool.hatch.envs.lint.scripts]
-check = "ruff format crossplane tests && ruff check --fix crossplane tests"
-
-
-[tool.hatch.envs.test]
-type = "virtual"
-path = ".venv-test"
-
-[tool.hatch.envs.test.scripts]
-unit = "python -m unittest tests/*.py"
-
 [tool.hatch.envs.docs]
 type = "virtual"
 path = ".venv-docs"
@@ -71,9 +60,14 @@ generate = "pdoc -m google crossplane/function -o docs"
 [tool.hatch.build.targets.wheel]
 packages = ["crossplane"]
 
+# This special environment is used by hatch fmt.
+[tool.hatch.envs.hatch-static-analysis]
+dependencies = ["ruff==0.6.9"]
+config-path = "none"           # Disable Hatch's default Ruff config.
+
 [tool.ruff]
 target-version = "py311"
-exclude = ["crossplane/function/proto/*"]
+exclude = ["crossplane/function/proto/*", "tests/testdata/*"]
 lint.select = [
   "A",
   "ARG",

{crossplane_function_sdk_python-0.4.0 → crossplane_function_sdk_python-0.5.0}/tests/test_resource.py

@@ -16,15 +16,94 @@ import dataclasses
 import datetime
 import unittest
 
+import pydantic
+from google.protobuf import json_format
 from google.protobuf import struct_pb2 as structpb
 
+import crossplane.function.proto.v1.run_function_pb2 as fnv1
 from crossplane.function import logging, resource
+from tests.testdata.models.io.upbound.aws.s3 import v1beta2
 
 
 class TestResource(unittest.TestCase):
     def setUp(self) -> None:
         logging.configure(level=logging.Level.DISABLED)
 
+    def test_add(self) -> None:
+        @dataclasses.dataclass
+        class TestCase:
+            reason: str
+            r: fnv1.Resource
+            source: dict | structpb.Struct | pydantic.BaseModel
+            want: fnv1.Resource
+
+        cases = [
+            TestCase(
+                reason="Updating from a dict should work.",
+                r=fnv1.Resource(),
+                source={"apiVersion": "example.org", "kind": "Resource"},
+                want=fnv1.Resource(
+                    resource=resource.dict_to_struct(
+                        {"apiVersion": "example.org", "kind": "Resource"}
+                    ),
+                ),
+            ),
+            TestCase(
+                reason="Updating an existing resource from a dict should work.",
+                r=fnv1.Resource(
+                    resource=resource.dict_to_struct(
+                        {"apiVersion": "example.org", "kind": "Resource"}
+                    ),
+                ),
+                source={
+                    "metadata": {"name": "cool"},
+                },
+                want=fnv1.Resource(
+                    resource=resource.dict_to_struct(
+                        {
+                            "apiVersion": "example.org",
+                            "kind": "Resource",
+                            "metadata": {"name": "cool"},
+                        }
+                    ),
+                ),
+            ),
+            TestCase(
+                reason="Updating from a struct should work.",
+                r=fnv1.Resource(),
+                source=resource.dict_to_struct(
+                    {"apiVersion": "example.org", "kind": "Resource"}
+                ),
+                want=fnv1.Resource(
+                    resource=resource.dict_to_struct(
+                        {"apiVersion": "example.org", "kind": "Resource"}
+                    ),
+                ),
+            ),
+            TestCase(
+                reason="Updating from a Pydantic model should work.",
+                r=fnv1.Resource(),
+                source=v1beta2.Bucket(
+                    spec=v1beta2.Spec(
+                        forProvider=v1beta2.ForProvider(region="us-west-2"),
+                    ),
+                ),
+                want=fnv1.Resource(
+                    resource=resource.dict_to_struct(
+                        {"spec": {"forProvider": {"region": "us-west-2"}}}
+                    ),
+                ),
+            ),
+        ]
+
+        for case in cases:
+            resource.update(case.r, case.source)
+            self.assertEqual(
+                json_format.MessageToDict(case.want),
+                json_format.MessageToDict(case.r),
+                "-want, +got",
+            )
+
     def test_get_condition(self) -> None:
         @dataclasses.dataclass
         class TestCase:

crossplane_function_sdk_python-0.5.0/tests/testdata/models/io/k8s/apimachinery/pkg/apis/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  <stdin>
+#   timestamp: 2024-10-04T21:01:52+00:00

crossplane_function_sdk_python-0.5.0/tests/testdata/models/io/k8s/apimachinery/pkg/apis/meta/__init__.py

@@ -0,0 +1,3 @@
+# generated by datamodel-codegen:
+#   filename:  <stdin>
+#   timestamp: 2024-10-04T21:01:52+00:00

crossplane_function_sdk_python-0.5.0/tests/testdata/models/io/k8s/apimachinery/pkg/apis/meta/v1.py

@@ -0,0 +1,301 @@
+# generated by datamodel-codegen:
+#   filename:  <stdin>
+#   timestamp: 2024-10-04T21:01:52+00:00
+
+from __future__ import annotations
+
+from typing import Dict, List, Optional
+
+from pydantic import AwareDatetime, BaseModel, Field, RootModel
+
+
+class FieldsV1(BaseModel):
+    pass
+
+
+class ListMeta(BaseModel):
+    continue_: Optional[str] = Field(None, alias='continue')
+    """
+    continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
+    """
+    remainingItemCount: Optional[int] = None
+    """
+    remainingItemCount is the number of subsequent items in the list which are not included in this list response. If the list request contained label or field selectors, then the number of remaining items is unknown and the field will be left unset and omitted during serialization. If the list is complete (either because it is not chunking or because this is the last chunk), then there are no more remaining items and this field will be left unset and omitted during serialization. Servers older than v1.15 do not set this field. The intended use of the remainingItemCount is *estimating* the size of a collection. Clients should not rely on the remainingItemCount to be set or to be exact.
+    """
+    resourceVersion: Optional[str] = None
+    """
+    String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+    """
+    selfLink: Optional[str] = None
+    """
+    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+    """
+
+
+class OwnerReference(BaseModel):
+    apiVersion: str
+    """
+    API version of the referent.
+    """
+    blockOwnerDeletion: Optional[bool] = None
+    """
+    If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion for how the garbage collector interacts with this field and enforces the foreground deletion. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
+    """
+    controller: Optional[bool] = None
+    """
+    If true, this reference points to the managing controller.
+    """
+    kind: str
+    """
+    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+    """
+    name: str
+    """
+    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+    """
+    uid: str
+    """
+    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+    """
+
+
+class Patch(BaseModel):
+    pass
+
+
+class Preconditions(BaseModel):
+    resourceVersion: Optional[str] = None
+    """
+    Specifies the target ResourceVersion
+    """
+    uid: Optional[str] = None
+    """
+    Specifies the target UID.
+    """
+
+
+class StatusCause(BaseModel):
+    field: Optional[str] = None
+    """
+    The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed.  Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
+
+    Examples:
+      "name" - the field "name" on the current resource
+      "items[0].name" - the field "name" on the first array entry in "items"
+    """
+    message: Optional[str] = None
+    """
+    A human-readable description of the cause of the error.  This field may be presented as-is to a reader.
+    """
+    reason: Optional[str] = None
+    """
+    A machine-readable description of the cause of the error. If this value is empty there is no information available.
+    """
+
+
+class StatusDetails(BaseModel):
+    causes: Optional[List[StatusCause]] = None
+    """
+    The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
+    """
+    group: Optional[str] = None
+    """
+    The group attribute of the resource associated with the status StatusReason.
+    """
+    kind: Optional[str] = None
+    """
+    The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+    """
+    name: Optional[str] = None
+    """
+    The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
+    """
+    retryAfterSeconds: Optional[int] = None
+    """
+    If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
+    """
+    uid: Optional[str] = None
+    """
+    UID of the resource. (when there is a single resource which can be described). More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+    """
+
+
+class Time(RootModel[AwareDatetime]):
+    root: AwareDatetime
+    """
+    Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON.  Wrappers are provided for many of the factory methods that the time package offers.
+    """
+
+
+class DeleteOptions(BaseModel):
+    apiVersion: Optional[str] = None
+    """
+    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+    """
+    dryRun: Optional[List[str]] = None
+    """
+    When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
+    """
+    gracePeriodSeconds: Optional[int] = None
+    """
+    The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
+    """
+    kind: Optional[str] = None
+    """
+    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+    """
+    orphanDependents: Optional[bool] = None
+    """
+    Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
+    """
+    preconditions: Optional[Preconditions] = None
+    """
+    Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
+    """
+    propagationPolicy: Optional[str] = None
+    """
+    Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
+    """
+
+
+class ManagedFieldsEntry(BaseModel):
+    apiVersion: Optional[str] = None
+    """
+    APIVersion defines the version of this resource that this field set applies to. The format is "group/version" just like the top-level APIVersion field. It is necessary to track the version of a field set because it cannot be automatically converted.
+    """
+    fieldsType: Optional[str] = None
+    """
+    FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"
+    """
+    fieldsV1: Optional[FieldsV1] = None
+    """
+    FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
+    """
+    manager: Optional[str] = None
+    """
+    Manager is an identifier of the workflow managing these fields.
+    """
+    operation: Optional[str] = None
+    """
+    Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.
+    """
+    subresource: Optional[str] = None
+    """
+    Subresource is the name of the subresource used to update that object, or empty string if the object was updated through the main resource. The value of this field is used to distinguish between managers, even if they share the same name. For example, a status update will be distinct from a regular update using the same manager name. Note that the APIVersion field is not related to the Subresource field and it always corresponds to the version of the main resource.
+    """
+    time: Optional[Time] = None
+    """
+    Time is the timestamp of when the ManagedFields entry was added. The timestamp will also be updated if a field is added, the manager changes any of the owned fields value or removes a field. The timestamp does not update when a field is removed from the entry because another manager took it over.
+    """
+
+
+class ObjectMeta(BaseModel):
+    annotations: Optional[Dict[str, str]] = None
+    """
+    Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
+    """
+    creationTimestamp: Optional[Time] = None
+    """
+    CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
+
+    Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+    """
+    deletionGracePeriodSeconds: Optional[int] = None
+    """
+    Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
+    """
+    deletionTimestamp: Optional[Time] = None
+    """
+    DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
+
+    Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
+    """
+    finalizers: Optional[List[str]] = None
+    """
+    Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order.  Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list.
+    """
+    generateName: Optional[str] = None
+    """
+    GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
+
+    If this field is specified and the generated name exists, the server will return a 409.
+
+    Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
+    """
+    generation: Optional[int] = None
+    """
+    A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
+    """
+    labels: Optional[Dict[str, str]] = None
+    """
+    Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
+    """
+    managedFields: Optional[List[ManagedFieldsEntry]] = None
+    """
+    ManagedFields maps workflow-id and version to the set of fields that are managed by that workflow. This is mostly for internal housekeeping, and users typically shouldn't need to set or understand this field. A workflow can be the user's name, a controller's name, or the name of a specific apply path like "ci-cd". The set of fields is always in the version that the workflow used when modifying the object.
+    """
+    name: Optional[str] = None
+    """
+    Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
+    """
+    namespace: Optional[str] = None
+    """
+    Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
+
+    Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
+    """
+    ownerReferences: Optional[List[OwnerReference]] = None
+    """
+    List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
+    """
+    resourceVersion: Optional[str] = None
+    """
+    An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
+
+    Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
+    """
+    selfLink: Optional[str] = None
+    """
+    Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
+    """
+    uid: Optional[str] = None
+    """
+    UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
+
+    Populated by the system. Read-only. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
+    """
+
+
+class Status(BaseModel):
+    apiVersion: Optional[str] = None
+    """
+    APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
+    """
+    code: Optional[int] = None
+    """
+    Suggested HTTP return code for this status, 0 if not set.
+    """
+    details: Optional[StatusDetails] = None
+    """
+    Extended data associated with the reason.  Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
+    """
+    kind: Optional[str] = None
+    """
+    Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+    """
+    message: Optional[str] = None
+    """
+    A human-readable description of the status of this operation.
+    """
+    metadata: Optional[ListMeta] = {}
+    """
+    Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
+    """
+    reason: Optional[str] = None
+    """
+    A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
+    """
+    status: Optional[str] = None
+    """
+    Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
+    """