为整个Python程序签名。提取项目的结构、框架、骨骼，以生成API文档或查找API中的破坏性更改。
项目描述
Griffe
为整个Python程序签名。提取项目的结构、框架、骨骼，以生成API文档或查找API中的破坏性更改。
Griffe，发音为“grif”（/ɡʁif/），是法语中的一个词，意为“爪子”，但也可以亲切地表示“签名”。 “On reconnaît bien là sa griffe。”
安装
使用pip
pip install griffe
使用pipx
python3.8 -m pip install --user pipx
pipx install griffe
用法
在命令行上，将包的名称传递给griffe dump命令
$ griffe dump httpx fastapi
{
"httpx": {
"name": "httpx",
...
},
"fastapi": {
"name": "fastapi",
...
}
}
有关更多示例，请参阅序列化章节。
或者为 griffe check 命令传递一个相对路径
$ griffe check mypackage --verbose
mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
Old: positional or keyword
New: keyword-only
对于 src 布局
$ griffe check --search src mypackage --verbose
src/mypackage/mymodule.py:10: MyClass.mymethod(myparam):
Parameter kind was changed:
Old: positional or keyword
New: keyword-only
还可以直接从 PyPI.org 检查包（或通过 PIP_INDEX_URL 配置的其他索引）。此功能仅对赞助商开放，并且需要使用带有 pypi 额外功能的 Griffe 进行安装。
pip install griffe[pypi]
命令语法如下
griffe check package_name -b project-name==2.0 -a project-name==1.0
请参阅检查章节以获取更多示例。
使用 Python 加载一个包
import griffe
fastapi = griffe.load("fastapi")
查找破坏性更改
import griffe
previous = griffe.load_git("mypackage", ref="0.2.0")
current = griffe.load("mypackage")
for breakage in griffe.find_breaking_changes(previous, current):
...
请参阅加载章节以获取更多示例。
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分发
griffe-1.3.2.tar.gz (382.5 kB 查看哈希值)
构建版本
griffe-1.3.2-py3-none-any.whl (127.0 kB 查看哈希值)
关闭
griffe-1.3.2.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 1ec50335aa507ed2445f2dd45a15c9fa3a45f52c9527e880571dfc61912fd60c |
|
| MD5 | 157b5faaf01c5f09078aae4265850ae5 |
|
| BLAKE2b-256 | c237813e72a3458fa3d996cf6bcc6a0caa919d16540f873366b0d328d51d684a |
关闭
griffe-1.3.2-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 2e34b5e46507d615915c8e6288bb1a2234bd35dee44d01e40a2bc2f25bd4d10c |
|
| MD5 | ed6dc7656b6205933556b8c636234ce0 |
|
| BLAKE2b-256 | 2a4939967633dd3c5f06fde83fec140228671a7344289ece0cfdd3cbe4798d69 |
