Retornam/edits (#94)

* Update python packages

* Update proto files

Author: ddl-retornam

Pipfile

@@ -9,7 +9,7 @@ container-runtime-interface-api = {editable = true, path = "."}
 [dev-packages]
 build = "*"
 exceptiongroup = "*" # Required for Python versions < 3.11
-grpcio-tools = "~=1.47"
+grpcio-tools = "~=1.73"
 mypy = "*"
 mypy-protobuf = "*"
 pytest = "*"

bin/update-proto.sh

@@ -8,25 +8,22 @@ cd "$SCRIPT_DIR/../" || exit 1
 # Commented out until 1.26 is fully supported
 # git submodule update --init --recursive --remote --merge
 
-pipenv run python -m grpc_tools.protoc \
-  -I vendor \
-  -I vendor/github.com/gogo/protobuf/ \
-  -I vendor/cri-api/pkg/apis/runtime/ \
-  --python_out=src/cri_api \
-  --mypy_out=src/cri_api \
-  --grpc_python_out=src/cri_api \
-  v1/api.proto \
-  vendor/github.com/gogo/protobuf/gogoproto/gogo.proto
 
-pipenv run python -m grpc_tools.protoc \
+# find all prot files under the vendor/cri-api/pkg/apis/runtime/ directory
+# strip vendor/cri-api/pkg/apis/runtime/ leaving only the folder before
+# vendor/cri-api/pkg/apis/runtime/v1/api.proto becomes
+# v1/api.proto
+find vendor/cri-api/pkg/apis/runtime/ -name '*.proto' | sed 's|vendor/cri-api/pkg/apis/runtime/||' | \
+xargs pipenv run python -m grpc_tools.protoc \
   -I vendor \
   -I vendor/github.com/gogo/protobuf/ \
   -I vendor/cri-api/pkg/apis/runtime/ \
   --python_out=src/cri_api \
   --mypy_out=src/cri_api \
   --grpc_python_out=src/cri_api \
-  v1alpha2/api.proto \
   vendor/github.com/gogo/protobuf/gogoproto/gogo.proto
 
+
+# replace from v1 or from github with cri_api
 find src/cri_api/ -type f -name '*.py' -print0 | xargs -0 -P 1 -I {} sed -i '' -Ee 's/from (v1|github)/from cri_api.\1/' {}
 pipenv run black .

setup.py

@@ -8,8 +8,8 @@
     packages=setuptools.find_namespace_packages(where="src"),
     package_dir={"": "src"},
     include_package_data=True,
-    install_requires=["grpcio~=1.39", "protobuf~=4.2"],
-    version="2.0.0",
+    install_requires=["grpcio~=1.73", "protobuf~=6.31"],
+    version="2.0.1",
     author="Domino Data Lab",
     author_email="[email protected]",
     description="Python library for interaction with the Kubernetes container runtime interface API.",  # noqa

src/cri_api/github.com/gogo/protobuf/gogoproto/gogo_pb2_grpc.py

@@ -1,4 +1,3 @@
 # Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
 """Client and server classes corresponding to protobuf-defined services."""
 import grpc
-

src/cri_api/github/com/gogo/protobuf/gogoproto/gogo_pb2.py

@@ -0,0 +1,27 @@
+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+import warnings
+
+
+GRPC_GENERATED_VERSION = "1.73.1"
+GRPC_VERSION = grpc.__version__
+_version_not_supported = False
+
+try:
+    from grpc._utilities import first_version_is_lower
+
+    _version_not_supported = first_version_is_lower(
+        GRPC_VERSION, GRPC_GENERATED_VERSION
+    )
+except ImportError:
+    _version_not_supported = True
+
+if _version_not_supported:
+    raise RuntimeError(
+        f"The grpc package installed is at version {GRPC_VERSION},"
+        + f" but the generated code in github.com/gogo/protobuf/gogoproto/gogo_pb2_grpc.py depends on"
+        + f" grpcio>={GRPC_GENERATED_VERSION}."
+        + f" Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}"
+        + f" or downgrade your generated code using grpcio-tools<={GRPC_VERSION}."
+    )

src/cri_api/github/com/gogo/protobuf/gogoproto/gogo_pb2.pyi

@@ -9,6 +9,7 @@
 from .exceptions import ImageServiceException
 from .v1.api_pb2 import (
     AuthConfig,
+    ImageFilter,
     ImageSpec,
     ImageStatusRequest,
     ListImagesRequest,
@@ -17,6 +18,7 @@
 )
 from .v1.api_pb2_grpc import ImageServiceStub
 from .v1alpha2.api_pb2 import AuthConfig as V1Alpha2AuthConfig
+from .v1alpha2.api_pb2 import ImageFilter as V1Alpha2ImageFilter
 from .v1alpha2.api_pb2 import ImageSpec as V1Alpha2ImageSpec
 from .v1alpha2.api_pb2 import ImageStatusRequest as V1Alpha2ImageStatusRequest
 from .v1alpha2.api_pb2 import ListImagesRequest as V1Alpha2ListImagesRequest
@@ -34,14 +36,35 @@ def __init__(self, channel: Channel) -> None:
             else V1Alpha2ImageServiceStub(channel.channel)
         )
 
-    # TODO filter?
-    def list_images(self) -> List[dict]:
+    def list_images(
+        self, image_filter: Optional[Union[ImageFilter, V1Alpha2ImageFilter]] = None
+    ) -> List[dict]:
         try:
-            response = self.stub.ListImages(
-                ListImagesRequest()
-                if self.channel.version == V1
-                else V1Alpha2ListImagesRequest()
-            )
+            request: Union[ListImagesRequest, V1Alpha2ListImagesRequest]
+            if self.channel.version == V1:
+                # Only pass if it's the right type
+                if image_filter is not None and not isinstance(
+                    image_filter, ImageFilter
+                ):
+                    raise TypeError("For V1, image_filter must be of type ImageFilter")
+                request = (
+                    ListImagesRequest(filter=image_filter)
+                    if image_filter
+                    else ListImagesRequest()
+                )
+            else:
+                if image_filter is not None and not isinstance(
+                    image_filter, V1Alpha2ImageFilter
+                ):
+                    raise TypeError(
+                        "For V1Alpha2, image_filter must be of type V1Alpha2ImageFilter"
+                    )
+                request = (
+                    V1Alpha2ListImagesRequest(filter=image_filter)
+                    if image_filter
+                    else V1Alpha2ListImagesRequest()
+                )
+            response = self.stub.ListImages(request)
             return MessageToDict(response).get("images", [])
         except RpcError as e:
             raise ImageServiceException(e.code(), e.details()) from e
@@ -73,9 +96,11 @@ def pull_image(self, image_ref: str, auth_config: Optional[dict] = None) -> None
         else:
             request = V1Alpha2PullImageRequest(
                 image=V1Alpha2ImageSpec(image=image_ref),
-                auth=ParseDict(auth_config, V1Alpha2AuthConfig())
-                if auth_config
-                else None,
+                auth=(
+                    ParseDict(auth_config, V1Alpha2AuthConfig())
+                    if auth_config
+                    else None
+                ),
             )
 
         try: