pydantic-firebase-remoteconfig 0.2.2

A simple Firebase Remote Config binding for Pydantic

Firebase Remote config validator for Pydantic

A simple Firebase Remote Config binding for Pydantic, using remote server configuration only.

Installation

Package is publicly available on PyPi and can be install using any supported package manager:

pip install pydantic-firebase-remoteconfig

Usage

You simply need to implement your BaseRemoteConfigModel class and use the appropriate async validation class method. Let's imagine you have a server remote configuration with a foo variable with bar value:

from pydantic_firebase_remoteconfig import BaseRemoteConfigModel


class MyRemoteConfigModel(BaseRemoteConfigModel):
    foo: str


config = await MyRemoteConfigModel.model_validate_remoteconfig()
print(config.foo)
# bar

With custom model configuration

A custom model configuration dict is also available.

Key prefix

from pydantic_firebase_remoteconfig import RemoteConfigConfigDict


class MyRemoteConfigModel(BaseRemoteConfigModel):
    model_config = RemoteConfigConfigDict(
        # This would evaluate remote configuration
        # variable `myprefix_foo`.
        rc_prefix="myprefix_",
    )
    foo: str

Parameter group selection

from pydantic_firebase_remoteconfig import RemoteConfigConfigDict


class MyRemoteConfigModel(BaseRemoteConfigModel):
    model_config = RemoteConfigConfigDict(
        # This would evaluate remote configuration
        # variable `foo` under group `my_group`.
        rc_group="my_group",
    )
    foo: str

Complex model using nested delimiter

Using the same pattern than pydantic_settings, nested configuration can be evaluated, based on either:

• A submodel is designed as a JSON parameter on RemoteConfig.
• A submodel is designed as combinaison of flat value with delimiter.

from pydantic import BaseModel
from pydantic_firebase_remoteconfig import RemoteConfigConfigDict


class MyNestedConfig(BaseModel):
    foo: str


class MyRemoteConfigModel(BaseRemoteConfigModel):
    model_config = RemoteConfigConfigDict(
        # This would evaluate remote configuration
        # variable `nested_config__foo`.
        rc_nested_delimiter="__",
    )

    nested_config: MyNestedConfig