Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Decorator for fixing naming conventions to keys of keyword arguments - adds trailing underscores to keys using bad naming such as reserved keywords or Python built-ins

Project description

cure

pypi Made with Python Type hinted - mypy validated MIT License Code coverage

Library for adding trailing underscores to passed down keyword arguments from third party libraries. Adds the preferred trailing underscore to the key in the kwarg if the key would conflict with the Python reserved keywords or Python built-ins. Methods can be decorated with the @cure decorator.

Can also be used to convert input keyword arguments to snake case. All in all a decorator to put on your functions which take input from third party libraries which are dependant on user input. In my experience this may happen when working with web frameworks that may apply query values as kwargs or when interfacing with GraphQL libraries that will send user input arguments as kwargs.

As described in PEP 8 -- Style Guide for Python Code (https://www.python.org/dev/peps/pep-0008/):

The following special forms using leading or trailing underscores are recognized (these can generally be combined with any case convention):

single_trailing_underscore_: used by convention to avoid conflicts with Python keyword.

Installation with pip

Like you would install any other Python package, use pip, poetry, pipenv or your weapon of choice.

$ pip install cure

Usage and examples

Use the @cure.decorator

import cure

@cure.decorator(cure.KEYWORD_TRAILING_UNDERSCORES)
def my_function(id_=None, username=None, type_=None):
    pass

This function could then be called with the keyword arguments id, username and/or type. Since id and type are either reserved Python keywords or are Python built-ins and shouldn't be used as names, the decorator will add a trailing underscore to the kwargs before passing them into our function my_function.

Convert kwargs to snake case as well

import cure

@cure.decorator(cure.KEYWORD_TRAILING_UNDERSCORES | cure.KEYWORD_SNAKE_CASE_RECURSIVE)
def graphql_resolver(obj, info, resource_id, type_=None):
    pass

This function uses both the options of adding trailing underscores to reserved keywords and built-ins as well as the option of converting input kwargs to snake case. Let's say we're dealing with a GraphQL framework which would otherwise call our function like this, depending on the user input my_function(None, info, resourceId=kwargs["resourceId"], type=kwargs["type"]) or even more likely like my_function(None, info, **kwargs) where kwargs would be a dict holding the keys resourceId and type. Since we want our code to be Pythonic and adhere to proper naming conventions the @cure.decorator can help out with removing the hurdle of converting the kwargs ourself or by jumping through hoops otherwise required.

Available options

  • cure.KEYWORD_TRAILING_UNDERSCORES: Adds trailing underscores to keys in keyword arguments that are using a name that is either a reserved keyword or a Python built-in.
  • cure.KEYWORD_SNAKE_CASE: Converts keys in keyword arguments to snake case.
  • cure.KEYWORD_SNAKE_CASE_RECURSIVE: Converts keys in keyword arguments to snake case. If the keyword argument's value is a dict or a list of dicts it will also convert keys within these to snake case.
  • cure.KEYWORD_CAMEL_CASE: Converts keys in keyword arguments to camel case. This is not recommended, but may be used as a reversal of values converted by the snake case decorator.
  • cure.KEYWORD_CAMEL_CASE_RECURSIVE: Recursive conversion to camel case.

Other functions

The following functions are also available from the module.

cure.is_keyword(kw)
import cure

cure.is_keyword("id")
# True
cure.is_keyword("type")
# True
cure.is_keyword("api")
# False
cure.trail_name(kw)
import cure

cure.trail_name("id")
# "id_"
cure.trail_name("type")
# "type_"
cure.trail_name("api")
# "api"
cure.snake_case_name(kw) and cure.snake_case_dict(input_dict, recursive)
import cure

cure.snake_case_name("apiSecret")
# "api_secret"
cure.snake_case_dict({"user": {"userId": 4711, "userLevel": "ADMIN"}}, recursive=True)
# {'user': {'user_id': 4711, 'user_level': 'ADMIN'}}
cure.camel_case_name(kw) and cure.camel_case_dict(input_dict, recursive)
import cure

cure.camel_case_name("api_secret")
# "apiSecret"
cure.camel_case_dict({"user": {"user_id": 4711, "user_level": "ADMIN"}}, recursive=True)
# {'user': {'userId': 4711, 'userLevel': 'ADMIN'}}

Project details


Download files

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

Files for cure, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size cure-0.2.2-py3-none-any.whl (6.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cure-0.2.2.tar.gz (7.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page