Module config.cf

None

None

View Source

from typing import Any, Dict, KeysView

from attrs import field, mutable, validators

from .auth import OAuth2

from .cfenv import CFenv

from .spring import ConfigClient

@mutable

class CF:

    cfenv: CFenv = field(

        factory=CFenv,

        validator=validators.instance_of(CFenv),

    )

    oauth2: OAuth2 = field(default=None)

    client: ConfigClient = field(default=None)

    def __attrs_post_init__(self) -> None:

        if not self.oauth2:

            self.oauth2 = OAuth2(

                access_token_uri=self.cfenv.configserver_access_token_uri(),

                client_id=self.cfenv.configserver_client_id(),

                client_secret=self.cfenv.configserver_client_secret(),

            )

        if not self.client:

            self.client = ConfigClient(

                address=self.cfenv.configserver_uri(),

                app_name=self.cfenv.application_name,

                profile=self.cfenv.space_name.lower(),

                oauth2=self.oauth2,

            )

    @property

    def vcap_services(self):

        return self.cfenv.vcap_services

    @property

    def vcap_application(self):

        return self.cfenv.vcap_application

    def get_config(self, **kwargs) -> None:

        self.client.get_config(**kwargs)

    async def get_config_async(self, **kwargs) -> None:

        await self.client.get_config_async(**kwargs)

    @property

    def config(self) -> Dict:

        return self.client.config

    def get(self, key, default: Any = ""):

        return self.client.get(key, default)

    def keys(self) -> KeysView:

        return self.client.keys()

Classes

CF

class CF(
    cfenv: config.cfenv.CFenv = NOTHING,
    oauth2: config.auth.OAuth2 = None,
    client: config.spring.ConfigClient = None
)

View Source

@mutable

class CF:

    cfenv: CFenv = field(

        factory=CFenv,

        validator=validators.instance_of(CFenv),

    )

    oauth2: OAuth2 = field(default=None)

    client: ConfigClient = field(default=None)

    def __attrs_post_init__(self) -> None:

        if not self.oauth2:

            self.oauth2 = OAuth2(

                access_token_uri=self.cfenv.configserver_access_token_uri(),

                client_id=self.cfenv.configserver_client_id(),

                client_secret=self.cfenv.configserver_client_secret(),

            )

        if not self.client:

            self.client = ConfigClient(

                address=self.cfenv.configserver_uri(),

                app_name=self.cfenv.application_name,

                profile=self.cfenv.space_name.lower(),

                oauth2=self.oauth2,

            )

    @property

    def vcap_services(self):

        return self.cfenv.vcap_services

    @property

    def vcap_application(self):

        return self.cfenv.vcap_application

    def get_config(self, **kwargs) -> None:

        self.client.get_config(**kwargs)

    async def get_config_async(self, **kwargs) -> None:

        await self.client.get_config_async(**kwargs)

    @property

    def config(self) -> Dict:

        return self.client.config

    def get(self, key, default: Any = ""):

        return self.client.get(key, default)

    def keys(self) -> KeysView:

        return self.client.keys()

---

Instance variables

cfenv

client

config

oauth2

vcap_application

vcap_services

Methods

get

def get(
    self,
    key,
    default: Any = ''
)

View Source

    def get(self, key, default: Any = ""):

        return self.client.get(key, default)

get_config

def get_config(
    self,
    **kwargs
) -> None

View Source

    def get_config(self, **kwargs) -> None:

        self.client.get_config(**kwargs)

get_config_async

def get_config_async(
    self,
    **kwargs
) -> None

View Source

    async def get_config_async(self, **kwargs) -> None:

        await self.client.get_config_async(**kwargs)

keys

def keys(
    self
) -> KeysView

View Source

    def keys(self) -> KeysView:

        return self.client.keys()