[ServiceBus] add keyword override support to update_ methods in mgmt module #18210
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,6 +6,7 @@ | |
| # pylint:disable=specify-parameter-names-in-call | ||
| # pylint:disable=too-many-lines | ||
| import functools | ||
| from copy import deepcopy | ||
| from typing import TYPE_CHECKING, Any, Union, cast, Mapping | ||
| from xml.etree.ElementTree import ElementTree | ||
|
|
||
|
|
@@ -72,7 +73,6 @@ | |
| ) | ||
| from ...management._xml_workaround_policy import ServiceBusXMLWorkaroundPolicy | ||
| from ...management._handle_response_error import _handle_response_error | ||
| from ._utils import extract_data_template, extract_rule_data_template, get_next_template | ||
| from ...management._utils import ( | ||
| deserialize_rule_key_values, | ||
|
|
@@ -386,14 +386,14 @@ async def create_queue(self, queue_name: str, **kwargs) -> QueueProperties: | |
| forward_dead_lettered_messages_to=forward_dead_lettered_messages_to, | ||
| user_metadata=kwargs.pop("user_metadata", None), | ||
| ) | ||
| to_create = queue._to_internal_entity(self.fully_qualified_namespace) | ||
| create_entity_body = CreateQueueBody( | ||
| content=CreateQueueBodyContent( | ||
| queue_description=to_create, # type: ignore | ||
| ) | ||
| ) | ||
| request_body = create_entity_body.serialize(is_xml=True) | ||
| await self._create_forward_to_header_tokens(to_create, kwargs) | ||
| with _handle_response_error(): | ||
| entry_ele = cast( | ||
| ElementTree, | ||
|
|
@@ -419,39 +419,26 @@ async def update_queue( | |
| Before calling this method, you should use `get_queue`, `create_queue` or `list_queues` to get a | ||
| `QueueProperties` instance, then update the properties. Only a portion of properties can | ||
| be updated. Refer to https://docs.microsoft.com/en-us/rest/api/servicebus/update-queue. | ||
| You could also pass keyword arguments for updating properties in the form of | ||
| `<property_name>=<property_value>` which will override whatever was specified in | ||
| the `QueueProperties` instance. Refer to ~azure.servicebus.management.QueueProperties for names of properties. | ||
|
|
||
| :param queue: The queue that is returned from `get_queue`, `create_queue` or `list_queues` and | ||
| has the updated properties. | ||
| :type queue: ~azure.servicebus.management.QueueProperties | ||
| :rtype: None | ||
| """ | ||
| # we should not mutate the input, making a copy first for update | ||
| queue = deepcopy(create_properties_from_dict_if_needed(queue, QueueProperties)) | ||
| to_update = queue._to_internal_entity(self.fully_qualified_namespace, kwargs) | ||
|
|
||
| create_entity_body = CreateQueueBody( | ||
| content=CreateQueueBodyContent( | ||
| queue_description=to_update, | ||
| ) | ||
| ) | ||
| request_body = create_entity_body.serialize(is_xml=True) | ||
| await self._create_forward_to_header_tokens(to_update, kwargs) | ||
| with _handle_response_error(): | ||
| await self._impl.entity.put( | ||
| queue.name, # type: ignore | ||
|
|
@@ -660,22 +647,18 @@ async def update_topic( | |
| Before calling this method, you should use `get_topic`, `create_topic` or `list_topics` to get a | ||
| `TopicProperties` instance, then update the properties. Only a portion of properties can be updated. | ||
| Refer to https://docs.microsoft.com/en-us/rest/api/servicebus/update-topic. | ||
| You could also pass keyword arguments for updating properties in the form of | ||
| `<property_name>=<property_value>` which will override whatever was specified in | ||
| the `TopicProperties` instance. Refer to ~azure.servicebus.management.TopicProperties for names of properties. | ||
|
|
||
| :param topic: The topic that is returned from `get_topic`, `create_topic`, or `list_topics` | ||
| and has the updated properties. | ||
| :type topic: ~azure.servicebus.management.TopicProperties | ||
| :rtype: None | ||
| """ | ||
|
|
||
| topic = deepcopy(create_properties_from_dict_if_needed(topic, TopicProperties)) | ||
| to_update = topic._to_internal_entity(kwargs) | ||
|
|
||
| create_entity_body = CreateTopicBody( | ||
| content=CreateTopicBodyContent( | ||
|
|
@@ -849,6 +832,7 @@ async def create_subscription( | |
| :type auto_delete_on_idle: Union[~datetime.timedelta, str] | ||
| :rtype: ~azure.servicebus.management.SubscriptionProperties | ||
| """ | ||
| # pylint:disable=protected-access | ||
| _validate_entity_name_type(topic_name, display_name="topic_name") | ||
| forward_to = _normalize_entity_path_to_full_path_if_needed( | ||
| kwargs.pop("forward_to", None), self.fully_qualified_namespace | ||
|
|
@@ -882,15 +866,15 @@ async def create_subscription( | |
| auto_delete_on_idle=kwargs.pop("auto_delete_on_idle", None), | ||
| availability_status=None, | ||
| ) | ||
| to_create = subscription._to_internal_entity(self.fully_qualified_namespace) # type: ignore | ||
|
|
||
| create_entity_body = CreateSubscriptionBody( | ||
| content=CreateSubscriptionBodyContent( | ||
| subscription_description=to_create, # type: ignore | ||
| ) | ||
| ) | ||
| request_body = create_entity_body.serialize(is_xml=True) | ||
| await self._create_forward_to_header_tokens(to_create, kwargs) | ||
| with _handle_response_error(): | ||
| entry_ele = cast( | ||
| ElementTree, | ||
|
|
@@ -919,6 +903,10 @@ async def update_subscription( | |
|
|
||
| Before calling this method, you should use `get_subscription`, `update_subscription` or `list_subscription` | ||
| to get a `SubscriptionProperties` instance, then update the properties. | ||
| You could also pass keyword arguments for updating properties in the form of | ||
| `<property_name>=<property_value>` which will override whatever was specified in | ||
|
There was a problem hiding this comment. should these keywords be documeneted? There was a problem hiding this comment. I was trying to be vague here -- I'm not sure whether those keywords should be documented. @annatisch , do you think we'd better document those keyword arguments? There was a problem hiding this comment. hmm I don't feel strongly either way.... documentation can always be updated as needed. There was a problem hiding this comment. code snippets updated! @rakshith91 are you good with updating the docs later? |
||
| the `SubscriptionProperties` instance. | ||
| Refer to ~azure.servicebus.management.SubscriptionProperties for names of properties. | ||
|
|
||
| :param str topic_name: The topic that owns the subscription. | ||
| :param ~azure.servicebus.management.SubscriptionProperties subscription: The subscription that is returned | ||
|
|
@@ -927,35 +915,17 @@ async def update_subscription( | |
| """ | ||
|
|
||
| _validate_entity_name_type(topic_name, display_name="topic_name") | ||
| # we should not mutate the input, making a copy first for update | ||
| subscription = deepcopy(create_properties_from_dict_if_needed(subscription, SubscriptionProperties)) | ||
yunhaoling marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| to_update = subscription._to_internal_entity(self.fully_qualified_namespace, kwargs) | ||
|
|
||
| create_entity_body = CreateSubscriptionBody( | ||
| content=CreateSubscriptionBodyContent( | ||
| subscription_description=to_update, | ||
| ) | ||
| ) | ||
| request_body = create_entity_body.serialize(is_xml=True) | ||
| await self._create_forward_to_header_tokens(to_update, kwargs) | ||
| with _handle_response_error(): | ||
| await self._impl.subscription.put( | ||
| topic_name, | ||
|
|
@@ -1130,6 +1100,9 @@ async def update_rule( | |
|
|
||
| Before calling this method, you should use `get_rule`, `create_rule` or `list_rules` to get a `RuleProperties` | ||
| instance, then update the properties. | ||
| You could also pass keyword arguments for updating properties in the form of | ||
| `<property_name>=<property_value>` which will override whatever was specified in | ||
| the `RuleProperties` instance. Refer to ~azure.servicebus.management.RuleProperties for names of properties. | ||
|
|
||
| :param str topic_name: The topic that owns the subscription. | ||
| :param str subscription_name: The subscription that | ||
|
|
@@ -1140,9 +1113,9 @@ async def update_rule( | |
| :rtype: None | ||
| """ | ||
| _validate_topic_and_subscription_types(topic_name, subscription_name) | ||
| # we should not mutate the input, making a copy first for update | ||
| rule = deepcopy(create_properties_from_dict_if_needed(rule, RuleProperties)) | ||
| to_update = rule._to_internal_entity(kwargs) | ||
|
|
||
| create_entity_body = CreateRuleBody( | ||
| content=CreateRuleBodyContent( | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.