nova-trame 0.13.1__py3-none-any.whl → 0.14.1__py3-none-any.whl

nova/trame/view/components/input_field.py

@@ -1,6 +1,7 @@
 """View Implementation for InputField."""
 
 import logging
+import os
 import re
 from typing import Any, Dict, Optional, Union
 
@@ -20,7 +21,14 @@ class InputField:
     """Factory class for generating Vuetify input components."""
 
     @staticmethod
-    def create_boilerplate_properties(v_model: Optional[Union[tuple[str, Any], str]]) -> dict:
+    def create_boilerplate_properties(
+        v_model: Optional[Union[tuple[str, Any], str]], debounce: int, throttle: int
+    ) -> dict:
+        if debounce == -1:
+            debounce = int(os.environ.get("NOVA_TRAME_DEFAULT_DEBOUNCE", 0))
+        if throttle == -1:
+            throttle = int(os.environ.get("NOVA_TRAME_DEFAULT_THROTTLE", 0))
+
         if not v_model:
             return {}
         if isinstance(v_model, tuple):
@@ -55,22 +63,45 @@ class InputField:
 
         args: Dict[str, Any] = {}
         if v_model:
-            args |= {
-                "v_model": v_model,
-                "label": label,
-                "help": help_dict,
-                "update_modelValue": f"flushState('{object_name_in_state}')",
-            }
+            args |= {"v_model": v_model, "label": label, "help": help_dict}
             if field_info:
                 args |= {
                     "rules": (f"[(v) => trigger('validate_pydantic_field', ['{field}', v, index])]",),
                 }
+
+            if debounce > 0 and throttle > 0:
+                raise ValueError("debounce and throttle cannot be used together")
+
+            if debounce > 0:
+                args |= {
+                    "update_modelValue": (
+                        "window.delay_manager.debounce("
+                        f"  '{v_model}',"
+                        f"  () => flushState('{object_name_in_state}'),"
+                        f"  {debounce}"
+                        ")"
+                    )
+                }
+            elif throttle > 0:
+                args |= {
+                    "update_modelValue": (
+                        "window.delay_manager.throttle("
+                        f"  '{v_model}',"
+                        f"  () => flushState('{object_name_in_state}'),"
+                        f"  {throttle}"
+                        ")"
+                    )
+                }
+            else:
+                args |= {"update_modelValue": f"flushState('{object_name_in_state}')"}
         return args
 
     def __new__(
         cls,
         v_model: Optional[Union[tuple[str, Any], str]] = None,
         required: bool = False,
+        debounce: int = -1,
+        throttle: int = -1,
         type: str = "text",
         **kwargs: Any,
     ) -> AbstractElement:
@@ -84,6 +115,16 @@ class InputField:
         required : bool
             If true, the input will be visually marked as required and a required rule will be added to the end of the
             rules list.
+        debounce : int
+            Number of milliseconds to wait after the last user interaction with this field before attempting to update
+            the Trame state. If set to 0, then no debouncing will occur. If set to -1, then the environment variable
+            `NOVA_TRAME_DEFAULT_DEBOUNCE` will be used to set this (defaults to 0). See the `Lodash Docs
+            <https://lodash.com/docs/4.17.15#debounce>`_ for details.
+        throttle : int
+            Number of milliseconds to wait between updates to the Trame state when the user is interacting with this
+            field. If set to 0, then no throttling will occur. If set to -1, then the environment variable
+            `NOVA_TRAME_DEFAULT_THROTTLE` will be used to set this (defaults to 0). See the `Lodash Docs
+            <https://lodash.com/docs/4.17.15#throttle>`_ for details.
         type : str
             The type of input to create. This can be any of the following:
 
