本文探讨在使用 protoc 编译 Protocol Buffer 文件时，如何合规、可持续地嵌入版权信息，重点分析直接修改生成文件的风险、推荐的替代方案（如在 .proto 源文件中声明版权），并说明为何分发源 .proto 文件比分发生成代码更符合开源合规与工程实践。
本文探讨在使用 protoc 编译 protocol buffer 文件时，如何合规、可持续地嵌入版权信息，重点分析直接修改生成文件的风险、推荐的替代方案（如在 `.proto` 源文件中声明版权），并说明为何分发源 `.proto` 源文件比分发生成代码更符合开源合规与工程实践。
在构建基于 Protocol Buffer 的 Python 包时，一个常见但易被忽视的合规问题是：*如何为 `_pb2.py` 这类自动生成的代码添加版权信息？** 直观上，有人希望在生成文件顶部插入类似以下的声明：
# Copyright (c) 2024 charlestoncrabb. All Rights Reserved. # -*- coding: utf-8 -*- # Generated by the protocol buffer compiler. DO NOT EDIT! # source: foo.proto
⚠️ 但这是不推荐且存在风险的做法。
DO NOT EDIT! 并非形式化警告——它是 protoc 生成器的明确契约：任何手动修改都将被下次编译覆盖，且可能破坏构建可重现性、引入版本漂移，甚至违反某些许可证对“衍生作品”的定义（例如，若生成代码被视为原始 .proto 的衍生作品，则其版权归属应与源文件一致）。
✅ 正确做法：将版权声明置于 .proto 源文件头部
Protocol Buffer 编译器支持在 .proto 文件中使用普通 C++/Java 风格注释，这些注释虽不参与语义解析，但会被保留在生成代码的 source: 行之后（部分语言插件会保留注释结构）。更重要的是，分发 .proto 文件本身即构成完整的法律声明载体。示例 foo.proto：
// Copyright (c) 2024 charlestoncrabb. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0
//
// This file defines the Foo service interface and message types.
// Generated Python code inherits this copyright via provenance.
syntax = "proto3";
package example;
message Foo {
string name = 1;
}
当您将 foo.proto 作为 Python 包的一部分随 wheel 分发（例如放入 package/proto/ 目录），用户不仅能获得可执行代码，还能追溯到权威源码及完整版权信息。这符合 REUSE 规范、满足多数开源许可证（如 Apache-2.0、MIT）对“显著声明”的要求，也便于审计与合规检查。
? 为什么不应依赖生成文件嵌入版权？
- protoc 不提供原生参数（如 --copyright）注入头注释；
- 第三方插件（如 protoc-gen-py 自定义后端）虽可行，但增加构建复杂度与维护成本；
- 多语言一致性受损（Python 有 pb2.py，Go 有 _pb.go，C++ 有 pb.h/cc），需为每种语言单独适配；
- 若使用 Bazel、Poetry 或 Pants 等现代构建工具，其依赖解析与缓存机制可能因篡改生成文件而失效。
? 最佳实践总结：
- 始终在 .proto 文件顶部添加标准化版权与许可证注释（推荐 SPDX 格式）；
- 将 .proto 文件纳入 Python 包的 MANIFEST.in 或 pyproject.toml 的 include 规则中，确保随 wheel 一同发布；
- *文档中明确说明：`_pb2.py是构建产物，版权信息以.proto` 源文件为准**；
- 如需自动化验证，可用脚本检查所有 .proto 文件是否包含 Copyright 行（例如 grep -r "^// Copyright" proto/）。
这种模式不仅规避了技术脆弱性，更体现了对开源协作本质的理解：源代码（.proto）是事实真相，生成代码只是其可执行投影。版权属于源头，而非投影仪。
Python免费学习笔记（深入）：立即使用
在学习笔记中，你将探索 Python 的核心概念和高级技巧！
