document usage @pcrespov

Author: bisgaard-itis

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

@@ -19,6 +19,23 @@
 
 
 class TaskFilter(BaseModel):
+    """
+    Class for associating metadata with a celery task. The implementation is very flexible and allows "clients" to define their own metadata.
+    The class exposes a filtering mechanism to list tasks using wildcards.
+
+    Example usage:
+        class MyTaskFilter(TaskFilter):
+            user_id: int | Wildcard
+            product_name: int | Wildcard
+            client_name: str
+
+        Listing tasks using the filter `MyTaskFilter(user_id=123, product_name=Wildcard, client_name="my-app")` will return all tasks with
+        user_id 123, any product_name submitted from my-app.
+
+    If the metadata schema is known, the class allows deserializing the metadata (recreate_as_model)
+
+    """
+
     model_config = ConfigDict(extra="allow")
 
     @model_validator(mode="after")
@@ -47,7 +64,7 @@ def get_task_id(self, task_uuid: TaskUUID | Literal["*"]) -> TaskID:
         )
 
     @classmethod
-    def recreate_model(cls, task_id: TaskID, model: type[ModelType]) -> ModelType:
+    def recreate_as_model(cls, task_id: TaskID, model: type[ModelType]) -> ModelType:
         filter_dict = cls.recreate_data(task_id)
         return model.model_validate(filter_dict)
 

packages/service-library/tests/test_celery.py

@@ -63,7 +63,7 @@ class MyModel(BaseModel):
     task_filter = TaskFilter.model_validate(mymodel.model_dump())
     task_uuid = TaskUUID(_faker.uuid4())
     task_id = task_filter.get_task_id(task_uuid)
-    assert TaskFilter.recreate_model(task_id=task_id, model=MyModel) == mymodel
+    assert TaskFilter.recreate_as_model(task_id=task_id, model=MyModel) == mymodel
 
 
 @pytest.mark.parametrize(