Skip to content

Dependencies

fastapi_gcp_tasks.dependencies

CloudTasksHeaders 

CloudTasksHeaders(
    x_cloudtasks_taskretrycount: int = Header(0),
    x_cloudtasks_taskexecutioncount: int = Header(0),
    x_cloudtasks_queuename: str = Header(""),
    x_cloudtasks_taskname: str = Header(""),
    x_cloudtasks_tasketa: float = Header(0),
    x_cloudtasks_taskpreviousresponse: int = Header(0),
    x_cloudtasks_taskretryreason: str = Header(""),
)

Extracts known headers sent by Cloud Tasks.

Full list: https://cloud.google.com/tasks/docs/creating-http-target-tasks#handler

Source code in fastapi_gcp_tasks/dependencies.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
def __init__(
    self,
    x_cloudtasks_taskretrycount: int = Header(0),
    x_cloudtasks_taskexecutioncount: int = Header(0),
    x_cloudtasks_queuename: str = Header(""),
    x_cloudtasks_taskname: str = Header(""),
    x_cloudtasks_tasketa: float = Header(0),
    x_cloudtasks_taskpreviousresponse: int = Header(0),
    x_cloudtasks_taskretryreason: str = Header(""),
) -> None:
    self.retry_count = x_cloudtasks_taskretrycount
    self.execution_count = x_cloudtasks_taskexecutioncount
    self.queue_name = x_cloudtasks_queuename
    self.task_name = x_cloudtasks_taskname
    self.eta = datetime.fromtimestamp(x_cloudtasks_tasketa)
    self.previous_response = x_cloudtasks_taskpreviousresponse
    self.retry_reason = x_cloudtasks_taskretryreason

max_retries 

max_retries(
    count: int = 20,
) -> Callable[[CloudTasksHeaders], bool]

Raises an http exception (with status 200) after max retries are exhausted.

Source code in fastapi_gcp_tasks/dependencies.py 
35
36
37
38
39
40
41
42
43
44
def max_retries(count: int = 20) -> Callable[[CloudTasksHeaders], bool]:
    """Raises an http exception (with status 200) after max retries are exhausted."""

    def retries_dep(meta: CloudTasksHeaders = Depends()) -> bool:
        # count starts from 0 so equality check is required
        if meta.retry_count >= count:
            raise HTTPException(status_code=200, detail="Max retries exhausted")
        return True

    return retries_dep