Skip to main content

More KWARGS! Let call parameters override kwargs

Project description

Extensive 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 simply overwrite the properties that need to be changed for the new configuration. @override has been created to provide this templating system for Python function calls (primarily class constructors).

@override will decorate a function to accept a kwargs parameter which is just like **kwargs, but the call parameters will override the properties in kwargs, rather than raise duplicate key exceptions.

Example

We decorate the login() function with @override. In this case, username is a required parameter, and password will default to None. The kwargs parameter should always default to None so that it’s not required.

@override
def login(username, password=None, kwargs=None):
    pass

Define some dicts for use with our kwargs parameter:

creds = {"userame": "ekyle", "password": "password123"}
alt_creds = {"username": "klahnakoski"}

The simplest case is when we use kwargs with no overrides

login(kwargs=creds)
# SAME AS
login(**creds)
# SAME AS
login(username="ekyle", password="password123")

You may override any property in kwargs: In this case it is password

login(password="123", kwargs=creds)
# SAME AS
login(username="ekyle", password="123")

There is no problem with overriding everything in kwargs:

login(username="klahnakoski", password="asd213", kwargs=creds)
# SAME AS
login(username="klahnakoski", password="asd213")

You may continue to use **kwargs; which provides a way to overlay one parameter template (creds) with another (alt_creds)

login(kwargs=creds, **alt_creds)
# SAME AS
login(username="klahnakoski", password="password123")

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mo-kwargs-2.18.18240.tar.gz (5.5 kB view details)

Uploaded Source

File details

Details for the file mo-kwargs-2.18.18240.tar.gz.

File metadata

  • Download URL: mo-kwargs-2.18.18240.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.9.1 pkginfo/1.4.1 requests/2.18.4 setuptools/38.5.2 requests-toolbelt/0.8.0 tqdm/4.19.5 CPython/2.7.14

File hashes

Hashes for mo-kwargs-2.18.18240.tar.gz
Algorithm Hash digest
SHA256 b5d9a8c2d48ff72be6509d2ecd76114ec40f466dd67b029080900ea7916f0676
MD5 c0fcf2d3aee9b019df246f4131f90a0d
BLAKE2b-256 507a13257e86d2aad44d7785b8a53d3b7b902a7eaa426ba105515c1654f61ac2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page