rrq 0.4.0__tar.gz → 0.5.0__tar.gz

rrq-0.5.0/.claude/settings.local.json

@@ -0,0 +1,17 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(find:*)",
+      "Bash(grep:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(mkdir:*)",
+      "Bash(mv:*)",
+      "Bash(python -m pytest tests/test_worker.py::test_worker_handles_job_failure_max_retries_dlq -xvs)",
+      "Bash(rg:*)",
+      "Bash(uv run:*)",
+      "Bash(ruff format:*)",
+      "Bash(ruff check:*)"
+    ],
+    "deny": []
+  }
+}

rrq-0.5.0/CLAUDE.md

@@ -0,0 +1,115 @@
+---
+description: RRQ Development Guidelines
+globs: ["**/*", "!tests/**/*"]
+alwaysApply: true
+---
+# RRQ Development Guidelines
+
+## Project Overview
+
+**Important**: Also refer to:
+- `tests/CLAUDE.md` - Testing guidelines
+- `README.md` - Project setup and overview
+
+## Quick Start Commands
+```bash
+# Backend
+uv run pytest             # Running tests
+ruff check                # Lint backend code
+ruff format               # Format backend code
+
+# Package Management
+uv add package_name        # Add dependency
+uv sync --extra dev        # Sync dependencies
+```
+
+## Code References Format
+**CRITICAL**: Always use VS Code clickable format for code references:
+- `app/api/users.py:45` - Single line
+- `app/models/job.py:120-135` - Line range
+- Always use paths relative to project root
+
+### Python Code Style
+- Python 3.10+ with comprehensive type hints
+- Double quotes for strings
+- Max line length: 88 characters
+- PEP 8 naming: `snake_case` functions, `PascalCase` classes
+- Pydantic V2 for data validation
+- Import order: stdlib → third-party → local
+- Docstrings for public interfaces
+- Type annotations for all function signatures
+
+### Code Quality Practices
+- Early returns over nested conditions
+- Small, focused functions (single responsibility)
+- Descriptive variable names
+- Comprehensive error handling with specific exceptions
+- Consistent async/await patterns
+- Use `match/case` for complex conditionals
+
+## Self-Review Checklist for Large Changes
+
+Before submitting significant backend changes:
+
+### Code Quality
+- [ ] All functions have type hints
+- [ ] Complex logic is well-commented
+- [ ] No debug prints or commented code
+- [ ] Follows existing patterns in codebase
+- [ ] Proper error handling throughout
+- [ ] Idiomatic code using Python, Asyncio, and Pydantic best practices
+
+### Testing
+- [ ] Unit tests for new functionality
+- [ ] Integration tests for API changes
+- [ ] All tests pass with `--warnings-as-errors`
+- [ ] Edge cases covered
+- [ ] Mocked external dependencies
+
+### Performance
+- [ ] Database queries are optimized (N+1 prevention)
+- [ ] Async operations are properly awaited
+- [ ] No blocking I/O in async contexts
+- [ ] Background jobs for heavy operations
+
+### Security
+- [ ] Input validation on all endpoints
+- [ ] No sensitive data in logs
+- [ ] SQL injection prevention
+
+### Documentation
+- [ ] API endpoints documented
+- [ ] Complex functions have docstrings
+- [ ] Schema changes documented
+- [ ] Migration files created if needed
+
+## Linting and Pre-commit
+
+**Always run before committing:**
+```bash
+# Format and lint
+ruff format 
+ruff check  --fix
+
+```
+
+## Important Development Rules
+
+1. **Never commit broken tests** - Fix root causes
+2. **Ask before large changes** - Especially cross-domain
+3. **Follow existing patterns** - Check similar code first
+4. **Quality over speed** - Do it right the first time
+5. **Security first** - Never expose sensitive data
+
+## Performance Considerations
+- Profile before optimizing
+- Use async correctly (no sync in async)
+- Cache expensive operations
+- Paginate large result sets
+- Monitor query performance
+
+## Debugging Tips
+- Use `uv run pytest --maxfail=1` for failing tests
+- Use debugger with `import pdb; pdb.set_trace()`
+
+Remember: If unsure about implementation, check existing code patterns first!