@@ -120,7 +161,7 @@ class InputField:
         """
         server = get_server(None, client_type="vue3")
 
-        kwargs = {**cls.create_boilerplate_properties(v_model), **kwargs}
+        kwargs = {**cls.create_boilerplate_properties(v_model, debounce, throttle), **kwargs}
 
         if "__events" not in kwargs or kwargs["__events"] is None:
             kwargs["__events"] = []
@@ -235,8 +276,8 @@ class InputField:
     def _setup_help(_input: AbstractElement, **kwargs: Any) -> None:
         help = kwargs.get("help", None)
         if help and isinstance(help, dict):
-            _input.hint = help.get("hint", None)
             _input.placeholder = help.get("placeholder", None)
+            _input.title = help.get("hint", None)
 
     @staticmethod
     def _setup_required_label(input: AbstractElement) -> None:

nova/trame/view/theme/assets/js/delay_manager.js

@@ -0,0 +1,24 @@
+class DelayManager {
+    constructor() {
+        this.debounces = {}
+        this.throttles = {}
+    }
+
+    debounce(id, func, wait) {
+        if (!(id in this.debounces)) {
+            this.debounces[id] = window.debounce(func, wait)
+        }
+
+        this.debounces[id]()
+    }
+
+    throttle(id, func, wait) {
+        if (!(id in this.throttles)) {
+            this.throttles[id] = window.throttle(func, wait)
+        }
+
+        this.throttles[id]()
+    }
+}
+
+window.delay_manager = new DelayManager()

nova/trame/view/theme/assets/js/lodash.debounce.min.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+ *
+ * Based on Underscore.js, copyright Jeremy Ashkenas,
+ * DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals. For exact contribution history, see the revision history
+ * available at https://github.com/lodash/lodash
+ *
+ * The following license applies to all parts of this software except as
+ * documented below:
+ *
+ * ====
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * ====
+ *
+ * Copyright and related rights for sample code are waived via CC0. Sample
+ * code is defined as all source code displayed within the prose of the
+ * documentation.
+ *
+ * CC0: http://creativecommons.org/publicdomain/zero/1.0/
+ *
+ * ====
+ *
+ * Files located in the node_modules and vendor directories are externally
+ * maintained libraries used by this software which have their own
+ * licenses; we recommend you read them, as their terms may differ from the
+ * terms above.
+ */
+
+/**
+ * Minified by jsDelivr using UglifyJS v3.1.10.
+ * Original file: /npm/lodash.debounce@4.0.8/index.js
+ *
+ * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files
+ */
+function debounce(e,t,r){function o(t){var r=f,o=c;return f=c=void 0,m=t,b=e.apply(o,r)}function n(e){var r=e-v;return void 0===v||r>=t||r<0||y&&e-m>=l}function i(){var e=now();if(n(e))return u(e);s=setTimeout(i,function(e){var r=t-(e-v);return y?nativeMin(r,l-(e-m)):r}(e))}function u(e){return s=void 0,p&&f?o(e):(f=c=void 0,b)}function a(){var e=now(),r=n(e);if(f=arguments,c=this,v=e,r){if(void 0===s)return function(e){return m=e,s=setTimeout(i,t),j?o(e):b}(v);if(y)return s=setTimeout(i,t),o(v)}return void 0===s&&(s=setTimeout(i,t)),b}var f,c,l,b,s,v,m=0,j=!1,y=!1,p=!0;if("function"!=typeof e)throw new TypeError(FUNC_ERROR_TEXT);return t=toNumber(t)||0,isObject(r)&&(j=!!r.leading,l=(y="maxWait"in r)?nativeMax(toNumber(r.maxWait)||0,t):l,p="trailing"in r?!!r.trailing:p),a.cancel=function(){void 0!==s&&clearTimeout(s),m=0,f=v=c=s=void 0},a.flush=function(){return void 0===s?b:u(now())},a}function isObject(e){var t=typeof e;return!!e&&("object"==t||"function"==t)}function isObjectLike(e){return!!e&&"object"==typeof e}function isSymbol(e){return"symbol"==typeof e||isObjectLike(e)&&objectToString.call(e)==symbolTag}function toNumber(e){if("number"==typeof e)return e;if(isSymbol(e))return NAN;if(isObject(e)){var t="function"==typeof e.valueOf?e.valueOf():e;e=isObject(t)?t+"":t}if("string"!=typeof e)return 0===e?e:+e;e=e.replace(reTrim,"");var r=reIsBinary.test(e);return r||reIsOctal.test(e)?freeParseInt(e.slice(2),r?2:8):reIsBadHex.test(e)?NAN:+e}var FUNC_ERROR_TEXT="Expected a function",NAN=NaN,symbolTag="[object Symbol]",reTrim=/^\s+|\s+$/g,reIsBadHex=/^[-+]0x[0-9a-f]+$/i,reIsBinary=/^0b[01]+$/i,reIsOctal=/^0o[0-7]+$/i,freeParseInt=parseInt,freeGlobal="object"==typeof global&&global&&global.Object===Object&&global,freeSelf="object"==typeof self&&self&&self.Object===Object&&self,root=freeGlobal||freeSelf||Function("return this")(),objectProto=Object.prototype,objectToString=objectProto.toString,nativeMax=Math.max,nativeMin=Math.min,now=function(){return root.Date.now()};window.debounce=debounce;
+//# sourceMappingURL=/sm/a79a09ba42f2fc9121b50e9acc14e4678d879dc4f045b63230ef13e933e74f71.map

nova/trame/view/theme/assets/js/lodash.throttle.min.js

@@ -0,0 +1,58 @@
+/**
+ * Copyright OpenJS Foundation and other contributors <https://openjsf.org/>
+ *
+ * Based on Underscore.js, copyright Jeremy Ashkenas,
+ * DocumentCloud and Investigative Reporters & Editors <http://underscorejs.org/>
+ *
+ * This software consists of voluntary contributions made by many
+ * individuals. For exact contribution history, see the revision history
+ * available at https://github.com/lodash/lodash
+ *
+ * The following license applies to all parts of this software except as
+ * documented below:
+ *
+ * ====
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * ====
+ *
+ * Copyright and related rights for sample code are waived via CC0. Sample
+ * code is defined as all source code displayed within the prose of the
+ * documentation.
+ *
+ * CC0: http://creativecommons.org/publicdomain/zero/1.0/
+ *
+ * ====
+ *
+ * Files located in the node_modules and vendor directories are externally
+ * maintained libraries used by this software which have their own
+ * licenses; we recommend you read them, as their terms may differ from the
+ * terms above.
+ */
+
+/**
+ * Minified by jsDelivr using Terser v5.19.2.
+ * Original file: /npm/lodash.throttle@4.1.1/index.js
+ *
+ * Do NOT use SRI with dynamically generated files! More information: https://www.jsdelivr.com/using-sri-with-dynamic-files
+ */
+var FUNC_ERROR_TEXT="Expected a function",NAN=NaN,symbolTag="[object Symbol]",reTrim=/^\s+|\s+$/g,reIsBadHex=/^[-+]0x[0-9a-f]+$/i,reIsBinary=/^0b[01]+$/i,reIsOctal=/^0o[0-7]+$/i,freeParseInt=parseInt,freeGlobal="object"==typeof global&&global&&global.Object===Object&&global,freeSelf="object"==typeof self&&self&&self.Object===Object&&self,root=freeGlobal||freeSelf||Function("return this")(),objectProto=Object.prototype,objectToString=objectProto.toString,nativeMax=Math.max,nativeMin=Math.min,now=function(){return root.Date.now()};function debounce(t,e,n){var r,i,o,a,u,f,c=0,l=!1,b=!1,s=!0;if("function"!=typeof t)throw new TypeError(FUNC_ERROR_TEXT);function v(e){var n=r,o=i;return r=i=void 0,c=e,a=t.apply(o,n)}function m(t){var n=t-f;return void 0===f||n>=e||n<0||b&&t-c>=o}function y(){var t=now();if(m(t))return j(t);u=setTimeout(y,function(t){var n=e-(t-f);return b?nativeMin(n,o-(t-c)):n}(t))}function j(t){return u=void 0,s&&r?v(t):(r=i=void 0,a)}function g(){var t=now(),n=m(t);if(r=arguments,i=this,f=t,n){if(void 0===u)return function(t){return c=t,u=setTimeout(y,e),l?v(t):a}(f);if(b)return u=setTimeout(y,e),v(f)}return void 0===u&&(u=setTimeout(y,e)),a}return e=toNumber(e)||0,isObject(n)&&(l=!!n.leading,o=(b="maxWait"in n)?nativeMax(toNumber(n.maxWait)||0,e):o,s="trailing"in n?!!n.trailing:s),g.cancel=function(){void 0!==u&&clearTimeout(u),c=0,r=f=i=u=void 0},g.flush=function(){return void 0===u?a:j(now())},g}function throttle(t,e,n){var r=!0,i=!0;if("function"!=typeof t)throw new TypeError(FUNC_ERROR_TEXT);return isObject(n)&&(r="leading"in n?!!n.leading:r,i="trailing"in n?!!n.trailing:i),debounce(t,e,{leading:r,maxWait:e,trailing:i})}function isObject(t){var e=typeof t;return!!t&&("object"==e||"function"==e)}function isObjectLike(t){return!!t&&"object"==typeof t}function isSymbol(t){return"symbol"==typeof t||isObjectLike(t)&&objectToString.call(t)==symbolTag}function toNumber(t){if("number"==typeof t)return t;if(isSymbol(t))return NAN;if(isObject(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=isObject(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=t.replace(reTrim,"");var n=reIsBinary.test(t);return n||reIsOctal.test(t)?freeParseInt(t.slice(2),n?2:8):reIsBadHex.test(t)?NAN:+t}window.throttle=throttle;
+//# sourceMappingURL=/sm/4821be4c17c96774933f52de28b42cf423cc8f3e273d4f8b4fb982a8aebf2981.map

nova/trame/view/theme/theme.py

@@ -103,6 +103,8 @@ class ThemedApp:
                     shortcut
                 ]
 
+        self.init_lodash()
+
         # Since this is only intended for theming Trame apps, I don't think we need to invoke the MVVM framework here,
         # and working directly with the Trame state makes this easier for me to manage.
         self.state.nova__menu = False
@@ -114,6 +116,19 @@ class ThemedApp:
     def state(self) -> State:
         return self.server.state
 
+    def init_lodash(self) -> None:
+        js_path = (Path(__file__).parent / "assets" / "js").resolve()
+        self.server.enable_module(
+            {
+                "scripts": [
+                    "assets/js/lodash.debounce.min.js",
+                    "assets/js/lodash.throttle.min.js",
+                    "assets/js/delay_manager.js",
+                ],
+                "serve": {"assets/js": js_path},
+            }
+        )
+
     def init_mantid(self) -> None:
         """Initializes MantidManager.
 

