[Container Registry] renaming TagProperties -> ArtifactTagProperties (#18430)

* renaming TagProperties -> ArtifactTagProperties

* forgot the changelog

Author: seankane-msft

sdk/containerregistry/azure-containerregistry/CHANGELOG.md

@@ -1,6 +1,7 @@
 # Release History
 
 ## 1.0.0b2 (Unreleased)
+* Rename `TagProperties` to `ArtifactTagProperties`
 * Rename `ContentPermissions` to `ContentProperties`
 * Rename `content_permissions` attributes on `TagProperties`, `RepositoryProperties`, and `RegistryArtifactProperties` to `writeable_properties`.
 

sdk/containerregistry/azure-containerregistry/azure/containerregistry/__init__.py

@@ -15,7 +15,7 @@
     RegistryArtifactProperties,
     RepositoryProperties,
     TagOrderBy,
-    TagProperties,
+    ArtifactTagProperties,
 )
 from ._version import VERSION
 
@@ -30,5 +30,5 @@
     "RegistryArtifactProperties",
     "RepositoryProperties",
     "TagOrderBy",
-    "TagProperties",
+    "ArtifactTagProperties",
 ]

sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_repository_client.py

@@ -3,7 +3,7 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any, Dict
 
 from azure.core.exceptions import (
     ClientAuthenticationError,
@@ -22,11 +22,10 @@
     DeletedRepositoryResult,
     RegistryArtifactProperties,
     RepositoryProperties,
-    TagProperties,
+    ArtifactTagProperties,
 )
 
 if TYPE_CHECKING:
-    from typing import Any, Dict
     from azure.core.credentials import TokenCredential
     from ._models import ContentProperties
 
@@ -123,16 +122,17 @@ def get_registry_artifact_properties(self, tag_or_digest, **kwargs):
 
     @distributed_trace
     def get_tag_properties(self, tag, **kwargs):
-        # type: (str, Dict[str, Any]) -> TagProperties
+        # type: (str, Dict[str, Any]) -> ArtifactTagProperties
         """Get the properties for a tag
 
         :param tag: The tag to get properties for
         :type tag: str
-        :returns: :class:`~azure.containerregistry.TagProperties`
+        :returns: :class:`~azure.containerregistry.ArtifactTagProperties`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
-        return TagProperties._from_generated(  # pylint: disable=protected-access
-            self._client.container_registry.get_tag_properties(self.repository, tag, **kwargs)
+        return ArtifactTagProperties._from_generated(  # pylint: disable=protected-access
+            self._client.container_registry.get_tag_properties(self.repository, tag, **kwargs),
+            repository=self.repository,
         )
 
     @distributed_trace
@@ -255,7 +255,7 @@ def get_next(next_link=None):
 
     @distributed_trace
     def list_tags(self, **kwargs):
-        # type: (Dict[str, Any]) -> ItemPaged[TagProperties]
+        # type: (Dict[str, Any]) -> ItemPaged[ArtifactTagProperties]
         """List the tags for a repository
 
         :keyword last: Query parameter for the last item in the previous call. Ensuing
@@ -265,7 +265,7 @@ def list_tags(self, **kwargs):
         :paramtype order_by: :class:`~azure.containerregistry.TagOrderBy`
         :keyword results_per_page: Number of repositories to return per page
         :paramtype results_per_page: int
-        :return: ItemPaged[:class:`~azure.containerregistry.TagProperties`]
+        :return: ItemPaged[:class:`~azure.containerregistry.ArtifactTagProperties`]
         :rtype: :class:`~azure.core.paging.ItemPaged`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
@@ -275,7 +275,11 @@ def list_tags(self, **kwargs):
         orderby = kwargs.pop("order_by", None)
         digest = kwargs.pop("digest", None)
         cls = kwargs.pop(
-            "cls", lambda objs: [TagProperties._from_generated(o) for o in objs]  # pylint: disable=protected-access
+            "cls",
+            lambda objs: [
+                ArtifactTagProperties._from_generated(o, repository=self.repository)  # pylint: disable=protected-access
+                for o in objs
+            ],
         )
 
         error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
