Skip to content

camelCase to snake_case conversion - Fixes #9726 #9727

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions strings/camel_case_to_snake_case.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
def camel_to_snake_case(input_str: str) -> str:
"""
Transforms a camelCase (or PascalCase) string to snake_case

>>> camel_to_snake_case("someRandomString")
'some_random_string'

>>> camel_to_snake_case("SomeRandomString")
'some_random_string'

>>> camel_to_snake_case("123someRandom123String123")
'123_some_random_123_string_123'

>>> camel_to_snake_case("123SomeRandom123String123")
'123_some_random_123_string_123'

>>> camel_to_snake_case(123)
Traceback (most recent call last):
...
ValueError: Expected string as input, found <class 'int'>

"""

import re

# check for invalid input type
if not isinstance(input_str, str):
msg = f"Expected string as input, found {type(input_str)}"
raise ValueError(msg)

# Replace all characters that are not letters or numbers with the underscore
snake_str = re.sub(r"[^a-zA-Z0-9]", "_", input_str)

# Find where lowercase meets uppercase. Insert underscore between them
snake_str = re.sub(r"([a-z])([A-Z])", r"\1_\2", snake_str).lower()

# Find the sequence of digits at the beginning
snake_str = re.sub(r"^(\d+)", r"\1_", snake_str)

# Find the sequence of digits at the end
snake_str = re.sub(r"(\d+)$", r"_\1", snake_str)

# Find where letter meets digits
snake_str = re.sub(r"([a-z])(\d+)", r"\1_\2", snake_str)

# Find where digits meet letter
snake_str = re.sub(r"(\d+)([a-z])", r"\1_\2", snake_str)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this be done without using a regex?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add Fixes: #9726 to the description.

Added.

Can this be done without using a regex?

Yes, it can. Although I suspect the code will be longer. I'll get to it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ChrisO345
I have updated the code. It no longer uses regex.


return snake_str


if __name__ == "__main__":
from doctest import testmod

testmod()