Value sharing (From BaseApp)

[Geson-anko]

Value sharing

Regarding #101
Implementing value sharing methods such as setThreadSharedValues and etc...

Originally posted by @Geson-anko in #16 (comment)

[Geson-anko]

process/thread shared values (class attribute)

BaseAppにprocess_shared_values属性とthread_shared_values属性を追加します。
どちらもFolderDict_withLock #115 で propertyであり、@-_shared_values.setterによるsetterを持ちます。

• process_shared_values
  初期値はNoneです。 実際には_process_shared_values属性に値を格納しています。
  setterが呼ばれた際にはそのアプリの子アプリーケーションにも値をセットします。
  multiprocessingモジュールによる並列処理の開始後に呼び出してはいけません。

• thread_shared_values
  基本的に process_shared_valuesと同じですが、setterが呼ばれた際は、自分とthreadで起動する子アプリだけにセットします。
  process_shared_valuesとは対照的に、multiprocessingモジュールによる並列処理の開始後にのみ呼び出し可能です。

[Geson-anko]

SharedValueHolder

値を共有する際のフォーマットを統一できます。必ずname属性が付くのでaddProcessSharedValuesメソッド等を実装する際にエラーチェックが便利です。ただし、冗長です。

@dataclasss
class SharedValueHolder:
    name:str
    obj: Any

[Geson-anko]

SharedValueHolder

値を共有する際のフォーマットを統一できます。必ずname属性が付くのでaddProcessSharedValuesメソッド等を実装する際にエラーチェックが便利です。ただし、冗長です。

@dataclasss
class SharedValueHolder:
    name:str
    obj: Any

実装しません。

[Geson-anko]

Register Process/Thread Shared Values

Override method.
Register values for sharing inter multiprocessing or threading.

[Geson-anko]

get Shared Values (Process/Thread)

process_shared_valuesやthread_shared_valuesに格納された共有値を、名前を指定して取得します。
取得方法はファイルパスのようにになっている事を念頭においてください。

Method

名前を指定して取得します。アプリケーションの木構造をもとにドット.区切りのファイルパスのようにオブジェクトは保持されています。規則はパスのようになっています。

• 絶対パス
  名前の先頭にドット.がない場合、ルートアプリケーションから値を検索し、値を取得します。
• 相対パス
  名前の先頭に.がある場合、その数だけ自分の相対位置から階層を遡って検索し、値を取得します。

Example

以下のようにアプリケーション全体が構成され、値が共有されているとします。

MAIN
|- App0
|- App1
    |- App1_1
    |- App1_2

[
    "shutdown" = ReadOnlyValue,
    "MAIN.lock" = Lock,
    "MAIN.App0.int_value" = 10,
    "MAIN.App1.str_value" = "apple",
    "MAIN.App1.App1_1.bool_value" = True,
    "MAIN.App1.App1_2.float_value" = 1.0,
]

このとき、MAINアプリケーションにおけるgetSharedValueの振る舞いは次のようになります。

MAIN.getSharedValue("shutdown") -> ReadOnlyValue
MAIN.getSharedValue(".lock") -> Lock
MAIN.getSharedValue("..shutdown") -> ReadOnlyValue
MAIN.getSharedValue(".App0.int_value") -> 10

また、MAIN.App1.App1_1においても以下のようになります。

App1_1.getSharedValue(".bool_value") -> True
App1_1.getSharedValue("MAIN.lock") -> Lock
App1_1.getSharedValue("..str_value") -> "apple"
App1_1.getSharedValue("..App1_2.float_value") -> 1.0