redis-allocator 0.0.1__py3-none-any.whl → 0.3.1__py3-none-any.whl

redis_allocator-0.0.1.dist-info/METADATA

@@ -1,229 +0,0 @@
-Metadata-Version: 2.4
-Name: redis-allocator
-Version: 0.0.1
-Summary: Redis-based resource allocation system.
-Home-page: https://github.com/invoker-bot/RedisAllocator-python
-Author: Invoker Bot
-Author-email: invoker-bot@outlook.com
-License: MIT
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: Programming Language :: Python :: 3.9
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.10
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: redis>=5.0.0
-Provides-Extra: test
-Requires-Dist: pytest>=7.4.3; extra == "test"
-Requires-Dist: pytest-cov>=4.1.0; extra == "test"
-Requires-Dist: pytest-mock>=3.12.0; extra == "test"
-Requires-Dist: fakeredis[lua]>=2.20.1; extra == "test"
-Requires-Dist: flake8>=6.1.0; extra == "test"
-Requires-Dist: freezegun>=1.4.0; extra == "test"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# RedisAllocator
-
-## Project Overview
-
-RedisAllocator is an efficient Redis-based distributed memory allocation system. This system simulates traditional memory allocation mechanisms but implements them in a distributed environment, using Redis as the underlying storage and coordination tool.
-
-> **Note**: Currently, RedisAllocator only supports single Redis instance deployments. For Redis cluster environments, we recommend using RedLock for distributed locking operations.
-
-### Core Features
-
-- **Distributed Locking**: Provides robust distributed locking mechanisms to ensure data consistency in concurrent environments
-- **Resource Allocation**: Implements a distributed resource allocation system with support for:
-  - Priority-based distribution
-  - Soft binding
-  - Garbage collection
-  - Health checking
-- **Task Management**: Implements a distributed task queue system for efficient task processing across multiple workers
-- **Object Allocation**: Supports allocation of resources with priority-based distribution and soft binding
-- **Health Checking**: Monitors the health of distributed instances and automatically handles unhealthy resources
-- **Garbage Collection**: Automatically identifies and reclaims unused resources, optimizing memory usage
-
-
-## Installation
-
-```bash
-pip install redis-allocator
-```
-
-## Quick Start
-
-### Using RedisLock for Distributed Locking
-
-```python
-from redis import Redis
-from redis_allocator import RedisLock
-
-# Initialize Redis client
-redis = Redis(host='localhost', port=6379)
-
-# Create a RedisLock instance
-lock = RedisLock(redis, "myapp", "resource-lock")
-
-# Acquire a lock
-if lock.lock("resource-123", timeout=60):
-    try:
-        # Perform operations with the locked resource
-        print("Resource locked successfully")
-    finally:
-        # Release the lock when done
-        lock.unlock("resource-123")
-```
-
-### Using RedisAllocator for Resource Management
-
-```python
-from redis import Redis
-from redis_allocator import RedisAllocator
-
-# Initialize Redis client
-redis = Redis(host='localhost', port=6379)
-
-# Create a RedisAllocator instance
-allocator = RedisAllocator(
-    redis, 
-    prefix='myapp',
-    suffix='allocator',
-    shared=False  # Whether resources can be shared
-)
-
-# Add resources to the pool
-allocator.extend(['resource-1', 'resource-2', 'resource-3'])
-
-# Allocate a resource key (returns only the key)
-key = allocator.malloc_key(timeout=120)
-if key:
-    try:
-        # Use the allocated resource
-        print(f"Allocated resource: {key}")
-    finally:
-        # Free the resource when done
-        allocator.free_keys(key)
-
-# Allocate a resource with object (returns a RedisAllocatorObject)
-allocated_obj = allocator.malloc(timeout=120)
-if allocated_obj:
-    try:
-        # The key is available as a property
-        print(f"Allocated resource: {allocated_obj.key}")
-        
-        # Update the resource's lock timeout
-        allocated_obj.update(timeout=60)
-    finally:
-        # Free the resource when done
-        allocator.free(allocated_obj)
-
-# Using soft binding (associates a name with a resource)
-allocator.update_soft_bind("worker-1", "resource-1")
-# Later...
-allocator.unbind_soft_bind("worker-1")
-
-# Garbage collection (reclaims unused resources)
-allocator.gc(count=10)  # Check 10 items for cleanup
-```
-
-### Using RedisTaskQueue for Distributed Task Processing
-
-```python
-from redis import Redis
-from redis_allocator import RedisTaskQueue, TaskExecutePolicy
-import json
-
-# Initialize Redis client
-redis = Redis(host='localhost', port=6379)
-
-# Process tasks in a worker
-def process_task(task):
-    # Process the task (task is a RedisTask object)
-    # You can access task.id, task.name, task.params
-    # You can update progress with task.update(current, total)
-    return json.dumps({"result": "processed"})
-
-
-# Create a task queue
-task_queue = RedisTaskQueue(redis, "myapp", task_fn=process_task)
-
-# Submit a task with query method
-result = task_queue.query(
-    id="task-123",
-    name="example-task",
-    params={"input": "data"},
-    timeout=300,  # Optional timeout in seconds
-    policy=TaskExecutePolicy.Auto,  # Execution policy
-    once=False  # Whether to delete the result after getting it
-)
-
-# Start listening for tasks
-task_queue.listen(
-    names=["example-task"],  # List of task names to listen for
-    workers=128,  # Number of worker threads
-    event=None  # Optional event to signal when to stop listening
-)
-```
-
-## Modules
-
-RedisAllocator consists of several modules, each providing specific functionality:
-
-- **lock.py**: Provides `RedisLock` and `RedisLockPool` for distributed locking mechanisms
-- **task_queue.py**: Implements `RedisTaskQueue` for distributed task processing
-- **allocator.py**: Contains `RedisAllocator` and `RedisThreadHealthChecker` for resource allocation
-
-
-## Roadmap
-
-### Phase 1 (Completed)
-- [x] Distributed lock mechanism implementation
-- [x] Task queue processing system
-- [x] Resource allocation and management
-- [x] Basic health checking and monitoring
-- [x] Object allocation with serialization
-- [x] Unit tests for core components
-
-### Phase 2 (In Progress)
-- [ ] Advanced sharding implementation
-- [ ] Performance optimization and benchmarking
-- [ ] Documentation improvement
-- [ ] Enhanced error handling and recovery
-
-### Phase 3 (Planned)
-- [ ] Advanced garbage collection strategies
-- [ ] Redis cluster support
-- [ ] Fault recovery mechanisms
-- [ ] Automated resource scaling
-
-### Phase 4 (Future)
-- [ ] API stability and backward compatibility
-- [ ] Performance monitoring and tuning tools
-- [ ] Advanced features (transaction support, data compression, etc.)
-- [ ] Production environment validation and case studies
-
-## Contributing
-
-Contributions and suggestions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Contact
-
-For questions or suggestions, please contact us through GitHub Issues.

