FastAPI-utils驼峰转换工具：字符串大小写转换的完整指南

FastAPI-utils驼峰转换工具：字符串大小写转换的完整指南

【免费下载链接】fastapi-utilsReusable utilities for FastAPI项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-utils

FastAPI-utils是一个为FastAPI框架提供可重用工具的项目，其中的驼峰转换工具能够轻松实现字符串在snake_case和camelCase之间的转换，帮助开发者处理API开发中常见的命名规范问题。

为什么需要驼峰转换工具？

在API开发中，Python代码通常使用snake_case命名规范，而JSON数据则更倾向于camelCase格式。FastAPI-utils的驼峰转换工具解决了这一命名冲突，让开发者可以专注于业务逻辑而非格式转换。

核心功能模块

驼峰转换功能主要由fastapi_utils.camelcase模块提供，包含两个核心函数：

• snake2camel: 将snake_case字符串转换为camelCase
• camel2snake: 将camelCase字符串转换为snake_case

快速使用指南

基础转换示例

以下是最基本的转换用法：

from fastapi_utils.camelcase import camel2snake, snake2camel # snake_case 转 camelCase print(snake2camel("user_name")) # 输出 "userName" print(snake2camel("user_name", start_lower=False)) # 输出 "UserName" # camelCase 转 snake_case print(camel2snake("userName")) # 输出 "user_name" print(camel2snake("UserName")) # 输出 "user_name"

在APIModel中自动转换

FastAPI-utils的APIModel会自动使用这些转换函数，确保Python代码中的snake_case属性在JSON中自动转换为camelCase：

from fastapi_utils.api_model import APIModel class User(APIModel): user_name: str email_address: str # 序列化时会自动转换为 camelCase user = User(user_name="John Doe", email_address="john@example.com") print(user.json()) # 输出 {"userName": "John Doe", "emailAddress": "john@example.com"}

数据库表名转换

驼峰转换工具还可以用于数据库表名的规范化，例如与SQLAlchemy结合使用：

from sqlalchemy.ext.declarative import declarative_base from fastapi_utils.camelcase import camel2snake Base = declarative_base() Base.__tablename__ = camel2snake(Base.__name__) class MyUser(Base): # 表名将自动变为 "my_user" pass

函数详解

snake2camel函数

snake2camel函数的完整定义如下：

def snake2camel(snake: str, start_lower: bool = False) -> str: """ Converts a snake_case string to camelCase. The `start_lower` argument determines whether the first letter in the generated camelcase should be lowercase (if `start_lower` is True), or capitalized (if `start_lower` is False). """ camel = snake.title() camel = re.sub("([0-9A-Za-z])_(?=[0-9A-Z])", lambda m: m.group(1), camel) if start_lower: camel = re.sub("(^_*[A-Z])", lambda m: m.group(1).lower(), camel) return camel

主要参数：

• snake: 输入的snake_case字符串
• start_lower: 是否小写开头，默认为False（即首字母大写）

camel2snake函数

camel2snake函数的完整定义如下：

def camel2snake(camel: str) -> str: """ Converts a camelCase string to snake_case. """ snake = re.sub(r"([a-zA-Z])([0-9])", lambda m: f"{m.group(1)}_{m.group(2)}", camel) snake = re.sub(r"([a-z0-9])([A-Z])", lambda m: f"{m.group(1)}_{m.group(2)}", snake) return snake.lower()

该函数会处理字母与数字混合的情况，并将所有字母转换为小写。

安装与使用

要使用FastAPI-utils的驼峰转换工具，首先需要安装该项目：

git clone https://gitcode.com/gh_mirrors/fa/fastapi-utils cd fastapi-utils pip install .

安装完成后，即可通过from fastapi_utils.camelcase import camel2snake, snake2camel导入并使用这些转换函数。

总结

FastAPI-utils的驼峰转换工具为开发者提供了简单高效的字符串大小写转换解决方案，特别适合处理API开发中的命名规范差异。通过fastapi_utils.camelcase模块提供的snake2camel和camel2snake函数，开发者可以轻松实现不同命名规范之间的转换，提高代码质量和开发效率。

无论是在数据模型定义、API请求响应处理，还是数据库交互中，这些工具都能发挥重要作用，是FastAPI开发者的必备工具之一。

【免费下载链接】fastapi-utilsReusable utilities for FastAPI项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-utils