Canvas:ワークフローの設計—Pythonドキュメント
キャンバス:ワークフローの設計
署名
バージョン2.0の新機能。
calling ガイドのtasks delay
メソッドを使用してタスクを呼び出す方法を学習しました。多くの場合、これで十分ですが、タスク呼び出しの署名を渡したい場合もあります。別のプロセスへ、または別の関数への引数として。
signature()
は、単一のタスク呼び出しの引数、キーワード引数、および実行オプションを、関数に渡したり、シリアル化してネットワーク経由で送信したりできるようにラップします。
add
タスクの署名は、次のような名前を使用して作成できます。このタスクには、アリティ2(2つの引数)のシグネチャ
(2, 2)
があり、カウントダウン実行オプションを10に設定します。または、タスクの
signature
メソッドを使用して作成できます。スター引数を使用したショートカットもあります。
キーワード引数もサポートされています。
任意の署名インスタンスから、さまざまなフィールドを検査できます。
delay
、apply_async
などの「CallingAPI」をサポートしており、直接呼び出されることもあります(__call__
)。署名を呼び出すと、現在のプロセスでタスクがインラインで実行されます。
delay
は、スター引数を取るapply_async
への私たちの最愛のショートカットです。apply_async
は、Task.apply_async
メソッドと同じ引数を取ります。s()
でオプションを定義することはできませんが、チェーンset
呼び出しがそれを処理します。
パーシャル
署名を使用すると、ワーカーでタスクを実行できます。
または、現在のプロセスで直接呼び出すこともできます。
apply_async
/ delay
に追加の引数、kwargs、またはオプションを指定すると、パーシャルが作成されます。
追加された引数はすべて、署名の引数の前に追加されます。
追加されたキーワード引数はすべて、署名のkwargsとマージされ、新しいキーワード引数が優先されます。
追加されたオプションはすべて、署名のオプションとマージされ、新しいオプションが優先されます。
署名を複製して派生物を作成することもできます。
不変性
バージョン3.0の新機能。
パーシャルは、コールバック、リンクされたタスク、またはコードコールバックで使用されることを意図しており、親タスクの結果とともに適用されます。 追加の引数をとらないコールバックを指定したい場合があります。その場合、署名を不変に設定できます。
.si()
ショートカットを使用して、不変の署名を作成することもできます。
シグニチャが不変の場合は実行オプションのみを設定できるため、部分的なargs / kwargsを使用してシグニチャを呼び出すことはできません。
ノート
このチュートリアルでは、署名にプレフィックス演算子〜を使用することがあります。 おそらく本番コードでは使用しないでください。ただし、Pythonシェルで実験する場合は便利なショートカットです。
コールバック
バージョン3.0の新機能。
apply_async
のlink
引数を使用してコールバックを任意のタスクに追加できます。
コールバックは、タスクが正常に終了した場合にのみ適用され、親タスクの戻り値を引数として適用されます。
前に述べたように、署名に追加する引数はすべて、署名自体によって指定された引数の前に追加されます。
署名がある場合:
その場合、 sig.delay(result)は次のようになります。
…
次に、部分引数を使用したコールバックでadd
タスクを呼び出しましょう。
予想どおり、これは最初に \(2 + 2 \)を計算する1つのタスクを起動し、次に \(4 + 8 \)を計算する別のタスクを起動します。
プリミティブ
バージョン3.0の新機能。
概要
group
グループプリミティブは、並行して適用する必要があるタスクのリストを取得するシグニチャです。
chain
チェーンプリミティブを使用すると、シグニチャをリンクして、一方が次々に呼び出され、基本的にコールバックのチェーンが形成されます。
chord
コードはグループと同じですが、コールバックがあります。 コードはヘッダーグループと本文で構成されます。本文は、ヘッダー内のすべてのタスクが完了した後に実行する必要があるタスクです。
map
マッププリミティブは、組み込みの
map
関数のように機能しますが、引数のリストがタスクに適用される一時的なタスクを作成します。 たとえば、task.map([1, 2])
–単一のタスクが呼び出され、タスク関数に順番に引数が適用され、結果は次のようになります。starmap
引数が
*args
として適用されることを除いて、mapとまったく同じように機能します。 たとえば、add.starmap([(2, 2), (4, 4)])
は、以下を呼び出す単一のタスクになります。chunks
チャンキングは、引数の長いリストを次のように部分に分割します。
アイテムのリストを10個のチャンクに分割し、100個のタスクを生成します(それぞれが10個のアイテムを順番に処理します)。
プリミティブはそれ自体が署名オブジェクトでもあるため、さまざまな方法で組み合わせて複雑なワークフローを構成できます。
ここにいくつかの例があります:
シンプルチェーン
これは単純なチェーンです。最初のタスクが実行され、その戻り値がチェーン内の次のタスクに渡されます。
これは、パイプを使用して書き込むこともできます。
不変の署名
署名は部分的であるため、既存の引数に引数を追加できますが、チェーン内の前のタスクの結果が必要ない場合など、常に必要な場合はありません。
その場合、署名を不変としてマークして、引数を変更できないようにすることができます。
これには
.si()
ショートカットもあり、これは署名を作成するための推奨される方法です。これで、代わりに独立したタスクのチェーンを作成できます。
単純なグループ
並行して実行するタスクのグループを簡単に作成できます。
シンプルなコード
コードプリミティブを使用すると、グループ内のすべてのタスクの実行が終了したときに呼び出されるコールバックを追加できます。 これは、驚異的並列ではないアルゴリズムで必要になることがよくあります。
上記の例では、すべてが並行して開始される10個のタスクを作成し、それらがすべて完了すると、戻り値がリストにまとめられ、
xsum
タスクに送信されます。コードの本体も不変である可能性があるため、グループの戻り値はコールバックに渡されません。
上記の
.si
の使用に注意してください。 これにより、不変の署名が作成されます。つまり、渡された新しい引数(前のタスクの戻り値を含む)はすべて無視されます。組み合わせてあなたの心を吹き飛ばします
チェーンも部分的である可能性があります。
これは、チェーンを組み合わせることができることを意味します。
グループを別のタスクとチェーンすると、自動的にコードにアップグレードされます。
グループとコードは部分的な引数も受け入れるため、チェーンでは、前のタスクの戻り値がグループ内のすべてのタスクに転送されます。
引数をグループに転送したくない場合は、グループ内の署名を不変にすることができます。
チェーン
バージョン3.0の新機能。
タスクは相互にリンクできます。リンクされたタスクは、タスクが正常に戻ったときに呼び出されます。
リンクされたタスクは、その親タスクの結果を最初の引数として適用されます。 結果が4である上記の場合、これはmul(4, 16)
になります。
結果は、元のタスクによって呼び出されたサブタスクを追跡します。これには、結果インスタンスからアクセスできます。
結果インスタンスには、結果をグラフとして扱うcollect()
メソッドもあり、結果を反復処理できます。
デフォルトでは、グラフが完全に形成されていない場合(タスクの1つがまだ完了していない場合)、collect()
は@IncompleteStream
例外を発生させますが、グラフの中間表現を取得することもできます。
必要な数のタスクをリンクでき、署名もリンクできます。
on_error メソッドを使用して、エラーコールバックを追加することもできます。
これにより、署名が適用されると、次の.apply_async
呼び出しが発生します。
ワーカーは実際にはerrbackをタスクとして呼び出すことはありませんが、代わりにerrback関数を直接呼び出して、生の要求、例外、およびトレースバックオブジェクトをタスクに渡すことができるようにします。
errbackの例を次に示します。
タスクをさらに簡単にリンクできるようにするために、chain
と呼ばれる特別な署名があります。これを使用するとタスクをチェーンできます。
チェーンを呼び出すと、現在のプロセスのタスクが呼び出され、チェーンの最後のタスクの結果が返されます。
また、parent
属性を設定して、チェーンを上っていき、中間結果を取得できるようにします。
チェーンは、|
(パイプ)演算子を使用して作成することもできます。
グラフ
さらに、結果グラフをDependencyGraph
として操作できます。
これらのグラフをドット形式に変換することもできます。
画像を作成します。
グループ
バージョン3.0の新機能。
グループを使用して、複数のタスクを並行して実行できます。
group
関数は、署名のリストを受け取ります。
グループを呼び出しすると、タスクは現在のプロセスで次々に適用され、結果を追跡したり、方法を教えたりするために使用できるGroupResult
インスタンスが返されます。多くのタスクの準備ができているなど:
グループはイテレータもサポートしています。
グループは署名オブジェクトであるため、他の署名と組み合わせて使用できます。
グループコールバックとエラー処理
グループにはコールバック署名とエラーバック署名をリンクさせることもできますが、グループは実際のタスクではなく、リンクされたタスクをカプセル化された署名に渡すだけなので、動作はやや意外な場合があります。 これは、グループの戻り値が収集されて、リンクされたコールバック署名に渡されないことを意味します。 例として、単純な add(a、b)タスクを使用する次のスニペットは、リンクされた add.s()署名が最終的なグループ結果を受け取らないため、障害があります。予想。
最初の2つのタスクの最終結果が返されますが、コールバックシグネチャはバックグラウンドで実行され、予期する2つの引数を受け取らなかったため、例外が発生することに注意してください。
グループのエラーバックはカプセル化されたシグニチャにも渡されます。これにより、グループ内の複数のタスクが失敗した場合に、一度だけリンクされたエラーバックが複数回呼び出される可能性があります。 例として、例外を発生させる fail()タスクを使用する次のスニペットは、グループで実行される失敗したタスクごとに1回 log_error()署名を呼び出すことが期待できます。 。
これを念頭に置いて、エラーバックとして使用するために繰り返し呼び出されることを許容するべき等またはカウントタスクを作成することをお勧めします。
これらのユースケースは、特定のバックエンド実装でサポートされているchord
クラスによってより適切に対処されます。
グループの結果
グループタスクも特別な結果を返します。この結果は、グループ全体で機能することを除いて、通常のタスク結果と同じように機能します。
GroupResult
は、AsyncResult
インスタンスのリストを取得し、単一のタスクであるかのようにそれらを操作します。
次の操作をサポートします。
successful()
すべてのサブタスクが正常に終了した場合(たとえば、例外が発生しなかった場合)、
True
を返します。failed()
サブタスクのいずれかが失敗した場合は、
True
を返します。waiting()
サブタスクのいずれかがまだ準備ができていない場合は、
True
を返します。ready()
すべてのサブタスクの準備ができたら、
True
を返します。completed_count()
完了したサブタスクの数を返します。
revoke()
すべてのサブタスクを取り消します。
join()
すべてのサブタスクの結果を収集し、呼び出されたのと同じ順序で(リストとして)返します。
和音
バージョン2.3の新機能。
ノート
コード内で使用されるタスクは、その結果を無視してはなりません ' 。 コード内の任意のタスク(ヘッダーまたは本文)で結果バックエンドが無効になっている場合は、「重要な注意事項」をお読みください。 コードは現在、RPC結果バックエンドではサポートされていません。
コードは、グループ内のすべてのタスクの実行が終了した後にのみ実行されるタスクです。
式の合計を計算してみましょう \(1 + 1 + 2 + 2 + 3 + 3..。 n + n \) 100桁まで。
まず、add()
とtsum()
の2つのタスクが必要です(sum()
はすでに標準機能です)。
これで、コードを使用して各加算ステップを並行して計算し、結果の数値の合計を取得できます。
これは明らかに非常に不自然な例です。メッセージングと同期のオーバーヘッドにより、Pythonの対応するものよりもはるかに遅くなります。
同期の手順にはコストがかかるため、コードの使用はできるだけ避けてください。 それでも、同期は多くの並列アルゴリズムに必要なステップであるため、コードはツールボックスに含めることができる強力なプリミティブです。
コード式を分解してみましょう:
コールバックは、ヘッダー内のすべてのタスクが返された後にのみ実行できることを忘れないでください。 ヘッダーの各ステップは、タスクとして並行して、場合によっては異なるノードで実行されます。 次に、ヘッダー内の各タスクの戻り値を使用してコールバックが適用されます。 chord()
によって返されるタスクIDはコールバックのIDであるため、コールバックが完了するのを待って最終的な戻り値を取得できます(ただし、タスクに他のタスクを待機させないでください )
エラー処理
では、タスクの1つで例外が発生した場合はどうなりますか?
コードコールバックの結果は失敗状態に移行し、エラーは@ChordError
例外に設定されます。
トレースバックは、使用された結果バックエンドによって異なる場合がありますが、エラーの説明には、失敗したタスクのIDと元の例外の文字列表現が含まれていることがわかります。 元のトレースバックはresult.traceback
にもあります。
残りのタスクは引き続き実行されるため、中間のタスクが失敗した場合でも、3番目のタスク(add.s(8, 8)
)は引き続き実行されることに注意してください。 また、@ChordError
は、最初に(時間内に)失敗したタスクのみを表示します。ヘッダーグループの順序は考慮されません。
したがって、コードが失敗したときにアクションを実行するには、コードコールバックにerrbackをアタッチできます。
コードには、コールバック署名とエラーバック署名がリンクされている場合があります。これにより、署名をグループにリンクする際の問題のいくつかに対処できます。 そうすることで、提供された署名がコードの本体にリンクされ、本体の完了時にコールバックが1回だけ正常に呼び出されるか、コードヘッダーまたは本体のタスクが失敗した場合にエラーバックが1回だけ呼び出されることが期待できます。
重要な注意事項
コード内で使用されるタスクは、その結果を無視してはなりません ' 。 実際には、これは、コードを使用するためにresult_backend
を有効にする必要があることを意味します。 また、設定でtask_ignore_result
がTrue
に設定されている場合は、コード内で使用する個々のタスクがignore_result=False
で定義されていることを確認してください。 これは、タスクサブクラスと装飾されたタスクの両方に適用されます。
タスクサブクラスの例:
装飾されたタスクの例:
デフォルトでは、同期ステップは、定期的なタスクがグループの完了を毎秒ポーリングし、準備ができたら署名を呼び出すことによって実装されます。
実装例:
これは、RedisとMemcachedを除くすべての結果バックエンドで使用されます。ヘッダー内の各タスクの後にカウンターをインクリメントし、カウンターがセット内のタスクの数を超えるとコールバックを適用します。
RedisとMemcachedのアプローチははるかに優れたソリューションですが、他のバックエンドに簡単に実装することはできません(提案を歓迎します!)。
ノート
コードは、バージョン2.2より前のRedisでは正しく機能しません。 それらを使用するには、少なくともredis-server2.2にアップグレードする必要があります。
ノート
Redis結果バックエンドでコードを使用していて、Task.after_return()
メソッドもオーバーライドしている場合は、必ずスーパーメソッドを呼び出す必要があります。そうしないと、コードコールバックが適用されません。
地図と星図
map
およびstarmap
は、シーケンス内のすべての要素に対して提供された呼び出しタスクを呼び出す組み込みタスクです。
group
とは次の点で異なります。
- 1つのタスクメッセージのみが送信されます。
- 操作は順次です。
たとえば、map
を使用します。
タスクを実行するのと同じです。
starmap
の使用:
タスクを実行するのと同じです。
map
とstarmap
はどちらも署名オブジェクトであるため、他の署名として使用したり、グループなどで組み合わせたりして、たとえば10秒後に星図を呼び出すことができます。
チャンク
チャンキングを使用すると、反復可能な作業を断片に分割できるため、100万個のオブジェクトがある場合、それぞれ10万個のオブジェクトで10個のタスクを作成できます。
タスクをチャンク化すると並列処理が低下することを心配する人もいるかもしれませんが、これがビジーなクラスターに当てはまることはめったにありません。実際には、メッセージングのオーバーヘッドを回避しているため、パフォーマンスが大幅に向上する可能性があります。
チャンク署名を作成するには、@Task.chunks()
を使用できます。
group
と同様に、チャンクのメッセージを送信する動作は、呼び出されたときに現在のプロセスで発生します。
.apply_async
を呼び出すと、専用のタスクが作成され、代わりに個々のタスクがワーカーに適用されます。
チャンクをグループに変換することもできます。
グループを使用すると、各タスクのカウントダウンが1ずつ増加します。
これは、最初のタスクのカウントダウンが1秒、2番目のタスクのカウントダウンが2秒というようになることを意味します。