Efficiently cache calls to functions
Project description
cacholote
Efficiently cache calls to functions
Quick Start
>>> import cacholote
>>> cacholote.config.set(cache_db_urlpath="sqlite://")
<cacholote.config.set ...
>>> @cacholote.cacheable
... def now():
... import datetime
... return datetime.datetime.now()
>>> now() == now()
True
>>> with cacholote.config.set(use_cache=False):
... now() == now()
False
Cache files
>>> import cacholote
>>> import tempfile
>>> tmpdir = tempfile.TemporaryDirectory().name
>>> cacholote.config.set(
... cache_db_urlpath="sqlite://",
... cache_files_urlpath=tmpdir,
... )
<cacholote.config.set ...
>>> cached_open = cacholote.cacheable(open)
>>> cached_file = cached_open("README.md")
>>> cached_file.name.startswith(tmpdir)
True
>>> import filecmp
>>> filecmp.cmp("README.md", cached_file.name)
True
Cache Xarray objects
>>> import cacholote
>>> import pytest
>>> xr = pytest.importorskip("xarray")
>>> import tempfile
>>> tmpdir = tempfile.TemporaryDirectory().name
>>> cacholote.config.set(
... cache_db_urlpath="sqlite://",
... cache_files_urlpath=tmpdir,
... )
<cacholote.config.set ...
>>> @cacholote.cacheable
... def dataset_from_dict(ds_dict):
... return xr.Dataset(ds_dict)
>>> ds = dataset_from_dict({"foo": 0})
>>> ds
<xarray.Dataset> Size: 8B
Dimensions: ()
Data variables:
foo int64 ...
>>> ds.encoding["source"].startswith(tmpdir)
True
Configuration
Configuration settings can be accessed using cacholote.config.get() and modified using cacholote.config.set(**kwargs). It is possible to use cacholote.config.set either as a context manager, or to configure global settings. See help(cacholote.config.set).
Defaults are controlled by environment variables and dotenv files. See help(cacholote.config.reset).
Workflow for developers/contributors
For best experience create a new conda environment (e.g. DEVELOP) with Python 3.11:
conda create -n DEVELOP -c conda-forge python=3.11
conda activate DEVELOP
Before pushing to GitHub, run the following commands:
- Update conda environment:
make conda-env-update - Install this package:
pip install -e . - Sync with the latest template (optional):
make template-update - Run quality assurance checks:
make qa - Run tests:
make unit-tests - Run the static type checker:
make type-check - Build the documentation (see Sphinx tutorial):
make docs-build
License
Copyright 2019, B-Open Solutions srl.
Copyright 2022, European Union.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
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
cacholote-1.1.0.tar.gz
(45.2 kB
view details)
Built Distribution
cacholote-1.1.0-py3-none-any.whl
(30.6 kB
view details)
File details
Details for the file cacholote-1.1.0.tar.gz.
File metadata
- Download URL: cacholote-1.1.0.tar.gz
- Upload date:
- Size: 45.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | abcd40babd798638a9d75f1f4a700fcf5b2353da1e47bf3cf8fa4c11286fdc14 |
|
| MD5 | 0597b91aa14b145e09b06e507126030d |
|
| BLAKE2b-256 | 66794157f696c763f9727c612c6a57874c4951af1e1ab9948c6bebf94c4a7767 |
File details
Details for the file cacholote-1.1.0-py3-none-any.whl.
File metadata
- Download URL: cacholote-1.1.0-py3-none-any.whl
- Upload date:
- Size: 30.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f8ddc8c285fe93fa8daf5d2bef7bfb1a26ac77e4d65dab25fae8914b3c9baa5c |
|
| MD5 | 0e2daddd0e00121ab1267e84477d40d1 |
|
| BLAKE2b-256 | 15b0eeefe3fcc304a11485ee6fc7d5a1e68d5a4991bdace961888dd08e797336 |
