Address comments

sdk/cosmos/azure-cosmos/azure/cosmos/_global_partition_endpoint_manager_circuit_breaker.py

@@ -23,7 +23,7 @@
 """
 from typing import TYPE_CHECKING, Optional
 
-from azure.cosmos.partition_key import get_partition_key_from_definition
+from azure.cosmos.partition_key import _get_partition_key_from_partition_key_definition
 from azure.cosmos._global_partition_endpoint_manager_circuit_breaker_core import \
     _GlobalPartitionEndpointManagerForCircuitBreakerCore
 
@@ -62,7 +62,7 @@ def create_pk_range_wrapper(self, request: RequestObject) -> Optional[PartitionK
         # get relevant information from container cache to get the overlapping ranges
         container_link = properties["container_link"]
         partition_key_definition = properties["partitionKey"]
-        partition_key = get_partition_key_from_definition(partition_key_definition)
+        partition_key = _get_partition_key_from_partition_key_definition(partition_key_definition)
 
         if HttpHeaders.PartitionKey in request.headers:
             partition_key_value = request.headers[HttpHeaders.PartitionKey]

sdk/cosmos/azure-cosmos/azure/cosmos/_utils.py

@@ -132,3 +132,17 @@ def verify_exclusive_arguments(
     if len(keys_in_kwargs) > 1:
         raise ValueError(f"{format_list_with_and(keys_in_kwargs)} are exclusive parameters, "
                          f"please only set one of them.")
+
+def valid_key_value_exist(
+        kwargs: Dict[str, Any],
+        key: str,
+        invalid_value: Any = None) -> bool:
+    """Check if a valid key and value exists in kwargs. By default, it checks if the value is not None.
+
+    :param Dict[str, Any] kwargs: The dictionary of keyword arguments.
+    :param str key: The key to check.
+    :param Any invalid_value: The value that is considered invalid. Default is None.
+    :return: True if the key exists and its value is not None, False otherwise.
+    :rtype: bool
+    """
+    return key in kwargs and kwargs[key] is not invalid_value

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_container.py

@@ -53,7 +53,7 @@
     _return_undefined_or_empty_partition_key,
     _Empty,
     _Undefined,
-    get_partition_key_from_definition
+    _get_partition_key_from_partition_key_definition
 )
 
 __all__ = ("ContainerProxy",)
@@ -155,7 +155,7 @@ async def _get_epk_range_for_partition_key(
             feed_options: Optional[Dict[str, Any]] = None) -> Range:
         container_properties = await self._get_properties_with_options(feed_options)
         partition_key_definition = container_properties["partitionKey"]
-        partition_key = get_partition_key_from_definition(partition_key_definition)
+        partition_key = _get_partition_key_from_partition_key_definition(partition_key_definition)
 
         return partition_key._get_epk_range_for_partition_key(partition_key_value)
 
@@ -657,24 +657,24 @@ def query_items(
         feed_options = _build_options(kwargs)
 
         # Update 'feed_options' from 'kwargs'
-        if "max_item_count" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "max_item_count"):
             feed_options["maxItemCount"] = kwargs.pop("max_item_count")
-        if "populate_query_metrics" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "populate_query_metrics"):
             feed_options["populateQueryMetrics"] = kwargs.pop("populate_query_metrics")
-        if "populate_index_metrics" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "populate_index_metrics"):
             feed_options["populateIndexMetrics"] = kwargs.pop("populate_index_metrics")
-        if "enable_scan_in_query" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "enable_scan_in_query"):
             feed_options["enableScanInQuery"] = kwargs.pop("enable_scan_in_query")
-        if "max_integrated_cache_staleness_in_ms" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "max_integrated_cache_staleness_in_ms"):
             max_integrated_cache_staleness_in_ms = kwargs.pop("max_integrated_cache_staleness_in_ms")
             validate_cache_staleness_value(max_integrated_cache_staleness_in_ms)
             feed_options["maxIntegratedCacheStaleness"] = max_integrated_cache_staleness_in_ms
-        if "continuation_token_limit" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "continuation_token_limit"):
             feed_options["responseContinuationTokenLimitInKb"] = kwargs.pop("continuation_token_limit")
         feed_options["correlatedActivityId"] = GenerateGuidId()
 
         # Set query with 'query' and 'parameters' from kwargs
-        if "parameters" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "parameters"):
             query = {"query": kwargs.pop("query", None), "parameters": kwargs.pop("parameters", None)}
         else:
             query = kwargs.pop("query", None)
@@ -684,10 +684,12 @@ def query_items(
 
         utils.verify_exclusive_arguments(["feed_range", "partition_key"], **kwargs)
         partition_key = None
-        if "feed_range" not in kwargs and "partition_key" in kwargs:
-            partition_key_value = kwargs.pop("partition_key")
-            feed_options["partitionKey"] = self._set_partition_key(partition_key_value)
-        else:
+        # If 'partition_key' is provided, set 'partitionKey' in 'feed_options'
+        if utils.valid_key_value_exist(kwargs, "partition_key"):
+            partition_key = kwargs.pop("partition_key")
+            feed_options["partitionKey"] = self._set_partition_key(partition_key)
+        # If 'partition_key' or 'feed_range' is not provided, set 'enableCrossPartitionQuery' to True
+        elif not utils.valid_key_value_exist(kwargs, "feed_range"):
             feed_options["enableCrossPartitionQuery"] = True
 
         # Set 'response_hook'

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_cosmos_client_connection_async.py

@@ -2962,7 +2962,7 @@ def __GetBodiesFromQueryResult(result: Dict[str, Any]) -> List[Dict[str, Any]]:
             # check if query has prefix partition key
             partition_key_value = options["partitionKey"]
             partition_key_obj = _build_partition_key_from_properties(container_property)
-            if partition_key_obj.is_prefix_partition_key(partition_key_value):
+            if partition_key_obj._is_prefix_partition_key(partition_key_value):
                 req_headers.pop(http_constants.HttpHeaders.PartitionKey, None)
                 partition_key_value = cast(_SequentialPartitionKeyType, partition_key_value)
                 feed_range_epk = partition_key_obj._get_epk_range_for_prefix_partition_key(partition_key_value)

sdk/cosmos/azure-cosmos/azure/cosmos/aio/_global_partition_endpoint_manager_circuit_breaker_async.py

@@ -23,7 +23,7 @@
 """
 from typing import TYPE_CHECKING, Optional
 
