aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/pydantic/alias_generators.py
diff options
context:
space:
mode:
Diffstat (limited to '.venv/lib/python3.12/site-packages/pydantic/alias_generators.py')
-rw-r--r--.venv/lib/python3.12/site-packages/pydantic/alias_generators.py62
1 files changed, 62 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/pydantic/alias_generators.py b/.venv/lib/python3.12/site-packages/pydantic/alias_generators.py
new file mode 100644
index 00000000..0b7653f5
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/pydantic/alias_generators.py
@@ -0,0 +1,62 @@
+"""Alias generators for converting between different capitalization conventions."""
+
+import re
+
+__all__ = ('to_pascal', 'to_camel', 'to_snake')
+
+# TODO: in V3, change the argument names to be more descriptive
+# Generally, don't only convert from snake_case, or name the functions
+# more specifically like snake_to_camel.
+
+
+def to_pascal(snake: str) -> str:
+ """Convert a snake_case string to PascalCase.
+
+ Args:
+ snake: The string to convert.
+
+ Returns:
+ The PascalCase string.
+ """
+ camel = snake.title()
+ return re.sub('([0-9A-Za-z])_(?=[0-9A-Z])', lambda m: m.group(1), camel)
+
+
+def to_camel(snake: str) -> str:
+ """Convert a snake_case string to camelCase.
+
+ Args:
+ snake: The string to convert.
+
+ Returns:
+ The converted camelCase string.
+ """
+ # If the string is already in camelCase and does not contain a digit followed
+ # by a lowercase letter, return it as it is
+ if re.match('^[a-z]+[A-Za-z0-9]*$', snake) and not re.search(r'\d[a-z]', snake):
+ return snake
+
+ camel = to_pascal(snake)
+ return re.sub('(^_*[A-Z])', lambda m: m.group(1).lower(), camel)
+
+
+def to_snake(camel: str) -> str:
+ """Convert a PascalCase, camelCase, or kebab-case string to snake_case.
+
+ Args:
+ camel: The string to convert.
+
+ Returns:
+ The converted string in snake_case.
+ """
+ # Handle the sequence of uppercase letters followed by a lowercase letter
+ snake = re.sub(r'([A-Z]+)([A-Z][a-z])', lambda m: f'{m.group(1)}_{m.group(2)}', camel)
+ # Insert an underscore between a lowercase letter and an uppercase letter
+ snake = re.sub(r'([a-z])([A-Z])', lambda m: f'{m.group(1)}_{m.group(2)}', snake)
+ # Insert an underscore between a digit and an uppercase letter
+ snake = re.sub(r'([0-9])([A-Z])', lambda m: f'{m.group(1)}_{m.group(2)}', snake)
+ # Insert an underscore between a lowercase letter and a digit
+ snake = re.sub(r'([a-z])([0-9])', lambda m: f'{m.group(1)}_{m.group(2)}', snake)
+ # Replace hyphens with underscores to handle kebab-case
+ snake = snake.replace('-', '_')
+ return snake.lower()