解析aws/jsii项目中Python包命名规范问题

问题背景

在aws/jsii项目中，当从TypeScript项目生成Python包时，存在一个关于包命名规范的重要问题。具体表现为：当TypeScript项目使用@user/package-name格式命名时，生成的Python包会保留原始名称中的连字符(-)，导致不符合Python的包命名规范。

技术细节分析

Python包命名有以下重要规范：

1. 包名只能包含字母、数字和下划线
2. 不能以数字开头
3. 不能包含连字符(-)等特殊字符

当前jsii的实现直接将@mbonig/state-machine转换为mbonig.state-machine，这会导致两个问题：

1. 包名中包含非法字符-
2. 包结构被不必要地嵌套

影响范围

这种命名不规范会导致：

1. 无法使用标准的Python import语句导入包
2. 需要使用importlib.import_module这样的变通方法
3. 可能影响IDE的自动补全和代码分析功能
4. 不符合Python社区的最佳实践

解决方案建议

正确的做法应该是：

1. 将@user/package-name转换为user_package_name格式
2. 保持包结构的扁平化
3. 在转换过程中处理所有特殊字符

实现考量

在实现这种转换时需要考虑：

1. 保持名称的唯一性和可读性
2. 确保向后兼容性
3. 处理各种可能的命名组合
4. 在文档中明确说明命名转换规则

总结

包命名规范是跨语言互操作中的重要环节。jsii作为连接TypeScript和Python的桥梁，应该确保生成的Python包完全符合Python的命名规范。这不仅关系到功能的可用性，也影响着开发者的使用体验和项目的长期维护性。