case-conversion 3.0.2

Convert between different types of cases (unicode supported)

Case Conversion

This is a port of the Sublime Text 3 plugin CaseConversion, by Davis Clark, to a regular python package. I couldn't find any other python packages on PyPI at the time (Feb 2016) that could seamlessly convert from any case to any other case without having to specify from what type of case I was converting. This plugin worked really well, so I separated the (non-sublime) python parts of the plugin into this useful python package. I also added Unicode support via python's unicodedata and extended the interface some.

Features

• Auto-detection of case (no need to specify explicitly which case you are converting from!)
• Acronym detection (no funky splitting on every capital letter of an all caps acronym like HTTPError!)
• Unicode supported (non-ASCII characters are first class citizens!)
• Dependency free!
• Supports Python 3.10+
• Every case conversion from/to you ever gonna need:
  • camel -> "camelCase"
  • pascal / mixed -> "PascalCase" / "MixedCase"
  • snake -> "snake_case"
  • snake / kebab / spinal / slug -> "dash-case" / "kebab-case" / "spinal-case" / "slug-case"
  • const / screaming_snake -> "CONST_CASE" / "SCREAMING_SNAKE_CASE"
  • dot -> "dot.case"
  • separate_words -> "separate words"
  • slash -> "slash/case"
  • backslash -> "backslash\case"
  • ada -> "Ada_Case"
  • http_header -> "Http-Header-Case"

Usage

Converter Class

Basic

>>> from case_conversion import Converter
>>> converter = Converter()
>>> converter.camel("FOO_BAR_STRING")
'fooBarString'

Initialize text when needing to convert the same text to multiple different cases.

>>> from case_conversion import Converter
>>> converter = Converter(text="FOO_BAR_STRING")
>>> converter.camel()
'fooBarString'
>>> converter.pascal()
'FooBarString'

Initialize custom acronyms

>>> from case_conversion import Converter
>>> converter = Converter(acronyms=["BAR"])
>>> converter.camel("FOO_BAR_STRING")
'fooBARString'

Convenience Functions

For backwards compatibility and convenience, all converters are available as top level functions. They are all shorthand for:

Converter(text, acronyms).converter_function()

>>> import case_conversion
>>> case_conversion.dash("FOO_BAR_STRING")
'foo-bar-string'

Simple acronym detection comes included, by treating strings of capital letters as a single word instead of several single letter words.

Custom acronyms can be supplied when needing to separate them from each other.

>>> import case_conversion
>>> case_conversion.snake("fooBADHTTPError")
'foo_badhttp_error'  # we wanted BAD and HTTP to be separate!
>>> case_conversion.snake("fooBarHTTPError", acronyms=['BAD', 'HTTP'])
'foo_bad_http_error'  # custom acronyms achieved!

Unicode is fully supported - even for acronyms.

>>> import case_conversion
>>> case_conversion.const(u"fóó-bar-string")
FÓÓ_BAR_STRING
>>> case_conversion.snake("fooBarHÓÓPError", acronyms=['HÓÓP'])
'foo_bar_hóóp_error'

Install

pip install case-conversion

Contribute

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

This package is being developed with uv (-> docs).

CI will run tests and lint checks. Locally you can run them with:

# runs tests with coverage
make test
# Runs linter (using ruff)
make lint
# Auto-fix linter errors (using ruff --fix)
make format
# run type check (using ty)
make tc

Credits

Credit goes to Davis Clark's as the author of the original plugin and its contributors (Scott Bessler, Curtis Gibby, Matt Morrison). Thanks for their awesome work on making such a robust and awesome case converter.

Further thanks and credit to @olsonpm for making this package dependency-free and encouraging package maintenance and best practices.

License

Using MIT license with Davis Clark's Copyright