Python WebインターフェースでのKA（FSM）の経験

はじめに

最近、1つのプログラムにWebインターフェイスを添付する必要がありました。
より正確には、Webインターフェイスはすでに存在していませんでしたが、一方向にしか機能せず、プログラムコアの結果を提供していました。 そして、双方向性を導入する必要がありました。

元の形式のプログラムは、XMLファイルで記述されたスキームの特定のブロックの表現をグラフィカル表現に変換しました。 このプログラムのコアはXMLファイルを読み取り、これらのファイルに記述されているブロック図ブロックをオブジェクトに表示し、これらのオブジェクトから画像を描画してブラウザーで表示しました。

新しい要件に従って、インタラクティブな編集を追加する必要がありました。 そしてこれは、リンク、フォームを追加し、エラーを処理し、それらに関するメッセージを発行し、フォームに入力されたデータを確認し、履歴を移動できるようにするブラウザーボタンを考慮する必要があることを意味します。 そして最も重要なことは、これらすべてを混同しないでください。

フローチャートを描く複雑なプログラムの習慣があります。 プログラムの位置を特定できる状態、プログラムが応答するイベント（ボタンを押すなど）、およびある状態から別の状態への遷移が表現されているモードで動作するプログラムの場合、有限状態マシンまたは宇宙船の概念は理想的です;海外では、これはFSMまたはFinitステートマシン。 かつてDOSの下でも、SC状態図の図を描いたときだけ、1つの洗練されたプログラムのメニューがわかりました。

宇宙船（ステートマシン）とは

それが何であるかを知っている人は、このセクションを安全にスキップできます。

KA、これはオートマトンの操作の記述に対するそのようなアプローチです。 それは、図に描かれた状態を、内側に碑文が描かれた円の形で示し、遷移は円の状態を結ぶ矢印の形で描かれます。 矢印は、同じ状態に戻るのと同じトリックを実行できます。 通常、矢印にも名称があります。

実際、宇宙船の仕事は、ある状態から別の状態への移行で構成されています。

この場合、宇宙船アプローチのアプリケーションは何を提供できますか？

この場合、これはWebインターフェースの操作を説明するためのものです

-読みやすいインターフェース状態図を描くことができます。
-この図で整理されたコードを書くことができます。
-コードからチャートへ、またはその逆に簡単に移動できます。
-状態とアクションを理解/追加/削除しやすい。
-インターフェイスのすべての遷移を比較的簡単にカバーできるため、テストが簡単になります。
-状態テーブルを簡単に作成できるため、テストが簡単になります。

水曜日

このソフトウェアの開発時には、次のソフトウェアが使用されました。
言語：Python 2.5.4
Webサーバー：Cherrypy 3.1.1

コードの実装と操作

KAコード編成

cherrypyがWebサーバーとして使用されたという事実により、コードの編成に関するいくつかの要件が決まりました。

コードは次のように編成されました。Webインターフェース全体がHomePageクラスに実装されています。
WebインターフェイスとKA、index（）メソッドの両方の節点

KAはHomePageクラスにも実装されています。 宇宙船のコードは3つの部分に分けることができます。

1. index（）メソッドのコード。 ブラウザから「tostate」パラメータを受け取り、制御メソッドを呼び出して、宇宙船の制御ループを実装します。

2.宇宙船の制御方法。 fsm_transition（self、to_state）、fsm_process_methods（self、fsm_data）

3. KAデータディクショナリ（self.fsm_trans）。

4.宇宙船のインターフェースメソッド。 これらは、宇宙船のある状態から別の状態への移行時に呼び出され、これらの移行中に必要な特定のアクションを実行するメソッドです。

KAデータ辞書

