xref: /aosp_15_r20/external/grpc-grpc/src/compiler/python_generator.h (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1 /*
2  *
3  * Copyright 2015 gRPC authors.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  *     http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  */
18 
19 #ifndef GRPC_INTERNAL_COMPILER_PYTHON_GENERATOR_H
20 #define GRPC_INTERNAL_COMPILER_PYTHON_GENERATOR_H
21 
22 #include <utility>
23 #include <vector>
24 
25 #include "src/compiler/config.h"
26 #include "src/compiler/schema_interface.h"
27 
28 namespace grpc_python_generator {
29 
30 // Data pertaining to configuration of the generator with respect to anything
31 // that may be used internally at Google.
32 struct GeneratorConfiguration {
33   GeneratorConfiguration();
34   GeneratorConfiguration(std::string version);
35   std::string grpc_package_root;
36   // TODO(https://github.com/grpc/grpc/issues/8622): Drop this.
37   std::string beta_package_root;
38   // TODO(https://github.com/protocolbuffers/protobuf/issues/888): Drop this.
39   std::string import_prefix;
40   std::string grpc_tools_version;
41   std::vector<std::string> prefixes_to_filter;
42 };
43 
44 class PythonGrpcGenerator : public grpc::protobuf::compiler::CodeGenerator {
45  public:
46   PythonGrpcGenerator(const GeneratorConfiguration& config);
47   ~PythonGrpcGenerator();
48 
GetSupportedFeatures()49   uint64_t GetSupportedFeatures() const override {
50     return FEATURE_PROTO3_OPTIONAL
51 #ifdef GRPC_PROTOBUF_EDITION_SUPPORT
52            | FEATURE_SUPPORTS_EDITIONS
53 #endif
54         ;
55   }
56 
57 #ifdef GRPC_PROTOBUF_EDITION_SUPPORT
GetMinimumEdition()58   grpc::protobuf::Edition GetMinimumEdition() const override {
59     return grpc::protobuf::Edition::EDITION_PROTO2;
60   }
GetMaximumEdition()61   grpc::protobuf::Edition GetMaximumEdition() const override {
62     return grpc::protobuf::Edition::EDITION_2023;
63   }
64 #endif
65 
66   bool Generate(const grpc::protobuf::FileDescriptor* file,
67                 const std::string& parameter,
68                 grpc::protobuf::compiler::GeneratorContext* context,
69                 std::string* error) const override;
70 
71  private:
72   GeneratorConfiguration config_;
73 };
74 
75 }  // namespace grpc_python_generator
76 
77 #endif  // GRPC_INTERNAL_COMPILER_PYTHON_GENERATOR_H
78