python 自动生成文档

python 自动生成文档
python 自动生成文档
一、配置文档
二、protobuf
三、代码
python 自动生成文档
一、配置文档
register.temeprate
# Datetime: ${DATETIME}

from proto import ${FILENAME}_pb2
from proto import xCmd_pb2


def register_${WRITEFILE}(pbmap):
    pbmap.register_command(
            xCmd_pb2.${PROTTOCMD},
            ${FILENAME}_pb2.${PARAMNAME}Param)  # ${NUMBER}

cmd.temperate
   pbmap.register_descriptor(
           xCmd_pb2.${PROTTOCMD},
           ${FILENAME}_pb2.${CMD})  # ${NUMBER}
</securityRealm>

二、protobuf
// scene -> client : puzzle item ntf
message PuzzleItemNtf
{
  optional Command cmd = 1 [ default = PUZZLE_PROTOCMD ];
  optional PuzzleParam param = 2 [ default = PUZZLEPARAM_ITEMNTF ];

  repeated PuzzleItem items = 3;
}

// client <-> scene : get reward
message ActivePuzzleCmd
{
  optional Command cmd = 1 [ default = PUZZLE_PROTOCMD ];
  optional PuzzleParam param = 2 [ default = PUZZLEPARAM_ACTIVIEPUZZLE ];

  optional uint32 actid = 3 [ default = 0 ];
  optional uint32 puzzleid = 4 [ default = 0 ];
}

三、代码
# Author: Allan
# Datetime: 2019-03-15
# 遍历 proto 目录下使用文件，自动在 pbmap 目录下生成相应文件

import re
import os
from datetime import datetime
from string import Template


class AutoCreateFile:

    def __init__(self):
        self.file_path = r'./proto/{}.proto'