redis_allocator-0.0.1.dist-info/RECORD

@@ -1,14 +0,0 @@
-redis_allocator/__init__.py,sha256=x4koK9zx8W1wWnrwt72tPve-LwKdhKbKxTGgacZ8q84,800
-redis_allocator/allocator.py,sha256=qqxKOAPG_QgTp3gxvi8O443dPC9DGr3_iM5nCP3lidM,21831
-redis_allocator/lock.py,sha256=HSCXyBhO3qBMylvByqskekHp6CMgqwbVcwMyP77pBmM,24768
-redis_allocator/task_queue.py,sha256=NalI77hk1u8X-JBWpGoZFv5nJXzfem5fDthiSa9cgFg,13596
-redis_allocator-0.0.1.dist-info/licenses/LICENSE,sha256=NiCCQOo0TQ_djjGpoCphsT59Bgu2sLOk8rVwIRxrqQE,1089
-tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-tests/conftest.py,sha256=gsMBUrUTGxD-ki29rWrtJCZZymb7n7biRV6lWcd7fWo,1124
-tests/test_allocator.py,sha256=F-GHbgWGss5CvbUsQt1AvLib9V0Rxyih1HisHWFi6jU,18608
-tests/test_lock.py,sha256=wA2po5vSgeoyOeH9-bTF3fxVwh-CmR-CSH-ZThVHisY,35294
-tests/test_task_queue.py,sha256=pohhYpw9RIPJma9wQPEF9r4pKkK__PZDd6Y10mEPtjs,33071
-redis_allocator-0.0.1.dist-info/METADATA,sha256=nSxDu1WR1H6NJGdEu3eoVkPivnzEiM04DbVxk5VmLss,7465
-redis_allocator-0.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-redis_allocator-0.0.1.dist-info/top_level.txt,sha256=0hXzU7sK5FCeSolTEYxThOt3HOybnwaXv1FLRJvHVgI,22
-redis_allocator-0.0.1.dist-info/RECORD,,