Update comments in samples and its refernces in docstrings (Azure#22776)

Author: Yalin Li

sdk/containerregistry/azure-containerregistry/azure/containerregistry/_container_registry_client.py

@@ -45,7 +45,7 @@ def __init__(self, endpoint, credential=None, **kwargs):
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/sample_create_client.py
+            .. literalinclude:: ../samples/sample_hello_world.py
                 :start-after: [START create_registry_client]
                 :end-before: [END create_registry_client]
                 :language: python
@@ -89,7 +89,7 @@ def delete_repository(self, repository, **kwargs):
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/sample_create_client.py
+            .. literalinclude:: ../samples/sample_hello_world.py
                 :start-after: [START delete_repository]
                 :end-before: [END delete_repository]
                 :language: python
@@ -111,7 +111,7 @@ def list_repository_names(self, **kwargs):
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/sample_delete_old_tags.py
+            .. literalinclude:: ../samples/sample_delete_tags.py
                 :start-after: [START list_repository_names]
                 :end-before: [END list_repository_names]
                 :language: python

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

@@ -47,7 +47,7 @@ def __init__(
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_create_client_async.py
+            .. literalinclude:: ../samples/async_samples/sample_hello_world_async.py
                 :start-after: [START create_registry_client]
                 :end-before: [END create_registry_client]
                 :language: python
@@ -86,7 +86,7 @@ async def delete_repository(self, repository: str, **kwargs: Any) -> None:
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_create_client_async.py
+            .. literalinclude:: ../samples/async_samples/sample_hello_world_async.py
                 :start-after: [START delete_repository]
                 :end-before: [END delete_repository]
                 :language: python
@@ -107,7 +107,7 @@ def list_repository_names(self, **kwargs: Any) -> AsyncItemPaged[str]:
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/async_samples/sample_delete_old_tags_async.py
+            .. literalinclude:: ../samples/async_samples/sample_delete_tags_async.py
                 :start-after: [START list_repository_names]
                 :end-before: [END list_repository_names]
                 :language: python

sdk/containerregistry/azure-containerregistry/samples/README.md

@@ -17,10 +17,10 @@ The async versions of the samples require Python 3.6 or later.
 |**File Name**|**Description**|
 |-------------|---------------|
 |[sample_hello_world.py][hello_world] ([sample_hello_world_async.py][hello_world_async]) |Instantiate a `ContainerRegistryClient` object and iterating through the collection of tags in the repository with anonymous access |
-|[sample_delete_tags.py][delete_tags] and [sample_delete_tags_async.py][delete_tags_async] | Delete tags from a repository |
-|[sample_delete_images.py][delete_images] and [sample_delete_images_async.py][delete_images_async] | Delete images from a repository |
-|[sample_set_image_properties.py][set_image_properties] and [sample_set_image_properties_async.py][set_image_properties_async] | Set read/write/delete properties on an image |
-|[sample_list_tags.py][list_tags] and [sample_list_tags_async.py][list_tags_async] | List tags on an image using an anonymous access |
+|[sample_delete_tags.py][delete_tags] ([sample_delete_tags_async.py][delete_tags_async]) | Delete tags from a repository |
+|[sample_delete_images.py][delete_images] ([sample_delete_images_async.py][delete_images_async]) | Delete images from a repository |
+|[sample_set_image_properties.py][set_image_properties] ([sample_set_image_properties_async.py][set_image_properties_async]) | Set read/write/delete properties on an image |
+|[sample_list_tags.py][list_tags] ([sample_list_tags_async.py][list_tags_async]) | List tags on an image with anonymous access |
 
 ### Prerequisites
 * Python 3.6 or later is required to use this package.

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_delete_images_async.py

@@ -33,7 +33,7 @@ def __init__(self):
         load_dotenv(find_dotenv())
 
     async def delete_images(self):
-        # [START list_repository_names]   
+        # Instantiate an instance of ContainerRegistryClient
         audience = "https://management.azure.com"
         endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
         credential = DefaultAzureCredential()
@@ -42,16 +42,13 @@ async def delete_images(self):
         async with client:
             async for repository in client.list_repository_names():
                 print(repository)
-                # [END list_repository_names]
 
-                # [START list_manifest_properties]
                 # Keep the three most recent images, delete everything else
                 manifest_count = 0
                 async for manifest in client.list_manifest_properties(repository, order_by=ArtifactManifestOrder.LAST_UPDATED_ON_DESCENDING):
                     manifest_count += 1
                     if manifest_count > 3:
                         await client.delete_manifest(repository, manifest.digest)
-                # [END list_manifest_properties]
 
 
 async def main():

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_delete_tags_async.py

@@ -44,14 +44,12 @@ async def delete_tags(self):
                 print(repository)
                 # [END list_repository_names]
 
-                # [START list_tag_properties]
                 # Keep the three most recent tags, delete everything else
                 tag_count = 0
                 async for tag in client.list_tag_properties(repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING):
                     tag_count += 1
                     if tag_count > 3:
                         await client.delete_tag(repository, tag.name)
-                # [END list_tag_properties]
 
 
 async def main():

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_hello_world_async.py

@@ -28,23 +28,17 @@
 from azure.identity.aio import DefaultAzureCredential
 
 
-class CreateClientsAsync(object):
+class HelloWorldAsync(object):
     def __init__(self):
         load_dotenv(find_dotenv())
 
-    async def create_registry_client(self):
-        # Instantiate the ContainerRegistryClient
+    async def basic_sample(self):
+        # Instantiate an instance of ContainerRegistryClient
         # [START create_registry_client]
         endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
         audience = "https://management.azure.com"
         client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience)
         # [END create_registry_client]
-
-    async def basic_sample(self):
-        # Instantiate the client
-        endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
-        audience = "https://management.azure.com"
-        client = ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience)
         async with client:
             # Iterate through all the repositories
             async for repository_name in client.list_repository_names():
