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 context 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 configuration and may be fully overridden by environment vars
structlog boilerplate for json/tty logging
fork the process and share bound sockets
pytest fixtures to reduce testing boilerplate
You bootstrap like following:
from buvar import plugin
plugin.stage("some.module.with.prepare")
# some.module.with.prepare
from buvar import context, plugin
class Foo:
...
async def task():
asyncio.sleep(1)
async def server():
my_component = context.get(Foo)
await asyncio.Future()
# there is also plugin.Teardown and plugin.Cancel
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 kwargs.
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)
yield task()
a config source
buvar.config.ConfigSource
is just a dict
, which merges
arbitrary dicts into one. It serves as 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=thing
import 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 CLI 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 in the main entry point
await load(config)
foobar_config = await di.nject(FoobarConfig)
a structlog
Just structlog boilerplate.
import sys
from buvar import log
log_config = log.LogConfig(tty=sys.stdout.isatty(), level="DEBUG")
log_config.setup()
pytest
There are a couple of pytest fixtures provided to get your context into a reasonable state:
buvar_config_source
A
dict
with arbitrary application settings.buvar_context
The basic context staging operates on.
buvar_stage
The actual stage processing all plugins.
buvar_load
The loader to add plugins to the stage.
buvar_plugin_context
The context all plugins share, when they are prepared.
Following markers may be applied to a test
buvar_plugins(plugin, ...)
Load all plugins into plugin context.
import pytest
async def prepare():
from buvar import context
context.add("foobar")
@pytest.mark.asyncio
@pytest.mark.buvar_plugins("tests.test_testing")
async def test_wrapped_stage_context():
from buvar import context, plugin
assert context.get(str) == "foobar"
assert context.get(plugin.Cancel)
@pytest.mark.asyncio
@pytest.mark.buvar_plugins()
async def test_wrapped_stage_context_load(buvar_load):
from buvar import context, plugin
await buvar_load(prepare)
assert context.get(str) == "foobar"
assert context.get(plugin.Cancel)
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 Distributions
Hashes for buvar-0.43.10-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_28_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cd382c38dfcd7096c77e29abae81bd47b39d09c869bc5dd0a12b5ba3ccaf5a20 |
|
MD5 | 8ead49c24fa425017ba3691ba221e9f3 |
|
BLAKE2b-256 | 51e7b21b17f72c7c056159689a0093f0264e17bfbd114e7229ff7ca62bde8f61 |
Hashes for buvar-0.43.10-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_28_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5cb3def0193be876230a70119e32d1a36dca9a38280d0b6c8366f2c35ca00e01 |
|
MD5 | 8c56dd1142304d5cb76d036e44803bf9 |
|
BLAKE2b-256 | c2780bf6a339f8aee76663b390eba321d30faa589efd328b0d6fa9bbd6609db1 |
Hashes for buvar-0.43.10-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_28_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a45c783bb2dbe43f6d3c87f5e4c78c25729e6f10d3f0bdabb8dd61583ef306cd |
|
MD5 | 396f39c712848ad5f62222cdea088a98 |
|
BLAKE2b-256 | 0058f4f684ec3d81e5e8e40843be4836b9b793ed7c066f360b97020ec3daa5e7 |