diff --git a/setup.py b/setup.py index 6bf65fe..83fdabb 100644 --- a/setup.py +++ b/setup.py @@ -9,13 +9,13 @@ description='More KWARGS! Let call parameters override kwargs', extras_require={"tests":["mo-testing","mo-times","mo-json","mo-threads"]}, include_package_data=True, - install_requires=["mo-dots==7.4.21313","mo-future==6.2.21303"], + install_requires=["mo-dots==9.113.22021","mo-future==6.2.21303"], license='MPL 2.0', long_description='\n# More KWARGS!\n\n|Branch |Status |\n|------------|---------|\n|master | [![Build Status](https://app.travis-ci.com/klahnakoski/mo-kwargs.svg?branch=master)](https://travis-ci.com/github/klahnakoski/mo-kwargs) |\n|dev | [![Build Status](https://app.travis-ci.com/klahnakoski/mo-kwargs.svg?branch=dev)](https://travis-ci.com/github/klahnakoski/mo-kwargs) [![Coverage Status](https://coveralls.io/repos/github/klahnakoski/mo-kwargs/badge.svg?branch=dev)](https://coveralls.io/github/klahnakoski/mo-kwargs?branch=dev) |\n\n\n\n## Motivation\n\nExtensive use of dependency injection, plus managing the configuration for each of the components being injected, can result in some spectacularly complex system configuration. One way to reduce the complexity is to use configuration templates that contain useful defaults, and then overwrite the properties that need to be changed for the desired configuration. \n\n`@override` has been created to provide this templating system for Python function calls. It is mostly used for class constructors, but any method can benefit. The `@overrides` decorator adds a `kwargs` parameter which can be given a template of default parameters; but unlike `**kwargs`, it will not raise duplicate key exceptions.\n\n## Provide default values\n\nWe decorate the `login()` function with `@override`. In this case, `username` is a required parameter, and `password` will default to `None`. \n\n @override\n def login(username, password=None):\n pass\n\nDefine some `dicts` for use with our `kwargs` parameter:\n\n creds = {"userame": "ekyle", "password": "password123"}\n alt_creds = {"username": "klahnakoski"}\n\n\nThe simplest case is when we use `kwargs` with no overrides\n\n login(kwargs=creds)\n # SAME AS\n login(**creds)\n # SAME AS\n login(username="ekyle", password="password123")\n\nYou may override any property in `kwargs`: In this case it is `password`\n\n login(password="123", kwargs=creds)\n # SAME AS\n login(username="ekyle", password="123")\n\nThere is no problem with overriding everything in `kwargs`:\n\n login(username="klahnakoski", password="asd213", kwargs=creds)\n # SAME AS\n login(username="klahnakoski", password="asd213")\n\nYou may continue to use `**kwargs`; which provides a way to overlay one parameter template (`creds`) with another (`alt_creds`)\n\n login(kwargs=creds, **alt_creds)\n # SAME AS\n login(username="klahnakoski", password="password123")\n\n## Handle too many parameters\n\nSometimes your method parameters come from a configuration file, or some other outside source which is outside your control. There may be more parameters than your method is willing to accept. \n\n creds = {"username": "ekyle", "password": "password123", "port":9000}\n def login(username, password=None):\n print(kwargs.get("port"))\n\nWithout `mo-kwargs`, passing the `creds` dictionary directly to `login()` would raise a key error\n\n >>> login(**creds)\n Traceback (most recent call last):\n File "", line 1, in \n TypeError: login() got an unexpected keyword argument \'port\'\n \nThe traditional solution is to pass the parameters explicitly:\n\n login(username=creds.username, password=creds.password)\n\nbut that can get get tedious when done often, or the parameter list get long. `mo-kwargs` allows you to pass the whole dictionary to the `kwargs` parameter; only the parameters used by the method are used:\n\n @override\n def login(username, password=None):\n pass\n \n login(kwargs=creds)\n # SAME AS\n login(username=creds.username, password=creds.password)\n\n## Package all parameters\n\nYour method can accept `kwargs` as a parameter. If it does, ensure it defaults to `None` so that it\'s not required.\n\n @override\n def login(username, password=None, kwargs=None):\n print(kwargs.get("username"))\n print(kwargs.get("port"))\n\n`kwargs` will always be a dict, possibly empty, with the full set of parameters. This is different from using `**kwargs` which contains only the remainder of the keyword parameters.\n\n >>> creds = {"username": "ekyle", "password": "password123", "port":9000}\n >>> login(**creds)\n ekyle\n 9000\n', long_description_content_type='text/markdown', name='mo-kwargs', packages=["mo_kwargs"], url='https://github.com/klahnakoski/mo-kwargs', - version='7.4.21313', + version='7.114.22021', zip_safe=False ) \ No newline at end of file diff --git a/setuptools.json b/setuptools.json index 8603f50..d370b2d 100644 --- a/setuptools.json +++ b/setuptools.json @@ -13,7 +13,7 @@ "description": "More KWARGS! Let call parameters override kwargs", "extras_require": {"tests": ["mo-testing", "mo-times", "mo-json", "mo-threads"]}, "include_package_data": true, - "install_requires": ["mo-dots==7.4.21313", "mo-future==6.2.21303"], + "install_requires": ["mo-dots==9.113.22021", "mo-future==6.2.21303"], "license": "MPL 2.0", "long_description": { "$concat": [ @@ -125,6 +125,6 @@ "name": "mo-kwargs", "packages": ["mo_kwargs"], "url": "https://github.com/klahnakoski/mo-kwargs", - "version": "7.4.21313", + "version": "7.114.22021", "zip_safe": false } \ No newline at end of file