pyparamvalidate 项目背景和需求分析

目录

一、前置说明

1、总体目录

2、本节目标

  • 阐述 pyparamvalidate 项目背景和需求分析。

二、主要内容

1、项目背景

在编写 easyuiautotest 自动化测试框架时,经常需要对用户输入的数据进行校验,并给出错误提示。

下面是一段典型的问题代码:

python 复制代码
def example_function(name, age, gender='male', **kwargs):

    # 校验代码
    if not name:
        raise ValueError('name is required')

    if not age:
        raise ValueError('age is required')

    if gender not in ['male', 'female']:
        raise ValueError("gender must be either 'male' or 'female'")

    profile = kwargs.get("profile")
    if profile is None:
        raise ValueError('profile is required')

    address = profile.get("address")
    if not address:
        raise ValueError("address is required")

    # 业务代码
    print(name, age, gender, profile)

它的问题是:大量的校验代码与业务代码混在一起,整体显得很杂乱冗余。

所以需要对它进行改造:将普遍的校验行为抽离出来模块化,最小化对业务代码的侵入。

下面是期望的改造效果:

python 复制代码
@ParamValidator("profile").is_similar_dict(reference_dict={"address": "", "others": {}})
@ParamValidator("gender", "gender must be either 'male' or 'female'").is_allowed("male", "female")
@ParamValidator("age", "age must be integer.").is_integer().is_not_empty()
@ParamValidator("name", "name must be string.").is_string().is_not_empty()
def example_function(name, age, gender='male', **kwargs):

    address = kwargs.get("profile").get("address")
    Validator(address).is_not_empty('address is required')

    # 业务代码
    print(name, age, gender, profile)
    

2、需求分析

从问题与期望中,大致提炼出需求如下:

  • 支持对函数参数进行校验,如:
python 复制代码
@ParamValidator("name", "name must be string.").is_string().is_not_empty()
def example_function(name, age, gender='male', **kwargs):
	...
  • 支持对一般数据进行校验,如:
python 复制代码
address = kwargs.get("profile").get("address")
Validator(address).is_not_empty('address is required')
  • 提供清晰的错误提示,在字段规则描述或在校验方法中给出错误提示,如:
python 复制代码
Validator(address, rule_des='address is required').is_not_empty()
Validator(address).is_not_empty('address is required')
  • 支持链式调用,方便用户连续调用多个校验方法,如:
python 复制代码
Validator(address).is_string().is_not_empty()
  • 支持用户自定义校验规则,如:
python 复制代码
def is_even_number(value):
    return value % 2 == 0

Validator(input).custom_validator(is_even_number, "Value must be an even number")

3、轮子调研

不重复造轮子,确定需求之后,使用 Chatgpt 做了一个简单的调研,发现有几个强大的校验数据结构的库:

暂未发现支持函数参数校验的现成项目(可能调研不全面),于是决定: do it now .

从特性出发,因此将项目命名为:pyparamvalidate .

三、后置说明

1、要点小结

  • 数据校验是一个通用行为,可以将其模块化;
  • do it now ,立即行动,开始实施;

2、下节准备

  • Validator 类的简单实现

点击返回主目录

相关推荐
湫ccc6 分钟前
《Python基础》之字符串格式化输出
开发语言·python
mqiqe44 分钟前
Python MySQL通过Binlog 获取变更记录 恢复数据
开发语言·python·mysql
AttackingLin1 小时前
2024强网杯--babyheap house of apple2解法
linux·开发语言·python
哭泣的眼泪4081 小时前
解析粗糙度仪在工业制造及材料科学和建筑工程领域的重要性
python·算法·django·virtualenv·pygame
湫ccc2 小时前
《Python基础》之基本数据类型
开发语言·python
drebander3 小时前
使用 Java Stream 优雅实现List 转化为Map<key,Map<key,value>>
java·python·list
威威猫的栗子3 小时前
Python Turtle召唤童年:喜羊羊与灰太狼之懒羊羊绘画
开发语言·python
墨染风华不染尘4 小时前
python之开发笔记
开发语言·笔记·python
Dxy12393102164 小时前
python bmp图片转jpg
python
麦麦大数据4 小时前
Python棉花病虫害图谱系统CNN识别+AI问答知识neo4j vue+flask深度学习神经网络可视化
人工智能·python·深度学习