Skip to content

remove duplicate __init__ docstring in AutoLockRenewer #40562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
l0lawrence merged 1 commit into from
Apr 18, 2025
Merged

remove duplicate __init__ docstring in AutoLockRenewer #40562

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 2 additions & 18 deletions sdk/servicebus/azure-servicebus/azure/servicebus/_common/auto_lock_renewer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

class AutoLockRenewer(object): # pylint:disable=too-many-instance-attributes
"""Auto renew locks for messages and sessions using a background thread pool.
When handling multiple messages or sessions concurrently,
set `max_workers` high or pass a ThreadPoolExecutor with sufficient `max_workers`.

:param max_lock_renewal_duration: A time in seconds that locks registered to this renewer
should be maintained for. Default value is 300 (5 minutes).
Expand Down Expand Up @@ -71,24 +73,6 @@ def __init__(
executor: Optional[ThreadPoolExecutor] = None,
max_workers: Optional[int] = None,
) -> None:
"""Auto renew locks for messages and sessions using a background thread pool. It is recommended
setting max_worker to a large number or passing ThreadPoolExecutor of large max_workers number when
AutoLockRenewer is supposed to deal with multiple messages or sessions simultaneously.

:param max_lock_renewal_duration: A time in seconds that locks registered to this renewer
should be maintained for. Default value is 300 (5 minutes).
:type max_lock_renewal_duration: float
:param on_lock_renew_failure: A callback may be specified to be called when the lock is lost on the renewable
that is being registered. Default value is None (no callback).
:type on_lock_renew_failure: Optional[LockRenewFailureCallback]
:param executor: A user-specified thread pool. This cannot be combined with
setting `max_workers`.
:type executor: Optional[~concurrent.futures.ThreadPoolExecutor]
:param max_workers: Specify the maximum workers in the thread pool. If not
specified the number used will be derived from the core count of the environment.
This cannot be combined with `executor`.
:type max_workers: Optional[int]
"""
self._executor = executor or ThreadPoolExecutor(max_workers=max_workers)
# None indicates it's unknown whether the provided executor has max workers > 1
self._is_max_workers_greater_than_one = None if executor else (max_workers is None or max_workers > 1)
Expand Down