Skip to content

Commit 8eeff36

Browse files
author
annie-mac
committed
fix doc
1 parent 95572e3 commit 8eeff36

File tree

5 files changed

+15
-10
lines changed

5 files changed

+15
-10
lines changed

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/change_feed_state.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
from azure.cosmos._change_feed.change_feed_start_from import ChangeFeedStartFromInternal, \
3535
ChangeFeedStartFromETagAndFeedRange
3636
from azure.cosmos._change_feed.composite_continuation_token import CompositeContinuationToken
37-
from azure.cosmos._change_feed.feed_range_internal import FeedRangeInternal, FeedRangeInternalEpk, FeedRangeInternalPartitionKey
37+
from azure.cosmos._change_feed.feed_range_internal import (FeedRangeInternal, FeedRangeInternalEpk,
38+
FeedRangeInternalPartitionKey)
3839
from azure.cosmos._change_feed.feed_range_composite_continuation_token import FeedRangeCompositeContinuation
3940
from azure.cosmos._routing.aio.routing_map_provider import SmartRoutingMapProvider as AsyncSmartRoutingMapProvider
4041
from azure.cosmos._routing.routing_map_provider import SmartRoutingMapProvider
@@ -388,7 +389,7 @@ def from_initial_state(
388389
feed_range =\
389390
FeedRangeInternalPartitionKey(
390391
change_feed_state_context["partitionKey"],
391-
change_feed_state_context["partitionKeyFeedRange"])
392+
change_feed_state_context["partitionKeyFeedRange"]) # type: FeedRangeInternal
392393
else:
393394
raise ValueError("partitionKey is in the changeFeedStateContext, but missing partitionKeyFeedRange")
394395
else:
@@ -399,7 +400,7 @@ def from_initial_state(
399400
"FF",
400401
True,
401402
False)
402-
)
403+
) # type: FeedRangeInternal
403404

404405
change_feed_start_from = (
405406
ChangeFeedStartFromInternal.from_start_time(change_feed_state_context.get("startTime")))

sdk/cosmos/azure-cosmos/azure/cosmos/_change_feed/feed_range_composite_continuation_token.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@
2626
from typing import Any, Deque, Dict, Optional
2727

2828
from azure.cosmos._change_feed.composite_continuation_token import CompositeContinuationToken
29-
from azure.cosmos._change_feed.feed_range_internal import FeedRangeInternal, FeedRangeInternalEpk, FeedRangeInternalPartitionKey
29+
from azure.cosmos._change_feed.feed_range_internal import (FeedRangeInternal, FeedRangeInternalEpk,
30+
FeedRangeInternalPartitionKey)
3031
from azure.cosmos._routing.routing_map_provider import SmartRoutingMapProvider
3132
from azure.cosmos._routing.aio.routing_map_provider import SmartRoutingMapProvider as AsyncSmartRoutingMapProvider
3233
from azure.cosmos._routing.routing_range import Range

sdk/cosmos/azure-cosmos/azure/cosmos/_feed_range.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
from azure.cosmos._change_feed.feed_range_internal import FeedRangeInternal, FeedRangeInternalEpk
2828
from azure.cosmos._routing.routing_range import Range
2929

30-
30+
# pylint: disable=protected-access
3131
class FeedRange(ABC):
3232
"""Represents a single feed range in an Azure Cosmos DB SQL API container.
3333
@@ -37,6 +37,7 @@ def to_string(self) -> str:
3737
"""
3838
Get a json representation of the feed range.
3939
The returned json string can be used to create a new feed range from it.
40+
4041
:return: A json representation of the feed range.
4142
:rtype: str
4243
"""
@@ -48,16 +49,16 @@ def from_string(json_str: str) -> 'FeedRange':
4849
"""
4950
Create a feed range from previously obtained string representation.
5051
51-
:param json_str: A string representation of a feed range.
52+
:param str json_str: A string representation of a feed range.
5253
:return: A feed range.
5354
:rtype: ~azure.cosmos.FeedRange
5455
"""
5556
feed_range_json_str = base64.b64decode(json_str).decode('utf-8')
5657
feed_range_json = json.loads(feed_range_json_str)
5758
if feed_range_json.get(FeedRangeEpk.type_property_name):
5859
return FeedRangeEpk._from_json(feed_range_json)
59-
else:
60-
raise ValueError("Invalid feed range base64 encoded string [Wrong feed range type]")
60+
61+
raise ValueError("Invalid feed range base64 encoded string [Wrong feed range type]")
6162

6263
@abstractmethod
6364
def _to_dict(self) -> Dict[str, Any]:

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -1265,4 +1265,5 @@ async def read_feed_ranges(
12651265
[Range("", "FF", True, False)],
12661266
**kwargs)
12671267

1268-
return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange)) for partitionKeyRange in partition_key_ranges]
1268+
return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange))
1269+
for partitionKeyRange in partition_key_ranges]

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

+2-1
Original file line numberDiff line numberDiff line change
@@ -1332,4 +1332,5 @@ def read_feed_ranges(
13321332
[Range("", "FF", True, False)], # default to full range
13331333
**kwargs)
13341334

1335-
return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange)) for partitionKeyRange in partition_key_ranges]
1335+
return [FeedRangeEpk(Range.PartitionKeyRangeToRange(partitionKeyRange))
1336+
for partitionKeyRange in partition_key_ranges]

0 commit comments

Comments
 (0)