textcase

Common errors

• ModuleNotFoundError: No module named 'textcase'

  cause The 'textcase' library is not installed in the current Python environment.
  fix Run `pip install textcase` to install the library.

• AttributeError: module 'textcase' has no attribute 'convert'

  cause You are attempting to use the `convert` function, which was part of an older API (pre-0.4.0 rewrite). The current API uses direct methods on the `textcase` module.
  fix Update your code to use the new API. For example, replace `convert(my_string, case.SNAKE)` with `textcase.snake(my_string)`.

• TypeError: 'Case' object is not callable

  cause This error can occur if you're trying to call `textcase.case.SNAKE()` as a function, or if you're attempting to access `case` or `convert` from an outdated import pattern after the 0.4.0 rewrite.
  fix Ensure you are using `import textcase` and calling methods directly on the module, e.g., `textcase.snake("my string")`. The `case` object is no longer directly exposed in the same way for conversion functions.

Warnings

• breaking Version 0.4.0 introduced a significant rewrite of the library's internal structure and API. The primary way to import and use the library changed from `from textcase import case, convert` to directly importing `textcase` and calling methods on the module (e.g., `textcase.snake()`).
  Fix: Update your imports from `from textcase import case, convert` to `import textcase` and adjust calls from `convert(string, case.SNAKE)` to `textcase.snake(string)`.
• gotcha The library primarily focuses on case conversion based on defined word boundaries. For languages or specific contexts requiring Unicode normalization (e.g., decomposing accented characters before processing), `textcase` does not perform this automatically. Users should handle Unicode normalization separately if needed.
  Fix: If Unicode normalization is required for your text, preprocess strings using Python's `unicodedata` module (e.g., `unicodedata.normalize('NFKC', my_string)`) before passing them to `textcase` functions.
• gotcha Behavior around stripping leading/trailing punctuation and handling specific delimiters was refined in versions 0.4.2 and 0.4.4. If you rely on very specific edge-case punctuation handling, test thoroughly after updating, as outputs might have subtly changed due to bug fixes and optimizations.
  Fix: Review the release notes for versions 0.4.2 and 0.4.4 for details on punctuation stripping changes. Ensure your tests cover expected punctuation behavior, especially for edge cases.

Install

• pip install textcase Install stable version

Imports

• textcase
  wrong:

  from textcase import case, convert

  correct:

  import textcase

  The `case` and `convert` functions were part of an older API (pre-0.4.0) and are no longer the primary way to interact with the library. Direct methods on the `textcase` module are now used.

Quickstart

This quickstart demonstrates how to import the `textcase` library and use its direct methods to convert strings between common text cases like snake_case, camelCase, kebab-case, and PascalCase. It also shows how to use the `.match()` method to check if a string conforms to a specific case.

import textcase

input_string = "Hello, beautiful_World! How are you in this wonderful-Day?"

# Convert to snake_case
snake_case_string = textcase.snake(input_string)
print(f"Snake Case: {snake_case_string}")

# Convert to camelCase
camel_case_string = textcase.camel(input_string)
print(f"Camel Case: {camel_case_string}")

# Convert to KEBAB-CASE
kebab_case_string = textcase.kebab(input_string)
print(f"Kebab Case: {kebab_case_string}")

# Convert to PascalCase
pascal_case_string = textcase.pascal(input_string)
print(f"Pascal Case: {pascal_case_string}")

# Check if a string matches a specific case
is_kebab = textcase.kebab.match("my-css-class")
print(f"'my-css-class' is Kebab Case: {is_kebab}")

is_snake = textcase.snake.match("my_css_class")
print(f"'my_css_class' is Snake Case: {is_snake}")