fastapi-progress 0.1.1__tar.gz → 0.1.2__tar.gz

{fastapi_progress-0.1.1 → fastapi_progress-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fastapi-progress
-Version: 0.1.1
+Version: 0.1.2
 Summary: Zero-config background task progress tracker for FastAPI using WebSockets.
 Author: Aldair Andrade
 Author-email: Aldair Andrade <demianmaster2003@gmail.com>

{fastapi_progress-0.1.1 → fastapi_progress-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-progress"
-version = "0.1.1"
+version = "0.1.2"
 description = "Zero-config background task progress tracker for FastAPI using WebSockets."
 readme = "README.md"
 authors = [

{fastapi_progress-0.1.1 → fastapi_progress-0.1.2}/src/fastapi_progress/context.py

@@ -6,6 +6,7 @@ current_task_id: ContextVar[str | None] = ContextVar("current_task_id", default=
 
 class Progress:
     async def update(self, progress: int, message: str = "", metadata: dict[str, Any] | None = None) -> None:
+        # Updates task progress
         task_id = current_task_id.get()
         if task_id:
             backend = get_backend()

{fastapi_progress-0.1.1 → fastapi_progress-0.1.2}/src/fastapi_progress/core.py

@@ -5,6 +5,7 @@ from .globals import set_backend, get_backend
 from .state.base import StateBackend
 
 def init_progress(app: FastAPI, backend: StateBackend | None = None, prefix: str = "/ws/progress") -> None:
+    # Injects WebSocket route into FastAPI
     if backend:
         set_backend(backend)
 

{fastapi_progress-0.1.1 → fastapi_progress-0.1.2}/src/fastapi_progress/decorators.py

@@ -9,6 +9,7 @@ P = ParamSpec("P")
 R = TypeVar("R")
 
 def track_progress(task_id_param: str | None = None) -> Callable[[Callable[P, Coroutine[Any, Any, R]]], Callable[P, Coroutine[Any, Any, R]]]:
+    # Tracks background task progress
     def decorator(func: Callable[P, Coroutine[Any, Any, R]]) -> Callable[P, Coroutine[Any, Any, R]]:
         @wraps(func)
         async def wrapper(*args: P.args, **kwargs: P.kwargs) -> R: