DescriptorBase now is a NewBase class by rozyczko · Pull Request #306 · easyscience/core

rozyczko · 2026-09-04T17:20:13Z

DescriptorBase now inherits from NewBase instead of SerializerComponent, and uses SerializerBase for serialization. The to_dict method is introduced as the standard serialization method, with as_dict provided as an alias for backward compatibility.

The serialization interface for descriptor and parameter classes (DescriptorNumber, DescriptorArray, DescriptorAnyType, Parameter) is unified to use to_dict, replacing previous as_dict implementations.

EasyList used in MultiFitter now only accepts ModelBase members, preventing bare parameters or foreign objects from being silently ignored during fitting.

codecov · 2026-09-04T17:21:46Z

Codecov Report

❌ Patch coverage is 87.50000% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.81%. Comparing base (2e9d9c2) to head (03f86be).

Files with missing lines	Patch %	Lines
src/easyscience/job/theoreticalmodel.py	0.00%	2 Missing ⚠️
src/easyscience/io/serializer_component.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@                     Coverage Diff                     @@
##           easylist-on-multifitter     #306      +/-   ##
===========================================================
+ Coverage                    83.66%   83.81%   +0.14%     
===========================================================
  Files                           68       68              
  Lines                         5271     5332      +61     
===========================================================
+ Hits                          4410     4469      +59     
- Misses                         861      863       +2

Flag	Coverage Δ
unittests	`83.81% <87.50%> (+0.14%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/easyscience/base_classes/based_base.py	`83.48% <100.00%> (ø)`
src/easyscience/base_classes/easy_list.py	`96.20% <ø> (ø)`
src/easyscience/base_classes/new_base.py	`100.00% <ø> (ø)`
src/easyscience/fitting/multi_fitter.py	`98.70% <100.00%> (ø)`
src/easyscience/io/serializer_base.py	`90.20% <ø> (ø)`
src/easyscience/variable/descriptor_any_type.py	`96.87% <100.00%> (ø)`
src/easyscience/variable/descriptor_array.py	`89.56% <100.00%> (ø)`
src/easyscience/variable/descriptor_base.py	`95.83% <100.00%> (+1.26%)`	⬆️
src/easyscience/variable/descriptor_bool.py	`96.42% <ø> (-0.13%)`	⬇️
src/easyscience/variable/descriptor_number.py	`95.40% <100.00%> (ø)`
... and 4 more

... and 14 files with indirect coverage changes

damskii9992

More work to do. You forgot the biggest part of the change, the removal of the name attribute.

damskii9992 · 2026-09-09T09:23:10Z

+    ``DescriptorBase`` is a ``NewBase`` object. As such every descriptor
+    is registered in the global object map under its ``unique_name``,
+    has an optional ``display_name`` and is serialized with
+    ``to_dict``/``from_dict``. Descriptors and parameters can
+    therefore be held directly by an ``EasyList``.
+
+    Following the ``NewBase`` design, a ``unique_name`` that was
+    generated automatically is *not* written by ``to_dict``; a
+    deserialized descriptor is simply assigned a fresh one. Only a
+    ``unique_name`` passed explicitly to the constructor is serialized.
+
+    Descriptors no longer provide the ``SerializerComponent`` methods
+    ``encode``, ``decode`` and ``encode_data``. Use a serializer
+    directly instead, e.g. ``SerializerDict().encode(descriptor)`` and
+    ``SerializerDict.decode(data)``.


I wouldn't keep these comments. You can just look at the NewBase class to see its design, and I also wouldn't describe the difference from the old implementation.

damskii9992 · 2026-09-09T09:23:43Z


    def __init__(
        self,
        name: str,


We want to get rid of the name attribute. This was part of the reason to move to NewBase.

As described below

damskii9992 · 2026-09-09T09:26:30Z

+        # Registers the descriptor with the global object map and takes
+        # care of `unique_name` and `display_name`.


Remove this comment

damskii9992 · 2026-09-09T09:28:37Z

Should we also get rid of parent? I think that is only used in the global_object map . . .

a larger scope but fitting here so will add this

damskii9992 · 2026-09-09T09:31:02Z

    @property
    def display_name(self) -> str:


Can be removed when we remove name.

damskii9992 · 2026-09-09T09:43:13Z

+        # Only ModelBase members are accepted: EasyList harvests parameters
+        # from ModelBase items alone, so any other NewBase (a bare Parameter,
+        # say) would be accepted and then silently sit out the fit.
+        self._fit_objects = EasyList(*fit_objects, protected_types=ModelBase)


Hmm, I guess we would need to edit the EasyList to also return bare Parameters, otherwise we can't get rid of ObjBase to use the Fitter in standalone fitting.

or maybe have Fitter.__init__ accept a plain list (or tuple) of parameters and wrap it in an EasyList itself? so users don't even need to know the container exists.

damskii9992 · 2026-09-09T10:36:35Z

+  `ModelBase`, `EasyList`; the legacy `ObjBase` and `CollectionBase` are
+  deprecated).


Remove line about legacy, they will be removed in 3.0, when this is released, so they won't even exist anymore.

damskii9992 · 2026-09-09T10:38:12Z

+    def test_is_a_new_base(self, descriptor: DescriptorBase):
+        # When Then Expect
+        assert isinstance(descriptor, NewBase)
+        assert not isinstance(descriptor, SerializerComponent)


. . . Huh? Why? XD

legacy check, but can remove.

damskii9992 · 2026-09-09T10:39:00Z

+    def test_to_dict_drops_generated_unique_name(self, clear):
+        """Descriptors follow the ``NewBase`` design: an auto-generated
+        unique_name is not serialized, so a decoded descriptor is given
+        a fresh one instead of colliding with the original."""
+        # When
+        descriptor = DescriptorNumber(name='name', value=1.0)
+
+        # Then Expect
+        assert descriptor._default_unique_name
+        assert 'unique_name' not in descriptor.to_dict()
+
+    def test_to_dict_keeps_explicit_unique_name(self, clear):
+        """An explicitly supplied unique_name is still serialized."""
+        # When
+        descriptor = DescriptorNumber(name='name', value=1.0, unique_name='explicit_name')
+
+        # Then Expect
+        assert not descriptor._default_unique_name
+        assert descriptor.to_dict()['unique_name'] == 'explicit_name'


This is tested in NewBase, no need to test it again.

damskii9992 · 2026-09-09T10:39:52Z

+    def test_can_be_held_by_an_easy_list(self, clear):
+        """Descriptors are NewBase objects, so EasyList accepts them."""
+        # When
+        descriptor = DescriptorNumber(name='name', value=1.0)
+        easy_list = EasyList(descriptor)
+
+        # Then Expect
+        assert list(easy_list) == [descriptor]
+        assert easy_list[descriptor.unique_name] is descriptor


Redundant test, I'd say. At least it should be covered by our integration tests, not a unit test.

rozyczko · 2026-09-11T09:22:47Z

More work to do. You forgot the biggest part of the change, the removal of the name attribute.

I prefer to do it in a separate PR. The changes required are quite substantial.

DescriptorBase now is a ModelBase class

39f308c

rozyczko added [scope] maintenance Code/tooling cleanup, no feature or bugfix (major.minor.PATCH) [priority] high Should be prioritized soon [area] base classes Changes to or creation of new base classes labels Sep 4, 2026

rozyczko added 2 commits September 4, 2026 21:25

updated handling of unique_names

fda0d28

updated docstrings and some docs

c02814f

rozyczko changed the title ~~DescriptorBase now is a ModelBase class~~ DescriptorBase now is a NewBase class Sep 7, 2026

damskii9992 requested changes Sep 9, 2026

View reviewed changes

PR issues addressed

4c3a8b4

rozyczko requested a review from damskii9992 September 11, 2026 10:57

rozyczko added 2 commits September 11, 2026 15:13

Merge branch 'easylist-on-multifitter' into modelbase-on-descriptor

08b08e9

fix the behaviour when parameters are passed

03f86be

		# Registers the descriptor with the global object map and takes
		# care of `unique_name` and `display_name`.

		`ModelBase`, `EasyList`; the legacy `ObjBase` and `CollectionBase` are
		deprecated).

Uh oh!

Conversation

rozyczko commented Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Sep 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

damskii9992 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rozyczko commented Sep 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rozyczko commented Sep 4, 2026 •

edited

Loading

codecov Bot commented Sep 4, 2026 •

edited

Loading