doxxie:发现您的mypy类型的库的公共API

时间:2024-04-17 19:34:00
【文件属性】:

文件名称:doxxie:发现您的mypy类型的库的公共API

文件大小:17KB

文件格式:ZIP

更新时间:2024-04-17 19:34:00

Python

多克西 doxxie是一个插件,可输出mypy类型的Python库的真实公共API。 可以将doxxie的输出检查到源代码控制中,并使用CI作业进行验证,以确保有意对公共API进行更改并记录在案。 doxxie从库的公共API开始,然后递归地添加属性和函数公开的任何类型,直到达到真正的公共API。 安装 从PyPI安装: pip install doxxie 用法 将doxxie添加到mypy配置的插件部分: [mypy] files = module/ plugins = doxxie 然后使用环境变量运行mypy ,以指定要包括的模块: $ DOXXIE_INCLUDES=module mypy --no-incremental 文件.public_api将与module的公共API一起输出。 注意: --no-incremental doxxie --no-incre


【文件预览】:
doxxie-main
----.gitignore(607B)
----setup.cfg(883B)
----README.md(2KB)
----.github()
--------workflows()
--------CODEOWNERS(0B)
----tests()
--------test_integration.py(5KB)
--------__init__.py(0B)
--------comprehensive()
----mypy.ini(48B)
----docs()
--------.gitignore(7B)
--------contributing.rst(863B)
--------conf.py(743B)
--------index.rst(112B)
--------release_notes.rst(33B)
--------requirements.txt(66B)
----LICENSE(1KB)
----doxxie()
--------__init__.py(49B)
--------doxxie.py(10KB)
--------py.typed(0B)
----riotfile.py(3KB)
----.public_api(551B)
----pyproject.toml(286B)
----setup.py(1KB)
----NOTICE(139B)
----.readthedocs.yml(213B)

网友评论