@@ -391,18 +395,19 @@ def set_manifest_properties(self, digest, permissions, **kwargs):
 
     @distributed_trace
     def set_tag_properties(self, tag, permissions, **kwargs):
-        # type: (str, ContentProperties, Dict[str, Any]) -> TagProperties
+        # type: (str, ContentProperties, Dict[str, Any]) -> ArtifactTagProperties
         """Set the properties for a tag
 
         :param tag: Tag to set properties for
         :type tag: str
         :param permissions: The property's values to be set
         :type permissions: ContentProperties
-        :returns: :class:`~azure.containerregistry.TagProperties`
+        :returns: :class:`~azure.containerregistry.ArtifactTagProperties`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
-        return TagProperties._from_generated(  # pylint: disable=protected-access
+        return ArtifactTagProperties._from_generated(  # pylint: disable=protected-access
             self._client.container_registry.update_tag_attributes(
                 self.repository, tag, value=permissions._to_generated(), **kwargs  # pylint: disable=protected-access
-            )
+            ),
+            repository=self.repository,
         )

sdk/containerregistry/azure-containerregistry/azure/containerregistry/_models.py

@@ -5,7 +5,7 @@
 # ------------------------------------
 
 from enum import Enum
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Dict, Any
 from ._generated.models import ContentProperties as GeneratedContentProperties
 
 if TYPE_CHECKING:
@@ -174,7 +174,7 @@ class TagOrderBy(str, Enum):
     LAST_UPDATE_TIME_ASCENDING = "timeasc"
 
 
-class TagProperties(object):
+class ArtifactTagProperties(object):
     """Model for storing properties of a single tag
 
     :ivar writeable_properties: Read/Write/List/Delete permissions for the tag
@@ -185,7 +185,7 @@ class TagProperties(object):
     :ivar last_updated_on: Time the tag was last updated
     :vartype last_updated_on: :class:`datetime.datetime`
     :ivar str name: Name of the image the tag corresponds to
-    :ivar str registry: Registry the tag belongs to
+    :ivar str repository: Repository the tag belongs to
     """
 
     def __init__(self, **kwargs):
@@ -194,16 +194,18 @@ def __init__(self, **kwargs):
         self.digest = kwargs.get("digest", None)
         self.last_updated_on = kwargs.get("last_updated_on", None)
         self.name = kwargs.get("name", None)
+        self.repository = kwargs.get("repository", None)
         if self.writeable_properties:
             self.writeable_properties = ContentProperties._from_generated(self.writeable_properties)
 
     @classmethod
-    def _from_generated(cls, generated):
-        # type: (GeneratedTagProperties) -> TagProperties
+    def _from_generated(cls, generated, **kwargs):
+        # type: (GeneratedTagProperties, Dict[str, Any]) -> ArtifactTagProperties
         return cls(
             created_on=generated.created_on,
             digest=generated.digest,
             last_updated_on=generated.last_updated_on,
             name=generated.name,
             writeable_properties=generated.writeable_properties,
+            repository=kwargs.get("repository", None),
         )

sdk/containerregistry/azure-containerregistry/azure/containerregistry/aio/_async_container_repository_client.py

@@ -24,7 +24,7 @@
     DeletedRepositoryResult,
     RegistryArtifactProperties,
     RepositoryProperties,
-    TagProperties,
+    ArtifactTagProperties,
 )
 
 if TYPE_CHECKING:
@@ -120,16 +120,17 @@ async def get_registry_artifact_properties(
         )
 
     @distributed_trace_async
-    async def get_tag_properties(self, tag: str, **kwargs: Dict[str, Any]) -> TagProperties:
+    async def get_tag_properties(self, tag: str, **kwargs: Dict[str, Any]) -> ArtifactTagProperties:
         """Get the properties for a tag
 
         :param tag: The tag to get properties for
         :type tag: str
