PK!aUFconfect/__init__.py from .conf import Conf from .error import (ConfGroupExistsError, FrozenConfGroupError, FrozenConfPropError, UnknownConfError) __all__ = [ Conf, FrozenConfPropError, FrozenConfGroupError, UnknownConfError, ConfGroupExistsError ] PK!L!YD7D7confect/conf.pyimport functools as fnt import importlib import logging import os import weakref from contextlib import contextmanager from copy import deepcopy import confect.parser 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', 'parser') def __init__(self, default=Undefined, parser=None): '''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: parser = confect.parser.of_value(default) self.parser = parser @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 __repr__(self): return (f'<{__name__}.{type(self).__qualname__} ' f'default={self.default!r} value={self._value!r} ' f'parser={self.parser}>') 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 __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].parser(string) 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!Mconfect/parser.pyimport datetime as dt import json from collections import OrderedDict import pendulum as pdl __all__ = ['of_value', 'register'] TYPE_PARSER_MAP = OrderedDict([ (str, lambda s: s), (int, lambda s: int(s)), (float, lambda s: float(s)), (bytes, lambda s: s.encode()), (dt.datetime, lambda s: pdl.parse(s)), (dt.date, lambda s: pdl.parse(s).date()), (tuple, lambda s: tuple(json.load(s))), (dict, lambda s: json.loads(s)), (list, lambda s: json.loads(s)), ]) class register(): '''A function or decorator to register new parsers for some type # >>> from decimal import Decimal # >>> @parser.register(Decimal) # ... def decimal_parser(s): # ... return Decimal(s) # >>> type_parser(Decimal, Decimal) # >>> @register ''' def __init__(self, type_, parser=None): self.type_ = type_ if parser is not None: TYPE_PARSER_MAP[self.type_] = parser def __call__(self, parser): TYPE_PARSER_MAP[self.type_] = parser def of_value(value): for type_, parser in TYPE_PARSER_MAP.items(): if isinstance(value, type_): return parser PK!HW"TTconfect-0.2.7.dist-info/WHEEL A н#J."jm)Afb~ ڡ5 G7hiޅF4+-3ڦ/̖?XPK!H8hf' confect-0.2.7.dist-info/METADATAZے}WL-UXZ׺Xke\q\$3X.ߤRܸ}H`ӗӧ|-ml4NFl&N(3l-c4]QQee:ejS"en#+Bߨ4"Odd-^ɵX#Tfeb9ʊBF+#ʬ*r%*aRrGakmnfFm cNWӣi}W*57,ELFs"2$I0qAX!-:йjCG W5A (sui;;F_ؙ4IȕJ,rkƗ0(Tz*ᴘ>Y)4[Զ}j[e:L4BŰô]5I .@ĘlGNYZڢC ő7(##9%W2Jf1C|%g\LN$E3u<![;f8)Lrg::b%D&w{nw(0,m BAHVB6 SH>ZϋEᇭ' {9HBm ]A1\RCz|@h4Ӎ1-̭` s`Wu((\꠷=࢏ UpIf :d%"e0IT52)WH\ v2CxhGt.&Y-DEPB!|N0+WpVR$4wh_B&q{gc :Ch!9>g&1[d!#Y{AG uJNrd |dG3>"kkDp/wL%$XdGn[Ck)Q :@ZtYA:{d %1ET6)pJ`LUfB6]%u8Ckઑ= 5ְH]ɍ je4Kk 9"TltјTu q"|#l0:fҳifA#[G6aL\hSgwV8-V5GGue̗9AZ7Q;'n0et ܦ_-ouf<ظfl=Tt%6ls8J{SP#ށ[SXjre YgۣkY5t0gwUzk' l >dꍇYAߣ00T \ uӐTA R!7 H;ed׃.8T5L{-cPɠ4%! .ֽ\XSթVSzM o\_Ў֤ziCۍwTBfL?2Y< ;*[써1h~eĒQ9ggtjA^]<0 Oh8pc\y3 vB*T!5hsy,޸.@0/:%@w5k*9_8P.Du=ުZf{;ɼn!Q28.nǝPxՖRe谰FGO_>я:e?{ (ʗZ`cK[gBi"A}Z'2n".{<;n*nt1ңw̙}ao0F_g'1˩%oIOmЂ|;vG].Ϫl3,ս#6^{j/DAg>E*#UUAct p,|3pZu&'gH:+F~Լ2X3fA}VTZ#!hXcx$< Ҩ `s^UVoh4> rFh0,Ssd)l=tTzw ) Ap%zw3wӘM|A:G-xѷ. JH{vq7Ð34h3o..Qd"tL MKew-Ryَ Ѿf P)9{X }ʬG_]t:l,+͋lBVapPZHʤLCV[h-l/^oJ% _b2:q߂bxŀ( "01s6YHuu-%5I%ɒMP JK,,J[2&y.c-5 t&6AC4ei8v/JrºSGF|زi\ z?=#~|ff'⿍}?Enh \'X g[9ŅsGtsh&Nt*Tē)>p7 )8R^p[T-^alzk̷r;@{*!lۋGJg1ҏcHG>jQ5wi^Jrۚ*$iWxt28{t{ PK!aUFconfect/__init__.pyPK!L!YD7D78confect/conf.pyPK!8confect/conf_depot.pyPK!Aconfect/error.pyPK!MBconfect/parser.pyPK!HW"TTQGconfect-0.2.7.dist-info/WHEELPK!H8hf' Gconfect-0.2.7.dist-info/METADATAPK!H&yCVconfect-0.2.7.dist-info/RECORDPK#CX