Generate service functions on the thrift python client class

Summary: The concept of async and sync clients is new to thrift python, in thrift py3 every client was async, and the client methods were located directly on the class. This leads to potential issues when enabling auto-migrate as these methods are no longer there. Just sticking references to the Async class methods directly on the class itself to avoid this problem. This does require a bit of a hack in that we have to tell pyre to ignore the fact that we have no annotation. I'm not 100% sure this is correct, but I was looking into adding the correct annotation and what pyre expects here is something like: `typing.Callable(Async.getMetadaField)[[Named(self, Async), Named(key, str), KeywordOnly(rpc_options, Optional[RpcOptions], default)], Coroutine[typing.Any, typing.Any, str]]`, and this just seems like way too much duplication to me. Optimally I'd like tell pyre to just use the inferred type but I don't think there's any to do that. Reviewed By: ahilger Differential Revision: D67056477 fbshipit-source-id: 06aa228b911a24f087cbff56803934356d5d1a94
facebook · Dec 12, 2024 · 10edf95 · 10edf95
1 parent 94a937a
commit 10edf95
Show file tree

Hide file tree

Showing 41 changed files with 916 additions and 0 deletions.
diff --git a/thrift/compiler/generate/templates/python/clients/client_body.mustache b/thrift/compiler/generate/templates/python/clients/client_body.mustache
@@ -151,6 +151,12 @@ class Async({{#service:extends}}{{!
     ) -> {{service:parent_service_name}}_{{service:name}}.Async:
         return self.create{{service:name}}()
     {{/service:interactions}}
+
+{{#service:supported_functions}}
+# pyre-ignore[4]: Missing annotation.{{! Adding an annotation here would require way too much duplication }}
+{{function:name}} = Async.{{function:name}}
+{{/service:supported_functions}}
+
 class Sync({{#service:extends}}{{!
     }}{{> services/client_module_path}}.Sync{{!
 }}{{/service:extends}}{{^service:extends?}}{{!

diff --git a/thrift/compiler/test/fixtures/adapter/out/python_a/gen-python/a/thrift_clients.py b/thrift/compiler/test/fixtures/adapter/out/python_a/gen-python/a/thrift_clients.py
@@ -101,6 +101,12 @@ async def adapted_param(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    adapted_return = Async.adapted_return
+    # pyre-ignore[4]: Missing annotation.
+    adapted_param = Async.adapted_param
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...er/test/fixtures/basic/out/python/gen-python/test/fixtures/basic/module/thrift_clients.py b/...er/test/fixtures/basic/out/python/gen-python/test/fixtures/basic/module/thrift_clients.py
@@ -69,6 +69,10 @@ async def simple_rpc(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -152,6 +156,10 @@ async def simple_rpc(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -414,6 +422,28 @@ async def rpc_skipped_codegen(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    ping = Async.ping
+    # pyre-ignore[4]: Missing annotation.
+    getRandomData = Async.getRandomData
+    # pyre-ignore[4]: Missing annotation.
+    sink = Async.sink
+    # pyre-ignore[4]: Missing annotation.
+    putDataById = Async.putDataById
+    # pyre-ignore[4]: Missing annotation.
+    hasDataById = Async.hasDataById
+    # pyre-ignore[4]: Missing annotation.
+    getDataById = Async.getDataById
+    # pyre-ignore[4]: Missing annotation.
+    deleteDataById = Async.deleteDataById
+    # pyre-ignore[4]: Missing annotation.
+    lobDataById = Async.lobDataById
+    # pyre-ignore[4]: Missing annotation.
+    invalid_return_for_hack = Async.invalid_return_for_hack
+    # pyre-ignore[4]: Missing annotation.
+    rpc_skipped_codegen = Async.rpc_skipped_codegen
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -691,6 +721,12 @@ async def getDataByKey1(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey0 = Async.getDataByKey0
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey1 = Async.getDataByKey1
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...perimental_generate_mutable_types/gen-python/test/fixtures/basic/module/thrift_clients.py b/...perimental_generate_mutable_types/gen-python/test/fixtures/basic/module/thrift_clients.py
@@ -69,6 +69,10 @@ async def simple_rpc(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -152,6 +156,10 @@ async def simple_rpc(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -414,6 +422,28 @@ async def rpc_skipped_codegen(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    ping = Async.ping
+    # pyre-ignore[4]: Missing annotation.
+    getRandomData = Async.getRandomData
+    # pyre-ignore[4]: Missing annotation.
+    sink = Async.sink
+    # pyre-ignore[4]: Missing annotation.
+    putDataById = Async.putDataById
+    # pyre-ignore[4]: Missing annotation.
+    hasDataById = Async.hasDataById
+    # pyre-ignore[4]: Missing annotation.
+    getDataById = Async.getDataById
+    # pyre-ignore[4]: Missing annotation.
+    deleteDataById = Async.deleteDataById
+    # pyre-ignore[4]: Missing annotation.
+    lobDataById = Async.lobDataById
+    # pyre-ignore[4]: Missing annotation.
+    invalid_return_for_hack = Async.invalid_return_for_hack
+    # pyre-ignore[4]: Missing annotation.
+    rpc_skipped_codegen = Async.rpc_skipped_codegen
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -691,6 +721,12 @@ async def getDataByKey1(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey0 = Async.getDataByKey0
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey1 = Async.getDataByKey1
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...al_generate_mutable_types/gen-python/test/fixtures/basic/module/thrift_mutable_clients.py b/...al_generate_mutable_types/gen-python/test/fixtures/basic/module/thrift_mutable_clients.py
@@ -73,6 +73,10 @@ async def simple_rpc(
                 is_mutable_types=True,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -158,6 +162,10 @@ async def simple_rpc(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -431,6 +439,28 @@ async def rpc_skipped_codegen(
                 is_mutable_types=True,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    ping = Async.ping
+    # pyre-ignore[4]: Missing annotation.
+    getRandomData = Async.getRandomData
+    # pyre-ignore[4]: Missing annotation.
+    sink = Async.sink
+    # pyre-ignore[4]: Missing annotation.
+    putDataById = Async.putDataById
+    # pyre-ignore[4]: Missing annotation.
+    hasDataById = Async.hasDataById
+    # pyre-ignore[4]: Missing annotation.
+    getDataById = Async.getDataById
+    # pyre-ignore[4]: Missing annotation.
+    deleteDataById = Async.deleteDataById
+    # pyre-ignore[4]: Missing annotation.
+    lobDataById = Async.lobDataById
+    # pyre-ignore[4]: Missing annotation.
+    invalid_return_for_hack = Async.invalid_return_for_hack
+    # pyre-ignore[4]: Missing annotation.
+    rpc_skipped_codegen = Async.rpc_skipped_codegen
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -720,6 +750,12 @@ async def getDataByKey1(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey0 = Async.getDataByKey0
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey1 = Async.getDataByKey1
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...l_generate_mutable_types_service/gen-python/meta/example/thrift/service/thrift_clients.py b/...l_generate_mutable_types_service/gen-python/meta/example/thrift/service/thrift_clients.py
@@ -80,6 +80,10 @@ async def echo(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    echo = Async.echo
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...te_mutable_types_service/gen-python/meta/example/thrift/service/thrift_mutable_clients.py b/...te_mutable_types_service/gen-python/meta/example/thrift/service/thrift_mutable_clients.py
@@ -84,6 +84,10 @@ async def echo(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    echo = Async.echo
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...te_mutable_without_abstract_types/gen-python/test/fixtures/basic/module/thrift_clients.py b/...te_mutable_without_abstract_types/gen-python/test/fixtures/basic/module/thrift_clients.py
@@ -69,6 +69,10 @@ async def simple_rpc(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -152,6 +156,10 @@ async def simple_rpc(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -414,6 +422,28 @@ async def rpc_skipped_codegen(
                 rpc_options=rpc_options,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    ping = Async.ping
+    # pyre-ignore[4]: Missing annotation.
+    getRandomData = Async.getRandomData
+    # pyre-ignore[4]: Missing annotation.
+    sink = Async.sink
+    # pyre-ignore[4]: Missing annotation.
+    putDataById = Async.putDataById
+    # pyre-ignore[4]: Missing annotation.
+    hasDataById = Async.hasDataById
+    # pyre-ignore[4]: Missing annotation.
+    getDataById = Async.getDataById
+    # pyre-ignore[4]: Missing annotation.
+    deleteDataById = Async.deleteDataById
+    # pyre-ignore[4]: Missing annotation.
+    lobDataById = Async.lobDataById
+    # pyre-ignore[4]: Missing annotation.
+    invalid_return_for_hack = Async.invalid_return_for_hack
+    # pyre-ignore[4]: Missing annotation.
+    rpc_skipped_codegen = Async.rpc_skipped_codegen
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -691,6 +721,12 @@ async def getDataByKey1(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey0 = Async.getDataByKey0
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey1 = Async.getDataByKey1
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...le_without_abstract_types/gen-python/test/fixtures/basic/module/thrift_mutable_clients.py b/...le_without_abstract_types/gen-python/test/fixtures/basic/module/thrift_mutable_clients.py
@@ -73,6 +73,10 @@ async def simple_rpc(
                 is_mutable_types=True,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -158,6 +162,10 @@ async def simple_rpc(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    simple_rpc = Async.simple_rpc
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -431,6 +439,28 @@ async def rpc_skipped_codegen(
                 is_mutable_types=True,
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    ping = Async.ping
+    # pyre-ignore[4]: Missing annotation.
+    getRandomData = Async.getRandomData
+    # pyre-ignore[4]: Missing annotation.
+    sink = Async.sink
+    # pyre-ignore[4]: Missing annotation.
+    putDataById = Async.putDataById
+    # pyre-ignore[4]: Missing annotation.
+    hasDataById = Async.hasDataById
+    # pyre-ignore[4]: Missing annotation.
+    getDataById = Async.getDataById
+    # pyre-ignore[4]: Missing annotation.
+    deleteDataById = Async.deleteDataById
+    # pyre-ignore[4]: Missing annotation.
+    lobDataById = Async.lobDataById
+    # pyre-ignore[4]: Missing annotation.
+    invalid_return_for_hack = Async.invalid_return_for_hack
+    # pyre-ignore[4]: Missing annotation.
+    rpc_skipped_codegen = Async.rpc_skipped_codegen
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:
@@ -720,6 +750,12 @@ async def getDataByKey1(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey0 = Async.getDataByKey0
+    # pyre-ignore[4]: Missing annotation.
+    getDataByKey1 = Async.getDataByKey1
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/...ixtures/basic/out/python_service/gen-python/meta/example/thrift/service/thrift_clients.py b/...ixtures/basic/out/python_service/gen-python/meta/example/thrift/service/thrift_clients.py
@@ -80,6 +80,10 @@ async def echo(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    echo = Async.echo
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str:

diff --git a/thrift/compiler/test/fixtures/exceptions/out/python/gen-python/module/thrift_clients.py b/thrift/compiler/test/fixtures/exceptions/out/python/gen-python/module/thrift_clients.py
@@ -140,6 +140,16 @@ async def get500(
                 "Empty Response",
             )
 
+
+    # pyre-ignore[4]: Missing annotation.
+    doBland = Async.doBland
+    # pyre-ignore[4]: Missing annotation.
+    doRaise = Async.doRaise
+    # pyre-ignore[4]: Missing annotation.
+    get200 = Async.get200
+    # pyre-ignore[4]: Missing annotation.
+    get500 = Async.get500
+
     class Sync(_fbthrift_python_SyncClient):
         @staticmethod
         def __get_thrift_name__() -> str: