関数またはメソッドが正常または非同期であるかどうかのテスト

Question

関数またはメソッドが通常関数または非同期関数であるかどうか調べるにはどうすればよいですか？私のコードでは、通常のコールバックまたは非同期のコールバックを自動的にサポートし、どのタイプの関数が渡されるかをテストする方法が必要です。

async def exampleAsyncCb(): 
    pass 

def exampleNomralCb(): 
    pass 

def isAsync(someFunc): 
    #do cool dynamic python stuff on the function 
    return True/False 

async def callCallback(cb, arg): 
    if isAsync(cb): 
     await cb(arg) 
    else: 
     cb(arg) 

そして、それが正常にまたはのawaitでそれを実行する必要がありますいずれか渡さ機能の種類によって異なります。私は様々なことを試しましたが、どのように実装するのか分かりませんisAsync()。

Answer 1

Pythonのinspectモジュールを使用してください。

inspect.iscoroutinefunction(object)

戻る真の目的は、コルーチン関数（非同期DEF構文で定義された関数）である場合。

この関数は、Python 3.5以降で使用できます。 このモジュールは、Python 2の機能が少なく、探しているモジュールがなくても利用できます。inspect

名前が示すようにモジュールを検査すると、多くのことを調べるのに便利です。ドキュメントは

言う検査モジュールは、モジュール、クラス、メソッド、関数・トレースバック・フレームオブジェクト・コードオブジェクトなどのオブジェクトに関する情報を得るのを助けるために、いくつかの便利な機能を提供します。たとえば、クラスの内容を調べたり、メソッドのソースコードを取得したり、関数の引数リストを抽出してフォーマットしたり、詳細なトレースバックを表示するのに必要なすべての情報を取得するのに役立ちます。

このモジュールで提供される主なサービスには、型チェック、ソースコードの取得、クラスと関数の検査、インタープリタスタックの検査があります。

このモジュールのいくつかの基本的な機能は以下のとおりです。

inspect.ismodule(object) 
inspect.isclass(object) 
inspect.ismethod(object) 
inspect.isfunction(object) 

また

inspect.getdoc(object) 
inspect.getcomments(object) 
inspect.getfile(object) 
inspect.getmodule(object) 

方法が直感的に命名されているソースコードを取得する機能をパックします。必要に応じて説明がドキュメントにあります。

Answer 2

コルーチンは、COROUTINEフラグが設定されている、コードフラグのビット6：

値128が inspectモジュールに定数として記憶される

>>> async def foo(): pass 
>>> foo.__code__.co_flags & (2 << 6) 
128 # not 0, so the flag is set. 

：

>>> import inspect 
>>> inspect.CO_COROUTINE 
128 
>>> foo.__code__.co_flags & inspect.CO_COROUTINE 
128 

inspect.iscoroutinefunction() functionはありませんそれだけ;オブジェクトがファンクションまたはメソッドであるかどうかをテストし（__code__属性があることを確認する）、そのフラグをテストします。 source codeを参照してください。もちろん

、inspect.iscoroutinefunction()を使用すると、最も読みやすいですし、これまでのコードフラグを変更した場合は動作し続けることが保証：さ

>>> inspect.iscoroutinefunction(foo) 
True 

Answer 3

をあなたはinspectで別のインポートを導入したくない場合は、iscoroutineasyncioでもご利用いただけます。

import asyncio 

def isAsync(someFunc): 
    return asyncio.iscoroutinefunction(someFunc) 

Answer 4

上記のソリューションは、コルーチン関数を渡すと単純なケースで動作します。場合によっては、待遇オブジェクト関数をコルーチン関数のように動作させるが、コルーチン関数ではない関数に渡すことがあります。 2つの例は、Futureクラスまたはフューチャーのようなオブジェクトクラス（クラスはimplements__await__の魔法）です。この場合、iscoroutinefunctionはFalseを返します。何が必要なのでしょうか？

それはコールバックとして非機能呼び出し可能なパッシングと非非同期例に理解することは簡単です：、

class SmartCallback: 
    def __init__(self): 
     print('SmartCallback is not function, but can be used as function') 

await callCallback(SmartCallback) # Should work, right? 

戻る非同期の世界に似たような状況：それをしませ解決する

class AsyncSmartCallback: 
    def __await__(self): 
     return self._coro().__await__() 

    async def _coro(self): 
     print('AsyncSmartCallback is not coroutine function, but can be used as coroutine function') 
     await asyncio.sleep(1) 

await callCallback(AsyncSmartCallback) # Should work, but oops! iscoroutinefunction(AsyncSmartCallback) == False 

ウェイiscoroutineまたはiscoroutinefunctionを使用しますが、代わりにinspect.isawaitableを使用してください。準備ができているオブジェクトで動作するので、最初に作成する必要があります。言い換えれば、ソリューションを使用することをお勧めします：

async def callCallback(cb, arg): 
    if callable(cb): 
     res = cb() # here's result of regular func or awaitable 
     if inspect.isawaitable(res): 
      res = await res # await if awaitable 
     return res # return final result 
    else: 
     raise ValueError('cb is not callable') 

これはより普遍的な（と私は確かに論理的に正しい）ソリューションです。