宇宙船データディクショナリを使用して、コード操作の説明を開始することをお勧めします。 ここにあります：

 self.fsm_trans = {
     ＃1
     'init_logo'：{'type'： 'Show'、 'methods'：[self.fsm_logo_show]}、
     ＃2
     「logo_logo」：{「タイプ」：「表示」、「メソッド」：[self.fsm_logo_show]}、
 .......
     ＃6
     「pg1_prj_select_page」：{「タイプ」：「表示」、「メソッド」：[self.fsm_project_set_dir、
                                                 self.fsm_diag_files_rm、
                                                 self.fsm_project_page_algor_start、
                                                 self.fsm_set_cur_page_algor_first_page、
                                                 self.fsm_set_cur_block_first_block_of_page、
                                                 self.fsm_create_cur_page_diag_files、
                                                 self.fsm_page_show]}、
 .....

     ＃29
     'f3_pg_block_edit_check_pg_block_edit'：{'type'： 'Act'、 'methods'：
                                                [self.fsm_pg_block_edit、
                                                  self.fsm_diag_files_rm、
                                                  self.fsm_create_cur_page_diag_files、
                                                  self.fsm_page_cur_save、
                                                  self.fsm_go_to_page]}、
 .....

辞書キー これは、元の状態と次の状態の2つの状態の名前で構成される文字列です。 初期状態は、スペースクラフトによってself.fsm_prev_state変数に記憶され、次はブラウザのリクエストパラメータから取得されます。 たとえば、「＃1」で示される遷移の場合、初期状態は「init」、次は「logo」、キーは「init」+「_」+「logo」として取得されます

ここでもキーは辞書です。 「タイプ」と「メソッド」の2つのキーがあります。

キー「タイプ」は、次の状態のタイプを示します。 「表示」と「実行」の2つの状態タイプがあります。 タイプ「表示」は、これが生成されたHTMLページの表示状態であり、ブラウザからの次のリクエストを待っていることを意味します。 タイプ「Act」は、この状態を停止する必要がないことを意味します。 次の状態に進む必要があります。

宇宙船のメソッドのインターフェース名の配列は、「methods」キーによって見つけられます。 実際、これは、ある状態から別の状態への移行中に実行する必要がある一連の有用なアクションです。 さらに、タイプ 'Show'の場合、配列の最後のメソッドは生成されたHTMLページを返し、タイプ 'Act'の場合-目的の状態の名前を返します。

index（）メソッドのCAコード

 1 @ cherrypy.expose
 2 defインデックス（self、block = ''、tostate = ''、page = ''、project = ''、** data）：
     .......
 3試行：
 4＃FSMは次の状態に進む
 5 fsm_data = self.fsm_transition（self.http_param ['tostate']）
 6＃「tostate」パラメーターがこの状態に対して有効でない場合
 KeyError、error_detailを除く7：
 8 return self.fsm_error_show（ 'KeyError：' + str（error_detail））
 9 processing_result = self.fsm_process_methods（fsm_data）
 10がTrueの場合：
 11＃タイプが 'Show'の場合、HTMLページを返す 
 12 fsm_data ['type'] == 'Show'の場合：
 13 return processing_result
 14＃タイプが「Act」の場合、FSMは次の状態に
 15＃状態の名前はprocessing_resultにあります
 16 fsm_data ['type'] == 'Act'の場合：
 17 fsm_data = self.fsm_transition（processing_result）
 18 processing_result = self.fsm_process_methods（fsm_data）
   

このメソッドは、リクエストから「tostate」パラメーターを取得します。 その後、5行目のself.fsm_transition（）メソッドは、状態タイプ（Show | ACt）と実行用のメソッドの配列を含むデータディクショナリからディクショナリを返します。

キーエラーの場合、すなわち この状態から目的の状態に切り替えることはできませんが、例外として、SCは「エラー」状態に切り替わります。 たとえば、ブラウザが履歴に沿っていくつかのステップを返され、任意のリンクをクリックした場合、重要なエラーが発生する可能性があります。 この場合、
HTMLブラウザーによって表示されるページは宇宙船の状態に対応しておらず、リクエストには現在の状態からの遷移が存在すべきでない状態への遷移が必要な場合があります。

9行目では、self.fsm_process_methods（fsm_data）メソッドは遷移メソッドの配列を処理し、最後のメソッドがメソッド配列から返した値を返します。 「Show」タイプの場合、これはページのHTMLコードであり、「index」メソッドはそれを返し、サーバーはそれをブラウザーに渡します。
タイプが「Act」の場合、これは次の状態の名前です。17行目で宇宙船を次の状態に変換し、18行目で遷移メソッドを処理します。

宇宙船の制御方法

 ＃FSMメソッド
 def fsm_transition（self、to_state）：
     「」
     FSMの状態を状態に変更します
    決定事項を提供する
    引数：
     to_state-移動先の州
    戻り値：
     「」
     ＃古い状態を記憶する
     self.fsm_prev_state = self.fsm_state
     self.fsm_state = to_state
     ＃辞書から戻り値を取得
    キー= str（self.fsm_prev_state）+ '_' + str（self.fsm_state）
     self.fsm_return = self.fsm_trans [キー]
     self.fsm_returnを返す

 def fsm_process_methods（self、fsm_data）：
     「」
     fsm_data辞書を取得し、関数を処理し、
     htmalまたは次の状態を返す
    引数：
     fsm_data-self.fsm_transition（）の戻り値から取得した辞書
     self.fsm_trans辞書から取得されます
    戻り値：
    ケース 'タイプ'のhtmlテキスト： '表示'
    ケース 'type'の次の状態の名前： 'Act'
     「」
     last_func = len（fsm_data ['methods']）
     i = 0
     fsm_data ['methods']のメソッドの場合：
         i + = 1
         i == last_funcの場合：
             return method（）＃最後の関数は戻り値を返す
        メソッド（）

ここでは、すべてが些細なことだと思います。

インターフェイスメソッドの処理方法の選択について

メソッドを配列に格納する特別な理由はありません。 遷移ごとに、ネストされたインターフェイスメソッドが呼び出される独自のメソッドを持つことは完全に可能です。

上記の処理方法は、コードを読みやすくするために、インターフェイス関数へのすべての呼び出しを1つの場所で同じネストレベルにするために、意図的に選択されました。 実装されたコードでは、宇宙船の印刷されたチャートを取得し、宇宙船のデータディクショナリのコードを使用して、1つからの遷移に対して実行されるアクションのチェーンを確認できます。
別の状態。

おわりに

設計に宇宙船を使用したアプローチを適用することで、柔軟で読みやすく、透明で簡単にサポートできるコードを書くことができたと思います。

付録：宇宙船図の例（実際の図の断片）