diff --git a/examples/python/easy_start_demo/LICENSE b/examples/python/easy_start_demo/LICENSE new file mode 100644 index 00000000000..a612ad9813b --- /dev/null +++ b/examples/python/easy_start_demo/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/examples/python/easy_start_demo/PyClient.py b/examples/python/easy_start_demo/PyClient.py new file mode 100644 index 00000000000..257c817e06f --- /dev/null +++ b/examples/python/easy_start_demo/PyClient.py @@ -0,0 +1,93 @@ +""" +Author: Zhongying Wang +Email: kerbalwzy@gmail.com +License: MPL2 +DateTime: 2019-08-13T23:30:00Z +PythonVersion: Python3.6.3 +""" +import grpc +import time +from customGrpcPackages import demo_pb2, demo_pb2_grpc + +# Constants +PyGrpcServerAddress = "127.0.0.1:23334" +ClientId = 1 + + +# 简单模式 +# Unary +def simple_method(stub): + print("--------------Call SimpleMethod Begin--------------") + req = demo_pb2.Request(Cid=ClientId, ReqMsg="called by Python client") + resp = stub.SimpleMethod(req) + print(f"resp from server({resp.Sid}), the message={resp.RespMsg}") + print("--------------Call SimpleMethod Over---------------") + + +# 客户端流模式（在一次调用中, 客户端可以多次向服务器传输数据, 但是服务器只能返回一次响应） +# Client Streaming (In a single call, the client can transfer data to the server several times, +# but the server can only return a response once.) +def c_stream_method(stub): + print("--------------Call CStreamMethod Begin--------------") + + # 创建一个生成器 + # create a generator + def req_msgs(): + for i in range(5): + req = demo_pb2.Request(Cid=ClientId, ReqMsg=f"called by Python client, message: {i}") + yield req + + resp = stub.CStreamMethod(req_msgs()) + print(f"resp from server({resp.Sid}), the message={resp.RespMsg}") + print("--------------Call CStreamMethod Over---------------") + + +# 服务端流模式（在一次调用中, 客户端只能一次向服务器传输数据, 但是服务器可以多次返回响应） +# Server Streaming (In a single call, the client can only transmit data to the server at one time, +# but the server can return the response many times.) +def s_stream_method(stub): + print("--------------Call SStreamMethod Begin--------------") + req = demo_pb2.Request(Cid=ClientId, ReqMsg="called by Python client") + resp_s = stub.SStreamMethod(req) + for resp in resp_s: + print(f"recv from server({resp.Sid}, message={resp.RespMsg})") + + print("--------------Call SStreamMethod Over---------------") + + +# 双向流模式 (在一次调用中, 客户端和服务器都可以向对方多次收发数据) +# Bidirectional Streaming (In a single call, both client and server can send and receive data +# to each other multiple times.) +def twf_method(stub): + print("--------------Call TWFMethod Begin---------------") + + # 创建一个生成器 + # create a generator + def req_msgs(): + for i in range(5): + req = demo_pb2.Request(Cid=ClientId, ReqMsg=f"called by Python client, message: {i}") + yield req + time.sleep(1) + + resp_s = stub.TWFMethod(req_msgs()) + for resp in resp_s: + print(f"recv from server({resp.Sid}, message={resp.RespMsg})") + + print("--------------Call TWFMethod Over---------------") + + +def main(): + with grpc.insecure_channel(PyGrpcServerAddress) as channel: + stub = demo_pb2_grpc.GRPCDemoStub(channel) + + simple_method(stub) + + c_stream_method(stub) + + s_stream_method(stub) + + twf_method(stub) + + +if __name__ == '__main__': + main() diff --git a/examples/python/easy_start_demo/PyServer.py b/examples/python/easy_start_demo/PyServer.py new file mode 100644 index 00000000000..a814205d0d1 --- /dev/null +++ b/examples/python/easy_start_demo/PyServer.py @@ -0,0 +1,87 @@ +""" +Author: Zhongying Wang +Email: kerbalwzy@gmail.com +License: MPL2 +DateTime: 2019-08-13T23:30:00Z +PythonVersion: Python3.6.3 +""" +import time + +import grpc +from threading import Thread +from concurrent import futures +from customGrpcPackages import demo_pb2, demo_pb2_grpc + +# Constants +ServerAddress = '127.0.0.1:23334' +ServerId = 1 + + +class DemoServer(demo_pb2_grpc.GRPCDemoServicer): + + # 简单模式 + # Unary + def SimpleMethod(self, request, context): + print(f"SimpleMethod called by client({request.Cid}) the message: {request.ReqMsg}") + resp = demo_pb2.Response(Sid=ServerId, RespMsg="Python server SimpleMethod Ok!!!!") + return resp + + # 客户端流模式（在一次调用中, 客户端可以多次向服务器传输数据, 但是服务器只能返回一次响应） + # Client Streaming (In a single call, the client can transfer data to the server several times, + # but the server can only return a response once.) + def CStreamMethod(self, request_iterator, context): + print("CStreamMethod called by client...") + for req in request_iterator: + print(f"recv from client({req.Cid}), message={req.ReqMsg}") + resp = demo_pb2.Response(Sid=ServerId, RespMsg="Python server CStreamMethod ok") + return resp + + # 服务端流模式（在一次调用中, 客户端只能一次向服务器传输数据, 但是服务器可以多次返回响应） + # Server Streaming (In a single call, the client can only transmit data to the server at one time, + # but the server can return the response many times.) + def SStreamMethod(self, request, context): + print(f"SStreamMethod called by client({request.Cid}), message={request.ReqMsg}") + + # 创建一个生成器 + def resp_msgs(): + for i in range(5): + resp = demo_pb2.Response(Sid=ServerId, RespMsg=f"send by Python server, message={i}") + yield resp + + return resp_msgs() + + # 双向流模式 (在一次调用中, 客户端和服务器都可以向对方多次收发数据) + # Bidirectional Streaming (In a single call, both client and server can send and receive data + # to each other multiple times.) + def TWFMethod(self, request_iterator, context): + # 开启一个子线程去接收数据 + # Open a sub thread to receive data + def parse_req(): + for req in request_iterator: + print(f"recv from client{req.Cid}, message={req.ReqMsg}") + + t = Thread(target=parse_req) + t.start() + + for i in range(5): + yield demo_pb2.Response(Sid=ServerId, RespMsg=f"send by Python server, message={i}") + + t.join() + + +def main(): + server = grpc.server(futures.ThreadPoolExecutor(max_workers=10)) + + demo_pb2_grpc.add_GRPCDemoServicer_to_server(DemoServer(), server) + + server.add_insecure_port(ServerAddress) + print("------------------start Python GRPC server") + server.start() + + # In python3, `server` have no attribute `wait_for_termination` + while 1: + time.sleep(10) + + +if __name__ == '__main__': + main() diff --git a/examples/python/easy_start_demo/README.md b/examples/python/easy_start_demo/README.md new file mode 100644 index 00000000000..2bb9059bc90 --- /dev/null +++ b/examples/python/easy_start_demo/README.md @@ -0,0 +1,37 @@ +## easyDemo for using GRPC in Python +###主要是介绍了在Python中使用GRPC时, 进行数据传输的四种方式。 +###This paper mainly introduces four ways of data transmission when GRPC is used in Python. + +- ####简单模式 (Unary) +```text +没啥好说的,跟调普通方法没差 +There's nothing to say. It's no different from the usual way. +``` +- ####客户端流模式 (Client Streaming) +```text +在一次调用中, 客户端可以多次向服务器传输数据, 但是服务器只能返回一次响应. +In a single call, the client can transfer data to the server several times, +but the server can only return a response once. +``` +- ####服务端流模式 (Server Streaming) +```text +在一次调用中, 客户端只能一次向服务器传输数据, 但是服务器可以多次返回响应 +In a single call, the client can only transmit data to the server at one time, +but the server can return the response many times. +``` +- ####双向流模式 (Bidirectional Streaming) +```text +在一次调用中, 客户端和服务器都可以向对方多次收发数据 +In a single call, both client and server can send and receive data +to each other multiple times. +``` +---- +Author: Zhongying Wang + +Email: kerbalwzy@gmail.com + +License: MPL2 + +DateTime: 2019-08-13T23:30:00Z + +PythonVersion: Python3.6.3 \ No newline at end of file diff --git a/examples/python/easy_start_demo/customGrpcPackages/demo_pb2.py b/examples/python/easy_start_demo/customGrpcPackages/demo_pb2.py new file mode 100644 index 00000000000..4df1dad0b43 --- /dev/null +++ b/examples/python/easy_start_demo/customGrpcPackages/demo_pb2.py @@ -0,0 +1,174 @@ +# -*- coding: utf-8 -*- +# Generated by the protocol buffer compiler. DO NOT EDIT! +# source: demo.proto + +import sys +_b=sys.version_info[0]<3 and (lambda x:x) or (lambda x:x.encode('latin1')) +from google.protobuf import descriptor as _descriptor +from google.protobuf import message as _message +from google.protobuf import reflection as _reflection +from google.protobuf import symbol_database as _symbol_database +# @@protoc_insertion_point(imports) + +_sym_db = _symbol_database.Default() + + + + +DESCRIPTOR = _descriptor.FileDescriptor( + name='demo.proto', + package='demo', + syntax='proto3', + serialized_options=None, + serialized_pb=_b('\n\ndemo.proto\x12\x04\x64\x65mo\"&\n\x07Request\x12\x0b\n\x03\x43id\x18\x01 \x01(\x03\x12\x0e\n\x06ReqMsg\x18\x02 \x01(\t\"(\n\x08Response\x12\x0b\n\x03Sid\x18\x01 \x01(\x03\x12\x0f\n\x07RespMsg\x18\x02 \x01(\t2\xcd\x01\n\x08GRPCDemo\x12-\n\x0cSimpleMethod\x12\r.demo.Request\x1a\x0e.demo.Response\x12\x30\n\rCStreamMethod\x12\r.demo.Request\x1a\x0e.demo.Response(\x01\x12\x30\n\rSStreamMethod\x12\r.demo.Request\x1a\x0e.demo.Response0\x01\x12.\n\tTWFMethod\x12\r.demo.Request\x1a\x0e.demo.Response(\x01\x30\x01\x62\x06proto3') +) + + + + +_REQUEST = _descriptor.Descriptor( + name='Request', + full_name='demo.Request', + filename=None, + file=DESCRIPTOR, + containing_type=None, + fields=[ + _descriptor.FieldDescriptor( + name='Cid', full_name='demo.Request.Cid', index=0, + number=1, type=3, cpp_type=2, label=1, + has_default_value=False, default_value=0, + message_type=None, enum_type=None, containing_type=None, + is_extension=False, extension_scope=None, + serialized_options=None, file=DESCRIPTOR), + _descriptor.FieldDescriptor( + name='ReqMsg', full_name='demo.Request.ReqMsg', index=1, + number=2, type=9, cpp_type=9, label=1, + has_default_value=False, default_value=_b("").decode('utf-8'), + message_type=None, enum_type=None, containing_type=None, + is_extension=False, extension_scope=None, + serialized_options=None, file=DESCRIPTOR), + ], + extensions=[ + ], + nested_types=[], + enum_types=[ + ], + serialized_options=None, + is_extendable=False, + syntax='proto3', + extension_ranges=[], + oneofs=[ + ], + serialized_start=20, + serialized_end=58, +) + + +_RESPONSE = _descriptor.Descriptor( + name='Response', + full_name='demo.Response', + filename=None, + file=DESCRIPTOR, + containing_type=None, + fields=[ + _descriptor.FieldDescriptor( + name='Sid', full_name='demo.Response.Sid', index=0, + number=1, type=3, cpp_type=2, label=1, + has_default_value=False, default_value=0, + message_type=None, enum_type=None, containing_type=None, + is_extension=False, extension_scope=None, + serialized_options=None, file=DESCRIPTOR), + _descriptor.FieldDescriptor( + name='RespMsg', full_name='demo.Response.RespMsg', index=1, + number=2, type=9, cpp_type=9, label=1, + has_default_value=False, default_value=_b("").decode('utf-8'), + message_type=None, enum_type=None, containing_type=None, + is_extension=False, extension_scope=None, + serialized_options=None, file=DESCRIPTOR), + ], + extensions=[ + ], + nested_types=[], + enum_types=[ + ], + serialized_options=None, + is_extendable=False, + syntax='proto3', + extension_ranges=[], + oneofs=[ + ], + serialized_start=60, + serialized_end=100, +) + +DESCRIPTOR.message_types_by_name['Request'] = _REQUEST +DESCRIPTOR.message_types_by_name['Response'] = _RESPONSE +_sym_db.RegisterFileDescriptor(DESCRIPTOR) + +Request = _reflection.GeneratedProtocolMessageType('Request', (_message.Message,), { + 'DESCRIPTOR' : _REQUEST, + '__module__' : 'demo_pb2' + # @@protoc_insertion_point(class_scope:demo.Request) + }) +_sym_db.RegisterMessage(Request) + +Response = _reflection.GeneratedProtocolMessageType('Response', (_message.Message,), { + 'DESCRIPTOR' : _RESPONSE, + '__module__' : 'demo_pb2' + # @@protoc_insertion_point(class_scope:demo.Response) + }) +_sym_db.RegisterMessage(Response) + + + +_GRPCDEMO = _descriptor.ServiceDescriptor( + name='GRPCDemo', + full_name='demo.GRPCDemo', + file=DESCRIPTOR, + index=0, + serialized_options=None, + serialized_start=103, + serialized_end=308, + methods=[ + _descriptor.MethodDescriptor( + name='SimpleMethod', + full_name='demo.GRPCDemo.SimpleMethod', + index=0, + containing_service=None, + input_type=_REQUEST, + output_type=_RESPONSE, + serialized_options=None, + ), + _descriptor.MethodDescriptor( + name='CStreamMethod', + full_name='demo.GRPCDemo.CStreamMethod', + index=1, + containing_service=None, + input_type=_REQUEST, + output_type=_RESPONSE, + serialized_options=None, + ), + _descriptor.MethodDescriptor( + name='SStreamMethod', + full_name='demo.GRPCDemo.SStreamMethod', + index=2, + containing_service=None, + input_type=_REQUEST, + output_type=_RESPONSE, + serialized_options=None, + ), + _descriptor.MethodDescriptor( + name='TWFMethod', + full_name='demo.GRPCDemo.TWFMethod', + index=3, + containing_service=None, + input_type=_REQUEST, + output_type=_RESPONSE, + serialized_options=None, + ), +]) +_sym_db.RegisterServiceDescriptor(_GRPCDEMO) + +DESCRIPTOR.services_by_name['GRPCDemo'] = _GRPCDEMO + +# @@protoc_insertion_point(module_scope) diff --git a/examples/python/easy_start_demo/customGrpcPackages/demo_pb2_grpc.py b/examples/python/easy_start_demo/customGrpcPackages/demo_pb2_grpc.py new file mode 100644 index 00000000000..4aaccf1144a --- /dev/null +++ b/examples/python/easy_start_demo/customGrpcPackages/demo_pb2_grpc.py @@ -0,0 +1,99 @@ +# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT! +import grpc + +from . import demo_pb2 as demo__pb2 + + +class GRPCDemoStub(object): + """服务service是用来gRPC的方法的, 格式固定 + 类似于Python中定义一个类, 类似于Golang中定义一个接口 + """ + + def __init__(self, channel): + """Constructor. + + Args: + channel: A grpc.Channel. + """ + self.SimpleMethod = channel.unary_unary( + '/demo.GRPCDemo/SimpleMethod', + request_serializer=demo__pb2.Request.SerializeToString, + response_deserializer=demo__pb2.Response.FromString, + ) + self.CStreamMethod = channel.stream_unary( + '/demo.GRPCDemo/CStreamMethod', + request_serializer=demo__pb2.Request.SerializeToString, + response_deserializer=demo__pb2.Response.FromString, + ) + self.SStreamMethod = channel.unary_stream( + '/demo.GRPCDemo/SStreamMethod', + request_serializer=demo__pb2.Request.SerializeToString, + response_deserializer=demo__pb2.Response.FromString, + ) + self.TWFMethod = channel.stream_stream( + '/demo.GRPCDemo/TWFMethod', + request_serializer=demo__pb2.Request.SerializeToString, + response_deserializer=demo__pb2.Response.FromString, + ) + + +class GRPCDemoServicer(object): + """服务service是用来gRPC的方法的, 格式固定 + 类似于Python中定义一个类, 类似于Golang中定义一个接口 + """ + + def SimpleMethod(self, request, context): + """简单模式 + """ + context.set_code(grpc.StatusCode.UNIMPLEMENTED) + context.set_details('Method not implemented!') + raise NotImplementedError('Method not implemented!') + + def CStreamMethod(self, request_iterator, context): + """客户端流模式（在一次调用中, 客户端可以多次向服务器传输数据, 但是服务器只能返回一次响应） + """ + context.set_code(grpc.StatusCode.UNIMPLEMENTED) + context.set_details('Method not implemented!') + raise NotImplementedError('Method not implemented!') + + def SStreamMethod(self, request, context): + """服务端流模式（在一次调用中, 客户端只能一次向服务器传输数据, 但是服务器可以多次返回响应） + """ + context.set_code(grpc.StatusCode.UNIMPLEMENTED) + context.set_details('Method not implemented!') + raise NotImplementedError('Method not implemented!') + + def TWFMethod(self, request_iterator, context): + """双向流模式 (在一次调用中, 客户端和服务器都可以向对象多次收发数据) + """ + context.set_code(grpc.StatusCode.UNIMPLEMENTED) + context.set_details('Method not implemented!') + raise NotImplementedError('Method not implemented!') + + +def add_GRPCDemoServicer_to_server(servicer, server): + rpc_method_handlers = { + 'SimpleMethod': grpc.unary_unary_rpc_method_handler( + servicer.SimpleMethod, + request_deserializer=demo__pb2.Request.FromString, + response_serializer=demo__pb2.Response.SerializeToString, + ), + 'CStreamMethod': grpc.stream_unary_rpc_method_handler( + servicer.CStreamMethod, + request_deserializer=demo__pb2.Request.FromString, + response_serializer=demo__pb2.Response.SerializeToString, + ), + 'SStreamMethod': grpc.unary_stream_rpc_method_handler( + servicer.SStreamMethod, + request_deserializer=demo__pb2.Request.FromString, + response_serializer=demo__pb2.Response.SerializeToString, + ), + 'TWFMethod': grpc.stream_stream_rpc_method_handler( + servicer.TWFMethod, + request_deserializer=demo__pb2.Request.FromString, + response_serializer=demo__pb2.Response.SerializeToString, + ), + } + generic_handler = grpc.method_handlers_generic_handler( + 'demo.GRPCDemo', rpc_method_handlers) + server.add_generic_rpc_handlers((generic_handler,)) diff --git a/examples/python/easy_start_demo/demo.proto b/examples/python/easy_start_demo/demo.proto new file mode 100644 index 00000000000..4fb76bce752 --- /dev/null +++ b/examples/python/easy_start_demo/demo.proto @@ -0,0 +1,51 @@ +// 语法版本声明，必须放在非注释的第一行 +// Syntax version declaration, Must be placed on the first line of non-commentary +syntax = "proto3"; + +// 包名定义, Python中使用时可以省略不写(PS:我还要再Go中使用,所以留在这里了) +// Package name definition, which can be omitted in Python (PS: I'll use it again in Go, so stay here) +package demo; + +/* +`message`是用来定义传输的数据的格式的, 等号后面的是字段编号 +消息定义中的每个字段都有唯一的编号 +总体格式类似于Python中定义一个类或者Golang中定义一个结构体 +*/ +/* +`message` is used to define the structure of the data to be transmitted, After the equal sign is the field number. +Each field in the message definition has a unique number. +The overall format is similar to defining a class in Python or a structure in Golang. +*/ +message Request { + int64 Cid = 1; + string ReqMsg = 2; +} + +message Response { + int64 Sid = 1; + string RespMsg = 2; +} + +// service是用来给GRPC服务定义方法的, 格式固定, 类似于Golang中定义一个接口 +// `service` is used to define methods for GRPC services in a fixed format, similar to defining an interface in Golang +service GRPCDemo { + // 简单模式 + // Unary + rpc SimpleMethod (Request) returns (Response); + + // 客户端流模式（在一次调用中, 客户端可以多次向服务器传输数据, 但是服务器只能返回一次响应） + // Client Streaming (In a single call, the client can transfer data to the server several times, + // but the server can only return a response once.) + rpc CStreamMethod (stream Request) returns (Response); + + // 服务端流模式（在一次调用中, 客户端只能一次向服务器传输数据, 但是服务器可以多次返回响应） + // Server Streaming (In a single call, the client can only transmit data to the server at one time, + // but the server can return the response many times.) + rpc SStreamMethod (Request) returns (stream Response); + + // 双向流模式 (在一次调用中, 客户端和服务器都可以向对方多次收发数据) + // Bidirectional Streaming (In a single call, both client and server can send and receive data + // to each other multiple times.) + rpc TWFMethod (stream Request) returns (stream Response); +} + diff --git a/examples/python/easy_start_demo/notes b/examples/python/easy_start_demo/notes new file mode 100644 index 00000000000..f0518fc1746 --- /dev/null +++ b/examples/python/easy_start_demo/notes @@ -0,0 +1,3 @@ +//自动生成代码 +//Automatic code generation +>>> python -m grpc_tools.protoc -I ./ ./demo.proto --python_out=./customGrpcPackages --grpc_python_out=./customGrpcPackages \ No newline at end of file