🐫 Convert strings (and dictionary keys) between snake case, camel case and pascal case in Python. Inspired by Humps for Node
Project description
Convert strings (and dictionary keys) between snake case, camel case and pascal case in Python. Inspired by Humps for Node.
Installation
To install humps, simply use pipenv (or pip, of course):
$ pipenv install pyhumps
Usage
Converting strings
import humps
humps.camelize('jack_in_the_box') # jackInTheBox
humps.decamelize('rubyTuesdays') # ruby_tuesdays
humps.pascalize('red_robin') # RedRobin
Converting dictionary keys
import humps
array = [{'attrOne': 'foo'}, {'attrOne': 'bar'}]
humps.decamelize(array) # [{'attr_one': 'foo'}, {'attr_one': 'bar'}]
array = [{'attr_one': 'foo'}, {'attr_one': 'bar'}]
humps.camelize(array) # [{'attrOne': 'foo'}, {'attrOne': 'bar'}]
array = [{'attr_one': 'foo'}, {'attr_one': 'bar'}]
humps.pascalize(array) # [{'AttrOne': 'foo'}, {'AttrOne': 'bar'}]
Checking character casing
import humps
humps.is_camelcase('illWearYourGranddadsClothes') # True
humps.is_pascalcase('ILookIncredible') # True
humps.is_snakecase('im_in_this_big_ass_coat') # True
humps.is_camelcase('from_that_thrift_shop') # False
humps.is_snakecase('downTheRoad') # False
# what about abbrevations, acronyms, and initialisms? No problem!
humps.decamelize('APIResponse') # api_response
Humps Cookbook
Pythonic Boto3 API Wrapper
# aws.py
import humps
import boto3
def api(service, decamelize=True, *args, **kwargs):
service, func = service.split(':')
client = boto3.client(service)
kwargs = humps.pascalize(kwargs)
response = getattr(client, func)(*args, **kwargs)
return (depascalize(response) if decamelize else response)
# usage
api('s3:download_file', bucket='bucket', key='hello.png', filename='hello.png')
Generic API Response Return Mangler
from functools import wraps
import enum
import humps
class Flags(enum.Enum):
RAW = 1
JSON = 2
STATUS_CODE = 4
OK = 8
DECAMELIZE = 16
def returning(api_exception=Exception):
def decorator(fn):
@wraps(fn)
def wrapper(*args, **kwargs):
flags = []
if 'returning' in kwargs:
returning = kwargs.pop('returning')
if isinstance(returning, Flags):
flags.append(returning)
else:
flags.extend(returning)
flags.extend([a for a in args if isinstance(a, Flags)])
args = [a for a in args if not isinstance(a, Flags)]
resp = fn(*args, **kwargs)
is_json = resp.headers.get('Content-Type') == 'application/json'
if not flags or Flags.RAW in flags:
return resp
if Flags.OK in flags:
return resp.ok
if Flags.STATUS_CODE in flags:
return resp.status_code
if Flags.JSON in flags:
if not resp.ok:
raise api_exception(resp.json() if is_json else resp.text)
if Flags.DECAMELIZE in flags:
return humps.decamelize(resp.json())
else:
return resp.json()
return wrapper
return decorator
# usage
import requests
@returning()
def get_todo(todo_id):
return requests.get('https://jsonplaceholder.typicode.com/posts/1')
get_todo(1) # <Response [200]> (true method return)
get_todo(1, Flags.JSON) # {'userId': 1, 'id': 1, 'title': '...'}
get_todo(1, Flags.JSON, Flags.DECAMELIZE) # {'user_id': 1, 'id': 1, 'title': '...'}
get_todo(1, Flags.OK) # True
get_todo(1, Flags.STATUS_CODE) # 200
Flask-RESTful Adaptive Responses
# I will post a code snippet for this soon. It's a decorator that checks if
# the request arguments were passed as camelcase or snake_case, it then
# rewrites the response to match the consumer's preferred casing style.
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
pyhumps-1.1.2.tar.gz
(6.6 kB
view hashes)