AutomationDev85 commented on code in PR #56700: URL: https://github.com/apache/airflow/pull/56700#discussion_r2446741011
########## providers/cncf/kubernetes/src/airflow/providers/cncf/kubernetes/utils/container.py: ########## @@ -0,0 +1,121 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +"""Helper functions for inspecting and interacting with containers in a Kubernetes Pod.""" + +from __future__ import annotations + +from contextlib import suppress +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from kubernetes.client.models.v1_container_status import V1ContainerStatus + from kubernetes.client.models.v1_pod import V1Pod + + +def get_container_status(pod: V1Pod, container_name: str) -> V1ContainerStatus | None: + """Retrieve container status.""" + if pod and pod.status: + container_statuses = [] + if pod.status.container_statuses: + container_statuses.extend(pod.status.container_statuses) + if pod.status.init_container_statuses: + container_statuses.extend(pod.status.init_container_statuses) + + else: + container_statuses = None + + if container_statuses: + # In general the variable container_statuses can store multiple items matching different containers. + # The following generator expression yields all items that have name equal to the container_name. + # The function next() here calls the generator to get only the first value. If there's nothing found + # then None is returned. + return next((x for x in container_statuses if x.name == container_name), None) + return None + + +def container_is_running(pod: V1Pod, container_name: str) -> bool: + """ + Examine V1Pod ``pod`` to determine whether ``container_name`` is running. + + If that container is present and running, returns True. Returns False otherwise. + """ + container_status = get_container_status(pod, container_name) + if not container_status: + return False + return container_status.state.running is not None + + +def container_is_completed(pod: V1Pod, container_name: str) -> bool: + """ + Examine V1Pod ``pod`` to determine whether ``container_name`` is completed. + + If that container is present and completed, returns True. Returns False otherwise. + """ + container_status = get_container_status(pod, container_name) + if not container_status: + return False + return container_status.state.terminated is not None + + +def container_is_succeeded(pod: V1Pod, container_name: str) -> bool: + """ + Examine V1Pod ``pod`` to determine whether ``container_name`` is completed and succeeded. + + If that container is present and completed and succeeded, returns True. Returns False otherwise. + """ + if not container_is_completed(pod, container_name): + return False + + container_status = get_container_status(pod, container_name) Review Comment: Thanks for your feedback and good catch. I optimized the function call. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
