Skip to content

Write id and version to settings #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hsorby merged 2 commits into from
Aug 22, 2025
Merged

Write id and version to settings #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c19801d
Write id and version to settings
rchristie Aug 21, 2025
995bce9
Verify settings id and version
rchristie Aug 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions src/scaffoldfitter/fitter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@ def cleanup(self):
self._logger = None
self._context = None

SCAFFOLD_FITTER_SETTINGS_ID = "scaffold fitter settings"

def decodeSettingsJSON(self, s: str, decoder):
"""
Define Fitter from JSON serialisation output by encodeSettingsJSON.
Expand All @@ -140,6 +142,10 @@ def decodeSettingsJSON(self, s: str, decoder):
# ensure there is a first config step:
if (len(self._fitterSteps) > 0) and isinstance(self._fitterSteps[0], FitterStepConfig):
# field names are read (default to None), fields are found on load
id = settings.get("id")
if id is not None:
assert id == self.SCAFFOLD_FITTER_SETTINGS_ID
assert settings['version'] == '1.0.0' # future: migrate if version changes
Comment on lines +147 to +148
Copy link
Contributor

@hsorby hsorby Aug 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will probably have to evolve into a function in the future when changes are made to the current standard.

self._modelCoordinatesFieldName = settings.get("modelCoordinatesField")
self._modelFitGroupName = settings.get("modelFitGroup")
self._fibreFieldName = settings.get("fibreField")
Expand All @@ -156,6 +162,8 @@ def encodeSettingsJSON(self) -> str:
:return: String JSON encoding of Fitter settings.
"""
dct = {
"id": self.SCAFFOLD_FITTER_SETTINGS_ID,
"version": "1.0.0",
"modelCoordinatesField": self._modelCoordinatesFieldName,
"modelFitGroup": self._modelFitGroupName,
"fibreField": self._fibreFieldName,
Expand Down
13 changes: 13 additions & 0 deletions tests/test_fitcube.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import json
import logging
import math
import os
Expand Down Expand Up @@ -229,6 +230,18 @@ def test_alignMarkersFitRegularData(self):

# test json serialisation
s = fitter.encodeSettingsJSON()
settings_dct = json.loads(s)
self.assertEqual(len(settings_dct), 10)
self.assertEqual(settings_dct['id'], 'scaffold fitter settings')
self.assertEqual(settings_dct['version'], '1.0.0')
self.assertEqual(settings_dct['modelCoordinatesField'], 'coordinates')
self.assertIsNone(settings_dct['modelFitGroup'])
self.assertIsNone(settings_dct['fibreField'])
self.assertIsNone(settings_dct['flattenGroup'])
self.assertEqual(settings_dct['dataCoordinatesField'], 'data_coordinates')
self.assertEqual(settings_dct['markerGroup'], 'marker')
self.assertEqual(settings_dct['diagnosticLevel'], 1)
self.assertEqual(len(settings_dct['fitterSteps']), 3)
fitter2 = Fitter(zinc_model_file, zinc_data_file)
fitter2.decodeSettingsJSON(s, decodeJSONFitterSteps)
fitterSteps = fitter2.getFitterSteps()
Expand Down