PackageInformation

类数据类源码

PackageInformation(
    user: str | None = None,
    package_name: str | None = None,
    sidebar: list[str | dict[str, Any]] | None = None,
    source_uris: dict[str, dict[str, str]] | None = None,
    source_versions: dict[str, str] | None = None
)

模块包的基本信息。所有的字段都是可选的，且可以从解析到的模块包数据中推断。

字段

字段	类型	必选	说明
user	str | None		仓库持有者的用户名。通常理解为 GitHub 的用户名。
package_name	str | None		在渲染文档时，所用的模块包的（同时也是项目的）名称。如果未指定，会自动推断该名称。
sidebar	list[str | dict[str, Any]] | None		渲染 API 文档时，所用的侧边栏。如果未指定，会自动推断侧边栏结构。
source_uris	dict[str, dict[str, str]] | None		源代码URI列表。用来提供指向源代码的链接。如果未指定，会自动推断URI。
source_versions	dict[str, str] | None		从版本名称指向版本识别码的映射。版本名称用作字典source_uris的键，而版本识别码用来定位版本对应的链接。如果未指定，会自动从source_uris中推断出该映射。

方法

as_vardict

v_1: dict[str, Any] = self.as_vardict()

将数据导出成（渲染模板用的）变量字典。

输出

参数	类型	说明
v_1	dict[str, Any]	在渲染资源的过程中，所用的变量字典。

---

set_pkg_info

v_1: Self = self.set_pkg_info(pkg: ModuleType)

在尚未指定package_name情况下设置该值。

输入

参数	类型	必选	说明
pkg	ModuleType		用来提供名称的模块包。

输出

参数	类型	说明
v_1	Self	该数据模型本身。

---

set_sidebar

v_1: Self = self.set_sidebar(pkg_renderer: PackageRenderer)

在尚未指定sidebar情况下设置该值。

输入

参数	类型	必选	说明
pkg_renderer	PackageRenderer		用来提供侧边栏的模块包。

输出

参数	类型	说明
v_1	Self	该数据模型本身。

---

set_source_uris

v_1: Self = self.set_source_uris(pkg_renderer: PackageRenderer, version: str | None = None)

在尚未指定source_uris情况下设置该值。

输入

参数	类型	必选	说明
pkg_renderer	PackageRenderer		用来提供 URI 的模块包。
version	str | None		模块包提供的版本文字。

输出

参数	类型	说明
v_1	Self	该数据模型本身。

---

set_source_versions

v_1: Self = self.set_source_versions(versions: Mapping[str, str] | None = None)

在尚未指定source_versions情况下设置该值。

输入

参数	类型	必选	说明
versions	Mapping[str, str] | None		从版本名称指向版本识别码的映射。版本名称用作字典source_uris的键，而版本识别码用来定位版本对应的链接。如果未指定，会自动从source_uris中推断出该映射。

输出

参数	类型	说明
v_1	Self	该数据模型本身。