-        :returns: :class:`~azure.containerregistry.TagProperties`
+        :returns: :class:`~azure.containerregistry.ArtifactTagProperties`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
-        return TagProperties._from_generated(  # pylint: disable=protected-access
-            await self._client.container_registry.get_tag_properties(self.repository, tag, **kwargs)
+        return ArtifactTagProperties._from_generated(  # pylint: disable=protected-access
+            await self._client.container_registry.get_tag_properties(self.repository, tag, **kwargs),
+            repository=self.repository,
         )
 
     @distributed_trace
@@ -250,7 +251,7 @@ async def get_next(next_link=None):
         return AsyncItemPaged(get_next, extract_data)
 
     @distributed_trace
-    def list_tags(self, **kwargs: Dict[str, Any]) -> AsyncItemPaged[TagProperties]:
+    def list_tags(self, **kwargs: Dict[str, Any]) -> AsyncItemPaged[ArtifactTagProperties]:
         """List the tags for a repository
 
         :keyword last: Query parameter for the last item in the previous call. Ensuing
@@ -260,7 +261,7 @@ def list_tags(self, **kwargs: Dict[str, Any]) -> AsyncItemPaged[TagProperties]:
         :paramtype order_by: :class:`~azure.containerregistry.TagOrderBy`
         :keyword results_per_page: Number of repositories to return per page
         :paramtype results_per_page: int
-        :return: ItemPaged[:class:`~azure.containerregistry.TagProperties`]
+        :return: ItemPaged[:class:`~azure.containerregistry.ArtifactTagProperties`]
         :rtype: :class:`~azure.core.async_paging.AsyncItemPaged`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
@@ -270,7 +271,11 @@ def list_tags(self, **kwargs: Dict[str, Any]) -> AsyncItemPaged[TagProperties]:
         orderby = kwargs.pop("order_by", None)
         digest = kwargs.pop("digest", None)
         cls = kwargs.pop(
-            "cls", lambda objs: [TagProperties._from_generated(o) for o in objs]  # pylint: disable=protected-access
+            "cls",
+            lambda objs: [
+                ArtifactTagProperties._from_generated(o, repository=self.repository)  # pylint: disable=protected-access
+                for o in objs
+            ],
         )
 
         error_map = {401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError}
@@ -388,18 +393,19 @@ async def set_manifest_properties(
     @distributed_trace_async
     async def set_tag_properties(
         self, tag: str, permissions: ContentProperties, **kwargs: Dict[str, Any]
-    ) -> TagProperties:
+    ) -> ArtifactTagProperties:
         """Set the properties for a tag
 
         :param tag: Tag to set properties for
         :type tag: str
         :param permissions: The property's values to be set
         :type permissions: ContentProperties
-        :returns: :class:`~azure.containerregistry.TagProperties`
+        :returns: :class:`~azure.containerregistry.ArtifactTagProperties`
         :raises: :class:`~azure.core.exceptions.ResourceNotFoundError`
         """
-        return TagProperties._from_generated(  # pylint: disable=protected-access
+        return ArtifactTagProperties._from_generated(  # pylint: disable=protected-access
             await self._client.container_registry.update_tag_attributes(
                 self.repository, tag, value=permissions._to_generated(), **kwargs  # pylint: disable=protected-access
-            )
+            ),
+            repository=self.repository,
         )

sdk/containerregistry/azure-containerregistry/tests/asynctestcase.py

@@ -3,28 +3,14 @@
 # Copyright (c) Microsoft Corporation.
 # Licensed under the MIT License.
 # ------------------------------------
-from datetime import datetime
-import json
-import os
-import re
-import six
-
 from azure.containerregistry.aio import (
     ContainerRepositoryClient,
     ContainerRegistryClient,
 )
-from azure.containerregistry import (
-    TagProperties,
-    ContentProperties,
-    RegistryArtifactProperties,
-)
 
 from azure.core.credentials import AccessToken
 from azure.identity.aio import DefaultAzureCredential
 
-from azure_devtools.scenario_tests import RecordingProcessor
-from devtools_testutils import AzureTestCase
-
 from testcase import ContainerRegistryTestClass