Merge pull request #16 from Kitware/add-translator-support

feat(translator): template patching via translator

examples/test/print.py

@@ -2,7 +2,7 @@
 from trame.ui.html import DivLayout
 from trame.widgets import html
 
-server = get_server()
+server = get_server(client_type="vue3")
 
 # Test to dynamically add a fake directive
 html.Div.register_directive("v_seb_directive")

examples/test/reactivity.py

@@ -1,7 +1,7 @@
 from trame.app import get_server
 from trame_client.utils.testing import enable_testing
 
-server = get_server()
+server = get_server(client_type="vue3")
 server.state.count = 1
 server.state.trame__template_main = """
     <div>

examples/vue2/client_components.py

@@ -2,8 +2,7 @@
 from trame.widgets import html, client
 from trame.ui.html import DivLayout
 
-server = get_server()
-server.client_type = "vue2"
+server = get_server(client_type="vue2")
 state, ctrl = server.state, server.controller
 
 dyna_var_count = 1

examples/vue2/core_reactive_state.py

@@ -1,7 +1,6 @@
 from trame.app import get_server
 
-server = get_server()
-server.client_type = "vue2"  # default until trame>=3.x
+server = get_server(client_type="vue2")
 state, ctrl = server.state, server.controller
 
 state.count = 2

examples/vue2/dynamic_template.py

@@ -3,8 +3,7 @@
 from trame.ui.html import DivLayout
 from trame_client.utils.testing import enable_testing
 
-server = enable_testing(get_server(), "count")
-server.client_type = "vue2"
+server = enable_testing(get_server(client_type="vue2"), "count")
 state, ctrl = server.state, server.controller
 
 state.count = 1

examples/vue2/getter.py

@@ -6,8 +6,7 @@
 # Trame setup
 # -----------------------------------------------------------------------------
 
-server = get_server()
-server.client_type = "vue2"
+server = get_server(client_type="vue2")
 state, ctrl = server.state, server.controller
 
 state.message_1 = "Hello 1"

examples/vue2/js_call.py

@@ -3,8 +3,7 @@
 from trame.ui.html import DivLayout
 from trame_client.utils.testing import enable_testing
 
-server = enable_testing(get_server(), "message")
-server.client_type = "vue2"
+server = enable_testing(get_server(client_type="vue2"), "message")
 state, ctrl = server.state, server.controller
 
 

examples/vue2/life_cycle.py

@@ -1,7 +1,6 @@
 from trame.app import get_server
 
-server = get_server()
-server.client_type = "vue2"
+server = get_server(client_type="vue2")
 ctrl = server.controller
 server.state.trame__template_main = "Life Cycle App"
 

examples/vue2/namespace_nested.py

@@ -0,0 +1,31 @@
+from trame.app import get_server
+
+import sys
+import os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../../tests"))
+from test_translator import NestedApp  # noqa: E402
+
+CLIENT_TYPE = "vue2"
+ISOLATED = False
+
+
+def main():
+    root_server = get_server(client_type=CLIENT_TYPE)
+
+    root_app = NestedApp(root_server, client_type=CLIENT_TYPE)
+
+    if not ISOLATED:
+        root_app.child_a_app.server.translator.add_translation("f", "common_f")
+        root_app.child_b_app.server.translator.add_translation("f", "common_f")
+
+    root_app.ui
+
+    root_server.controller.on_server_ready.add(
+        lambda **kwargs: print("Root server ready")
+    )
+    root_app.server.start()
+
+
+if __name__ == "__main__":
+    main()

examples/vue2/namespace_prefix.py

@@ -0,0 +1,34 @@
+from trame.app import get_server
+
+import sys
+import os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../../tests"))
+from test_translator import BasicApp  # noqa: E402
+
+CLIENT_TYPE = "vue2"
+
+
+def main():
+    root_server = get_server(client_type=CLIENT_TYPE)
+    one_of_the_app = None
+    for app_name in ["main", "a", "b", "c"]:
+        child_server = root_server.create_child_server(prefix=f"{app_name}_")
+        app = BasicApp(child_server, app_name, CLIENT_TYPE)
+        app.ui
+        app.add()
+        app.ctrl.plus()
+        one_of_the_app = app
+
+    # root_server.controller.on_server_ready.add(lambda **kwargs: print(json.dumps(root_server.state.to_dict(), indent=2)))
+    root_server.controller.on_server_ready.add(
+        lambda **kwargs: print("Root server ready")
+    )
+    one_of_the_app.server.controller.on_server_ready.add(
+        lambda **kwargs: print("Sub server ready")
+    )
+    one_of_the_app.server.start()
+
+
+if __name__ == "__main__":
+    main()

examples/vue3/client_components.py

@@ -2,8 +2,7 @@
 from trame.widgets import html, client
 from trame.ui.html import DivLayout
 
-server = get_server()
-server.client_type = "vue3"
+server = get_server(client_type="vue3")
 state, ctrl = server.state, server.controller
 
 dyna_var_count = 1

examples/vue3/core_reactive_state.py

@@ -1,7 +1,6 @@
 from trame.app import get_server
 
-server = get_server()
-server.client_type = "vue3"
+server = get_server(client_type="vue3")
 state, ctrl = server.state, server.controller
 
 state.count = 2

examples/vue3/dynamic_template.py

@@ -3,8 +3,7 @@
 from trame.ui.html import DivLayout
 from trame_client.utils.testing import enable_testing
 
-server = get_server()
-server.client_type = "vue3"
+server = get_server(client_type="vue3")
 state, ctrl = server.state, server.controller
 
 state.count = 1

examples/vue3/getter.py

@@ -6,8 +6,7 @@
 # Trame setup
 # -----------------------------------------------------------------------------
 
-server = get_server()
-server.client_type = "vue3"
+server = get_server(client_type="vue3")
 state, ctrl = server.state, server.controller
 
 state.message_1 = "Hello 1"

examples/vue3/js_call.py

@@ -3,8 +3,7 @@
 from trame.ui.html import DivLayout
 from trame_client.utils.testing import enable_testing
 
-server = enable_testing(get_server(), "message")
-server.client_type = "vue3"
+server = enable_testing(get_server(client_type="vue3"), "message")
 state, ctrl = server.state, server.controller
 
 

examples/vue3/life_cycle.py

@@ -1,7 +1,6 @@
 from trame.app import get_server
 
-server = get_server()
-server.client_type = "vue3"
+server = get_server(client_type="vue3")
 ctrl = server.controller
 server.state.trame__template_main = "Life Cycle App"
 

examples/vue3/namespace_nested.py

@@ -0,0 +1,31 @@
+from trame.app import get_server
+
+import sys
+import os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../../tests"))
+from test_translator import NestedApp  # noqa: E402
+
+CLIENT_TYPE = "vue3"
+ISOLATED = False
+
+
+def main():
+    root_server = get_server(client_type=CLIENT_TYPE)
+
+    root_app = NestedApp(root_server, client_type=CLIENT_TYPE)
+
+    if not ISOLATED:
+        root_app.child_a_app.server.translator.add_translation("f", "common_f")
+        root_app.child_b_app.server.translator.add_translation("f", "common_f")
+
+    root_app.ui
+
+    root_server.controller.on_server_ready.add(
+        lambda **kwargs: print("Root server ready")
+    )
+    root_app.server.start()
+
+
+if __name__ == "__main__":
+    main()

examples/vue3/namespace_prefix.py

@@ -0,0 +1,34 @@
+from trame.app import get_server
+
+import sys
+import os
+
+sys.path.insert(0, os.path.join(os.path.dirname(__file__), "../../tests"))
+from test_translator import BasicApp  # noqa: E402
+
+CLIENT_TYPE = "vue3"
+
+
+def main():
+    root_server = get_server(client_type=CLIENT_TYPE)
+    one_of_the_app = None
+    for app_name in ["main", "a", "b", "c"]:
+        child_server = root_server.create_child_server(prefix=f"{app_name}_")
+        app = BasicApp(child_server, app_name, CLIENT_TYPE)
+        app.ui
+        app.add()
+        app.ctrl.plus()
+        one_of_the_app = app
+
+    # root_server.controller.on_server_ready.add(lambda **kwargs: print(json.dumps(root_server.state.to_dict(), indent=2)))
+    root_server.controller.on_server_ready.add(
+        lambda **kwargs: print("Root server ready")
+    )
+    one_of_the_app.server.controller.on_server_ready.add(
+        lambda **kwargs: print("Sub server ready")
+    )
+    one_of_the_app.server.start()
+
+
+if __name__ == "__main__":
+    main()

tests/requirements.txt

@@ -3,4 +3,5 @@ seleniumbase
 pixelmatch
 Pillow
 pytest-xprocess
-trame
+trame
+trame-server>=2.13.1