deleteobjects.py 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
  1. # -*- coding: utf-8 -*-
  2. # MinIO Python Library for Amazon S3 Compatible Cloud Storage, (C)
  3. # 2020 MinIO, Inc.
  4. #
  5. # Licensed under the Apache License, Version 2.0 (the "License");
  6. # you may not use this file except in compliance with the License.
  7. # You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. """Request/response of DeleteObjects API."""
  17. from __future__ import absolute_import, annotations
  18. from dataclasses import dataclass
  19. from typing import Optional, Type, TypeVar, cast
  20. from xml.etree import ElementTree as ET
  21. from .xml import Element, SubElement, findall, findtext
  22. @dataclass(frozen=True)
  23. class DeleteObject:
  24. """Delete object request information."""
  25. name: str
  26. version_id: Optional[str] = None
  27. def toxml(self, element: Optional[ET.Element]) -> ET.Element:
  28. """Convert to XML."""
  29. if element is None:
  30. raise ValueError("element must be provided")
  31. element = SubElement(element, "Object")
  32. SubElement(element, "Key", self.name)
  33. if self.version_id is not None:
  34. SubElement(element, "VersionId", self.version_id)
  35. return element
  36. @dataclass(frozen=True)
  37. class DeleteRequest:
  38. """Delete object request."""
  39. object_list: list[DeleteObject]
  40. quiet: bool = False
  41. def toxml(self, element: Optional[ET.Element]) -> ET.Element:
  42. """Convert to XML."""
  43. element = Element("Delete")
  44. if self.quiet:
  45. SubElement(element, "Quiet", "true")
  46. for obj in self.object_list:
  47. obj.toxml(element)
  48. return element
  49. A = TypeVar("A", bound="DeletedObject")
  50. @dataclass(frozen=True)
  51. class DeletedObject:
  52. """Deleted object information."""
  53. name: str
  54. version_id: Optional[str]
  55. delete_marker: bool
  56. delete_marker_version_id: Optional[str]
  57. @classmethod
  58. def fromxml(cls: Type[A], element: ET.Element) -> A:
  59. """Create new object with values from XML element."""
  60. name = cast(str, findtext(element, "Key", True))
  61. version_id = findtext(element, "VersionId")
  62. delete_marker = findtext(element, "DeleteMarker")
  63. delete_marker_version_id = findtext(element, "DeleteMarkerVersionId")
  64. return cls(
  65. name=name,
  66. version_id=version_id,
  67. delete_marker=(
  68. delete_marker is not None and delete_marker.title() == "True"
  69. ),
  70. delete_marker_version_id=delete_marker_version_id,
  71. )
  72. B = TypeVar("B", bound="DeleteError")
  73. @dataclass(frozen=True)
  74. class DeleteError:
  75. """Delete error information."""
  76. code: str
  77. message: Optional[str]
  78. name: Optional[str]
  79. version_id: Optional[str]
  80. @classmethod
  81. def fromxml(cls: Type[B], element: ET.Element) -> B:
  82. """Create new object with values from XML element."""
  83. code = cast(str, findtext(element, "Code", True))
  84. message = findtext(element, "Message")
  85. name = findtext(element, "Key")
  86. version_id = findtext(element, "VersionId")
  87. return cls(
  88. code=code,
  89. message=message,
  90. name=name,
  91. version_id=version_id,
  92. )
  93. C = TypeVar("C", bound="DeleteResult")
  94. @dataclass(frozen=True)
  95. class DeleteResult:
  96. """Delete object result."""
  97. object_list: list[DeletedObject]
  98. error_list: list[DeleteError]
  99. @classmethod
  100. def fromxml(cls: Type[C], element: ET.Element) -> C:
  101. """Create new object with values from XML element."""
  102. elements = findall(element, "Deleted")
  103. object_list = []
  104. for tag in elements:
  105. object_list.append(DeletedObject.fromxml(tag))
  106. elements = findall(element, "Error")
  107. error_list = []
  108. for tag in elements:
  109. error_list.append(DeleteError.fromxml(tag))
  110. return cls(object_list=object_list, error_list=error_list)