rrq 0.3.5__py3-none-any.whl → 0.3.7__py3-none-any.whl

rrq/cli.py

@@ -18,6 +18,14 @@ from .settings import RRQSettings
 from .store import JobStore
 from .worker import RRQWorker
 
+# Attempt to import dotenv components for .env file loading
+try:
+    from dotenv import find_dotenv, load_dotenv
+
+    DOTENV_AVAILABLE = True
+except ImportError:
+    DOTENV_AVAILABLE = False
+
 logger = logging.getLogger(__name__)
 
 
@@ -28,12 +36,21 @@ def _load_app_settings(settings_object_path: str | None = None) -> RRQSettings:
     If the environment variable is not set, will create a default settings object.
     RRQ Setting objects, automatically pick up ENVIRONMENT variables starting with RRQ_.
 
+    This function will also attempt to load a .env file if python-dotenv is installed
+    and a .env file is found. System environment variables take precedence over .env variables.
+
     Args:
         settings_object_path: A string representing the path to the settings object. (e.g. "myapp.worker_config.rrq_settings").
 
     Returns:
         The RRQSettings object.
     """
+    if DOTENV_AVAILABLE:
+        dotenv_path = find_dotenv(usecwd=True)
+        if dotenv_path:
+            logger.debug(f"Loading .env file at: {dotenv_path}...")
+            load_dotenv(dotenv_path=dotenv_path, override=False)
+
     try:
         if settings_object_path is None:
             settings_object_path = os.getenv("RRQ_SETTINGS")
@@ -153,12 +170,10 @@ def start_rrq_worker_subprocess(
 ) -> subprocess.Popen | None:
     """Start an RRQ worker process, optionally for specific queues."""
     command = ["rrq", "worker", "run"]
+
     if settings_object_path:
         command.extend(["--settings", settings_object_path])
-    else:
-        raise ValueError(
-            "start_rrq_worker_subprocess called without settings_object_path!"
-        )
+
     # Add queue filters if specified
     if queues:
         for q in queues:
@@ -220,16 +235,6 @@ async def watch_rrq_worker_impl(
     settings_object_path: str | None = None,
     queues: list[str] | None = None,
 ) -> None:
-    if not settings_object_path:
-        click.echo(
-            click.style(
-                "ERROR: 'rrq worker watch' requires --settings to be specified.",
-                fg="red",
-            ),
-            err=True,
-        )
-        sys.exit(1)
-
     abs_watch_path = os.path.abspath(watch_path)
     click.echo(
         f"Watching for file changes in {abs_watch_path} to restart RRQ worker (app settings: {settings_object_path})..."
@@ -295,7 +300,7 @@ def rrq():
     """RRQ: Reliable Redis Queue Command Line Interface.
 
     Provides tools for running RRQ workers, checking system health,
