Skip to content

Commit 0b0d3ca

Browse files
committed
Review comments
1 parent 9b7853b commit 0b0d3ca

File tree

1 file changed

+24
-28
lines changed

1 file changed

+24
-28
lines changed

src/apify_client/clients/resource_clients/request_queue.py

Lines changed: 24 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -220,18 +220,18 @@ def get_request(self, request_id: str) -> dict | None:
220220

221221
return None
222222

223-
def get_request_by_unique_key(self, request_unique_key: str) -> dict | None:
223+
def get_request_by_unique_key(self, unique_key: str) -> dict | None:
224224
"""Retrieve a request from the queue.
225225
226226
https://docs.apify.com/api/v2#/reference/request-queues/request/get-request
227227
228228
Args:
229-
request_unique_key: Unique key of the request to retrieve.
229+
unique_key: Unique key of the request to retrieve.
230230
231231
Returns:
232232
The retrieved request, or None, if it did not exist.
233233
"""
234-
return self.get_request(unique_key_to_request_id(request_unique_key))
234+
return self.get_request(unique_key_to_request_id(unique_key))
235235

236236
def update_request(self, request: dict, *, forefront: bool | None = None) -> dict:
237237
"""Update a request in the queue.
@@ -278,15 +278,15 @@ def delete_request(self, request_id: str) -> None:
278278
timeout_secs=_SMALL_TIMEOUT,
279279
)
280280

281-
def delete_request_by_unique_key(self, request_unique_key: str) -> None:
281+
def delete_request_by_unique_key(self, unique_key: str) -> None:
282282
"""Delete a request from the queue.
283283
284284
https://docs.apify.com/api/v2#/reference/request-queues/request/delete-request
285285
286286
Args:
287-
request_unique_key: Unique key of the request to delete.
287+
unique_key: Unique key of the request to delete.
288288
"""
289-
return self.delete_request(unique_key_to_request_id(request_unique_key))
289+
return self.delete_request(unique_key_to_request_id(unique_key))
290290

291291
def prolong_request_lock(
292292
self,
@@ -317,7 +317,7 @@ def prolong_request_lock(
317317

318318
def prolong_request_lock_by_unique_key(
319319
self,
320-
request_unique_key: str,
320+
unique_key: str,
321321
*,
322322
forefront: bool | None = None,
323323
lock_secs: int,
@@ -327,13 +327,11 @@ def prolong_request_lock_by_unique_key(
327327
https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock
328328
329329
Args:
330-
request_unique_key: Unique key of the request to prolong the lock.
330+
unique_key: Unique key of the request to prolong the lock.
331331
forefront: Whether to put the request in the beginning or the end of the queue after lock expires.
332332
lock_secs: By how much to prolong the lock, in seconds.
333333
"""
334-
return self.prolong_request_lock(
335-
unique_key_to_request_id(request_unique_key), forefront=forefront, lock_secs=lock_secs
336-
)
334+
return self.prolong_request_lock(unique_key_to_request_id(unique_key), forefront=forefront, lock_secs=lock_secs)
337335

