Skip to content

Commit c56fbce

Browse files
committed
Update BaseRequestSettings type hints
1 parent e3d499e commit c56fbce

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

ydb/settings.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def make_copy(self):
3939
.with_need_rpc_auth(self.need_rpc_auth)
4040
)
4141

42-
def with_compression(self, compression):
42+
def with_compression(self, compression) -> "BaseRequestSettings":
4343
"""
4444
Enables compression for the specific RPC
4545
:param compression: An RPCCompression enum value.
@@ -48,11 +48,11 @@ def with_compression(self, compression):
4848
self.compression = compression
4949
return self
5050

51-
def with_need_rpc_auth(self, need_rpc_auth):
51+
def with_need_rpc_auth(self, need_rpc_auth) -> "BaseRequestSettings":
5252
self.need_rpc_auth = need_rpc_auth
5353
return self
5454

55-
def with_header(self, key, value):
55+
def with_header(self, key, value) -> "BaseRequestSettings":
5656
"""
5757
Adds a key-value pair to the request headers.
5858
:param key: A string with a header key.
@@ -62,7 +62,7 @@ def with_header(self, key, value):
6262
self.headers.append((key, value))
6363
return self
6464

65-
def with_trace_id(self, trace_id):
65+
def with_trace_id(self, trace_id) -> "BaseRequestSettings":
6666
"""
6767
Includes trace id for RPC headers
6868
:param trace_id: A trace id string
@@ -71,7 +71,7 @@ def with_trace_id(self, trace_id):
7171
self.trace_id = trace_id
7272
return self
7373

74-
def with_request_type(self, request_type):
74+
def with_request_type(self, request_type) -> "BaseRequestSettings":
7575
"""
7676
Includes request type for RPC headers
7777
:param request_type: A request type string
@@ -80,7 +80,7 @@ def with_request_type(self, request_type):
8080
self.request_type = request_type
8181
return self
8282

83-
def with_operation_timeout(self, timeout):
83+
def with_operation_timeout(self, timeout) -> "BaseRequestSettings":
8484
"""
8585
Indicates that client is no longer interested in the result of operation after the specified duration
8686
starting from the time operation arrives at the server.
@@ -89,25 +89,25 @@ def with_operation_timeout(self, timeout):
8989
Timeout of operation does not tell anything about its result, it might be completed successfully
9090
or cancelled on server.
9191
:param timeout:
92-
:return:
92+
:return: The self instance
9393
"""
9494
self.operation_timeout = timeout
9595
return self
9696

97-
def with_cancel_after(self, timeout):
97+
def with_cancel_after(self, timeout) -> "BaseRequestSettings":
9898
"""
9999
Server will try to cancel the operation after the specified duration starting from the time
100100
the operation arrives at server.
101101
In case of successful cancellation operation will receive CANCELLED status code, which will be
102102
sent back to client if it was waiting for the operation result.
103103
In case when cancellation isn't possible, no action will be performed.
104104
:param timeout:
105-
:return:
105+
:return: The self instance
106106
"""
107107
self.cancel_after = timeout
108108
return self
109109

110-
def with_timeout(self, timeout):
110+
def with_timeout(self, timeout) -> "BaseRequestSettings":
111111
"""
112112
Client-side timeout to complete request.
113113
Since YDB doesn't support request cancellation at this moment, this feature should be

0 commit comments

Comments
 (0)