Skip to main content

Convert strings between camelCase, snake_case, PascalCase, kebab-case, and more

Project description

philiprehberger-str-case

Tests PyPI version Last updated

Convert strings between camelCase, snake_case, PascalCase, kebab-case, and more.

Installation

pip install philiprehberger-str-case

Usage

from philiprehberger_str_case import to_snake, to_camel, to_pascal, to_kebab

to_snake("HTMLParser")       # "html_parser"
to_camel("html_parser")      # "htmlParser"
to_pascal("get-https-url")   # "GetHttpsUrl"
to_kebab("getHTTPSUrl")      # "get-https-url"

Acronym handling

Acronyms are split correctly:

from philiprehberger_str_case import to_snake

to_snake("HTMLParser")    # "html_parser"
to_snake("getHTTPSUrl")  # "get_https_url"
to_snake("XMLToJSON")    # "xml_to_json"

Number-aware splitting

Numbers at letter-digit boundaries are split into separate words:

from philiprehberger_str_case import to_snake, to_kebab

to_snake("html2json")      # "html_2_json"
to_snake("item123Name")    # "item_123_name"
to_kebab("v2Api")          # "v2-api"  (single-letter prefix stays attached)

More formats

from philiprehberger_str_case import to_constant, to_title, to_dot, to_path

to_constant("htmlParser")  # "HTML_PARSER"
to_title("html_parser")    # "Html Parser"
to_dot("htmlParser")       # "html.parser"
to_path("htmlParser")      # "html/parser"

Sentence case and Header-Case

from philiprehberger_str_case import to_sentence, to_header

to_sentence("html_parser")    # "Html parser"
to_sentence("getHTTPSUrl")    # "Get https url"

to_header("content_type")     # "Content-Type"
to_header("xForwardedFor")    # "X-Forwarded-For"

Convert dictionary keys

from philiprehberger_str_case import convert_keys, to_snake

data = {
    "firstName": "John",
    "lastName": "Doe",
    "contactInfo": {
        "emailAddress": "john@example.com",
        "phoneNumber": "555-1234",
    },
}

convert_keys(data, to_snake)
# {
#     "first_name": "John",
#     "last_name": "Doe",
#     "contact_info": {
#         "email_address": "john@example.com",
#         "phone_number": "555-1234",
#     },
# }

Lists of dicts are also supported:

records = [{"firstName": "Alice"}, {"firstName": "Bob"}]
convert_keys(records, to_snake)
# [{"first_name": "Alice"}, {"first_name": "Bob"}]

Detect case

from philiprehberger_str_case import detect_case, is_case

detect_case("my_variable")   # "snake_case"
detect_case("myVariable")    # "camelCase"
detect_case("MyVariable")    # "PascalCase"
detect_case("my-variable")   # "kebab-case"
detect_case("MY_VARIABLE")   # "CONSTANT_CASE"
detect_case("Content-Type")  # "Header-Case"
detect_case("Hello world")   # "Sentence case"

is_case("my_variable", "snake_case")  # True
is_case("my_variable", "camelCase")   # False

API

Function Description
to_snake(s) Convert to snake_case
to_camel(s) Convert to camelCase
to_pascal(s) Convert to PascalCase
to_kebab(s) Convert to kebab-case
to_constant(s) Convert to CONSTANT_CASE
to_title(s) Convert to Title Case
to_dot(s) Convert to dot.case
to_path(s) Convert to path/case
to_sentence(s) Convert to Sentence case
to_header(s) Convert to HTTP Header-Case
convert_keys(data, converter) Recursively convert dict/list keys
detect_case(s) Detect case convention of a string
is_case(s, case) Check if string matches a case convention

Development

pip install -e .
python -m pytest tests/ -v

Support

If you find this project useful:

Star the repo

🐛 Report issues

💡 Suggest features

❤️ Sponsor development

🌐 All Open Source Projects

💻 GitHub Profile

🔗 LinkedIn Profile

License

MIT

Project details


Download files

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

Source Distribution

philiprehberger_str_case-0.2.3.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_str_case-0.2.3-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_str_case-0.2.3.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_str_case-0.2.3.tar.gz
Algorithm Hash digest
SHA256 d1d33847aee3112e099fa39990bbe86bcee2c8bd986535e221050b53d24f3104
MD5 7523e8ffe06ec2677b277321fcae374a
BLAKE2b-256 df8860d510e9b3319cd950afeff0ee0be59e5c6c6f72c152e37de1d68c415ed5

See more details on using hashes here.

File details

Details for the file philiprehberger_str_case-0.2.3-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_str_case-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5bbb42d4626284920a85f638689b1d9f93608efdaca73d6931dedbb4d69c349f
MD5 c5c517b0697094178bdcfa4cdbbfc189
BLAKE2b-256 d8ea8189959a6d7bb367e49681ee024b7ba8bea7cd4545f2e05945876bca2e40

See more details on using hashes here.

Supported by

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