Skip to content

Commit 36d92ff

Browse files
committed
Several minor corrections @pcrespov
1 parent 7ede81b commit 36d92ff

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

packages/celery-library/src/celery_library/backends/_redis.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ async def get_task_progress(self, task_id: TaskID) -> ProgressReport | None:
7575
return None
7676

7777
async def list_tasks(self, task_filter: TaskFilter) -> list[Task]:
78-
search_key = _CELERY_TASK_INFO_PREFIX + task_filter.task_id("*")
78+
search_key = _CELERY_TASK_INFO_PREFIX + task_filter.get_task_id("*")
7979

8080
keys: list[str] = []
8181
pipeline = self._redis_client_sdk.redis.pipeline()
@@ -102,7 +102,7 @@ async def list_tasks(self, task_filter: TaskFilter) -> list[Task]:
102102
task_metadata = TaskMetadata.model_validate_json(raw_metadata)
103103
tasks.append(
104104
Task(
105-
uuid=TaskFilter.task_uuid(key),
105+
uuid=TaskFilter.get_task_uuid(key),
106106
metadata=task_metadata,
107107
)
108108
)

packages/celery-library/src/celery_library/task_manager.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ async def submit_task(
4949
msg=f"Submit {task_metadata.name=}: {task_filter=} {task_params=}",
5050
):
5151
task_uuid = uuid4()
52-
task_id = task_filter.task_id(task_uuid=task_uuid)
52+
task_id = task_filter.get_task_id(task_uuid=task_uuid)
5353
self._celery_app.send_task(
5454
task_metadata.name,
5555
task_id=task_id,
@@ -77,7 +77,7 @@ async def cancel_task(self, task_filter: TaskFilter, task_uuid: TaskUUID) -> Non
7777
logging.DEBUG,
7878
msg=f"task cancellation: {task_filter=} {task_uuid=}",
7979
):
80-
task_id = task_filter.task_id(task_uuid=task_uuid)
80+
task_id = task_filter.get_task_id(task_uuid=task_uuid)
8181
if not (await self.get_task_status(task_filter, task_uuid)).is_done:
8282
await self._abort_task(task_id)
8383
await self._task_info_store.remove_task(task_id)
@@ -94,7 +94,7 @@ async def get_task_result(
9494
logging.DEBUG,
9595
msg=f"Get task result: {task_filter=} {task_uuid=}",
9696
):
97-
task_id = task_filter.task_id(task_uuid=task_uuid)
97+
task_id = task_filter.get_task_id(task_uuid=task_uuid)
9898
async_result = self._celery_app.AsyncResult(task_id)
9999
result = async_result.result
100100
if async_result.ready():
@@ -108,7 +108,7 @@ async def _get_task_progress_report(
108108
self, task_filter: TaskFilter, task_uuid: TaskUUID, task_state: TaskState
109109
) -> ProgressReport:
110110
if task_state in (TaskState.STARTED, TaskState.RETRY, TaskState.ABORTED):
111-
task_id = task_filter.task_id(task_uuid=task_uuid)
111+
task_id = task_filter.get_task_id(task_uuid=task_uuid)
112112
progress = await self._task_info_store.get_task_progress(task_id)
113113
if progress is not None:
114114
return progress
@@ -137,7 +137,7 @@ async def get_task_status(
137137
logging.DEBUG,
138138
msg=f"Getting task status: {task_filter=} {task_uuid=}",
139139
):
140-
task_id = task_filter.task_id(task_uuid=task_uuid)
140+
task_id = task_filter.get_task_id(task_uuid=task_uuid)
141141
task_state = await self._get_task_celery_state(task_id)
142142
return TaskStatus(
143143
task_uuid=task_uuid,

packages/service-library/src/servicelib/celery/models.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from pydantic import BaseModel, ConfigDict, StringConstraints, model_validator
88
from pydantic.config import JsonDict
99

10-
T = TypeVar("T", bound=BaseModel)
10+
ModelType = TypeVar("ModelType", bound=BaseModel)
1111

1212
TaskID: TypeAlias = str
1313
TaskName: TypeAlias = Annotated[
@@ -41,20 +41,20 @@ def _build_task_id_prefix(self) -> str:
4141
[f"{key}={filter_dict[key]}" for key in sorted(filter_dict)]
4242
)
4343

44-
def task_id(self, task_uuid: TaskUUID | Literal["*"]) -> TaskID:
44+
def get_task_id(self, task_uuid: TaskUUID | Literal["*"]) -> TaskID:
4545
return _TASK_ID_KEY_DELIMITATOR.join(
4646
[self._build_task_id_prefix(), f"task_uuid={task_uuid}"]
4747
)
4848

4949
@classmethod
50-
def recreate_model(cls, task_id: TaskID, model: type[T]) -> T:
50+
def recreate_model(cls, task_id: TaskID, model: type[ModelType]) -> ModelType:
5151
filter_dict = cls.recreate_data(task_id)
5252
return model.model_validate(filter_dict)
5353

5454
@classmethod
5555
def recreate_data(cls, task_id: TaskID) -> dict[str, Any]:
5656
"""Recreates the filter data from a task_id string
57-
Careful: does not validate types. For that use `recreate_model` instead
57+
WARNING: does not validate types. For that use `recreate_model` instead
5858
"""
5959
try:
6060
parts = task_id.split(_TASK_ID_KEY_DELIMITATOR)
@@ -67,7 +67,7 @@ def recreate_data(cls, task_id: TaskID) -> dict[str, Any]:
6767
raise ValueError(f"Invalid task_id format: {task_id}") from err
6868

6969
@classmethod
70-
def task_uuid(cls, task_id: TaskID) -> TaskUUID:
70+
def get_task_uuid(cls, task_id: TaskID) -> TaskUUID:
7171
try:
7272
return UUID(task_id.split(_TASK_ID_KEY_DELIMITATOR)[-1].split("=")[1])
7373
except (IndexError, ValueError) as err:

packages/service-library/tests/test_celery.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ async def test_task_filter_task_uuid(
4747
):
4848
task_filter = TaskFilter.model_validate(task_filter_data)
4949
task_uuid = TaskUUID(_faker.uuid4())
50-
task_id = task_filter.task_id(task_uuid)
51-
assert TaskFilter.task_uuid(task_id=task_id) == task_uuid
50+
task_id = task_filter.get_task_id(task_uuid)
51+
assert TaskFilter.get_task_uuid(task_id=task_id) == task_uuid
5252

5353

5454
async def test_create_task_filter_from_task_id():
@@ -62,7 +62,7 @@ class MyModel(BaseModel):
6262
mymodel = MyModel(_int=1, _bool=True, _str="test", _list=["a", "b"])
6363
task_filter = TaskFilter.model_validate(mymodel.model_dump())
6464
task_uuid = TaskUUID(_faker.uuid4())
65-
task_id = task_filter.task_id(task_uuid)
65+
task_id = task_filter.get_task_id(task_uuid)
6666
assert TaskFilter.recreate_model(task_id=task_id, model=MyModel) == mymodel
6767

6868

0 commit comments

Comments
 (0)