# -*- coding: utf-8 -*-
# Asynchronous MinIO Client SDK for Python
# (C) 2020 MinIO, Inc.
# (C) 2022 Huseyn Mashadiyev <mashadiyev.huseyn@gmail.com>
# (C) 2022 L-ING <hlf01@icloud.com>
#
# Licensed 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.
"""Request/response of DeleteObjects API."""
from __future__ import absolute_import, annotations
from typing import Type, TypeVar, cast
from xml.etree import ElementTree as ET
from .xml import Element, SubElement, findall, findtext
[docs]
class DeleteObject:
"""Delete object request information."""
def __init__(self, name: str, version_id: str | None = None):
self._name = name
self._version_id = version_id
[docs]
def toxml(self, element: ET.Element | None) -> ET.Element:
"""Convert to XML."""
if element is None:
raise ValueError("element must be provided")
element = SubElement(element, "Object")
SubElement(element, "Key", self._name)
if self._version_id is not None:
SubElement(element, "VersionId", self._version_id)
return element
[docs]
class DeleteRequest:
"""Delete object request."""
def __init__(self, object_list: list[DeleteObject], quiet: bool = False):
self._object_list = object_list
self._quiet = quiet
[docs]
def toxml(self, element: ET.Element | None) -> ET.Element:
"""Convert to XML."""
element = Element("Delete")
if self._quiet:
SubElement(element, "Quiet", "true")
for obj in self._object_list:
obj.toxml(element)
return element
A = TypeVar("A", bound="DeletedObject")
[docs]
class DeletedObject:
"""Deleted object information."""
def __init__(
self,
name: str,
version_id: str | None,
delete_marker: bool,
delete_marker_version_id: str | None,
):
self._name = name
self._version_id = version_id
self._delete_marker = delete_marker
self._delete_marker_version_id = delete_marker_version_id
@property
def name(self) -> str:
"""Get name."""
return self._name
@property
def version_id(self) -> str | None:
"""Get version ID."""
return self._version_id
@property
def delete_marker(self) -> bool:
"""Get delete marker."""
return self._delete_marker
@property
def delete_marker_version_id(self) -> str | None:
"""Get delete marker version ID."""
return self._delete_marker_version_id
[docs]
@classmethod
def fromxml(cls: Type[A], element: ET.Element) -> A:
"""Create new object with values from XML element."""
name = cast(str, findtext(element, "Key", True))
version_id = findtext(element, "VersionId")
delete_marker = findtext(element, "DeleteMarker")
delete_marker = delete_marker is not None and delete_marker.title() == "True"
delete_marker_version_id = findtext(element, "DeleteMarkerVersionId")
return cls(name, version_id, delete_marker, delete_marker_version_id)
B = TypeVar("B", bound="DeleteError")
[docs]
class DeleteError:
"""Delete error information."""
def __init__(
self,
code: str,
message: str | None,
name: str | None,
version_id: str | None,
):
self._code = code
self._message = message
self._name = name
self._version_id = version_id
@property
def code(self) -> str:
"""Get error code."""
return self._code
@property
def message(self) -> str | None:
"""Get error message."""
return self._message
@property
def name(self) -> str | None:
"""Get name."""
return self._name
@property
def version_id(self) -> str | None:
"""Get version ID."""
return self._version_id
[docs]
@classmethod
def fromxml(cls: Type[B], element: ET.Element) -> B:
"""Create new object with values from XML element."""
code = cast(str, findtext(element, "Code", True))
message = findtext(element, "Message")
name = findtext(element, "Key")
version_id = findtext(element, "VersionId")
return cls(code, message, name, version_id)
C = TypeVar("C", bound="DeleteResult")
[docs]
class DeleteResult:
"""Delete object result."""
def __init__(
self,
object_list: list[DeletedObject],
error_list: list[DeleteError],
):
self._object_list = object_list
self._error_list = error_list
@property
def object_list(self) -> list[DeletedObject]:
"""Get object list."""
return self._object_list
@property
def error_list(self) -> list[DeleteError]:
"""Get error list."""
return self._error_list
[docs]
@classmethod
def fromxml(cls: Type[C], element: ET.Element) -> C:
"""Create new object with values from XML element."""
elements = findall(element, "Deleted")
object_list = []
for tag in elements:
object_list.append(DeletedObject.fromxml(tag))
elements = findall(element, "Error")
error_list = []
for tag in elements:
error_list.append(DeleteError.fromxml(tag))
return cls(object_list, error_list)