diff --git a/sdk/containerregistry/azure-containerregistry/MANIFEST.in b/sdk/containerregistry/azure-containerregistry/MANIFEST.in index 442a31f67463..bce87c056b23 100644 --- a/sdk/containerregistry/azure-containerregistry/MANIFEST.in +++ b/sdk/containerregistry/azure-containerregistry/MANIFEST.in @@ -1,6 +1,7 @@ include *.md -include azure/__init__.py include LICENSE +include azure/containerregistry/_generated/py.typed recursive-include tests *.py recursive-include samples *.py *.md -include azure/containerregistry/py.typed +include azure/__init__.py +include azure/containerregistry/__init__.py diff --git a/sdk/containerregistry/azure-containerregistry/_metadata.json b/sdk/containerregistry/azure-containerregistry/_metadata.json new file mode 100644 index 000000000000..45610089d6c2 --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/_metadata.json @@ -0,0 +1,3 @@ +{ + "apiVersion": "2021-07-01" +} \ No newline at end of file diff --git a/sdk/containerregistry/azure-containerregistry/apiview-properties.json b/sdk/containerregistry/azure-containerregistry/apiview-properties.json new file mode 100644 index 000000000000..8806ba399e1f --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/apiview-properties.json @@ -0,0 +1,97 @@ +{ + "CrossLanguagePackageId": "ContainerRegistryService", + "CrossLanguageDefinitionId": { + "azure.containerregistry._generated.models.AcrAccessToken": "ContainerRegistryService.AcrAccessToken", + "azure.containerregistry._generated.models.AcrErrorInfo": "ContainerRegistryService.AcrErrorInfo", + "azure.containerregistry._generated.models.AcrErrors": "ContainerRegistryService.AcrErrors", + "azure.containerregistry._generated.models.AcrManifests": "ContainerRegistryService.AcrManifests", + "azure.containerregistry._generated.models.AcrRefreshToken": "ContainerRegistryService.AcrRefreshToken", + "azure.containerregistry._generated.models.Annotations": "ContainerRegistryService.Annotations", + "azure.containerregistry._generated.models.ArtifactManifestPlatform": "ContainerRegistryService.ArtifactManifestPlatform", + "azure.containerregistry._generated.models.ArtifactManifestProperties": "ContainerRegistryService.ArtifactManifestProperties", + "azure.containerregistry._generated.models.ArtifactTagProperties": "ContainerRegistryService.ArtifactTagProperties", + "azure.containerregistry._generated.models.ContainerRepositoryProperties": "ContainerRegistryService.ContainerRepositoryProperties", + "azure.containerregistry._generated.models.DeleteRepositoryResult": "ContainerRegistryService.DeleteRepositoryResult", + "azure.containerregistry._generated.models.Descriptor": "ContainerRegistryService.Descriptor", + "azure.containerregistry._generated.models.FsLayer": "ContainerRegistryService.FsLayer", + "azure.containerregistry._generated.models.History": "ContainerRegistryService.History", + "azure.containerregistry._generated.models.ImageSignature": "ContainerRegistryService.ImageSignature", + "azure.containerregistry._generated.models.JWK": "ContainerRegistryService.JWK", + "azure.containerregistry._generated.models.JWKHeader": "ContainerRegistryService.JWKHeader", + "azure.containerregistry._generated.models.Manifest": "ContainerRegistryService.Manifest", + "azure.containerregistry._generated.models.ManifestAttributesBase": "ContainerRegistryService.ManifestAttributesBase", + "azure.containerregistry._generated.models.ManifestListAttributes": "ContainerRegistryService.ManifestListAttributes", + "azure.containerregistry._generated.models.ManifestWrapper": "ContainerRegistryService.ManifestWrapper", + "azure.containerregistry._generated.models.ManifestWriteableProperties": "ContainerRegistryService.ManifestWriteableProperties", + "azure.containerregistry._generated.models.MultipartBodyParameter": "ContainerRegistryService.MultipartBodyParameter", + "azure.containerregistry._generated.models.Platform": "ContainerRegistryService.Platform", + "azure.containerregistry._generated.models.RepositoryWriteableProperties": "ContainerRegistryService.RepositoryWriteableProperties", + "azure.containerregistry._generated.models.TagAttributesBase": "ContainerRegistryService.TagAttributesBase", + "azure.containerregistry._generated.models.TagList": "ContainerRegistryService.TagList", + "azure.containerregistry._generated.models.TagWriteableProperties": "ContainerRegistryService.TagWriteableProperties", + "azure.containerregistry._generated.models.ArtifactTagOrder": "ContainerRegistryService.ArtifactTagOrder", + "azure.containerregistry._generated.models.ArtifactArchitecture": "ContainerRegistryService.ArtifactArchitecture", + "azure.containerregistry._generated.models.ArtifactOperatingSystem": "ContainerRegistryService.ArtifactOperatingSystem", + "azure.containerregistry._generated.models.ArtifactManifestOrder": "ContainerRegistryService.ArtifactManifestOrder", + "azure.containerregistry._generated.models.PostContentSchemaGrantType": "ContainerRegistryService.PostContentSchemaGrantType", + "azure.containerregistry._generated.models.TokenGrantType": "ContainerRegistryService.TokenGrantType", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.check_docker_v2_support": "ContainerRegistryService.ContainerRegistry.checkDockerV2Support", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.check_docker_v2_support": "ContainerRegistryService.ContainerRegistry.checkDockerV2Support", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_manifest": "ContainerRegistryService.ContainerRegistry.getManifest", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_manifest": "ContainerRegistryService.ContainerRegistry.getManifest", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.create_manifest": "ContainerRegistryService.ContainerRegistry.createManifest", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.create_manifest": "ContainerRegistryService.ContainerRegistry.createManifest", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.delete_manifest": "ContainerRegistryService.ContainerRegistry.deleteManifest", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.delete_manifest": "ContainerRegistryService.ContainerRegistry.deleteManifest", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_repositories": "ContainerRegistryService.ContainerRegistry.getRepositories", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_repositories": "ContainerRegistryService.ContainerRegistry.getRepositories", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_properties": "ContainerRegistryService.ContainerRegistry.getProperties", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_properties": "ContainerRegistryService.ContainerRegistry.getProperties", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.delete_repository": "ContainerRegistryService.ContainerRegistry.deleteRepository", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.delete_repository": "ContainerRegistryService.ContainerRegistry.deleteRepository", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.update_properties": "ContainerRegistryService.ContainerRegistry.updateProperties", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.update_properties": "ContainerRegistryService.ContainerRegistry.updateProperties", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_tags": "ContainerRegistryService.ContainerRegistry.getTags", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_tags": "ContainerRegistryService.ContainerRegistry.getTags", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_tag_properties": "ContainerRegistryService.ContainerRegistry.getTagProperties", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_tag_properties": "ContainerRegistryService.ContainerRegistry.getTagProperties", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.update_tag_attributes": "ContainerRegistryService.ContainerRegistry.updateTagAttributes", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.update_tag_attributes": "ContainerRegistryService.ContainerRegistry.updateTagAttributes", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.delete_tag": "ContainerRegistryService.ContainerRegistry.deleteTag", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.delete_tag": "ContainerRegistryService.ContainerRegistry.deleteTag", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_manifests": "ContainerRegistryService.ContainerRegistry.getManifests", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_manifests": "ContainerRegistryService.ContainerRegistry.getManifests", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.get_manifest_properties": "ContainerRegistryService.ContainerRegistry.getManifestProperties", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.get_manifest_properties": "ContainerRegistryService.ContainerRegistry.getManifestProperties", + "azure.containerregistry._generated.operations.ContainerRegistryOperations.update_manifest_properties": "ContainerRegistryService.ContainerRegistry.updateManifestProperties", + "azure.containerregistry._generated.aio.operations.ContainerRegistryOperations.update_manifest_properties": "ContainerRegistryService.ContainerRegistry.updateManifestProperties", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.get_blob": "ContainerRegistryService.ContainerRegistryBlob.getBlob", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.get_blob": "ContainerRegistryService.ContainerRegistryBlob.getBlob", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.check_blob_exists": "ContainerRegistryService.ContainerRegistryBlob.checkBlobExists", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.check_blob_exists": "ContainerRegistryService.ContainerRegistryBlob.checkBlobExists", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.delete_blob": "ContainerRegistryService.ContainerRegistryBlob.deleteBlob", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.delete_blob": "ContainerRegistryService.ContainerRegistryBlob.deleteBlob", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.mount_blob": "ContainerRegistryService.ContainerRegistryBlob.mountBlob", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.mount_blob": "ContainerRegistryService.ContainerRegistryBlob.mountBlob", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.get_upload_status": "ContainerRegistryService.ContainerRegistryBlob.getUploadStatus", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.get_upload_status": "ContainerRegistryService.ContainerRegistryBlob.getUploadStatus", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.upload_chunk": "ContainerRegistryService.ContainerRegistryBlob.uploadChunk", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.upload_chunk": "ContainerRegistryService.ContainerRegistryBlob.uploadChunk", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.complete_upload": "ContainerRegistryService.ContainerRegistryBlob.completeUpload", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.complete_upload": "ContainerRegistryService.ContainerRegistryBlob.completeUpload", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.cancel_upload": "ContainerRegistryService.ContainerRegistryBlob.cancelUpload", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.cancel_upload": "ContainerRegistryService.ContainerRegistryBlob.cancelUpload", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.start_upload": "ContainerRegistryService.ContainerRegistryBlob.startUpload", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.start_upload": "ContainerRegistryService.ContainerRegistryBlob.startUpload", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.get_chunk": "ContainerRegistryService.ContainerRegistryBlob.getChunk", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.get_chunk": "ContainerRegistryService.ContainerRegistryBlob.getChunk", + "azure.containerregistry._generated.operations.ContainerRegistryBlobOperations.check_chunk_exists": "ContainerRegistryService.ContainerRegistryBlob.checkChunkExists", + "azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations.check_chunk_exists": "ContainerRegistryService.ContainerRegistryBlob.checkChunkExists", + "azure.containerregistry._generated.operations.AuthenticationOperations.exchange_aad_access_token_for_acr_refresh_token": "ContainerRegistryService.Authentication.exchangeAadAccessTokenForAcrRefreshToken", + "azure.containerregistry._generated.aio.operations.AuthenticationOperations.exchange_aad_access_token_for_acr_refresh_token": "ContainerRegistryService.Authentication.exchangeAadAccessTokenForAcrRefreshToken", + "azure.containerregistry._generated.operations.AuthenticationOperations.exchange_acr_refresh_token_for_acr_access_token": "ContainerRegistryService.Authentication.exchangeAcrRefreshTokenForAcrAccessToken", + "azure.containerregistry._generated.aio.operations.AuthenticationOperations.exchange_acr_refresh_token_for_acr_access_token": "ContainerRegistryService.Authentication.exchangeAcrRefreshTokenForAcrAccessToken", + "azure.containerregistry._generated.operations.AuthenticationOperations.get_acr_access_token_from_login": "ContainerRegistryService.Authentication.getAcrAccessTokenFromLogin", + "azure.containerregistry._generated.aio.operations.AuthenticationOperations.get_acr_access_token_from_login": "ContainerRegistryService.Authentication.getAcrAccessTokenFromLogin" + } +} \ No newline at end of file diff --git a/sdk/containerregistry/azure-containerregistry/azure/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/__init__.py index 8db66d3d0f0f..d55ccad1f573 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/__init__.py @@ -1 +1 @@ -__path__ = __import__("pkgutil").extend_path(__path__, __name__) +__path__ = __import__("pkgutil").extend_path(__path__, __name__) # type: ignore diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/__init__.py index 6754d0fa7c62..512620f39409 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/__init__.py @@ -37,4 +37,4 @@ "GetManifestResult", "DownloadBlobStream", "DigestValidationError", -] +] \ No newline at end of file diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_anonymous_exchange_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_anonymous_exchange_client.py index 1963936fde9f..beb950b82087 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_anonymous_exchange_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_anonymous_exchange_client.py @@ -38,8 +38,8 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential endpoint = "https://" + endpoint self._endpoint = endpoint self._client = ContainerRegistry( + endpoint=endpoint, credential=AnonymousAccessCredential(), - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=ExchangeClientAuthenticationPolicy(), **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_base_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_base_client.py index 042b3474e3b2..e8fa2dafd5fa 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_base_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_base_client.py @@ -39,8 +39,8 @@ class ContainerRegistryBaseClient(object): def __init__(self, endpoint: str, credential: Optional[TokenCredential], **kwargs: Any) -> None: self._auth_policy = ContainerRegistryChallengePolicy(credential, endpoint, **kwargs) self._client = ContainerRegistry( + endpoint=endpoint, credential=credential or AnonymousAccessCredential(), - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=self._auth_policy, **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py index 97a1d66e95dc..34fefe0eb2e8 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py @@ -1,3 +1,4 @@ +# pylint: disable=too-many-lines # coding=utf-8 # ------------------------------------ # Copyright (c) Microsoft Corporation. @@ -45,8 +46,13 @@ ArtifactManifestProperties, GetManifestResult, DigestValidationError, + TagAttributesBase, ) +from ._generated.models import AcrManifests + +from ._generated._utils.model_base import _deserialize + if TYPE_CHECKING: from ._generated.models import ArtifactManifestOrder, ArtifactTagOrder JSON = MutableMapping[str, Any] @@ -173,9 +179,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/_catalog" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -199,9 +205,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -213,10 +219,10 @@ def prepare_request(next_link=None): return request def extract_data(pipeline_response): - deserialized = self._client._deserialize( # pylint: disable=protected-access - "Repositories", pipeline_response + list_of_elem = _deserialize( + list[str], + pipeline_response.http_response.internal_response.json().get("repositories", []) ) - list_of_elem = deserialized.repositories or [] if cls: list_of_elem = cls(list_of_elem) link = None @@ -303,9 +309,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/{name}/_manifests" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -334,9 +340,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -349,10 +355,10 @@ def prepare_request(next_link=None): return request def extract_data(pipeline_response): - deserialized = self._client._deserialize( # pylint: disable=protected-access - "AcrManifests", pipeline_response + list_of_elem = _deserialize( + list[AcrManifests], + pipeline_response.http_response.internal_response.json().get("manifests", []) ) - list_of_elem = deserialized.manifests or [] if cls: list_of_elem = cls(list_of_elem) link = None @@ -520,9 +526,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/{name}/_tags" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -555,9 +561,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -570,8 +576,9 @@ def prepare_request(next_link=None): return request def extract_data(pipeline_response): - deserialized = self._client._deserialize("TagList", pipeline_response) # pylint: disable=protected-access - list_of_elem = deserialized.tag_attribute_bases or [] + list_of_elem = _deserialize( + list[TagAttributesBase], pipeline_response.http_response.internal_response.json().get("tags", []) + ) if cls: list_of_elem = cls(list_of_elem) link = None @@ -990,7 +997,7 @@ def upload_blob(self, repository: str, data: IO[bytes], **kwargs: Any) -> Tuple[ complete_upload_response_headers = cast( Dict[str, str], self._client.container_registry_blob.complete_upload( - digest=digest, next_link=location, cls=_return_response_headers, **kwargs + location, digest=digest, cls=_return_response_headers, **kwargs ), ) if digest != complete_upload_response_headers["Docker-Content-Digest"]: diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_exchange_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_exchange_client.py index 3fd6d3047a43..c27a3374c659 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_exchange_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_exchange_client.py @@ -46,8 +46,8 @@ def __init__(self, endpoint: str, credential: TokenCredential, **kwargs: Any) -> self._endpoint = endpoint self.credential_scopes = kwargs.get("credential_scopes", ["https://management.core.windows.net/.default"]) self._client = ContainerRegistry( + endpoint=endpoint, credential=credential, - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=ExchangeClientAuthenticationPolicy(), **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/__init__.py index 75020eabd3bb..47f3f3c6ac8d 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/__init__.py @@ -1,14 +1,25 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import ContainerRegistry +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ContainerRegistry # type: ignore +from ._version import VERSION + +__version__ = VERSION try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -16,6 +27,6 @@ __all__ = [ "ContainerRegistry", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_client.py index 21de7a387b90..580be8af926c 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_client.py @@ -1,52 +1,72 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from copy import deepcopy from typing import Any, TYPE_CHECKING +from typing_extensions import Self from azure.core import PipelineClient +from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse -from . import models as _models from ._configuration import ContainerRegistryConfiguration -from ._serialization import Deserializer, Serializer +from ._utils.serialization import Deserializer, Serializer from .operations import AuthenticationOperations, ContainerRegistryBlobOperations, ContainerRegistryOperations if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -class ContainerRegistry: # pylint: disable=client-accepts-api-version-keyword +class ContainerRegistry: """Metadata API definition for the Azure Container Registry runtime. :ivar container_registry: ContainerRegistryOperations operations - :vartype container_registry: container_registry.operations.ContainerRegistryOperations + :vartype container_registry: + azure.containerregistry._generated.operations.ContainerRegistryOperations :ivar container_registry_blob: ContainerRegistryBlobOperations operations - :vartype container_registry_blob: container_registry.operations.ContainerRegistryBlobOperations + :vartype container_registry_blob: + azure.containerregistry._generated.operations.ContainerRegistryBlobOperations :ivar authentication: AuthenticationOperations operations - :vartype authentication: container_registry.operations.AuthenticationOperations - :param url: Registry login URL. Required. - :type url: str - :param credential: Credential needed for the client to connect to Azure. Required. + :vartype authentication: azure.containerregistry._generated.operations.AuthenticationOperations + :param endpoint: Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2021-07-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is "2021-07-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ - def __init__(self, url: str, credential: "TokenCredential", **kwargs: Any) -> None: - _endpoint = "{url}" - self._config = ContainerRegistryConfiguration(url=url, credential=credential, **kwargs) - self._client: PipelineClient = PipelineClient(base_url=_endpoint, config=self._config, **kwargs) - - client_models = {k: v for k, v in _models._models.__dict__.items() if isinstance(v, type)} - client_models.update({k: v for k, v in _models.__dict__.items() if isinstance(v, type)}) - self._serialize = Serializer(client_models) - self._deserialize = Deserializer(client_models) + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = ContainerRegistryConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: PipelineClient = PipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() self._serialize.client_side_validation = False self.container_registry = ContainerRegistryOperations( self._client, self._config, self._serialize, self._deserialize @@ -56,7 +76,7 @@ def __init__(self, url: str, credential: "TokenCredential", **kwargs: Any) -> No ) self.authentication = AuthenticationOperations(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: + def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -76,16 +96,16 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> HttpResponse: request_copy = deepcopy(request) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore def close(self) -> None: self._client.close() - def __enter__(self) -> "ContainerRegistry": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_configuration.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_configuration.py index c564f6b32232..e5f176db23a2 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_configuration.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_configuration.py @@ -1,50 +1,50 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from typing import Any, TYPE_CHECKING -from azure.core.configuration import Configuration from azure.core.pipeline import policies +from ._version import VERSION + if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials import TokenCredential -VERSION = "unknown" - -class ContainerRegistryConfiguration(Configuration): # pylint: disable=too-many-instance-attributes,name-too-long +class ContainerRegistryConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for ContainerRegistry. Note that all parameters used to create this instance are saved as instance attributes. - :param url: Registry login URL. Required. - :type url: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param endpoint: Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. :type credential: ~azure.core.credentials.TokenCredential - :keyword api_version: Api Version. Default value is "2021-07-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is "2021-07-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ - def __init__(self, url: str, credential: "TokenCredential", **kwargs: Any) -> None: - super(ContainerRegistryConfiguration, self).__init__(**kwargs) + def __init__(self, endpoint: str, credential: "TokenCredential", **kwargs: Any) -> None: api_version: str = kwargs.pop("api_version", "2021-07-01") - if url is None: - raise ValueError("Parameter 'url' must not be None.") + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") if credential is None: raise ValueError("Parameter 'credential' must not be None.") - self.url = url + self.endpoint = endpoint self.credential = credential self.api_version = api_version self.credential_scopes = kwargs.pop("credential_scopes", []) kwargs.setdefault("sdk_moniker", "containerregistry/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -53,9 +53,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.RedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.RetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if not self.credential_scopes and not self.authentication_policy: raise ValueError("You must provide either credential_scopes or authentication_policy as kwargs") diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_patch.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_patch.py index 17dbc073e01b..87676c65a8f0 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_patch.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_patch.py @@ -1,32 +1,21 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# # Copyright (c) Microsoft Corporation. All rights reserved. -# -# The MIT License (MIT) -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the ""Software""), to -# deal in the Software without restriction, including without limitation the -# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -# sell copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -# IN THE SOFTWARE. -# +# Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level -# This file is used for handwritten extensions to the generated code. Example: -# https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md def patch_sdk(): - pass + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/model_base.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/model_base.py new file mode 100644 index 000000000000..12926fa98dcf --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/model_base.py @@ -0,0 +1,1237 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null +from azure.core.rest import HttpResponse + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: # pylint: disable=too-many-nested-blocks + if isinstance(args[0], ET.Element): + existed_attr_keys = [] + model_meta = getattr(self, "_xml", {}) + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and args[0].get(xml_name) is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + if prop_meta.get("itemsName"): + xml_name = prop_meta.get("itemsName") + xml_ns = prop_meta.get("itemNs") + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = args[0].findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, items) + continue + + # text element is primitive type + if prop_meta.get("text", False): + if args[0].text is not None: + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = args[0].find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in args[0]: + if e.tag not in existed_attr_keys: + dict_to_pass[e.tag] = _convert_element(e) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + wrapped_element = _create_xml_element( + model_meta.get("name", o.__class__.__name__), + model_meta.get("prefix"), + model_meta.get("ns"), + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # if no ns for prop, use model's + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + xml_name = prop_meta.get("name", k) + if prop_meta.get("ns"): + ET.register_namespace(prop_meta.get("prefix"), prop_meta.get("ns")) # pyright: ignore + xml_name = "{" + prop_meta.get("ns") + "}" + xml_name # pyright: ignore + # attribute should be primitive type + wrapped_element.set(xml_name, _get_primitive_type_value(v)) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": parent_meta.get("ns") if parent_meta else None, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": parent_meta.get("itemsNs", parent_meta.get("ns")), + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, meta.get("ns") if meta else None + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _create_xml_element(tag, prefix=None, ns=None): + if prefix and ns: + ET.register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_serialization.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/serialization.py similarity index 79% rename from sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_serialization.py rename to sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/serialization.py index 9f3e29b11388..45a3e44e45cb 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_serialization.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/serialization.py @@ -1,30 +1,12 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# coding=utf-8 # -------------------------------------------------------------------------- -# # Copyright (c) Microsoft Corporation. All rights reserved. -# -# The MIT License (MIT) -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the ""Software""), to -# deal in the Software without restriction, including without limitation the -# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -# sell copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -# IN THE SOFTWARE. -# +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -# pylint: skip-file # pyright: reportUnnecessaryTypeIgnoreComment=false from base64 import b64decode, b64encode @@ -39,7 +21,6 @@ import sys import codecs from typing import ( - Dict, Any, cast, Optional, @@ -48,11 +29,7 @@ IO, Mapping, Callable, - TypeVar, MutableMapping, - Type, - List, - Mapping, ) try: @@ -62,13 +39,13 @@ import xml.etree.ElementTree as ET import isodate # type: ignore +from typing_extensions import Self -from azure.core.exceptions import DeserializationError, SerializationError, raise_with_traceback -from azure.core.serialization import NULL as AzureCoreNull +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull _BOM = codecs.BOM_UTF8.decode(encoding="utf-8") -ModelType = TypeVar("ModelType", bound="Model") JSON = MutableMapping[str, Any] @@ -91,6 +68,8 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: :param data: Input, could be bytes or stream (will be decoded with UTF8) or text :type data: str or bytes or IO :param str content_type: The content type. + :return: The deserialized data. + :rtype: object """ if hasattr(data, "read"): # Assume a stream @@ -112,7 +91,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: try: return json.loads(data_as_str) except ValueError as err: - raise DeserializationError("JSON is invalid: {}".format(err), err) + raise DeserializationError("JSON is invalid: {}".format(err), err) from err elif "xml" in (content_type or []): try: @@ -124,7 +103,7 @@ def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: pass return ET.fromstring(data_as_str) # nosec - except ET.ParseError: + except ET.ParseError as err: # It might be because the server has an issue, and returned JSON with # content-type XML.... # So let's try a JSON load, and if it's still broken @@ -143,7 +122,9 @@ def _json_attemp(data): # The function hack is because Py2.7 messes up with exception # context otherwise. _LOGGER.critical("Wasn't XML not JSON, failing") - raise_with_traceback(DeserializationError, "XML is invalid") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) @classmethod @@ -153,6 +134,11 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], Use bytes and headers to NOT use any requests/aiohttp or whatever specific implementation. Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object """ # Try to use content-type from headers if available content_type = None @@ -170,13 +156,6 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], return None -try: - basestring # type: ignore - unicode_str = unicode # type: ignore -except NameError: - basestring = str - unicode_str = str - _LOGGER = logging.getLogger(__name__) try: @@ -184,80 +163,31 @@ def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], except NameError: _long_type = int - -class UTC(datetime.tzinfo): - """Time Zone info for handling UTC""" - - def utcoffset(self, dt): - """UTF offset for UTC is 0.""" - return datetime.timedelta(0) - - def tzname(self, dt): - """Timestamp representation.""" - return "Z" - - def dst(self, dt): - """No daylight saving for UTC.""" - return datetime.timedelta(hours=1) - - -try: - from datetime import timezone as _FixedOffset # type: ignore -except ImportError: # Python 2.7 - - class _FixedOffset(datetime.tzinfo): # type: ignore - """Fixed offset in minutes east from UTC. - Copy/pasted from Python doc - :param datetime.timedelta offset: offset in timedelta format - """ - - def __init__(self, offset): - self.__offset = offset - - def utcoffset(self, dt): - return self.__offset - - def tzname(self, dt): - return str(self.__offset.total_seconds() / 3600) - - def __repr__(self): - return "".format(self.tzname(None)) - - def dst(self, dt): - return datetime.timedelta(0) - - def __getinitargs__(self): - return (self.__offset,) - - -try: - from datetime import timezone - - TZ_UTC = timezone.utc -except ImportError: - TZ_UTC = UTC() # type: ignore +TZ_UTC = datetime.timezone.utc _FLATTEN = re.compile(r"(? None: - self.additional_properties: Dict[str, Any] = {} - for k in kwargs: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items if k not in self._attribute_map: _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) elif k in self._validation and self._validation[k].get("readonly", False): @@ -305,13 +242,23 @@ def __init__(self, **kwargs: Any) -> None: setattr(self, k, kwargs[k]) def __eq__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ if isinstance(other, self.__class__): return self.__dict__ == other.__dict__ return False def __ne__(self, other: Any) -> bool: - """Compare objects by comparing all attributes.""" + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ return not self.__eq__(other) def __str__(self) -> str: @@ -331,7 +278,11 @@ def is_xml_model(cls) -> bool: @classmethod def _create_xml_node(cls): - """Create XML node.""" + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ try: xml_map = cls._xml_map # type: ignore except AttributeError: @@ -340,7 +291,7 @@ def _create_xml_node(cls): return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: - """Return the JSON that would be sent to azure from this model. + """Return the JSON that would be sent to server from this model. This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. @@ -351,12 +302,14 @@ def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) def as_dict( self, keep_readonly: bool = True, - key_transformer: Callable[[str, Dict[str, Any], Any], Any] = attribute_transformer, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, **kwargs: Any ) -> JSON: """Return a dict that can be serialized using json.dump. @@ -385,12 +338,15 @@ def my_key_transformer(key, attr_desc, value): If you want XML serialization, you can pass the kwargs is_xml=True. + :param bool keep_readonly: If you want to serialize the readonly attributes :param function key_transformer: A key transformer function. :returns: A dict JSON compatible object :rtype: dict """ serializer = Serializer(self._infer_class_models()) - return serializer._serialize(self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) @classmethod def _infer_class_models(cls): @@ -400,30 +356,31 @@ def _infer_class_models(cls): client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} if cls.__name__ not in client_models: raise ValueError("Not Autorest generated code") - except Exception: + except Exception: # pylint: disable=broad-exception-caught # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. client_models = {cls.__name__: cls} return client_models @classmethod - def deserialize(cls: Type[ModelType], data: Any, content_type: Optional[str] = None) -> ModelType: + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: """Parse a str using the RestAPI syntax and return a model. :param str data: A str using RestAPI structure. JSON by default. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model - :raises: DeserializationError if something went wrong + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def from_dict( - cls: Type[ModelType], + cls, data: Any, - key_extractors: Optional[Callable[[str, Dict[str, Any], Any], Any]] = None, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, content_type: Optional[str] = None, - ) -> ModelType: + ) -> Self: """Parse a dict using given key extractor return a model. By default consider key @@ -431,9 +388,11 @@ def from_dict( and last_rest_key_case_insensitive_extractor) :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. :param str content_type: JSON by default, set application/xml if XML. :returns: An instance of this model - :raises: DeserializationError if something went wrong + :raises DeserializationError: if something went wrong + :rtype: Self """ deserializer = Deserializer(cls._infer_class_models()) deserializer.key_extractors = ( # type: ignore @@ -445,7 +404,7 @@ def from_dict( if key_extractors is None else key_extractors ) - return deserializer(cls.__name__, data, content_type=content_type) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore @classmethod def _flatten_subtype(cls, key, objects): @@ -453,21 +412,25 @@ def _flatten_subtype(cls, key, objects): return {} result = dict(cls._subtype_map[key]) for valuetype in cls._subtype_map[key].values(): - result.update(objects[valuetype]._flatten_subtype(key, objects)) + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access return result @classmethod def _classify(cls, response, objects): """Check the class _subtype_map for any child classes. We want to ignore any inherited _subtype_maps. - Remove the polymorphic key from the initial data. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class """ for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): subtype_value = None if not isinstance(response, ET.Element): rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] - subtype_value = response.pop(rest_api_response_key, None) or response.pop(subtype_key, None) + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) else: subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) if subtype_value: @@ -506,11 +469,13 @@ def _decode_attribute_map_key(key): inside the received data. :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str """ return key.replace("\\.", ".") -class Serializer(object): +class Serializer: # pylint: disable=too-many-public-methods """Request object model serializer.""" basic_types = {str: "str", int: "int", bool: "bool", float: "float"} @@ -545,7 +510,7 @@ class Serializer(object): "multiple": lambda x, y: x % y != 0, } - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.serialize_type = { "iso-8601": Serializer.serialize_iso, "rfc-1123": Serializer.serialize_rfc, @@ -561,17 +526,20 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "[]": self.serialize_iter, "{}": self.serialize_dict, } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: dict[str, type] = dict(classes) if classes else {} self.key_transformer = full_restapi_key_transformer self.client_side_validation = True - def _serialize(self, target_obj, data_type=None, **kwargs): + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): """Serialize data into a string according to type. - :param target_obj: The data to be serialized. + :param object target_obj: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str, dict - :raises: SerializationError if serialization fails. + :raises SerializationError: if serialization fails. + :returns: The serialized data. """ key_transformer = kwargs.get("key_transformer", self.key_transformer) keep_readonly = kwargs.get("keep_readonly", False) @@ -597,17 +565,19 @@ def _serialize(self, target_obj, data_type=None, **kwargs): serialized = {} if is_xml_model_serialization: - serialized = target_obj._create_xml_node() + serialized = target_obj._create_xml_node() # pylint: disable=protected-access try: - attributes = target_obj._attribute_map + attributes = target_obj._attribute_map # pylint: disable=protected-access for attr, attr_desc in attributes.items(): attr_name = attr - if not keep_readonly and target_obj._validation.get(attr_name, {}).get("readonly", False): + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): continue if attr_name == "additional_properties" and attr_desc["key"] == "": if target_obj.additional_properties is not None: - serialized.update(target_obj.additional_properties) + serialized |= target_obj.additional_properties continue try: @@ -638,7 +608,8 @@ def _serialize(self, target_obj, data_type=None, **kwargs): if isinstance(new_attr, list): serialized.extend(new_attr) # type: ignore elif isinstance(new_attr, ET.Element): - # If the down XML has no XML/Name, we MUST replace the tag with the local tag. But keeping the namespaces. + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. if "name" not in getattr(orig_attr, "_xml_map", {}): splitted_tag = new_attr.tag.split("}") if len(splitted_tag) == 2: # Namespace @@ -649,7 +620,7 @@ def _serialize(self, target_obj, data_type=None, **kwargs): else: # That's a basic type # Integrate namespace if necessary local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) - local_node.text = unicode_str(new_attr) + local_node.text = str(new_attr) serialized.append(local_node) # type: ignore else: # JSON for k in reversed(keys): # type: ignore @@ -668,18 +639,18 @@ def _serialize(self, target_obj, data_type=None, **kwargs): except (AttributeError, KeyError, TypeError) as err: msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) - raise_with_traceback(SerializationError, msg, err) - else: - return serialized + raise SerializationError(msg) from err + return serialized def body(self, data, data_type, **kwargs): """Serialize data intended for a request body. - :param data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: dict - :raises: SerializationError if serialization fails. - :raises: ValueError if data is None + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body """ # Just in case this is a dict @@ -708,20 +679,22 @@ def body(self, data, data_type, **kwargs): attribute_key_case_insensitive_extractor, last_rest_key_case_insensitive_extractor, ] - data = deserializer._deserialize(data_type, data) + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access except DeserializationError as err: - raise_with_traceback(SerializationError, "Unable to build a model: " + str(err), err) + raise SerializationError("Unable to build a model: " + str(err)) from err return self._serialize(data, data_type, **kwargs) def url(self, name, data, data_type, **kwargs): """Serialize data intended for a URL path. - :param data: The data to be serialized. + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None """ try: output = self.serialize_data(data, data_type, **kwargs) @@ -730,32 +703,30 @@ def url(self, name, data, data_type, **kwargs): if kwargs.get("skip_quote") is True: output = str(output) - # https://github.com/Azure/autorest.python/issues/2063 output = output.replace("{", quote("{")).replace("}", quote("}")) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return output + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output def query(self, name, data, data_type, **kwargs): """Serialize data intended for a URL query. - :param data: The data to be serialized. + :param str name: The name of the query parameter. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :keyword bool skip_quote: Whether to skip quote the serialized result. - Defaults to False. - :rtype: str - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter """ try: # Treat the list aside, since we don't want to encode the div separator if data_type.startswith("["): internal_data_type = data_type[1:-1] do_quote = not kwargs.get("skip_quote", False) - return str(self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs)) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) # Not a list, regular serialization output = self.serialize_data(data, data_type, **kwargs) @@ -765,19 +736,20 @@ def query(self, name, data, data_type, **kwargs): output = str(output) else: output = quote(str(output), safe="") - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def header(self, name, data, data_type, **kwargs): """Serialize data intended for a request header. - :param data: The data to be serialized. + :param str name: The name of the header. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. :rtype: str - :raises: TypeError if serialization fails. - :raises: ValueError if data is None + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header """ try: if data_type in ["[str]"]: @@ -786,37 +758,36 @@ def header(self, name, data, data_type, **kwargs): output = self.serialize_data(data, data_type, **kwargs) if data_type == "bool": output = json.dumps(output) - except SerializationError: - raise TypeError("{} must be type {}.".format(name, data_type)) - else: - return str(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) def serialize_data(self, data, data_type, **kwargs): """Serialize generic data according to supplied data type. - :param data: The data to be serialized. + :param object data: The data to be serialized. :param str data_type: The type to be serialized from. - :param bool required: Whether it's essential that the data not be - empty or None - :raises: AttributeError if required data is None. - :raises: ValueError if data is None - :raises: SerializationError if serialization fails. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list """ if data is None: raise ValueError("No value for given attribute") try: - if data is AzureCoreNull: + if data is CoreNull: return None if data_type in self.basic_types.values(): return self.serialize_basic(data, data_type, **kwargs) - elif data_type in self.serialize_type: + if data_type in self.serialize_type: return self.serialize_type[data_type](data, **kwargs) # If dependencies is empty, try with current data class # It has to be a subclass of Enum anyway - enum_type = self.dependencies.get(data_type, data.__class__) + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) if issubclass(enum_type, Enum): return Serializer.serialize_enum(data, enum_obj=enum_type) @@ -826,12 +797,11 @@ def serialize_data(self, data, data_type, **kwargs): except (ValueError, TypeError) as err: msg = "Unable to serialize value: {!r} as type: {!r}." - raise_with_traceback(SerializationError, msg.format(data, data_type), err) - else: - return self._serialize(data, **kwargs) + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) @classmethod - def _get_custom_serializers(cls, data_type, **kwargs): + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) if custom_serializer: return custom_serializer @@ -847,23 +817,26 @@ def serialize_basic(cls, data, data_type, **kwargs): - basic_types_serializers dict[str, callable] : If set, use the callable as serializer - is_xml bool : If set, use xml_basic_types_serializers - :param data: Object to be serialized. + :param obj data: Object to be serialized. :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object """ custom_serializer = cls._get_custom_serializers(data_type, **kwargs) if custom_serializer: return custom_serializer(data) if data_type == "str": return cls.serialize_unicode(data) - return eval(data_type)(data) # nosec + return eval(data_type)(data) # nosec # pylint: disable=eval-used @classmethod def serialize_unicode(cls, data): """Special handling for serializing unicode strings in Py2. Encode to UTF-8 if unicode, otherwise handle as a str. - :param data: Object to be serialized. + :param str data: Object to be serialized. :rtype: str + :return: serialized object """ try: # If I received an enum, return its value return data.value @@ -877,8 +850,7 @@ def serialize_unicode(cls, data): return data except NameError: return str(data) - else: - return str(data) + return str(data) def serialize_iter(self, data, iter_type, div=None, **kwargs): """Serialize iterable. @@ -888,15 +860,13 @@ def serialize_iter(self, data, iter_type, div=None, **kwargs): serialization_ctxt['type'] should be same as data_type. - is_xml bool : If set, serialize as XML - :param list attr: Object to be serialized. + :param list data: Object to be serialized. :param str iter_type: Type of object in the iterable. - :param bool required: Whether the objects in the iterable must - not be None or empty. :param str div: If set, this str will be used to combine the elements in the iterable into a combined string. Default is 'None'. - :keyword bool do_quote: Whether to quote the serialized result of each iterable element. Defaults to False. :rtype: list, str + :return: serialized iterable """ if isinstance(data, str): raise SerializationError("Refuse str type as a valid iter type.") @@ -951,9 +921,8 @@ def serialize_dict(self, attr, dict_type, **kwargs): :param dict attr: Object to be serialized. :param str dict_type: Type of object in the dictionary. - :param bool required: Whether the objects in the dictionary must - not be None or empty. :rtype: dict + :return: serialized dictionary """ serialization_ctxt = kwargs.get("serialization_ctxt", {}) serialized = {} @@ -977,7 +946,7 @@ def serialize_dict(self, attr, dict_type, **kwargs): return serialized - def serialize_object(self, attr, **kwargs): + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Serialize a generic object. This will be handled as a dictionary. If object passed in is not a basic type (str, int, float, dict, list) it will simply be @@ -985,6 +954,7 @@ def serialize_object(self, attr, **kwargs): :param dict attr: Object to be serialized. :rtype: dict or str + :return: serialized object """ if attr is None: return None @@ -995,7 +965,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) if obj_type is _long_type: return self.serialize_long(attr) - if obj_type is unicode_str: + if obj_type is str: return self.serialize_unicode(attr) if obj_type is datetime.datetime: return self.serialize_iso(attr) @@ -1009,7 +979,7 @@ def serialize_object(self, attr, **kwargs): return self.serialize_decimal(attr) # If it's a model or I know this dependency, serialize as a Model - elif obj_type in self.dependencies.values() or isinstance(attr, Model): + if obj_type in self.dependencies.values() or isinstance(attr, Model): return self._serialize(attr) if obj_type == dict: @@ -1040,56 +1010,61 @@ def serialize_enum(attr, enum_obj=None): try: enum_obj(result) # type: ignore return result - except ValueError: + except ValueError as exc: for enum_value in enum_obj: # type: ignore if enum_value.value.lower() == str(attr).lower(): return enum_value.value error = "{!r} is not valid value for enum {!r}" - raise SerializationError(error.format(attr, enum_obj)) + raise SerializationError(error.format(attr, enum_obj)) from exc @staticmethod - def serialize_bytearray(attr, **kwargs): + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument """Serialize bytearray into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ return b64encode(attr).decode() @staticmethod - def serialize_base64(attr, **kwargs): + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument """Serialize str into base-64 string. - :param attr: Object to be serialized. + :param str attr: Object to be serialized. :rtype: str + :return: serialized base64 """ encoded = b64encode(attr).decode("ascii") return encoded.strip("=").replace("+", "-").replace("/", "_") @staticmethod - def serialize_decimal(attr, **kwargs): + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument """Serialize Decimal object to float. - :param attr: Object to be serialized. + :param decimal attr: Object to be serialized. :rtype: float + :return: serialized decimal """ return float(attr) @staticmethod - def serialize_long(attr, **kwargs): + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument """Serialize long (Py2) or int (Py3). - :param attr: Object to be serialized. + :param int attr: Object to be serialized. :rtype: int/long + :return: serialized long """ return _long_type(attr) @staticmethod - def serialize_date(attr, **kwargs): + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument """Serialize Date object into ISO-8601 formatted string. :param Date attr: Object to be serialized. :rtype: str + :return: serialized date """ if isinstance(attr, str): attr = isodate.parse_date(attr) @@ -1097,11 +1072,12 @@ def serialize_date(attr, **kwargs): return t @staticmethod - def serialize_time(attr, **kwargs): + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument """Serialize Time object into ISO-8601 formatted string. :param datetime.time attr: Object to be serialized. :rtype: str + :return: serialized time """ if isinstance(attr, str): attr = isodate.parse_time(attr) @@ -1111,30 +1087,32 @@ def serialize_time(attr, **kwargs): return t @staticmethod - def serialize_duration(attr, **kwargs): + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument """Serialize TimeDelta object into ISO-8601 formatted string. :param TimeDelta attr: Object to be serialized. :rtype: str + :return: serialized duration """ if isinstance(attr, str): attr = isodate.parse_duration(attr) return isodate.duration_isoformat(attr) @staticmethod - def serialize_rfc(attr, **kwargs): + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into RFC-1123 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: TypeError if format invalid. + :raises TypeError: if format invalid. + :return: serialized rfc """ try: if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") utc = attr.utctimetuple() - except AttributeError: - raise TypeError("RFC1123 object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( Serializer.days[utc.tm_wday], @@ -1147,12 +1125,13 @@ def serialize_rfc(attr, **kwargs): ) @staticmethod - def serialize_iso(attr, **kwargs): + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into ISO-8601 formatted string. :param Datetime attr: Object to be serialized. :rtype: str - :raises: SerializationError if format invalid. + :raises SerializationError: if format invalid. + :return: serialized iso """ if isinstance(attr, str): attr = isodate.parse_datetime(attr) @@ -1172,19 +1151,20 @@ def serialize_iso(attr, **kwargs): return date + microseconds + "Z" except (ValueError, OverflowError) as err: msg = "Unable to serialize datetime object." - raise_with_traceback(SerializationError, msg, err) + raise SerializationError(msg) from err except AttributeError as err: msg = "ISO-8601 object must be valid Datetime object." - raise_with_traceback(TypeError, msg, err) + raise TypeError(msg) from err @staticmethod - def serialize_unix(attr, **kwargs): + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument """Serialize Datetime object into IntTime format. This is represented as seconds. :param Datetime attr: Object to be serialized. :rtype: int - :raises: SerializationError if format invalid + :raises SerializationError: if format invalid + :return: serialied unix """ if isinstance(attr, int): return attr @@ -1192,17 +1172,17 @@ def serialize_unix(attr, **kwargs): if not attr.tzinfo: _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") return int(calendar.timegm(attr.utctimetuple())) - except AttributeError: - raise TypeError("Unix time object must be valid Datetime object.") + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc -def rest_key_extractor(attr, attr_desc, data): +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument key = attr_desc["key"] working_data = data while "." in key: # Need the cast, as for some reasons "split" is typed as list[str | Any] - dict_keys = cast(List[str], _FLATTEN.split(key)) + dict_keys = cast(list[str], _FLATTEN.split(key)) if len(dict_keys) == 1: key = _decode_attribute_map_key(dict_keys[0]) break @@ -1211,14 +1191,15 @@ def rest_key_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) return working_data.get(key) -def rest_key_case_insensitive_extractor(attr, attr_desc, data): +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): key = attr_desc["key"] working_data = data @@ -1232,7 +1213,6 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): if working_data is None: # If at any point while following flatten JSON path see None, it means # that all properties under are None as well - # https://github.com/Azure/msrest-for-python/issues/197 return None key = ".".join(dict_keys[1:]) @@ -1240,17 +1220,29 @@ def rest_key_case_insensitive_extractor(attr, attr_desc, data): return attribute_key_case_insensitive_extractor(key, None, working_data) -def last_rest_key_extractor(attr, attr_desc, data): - """Extract the attribute in "data" based on the last part of the JSON path key.""" +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) return attribute_key_extractor(dict_keys[-1], None, data) -def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument """Extract the attribute in "data" based on the last part of the JSON path key. This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute """ key = attr_desc["key"] dict_keys = _FLATTEN.split(key) @@ -1287,7 +1279,7 @@ def _extract_name_from_internal_type(internal_type): return xml_name -def xml_key_extractor(attr, attr_desc, data): +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements if isinstance(data, dict): return None @@ -1339,22 +1331,21 @@ def xml_key_extractor(attr, attr_desc, data): if is_iter_type: if is_wrapped: return None # is_wrapped no node, we want None - else: - return [] # not wrapped, assume empty list + return [] # not wrapped, assume empty list return None # Assume it's not there, maybe an optional node. # If is_iter_type and not wrapped, return all found children if is_iter_type: if not is_wrapped: return children - else: # Iter and wrapped, should have found one node only (the wrap one) - if len(children) != 1: - raise DeserializationError( - "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( - xml_name - ) + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name ) - return list(children[0]) # Might be empty list and that's ok. + ) + return list(children[0]) # Might be empty list and that's ok. # Here it's not a itertype, we should have found one element only or empty if len(children) > 1: @@ -1362,7 +1353,7 @@ def xml_key_extractor(attr, attr_desc, data): return children[0] -class Deserializer(object): +class Deserializer: """Response object model deserializer. :param dict classes: Class type dictionary for deserializing complex types. @@ -1371,9 +1362,9 @@ class Deserializer(object): basic_types = {str: "str", int: "int", bool: "bool", float: "float"} - valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") - def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: self.deserialize_type = { "iso-8601": Deserializer.deserialize_iso, "rfc-1123": Deserializer.deserialize_rfc, @@ -1393,7 +1384,7 @@ def __init__(self, classes: Optional[Mapping[str, Type[ModelType]]] = None): "duration": (isodate.Duration, datetime.timedelta), "iso-8601": (datetime.datetime), } - self.dependencies: Dict[str, Type[ModelType]] = dict(classes) if classes else {} + self.dependencies: dict[str, type] = dict(classes) if classes else {} self.key_extractors = [rest_key_extractor, xml_key_extractor] # Additional properties only works if the "rest_key_extractor" is used to # extract the keys. Making it to work whatever the key extractor is too much @@ -1409,27 +1400,29 @@ def __call__(self, target_obj, response_data, content_type=None): :param str target_obj: Target data type to deserialize to. :param requests.Response response_data: REST response object. :param str content_type: Swagger "produces" if available. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ data = self._unpack_content(response_data, content_type) return self._deserialize(target_obj, data) - def _deserialize(self, target_obj, data): + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements """Call the deserializer on a model. Data needs to be already deserialized as JSON or XML ElementTree :param str target_obj: Target data type to deserialize to. :param object data: Object to deserialize. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ # This is already a model, go recursive just in case if hasattr(data, "_attribute_map"): constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] try: - for attr, mapconfig in data._attribute_map.items(): + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access if attr in constants: continue value = getattr(data, attr) @@ -1446,15 +1439,15 @@ def _deserialize(self, target_obj, data): response, class_name = self._classify_target(target_obj, data) - if isinstance(response, basestring): + if isinstance(response, str): return self.deserialize_data(data, response) - elif isinstance(response, type) and issubclass(response, Enum): + if isinstance(response, type) and issubclass(response, Enum): return self.deserialize_enum(data, response) - if data is None: + if data is None or data is CoreNull: return data try: - attributes = response._attribute_map # type: ignore + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access d_attrs = {} for attr, attr_desc in attributes.items(): # Check empty string. If it's not empty, someone has a real "additionalProperties"... @@ -1483,10 +1476,9 @@ def _deserialize(self, target_obj, data): d_attrs[attr] = value except (AttributeError, TypeError, KeyError) as err: msg = "Unable to deserialize to object: " + class_name # type: ignore - raise_with_traceback(DeserializationError, msg, err) - else: - additional_properties = self._build_additional_properties(attributes, data) - return self._instantiate_model(response, d_attrs, additional_properties) + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) def _build_additional_properties(self, attribute_map, data): if not self.additional_properties_detection: @@ -1513,18 +1505,20 @@ def _classify_target(self, target, data): :param str target: The target object type to deserialize to. :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple """ if target is None: return None, None - if isinstance(target, basestring): + if isinstance(target, str): try: target = self.dependencies[target] except KeyError: return target, target try: - target = target._classify(data, self.dependencies) + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access except AttributeError: pass # Target is not a Model, no classify return target, target.__class__.__name__ # type: ignore @@ -1539,10 +1533,12 @@ def failsafe_deserialize(self, target_obj, data, content_type=None): :param str target_obj: The target object type to deserialize to. :param str/dict data: The response data to deserialize. :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object """ try: return self(target_obj, data, content_type=content_type) - except: + except: # pylint: disable=bare-except _LOGGER.debug( "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True ) @@ -1560,10 +1556,12 @@ def _unpack_content(raw_data, content_type=None): If raw_data is something else, bypass all logic and return it directly. - :param raw_data: Data to be processed. - :param content_type: How to parse if raw_data is a string/bytes. + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. :raises JSONDecodeError: If JSON is requested and parsing is impossible. :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. """ # Assume this is enough to detect a Pipeline Response without importing it context = getattr(raw_data, "context", {}) @@ -1580,31 +1578,42 @@ def _unpack_content(raw_data, content_type=None): if hasattr(raw_data, "_content_consumed"): return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) - if isinstance(raw_data, (basestring, bytes)) or hasattr(raw_data, "read"): + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore return raw_data def _instantiate_model(self, response, attrs, additional_properties=None): """Instantiate a response model passing in deserialized args. - :param response: The response model class. - :param d_attrs: The deserialized response attributes. + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. """ if callable(response): subtype = getattr(response, "_subtype_map", {}) try: - readonly = [k for k, v in response._validation.items() if v.get("readonly")] - const = [k for k, v in response._validation.items() if v.get("constant")] + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} response_obj = response(**kwargs) for attr in readonly: setattr(response_obj, attr, attrs.get(attr)) if additional_properties: - response_obj.additional_properties = additional_properties + response_obj.additional_properties = additional_properties # type: ignore return response_obj except TypeError as err: msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore - raise DeserializationError(msg + str(err)) + raise DeserializationError(msg + str(err)) from err else: try: for attr, value in attrs.items(): @@ -1613,15 +1622,16 @@ def _instantiate_model(self, response, attrs, additional_properties=None): except Exception as exp: msg = "Unable to populate response model. " msg += "Type: {}, Error: {}".format(type(response), exp) - raise DeserializationError(msg) + raise DeserializationError(msg) from exp - def deserialize_data(self, data, data_type): + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements """Process data for deserialization according to data type. :param str data: The response string to be deserialized. :param str data_type: The type to deserialize to. - :raises: DeserializationError if deserialization fails. + :raises DeserializationError: if deserialization fails. :return: Deserialized object. + :rtype: object """ if data is None: return data @@ -1635,7 +1645,11 @@ def deserialize_data(self, data, data_type): if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): return data - is_a_text_parsing_type = lambda x: x not in ["object", "[]", r"{}"] + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: return None data_val = self.deserialize_type[data_type](data) @@ -1654,15 +1668,15 @@ def deserialize_data(self, data, data_type): except (ValueError, TypeError, AttributeError) as err: msg = "Unable to deserialize response data." msg += " Data: {}, {}".format(data, data_type) - raise_with_traceback(DeserializationError, msg, err) - else: - return self._deserialize(obj_type, data) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) def deserialize_iter(self, attr, iter_type): """Deserialize an iterable. :param list attr: Iterable to be deserialized. :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. :rtype: list """ if attr is None: @@ -1679,6 +1693,7 @@ def deserialize_dict(self, attr, dict_type): :param dict/list attr: Dictionary to be deserialized. Also accepts a list of key, value pairs. :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. :rtype: dict """ if isinstance(attr, list): @@ -1689,20 +1704,21 @@ def deserialize_dict(self, attr, dict_type): attr = {el.tag: el.text for el in attr} return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} - def deserialize_object(self, attr, **kwargs): + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements """Deserialize a generic object. This will be handled as a dictionary. :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. :rtype: dict - :raises: TypeError if non-builtin datatype encountered. + :raises TypeError: if non-builtin datatype encountered. """ if attr is None: return None if isinstance(attr, ET.Element): # Do no recurse on XML, just return the tree as-is return attr - if isinstance(attr, basestring): + if isinstance(attr, str): return self.deserialize_basic(attr, "str") obj_type = type(attr) if obj_type in self.basic_types: @@ -1728,11 +1744,10 @@ def deserialize_object(self, attr, **kwargs): pass return deserialized - else: - error = "Cannot deserialize generic object with type: " - raise TypeError(error + str(obj_type)) + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) - def deserialize_basic(self, attr, data_type): + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements """Deserialize basic builtin data type from string. Will attempt to convert to str, int, float and bool. This function will also accept '1', '0', 'true' and 'false' as @@ -1740,8 +1755,9 @@ def deserialize_basic(self, attr, data_type): :param str attr: response string to be deserialized. :param str data_type: deserialization data type. + :return: Deserialized basic type. :rtype: str, int, float or bool - :raises: TypeError if string format is not valid. + :raises TypeError: if string format is not valid. """ # If we're here, data is supposed to be a basic type. # If it's still an XML node, take the text @@ -1751,24 +1767,23 @@ def deserialize_basic(self, attr, data_type): if data_type == "str": # None or '', node is empty string. return "" - else: - # None or '', node with a strong type is None. - # Don't try to model "empty bool" or "empty int" - return None + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None if data_type == "bool": if attr in [True, False, 1, 0]: return bool(attr) - elif isinstance(attr, basestring): + if isinstance(attr, str): if attr.lower() in ["true", "1"]: return True - elif attr.lower() in ["false", "0"]: + if attr.lower() in ["false", "0"]: return False raise TypeError("Invalid boolean value: {}".format(attr)) if data_type == "str": return self.deserialize_unicode(attr) - return eval(data_type)(attr) # nosec + return eval(data_type)(attr) # nosec # pylint: disable=eval-used @staticmethod def deserialize_unicode(data): @@ -1776,6 +1791,7 @@ def deserialize_unicode(data): as a string. :param str data: response string to be deserialized. + :return: Deserialized string. :rtype: str or unicode """ # We might be here because we have an enum modeled as string, @@ -1789,8 +1805,7 @@ def deserialize_unicode(data): return data except NameError: return str(data) - else: - return str(data) + return str(data) @staticmethod def deserialize_enum(data, enum_obj): @@ -1802,6 +1817,7 @@ def deserialize_enum(data, enum_obj): :param str data: Response string to be deserialized. If this value is None or invalid it will be returned as-is. :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. :rtype: Enum """ if isinstance(data, enum_obj) or data is None: @@ -1810,12 +1826,11 @@ def deserialize_enum(data, enum_obj): data = data.value if isinstance(data, int): # Workaround. We might consider remove it in the future. - # https://github.com/Azure/azure-rest-api-specs/issues/141 try: return list(enum_obj.__members__.values())[data] - except IndexError: + except IndexError as exc: error = "{!r} is not a valid index for enum {!r}" - raise DeserializationError(error.format(data, enum_obj)) + raise DeserializationError(error.format(data, enum_obj)) from exc try: return enum_obj(str(data)) except ValueError: @@ -1831,8 +1846,9 @@ def deserialize_bytearray(attr): """Deserialize string into bytearray. :param str attr: response string to be deserialized. + :return: Deserialized bytearray :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1843,8 +1859,9 @@ def deserialize_base64(attr): """Deserialize base64 encoded string into string. :param str attr: response string to be deserialized. + :return: Deserialized base64 string :rtype: bytearray - :raises: TypeError if string format invalid. + :raises TypeError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1858,24 +1875,26 @@ def deserialize_decimal(attr): """Deserialize string into Decimal object. :param str attr: response string to be deserialized. - :rtype: Decimal - :raises: DeserializationError if string format invalid. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal """ if isinstance(attr, ET.Element): attr = attr.text try: - return decimal.Decimal(attr) # type: ignore + return decimal.Decimal(str(attr)) # type: ignore except decimal.DecimalException as err: msg = "Invalid decimal {}".format(attr) - raise_with_traceback(DeserializationError, msg, err) + raise DeserializationError(msg) from err @staticmethod def deserialize_long(attr): """Deserialize string into long (Py2) or int (Py3). :param str attr: response string to be deserialized. + :return: Deserialized int :rtype: long or int - :raises: ValueError if string format invalid. + :raises ValueError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1886,8 +1905,9 @@ def deserialize_duration(attr): """Deserialize ISO-8601 formatted string into TimeDelta object. :param str attr: response string to be deserialized. + :return: Deserialized duration :rtype: TimeDelta - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1895,17 +1915,17 @@ def deserialize_duration(attr): duration = isodate.parse_duration(attr) except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize duration object." - raise_with_traceback(DeserializationError, msg, err) - else: - return duration + raise DeserializationError(msg) from err + return duration @staticmethod def deserialize_date(attr): """Deserialize ISO-8601 formatted string into Date object. :param str attr: response string to be deserialized. + :return: Deserialized date :rtype: Date - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1919,8 +1939,9 @@ def deserialize_time(attr): """Deserialize ISO-8601 formatted string into time object. :param str attr: response string to be deserialized. + :return: Deserialized time :rtype: datetime.time - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1933,31 +1954,32 @@ def deserialize_rfc(attr): """Deserialize RFC-1123 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text try: parsed_date = email.utils.parsedate_tz(attr) # type: ignore date_obj = datetime.datetime( - *parsed_date[:6], tzinfo=_FixedOffset(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) ) if not date_obj.tzinfo: date_obj = date_obj.astimezone(tz=TZ_UTC) except ValueError as err: msg = "Cannot deserialize to rfc datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_iso(attr): """Deserialize ISO-8601 formatted string into Datetime object. :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime :rtype: Datetime - :raises: DeserializationError if string format invalid. + :raises DeserializationError: if string format invalid. """ if isinstance(attr, ET.Element): attr = attr.text @@ -1984,9 +2006,8 @@ def deserialize_iso(attr): raise OverflowError("Hit max or min date") except (ValueError, OverflowError, AttributeError) as err: msg = "Cannot deserialize datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj @staticmethod def deserialize_unix(attr): @@ -1994,15 +2015,16 @@ def deserialize_unix(attr): This is represented as seconds. :param int attr: Object to be serialized. + :return: Deserialized datetime :rtype: Datetime - :raises: DeserializationError if format invalid + :raises DeserializationError: if format invalid """ if isinstance(attr, ET.Element): attr = int(attr.text) # type: ignore try: + attr = int(attr) date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) except ValueError as err: msg = "Cannot deserialize to unix datetime object." - raise_with_traceback(DeserializationError, msg, err) - else: - return date_obj + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/utils.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/utils.py new file mode 100644 index 000000000000..e98db3239df0 --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_utils/utils.py @@ -0,0 +1,50 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +import json +from typing import Any, IO, Mapping, Optional, Union + +from .._utils.model_base import Model, SdkJSONEncoder + + +# file-like tuple could be `(filename, IO (or bytes))` or `(filename, IO (or bytes), content_type)` +FileContent = Union[str, bytes, IO[str], IO[bytes]] + +FileType = Union[ + # file (or bytes) + FileContent, + # (filename, file (or bytes)) + tuple[Optional[str], FileContent], + # (filename, file (or bytes), content_type) + tuple[Optional[str], FileContent, Optional[str]], +] + + +def serialize_multipart_data_entry(data_entry: Any) -> Any: + if isinstance(data_entry, (list, tuple, dict, Model)): + return json.dumps(data_entry, cls=SdkJSONEncoder, exclude_readonly=True) + return data_entry + + +def prepare_multipart_form_data( + body: Mapping[str, Any], multipart_fields: list[str], data_fields: list[str] +) -> tuple[list[FileType], dict[str, Any]]: + files: list[FileType] = [] + data: dict[str, Any] = {} + for multipart_field in multipart_fields: + multipart_entry = body.get(multipart_field) + if isinstance(multipart_entry, list): + files.extend([(multipart_field, e) for e in multipart_entry]) + elif multipart_entry: + files.append((multipart_field, multipart_entry)) + + for data_field in data_fields: + data_entry = body.get(data_field) + if data_entry: + data[data_field] = serialize_multipart_data_entry(data_entry) + + return files, data diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_vendor.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_vendor.py deleted file mode 100644 index b89fce811475..000000000000 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_vendor.py +++ /dev/null @@ -1,15 +0,0 @@ -# -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - - -def raise_if_not_implemented(cls, abstract_methods): - not_implemented = [f for f in abstract_methods if not callable(getattr(cls, f, None))] - if not_implemented: - raise NotImplementedError( - "The following methods on operation group '{}' are not implemented: '{}'." - " Please refer to https://aka.ms/azsdk/python/dpcodegen/python/customize to learn how to customize.".format( - cls.__name__, "', '".join(not_implemented) - ) - ) diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_version.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_version.py new file mode 100644 index 000000000000..a73f358d285a --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/_version.py @@ -0,0 +1,9 @@ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +VERSION = "1.2.0" diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/__init__.py index 75020eabd3bb..b94b74b1e684 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/__init__.py @@ -1,14 +1,22 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._client import ContainerRegistry +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import ContainerRegistry # type: ignore try: from ._patch import __all__ as _patch_all - from ._patch import * # pylint: disable=unused-wildcard-import + from ._patch import * except ImportError: _patch_all = [] from ._patch import patch_sdk as _patch_sdk @@ -16,6 +24,6 @@ __all__ = [ "ContainerRegistry", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_client.py index 8bbf9d670fb1..f0adb9f0617f 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_client.py @@ -1,53 +1,73 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from copy import deepcopy from typing import Any, Awaitable, TYPE_CHECKING +from typing_extensions import Self from azure.core import AsyncPipelineClient +from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest -from .. import models as _models -from .._serialization import Deserializer, Serializer +from .._utils.serialization import Deserializer, Serializer from ._configuration import ContainerRegistryConfiguration from .operations import AuthenticationOperations, ContainerRegistryBlobOperations, ContainerRegistryOperations if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -class ContainerRegistry: # pylint: disable=client-accepts-api-version-keyword +class ContainerRegistry: """Metadata API definition for the Azure Container Registry runtime. :ivar container_registry: ContainerRegistryOperations operations - :vartype container_registry: container_registry.aio.operations.ContainerRegistryOperations + :vartype container_registry: + azure.containerregistry._generated.aio.operations.ContainerRegistryOperations :ivar container_registry_blob: ContainerRegistryBlobOperations operations :vartype container_registry_blob: - container_registry.aio.operations.ContainerRegistryBlobOperations + azure.containerregistry._generated.aio.operations.ContainerRegistryBlobOperations :ivar authentication: AuthenticationOperations operations - :vartype authentication: container_registry.aio.operations.AuthenticationOperations - :param url: Registry login URL. Required. - :type url: str - :param credential: Credential needed for the client to connect to Azure. Required. + :vartype authentication: + azure.containerregistry._generated.aio.operations.AuthenticationOperations + :param endpoint: Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2021-07-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is "2021-07-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ - def __init__(self, url: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: - _endpoint = "{url}" - self._config = ContainerRegistryConfiguration(url=url, credential=credential, **kwargs) - self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, config=self._config, **kwargs) - - client_models = {k: v for k, v in _models._models.__dict__.items() if isinstance(v, type)} - client_models.update({k: v for k, v in _models.__dict__.items() if isinstance(v, type)}) - self._serialize = Serializer(client_models) - self._deserialize = Deserializer(client_models) + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: + _endpoint = "{endpoint}" + self._config = ContainerRegistryConfiguration(endpoint=endpoint, credential=credential, **kwargs) + + _policies = kwargs.pop("policies", None) + if _policies is None: + _policies = [ + policies.RequestIdPolicy(**kwargs), + self._config.headers_policy, + self._config.user_agent_policy, + self._config.proxy_policy, + policies.ContentDecodePolicy(**kwargs), + self._config.redirect_policy, + self._config.retry_policy, + self._config.authentication_policy, + self._config.custom_hook_policy, + self._config.logging_policy, + policies.DistributedTracingPolicy(**kwargs), + policies.SensitiveHeaderCleanupPolicy(**kwargs) if self._config.redirect_policy else None, + self._config.http_logging_policy, + ] + self._client: AsyncPipelineClient = AsyncPipelineClient(base_url=_endpoint, policies=_policies, **kwargs) + + self._serialize = Serializer() + self._deserialize = Deserializer() self._serialize.client_side_validation = False self.container_registry = ContainerRegistryOperations( self._client, self._config, self._serialize, self._deserialize @@ -57,7 +77,9 @@ def __init__(self, url: str, credential: "AsyncTokenCredential", **kwargs: Any) ) self.authentication = AuthenticationOperations(self._client, self._config, self._serialize, self._deserialize) - def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHttpResponse]: + def send_request( + self, request: HttpRequest, *, stream: bool = False, **kwargs: Any + ) -> Awaitable[AsyncHttpResponse]: """Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest @@ -77,16 +99,16 @@ def send_request(self, request: HttpRequest, **kwargs: Any) -> Awaitable[AsyncHt request_copy = deepcopy(request) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request_copy.url = self._client.format_url(request_copy.url, **path_format_arguments) - return self._client.send_request(request_copy, **kwargs) + return self._client.send_request(request_copy, stream=stream, **kwargs) # type: ignore async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "ContainerRegistry": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_configuration.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_configuration.py index d423202b4dbd..47f5fa894cd8 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_configuration.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_configuration.py @@ -1,50 +1,50 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- from typing import Any, TYPE_CHECKING -from azure.core.configuration import Configuration from azure.core.pipeline import policies +from .._version import VERSION + if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from azure.core.credentials_async import AsyncTokenCredential -VERSION = "unknown" - -class ContainerRegistryConfiguration(Configuration): # pylint: disable=too-many-instance-attributes,name-too-long +class ContainerRegistryConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for ContainerRegistry. Note that all parameters used to create this instance are saved as instance attributes. - :param url: Registry login URL. Required. - :type url: str - :param credential: Credential needed for the client to connect to Azure. Required. + :param endpoint: Required. + :type endpoint: str + :param credential: Credential used to authenticate requests to the service. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential - :keyword api_version: Api Version. Default value is "2021-07-01". Note that overriding this - default value may result in unsupported behavior. + :keyword api_version: The API version to use for this operation. Default value is "2021-07-01". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ - def __init__(self, url: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: - super(ContainerRegistryConfiguration, self).__init__(**kwargs) + def __init__(self, endpoint: str, credential: "AsyncTokenCredential", **kwargs: Any) -> None: api_version: str = kwargs.pop("api_version", "2021-07-01") - if url is None: - raise ValueError("Parameter 'url' must not be None.") + if endpoint is None: + raise ValueError("Parameter 'endpoint' must not be None.") if credential is None: raise ValueError("Parameter 'credential' must not be None.") - self.url = url + self.endpoint = endpoint self.credential = credential self.api_version = api_version self.credential_scopes = kwargs.pop("credential_scopes", []) kwargs.setdefault("sdk_moniker", "containerregistry/{}".format(VERSION)) + self.polling_interval = kwargs.get("polling_interval", 30) self._configure(**kwargs) def _configure(self, **kwargs: Any) -> None: @@ -53,9 +53,9 @@ def _configure(self, **kwargs: Any) -> None: self.proxy_policy = kwargs.get("proxy_policy") or policies.ProxyPolicy(**kwargs) self.logging_policy = kwargs.get("logging_policy") or policies.NetworkTraceLoggingPolicy(**kwargs) self.http_logging_policy = kwargs.get("http_logging_policy") or policies.HttpLoggingPolicy(**kwargs) - self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.custom_hook_policy = kwargs.get("custom_hook_policy") or policies.CustomHookPolicy(**kwargs) self.redirect_policy = kwargs.get("redirect_policy") or policies.AsyncRedirectPolicy(**kwargs) + self.retry_policy = kwargs.get("retry_policy") or policies.AsyncRetryPolicy(**kwargs) self.authentication_policy = kwargs.get("authentication_policy") if not self.credential_scopes and not self.authentication_policy: raise ValueError("You must provide either credential_scopes or authentication_policy as kwargs") diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_patch.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_patch.py index 17dbc073e01b..87676c65a8f0 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_patch.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_patch.py @@ -1,32 +1,21 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# # Copyright (c) Microsoft Corporation. All rights reserved. -# -# The MIT License (MIT) -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the ""Software""), to -# deal in the Software without restriction, including without limitation the -# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or -# sell copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS -# IN THE SOFTWARE. -# +# Licensed under the MIT License. See License.txt in the project root for license information. # -------------------------------------------------------------------------- +"""Customize generated code here. + +Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize +""" + + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level -# This file is used for handwritten extensions to the generated code. Example: -# https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/customize_code/how-to-patch-sdk-code.md def patch_sdk(): - pass + """Do not remove from this file. + + `patch_sdk` is a last resort escape hatch that allows you to do customizations + you can't accomplish using the techniques described in + https://aka.ms/azsdk/python/dpcodegen/python/customize + """ diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_vendor.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_vendor.py deleted file mode 100644 index b89fce811475..000000000000 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/_vendor.py +++ /dev/null @@ -1,15 +0,0 @@ -# -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) -# Changes may cause incorrect behavior and will be lost if the code is regenerated. -# -------------------------------------------------------------------------- - - -def raise_if_not_implemented(cls, abstract_methods): - not_implemented = [f for f in abstract_methods if not callable(getattr(cls, f, None))] - if not_implemented: - raise NotImplementedError( - "The following methods on operation group '{}' are not implemented: '{}'." - " Please refer to https://aka.ms/azsdk/python/dpcodegen/python/customize to learn how to customize.".format( - cls.__name__, "', '".join(not_implemented) - ) - ) diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/__init__.py index bcf2637fb304..461f85a3cebf 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/__init__.py @@ -1,15 +1,23 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import ContainerRegistryOperations -from ._operations import ContainerRegistryBlobOperations -from ._operations import AuthenticationOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import ContainerRegistryOperations # type: ignore +from ._operations import ContainerRegistryBlobOperations # type: ignore +from ._operations import AuthenticationOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ @@ -17,5 +25,5 @@ "ContainerRegistryBlobOperations", "AuthenticationOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_operations.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_operations.py index f4264266a1dd..4213873bd900 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_operations.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_operations.py @@ -1,13 +1,18 @@ # pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase -from typing import Any, AsyncIterable, AsyncIterator, Callable, Dict, IO, Optional, TypeVar, Union, overload +import json +from typing import Any, AsyncIterator, Callable, IO, Optional, TypeVar, Union, overload import urllib.parse +from azure.core import AsyncPipelineClient from azure.core.async_paging import AsyncItemPaged, AsyncList from azure.core.exceptions import ( ClientAuthenticationError, @@ -15,6 +20,8 @@ ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse @@ -24,7 +31,13 @@ from azure.core.utils import case_insensitive_dict from ... import models as _models +from ..._utils.model_base import Model as _Model, SdkJSONEncoder, _deserialize +from ..._utils.serialization import Deserializer, Serializer +from ..._utils.utils import prepare_multipart_form_data from ...operations._operations import ( + build_authentication_exchange_aad_access_token_for_acr_refresh_token_request, + build_authentication_exchange_acr_refresh_token_for_acr_access_token_request, + build_authentication_get_acr_access_token_from_login_request, build_container_registry_blob_cancel_upload_request, build_container_registry_blob_check_blob_exists_request, build_container_registry_blob_check_chunk_exists_request, @@ -52,10 +65,11 @@ build_container_registry_update_properties_request, build_container_registry_update_tag_attributes_request, ) -from .._vendor import raise_if_not_implemented +from .._configuration import ContainerRegistryConfiguration +JSON = MutableMapping[str, Any] T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] class ContainerRegistryOperations: @@ -64,28 +78,26 @@ class ContainerRegistryOperations: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.aio.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.aio.ContainerRegistry`'s :attr:`container_registry` attribute. """ - models = _models - def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace_async - async def check_docker_v2_support(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + async def check_docker_v2_support(self, **kwargs: Any) -> None: """Tells whether this Docker Registry instance supports Docker Registry HTTP API v2. :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -98,38 +110,36 @@ async def check_docker_v2_support(self, **kwargs: Any) -> None: # pylint: disab cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_check_docker_v2_support_request( + _request = build_container_registry_check_docker_v2_support_request( + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket + if response.status_code not in [204]: map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace_async async def get_manifest( self, name: str, reference: str, *, accept: Optional[str] = None, **kwargs: Any - ) -> AsyncIterator[bytes]: - """Get the manifest identified by ``name`` and ``reference`` where ``reference`` can be a tag or - digest. + ) -> _models.ManifestWrapper: + """Get the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. :param name: Name of the image (including the namespace). Required. :type name: str @@ -138,11 +148,11 @@ async def get_manifest( :keyword accept: Accept header string delimited by comma. For example, application/vnd.docker.distribution.manifest.v2+json. Default value is None. :paramtype accept: str - :return: Async iterator of the response bytes - :rtype: AsyncIterator[bytes] + :return: ManifestWrapper. The ManifestWrapper is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ManifestWrapper :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -153,57 +163,135 @@ async def get_manifest( _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + cls: ClsType[_models.ManifestWrapper] = kwargs.pop("cls", None) - request = build_container_registry_get_manifest_request( + _request = build_container_registry_get_manifest_request( name=name, reference=reference, accept=accept, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = response.iter_bytes() + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ManifestWrapper, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore return deserialized # type: ignore - @distributed_trace_async - async def create_manifest(self, name: str, reference: str, payload: IO, **kwargs: Any) -> Any: - """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be a tag or - digest. + @overload + async def create_manifest( + self, + name: str, + reference: str, + payload: _models.Manifest, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. :param name: Name of the image (including the namespace). Required. :type name: str :param reference: A tag or a digest, pointing to a specific image. Required. :type reference: str :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. - :type payload: IO - :return: any - :rtype: any + :type payload: ~azure.containerregistry._generated.models.Manifest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + + @overload + async def create_manifest( + self, name: str, reference: str, payload: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. + :type payload: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def create_manifest( + self, name: str, reference: str, payload: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. + :type payload: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def create_manifest( + self, name: str, reference: str, payload: Union[_models.Manifest, JSON, IO[bytes]], **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Is one of + the following types: Manifest, JSON, IO[bytes] Required. + :type payload: ~azure.containerregistry._generated.models.Manifest or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -214,60 +302,55 @@ async def create_manifest(self, name: str, reference: str, payload: IO, **kwargs _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} - content_type: str = kwargs.pop( - "content_type", _headers.pop("Content-Type", "application/vnd.docker.distribution.manifest.v2+json") - ) - cls: ClsType[Any] = kwargs.pop("cls", None) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) - _content = payload + content_type = content_type or "application/json" + _content = None + if isinstance(payload, (IOBase, bytes)): + _content = payload + else: + _content = json.dumps(payload, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_container_registry_create_manifest_request( + _request = build_container_registry_create_manifest_request( name=name, reference=reference, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Docker-Content-Digest"] = self._deserialize( "str", response.headers.get("Docker-Content-Digest") ) - response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) - response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) - - deserialized = self._deserialize("object", pipeline_response) if cls: - return cls(pipeline_response, deserialized, response_headers) - - return deserialized + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def delete_manifest( # pylint: disable=inconsistent-return-statements - self, name: str, reference: str, **kwargs: Any - ) -> None: - """Delete the manifest identified by ``name`` and ``reference``. Note that a manifest can *only* - be deleted by ``digest``. + async def delete_manifest(self, name: str, reference: str, **kwargs: Any) -> None: + """Delete the manifest identified by ``name`` and ``reference``. Note that a manifest + can *only* be deleted by ``digest``. :param name: Name of the image (including the namespace). Required. :type name: str @@ -277,7 +360,7 @@ async def delete_manifest( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -290,44 +373,42 @@ async def delete_manifest( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_delete_manifest_request( + _request = build_container_registry_delete_manifest_request( name=name, reference=reference, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202, 404]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace def get_repositories( self, *, last: Optional[str] = None, n: Optional[int] = None, **kwargs: Any - ) -> AsyncIterable[str]: + ) -> AsyncItemPaged[str]: """List repositories. :keyword last: Query parameter for the last item in previous query. Result set will include values lexically after last. Default value is None. :paramtype last: str - :keyword n: query parameter for max number of items. Default value is None. + :keyword n: Query parameter for max number of items. Default value is None. :paramtype n: int :return: An iterator like instance of str :rtype: ~azure.core.async_paging.AsyncItemPaged[str] @@ -336,9 +417,9 @@ def get_repositories( _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[_models._models.Repositories] = kwargs.pop("cls", None) # pylint: disable=protected-access + cls: ClsType[list[str]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -349,7 +430,7 @@ def get_repositories( def prepare_request(next_link=None): if not next_link: - request = build_container_registry_get_repositories_request( + _request = build_container_registry_get_repositories_request( last=last, n=n, api_version=self._config.api_version, @@ -357,9 +438,11 @@ def prepare_request(next_link=None): params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) else: # make call to next link with the client's api-version @@ -371,40 +454,37 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - return request + return _request async def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.Repositories, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.repositories + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(list[str], deserialized.get("repositories", [])) if cls: list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, AsyncList(list_of_elem) + return deserialized.get("link") or None, AsyncList(list_of_elem) async def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) return pipeline_response @@ -416,11 +496,12 @@ async def get_properties(self, name: str, **kwargs: Any) -> _models.ContainerRep :param name: Name of the image (including the namespace). Required. :type name: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -433,51 +514,54 @@ async def get_properties(self, name: str, **kwargs: Any) -> _models.ContainerRep cls: ClsType[_models.ContainerRepositoryProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_properties_request( + _request = build_container_registry_get_properties_request( name=name, api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ContainerRepositoryProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ContainerRepositoryProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace_async - async def delete_repository( # pylint: disable=inconsistent-return-statements - self, name: str, **kwargs: Any - ) -> None: + async def delete_repository(self, name: str, **kwargs: Any) -> _models.DeleteRepositoryResult: """Delete the repository identified by ``name``. :param name: Name of the image (including the namespace). Required. :type name: str - :return: None - :rtype: None + :return: DeleteRepositoryResult. The DeleteRepositoryResult is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.DeleteRepositoryResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -488,35 +572,44 @@ async def delete_repository( # pylint: disable=inconsistent-return-statements _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[None] = kwargs.pop("cls", None) + cls: ClsType[_models.DeleteRepositoryResult] = kwargs.pop("cls", None) - request = build_container_registry_delete_repository_request( + _request = build_container_registry_delete_repository_request( name=name, api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [202, 404]: + if response.status_code not in [202]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DeleteRepositoryResult, response.json()) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @overload async def update_properties( @@ -527,57 +620,84 @@ async def update_properties( content_type: str = "application/json", **kwargs: Any ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param value: Repository attribute value. Default value is None. + :type value: ~azure.containerregistry._generated.models.RepositoryWriteableProperties + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def update_properties( + self, name: str, value: Optional[JSON] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ContainerRepositoryProperties: + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str :param value: Repository attribute value. Default value is None. - :type value: ~container_registry.models.RepositoryWriteableProperties + :type value: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ @overload async def update_properties( - self, name: str, value: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, name: str, value: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str :param value: Repository attribute value. Default value is None. - :type value: IO + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace_async async def update_properties( - self, name: str, value: Optional[Union[_models.RepositoryWriteableProperties, IO]] = None, **kwargs: Any + self, + name: str, + value: Optional[Union[_models.RepositoryWriteableProperties, JSON, IO[bytes]]] = None, + **kwargs: Any ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str - :param value: Repository attribute value. Is either a RepositoryWriteableProperties type or a - IO type. Default value is None. - :type value: ~container_registry.models.RepositoryWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :param value: Repository attribute value. Is one of the following types: + RepositoryWriteableProperties, JSON, IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.RepositoryWriteableProperties or JSON + or IO[bytes] + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -589,65 +709,69 @@ async def update_properties( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ContainerRepositoryProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "RepositoryWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_properties_request( + _request = build_container_registry_update_properties_request( name=name, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ContainerRepositoryProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ContainerRepositoryProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore - @distributed_trace - def get_tags( + @distributed_trace_async + async def get_tags( self, name: str, *, last: Optional[str] = None, n: Optional[int] = None, - orderby: Optional[str] = None, + orderby: Optional[Union[str, _models.ArtifactTagOrder]] = None, digest: Optional[str] = None, **kwargs: Any - ) -> AsyncIterable["_models.TagAttributesBase"]: + ) -> _models.TagList: """List tags of a repository. :param name: Name of the image (including the namespace). Required. @@ -657,20 +781,16 @@ def get_tags( :paramtype last: str :keyword n: query parameter for max number of items. Default value is None. :paramtype n: int - :keyword orderby: orderby query parameter. Default value is None. - :paramtype orderby: str + :keyword orderby: orderby query parameter. Known values are: "none", "timedesc", and "timeasc". + Default value is None. + :paramtype orderby: str or ~azure.containerregistry._generated.models.ArtifactTagOrder :keyword digest: filter by digest. Default value is None. :paramtype digest: str - :return: An iterator like instance of TagAttributesBase - :rtype: ~azure.core.async_paging.AsyncItemPaged[~container_registry.models.TagAttributesBase] + :return: TagList. The TagList is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.TagList :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = kwargs.pop("params", {}) or {} - - cls: ClsType[_models._models.TagList] = kwargs.pop("cls", None) # pylint: disable=protected-access - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -678,72 +798,51 @@ def get_tags( } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_container_registry_get_tags_request( - name=name, - last=last, - n=n, - orderby=orderby, - digest=digest, - api_version=self._config.api_version, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) - - else: - # make call to next link with the client's api-version - _parsed_next_link = urllib.parse.urlparse(next_link) - _next_request_params = case_insensitive_dict( - { - key: [urllib.parse.quote(v) for v in value] - for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() - } - ) - _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} - return request + cls: ClsType[_models.TagList] = kwargs.pop("cls", None) - async def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.TagList, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.tag_attribute_bases - if cls: - list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, AsyncList(list_of_elem) + _request = build_container_registry_get_tags_request( + name=name, + last=last, + n=n, + orderby=orderby, + digest=digest, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) - async def get_next(next_link=None): - request = prepare_request(next_link) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - _stream = False - pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs - ) - response = pipeline_response.http_response + response = pipeline_response.http_response - if response.status_code not in [200]: - if _stream: + if response.status_code not in [200]: + if _stream: + try: await response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) - return pipeline_response + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TagList, response.json()) - return AsyncItemPaged(get_next, extract_data) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @distributed_trace_async async def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> _models.ArtifactTagProperties: @@ -753,11 +852,11 @@ async def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> :type name: str :param reference: Tag name. Required. :type reference: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -770,7 +869,7 @@ async def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> cls: ClsType[_models.ArtifactTagProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_tag_properties_request( + _request = build_container_registry_get_tag_properties_request( name=name, reference=reference, api_version=self._config.api_version, @@ -778,30 +877,35 @@ async def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactTagProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactTagProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def update_tag_attributes( @@ -820,12 +924,12 @@ async def update_tag_attributes( :param reference: Tag name. Required. :type reference: str :param value: Tag attribute value. Default value is None. - :type value: ~container_registry.models.TagWriteableProperties + :type value: ~azure.containerregistry._generated.models.TagWriteableProperties :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -834,7 +938,7 @@ async def update_tag_attributes( self, name: str, reference: str, - value: Optional[IO] = None, + value: Optional[JSON] = None, *, content_type: str = "application/json", **kwargs: Any @@ -846,12 +950,38 @@ async def update_tag_attributes( :param reference: Tag name. Required. :type reference: str :param value: Tag attribute value. Default value is None. - :type value: IO + :type value: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def update_tag_attributes( + self, + name: str, + reference: str, + value: Optional[IO[bytes]] = None, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.ArtifactTagProperties: + """Update tag attributes. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: Tag name. Required. + :type reference: str + :param value: Tag attribute value. Default value is None. + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -860,7 +990,7 @@ async def update_tag_attributes( self, name: str, reference: str, - value: Optional[Union[_models.TagWriteableProperties, IO]] = None, + value: Optional[Union[_models.TagWriteableProperties, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models.ArtifactTagProperties: """Update tag attributes. @@ -869,17 +999,15 @@ async def update_tag_attributes( :type name: str :param reference: Tag name. Required. :type reference: str - :param value: Tag attribute value. Is either a TagWriteableProperties type or a IO type. - Default value is None. - :type value: ~container_registry.models.TagWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :param value: Tag attribute value. Is one of the following types: TagWriteableProperties, JSON, + IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.TagWriteableProperties or JSON or + IO[bytes] + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -891,59 +1019,61 @@ async def update_tag_attributes( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ArtifactTagProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "TagWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_tag_attributes_request( + _request = build_container_registry_update_tag_attributes_request( name=name, reference=reference, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactTagProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactTagProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace_async - async def delete_tag( # pylint: disable=inconsistent-return-statements - self, name: str, reference: str, **kwargs: Any - ) -> None: + async def delete_tag(self, name: str, reference: str, **kwargs: Any) -> None: """Delete tag. :param name: Name of the image (including the namespace). Required. @@ -954,7 +1084,7 @@ async def delete_tag( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -967,7 +1097,7 @@ async def delete_tag( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_delete_tag_request( + _request = build_container_registry_delete_tag_request( name=name, reference=reference, api_version=self._config.api_version, @@ -975,37 +1105,34 @@ async def delete_tag( # pylint: disable=inconsistent-return-statements params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202, 404]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore - @distributed_trace - def get_manifests( + @distributed_trace_async + async def get_manifests( self, name: str, *, last: Optional[str] = None, n: Optional[int] = None, - orderby: Optional[str] = None, + orderby: Optional[Union[str, _models.ArtifactManifestOrder]] = None, **kwargs: Any - ) -> AsyncIterable["_models.ManifestAttributesBase"]: + ) -> _models.AcrManifests: """List manifests of a repository. :param name: Name of the image (including the namespace). Required. @@ -1015,19 +1142,14 @@ def get_manifests( :paramtype last: str :keyword n: query parameter for max number of items. Default value is None. :paramtype n: int - :keyword orderby: orderby query parameter. Default value is None. - :paramtype orderby: str - :return: An iterator like instance of ManifestAttributesBase - :rtype: - ~azure.core.async_paging.AsyncItemPaged[~container_registry.models.ManifestAttributesBase] + :keyword orderby: orderby query parameter. Known values are: "none", "timedesc", and "timeasc". + Default value is None. + :paramtype orderby: str or ~azure.containerregistry._generated.models.ArtifactManifestOrder + :return: AcrManifests. The AcrManifests is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrManifests :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = kwargs.pop("params", {}) or {} - - cls: ClsType[_models._models.AcrManifests] = kwargs.pop("cls", None) # pylint: disable=protected-access - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1035,71 +1157,50 @@ def get_manifests( } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_container_registry_get_manifests_request( - name=name, - last=last, - n=n, - orderby=orderby, - api_version=self._config.api_version, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) - - else: - # make call to next link with the client's api-version - _parsed_next_link = urllib.parse.urlparse(next_link) - _next_request_params = case_insensitive_dict( - { - key: [urllib.parse.quote(v) for v in value] - for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() - } - ) - _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) - - return request + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} - async def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.AcrManifests, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.manifests - if cls: - list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, AsyncList(list_of_elem) + cls: ClsType[_models.AcrManifests] = kwargs.pop("cls", None) - async def get_next(next_link=None): - request = prepare_request(next_link) + _request = build_container_registry_get_manifests_request( + name=name, + last=last, + n=n, + orderby=orderby, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False - pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs - ) - response = pipeline_response.http_response + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - if response.status_code not in [200]: - if _stream: + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: await response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) - return pipeline_response + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrManifests, response.json()) - return AsyncItemPaged(get_next, extract_data) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @distributed_trace_async async def get_manifest_properties( @@ -1111,11 +1212,12 @@ async def get_manifest_properties( :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1128,7 +1230,7 @@ async def get_manifest_properties( cls: ClsType[_models.ArtifactManifestProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_manifest_properties_request( + _request = build_container_registry_get_manifest_properties_request( name=name, digest=digest, api_version=self._config.api_version, @@ -1136,30 +1238,35 @@ async def get_manifest_properties( params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactManifestProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactManifestProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @overload async def update_manifest_properties( @@ -1178,12 +1285,40 @@ async def update_manifest_properties( :param digest: Digest of a BLOB. Required. :type digest: str :param value: Manifest attribute value. Default value is None. - :type value: ~container_registry.models.ManifestWriteableProperties + :type value: ~azure.containerregistry._generated.models.ManifestWriteableProperties + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def update_manifest_properties( + self, + name: str, + digest: str, + value: Optional[JSON] = None, + *, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.ArtifactManifestProperties: + """Update properties of a manifest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param digest: Digest of a BLOB. Required. + :type digest: str + :param value: Manifest attribute value. Default value is None. + :type value: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1192,7 +1327,7 @@ async def update_manifest_properties( self, name: str, digest: str, - value: Optional[IO] = None, + value: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any @@ -1204,12 +1339,13 @@ async def update_manifest_properties( :param digest: Digest of a BLOB. Required. :type digest: str :param value: Manifest attribute value. Default value is None. - :type value: IO + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1218,7 +1354,7 @@ async def update_manifest_properties( self, name: str, digest: str, - value: Optional[Union[_models.ManifestWriteableProperties, IO]] = None, + value: Optional[Union[_models.ManifestWriteableProperties, JSON, IO[bytes]]] = None, **kwargs: Any ) -> _models.ArtifactManifestProperties: """Update properties of a manifest. @@ -1227,17 +1363,16 @@ async def update_manifest_properties( :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :param value: Manifest attribute value. Is either a ManifestWriteableProperties type or a IO - type. Default value is None. - :type value: ~container_registry.models.ManifestWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :param value: Manifest attribute value. Is one of the following types: + ManifestWriteableProperties, JSON, IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.ManifestWriteableProperties or JSON or + IO[bytes] + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1249,54 +1384,58 @@ async def update_manifest_properties( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ArtifactManifestProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "ManifestWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_manifest_properties_request( + _request = build_container_registry_update_manifest_properties_request( name=name, digest=digest, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactManifestProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactManifestProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore class ContainerRegistryBlobOperations: @@ -1305,18 +1444,16 @@ class ContainerRegistryBlobOperations: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.aio.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.aio.ContainerRegistry`'s :attr:`container_registry_blob` attribute. """ - models = _models - def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace_async async def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[AsyncIterator[bytes]]: @@ -1326,11 +1463,11 @@ async def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Asyn :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: Async iterator of the response bytes or None + :return: AsyncIterator[bytes] or None :rtype: AsyncIterator[bytes] or None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1343,27 +1480,31 @@ async def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Asyn cls: ClsType[Optional[AsyncIterator[bytes]]] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_blob_request( + _request = build_container_registry_blob_get_blob_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = kwargs.pop("stream", True) pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200, 307]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1375,31 +1516,29 @@ async def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Asyn "str", response.headers.get("Docker-Content-Digest") ) - deserialized = response.iter_bytes() - if response.status_code == 307: response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + deserialized = response.iter_bytes() + if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace_async - async def check_blob_exists( # pylint: disable=inconsistent-return-statements - self, name: str, digest: str, **kwargs: Any - ) -> None: + async def check_blob_exists(self, name: str, digest: str, **kwargs: Any) -> bool: """Same as GET, except only the headers are returned. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: None - :rtype: None + :return: bool + :rtype: bool :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1412,30 +1551,28 @@ async def check_blob_exists( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_check_blob_exists_request( + _request = build_container_registry_blob_check_blob_exists_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200, 307]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} if response.status_code == 200: @@ -1448,12 +1585,11 @@ async def check_blob_exists( # pylint: disable=inconsistent-return-statements response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore + return 200 <= response.status_code <= 299 @distributed_trace_async - async def delete_blob( # pylint: disable=inconsistent-return-statements - self, name: str, digest: str, **kwargs: Any - ) -> None: + async def delete_blob(self, name: str, digest: str, **kwargs: Any) -> None: """Removes an already uploaded blob. :param name: Name of the image (including the namespace). Required. @@ -1464,7 +1600,7 @@ async def delete_blob( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1477,27 +1613,26 @@ async def delete_blob( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_delete_blob_request( + _request = build_container_registry_blob_delete_blob_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1507,12 +1642,10 @@ async def delete_blob( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def mount_blob( # pylint: disable=inconsistent-return-statements - self, name: str, *, from_parameter: str, mount: str, **kwargs: Any - ) -> None: + async def mount_blob(self, name: str, *, from_parameter: str, mount: str, **kwargs: Any) -> None: """Mount a blob identified by the ``mount`` parameter from another repository. :param name: Name of the image (including the namespace). Required. @@ -1525,7 +1658,7 @@ async def mount_blob( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1538,31 +1671,29 @@ async def mount_blob( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_mount_blob_request( + _request = build_container_registry_blob_mount_blob_request( name=name, from_parameter=from_parameter, mount=mount, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -1572,23 +1703,22 @@ async def mount_blob( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def get_upload_status( # pylint: disable=inconsistent-return-statements - self, next_link: str, **kwargs: Any - ) -> None: - """Retrieve status of upload identified by uuid. The primary purpose of this endpoint is to - resolve the current status of a resumable upload. - - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + async def get_upload_status(self, next_blob_uuid_link: str, **kwargs: Any) -> None: + """Retrieve status of upload identified by uuid. The primary purpose of this + endpoint is to resolve the current status of a resumable upload. + + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1601,53 +1731,50 @@ async def get_upload_status( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_upload_status_request( - next_link=next_link, + _request = build_container_registry_blob_get_upload_status_request( + next_blob_uuid_link=next_blob_uuid_link, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Range"] = self._deserialize("str", response.headers.get("Range")) response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def upload_chunk( # pylint: disable=inconsistent-return-statements - self, next_link: str, value: IO, **kwargs: Any - ) -> None: + async def upload_chunk(self, next_blob_uuid_link: str, value: bytes, **kwargs: Any) -> None: """Upload a stream of data without completing the upload. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :param value: Raw data of blob. Required. - :type value: IO + :type value: bytes :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1663,31 +1790,29 @@ async def upload_chunk( # pylint: disable=inconsistent-return-statements _content = value - request = build_container_registry_blob_upload_chunk_request( - next_link=next_link, + _request = build_container_registry_blob_upload_chunk_request( + next_blob_uuid_link=next_blob_uuid_link, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -1695,27 +1820,29 @@ async def upload_chunk( # pylint: disable=inconsistent-return-statements response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def complete_upload( # pylint: disable=inconsistent-return-statements - self, next_link: str, value: Optional[IO] = None, *, digest: str, **kwargs: Any + async def complete_upload( + self, next_blob_uuid_link: str, value: Optional[bytes] = None, *, digest: str, **kwargs: Any ) -> None: - """Complete the upload, providing all the data in the body, if necessary. A request without a body - will just complete the upload with previously uploaded content. + """Complete the upload, providing all the data in the body, if necessary. A + request without a body will just complete the upload with previously uploaded + content. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :param value: Optional raw data of blob. Default value is None. - :type value: IO + :type value: bytes :keyword digest: Digest of a BLOB. Required. :paramtype digest: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1726,37 +1853,38 @@ async def complete_upload( # pylint: disable=inconsistent-return-statements _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} - content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/octet-stream")) + content_type: Optional[str] = kwargs.pop( + "content_type", _headers.pop("Content-Type", "application/octet-stream") + ) + content_type = content_type if value else None cls: ClsType[None] = kwargs.pop("cls", None) _content = value - request = build_container_registry_blob_complete_upload_request( - next_link=next_link, + _request = build_container_registry_blob_complete_upload_request( + next_blob_uuid_link=next_blob_uuid_link, digest=digest, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -1766,23 +1894,22 @@ async def complete_upload( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def cancel_upload( # pylint: disable=inconsistent-return-statements - self, next_link: str, **kwargs: Any - ) -> None: - """Cancel outstanding upload processes, releasing associated resources. If this is not called, the - unfinished uploads will eventually timeout. - - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + async def cancel_upload(self, next_blob_uuid_link: str, **kwargs: Any) -> None: + """Cancel outstanding upload processes, releasing associated resources. If this is + not called, the unfinished uploads will eventually timeout. + + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1795,35 +1922,33 @@ async def cancel_upload( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_cancel_upload_request( - next_link=next_link, + _request = build_container_registry_blob_cancel_upload_request( + next_blob_uuid_link=next_blob_uuid_link, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace_async - async def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + async def start_upload(self, name: str, **kwargs: Any) -> None: """Initiate a resumable blob upload with an empty request body. :param name: Name of the image (including the namespace). Required. @@ -1832,7 +1957,7 @@ async def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disab :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1845,29 +1970,27 @@ async def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disab cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_start_upload_request( + _request = build_container_registry_blob_start_upload_request( name=name, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -1875,27 +1998,27 @@ async def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disab response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs: Any) -> AsyncIterator[bytes]: - """Retrieve the blob from the registry identified by ``digest``. This endpoint may also support - RFC7233 compliant range requests. Support can be detected by issuing a HEAD request. If the - header ``Accept-Range: bytes`` is returned, range requests can be used to fetch partial - content. + async def get_chunk(self, name: str, digest: str, *, range: str, **kwargs: Any) -> None: + """Retrieve the blob from the registry identified by ``digest``. This endpoint may + also support RFC7233 compliant range requests. Support can be detected by + issuing a HEAD request. If the header ``Accept-Range: bytes`` is returned, range + requests can be used to fetch partial content. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :keyword range_header: Format : bytes=:code:``-:code:``, HTTP Range header - specifying blob chunk. Required. - :paramtype range_header: str - :return: Async iterator of the response bytes - :rtype: AsyncIterator[bytes] + :keyword range: Format : bytes=-, HTTP Range header specifying blob chunk. + Required. + :paramtype range: str + :return: None + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1906,30 +2029,29 @@ async def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[AsyncIterator[bytes]] = kwargs.pop("cls", None) + cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_chunk_request( + _request = build_container_registry_blob_get_chunk_request( name=name, digest=digest, - range_header=range_header, + range=range, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [206]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1937,31 +2059,25 @@ async def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Content-Range"] = self._deserialize("str", response.headers.get("Content-Range")) - deserialized = response.iter_bytes() - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace_async - async def check_chunk_exists( # pylint: disable=inconsistent-return-statements - self, name: str, digest: str, *, range_header: str, **kwargs: Any - ) -> None: + async def check_chunk_exists(self, name: str, digest: str, *, range: str, **kwargs: Any) -> bool: """Same as GET, except only the headers are returned. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :keyword range_header: Format : bytes=:code:``-:code:``, HTTP Range header - specifying blob chunk. Required. - :paramtype range_header: str - :return: None - :rtype: None + :keyword range: Format : bytes=-, HTTP Range header specifying blob chunk. + Required. + :paramtype range: str + :return: bool + :rtype: bool :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1974,62 +2090,307 @@ async def check_chunk_exists( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_check_chunk_exists_request( + _request = build_container_registry_blob_check_chunk_exists_request( name=name, digest=digest, - range_header=range_header, + range=range, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Content-Range"] = self._deserialize("str", response.headers.get("Content-Range")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore + return 200 <= response.status_code <= 299 -class AuthenticationOperations: # pylint: disable=abstract-class-instantiated +class AuthenticationOperations: """ .. warning:: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.aio.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.aio.ContainerRegistry`'s :attr:`authentication` attribute. """ - models = _models - def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") - raise_if_not_implemented( - self.__class__, - [ - "exchange_aad_access_token_for_acr_refresh_token", - "exchange_acr_refresh_token_for_acr_access_token", - ], + self._client: AsyncPipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + async def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: _models.MultipartBodyParameter, **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: JSON, **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Required. + :type body: JSON + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: Union[_models.MultipartBodyParameter, JSON], **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Is either a MultipartBodyParameter type or a JSON type. + Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter or JSON + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrRefreshToken] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _Model) else body + _file_fields: list[str] = [] + _data_fields: list[str] = ["grantType", "service", "tenant", "refreshToken", "accessToken"] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_authentication_exchange_aad_access_token_for_acr_refresh_token_request( + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrRefreshToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + async def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: _models.MultipartBodyParameter, **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: JSON, **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Required. + :type body: JSON + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace_async + async def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: Union[_models.MultipartBodyParameter, JSON], **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Is either a MultipartBodyParameter type or a JSON type. + Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter or JSON + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrAccessToken] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _Model) else body + _file_fields: list[str] = [] + _data_fields: list[str] = ["grantType", "service", "tenant", "refreshToken", "accessToken"] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_authentication_exchange_acr_refresh_token_for_acr_access_token_request( + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrAccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace_async + async def get_acr_access_token_from_login( + self, *, service: str, scope: str, **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange Username, Password and Scope for an ACR Access Token. + + :keyword service: Indicates the name of your Azure container registry. Required. + :paramtype service: str + :keyword scope: Expected to be a valid scope, and can be specified more than once for multiple + scope requests. You can obtain this from the Www-Authenticate response header + from the challenge. Required. + :paramtype scope: str + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrAccessToken] = kwargs.pop("cls", None) + + _request = build_authentication_get_acr_access_token_from_login_request( + service=service, + scope=scope, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = await self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrAccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_patch.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_patch.py index 28f7b7d642e0..c90e93d19fc6 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_patch.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/aio/operations/_patch.py @@ -1,11 +1,13 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ + from typing import Any, Callable, Dict, Optional, TypeVar, Union from azure.core.exceptions import ( @@ -28,6 +30,8 @@ build_exchange_acr_refresh_token_for_acr_access_token_request, ) +from ..._utils.model_base import _deserialize + T = TypeVar("T") ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] @@ -91,7 +95,7 @@ async def exchange_aad_access_token_for_acr_refresh_token( params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore @@ -104,7 +108,7 @@ async def exchange_aad_access_token_for_acr_refresh_token( map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("AcrRefreshToken", pipeline_response) + deserialized = _deserialize(_models.AcrRefreshToken, response.json()) if cls: return cls(pipeline_response, deserialized, {}) @@ -164,7 +168,7 @@ async def exchange_acr_refresh_token_for_acr_access_token( params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore @@ -177,16 +181,16 @@ async def exchange_acr_refresh_token_for_acr_access_token( map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("AcrAccessToken", pipeline_response) + deserialized = _deserialize(_models.AcrAccessToken, response.json()) if cls: return cls(pipeline_response, deserialized, {}) return deserialized -__all__ = [ - "AuthenticationOperations" -] # type: List[str] # Add all objects you want publicly available to users at this package level +__all__: list[str] = [ + "AuthenticationOperations", +] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/__init__.py index c1a4cd394315..381ab237a495 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/__init__.py @@ -1,59 +1,66 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._models import AcrAccessToken -from ._models import AcrErrorInfo -from ._models import AcrErrors -from ._models import AcrRefreshToken -from ._models import Annotations -from ._models import ArtifactManifestPlatform -from ._models import ArtifactManifestProperties -from ._models import ArtifactTagProperties -from ._models import ContainerRepositoryProperties -from ._models import DeleteRepositoryResult -from ._models import Descriptor -from ._models import FsLayer -from ._models import History -from ._models import ImageSignature -from ._models import JWK -from ._models import JWKHeader -from ._models import Manifest -from ._models import ManifestAttributesBase -from ._models import ManifestAttributesManifest -from ._models import ManifestList -from ._models import ManifestListAttributes -from ._models import ManifestWrapper -from ._models import ManifestWriteableProperties -from ._models import OCIIndex -from ._models import OCIManifest -from ._models import Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema -from ._models import PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema -from ._models import Platform -from ._models import RepositoryTags -from ._models import RepositoryWriteableProperties -from ._models import TagAttributesBase -from ._models import TagAttributesTag -from ._models import TagWriteableProperties -from ._models import V1Manifest -from ._models import V2Manifest +from typing import TYPE_CHECKING -from ._enums import ArtifactArchitecture -from ._enums import ArtifactManifestOrder -from ._enums import ArtifactOperatingSystem -from ._enums import ArtifactTagOrder -from ._enums import PostContentSchemaGrantType -from ._enums import TokenGrantType +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + AcrAccessToken, + AcrErrorInfo, + AcrErrors, + AcrManifests, + AcrRefreshToken, + Annotations, + ArtifactManifestPlatform, + ArtifactManifestProperties, + ArtifactTagProperties, + ContainerRepositoryProperties, + DeleteRepositoryResult, + Descriptor, + FsLayer, + History, + ImageSignature, + JWK, + JWKHeader, + Manifest, + ManifestAttributesBase, + ManifestListAttributes, + ManifestWrapper, + ManifestWriteableProperties, + MultipartBodyParameter, + Platform, + RepositoryWriteableProperties, + TagAttributesBase, + TagList, + TagWriteableProperties, +) + +from ._enums import ( # type: ignore + ArtifactArchitecture, + ArtifactManifestOrder, + ArtifactOperatingSystem, + ArtifactTagOrder, + PostContentSchemaGrantType, + TokenGrantType, +) from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ "AcrAccessToken", "AcrErrorInfo", "AcrErrors", + "AcrManifests", "AcrRefreshToken", "Annotations", "ArtifactManifestPlatform", @@ -69,23 +76,15 @@ "JWKHeader", "Manifest", "ManifestAttributesBase", - "ManifestAttributesManifest", - "ManifestList", "ManifestListAttributes", "ManifestWrapper", "ManifestWriteableProperties", - "OCIIndex", - "OCIManifest", - "Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema", - "PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema", + "MultipartBodyParameter", "Platform", - "RepositoryTags", "RepositoryWriteableProperties", "TagAttributesBase", - "TagAttributesTag", + "TagList", "TagWriteableProperties", - "V1Manifest", - "V2Manifest", "ArtifactArchitecture", "ArtifactManifestOrder", "ArtifactOperatingSystem", @@ -93,5 +92,5 @@ "PostContentSchemaGrantType", "TokenGrantType", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_enums.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_enums.py index 2182c99cc41e..268c6e53a664 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_enums.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_enums.py @@ -1,6 +1,8 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- @@ -45,28 +47,44 @@ class ArtifactManifestOrder(str, Enum, metaclass=CaseInsensitiveEnumMeta): NONE = "none" """Do not provide an orderby value in the request.""" LAST_UPDATED_ON_DESCENDING = "timedesc" - """Order manifests by LastUpdatedOn field, from most recently updated to least recently updated.""" + """Order manifests by LastUpdatedOn field, from most recently updated to least + recently updated.""" LAST_UPDATED_ON_ASCENDING = "timeasc" - """Order manifest by LastUpdatedOn field, from least recently updated to most recently updated.""" + """Order manifest by LastUpdatedOn field, from least recently updated to most + recently updated.""" class ArtifactOperatingSystem(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """ArtifactOperatingSystem.""" + """The artifact platform's operating system.""" AIX = "aix" + """AIX operating system""" ANDROID = "android" + """Android operating system""" DARWIN = "darwin" + """Darwin operating system""" DRAGONFLY = "dragonfly" + """Dragonfly operating system""" FREE_BSD = "freebsd" + """FreeBSD operating system""" ILLUMOS = "illumos" + """Illumos operating system""" I_OS = "ios" + """iOS operating system""" JS = "js" + """JavaScript operating system""" LINUX = "linux" + """Linux operating system""" NET_BSD = "netbsd" + """NetBSD operating system""" OPEN_BSD = "openbsd" + """OpenBSD operating system""" PLAN9 = "plan9" + """Plan 9 operating system""" SOLARIS = "solaris" + """Solaris operating system""" WINDOWS = "windows" + """Windows operating system""" class ArtifactTagOrder(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -75,21 +93,30 @@ class ArtifactTagOrder(str, Enum, metaclass=CaseInsensitiveEnumMeta): NONE = "none" """Do not provide an orderby value in the request.""" LAST_UPDATED_ON_DESCENDING = "timedesc" - """Order tags by LastUpdatedOn field, from most recently updated to least recently updated.""" + """Order tags by LastUpdatedOn field, from most recently updated to least recently + updated.""" LAST_UPDATED_ON_ASCENDING = "timeasc" - """Order tags by LastUpdatedOn field, from least recently updated to most recently updated.""" + """Order tags by LastUpdatedOn field, from least recently updated to most recently + updated.""" class PostContentSchemaGrantType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Can take a value of access_token_refresh_token, or access_token, or refresh_token.""" + """Can take a value of access_token_refresh_token, or access_token, or + refresh_token. + """ ACCESS_TOKEN_REFRESH_TOKEN = "access_token_refresh_token" + """Grant type for exchanging both access token and refresh token""" ACCESS_TOKEN = "access_token" + """Grant type for exchanging access token only""" REFRESH_TOKEN = "refresh_token" + """Grant type for exchanging refresh token only""" class TokenGrantType(str, Enum, metaclass=CaseInsensitiveEnumMeta): """Grant type is expected to be refresh_token.""" REFRESH_TOKEN = "refresh_token" + """Grant type for refreshing the token""" PASSWORD = "password" + """Grant type for password authentication""" diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_models.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_models.py index 7c2d829ebf55..1250508810e3 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_models.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_models.py @@ -1,48 +1,51 @@ -# coding=utf-8 # pylint: disable=too-many-lines +# coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation import datetime -import sys -from typing import Any, Dict, List, Optional, TYPE_CHECKING, Union +from typing import Any, Mapping, Optional, TYPE_CHECKING, Union, overload -from .. import _serialization - -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +from .._utils.model_base import Model as _Model, rest_field if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -JSON = MutableMapping[str, Any] # pylint: disable=unsubscriptable-object -class AcrAccessToken(_serialization.Model): - """AcrAccessToken. +class AcrAccessToken(_Model): + """The ACR access token response containing the access token for authentication. :ivar access_token: The access token for performing authenticated requests. :vartype access_token: str """ - _attribute_map = { - "access_token": {"key": "access_token", "type": "str"}, - } + access_token: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The access token for performing authenticated requests.""" + + @overload + def __init__( + self, + *, + access_token: Optional[str] = None, + ) -> None: ... - def __init__(self, *, access_token: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword access_token: The access token for performing authenticated requests. - :paramtype access_token: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.access_token = access_token + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class AcrErrorInfo(_serialization.Model): +class AcrErrorInfo(_Model): """Error information. :ivar code: Error code. @@ -50,53 +53,67 @@ class AcrErrorInfo(_serialization.Model): :ivar message: Error message. :vartype message: str :ivar detail: Error details. - :vartype detail: JSON + :vartype detail: dict[str, str] """ - _attribute_map = { - "code": {"key": "code", "type": "str"}, - "message": {"key": "message", "type": "str"}, - "detail": {"key": "detail", "type": "object"}, - } + code: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error code.""" + message: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error message.""" + detail: Optional[dict[str, str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Error details.""" + @overload def __init__( - self, *, code: Optional[str] = None, message: Optional[str] = None, detail: Optional[JSON] = None, **kwargs: Any - ) -> None: + self, + *, + code: Optional[str] = None, + message: Optional[str] = None, + detail: Optional[dict[str, str]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword code: Error code. - :paramtype code: str - :keyword message: Error message. - :paramtype message: str - :keyword detail: Error details. - :paramtype detail: JSON + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.code = code - self.message = message - self.detail = detail + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class AcrErrors(_serialization.Model): +class AcrErrors(_Model): """Acr error response describing why the operation failed. :ivar errors: Array of detailed error. - :vartype errors: list[~container_registry.models.AcrErrorInfo] + :vartype errors: list[~azure.containerregistry._generated.models.AcrErrorInfo] """ - _attribute_map = { - "errors": {"key": "errors", "type": "[AcrErrorInfo]"}, - } + errors: Optional[list["_models.AcrErrorInfo"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Array of detailed error.""" + + @overload + def __init__( + self, + *, + errors: Optional[list["_models.AcrErrorInfo"]] = None, + ) -> None: ... - def __init__(self, *, errors: Optional[List["_models.AcrErrorInfo"]] = None, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword errors: Array of detailed error. - :paramtype errors: list[~container_registry.models.AcrErrorInfo] + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.errors = errors + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class AcrManifests(_serialization.Model): + +class AcrManifests(_Model): """Manifest attributes. :ivar registry_login_server: Registry login server name. This is likely to be similar to @@ -105,73 +122,80 @@ class AcrManifests(_serialization.Model): :ivar repository: Image name. :vartype repository: str :ivar manifests: List of manifests. - :vartype manifests: list[~container_registry.models.ManifestAttributesBase] - :ivar link: + :vartype manifests: list[~azure.containerregistry._generated.models.ManifestAttributesBase] + :ivar link: Link to the next page of results. :vartype link: str """ - _attribute_map = { - "registry_login_server": {"key": "registry", "type": "str"}, - "repository": {"key": "imageName", "type": "str"}, - "manifests": {"key": "manifests", "type": "[ManifestAttributesBase]"}, - "link": {"key": "link", "type": "str"}, - } - + registry_login_server: Optional[str] = rest_field( + name="registry", visibility=["read", "create", "update", "delete", "query"] + ) + """Registry login server name. This is likely to be similar to + {registry-name}.azurecr.io.""" + repository: Optional[str] = rest_field(name="imageName", visibility=["read", "create", "update", "delete", "query"]) + """Image name.""" + manifests: Optional[list["_models.ManifestAttributesBase"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """List of manifests.""" + link: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Link to the next page of results.""" + + @overload def __init__( self, *, registry_login_server: Optional[str] = None, repository: Optional[str] = None, - manifests: Optional[List["_models.ManifestAttributesBase"]] = None, + manifests: Optional[list["_models.ManifestAttributesBase"]] = None, link: Optional[str] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword registry_login_server: Registry login server name. This is likely to be similar to - {registry-name}.azurecr.io. - :paramtype registry_login_server: str - :keyword repository: Image name. - :paramtype repository: str - :keyword manifests: List of manifests. - :paramtype manifests: list[~container_registry.models.ManifestAttributesBase] - :keyword link: - :paramtype link: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.registry_login_server = registry_login_server - self.repository = repository - self.manifests = manifests - self.link = link + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class AcrRefreshToken(_serialization.Model): - """AcrRefreshToken. +class AcrRefreshToken(_Model): + """The ACR refresh token response containing the refresh token for authentication. :ivar refresh_token: The refresh token to be used for generating access tokens. :vartype refresh_token: str """ - _attribute_map = { - "refresh_token": {"key": "refresh_token", "type": "str"}, - } + refresh_token: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The refresh token to be used for generating access tokens.""" - def __init__(self, *, refresh_token: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + refresh_token: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword refresh_token: The refresh token to be used for generating access tokens. - :paramtype refresh_token: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.refresh_token = refresh_token + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class Annotations(_serialization.Model): # pylint: disable=too-many-instance-attributes +class Annotations(_Model): """Additional information provided through arbitrary metadata. - :ivar additional_properties: Unmatched properties from the message are deserialized to this - collection. - :vartype additional_properties: dict[str, JSON] :ivar created: Date and time on which the image was built (string, date-time as defined by - https://tools.ietf.org/html/rfc3339#section-5.6). + `https://tools.ietf.org/html/rfc3339#section-5.6 + `_). :vartype created: ~datetime.datetime :ivar authors: Contact details of the people or organization responsible for the image. :vartype authors: str @@ -199,26 +223,65 @@ class Annotations(_serialization.Model): # pylint: disable=too-many-instance-at :vartype description: str """ - _attribute_map = { - "additional_properties": {"key": "", "type": "{object}"}, - "created": {"key": "org\\.opencontainers\\.image\\.created", "type": "iso-8601"}, - "authors": {"key": "org\\.opencontainers\\.image\\.authors", "type": "str"}, - "url": {"key": "org\\.opencontainers\\.image\\.url", "type": "str"}, - "documentation": {"key": "org\\.opencontainers\\.image\\.documentation", "type": "str"}, - "source": {"key": "org\\.opencontainers\\.image\\.source", "type": "str"}, - "version": {"key": "org\\.opencontainers\\.image\\.version", "type": "str"}, - "revision": {"key": "org\\.opencontainers\\.image\\.revision", "type": "str"}, - "vendor": {"key": "org\\.opencontainers\\.image\\.vendor", "type": "str"}, - "licenses": {"key": "org\\.opencontainers\\.image\\.licenses", "type": "str"}, - "name": {"key": "org\\.opencontainers\\.image\\.ref\\.name", "type": "str"}, - "title": {"key": "org\\.opencontainers\\.image\\.title", "type": "str"}, - "description": {"key": "org\\.opencontainers\\.image\\.description", "type": "str"}, - } - + created: Optional[datetime.datetime] = rest_field( + name="org.opencontainers.image.created", + visibility=["read", "create", "update", "delete", "query"], + format="rfc3339", + ) + """Date and time on which the image was built (string, date-time as defined by + `https://tools.ietf.org/html/rfc3339#section-5.6 + `_).""" + authors: Optional[str] = rest_field( + name="org.opencontainers.image.authors", visibility=["read", "create", "update", "delete", "query"] + ) + """Contact details of the people or organization responsible for the image.""" + url: Optional[str] = rest_field( + name="org.opencontainers.image.url", visibility=["read", "create", "update", "delete", "query"] + ) + """URL to find more information on the image.""" + documentation: Optional[str] = rest_field( + name="org.opencontainers.image.documentation", visibility=["read", "create", "update", "delete", "query"] + ) + """URL to get documentation on the image.""" + source: Optional[str] = rest_field( + name="org.opencontainers.image.source", visibility=["read", "create", "update", "delete", "query"] + ) + """URL to get source code for building the image.""" + version: Optional[str] = rest_field( + name="org.opencontainers.image.version", visibility=["read", "create", "update", "delete", "query"] + ) + """Version of the packaged software. The version MAY match a label or tag in the + source code repository, may also be Semantic versioning-compatible.""" + revision: Optional[str] = rest_field( + name="org.opencontainers.image.revision", visibility=["read", "create", "update", "delete", "query"] + ) + """Source control revision identifier for the packaged software.""" + vendor: Optional[str] = rest_field( + name="org.opencontainers.image.vendor", visibility=["read", "create", "update", "delete", "query"] + ) + """Name of the distributing entity, organization or individual.""" + licenses: Optional[str] = rest_field( + name="org.opencontainers.image.licenses", visibility=["read", "create", "update", "delete", "query"] + ) + """License(s) under which contained software is distributed as an SPDX License + Expression.""" + name: Optional[str] = rest_field( + name="org.opencontainers.image.ref.name", visibility=["read", "create", "update", "delete", "query"] + ) + """Name of the reference for a target.""" + title: Optional[str] = rest_field( + name="org.opencontainers.image.title", visibility=["read", "create", "update", "delete", "query"] + ) + """Human-readable title of the image.""" + description: Optional[str] = rest_field( + name="org.opencontainers.image.description", visibility=["read", "create", "update", "delete", "query"] + ) + """Human-readable description of the software packaged in the image.""" + + @overload def __init__( self, *, - additional_properties: Optional[Dict[str, JSON]] = None, created: Optional[datetime.datetime] = None, authors: Optional[str] = None, url: Optional[str] = None, @@ -231,173 +294,93 @@ def __init__( name: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword additional_properties: Unmatched properties from the message are deserialized to this - collection. - :paramtype additional_properties: dict[str, JSON] - :keyword created: Date and time on which the image was built (string, date-time as defined by - https://tools.ietf.org/html/rfc3339#section-5.6). - :paramtype created: ~datetime.datetime - :keyword authors: Contact details of the people or organization responsible for the image. - :paramtype authors: str - :keyword url: URL to find more information on the image. - :paramtype url: str - :keyword documentation: URL to get documentation on the image. - :paramtype documentation: str - :keyword source: URL to get source code for building the image. - :paramtype source: str - :keyword version: Version of the packaged software. The version MAY match a label or tag in the - source code repository, may also be Semantic versioning-compatible. - :paramtype version: str - :keyword revision: Source control revision identifier for the packaged software. - :paramtype revision: str - :keyword vendor: Name of the distributing entity, organization or individual. - :paramtype vendor: str - :keyword licenses: License(s) under which contained software is distributed as an SPDX License - Expression. - :paramtype licenses: str - :keyword name: Name of the reference for a target. - :paramtype name: str - :keyword title: Human-readable title of the image. - :paramtype title: str - :keyword description: Human-readable description of the software packaged in the image. - :paramtype description: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.additional_properties = additional_properties - self.created = created - self.authors = authors - self.url = url - self.documentation = documentation - self.source = source - self.version = version - self.revision = revision - self.vendor = vendor - self.licenses = licenses - self.name = name - self.title = title - self.description = description - - -class ArtifactManifestPlatform(_serialization.Model): - """The artifact's platform, consisting of operating system and architecture. - Variables are only populated by the server, and will be ignored when sending a request. + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + - All required parameters must be populated in order to send to Azure. +class ArtifactManifestPlatform(_Model): + """The artifact's platform, consisting of operating system and architecture. :ivar digest: Manifest digest. Required. :vartype digest: str :ivar architecture: CPU architecture. Known values are: "386", "amd64", "arm", "arm64", "mips", "mipsle", "mips64", "mips64le", "ppc64", "ppc64le", "riscv64", "s390x", and "wasm". - :vartype architecture: str or ~container_registry.models.ArtifactArchitecture + :vartype architecture: str or ~azure.containerregistry._generated.models.ArtifactArchitecture :ivar operating_system: Operating system. Known values are: "aix", "android", "darwin", "dragonfly", "freebsd", "illumos", "ios", "js", "linux", "netbsd", "openbsd", "plan9", "solaris", and "windows". - :vartype operating_system: str or ~container_registry.models.ArtifactOperatingSystem + :vartype operating_system: str or + ~azure.containerregistry._generated.models.ArtifactOperatingSystem """ - _validation = { - "digest": {"required": True, "readonly": True}, - "architecture": {"readonly": True}, - "operating_system": {"readonly": True}, - } - - _attribute_map = { - "digest": {"key": "digest", "type": "str"}, - "architecture": {"key": "architecture", "type": "str"}, - "operating_system": {"key": "os", "type": "str"}, - } - - def __init__(self, **kwargs: Any) -> None: - """ """ - super().__init__(**kwargs) - self.digest = None - self.architecture = None - self.operating_system = None - - -class ArtifactManifestProperties(_serialization.Model): + digest: str = rest_field(visibility=["read"]) + """Manifest digest. Required.""" + architecture: Optional[Union[str, "_models.ArtifactArchitecture"]] = rest_field(visibility=["read"]) + """CPU architecture. Known values are: \"386\", \"amd64\", \"arm\", \"arm64\", \"mips\", + \"mipsle\", \"mips64\", \"mips64le\", \"ppc64\", \"ppc64le\", \"riscv64\", \"s390x\", and + \"wasm\".""" + operating_system: Optional[Union[str, "_models.ArtifactOperatingSystem"]] = rest_field( + name="os", visibility=["read"] + ) + """Operating system. Known values are: \"aix\", \"android\", \"darwin\", \"dragonfly\", + \"freebsd\", \"illumos\", \"ios\", \"js\", \"linux\", \"netbsd\", \"openbsd\", \"plan9\", + \"solaris\", and \"windows\".""" + + +class ArtifactManifestProperties(_Model): """Manifest attributes details. - Variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - :ivar registry_login_server: Registry login server name. This is likely to be similar to {registry-name}.azurecr.io. :vartype registry_login_server: str :ivar repository_name: Repository name. :vartype repository_name: str :ivar manifest: Manifest attributes. Required. - :vartype manifest: ~container_registry.models.ManifestAttributesBase + :vartype manifest: ~azure.containerregistry._generated.models.ManifestAttributesBase """ - _validation = { - "registry_login_server": {"readonly": True}, - "repository_name": {"readonly": True}, - "manifest": {"required": True, "readonly": True}, - } - - _attribute_map = { - "registry_login_server": {"key": "registry", "type": "str"}, - "repository_name": {"key": "imageName", "type": "str"}, - "manifest": {"key": "manifest", "type": "ManifestAttributesBase"}, - } - - def __init__(self, **kwargs: Any) -> None: - """ """ - super().__init__(**kwargs) - self.registry_login_server = None - self.repository_name = None - self.manifest = None + registry_login_server: Optional[str] = rest_field(name="registry", visibility=["read"]) + """Registry login server name. This is likely to be similar to + {registry-name}.azurecr.io.""" + repository_name: Optional[str] = rest_field(name="imageName", visibility=["read"]) + """Repository name.""" + manifest: "_models.ManifestAttributesBase" = rest_field(visibility=["read"]) + """Manifest attributes. Required.""" -class ArtifactTagProperties(_serialization.Model): +class ArtifactTagProperties(_Model): """Tag attributes. - Variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - :ivar registry_login_server: Registry login server name. This is likely to be similar to {registry-name}.azurecr.io. Required. :vartype registry_login_server: str :ivar repository_name: Image name. Required. :vartype repository_name: str :ivar tag: List of tag attribute details. Required. - :vartype tag: ~container_registry.models.TagAttributesBase + :vartype tag: ~azure.containerregistry._generated.models.TagAttributesBase """ - _validation = { - "registry_login_server": {"required": True, "readonly": True}, - "repository_name": {"required": True, "readonly": True}, - "tag": {"required": True, "readonly": True}, - } - - _attribute_map = { - "registry_login_server": {"key": "registry", "type": "str"}, - "repository_name": {"key": "imageName", "type": "str"}, - "tag": {"key": "tag", "type": "TagAttributesBase"}, - } - - def __init__(self, **kwargs: Any) -> None: - """ """ - super().__init__(**kwargs) - self.registry_login_server = None - self.repository_name = None - self.tag = None + registry_login_server: str = rest_field(name="registry", visibility=["read"]) + """Registry login server name. This is likely to be similar to + {registry-name}.azurecr.io. Required.""" + repository_name: str = rest_field(name="imageName", visibility=["read"]) + """Image name. Required.""" + tag: "_models.TagAttributesBase" = rest_field(visibility=["read"]) + """List of tag attribute details. Required.""" -class ContainerRepositoryProperties(_serialization.Model): +class ContainerRepositoryProperties(_Model): """Properties of this repository. - Variables are only populated by the server, and will be ignored when sending a request. - - All required parameters must be populated in order to send to Azure. - :ivar registry_login_server: Registry login server name. This is likely to be similar to {registry-name}.azurecr.io. Required. :vartype registry_login_server: str @@ -412,48 +395,48 @@ class ContainerRepositoryProperties(_serialization.Model): :ivar tag_count: Number of the tags. Required. :vartype tag_count: int :ivar changeable_attributes: Writeable properties of the resource. Required. - :vartype changeable_attributes: ~container_registry.models.RepositoryWriteableProperties + :vartype changeable_attributes: + ~azure.containerregistry._generated.models.RepositoryWriteableProperties """ - _validation = { - "registry_login_server": {"required": True, "readonly": True}, - "name": {"required": True, "readonly": True}, - "created_on": {"required": True, "readonly": True}, - "last_updated_on": {"required": True, "readonly": True}, - "manifest_count": {"required": True, "readonly": True}, - "tag_count": {"required": True, "readonly": True}, - "changeable_attributes": {"required": True}, - } - - _attribute_map = { - "registry_login_server": {"key": "registry", "type": "str"}, - "name": {"key": "imageName", "type": "str"}, - "created_on": {"key": "createdTime", "type": "iso-8601"}, - "last_updated_on": {"key": "lastUpdateTime", "type": "iso-8601"}, - "manifest_count": {"key": "manifestCount", "type": "int"}, - "tag_count": {"key": "tagCount", "type": "int"}, - "changeable_attributes": {"key": "changeableAttributes", "type": "RepositoryWriteableProperties"}, - } - - def __init__(self, *, changeable_attributes: "_models.RepositoryWriteableProperties", **kwargs: Any) -> None: + registry_login_server: str = rest_field(name="registry", visibility=["read"]) + """Registry login server name. This is likely to be similar to + {registry-name}.azurecr.io. Required.""" + name: str = rest_field(name="imageName", visibility=["read"]) + """Image name. Required.""" + created_on: datetime.datetime = rest_field(name="createdTime", visibility=["read"], format="rfc3339") + """Image created time. Required.""" + last_updated_on: datetime.datetime = rest_field(name="lastUpdateTime", visibility=["read"], format="rfc3339") + """Image last update time. Required.""" + manifest_count: int = rest_field(name="manifestCount", visibility=["read"]) + """Number of the manifests. Required.""" + tag_count: int = rest_field(name="tagCount", visibility=["read"]) + """Number of the tags. Required.""" + changeable_attributes: "_models.RepositoryWriteableProperties" = rest_field( + name="changeableAttributes", visibility=["read", "create", "update", "delete", "query"] + ) + """Writeable properties of the resource. Required.""" + + @overload + def __init__( + self, + *, + changeable_attributes: "_models.RepositoryWriteableProperties", + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword changeable_attributes: Writeable properties of the resource. Required. - :paramtype changeable_attributes: ~container_registry.models.RepositoryWriteableProperties + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.registry_login_server = None - self.name = None - self.created_on = None - self.last_updated_on = None - self.manifest_count = None - self.tag_count = None - self.changeable_attributes = changeable_attributes + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class DeleteRepositoryResult(_serialization.Model): - """Deleted repository. - Variables are only populated by the server, and will be ignored when sending a request. +class DeleteRepositoryResult(_Model): + """Deleted repository. :ivar deleted_manifests: SHA of the deleted image. :vartype deleted_manifests: list[str] @@ -461,24 +444,13 @@ class DeleteRepositoryResult(_serialization.Model): :vartype deleted_tags: list[str] """ - _validation = { - "deleted_manifests": {"readonly": True}, - "deleted_tags": {"readonly": True}, - } + deleted_manifests: Optional[list[str]] = rest_field(name="manifestsDeleted", visibility=["read"]) + """SHA of the deleted image.""" + deleted_tags: Optional[list[str]] = rest_field(name="tagsDeleted", visibility=["read"]) + """Tag of the deleted image.""" - _attribute_map = { - "deleted_manifests": {"key": "manifestsDeleted", "type": "[str]"}, - "deleted_tags": {"key": "tagsDeleted", "type": "[str]"}, - } - def __init__(self, **kwargs: Any) -> None: - """ """ - super().__init__(**kwargs) - self.deleted_manifests = None - self.deleted_tags = None - - -class Descriptor(_serialization.Model): +class Descriptor(_Model): """Docker V2 image layer descriptor including config and layers. :ivar media_type: Layer media type. @@ -490,153 +462,174 @@ class Descriptor(_serialization.Model): :ivar urls: Specifies a list of URIs from which this object may be downloaded. :vartype urls: list[str] :ivar annotations: Additional information provided through arbitrary metadata. - :vartype annotations: ~container_registry.models.Annotations + :vartype annotations: ~azure.containerregistry._generated.models.Annotations """ - _attribute_map = { - "media_type": {"key": "mediaType", "type": "str"}, - "size": {"key": "size", "type": "int"}, - "digest": {"key": "digest", "type": "str"}, - "urls": {"key": "urls", "type": "[str]"}, - "annotations": {"key": "annotations", "type": "Annotations"}, - } - + media_type: Optional[str] = rest_field(name="mediaType", visibility=["read", "create", "update", "delete", "query"]) + """Layer media type.""" + size: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Layer size.""" + digest: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Layer digest.""" + urls: Optional[list[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies a list of URIs from which this object may be downloaded.""" + annotations: Optional["_models.Annotations"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """Additional information provided through arbitrary metadata.""" + + @overload def __init__( self, *, media_type: Optional[str] = None, size: Optional[int] = None, digest: Optional[str] = None, - urls: Optional[List[str]] = None, + urls: Optional[list[str]] = None, annotations: Optional["_models.Annotations"] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword media_type: Layer media type. - :paramtype media_type: str - :keyword size: Layer size. - :paramtype size: int - :keyword digest: Layer digest. - :paramtype digest: str - :keyword urls: Specifies a list of URIs from which this object may be downloaded. - :paramtype urls: list[str] - :keyword annotations: Additional information provided through arbitrary metadata. - :paramtype annotations: ~container_registry.models.Annotations + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.media_type = media_type - self.size = size - self.digest = digest - self.urls = urls - self.annotations = annotations + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class FsLayer(_serialization.Model): + +class FsLayer(_Model): """Image layer information. :ivar blob_sum: SHA of an image layer. :vartype blob_sum: str """ - _attribute_map = { - "blob_sum": {"key": "blobSum", "type": "str"}, - } + blob_sum: Optional[str] = rest_field(name="blobSum", visibility=["read", "create", "update", "delete", "query"]) + """SHA of an image layer.""" - def __init__(self, *, blob_sum: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + blob_sum: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword blob_sum: SHA of an image layer. - :paramtype blob_sum: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.blob_sum = blob_sum + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class History(_serialization.Model): +class History(_Model): """A list of unstructured historical data for v1 compatibility. :ivar v1_compatibility: The raw v1 compatibility information. :vartype v1_compatibility: str """ - _attribute_map = { - "v1_compatibility": {"key": "v1Compatibility", "type": "str"}, - } + v1_compatibility: Optional[str] = rest_field( + name="v1Compatibility", visibility=["read", "create", "update", "delete", "query"] + ) + """The raw v1 compatibility information.""" - def __init__(self, *, v1_compatibility: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + v1_compatibility: Optional[str] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword v1_compatibility: The raw v1 compatibility information. - :paramtype v1_compatibility: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.v1_compatibility = v1_compatibility + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class ImageSignature(_serialization.Model): +class ImageSignature(_Model): """Signature of a signed manifest. :ivar header: A JSON web signature. - :vartype header: ~container_registry.models.JWK + :vartype header: ~azure.containerregistry._generated.models.JWK :ivar signature: A signature for the image manifest, signed by a libtrust private key. :vartype signature: str :ivar protected: The signed protected header. :vartype protected: str """ - _attribute_map = { - "header": {"key": "header", "type": "JWK"}, - "signature": {"key": "signature", "type": "str"}, - "protected": {"key": "protected", "type": "str"}, - } + header: Optional["_models.JWK"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """A JSON web signature.""" + signature: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """A signature for the image manifest, signed by a libtrust private key.""" + protected: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The signed protected header.""" + @overload def __init__( self, *, header: Optional["_models.JWK"] = None, signature: Optional[str] = None, protected: Optional[str] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword header: A JSON web signature. - :paramtype header: ~container_registry.models.JWK - :keyword signature: A signature for the image manifest, signed by a libtrust private key. - :paramtype signature: str - :keyword protected: The signed protected header. - :paramtype protected: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.header = header - self.signature = signature - self.protected = protected + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class JWK(_serialization.Model): +class JWK(_Model): """A JSON web signature. :ivar jwk: JSON web key parameter. - :vartype jwk: ~container_registry.models.JWKHeader + :vartype jwk: ~azure.containerregistry._generated.models.JWKHeader :ivar alg: The algorithm used to sign or encrypt the JWT. :vartype alg: str """ - _attribute_map = { - "jwk": {"key": "jwk", "type": "JWKHeader"}, - "alg": {"key": "alg", "type": "str"}, - } + jwk: Optional["_models.JWKHeader"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """JSON web key parameter.""" + alg: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The algorithm used to sign or encrypt the JWT.""" + + @overload + def __init__( + self, + *, + jwk: Optional["_models.JWKHeader"] = None, + alg: Optional[str] = None, + ) -> None: ... - def __init__(self, *, jwk: Optional["_models.JWKHeader"] = None, alg: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword jwk: JSON web key parameter. - :paramtype jwk: ~container_registry.models.JWKHeader - :keyword alg: The algorithm used to sign or encrypt the JWT. - :paramtype alg: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.jwk = jwk - self.alg = alg + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class JWKHeader(_serialization.Model): + +class JWKHeader(_Model): """JSON web key parameter. :ivar crv: crv value. @@ -651,14 +644,18 @@ class JWKHeader(_serialization.Model): :vartype y: str """ - _attribute_map = { - "crv": {"key": "crv", "type": "str"}, - "kid": {"key": "kid", "type": "str"}, - "kty": {"key": "kty", "type": "str"}, - "x": {"key": "x", "type": "str"}, - "y": {"key": "y", "type": "str"}, - } - + crv: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """crv value.""" + kid: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """kid value.""" + kty: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """kty value.""" + x: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """x value.""" + y: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """y value.""" + + @overload def __init__( self, *, @@ -667,54 +664,51 @@ def __init__( kty: Optional[str] = None, x: Optional[str] = None, y: Optional[str] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword crv: crv value. - :paramtype crv: str - :keyword kid: kid value. - :paramtype kid: str - :keyword kty: kty value. - :paramtype kty: str - :keyword x: x value. - :paramtype x: str - :keyword y: y value. - :paramtype y: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.crv = crv - self.kid = kid - self.kty = kty - self.x = x - self.y = y + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class Manifest(_serialization.Model): +class Manifest(_Model): """Returns the requested manifest file. :ivar schema_version: Schema version. :vartype schema_version: int """ - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - } + schema_version: Optional[int] = rest_field( + name="schemaVersion", visibility=["read", "create", "update", "delete", "query"] + ) + """Schema version.""" - def __init__(self, *, schema_version: Optional[int] = None, **kwargs: Any) -> None: + @overload + def __init__( + self, + *, + schema_version: Optional[int] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword schema_version: Schema version. - :paramtype schema_version: int + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.schema_version = schema_version - -class ManifestAttributesBase(_serialization.Model): - """Manifest details. + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - Variables are only populated by the server, and will be ignored when sending a request. - All required parameters must be populated in order to send to Azure. +class ManifestAttributesBase(_Model): + """Manifest details. :ivar digest: Manifest. Required. :vartype digest: str @@ -726,123 +720,83 @@ class ManifestAttributesBase(_serialization.Model): :vartype last_updated_on: ~datetime.datetime :ivar architecture: CPU architecture. Known values are: "386", "amd64", "arm", "arm64", "mips", "mipsle", "mips64", "mips64le", "ppc64", "ppc64le", "riscv64", "s390x", and "wasm". - :vartype architecture: str or ~container_registry.models.ArtifactArchitecture + :vartype architecture: str or ~azure.containerregistry._generated.models.ArtifactArchitecture :ivar operating_system: Operating system. Known values are: "aix", "android", "darwin", "dragonfly", "freebsd", "illumos", "ios", "js", "linux", "netbsd", "openbsd", "plan9", "solaris", and "windows". - :vartype operating_system: str or ~container_registry.models.ArtifactOperatingSystem + :vartype operating_system: str or + ~azure.containerregistry._generated.models.ArtifactOperatingSystem :ivar related_artifacts: List of artifacts that are referenced by this manifest list, with - information about the platform each supports. This list will be empty if this is a leaf + information + about the platform each supports. This list will be empty if this is a leaf manifest and not a manifest list. - :vartype related_artifacts: list[~container_registry.models.ArtifactManifestPlatform] + :vartype related_artifacts: + list[~azure.containerregistry._generated.models.ArtifactManifestPlatform] + :ivar config_media_type: Config blob media type. + :vartype config_media_type: str :ivar tags: List of tags. :vartype tags: list[str] :ivar changeable_attributes: Writeable properties of the resource. - :vartype changeable_attributes: ~container_registry.models.ManifestWriteableProperties + :vartype changeable_attributes: + ~azure.containerregistry._generated.models.ManifestWriteableProperties """ - _validation = { - "digest": {"required": True, "readonly": True}, - "size": {"readonly": True}, - "created_on": {"required": True, "readonly": True}, - "last_updated_on": {"required": True, "readonly": True}, - "architecture": {"readonly": True}, - "operating_system": {"readonly": True}, - "related_artifacts": {"readonly": True}, - "tags": {"readonly": True}, - } - - _attribute_map = { - "digest": {"key": "digest", "type": "str"}, - "size": {"key": "imageSize", "type": "int"}, - "created_on": {"key": "createdTime", "type": "iso-8601"}, - "last_updated_on": {"key": "lastUpdateTime", "type": "iso-8601"}, - "architecture": {"key": "architecture", "type": "str"}, - "operating_system": {"key": "os", "type": "str"}, - "related_artifacts": {"key": "references", "type": "[ArtifactManifestPlatform]"}, - "tags": {"key": "tags", "type": "[str]"}, - "changeable_attributes": {"key": "changeableAttributes", "type": "ManifestWriteableProperties"}, - } - - def __init__( - self, *, changeable_attributes: Optional["_models.ManifestWriteableProperties"] = None, **kwargs: Any - ) -> None: - """ - :keyword changeable_attributes: Writeable properties of the resource. - :paramtype changeable_attributes: ~container_registry.models.ManifestWriteableProperties - """ - super().__init__(**kwargs) - self.digest = None - self.size = None - self.created_on = None - self.last_updated_on = None - self.architecture = None - self.operating_system = None - self.related_artifacts = None - self.tags = None - self.changeable_attributes = changeable_attributes - - -class ManifestAttributesManifest(_serialization.Model): - """List of manifest attributes. - - :ivar references: List of manifest attributes details. - :vartype references: list[~container_registry.models.ArtifactManifestPlatform] - """ - - _attribute_map = { - "references": {"key": "references", "type": "[ArtifactManifestPlatform]"}, - } - - def __init__(self, *, references: Optional[List["_models.ArtifactManifestPlatform"]] = None, **kwargs: Any) -> None: - """ - :keyword references: List of manifest attributes details. - :paramtype references: list[~container_registry.models.ArtifactManifestPlatform] - """ - super().__init__(**kwargs) - self.references = references - - -class ManifestList(Manifest): - """Returns the requested Docker multi-arch-manifest file. - - :ivar schema_version: Schema version. - :vartype schema_version: int - :ivar media_type: Media type for this Manifest. - :vartype media_type: str - :ivar manifests: List of V2 image layer information. - :vartype manifests: list[~container_registry.models.ManifestListAttributes] - """ - - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "media_type": {"key": "mediaType", "type": "str"}, - "manifests": {"key": "manifests", "type": "[ManifestListAttributes]"}, - } - + digest: str = rest_field(visibility=["read"]) + """Manifest. Required.""" + size: Optional[int] = rest_field(name="imageSize", visibility=["read"]) + """Image size.""" + created_on: datetime.datetime = rest_field(name="createdTime", visibility=["read"], format="rfc3339") + """Created time. Required.""" + last_updated_on: datetime.datetime = rest_field(name="lastUpdateTime", visibility=["read"], format="rfc3339") + """Last update time. Required.""" + architecture: Optional[Union[str, "_models.ArtifactArchitecture"]] = rest_field(visibility=["read"]) + """CPU architecture. Known values are: \"386\", \"amd64\", \"arm\", \"arm64\", \"mips\", + \"mipsle\", \"mips64\", \"mips64le\", \"ppc64\", \"ppc64le\", \"riscv64\", \"s390x\", and + \"wasm\".""" + operating_system: Optional[Union[str, "_models.ArtifactOperatingSystem"]] = rest_field( + name="os", visibility=["read"] + ) + """Operating system. Known values are: \"aix\", \"android\", \"darwin\", \"dragonfly\", + \"freebsd\", \"illumos\", \"ios\", \"js\", \"linux\", \"netbsd\", \"openbsd\", \"plan9\", + \"solaris\", and \"windows\".""" + related_artifacts: Optional[list["_models.ArtifactManifestPlatform"]] = rest_field( + name="references", visibility=["read"] + ) + """List of artifacts that are referenced by this manifest list, with information + about the platform each supports. This list will be empty if this is a leaf + manifest and not a manifest list.""" + config_media_type: Optional[str] = rest_field( + name="configMediaType", visibility=["read", "create", "update", "delete", "query"] + ) + """Config blob media type.""" + tags: Optional[list[str]] = rest_field(visibility=["read"]) + """List of tags.""" + changeable_attributes: Optional["_models.ManifestWriteableProperties"] = rest_field( + name="changeableAttributes", visibility=["read", "create", "update", "delete", "query"] + ) + """Writeable properties of the resource.""" + + @overload def __init__( self, *, - schema_version: Optional[int] = None, - media_type: Optional[str] = None, - manifests: Optional[List["_models.ManifestListAttributes"]] = None, - **kwargs: Any - ) -> None: + config_media_type: Optional[str] = None, + changeable_attributes: Optional["_models.ManifestWriteableProperties"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword media_type: Media type for this Manifest. - :paramtype media_type: str - :keyword manifests: List of V2 image layer information. - :paramtype manifests: list[~container_registry.models.ManifestListAttributes] + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(schema_version=schema_version, **kwargs) - self.media_type = media_type - self.manifests = manifests + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class ManifestListAttributes(_serialization.Model): - """ManifestListAttributes. +class ManifestListAttributes(_Model): + """Attributes of a manifest in a manifest list. :ivar media_type: The MIME type of the referenced object. This will generally be application/vnd.docker.image.manifest.v2+json, but it could also be @@ -853,18 +807,25 @@ class ManifestListAttributes(_serialization.Model): :ivar digest: The digest of the content, as defined by the Registry V2 HTTP API Specification. :vartype digest: str :ivar platform: The platform object describes the platform which the image in the manifest runs - on. A full list of valid operating system and architecture values are listed in the Go language - documentation for $GOOS and $GOARCH. - :vartype platform: ~container_registry.models.Platform + on. A full list of valid operating system and architecture values are listed in + the Go language documentation for $GOOS and $GOARCH. + :vartype platform: ~azure.containerregistry._generated.models.Platform """ - _attribute_map = { - "media_type": {"key": "mediaType", "type": "str"}, - "size": {"key": "size", "type": "int"}, - "digest": {"key": "digest", "type": "str"}, - "platform": {"key": "platform", "type": "Platform"}, - } - + media_type: Optional[str] = rest_field(name="mediaType", visibility=["read", "create", "update", "delete", "query"]) + """The MIME type of the referenced object. This will generally be + application/vnd.docker.image.manifest.v2+json, but it could also be + application/vnd.docker.image.manifest.v1+json.""" + size: Optional[int] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The size in bytes of the object.""" + digest: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The digest of the content, as defined by the Registry V2 HTTP API Specification.""" + platform: Optional["_models.Platform"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The platform object describes the platform which the image in the manifest runs + on. A full list of valid operating system and architecture values are listed in + the Go language documentation for $GOOS and $GOARCH.""" + + @overload def __init__( self, *, @@ -872,31 +833,20 @@ def __init__( size: Optional[int] = None, digest: Optional[str] = None, platform: Optional["_models.Platform"] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword media_type: The MIME type of the referenced object. This will generally be - application/vnd.docker.image.manifest.v2+json, but it could also be - application/vnd.docker.image.manifest.v1+json. - :paramtype media_type: str - :keyword size: The size in bytes of the object. - :paramtype size: int - :keyword digest: The digest of the content, as defined by the Registry V2 HTTP API - Specification. - :paramtype digest: str - :keyword platform: The platform object describes the platform which the image in the manifest - runs on. A full list of valid operating system and architecture values are listed in the Go - language documentation for $GOOS and $GOARCH. - :paramtype platform: ~container_registry.models.Platform + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.media_type = media_type - self.size = size - self.digest = digest - self.platform = platform + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class ManifestWrapper(Manifest): # pylint: disable=too-many-instance-attributes + +class ManifestWrapper(Manifest): """Returns the requested manifest file. :ivar schema_version: Schema version. @@ -904,13 +854,13 @@ class ManifestWrapper(Manifest): # pylint: disable=too-many-instance-attributes :ivar media_type: Media type for this Manifest. :vartype media_type: str :ivar manifests: (ManifestList, OCIIndex) List of V2 image layer information. - :vartype manifests: list[~container_registry.models.ManifestListAttributes] + :vartype manifests: list[~azure.containerregistry._generated.models.ManifestListAttributes] :ivar config: (V2, OCI) Image config descriptor. - :vartype config: ~container_registry.models.Descriptor + :vartype config: ~azure.containerregistry._generated.models.Descriptor :ivar layers: (V2, OCI) List of V2 image layer information. - :vartype layers: list[~container_registry.models.Descriptor] + :vartype layers: list[~azure.containerregistry._generated.models.Descriptor] :ivar annotations: (OCI, OCIIndex) Additional metadata. - :vartype annotations: ~container_registry.models.Annotations + :vartype annotations: ~azure.containerregistry._generated.models.Annotations :ivar architecture: (V1) CPU architecture. :vartype architecture: str :ivar name: (V1) Image name. @@ -918,86 +868,76 @@ class ManifestWrapper(Manifest): # pylint: disable=too-many-instance-attributes :ivar tag: (V1) Image tag. :vartype tag: str :ivar fs_layers: (V1) List of layer information. - :vartype fs_layers: list[~container_registry.models.FsLayer] + :vartype fs_layers: list[~azure.containerregistry._generated.models.FsLayer] :ivar history: (V1) Image history. - :vartype history: list[~container_registry.models.History] + :vartype history: list[~azure.containerregistry._generated.models.History] :ivar signatures: (V1) Image signature. - :vartype signatures: list[~container_registry.models.ImageSignature] + :vartype signatures: list[~azure.containerregistry._generated.models.ImageSignature] """ - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "media_type": {"key": "mediaType", "type": "str"}, - "manifests": {"key": "manifests", "type": "[ManifestListAttributes]"}, - "config": {"key": "config", "type": "Descriptor"}, - "layers": {"key": "layers", "type": "[Descriptor]"}, - "annotations": {"key": "annotations", "type": "Annotations"}, - "architecture": {"key": "architecture", "type": "str"}, - "name": {"key": "name", "type": "str"}, - "tag": {"key": "tag", "type": "str"}, - "fs_layers": {"key": "fsLayers", "type": "[FsLayer]"}, - "history": {"key": "history", "type": "[History]"}, - "signatures": {"key": "signatures", "type": "[ImageSignature]"}, - } - + media_type: Optional[str] = rest_field(name="mediaType", visibility=["read", "create", "update", "delete", "query"]) + """Media type for this Manifest.""" + manifests: Optional[list["_models.ManifestListAttributes"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """(ManifestList, OCIIndex) List of V2 image layer information.""" + config: Optional["_models.Descriptor"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(V2, OCI) Image config descriptor.""" + layers: Optional[list["_models.Descriptor"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """(V2, OCI) List of V2 image layer information.""" + annotations: Optional["_models.Annotations"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """(OCI, OCIIndex) Additional metadata.""" + architecture: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(V1) CPU architecture.""" + name: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(V1) Image name.""" + tag: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(V1) Image tag.""" + fs_layers: Optional[list["_models.FsLayer"]] = rest_field( + name="fsLayers", visibility=["read", "create", "update", "delete", "query"] + ) + """(V1) List of layer information.""" + history: Optional[list["_models.History"]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """(V1) Image history.""" + signatures: Optional[list["_models.ImageSignature"]] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) + """(V1) Image signature.""" + + @overload def __init__( self, *, schema_version: Optional[int] = None, media_type: Optional[str] = None, - manifests: Optional[List["_models.ManifestListAttributes"]] = None, + manifests: Optional[list["_models.ManifestListAttributes"]] = None, config: Optional["_models.Descriptor"] = None, - layers: Optional[List["_models.Descriptor"]] = None, + layers: Optional[list["_models.Descriptor"]] = None, annotations: Optional["_models.Annotations"] = None, architecture: Optional[str] = None, name: Optional[str] = None, tag: Optional[str] = None, - fs_layers: Optional[List["_models.FsLayer"]] = None, - history: Optional[List["_models.History"]] = None, - signatures: Optional[List["_models.ImageSignature"]] = None, - **kwargs: Any - ) -> None: + fs_layers: Optional[list["_models.FsLayer"]] = None, + history: Optional[list["_models.History"]] = None, + signatures: Optional[list["_models.ImageSignature"]] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword media_type: Media type for this Manifest. - :paramtype media_type: str - :keyword manifests: (ManifestList, OCIIndex) List of V2 image layer information. - :paramtype manifests: list[~container_registry.models.ManifestListAttributes] - :keyword config: (V2, OCI) Image config descriptor. - :paramtype config: ~container_registry.models.Descriptor - :keyword layers: (V2, OCI) List of V2 image layer information. - :paramtype layers: list[~container_registry.models.Descriptor] - :keyword annotations: (OCI, OCIIndex) Additional metadata. - :paramtype annotations: ~container_registry.models.Annotations - :keyword architecture: (V1) CPU architecture. - :paramtype architecture: str - :keyword name: (V1) Image name. - :paramtype name: str - :keyword tag: (V1) Image tag. - :paramtype tag: str - :keyword fs_layers: (V1) List of layer information. - :paramtype fs_layers: list[~container_registry.models.FsLayer] - :keyword history: (V1) Image history. - :paramtype history: list[~container_registry.models.History] - :keyword signatures: (V1) Image signature. - :paramtype signatures: list[~container_registry.models.ImageSignature] + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(schema_version=schema_version, **kwargs) - self.media_type = media_type - self.manifests = manifests - self.config = config - self.layers = layers - self.annotations = annotations - self.architecture = architecture - self.name = name - self.tag = tag - self.fs_layers = fs_layers - self.history = history - self.signatures = signatures - - -class ManifestWriteableProperties(_serialization.Model): + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class ManifestWriteableProperties(_Model): """Changeable attributes. :ivar can_delete: Delete enabled. @@ -1010,13 +950,24 @@ class ManifestWriteableProperties(_serialization.Model): :vartype can_read: bool """ - _attribute_map = { - "can_delete": {"key": "deleteEnabled", "type": "bool"}, - "can_write": {"key": "writeEnabled", "type": "bool"}, - "can_list": {"key": "listEnabled", "type": "bool"}, - "can_read": {"key": "readEnabled", "type": "bool"}, - } - + can_delete: Optional[bool] = rest_field( + name="deleteEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Delete enabled.""" + can_write: Optional[bool] = rest_field( + name="writeEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Write enabled.""" + can_list: Optional[bool] = rest_field( + name="listEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """List enabled.""" + can_read: Optional[bool] = rest_field( + name="readEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Read enabled.""" + + @overload def __init__( self, *, @@ -1024,142 +975,63 @@ def __init__( can_write: Optional[bool] = None, can_list: Optional[bool] = None, can_read: Optional[bool] = None, - **kwargs: Any - ) -> None: - """ - :keyword can_delete: Delete enabled. - :paramtype can_delete: bool - :keyword can_write: Write enabled. - :paramtype can_write: bool - :keyword can_list: List enabled. - :paramtype can_list: bool - :keyword can_read: Read enabled. - :paramtype can_read: bool - """ - super().__init__(**kwargs) - self.can_delete = can_delete - self.can_write = can_write - self.can_list = can_list - self.can_read = can_read - + ) -> None: ... -class OCIIndex(Manifest): - """Returns the requested OCI index file. - - :ivar schema_version: Schema version. - :vartype schema_version: int - :ivar manifests: List of OCI image layer information. - :vartype manifests: list[~container_registry.models.ManifestListAttributes] - :ivar annotations: Additional information provided through arbitrary metadata. - :vartype annotations: ~container_registry.models.Annotations - """ - - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "manifests": {"key": "manifests", "type": "[ManifestListAttributes]"}, - "annotations": {"key": "annotations", "type": "Annotations"}, - } - - def __init__( - self, - *, - schema_version: Optional[int] = None, - manifests: Optional[List["_models.ManifestListAttributes"]] = None, - annotations: Optional["_models.Annotations"] = None, - **kwargs: Any - ) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword manifests: List of OCI image layer information. - :paramtype manifests: list[~container_registry.models.ManifestListAttributes] - :keyword annotations: Additional information provided through arbitrary metadata. - :paramtype annotations: ~container_registry.models.Annotations + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(schema_version=schema_version, **kwargs) - self.manifests = manifests - self.annotations = annotations - -class OCIManifest(Manifest): - """Returns the requested OCI Manifest file. + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - :ivar schema_version: Schema version. - :vartype schema_version: int - :ivar config: V2 image config descriptor. - :vartype config: ~container_registry.models.Descriptor - :ivar layers: List of V2 image layer information. - :vartype layers: list[~container_registry.models.Descriptor] - :ivar annotations: Additional information provided through arbitrary metadata. - :vartype annotations: ~container_registry.models.Annotations - """ - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "config": {"key": "config", "type": "Descriptor"}, - "layers": {"key": "layers", "type": "[Descriptor]"}, - "annotations": {"key": "annotations", "type": "Annotations"}, - } - - def __init__( - self, - *, - schema_version: Optional[int] = None, - config: Optional["_models.Descriptor"] = None, - layers: Optional[List["_models.Descriptor"]] = None, - annotations: Optional["_models.Annotations"] = None, - **kwargs: Any - ) -> None: - """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword config: V2 image config descriptor. - :paramtype config: ~container_registry.models.Descriptor - :keyword layers: List of V2 image layer information. - :paramtype layers: list[~container_registry.models.Descriptor] - :keyword annotations: Additional information provided through arbitrary metadata. - :paramtype annotations: ~container_registry.models.Annotations - """ - super().__init__(schema_version=schema_version, **kwargs) - self.config = config - self.layers = layers - self.annotations = annotations - - -class Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema(_serialization.Model): - """Paths108HwamOauth2ExchangePostRequestbodyContentApplicationXWwwFormUrlencodedSchema. - - All required parameters must be populated in order to send to Azure. +class MultipartBodyParameter(_Model): + """The multipart body parameter for AAD token exchange. :ivar grant_type: Can take a value of access_token_refresh_token, or access_token, or refresh_token. Required. Known values are: "access_token_refresh_token", "access_token", and "refresh_token". - :vartype grant_type: str or ~container_registry.models.PostContentSchemaGrantType + :vartype grant_type: str or + ~azure.containerregistry._generated.models.PostContentSchemaGrantType :ivar service: Indicates the name of your Azure container registry. Required. :vartype service: str :ivar tenant: AAD tenant associated to the AAD credentials. :vartype tenant: str :ivar refresh_token: AAD refresh token, mandatory when grant_type is access_token_refresh_token - or refresh_token. + or + refresh_token. :vartype refresh_token: str - :ivar aad_access_token: AAD access token, mandatory when grant_type is - access_token_refresh_token or access_token. - :vartype aad_access_token: str + :ivar access_token: AAD access token, mandatory when grant_type is access_token_refresh_token + or + access_token. + :vartype access_token: str """ - _validation = { - "grant_type": {"required": True}, - "service": {"required": True}, - } - - _attribute_map = { - "grant_type": {"key": "grant_type", "type": "str"}, - "service": {"key": "service", "type": "str"}, - "tenant": {"key": "tenant", "type": "str"}, - "refresh_token": {"key": "refresh_token", "type": "str"}, - "aad_access_token": {"key": "access_token", "type": "str"}, - } - + grant_type: Union[str, "_models.PostContentSchemaGrantType"] = rest_field( + name="grantType", visibility=["read", "create", "update", "delete", "query"] + ) + """Can take a value of access_token_refresh_token, or access_token, or + refresh_token. Required. Known values are: \"access_token_refresh_token\", \"access_token\", + and \"refresh_token\".""" + service: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Indicates the name of your Azure container registry. Required.""" + tenant: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """AAD tenant associated to the AAD credentials.""" + refresh_token: Optional[str] = rest_field( + name="refreshToken", visibility=["read", "create", "update", "delete", "query"] + ) + """AAD refresh token, mandatory when grant_type is access_token_refresh_token or + refresh_token.""" + access_token: Optional[str] = rest_field( + name="accessToken", visibility=["read", "create", "update", "delete", "query"] + ) + """AAD access token, mandatory when grant_type is access_token_refresh_token or + access_token.""" + + @overload def __init__( self, *, @@ -1167,98 +1039,24 @@ def __init__( service: str, tenant: Optional[str] = None, refresh_token: Optional[str] = None, - aad_access_token: Optional[str] = None, - **kwargs: Any - ) -> None: - """ - :keyword grant_type: Can take a value of access_token_refresh_token, or access_token, or - refresh_token. Required. Known values are: "access_token_refresh_token", "access_token", and - "refresh_token". - :paramtype grant_type: str or ~container_registry.models.PostContentSchemaGrantType - :keyword service: Indicates the name of your Azure container registry. Required. - :paramtype service: str - :keyword tenant: AAD tenant associated to the AAD credentials. - :paramtype tenant: str - :keyword refresh_token: AAD refresh token, mandatory when grant_type is - access_token_refresh_token or refresh_token. - :paramtype refresh_token: str - :keyword aad_access_token: AAD access token, mandatory when grant_type is - access_token_refresh_token or access_token. - :paramtype aad_access_token: str - """ - super().__init__(**kwargs) - self.grant_type = grant_type - self.service = service - self.tenant = tenant - self.refresh_token = refresh_token - self.aad_access_token = aad_access_token + access_token: Optional[str] = None, + ) -> None: ... - -class PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema(_serialization.Model): - """PathsV3R3RxOauth2TokenPostRequestbodyContentApplicationXWwwFormUrlencodedSchema. - - All required parameters must be populated in order to send to Azure. - - :ivar service: Indicates the name of your Azure container registry. Required. - :vartype service: str - :ivar scope: Which is expected to be a valid scope, and can be specified more than once for - multiple scope requests. You obtained this from the Www-Authenticate response header from the - challenge. Required. - :vartype scope: str - :ivar acr_refresh_token: Must be a valid ACR refresh token. Required. - :vartype acr_refresh_token: str - :ivar grant_type: Grant type is expected to be refresh_token. Known values are: "refresh_token" - and "password". - :vartype grant_type: str or ~container_registry.models.TokenGrantType - """ - - _validation = { - "service": {"required": True}, - "scope": {"required": True}, - "acr_refresh_token": {"required": True}, - "grant_type": {"required": True}, - } - - _attribute_map = { - "service": {"key": "service", "type": "str"}, - "scope": {"key": "scope", "type": "str"}, - "acr_refresh_token": {"key": "refresh_token", "type": "str"}, - "grant_type": {"key": "grant_type", "type": "str"}, - } - - def __init__( - self, - *, - service: str, - scope: str, - acr_refresh_token: str, - grant_type: Union[str, "_models.TokenGrantType"] = "refresh_token", - **kwargs: Any - ) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword service: Indicates the name of your Azure container registry. Required. - :paramtype service: str - :keyword scope: Which is expected to be a valid scope, and can be specified more than once for - multiple scope requests. You obtained this from the Www-Authenticate response header from the - challenge. Required. - :paramtype scope: str - :keyword acr_refresh_token: Must be a valid ACR refresh token. Required. - :paramtype acr_refresh_token: str - :keyword grant_type: Grant type is expected to be refresh_token. Known values are: - "refresh_token" and "password". - :paramtype grant_type: str or ~container_registry.models.TokenGrantType + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.service = service - self.scope = scope - self.acr_refresh_token = acr_refresh_token - self.grant_type = grant_type + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class Platform(_serialization.Model): - """The platform object describes the platform which the image in the manifest runs on. A full list - of valid operating system and architecture values are listed in the Go language documentation - for $GOOS and $GOARCH. +class Platform(_Model): + """The platform object describes the platform which the image in the manifest runs + on. A full list of valid operating system and architecture values are listed in + the Go language documentation for $GOOS and $GOARCH. :ivar architecture: Specifies the CPU architecture, for example amd64 or ppc64le. :vartype architecture: str @@ -1270,114 +1068,59 @@ class Platform(_serialization.Model): :ivar os_features: The optional os.features field specifies an array of strings, each listing a required OS feature (for example on Windows win32k. :vartype os_features: list[str] - :ivar variant: The optional variant field specifies a variant of the CPU, for example armv6l to - specify a particular CPU variant of the ARM CPU. + :ivar variant: The optional variant field specifies a variant of the CPU, for example armv6l + to specify a particular CPU variant of the ARM CPU. :vartype variant: str :ivar features: The optional features field specifies an array of strings, each listing a required CPU feature (for example sse4 or aes. :vartype features: list[str] """ - _attribute_map = { - "architecture": {"key": "architecture", "type": "str"}, - "os": {"key": "os", "type": "str"}, - "os_version": {"key": "os\\.version", "type": "str"}, - "os_features": {"key": "os\\.features", "type": "[str]"}, - "variant": {"key": "variant", "type": "str"}, - "features": {"key": "features", "type": "[str]"}, - } - + architecture: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies the CPU architecture, for example amd64 or ppc64le.""" + os: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The os field specifies the operating system, for example linux or windows.""" + os_version: Optional[str] = rest_field( + name="os.version", visibility=["read", "create", "update", "delete", "query"] + ) + """The optional os.version field specifies the operating system version, for + example 10.0.10586.""" + os_features: Optional[list[str]] = rest_field( + name="os.features", visibility=["read", "create", "update", "delete", "query"] + ) + """The optional os.features field specifies an array of strings, each listing a + required OS feature (for example on Windows win32k.""" + variant: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The optional variant field specifies a variant of the CPU, for example armv6l + to specify a particular CPU variant of the ARM CPU.""" + features: Optional[list[str]] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """The optional features field specifies an array of strings, each listing a + required CPU feature (for example sse4 or aes.""" + + @overload def __init__( self, *, architecture: Optional[str] = None, os: Optional[str] = None, os_version: Optional[str] = None, - os_features: Optional[List[str]] = None, + os_features: Optional[list[str]] = None, variant: Optional[str] = None, - features: Optional[List[str]] = None, - **kwargs: Any - ) -> None: - """ - :keyword architecture: Specifies the CPU architecture, for example amd64 or ppc64le. - :paramtype architecture: str - :keyword os: The os field specifies the operating system, for example linux or windows. - :paramtype os: str - :keyword os_version: The optional os.version field specifies the operating system version, for - example 10.0.10586. - :paramtype os_version: str - :keyword os_features: The optional os.features field specifies an array of strings, each - listing a required OS feature (for example on Windows win32k. - :paramtype os_features: list[str] - :keyword variant: The optional variant field specifies a variant of the CPU, for example armv6l - to specify a particular CPU variant of the ARM CPU. - :paramtype variant: str - :keyword features: The optional features field specifies an array of strings, each listing a - required CPU feature (for example sse4 or aes. - :paramtype features: list[str] - """ - super().__init__(**kwargs) - self.architecture = architecture - self.os = os - self.os_version = os_version - self.os_features = os_features - self.variant = variant - self.features = features - - -class Repositories(_serialization.Model): - """List of repositories. - - :ivar repositories: Repository names. - :vartype repositories: list[str] - :ivar link: - :vartype link: str - """ - - _attribute_map = { - "repositories": {"key": "repositories", "type": "[str]"}, - "link": {"key": "link", "type": "str"}, - } + features: Optional[list[str]] = None, + ) -> None: ... - def __init__(self, *, repositories: Optional[List[str]] = None, link: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword repositories: Repository names. - :paramtype repositories: list[str] - :keyword link: - :paramtype link: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.repositories = repositories - self.link = link - - -class RepositoryTags(_serialization.Model): - """Result of the request to list tags of the image. - - :ivar name: Name of the image. - :vartype name: str - :ivar tags: List of tags. - :vartype tags: list[str] - """ - _attribute_map = { - "name": {"key": "name", "type": "str"}, - "tags": {"key": "tags", "type": "[str]"}, - } + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - def __init__(self, *, name: Optional[str] = None, tags: Optional[List[str]] = None, **kwargs: Any) -> None: - """ - :keyword name: Name of the image. - :paramtype name: str - :keyword tags: List of tags. - :paramtype tags: list[str] - """ - super().__init__(**kwargs) - self.name = name - self.tags = tags - -class RepositoryWriteableProperties(_serialization.Model): +class RepositoryWriteableProperties(_Model): """Changeable attributes for Repository. :ivar can_delete: Delete enabled. @@ -1390,13 +1133,24 @@ class RepositoryWriteableProperties(_serialization.Model): :vartype can_read: bool """ - _attribute_map = { - "can_delete": {"key": "deleteEnabled", "type": "bool"}, - "can_write": {"key": "writeEnabled", "type": "bool"}, - "can_list": {"key": "listEnabled", "type": "bool"}, - "can_read": {"key": "readEnabled", "type": "bool"}, - } - + can_delete: Optional[bool] = rest_field( + name="deleteEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Delete enabled.""" + can_write: Optional[bool] = rest_field( + name="writeEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Write enabled.""" + can_list: Optional[bool] = rest_field( + name="listEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """List enabled.""" + can_read: Optional[bool] = rest_field( + name="readEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Read enabled.""" + + @overload def __init__( self, *, @@ -1404,31 +1158,21 @@ def __init__( can_write: Optional[bool] = None, can_list: Optional[bool] = None, can_read: Optional[bool] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword can_delete: Delete enabled. - :paramtype can_delete: bool - :keyword can_write: Write enabled. - :paramtype can_write: bool - :keyword can_list: List enabled. - :paramtype can_list: bool - :keyword can_read: Read enabled. - :paramtype can_read: bool + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.can_delete = can_delete - self.can_write = can_write - self.can_list = can_list - self.can_read = can_read - -class TagAttributesBase(_serialization.Model): - """Tag attribute details. + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) - Variables are only populated by the server, and will be ignored when sending a request. - All required parameters must be populated in order to send to Azure. +class TagAttributesBase(_Model): + """Tag attribute details. :ivar name: Tag name. Required. :vartype name: str @@ -1438,63 +1182,49 @@ class TagAttributesBase(_serialization.Model): :vartype created_on: ~datetime.datetime :ivar last_updated_on: Tag last update time. Required. :vartype last_updated_on: ~datetime.datetime + :ivar signed: Is signed. + :vartype signed: bool :ivar changeable_attributes: Writeable properties of the resource. Required. - :vartype changeable_attributes: ~container_registry.models.TagWriteableProperties + :vartype changeable_attributes: + ~azure.containerregistry._generated.models.TagWriteableProperties """ - _validation = { - "name": {"required": True, "readonly": True}, - "digest": {"required": True, "readonly": True}, - "created_on": {"required": True, "readonly": True}, - "last_updated_on": {"required": True, "readonly": True}, - "changeable_attributes": {"required": True}, - } - - _attribute_map = { - "name": {"key": "name", "type": "str"}, - "digest": {"key": "digest", "type": "str"}, - "created_on": {"key": "createdTime", "type": "iso-8601"}, - "last_updated_on": {"key": "lastUpdateTime", "type": "iso-8601"}, - "changeable_attributes": {"key": "changeableAttributes", "type": "TagWriteableProperties"}, - } - - def __init__(self, *, changeable_attributes: "_models.TagWriteableProperties", **kwargs: Any) -> None: - """ - :keyword changeable_attributes: Writeable properties of the resource. Required. - :paramtype changeable_attributes: ~container_registry.models.TagWriteableProperties - """ - super().__init__(**kwargs) - self.name = None - self.digest = None - self.created_on = None - self.last_updated_on = None - self.changeable_attributes = changeable_attributes - - -class TagAttributesTag(_serialization.Model): - """Tag. - - :ivar signature_record: SignatureRecord value. - :vartype signature_record: str - """ - - _attribute_map = { - "signature_record": {"key": "signatureRecord", "type": "str"}, - } + name: str = rest_field(visibility=["read"]) + """Tag name. Required.""" + digest: str = rest_field(visibility=["read"]) + """Tag digest. Required.""" + created_on: datetime.datetime = rest_field(name="createdTime", visibility=["read"], format="rfc3339") + """Tag created time. Required.""" + last_updated_on: datetime.datetime = rest_field(name="lastUpdateTime", visibility=["read"], format="rfc3339") + """Tag last update time. Required.""" + signed: Optional[bool] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Is signed.""" + changeable_attributes: "_models.TagWriteableProperties" = rest_field( + name="changeableAttributes", visibility=["read", "create", "update", "delete", "query"] + ) + """Writeable properties of the resource. Required.""" + + @overload + def __init__( + self, + *, + changeable_attributes: "_models.TagWriteableProperties", + signed: Optional[bool] = None, + ) -> None: ... - def __init__(self, *, signature_record: Optional[str] = None, **kwargs: Any) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword signature_record: SignatureRecord value. - :paramtype signature_record: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.signature_record = signature_record + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class TagList(_serialization.Model): - """List of tag details. - All required parameters must be populated in order to send to Azure. +class TagList(_Model): + """List of tag details. :ivar registry_login_server: Registry login server name. This is likely to be similar to {registry-name}.azurecr.io. Required. @@ -1502,52 +1232,46 @@ class TagList(_serialization.Model): :ivar repository: Image name. Required. :vartype repository: str :ivar tag_attribute_bases: List of tag attribute details. Required. - :vartype tag_attribute_bases: list[~container_registry.models.TagAttributesBase] - :ivar link: + :vartype tag_attribute_bases: + list[~azure.containerregistry._generated.models.TagAttributesBase] + :ivar link: Link to the next page of results. :vartype link: str """ - _validation = { - "registry_login_server": {"required": True}, - "repository": {"required": True}, - "tag_attribute_bases": {"required": True}, - } - - _attribute_map = { - "registry_login_server": {"key": "registry", "type": "str"}, - "repository": {"key": "imageName", "type": "str"}, - "tag_attribute_bases": {"key": "tags", "type": "[TagAttributesBase]"}, - "link": {"key": "link", "type": "str"}, - } - + registry_login_server: str = rest_field(name="registry", visibility=["read", "create", "update", "delete", "query"]) + """Registry login server name. This is likely to be similar to + {registry-name}.azurecr.io. Required.""" + repository: str = rest_field(name="imageName", visibility=["read", "create", "update", "delete", "query"]) + """Image name. Required.""" + tag_attribute_bases: list["_models.TagAttributesBase"] = rest_field( + name="tags", visibility=["read", "create", "update", "delete", "query"] + ) + """List of tag attribute details. Required.""" + link: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Link to the next page of results.""" + + @overload def __init__( self, *, registry_login_server: str, repository: str, - tag_attribute_bases: List["_models.TagAttributesBase"], + tag_attribute_bases: list["_models.TagAttributesBase"], link: Optional[str] = None, - **kwargs: Any - ) -> None: + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword registry_login_server: Registry login server name. This is likely to be similar to - {registry-name}.azurecr.io. Required. - :paramtype registry_login_server: str - :keyword repository: Image name. Required. - :paramtype repository: str - :keyword tag_attribute_bases: List of tag attribute details. Required. - :paramtype tag_attribute_bases: list[~container_registry.models.TagAttributesBase] - :keyword link: - :paramtype link: str + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(**kwargs) - self.registry_login_server = registry_login_server - self.repository = repository - self.tag_attribute_bases = tag_attribute_bases - self.link = link + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) -class TagWriteableProperties(_serialization.Model): +class TagWriteableProperties(_Model): """Changeable attributes. :ivar can_delete: Delete enabled. @@ -1560,13 +1284,24 @@ class TagWriteableProperties(_serialization.Model): :vartype can_read: bool """ - _attribute_map = { - "can_delete": {"key": "deleteEnabled", "type": "bool"}, - "can_write": {"key": "writeEnabled", "type": "bool"}, - "can_list": {"key": "listEnabled", "type": "bool"}, - "can_read": {"key": "readEnabled", "type": "bool"}, - } - + can_delete: Optional[bool] = rest_field( + name="deleteEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Delete enabled.""" + can_write: Optional[bool] = rest_field( + name="writeEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Write enabled.""" + can_list: Optional[bool] = rest_field( + name="listEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """List enabled.""" + can_read: Optional[bool] = rest_field( + name="readEnabled", visibility=["read", "create", "update", "delete", "query"] + ) + """Read enabled.""" + + @overload def __init__( self, *, @@ -1574,131 +1309,14 @@ def __init__( can_write: Optional[bool] = None, can_list: Optional[bool] = None, can_read: Optional[bool] = None, - **kwargs: Any - ) -> None: - """ - :keyword can_delete: Delete enabled. - :paramtype can_delete: bool - :keyword can_write: Write enabled. - :paramtype can_write: bool - :keyword can_list: List enabled. - :paramtype can_list: bool - :keyword can_read: Read enabled. - :paramtype can_read: bool - """ - super().__init__(**kwargs) - self.can_delete = can_delete - self.can_write = can_write - self.can_list = can_list - self.can_read = can_read - + ) -> None: ... -class V1Manifest(Manifest): - """Returns the requested V1 manifest file. - - :ivar schema_version: Schema version. - :vartype schema_version: int - :ivar architecture: CPU architecture. - :vartype architecture: str - :ivar name: Image name. - :vartype name: str - :ivar tag: Image tag. - :vartype tag: str - :ivar fs_layers: List of layer information. - :vartype fs_layers: list[~container_registry.models.FsLayer] - :ivar history: Image history. - :vartype history: list[~container_registry.models.History] - :ivar signatures: Image signature. - :vartype signatures: list[~container_registry.models.ImageSignature] - """ - - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "architecture": {"key": "architecture", "type": "str"}, - "name": {"key": "name", "type": "str"}, - "tag": {"key": "tag", "type": "str"}, - "fs_layers": {"key": "fsLayers", "type": "[FsLayer]"}, - "history": {"key": "history", "type": "[History]"}, - "signatures": {"key": "signatures", "type": "[ImageSignature]"}, - } - - def __init__( - self, - *, - schema_version: Optional[int] = None, - architecture: Optional[str] = None, - name: Optional[str] = None, - tag: Optional[str] = None, - fs_layers: Optional[List["_models.FsLayer"]] = None, - history: Optional[List["_models.History"]] = None, - signatures: Optional[List["_models.ImageSignature"]] = None, - **kwargs: Any - ) -> None: + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword architecture: CPU architecture. - :paramtype architecture: str - :keyword name: Image name. - :paramtype name: str - :keyword tag: Image tag. - :paramtype tag: str - :keyword fs_layers: List of layer information. - :paramtype fs_layers: list[~container_registry.models.FsLayer] - :keyword history: Image history. - :paramtype history: list[~container_registry.models.History] - :keyword signatures: Image signature. - :paramtype signatures: list[~container_registry.models.ImageSignature] + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] """ - super().__init__(schema_version=schema_version, **kwargs) - self.architecture = architecture - self.name = name - self.tag = tag - self.fs_layers = fs_layers - self.history = history - self.signatures = signatures - - -class V2Manifest(Manifest): - """Returns the requested Docker V2 Manifest file. - :ivar schema_version: Schema version. - :vartype schema_version: int - :ivar media_type: Media type for this Manifest. - :vartype media_type: str - :ivar config: V2 image config descriptor. - :vartype config: ~container_registry.models.Descriptor - :ivar layers: List of V2 image layer information. - :vartype layers: list[~container_registry.models.Descriptor] - """ - - _attribute_map = { - "schema_version": {"key": "schemaVersion", "type": "int"}, - "media_type": {"key": "mediaType", "type": "str"}, - "config": {"key": "config", "type": "Descriptor"}, - "layers": {"key": "layers", "type": "[Descriptor]"}, - } - - def __init__( - self, - *, - schema_version: Optional[int] = None, - media_type: Optional[str] = None, - config: Optional["_models.Descriptor"] = None, - layers: Optional[List["_models.Descriptor"]] = None, - **kwargs: Any - ) -> None: - """ - :keyword schema_version: Schema version. - :paramtype schema_version: int - :keyword media_type: Media type for this Manifest. - :paramtype media_type: str - :keyword config: V2 image config descriptor. - :paramtype config: ~container_registry.models.Descriptor - :keyword layers: List of V2 image layer information. - :paramtype layers: list[~container_registry.models.Descriptor] - """ - super().__init__(schema_version=schema_version, **kwargs) - self.media_type = media_type - self.config = config - self.layers = layers + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_patch.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_patch.py index 029b47fe4787..87676c65a8f0 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_patch.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/models/_patch.py @@ -1,17 +1,15 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ -from typing import TYPE_CHECKING -if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports - from typing import List -__all__ = [] # type: List[str] # Add all objects you want publicly available to users at this package level + +__all__: list[str] = [] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/__init__.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/__init__.py index bcf2637fb304..461f85a3cebf 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/__init__.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/__init__.py @@ -1,15 +1,23 @@ # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._operations import ContainerRegistryOperations -from ._operations import ContainerRegistryBlobOperations -from ._operations import AuthenticationOperations +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._operations import ContainerRegistryOperations # type: ignore +from ._operations import ContainerRegistryBlobOperations # type: ignore +from ._operations import AuthenticationOperations # type: ignore from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ @@ -17,5 +25,5 @@ "ContainerRegistryBlobOperations", "AuthenticationOperations", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_operations.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_operations.py index b15ebfa53cb0..7304d6455938 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_operations.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_operations.py @@ -1,19 +1,26 @@ # pylint: disable=too-many-lines # coding=utf-8 # -------------------------------------------------------------------------- -# Code generated by Microsoft (R) AutoRest Code Generator (autorest: 3.9.7, generator: @autorest/python@6.7.8) +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +from collections.abc import MutableMapping from io import IOBase -from typing import Any, Callable, Dict, IO, Iterable, Iterator, Optional, TypeVar, Union, overload +import json +from typing import Any, Callable, IO, Iterator, Optional, TypeVar, Union, overload import urllib.parse +from azure.core import PipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.paging import ItemPaged @@ -23,11 +30,14 @@ from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._serialization import Serializer -from .._vendor import raise_if_not_implemented +from .._configuration import ContainerRegistryConfiguration +from .._utils.model_base import Model as _Model, SdkJSONEncoder, _deserialize +from .._utils.serialization import Deserializer, Serializer +from .._utils.utils import prepare_multipart_form_data +JSON = MutableMapping[str, Any] T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] _SERIALIZER = Serializer() _SERIALIZER.client_side_validation = False @@ -36,24 +46,25 @@ def build_container_registry_check_docker_v2_support_request( # pylint: disable=name-too-long **kwargs: Any, ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/" - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, **kwargs) def build_container_registry_get_manifest_request( # pylint: disable=name-too-long name: str, reference: str, *, accept: Optional[str] = None, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/manifests/{reference}" path_format_arguments = { @@ -63,21 +74,24 @@ def build_container_registry_get_manifest_request( # pylint: disable=name-too-l _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + # Construct headers if accept is not None: _headers["accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_create_manifest_request( # pylint: disable=name-too-long - name: str, reference: str, *, content: IO, **kwargs: Any + name: str, reference: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - accept = _headers.pop("Accept", "application/json") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/manifests/{reference}" path_format_arguments = { @@ -87,21 +101,22 @@ def build_container_registry_create_manifest_request( # pylint: disable=name-to _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + # Construct headers if content_type is not None: _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="PUT", url=_url, headers=_headers, content=content, **kwargs) + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_delete_manifest_request( # pylint: disable=name-too-long name: str, reference: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/manifests/{reference}" path_format_arguments = { @@ -111,10 +126,10 @@ def build_container_registry_delete_manifest_request( # pylint: disable=name-to _url: str = _url.format(**path_format_arguments) # type: ignore - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) def build_container_registry_get_repositories_request( # pylint: disable=name-too-long @@ -130,11 +145,11 @@ def build_container_registry_get_repositories_request( # pylint: disable=name-t _url = "/acr/v1/_catalog" # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") if last is not None: _params["last"] = _SERIALIZER.query("last", last, "str") if n is not None: _params["n"] = _SERIALIZER.query("n", n, "int") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") @@ -228,7 +243,7 @@ def build_container_registry_get_tags_request( # pylint: disable=name-too-long *, last: Optional[str] = None, n: Optional[int] = None, - orderby: Optional[str] = None, + orderby: Optional[Union[str, _models.ArtifactTagOrder]] = None, digest: Optional[str] = None, **kwargs: Any, ) -> HttpRequest: @@ -247,6 +262,7 @@ def build_container_registry_get_tags_request( # pylint: disable=name-too-long _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") if last is not None: _params["last"] = _SERIALIZER.query("last", last, "str") if n is not None: @@ -255,7 +271,6 @@ def build_container_registry_get_tags_request( # pylint: disable=name-too-long _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") if digest is not None: _params["digest"] = _SERIALIZER.query("digest", digest, "str") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") @@ -323,12 +338,9 @@ def build_container_registry_update_tag_attributes_request( # pylint: disable=n def build_container_registry_delete_tag_request( # pylint: disable=name-too-long name: str, reference: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) - accept = _headers.pop("Accept", "application/json") - # Construct URL _url = "/acr/v1/{name}/_tags/{reference}" path_format_arguments = { @@ -341,14 +353,16 @@ def build_container_registry_delete_tag_request( # pylint: disable=name-too-lon # Construct parameters _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - - return HttpRequest(method="DELETE", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) def build_container_registry_get_manifests_request( # pylint: disable=name-too-long - name: str, *, last: Optional[str] = None, n: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any + name: str, + *, + last: Optional[str] = None, + n: Optional[int] = None, + orderby: Optional[Union[str, _models.ArtifactManifestOrder]] = None, + **kwargs: Any, ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) @@ -365,13 +379,13 @@ def build_container_registry_get_manifests_request( # pylint: disable=name-too- _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") if last is not None: _params["last"] = _SERIALIZER.query("last", last, "str") if n is not None: _params["n"] = _SERIALIZER.query("n", n, "int") if orderby is not None: _params["orderby"] = _SERIALIZER.query("orderby", orderby, "str") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") @@ -440,7 +454,9 @@ def build_container_registry_blob_get_blob_request( # pylint: disable=name-too- name: str, digest: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) accept = _headers.pop("Accept", "application/octet-stream") # Construct URL @@ -452,19 +468,21 @@ def build_container_registry_blob_get_blob_request( # pylint: disable=name-too- _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + # Construct headers _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_blob_check_blob_exists_request( # pylint: disable=name-too-long name: str, digest: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/{digest}" path_format_arguments = { @@ -474,15 +492,18 @@ def build_container_registry_blob_check_blob_exists_request( # pylint: disable= _url: str = _url.format(**path_format_arguments) # type: ignore - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="HEAD", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="HEAD", url=_url, params=_params, **kwargs) def build_container_registry_blob_delete_blob_request( # pylint: disable=name-too-long name: str, digest: str, **kwargs: Any ) -> HttpRequest: + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/{digest}" path_format_arguments = { @@ -492,17 +513,18 @@ def build_container_registry_blob_delete_blob_request( # pylint: disable=name-t _url: str = _url.format(**path_format_arguments) # type: ignore - return HttpRequest(method="DELETE", url=_url, **kwargs) + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) def build_container_registry_blob_mount_blob_request( # pylint: disable=name-too-long name: str, *, from_parameter: str, mount: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - accept = _headers.pop("Accept", "application/json") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/uploads/" path_format_arguments = { @@ -512,116 +534,111 @@ def build_container_registry_blob_mount_blob_request( # pylint: disable=name-to _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") _params["from"] = _SERIALIZER.query("from_parameter", from_parameter, "str") _params["mount"] = _SERIALIZER.query("mount", mount, "str") - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) + return HttpRequest(method="POST", url=_url, params=_params, **kwargs) def build_container_registry_blob_get_upload_status_request( # pylint: disable=name-too-long - next_link: str, **kwargs: Any + next_blob_uuid_link: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/{nextBlobUuidLink}" path_format_arguments = { - "nextBlobUuidLink": _SERIALIZER.url("next_link", next_link, "str", skip_quote=True), + "nextBlobUuidLink": _SERIALIZER.url("next_blob_uuid_link", next_blob_uuid_link, "str", skip_quote=True), } _url: str = _url.format(**path_format_arguments) # type: ignore - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, **kwargs) def build_container_registry_blob_upload_chunk_request( # pylint: disable=name-too-long - next_link: str, *, content: IO, **kwargs: Any + next_blob_uuid_link: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - accept = _headers.pop("Accept", "application/json") - + content_type: str = kwargs.pop("content_type") + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/{nextBlobUuidLink}" path_format_arguments = { - "nextBlobUuidLink": _SERIALIZER.url("next_link", next_link, "str", skip_quote=True), + "nextBlobUuidLink": _SERIALIZER.url("next_blob_uuid_link", next_blob_uuid_link, "str", skip_quote=True), } _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + # Construct headers - if content_type is not None: - _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - return HttpRequest(method="PATCH", url=_url, headers=_headers, content=content, **kwargs) + return HttpRequest(method="PATCH", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_blob_complete_upload_request( # pylint: disable=name-too-long - next_link: str, *, digest: str, content: Optional[IO] = None, **kwargs: Any + next_blob_uuid_link: str, *, digest: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - accept = _headers.pop("Accept", "application/json") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/{nextBlobUuidLink}" path_format_arguments = { - "nextBlobUuidLink": _SERIALIZER.url("next_link", next_link, "str", skip_quote=True), + "nextBlobUuidLink": _SERIALIZER.url("next_blob_uuid_link", next_blob_uuid_link, "str", skip_quote=True), } _url: str = _url.format(**path_format_arguments) # type: ignore # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") _params["digest"] = _SERIALIZER.query("digest", digest, "str") # Construct headers if content_type is not None: _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, content=content, **kwargs) + return HttpRequest(method="PUT", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_blob_cancel_upload_request( # pylint: disable=name-too-long - next_link: str, **kwargs: Any + next_blob_uuid_link: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/{nextBlobUuidLink}" path_format_arguments = { - "nextBlobUuidLink": _SERIALIZER.url("next_link", next_link, "str", skip_quote=True), + "nextBlobUuidLink": _SERIALIZER.url("next_blob_uuid_link", next_blob_uuid_link, "str", skip_quote=True), } _url: str = _url.format(**path_format_arguments) # type: ignore - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="DELETE", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="DELETE", url=_url, params=_params, **kwargs) def build_container_registry_blob_start_upload_request( # pylint: disable=name-too-long name: str, **kwargs: Any ) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - - accept = _headers.pop("Accept", "application/json") + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/uploads/" path_format_arguments = { @@ -630,19 +647,19 @@ def build_container_registry_blob_start_upload_request( # pylint: disable=name- _url: str = _url.format(**path_format_arguments) # type: ignore - # Construct headers - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="POST", url=_url, params=_params, **kwargs) def build_container_registry_blob_get_chunk_request( # pylint: disable=name-too-long - name: str, digest: str, *, range_header: str, **kwargs: Any + name: str, digest: str, *, range: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - accept = _headers.pop("Accept", "application/octet-stream") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/{digest}" path_format_arguments = { @@ -652,20 +669,22 @@ def build_container_registry_blob_get_chunk_request( # pylint: disable=name-too _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + # Construct headers - _headers["Range"] = _SERIALIZER.header("range_header", range_header, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + _headers["range"] = _SERIALIZER.header("range", range, "str") - return HttpRequest(method="GET", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) def build_container_registry_blob_check_chunk_exists_request( # pylint: disable=name-too-long - name: str, digest: str, *, range_header: str, **kwargs: Any + name: str, digest: str, *, range: str, **kwargs: Any ) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - accept = _headers.pop("Accept", "application/json") - + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # Construct URL _url = "/v2/{name}/blobs/{digest}" path_format_arguments = { @@ -675,11 +694,68 @@ def build_container_registry_blob_check_chunk_exists_request( # pylint: disable _url: str = _url.format(**path_format_arguments) # type: ignore + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + + # Construct headers + _headers["range"] = _SERIALIZER.header("range", range, "str") + + return HttpRequest(method="HEAD", url=_url, params=_params, headers=_headers, **kwargs) + + +def build_authentication_exchange_aad_access_token_for_acr_refresh_token_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/oauth2/exchange" + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_authentication_exchange_acr_refresh_token_for_acr_access_token_request( # pylint: disable=name-too-long + **kwargs: Any, +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/oauth2/token" + # Construct headers - _headers["Range"] = _SERIALIZER.header("range_header", range_header, "str") _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest(method="HEAD", url=_url, headers=_headers, **kwargs) + return HttpRequest(method="POST", url=_url, headers=_headers, **kwargs) + + +def build_authentication_get_acr_access_token_from_login_request( # pylint: disable=name-too-long + *, service: str, scope: str, **kwargs: Any +) -> HttpRequest: + _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) + _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) + + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) + accept = _headers.pop("Accept", "application/json") + + # Construct URL + _url = "/oauth2/token" + + # Construct parameters + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") + _params["service"] = _SERIALIZER.query("service", service, "str") + _params["scope"] = _SERIALIZER.query("scope", scope, "str") + + # Construct headers + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) class ContainerRegistryOperations: @@ -688,18 +764,16 @@ class ContainerRegistryOperations: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.ContainerRegistry`'s :attr:`container_registry` attribute. """ - models = _models - - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace def check_docker_v2_support(self, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements @@ -709,7 +783,7 @@ def check_docker_v2_support(self, **kwargs: Any) -> None: # pylint: disable=inc :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -722,38 +796,36 @@ def check_docker_v2_support(self, **kwargs: Any) -> None: # pylint: disable=inc cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_check_docker_v2_support_request( + _request = build_container_registry_check_docker_v2_support_request( + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket + if response.status_code not in [204]: map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace def get_manifest( self, name: str, reference: str, *, accept: Optional[str] = None, **kwargs: Any - ) -> Iterator[bytes]: - """Get the manifest identified by ``name`` and ``reference`` where ``reference`` can be a tag or - digest. + ) -> _models.ManifestWrapper: + """Get the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. :param name: Name of the image (including the namespace). Required. :type name: str @@ -762,11 +834,11 @@ def get_manifest( :keyword accept: Accept header string delimited by comma. For example, application/vnd.docker.distribution.manifest.v2+json. Default value is None. :paramtype accept: str - :return: Iterator of the response bytes - :rtype: Iterator[bytes] + :return: ManifestWrapper. The ManifestWrapper is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ManifestWrapper :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -777,57 +849,135 @@ def get_manifest( _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + cls: ClsType[_models.ManifestWrapper] = kwargs.pop("cls", None) - request = build_container_registry_get_manifest_request( + _request = build_container_registry_get_manifest_request( name=name, reference=reference, accept=accept, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = response.iter_bytes() + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ManifestWrapper, response.json()) if cls: return cls(pipeline_response, deserialized, {}) # type: ignore return deserialized # type: ignore - @distributed_trace - def create_manifest(self, name: str, reference: str, payload: IO, **kwargs: Any) -> Any: - """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be a tag or - digest. + @overload + def create_manifest( + self, + name: str, + reference: str, + payload: _models.Manifest, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. :param name: Name of the image (including the namespace). Required. :type name: str :param reference: A tag or a digest, pointing to a specific image. Required. :type reference: str :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. - :type payload: IO - :return: any - :rtype: any + :type payload: ~azure.containerregistry._generated.models.Manifest + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + + @overload + def create_manifest( + self, name: str, reference: str, payload: JSON, *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. + :type payload: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def create_manifest( + self, name: str, reference: str, payload: IO[bytes], *, content_type: str = "application/json", **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Required. + :type payload: IO[bytes] + :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + Default value is "application/json". + :paramtype content_type: str + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def create_manifest( # pylint: disable=inconsistent-return-statements + self, name: str, reference: str, payload: Union[_models.Manifest, JSON, IO[bytes]], **kwargs: Any + ) -> None: + """Put the manifest identified by ``name`` and ``reference`` where ``reference`` can be + a tag or digest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: A tag or a digest, pointing to a specific image. Required. + :type reference: str + :param payload: Manifest body, can take v1 or v2 values depending on accept header. Is one of + the following types: Manifest, JSON, IO[bytes] Required. + :type payload: ~azure.containerregistry._generated.models.Manifest or JSON or IO[bytes] + :return: None + :rtype: None + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -838,60 +988,57 @@ def create_manifest(self, name: str, reference: str, payload: IO, **kwargs: Any) _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} - content_type: str = kwargs.pop( - "content_type", _headers.pop("Content-Type", "application/vnd.docker.distribution.manifest.v2+json") - ) - cls: ClsType[Any] = kwargs.pop("cls", None) + content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + cls: ClsType[None] = kwargs.pop("cls", None) - _content = payload + content_type = content_type or "application/json" + _content = None + if isinstance(payload, (IOBase, bytes)): + _content = payload + else: + _content = json.dumps(payload, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - request = build_container_registry_create_manifest_request( + _request = build_container_registry_create_manifest_request( name=name, reference=reference, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} + response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Docker-Content-Digest"] = self._deserialize( "str", response.headers.get("Docker-Content-Digest") ) - response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) - response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) - - deserialized = self._deserialize("object", pipeline_response) if cls: - return cls(pipeline_response, deserialized, response_headers) - - return deserialized + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace def delete_manifest( # pylint: disable=inconsistent-return-statements self, name: str, reference: str, **kwargs: Any ) -> None: - """Delete the manifest identified by ``name`` and ``reference``. Note that a manifest can *only* - be deleted by ``digest``. + """Delete the manifest identified by ``name`` and ``reference``. Note that a manifest + can *only* be deleted by ``digest``. :param name: Name of the image (including the namespace). Required. :type name: str @@ -901,7 +1048,7 @@ def delete_manifest( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -914,42 +1061,40 @@ def delete_manifest( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_delete_manifest_request( + _request = build_container_registry_delete_manifest_request( name=name, reference=reference, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202, 404]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace - def get_repositories(self, *, last: Optional[str] = None, n: Optional[int] = None, **kwargs: Any) -> Iterable[str]: + def get_repositories(self, *, last: Optional[str] = None, n: Optional[int] = None, **kwargs: Any) -> ItemPaged[str]: """List repositories. :keyword last: Query parameter for the last item in previous query. Result set will include values lexically after last. Default value is None. :paramtype last: str - :keyword n: query parameter for max number of items. Default value is None. + :keyword n: Query parameter for max number of items. Default value is None. :paramtype n: int :return: An iterator like instance of str :rtype: ~azure.core.paging.ItemPaged[str] @@ -958,9 +1103,9 @@ def get_repositories(self, *, last: Optional[str] = None, n: Optional[int] = Non _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[_models._models.Repositories] = kwargs.pop("cls", None) # pylint: disable=protected-access + cls: ClsType[list[str]] = kwargs.pop("cls", None) - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -971,7 +1116,7 @@ def get_repositories(self, *, last: Optional[str] = None, n: Optional[int] = Non def prepare_request(next_link=None): if not next_link: - request = build_container_registry_get_repositories_request( + _request = build_container_registry_get_repositories_request( last=last, n=n, api_version=self._config.api_version, @@ -979,9 +1124,11 @@ def prepare_request(next_link=None): params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) else: # make call to next link with the client's api-version @@ -993,40 +1140,37 @@ def prepare_request(next_link=None): } ) _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( + _request = HttpRequest( "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url( + "self._config.endpoint", self._config.endpoint, "str", skip_quote=True + ), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - return request + return _request def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.Repositories, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.repositories + deserialized = pipeline_response.http_response.json() + list_of_elem = _deserialize(list[str], deserialized.get("repositories", [])) if cls: list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, iter(list_of_elem) + return deserialized.get("link") or None, iter(list_of_elem) def get_next(next_link=None): - request = prepare_request(next_link) + _request = prepare_request(next_link) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) return pipeline_response @@ -1038,11 +1182,12 @@ def get_properties(self, name: str, **kwargs: Any) -> _models.ContainerRepositor :param name: Name of the image (including the namespace). Required. :type name: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1055,49 +1200,54 @@ def get_properties(self, name: str, **kwargs: Any) -> _models.ContainerRepositor cls: ClsType[_models.ContainerRepositoryProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_properties_request( + _request = build_container_registry_get_properties_request( name=name, api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ContainerRepositoryProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ContainerRepositoryProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace - def delete_repository(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements + def delete_repository(self, name: str, **kwargs: Any) -> _models.DeleteRepositoryResult: """Delete the repository identified by ``name``. :param name: Name of the image (including the namespace). Required. :type name: str - :return: None - :rtype: None + :return: DeleteRepositoryResult. The DeleteRepositoryResult is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.DeleteRepositoryResult :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1108,35 +1258,44 @@ def delete_repository(self, name: str, **kwargs: Any) -> None: # pylint: disabl _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[None] = kwargs.pop("cls", None) + cls: ClsType[_models.DeleteRepositoryResult] = kwargs.pop("cls", None) - request = build_container_registry_delete_repository_request( + _request = build_container_registry_delete_repository_request( name=name, api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response - if response.status_code not in [202, 404]: + if response.status_code not in [202]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.DeleteRepositoryResult, response.json()) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @overload def update_properties( @@ -1147,57 +1306,84 @@ def update_properties( content_type: str = "application/json", **kwargs: Any, ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str :param value: Repository attribute value. Default value is None. - :type value: ~container_registry.models.RepositoryWriteableProperties + :type value: ~azure.containerregistry._generated.models.RepositoryWriteableProperties :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ @overload def update_properties( - self, name: str, value: Optional[IO] = None, *, content_type: str = "application/json", **kwargs: Any + self, name: str, value: Optional[JSON] = None, *, content_type: str = "application/json", **kwargs: Any ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str :param value: Repository attribute value. Default value is None. - :type value: IO + :type value: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def update_properties( + self, name: str, value: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any + ) -> _models.ContainerRepositoryProperties: + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param value: Repository attribute value. Default value is None. + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ @distributed_trace def update_properties( - self, name: str, value: Optional[Union[_models.RepositoryWriteableProperties, IO]] = None, **kwargs: Any + self, + name: str, + value: Optional[Union[_models.RepositoryWriteableProperties, JSON, IO[bytes]]] = None, + **kwargs: Any, ) -> _models.ContainerRepositoryProperties: - """Update the attribute identified by ``name`` where ``reference`` is the name of the repository. + """Update the attribute identified by ``name`` where ``reference`` is the name of the + repository. :param name: Name of the image (including the namespace). Required. :type name: str - :param value: Repository attribute value. Is either a RepositoryWriteableProperties type or a - IO type. Default value is None. - :type value: ~container_registry.models.RepositoryWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ContainerRepositoryProperties - :rtype: ~container_registry.models.ContainerRepositoryProperties + :param value: Repository attribute value. Is one of the following types: + RepositoryWriteableProperties, JSON, IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.RepositoryWriteableProperties or JSON + or IO[bytes] + :return: ContainerRepositoryProperties. The ContainerRepositoryProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ContainerRepositoryProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1209,53 +1395,57 @@ def update_properties( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ContainerRepositoryProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "RepositoryWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_properties_request( + _request = build_container_registry_update_properties_request( name=name, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ContainerRepositoryProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ContainerRepositoryProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace def get_tags( @@ -1264,10 +1454,10 @@ def get_tags( *, last: Optional[str] = None, n: Optional[int] = None, - orderby: Optional[str] = None, + orderby: Optional[Union[str, _models.ArtifactTagOrder]] = None, digest: Optional[str] = None, **kwargs: Any, - ) -> Iterable["_models.TagAttributesBase"]: + ) -> _models.TagList: """List tags of a repository. :param name: Name of the image (including the namespace). Required. @@ -1277,20 +1467,16 @@ def get_tags( :paramtype last: str :keyword n: query parameter for max number of items. Default value is None. :paramtype n: int - :keyword orderby: orderby query parameter. Default value is None. - :paramtype orderby: str + :keyword orderby: orderby query parameter. Known values are: "none", "timedesc", and "timeasc". + Default value is None. + :paramtype orderby: str or ~azure.containerregistry._generated.models.ArtifactTagOrder :keyword digest: filter by digest. Default value is None. :paramtype digest: str - :return: An iterator like instance of TagAttributesBase - :rtype: ~azure.core.paging.ItemPaged[~container_registry.models.TagAttributesBase] + :return: TagList. The TagList is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.TagList :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = kwargs.pop("params", {}) or {} - - cls: ClsType[_models._models.TagList] = kwargs.pop("cls", None) # pylint: disable=protected-access - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1298,72 +1484,51 @@ def get_tags( } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_container_registry_get_tags_request( - name=name, - last=last, - n=n, - orderby=orderby, - digest=digest, - api_version=self._config.api_version, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) - - else: - # make call to next link with the client's api-version - _parsed_next_link = urllib.parse.urlparse(next_link) - _next_request_params = case_insensitive_dict( - { - key: [urllib.parse.quote(v) for v in value] - for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() - } - ) - _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} - return request + cls: ClsType[_models.TagList] = kwargs.pop("cls", None) - def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.TagList, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.tag_attribute_bases - if cls: - list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, iter(list_of_elem) + _request = build_container_registry_get_tags_request( + name=name, + last=last, + n=n, + orderby=orderby, + digest=digest, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) - def get_next(next_link=None): - request = prepare_request(next_link) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - _stream = False - pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs - ) - response = pipeline_response.http_response + response = pipeline_response.http_response - if response.status_code not in [200]: - if _stream: + if response.status_code not in [200]: + if _stream: + try: response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) - return pipeline_response + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.TagList, response.json()) - return ItemPaged(get_next, extract_data) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @distributed_trace def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> _models.ArtifactTagProperties: @@ -1373,11 +1538,11 @@ def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> _model :type name: str :param reference: Tag name. Required. :type reference: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1390,7 +1555,7 @@ def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> _model cls: ClsType[_models.ArtifactTagProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_tag_properties_request( + _request = build_container_registry_get_tag_properties_request( name=name, reference=reference, api_version=self._config.api_version, @@ -1398,30 +1563,35 @@ def get_tag_properties(self, name: str, reference: str, **kwargs: Any) -> _model params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactTagProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactTagProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @overload def update_tag_attributes( @@ -1440,12 +1610,12 @@ def update_tag_attributes( :param reference: Tag name. Required. :type reference: str :param value: Tag attribute value. Default value is None. - :type value: ~container_registry.models.TagWriteableProperties + :type value: ~azure.containerregistry._generated.models.TagWriteableProperties :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1454,7 +1624,7 @@ def update_tag_attributes( self, name: str, reference: str, - value: Optional[IO] = None, + value: Optional[JSON] = None, *, content_type: str = "application/json", **kwargs: Any, @@ -1466,12 +1636,38 @@ def update_tag_attributes( :param reference: Tag name. Required. :type reference: str :param value: Tag attribute value. Default value is None. - :type value: IO + :type value: JSON + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def update_tag_attributes( + self, + name: str, + reference: str, + value: Optional[IO[bytes]] = None, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.ArtifactTagProperties: + """Update tag attributes. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param reference: Tag name. Required. + :type reference: str + :param value: Tag attribute value. Default value is None. + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1480,7 +1676,7 @@ def update_tag_attributes( self, name: str, reference: str, - value: Optional[Union[_models.TagWriteableProperties, IO]] = None, + value: Optional[Union[_models.TagWriteableProperties, JSON, IO[bytes]]] = None, **kwargs: Any, ) -> _models.ArtifactTagProperties: """Update tag attributes. @@ -1489,17 +1685,15 @@ def update_tag_attributes( :type name: str :param reference: Tag name. Required. :type reference: str - :param value: Tag attribute value. Is either a TagWriteableProperties type or a IO type. - Default value is None. - :type value: ~container_registry.models.TagWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ArtifactTagProperties - :rtype: ~container_registry.models.ArtifactTagProperties + :param value: Tag attribute value. Is one of the following types: TagWriteableProperties, JSON, + IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.TagWriteableProperties or JSON or + IO[bytes] + :return: ArtifactTagProperties. The ArtifactTagProperties is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactTagProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1511,54 +1705,58 @@ def update_tag_attributes( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ArtifactTagProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "TagWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_tag_attributes_request( + _request = build_container_registry_update_tag_attributes_request( name=name, reference=reference, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactTagProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactTagProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace def delete_tag( # pylint: disable=inconsistent-return-statements @@ -1574,7 +1772,7 @@ def delete_tag( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1587,7 +1785,7 @@ def delete_tag( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_delete_tag_request( + _request = build_container_registry_delete_tag_request( name=name, reference=reference, api_version=self._config.api_version, @@ -1595,26 +1793,23 @@ def delete_tag( # pylint: disable=inconsistent-return-statements params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202, 404]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace def get_manifests( @@ -1623,9 +1818,9 @@ def get_manifests( *, last: Optional[str] = None, n: Optional[int] = None, - orderby: Optional[str] = None, + orderby: Optional[Union[str, _models.ArtifactManifestOrder]] = None, **kwargs: Any, - ) -> Iterable["_models.ManifestAttributesBase"]: + ) -> _models.AcrManifests: """List manifests of a repository. :param name: Name of the image (including the namespace). Required. @@ -1635,18 +1830,14 @@ def get_manifests( :paramtype last: str :keyword n: query parameter for max number of items. Default value is None. :paramtype n: int - :keyword orderby: orderby query parameter. Default value is None. - :paramtype orderby: str - :return: An iterator like instance of ManifestAttributesBase - :rtype: ~azure.core.paging.ItemPaged[~container_registry.models.ManifestAttributesBase] + :keyword orderby: orderby query parameter. Known values are: "none", "timedesc", and "timeasc". + Default value is None. + :paramtype orderby: str or ~azure.containerregistry._generated.models.ArtifactManifestOrder + :return: AcrManifests. The AcrManifests is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrManifests :raises ~azure.core.exceptions.HttpResponseError: """ - _headers = kwargs.pop("headers", {}) or {} - _params = kwargs.pop("params", {}) or {} - - cls: ClsType[_models._models.AcrManifests] = kwargs.pop("cls", None) # pylint: disable=protected-access - - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1654,71 +1845,50 @@ def get_manifests( } error_map.update(kwargs.pop("error_map", {}) or {}) - def prepare_request(next_link=None): - if not next_link: - - request = build_container_registry_get_manifests_request( - name=name, - last=last, - n=n, - orderby=orderby, - api_version=self._config.api_version, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) - - else: - # make call to next link with the client's api-version - _parsed_next_link = urllib.parse.urlparse(next_link) - _next_request_params = case_insensitive_dict( - { - key: [urllib.parse.quote(v) for v in value] - for key, value in urllib.parse.parse_qs(_parsed_next_link.query).items() - } - ) - _next_request_params["api-version"] = self._config.api_version - request = HttpRequest( - "GET", urllib.parse.urljoin(next_link, _parsed_next_link.path), params=_next_request_params - ) - path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), - } - request.url = self._client.format_url(request.url, **path_format_arguments) + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} - return request + cls: ClsType[_models.AcrManifests] = kwargs.pop("cls", None) - def extract_data(pipeline_response): - deserialized = self._deserialize( - _models._models.AcrManifests, pipeline_response # pylint: disable=protected-access - ) - list_of_elem = deserialized.manifests - if cls: - list_of_elem = cls(list_of_elem) # type: ignore - return deserialized.link or None, iter(list_of_elem) + _request = build_container_registry_get_manifests_request( + name=name, + last=last, + n=n, + orderby=orderby, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) - def get_next(next_link=None): - request = prepare_request(next_link) + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) - _stream = False - pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs - ) - response = pipeline_response.http_response + response = pipeline_response.http_response - if response.status_code not in [200]: - if _stream: + if response.status_code not in [200]: + if _stream: + try: response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) - return pipeline_response + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrManifests, response.json()) - return ItemPaged(get_next, extract_data) + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore @distributed_trace def get_manifest_properties(self, name: str, digest: str, **kwargs: Any) -> _models.ArtifactManifestProperties: @@ -1728,11 +1898,12 @@ def get_manifest_properties(self, name: str, digest: str, **kwargs: Any) -> _mod :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1745,7 +1916,7 @@ def get_manifest_properties(self, name: str, digest: str, **kwargs: Any) -> _mod cls: ClsType[_models.ArtifactManifestProperties] = kwargs.pop("cls", None) - request = build_container_registry_get_manifest_properties_request( + _request = build_container_registry_get_manifest_properties_request( name=name, digest=digest, api_version=self._config.api_version, @@ -1753,30 +1924,35 @@ def get_manifest_properties(self, name: str, digest: str, **kwargs: Any) -> _mod params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactManifestProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactManifestProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore @overload def update_manifest_properties( @@ -1795,12 +1971,40 @@ def update_manifest_properties( :param digest: Digest of a BLOB. Required. :type digest: str :param value: Manifest attribute value. Default value is None. - :type value: ~container_registry.models.ManifestWriteableProperties + :type value: ~azure.containerregistry._generated.models.ManifestWriteableProperties + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def update_manifest_properties( + self, + name: str, + digest: str, + value: Optional[JSON] = None, + *, + content_type: str = "application/json", + **kwargs: Any, + ) -> _models.ArtifactManifestProperties: + """Update properties of a manifest. + + :param name: Name of the image (including the namespace). Required. + :type name: str + :param digest: Digest of a BLOB. Required. + :type digest: str + :param value: Manifest attribute value. Default value is None. + :type value: JSON :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1809,7 +2013,7 @@ def update_manifest_properties( self, name: str, digest: str, - value: Optional[IO] = None, + value: Optional[IO[bytes]] = None, *, content_type: str = "application/json", **kwargs: Any, @@ -1821,12 +2025,13 @@ def update_manifest_properties( :param digest: Digest of a BLOB. Required. :type digest: str :param value: Manifest attribute value. Default value is None. - :type value: IO + :type value: IO[bytes] :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ @@ -1835,7 +2040,7 @@ def update_manifest_properties( self, name: str, digest: str, - value: Optional[Union[_models.ManifestWriteableProperties, IO]] = None, + value: Optional[Union[_models.ManifestWriteableProperties, JSON, IO[bytes]]] = None, **kwargs: Any, ) -> _models.ArtifactManifestProperties: """Update properties of a manifest. @@ -1844,17 +2049,16 @@ def update_manifest_properties( :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :param value: Manifest attribute value. Is either a ManifestWriteableProperties type or a IO - type. Default value is None. - :type value: ~container_registry.models.ManifestWriteableProperties or IO - :keyword content_type: Body Parameter content-type. Known values are: 'application/json'. - Default value is None. - :paramtype content_type: str - :return: ArtifactManifestProperties - :rtype: ~container_registry.models.ArtifactManifestProperties + :param value: Manifest attribute value. Is one of the following types: + ManifestWriteableProperties, JSON, IO[bytes] Default value is None. + :type value: ~azure.containerregistry._generated.models.ManifestWriteableProperties or JSON or + IO[bytes] + :return: ArtifactManifestProperties. The ArtifactManifestProperties is compatible with + MutableMapping + :rtype: ~azure.containerregistry._generated.models.ArtifactManifestProperties :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1866,54 +2070,58 @@ def update_manifest_properties( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) + content_type = content_type if value else None cls: ClsType[_models.ArtifactManifestProperties] = kwargs.pop("cls", None) - content_type = content_type or "application/json" - _json = None + content_type = content_type or "application/json" if value else None _content = None if isinstance(value, (IOBase, bytes)): _content = value else: if value is not None: - _json = self._serialize.body(value, "ManifestWriteableProperties") + _content = json.dumps(value, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore else: - _json = None + _content = None - request = build_container_registry_update_manifest_properties_request( + _request = build_container_registry_update_manifest_properties_request( name=name, digest=digest, content_type=content_type, api_version=self._config.api_version, - json=_json, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = False + _stream = kwargs.pop("stream", False) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) - deserialized = self._deserialize("ArtifactManifestProperties", pipeline_response) + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.ArtifactManifestProperties, response.json()) if cls: - return cls(pipeline_response, deserialized, {}) + return cls(pipeline_response, deserialized, {}) # type: ignore - return deserialized + return deserialized # type: ignore class ContainerRegistryBlobOperations: @@ -1922,18 +2130,16 @@ class ContainerRegistryBlobOperations: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.ContainerRegistry`'s :attr:`container_registry_blob` attribute. """ - models = _models - - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") @distributed_trace def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Iterator[bytes]]: @@ -1943,11 +2149,11 @@ def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Iterator[b :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: Iterator of the response bytes or None + :return: Iterator[bytes] or None :rtype: Iterator[bytes] or None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1960,27 +2166,31 @@ def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Iterator[b cls: ClsType[Optional[Iterator[bytes]]] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_blob_request( + _request = build_container_registry_blob_get_blob_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = kwargs.pop("stream", True) pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200, 307]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -1992,31 +2202,29 @@ def get_blob(self, name: str, digest: str, **kwargs: Any) -> Optional[Iterator[b "str", response.headers.get("Docker-Content-Digest") ) - deserialized = response.iter_bytes() - if response.status_code == 307: response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) + deserialized = response.iter_bytes() + if cls: - return cls(pipeline_response, deserialized, response_headers) + return cls(pipeline_response, deserialized, response_headers) # type: ignore - return deserialized + return deserialized # type: ignore @distributed_trace - def check_blob_exists( # pylint: disable=inconsistent-return-statements - self, name: str, digest: str, **kwargs: Any - ) -> None: + def check_blob_exists(self, name: str, digest: str, **kwargs: Any) -> bool: """Same as GET, except only the headers are returned. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :return: None - :rtype: None + :return: bool + :rtype: bool :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2029,30 +2237,28 @@ def check_blob_exists( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_check_blob_exists_request( + _request = build_container_registry_blob_check_blob_exists_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200, 307]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} if response.status_code == 200: @@ -2065,7 +2271,8 @@ def check_blob_exists( # pylint: disable=inconsistent-return-statements response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore + return 200 <= response.status_code <= 299 @distributed_trace def delete_blob( # pylint: disable=inconsistent-return-statements @@ -2081,7 +2288,7 @@ def delete_blob( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2094,27 +2301,26 @@ def delete_blob( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_delete_blob_request( + _request = build_container_registry_blob_delete_blob_request( name=name, digest=digest, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -2124,7 +2330,7 @@ def delete_blob( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace def mount_blob( # pylint: disable=inconsistent-return-statements @@ -2142,7 +2348,7 @@ def mount_blob( # pylint: disable=inconsistent-return-statements :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2155,31 +2361,29 @@ def mount_blob( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_mount_blob_request( + _request = build_container_registry_blob_mount_blob_request( name=name, from_parameter=from_parameter, mount=mount, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -2189,23 +2393,24 @@ def mount_blob( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace def get_upload_status( # pylint: disable=inconsistent-return-statements - self, next_link: str, **kwargs: Any + self, next_blob_uuid_link: str, **kwargs: Any ) -> None: - """Retrieve status of upload identified by uuid. The primary purpose of this endpoint is to - resolve the current status of a resumable upload. + """Retrieve status of upload identified by uuid. The primary purpose of this + endpoint is to resolve the current status of a resumable upload. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2218,53 +2423,52 @@ def get_upload_status( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_upload_status_request( - next_link=next_link, + _request = build_container_registry_blob_get_upload_status_request( + next_blob_uuid_link=next_blob_uuid_link, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Range"] = self._deserialize("str", response.headers.get("Range")) response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace def upload_chunk( # pylint: disable=inconsistent-return-statements - self, next_link: str, value: IO, **kwargs: Any + self, next_blob_uuid_link: str, value: bytes, **kwargs: Any ) -> None: """Upload a stream of data without completing the upload. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :param value: Raw data of blob. Required. - :type value: IO + :type value: bytes :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2280,31 +2484,29 @@ def upload_chunk( # pylint: disable=inconsistent-return-statements _content = value - request = build_container_registry_blob_upload_chunk_request( - next_link=next_link, + _request = build_container_registry_blob_upload_chunk_request( + next_blob_uuid_link=next_blob_uuid_link, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -2312,27 +2514,29 @@ def upload_chunk( # pylint: disable=inconsistent-return-statements response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace def complete_upload( # pylint: disable=inconsistent-return-statements - self, next_link: str, value: Optional[IO] = None, *, digest: str, **kwargs: Any + self, next_blob_uuid_link: str, value: Optional[bytes] = None, *, digest: str, **kwargs: Any ) -> None: - """Complete the upload, providing all the data in the body, if necessary. A request without a body - will just complete the upload with previously uploaded content. + """Complete the upload, providing all the data in the body, if necessary. A + request without a body will just complete the upload with previously uploaded + content. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :param value: Optional raw data of blob. Default value is None. - :type value: IO + :type value: bytes :keyword digest: Digest of a BLOB. Required. :paramtype digest: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2343,37 +2547,38 @@ def complete_upload( # pylint: disable=inconsistent-return-statements _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = kwargs.pop("params", {}) or {} - content_type: str = kwargs.pop("content_type", _headers.pop("Content-Type", "application/octet-stream")) + content_type: Optional[str] = kwargs.pop( + "content_type", _headers.pop("Content-Type", "application/octet-stream") + ) + content_type = content_type if value else None cls: ClsType[None] = kwargs.pop("cls", None) _content = value - request = build_container_registry_blob_complete_upload_request( - next_link=next_link, + _request = build_container_registry_blob_complete_upload_request( + next_blob_uuid_link=next_blob_uuid_link, digest=digest, content_type=content_type, + api_version=self._config.api_version, content=_content, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [201]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -2383,21 +2588,24 @@ def complete_upload( # pylint: disable=inconsistent-return-statements ) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace - def cancel_upload(self, next_link: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements - """Cancel outstanding upload processes, releasing associated resources. If this is not called, the - unfinished uploads will eventually timeout. + def cancel_upload( # pylint: disable=inconsistent-return-statements + self, next_blob_uuid_link: str, **kwargs: Any + ) -> None: + """Cancel outstanding upload processes, releasing associated resources. If this is + not called, the unfinished uploads will eventually timeout. - :param next_link: Link acquired from upload start or previous chunk. Note, do not include - initial / (must do substring(1) ). Required. - :type next_link: str + :param next_blob_uuid_link: Link acquired from upload start or previous chunk. Note, do not + include initial + / (must do substring(1) ). Required. + :type next_blob_uuid_link: str :return: None :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2410,32 +2618,30 @@ def cancel_upload(self, next_link: str, **kwargs: Any) -> None: # pylint: disab cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_cancel_upload_request( - next_link=next_link, + _request = build_container_registry_blob_cancel_upload_request( + next_blob_uuid_link=next_blob_uuid_link, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [204]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) if cls: - return cls(pipeline_response, None, {}) + return cls(pipeline_response, None, {}) # type: ignore @distributed_trace def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disable=inconsistent-return-statements @@ -2447,7 +2653,7 @@ def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2460,29 +2666,27 @@ def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_start_upload_request( + _request = build_container_registry_blob_start_upload_request( name=name, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [202]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Location"] = self._deserialize("str", response.headers.get("Location")) @@ -2490,27 +2694,29 @@ def start_upload(self, name: str, **kwargs: Any) -> None: # pylint: disable=inc response_headers["Docker-Upload-UUID"] = self._deserialize("str", response.headers.get("Docker-Upload-UUID")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace - def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs: Any) -> Iterator[bytes]: - """Retrieve the blob from the registry identified by ``digest``. This endpoint may also support - RFC7233 compliant range requests. Support can be detected by issuing a HEAD request. If the - header ``Accept-Range: bytes`` is returned, range requests can be used to fetch partial - content. + def get_chunk( # pylint: disable=inconsistent-return-statements + self, name: str, digest: str, *, range: str, **kwargs: Any + ) -> None: + """Retrieve the blob from the registry identified by ``digest``. This endpoint may + also support RFC7233 compliant range requests. Support can be detected by + issuing a HEAD request. If the header ``Accept-Range: bytes`` is returned, range + requests can be used to fetch partial content. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :keyword range_header: Format : bytes=:code:``-:code:``, HTTP Range header - specifying blob chunk. Required. - :paramtype range_header: str - :return: Iterator of the response bytes - :rtype: Iterator[bytes] + :keyword range: Format : bytes=-, HTTP Range header specifying blob chunk. + Required. + :paramtype range: str + :return: None + :rtype: None :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2521,30 +2727,29 @@ def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs: Any) _headers = kwargs.pop("headers", {}) or {} _params = kwargs.pop("params", {}) or {} - cls: ClsType[Iterator[bytes]] = kwargs.pop("cls", None) + cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_get_chunk_request( + _request = build_container_registry_blob_get_chunk_request( name=name, digest=digest, - range_header=range_header, + range=range, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) - _stream = True + _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [206]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) raise HttpResponseError(response=response) @@ -2552,31 +2757,25 @@ def get_chunk(self, name: str, digest: str, *, range_header: str, **kwargs: Any) response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Content-Range"] = self._deserialize("str", response.headers.get("Content-Range")) - deserialized = response.iter_bytes() - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore + return cls(pipeline_response, None, response_headers) # type: ignore @distributed_trace - def check_chunk_exists( # pylint: disable=inconsistent-return-statements - self, name: str, digest: str, *, range_header: str, **kwargs: Any - ) -> None: + def check_chunk_exists(self, name: str, digest: str, *, range: str, **kwargs: Any) -> bool: """Same as GET, except only the headers are returned. :param name: Name of the image (including the namespace). Required. :type name: str :param digest: Digest of a BLOB. Required. :type digest: str - :keyword range_header: Format : bytes=:code:``-:code:``, HTTP Range header - specifying blob chunk. Required. - :paramtype range_header: str - :return: None - :rtype: None + :keyword range: Format : bytes=-, HTTP Range header specifying blob chunk. + Required. + :paramtype range: str + :return: bool + :rtype: bool :raises ~azure.core.exceptions.HttpResponseError: """ - error_map = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2589,62 +2788,305 @@ def check_chunk_exists( # pylint: disable=inconsistent-return-statements cls: ClsType[None] = kwargs.pop("cls", None) - request = build_container_registry_blob_check_chunk_exists_request( + _request = build_container_registry_blob_check_chunk_exists_request( name=name, digest=digest, - range_header=range_header, + range=range, + api_version=self._config.api_version, headers=_headers, params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } - request.url = self._client.format_url(request.url, **path_format_arguments) + _request.url = self._client.format_url(_request.url, **path_format_arguments) _stream = False pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - request, stream=_stream, **kwargs + _request, stream=_stream, **kwargs ) response = pipeline_response.http_response if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket map_error(status_code=response.status_code, response=response, error_map=error_map) - error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) - raise HttpResponseError(response=response, model=error) + raise HttpResponseError(response=response) response_headers = {} response_headers["Content-Length"] = self._deserialize("int", response.headers.get("Content-Length")) response_headers["Content-Range"] = self._deserialize("str", response.headers.get("Content-Range")) if cls: - return cls(pipeline_response, None, response_headers) + return cls(pipeline_response, None, response_headers) # type: ignore + return 200 <= response.status_code <= 299 -class AuthenticationOperations: # pylint: disable=abstract-class-instantiated +class AuthenticationOperations: """ .. warning:: **DO NOT** instantiate this class directly. Instead, you should access the following operations through - :class:`~container_registry.ContainerRegistry`'s + :class:`~azure.containerregistry._generated.ContainerRegistry`'s :attr:`authentication` attribute. """ - models = _models - - def __init__(self, *args, **kwargs): + def __init__(self, *args, **kwargs) -> None: input_args = list(args) - self._client = input_args.pop(0) if input_args else kwargs.pop("client") - self._config = input_args.pop(0) if input_args else kwargs.pop("config") - self._serialize = input_args.pop(0) if input_args else kwargs.pop("serializer") - self._deserialize = input_args.pop(0) if input_args else kwargs.pop("deserializer") - raise_if_not_implemented( - self.__class__, - [ - "exchange_aad_access_token_for_acr_refresh_token", - "exchange_acr_refresh_token_for_acr_access_token", - ], + self._client: PipelineClient = input_args.pop(0) if input_args else kwargs.pop("client") + self._config: ContainerRegistryConfiguration = input_args.pop(0) if input_args else kwargs.pop("config") + self._serialize: Serializer = input_args.pop(0) if input_args else kwargs.pop("serializer") + self._deserialize: Deserializer = input_args.pop(0) if input_args else kwargs.pop("deserializer") + + @overload + def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: _models.MultipartBodyParameter, **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: JSON, **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Required. + :type body: JSON + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def exchange_aad_access_token_for_acr_refresh_token( # pylint: disable=name-too-long + self, body: Union[_models.MultipartBodyParameter, JSON], **kwargs: Any + ) -> _models.AcrRefreshToken: + """Exchange AAD tokens for an ACR refresh Token. + + :param body: The body of the request. Is either a MultipartBodyParameter type or a JSON type. + Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter or JSON + :return: AcrRefreshToken. The AcrRefreshToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrRefreshToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrRefreshToken] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _Model) else body + _file_fields: list[str] = [] + _data_fields: list[str] = ["grantType", "service", "tenant", "refreshToken", "accessToken"] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_authentication_exchange_aad_access_token_for_acr_refresh_token_request( + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrRefreshToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @overload + def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: _models.MultipartBodyParameter, **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: JSON, **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Required. + :type body: JSON + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + + @distributed_trace + def exchange_acr_refresh_token_for_acr_access_token( # pylint: disable=name-too-long + self, body: Union[_models.MultipartBodyParameter, JSON], **kwargs: Any + ) -> _models.AcrAccessToken: + """Exchange ACR Refresh token for an ACR Access Token. + + :param body: The body of the request. Is either a MultipartBodyParameter type or a JSON type. + Required. + :type body: ~azure.containerregistry._generated.models.MultipartBodyParameter or JSON + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrAccessToken] = kwargs.pop("cls", None) + + _body = body.as_dict() if isinstance(body, _Model) else body + _file_fields: list[str] = [] + _data_fields: list[str] = ["grantType", "service", "tenant", "refreshToken", "accessToken"] + _files, _data = prepare_multipart_form_data(_body, _file_fields, _data_fields) + + _request = build_authentication_exchange_acr_refresh_token_for_acr_access_token_request( + files=_files, + data=_data, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs + ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrAccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore + + @distributed_trace + def get_acr_access_token_from_login(self, *, service: str, scope: str, **kwargs: Any) -> _models.AcrAccessToken: + """Exchange Username, Password and Scope for an ACR Access Token. + + :keyword service: Indicates the name of your Azure container registry. Required. + :paramtype service: str + :keyword scope: Expected to be a valid scope, and can be specified more than once for multiple + scope requests. You can obtain this from the Www-Authenticate response header + from the challenge. Required. + :paramtype scope: str + :return: AcrAccessToken. The AcrAccessToken is compatible with MutableMapping + :rtype: ~azure.containerregistry._generated.models.AcrAccessToken + :raises ~azure.core.exceptions.HttpResponseError: + """ + error_map: MutableMapping = { + 401: ClientAuthenticationError, + 404: ResourceNotFoundError, + 409: ResourceExistsError, + 304: ResourceNotModifiedError, + } + error_map.update(kwargs.pop("error_map", {}) or {}) + + _headers = kwargs.pop("headers", {}) or {} + _params = kwargs.pop("params", {}) or {} + + cls: ClsType[_models.AcrAccessToken] = kwargs.pop("cls", None) + + _request = build_authentication_get_acr_access_token_from_login_request( + service=service, + scope=scope, + api_version=self._config.api_version, + headers=_headers, + params=_params, + ) + path_format_arguments = { + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), + } + _request.url = self._client.format_url(_request.url, **path_format_arguments) + + _stream = kwargs.pop("stream", False) + pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access + _request, stream=_stream, **kwargs ) + + response = pipeline_response.http_response + + if response.status_code not in [200]: + if _stream: + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass + map_error(status_code=response.status_code, response=response, error_map=error_map) + raise HttpResponseError(response=response) + + if _stream: + deserialized = response.iter_bytes() + else: + deserialized = _deserialize(_models.AcrAccessToken, response.json()) + + if cls: + return cls(pipeline_response, deserialized, {}) # type: ignore + + return deserialized # type: ignore diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_patch.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_patch.py index 1cdf038ca534..5d44f75ddd26 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_patch.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_generated/operations/_patch.py @@ -1,13 +1,16 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ +# coding=utf-8 +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# -------------------------------------------------------------------------- """Customize generated code here. Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ + from typing import Any, Callable, Dict, List, Optional, TypeVar, Union -from .._serialization import Serializer +from .._utils.serialization import Serializer +from .._utils.model_base import _deserialize from azure.core.exceptions import ( ClientAuthenticationError, @@ -30,73 +33,57 @@ _SERIALIZER = Serializer() _SERIALIZER.client_side_validation = False -# fmt: off - - - - def build_exchange_aad_access_token_for_acr_refresh_token_request( - **kwargs # type: Any + **kwargs, # type: Any ): # type: (...) -> HttpRequest _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop('api_version', _params.pop('api-version', "2021-07-01")) # type: str - content_type = kwargs.pop('content_type', _headers.pop('Content-Type', None)) # type: Optional[str] - accept = _headers.pop('Accept', "application/json") + api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # type: str + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop("template_url", "/oauth2/exchange") # Construct parameters - _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers if content_type is not None: - _headers['Content-Type'] = _SERIALIZER.header("content_type", content_type, 'str') - _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - return HttpRequest( - method="POST", - url=_url, - params=_params, - headers=_headers, - **kwargs - ) + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) def build_exchange_acr_refresh_token_for_acr_access_token_request( - **kwargs # type: Any + **kwargs, # type: Any ): # type: (...) -> HttpRequest _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version = kwargs.pop('api_version', _params.pop('api-version', "2021-07-01")) # type: str - content_type = kwargs.pop('content_type', _headers.pop('Content-Type', None)) # type: Optional[str] - accept = _headers.pop('Accept', "application/json") + api_version = kwargs.pop("api_version", _params.pop("api-version", "2021-07-01")) # type: str + content_type = kwargs.pop("content_type", _headers.pop("Content-Type", None)) # type: Optional[str] + accept = _headers.pop("Accept", "application/json") # Construct URL _url = kwargs.pop("template_url", "/oauth2/token") # Construct parameters - _params['api-version'] = _SERIALIZER.query("api_version", api_version, 'str') + _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers if content_type is not None: - _headers['Content-Type'] = _SERIALIZER.header("content_type", content_type, 'str') - _headers['Accept'] = _SERIALIZER.header("accept", accept, 'str') + _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") + _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") + + return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) - return HttpRequest( - method="POST", - url=_url, - params=_params, - headers=_headers, - **kwargs - ) # fmt: on @@ -110,7 +97,7 @@ def exchange_aad_access_token_for_acr_refresh_token( tenant=None, # type: Optional[str] refresh_token=None, # type: Optional[str] access_token=None, # type: Optional[str] - **kwargs # type: Any + **kwargs, # type: Any ): # type: (...) -> _models.AcrRefreshToken """Exchange AAD tokens for an ACR refresh Token. @@ -161,7 +148,7 @@ def exchange_aad_access_token_for_acr_refresh_token( params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore @@ -174,7 +161,7 @@ def exchange_aad_access_token_for_acr_refresh_token( map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("AcrRefreshToken", pipeline_response) + deserialized = _deserialize(_models.AcrRefreshToken, response.json()) if cls: return cls(pipeline_response, deserialized, {}) @@ -187,7 +174,7 @@ def exchange_acr_refresh_token_for_acr_access_token( scope, # type: str refresh_token, # type: str grant_type="refresh_token", # type: Union[str, "_models.TokenGrantType"] - **kwargs # type: Any + **kwargs, # type: Any ): # type: (...) -> _models.AcrAccessToken """Exchange ACR Refresh token for an ACR Access Token. @@ -235,7 +222,7 @@ def exchange_acr_refresh_token_for_acr_access_token( params=_params, ) path_format_arguments = { - "url": self._serialize.url("self._config.url", self._config.url, "str", skip_quote=True), + "endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), } request.url = self._client.format_url(request.url, **path_format_arguments) # type: ignore @@ -248,16 +235,16 @@ def exchange_acr_refresh_token_for_acr_access_token( map_error(status_code=response.status_code, response=response, error_map=error_map) error = self._deserialize.failsafe_deserialize(_models.AcrErrors, pipeline_response) raise HttpResponseError(response=response, model=error) - deserialized = self._deserialize("AcrAccessToken", pipeline_response) + deserialized = _deserialize(_models.AcrAccessToken, response.json()) if cls: return cls(pipeline_response, deserialized, {}) return deserialized -__all__ = [ - "AuthenticationOperations" -] # type: List[str] # Add all objects you want publicly available to users at this package level +__all__: list[str] = [ + "AuthenticationOperations", +] # Add all objects you want publicly available to users at this package level def patch_sdk(): diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_models.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_models.py index c19ab18d008f..73d50756da29 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_models.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/_models.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # ------------------------------------ # Copyright (c) Microsoft Corporation. diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_anonymous_exchange_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_anonymous_exchange_client.py index 3543382b9a28..0065b67e3efe 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_anonymous_exchange_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_anonymous_exchange_client.py @@ -54,8 +54,8 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential endpoint = "https://" + endpoint self._endpoint = endpoint self._client = ContainerRegistry( + endpoint=endpoint, credential=AsyncAnonymousAccessCredential(), - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=ExchangeClientAuthenticationPolicy(), **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_base_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_base_client.py index fd260cdfa3fb..c53524d2472f 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_base_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_base_client.py @@ -39,8 +39,8 @@ class ContainerRegistryBaseClient(object): def __init__(self, endpoint: str, credential: Optional[AsyncTokenCredential], **kwargs: Any) -> None: self._auth_policy = ContainerRegistryChallengePolicy(credential, endpoint, **kwargs) self._client = ContainerRegistry( + endpoint=endpoint, credential=credential or AsyncAnonymousAccessCredential(), - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=self._auth_policy, **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py index 1da360b7f75e..7fc566c7a51d 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_registry_client.py @@ -1,3 +1,4 @@ +# pylint: disable=too-many-lines # coding=utf-8 # ------------------------------------ # Copyright (c) Microsoft Corporation. @@ -51,8 +52,12 @@ ArtifactTagProperties, GetManifestResult, DigestValidationError, + TagAttributesBase, ) +from ._generated.models import AcrManifests +from .._generated._utils.model_base import _deserialize + if TYPE_CHECKING: from .._generated.models import ArtifactManifestOrder, ArtifactTagOrder JSON = MutableMapping[str, Any] @@ -175,9 +180,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/_catalog" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -201,9 +206,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -215,10 +220,10 @@ def prepare_request(next_link=None): return request async def extract_data(pipeline_response): - deserialized = self._client._deserialize( # pylint: disable=protected-access - "Repositories", pipeline_response + list_of_elem = _deserialize( + list[str], + pipeline_response.http_response.internal_response.json().get("repositories", []) ) - list_of_elem = deserialized.repositories or [] if cls: list_of_elem = cls(list_of_elem) link = None @@ -305,9 +310,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/{name}/_manifests" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -336,9 +341,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -351,10 +356,10 @@ def prepare_request(next_link=None): return request async def extract_data(pipeline_response): - deserialized = self._client._deserialize( # pylint: disable=protected-access - "AcrManifests", pipeline_response + list_of_elem = _deserialize( + list[AcrManifests], + pipeline_response.http_response.internal_response.json().get("manifests", []) ) - list_of_elem = deserialized.manifests or [] if cls: list_of_elem = cls(list_of_elem) link = None @@ -525,9 +530,9 @@ def prepare_request(next_link=None): # Construct URL url = "/acr/v1/{name}/_tags" path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -560,9 +565,9 @@ def prepare_request(next_link=None): url = next_link query_parameters: Dict[str, Any] = {} path_format_arguments = { - "url": self._client._serialize.url( # pylint: disable=protected-access - "self._client._config.url", - self._client._config.url, # pylint: disable=protected-access + "endpoint": self._client._serialize.url( # pylint: disable=protected-access + "self._client._config.endpoint", + self._client._config.endpoint, # pylint: disable=protected-access "str", skip_quote=True, ), @@ -575,8 +580,9 @@ def prepare_request(next_link=None): return request async def extract_data(pipeline_response): - deserialized = self._client._deserialize("TagList", pipeline_response) # pylint: disable=protected-access - list_of_elem = deserialized.tag_attribute_bases or [] + list_of_elem = _deserialize( + list[TagAttributesBase], pipeline_response.http_response.internal_response.json().get("tags", []) + ) if cls: list_of_elem = cls(list_of_elem) link = None @@ -1001,7 +1007,7 @@ async def upload_blob(self, repository: str, data: IO[bytes], **kwargs: Any) -> complete_upload_response_headers = cast( Dict[str, str], await self._client.container_registry_blob.complete_upload( - digest=digest, next_link=location, cls=_return_response_headers, **kwargs + location, digest=digest, cls=_return_response_headers, **kwargs ), ) if digest != complete_upload_response_headers["Docker-Content-Digest"]: diff --git a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_exchange_client.py b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_exchange_client.py index 4bd6085e5be9..537c204b11a6 100644 --- a/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_exchange_client.py +++ b/sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_exchange_client.py @@ -46,8 +46,8 @@ def __init__(self, endpoint: str, credential: AsyncTokenCredential, **kwargs: An self._endpoint = endpoint self.credential_scopes = kwargs.get("credential_scopes", ["https://management.core.windows.net/.default"]) self._client = ContainerRegistry( + endpoint=endpoint, credential=credential, - url=endpoint, sdk_moniker=USER_AGENT, authentication_policy=ExchangeClientAuthenticationPolicy(), **kwargs diff --git a/sdk/containerregistry/azure-containerregistry/pyproject.toml b/sdk/containerregistry/azure-containerregistry/pyproject.toml index 2a482558eb95..297752b68e6d 100644 --- a/sdk/containerregistry/azure-containerregistry/pyproject.toml +++ b/sdk/containerregistry/azure-containerregistry/pyproject.toml @@ -1,3 +1,65 @@ +# -------------------------------------------------------------------------- +# Copyright (c) Microsoft Corporation. All rights reserved. +# Licensed under the MIT License. See License.txt in the project root for license information. +# Code generated by Microsoft (R) Python Code Generator. +# Changes may cause incorrect behavior and will be lost if the code is regenerated. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-containerregistry" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Container Registry Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +requires-python = ">=3.9" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.35.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.containerregistry._generated._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.containerregistry", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] + [tool.azure-sdk-build] pyright = false -black = true \ No newline at end of file +black = true diff --git a/sdk/containerregistry/azure-containerregistry/setup.py b/sdk/containerregistry/azure-containerregistry/setup.py deleted file mode 100644 index b8908f3673f1..000000000000 --- a/sdk/containerregistry/azure-containerregistry/setup.py +++ /dev/null @@ -1,66 +0,0 @@ -from setuptools import setup, find_packages -import os -from io import open -import re - -# Change the PACKAGE_NAME only to change folder and different name -PACKAGE_NAME = "azure-containerregistry" -PACKAGE_PPRINT_NAME = "Azure Container Registry" - -# a-b-c => a/b/c -package_folder_path = PACKAGE_NAME.replace("-", "/") -# a-b-c => a.b.c -namespace_name = PACKAGE_NAME.replace("-", ".") - -# Version extraction inspired from 'requests' -with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: - version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) -if not version: - raise RuntimeError("Cannot find version information") - -with open("README.md", encoding="utf-8") as f: - long_description = f.read() - -setup( - name=PACKAGE_NAME, - version=version, - include_package_data=True, - description=f"Microsoft Azure {PACKAGE_PPRINT_NAME} Client Library for Python", - # ensure that these are updated to reflect the package owners' information - long_description=long_description, - long_description_content_type="text/markdown", - url="https://github.com/Azure/azure-sdk-for-python", - keywords="azure, azure sdk", - author="Microsoft Corporation", - author_email="azuresdkengsysadmins@microsoft.com", - license="MIT License", - # ensure that the development status reflects the status of your package - classifiers=[ - "Development Status :: 5 - Production/Stable", - "Programming Language :: Python", - "Programming Language :: Python :: 3 :: Only", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "License :: OSI Approved :: MIT License", - ], - packages=find_packages( - exclude=[ - "tests", - # Exclude packages that will be covered by PEP420 or nspkg - "azure", - ] - ), - python_requires=">=3.8", - install_requires=[ - "azure-core>=1.27.0,<2.0.0", - "isodate>=0.6.0", - ], - project_urls={ - "Bug Reports": "https://github.com/Azure/azure-sdk-for-python/issues", - "Source": "https://github.com/Azure/azure-sdk-for-python", - }, -) diff --git a/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client.py b/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client.py index 72290b8054de..1b856fd5f615 100644 --- a/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client.py +++ b/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # ------------------------------------ # Copyright (c) Microsoft Corporation. diff --git a/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client_async.py b/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client_async.py index 384afe9ddcb3..5a5377b8b3ee 100644 --- a/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client_async.py +++ b/sdk/containerregistry/azure-containerregistry/tests/test_container_registry_client_async.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # ------------------------------------ # Copyright (c) Microsoft Corporation. diff --git a/sdk/containerregistry/azure-containerregistry/tsp-location.yaml b/sdk/containerregistry/azure-containerregistry/tsp-location.yaml new file mode 100644 index 000000000000..fb8e4c437f5d --- /dev/null +++ b/sdk/containerregistry/azure-containerregistry/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/containerregistry/data-plane/Registry +commit: +repo: +additionalDirectories: