Merge pull request #69 from so1n/0.3.0-pre

0.3.0 pre

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.0.0
+    rev: v1.8.0
     hooks:
       - id: mypy
         exclude: "^example/example_proto|^example/proto|^protobuf_to_pydantic/protos|test_p2p_validate.py$|test_pgv_validate.py$|protobuf_to_pydantic/contrib/proto_parser.py|example/validate_example/demo_gen_code_by_pgv.py|example/p2p_validate_example/demo_gen_code_by_p2p.py|protobuf_to_pydantic/_pydantic_adapter.py|protobuf_to_pydantic/customer_validator/__init__.py|protobuf_to_pydantic/customer_validator/v1.py|protobuf_to_pydantic/customer_validator/v2.py|protobuf_to_pydantic/customer_con_type/__init__.py|protobuf_to_pydantic/customer_con_type/v1.py|protobuf_to_pydantic/customer_con_type/v2.py|protobuf_to_pydantic/grpc_types.py"

buf-plugin/README.md

@@ -145,6 +145,8 @@ Regardless of which method is used to generate `Pydantic` code, the final projec
 └── pyproject.toml
 ```
 ### 1.4.Generating Pydantic Code with Remote Plugins
+> Note: Since the BUF plugin created by the developer cannot be used publicly, the remote plug-in cannot be used normally(See: [issue](https://github.com/bufbuild/plugins/issues/589#issuecomment-1799085322))。If necessary, please refer to the custom plugins in the next section to create your own plugins。
+
 In addition to executing local plugin to generate `Pydantic` code, can also use remote plugin.
 
 First, need to change the `buf.gen.yaml` file to the following content:

buf-plugin/README_ZH.md

@@ -141,6 +141,8 @@ plugins:
 └── pyproject.toml
 ```
 ### 1.4.使用远程插件生成Pydantic代码
+> Note: 由于开发者自己创建的buf插件是无法公开使用的，所以远程插件无法正常使用(具体见：[issue](https://github.com/bufbuild/plugins/issues/589#issuecomment-1799085322))。如有需要，请参考下一节的自定义插件自己创建插件。
+
 除了执行本地插件生成Pydantic代码外，还可以使用远程插件，首先需要更改`buf.gen.yaml`文件为如下内容:
 ```yaml
 version: v1
@@ -166,7 +168,7 @@ plugins:
 
 
 
-## 2.Custom Plugins
+## 2.自定义插件
 > Note: 请确保你已经阅读了 [buf custom plugins dev doc](https://buf.build/docs/bsr/remote-plugins/custom-plugins)
 
 `protobuf-to-pydantic`的标准`buf-plugin`可以满足大多数功能。如果您有自定义需求，您应该创建属于自己的自定义插件。

example/example_proto/demo/demo.proto

@@ -125,3 +125,19 @@ message Invoice3 {
   int32 quantity = 3;
   repeated InvoiceItem2 items = 4;
 }
+
+// Test Message references
+// from: https://github.com/so1n/protobuf_to_pydantic/issues/64
+message RootMessage {
+  string field1 = 1;
+  AnOtherMessage field2 = 2;
+}
+
+message AnOtherMessage {
+  string field1 = 1;
+  SubMessage field2 = 2;
+
+  message SubMessage {
+    string text = 1;
+  }
+}

example/example_proto/demo/single_config.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+package single_config;
+
+
+// user info
+message UserMessage {
+  // aha: {"required": true, "example": "10086", "title": "UID", "description": "user union id"}
+  string uid=1;
+  // aha: {"example": 18, "title": "use age", "ge": 0}
+  int32 age=2;
+  // aha: {"ge": 0, "le": 2.5}
+  float height=3;
+  bool is_adult=7;
+  // aha: {"description": "user name"}
+  // aha: {"default": "", "min_length": 1, "max_length": "10", "example": "so1n"}
+  string user_name=8;
+}

example/gen_p2p_code.py

@@ -9,7 +9,7 @@
 from pydantic import confloat, conint
 from pydantic.fields import FieldInfo
 
-from protobuf_to_pydantic import _pydantic_adapter, desc_template, msg_to_pydantic_model, pydantic_model_to_py_file
+from protobuf_to_pydantic import _pydantic_adapter, msg_to_pydantic_model, pydantic_model_to_py_file, template
 
 # use pydantic v1 method, pydantic will print warning, ignore!~
 warnings.filterwarnings("ignore")
@@ -42,7 +42,7 @@ def customer_any() -> Any:
 now_path: pathlib.Path = pathlib.Path(__file__).absolute()
 
 
-class CustomDescTemplate(desc_template.DescTemplate):
+class CustomCommentTemplate(template.Template):
     def template_timestamp(self, length_str: str) -> int:
         timestamp: float = 1600000000
         if length_str == "10":
@@ -65,7 +65,7 @@ def gen_code() -> None:
                     "conint": conint,
                     "customer_any": customer_any,
                 },
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],

example/gen_text_comment_code.py

@@ -9,10 +9,10 @@
 from google.protobuf.message import Message
 
 from protobuf_to_pydantic import _pydantic_adapter, msg_to_pydantic_model, pydantic_model_to_py_file
-from protobuf_to_pydantic.desc_template import DescTemplate
+from protobuf_to_pydantic.template import Template
 
 
-class CustomDescTemplate(DescTemplate):
+class CustomCommentTemplate(Template):
     def template_timestamp(self, length_str: str) -> int:
         timestamp: float = 1600000000
         if length_str == "10":
@@ -59,7 +59,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=module,
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -72,7 +72,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=str(now_path.parent.parent),
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -85,7 +85,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=module,
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -97,7 +97,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=str(now_path.parent.parent),
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],

example/p2p_validate_by_comment_gen_code.py

@@ -12,10 +12,10 @@
 from pydantic.fields import FieldInfo
 
 from protobuf_to_pydantic import _pydantic_adapter, msg_to_pydantic_model, pydantic_model_to_py_file
-from protobuf_to_pydantic.desc_template import DescTemplate
+from protobuf_to_pydantic.template import Template
 
 
-class CustomDescTemplate(DescTemplate):
+class CustomCommentTemplate(Template):
     def template_timestamp(self, length_str: str) -> int:
         timestamp: float = 1600000000
         if length_str == "10":
@@ -77,7 +77,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=module,
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -92,7 +92,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=str(now_path.parent.parent),
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -105,7 +105,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=module,
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],
@@ -119,7 +119,7 @@ def gen_code() -> None:
                 model,
                 parse_msg_desc_method=str(now_path.parent.parent),
                 local_dict=local_dict,
-                desc_template=CustomDescTemplate,
+                template=CustomCommentTemplate,
             )
             for model in message_class_list
         ],

example/plugin_config.py

@@ -1,13 +1,16 @@
 import logging
 import time
-from typing import List, Type
+from typing import Dict, List, Type
 from uuid import uuid4
 
 from google.protobuf.any_pb2 import Any  # type: ignore
 from pydantic import confloat, conint
 from pydantic.fields import FieldInfo
 
-from protobuf_to_pydantic.desc_template import DescTemplate
+from protobuf_to_pydantic.plugin.config import SubConfigModel
+from protobuf_to_pydantic.template import Template
+
+from . import single_config_pkg_plugin_config
 
 logging.basicConfig(format="[%(asctime)s %(levelname)s] %(message)s", datefmt="%y-%m-%d %H:%M:%S", level=logging.INFO)
 
@@ -20,7 +23,7 @@ def customer_any() -> Any:
     return Any  # type: ignore
 
 
-class CustomDescTemplate(DescTemplate):
+class CustomCommentTemplate(Template):
     def template_timestamp(self, length_str: str) -> int:
         timestamp: float = 1600000000
         if length_str == "10":
@@ -44,5 +47,6 @@ def exp_time() -> float:
     "uuid4": uuid4,
 }
 comment_prefix = "p2p"
-desc_template: Type[DescTemplate] = CustomDescTemplate
+template: Type[Template] = CustomCommentTemplate
 ignore_pkg_list: List[str] = ["validate", "p2p_validate"]
+pkg_config: Dict[str, SubConfigModel] = {"single_config": SubConfigModel(module=single_config_pkg_plugin_config)}

example/proto_3_20_pydanticv1/demo_gen_code.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -17,6 +17,14 @@ class AfterReferMessage(BaseModel):
     age: int = Field(default=0)
 
 
+class AnOtherMessage(BaseModel):
+    class SubMessage(BaseModel):
+        text: str = Field(default="")
+
+    field1: str = Field(default="")
+    field2: SubMessage = Field()
+
+
 class EmptyMessage(BaseModel):
     pass
 
@@ -130,3 +138,8 @@ class Config:
     metadata: typing.Dict[str, typing.Any] = Field(default_factory=dict)
     double_value: DoubleValue = Field(default_factory=DoubleValue)
     field_mask: typing.Optional[FieldMask] = Field(default_factory=FieldMask)
+
+
+class RootMessage(BaseModel):
+    field1: str = Field(default="")
+    field2: AnOtherMessage = Field()

example/proto_3_20_pydanticv1/demo_gen_code_by_p2p.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -42,7 +42,7 @@
     timestamp_lt_validator,
     timestamp_within_validator,
 )
-from protobuf_to_pydantic.get_desc.from_pb_option.types import HostNameStr, UriRefStr
+from protobuf_to_pydantic.field_info_rule.protobuf_option_to_field_info.types import HostNameStr, UriRefStr
 from protobuf_to_pydantic.util import Timedelta
 from pydantic import BaseModel, Field, root_validator, validator
 from pydantic.networks import AnyUrl, EmailStr, IPvAnyAddress

example/proto_3_20_pydanticv1/demo_gen_code_by_pgv.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -39,7 +39,7 @@
     timestamp_lt_validator,
     timestamp_within_validator,
 )
-from protobuf_to_pydantic.get_desc.from_pb_option.types import HostNameStr, UriRefStr
+from protobuf_to_pydantic.field_info_rule.protobuf_option_to_field_info.types import HostNameStr, UriRefStr
 from protobuf_to_pydantic.util import Timedelta
 from pydantic import BaseModel, Field, root_validator, validator
 from pydantic.networks import AnyUrl, EmailStr, IPvAnyAddress

example/proto_3_20_pydanticv1/demo_gen_code_by_text_comment_protobuf_field.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -20,6 +20,14 @@ class AfterReferMessage(BaseModel):
     age: int = Field(default=0, title="use age", ge=0.0, example=18)
 
 
+class AnOtherMessage(BaseModel):
+    class SubMessage(BaseModel):
+        text: str = Field(default="")
+
+    field1: str = Field(default="")
+    field2: SubMessage = Field()
+
+
 class EmptyMessage(BaseModel):
     pass
 
@@ -132,3 +140,8 @@ class Config:
     metadata: typing.Dict[str, typing.Any] = Field(default_factory=dict)
     double_value: DoubleValue = Field(default_factory=DoubleValue)
     field_mask: typing.Optional[FieldMask] = Field(default_factory=FieldMask)
+
+
+class RootMessage(BaseModel):
+    field1: str = Field(default="")
+    field2: AnOtherMessage = Field()

example/proto_3_20_pydanticv1/demo_gen_code_by_text_comment_pyi.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -20,6 +20,14 @@ class AfterReferMessage(BaseModel):
     age: int = Field(default=0, title="use age", ge=0.0, example=18)
 
 
+class AnOtherMessage(BaseModel):
+    class SubMessage(BaseModel):
+        text: str = Field(default="")
+
+    field1: str = Field(default="")
+    field2: SubMessage = Field()
+
+
 class EmptyMessage(BaseModel):
     pass
 
@@ -132,3 +140,8 @@ class Config:
     metadata: typing.Dict[str, typing.Any] = Field(default_factory=dict)
     double_value: DoubleValue = Field(default_factory=DoubleValue)
     field_mask: typing.Optional[FieldMask] = Field(default_factory=FieldMask)
+
+
+class RootMessage(BaseModel):
+    field1: str = Field(default="")
+    field2: AnOtherMessage = Field()

example/proto_3_20_pydanticv1/example/example_proto/common/single_p2p.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 from enum import IntEnum

example/proto_3_20_pydanticv1/example/example_proto/demo/demo_p2p.py

@@ -1,5 +1,5 @@
 # This is an automatically generated file, please do not change
-# gen by protobuf_to_pydantic[v0.2.6](https://github.com/so1n/protobuf_to_pydantic)
+# gen by protobuf_to_pydantic[v0.2.7](https://github.com/so1n/protobuf_to_pydantic)
 # Protobuf Version: 3.20.3
 # Pydantic Version: 1.10.7
 import typing
@@ -142,3 +142,21 @@ class InvoiceItem2(BaseModel):
     quantity: int = Field(default=0)
     items: typing.List["InvoiceItem2"] = Field(default_factory=list)
     invoice: Invoice3 = Field()
+
+
+class AnOtherMessage(BaseModel):
+    class SubMessage(BaseModel):
+        text: str = Field(default="")
+
+    field1: str = Field(default="")
+    field2: SubMessage = Field()
+
+
+class RootMessage(BaseModel):
+    """
+        Test Message references
+    from: https://github.com/so1n/protobuf_to_pydantic/issues/64
+    """
+
+    field1: str = Field(default="")
+    field2: AnOtherMessage = Field()