338336
def delete_request_lock(self, request_id: str, *, forefront: bool | None = None) -> None:
339337
"""Delete the lock on a request.
@@ -353,16 +351,16 @@ def delete_request_lock(self, request_id: str, *, forefront: bool | None = None)
353351
timeout_secs=_SMALL_TIMEOUT,
354352
)
355353

356-
def delete_request_lock_by_unique_key(self, request_unique_key: str, *, forefront: bool | None = None) -> None:
354+
def delete_request_lock_by_unique_key(self, unique_key: str, *, forefront: bool | None = None) -> None:
357355
"""Delete the lock on a request.
358356
359357
https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock
360358
361359
Args:
362-
request_unique_key: Unique key of the request to delete the lock.
360+
unique_key: Unique key of the request to delete the lock.
363361
forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted.
364362
"""
365-
return self.delete_request_lock(unique_key_to_request_id(request_unique_key), forefront=forefront)
363+
return self.delete_request_lock(unique_key_to_request_id(unique_key), forefront=forefront)
366364

367365
def batch_add_requests(
368366
self,
@@ -654,18 +652,18 @@ async def get_request(self, request_id: str) -> dict | None:
654652

655653
return None
656654

657-
async def get_request_by_unique_key(self, request_unique_key: str) -> dict | None:
655+
async def get_request_by_unique_key(self, unique_key: str) -> dict | None:
658656
"""Retrieve a request from the queue.
659657
660658
https://docs.apify.com/api/v2#/reference/request-queues/request/get-request
661659
662660
Args:
663-
request_unique_key: Unique key of the request to retrieve.
661+
unique_key: Unique key of the request to retrieve.
664662
665663
Returns:
666664
The retrieved request, or None, if it did not exist.
667665
"""
668-
return await self.get_request(unique_key_to_request_id(request_unique_key))
666+
return await self.get_request(unique_key_to_request_id(unique_key))
669667

670668
async def update_request(self, request: dict, *, forefront: bool | None = None) -> dict:
671669
"""Update a request in the queue.
@@ -710,15 +708,15 @@ async def delete_request(self, request_id: str) -> None:
710708
timeout_secs=_SMALL_TIMEOUT,
711709
)
712710

713-
async def delete_request_by_unique_key(self, request_unique_key: str) -> None:
711+
async def delete_request_by_unique_key(self, unique_key: str) -> None:
714712
"""Delete a request from the queue.
715713
716714
https://docs.apify.com/api/v2#/reference/request-queues/request/delete-request
717715
718716
Args:
719-
request_unique_key: Unique key of the request to delete.
717+
unique_key: Unique key of the request to delete.
720718
"""
721-
return await self.delete_request(unique_key_to_request_id(request_unique_key))
719+
return await self.delete_request(unique_key_to_request_id(unique_key))
722720

723721
async def prolong_request_lock(
724722
self,
@@ -749,7 +747,7 @@ async def prolong_request_lock(
749747

750748
async def prolong_request_lock_by_unique_key(
751749
self,
752-
request_unique_key: str,
750+
unique_key: str,
753751
*,
754752
forefront: bool | None = None,
755753
lock_secs: int,
@@ -759,12 +757,12 @@ async def prolong_request_lock_by_unique_key(
759757
https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock
760758
761759
Args:
762-
request_unique_key: Unique key of the request to prolong the lock.
760+
unique_key: Unique key of the request to prolong the lock.
763761
forefront: Whether to put the request in the beginning or the end of the queue after lock expires.
764762
lock_secs: By how much to prolong the lock, in seconds.
765763
"""
766764
return await self.prolong_request_lock(
767-
unique_key_to_request_id(request_unique_key), forefront=forefront, lock_secs=lock_secs
765+
unique_key_to_request_id(unique_key), forefront=forefront, lock_secs=lock_secs
768766
)
769767

770768
async def delete_request_lock(
@@ -790,18 +788,16 @@ async def delete_request_lock(
790788
timeout_secs=_SMALL_TIMEOUT,
791789
)
792790

793-
async def delete_request_lock_by_unique_key(
794-
self, request_unique_key: str, *, forefront: bool | None = None
795-
) -> None:
791+
async def delete_request_lock_by_unique_key(self, unique_key: str, *, forefront: bool | None = None) -> None:
796792
"""Delete the lock on a request.
797793
798794
https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock
799795
800796
Args:
801-
request_unique_key: Unique key of the request to delete the lock.
797+
unique_key: Unique key of the request to delete the lock.
802798
forefront: Whether to put the request in the beginning or the end of the queue after the lock is deleted.
803799
"""
804-
return await self.delete_request_lock(unique_key_to_request_id(request_unique_key), forefront=forefront)
800+
return await self.delete_request_lock(unique_key_to_request_id(unique_key), forefront=forefront)
805801

806802
async def _batch_add_requests_worker(
807803
self,

0 commit comments

Comments
 (0)