refactor: Renamed param service_name to master_name.

Author: David Grigorenko

taskiq_redis/redis_backend.py

@@ -297,7 +297,7 @@ class RedisSentinelAsyncResultBackend(AsyncResultBackend[_ReturnType]):
     def __init__(
         self,
         sentinels: List[Tuple[str, int]],
-        service_name: str,
+        master_name: str,
         keep_results: bool = True,
         result_ex_time: Optional[int] = None,
         result_px_time: Optional[int] = None,
@@ -309,7 +309,7 @@ def __init__(
         Constructs a new result backend.
 
         :param sentinels: list of sentinel host and ports pairs.
-        :param service_name: sentinel master name.
+        :param master_name: sentinel master name.
         :param keep_results: flag to not remove results from Redis after reading.
         :param result_ex_time: expire time in seconds for result.
         :param result_px_time: expire time in milliseconds for result.
@@ -327,7 +327,7 @@ def __init__(
             sentinel_kwargs=sentinel_kwargs,
             **connection_kwargs,
         )
-        self.service_name = service_name
+        self.master_name = master_name
         self.keep_results = keep_results
         self.result_ex_time = result_ex_time
         self.result_px_time = result_px_time
@@ -350,7 +350,7 @@ def __init__(
 
     @asynccontextmanager
     async def _acquire_master_conn(self) -> AsyncIterator[_Redis]:
-        async with self.sentinel.master_for(self.service_name) as redis_conn:
+        async with self.sentinel.master_for(self.master_name) as redis_conn:
             yield redis_conn
 
     async def set_result(

taskiq_redis/redis_sentinel_broker.py

@@ -38,7 +38,7 @@ class BaseSentinelBroker(AsyncBroker):
     def __init__(
         self,
         sentinels: List[Tuple[str, int]],
-        service_name: str,
+        master_name: str,
         result_backend: Optional[AsyncResultBackend[_T]] = None,
         task_id_generator: Optional[Callable[[], str]] = None,
         queue_name: str = "taskiq",
@@ -57,12 +57,12 @@ def __init__(
             sentinel_kwargs=sentinel_kwargs,
             **connection_kwargs,
         )
-        self.service_name = service_name
+        self.master_name = master_name
         self.queue_name = queue_name
 
     @asynccontextmanager
     async def _acquire_master_conn(self) -> AsyncIterator[_Redis]:
-        async with self.sentinel.master_for(self.service_name) as redis_conn:
+        async with self.sentinel.master_for(self.master_name) as redis_conn:
             yield redis_conn
 
 

taskiq_redis/schedule_source.py

@@ -202,7 +202,7 @@ class RedisSentinelScheduleSource(ScheduleSource):
     Also it supports dynamic schedules.
 
     :param sentinels: list of sentinel host and ports pairs.
-    :param service_name: sentinel master name.
+    :param master_name: sentinel master name.
     :param prefix: prefix for redis schedule keys.
     :param buffer_size: buffer size for redis scan.
         This is how many keys will be fetched at once.
@@ -214,7 +214,7 @@ class RedisSentinelScheduleSource(ScheduleSource):
     def __init__(
         self,
         sentinels: List[Tuple[str, int]],
-        service_name: str,
+        master_name: str,
         prefix: str = "schedule",
         buffer_size: int = 50,
         serializer: Optional[TaskiqSerializer] = None,
@@ -229,15 +229,15 @@ def __init__(
             sentinel_kwargs=sentinel_kwargs,
             **connection_kwargs,
         )
-        self.service_name = service_name
+        self.master_name = master_name
         self.buffer_size = buffer_size
         if serializer is None:
             serializer = PickleSerializer()
         self.serializer = serializer
 
     @asynccontextmanager
     async def _acquire_master_conn(self) -> AsyncIterator[_Redis]:
-        async with self.sentinel.master_for(self.service_name) as redis_conn:
+        async with self.sentinel.master_for(self.master_name) as redis_conn:
             yield redis_conn
 
     async def delete_schedule(self, schedule_id: str) -> None:

tests/test_broker.py

@@ -190,7 +190,7 @@ async def test_list_queue_sentinel_broker(
     """
     broker = ListQueueSentinelBroker(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         queue_name=uuid.uuid4().hex,
     )
     worker_task = asyncio.create_task(get_message(broker))

tests/test_result_backend.py

@@ -308,7 +308,7 @@ async def test_set_result_success_sentinel(
     """
     result_backend = RedisSentinelAsyncResultBackend(  # type: ignore
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
     )
     task_id = uuid.uuid4().hex
     result: "TaskiqResult[int]" = TaskiqResult(
@@ -346,7 +346,7 @@ async def test_fetch_without_logs_sentinel(
     """
     result_backend = RedisSentinelAsyncResultBackend(  # type: ignore
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
     )
     task_id = uuid.uuid4().hex
     result: "TaskiqResult[int]" = TaskiqResult(
@@ -384,7 +384,7 @@ async def test_remove_results_after_reading_sentinel(
     """
     result_backend = RedisSentinelAsyncResultBackend(  # type: ignore
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         keep_results=False,
     )
     task_id = uuid.uuid4().hex
@@ -419,7 +419,7 @@ async def test_keep_results_after_reading_sentinel(
     """
     result_backend = RedisSentinelAsyncResultBackend(  # type: ignore
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         keep_results=True,
     )
     task_id = uuid.uuid4().hex

tests/test_schedule_source.py

@@ -235,7 +235,7 @@ async def test_sentinel_set_schedule(
     prefix = uuid.uuid4().hex
     source = RedisSentinelScheduleSource(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         prefix=prefix,
     )
     schedule = ScheduledTask(
@@ -259,7 +259,7 @@ async def test_sentinel_delete_schedule(
     prefix = uuid.uuid4().hex
     source = RedisSentinelScheduleSource(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         prefix=prefix,
     )
     schedule = ScheduledTask(
@@ -287,7 +287,7 @@ async def test_sentinel_post_run_cron(
     prefix = uuid.uuid4().hex
     source = RedisSentinelScheduleSource(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         prefix=prefix,
     )
     schedule = ScheduledTask(
@@ -312,7 +312,7 @@ async def test_sentinel_post_run_time(
     prefix = uuid.uuid4().hex
     source = RedisSentinelScheduleSource(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         prefix=prefix,
     )
     schedule = ScheduledTask(
@@ -337,7 +337,7 @@ async def test_sentinel_buffer(
     prefix = uuid.uuid4().hex
     source = RedisSentinelScheduleSource(
         sentinels=redis_sentinels,
-        service_name=redis_sentinel_master_name,
+        master_name=redis_sentinel_master_name,
         prefix=prefix,
         buffer_size=1,
     )