Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf2b5e4f

Browse files
JohnVillalovosnejch
authored andcommitted
chore: use a dataclass to return values fromprepare_send_data
I found the tuple of three values confusing. So instead use adataclass to return the three values. It is still confusing but alittle bit less so.Also add some unit tests
1 parentd387d91 commitf2b5e4f

File tree

4 files changed

+62
-15
lines changed

4 files changed

+62
-15
lines changed

‎gitlab/_backends/requests_backend.py‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
from __future__importannotations
22

3-
fromtypingimportAny,Dict,Optional,Tuple,TYPE_CHECKING,Union
3+
importdataclasses
4+
fromtypingimportAny,Dict,Optional,TYPE_CHECKING,Union
45

56
importrequests
67
fromrequests.structuresimportCaseInsensitiveDict
@@ -9,6 +10,20 @@
910
from .importprotocol
1011

1112

13+
@dataclasses.dataclass
14+
classSendData:
15+
content_type:str
16+
data:Optional[Union[Dict[str,Any],MultipartEncoder]]=None
17+
json:Optional[Union[Dict[str,Any],bytes]]=None
18+
19+
def__post_init__(self)->None:
20+
ifself.jsonisnotNoneandself.dataisnotNone:
21+
raiseValueError(
22+
f"`json` and `data` are mutually exclusive. Only one can be set. "
23+
f"json={self.json!r} data={self.data!r}"
24+
)
25+
26+
1227
classRequestsResponse(protocol.BackendResponse):
1328
def__init__(self,response:requests.Response)->None:
1429
self._response:requests.Response=response
@@ -50,11 +65,7 @@ def prepare_send_data(
5065
files:Optional[Dict[str,Any]]=None,
5166
post_data:Optional[Union[Dict[str,Any],bytes]]=None,
5267
raw:bool=False,
53-
)->Tuple[
54-
Optional[Union[Dict[str,Any],bytes]],
55-
Optional[Union[Dict[str,Any],MultipartEncoder]],
56-
str,
57-
]:
68+
)->SendData:
5869
iffiles:
5970
ifpost_dataisNone:
6071
post_data= {}
@@ -70,12 +81,12 @@ def prepare_send_data(
7081
post_data["avatar"]=files.get("avatar")
7182

7283
data=MultipartEncoder(post_data)
73-
return(None,data,data.content_type)
84+
returnSendData(data=data,content_type=data.content_type)
7485

7586
ifrawandpost_data:
76-
return(None,post_data,"application/octet-stream")
87+
returnSendData(data=post_data,content_type="application/octet-stream")
7788

78-
return(post_data,None,"application/json")
89+
returnSendData(json=post_data,content_type="application/json")
7990

8091
defhttp_request(
8192
self,

‎gitlab/client.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -716,19 +716,17 @@ def http_request(
716716
retry_transient_errors=self.retry_transient_errors
717717

718718
# We need to deal with json vs. data when uploading files
719-
json,data,content_type=self._backend.prepare_send_data(
720-
files,post_data,raw
721-
)
722-
opts["headers"]["Content-type"]=content_type
719+
send_data=self._backend.prepare_send_data(files,post_data,raw)
720+
opts["headers"]["Content-type"]=send_data.content_type
723721

724722
cur_retries=0
725723
whileTrue:
726724
try:
727725
result=self._backend.http_request(
728726
method=verb,
729727
url=url,
730-
json=json,
731-
data=data,
728+
json=send_data.json,
729+
data=send_data.data,
732730
params=params,
733731
timeout=timeout,
734732
verify=verify,

‎tests/unit/_backends/__init__.py‎

Whitespace-only changes.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
importpytest
2+
fromrequests_toolbelt.multipart.encoderimportMultipartEncoder# type: ignore
3+
4+
fromgitlab._backendsimportrequests_backend
5+
6+
7+
classTestSendData:
8+
deftest_senddata_json(self)->None:
9+
result=requests_backend.SendData(
10+
json={"a":1},content_type="application/json"
11+
)
12+
assertresult.dataisNone
13+
14+
deftest_senddata_data(self)->None:
15+
result=requests_backend.SendData(
16+
data={"b":2},content_type="application/octet-stream"
17+
)
18+
assertresult.jsonisNone
19+
20+
deftest_senddata_json_and_data(self)->None:
21+
withpytest.raises(ValueError,match=r"json={'a': 1} data={'b': 2}"):
22+
requests_backend.SendData(
23+
json={"a":1},data={"b":2},content_type="application/json"
24+
)
25+
26+
27+
classTestRequestsBackend:
28+
deftest_prepare_send_data_str_parentid(self)->None:
29+
file="12345"
30+
files= {"file": ("file.tar.gz",file,"application/octet-stream")}
31+
post_data= {"parent_id":"12"}
32+
33+
result=requests_backend.RequestsBackend.prepare_send_data(
34+
files=files,post_data=post_data,raw=False
35+
)
36+
assertresult.jsonisNone
37+
assertresult.content_type.startswith("multipart/form-data")
38+
assertisinstance(result.data,MultipartEncoder)

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp