Skip to content

[DEV-7731] implement identifiable interface#218

Merged
charlta merged 11 commits intomainfrom
DEV-7731-implement-identifiable-interface
Apr 7, 2026
Merged

[DEV-7731] implement identifiable interface#218
charlta merged 11 commits intomainfrom
DEV-7731-implement-identifiable-interface

Conversation

@chestm007
Copy link
Copy Markdown
Contributor

Description

Port over jvm sdk changes.

changes that snuck in:

  • renamed decorator add_to_network_or_none to add_to_service_or_none
  • Fixed up alot of the docs in BaseService while i was in there, didnt touch the child classes as i wasnt there, but they need doing too

Associated tasks

List any other tasks / PRs that are required to be merged alongside this one (e.g. front end task for back end change or vice versa). If a PR exists, add a link. If not, just add an appropriate note here so reviewers know there is a dependency and will hold off merging until all things are ready.

Test Steps

Explain in detail how your reviewer can test the changes proposed in this PR. If it cannot be tested, leave an explanation on why.

Checklist

If any of these are not applicable, strikethrough the line ~like this~. Do not delete it!. Let the reviewer decide if you should have done it.

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.

Please leave a summary of the breaking changes here and then post it on the Slack breaking-changes channel to notify the team about it.

@ryanjcoleman
Copy link
Copy Markdown
Member

Task linked: DEV-7731 Update Python SDK

@chestm007 chestm007 requested review from charlta and kgreav March 23, 2026 03:15
@charlta charlta marked this pull request as draft March 23, 2026 06:47
Copy link
Copy Markdown
Member

@charlta charlta left a comment

Choose a reason for hiding this comment

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

How much fun did you have trying to figure out what parts of the JVM SDK change you needed to pull across with the vastly different way the proto2cim stuff works? It was a PITA for me to review 😜

@chestm007 chestm007 force-pushed the DEV-7731-implement-identifiable-interface branch from d05214e to 5c3979d Compare March 30, 2026 01:46
@chestm007 chestm007 marked this pull request as ready for review March 30, 2026 01:51
@charlta charlta self-requested a review March 30, 2026 06:47
chestm007 and others added 4 commits April 7, 2026 17:47
…` subclasses of ``Identifiable``

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

a

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

make ``Name`` a subclass of identifiable

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

bump zepben.protobuf to 1.4.0b4. and make work

Function names, Type hints, docs, and much more are WRONG, but the code works.
Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

GrpcClient kinda done, could definitely refactor some of the child classes into this base to dedupe stuff

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

BaseService, Differences and Comparator. Difference, ReferenceResolvers

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

rename `add_to_network_or_none` to `add_to_service_or_none` as network is misleading and wrong.

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

I think thats all.

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

missed some stuff, docs on BaseService were all sorts of whack

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

PR Changes

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

fix type hinting in ServiceComparatorValidator

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

sum hints bad, good now

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

parameterise, and make pretty

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

name.mrid and stuff

Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>
Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>
Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
@charlta charlta force-pushed the DEV-7731-implement-identifiable-interface branch from 5c3979d to e3f28cf Compare April 7, 2026 08:10
@charlta charlta changed the title Dev 7731 implement identifiable interface [DEV-7731] implement identifiable interface Apr 7, 2026
charlta added 7 commits April 7, 2026 18:37
…ate_reference_by_field` to `Identifiable`

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
…`Identifiable` or `IdentifiedObject`

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
…wasn't.

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
…ving them when unused.

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>
@charlta charlta force-pushed the DEV-7731-implement-identifiable-interface branch from f50c7c0 to 5eb05af Compare April 7, 2026 12:38
@charlta charlta merged commit 5ab2087 into main Apr 7, 2026
5 checks passed
@charlta charlta deleted the DEV-7731-implement-identifiable-interface branch April 7, 2026 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants