Skip to content

Commit 291e0be

Browse files
authored
[Backport][v1.83.x][Python] Fix the StatusCode Enums to be int (#43252)
Backport of #43167 to v1.83.x. --- # Description Fixes #43166 # Testing ``` >>> import grpc >>> grpc.StatusCode.OK.value[0] 0 >>> str(grpc.StatusCode.OK.value[0]) '0' >>> ``` Added test case for this as well.
1 parent 05ceb5d commit 291e0be

4 files changed

Lines changed: 98 additions & 27 deletions

File tree

‎src/python/grpcio/grpc/__init__.py‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -262,35 +262,41 @@ class StatusCode(enum.Enum):
262262
DATA_LOSS: Unrecoverable data loss or corruption.
263263
"""
264264

265-
OK = (_cygrpc.StatusCode.ok, "ok")
266-
CANCELLED = (_cygrpc.StatusCode.cancelled, "cancelled")
267-
UNKNOWN = (_cygrpc.StatusCode.unknown, "unknown")
268-
INVALID_ARGUMENT = (_cygrpc.StatusCode.invalid_argument, "invalid argument")
265+
OK = (int(_cygrpc.StatusCode.ok), "ok")
266+
CANCELLED = (int(_cygrpc.StatusCode.cancelled), "cancelled")
267+
UNKNOWN = (int(_cygrpc.StatusCode.unknown), "unknown")
268+
INVALID_ARGUMENT = (
269+
int(_cygrpc.StatusCode.invalid_argument),
270+
"invalid argument",
271+
)
269272
DEADLINE_EXCEEDED = (
270-
_cygrpc.StatusCode.deadline_exceeded,
273+
int(_cygrpc.StatusCode.deadline_exceeded),
271274
"deadline exceeded",
272275
)
273-
NOT_FOUND = (_cygrpc.StatusCode.not_found, "not found")
274-
ALREADY_EXISTS = (_cygrpc.StatusCode.already_exists, "already exists")
276+
NOT_FOUND = (int(_cygrpc.StatusCode.not_found), "not found")
277+
ALREADY_EXISTS = (int(_cygrpc.StatusCode.already_exists), "already exists")
275278
PERMISSION_DENIED = (
276-
_cygrpc.StatusCode.permission_denied,
279+
int(_cygrpc.StatusCode.permission_denied),
277280
"permission denied",
278281
)
279282
RESOURCE_EXHAUSTED = (
280-
_cygrpc.StatusCode.resource_exhausted,
283+
int(_cygrpc.StatusCode.resource_exhausted),
281284
"resource exhausted",
282285
)
283286
FAILED_PRECONDITION = (
284-
_cygrpc.StatusCode.failed_precondition,
287+
int(_cygrpc.StatusCode.failed_precondition),
285288
"failed precondition",
286289
)
287-
ABORTED = (_cygrpc.StatusCode.aborted, "aborted")
288-
OUT_OF_RANGE = (_cygrpc.StatusCode.out_of_range, "out of range")
289-
UNIMPLEMENTED = (_cygrpc.StatusCode.unimplemented, "unimplemented")
290-
INTERNAL = (_cygrpc.StatusCode.internal, "internal")
291-
UNAVAILABLE = (_cygrpc.StatusCode.unavailable, "unavailable")
292-
DATA_LOSS = (_cygrpc.StatusCode.data_loss, "data loss")
293-
UNAUTHENTICATED = (_cygrpc.StatusCode.unauthenticated, "unauthenticated")
290+
ABORTED = (int(_cygrpc.StatusCode.aborted), "aborted")
291+
OUT_OF_RANGE = (int(_cygrpc.StatusCode.out_of_range), "out of range")
292+
UNIMPLEMENTED = (int(_cygrpc.StatusCode.unimplemented), "unimplemented")
293+
INTERNAL = (int(_cygrpc.StatusCode.internal), "internal")
294+
UNAVAILABLE = (int(_cygrpc.StatusCode.unavailable), "unavailable")
295+
DATA_LOSS = (int(_cygrpc.StatusCode.data_loss), "data loss")
296+
UNAUTHENTICATED = (
297+
int(_cygrpc.StatusCode.unauthenticated),
298+
"unauthenticated",
299+
)
294300

295301

296302
############################# gRPC Status ################################

‎src/python/grpcio/grpc/_cython/_cygrpc/records.pyx.pxi‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,6 @@ class StatusCode(enum.IntEnum):
7777
unavailable = GRPC_STATUS_UNAVAILABLE
7878
data_loss = GRPC_STATUS_DATA_LOSS
7979

80-
# Typeguard cannot identify `_cygrpc.StatusCode` values as integers unless
81-
# the class inherits from `enum.IntEnum`. However, doing so breaks the
82-
# pickling of `grpc.StatusCode` because it then embeds instances of
83-
# `_cygrpc.StatusCode` instead of plain integers. This leads to a
84-
# PicklingError: Can't pickle : import of module '_cython.cygrpc' failed.
85-
# To resolve this, we implement the pickling interface and ensure
86-
# `_cygrpc.StatusCode` values are pickled as pure integers. Test:
87-
# grpcio_tests.tests_aio.unit.aio_rpc_error_test.TestAioRpcError.test_pickle
88-
def __reduce_ex__(self, proto):
89-
return (int, (self.value,))
9080

9181
class CallError:
9282
ok = GRPC_CALL_OK

‎src/python/grpcio_tests/tests/tests.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
"tests.unit._api_test.AllTest",
3939
"tests.unit._api_test.ChannelConnectivityTest",
4040
"tests.unit._api_test.ChannelTest",
41+
"tests.unit._api_test.StatusCodeTest",
4142
"tests.unit._auth_context_test.AuthContextTest",
4243
"tests.unit._auth_test.AccessTokenAuthMetadataPluginTest",
4344
"tests.unit._auth_test.GoogleCallCredentialsTest",

‎src/python/grpcio_tests/tests/unit/_api_test.py‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,80 @@ def testAll(self):
9797
)
9898

9999

100+
class StatusCodeTest(unittest.TestCase):
101+
def test_status_code_type(self):
102+
self.assertIs(type(grpc.StatusCode.OK.value[0]), int)
103+
self.assertIs(type(grpc.StatusCode.CANCELLED.value[0]), int)
104+
self.assertIs(type(grpc.StatusCode.UNKNOWN.value[0]), int)
105+
self.assertIs(type(grpc.StatusCode.INVALID_ARGUMENT.value[0]), int)
106+
self.assertIs(type(grpc.StatusCode.DEADLINE_EXCEEDED.value[0]), int)
107+
self.assertIs(type(grpc.StatusCode.NOT_FOUND.value[0]), int)
108+
self.assertIs(type(grpc.StatusCode.ALREADY_EXISTS.value[0]), int)
109+
self.assertIs(type(grpc.StatusCode.PERMISSION_DENIED.value[0]), int)
110+
self.assertIs(type(grpc.StatusCode.RESOURCE_EXHAUSTED.value[0]), int)
111+
self.assertIs(type(grpc.StatusCode.FAILED_PRECONDITION.value[0]), int)
112+
self.assertIs(type(grpc.StatusCode.ABORTED.value[0]), int)
113+
self.assertIs(type(grpc.StatusCode.OUT_OF_RANGE.value[0]), int)
114+
self.assertIs(type(grpc.StatusCode.UNIMPLEMENTED.value[0]), int)
115+
self.assertIs(type(grpc.StatusCode.INTERNAL.value[0]), int)
116+
self.assertIs(type(grpc.StatusCode.UNAVAILABLE.value[0]), int)
117+
self.assertIs(type(grpc.StatusCode.DATA_LOSS.value[0]), int)
118+
self.assertIs(type(grpc.StatusCode.UNAUTHENTICATED.value[0]), int)
119+
120+
def test_status_code_str_serialization(self):
121+
self.assertEqual(str(grpc.StatusCode.OK.value), "(0, 'ok')")
122+
self.assertEqual(
123+
str(grpc.StatusCode.CANCELLED.value), "(1, 'cancelled')"
124+
)
125+
self.assertEqual(str(grpc.StatusCode.UNKNOWN.value), "(2, 'unknown')")
126+
self.assertEqual(
127+
str(grpc.StatusCode.INVALID_ARGUMENT.value),
128+
"(3, 'invalid argument')",
129+
)
130+
self.assertEqual(
131+
str(grpc.StatusCode.DEADLINE_EXCEEDED.value),
132+
"(4, 'deadline exceeded')",
133+
)
134+
self.assertEqual(
135+
str(grpc.StatusCode.NOT_FOUND.value), "(5, 'not found')"
136+
)
137+
self.assertEqual(
138+
str(grpc.StatusCode.ALREADY_EXISTS.value), "(6, 'already exists')"
139+
)
140+
self.assertEqual(
141+
str(grpc.StatusCode.PERMISSION_DENIED.value),
142+
"(7, 'permission denied')",
143+
)
144+
self.assertEqual(
145+
str(grpc.StatusCode.RESOURCE_EXHAUSTED.value),
146+
"(8, 'resource exhausted')",
147+
)
148+
self.assertEqual(
149+
str(grpc.StatusCode.FAILED_PRECONDITION.value),
150+
"(9, 'failed precondition')",
151+
)
152+
self.assertEqual(str(grpc.StatusCode.ABORTED.value), "(10, 'aborted')")
153+
self.assertEqual(
154+
str(grpc.StatusCode.OUT_OF_RANGE.value), "(11, 'out of range')"
155+
)
156+
self.assertEqual(
157+
str(grpc.StatusCode.UNIMPLEMENTED.value), "(12, 'unimplemented')"
158+
)
159+
self.assertEqual(
160+
str(grpc.StatusCode.INTERNAL.value), "(13, 'internal')"
161+
)
162+
self.assertEqual(
163+
str(grpc.StatusCode.UNAVAILABLE.value), "(14, 'unavailable')"
164+
)
165+
self.assertEqual(
166+
str(grpc.StatusCode.DATA_LOSS.value), "(15, 'data loss')"
167+
)
168+
self.assertEqual(
169+
str(grpc.StatusCode.UNAUTHENTICATED.value),
170+
"(16, 'unauthenticated')",
171+
)
172+
173+
100174
class ChannelConnectivityTest(unittest.TestCase):
101175
def testChannelConnectivity(self):
102176
self.assertSequenceEqual(

0 commit comments

Comments
 (0)