Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bswck/slothy
Super-easy lazy importing in pure Python.
https://github.com/bswck/slothy
lazy-importing lazy-imports pep-690 python
Last synced: 23 days ago
JSON representation
Super-easy lazy importing in pure Python.
- Host: GitHub
- URL: https://github.com/bswck/slothy
- Owner: bswck
- License: mit
- Created: 2024-01-11T02:32:51.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-06T17:16:16.000Z (2 months ago)
- Last Synced: 2024-10-06T22:35:37.507Z (about 1 month ago)
- Topics: lazy-importing, lazy-imports, pep-690, python
- Language: Python
- Homepage: https://bswck.github.io/slothy/
- Size: 1.21 MB
- Stars: 86
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
#
slothy
[](https://pypi.org/project/slothy/) [](https://pypi.org/project/slothy/) [](https://pypistats.org/packages/slothy)
[](https://github.com/bswck/slothy/actions/workflows/test.yml)
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/bswck/slothy)
> [!Note]
> This package is largely experimental and may be unsuitable for production.
Super-easy lazy importing in Python.
Intended to be used as a guard for expensive or type-checking imports.
# Usage
```pycon
>>> from slothy import lazy_importing
>>>
>>> with lazy_importing():
... from asyncio import get_event_loop, run, erroneous_import
... print(get_event_loop)
... print(run)
... print(erroneous_import)
...
", line 2)>
", line 2)>
", line 2)>
>>>
>>> get_event_loop
>>>
>>> globals()["run"]
>>>
>>> erroneous_import
Traceback (most recent call last):
File "", line 1, in
File "./slothy/_importing.py", line 423, in __eq__
self._import(their_import)
File "./slothy/_importing.py", line 304, in __import
raise exc from None
File "./slothy/_importing.py", line 286, in __import
obj = _import_item_from_list(
File "./slothy/_importing.py", line 203, in _import_item_from_list
raise ImportError(msg) from None
ImportError: cannot import name 'erroneous_import' from 'asyncio'
(caused by delayed execution of "", line 2)
```
By default, `with lazy_importing()` statements fail immediately on unsupported Python
implementations, i.e. those that don't define [`sys._getframe`](https://docs.python.org/3/library/sys.html#sys._getframe). To disable this behavior,
which might be particularly useful in libraries, use `with lazy_importing(prevent_eager=False)`.
# Credits
Many thanks to Jelle Zijlstra [@JelleZijlstra](https://github.com/JelleZijlstra) who wrote a [basic
dict key lookup-based lazy importing implementation](https://gist.github.com/JelleZijlstra/23c01ceb35d1bc8f335128f59a32db4c)
that is now the core solution of slothy.
Kudos to Carl Meyer [@carljm](https://github.com/carljm) who willingly sacrificed his time
to consult the project with me and share his deep knowledge of the problem at the bigger picture.
His experience with [PEP 690](https://peps.python.org/pep-0690) as a Meta software engineer
significantly helped me.
I'm very grateful to [@jimfulton](https://github.com/jimfulton) for [making the library possible in the first place](https://github.com/python/cpython/commit/d47a0a86b4ae4afeb17d8e64e1c447e4d4025f10) almost 30 years ago.
Special thanks to Alex Waygood [@AlexWaygood](https://github.com/AlexWaygood) who made this project possible
by sharing his knowledge of CPython implementation details regarding name lookup behavior.
Shoutout to Will McGugan [@willmcgugan](https://github.com/willmcgugan) who supported the idea of slothy
from the very beginning and [promoted the project on Twitter](https://twitter.com/willmcgugan/status/1781327396773208427).
# Installation
You might simply install it with pip:
```shell
pip install slothy
```
If you use [Poetry](https://python-poetry.org/), then you might want to run:
```shell
poetry add slothy
```
## For Contributors
[](https://rye.astral.sh)
[](https://python-poetry.org/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/pre-commit/pre-commit)
> [!Note]
> If you use Windows, it is highly recommended to complete the installation in the way presented below through [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install).
1. Fork the [slothy repository](https://github.com/bswck/slothy) on GitHub.
1. [Install Poetry](https://python-poetry.org/docs/#installation).
Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.
You might use [pipx](https://github.com/pypa/pipx#readme) to install it globally (recommended):
```shell
pipx install poetry
```
If you encounter any problems, refer to [the official documentation](https://python-poetry.org/docs/#installation) for the most up-to-date installation instructions.
Be sure to have Python 3.8 installed—if you use [Rye](https://rye.astral.sh/guide/basics/), simply run:
```bash
rye toolchain fetch 3.8
```
1. Clone your fork locally and install dependencies.
```shell
git clone https://github.com/your-username/slothy path/to/slothy
cd path/to/slothy
poetry env use $(cat .python-version)
poetry install
```
Next up, simply activate the virtual environment and install pre-commit hooks:
```shell
poetry shell
pre-commit install
```
For more information on how to contribute, check out [CONTRIBUTING.md](https://github.com/bswck/slothy/blob/HEAD/CONTRIBUTING.md).
Always happy to accept contributions! ❤️
# Legal Info
© Copyright by Bartosz Sławecki ([@bswck](https://github.com/bswck)).
This software is licensed under the terms of [MIT License](https://github.com/bswck/slothy/blob/HEAD/LICENSE).