Skip to content

Commit ef73d19

Browse files
authored
moved mssautoplot to mslib/autoplot (#3154)
* moved mssautoplot to mslib/atuoplot * cleanup ignore_imports * further rules added
1 parent 9a59005 commit ef73d19

6 files changed

Lines changed: 29 additions & 12 deletions

File tree

mslib/autoplot/CLAUDE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# mslib.autoplot — headless batch plotting
2+
3+
Purpose: the `mssautoplot` CLI: renders top/side view plots from a JSON config
4+
without showing the GUI, by driving the msui plotting stack headlessly.
5+
Global map: ../../ARCHITECTURE.md
6+
7+
## Layout
8+
9+
- `__init__.py` — the whole CLI (click-based `main`, `load_from_ftml`,
10+
TopView/SideView plotting drivers)
11+
12+
## May import
13+
14+
`mslib.utils` and `mslib.msui` (this package exists precisely so that the
15+
GUI dependency does not sit inside the base layer mslib.utils).
16+
Never `mslib.mscolab` or `mslib.mswms` (enforced in setup.cfg).
17+
18+
## Verify
19+
20+
`pixi run -e dev env QT_QPA_PLATFORM=offscreen pytest tests/_test_utils/test_mssautoplot.py -q`
21+
and `mssautoplot --help` inside the dev env.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
3-
mslib.utils.mssautoplot
4-
~~~~~~~~~~~~~~~~~~~~~~~
3+
mslib.autoplot
4+
~~~~~~~~~~~~~~
55
66
A CLI tool to create for instance a number of the same plots
77
for several flights or several forecast steps

mslib/msui/autoplot_dockwidget.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
from PyQt5.QtWidgets import QWidget, QFileDialog, QTreeWidgetItem, QMessageBox
3737
from PyQt5 import QtCore
3838

39-
from mslib.utils.mssautoplot import main as cli_tool
39+
from mslib.autoplot import main as cli_tool
4040
from mslib.msui.qt5.ui_mss_autoplot import Ui_AutoplotDockWidget
4141
from mslib.utils import constants as const
4242

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Repository = "https://github.com/Open-MSS/MSS"
2222
[project.scripts]
2323
mscolab = "mslib.mscolab.mscolab:main"
2424
msidp = "mslib.msidp.idp:main"
25-
mssautoplot = "mslib.utils.mssautoplot:main"
25+
mssautoplot = "mslib.autoplot:main"
2626
mss = "mslib.msui.mss:main"
2727
mswms = "mslib.mswms.mswms:main"
2828

setup.cfg

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,12 +62,6 @@ source_modules =
6262
forbidden_modules =
6363
mslib.msui
6464
ignore_imports =
65-
mslib.utils.mssautoplot -> mslib.msui
66-
mslib.utils.mssautoplot -> mslib.msui.mpl_map
67-
mslib.utils.mssautoplot -> mslib.msui.wms_control
68-
mslib.utils.mssautoplot -> mslib.msui.viewplotter
69-
mslib.utils.mssautoplot -> mslib.msui.mpl_pathinteractor
70-
mslib.utils.mssautoplot -> mslib.msui.flighttrack
7165
mslib.plugins.io.csv -> mslib.msui.flighttrack
7266
mslib.plugins.io.text -> mslib.msui.flighttrack
7367
mslib.plugins.io.flitestar -> mslib.msui.flighttrack
@@ -82,6 +76,7 @@ source_modules =
8276
mslib.plugins
8377
mslib.msidp
8478
mslib.support
79+
mslib.autoplot
8580
forbidden_modules =
8681
mslib.mscolab
8782
ignore_imports =
@@ -98,5 +93,6 @@ source_modules =
9893
mslib.plugins
9994
mslib.msidp
10095
mslib.support
96+
mslib.autoplot
10197
forbidden_modules =
10298
mslib.mswms

tests/_test_utils/test_mssautoplot.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
tests._test_utils.test_mssautoplot
55
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
66
7-
This module provides pytest functions to tests mslib.utils.mssautoplot
7+
This module provides pytest functions to tests mslib.autoplot
88
99
This file is part of MSS.
1010
@@ -28,7 +28,7 @@
2828

2929
import os
3030

31-
from mslib.utils.mssautoplot import load_from_ftml
31+
from mslib.autoplot import load_from_ftml
3232

3333

3434
def test_load_from_ftml():

0 commit comments

Comments
 (0)