Datasette plugin providing the low_disk_space hook for other plugins to check for low disk space
Project description
datasette-low-disk-space-hook
Datasette plugin providing the low_disk_space hook for other plugins to check for low disk space
Installation
Install this plugin in the same environment as Datasette.
datasette install datasette-low-disk-space-hook
You are unlikely to need to install this plugin directly though: it will usually be automatically be installed as a dependency of another plugin.
Usage
This plugin adds a new plugin hook to Datasette called low_disk_space(datasette=datasette)
.
It also adds a new space_is_running_low(datasette)
utility function which can be called to check if the Datasette instance is running out of space:
from datasette_low_disk_space_hook import space_is_running_low
if await space_is_running_low(datasette):
print("Disk space is running low")
The idea is for plugins such as datasette-upload-csvs
and datasette-socrata
to call this hook before writing any new data into Datasette, to check if they should continue.
Other plugins can then implement the hook to warn when Datasette is running out of space.
Working together, this will help plugins avoid filling the disk entirely with data which could cause Datasette instances to crash.
Implementing the hook
An implementation of this hook (in yet another plugin) looks like this:
from datasette import hookimpl
import shutil
@hookimpl
def low_disk_space(self, datasette):
usage = shutil.disk_usage("/mnt")
# Fail at 95% or more used
if (usage.used / usage.total) > 0.95:
return True
The plugin can also return an async
function if it needs to use await
as part of its execution:
from datasette import hookimpl
from somewhere import check_disk_usage_percentage_async
@hookimpl
def low_disk_space(self, datasette):
async def inner():
usage = await check_disk_usage_percentage_async("/mnt")
if usage > 0.95:
return True
return inner
Development
To set up this plugin locally, first checkout the code. Then create a new virtual environment:
cd datasette-low-disk-space-hook
python3 -m venv venv
source venv/bin/activate
Now install the dependencies and test dependencies:
pip install -e '.[test]'
To run the tests:
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file datasette-low-disk-space-hook-0.1.tar.gz
.
File metadata
- Download URL: datasette-low-disk-space-hook-0.1.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58604c0b94c62f4616538d0866d2d6b0880ee3d2e2d673cbdd5d4e494bab0c5d |
|
MD5 | f637db254cab891a89653fc7272b6d26 |
|
BLAKE2b-256 | 1bbdab3ca9e788665fdb0c4a0841c36bd6c3d6d5e279832b57f5a68bae9bd41e |
File details
Details for the file datasette_low_disk_space_hook-0.1-py3-none-any.whl
.
File metadata
- Download URL: datasette_low_disk_space_hook-0.1-py3-none-any.whl
- Upload date:
- Size: 7.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.10.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b820561fef7fc7c6ab8275e615cc8d1ace393ea774dc15aa4cfde6f3b5a42738 |
|
MD5 | bd416ac9e224afcd174fc3a057b7b985 |
|
BLAKE2b-256 | efc37d26439ef28179214af22d19d6562d2c2185a79b0ecf2aaba1d461ea5d61 |