[Tables] Fix mypy error from ETag and update docstring (#35236)

Author: Yalin Li

sdk/tables/azure-data-tables/azure/data/tables/_error.py

@@ -230,7 +230,7 @@ def _reprocess_error(decoded_error, identifiers=None):
         ):
             args_list = list(decoded_error.args)
             args_list[0] += (
-                "\nA possible cause of this error could be that the account URL used to"
+                "\nA possible cause of this error could be that the account URL used to "
                 "create the Client includes an invalid path, for example the table name. Please check your account URL."
             )
             decoded_error.args = tuple(args_list)

sdk/tables/azure-data-tables/azure/data/tables/_table_batch.py

@@ -246,7 +246,7 @@ def delete(
             table=self.table_name,
             partition_key=self._encoder.prepare_key(partition_key),  # type: ignore[arg-type]
             row_key=self._encoder.prepare_key(row_key),  # type: ignore[arg-type]
-            etag=etag,  # type: ignore[arg-type] # Set None to skip checking etag.
+            etag=etag or "*",
             match_condition=_get_match_condition(
                 etag=etag, match_condition=match_condition or MatchConditions.Unconditionally
             ),

sdk/tables/azure-data-tables/azure/data/tables/_table_client.py

@@ -94,7 +94,7 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
 
     @classmethod
     def from_connection_string(cls, conn_str: str, table_name: str, **kwargs: Any) -> "TableClient":
-        """Create TableClient from a Connection String.
+        """Creates TableClient from a Connection String.
 
         :param str conn_str: A connection string to an Azure Tables account.
         :param str table_name: The table name.
@@ -400,7 +400,7 @@ def delete_entity(self, *args: Union[EntityType, str, T], **kwargs: Any) -> None
                 table=self.table_name,
                 partition_key=encoder.prepare_key(partition_key),
                 row_key=encoder.prepare_key(row_key),
-                etag=etag,
+                etag=etag or "*",
                 match_condition=match_condition,
                 **kwargs,
             )
@@ -413,7 +413,7 @@ def delete_entity(self, *args: Union[EntityType, str, T], **kwargs: Any) -> None
     def create_entity(
         self, entity: EntityType, *, encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER, **kwargs
     ) -> Dict[str, Any]:
