各種プラグインのコードスタイル

カスタムコードは、Pythonで記述します。基本的には、コーディング規約として、PEP8準拠を推奨しています。
Qmonus SDKのデフォルト環境には、autopep8モジュールがインストールされています。また組込みオブジェクトとしてPluginFormatterを提供しています。

組込みオブジェクトPluginFormatterは、各種プラグインを指定したオプションに従ってPEP8準拠のコードスタイルに変換します。
変換対象となるプラグインは、Scenario、Daemon、Job、Module、Function、LambdaFunction、CollectionHook、Reflection、Worker、Faker、Testcaseです。

項目


All

全てのプラグインのコードスタイルを変換する

await PluginFormatter.runall()


Scenario

全てのScenarioプラグインのコードスタイルを変換する

await PluginFormatter().ScenarioFormatter.runall()


特定のScenarioプラグインのコードスタイルを変換する

await PluginFormatter().ScenarioFormatter.run(<シナリオ名>)


Daemon

全てのDaemonプラグインのコードスタイルを変換する

await PluginFormatter().DaemonFormatter.runall()


特定のDaemonプラグインのコードスタイルを変換する

await PluginFormatter().DaemonFormatter.run(<デーモン名>)


ATOM

全てのATOMプラグインのコードスタイルを変換する

await PluginFormatter().ClassFormatter.runall()


特定のATOMプラグインのコードスタイルを変換する

await PluginFormatter().ClassFormatter.run(<クラス名>)


Module

全てのModuleプラグインのコードスタイルを変換する

await PluginFormatter().ModuleFormatter.runall()


特定のModuleプラグインのコードスタイルを変換する

await PluginFormatter().ModuleFormatter.run(<モジュール名>)


Function

全てのFunctionプラグインのコードスタイルを変換する

await PluginFormatter().FunctionFormatter.runall()


特定のFunctionプラグインのコードスタイルを変換する

await PluginFormatter().FunctionFormatter.run(<ファンクション名>)


LambdaFunction

全てのLambdaFunctionプラグインのコードスタイルを変換する

await PluginFormatter().LambdaFunctionFormatter.runall()


特定のLambdaFunctionプラグインのコードスタイルを変換する

await PluginFormatter().LambdaFunctionFormatter.run(<Lambdaファンクション名>)


CollectionHook

全てのCollectionHookプラグインのコードスタイルを変換する

await PluginFormatter().CollectionHookFormatter.runall()


特定のCollectionHookプラグインのコードスタイルを変換する

await PluginFormatter().CollectionHookFormatter.runall(<Collectionフック名>)


Reflection

全てのReflectionプラグインのコードスタイルを変換する

await PluginFormatter().ReflectionFormatter.runall()


特定のReflectionプラグインのコードスタイルを変換する

await PluginFormatter().ReflectionFormatter.run(<Reflection名>)


Worker

全てのWorkerプラグインのコードスタイルを変換する

await PluginFormatter().WorkerFormatter.runall()


特定のWorkerプラグインのコードスタイルを変換する

await PluginFormatter().WorkerFormatter.run(<Worker名>)


Faker

全てのFakerプラグインのコードスタイルを変換する

await PluginFormatter().FakerFormatter.runall()


特定のFakerプラグインのコードスタイルを変換する

await PluginFormatter().FakerFormatter.run(<Faker名>)


Testcase

全てのTestcaseプラグインのコードスタイルを変換する

await PluginFormatter().TestcaseFormatter.runall()


特定のTestcaseプラグインのコードスタイルを変換する

await PluginFormatter().TestcaseFormatter.run(<Testcase名>)


Tip

各種runall、runメソッドには、キーワード引数が指定できます。これらはautopep8.fix_codeの呼び出し時にoptionsに渡されます。
await PluginFormatter.runall(aggressive=2, ignore=["E402"])
上記のようにPEP8のオプションを指定することができます。
v22.2LTS以降のversionでは、カスタム設定ファイルを起動パラメータ(--code_style)で指定できます。