Merge pull request #97 from AlessioBugetti/move-worker-script

Move worker script

Author: igorbenav

README.md

@@ -561,7 +561,7 @@ First, you may want to take a look at the project structure and understand what
     ├── app                           # Main application directory.
     │   ├── __init__.py               # Initialization file for the app package.
     │   ├── main.py                   # Main entry point of the FastAPI application.
-    │   ├── worker.py                 # Worker script for background tasks.
+    │   │
     │   │
     │   ├── api                       # Folder containing API-related logic.
     │   │   ├── __init__.py
@@ -598,11 +598,16 @@ First, you may want to take a look at the project structure and understand what
     │   │   │   ├── cache_exceptions.py   # Exceptions related to cache operations.
     │   │   │   └── http_exceptions.py    # HTTP-related exceptions.
     │   │   │
-    │   │   └── utils                 # Utility functions and helpers.
+    │   │   ├── utils                 # Utility functions and helpers.
+    │   │   │   ├── __init__.py
+    │   │   │   ├── cache.py          # Cache-related utilities.
+    │   │   │   ├── queue.py          # Utilities for task queue management.
+    │   │   │   └── rate_limit.py     # Rate limiting utilities.
+    │   │   │
+    │   │   └── worker                # Worker script for background tasks.
     │   │       ├── __init__.py
-    │   │       ├── cache.py          # Cache-related utilities.
-    │   │       ├── queue.py          # Utilities for task queue management.
-    │   │       └── rate_limit.py     # Rate limiting utilities.
+    │   │       ├── settings.py       # Worker configuration and settings.
+    │   │       └── functions.py      # Async task definitions and management.
     │   │
     │   ├── crud                      # CRUD operations for the application.
     │   │   ├── __init__.py
@@ -1242,7 +1247,7 @@ For `client-side caching`, all you have to do is let the `Settings` class define
 
 ### 5.10 ARQ Job Queues
 
-Create the background task in `app/worker.py`:
+Create the background task in `app/core/worker/functions.py`:
 
 ```python
 ...
@@ -1252,7 +1257,7 @@ async def sample_background_task(ctx, name: str) -> str:
     return f"Task {name} is complete!"
 ```
 
-Then add the function to the `WorkerSettings` class `functions` variable:
+Then add the function to the `WorkerSettings` class `functions` variable in `app/core/worker/settings.py`:
 
 ```python
 # -------- class --------
@@ -1288,7 +1293,7 @@ If you are using `docker compose`, the worker is already running.
 If you are doing it from scratch, run while in the `root` folder:
 
 ```sh
-poetry run arq src.app.worker.WorkerSettings
+poetry run arq src.app.core.worker.settings.WorkerSettings
 ```
 
 ### 5.11 Rate Limiting
@@ -1469,7 +1474,7 @@ poetry run uvicorn src.app.main:app --reload
 And for the worker:
 
 ```sh
-poetry run arq src.app.worker.WorkerSettings
+poetry run arq src.app.core.worker.settings.WorkerSettings
 ```
 
 ## 6. Running in Production

docker-compose.yml

@@ -25,7 +25,7 @@ services:
     build:
       context: .
       dockerfile: Dockerfile
-    command: arq app.worker.WorkerSettings
+    command: arq app.core.worker.settings.WorkerSettings
     env_file:
       - ./src/.env
     depends_on:

src/app/core/worker/__init__.py

@@ -1,18 +1,12 @@
 import asyncio
 import logging
 import uvloop
-from arq.connections import RedisSettings
 from arq.worker import Worker
 
-from .core.config import settings
-
 asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
 
 logging.basicConfig(level=logging.INFO, format="%(asctime)s - %(name)s - %(levelname)s - %(message)s")
 
-REDIS_QUEUE_HOST = settings.REDIS_QUEUE_HOST
-REDIS_QUEUE_PORT = settings.REDIS_QUEUE_PORT
-
 
 # -------- background tasks --------
 async def sample_background_task(ctx: Worker, name: str) -> str:
@@ -27,12 +21,3 @@ async def startup(ctx: Worker) -> None:
 
 async def shutdown(ctx: Worker) -> None:
     logging.info("Worker end")
-
-
-# -------- class --------
-class WorkerSettings:
-    functions = [sample_background_task]
-    redis_settings = RedisSettings(host=REDIS_QUEUE_HOST, port=REDIS_QUEUE_PORT)
-    on_startup = startup
-    on_shutdown = shutdown
-    handle_signals = False

src/app/worker.py renamed to src/app/core/worker/functions.py

@@ -0,0 +1,14 @@
+from arq.connections import RedisSettings
+from ...core.config import settings
+from .functions import sample_background_task, startup, shutdown
+
+REDIS_QUEUE_HOST = settings.REDIS_QUEUE_HOST
+REDIS_QUEUE_PORT = settings.REDIS_QUEUE_PORT
+
+
+class WorkerSettings:
+    functions = [sample_background_task]
+    redis_settings = RedisSettings(host=REDIS_QUEUE_HOST, port=REDIS_QUEUE_PORT)
+    on_startup = startup
+    on_shutdown = shutdown
+    handle_signals = False