mirror of https://github.com/grpc/grpc.git
Craig Tiller
8 years ago
commit
aef13f78c7
232 changed files with 8873 additions and 4332 deletions
@ -1,56 +1 @@ |
|||||||
gRPC in 3 minutes (Python) |
[This code's documentation lives on the grpc.io site.](http://www.grpc.io/docs/quickstart/python.html) |
||||||
======================== |
|
||||||
|
|
||||||
Background |
|
||||||
------------- |
|
||||||
For this sample, we've already generated the server and client stubs from |
|
||||||
[helloworld.proto][] and we'll be using a specific reference platform. |
|
||||||
|
|
||||||
|
|
||||||
Install gRPC: |
|
||||||
```sh |
|
||||||
$ pip install grpcio |
|
||||||
``` |
|
||||||
Or, to install it system wide: |
|
||||||
```sh |
|
||||||
$ sudo pip install grpcio |
|
||||||
``` |
|
||||||
|
|
||||||
If you're on Windows, make sure you installed the `pip.exe` component when you |
|
||||||
installed Python. Invoke as above but with `pip.exe` instead of `pip` (you may |
|
||||||
also need to invoke from a `cmd.exe` ran as administrator): |
|
||||||
```sh |
|
||||||
$ pip.exe install grpcio |
|
||||||
``` |
|
||||||
|
|
||||||
Download the example |
|
||||||
```sh |
|
||||||
$ # Clone the repository to get the example code: |
|
||||||
$ git clone https://github.com/grpc/grpc |
|
||||||
$ # Navigate to the "hello, world" Python example: |
|
||||||
$ cd grpc/examples/python/helloworld |
|
||||||
``` |
|
||||||
|
|
||||||
Try it! |
|
||||||
------- |
|
||||||
|
|
||||||
- Run the server |
|
||||||
|
|
||||||
```sh |
|
||||||
$ python2.7 greeter_server.py & |
|
||||||
``` |
|
||||||
|
|
||||||
- Run the client |
|
||||||
|
|
||||||
```sh |
|
||||||
$ python2.7 greeter_client.py |
|
||||||
``` |
|
||||||
|
|
||||||
Tutorial |
|
||||||
-------- |
|
||||||
|
|
||||||
You can find a more detailed tutorial in [gRPC Basics: Python][] |
|
||||||
|
|
||||||
[helloworld.proto]:../protos/helloworld.proto |
|
||||||
[Install gRPC Python]:../../src/python#installation |
|
||||||
[gRPC Basics: Python]:http://www.grpc.io/docs/tutorials/basic/python.html |
|
||||||
|
|||||||
@ -1 +1 @@ |
|||||||
[This code's documentation lives on the grpc.io site.](http://www.grpc.io/docs) |
[This code's documentation lives on the grpc.io site.](http://www.grpc.io/docs/quickstart/python.html) |
||||||
|
|||||||
@ -1 +1,3 @@ |
|||||||
An example showing two stubs sharing a channel and two servicers sharing a server. |
An example showing two stubs sharing a channel and two servicers sharing a server. |
||||||
|
|
||||||
|
More complete documentation lives at [grpc.io](http://www.grpc.io/docs/tutorials/basic/python.html). |
||||||
|
|||||||
@ -0,0 +1,180 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, Google Inc. |
||||||
|
* All rights reserved. |
||||||
|
* |
||||||
|
* Redistribution and use in source and binary forms, with or without |
||||||
|
* modification, are permitted provided that the following conditions are |
||||||
|
* met: |
||||||
|
* |
||||||
|
* * Redistributions of source code must retain the above copyright |
||||||
|
* notice, this list of conditions and the following disclaimer. |
||||||
|
* * Redistributions in binary form must reproduce the above |
||||||
|
* copyright notice, this list of conditions and the following disclaimer |
||||||
|
* in the documentation and/or other materials provided with the |
||||||
|
* distribution. |
||||||
|
* * Neither the name of Google Inc. nor the names of its |
||||||
|
* contributors may be used to endorse or promote products derived from |
||||||
|
* this software without specific prior written permission. |
||||||
|
* |
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#include "src/core/lib/support/percent_encoding.h" |
||||||
|
|
||||||
|
#include <grpc/support/log.h> |
||||||
|
|
||||||
|
const uint8_t gpr_url_percent_encoding_unreserved_bytes[256 / 8] = { |
||||||
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x60, 0xff, 0x03, 0xfe, 0xff, 0xff, |
||||||
|
0x87, 0xfe, 0xff, 0xff, 0x47, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, |
||||||
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; |
||||||
|
const uint8_t gpr_compatible_percent_encoding_unreserved_bytes[256 / 8] = { |
||||||
|
0x00, 0x00, 0x00, 0x00, 0xdf, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, |
||||||
|
0xff, 0xff, 0xff, 0xff, 0x7f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, |
||||||
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}; |
||||||
|
|
||||||
|
static bool is_unreserved_character(uint8_t c, |
||||||
|
const uint8_t *unreserved_bytes) { |
||||||
|
return ((unreserved_bytes[c / 8] >> (c % 8)) & 1) != 0; |
||||||
|
} |
||||||
|
|
||||||
|
gpr_slice gpr_percent_encode_slice(gpr_slice slice, |
||||||
|
const uint8_t *unreserved_bytes) { |
||||||
|
static const uint8_t hex[] = "0123456789ABCDEF"; |
||||||
|
|
||||||
|
// first pass: count the number of bytes needed to output this string
|
||||||
|
size_t output_length = 0; |
||||||
|
const uint8_t *slice_start = GPR_SLICE_START_PTR(slice); |
||||||
|
const uint8_t *slice_end = GPR_SLICE_END_PTR(slice); |
||||||
|
const uint8_t *p; |
||||||
|
bool any_reserved_bytes = false; |
||||||
|
for (p = slice_start; p < slice_end; p++) { |
||||||
|
bool unres = is_unreserved_character(*p, unreserved_bytes); |
||||||
|
output_length += unres ? 1 : 3; |
||||||
|
any_reserved_bytes |= !unres; |
||||||
|
} |
||||||
|
// no unreserved bytes: return the string unmodified
|
||||||
|
if (!any_reserved_bytes) { |
||||||
|
return gpr_slice_ref(slice); |
||||||
|
} |
||||||
|
// second pass: actually encode
|
||||||
|
gpr_slice out = gpr_slice_malloc(output_length); |
||||||
|
uint8_t *q = GPR_SLICE_START_PTR(out); |
||||||
|
for (p = slice_start; p < slice_end; p++) { |
||||||
|
if (is_unreserved_character(*p, unreserved_bytes)) { |
||||||
|
*q++ = *p; |
||||||
|
} else { |
||||||
|
*q++ = '%'; |
||||||
|
*q++ = hex[*p >> 4]; |
||||||
|
*q++ = hex[*p & 15]; |
||||||
|
} |
||||||
|
} |
||||||
|
GPR_ASSERT(q == GPR_SLICE_END_PTR(out)); |
||||||
|
return out; |
||||||
|
} |
||||||
|
|
||||||
|
static bool valid_hex(const uint8_t *p, const uint8_t *end) { |
||||||
|
if (p >= end) return false; |
||||||
|
return (*p >= '0' && *p <= '9') || (*p >= 'a' && *p <= 'f') || |
||||||
|
(*p >= 'A' && *p <= 'F'); |
||||||
|
} |
||||||
|
|
||||||
|
static uint8_t dehex(uint8_t c) { |
||||||
|
if (c >= '0' && c <= '9') return (uint8_t)(c - '0'); |
||||||
|
if (c >= 'A' && c <= 'F') return (uint8_t)(c - 'A' + 10); |
||||||
|
if (c >= 'a' && c <= 'f') return (uint8_t)(c - 'a' + 10); |
||||||
|
GPR_UNREACHABLE_CODE(return 255); |
||||||
|
} |
||||||
|
|
||||||
|
bool gpr_strict_percent_decode_slice(gpr_slice slice_in, |
||||||
|
const uint8_t *unreserved_bytes, |
||||||
|
gpr_slice *slice_out) { |
||||||
|
const uint8_t *p = GPR_SLICE_START_PTR(slice_in); |
||||||
|
const uint8_t *in_end = GPR_SLICE_END_PTR(slice_in); |
||||||
|
size_t out_length = 0; |
||||||
|
bool any_percent_encoded_stuff = false; |
||||||
|
while (p != in_end) { |
||||||
|
if (*p == '%') { |
||||||
|
if (!valid_hex(++p, in_end)) return false; |
||||||
|
if (!valid_hex(++p, in_end)) return false; |
||||||
|
p++; |
||||||
|
out_length++; |
||||||
|
any_percent_encoded_stuff = true; |
||||||
|
} else if (is_unreserved_character(*p, unreserved_bytes)) { |
||||||
|
p++; |
||||||
|
out_length++; |
||||||
|
} else { |
||||||
|
return false; |
||||||
|
} |
||||||
|
} |
||||||
|
if (!any_percent_encoded_stuff) { |
||||||
|
*slice_out = gpr_slice_ref(slice_in); |
||||||
|
return true; |
||||||
|
} |
||||||
|
p = GPR_SLICE_START_PTR(slice_in); |
||||||
|
*slice_out = gpr_slice_malloc(out_length); |
||||||
|
uint8_t *q = GPR_SLICE_START_PTR(*slice_out); |
||||||
|
while (p != in_end) { |
||||||
|
if (*p == '%') { |
||||||
|
*q++ = (uint8_t)(dehex(p[1]) << 4) | (dehex(p[2])); |
||||||
|
p += 3; |
||||||
|
} else { |
||||||
|
*q++ = *p++; |
||||||
|
} |
||||||
|
} |
||||||
|
GPR_ASSERT(q == GPR_SLICE_END_PTR(*slice_out)); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
gpr_slice gpr_permissive_percent_decode_slice(gpr_slice slice_in) { |
||||||
|
const uint8_t *p = GPR_SLICE_START_PTR(slice_in); |
||||||
|
const uint8_t *in_end = GPR_SLICE_END_PTR(slice_in); |
||||||
|
size_t out_length = 0; |
||||||
|
bool any_percent_encoded_stuff = false; |
||||||
|
while (p != in_end) { |
||||||
|
if (*p == '%') { |
||||||
|
if (!valid_hex(p + 1, in_end) || !valid_hex(p + 2, in_end)) { |
||||||
|
p++; |
||||||
|
out_length++; |
||||||
|
} else { |
||||||
|
p += 3; |
||||||
|
out_length++; |
||||||
|
any_percent_encoded_stuff = true; |
||||||
|
} |
||||||
|
} else { |
||||||
|
p++; |
||||||
|
out_length++; |
||||||
|
} |
||||||
|
} |
||||||
|
if (!any_percent_encoded_stuff) { |
||||||
|
return gpr_slice_ref(slice_in); |
||||||
|
} |
||||||
|
p = GPR_SLICE_START_PTR(slice_in); |
||||||
|
gpr_slice out = gpr_slice_malloc(out_length); |
||||||
|
uint8_t *q = GPR_SLICE_START_PTR(out); |
||||||
|
while (p != in_end) { |
||||||
|
if (*p == '%') { |
||||||
|
if (!valid_hex(p + 1, in_end) || !valid_hex(p + 2, in_end)) { |
||||||
|
*q++ = *p++; |
||||||
|
} else { |
||||||
|
*q++ = (uint8_t)(dehex(p[1]) << 4) | (dehex(p[2])); |
||||||
|
p += 3; |
||||||
|
} |
||||||
|
} else { |
||||||
|
*q++ = *p++; |
||||||
|
} |
||||||
|
} |
||||||
|
GPR_ASSERT(q == GPR_SLICE_END_PTR(out)); |
||||||
|
return out; |
||||||
|
} |
||||||
@ -0,0 +1,78 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2016, Google Inc. |
||||||
|
* All rights reserved. |
||||||
|
* |
||||||
|
* Redistribution and use in source and binary forms, with or without |
||||||
|
* modification, are permitted provided that the following conditions are |
||||||
|
* met: |
||||||
|
* |
||||||
|
* * Redistributions of source code must retain the above copyright |
||||||
|
* notice, this list of conditions and the following disclaimer. |
||||||
|
* * Redistributions in binary form must reproduce the above |
||||||
|
* copyright notice, this list of conditions and the following disclaimer |
||||||
|
* in the documentation and/or other materials provided with the |
||||||
|
* distribution. |
||||||
|
* * Neither the name of Google Inc. nor the names of its |
||||||
|
* contributors may be used to endorse or promote products derived from |
||||||
|
* this software without specific prior written permission. |
||||||
|
* |
||||||
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||||
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||||
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||||
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||||
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||||
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||||
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||||
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||||
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||||
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||||
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPC_CORE_LIB_SUPPORT_PERCENT_ENCODING_H |
||||||
|
#define GRPC_CORE_LIB_SUPPORT_PERCENT_ENCODING_H |
||||||
|
|
||||||
|
/* Percent encoding and decoding of slices.
|
||||||
|
Transforms arbitrary strings into safe-for-transmission strings by using |
||||||
|
variants of percent encoding (RFC 3986). |
||||||
|
Two major variants are supplied: one that strictly matches URL encoding, |
||||||
|
and another which applies percent encoding only to non-http2 header |
||||||
|
bytes (the 'compatible' variant) */ |
||||||
|
|
||||||
|
#include <stdbool.h> |
||||||
|
|
||||||
|
#include <grpc/support/slice.h> |
||||||
|
|
||||||
|
/* URL percent encoding spec bitfield (usabel as 'unreserved_bytes' in
|
||||||
|
gpr_percent_encode_slice, gpr_strict_percent_decode_slice). |
||||||
|
Flags [A-Za-z0-9-_.~] as unreserved bytes for the percent encoding routines |
||||||
|
*/ |
||||||
|
extern const uint8_t gpr_url_percent_encoding_unreserved_bytes[256 / 8]; |
||||||
|
/* URL percent encoding spec bitfield (usabel as 'unreserved_bytes' in
|
||||||
|
gpr_percent_encode_slice, gpr_strict_percent_decode_slice). |
||||||
|
Flags ascii7 non-control characters excluding '%' as unreserved bytes for the |
||||||
|
percent encoding routines */ |
||||||
|
extern const uint8_t gpr_compatible_percent_encoding_unreserved_bytes[256 / 8]; |
||||||
|
|
||||||
|
/* Percent-encode a slice, returning the new slice (this cannot fail):
|
||||||
|
unreserved_bytes is a bitfield indicating which bytes are considered |
||||||
|
unreserved and thus do not need percent encoding */ |
||||||
|
gpr_slice gpr_percent_encode_slice(gpr_slice slice, |
||||||
|
const uint8_t *unreserved_bytes); |
||||||
|
/* Percent-decode a slice, strictly.
|
||||||
|
If the input is legal (contains no unreserved bytes, and legal % encodings), |
||||||
|
returns true and sets *slice_out to the decoded slice. |
||||||
|
If the input is not legal, returns false and leaves *slice_out untouched. |
||||||
|
unreserved_bytes is a bitfield indicating which bytes are considered |
||||||
|
unreserved and thus do not need percent encoding */ |
||||||
|
bool gpr_strict_percent_decode_slice(gpr_slice slice_in, |
||||||
|
const uint8_t *unreserved_bytes, |
||||||
|
gpr_slice *slice_out); |
||||||
|
/* Percent-decode a slice, permissively.
|
||||||
|
If a % triplet can not be decoded, pass it through verbatim. |
||||||
|
This cannot fail. */ |
||||||
|
gpr_slice gpr_permissive_percent_decode_slice(gpr_slice slice_in); |
||||||
|
|
||||||
|
#endif /* GRPC_CORE_LIB_SUPPORT_PERCENT_ENCODING_H */ |
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in new issue