Lookup and instantiate classes with style.
Project description
Class Resolver
Lookup and instantiate classes with style.
💪 Getting Started
from class_resolver import Resolver
from dataclasses import dataclass
class Base: pass
@dataclass
class A(Base):
name: str
@dataclass
class B(Base):
name: str
# Index
resolver = Resolver([A, B], base=Base)
# Lookup
assert A == resolver.lookup('A')
# Instantiate with a dictionary
assert A(name='hi') == resolver.make('A', {'name': 'hi'})
# Instantiate with kwargs
assert A(name='hi') == resolver.make('A', name='hi')
# A pre-instantiated class will simply be passed through
assert A(name='hi') == resolver.make(A(name='hi'))
⬇️ Installation
The most recent release can be installed from PyPI with:
$ pip install class_resolver
The most recent code and data can be installed directly from GitHub with:
$ pip install git+https://github.com/cthoyt/class-resolver.git
To install in development mode, use the following:
$ git clone git+https://github.com/cthoyt/class-resolver.git
$ cd class-resolver
$ pip install -e .
⚖️ License
The code in this package is licensed under the MIT License.
🙏 Contributing
Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.rst for more information on getting involved.
🍪 Cookiecutter Acknowledgement
This package was created with @audreyr's cookiecutter package using @cthoyt's cookiecutter-python-package template.
🛠️ Development
The final section of the README is for if you want to get involved by making a code contribution.
❓ Testing
After cloning the repository and installing tox with pip install tox, the unit tests in
the tests/ folder can be run reproducibly with:
$ tox
Additionally, these tests are automatically re-run with each commit in a GitHub Action.
📦 Making a Release
After installing the package in development mode and installing
tox with pip install tox, the commands for making a new release are contained within
the finish environment in tox.ini. Run the following from the shell:
$ tox -e finish
This script does the following:
- Uses BumpVersion to switch the version number in the
setup.cfgandsrc/class_resolver/version.pyto not have the-devsuffix - Packages the code in both a tar archive and a wheel
- Uploads to PyPI using
twine. Be sure to have a.pypircfile configured to avoid the need for manual input at this step - Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
- Bump the version to the next patch. If you made big changes and want to bump the version by
minor, you can use
tox -e bumpversion minorafter.
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 class_resolver-0.1.1.tar.gz.
File metadata
- Download URL: class_resolver-0.1.1.tar.gz
- Upload date:
- Size: 16.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f755c264f973a4b64501933b263e643dea2e60abfa04698ac72fb4356eecdb95 |
|
| MD5 | 0057a6a8dd72790234f6815903d7d518 |
|
| BLAKE2b-256 | 0a1cb1c6f696130261f2fd822e64e9a47deb1d70b3a94339258ca73c28b0e6c4 |
Provenance
File details
Details for the file class_resolver-0.1.1-py3-none-any.whl.
File metadata
- Download URL: class_resolver-0.1.1-py3-none-any.whl
- Upload date:
- Size: 10.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 017ae602d6da6e8aebc4b2c397c648742cea26cca290ee6d833a98d279b52678 |
|
| MD5 | 4096a0ae5e100d9917d1356327dbd5cb |
|
| BLAKE2b-256 | d1565b7f16b6ebc2c7a8fbd185a74efb5bc6b66c89b958ea3821329f197c5ac6 |
