rrq 0.3.5__tar.gz → 0.3.6__tar.gz

{rrq-0.3.5 → rrq-0.3.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rrq
-Version: 0.3.5
+Version: 0.3.6
 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

{rrq-0.3.5 → rrq-0.3.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rrq"
-version = "0.3.5"
+version = "0.3.6"
 authors = [
     { name = "Mazdak Rezvani", email = "mazdak@me.com" },
 ]

{rrq-0.3.5 → rrq-0.3.6}/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 → rrq-0.3.6}/tests/test_cli.py

@@ -271,11 +271,21 @@ def test_worker_watch_command_with_queues(
     assert kwargs.get("queues") == ["alpha", "beta"]
 
 
-def test_worker_watch_command_missing_settings(cli_runner):
-    """Test 'rrq worker watch' without --settings."""
+@mock.patch("rrq.cli.watch_rrq_worker_impl")
+def test_worker_watch_command_missing_settings(mock_watch_impl, cli_runner):
+    """Test 'rrq worker watch' without --settings uses default settings."""
+    async def dummy_watch_impl(path, settings_object_path=None, queues=None):
+        pass
+
+    mock_watch_impl.side_effect = dummy_watch_impl
+
     result = cli_runner.invoke(cli.rrq, ["worker", "watch", "--path", "."])
-    assert result.exit_code != 0
-    assert "requires --settings to be specified" in result.output
+    assert result.exit_code == 0
+    mock_watch_impl.assert_called_once()
+    args, kwargs = mock_watch_impl.call_args
+    assert args[0] == "."  # Path argument
+    assert kwargs.get("settings_object_path") is None
+    assert kwargs.get("queues") is None
 
 
 def test_worker_watch_command_invalid_path(cli_runner, mock_app_settings_path):
@@ -437,6 +447,63 @@ def test_load_app_settings_default(tmp_path, monkeypatch):
     settings = _load_app_settings(None)
     assert isinstance(settings, RRQSettings)
 
+def test_load_app_settings_from_env_var(tmp_path, monkeypatch):
+    """Test loading settings via RRQ_SETTINGS environment variable."""
+    # Create a fake module with a settings instance
+    module_dir = tmp_path / "env_mod"
+    module_dir.mkdir()
+    settings_file = module_dir / "settings_module.py"
+    settings_file.write_text(
+        """
+from rrq.settings import RRQSettings
+from rrq.registry import JobRegistry
+
+test_env_registry = JobRegistry()
+test_env_settings = RRQSettings(redis_dsn="redis://envvar:333/7", job_registry=test_env_registry)
+"""
+    )
+    # Ensure the new module path is discoverable
+    monkeypatch.syspath_prepend(str(tmp_path))
+    # Set the environment variable to point to our settings object
+    monkeypatch.setenv("RRQ_SETTINGS", "env_mod.settings_module.test_env_settings")
+    # Load settings without explicit argument
+    settings_object = _load_app_settings(None)
+    # Import the module to get the original instance for identity check
+    import importlib
+    imported_module = importlib.import_module("env_mod.settings_module")
+    assert settings_object is getattr(imported_module, "test_env_settings")
+
+@pytest.mark.skipif(not cli.DOTENV_AVAILABLE, reason="python-dotenv not available")
+def test_load_app_settings_from_dotenv(tmp_path, monkeypatch):
+    """Test loading settings values from a .env file."""
+    # Ensure no pre-existing env var for redis_dsn or settings
+    monkeypatch.delenv("RRQ_REDIS_DSN", raising=False)
+    monkeypatch.delenv("RRQ_SETTINGS", raising=False)
+    # Create a .env file with a custom Redis DSN
+    env_file = tmp_path / ".env"
+    env_file.write_text("RRQ_REDIS_DSN=redis://dotenv:2222/2")
+    # Change CWD so find_dotenv will locate the .env file
+    monkeypatch.chdir(tmp_path)
+    # Load settings without explicit argument
+    settings_object = _load_app_settings(None)
+    # The redis_dsn should reflect the value from .env
+    assert settings_object.redis_dsn == "redis://dotenv:2222/2"
+
+@pytest.mark.skipif(not cli.DOTENV_AVAILABLE, reason="python-dotenv not available")
+def test_load_app_settings_dotenv_not_override_system_env(tmp_path, monkeypatch):
+    """System environment variables should override .env file values."""
+    # Set system env var for redis_dsn
+    monkeypatch.setenv("RRQ_REDIS_DSN", "redis://env:1111/1")
+    monkeypatch.delenv("RRQ_SETTINGS", raising=False)
+    # Create a .env file with a different Redis DSN
+    env_file = tmp_path / ".env"
+    env_file.write_text("RRQ_REDIS_DSN=redis://dotenv:2222/2")
+    monkeypatch.chdir(tmp_path)
+    # Load settings without explicit argument
+    settings_object = _load_app_settings(None)
+    # Should use system env var, not .env value
+    assert settings_object.redis_dsn == "redis://env:1111/1"
+
 
 def test_load_app_settings_invalid(monkeypatch, capsys):
     # Invalid import path should exit with code 1
@@ -448,8 +515,8 @@ def test_load_app_settings_invalid(monkeypatch, capsys):
 
 
 def test_start_rrq_worker_subprocess_no_settings():
-    # Calling without settings should raise
-    with pytest.raises(ValueError):
+    # Calling without settings should attempt to start default worker process and fail if 'rrq' is not in PATH
+    with pytest.raises(FileNotFoundError):
         start_rrq_worker_subprocess()
 
 

{rrq-0.3.5 → rrq-0.3.6}/uv.lock

@@ -370,7 +370,7 @@ hiredis = [
 
 [[package]]
 name = "rrq"
-version = "0.3.0"
+version = "0.3.5"
 source = { editable = "." }
 dependencies = [
     { name = "click" },