Skip to content

Utils

Utils module.

Functions:

Name Description
compare_dirs

Compare dirs.

file_hash

Generate hash.

get_variants

Convert a string into snake_case, camelCase, and UPPER_CASE.

to_camel_case

Convert snake_case or UPPER_CASE to camelCase.

to_pascal_case

Generate class.

to_snake_case

Convert CamelCase or mixed strings to snake_case.

compare_dirs

compare_dirs(dir1: Path, dir2: Path) -> dict

Compare dirs.

file_hash

file_hash(path: Path) -> str

Generate hash.

get_variants

get_variants(name: str) -> str

Convert a string into snake_case, camelCase, and UPPER_CASE. Returns a list of unique values.

Parameters:

Name Type Description Default
name str

The input string (supports snake_case, camelCase, etc.)

required

Returns:

Type Description
str

List of unique strings: [snake, camel, upper]

to_camel_case

to_camel_case(snake_str: str) -> str

Convert snake_case or UPPER_CASE to camelCase.

to_pascal_case

to_pascal_case(text: str) -> str

Generate class.

to_snake_case

to_snake_case(name: str) -> str

Convert CamelCase or mixed strings to snake_case.

Parameters:

Name Type Description Default
name str

The string to convert (e.g., "CamelCase", "camelCase", "my-header").

required

Returns:

Name Type Description
str str

The converted snake_case string.