Asyncio plugins, components, dependency injection and configs
Project description
This is heavily inspired by Pyramid and my daily needs to fastly create and maintain microservice like applications.
a plugin mechanic
plugin may depend on other plugins
plugins yield tasks to run
a registry serves as a store for application components created by plugins
a dependency injection creates intermediate components
a config source is mapped to plugin specific needs
structlog boilerplate for json/tty logging
You bootstrap like following:
from buvar import plugin
plugin.stage("some.module.with.plugin.function")# some.module.with.plugin.function
from buvar import context, plugin
class Foo:
...
async def task():
asyncio.sleep(1)
async def server():
my_component = context.get(Foo)
await asyncio.Future()
# you may omit include in arguments
async def prepare(load: plugin.Loader):
await load('.another.plugin')
# create some long lasting components
my_component = context.add(Foo())
# you may run simple tasks
yield task()
# you may run server tasks
yield server()a components and dependency injection solution
Dependency injection relies on registered adapters, which may be a function, a method, a class, a classmethod or a generic classmthod.
Dependencies are looked up in components or may be provided via, arguments.
from buvar import di
class Bar:
pass
class Foo:
def __init__(self, bar: Bar = None):
self.bar = bar
@classmethod
async def adapt(cls, baz: str) -> Foo:
return Foo()
async def adapt(bar: Bar) -> Foo
foo = Foo(bar)
return foo
async def task():
foo = await di.nject(Foo, baz="baz")
assert foo.bar is None
bar = Bar()
foo = await di.nject(Foo, bar=bar)
assert foo.bar is bar
async def prepare():
di.register(Foo.adapt)
di.register(adapt)a config source
buvar.config.ConfigSource is just a dict, which merges arbitrary dicts into one. It serves a the single source of truth for application variability.
You can load a section of config values into your custom attrs class instance. ConfigSource will override values by environment variables if present.
config.toml
log_level = "DEBUG"
show_warnings = "yes"
[foobar]
some = "value"export APP_FOOBAR_SOME=thingimport attr
import toml
from buvar import config
@attr.s(auto_attribs=True)
class GeneralConfig:
log_level: str = "INFO"
show_warnings: bool = config.bool_var(False)
@attr.s(auto_attribs=True)
class FoobarConfig:
some: str
source = config.ConfigSource(toml.load('config.toml'), env_prefix="APP")
general_config = source.load(GeneralConfig)
assert general_config == GeneralConfig(log_level="DEBUG", show_warnings=True)
foobar_config = source.load(FoobarConfig, 'foobar')
assert foobar_config.some == "thing"There is a shortcut to the above approach provided by buvar.config.Config, which requires to be subclassed from it with a distinct section attribute. If one adds a buvar.config.ConfigSource component, he will receive the mapped config in one call.
from buvar import config, plugin
@attr.s(auto_attribs=True)
class GeneralConfig(config.Config):
log_level: str = "INFO"
show_warnings: bool = config.bool_var(False)
@attr.s(auto_attribs=True)
class FoobarConfig(config.Config, section="foobar"):
some: str
async def prepare(load: plugin.Loader):
# this would by typically placed in the main entry point
source = context.add(config.ConfigSource(toml.load('config.toml'), env_prefix="APP"))
# to provide the adapter to di, which could also be done inthe main entry point
await load(config)
foobar_config = await di.nject(FoobarConfig)a structlog
Just structlog boilerplate.
import sys
from buvar import log
log.setup_logging(sys.stdout.isatty(), general_config.log_level)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 Distributions
File details
Details for the file buvar-0.31.0.tar.gz.
File metadata
- Download URL: buvar-0.31.0.tar.gz
- Upload date:
- Size: 128.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2befced7adeb052a68e5237d150b1839c07a396b5c66a0a69a22598eebec9411 |
|
| MD5 | 522c5047d3cfcb54dd645b59e989503c |
|
| BLAKE2b-256 | a71d9de8d14bdd8897ec62aa75aece7fb855db18549a9ac4acfe723e30903096 |
File details
Details for the file buvar-0.31.0-cp38-cp38-manylinux1_x86_64.whl.
File metadata
- Download URL: buvar-0.31.0-cp38-cp38-manylinux1_x86_64.whl
- Upload date:
- Size: 439.2 kB
- Tags: CPython 3.8
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ff0273ec384d6ac16fe8159718436069b112d694675afa1c1593b28bd17a29cc |
|
| MD5 | 369ce98f0217485b62f8758633ddf3b1 |
|
| BLAKE2b-256 | 41e2e25dff3e74d209ebabd470003e76fcc3923cc0a1898ff0c6f618a8376c3b |
File details
Details for the file buvar-0.31.0-cp37-cp37m-manylinux1_x86_64.whl.
File metadata
- Download URL: buvar-0.31.0-cp37-cp37m-manylinux1_x86_64.whl
- Upload date:
- Size: 376.7 kB
- Tags: CPython 3.7m
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4e749d3b2427455ee3a86f3c2fe9a94a817b82c45ec6d290272e238a615d0023 |
|
| MD5 | b967b7240fe4fbca842487e7eb2cebe3 |
|
| BLAKE2b-256 | e09204c4c756393192c78377c2970a0f798ebb074351966067c4d32a449fb629 |
