Skip to content

Commit 1e60360

Browse files
authored
Update name to state (Azure#22991)
* Update name to state * async
1 parent 3cdd31d commit 1e60360

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

sdk/servicebus/azure-servicebus/CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Release History
22

3-
## 7.6.0 (Unreleased)
3+
## 7.6.0 (2022-02-10)
44

55
### Features Added
66

77
- Introduce `ServiceBusMessageState` enum that can assume the values of `active`, `scheduled` or `deferred`.
8-
- Add `ServiceBusMessageState` property in `ServiceBusReceivedMessage`.
8+
- Add `state` property in `ServiceBusReceivedMessage`.
99

1010
### Breaking Changes
1111

sdk/servicebus/azure-servicebus/azure/servicebus/_common/message.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -970,13 +970,13 @@ def dead_letter_source(self):
970970
return None
971971

972972
@property
973-
def message_state(self):
974-
# type: () -> int
973+
def state(self):
974+
# type: () -> ServiceBusMessageState
975975
"""
976976
Defaults to Active. Represents the message state of the message. Can be Active, Deferred.
977977
or Scheduled.
978978
979-
:rtype: int
979+
:rtype: ~azure.servicebus.ServiceBusMessageState
980980
"""
981981
try:
982982
message_state = self._raw_amqp_message.annotations.get(MESSAGE_STATE_NAME)

sdk/servicebus/azure-servicebus/tests/async_tests/test_queues_async.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2131,7 +2131,7 @@ async def test_queue_async_send_amqp_annotated_message(self, servicebus_namespac
21312131
@CachedResourceGroupPreparer(name_prefix='servicebustest')
21322132
@CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
21332133
@ServiceBusQueuePreparer(name_prefix='servicebustest', dead_lettering_on_message_expiration=True)
2134-
async def test_message_state_scheduled_async(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
2134+
async def test_state_scheduled_async(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
21352135
async with ServiceBusClient.from_connection_string(
21362136
servicebus_namespace_connection_string) as sb_client:
21372137

@@ -2146,15 +2146,15 @@ async def test_message_state_scheduled_async(self, servicebus_namespace_connecti
21462146
async with receiver:
21472147
messages = await receiver.peek_messages()
21482148
for msg in messages:
2149-
assert msg.message_state == ServiceBusMessageState.SCHEDULED
2149+
assert msg.state == ServiceBusMessageState.SCHEDULED
21502150

21512151

21522152
@pytest.mark.liveTest
21532153
@pytest.mark.live_test_only
21542154
@CachedResourceGroupPreparer(name_prefix='servicebustest')
21552155
@CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
21562156
@ServiceBusQueuePreparer(name_prefix='servicebustest', dead_lettering_on_message_expiration=True)
2157-
async def test_message_state_deferred_async(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
2157+
async def test_state_deferred_async(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
21582158
async with ServiceBusClient.from_connection_string(
21592159
servicebus_namespace_connection_string) as sb_client:
21602160

@@ -2169,12 +2169,12 @@ async def test_message_state_deferred_async(self, servicebus_namespace_connectio
21692169
async with receiver:
21702170
received_msgs = await receiver.receive_messages()
21712171
for message in received_msgs:
2172-
assert message.message_state == ServiceBusMessageState.ACTIVE
2172+
assert message.state == ServiceBusMessageState.ACTIVE
21732173
deferred_messages.append(message.sequence_number)
21742174
await receiver.defer_message(message)
21752175
if deferred_messages:
21762176
received_deferred_msg = await receiver.receive_deferred_messages(
21772177
sequence_numbers=deferred_messages
21782178
)
21792179
for message in received_deferred_msg:
2180-
assert message.message_state == ServiceBusMessageState.DEFERRED
2180+
assert message.state == ServiceBusMessageState.DEFERRED

sdk/servicebus/azure-servicebus/tests/test_message.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ def test_servicebus_received_message_repr():
5656
assert "content_type=None, correlation_id=None, to=None, reply_to=None, reply_to_session_id=None, subject=None,"
5757
assert "partition_key=r_key, scheduled_enqueue_time_utc" in repr_str
5858

59-
def test_servicebus_received_message_state():
59+
def test_servicebus_received_state():
6060
uamqp_received_message = uamqp.message.Message(
6161
body=b'data',
6262
annotations={
@@ -65,7 +65,7 @@ def test_servicebus_received_message_state():
6565
properties=uamqp.message.MessageProperties()
6666
)
6767
received_message = ServiceBusReceivedMessage(uamqp_received_message, receiver=None)
68-
assert received_message.message_state == 3
68+
assert received_message.state == 3
6969

7070
uamqp_received_message = uamqp.message.Message(
7171
body=b'data',
@@ -75,7 +75,7 @@ def test_servicebus_received_message_state():
7575
properties=uamqp.message.MessageProperties()
7676
)
7777
received_message = ServiceBusReceivedMessage(uamqp_received_message, receiver=None)
78-
assert received_message.message_state == ServiceBusMessageState.DEFERRED
78+
assert received_message.state == ServiceBusMessageState.DEFERRED
7979

8080
uamqp_received_message = uamqp.message.Message(
8181
body=b'data',
@@ -84,14 +84,14 @@ def test_servicebus_received_message_state():
8484
properties=uamqp.message.MessageProperties()
8585
)
8686
received_message = ServiceBusReceivedMessage(uamqp_received_message, receiver=None)
87-
assert received_message.message_state == ServiceBusMessageState.ACTIVE
87+
assert received_message.state == ServiceBusMessageState.ACTIVE
8888

8989
uamqp_received_message = uamqp.message.Message(
9090
body=b'data',
9191
properties=uamqp.message.MessageProperties()
9292
)
9393
received_message = ServiceBusReceivedMessage(uamqp_received_message, receiver=None)
94-
assert received_message.message_state == ServiceBusMessageState.ACTIVE
94+
assert received_message.state == ServiceBusMessageState.ACTIVE
9595

9696
uamqp_received_message = uamqp.message.Message(
9797
body=b'data',
@@ -101,7 +101,7 @@ def test_servicebus_received_message_state():
101101
properties=uamqp.message.MessageProperties()
102102
)
103103
received_message = ServiceBusReceivedMessage(uamqp_received_message, receiver=None)
104-
assert received_message.message_state == ServiceBusMessageState.ACTIVE
104+
assert received_message.state == ServiceBusMessageState.ACTIVE
105105

106106
def test_servicebus_received_message_repr_with_props():
107107
uamqp_received_message = uamqp.message.Message(

sdk/servicebus/azure-servicebus/tests/test_queues.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2590,7 +2590,7 @@ def test_queue_send_amqp_annotated_message(self, servicebus_namespace_connection
25902590
@CachedResourceGroupPreparer(name_prefix='servicebustest')
25912591
@CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
25922592
@ServiceBusQueuePreparer(name_prefix='servicebustest', dead_lettering_on_message_expiration=True)
2593-
def test_message_state_scheduled(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
2593+
def test_state_scheduled(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
25942594
with ServiceBusClient.from_connection_string(
25952595
servicebus_namespace_connection_string) as sb_client:
25962596

@@ -2603,15 +2603,15 @@ def test_message_state_scheduled(self, servicebus_namespace_connection_string, s
26032603
receiver = sb_client.get_queue_receiver(servicebus_queue.name)
26042604
with receiver:
26052605
for msg in receiver.peek_messages():
2606-
assert msg.message_state == ServiceBusMessageState.SCHEDULED
2606+
assert msg.state == ServiceBusMessageState.SCHEDULED
26072607

26082608

26092609
@pytest.mark.liveTest
26102610
@pytest.mark.live_test_only
26112611
@CachedResourceGroupPreparer(name_prefix='servicebustest')
26122612
@CachedServiceBusNamespacePreparer(name_prefix='servicebustest')
26132613
@ServiceBusQueuePreparer(name_prefix='servicebustest', dead_lettering_on_message_expiration=True)
2614-
def test_message_state_deferred(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
2614+
def test_state_deferred(self, servicebus_namespace_connection_string, servicebus_queue, **kwargs):
26152615
with ServiceBusClient.from_connection_string(
26162616
servicebus_namespace_connection_string) as sb_client:
26172617

@@ -2625,12 +2625,12 @@ def test_message_state_deferred(self, servicebus_namespace_connection_string, se
26252625
with receiver:
26262626
received_msgs = receiver.receive_messages()
26272627
for message in received_msgs:
2628-
assert message.message_state == ServiceBusMessageState.ACTIVE
2628+
assert message.state == ServiceBusMessageState.ACTIVE
26292629
deferred_messages.append(message.sequence_number)
26302630
receiver.defer_message(message)
26312631
if deferred_messages:
26322632
received_deferred_msg = receiver.receive_deferred_messages(
26332633
sequence_numbers=deferred_messages
26342634
)
26352635
for message in received_deferred_msg:
2636-
assert message.message_state == ServiceBusMessageState.DEFERRED
2636+
assert message.state == ServiceBusMessageState.DEFERRED

0 commit comments

Comments
 (0)