Conversation
0a73d12 to
19b7d44
Compare
gtrevisan
approved these changes
Mar 31, 2026
Member
gtrevisan
left a comment
There was a problem hiding this comment.
LGTM! once again, let's merge in a few days, or at the end of the week at the latest.
94332c6 to
2f9a71f
Compare
ef1a45f to
bbeedc0
Compare
…on ABC Signed-off-by: Sameer Chaturvedi <sameerc@mit.edu>
Fixes unresolved mkdocs cross-reference to DataConnection introduced in the data_conn rename. The base module had no mkdocstrings block, so autorefs couldn't resolve the link.
ae3ea9e to
f338e63
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR continues the backend-abstraction refactor by renaming MDSplus-specific identifiers (mds_conn, process_mds_conn, mds_connection_initializer, etc.) to backend-agnostic names (data_conn, process_data_conn, connection_initializer) to align with the DataConnection / ProcessConnection ABCs introduced in #523, and updates documentation/examples accordingly.
Changes:
- Renamed
mds_conn→data_conn(and related helpers) across core retrieval, settings params, and physics/time/nickname codepaths. - Renamed
get_shots_data()public kwargmds_connection_initializer→connection_initializerand refreshed the docstring parameter section. - Added/updated documentation pages and examples to reference
DataConnectionand the new naming.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds nav entry for the new DataConnection reference page. |
| examples/defaults.py | Updates example call to use connection_initializer. |
| docs/usage/physics_methods/physics_method_reference.md | Updates docs to reference params.data_conn instead of params.mds_conn. |
| docs/usage/data_connection_reference.md | New reference page for DataConnection/ProcessConnection base interfaces. |
| docs/examples/custom_time_setting.py | Updates example to use params.data_conn. |
| docs/examples/custom_physics_method.py | Updates example to use params.data_conn. |
| disruption_py/workflow.py | Renames initializer kwarg and internal helper/locals to connection-agnostic naming; updates get_shots_data() docstring. |
| disruption_py/settings/time_setting.py | Renames TimeSettingParams.mds_conn → data_conn and updates call sites. |
| disruption_py/settings/nickname_setting.py | Renames NicknameSettingParams.mds_conn → data_conn. |
| disruption_py/machine/mast/physics.py | Renames connection access to params.data_conn. |
| disruption_py/machine/mast/efit.py | Renames connection access to params.data_conn. |
| disruption_py/machine/hbtep/physics.py | Renames connection access to params.data_conn. |
| disruption_py/machine/generic/physics.py | Updates docstrings to say “data connection”. |
| disruption_py/machine/east/util.py | Renames arg name to data_conn and updates docstrings/calls accordingly. |
| disruption_py/machine/east/physics.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/east/efit.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/d3d/util.py | Updates docstrings and renames connection access to params.data_conn. |
| disruption_py/machine/d3d/physics.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/d3d/efit.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/cmod/thomson.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/cmod/physics.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/machine/cmod/efit.py | Renames connection access to params.data_conn and updates docstrings. |
| disruption_py/core/retrieval_manager.py | Renames process_mds_conn → process_data_conn and propagates data_conn through setup/time init. |
| disruption_py/core/physics_method/runner.py | Updates reconnect path to use physics_method_params.data_conn. |
| disruption_py/core/physics_method/params.py | Renames dataclass field mds_conn → data_conn and updates cleanup. |
| disruption_py/core/physics_method/decorator.py | Updates decorator docstring to refer to data_conn. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mds_conn→data_conn,process_mds_conn→process_data_conn,_get_mds_instance→_get_connection_instanceto reflect the backend-agnosticDataConnectionABCintroduced in Backend abstraction I: introduce DataConnection/ProcessConnection ABCs #523
mds_connection_initializer→connection_initializeringet_shots_data()(takesProcessConnection, not MDS-specific)physics_method_reference.md,examples/defaults.py,docs/examples/)get_shots_data()docstring (missing params, stale "from CMOD" wording)Details
24 files, ~370 line changes. Pure rename + formatting — no behavioral changes.
Test plan