Dev 9850 remove list boilerplate

[Boris-Filin]

Description

Add a new suite of classes such as MridList that implement nullable list functionality with advanced item validation. This avoids defining list handling methods (len, get, add, remove, clear) for most of the one-to-many relationships in the SDK.

Associated tasks

Java parity PR

• Dev 3625 remove list boilerpate ewb-sdk-jvm#280

Test Steps

Run tests (new ones were created to test lists, old ones still run); Load a model from a db and perform arbitrary work on it to ensure no tool functionality was broken
(Note: The change is made to be mostly backwards compatible, this is not expected to be an issue)

Checklist

Code

• I have performed a self review of my own code (including checking issues raised when creating the PR).
• I have added/updated unit tests for these changes, and if not I have explained why they are not necessary.
• I have commented my code in any hard-to-understand or hacky areas.
• I have handled all new warnings generated by the compiler or IDE.
• I have rebased onto the target branch (usually main).

Security

When developing applications, use following guidelines for information security considerations:

• Access to applications should be protected with security keys/tokens or usernames and passwords;
• All sessions are encrypted if possible;
• All application input is sanitised before being acted on (ie SQL statements, etc);
• Log messages, and especially client-facing ones, must be handled securely and must not leak credentials information (internal URLs, passwords, tokens).

• I have considered if this change impacts information security and made sure those impacts are handled.

Documentation

• I have updated the changelog.
• I have updated any documentation required for these changes.

Breaking Changes

• I have considered if this is a breaking change and will communicate it with other team members by posting it on the Slack breaking-changes channel.

• Every CIM class now has to be instantiated with keyword arguments. The only accepted positional argument is mRID.

[ryanjcoleman]

Task linked: DEV-9850 Update Python SDK

[charlta]

As requested I didn't do a full in depth review, just commenting on things that stood out. Overall looks pretty good.

[charlta]

question: Why did iter( need to be added in all these places?

If this is a new requirement it is a major breaking change for anyone using these collections. Can anything be done to remove this requirement?

[Boris-Filin]

next() calls are supposed to break on lists, because they are not themselves iterators iter(list) produces an iterator that stores the current index. We can easily support the old syntax, but it would be a hack. I will add this change to the breaking changes list, but let me know if you want the backwards compatibility instead.

[charlta]

@kgreav Are you happy with this breaking change going in or need the new collections to be iterators themselves and implement __next__?

[charlta]

question: Should this be an IndexError?

[Boris-Filin]

Indeed. Used ValueError for test parity, but it's fixed now in code and in tests

[charlta]

question: Can this be replaced with Identifiable? If not, what classes stop it?

[Boris-Filin]

replaced it

[charlta]

todo: Can we make the way these things check be consistent? The first three in the PR are all different, but essentially doing the same thing of "find first item or throw error".

AcLineSegmentPhaseList:

res = next((it for it in self if it.phase == phase), None)
        if res is None:
            raise KeyError(phase)
        return res

BatteryControlList:

        for control in self:
            if control.control_mode == control_mode:
                return control
        raise IndexError(f"No BatteryControl with a control_mode of {control_mode} was found in BatteryUnit {str(self)}")

CurveDataList:

        curve_data = next((it for it in self if it.x_value == x), None)
        if curve_data:
            return curve_data
        raise KeyError(x)

[Boris-Filin]

added a find_by function in the base collection that takes a callable predicate. equivalent of find in Kotlin.

[charlta]

todo: validate these all have correct language in them. i.e. this should be "A Terminal"

[Boris-Filin]

Validated. Also changed the index error in the index list to have a more consistent element description (also "A Thing", capitalised - moved the sentence around)

[charlta]

question: Why are types removed?

[charlta]

question: I assume we have some of these inits left over because parameter names don't match field names. Is this something we can mark as deprecated, as ideally we use the same args as property names.