No project description provided
Project description
incase
A word case management library with too many features (just in case).
Table of Contents
About The Project
Incase is a library to help manage word case. It includes a class for abstracting away from case for easy comparison of words or conversion to any case. Incase also includes a flexible decorator for managing the case of keywords, inputs, and outputs from functions.
Getting Started
To get a local copy up and running follow these simple steps.
Installing with pip
pip install incase
For information about cloning and dev setup see: Contributing
Usage
Caseless
Here is an example showing basic usage of the Caseless class.
from incase import Case, Caseless
# Easily output any case
example = Caseless("example string")
# By property
print(example.snake)
# my_cool_example_class
# Or by subscript (string or Case)
print(example["camel"])
# exampleString
print(example[Case.UPPER_SNAKE])
# EXAMPLE_STRING
# Caseless ignores case when checking equality with strings
print(Caseless("some name") == "SOME_NAME")
# True
# Caseless can also generate case coercion functions
make_camel = Caseless.factory("camel")
print(make_camel("snake_case"))
# snakeCase
Helper functions
case_modifier is a function for altering other functions. It can change the incoming case of parameter values, the case of the keywords provided, or the case of the function output.
from incase import Case, case_modifier
# Some functions you don't control
def external_function(expectsCamel, iterationCount):
# expects camelCase parameter names
for i in range(iterationCount):
print(expectsCamel)
# We'll use case_modifier. Now any keyword will be turned to camelCase
f = case_modifier(keywords_case=Case.CAMEL)(external_function)
f(expects_camel="this", iteration_count=1)
# this
# Here, we'll use case modifier as a function decorator
# to give a sarcastic twist to our output
@case_modifier(args_case="sarcasm")
def say_words(*args) -> None:
[print(word) for word in args]
say_words("It's all about", "the he said", "SHE SAID")
# It's aLl aBoUt
# ThE He sAi
# ShE SaId
Finally, incase is a powerful case coercion function.
from incase import incase
# It covers the basic case
print(incase("snake", "example text"))
# example_text
# But can also handle sequences
print(incase("upper", ["three", "word", "list"]))
# ['THREE', 'WORD', 'LIST']
print(incase("upper", ("three", "word", "tuple")))
# ('THREE', 'WORD', 'TUPLE')
# Even generators
generator = (word for word in ["some", "list"])
incased = incase("upper", generator)
print(incased)
# <generator object _incase_single.<locals>.<genexpr> at ...
print(list(incased))
# ['SOME', 'LIST']
# Or nested objects
nested = {
"first_key": ["some", "list"],
"second_key": {"another": "dict"},
"third_key": 1,
}
print(incase("upper", nested))
# {"first_key": ["SOME", "LIST"], "second_key": {"another": "DICT"}, "third_key": 1}
# Finally, it is possible to map case to objects
print(incase(["upper", "lower", "snake", "camel"], ["some_word"] * 4))
# ['SOME WORD', 'some word', 'some_word', 'someWord']
# By key
print(
incase(
{"first_key": "alternating", "second_key": "title"},
{"first_key": "some example", "second_key": "another example"},
)
)
# {'first_key': 'SoMe eXaMpLe', 'second_key': 'Another Example'}
Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Add tests, we aim for 100% test coverage Using Coverage
- Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Cloning / Development setup
- Clone the repo and install
git clone https://github.com/kajuberdut/incase.git cd incase pipenv install --dev
- Run tests
pipenv shell ward
For more about pipenv see: Pipenv Github
License
Distributed under the MIT License. See LICENSE
for more information.
Contact
Patrick Shechet - patrick.shechet@gmail.com
Project Link: https://github.com/kajuberdut/incase
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.