Skip to content

Commit da246a1

Browse files
azmeukazmeuk
committed
refactor: prefix private methods with _
1 parent c18f3bf commit da246a1

File tree

3 files changed

+41
-37
lines changed

3 files changed

+41
-37
lines changed

‎scim2_client/client.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ def get_resource_model(self, name: str) -> Optional[type[Resource]]:
202202
return resource_model
203203
return None
204204

205-
def check_resource_model(
205+
def _check_resource_model(
206206
self, resource_model: type[Resource], payload=None
207207
) -> None:
208208
if (
@@ -350,7 +350,7 @@ def check_response(
350350
scim_exc.add_note(str(exc))
351351
raise scim_exc from exc
352352

353-
def prepare_create_request(
353+
def _prepare_create_request(
354354
self,
355355
resource: Union[AnyResource, dict],
356356
check_request_payload: Optional[bool] = None,
@@ -387,7 +387,7 @@ def prepare_create_request(
387387
scim_validation_exc.add_note(str(exc))
388388
raise scim_validation_exc from exc
389389

390-
self.check_resource_model(resource_model, resource)
390+
self._check_resource_model(resource_model, resource)
391391
req.expected_types = [resource.__class__]
392392
req.url = req.request_kwargs.pop(
393393
"url", self.resource_endpoint(resource_model)
@@ -398,7 +398,7 @@ def prepare_create_request(
398398

399399
return req
400400

401-
def prepare_query_request(
401+
def _prepare_query_request(
402402
self,
403403
resource_model: Optional[type[Resource]] = None,
404404
id: Optional[str] = None,
@@ -416,7 +416,7 @@ def prepare_query_request(
416416
check_request_payload = self.check_request_payload
417417

418418
if resource_model and check_request_payload:
419-
self.check_resource_model(resource_model)
419+
self._check_resource_model(resource_model)
420420

421421
payload: Optional[SearchRequest]
422422
if not check_request_payload:
@@ -454,7 +454,7 @@ def prepare_query_request(
454454

455455
return req
456456

457-
def prepare_search_request(
457+
def _prepare_search_request(
458458
self,
459459
search_request: Optional[SearchRequest] = None,
460460
check_request_payload: Optional[bool] = None,
@@ -485,7 +485,7 @@ def prepare_search_request(
485485
req.expected_types = [ListResponse[Union[self.resource_models]]]
486486
return req
487487

488-
def prepare_delete_request(
488+
def _prepare_delete_request(
489489
self,
490490
resource_model: type,
491491
id: str,
@@ -497,12 +497,12 @@ def prepare_delete_request(
497497
request_kwargs=kwargs,
498498
)
499499

500-
self.check_resource_model(resource_model)
500+
self._check_resource_model(resource_model)
501501
delete_url = self.resource_endpoint(resource_model) + f"/{id}"
502502
req.url = req.request_kwargs.pop("url", delete_url)
503503
return req
504504

505-
def prepare_replace_request(
505+
def _prepare_replace_request(
506506
self,
507507
resource: Union[AnyResource, dict],
508508
check_request_payload: Optional[bool] = None,
@@ -541,7 +541,7 @@ def prepare_replace_request(
541541
scim_validation_exc.add_note(str(exc))
542542
raise scim_validation_exc from exc
543543

544-
self.check_resource_model(resource_model, resource)
544+
self._check_resource_model(resource_model, resource)
545545

546546
if not resource.id:
547547
raise SCIMRequestError("Resource must have an id", source=resource)
@@ -556,7 +556,7 @@ def prepare_replace_request(
556556

557557
return req
558558

559-
def prepare_patch_request(
559+
def _prepare_patch_request(
560560
self,
561561
resource_model: type[ResourceT],
562562
id: str,
@@ -589,7 +589,7 @@ def prepare_patch_request(
589589
if check_request_payload is None:
590590
check_request_payload = self.check_request_payload
591591

592-
self.check_resource_model(resource_model)
592+
self._check_resource_model(resource_model)
593593

594594
if not check_request_payload:
595595
req.payload = patch_op

‎scim2_client/engines/httpx.py‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ def create(
8181
raise_scim_errors: Optional[bool] = None,
8282
**kwargs,
8383
) -> Union[AnyResource, Error, dict]:
84-
req = self.prepare_create_request(
84+
req = self._prepare_create_request(
8585
resource=resource,
8686
check_request_payload=check_request_payload,
8787
expected_status_codes=expected_status_codes,
@@ -116,7 +116,7 @@ def query(
116116
raise_scim_errors: Optional[bool] = None,
117117
**kwargs,
118118
):
119-
req = self.prepare_query_request(
119+
req = self._prepare_query_request(
120120
resource_model=resource_model,
121121
id=id,
122122
search_request=search_request,
@@ -153,7 +153,7 @@ def search(
153153
raise_scim_errors: Optional[bool] = None,
154154
**kwargs,
155155
) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
156-
req = self.prepare_search_request(
156+
req = self._prepare_search_request(
157157
search_request=search_request,
158158
check_request_payload=check_request_payload,
159159
expected_status_codes=expected_status_codes,
@@ -186,7 +186,7 @@ def delete(
186186
raise_scim_errors: Optional[bool] = None,
187187
**kwargs,
188188
) -> Optional[Union[Error, dict]]:
189-
req = self.prepare_delete_request(
189+
req = self._prepare_delete_request(
190190
resource_model=resource_model,
191191
id=id,
192192
expected_status_codes=expected_status_codes,
@@ -217,7 +217,7 @@ def replace(
217217
raise_scim_errors: Optional[bool] = None,
218218
**kwargs,
219219
) -> Union[AnyResource, Error, dict]:
220-
req = self.prepare_replace_request(
220+
req = self._prepare_replace_request(
221221
resource=resource,
222222
check_request_payload=check_request_payload,
223223
expected_status_codes=expected_status_codes,
@@ -252,7 +252,7 @@ def modify(
252252
raise_scim_errors: Optional[bool] = None,
253253
**kwargs,
254254
) -> Optional[Union[ResourceT, Error, dict]]:
255-
req = self.prepare_patch_request(
255+
req = self._prepare_patch_request(
256256
resource_model=resource_model,
257257
id=id,
258258
patch_op=patch_op,
@@ -311,7 +311,7 @@ async def create(
311311
raise_scim_errors: Optional[bool] = None,
312312
**kwargs,
313313
) -> Union[AnyResource, Error, dict]:
314-
req = self.prepare_create_request(
314+
req = self._prepare_create_request(
315315
resource=resource,
316316
check_request_payload=check_request_payload,
317317
expected_status_codes=expected_status_codes,
@@ -348,7 +348,7 @@ async def query(
348348
raise_scim_errors: Optional[bool] = None,
349349
**kwargs,
350350
):
351-
req = self.prepare_query_request(
351+
req = self._prepare_query_request(
352352
resource_model=resource_model,
353353
id=id,
354354
search_request=search_request,
@@ -385,7 +385,7 @@ async def search(
385385
raise_scim_errors: Optional[bool] = None,
386386
**kwargs,
387387
) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
388-
req = self.prepare_search_request(
388+
req = self._prepare_search_request(
389389
search_request=search_request,
390390
check_request_payload=check_request_payload,
391391
expected_status_codes=expected_status_codes,
@@ -420,7 +420,7 @@ async def delete(
420420
raise_scim_errors: Optional[bool] = None,
421421
**kwargs,
422422
) -> Optional[Union[Error, dict]]:
423-
req = self.prepare_delete_request(
423+
req = self._prepare_delete_request(
424424
resource_model=resource_model,
425425
id=id,
426426
expected_status_codes=expected_status_codes,
@@ -451,7 +451,7 @@ async def replace(
451451
raise_scim_errors: Optional[bool] = None,
452452
**kwargs,
453453
) -> Union[AnyResource, Error, dict]:
454-
req = self.prepare_replace_request(
454+
req = self._prepare_replace_request(
455455
resource=resource,
456456
check_request_payload=check_request_payload,
457457
expected_status_codes=expected_status_codes,
@@ -488,7 +488,7 @@ async def modify(
488488
raise_scim_errors: Optional[bool] = None,
489489
**kwargs,
490490
) -> Optional[Union[ResourceT, Error, dict]]:
491-
req = self.prepare_patch_request(
491+
req = self._prepare_patch_request(
492492
resource_model=resource_model,
493493
id=id,
494494
patch_op=patch_op,

‎scim2_client/engines/werkzeug.py‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ def __init__(
9090
self.scim_prefix = scim_prefix
9191
self.environ = environ or {}
9292

93-
def make_url(self, url: Optional[str]) -> str:
93+
def _make_url(self, url: Optional[str]) -> str:
9494
url = url or ""
9595
prefix = (
9696
self.scim_prefix[:-1]
@@ -114,15 +114,17 @@ def create(
114114
raise_scim_errors: Optional[bool] = None,
115115
**kwargs,
116116
) -> Union[AnyResource, Error, dict]:
117-
req = self.prepare_create_request(
117+
req = self._prepare_create_request(
118118
resource=resource,
119119
check_request_payload=check_request_payload,
120120
expected_status_codes=expected_status_codes,
121121
**kwargs,
122122
)
123123

124124
environ = {**self.environ, **req.request_kwargs}
125-
response = self.client.post(self.make_url(req.url), json=req.payload, **environ)
125+
response = self.client.post(
126+
self._make_url(req.url), json=req.payload, **environ
127+
)
126128

127129
with handle_response_error(req.payload):
128130
return self.check_response(
@@ -149,7 +151,7 @@ def query(
149151
raise_scim_errors: Optional[bool] = None,
150152
**kwargs,
151153
):
152-
req = self.prepare_query_request(
154+
req = self._prepare_query_request(
153155
resource_model=resource_model,
154156
id=id,
155157
search_request=search_request,
@@ -161,7 +163,7 @@ def query(
161163
query_string = urlencode(req.payload, doseq=False) if req.payload else None
162164
environ = {**self.environ, **req.request_kwargs}
163165
response = self.client.get(
164-
self.make_url(req.url), query_string=query_string, **environ
166+
self._make_url(req.url), query_string=query_string, **environ
165167
)
166168

167169
with handle_response_error(req.payload):
@@ -187,15 +189,17 @@ def search(
187189
raise_scim_errors: Optional[bool] = None,
188190
**kwargs,
189191
) -> Union[AnyResource, ListResponse[AnyResource], Error, dict]:
190-
req = self.prepare_search_request(
192+
req = self._prepare_search_request(
191193
search_request=search_request,
192194
check_request_payload=check_request_payload,
193195
expected_status_codes=expected_status_codes,
194196
**kwargs,
195197
)
196198

197199
environ = {**self.environ, **req.request_kwargs}
198-
response = self.client.post(self.make_url(req.url), json=req.payload, **environ)
200+
response = self.client.post(
201+
self._make_url(req.url), json=req.payload, **environ
202+
)
199203

200204
with handle_response_error(response):
201205
return self.check_response(
@@ -220,15 +224,15 @@ def delete(
220224
raise_scim_errors: Optional[bool] = None,
221225
**kwargs,
222226
) -> Optional[Union[Error, dict]]:
223-
req = self.prepare_delete_request(
227+
req = self._prepare_delete_request(
224228
resource_model=resource_model,
225229
id=id,
226230
expected_status_codes=expected_status_codes,
227231
**kwargs,
228232
)
229233

230234
environ = {**self.environ, **req.request_kwargs}
231-
response = self.client.delete(self.make_url(req.url), **environ)
235+
response = self.client.delete(self._make_url(req.url), **environ)
232236

233237
with handle_response_error(response):
234238
return self.check_response(
@@ -251,15 +255,15 @@ def replace(
251255
raise_scim_errors: Optional[bool] = None,
252256
**kwargs,
253257
) -> Union[AnyResource, Error, dict]:
254-
req = self.prepare_replace_request(
258+
req = self._prepare_replace_request(
255259
resource=resource,
256260
check_request_payload=check_request_payload,
257261
expected_status_codes=expected_status_codes,
258262
**kwargs,
259263
)
260264

261265
environ = {**self.environ, **req.request_kwargs}
262-
response = self.client.put(self.make_url(req.url), json=req.payload, **environ)
266+
response = self.client.put(self._make_url(req.url), json=req.payload, **environ)
263267

264268
with handle_response_error(response):
265269
return self.check_response(
@@ -286,7 +290,7 @@ def modify(
286290
raise_scim_errors: Optional[bool] = None,
287291
**kwargs,
288292
) -> Optional[Union[ResourceT, Error, dict]]:
289-
req = self.prepare_patch_request(
293+
req = self._prepare_patch_request(
290294
resource_model=resource_model,
291295
id=id,
292296
patch_op=patch_op,
@@ -297,7 +301,7 @@ def modify(
297301

298302
environ = {**self.environ, **req.request_kwargs}
299303
response = self.client.patch(
300-
self.make_url(req.url), json=req.payload, **environ
304+
self._make_url(req.url), json=req.payload, **environ
301305
)
302306

303307
with handle_response_error(response):

0 commit comments

Comments
 (0)