{nova_trame-0.13.1.dist-info → nova_trame-0.14.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: nova-trame
-Version: 0.13.1
+Version: 0.14.1
 Summary: A Python Package for injecting curated themes and custom components into Trame applications
 License: MIT
 Keywords: NDIP,Python,Trame,Vuetify

{nova_trame-0.13.1.dist-info → nova_trame-0.14.1.dist-info}/RECORD

@@ -2,7 +2,7 @@ nova/__init__.py,sha256=ED6jHcYiuYpr_0vjGz0zx2lrrmJT9sDJCzIljoDfmlM,65
 nova/trame/__init__.py,sha256=gFrAg1qva5PIqR5TjvPzAxLx103IKipJLqp3XXvrQL8,59
 nova/trame/model/remote_file_input.py,sha256=9KAf31ZHzpsh_aXUrNcF81Q5jvUZDWCzW1QATKls-Jk,3675
 nova/trame/view/components/__init__.py,sha256=fopr6mVqcpDcVYK9ue7SLUHyswgvRPcFESTq86mu1R8,128
-nova/trame/view/components/input_field.py,sha256=YyDJJKHBsAdLN-GFOhXEpwNs5aJHb0BBbstcQ6nbAQE,12680
+nova/trame/view/components/input_field.py,sha256=yfNKDNIea4xv1CzAKIzbWk7kGi8Xt-pjJ6FvT_NFczQ,14728
 nova/trame/view/components/remote_file_input.py,sha256=k2yrwkell_g0sGnWR9XLL1LxkmFLr8-AGhduo8E-N4A,8669
 nova/trame/view/components/visualization/__init__.py,sha256=kDX1fkbtAgXSGlqhlMNhYYoYrq-hfS636smjgLsh6gg,84
 nova/trame/view/components/visualization/interactive_2d_plot.py,sha256=foZCMoqbuahT5dtqIQvm8C4ZJcY9P211eJEcpQJltmM,3421
@@ -13,12 +13,15 @@ nova/trame/view/layouts/vbox.py,sha256=Q4EvrtGJORyNF6AnCLGXToy8XU6yofiO5_kt7hK-A
 nova/trame/view/theme/__init__.py,sha256=70_marDlTigIcPEOGiJb2JTs-8b2sGM5SlY7XBPtBDM,54
 nova/trame/view/theme/assets/core_style.scss,sha256=AktysiiCYLeiTzCTtYwkksiUVmqb4S23RlDcW8L1ebI,518
 nova/trame/view/theme/assets/favicon.png,sha256=Xbp1nUmhcBDeObjsebEbEAraPDZ_M163M_ZLtm5AbQc,1927
+nova/trame/view/theme/assets/js/delay_manager.js,sha256=H_9mikPKxwtLBWWmOIk5A_47iiE2XmFeoLHdrG6J73Y,504
+nova/trame/view/theme/assets/js/lodash.debounce.min.js,sha256=GLzlQH04WDUNYN7i39ttHHejSdu-CpAvfWgDgKDn-OY,4448
+nova/trame/view/theme/assets/js/lodash.throttle.min.js,sha256=9csqjX-M-LVGJnF3z4ha1R_36O5AfkFE8rPHkxmt3tE,4677
 nova/trame/view/theme/assets/vuetify_config.json,sha256=7WGV6rO7hv2sapGsX9yy1d-dINshYFXRNX99D9I3dKQ,4780
-nova/trame/view/theme/theme.py,sha256=-5lq8u34eQ9j1bMeB5b63BiAdpi92WI2o-fJKcrwl3o,11401
+nova/trame/view/theme/theme.py,sha256=aNaQec73bfxVkNODBA9wWkPLzLUjsx5oWEoQCQ-0fLE,11867
 nova/trame/view/utilities/local_storage.py,sha256=vD8f2VZIpxhIKjZwEaD7siiPCTZO4cw9AfhwdawwYLY,3218
 nova/trame/view_model/remote_file_input.py,sha256=WHWCQkZBGeKLe1aTPbtVNI8tn-PDt64mi1-561uuBpQ,3320
-nova_trame-0.13.1.dist-info/LICENSE,sha256=MOqZ8tPMKy8ZETJ2-HEvFTZ7dYNlg3gXmBkV-Y9i8bw,1061
-nova_trame-0.13.1.dist-info/METADATA,sha256=ivedQKUq-ZJ2jk1e0aXkeHjbvtxXWLyOBGNl-lijv5E,1240
-nova_trame-0.13.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
-nova_trame-0.13.1.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
-nova_trame-0.13.1.dist-info/RECORD,,
+nova_trame-0.14.1.dist-info/LICENSE,sha256=MOqZ8tPMKy8ZETJ2-HEvFTZ7dYNlg3gXmBkV-Y9i8bw,1061
+nova_trame-0.14.1.dist-info/METADATA,sha256=vZyO-5ZpujJ_1vM4tWrmjHGwPnqBHbbERsc-GnHkq0o,1240
+nova_trame-0.14.1.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+nova_trame-0.14.1.dist-info/entry_points.txt,sha256=J2AmeSwiTYZ4ZqHHp9HO6v4MaYQTTBPbNh6WtoqOT58,42
+nova_trame-0.14.1.dist-info/RECORD,,