Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

Merged
merged 19 commits into from
May 5, 2021
Merged

[ServiceBus] add keyword override support to update_ methods in mgmt module #18210

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
1305015
add keyword override support
yunhaoling Apr 21, 2021
1a6c80e
updat impl
yunhaoling Apr 22, 2021
7b09800
add test and recordings
yunhaoling Apr 22, 2021
8d535cf
version bump, changelog update
yunhaoling Apr 22, 2021
fd4f29b
bug fix log
yunhaoling Apr 22, 2021
c54e4fd
fix pylint
yunhaoling Apr 22, 2021
5e06035
fix pylint and mypy
yunhaoling Apr 22, 2021
ae831d1
pr review feedback
yunhaoling Apr 22, 2021
ff61fc1
Update sdk/servicebus/azure-servicebus/CHANGELOG.md
yunhaoling Apr 23, 2021
a633599
Merge remote-tracking branch 'central/master' into yuling/sb/update_k…
yunhaoling Apr 26, 2021
366a063
Merge branch 'yuling/sb/update_keyword_overrides' of https://github.c…
yunhaoling Apr 26, 2021
3602c2f
Merge remote-tracking branch 'central/master' into yuling/sb/update_k…
yunhaoling Apr 29, 2021
4250615
review feedback
yunhaoling Apr 29, 2021
a55b94e
fix mypy and pylint
yunhaoling Apr 29, 2021
f36310e
fix pylint
yunhaoling Apr 29, 2021
106973d
Merge branch 'master' into yuling/sb/update_keyword_overrides
yunhaoling May 3, 2021
0370d6b
header bearer should use normalized path to generate token instead of…
yunhaoling May 3, 2021
8ff0874
Merge branch 'yuling/sb/update_keyword_overrides' of https://github.c…
yunhaoling May 3, 2021
1f3ffa4
update code snippets to show update keyword argument usage
yunhaoling May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions sdk/servicebus/azure-servicebus/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ The preview features related to AMQPAnnotatedMessage introduced in 7.2.0b1 are n
**New Features**

* Support for using `azure.core.credentials.AzureSasCredential` as credential for authenticating the clients is now GA.
* `ServiceBusAdministrationClient.update_*` methods now accept keyword arguments to override the properties specified in the model instance.

**Bug Fixes**

* Fixed a bug where `update_queue` and `update_subscription` methods were mutating the properties `forward_to` and `forward_dead_lettered_messages_to` of the model instance when those properties are entities instead of full paths.

## 7.2.0b1 (2021-04-07)

Expand All @@ -21,6 +26,7 @@ The preview features related to AMQPAnnotatedMessage introduced in 7.2.0b1 are n
- `VALUE`: The body of message consists of one amqp-value section and the section contains a single AMQP value.
* Added new property `body_type` on `azure.servicebus.ServiceBusMessage` and `azure.servicebus.ReceivedMessage` which returns `azure.servicebus.AMQPMessageBodyType`.


## 7.1.1 (2021-04-07)

This version and all future versions will require Python 2.7 or Python 3.6+, Python 3.5 is no longer supported.
Expand Down
91 changes: 32 additions & 59 deletions sdk/servicebus/azure-servicebus/azure/servicebus/aio/management/_management_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -72,7 +73,6 @@
)
from ...management._xml_workaround_policy import ServiceBusXMLWorkaroundPolicy
from ...management._handle_response_error import _handle_response_error
from ...management._model_workaround import avoid_timedelta_overflow
from ._utils import extract_data_template, extract_rule_data_template, get_next_template
from ...management._utils import (
deserialize_rule_key_values,
Expand Down Expand Up @@ -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()
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(queue, kwargs)
await self._create_forward_to_header_tokens(to_create, kwargs)
with _handle_response_error():
entry_ele = cast(
ElementTree,
Expand All @@ -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
swathipil marked this conversation as resolved.
Show resolved Hide resolved
:rtype: None
"""

queue = create_properties_from_dict_if_needed(queue, QueueProperties)
queue.forward_to = _normalize_entity_path_to_full_path_if_needed(
queue.forward_to, self.fully_qualified_namespace
)
queue.forward_dead_lettered_messages_to = (
_normalize_entity_path_to_full_path_if_needed(
queue.forward_dead_lettered_messages_to,
self.fully_qualified_namespace,
)
)
to_update = queue._to_internal_entity()

to_update.default_message_time_to_live = avoid_timedelta_overflow(
to_update.default_message_time_to_live
)
to_update.auto_delete_on_idle = avoid_timedelta_overflow(
to_update.auto_delete_on_idle
)
# 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(queue, kwargs)
await self._create_forward_to_header_tokens(to_update, kwargs)
with _handle_response_error():
await self._impl.entity.put(
queue.name, # type: ignore
Expand Down Expand Up @@ -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 = create_properties_from_dict_if_needed(topic, TopicProperties)
to_update = topic._to_internal_entity()

to_update.default_message_time_to_live = avoid_timedelta_overflow( # type: ignore
to_update.default_message_time_to_live
)
to_update.auto_delete_on_idle = avoid_timedelta_overflow( # type: ignore
to_update.auto_delete_on_idle
)
topic = deepcopy(create_properties_from_dict_if_needed(topic, TopicProperties))
to_update = topic._to_internal_entity(kwargs)

create_entity_body = CreateTopicBody(
content=CreateTopicBodyContent(
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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() # type: ignore # pylint:disable=protected-access
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(subscription, kwargs)
await self._create_forward_to_header_tokens(to_create, kwargs)
with _handle_response_error():
entry_ele = cast(
ElementTree,
Expand Down Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should these keywords be documeneted?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was trying to be vague here -- I'm not sure whether those keywords should be documented.
as once documented, then it feels like we're promoting using keyword arguments to do updates -- two ways to do the same thing.

@annatisch , do you think we'd better document those keyword arguments?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm I don't feel strongly either way.... documentation can always be updated as needed.
You could add an example in the code snippet to show their use rather than call them all out explicitly.

Copy link
Contributor Author

@yunhaoling yunhaoling May 4, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Expand All @@ -927,35 +915,17 @@ async def update_subscription(
"""

_validate_entity_name_type(topic_name, display_name="topic_name")

subscription = create_properties_from_dict_if_needed(
subscription, SubscriptionProperties
)
subscription.forward_to = _normalize_entity_path_to_full_path_if_needed(
subscription.forward_to, self.fully_qualified_namespace
)
subscription.forward_dead_lettered_messages_to = (
_normalize_entity_path_to_full_path_if_needed(
subscription.forward_dead_lettered_messages_to,
self.fully_qualified_namespace,
)
)
to_update = subscription._to_internal_entity()

to_update.default_message_time_to_live = avoid_timedelta_overflow( # type: ignore
to_update.default_message_time_to_live
)
to_update.auto_delete_on_idle = avoid_timedelta_overflow( # type: ignore
to_update.auto_delete_on_idle
)
# 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(subscription, kwargs)
await self._create_forward_to_header_tokens(to_update, kwargs)
with _handle_response_error():
await self._impl.subscription.put(
topic_name,
Expand Down Expand Up @@ -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
Expand All @@ -1140,9 +1113,9 @@ async def update_rule(
:rtype: None
"""
_validate_topic_and_subscription_types(topic_name, subscription_name)

rule = create_properties_from_dict_if_needed(rule, RuleProperties)
to_update = rule._to_internal_entity()
# 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(
Expand Down
Loading