Consistent returns (Azure#13245)

* fixes sync create_entity to return just the metadata

* fixes the create_table method to return just metadata

* fixes the create_table method to return just metadata

* fixed update_entity too

* changed upsert_entity too, now to change the async methods

* fixed async create and update entity

* fixed async create and update entity

* updated async methods to return metadata only, updated tests accordingly and reran tests

* tox fixes

* addressing izzys comments, fixing typehint formats, checking for a correct response instead that it is not None

* fixed comments

* making the same change for async code

* addressing annas comments, trimming metadata returns, removed if_not_match possibility

* had an extra space in there causing pylint failure

* changed how _trim_service_metadata works

Author: seankane-msft

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

@@ -206,3 +206,12 @@ def _return_headers_and_deserialized(response, deserialized, response_headers):
 
 def _return_context_and_deserialized(response, deserialized, response_headers):  # pylint: disable=unused-argument
     return response.http_response.location_mode, deserialized, response_headers
+
+
+def _trim_service_metadata(metadata):
+    # type: (dict[str,str] -> None)
+    return {
+        "date": metadata.pop("date", None),
+        "etag": metadata.pop("etag", None),
+        "version": metadata.pop("version", None)
+    }

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

@@ -17,7 +17,7 @@
 from azure.core.exceptions import HttpResponseError, ResourceNotFoundError
 from azure.core.tracing.decorator import distributed_trace
 
-from ._deserialize import _convert_to_entity
+from ._deserialize import _convert_to_entity, _trim_service_metadata
 from ._entity import TableEntity
 from ._generated import AzureTable
 from ._generated.models import AccessPolicy, SignedIdentifier, TableProperties, QueryOptions
@@ -28,7 +28,7 @@
 from ._deserialize import _return_headers_and_deserialized
 from ._error import _process_table_error
 from ._version import VERSION
-from ._models import TableEntityPropertiesPaged, UpdateMode, TableItem
+from ._models import TableEntityPropertiesPaged, UpdateMode
 
 
 class TableClient(TableClientBase):
@@ -126,7 +126,7 @@ def get_table_access_policy(
             self,
             **kwargs  # type: Any
     ):
-        # type: (...) -> dict[str,AccessPolicy]
+        # type: (...) -> Dict[str,AccessPolicy]
         """Retrieves details about any stored access policies specified on the table that may be
         used with Shared Access Signatures.
 
@@ -148,7 +148,7 @@ def get_table_access_policy(
     @distributed_trace
     def set_table_access_policy(
             self,
-            signed_identifiers,  # type: dict[str,AccessPolicy]
+            signed_identifiers,  # type: Dict[str,AccessPolicy]
             **kwargs):
         # type: (...) -> None
         """Sets stored access policies for the table that may be used with Shared Access Signatures.
@@ -180,17 +180,19 @@ def create_table(
             self,
             **kwargs  # type: Any
     ):
-        # type: (...) -> TableItem
+        # type: (...) -> Dict[str,str]
         """Creates a new table under the current account.
 
-        :return: TableItem created
-        :rtype: TableItem
+        :return: Dictionary of operation metadata returned from service
+        :rtype: dict[str,str]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
         table_properties = TableProperties(table_name=self.table_name, **kwargs)
         try:
-            table = self._client.table.create(table_properties)
-            return TableItem(table=table)
+            metadata, _ = self._client.table.create(
+                table_properties,
+                cls=kwargs.pop('cls', _return_headers_and_deserialized))
+            return _trim_service_metadata(metadata)
         except HttpResponseError as error:
             _process_table_error(error)
 
@@ -231,59 +233,57 @@ def delete_entity(
         :raises: ~azure.core.exceptions.HttpResponseError
         """
 
-        if_match, if_not_match = _get_match_headers(kwargs=dict(kwargs, etag=kwargs.pop('etag', None),
+        if_match, _ = _get_match_headers(kwargs=dict(kwargs, etag=kwargs.pop('etag', None),
                                                                 match_condition=kwargs.pop('match_condition', None)),
                                                     etag_param='etag', match_param='match_condition')
         try:
             self._client.table.delete_entity(
                 table=self.table_name,
                 partition_key=partition_key,
                 row_key=row_key,
-                if_match=if_match or if_not_match or '*',
+                if_match=if_match or '*',
                 **kwargs)
         except HttpResponseError as error:
             _process_table_error(error)
 
     @distributed_trace
     def create_entity(
             self,
-            entity,  # type: Union[TableEntity, dict[str,str]]
+            entity,  # type: Union[TableEntity, Dict[str,str]]
             **kwargs  # type: Any
     ):
-        # type: (...) -> TableEntity
+        # type: (...) -> Dict[str,str]
         """Insert entity in a table.
 
         :param entity: The properties for the table entity.
         :type entity: Union[TableEntity, dict[str,str]]
-        :return: TableEntity mapping str to azure.data.tables.EntityProperty
-        :rtype: ~azure.data.tables.TableEntity
+        :return: Dictionary mapping operation metadata returned from the service
+        :rtype: dict[str,str]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
 
         if "PartitionKey" in entity and "RowKey" in entity:
             entity = _add_entity_properties(entity)
-            # TODO: Remove - and run test to see what happens with the service
         else:
             raise ValueError('PartitionKey and RowKey were not provided in entity')
         try:
-            inserted_entity = self._client.table.insert_entity(
+            metadata, _ = self._client.table.insert_entity(
                 table=self.table_name,
                 table_entity_properties=entity,
-                **kwargs
-            )
-            properties = _convert_to_entity(inserted_entity)
-            return properties
+                cls=kwargs.pop('cls', _return_headers_and_deserialized),
+                **kwargs)
+            return _trim_service_metadata(metadata)
         except ResourceNotFoundError as error:
             _process_table_error(error)
 
     @distributed_trace
     def update_entity(  # pylint:disable=R1710
             self,
-            entity,  # type: Union[TableEntity, dict[str,str]]
+            entity,  # type: Union[TableEntity, Dict[str,str]]
             mode=UpdateMode.MERGE,  # type: UpdateMode
             **kwargs  # type: Any
     ):
-        # type: (...) -> None
+        # type: (...) -> Dict[str,str]
         """Update entity in a table.
 
         :param entity: The properties for the table entity.
@@ -294,33 +294,41 @@ def update_entity(  # pylint:disable=R1710
         :keyword str row_key: The row key of the entity.
         :keyword str etag: Etag of the entity
         :keyword ~azure.core.MatchConditions match_condition: MatchCondition
-        :return: None
-        :rtype: None
+        :return: Dictionary mapping operation metadata returned from the service
+        :rtype: dict[str,str]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
 
-        if_match, if_not_match = _get_match_headers(kwargs=dict(kwargs, etag=kwargs.pop('etag', None),
+        if_match, _ = _get_match_headers(kwargs=dict(kwargs, etag=kwargs.pop('etag', None),
                                                                 match_condition=kwargs.pop('match_condition', None)),
                                                     etag_param='etag', match_param='match_condition')
 
         partition_key = entity['PartitionKey']
         row_key = entity['RowKey']
         entity = _add_entity_properties(entity)
         try:
+            metadata = None
             if mode is UpdateMode.REPLACE:
-                self._client.table.update_entity(
+                metadata, _ = self._client.table.update_entity(
                     table=self.table_name,
                     partition_key=partition_key,
                     row_key=row_key,
                     table_entity_properties=entity,
-                    if_match=if_match or if_not_match or "*",
+                    if_match=if_match or "*",
+                    cls=kwargs.pop('cls', _return_headers_and_deserialized),
                     **kwargs)
             elif mode is UpdateMode.MERGE:
-                self._client.table.merge_entity(table=self.table_name, partition_key=partition_key,
-                                                row_key=row_key, if_match=if_match or if_not_match or "*",
-                                                table_entity_properties=entity, **kwargs)
+                metadata, _ = self._client.table.merge_entity(
+                    table=self.table_name,
+                    partition_key=partition_key,
+                    row_key=row_key,
+                    if_match=if_match or "*",
+                    table_entity_properties=entity,
+                    cls=kwargs.pop('cls', _return_headers_and_deserialized),
+                    **kwargs)
             else:
                 raise ValueError('Mode type is not supported')
+            return _trim_service_metadata(metadata)
         except HttpResponseError as error:
             _process_table_error(error)
 
@@ -395,15 +403,15 @@ def get_entity(
             row_key,  # type: str
             **kwargs  # type: Any
     ):
-        # type: (...) -> TableEntity
+        # type: (...) -> Dict[str,str]
         """Queries entities in a table.
 
         :param partition_key: The partition key of the entity.
         :type partition_key: str
         :param row_key: The row key of the entity.
         :type row_key: str
-        :return: Entity mapping str to azure.data.tables.EntityProperty
-        :rtype: ~azure.data.tables.TableEntity
+        :return: Dictionary mapping operation metadata returned from the service
+        :rtype: dict[str,str]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
         try:
@@ -420,19 +428,19 @@ def get_entity(
     @distributed_trace
     def upsert_entity(  # pylint:disable=R1710
             self,
-            entity,  # type: Union[TableEntity, dict[str,str]]
+            entity,  # type: Union[TableEntity, Dict[str,str]]
             mode=UpdateMode.MERGE,  # type: UpdateMode
             **kwargs  # type: Any
     ):
-        # type: (...) -> None
+        # type: (...) -> Dict[str,str]
         """Update/Merge or Insert entity into table.
 
         :param entity: The properties for the table entity.
         :type entity: Union[TableEntity, dict[str,str]]
         :param mode: Merge or Replace and Insert on fail
         :type mode: ~azure.data.tables.UpdateMode
-        :return: None
-        :rtype: None
+        :return: Dictionary mapping operation metadata returned from the service
+        :rtype: dict[str,str]
         :raises: ~azure.core.exceptions.HttpResponseError
         """
 
@@ -441,25 +449,30 @@ def upsert_entity(  # pylint:disable=R1710
         entity = _add_entity_properties(entity)
 
         try:
+            metadata = None
             if mode is UpdateMode.MERGE:
-                self._client.table.merge_entity(
+                metadata, _ = self._client.table.merge_entity(
                     table=self.table_name,
                     partition_key=partition_key,
                     row_key=row_key,
                     table_entity_properties=entity,
+                    cls=kwargs.pop('cls', _return_headers_and_deserialized),
                     **kwargs
                 )
             elif mode is UpdateMode.REPLACE:
-                self._client.table.update_entity(
+                metadata, _ = self._client.table.update_entity(
                     table=self.table_name,
                     partition_key=partition_key,
                     row_key=row_key,
                     table_entity_properties=entity,
+                    cls=kwargs.pop('cls', _return_headers_and_deserialized),
                     **kwargs)
             else:
-                raise ValueError('Mode type is not supported')
+                raise ValueError("""Update mode {} is not supported.
+                    For a list of supported modes see the UpdateMode enum""".format(mode))
+            return _trim_service_metadata(metadata)
         except ResourceNotFoundError:
-            self.create_entity(
+            return self.create_entity(
                 partition_key=partition_key,
                 row_key=row_key,
                 table_entity_properties=entity,