安装¶

先安装 Linux 工具，再将 p4net 安装到 Python 虚拟环境中。p4net 的 Python 包不包含 P4 编译器和 BMv2。

系统要求¶

下文通过 sudo 执行网络操作，安装 Python 包时使用普通用户。

在 Ubuntu 上，先安装 Python 环境工具和 Linux 网络工具：

sudo apt update
sudo apt install python3-venv python3-pip iproute2 iputils-ping procps git

然后按照上游文档安装 P4 编译器和 BMv2：

p4c：参照软件包安装说明，也可以从源码构建。安装结果需要包含 BMv2 后端，以及 core.p4 和 v1model.p4 头文件。
BMv2：参照 simple_switch_grpc 构建说明。该目标需要支持 Protobuf/gRPC 的 PI，构建 BMv2 时需启用 --with-pi。

p4net 使用以下命令：

确认这些命令均可通过 PATH 找到：

p4c --version
simple_switch_grpc --version
ip -V
tc -V
ping -V
sysctl --version

以下两项功能需要额外工具：

将拓扑渲染为 SVG、PNG 或 PDF 需要 Graphviz，可通过 sudo apt install graphviz 安装。仅导出 DOT 文件不需要 Graphviz。
读取、写入或重置寄存器需要 simple_switch_CLI 和 BMv2 的 Thrift 服务。如需操作寄存器，构建 BMv2 时保留 Thrift 支持。

创建并激活虚拟环境，然后安装 p4net：

python3 -m venv .venv
. .venv/bin/activate
python -m pip install p4net

pip 会自动安装 Python 依赖。后续命令均在已激活的环境中执行。

开发项目时，克隆仓库并以可编辑模式安装，同时安装测试、代码规范和类型检查工具：

git clone https://github.com/zhh2001/p4net.git
cd p4net
python3 -m venv .venv
. .venv/bin/activate
python -m pip install -e '.[dev]'

文档通过 CairoSVG 生成分享图片。在 Ubuntu 上，先用 sudo apt install libcairo2 安装系统 Cairo 库，再在仓库根目录安装文档工具：

python -m pip install -e '.[dev,docs]'

检查安装版本、命令行入口和 Python 依赖：

python -c "import p4net; print(p4net.__version__)"
p4net --help
python -m pip check

第一条命令会输出实际安装的版本号。接着按快速上手创建 quickstart.py 和 P4 程序，再启动网络：

sudo "$(command -v p4net)" quickstart.py

command -v p4net 会选取当前环境中的命令行入口。如果外部工具安装在自定义目录中，通过 sudo 运行时需将该目录加入 PATH：

sudo env "PATH=$PATH" "$(command -v p4net)" quickstart.py

从源码安装后，在仓库根目录运行测试：

python -m pytest

该命令只运行默认测试集，不包含标记为需要 root、p4c 或 BMv2 的测试。安装外部工具后，通过以下命令启用这三组测试：

sudo env "PATH=$PATH" "$(command -v python)" -m pytest \
  --run-integration --run-p4c --run-bmv2

安装文档工具后，通过以下命令构建站点：

python -m mkdocs build --strict

安装或启动时遇到问题，可查阅故障排查。