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!lL;L;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') 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: prop_type = confect.prop_type.of_value(default) else: prop_type = confect.prop_type.PropertyType(type(default), parser) self.prop_type = prop_type @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}>') 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, 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 __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!HW"TTconfect-0.3.0.dist-info/WHEEL A н#J."jm)Afb~ ڡ5 G7hiޅF4+-3ڦ/̖?XPK!H$F4 confect-0.3.0.dist-info/METADATA[rr:IVbX^EO֖ !9xNȟ<@&[ ܋s"$0uu:Fʼnx?^ky"e: OfNDjSʂeDfE^nP4ыr-UTdTr=?~գjx0h|V?,?]3s"kU,{oY!d,שO/*%=!%gO_yP:ɉxU}墾KM{ݯtz ˴X6Puç'>~=.+5AVeEM_+i:*ݪ zu 3sejP<;.Tm7d5x>siZU!zS>j6kSGQtnGz^mĦlD!a+P?wkJ\Қ7.E:Kcy,ZJjaq̀|x(^ϵōܘ8m]j$؈B#TAXN&2(ka5u}o`( ۱%4i }RǮUUy3XHM*[˂Ect]]H 6f*wÂ:Έ.$Ky-ƽ5V`ȶx)Tl\1Mje]\#j^e# =Yy_IXMBX`7Х0KjH/h*Țtln9XPBAxrBuZ45r`ud..`U/;vm>{u+5lEU+g̺5 r6 pu`OǬLu^Zl0Ii1y<9::\pyA#F26uaiKMڐƺ;B"ndI: ceu/lkna.o wi^!#,9PT 9};CLfX)Xf!;Jʈ:klݮa-IGKDQ7A.ډ] J|E"b y6f0[T(̛쬥neI+([5ߵ:9X|8xYD]lӀxN5Φ xP_iTp@GvJw"MnOF<;e360}o&p$֪ aZQGG5z=iid*Vd80F1ֆsn*QM(]dr|AHpmn9en*g]QG옲6gNK2″-FP8Zk4761XzC5ᜫ# #gϞ Ŕ'ѵNrR5s: Dmϲ Eد~ɷ-+B}Ud`f-Pqy$4!f![@Ԧh px[wyv:kqDi,={!PlV|H#J^{W œx&F$AڊhϦ~bToemL[6?~~OAE}ֲ KqG?YibH~x7S5x iZ!1+ ( bzi9"B&zϙЉF4ߏSv[aoX[ypM () gfv}y'𐣣tl杀!SupX2 ]EO\rҕN)U͉DHwDRA+#SGH:Y6XݟeeĵXd 傞t#D܉xy{~ᦱ݅yځ;r_9_V`n=;O:x% $uǦ(z%zr[-aFW2Ěs)fjq\&\stlxbXP_({'Ή_<|na^_ߵ=gcmG>l0% Wvv;$ױv{rb%bgXC/+ ɐyؐYG~OlF<~A1 &cNO jtrKO۬S87ܒbA;nOjY1PQ_8s/!m5p{O(el tvv^6K{'mGDrU%d9:*HD"N;c#y4T>#|(NUʅ:V3|7M)QL= g. wu3_ڏ/-j \#sL|8vD7NC|~vCoOˤ.'L|fj0L.ʦgR^9TηhfFXK+Н&#]_Ƚ}º_,]EN;*ෞ~ðC#X),I0{M_%g3f ^v3Pa,$l#Cļ5J 9̝|'YhEKUzhA$GEpʄԦpQe@ Χ_Iҗp%AߺG?I˓ڒ.b0r ~+M\rR*lɢ_/:njˀ ~YiC՚; _5Na }*j̡{sؾm67` o4X(5wc~_[~p]~vAuBtfVs2{FͭF"CߵL=C ݿ@X 6cAp"ÆF'|{p'&-K6ۚ BݰR=֤&V*Iw׃N%s|ؖŏW/lM:O7aӌAhl8Țzh,Nl=y|:ŚVC;tҎ`ew|r6QۄFLhdL)$/ %G==rvK~W#J+'?U3՜oI b.;wvZfe9yg)'-2U,R/'_Ncem[ࠉ-O&JķW:tI9{ 9ņeŘX%j|FIN0V\oA|VŠ3&nR|j4VDnl۵7M!oⵄ &mq7nٙDzsIEPK!Ha%confect-0.3.0.dist-info/RECORDuλv@>ςH"ptE4&qTumY=˪l'Y8^`\34_ /unhS,? *T8qu5t{~Xj:XQS >Eh?߾0q7"Op55B0XT,/p7pslU&Sn0H\7R;8[+ t8QI7Јzg+䟯w|\alpbͱ/sbD0֭C\nz$귫M.4t(؂^%̫~XTmٽdž_jm27ez2[$%#~ rF1gJJJ_lx'$xtJE],}m})YhR (PK!aUFconfect/__init__.pyPK!wh008confect/click.pyPK!lL;L;confect/conf.pyPK!@confect/conf_depot.pyPK!Iconfect/error.pyPK!:%1HxxJconfect/prop_type.pyPK!HW"TTOconfect-0.3.0.dist-info/WHEELPK!H$F4 9Pconfect-0.3.0.dist-info/METADATAPK!Ha%bconfect-0.3.0.dist-info/RECORDPK dd