turn dipole attrs into properties#13153
Merged
larsoner merged 3 commits intomne-tools:mainfrom Mar 12, 2025
Merged
Conversation
larsoner
reviewed
Mar 11, 2025
drammock
previously requested changes
Mar 11, 2025
Member
drammock
left a comment
There was a problem hiding this comment.
Lots of CI errors of the form:
FAILED mne/beamformer/tests/test_rap_music.py::test_rap_music_simulated - AttributeError: property 'pos' of 'Dipole' object has no setter
Normally how we handle this is to change the previously quasi-public attributes into private ones, e.g., in the class init and throughout the codebase we set Dipole._pos (note the underscore) and use the non-private one when we just need to get the value. If we expect / want users to also be able to set the value of any of these properties (name maybe?) then we would need to add a second public def decorated with @setter, e.g.
@setter
def name(self, name):
assert isinstance(name, str) # optional validation, could also use `_validate_type`
self._name = name
larsoner
approved these changes
Mar 12, 2025
Member
|
Marking for merge-when-green, thanks in advance @sappelhoff ! |
larsoner
added a commit
to larsoner/mne-python
that referenced
this pull request
Apr 4, 2025
* upstream/main: (149 commits) FIX make_watershed_bem to handle missing talairach_with_skull.lta courtesy Freesurfer 8 (mne-tools#13172) ENH: Add upsampling for MEG helmet surface (mne-tools#13179) MAINT: Update code credit (mne-tools#13180) BUG: Fix bug with least-squares sphere fit (mne-tools#13178) fix EDF export (mne-tools#13174) fix typo (mne-tools#13171) [pre-commit.ci] pre-commit autoupdate (mne-tools#13164) Fix dev installation guide (mne-tools#13163) expose 'mode' for plotting dipole on brain (mne-tools#13162) turn dipole attrs into properties (mne-tools#13153) remove misformatted (and unused) crossref anchor (mne-tools#13155) doc: point to read_dipole (mne-tools#13149) [pre-commit.ci] pre-commit autoupdate (mne-tools#13152) BUG: Fix bug with not short-circuiting n_jobs=1 (mne-tools#13147) FIX: Missing coordinates.xml in MFF file (mne-tools#13148) FIX: Gracefully handle bad XML files in EGI reader (mne-tools#13145) Fixes for Latest IPython (9.0.1) (mne-tools#13146) Fix intersphinx (mne-tools#13143) BUG: Fix bug with parallel doc build (mne-tools#13140) [pre-commit.ci] pre-commit autoupdate (mne-tools#13141) ...
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
3 participants
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.
To do