Dashboard: Simplify imports (#837)

proy30 · web-flow · commit 0ef70391bc48 · 2025-02-08T22:55:34.000-08:00
* centralize vuetify import into dashboard/__init__.py

* centralize setup_server import

* simplify some more imports

* move some __main__.py imports to __init__.py

* centralize some analyze imports
diff --git a/src/python/impactx/dashboard/Analyze/__init__.py b/src/python/impactx/dashboard/Analyze/__init__.py
@@ -0,0 +1,7 @@
+from .analyzeFunctions import AnalyzeFunctions
+from .plot_ParameterEvolutionOverS.overS import line_plot_1d
+
+__all__ = [
+    "AnalyzeFunctions",
+    "line_plot_1d",
+]
diff --git a/src/python/impactx/dashboard/Analyze/analyzeFunctions.py b/src/python/impactx/dashboard/Analyze/analyzeFunctions.py
@@ -8,7 +8,7 @@
 
 import pandas as pd
 
-from ..trame_setup import setup_server
+from .. import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Analyze/plotsMain.py b/src/python/impactx/dashboard/Analyze/plotsMain.py
@@ -9,11 +9,10 @@
 import glob
 import os
 
-from trame.widgets import matplotlib, plotly, vuetify
+from trame.widgets import matplotlib, plotly
 
-from ..trame_setup import setup_server
-from .analyzeFunctions import AnalyzeFunctions
-from .plot_ParameterEvolutionOverS.overS import line_plot_1d
+from .. import setup_server, vuetify
+from . import AnalyzeFunctions, line_plot_1d
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/__init__.py b/src/python/impactx/dashboard/Input/__init__.py
@@ -1,16 +1,11 @@
-from trame.widgets import vuetify as vuetify
-
-from ..trame_setup import setup_server
 from .components import CardComponents, InputComponents, NavigationComponents
 from .defaults import DashboardDefaults
 from .generalFunctions import generalFunctions
 
 __all__ = [
     "InputComponents",
     "CardComponents",
-    "vuetify",
     "DashboardDefaults",
     "NavigationComponents",
     "generalFunctions",
-    "setup_server",
 ]
diff --git a/src/python/impactx/dashboard/Input/components.py b/src/python/impactx/dashboard/Input/components.py
@@ -1,6 +1,6 @@
 from typing import Optional
 
-from . import setup_server, vuetify
+from .. import setup_server, vuetify
 from .generalFunctions import generalFunctions
 
 server, state, ctrl = setup_server()
diff --git a/src/python/impactx/dashboard/Input/csrConfiguration/csrMain.py b/src/python/impactx/dashboard/Input/csrConfiguration/csrMain.py
@@ -1,4 +1,5 @@
-from .. import CardComponents, InputComponents, setup_server, vuetify
+from ... import setup_server, vuetify
+from .. import CardComponents, InputComponents
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/distributionParameters/__init__.py b/src/python/impactx/dashboard/Input/distributionParameters/__init__.py
@@ -0,0 +1,5 @@
+from .distributionFunctions import DistributionFunctions
+
+__all__ = [
+    "DistributionFunctions",
+]
diff --git a/src/python/impactx/dashboard/Input/distributionParameters/distributionFunctions.py b/src/python/impactx/dashboard/Input/distributionParameters/distributionFunctions.py
@@ -1,4 +1,4 @@
-from ...trame_setup import setup_server
+from ... import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/distributionParameters/distributionMain.py b/src/python/impactx/dashboard/Input/distributionParameters/distributionMain.py
@@ -12,15 +12,9 @@
 
 from impactx import distribution
 
-from .. import (
-    CardComponents,
-    DashboardDefaults,
-    InputComponents,
-    generalFunctions,
-    setup_server,
-    vuetify,
-)
-from .distributionFunctions import DistributionFunctions
+from ... import setup_server, vuetify
+from .. import CardComponents, DashboardDefaults, InputComponents, generalFunctions
+from . import DistributionFunctions
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/generalFunctions.py b/src/python/impactx/dashboard/Input/generalFunctions.py
@@ -12,7 +12,7 @@
 import subprocess
 import webbrowser
 
-from ..trame_setup import setup_server
+from .. import setup_server
 from .defaults import DashboardDefaults
 
 server, state, ctrl = setup_server()
diff --git a/src/python/impactx/dashboard/Input/inputParameters/__init__.py b/src/python/impactx/dashboard/Input/inputParameters/__init__.py
@@ -0,0 +1,5 @@
+from .inputFunctions import InputFunctions
+
+__all__ = [
+    "InputFunctions",
+]
diff --git a/src/python/impactx/dashboard/Input/inputParameters/inputFunctions.py b/src/python/impactx/dashboard/Input/inputParameters/inputFunctions.py
@@ -6,7 +6,7 @@
 License: BSD-3-Clause-LBNL
 """
 
-from ...trame_setup import setup_server
+from ... import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/inputParameters/inputMain.py b/src/python/impactx/dashboard/Input/inputParameters/inputMain.py
@@ -6,15 +6,9 @@
 License: BSD-3-Clause-LBNL
 """
 
-from .. import (
-    CardComponents,
-    DashboardDefaults,
-    InputComponents,
-    generalFunctions,
-    setup_server,
-    vuetify,
-)
-from .inputFunctions import InputFunctions
+from ... import setup_server, vuetify
+from .. import CardComponents, DashboardDefaults, InputComponents, generalFunctions
+from . import InputFunctions
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/latticeConfiguration/latticeMain.py b/src/python/impactx/dashboard/Input/latticeConfiguration/latticeMain.py
@@ -8,14 +8,8 @@
 
 from impactx import elements
 
-from .. import (
-    CardComponents,
-    InputComponents,
-    NavigationComponents,
-    generalFunctions,
-    setup_server,
-    vuetify,
-)
+from ... import setup_server, vuetify
+from .. import CardComponents, InputComponents, NavigationComponents, generalFunctions
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/space_charge_configuration/__init__.py b/src/python/impactx/dashboard/Input/space_charge_configuration/__init__.py
@@ -0,0 +1,5 @@
+from .spaceChargeFunctions import SpaceChargeFunctions
+
+__all__ = [
+    "SpaceChargeFunctions",
+]
diff --git a/src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py b/src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeFunctions.py
@@ -1,5 +1,5 @@
-from ...trame_setup import setup_server
-from ..generalFunctions import generalFunctions
+from ... import setup_server
+from .. import generalFunctions
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py b/src/python/impactx/dashboard/Input/space_charge_configuration/spaceChargeMain.py
@@ -1,12 +1,6 @@
-from .. import (
-    CardComponents,
-    InputComponents,
-    NavigationComponents,
-    generalFunctions,
-    setup_server,
-    vuetify,
-)
-from .spaceChargeFunctions import SpaceChargeFunctions
+from ... import setup_server, vuetify
+from .. import CardComponents, InputComponents, NavigationComponents, generalFunctions
+from . import SpaceChargeFunctions
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Run/controls.py b/src/python/impactx/dashboard/Run/controls.py
@@ -3,8 +3,8 @@
 
 from wurlitzer import pipes
 
+from .. import setup_server
 from ..simulation import run_simulation
-from ..trame_setup import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Toolbar/controls.py b/src/python/impactx/dashboard/Toolbar/controls.py
@@ -6,12 +6,12 @@
 License: BSD-3-Clause-LBNL
 """
 
-from trame.widgets import html, vuetify
+from trame.widgets import html
 
+from .. import setup_server, vuetify
 from ..Analyze.plotsMain import available_plot_options, load_dataTable_data, update_plot
 from ..Input.generalFunctions import generalFunctions
 from ..Run.controls import execute_impactx_sim
-from ..trame_setup import setup_server
 from .exportTemplate import input_file
 from .importParser import DashboardParser
 
diff --git a/src/python/impactx/dashboard/Toolbar/exportTemplate.py b/src/python/impactx/dashboard/Toolbar/exportTemplate.py
@@ -1,6 +1,6 @@
+from .. import setup_server
 from ..Input.distributionParameters.distributionFunctions import DistributionFunctions
 from ..Input.latticeConfiguration.latticeMain import parameter_input_checker_for_lattice
-from ..trame_setup import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/Toolbar/importParser.py b/src/python/impactx/dashboard/Toolbar/importParser.py
@@ -1,3 +1,4 @@
+from .. import setup_server
 from ..Input.distributionParameters.distributionMain import (
     on_distribution_parameter_change,
     populate_distribution_parameters,
@@ -6,7 +7,6 @@
     add_lattice_element,
     on_lattice_element_parameter_change,
 )
-from ..trame_setup import setup_server
 from .importParserHelper import DashboardParserHelper
 
 server, state, ctrl = setup_server()
diff --git a/src/python/impactx/dashboard/__init__.py b/src/python/impactx/dashboard/__init__.py
@@ -1,5 +1,32 @@
+from trame.widgets import vuetify as vuetify
+
+# isort: off
+
+from .trame_setup import setup_server
+from .Toolbar.controls import GeneralToolbar
+
+from .Analyze.plotsMain import AnalyzeSimulation
+from .Input.csrConfiguration.csrMain import csrConfiguration
+from .Input.distributionParameters.distributionMain import DistributionParameters
+from .Input.inputParameters.inputMain import InputParameters
+from .Input.latticeConfiguration.latticeMain import LatticeConfiguration
+from .Input.components import NavigationComponents
+from .Input.space_charge_configuration.spaceChargeMain import SpaceChargeConfiguration
+
 from .jupyterApplication import JupyterMainApplication as JupyterApp
+# isort: on
+
 
 __all__ = [
     "JupyterApp",
+    "setup_server",
+    "vuetify",
+    "AnalyzeSimulation",
+    "NavigationComponents",
+    "csrConfiguration",
+    "DistributionParameters",
+    "InputParameters",
+    "LatticeConfiguration",
+    "SpaceChargeConfiguration",
+    "GeneralToolbar",
 ]
diff --git a/src/python/impactx/dashboard/__main__.py b/src/python/impactx/dashboard/__main__.py
@@ -10,18 +10,21 @@
 
 from trame.ui.router import RouterViewLayout
 from trame.ui.vuetify import SinglePageWithDrawerLayout
-from trame.widgets import router, vuetify, xterm
-
-from .Analyze.plotsMain import AnalyzeSimulation
-from .Input.components import NavigationComponents
-from .Input.csrConfiguration.csrMain import csrConfiguration
-from .Input.distributionParameters.distributionMain import DistributionParameters
-from .Input.inputParameters.inputMain import InputParameters
-from .Input.latticeConfiguration.latticeMain import LatticeConfiguration
-from .Input.space_charge_configuration.spaceChargeMain import SpaceChargeConfiguration
+from trame.widgets import router, xterm
+
+from . import (
+    AnalyzeSimulation,
+    DistributionParameters,
+    GeneralToolbar,
+    InputParameters,
+    LatticeConfiguration,
+    NavigationComponents,
+    SpaceChargeConfiguration,
+    csrConfiguration,
+    setup_server,
+    vuetify,
+)
 from .start import main
-from .Toolbar.controls import GeneralToolbar
-from .trame_setup import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/simulation.py b/src/python/impactx/dashboard/simulation.py
@@ -6,7 +6,7 @@
 License: BSD-3-Clause-LBNL
 """
 
-from .trame_setup import setup_server
+from . import setup_server
 
 server, state, ctrl = setup_server()
 
diff --git a/src/python/impactx/dashboard/start.py b/src/python/impactx/dashboard/start.py
@@ -6,8 +6,8 @@
 License: BSD-3-Clause-LBNL
 """
 
+from . import setup_server
 from .Input.defaults import DashboardDefaults
-from .trame_setup import setup_server
 
 server, state, ctrl = setup_server()
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-from ...trame_setup import setup_server`
	`1`	`+from ... import setup_server`
`2`	`2`
`3`	`3`	`server, state, ctrl = setup_server()`
`4`	`4`