Implements latest feedback from @swainn

- pyproject.toml added to all scaffolds - reactpy_base.html refactored to extend app_base.html - minor cleanups and refactors
tethysplatform · swainn · Nov 25, 2024 · May 13, 2024 · May 14, 2024 · May 16, 2024
commit 01bdf94e85b193d2907a29c7cb1a070c24058de4
diff --git a/tests/unit_tests/test_tethys_apps/test_base/test_app_base.py b/tests/unit_tests/test_tethys_apps/test_base/test_app_base.py
@@ -6,7 +6,6 @@
 from django.db.utils import ProgrammingError
 from django.test import RequestFactory, override_settings
 from django.core.exceptions import ValidationError, ObjectDoesNotExist
-from argparse import Namespace
 
 from tethys_apps.exceptions import (
     TethysAppSettingDoesNotExist,
@@ -1558,11 +1557,11 @@ def test_navigation_links_auto_excluded_page(self):
         app.root_url = "test-app"
 
         app._registered_url_maps = [
-            Namespace(name="exclude_page", title="Exclude Page", index=-1),
-            Namespace(name="last_page", title="Last Page", index=3),
-            Namespace(name="third_page", title="Third Page", index=2),
-            Namespace(name="second_page", title="Second Page", index=1),
-            Namespace(name="home", title="Home", index=0),
+            mock.MagicMock(name="exclude_page", title="Exclude Page", index=-1),
+            mock.MagicMock(name="last_page", title="Last Page", index=3),
+            mock.MagicMock(name="third_page", title="Third Page", index=2),
+            mock.MagicMock(name="second_page", title="Second Page", index=1),
+            mock.MagicMock(name="home", title="Home", index=0),
         ]
 
         links = app.navigation_links

diff --git a/tests/unit_tests/test_tethys_components/test_utils.py b/tests/unit_tests/test_tethys_components/test_utils.py
@@ -75,8 +75,8 @@ def test_delayed_execute(self):
         def test_func(arg1):
             pass
 
-        utils.delayed_execute(10, test_func, ["Hello"])
-        mock_import().Timer.assert_called_once_with(10, test_func, ["Hello"])
+        utils.delayed_execute(test_func, 10, ["Hello"])
+        mock_import().Timer.assert_called_once_with(test_func, 10, ["Hello"])
         mock_import().Timer().start.assert_called_once()
         mock.patch.stopall()
 

diff --git a/tethys_apps/templates/tethys_apps/app_base.html b/tethys_apps/templates/tethys_apps/app_base.html
@@ -85,8 +85,10 @@
     {% endcomment %}
 
     {% block styles %}
-      {{ tethys.bootstrap.link_tag|safe }}
-      {{ tethys.bootstrap_icons.link_tag|safe }}
+      {% block bootstrap_styles %}
+        {{ tethys.bootstrap.link_tag|safe }}
+        {{ tethys.bootstrap_icons.link_tag|safe }}
+      {% endblock %}
       {% block app_base_styles %}
         <link href="{% static 'tethys_apps/css/app_base.min.css' %}" rel="stylesheet" />
       {% endblock %}

diff --git a/tethys_apps/templates/tethys_apps/reactpy_base.html b/tethys_apps/templates/tethys_apps/reactpy_base.html
@@ -1,119 +1,34 @@
+{% extends "tethys_apps/app_base.html" %}
 {% load static tethys reactpy %}
-<!DOCTYPE html>
-<!--[if IE 7]> <html lang="en" class="ie ie7 h-100"> <![endif]-->
-<!--[if IE 8]> <html lang="en"  class="ie ie8 h-100"> <![endif]-->
-<!--[if IE 9]> <html lang="en"  class="ie9 h-100"> <![endif]-->
-<!--[if gt IE 8]><!--> <html lang="en" class="h-100"> <!--<![endif]-->
-  <head>
-    {% if has_analytical %}
-    {% include "analytical_head_top.html" %}
-    {% endif %}
 
-    <meta charset="utf-8" />
-    <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <meta name="viewport" content="width=device-width, initial-scale=1">
-    <meta name="generator" content="Django" />
-
-    <title>{{ title }} | {{ tethys_app.name }}</title>
-    <link rel="shortcut icon" href="{% if site_globals.favicon and 'http' in site_globals.favicon %}{{ site_globals.favicon }}{% elif site_globals.favicon %}{% static site_globals.favicon %}{% else %}{% static 'tethys_portal/images/default_favicon.png' %}{% endif %}" />
-    {% if tethys_app.enable_feedback %}
-      <link href="{% static 'tethys_apps/css/feedback.css' %}" rel="stylesheet" />
-    {% endif %}
-    <link href="{% static 'tethys_portal/css/termsandconditions.min.css' %}"  rel="stylesheet" />
-    {% for css in custom_css %}
-      <link href="{{ css }}" rel="stylesheet" />
-    {% endfor %}
-    <style>
-      :root {
-        --app-primary-color: {{ tethys_app.color }};
-        --app-secondary-color: {{ tethys_app.color|lighten:20 }};
-      }
-
-      #app-header .tethys-app-header {
-        background: var(--app-primary-color, '#7ec1f7');
-      }
-
-      #app-header .tethys-app-header .icon-wrapper img {
-        background: var(--app-primary-color, '#7ec1f7');
-      }
-
-      #app-header .btn-user-profile {
-        background-color: rgba(255, 255, 255, 0.08);
-        border: none;
-        color: {{ site_globals.primary_text_color }};
-      }
-
-      #app-header .btn-user-profile:hover {
-        background-color: rgba(255, 255, 255, 0.30);
-      }
-
-      #app-navigation .nav li a {
-        color: var(--app-primary-color, '#7ec1f7');
-      }
-
-      #app-navigation .nav li.active a {
-        color: var(--app-primary-color, '#7ec1f7');
-      }
-
-      #app-navigation .nav li a.active {
-        background: var(--app-primary-color, '#7ec1f7');
-        color: white;
-      }
-
-      #app-content-wrapper #app-content #app-actions {
-        background: var(--app-secondary-color);
-      }
-      .styled-header-button:hover, .styled-header-button:focus {
-        background-color: rgba(0, 0, 0, 0.1)!important;
-        color: white;
-        border: none;
-        box-shadow: none;
-      }
-    </style>
-    <script type="module">
-      import React from "https://esm.sh/react@{{ reactjs_version }}"
-      import ReactDOM from "https://esm.sh/react-dom@{{ reactjs_version }}"
-      globalThis['React'] = React
-      globalThis['ReactDOM'] = ReactDOM
-    </script>
-
-    {% if has_session_security %}
-      {% include 'session_security/all.html' %}
-      <link href="{% static 'tethys_portal/css/session_security_override.min.css' %}"  rel="stylesheet" />
-    {% endif %}
-
-    {% if has_analytical %}
-      {% include "analytical_head_bottom.html" %}
-    {% endif %}
-  </head>
-
-  <body class="h-100">
-    {% if has_analytical %}
-      {% include "analytical_body_top.html" %}
-    {% endif %}
-
-    {% component "tethys_apps.base.page_handler.page_component_wrapper" app=app user=request.user layout=layout_func component=component_func extras=extras %}
-
-    {% if has_terms %}
-      {% include "terms.html" %}
-    {% endif %}
-
-    <div id="page-attributes" data-username="{{ user.username }}" style="display: none;"></div>
-
-    {% csrf_token %}
-
-    {{ tethys.doc_cookies.script_tag|safe }}
-
-    {% if tethys_app.enable_feedback %}
-      <script src="{% static 'tethys_apps/js/feedback.js' %}" type="text/javascript"></script>
-    {% endif %}
-
-    {% for js in custom_js %}
-      <script src="{{ js }}" type="text/javascript"></script>
-    {% endfor %}
-
-    {% if has_analytical %}
-      {% include "analytical_body_bottom.html" %}
-    {% endif %}
-  </body>
-</html>
+{% block title %}{{ title }} | {{ tethys_app.name }}{% endblock %}
+
+{% block bootstrap_styles %}{% endblock %}
+{% block app_base_styles %}{% endblock %}
+
+{% block app_styles %}
+  {% for css in custom_css %}
+    <link href="{{ css }}" rel="stylesheet" />
+  {% endfor %}
+  {{ block.super }}
+{% endblock %}
+
+{% block global_scripts %}
+{{ tethys.jquery.script_tag|safe }}
+<script type="module">
+  import React from "https://esm.sh/react@{{ reactjs_version }}"
+  import ReactDOM from "https://esm.sh/react-dom@{{ reactjs_version }}"
+  globalThis['React'] = React
+  globalThis['ReactDOM'] = ReactDOM
+</script>
+{% endblock %}
+
+{% block app_content_wrapper_override %}
+  {% component "tethys_apps.base.page_handler.page_component_wrapper" app=app user=request.user layout=layout_func component=component_func extras=extras %}
+{% endblock %}
+
+{% block app_base_js %}
+  {% for js in custom_js %}
+    <script src="{{ js }}" type="text/javascript"></script>
+  {% endfor %}
+{% endblock %}
diff --git a/tethys_cli/scaffold_templates/app_templates/default/pyproject.toml_tmpl b/tethys_cli/scaffold_templates/app_templates/default/pyproject.toml_tmpl
@@ -0,0 +1,44 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{project_dir}}"
+description =  "{{description|default('')}}"
+{% if license_name %}license = {text = "{{license_name|default('')}}"}{% endif %}
+keywords = [{{', '.join(tags.split(','))}}]
+{% if author and author_email %}authors = [
+    {name = "{{author|default('')}}", email = "{{author_email|default('')}}"},
+]{% endif %}
+classifiers = [
+     "Environment :: Web Environment",
+     "Framework :: Django",
+     "Intended Audience :: Developers",{% if license_name %}
+     "License :: OSI Approved :: {{license_name}}",{% endif %}
+     "Operating System :: OS Independent",
+     "Programming Language :: Python",
+     "Programming Language :: Python :: 3",
+     "Programming Language :: Python :: 3.10",
+     "Topic :: Internet :: WWW/HTTP",
+     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dynamic = ["version"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["tethysapp*"]
+
+[tool.setuptools.package-data]
+"*" = [
+    "*.js",
+    "*.png",
+    "*.gif",
+    "*.jpg",
+    "*.html",
+    "*.css",
+    "*.gltf",
+    "*.json",
+    "*.svg",
+]
diff --git a/tethys_cli/scaffold_templates/app_templates/default/setup.py_tmpl b/tethys_cli/scaffold_templates/app_templates/default/setup.py_tmpl
diff --git a/tethys_cli/scaffold_templates/app_templates/react/pyproject.toml_tmpl b/tethys_cli/scaffold_templates/app_templates/react/pyproject.toml_tmpl
@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "{{project_dir}}"
+description =  "{{description|default('')}}"
+readme = "README.md"
+{% if license_name %}license = {text = "{{license_name|default('')}}"}{% endif %}
+keywords = [{{', '.join(tags.split(','))}}]
+{% if author and author_email %}authors = [
+    {name = "{{author|default('')}}", email = "{{author_email|default('')}}"},
+]{% endif %}
+classifiers = [
+     "Environment :: Web Environment",
+     "Framework :: Django",
+     "Intended Audience :: Developers",{% if license_name %}
+     "License :: OSI Approved :: {{license_name}}",{% endif %}
+     "Operating System :: OS Independent",
+     "Programming Language :: Python",
+     "Programming Language :: Python :: 3",
+     "Programming Language :: Python :: 3.10",
+     "Topic :: Internet :: WWW/HTTP",
+     "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dynamic = ["version"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["tethysapp*"]
+
+[tool.setuptools.package-data]
+"*" = [
+    "*.js",
+    "*.png",
+    "*.gif",
+    "*.jpg",
+    "*.html",
+    "*.css",
+    "*.gltf",
+    "*.json",
+    "*.svg",
+]
diff --git a/tethys_cli/scaffold_templates/app_templates/react/setup.py_tmpl b/tethys_cli/scaffold_templates/app_templates/react/setup.py_tmpl
diff --git a/tethys_cli/scaffold_templates/app_templates/reactpy/pyproject.toml_tmpl b/tethys_cli/scaffold_templates/app_templates/reactpy/pyproject.toml_tmpl
@@ -24,3 +24,22 @@ classifiers = [
      "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
 ]
 dynamic = ["version"]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+include = ["tethysapp*"]
+
+[tool.setuptools.package-data]
+"*" = [
+    "*.js",
+    "*.png",
+    "*.gif",
+    "*.jpg",
+    "*.html",
+    "*.css",
+    "*.gltf",
+    "*.json",
+    "*.svg",
+]
diff --git a/tethys_components/utils.py b/tethys_components/utils.py
@@ -38,10 +38,10 @@ def use_workspace(user=None):
     return workspace
 
 
-def delayed_execute(seconds, callable, args=None):
+def delayed_execute(callable, delay_seconds, args=None):
     from threading import Timer
 
-    t = Timer(seconds, callable, args or [])
+    t = Timer(delay_seconds, callable, args or [])
     t.start()