Skip to content

Commit 93ae040

Browse files
committed
Small fix to docstring
1 parent a0ca72c commit 93ae040

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

udsoncan/client.py

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2237,6 +2237,7 @@ def send_request(self, request: Request, timeout: int = -1) -> Optional[Response
22372237
def deauthenticate(self) -> Optional[services.Authentication.InterpretedResponse]:
22382238
"""
22392239
Sends a deAuthenticate request (sub function of Authentication Service) introduced in 2020 version of ISO-14229-1.
2240+
22402241
:Effective configuration: ``exception_on_<type>_response``
22412242
22422243
:return: The server response parsed by :meth:`Authentication.interpret_response<udsoncan.services.Authentication.interpret_response>`
@@ -2250,9 +2251,10 @@ def verify_certificate_unidirectional(self,
22502251
communication_configuration: int,
22512252
certificate_client: bytes,
22522253
challenge_client: Optional[bytes] = None) -> Optional[
2253-
services.Authentication.InterpretedResponse]:
2254+
services.Authentication.InterpretedResponse]:
22542255
"""
22552256
Sends a verifyCertificateUnidirectional request (sub function of Authentication Service)
2257+
22562258
:Effective configuration: ``exception_on_<type>_response``
22572259
22582260
:param communication_configuration: Configuration information about how to proceed with security in further diagnostic communication after the Authentication (vehicle manufacturer specific).
@@ -2273,15 +2275,16 @@ def verify_certificate_unidirectional(self,
22732275
communication_configuration=communication_configuration,
22742276
certificate_client=certificate_client,
22752277
challenge_client=challenge_client
2276-
)
2278+
)
22772279

22782280
def verify_certificate_bidirectional(self,
22792281
communication_configuration: int,
22802282
certificate_client: bytes,
22812283
challenge_client: bytes) -> Optional[
2282-
services.Authentication.InterpretedResponse]:
2284+
services.Authentication.InterpretedResponse]:
22832285
"""
22842286
Sends a verifyCertificateBidirectional request (sub function of Authentication Service)
2287+
22852288
:Effective configuration: ``exception_on_<type>_response``
22862289
22872290
:param communication_configuration: Configuration information about how to proceed with security in further diagnostic communication after the Authentication (vehicle manufacturer specific).
@@ -2302,14 +2305,15 @@ def verify_certificate_bidirectional(self,
23022305
communication_configuration=communication_configuration,
23032306
certificate_client=certificate_client,
23042307
challenge_client=challenge_client
2305-
)
2308+
)
23062309

23072310
def proof_of_ownership(self,
23082311
proof_of_ownership_client: bytes,
23092312
ephemeral_public_key_client: Optional[bytes] = None) -> Optional[
2310-
services.Authentication.InterpretedResponse]:
2313+
services.Authentication.InterpretedResponse]:
23112314
"""
23122315
Sends a proofOfOwnership request (sub function of Authentication Service)
2316+
23132317
:Effective configuration: ``exception_on_<type>_response``
23142318
23152319
:param proof_of_ownership_client: Proof of Ownership of the previous given challenge to be verified by the server.
@@ -2326,7 +2330,7 @@ def proof_of_ownership(self,
23262330
authentication_task=services.Authentication.AuthenticationTask.proofOfOwnership,
23272331
proof_of_ownership_client=proof_of_ownership_client,
23282332
ephemeral_public_key_client=ephemeral_public_key_client
2329-
)
2333+
)
23302334

23312335
def transmit_certificate(self,
23322336
certificate_evaluation_id: int,
@@ -2352,14 +2356,15 @@ def transmit_certificate(self,
23522356
authentication_task=services.Authentication.AuthenticationTask.transmitCertificate,
23532357
certificate_evaluation_id=certificate_evaluation_id,
23542358
certificate_data=certificate_data
2355-
)
2359+
)
23562360

23572361
def request_challenge_for_authentication(self,
23582362
communication_configuration: int,
23592363
algorithm_indicator: bytes) -> Optional[
2360-
services.Authentication.InterpretedResponse]:
2364+
services.Authentication.InterpretedResponse]:
23612365
"""
23622366
Sends a requestChallengeForAuthentication request (sub function of Authentication Service)
2367+
23632368
:Effective configuration: ``exception_on_<type>_response``
23642369
23652370
:param communication_configuration: Configuration information about how to proceed with security in further diagnostic communication after the Authentication (vehicle manufacturer specific).
@@ -2379,16 +2384,17 @@ def request_challenge_for_authentication(self,
23792384
authentication_task=services.Authentication.AuthenticationTask.requestChallengeForAuthentication,
23802385
communication_configuration=communication_configuration,
23812386
algorithm_indicator=algorithm_indicator
2382-
)
2387+
)
23832388

23842389
def verify_proof_of_ownership_unidirectional(self,
23852390
algorithm_indicator: bytes,
23862391
proof_of_ownership_client: bytes,
23872392
challenge_client: Optional[bytes] = None,
23882393
additional_parameter: Optional[bytes] = None) -> Optional[
2389-
services.Authentication.InterpretedResponse]:
2394+
services.Authentication.InterpretedResponse]:
23902395
"""
23912396
Sends a verifyProofOfOwnershipUnidirectional request (sub function of Authentication Service)
2397+
23922398
:Effective configuration: ``exception_on_<type>_response``
23932399
23942400
:param algorithm_indicator: Indicates the algorithm used in the generating and verifying Proof of Ownership (POWN),
@@ -2415,16 +2421,17 @@ def verify_proof_of_ownership_unidirectional(self,
24152421
proof_of_ownership_client=proof_of_ownership_client,
24162422
challenge_client=challenge_client,
24172423
additional_parameter=additional_parameter
2418-
)
2424+
)
24192425

24202426
def verify_proof_of_ownership_bidirectional(self,
24212427
algorithm_indicator: bytes,
24222428
proof_of_ownership_client: bytes,
24232429
challenge_client: bytes,
24242430
additional_parameter: Optional[bytes] = None) -> Optional[
2425-
services.Authentication.InterpretedResponse]:
2431+
services.Authentication.InterpretedResponse]:
24262432
"""
24272433
Sends a verifyProofOfOwnershipBidirectional request (sub function of Authentication Service)
2434+
24282435
:Effective configuration: ``exception_on_<type>_response``
24292436
24302437
:param algorithm_indicator: Indicates the algorithm used in the generating and verifying Proof of Ownership (POWN),
@@ -2451,7 +2458,7 @@ def verify_proof_of_ownership_bidirectional(self,
24512458
proof_of_ownership_client=proof_of_ownership_client,
24522459
challenge_client=challenge_client,
24532460
additional_parameter=additional_parameter
2454-
)
2461+
)
24552462

24562463
def authentication_configuration(self) -> Optional[services.Authentication.InterpretedResponse]:
24572464
"""
@@ -2478,9 +2485,10 @@ def authentication(self,
24782485
proof_of_ownership_client: Optional[bytes] = None,
24792486
ephemeral_public_key_client: Optional[bytes] = None,
24802487
additional_parameter: Optional[bytes] = None) -> Optional[
2481-
services.Authentication.InterpretedResponse]:
2488+
services.Authentication.InterpretedResponse]:
24822489
"""
24832490
Sends an Authentication request introduced in 2020 version of ISO-14229-1. You can also use the helper functions to send each authentication task (sub function).
2491+
24842492
:Effective configuration: ``exception_on_<type>_response``
24852493
24862494
:param authentication_task: The authenticationTask (subfunction) to use.

0 commit comments

Comments
 (0)