Replace remaining hardcoded kwargs and options strings with constants

Co-authored-by: bambriz <[email protected]>

Author: Copilot

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

@@ -1235,7 +1235,7 @@ def fetch_fn(options: Mapping[str, Any]) -> Tuple[List[Dict[str, Any]], CaseInse
             if collection_link in self.__container_properties_cache:
                 # TODO: This will make deep copy. Check if this has any performance impact
                 new_options = dict(options)
-                new_options["containerRID"] = self.__container_properties_cache[collection_link]["_rid"]
+                new_options[Constants.InternalOptions.CONTAINER_RID] = self.__container_properties_cache[collection_link]["_rid"]
                 options = new_options
             return self.__QueryFeed(
                 path,
@@ -3186,8 +3186,8 @@ def __GetBodiesFromQueryResult(result: Dict[str, Any]) -> List[Dict[str, Any]]:
             change_feed_state: Optional[ChangeFeedState] = options.get("changeFeedState")
             if change_feed_state is not None:
                 feed_options = {}
-                if 'excludedLocations' in options:
-                    feed_options['excludedLocations'] = options['excludedLocations']
+                if Constants.InternalOptions.EXCLUDED_LOCATIONS in options:
+                    feed_options[Constants.InternalOptions.EXCLUDED_LOCATIONS] = options[Constants.InternalOptions.EXCLUDED_LOCATIONS]
                 change_feed_state.populate_request_headers(self._routing_map_provider, headers, feed_options)
                 request_params.headers = headers
 
@@ -3394,9 +3394,9 @@ def _AddPartitionKey(
         # If the collection doesn't have a partition key definition, skip it as it's a legacy collection
         if partitionKeyDefinition:
             # If the user has passed in the partitionKey in options use that else extract it from the document
-            if "partitionKey" not in options:
+            if Constants.InternalOptions.PARTITION_KEY not in options:
                 partitionKeyValue = self._ExtractPartitionKey(partitionKeyDefinition, document)
-                new_options["partitionKey"] = partitionKeyValue
+                new_options[Constants.InternalOptions.PARTITION_KEY] = partitionKeyValue
         return new_options
 
     # Extracts the partition key from the document using the partitionKey definition

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

@@ -439,7 +439,7 @@ def read_all_items(
             feed_options[
             Constants.InternalOptions.CONTAINER_RID
         ] = self.__get_client_container_caches()[self.container_link]["_rid"]
-        kwargs["containerProperties"] = self._get_properties_with_options
+        kwargs[Constants.Kwargs.CONTAINER_PROPERTIES] = self._get_properties_with_options
 
         items = self.client_connection.ReadItems(
             collection_link=self.container_link, feed_options=feed_options, response_hook=response_hook, **kwargs
@@ -484,23 +484,23 @@ async def read_items(
 
 
         if session_token is not None:
-            kwargs['session_token'] = session_token
+            kwargs[Constants.Kwargs.SESSION_TOKEN] = session_token
         if initial_headers is not None:
-            kwargs['initial_headers'] = initial_headers
+            kwargs[Constants.Kwargs.INITIAL_HEADERS] = initial_headers
         if consistency_level is not None:
-            kwargs['consistencyLevel'] = consistency_level
+            kwargs[Constants.Kwargs.CONSISTENCY_LEVEL] = consistency_level
         if excluded_locations is not None:
-            kwargs['excludedLocations'] = excluded_locations
+            kwargs[Constants.Kwargs.EXCLUDED_LOCATIONS] = excluded_locations
         if priority is not None:
-            kwargs['priority'] = priority
+            kwargs[Constants.Kwargs.PRIORITY] = priority
         if throughput_bucket is not None:
-            kwargs["throughput_bucket"] = throughput_bucket
+            kwargs[Constants.Kwargs.THROUGHPUT_BUCKET] = throughput_bucket
 
         kwargs['max_concurrency'] = max_concurrency
-        kwargs["containerProperties"] = self._get_properties_with_options
+        kwargs[Constants.Kwargs.CONTAINER_PROPERTIES] = self._get_properties_with_options
         query_options = _build_options(kwargs)
         await self._get_properties_with_options(query_options)
-        query_options["enableCrossPartitionQuery"] = True
+        query_options[Constants.InternalOptions.ENABLE_CROSS_PARTITION_QUERY] = True
 
         return await self.client_connection.read_items(
             collection_link=self.container_link,
@@ -774,7 +774,7 @@ def query_items(
             query = kwargs.pop("query", None)
 
         # Set method to get/cache container properties
-        kwargs["containerProperties"] = self._get_properties_with_options
+        kwargs[Constants.Kwargs.CONTAINER_PROPERTIES] = self._get_properties_with_options
 
         utils.verify_exclusive_arguments(["feed_range", "partition_key"], **kwargs)
         partition_key = None

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

@@ -2343,7 +2343,7 @@ def QueryItems(
         async def fetch_fn(options: Mapping[str, Any]) -> Tuple[List[Dict[str, Any]], CaseInsensitiveDict]:
             await kwargs["containerProperties"](options)
             new_options = dict(options)
-            new_options["containerRID"] = self.__container_properties_cache[database_or_container_link]["_rid"]
+            new_options[Constants.InternalOptions.CONTAINER_RID] = self.__container_properties_cache[database_or_container_link]["_rid"]
             return (
                 await self.__QueryFeed(
                     path,
@@ -2440,7 +2440,7 @@ def _QueryChangeFeed(
         async def fetch_fn(options: Mapping[str, Any]) -> Tuple[List[Dict[str, Any]], CaseInsensitiveDict]:
             if collection_link in self.__container_properties_cache:
                 new_options = dict(options)
-                new_options["containerRID"] = self.__container_properties_cache[collection_link]["_rid"]
+                new_options[Constants.InternalOptions.CONTAINER_RID] = self.__container_properties_cache[collection_link]["_rid"]
                 options = new_options
             return (
                 await self.__QueryFeed(
@@ -2989,8 +2989,8 @@ def __GetBodiesFromQueryResult(result: Dict[str, Any]) -> List[Dict[str, Any]]:
             change_feed_state: Optional[ChangeFeedState] = options.get("changeFeedState")
             if change_feed_state is not None:
                 feed_options = {}
-                if 'excludedLocations' in options:
-                    feed_options['excludedLocations'] = options['excludedLocations']
+                if Constants.InternalOptions.EXCLUDED_LOCATIONS in options:
+                    feed_options[Constants.InternalOptions.EXCLUDED_LOCATIONS] = options[Constants.InternalOptions.EXCLUDED_LOCATIONS]
                 await change_feed_state.populate_request_headers_async(self._routing_map_provider, headers,
                                                                        feed_options)
                 request_params.headers = headers
@@ -3256,9 +3256,9 @@ async def _AddPartitionKey(self, collection_link, document, options):
         # If the collection doesn't have a partition key definition, skip it as it's a legacy collection
         if partitionKeyDefinition:
             # If the user has passed in the partitionKey in options use that else extract it from the document
-            if "partitionKey" not in options:
+            if Constants.InternalOptions.PARTITION_KEY not in options:
                 partitionKeyValue = self._ExtractPartitionKey(partitionKeyDefinition, document)
-                new_options["partitionKey"] = partitionKeyValue
+                new_options[Constants.InternalOptions.PARTITION_KEY] = partitionKeyValue
 
         return new_options
 

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

@@ -342,22 +342,22 @@ def read_items(
         """
 
         if session_token is not None:
-            kwargs['session_token'] = session_token
+            kwargs[Constants.Kwargs.SESSION_TOKEN] = session_token
         if initial_headers is not None:
-            kwargs['initial_headers'] = initial_headers
+            kwargs[Constants.Kwargs.INITIAL_HEADERS] = initial_headers
         if consistency_level is not None:
-            kwargs['consistencyLevel'] = consistency_level
+            kwargs[Constants.Kwargs.CONSISTENCY_LEVEL] = consistency_level
         if excluded_locations is not None:
-            kwargs['excludedLocations'] = excluded_locations
+            kwargs[Constants.Kwargs.EXCLUDED_LOCATIONS] = excluded_locations
         if priority is not None:
-            kwargs['priority'] = priority
+            kwargs[Constants.Kwargs.PRIORITY] = priority
         if throughput_bucket is not None:
-            kwargs["throughput_bucket"] = throughput_bucket
+            kwargs[Constants.Kwargs.THROUGHPUT_BUCKET] = throughput_bucket
 
         kwargs['max_concurrency'] = max_concurrency
         query_options = build_options(kwargs)
         self._get_properties_with_options(query_options)
-        query_options["enableCrossPartitionQuery"] = True
+        query_options[Constants.InternalOptions.ENABLE_CROSS_PARTITION_QUERY] = True
 
         item_tuples = [(item_id, self._set_partition_key(pk)) for item_id, pk in items]
 
@@ -658,13 +658,13 @@ def query_items_change_feed(
             change_feed_state_context["startTime"] = kwargs.pop("start_time")
 
         container_properties = self._get_properties_with_options(feed_options)
-        if "partition_key" in kwargs:
-            partition_key = kwargs.pop("partition_key")
+        if Constants.Kwargs.PARTITION_KEY in kwargs:
+            partition_key = kwargs.pop(Constants.Kwargs.PARTITION_KEY)
             change_feed_state_context["partitionKey"] = self._set_partition_key(cast(_PartitionKeyType, partition_key))
             change_feed_state_context["partitionKeyFeedRange"] = \
                 get_epk_range_for_partition_key(container_properties, partition_key)
-        if "feed_range" in kwargs:
-            change_feed_state_context["feedRange"] = kwargs.pop('feed_range')
+        if Constants.Kwargs.FEED_RANGE in kwargs:
+            change_feed_state_context["feedRange"] = kwargs.pop(Constants.Kwargs.FEED_RANGE)
         if "continuation" in feed_options:
             change_feed_state_context["continuation"] = feed_options.pop("continuation")
 
@@ -675,7 +675,7 @@ def query_items_change_feed(
 
         ] = container_properties["_rid"]
 
-        response_hook = kwargs.pop("response_hook", None)
+        response_hook = kwargs.pop(Constants.Kwargs.RESPONSE_HOOK, None)
         if hasattr(response_hook, "clear"):
             response_hook.clear()
 
@@ -977,17 +977,17 @@ def query_items(  # pylint:disable=docstring-missing-param
             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):
-                kwargs["prefix_partition_key_object"] = partition_key_obj
-                kwargs["prefix_partition_key_value"] = cast(_SequentialPartitionKeyType, partition_key_value)
+                kwargs[Constants.Kwargs.PREFIX_PARTITION_KEY_OBJECT] = partition_key_obj
+                kwargs[Constants.Kwargs.PREFIX_PARTITION_KEY_VALUE] = cast(_SequentialPartitionKeyType, partition_key_value)
             else:
                 # Add to feed_options, only when feed_range not given and partition_key was not prefixed partition_key
                 feed_options[Constants.InternalOptions.PARTITION_KEY] = partition_key_value
 
         # Set 'partition_key' for QueryItems method. This can be 'None' if feed range or prefix partition key was set
-        partition_key = feed_options.get("partitionKey")
+        partition_key = feed_options.get(Constants.InternalOptions.PARTITION_KEY)
 
         # Set 'response_hook'
-        response_hook = kwargs.pop("response_hook", None)
+        response_hook = kwargs.pop(Constants.Kwargs.RESPONSE_HOOK, None)
         if response_hook and hasattr(response_hook, "clear"):
             response_hook.clear()
 

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

@@ -457,7 +457,7 @@ def list_databases(  # pylint:disable=docstring-missing-param
             kwargs[Constants.Kwargs.INITIAL_HEADERS] = initial_headers
         feed_options = build_options(kwargs)
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
         result = self.client_connection.ReadDatabases(options=feed_options, **kwargs)
         if response_hook:
             response_hook(self.client_connection.last_response_headers)
@@ -510,9 +510,9 @@ def query_databases(  # pylint:disable=docstring-missing-param
             kwargs[Constants.Kwargs.THROUGHPUT_BUCKET] = throughput_bucket
         feed_options = build_options(kwargs)
         if enable_cross_partition_query is not None:
-            feed_options["enableCrossPartitionQuery"] = enable_cross_partition_query
+            feed_options[Constants.InternalOptions.ENABLE_CROSS_PARTITION_QUERY] = enable_cross_partition_query
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
 
         if query:
             result = self.client_connection.QueryDatabases(

sdk/cosmos/azure-cosmos/azure/cosmos/database.py

@@ -525,7 +525,7 @@ def list_containers(  # pylint:disable=docstring-missing-param
             kwargs[Constants.Kwargs.INITIAL_HEADERS] = initial_headers
         feed_options = build_options(kwargs)
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
         result = self.client_connection.ReadContainers(
             database_link=self.database_link, options=feed_options, **kwargs
         )
@@ -573,7 +573,7 @@ def query_containers(   # pylint:disable=docstring-missing-param
             kwargs[Constants.Kwargs.INITIAL_HEADERS] = initial_headers
         feed_options = build_options(kwargs)
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
         result = self.client_connection.QueryContainers(
             database_link=self.database_link,
             query=query if parameters is None else {"query": query, "parameters": parameters},
@@ -707,7 +707,7 @@ def list_users(
         """
         feed_options = build_options(kwargs)
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
 
         result = self.client_connection.ReadUsers(
             database_link=self.database_link, options=feed_options, **kwargs
@@ -739,7 +739,7 @@ def query_users(
         """
         feed_options = build_options(kwargs)
         if max_item_count is not None:
-            feed_options["maxItemCount"] = max_item_count
+            feed_options[Constants.InternalOptions.MAX_ITEM_COUNT] = max_item_count
 
         result = self.client_connection.QueryUsers(
             database_link=self.database_link,