@@ -59,8 +53,7 @@ async def basic_sample(self):
 
 
 async def main():
-    sample = CreateClientsAsync()
-    await sample.create_registry_client()
+    sample = HelloWorldAsync()
     await sample.basic_sample()
 
 

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_list_tags_async.py

@@ -36,14 +36,15 @@ def __init__(self):
         load_dotenv(find_dotenv())
 
     async def list_tags(self):
-        # Create a new ContainerRegistryClient      
+        # Instantiate an instance of ContainerRegistryClient    
         audience = "https://management.azure.com"
         endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
         credential = DefaultAzureCredential()
         client = ContainerRegistryClient(endpoint, credential, audience=audience)
 
         manifest = await client.get_manifest_properties("library/hello-world", "latest")
         print(manifest.repository_name + ": ")
+        # Iterate through all the tags
         for tag in manifest.tags:
             print(tag + "\n")
 

sdk/containerregistry/azure-containerregistry/samples/async_samples/sample_set_image_properties_async.py

@@ -35,21 +35,19 @@ def __init__(self):
         load_dotenv(find_dotenv())
 
     async def set_image_properties(self):
-        # Create a new ContainerRegistryClient
+        # Instantiate an instance of ContainerRegistryClient
         endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
         audience = "https://management.azure.com"
         credential = DefaultAzureCredential()
         client = ContainerRegistryClient(endpoint, credential, audience=audience)
 
-        # [START update_manifest_properties]
         # Set permissions on the v1 image's "latest" tag
         await client.update_manifest_properties(
             "library/hello-world",
             "latest",
             can_write=False,
             can_delete=False
         )
-        # [END update_manifest_properties]
         # After this update, if someone were to push an update to "myacr.azurecr.io\hello-world:v1", it would fail.
         # It's worth noting that if this image also had another tag, such as "latest", and that tag did not have
         # permissions set to prevent reads or deletes, the image could still be overwritten. For example,

sdk/containerregistry/azure-containerregistry/samples/sample_delete_images.py

@@ -30,16 +30,14 @@ def __init__(self):
         load_dotenv(find_dotenv())
 
     def delete_images(self):
-        # [START list_repository_names]
+        # Instantiate an instance of ContainerRegistryClient
         audience = "https://management.azure.com"
         endpoint = os.environ["CONTAINERREGISTRY_ENDPOINT"]
 
         with ContainerRegistryClient(endpoint, DefaultAzureCredential(), audience=audience) as client:
             for repository in client.list_repository_names():
                 print(repository)
-                # [END list_repository_names]
 
-                # [START list_manifest_properties]
                 # Keep the three most recent images, delete everything else
                 manifest_count = 0
                 for manifest in client.list_manifest_properties(
@@ -48,7 +46,6 @@ def delete_images(self):
                     if manifest_count > 3:
                         print("Deleting {}:{}".format(repository, manifest.digest))
                         client.delete_manifest(repository, manifest.digest)
-                # [END list_manifest_properties]
 
 
 if __name__ == "__main__":

sdk/containerregistry/azure-containerregistry/samples/sample_delete_tags.py

@@ -40,15 +40,13 @@ def delete_tags(self):
                 print(repository)
                 # [END list_repository_names]
 
-                # [START list_tag_properties]
                 # Keep the three most recent tags, delete everything else
                 tag_count = 0
                 for tag in client.list_tag_properties(repository, order_by=ArtifactTagOrder.LAST_UPDATED_ON_DESCENDING):
                     tag_count += 1
                     if tag_count > 3:
                         print("Deleting {}:{}".format(repository, tag.name))
                         client.delete_tag(repository, tag.name)
-                # [END list_tag_properties]
 
 
 if __name__ == "__main__":