-    and managing jobs. Requires an application-specific --settings module
+    and managing jobs. Requires an application-specific settings object
     for most operations.
     """
     pass
@@ -329,6 +334,7 @@ def worker_cli():
     help=(
         "Python settings path for application worker settings "
         "(e.g., myapp.worker_config.rrq_settings). "
+        "Alternatively, this can be specified as RRQ_SETTINGS env variable. "
         "The specified settings object must include a `job_registry: JobRegistry`."
     ),
 )
@@ -337,7 +343,9 @@ def worker_run_command(
     queues: tuple[str, ...],
     settings_object_path: str,
 ):
-    """Run an RRQ worker process. Requires --settings."""
+    """Run an RRQ worker process.
+    Requires an application-specific settings object.
+    """
     rrq_settings = _load_app_settings(settings_object_path)
 
     # Determine queues to poll
@@ -418,7 +426,9 @@ def worker_watch_command(
     settings_object_path: str,
     queues: tuple[str, ...],
 ):
-    """Run the RRQ worker with auto-restart on file changes in PATH. Requires --settings."""
+    """Run the RRQ worker with auto-restart on file changes in PATH.
+    Requires an application-specific settings object.
+    """
     # Run watch with optional queue filters
     asyncio.run(
         watch_rrq_worker_impl(
@@ -446,7 +456,9 @@ def worker_watch_command(
     ),
 )
 def check_command(settings_object_path: str):
-    """Perform a health check on active RRQ worker(s). Requires --settings."""
+    """Perform a health check on active RRQ worker(s).
+    Requires an application-specific settings object.
+    """
     click.echo("Performing RRQ health check...")
     healthy = asyncio.run(
         check_health_async_impl(settings_object_path=settings_object_path)

{rrq-0.3.5.dist-info → rrq-0.3.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rrq
-Version: 0.3.5
+Version: 0.3.7
 Summary: RRQ is a Python library for creating reliable job queues using Redis and asyncio
 Project-URL: Homepage, https://github.com/getresq/rrq
 Project-URL: Bug Tracker, https://github.com/getresq/rrq/issues
@@ -29,18 +29,6 @@ Description-Content-Type: text/markdown
 
 RRQ is a Python library for creating reliable job queues using Redis and `asyncio`, inspired by [ARQ (Async Redis Queue)](https://github.com/samuelcolvin/arq). It focuses on providing at-least-once job processing semantics with features like automatic retries, job timeouts, dead-letter queues, and graceful worker shutdown.
 
-## Core Components
-
-*   **`RRQClient` (`client.py`)**: Used to enqueue jobs onto specific queues. Supports deferring jobs (by time delta or specific datetime), assigning custom job IDs, and enforcing job uniqueness via keys.
-*   **`RRQWorker` (`worker.py`)**: The process that polls queues, fetches jobs, executes the corresponding handler functions, and manages the job lifecycle based on success, failure, retries, or timeouts. Handles graceful shutdown via signals (SIGINT, SIGTERM).
-*   **`JobRegistry` (`registry.py`)**: A simple registry to map string function names (used when enqueuing) to the actual asynchronous handler functions the worker should execute.
-*   **`JobStore` (`store.py`)**: An abstraction layer handling all direct interactions with Redis. It manages job definitions (Hashes), queues (Sorted Sets), processing locks (Strings with TTL), unique job locks, and worker health checks.
-*   **`Job` (`job.py`)**: A Pydantic model representing a job, containing its ID, handler name, arguments, status, retry counts, timestamps, results, etc.
-*   **`JobStatus` (`job.py`)**: An Enum defining the possible states of a job (`PENDING`, `ACTIVE`, `COMPLETED`, `FAILED`, `RETRYING`).
-*   **`RRQSettings` (`settings.py`)**: A Pydantic `BaseSettings` model for configuring RRQ behavior (Redis DSN, queue names, timeouts, retry policies, concurrency, etc.). Loadable from environment variables (prefix `RRQ_`).
-*   **`constants.py`**: Defines shared constants like Redis key prefixes and default configuration values.
-*   **`exc.py`**: Defines custom exceptions, notably `RetryJob` which handlers can raise to explicitly request a retry, potentially with a custom delay.
-
 ## Key Features
 
 *   **At-Least-Once Semantics**: Uses Redis locks to ensure a job is processed by only one worker at a time. If a worker crashes or shuts down mid-processing, the lock expires, and the job *should* be re-processed (though re-queueing on unclean shutdown isn't implemented here yet - graceful shutdown *does* re-queue).
@@ -52,8 +40,10 @@ RRQ is a Python library for creating reliable job queues using Redis and `asynci
 *   **Graceful Shutdown**: Workers listen for SIGINT/SIGTERM and attempt to finish active jobs within a grace period before exiting. Interrupted jobs are re-queued.
 *   **Worker Health Checks**: Workers periodically update a health key in Redis with a TTL, allowing monitoring systems to track active workers.
 *   **Deferred Execution**: Jobs can be scheduled to run at a future time using `_defer_by` or `_defer_until`.
-    *Note: Using deferral with a specific `_job_id` will effectively reschedule the job associated with that ID to the new time, overwriting its previous definition and score. It does not create multiple distinct scheduled jobs with the same ID.*
-    *To batch multiple enqueue calls into a single deferred job (and prevent duplicates within the defer window), combine `_unique_key` with `_defer_by`. For example:*
+
+    - Using deferral with a specific `_job_id` will effectively reschedule the job associated with that ID to the new time, overwriting its previous definition and score. It does not create multiple distinct scheduled jobs with the same ID.
+
+    - To batch multiple enqueue calls into a single deferred job (and prevent duplicates within the defer window), combine `_unique_key` with `_defer_by`. For example:
 
       ```python
       await client.enqueue(
@@ -129,6 +119,9 @@ if __name__ == "__main__":
 
 **5. Run a Worker:**
 
+Note: You don't need to run a worker as the Command Line Interface `rrq` is used for
+this purpose.
+
 ```python
 # worker_script.py
 from rrq.worker import RRQWorker
@@ -145,61 +138,47 @@ if __name__ == "__main__":
 
 You can run multiple instances of `worker_script.py` for concurrent processing.
 
-## Configuration
-
-RRQ behavior is configured via the `RRQSettings` object, which loads values from environment variables prefixed with `RRQ_` by default. Key settings include:
-
-*   `RRQ_REDIS_DSN`: Connection string for Redis.
-*   `RRQ_DEFAULT_QUEUE_NAME`: Default queue name.
-*   `RRQ_DEFAULT_MAX_RETRIES`: Default retry limit.
-*   `RRQ_DEFAULT_JOB_TIMEOUT_SECONDS`: Default job timeout.
-*   `RRQ_WORKER_CONCURRENCY`: Max concurrent jobs per worker.
-*   ... and others (see `settings.py`).
-
-## RRQ CLI
-
-RRQ provides a command-line interface (CLI) for interacting with the job queue system. The `rrq` CLI allows you to manage workers, check system health, and get statistics about queues and jobs.
+## Command Line Interface
+
+RRQ provides a command-line interface (CLI) for managing workers and performing health checks:
+
+- **`rrq worker run`** - Run an RRQ worker process.
+  - `--settings` (optional): Specify the Python path to your settings object (e.g., `myapp.worker_config.rrq_settings`). If not provided, it will use the `RRQ_SETTINGS` environment variable or default to a basic `RRQSettings` object.
+  - `--queue` (optional, multiple): Specify queue(s) to poll. Defaults to the `default_queue_name` in settings.
+  - `--burst` (flag): Run the worker in burst mode to process one job or batch and then exit.
+- **`rrq worker watch`** - Run an RRQ worker with auto-restart on file changes.
+  - `--path` (optional): Directory path to watch for changes. Defaults to the current directory.
+  - `--settings` (optional): Same as above.
+  - `--queue` (optional, multiple): Same as above.
+- **`rrq check`** - Perform a health check on active RRQ workers.
+  - `--settings` (optional): Same as above.
+- **`rrq dlq requeue`** - Requeue jobs from the dead letter queue back into a live queue.
+  - `--settings` (optional): Same as above.
+  - `--dlq-name` (optional): Name of the DLQ (without prefix). Defaults to `default_dlq_name` in settings.
+  - `--queue` (optional): Target queue name (without prefix). Defaults to `default_queue_name` in settings.
+  - `--limit` (optional): Maximum number of DLQ jobs to requeue; all if not set.
 
-### Usage
-
-```bash
-rrq <command> [options]
-```
-
-### Commands
-
-- **`worker run`**: Run an RRQ worker process to process jobs from queues.
-  ```bash
-  rrq worker run [--burst] --settings <settings_path>
-  ```
-  - `--burst`: Run in burst mode (process one job/batch then exit).
-  - `--settings`: Python settings path for application worker settings (e.g., `myapp.worker_config.rrq_settings`).
-
-- **`worker watch`**: Run an RRQ worker with auto-restart on file changes in a specified directory.
-  ```bash
-  rrq worker watch [--path <directory>] --settings <settings_path>
-  ```
-  - `--path`: Directory to watch for changes (default: current directory).
-  - `--settings`: Python settings path for application worker settings.
-
-- **`check`**: Perform a health check on active RRQ workers.
-  ```bash
-  rrq check --settings <settings_path>
-  ```
-  - `--settings`: Python settings path for application settings.
+## Configuration
 
+RRQ can be configured in several ways, with the following precedence:
 
-### Configuration
+1. **Command-Line Argument (`--settings`)**: Directly specify the settings object path via the CLI. This takes the highest precedence.
+2. **Environment Variable (`RRQ_SETTINGS`)**: Set the `RRQ_SETTINGS` environment variable to point to your settings object path. Used if `--settings` is not provided.
+3. **Default Settings**: If neither of the above is provided, RRQ will instantiate a default `RRQSettings` object, which can still be influenced by environment variables starting with `RRQ_`.
+4. **Environment Variables (Prefix `RRQ_`)**: Individual settings can be overridden by environment variables starting with `RRQ_`, which are automatically picked up by the `RRQSettings` object.
+5. **.env File**: If `python-dotenv` is installed, RRQ will attempt to load a `.env` file from the current working directory or parent directories. System environment variables take precedence over `.env` variables.
 
-The CLI uses the same `RRQSettings` as the library, loading configuration from environment variables prefixed with `RRQ_`. You can also specify the settings via the `--settings` option for commands.
+**Important Note on `job_registry`**: The `job_registry` attribute in your `RRQSettings` object is **critical** for RRQ to function. It must be an instance of `JobRegistry` and is used to register job handlers. Without a properly configured `job_registry`, workers will not know how to process jobs, and most operations will fail. Ensure it is set in your settings object to map job names to their respective handler functions.
 
-```bash
-rrq worker run --settings myapp.worker_config.rrq_settings
-```
 
-### Help
+## Core Components
 
-For detailed help on any command, use:
-```bash
-rrq <command> --help
-```
+*   **`RRQClient` (`client.py`)**: Used to enqueue jobs onto specific queues. Supports deferring jobs (by time delta or specific datetime), assigning custom job IDs, and enforcing job uniqueness via keys.
+*   **`RRQWorker` (`worker.py`)**: The process that polls queues, fetches jobs, executes the corresponding handler functions, and manages the job lifecycle based on success, failure, retries, or timeouts. Handles graceful shutdown via signals (SIGINT, SIGTERM).
+*   **`JobRegistry` (`registry.py`)**: A simple registry to map string function names (used when enqueuing) to the actual asynchronous handler functions the worker should execute.
+*   **`JobStore` (`store.py`)**: An abstraction layer handling all direct interactions with Redis. It manages job definitions (Hashes), queues (Sorted Sets), processing locks (Strings with TTL), unique job locks, and worker health checks.
+*   **`Job` (`job.py`)**: A Pydantic model representing a job, containing its ID, handler name, arguments, status, retry counts, timestamps, results, etc.
+*   **`JobStatus` (`job.py`)**: An Enum defining the possible states of a job (`PENDING`, `ACTIVE`, `COMPLETED`, `FAILED`, `RETRYING`).
+*   **`RRQSettings` (`settings.py`)**: A Pydantic `BaseSettings` model for configuring RRQ behavior (Redis DSN, queue names, timeouts, retry policies, concurrency, etc.). Loadable from environment variables (prefix `RRQ_`).
+*   **`constants.py`**: Defines shared constants like Redis key prefixes and default configuration values.
+*   **`exc.py`**: Defines custom exceptions, notably `RetryJob` which handlers can raise to explicitly request a retry, potentially with a custom delay.

{rrq-0.3.5.dist-info → rrq-0.3.7.dist-info}/RECORD

@@ -1,5 +1,5 @@
 rrq/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rrq/cli.py,sha256=B9ra9ipZGRto423uG1vGEP-_jLshfl2XrCTNqixBMiQ,16562
+rrq/cli.py,sha256=_LbaAH_w2a0VNRR0EctuE4afl-wccvMY2w2VbehFDEQ,16980
 rrq/client.py,sha256=5_bmZ05LKIfY9WFSKU-nYawEupsnrnHT2HewXfC2Ahg,7831
 rrq/constants.py,sha256=F_uZgBI3h00MctnEjBjiCGMrg5jUaz5Bz9I1vkyqNrs,1654
 rrq/exc.py,sha256=NJq3C7pUfcd47AB8kghIN8vdY0l90UrsHQEg4McBHP8,1281
@@ -8,8 +8,8 @@ rrq/registry.py,sha256=E9W_zx3QiKTBwMOGearaNpDKBDB87JIn0RlMQ3sAcP0,2925
 rrq/settings.py,sha256=BPKP4XjG7z475gqRgHZt4-IvvOs8uZefq4fPfD2Bepk,4350
 rrq/store.py,sha256=teO0Af8hzBiu7-dFn6_2lz5X90LAZXmtg0VDZuQoAwk,24972
 rrq/worker.py,sha256=y0UTziZVh4QbOPv24b8cqbm_xDBM0HtJLwPNYsJPWnE,40706
-rrq-0.3.5.dist-info/METADATA,sha256=0sqVBY1QbqT2GJshYbz_nkKPYfStjZVKE3ICDvv7jdU,9224
-rrq-0.3.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-rrq-0.3.5.dist-info/entry_points.txt,sha256=f8eFjk2ygDSyu9USwXGj5IM8xeyQqZgDa1rSrCj4Mis,36
-rrq-0.3.5.dist-info/licenses/LICENSE,sha256=XDvu5hKdS2-_ByiSj3tiu_3zSsrXXoJsgbILGoMpKCw,554
-rrq-0.3.5.dist-info/RECORD,,
+rrq-0.3.7.dist-info/METADATA,sha256=fqMod1pTxebf7d4fCh5vRK0o9gkD4OAYg-02TNHJfN4,10193
+rrq-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+rrq-0.3.7.dist-info/entry_points.txt,sha256=f8eFjk2ygDSyu9USwXGj5IM8xeyQqZgDa1rSrCj4Mis,36
+rrq-0.3.7.dist-info/licenses/LICENSE,sha256=XDvu5hKdS2-_ByiSj3tiu_3zSsrXXoJsgbILGoMpKCw,554
+rrq-0.3.7.dist-info/RECORD,,