-from azure.cosmos.partition_key import get_partition_key_from_definition
+from azure.cosmos.partition_key import _get_partition_key_from_partition_key_definition
 from azure.cosmos._global_partition_endpoint_manager_circuit_breaker_core import \
     _GlobalPartitionEndpointManagerForCircuitBreakerCore
 from azure.cosmos._routing.routing_range import PartitionKeyRangeWrapper, Range
@@ -60,7 +60,7 @@ async def create_pk_range_wrapper(self, request: RequestObject) -> Optional[Part
         # get relevant information from container cache to get the overlapping ranges
         container_link = properties["container_link"]
         partition_key_definition = properties["partitionKey"]
-        partition_key = get_partition_key_from_definition(partition_key_definition)
+        partition_key = _get_partition_key_from_partition_key_definition(partition_key_definition)
 
         if HttpHeaders.PartitionKey in request.headers:
             partition_key_value = request.headers[HttpHeaders.PartitionKey]

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

@@ -834,37 +834,37 @@ def query_items(  # pylint:disable=docstring-missing-param
         container_properties = self._get_properties_with_options(feed_options)
 
         # Update 'feed_options' from 'kwargs'
-        if "enable_cross_partition_query" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "enable_cross_partition_query"):
             feed_options["enableCrossPartitionQuery"] = kwargs.pop("enable_cross_partition_query")
-        if "max_item_count" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "max_item_count"):
             feed_options["maxItemCount"] = kwargs.pop("max_item_count")
-        if "populate_query_metrics" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "populate_query_metrics"):
             feed_options["populateQueryMetrics"] = kwargs.pop("populate_query_metrics")
-        if "populate_index_metrics" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "populate_index_metrics"):
             feed_options["populateIndexMetrics"] = kwargs.pop("populate_index_metrics")
-        if "enable_scan_in_query" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "enable_scan_in_query"):
             feed_options["enableScanInQuery"] = kwargs.pop("enable_scan_in_query")
-        if "max_integrated_cache_staleness_in_ms" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "max_integrated_cache_staleness_in_ms"):
             max_integrated_cache_staleness_in_ms = kwargs.pop("max_integrated_cache_staleness_in_ms")
             validate_cache_staleness_value(max_integrated_cache_staleness_in_ms)
             feed_options["maxIntegratedCacheStaleness"] = max_integrated_cache_staleness_in_ms
-        if "continuation_token_limit" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "continuation_token_limit"):
             feed_options["responseContinuationTokenLimitInKb"] = kwargs.pop("continuation_token_limit")
         feed_options["correlatedActivityId"] = GenerateGuidId()
         feed_options["containerRID"] = self.__get_client_container_caches()[self.container_link]["_rid"]
 
         # Set query with 'query' and 'parameters' from kwargs
-        if "parameters" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "parameters"):
             query = {"query": kwargs.pop("query", None), "parameters": kwargs.pop("parameters", None)}
         else:
             query = kwargs.pop("query", None)
 
-        # Set range filters for query. Options are either 'feed_range' or 'partition_key'
+        # Set range filters for a query. Options are either 'feed_range' or 'partition_key'
         utils.verify_exclusive_arguments(["feed_range", "partition_key"], **kwargs)
-        if "feed_range" not in kwargs and "partition_key" in kwargs:
+        if utils.valid_key_value_exist(kwargs, "partition_key"):
             partition_key_value = self._set_partition_key(kwargs.pop("partition_key"))
             partition_key_obj = _build_partition_key_from_properties(container_properties)
-            if partition_key_obj.is_prefix_partition_key(partition_key_value):
+            if partition_key_obj._is_prefix_partition_key(partition_key_value):
                 kwargs["prefix_partition_key_object"] = partition_key_obj
                 kwargs["prefix_partition_key_value"] = cast(_SequentialPartitionKeyType, partition_key_value)
             else:

sdk/cosmos/azure-cosmos/azure/cosmos/partition_key.py

@@ -214,7 +214,7 @@ def _get_epk_range_for_partition_key(
             self,
             pk_value: _PartitionKeyType
     ) -> _Range:
-        if self.is_prefix_partition_key(pk_value):
+        if self._is_prefix_partition_key(pk_value):
             return self._get_epk_range_for_prefix_partition_key(
                 cast(_SequentialPartitionKeyType, pk_value))
 
@@ -369,7 +369,7 @@ def _get_effective_partition_key_for_multi_hash_partitioning_v2(
 
         return ''.join(sb).upper()
 
-    def is_prefix_partition_key(
+    def _is_prefix_partition_key(
             self,
             partition_key: _PartitionKeyType) -> bool:  # pylint: disable=line-too-long
         if self.kind != _PartitionKeyKind.MULTI_HASH:
@@ -516,7 +516,7 @@ def _write_for_binary_encoding(
     elif isinstance(value, _Undefined):
         binary_writer.write(bytes([_PartitionKeyComponentType.Undefined]))
 
-def get_partition_key_from_definition(
+def _get_partition_key_from_partition_key_definition(
     partition_key_definition: Union[Dict[str, Any], "PartitionKey"]
 ) -> "PartitionKey":
     """Internal method to create a PartitionKey instance from a dictionary or PartitionKey object.
@@ -533,4 +533,4 @@ def get_partition_key_from_definition(
 
 def _build_partition_key_from_properties(container_properties: Dict[str, Any]) -> PartitionKey:
     partition_key_definition = container_properties["partitionKey"]
-    return get_partition_key_from_definition(partition_key_definition)
+    return _get_partition_key_from_partition_key_definition(partition_key_definition)

sdk/cosmos/azure-cosmos/samples/examples.py

@@ -145,7 +145,6 @@
 for feed_range in container.read_feed_ranges():
     for queried_item in container.query_items(
         query='SELECT * FROM c',
-        enable_cross_partition_query=True,
         feed_range=feed_range,
     ):
         print(json.dumps(queried_item, indent=True))

sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation.py

@@ -7,7 +7,7 @@
 
 import azure.cosmos.cosmos_client as cosmos_client
 import test_config
-from azure.cosmos.partition_key import PartitionKey, get_partition_key_from_definition
+from azure.cosmos.partition_key import PartitionKey, _get_partition_key_from_partition_key_definition
 from azure.cosmos.container import get_epk_range_for_partition_key
 
 @pytest.mark.cosmosEmulator
@@ -249,7 +249,7 @@ def _get_properties_override():
                                                                "in the partition key definition.")
 
             # Create a PartitionKey instance from the definition and validate
-            partition_key_instance = get_partition_key_from_definition(partition_key_definition)
+            partition_key_instance = _get_partition_key_from_partition_key_definition(partition_key_definition)
             assert partition_key_instance.kind == "Hash", "Partition key kind mismatch."
             assert partition_key_instance.version == 1, "Partition key version mismatch."
 

sdk/cosmos/azure-cosmos/tests/test_changefeed_partition_key_variation_async.py

@@ -3,7 +3,7 @@
 import pytest
 from azure.cosmos.aio import CosmosClient
 import test_config
-from azure.cosmos.partition_key import PartitionKey, get_partition_key_from_definition
+from azure.cosmos.partition_key import PartitionKey, _get_partition_key_from_partition_key_definition
 
 @pytest.mark.cosmosEmulator
 @pytest.mark.asyncio
@@ -248,7 +248,7 @@ async def _get_properties_override():
                                                                "in the partition key definition.")
 
             # Create a PartitionKey instance from the definition and validate
-            partition_key_instance = get_partition_key_from_definition(partition_key_definition)
+            partition_key_instance = _get_partition_key_from_partition_key_definition(partition_key_definition)
             assert partition_key_instance.kind == "Hash", "Partition key kind mismatch."
             assert partition_key_instance.version == 1, "Partition key version mismatch."
 

sdk/cosmos/azure-cosmos/tests/test_query_feed_range.py

@@ -64,7 +64,6 @@ def test_query_with_feed_range_for_all_partitions(self, container_id):
         for feed_range in iter_feed_ranges:
             items = list(container.query_items(
                 query=query,
-                enable_cross_partition_query=True,
                 feed_range=feed_range
             ))
             add_all_pk_values_to_set(items, actual_pk_values)
@@ -82,7 +81,6 @@ def test_query_with_feed_range_for_partition_key(self, container_id):
             feed_range = container.feed_range_from_partition_key(pk_value)
             items = list(container.query_items(
                 query=query,
-                enable_cross_partition_query=True,
                 feed_range=feed_range
             ))
             add_all_pk_values_to_set(items, actual_pk_values)
@@ -99,7 +97,6 @@ def test_query_with_both_feed_range_and_partition_key(self, container_id):
         with pytest.raises(ValueError) as e:
             list(container.query_items(
                 query=query,
-                enable_cross_partition_query=True,
                 feed_range=feed_range,
                 partition_key=partition_key
             ))
@@ -121,7 +118,6 @@ def test_query_with_feed_range_for_a_full_range(self, container_id):
         feed_range = test_config.create_feed_range_in_dict(new_range)
         items = list(container.query_items(
             query=query,
-            enable_cross_partition_query=True,
             feed_range=feed_range
         ))
         add_all_pk_values_to_set(items, actual_pk_values)