LLM-Guard项目中BanSubstrings扫描器的参数设计优化
2025-07-10 16:37:24作者:蔡丛锟
在LLM-Guard项目的BanSubstrings输入扫描器模块中,开发者对参数设计进行了重要优化,这些改进不仅提升了代码的健壮性,也增强了API的易用性。
参数默认值的重新设计
原实现中substrings参数默认为None的设计存在几个问题:首先,这使得类型检查变得复杂,需要额外的None值验证;其次,这种设计违背了Python的"显式优于隐式"原则。优化后的版本将substrings改为必填参数,这样可以在编译阶段就捕获错误,而不是在运行时通过assert语句检查。
这种改变带来了多重好处:
- 移除了运行时断言检查,避免了Python优化模式(-O)下断言被移除的风险
- 使API设计更加直观,用户必须显式提供要禁止的子字符串列表
- 减少了维护负担,因为不再需要处理None值的特殊情况
类型注解的改进
参数类型从List[str]升级为Sequence[str],这是一个更通用的抽象:
- Sequence是比List更宽泛的概念,包括tuple、list等任何实现了
__len__的可迭代对象 - 保持了类型安全的同时提供了更大的灵活性
- 符合Python的鸭子类型哲学,用户可以使用任何序列类型而不仅限于列表
API设计的最佳实践
通过添加*参数,强制后续参数必须使用关键字形式传递:
BanSubstrings(["a", "b", "c"], match_type="str", case_sensitive=False)
这种设计消除了位置参数带来的歧义,使代码更易读和维护。虽然这是一个破坏性变更,但在项目早期阶段(v0.x)是可以接受的,且带来的长期收益远大于短期迁移成本。
对项目质量的提升
这些改进共同提升了LLM-Guard项目的代码质量:
- 更强的类型安全性
- 更清晰的API设计
- 更少的运行时错误可能性
- 更好的开发者体验(IDE支持更完善)
这些变化体现了Python最佳实践在安全关键项目中的应用,展示了如何通过精心设计的API来构建更可靠的系统。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C089
baihu-dataset异构数据集“白虎”正式开源——首批开放10w+条真实机器人动作数据,构建具身智能标准化训练基座。00
mindquantumMindQuantum is a general software library supporting the development of applications for quantum computation.Python057
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0137
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
27
11
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
473
3.51 K
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
220
88
暂无简介
Dart
721
174
Ascend Extension for PyTorch
Python
281
315
React Native鸿蒙化仓库
JavaScript
286
335
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
848
436
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.27 K
698
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
65
19