https://github.com/jupe/py-lockable
py-lockable, python resource locking/reservation/allocation library
https://github.com/jupe/py-lockable
allocation allocator hardware lockable locker locking python resource
Last synced: 3 months ago
JSON representation
py-lockable, python resource locking/reservation/allocation library
- Host: GitHub
- URL: https://github.com/jupe/py-lockable
- Owner: jupe
- License: mit
- Created: 2020-09-29T05:02:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-17T12:02:07.000Z (6 months ago)
- Last Synced: 2025-03-29T17:35:56.176Z (4 months ago)
- Topics: allocation, allocator, hardware, lockable, locker, locking, python, resource
- Language: Python
- Homepage:
- Size: 156 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# lockable
[](https://circleci.com/gh/jupe/py-lockable/tree/master)
[](https://pypi.org/project/lockable/)
[](https://coveralls.io/github/jupe/py-lockable)
Resource locking module for python.
Originally designed for following projects:
* [pytest-lockable](https://github.com/jupe/pytest-lockable)
* [robot-lockable](https://github.com/jupe/robot-lockable)
Module provides python API and simple CLI interface.
Resource is released in following cases:
* process ends
* when context ends when `lockable.auto_lock(..)` is used
* allocation.unlock() is called
* lockable.unlock() is called
Resources data provider support following mechanisms:
* `resources.json` file in file system
* python list of dictionaries
* http uri which points to API and is used with HTTP GET method. API should provide `resources.json` data as json object.
# CLI interface
```
% lockable --help
usage: lockable [-h] [--validate-only] [--lock-folder LOCK_FOLDER] [--resources RESOURCES]
[--timeout TIMEOUT] [--hostname HOSTNAME]
[--requirements REQUIREMENTS]
[command [command ...]]
run given command while suitable resource is allocated.
Usage example: lockable --requirements {"online":true} echo using resource: $ID
positional arguments:
command Command to be execute during device allocation
optional arguments:
-h, --help show this help message and exit
--validate-only Only validate resources.json
--lock-folder LOCK_FOLDER
lock folder
--resources RESOURCES
Resources file (utf-8) or http uri
--timeout TIMEOUT Timeout for trying allocate suitable resource
--hostname HOSTNAME Hostname
--requirements REQUIREMENTS
requirements as json string
```
# API's
Constructor
```python
lockable = Lockable([hostname], [resource_list_file], [resource_list], [lock_folder])
```
Allocation
```python
allocation_context = lockable.lock(requirements, [timeout_s])
print(allocation_context.resource_info)
print(allocation_context.resource_id)
allocation_context.unlock()
# or using resource info
lockable.unlock(allocation_context)
```
Allocation context contains following API:
* `requirements: dict` Original requirements for allocation
* `resource_info: dict` Allocated resource information
* `unlock(): func` release resource lock function
* `allocation_queue_time: timedelta` How long waited before allocation
* `allocation_start_time: datetime` when allocation was started
* `release_time: datetime` when allocation was ended
* `alloc_id: str` allocation id
* `allocation_durations: timedelta` how long time allocation takes
or using context manager which unlock automatically
```python
with lockable.auto_lock(requirements, [timeout_s]) as allocation:
print(allocation.resource_info)
```
**Tips:**
You can allocate also offline devices by set requirements `"online": None` .
You can ignore also `hostname` same same way by setting it to None`