-        """Insert entity in a table.
+        """Inserts an entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: Union[TableEntity, Mapping[str, Any]]
@@ -436,7 +436,7 @@ def create_entity(
 
     @overload
     def create_entity(self, entity: T, *, encoder: TableEntityEncoderABC[T], **kwargs) -> Dict[str, Any]:
-        """Insert entity in a table.
+        """Inserts an entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: Custom entity type
@@ -483,7 +483,7 @@ def update_entity(
         encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER,
         **kwargs,
     ) -> Dict[str, Any]:
-        """Updates an entity in a table.
+        """Updates an already existing entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: ~azure.data.tables.TableEntity or dict[str, Any]
@@ -522,7 +522,7 @@ def update_entity(
         encoder: TableEntityEncoderABC[T],
         **kwargs,
     ) -> Dict[str, Any]:
-        """Update entity in a table.
+        """Updates an already existing entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: Custom entity type
@@ -745,7 +745,7 @@ def upsert_entity(
         encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER,
         **kwargs,
     ) -> Dict[str, Any]:
-        """Updates (merge or replace) an entity into a table.
+        """Updates (merge or replace) or inserts an entity into a table.
 
         :param entity: The properties for the table entity.
         :type entity: ~azure.data.tables.TableEntity or dict[str, Any]
@@ -772,7 +772,7 @@ def upsert_entity(
     def upsert_entity(
         self, entity: T, mode: Union[str, UpdateMode] = UpdateMode.MERGE, *, encoder: TableEntityEncoderABC[T], **kwargs
     ) -> Dict[str, Any]:
-        """Updates (merge or replace) an entity into a table.
+        """Updates (merge or replace) or inserts an entity into a table.
 
         :param entity: The properties for the table entity.
         :type entity: Custom entity type

sdk/tables/azure-data-tables/azure/data/tables/aio/_table_client_async.py

@@ -69,7 +69,7 @@ def __init__(  # pylint: disable=missing-client-constructor-parameter-credential
         api_version: Optional[str] = None,
         **kwargs: Any,
     ) -> None:
-        """Create TableClient from a Credential.
+        """Creates TableClient from a Credential.
 
         :param str endpoint: A URL to an Azure Tables account.
         :param str table_name: The table name.
@@ -356,6 +356,7 @@ async def delete_entity(
     ) -> None:
         """Deletes the specified entity in a table. No error will be raised if
         the entity or PartitionKey-RowKey pairing is not found.
+
         :param entity: The entity to delete.
         :type entity: Custom entity type
         :keyword etag: Etag of the entity.
@@ -400,7 +401,7 @@ async def delete_entity(self, *args: Union[EntityType, str, T], **kwargs: Any) -
                 table=self.table_name,
                 partition_key=encoder.prepare_key(partition_key),
                 row_key=encoder.prepare_key(row_key),
-                etag=etag,
+                etag=etag or "*",
                 match_condition=match_condition,
                 **kwargs,
             )
@@ -413,7 +414,7 @@ async def delete_entity(self, *args: Union[EntityType, str, T], **kwargs: Any) -
     async def create_entity(
         self, entity: EntityType, *, encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER, **kwargs
     ) -> Dict[str, Any]:
-        """Inserts entity in a table.
+        """Inserts an entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: ~azure.data.tables.TableEntity or Mapping
@@ -437,7 +438,7 @@ async def create_entity(
 
     @overload
     async def create_entity(self, entity: T, *, encoder: TableEntityEncoderABC[T], **kwargs) -> Dict[str, Any]:
-        """Insert entity in a table.
+        """Inserts an entity in a table.
         :param entity: The properties for the table entity.
         :type entity: Custom entity type
         :keyword encoder: The encoder used to serialize the outgoing Tables entities.
@@ -483,7 +484,7 @@ async def update_entity(
         encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER,
         **kwargs,
     ) -> Dict[str, Any]:
-        """Updates an entity in a table.
+        """Updates an already existing entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: ~azure.data.tables.TableEntity or dict[str, Any]
@@ -522,7 +523,8 @@ async def update_entity(
         encoder: TableEntityEncoderABC[T],
         **kwargs,
     ) -> Dict[str, Any]:
-        """Update entity in a table.
+        """Updates an already existing entity in a table.
+
         :param entity: The properties for the table entity.
         :type entity: Custom entity type
         :param mode: Merge or Replace entity.
@@ -745,7 +747,7 @@ async def upsert_entity(
         encoder: TableEntityEncoderABC[EntityType] = DEFAULT_ENCODER,
         **kwargs,
     ) -> Dict[str, Any]:
-        """Updates (merge or replace) an entity into a table.
+        """Updates (merge or replace) or inserts an entity into a table.
 
         :param entity: The properties for the table entity.
         :type entity: ~azure.data.tables.TableEntity or dict[str, Any]
@@ -772,7 +774,8 @@ async def upsert_entity(
     async def upsert_entity(
         self, entity: T, mode: Union[str, UpdateMode] = UpdateMode.MERGE, *, encoder: TableEntityEncoderABC[T], **kwargs
     ) -> Dict[str, Any]:
-        """Updates (merge or replace) an entity into a table.
+        """Updates (merge or replace) or inserts an entity into a table.
+
         :param entity: The properties for the table entity.
         :type entity: Custom entity type
         :param mode: Merge or Replace entity.

sdk/tables/tests.yml

@@ -24,10 +24,9 @@ extends:
         BLOB_STORAGE_ACCOUNT_KEY: $(python-storage-blob-storage-account-key)
         OAUTH_STORAGE_ACCOUNT_NAME: $(python-storage-oauth-storage-account-name)
         OAUTH_STORAGE_ACCOUNT_KEY: $(python-storage-oauth-storage-account-key)
-        ACTIVE_DIRECTORY_APPLICATION_ID: $(aad-azure-sdk-test-client-id)
-        ACTIVE_DIRECTORY_APPLICATION_SECRET: $(aad-azure-sdk-test-client-secret)
-        ACTIVE_DIRECTORY_TENANT_ID: $(aad-azure-sdk-test-tenant-id)
-        CONNECTION_STRING: $(python-storage-blob-connection-string)
+        AZURE_CLIENT_ID: $(aad-azure-sdk-test-client-id)
+        AZURE_CLIENT_SECRET: $(aad-azure-sdk-test-client-secret)
+        AZURE_TENANT_ID: $(aad-azure-sdk-test-tenant-id)
         BLOB_CONNECTION_STRING: $(python-storage-blob-connection-string)
         TEST_MODE: 'RunLiveNoRecord'
         AZURE_SKIP_LIVE_RECORDING: 'True'