首页
/ LLM-Guard项目中BanSubstrings扫描器的参数设计优化

LLM-Guard项目中BanSubstrings扫描器的参数设计优化

2025-07-10 14:34:15作者:蔡丛锟

在LLM-Guard项目的BanSubstrings输入扫描器模块中,开发者对参数设计进行了重要优化,这些改进不仅提升了代码的健壮性,也增强了API的易用性。

参数默认值的重新设计

原实现中substrings参数默认为None的设计存在几个问题:首先,这使得类型检查变得复杂,需要额外的None值验证;其次,这种设计违背了Python的"显式优于隐式"原则。优化后的版本将substrings改为必填参数,这样可以在编译阶段就捕获错误,而不是在运行时通过assert语句检查。

这种改变带来了多重好处:

  1. 移除了运行时断言检查,避免了Python优化模式(-O)下断言被移除的风险
  2. 使API设计更加直观,用户必须显式提供要禁止的子字符串列表
  3. 减少了维护负担,因为不再需要处理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项目的代码质量:

  1. 更强的类型安全性
  2. 更清晰的API设计
  3. 更少的运行时错误可能性
  4. 更好的开发者体验(IDE支持更完善)

这些变化体现了Python最佳实践在安全关键项目中的应用,展示了如何通过精心设计的API来构建更可靠的系统。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
144
1.93 K
kernelkernel
deepin linux kernel
C
22
6
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
274
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
930
553
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
423
392
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0
openHiTLS-examplesopenHiTLS-examples
本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
64
511