release-for-mgmt-cosmosdb-0.16.0 (Azure#12842)

Co-authored-by: Azure SDK Bot <[email protected]>

Author: qiaozha

sdk/cosmos/azure-cosmos/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 4.0.1 (Unreleased)
+
+- Added deprecation warning for "lazy" indexing mode. The backend no longer allows creating containers with this mode and will set them to consistent instead.
+
+**New features**
+- Added  the ability to set the analytical storage TTL when creating a new container.
+
+**Bug fixes**
+- Fixed support for dicts as inputs for get_client APIs.
+- Fixed Python 2/3 compatibility in query iterators.
+- Fixed type hint error. Issue #12570 - Thanks @sl-sandy.
+- Fixed bug where options headers were not added to upsert_item function. Issue #11791 - thank you @aalapatirvbd.
+- Fixed error raised when a non string ID is used in an item. It now raises TypeError rather than AttributeError. Issue #11793 - thank you @Rabbit994.
+
+
 ## 4.0.0 (2020-05-20)
 
 - Stable release.
@@ -235,4 +250,3 @@ Version 4.0.0b1 is the first preview of our efforts to create a user-friendly an
 
 - Supports proxy connection
 
-

sdk/cosmos/azure-cosmos/azure/cosmos/_cosmos_client_connection.py

@@ -31,6 +31,7 @@
 from urllib3.util.retry import Retry
 from azure.core.paging import ItemPaged  # type: ignore
 from azure.core import PipelineClient  # type: ignore
+from azure.core.exceptions import raise_with_traceback  # type: ignore
 from azure.core.pipeline.policies import (  # type: ignore
     HTTPPolicy,
     ContentDecodePolicy,
@@ -2480,11 +2481,14 @@ def __CheckAndUnifyQueryFormat(self, query_body):
     def __ValidateResource(resource):
         id_ = resource.get("id")
         if id_:
-            if id_.find("/") != -1 or id_.find("\\") != -1 or id_.find("?") != -1 or id_.find("#") != -1:
-                raise ValueError("Id contains illegal chars.")
-
-            if id_[-1] == " ":
-                raise ValueError("Id ends with a space.")
+            try:
+                if id_.find("/") != -1 or id_.find("\\") != -1 or id_.find("?") != -1 or id_.find("#") != -1:
+                    raise ValueError("Id contains illegal chars.")
+
+                if id_[-1] == " ":
+                    raise ValueError("Id ends with a space.")
+            except AttributeError:
+                raise_with_traceback(TypeError, message="Id type must be a string.")
 
     # Adds the partition key to options
     def _AddPartitionKey(self, collection_link, document, options):

sdk/cosmos/azure-cosmos/azure/cosmos/_execution_context/base_execution_context.py

@@ -81,7 +81,7 @@ def __iter__(self):
         """Returns itself as an iterator"""
         return self
 
-    def next(self):
+    def __next__(self):
         """Return the next query result.
 
         :return: The next query result.
@@ -101,10 +101,6 @@ def next(self):
 
         return self._buffer.popleft()
 
-    def __next__(self):
-        # supports python 3 iterator
-        return self.next()
-
     def _fetch_items_helper_no_retries(self, fetch_function):
         """Fetches more items and doesn't retry on failure
 
@@ -138,6 +134,8 @@ def callback():
 
         return _retry_utility.Execute(self._client, self._client._global_endpoint_manager, callback)
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _DefaultQueryExecutionContext(_QueryExecutionContextBase):
     """

sdk/cosmos/azure-cosmos/azure/cosmos/_execution_context/document_producer.py

@@ -64,18 +64,13 @@ def fetch_fn(options):
 
         self._ex_context = _DefaultQueryExecutionContext(client, self._options, fetch_fn)
 
-    def get_target_range(self):
-        """Returns the target partition key range.
-            :return:
-                Target partition key range.
-            :rtype: dict
-        """
-        return self._partition_key_target_range
+    def __lt__(self, other):
+        return self._doc_producer_comp.compare(self, other) < 0
 
     def __iter__(self):
         return self
 
-    def next(self):
+    def __next__(self):
         """
         :return: The next result item.
         :rtype: dict
@@ -89,9 +84,13 @@ def next(self):
 
         return next(self._ex_context)
 
-    def __next__(self):
-        # supports python 3 iterator
-        return self.next()
+    def get_target_range(self):
+        """Returns the target partition key range.
+            :return:
+                Target partition key range.
+            :rtype: dict
+        """
+        return self._partition_key_target_range
 
     def peek(self):
         """
@@ -106,8 +105,7 @@ def peek(self):
 
         return self._cur_item
 
-    def __lt__(self, other):
-        return self._doc_producer_comp.compare(self, other) < 0
+    next = __next__  # Python 2 compatibility.
 
 
 def _compare_helper(a, b):

sdk/cosmos/azure-cosmos/azure/cosmos/_execution_context/endpoint_component.py

@@ -44,23 +44,23 @@ def __init__(self, execution_context):
     def __iter__(self):
         return self
 
-    def next(self):
-        return next(self._execution_context)
-
     def __next__(self):
         # supports python 3 iterator
-        return self.next()
+        return next(self._execution_context)
+
+    next = __next__  # Python 2 compatibility.
 
 
 class _QueryExecutionOrderByEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling an order by query.
 
     For each processed orderby result it returns 'payload' item of the result.
     """
-
-    def next(self):
+    def __next__(self):
         return next(self._execution_context)["payload"]
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _QueryExecutionTopEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling top query.
@@ -72,13 +72,15 @@ def __init__(self, execution_context, top_count):
         super(_QueryExecutionTopEndpointComponent, self).__init__(execution_context)
         self._top_count = top_count
 
-    def next(self):
+    def __next__(self):
         if self._top_count > 0:
             res = next(self._execution_context)
             self._top_count -= 1
             return res
         raise StopIteration
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _QueryExecutionDistinctOrderedEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling distinct query.
@@ -89,13 +91,15 @@ def __init__(self, execution_context):
         super(_QueryExecutionDistinctOrderedEndpointComponent, self).__init__(execution_context)
         self.last_result = None
 
-    def next(self):
+    def __next__(self):
         res = next(self._execution_context)
         while self.last_result == res:
             res = next(self._execution_context)
         self.last_result = res
         return res
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _QueryExecutionDistinctUnorderedEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling distinct query.
@@ -119,14 +123,14 @@ def make_hash(self, value):
 
         return tuple(frozenset(sorted(new_value.items())))
 
-    def next(self):
+    def __next__(self):
         res = next(self._execution_context)
 
         json_repr = json.dumps(self.make_hash(res))
         if six.PY3:
             json_repr = json_repr.encode("utf-8")
 
-        hash_object = hashlib.sha1(json_repr)
+        hash_object = hashlib.sha1(json_repr)   # nosec
         hashed_result = hash_object.hexdigest()
 
         while hashed_result in self.last_result:
@@ -135,11 +139,13 @@ def next(self):
             if six.PY3:
                 json_repr = json_repr.encode("utf-8")
 
-            hash_object = hashlib.sha1(json_repr)
+            hash_object = hashlib.sha1(json_repr)   # nosec
             hashed_result = hash_object.hexdigest()
         self.last_result.add(hashed_result)
         return res
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _QueryExecutionOffsetEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling offset query.
@@ -150,7 +156,7 @@ def __init__(self, execution_context, offset_count):
         super(_QueryExecutionOffsetEndpointComponent, self).__init__(execution_context)
         self._offset_count = offset_count
 
-    def next(self):
+    def __next__(self):
         while self._offset_count > 0:
             res = next(self._execution_context)
             if res is not None:
@@ -159,6 +165,8 @@ def next(self):
                 raise StopIteration
         return next(self._execution_context)
 
+    next = __next__  # Python 2 compatibility.
+
 
 class _QueryExecutionAggregateEndpointComponent(_QueryExecutionEndpointComponent):
     """Represents an endpoint in handling aggregate query.
@@ -183,7 +191,7 @@ def __init__(self, execution_context, aggregate_operators):
             elif operator == "Sum":
                 self._local_aggregators.append(_SumAggregator())
 
-    def next(self):
+    def __next__(self):
         for res in self._execution_context:
             for item in res:
                 for operator in self._local_aggregators:
@@ -200,3 +208,5 @@ def next(self):
             self._result_index += 1
             return res
         raise StopIteration
+
+    next = __next__  # Python 2 compatibility.

sdk/cosmos/azure-cosmos/azure/cosmos/_execution_context/execution_dispatcher.py

@@ -68,7 +68,7 @@ def __init__(self, client, resource_link, query, options, fetch_function):
         self._query = query
         self._fetch_function = fetch_function
 
-    def next(self):
+    def __next__(self):
         """Returns the next query result.
 
         :return: The next query result.
@@ -128,6 +128,9 @@ def _create_pipelined_execution_context(self, query_execution_info):
         return _PipelineExecutionContext(self._client, self._options, execution_context_aggregator,
                                          query_execution_info)
 
+    next = __next__  # Python 2 compatibility.
+
+
 class _PipelineExecutionContext(_QueryExecutionContextBase):  # pylint: disable=abstract-method
 
     DEFAULT_PAGE_SIZE = 1000
@@ -171,7 +174,7 @@ def __init__(self, client, options, execution_context, query_execution_info):
             else:
                 self._endpoint = endpoint_component._QueryExecutionDistinctUnorderedEndpointComponent(self._endpoint)
 
-    def next(self):
+    def __next__(self):
         """Returns the next query result.
 
         :return: The next query result.
@@ -201,3 +204,5 @@ def fetch_next_block(self):
                 # no more results
                 break
         return results
+
+    next = __next__  # Python 2 compatibility.

sdk/cosmos/azure-cosmos/azure/cosmos/_execution_context/multi_execution_aggregator.py

@@ -102,7 +102,7 @@ def __init__(self, client, resource_link, query, options, partitioned_query_ex_i
             except StopIteration:
                 continue
 
-    def next(self):
+    def __next__(self):
         """Returns the next result
 
         :return: The next result.
@@ -157,3 +157,5 @@ def _get_target_parition_key_range(self):
         return self._routing_provider.get_overlapping_ranges(
             self._resource_link, [routing_range.Range.ParseFromDict(range_as_dict) for range_as_dict in query_ranges]
         )
+
+    next = __next__  # Python 2 compatibility.

sdk/cosmos/azure-cosmos/azure/cosmos/_version.py

@@ -19,4 +19,4 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-VERSION = "4.0.0"
+VERSION = "4.0.1"

sdk/cosmos/azure-cosmos/azure/cosmos/container.py

@@ -282,7 +282,7 @@ def query_items_change_feed(
     def query_items(
         self,
         query,  # type: str
-        parameters=None,  # type: Optional[List[str]]
+        parameters=None,  # type: Optional[List[Dict[str, object]]]
         partition_key=None,  # type: Optional[Any]
         enable_cross_partition_query=None,  # type: Optional[bool]
         max_item_count=None,  # type: Optional[int]
@@ -299,7 +299,9 @@ def query_items(
         the WHERE clause.
 
         :param query: The Azure Cosmos DB SQL query to execute.
-        :param parameters: Optional array of parameters to the query. Ignored if no query is provided.
+        :param parameters: Optional array of parameters to the query.
+            Each parameter is a dict() with 'name' and 'value' keys.
+            Ignored if no query is provided.
         :param partition_key: Specifies the partition key value for the item.
         :param enable_cross_partition_query: Allows sending of more than one request to
             execute the query in the Azure Cosmos DB service.
@@ -449,7 +451,11 @@ def upsert_item(
             request_options["postTriggerInclude"] = post_trigger_include
 
         result = self.client_connection.UpsertItem(
-            database_or_container_link=self.container_link, document=body, **kwargs)
+            database_or_container_link=self.container_link,
+            document=body,
+            options=request_options,
+            **kwargs
+        )
         if response_hook:
             response_hook(self.client_connection.last_response_headers, result)
         return result

sdk/cosmos/azure-cosmos/azure/cosmos/cosmos_client.py

@@ -22,7 +22,7 @@
 """Create, read, and delete databases in the Azure Cosmos DB SQL API service.
 """
 
-from typing import Any, Dict, Mapping, Optional, Union, cast, Iterable, List  # pylint: disable=unused-import
+from typing import Any, Dict, Optional, Union, cast, Iterable, List  # pylint: disable=unused-import
 
 import six
 from azure.core.tracing.decorator import distributed_trace  # type: ignore
@@ -320,10 +320,11 @@ def get_database_client(self, database):
         """
         if isinstance(database, DatabaseProxy):
             id_value = database.id
-        elif isinstance(database, Mapping):
-            id_value = database["id"]
         else:
-            id_value = database
+            try:
+                id_value = database["id"]
+            except TypeError:
+                id_value = database
 
         return DatabaseProxy(self.client_connection, id_value)