PK!aUFconfect/__init__.py from .conf import Conf from .error import (ConfGroupExistsError, FrozenConfGroupError, FrozenConfPropError, UnknownConfError) __all__ = [ Conf, FrozenConfPropError, FrozenConfGroupError, UnknownConfError, ConfGroupExistsError ] PK!wh00confect/click.pyimport click def get_builtin_click_param_type(type_): type_to_param_type_map = dict([ (str, click.STRING), (int, click.INT), (float, click.FLOAT), (bool, click.BOOL) ]) return type_to_param_type_map.get(type_) def create_click_param_type(name, parser): cap_name = name[0].upper() + name[1:] def convert(self, value, param, ctx): if isinstance(value, str): return parser(value) return value return type(f'{cap_name}ParamType', (click.ParamType, ), dict(name=name, convert=convert))() def get_click_param_type(type_, parser, name): param_type = get_builtin_click_param_type(type_) if param_type is None: param_type = create_click_param_type(name, parser) return param_type PK!F\<<confect/conf.pyimport functools as fnt import importlib import logging import os import weakref from contextlib import contextmanager from copy import deepcopy import confect.prop_type from confect.error import (ConfGroupExistsError, FrozenConfGroupError, FrozenConfPropError, UnknownConfError) logger = logging.getLogger(__name__) class Undefined: '''Undefined value''' __instance = None __slots__ = () def __new__(cls): if cls.__instance is None: cls.__instance = object.__new__(cls) return cls.__instance def __bool__(self): return False def __repr__(self): return f'<{__name__}.{type(self).__qualname__}>' def __deepcopy__(self, memo): return self.__instance Undefined = Undefined() class ConfProperty: __slots__ = ('_value', 'default', 'prop_type', 'desc') def __init__(self, default=Undefined, parser=None, desc=''): '''Create configuration property with details >>> import confect >>> import datetime as dt >>> conf = confect.Conf() >>> from enum import Enum >>> class Color(Enum): ... RED = 1 ... GREEN = 2 ... BLUE = 3 >>> with conf.declare_group('dummy') as cg: ... cg.a_number = 3 ... cg.some_string = 'some string' ... cg.color = conf.prop( ... default=Color.RED, ... parser=lambda s: getattr(Color, s.upper())) Paramaters ---------- default : ValueType default value parser : Callable[[str], ValueType] parser for reading environment variable or command line argument into property value ''' self.default = default self._value = Undefined if parser is None: prop_type = confect.prop_type.of_value(default) else: prop_type = confect.prop_type.PropertyType(type(default), parser) self.prop_type = prop_type self.desc = desc @property def value(self): if self._value is not Undefined: return self._value return self.default @value.setter def value(self, value): self._value = value def click_callback(self, ctx, param, value): if param.default != value: self._value = value def __repr__(self): return (f'<{__name__}.{type(self).__qualname__} ' f'default={self.default!r} value={self._value!r} ' f'prop_type={self.prop_type}>' f'desc={self.desc}') def __str__(self): return f'{self.desc} [default: {self.default!s}, value: {self.value!s}]' class Conf: '''Configuration >>> import confect >>> conf = confect.Conf() Declare new configuration properties with ``Conf.declare_group(group_name)`` >>> with conf.declare_group('dummy') as cg: ... cg.opt1 = 3 ... cg.opt2 = 'some string' >>> conf.dummy.opt1 3 Configurations are immutable >>> conf.dummy.opt2 = 'other string' Traceback (most recent call last): ... confect.error.FrozenConfPropError: Configuration properties are frozen. Configuration properties can only be changed globally by loading configuration file through ``Conf.load_file()`` and ``Conf.load_module()``. And it can be changed locally in the context created by `Conf.mutate_locally()`. ''' # noqa __slots__ = ('_is_setting_imported', '_is_frozen', '_conf_depot', '_conf_groups', '__weakref__', ) def __init__(self): '''Create a new confect.Conf object >>> import confect >>> conf = confect.Conf() Declare new configuration properties with ``Conf.declare_group(group_name)`` >>> with conf.declare_group('dummy') as cg: ... cg.opt1 = 3 ... cg.opt2 = 'some string' >>> conf.dummy.opt1 3 ''' from confect.conf_depot import ConfDepot self._is_setting_imported = False self._is_frozen = True self._conf_depot = ConfDepot() self._conf_groups = {} def declare_group(self, name, **default_properties): '''Add new configuration group and all property names with default values >>> conf = Conf() Add new group and properties through context manager >>> with conf.declare_group('yummy') as yummy: ... yummy.kind='seafood' ... yummy.name='fish' >>> conf.yummy.name 'fish' Add new group and properties through function call >>> conf.declare_group('dummy', ... num_prop=3, ... str_prop='some string') >>> conf.dummy.num_prop 3 ''' if name in self._conf_groups: raise ConfGroupExistsError( f'configuration group {name!r} already exists') with self.mutate_globally(): group = ConfGroup(self, name) self._conf_groups[name] = group default_setter_ctx = group._default_setter() if default_properties: with default_setter_ctx as default_setter: default_setter._update(default_properties) else: return default_setter_ctx def _backup(self): return deepcopy(self._conf_groups) def _restore(self, conf_groups): self._conf_groups = conf_groups @contextmanager def mutate_locally(self): '''Return a context manager that makes this Conf mutable temporarily. All configuration properties will be restored upon completion of the block. >>> conf = Conf() >>> with conf.declare_group('yummy') as yummy: ... yummy.kind='seafood' ... yummy.name='fish' ... >>> with conf.mutate_locally(): ... conf.yummy.name = 'octopus' ... print(conf.yummy.name) ... octopus >>> print(conf.yummy.name) fish ''' # noqa conf_groups_backup = self._backup() with self.mutate_globally(): yield self._restore(conf_groups_backup) @contextmanager def mutate_globally(self): self._is_frozen = False yield self._is_frozen = True @contextmanager def _confect_c_ctx(self): import confect confect.c = self._conf_depot yield del confect.c def __contains__(self, group_name): return group_name in self._conf_groups def __getitem__(self, group_name): if group_name not in self._conf_groups: raise UnknownConfError( f'Unknown configuration group {group_name!r}') conf_group = self._conf_groups[group_name] if group_name in self._conf_depot: conf_depot_group = self._conf_depot[group_name] conf_group._update_from_conf_depot_group(conf_depot_group) del self._conf_depot[group_name] return conf_group def __getattr__(self, group_name): return self[group_name] def __setitem__(self, group_name, group): raise FrozenConfGroupError( 'Configuration groups are frozen. ' 'Call `confect.declare_group()` for ' 'registering new configuration group.' ) def __setattr__(self, name, value): if name in self.__slots__: object.__setattr__(self, name, value) else: self[name] = value def __dir__(self): return object.__dir__(self) + list(self._conf_groups.keys()) def __deepcopy__(self, memo): cls = type(self) new_self = cls.__new__(cls) new_self._is_setting_imported = self._is_setting_imported new_self._is_frozen = self._is_frozen new_self._conf_depot = deepcopy(self._conf_depot) new_self._conf_groups = deepcopy(self._conf_groups) for group in new_self._conf_groups.values(): group._conf = weakref.proxy(new_self) return new_self def load_file(self, path): '''Load python configuration file through file path. All configuration groups and properties should be added through ``Conf.declare_group()`` in your source code. Otherwise, it won't be accessable even if it is in configuration file. >>> conf = Conf() >>> conf.load_file('path/to/conf.py') # doctest: +SKIP Configuration file example .. code: python from confect import c c.yammy.kind = 'seafood' c.yammy.name = 'fish' ''' # noqa from pathlib import Path if not isinstance(path, Path): path = Path(path) with self.mutate_globally(): with self._confect_c_ctx(): exec(path.open('r').read()) def load_module(self, module_name): '''Load python configuration file through import. The module should be importable either through PYTHONPATH or was install as a package. All configuration groups and properties should be added through ``Conf.declare_group()`` in your source code. Otherwise, it won't be accessable even if it is in configuration file. >>> conf = Conf() >>> conf.load_model('some.module.name') # doctest: +SKIP Configuration file example .. code: python from confect import c c.yammy.kind = 'seafood' c.yammy.name = 'fish' ''' # noqa with self.mutate_globally(): with self._confect_c_ctx(): importlib.import_module(module_name) def load_envvars(self, prefix): '''Load python configuration from environment variables This function automatically searches environment variable in ``____`` format. Be aware of that all of these three identifier are case sensitive. If you have a configuration property ``conf.cache.expire_time`` and you call ``Conf.load_envvars('proj_X')``. It will set that ``expire_time`` property to the parsed value of ``proj_X__cache__expire_time`` environment variable. >> conf = confect.Conf() >> conf.load_envvars('proj_X') # doctest: +SKIP Parameters ---------- prefix : str prefix of environment variables ''' prefix = prefix + '__' with self.mutate_globally(): for name, value in os.environ.items(): if name.startswith(prefix): _, group, prop = name.split('__') value = self.parse_prop(group, prop, value) self._conf_depot[group][prop] = value def parse_prop(self, group, prop, string): return self[group].parse_prop(prop, string) @fnt.wraps(ConfProperty.__init__) def prop(self, *args, **kwargs): return ConfProperty(*args, **kwargs) def _iter_props(self): for group_name, group in self._conf_groups.items(): for prop_name, prop in group._properties.items(): yield group_name, prop_name, prop def click_options(self, cmd_func): '''Attaches all configurations to the command in the `---` form.''' import click props = reversed(list(self._iter_props())) for group_name, prop_name, prop in props: cmd_func = click.option( f'--{group_name}-{prop_name}', default=prop.default, callback=prop.click_callback, expose_value=False, type=prop.prop_type.click_param_type, help=prop.desc, show_default=True)(cmd_func) return cmd_func def __repr__(self): return (f'<{__name__}.{type(self).__qualname__} ' f'groups={list(self._conf_groups.keys())}>') class ConfGroupPropertySetter: __slots__ = ('_conf_group',) def __init__(self, conf_group): self._conf_group = conf_group def __getattr__(self, property_name): return self[property_name] def __setattr__(self, property_name, value): if property_name in self.__slots__: object.__setattr__(self, property_name, value) else: self[property_name] = value def __getitem__(self, property_name): return self._conf_group._properties.setdefault( property_name, ConfProperty()) def __setitem__(self, property_name, default): if isinstance(default, ConfProperty): conf_prop = default else: conf_prop = ConfProperty(default) self._conf_group._properties[property_name] = conf_prop def _update(self, default_properties): for p, v in default_properties.items(): self[p] = v class ConfGroup: __slots__ = ('_conf', '_name', '_properties') def __init__(self, conf: Conf, name: str): self._conf = weakref.proxy(conf) self._name = name self._properties = {} def __getattr__(self, property_name): return self[property_name] def __setattr__(self, property_name, value): if property_name in self.__slots__: object.__setattr__(self, property_name, value) else: self[property_name] = value def __getitem__(self, property_name): if property_name not in self._properties: raise UnknownConfError( f'Unknown {property_name!r} property in ' f'configuration group {self._name!r}') return self._properties[property_name].value def __setitem__(self, property_name, value): if self._conf._is_frozen: raise FrozenConfPropError( 'Configuration properties are frozen.\n' 'Configuration properties can only be changed globally by ' 'loading configuration file through ' '``Conf.load_file()`` and ``Conf.load_module()``.\n' 'And it can be changed locally in the context ' 'created by `Conf.mutate_locally()`.' ) else: self._properties[property_name].value = value def __dir__(self): return self._properties.keys() @contextmanager def _default_setter(self): yield ConfGroupPropertySetter(self) def _update_from_conf_depot_group(self, conf_depot_group): for conf_property, value in conf_depot_group._items(): if conf_property in self._properties: self._properties[conf_property].value = value def __deepcopy__(self, memo): cls = type(self) new_self = cls.__new__(cls) new_self._conf = self._conf # Don't need to copy conf new_self._name = self._name new_self._properties = deepcopy(self._properties) return new_self def parse_prop(self, prop, string): return self._properties[prop].prop_type.parser(string) def as_dict(self): return { name: prob.value for name, prob in self._properties.items() } def __repr__(self): return (f'<{__name__}.{type(self).__qualname__} ' f'{self._name} properties={list(self._properties.keys())}>') PK!confect/conf_depot.py from confect.error import UnknownConfError class ConfDepot: __slots__ = '_depot_groups' def __init__(self): self._depot_groups = {} def __delitem__(self, group_name): del self._depot_groups[group_name] def __getitem__(self, group_name): if group_name not in self._depot_groups: conf_depot_group = ConfDepotGroup() self._depot_groups[group_name] = conf_depot_group return self._depot_groups[group_name] def __getattr__(self, group_name): return self[group_name] def __setattr__(self, name, value): if name in self.__slots__: object.__setattr__(self, name, value) else: raise TypeError( 'Adding property to first level of ConfDepot is forbidding.\n' # noqa 'In configuration file, all configuration properties should be in some configuration group.\n' # noqa 'Configuration group would be created automatically when needed.\n' # noqa 'In the following example, `yummy` is the group name and `kind` is the property name.\n' # noqa '>>> c.yummy.kind = "seafood"' ) def __contains__(self, group_name): return group_name in self._depot_groups def __dir__(self): return self._depot_groups.keys() class ConfDepotGroup: __slots__ = '_depot_properties' def __init__(self): self._depot_properties = {} def _items(self): return self._depot_properties.items() def __getitem__(self, property_name): if property_name not in self._depot_properties: raise UnknownConfError( f'ConfDepotGroup object has no property {property_name!r}' ) return self._depot_properties[property_name] def __setitem__(self, property_name, value): self._depot_properties[property_name] = value def __getattr__(self, property_name): return self[property_name] def __setattr__(self, name, value): if name in self.__slots__: object.__setattr__(self, name, value) else: self[name] = value def __dir__(self): return self._depot_properties.keys() PK!confect/error.py class UnknownConfError(AttributeError, KeyError): pass class FrozenConfPropError(TypeError): pass class FrozenConfGroupError(TypeError): pass class ConfGroupExistsError(ValueError): pass PK!:%1Hxxconfect/prop_type.pyimport ast import datetime as dt import json __all__ = ['of_value', 'PropertyType'] class PropertyType(): def __init__(self, type_, parser, name=None, click_param_type=None): self.type_ = type_ self.parser = parser if name is None: name = type_.__name__ self.name = name if click_param_type is None: try: import confect.click click_param_type = confect.click.get_click_param_type( type_, parser, name) except ModuleNotFoundError as e: pass self.click_param_type = click_param_type prop_types = [ PropertyType(bool, lambda s: bool(ast.literal_eval(s))), PropertyType(str, lambda s: s, str), PropertyType(int, lambda s: int(s)), PropertyType(float, lambda s: float(s)), PropertyType(bytes, lambda s: s.encode()), PropertyType(tuple, lambda s: tuple(json.load(s))), PropertyType(dict, lambda s: json.loads(s)), PropertyType(list, lambda s: json.loads(s)), ] try: import pendulum as pdl prop_types += [ PropertyType(dt.datetime, lambda s: pdl.parse(s)), PropertyType(dt.date, lambda s: pdl.parse(s).date()) ] except ModuleNotFoundError: pass def of_value(value): for prop_type in prop_types: if isinstance(value, prop_type.type_): return prop_type PK!HnHTUconfect-0.3.3.dist-info/WHEEL A н#Z;/"d&F[xzw@Zpy3Fv]\fi4WZ^EgM_-]#0(q7PK!H`+A7 confect-0.3.3.dist-info/METADATA[rFvSt&EI#3#0z~T3ͺ\`h@$q\o7M 7y;9|jZ*T< oZME\ ׁ8< Oz-THqWE eSD+Y!=dfJ/rVu]dLU3b=I>}œbx*h|VxOwjs[T :͗ǽଁTϿ_?>LЪ\'$@NI+f S$[>WEKBݨ(*+T8t7iՕei|*EkP<;PT__m7/U5x~>4͏wE7$YR;U:j/ϋM ݸuMs1?_/ia1?oJh(LR>: !4+y0MiT.ꕬyj-B8VZ a^) 8 Q<hYĵO.d>Z9J%R-VVAMy wjih*zh4UZVtP9}'T~VENkDԝ\:n5qq)d XOqΈXZYk5>ib^Uqo&SH0dnRH ɴ魳31M E]e-mR}ZxEcy{U5&SPwRP25&\wfVsCS4&W$[F:VVNiGv!ΰFr[գ/USbHөL-`/[hƎ쉤 bw5V {^qU`NԀ4QY[BAod((Q /WGy4% FK [BՂ0P \I28K2uSW xͲ Ȝ , Zg%HM)H!~rsyk `́Ll)1ox C1F L q aeju"c"ة9ܔT]d6O MEp=IUdQۍsA1,)(V)B|p5#]v\+; ѣ~)KVi 3(Q>sp ݢȲ#Fn$. cy7fWw;㶿O=6w!ԎRD0CjbU₇8'[nM`ί؋*xpJzr/h'd W\ߜayGَcv}#@Yjl+>Q]SeUE"J!D<<{;%s6l?]o&H&4(apZQ'O'5x =UMRq`c ؖx֛BJW>JZ%aQ- 1ݤ;? @ )p L$sIC:`;hk[A ͷz[sYO /[p Rʇ-m][N`{el\2:upVm0`7Xo)XyjL; 6B-G ,-49b؁/"=hm>`h?'_a6 q :}pB@<偰Tc=PuaMEeGb_o*_R>yj]d81b?dO~Gq~u:~_`'Q2%7,MI Ց/2wC.bN5p5P%| \pv+ gϞ Ŕ઒K:Vb[(%U"{}E\No*'E3د=BsӶkph_Osҟ=y}wNpHC} 6_X@9ȌK^X2{V0oqBdװ: =}WMFa7y2TȭwC<бw=Li/ QT&']9̔.9L[;hddtT'IbW MֶXd ɖ弞2syьI6 ~&_q_ih'?0DewavaWū`1ڊr gGQD7(FQD3Fݱr.#[s)R W*+Śsfjq,1MB B=˫oyk4f2Cn.\{NV?{6ü:k{t3^>t=ێ6}%~14]G~.&vHc/1tK^O^lW`;8! !#(2Нn'96{MpǜNNCB:NvO'xm..Hl7hr4#өY'U[e\oqg?WEOr睾}=R9k%+GP@lY}q>>hd(͝H;5 {L6DkPsoq ~D֑'TLTLAm6 )m[bZO\zE}i: |D7%AߺG?Iڒ.b0"d?z%&.tT \_;njˀig > ĕXon5o9wbq6ymÁ>OX}7 f"́{ TV }Bck/mo}ڎ\7/il76Kk{w"bpcpB/־XȰa  )p x~8PTrdTRCDدu/=w痯žlMb: OG9ec 4&$zAOH''[OLe[xՐ aM4`=Z~fa6#?Z49SKDnP*f`ҸՀʫbp ?e3ҘojAtlom/Ց;еjcFȚejϞlߴL'Sd*(¢ZN~3y>-3.k_:4ԓLo &m`OdOEfXP?/͸dJ04O5_1m' @gZsXpjCT46SB*D;b͘ 艛iF _Ri1QDvŶjp:PPIj嵝oBvj0Ah _PK!H1V}confect-0.3.3.dist-info/RECORDu;@| D X &((00ϫ`ξꆨ=~dYV4^fy-ȧr"%sj~~i83L|)XWH[Eagsun$q9n3s~y s76(rV =y h9S#XӍpKC}ኩ."n󐄸Qw7؄q Byj$)*fQQ7V{Cax:S} &gtŋ5%&)q"+!D)mtW:Vţ<cwCSj# V<\ejWq|H !0݅]b̥MبQY(YӖrƼjC`irgvݠ\+HGymhZgPK!aUFconfect/__init__.pyPK!wh008confect/click.pyPK!F\<<confect/conf.pyPK!qAconfect/conf_depot.pyPK!bJconfect/error.pyPK!:%1HxxbKconfect/prop_type.pyPK!HnHTU Qconfect-0.3.3.dist-info/WHEELPK!H`+A7 Qconfect-0.3.3.dist-info/METADATAPK!H1V}econfect-0.3.3.dist-info/RECORDPK dg