{rrq-0.4.0 → rrq-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rrq
-Version: 0.4.0
+Version: 0.5.0
 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
@@ -265,7 +265,8 @@ RRQ provides a command-line interface (CLI) for managing workers and performing
 - **`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.
+  - `--burst` (flag): Run the worker in burst mode to process one job or batch and then exit. Cannot be used with `--num-workers > 1`.
+  - `--num-workers` (optional, integer): Number of parallel worker processes to start. Defaults to the number of CPU cores available on the machine. Cannot be used with `--burst` mode.
 - **`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.

{rrq-0.4.0 → rrq-0.5.0}/README.md

@@ -238,7 +238,8 @@ RRQ provides a command-line interface (CLI) for managing workers and performing
 - **`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.
+  - `--burst` (flag): Run the worker in burst mode to process one job or batch and then exit. Cannot be used with `--num-workers > 1`.
+  - `--num-workers` (optional, integer): Number of parallel worker processes to start. Defaults to the number of CPU cores available on the machine. Cannot be used with `--burst` mode.
 - **`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.

{rrq-0.4.0 → rrq-0.5.0}/example/example_rrq_settings.py

@@ -1,4 +1,4 @@
-'''example_rrq_settings.py: Example RRQ Application Settings'''
+"""example_rrq_settings.py: Example RRQ Application Settings"""
 
 import asyncio
 import logging
@@ -16,20 +16,18 @@ logger.addHandler(console_handler)
 redis_dsn = "redis://localhost:6379/0"
 
 
-
-
 async def on_startup_hook():
     logger.info("Executing 'on_startup_hook' (application-specific startup)...")
     await asyncio.sleep(0.1)
     logger.info("'on_startup_hook' complete.")
 
+
 async def on_shutdown_hook():
     logger.info("Executing 'on_shutdown_hook' (application-specific shutdown)...")
     await asyncio.sleep(0.1)
     logger.info("'on_shutdown_hook' complete.")
 
 
-
 # RRQ Settings
 rrq_settings = RRQSettings(
     redis_dsn=redis_dsn,
@@ -42,20 +40,19 @@ rrq_settings = RRQSettings(
             function_name="daily_cleanup",
             schedule="0 2 * * *",
             args=["cleanup_logs"],
-            kwargs={"max_age_days": 30}
+            kwargs={"max_age_days": 30},
         ),
         # Send a status report every Monday at 9 AM
         CronJob(
             function_name="send_status_report",
             schedule="0 9 * * mon",
-            unique=True  # Prevent duplicate reports if worker restarts
+            unique=True,  # Prevent duplicate reports if worker restarts
         ),
         # Health check every 15 minutes
         CronJob(
             function_name="health_check",
             schedule="*/15 * * * *",
-            queue_name="monitoring"  # Use a specific queue for monitoring tasks
+            queue_name="monitoring",  # Use a specific queue for monitoring tasks
         ),
-    ]
+    ],
 )
-

{rrq-0.4.0 → rrq-0.5.0}/example/rrq_example.py

@@ -76,7 +76,9 @@ async def daily_cleanup(ctx, task_type: str, max_age_days: int = 30):
 
 async def send_status_report(ctx):
     """Example cron job handler for sending status reports."""
-    logger.info(f"STATUS_REPORT (Job {ctx['job_id']}): Generating and sending status report")
+    logger.info(
+        f"STATUS_REPORT (Job {ctx['job_id']}): Generating and sending status report"
+    )
     await asyncio.sleep(0.3)  # Simulate report generation
     logger.info(f"STATUS_REPORT (Job {ctx['job_id']}): Status report sent")
     return {"report_type": "weekly", "status": "sent"}
@@ -86,7 +88,9 @@ async def health_check(ctx):
     """Example cron job handler for health checks."""
     logger.info(f"HEALTH_CHECK (Job {ctx['job_id']}): Running system health check")
     await asyncio.sleep(0.1)  # Simulate health check
-    logger.info(f"HEALTH_CHECK (Job {ctx['job_id']}): Health check completed - all systems OK")
+    logger.info(
+        f"HEALTH_CHECK (Job {ctx['job_id']}): Health check completed - all systems OK"
+    )
     return {"status": "healthy", "timestamp": ctx.get("job_start_time")}
 
 
@@ -106,15 +110,15 @@ async def main():
             CronJob(
                 function_name="health_check",
                 schedule="*/2 * * * *",  # Every 2 minutes
-                queue_name="monitoring"
+                queue_name="monitoring",
             ),
             # Send a status report every 5 minutes (for demo purposes)
             CronJob(
                 function_name="send_status_report",
                 schedule="*/5 * * * *",  # Every 5 minutes
-                unique=True  # Prevent duplicate reports
+                unique=True,  # Prevent duplicate reports
             ),
-        ]
+        ],
     )
     logger.info(f"Using Redis DB: {settings.redis_dsn}")
     logger.info(f"Configured {len(settings.cron_jobs)} cron jobs")
@@ -210,7 +214,8 @@ async def main():
 
     # Wait for stop event or worker task completion (e.g., if it errors out)
     done, pending = await asyncio.wait(
-        [worker_task, asyncio.create_task(stop_event.wait())], return_when=asyncio.FIRST_COMPLETED
+        [worker_task, asyncio.create_task(stop_event.wait())],
+        return_when=asyncio.FIRST_COMPLETED,
     )
 
     logger.info("Stop event triggered or worker task finished.")

{rrq-0.4.0 → rrq-0.5.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "rrq"
-version = "0.4.0"
+version = "0.5.0"
 authors = [{ name = "Mazdak Rezvani", email = "mazdak@me.com" }]
 description = "RRQ is a Python library for creating reliable job queues using Redis and asyncio"
 readme = "README.md"