DEV-2963 Update Python SDK by chestm007 · Pull Request #185 · zepben/ewb-sdk-python

chestm007 · 2025-06-04T07:45:34Z

Description

Fixes a phase tracing bug, adds logging, and allows NetworkTrace to start on a known NetworkTraceStep.Path

Associated tasks

https://app.clickup.com/t/6929263/DEV-3187
https://app.clickup.com/t/6929263/DEV-3188
https://app.clickup.com/t/6929263/DEV-3189

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

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

Documentation

[ X ] I have updated the changelog.
I have updated any documentation required for these changes.

Breaking Changes

[ X ] 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 · 2025-06-04T07:45:40Z

Task linked: DEV-3187 add debug logging

chestm007 · 2025-06-04T07:52:24Z

inconsistent method/function argument indentation:

def func(self, var
               var2):

wrong docstring format:

"""
@param foo
...
`arg_name` arg desc
...
`argName` arg desc about [ClassName]
...

are all part of another change I'll put in PR, have the changes in a branch - fix-inconsistencies-in-PR-185

src/zepben/evolve/services/network/tracing/find_swer_equipment.py

src/zepben/evolve/services/network/tracing/traversal/debug_logging.py

src/zepben/evolve/services/network/tracing/networktrace/network_trace.py

src/zepben/evolve/services/network/tracing/traversal/traversal.py

test/services/network/tracing/traversal/test_debug_logging_wrapper.py

test/services/network/tracing/traversal/test_traversal.py

src/zepben/evolve/services/network/tracing/feeder/assign_to_feeders.py

ryanjcoleman · 2025-06-05T03:48:50Z

Task linked: DEV-2963 Update Python SDK

ryanjcoleman · 2025-06-05T03:50:20Z

Task linked: DEV-3188 NetworkTrace should support starting from a known NetworkTraceStep.Path
Task linked: DEV-3189 Fix bug this task is a child of

src/zepben/evolve/services/network/tracing/feeder/set_direction.py

src/zepben/evolve/services/network/tracing/phases/remove_phases.py

src/zepben/evolve/services/network/tracing/networktrace/network_trace.py

changelog.md

src/zepben/evolve/services/network/tracing/networktrace/network_trace.py

src/zepben/evolve/services/network/tracing/phases/remove_phases.py

test/services/network/tracing/traversal/test_debug_logging_wrapper.py

test/services/network/tracing/traversal/test_traversal.py

charlta · 2025-06-19T09:29:37Z

Marked as draft till rebased to resolve conflicts

…`Tracing` methods and `TestNetworkBuilder.build`. Just need to write the tests for the actual wrapper Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

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

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

… favor of builtins Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

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

need to expose this via either the `.add*` commands in `Traversal`, a class attribute on `Traversal` or a global. Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

…s if_[not_]stopping() actions 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: Max Chesterfield <max.chesterfield@zepben.com>

…PhaseCode.ABC + PhaseCode.N) and removed last remaining **kwargs. Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>

chestm007 requested a review from Esaotuelr June 4, 2025 07:54

charlta force-pushed the debug-logging branch from 4117d52 to 342c258 Compare June 4, 2025 08:28

chestm007 force-pushed the debug-logging branch 2 times, most recently from 118c11e to 89eaa99 Compare June 4, 2025 10:39

charlta requested changes Jun 4, 2025

View reviewed changes

charlta marked this pull request as draft June 4, 2025 11:05

Esaotuelr reviewed Jun 5, 2025

View reviewed changes

src/zepben/evolve/services/network/tracing/feeder/assign_to_feeders.py Show resolved Hide resolved

chestm007 changed the title ~~[DEV-3187] Debug logging~~ DEV-2963 Update Python SDK Jun 5, 2025

Esaotuelr reviewed Jun 5, 2025

View reviewed changes

src/zepben/evolve/services/network/tracing/feeder/set_direction.py Show resolved Hide resolved

Esaotuelr reviewed Jun 6, 2025

View reviewed changes

src/zepben/evolve/services/network/tracing/phases/remove_phases.py Show resolved Hide resolved

src/zepben/evolve/services/network/tracing/networktrace/network_trace.py Outdated Show resolved Hide resolved

chestm007 marked this pull request as ready for review June 9, 2025 08:15

charlta requested changes Jun 17, 2025

View reviewed changes

charlta marked this pull request as draft June 17, 2025 07:02

chestm007 marked this pull request as ready for review June 19, 2025 06:15

charlta marked this pull request as draft June 19, 2025 09:29

charlta self-requested a review June 19, 2025 09:29

chestm007 added 9 commits June 19, 2025 20:26

Add debug logging to Traversal and traces and exposed them via all …

73d1f1e

…`Tracing` methods and `TestNetworkBuilder.build`. Just need to write the tests for the actual wrapper Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

reworked the logger slightly, added heaps of docs to it

5e9819e

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

Minor formatting fix

1605456

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

update changelog

acf03df

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

Moving docstrings to where they should be, de-duping code

6f66585

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

Revert change not related to branch for later commit

c3a9e8d

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

updated copypasta changelog to contain the actual var/object names

5bf66ab

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

commitlog bro.

8746e90

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

fix docstring formatting, code layout, and general messy code caused …

3ad58b0

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

chestm007 added 15 commits June 19, 2025 20:27

more docstrings, some code changes to remove __code__ dunder usage in…

76540ab

… favor of builtins Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

moar docstrings

e70c7a7

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

DEV-3188-Network-Trace-can-start-on-path

fa65267

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

DEV-3189-assign-phases-bug

79cecbf

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

missed name for FindSwerEquipment._create_trace

984243c

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

allow deliberate rewrapping with DebugLoggingWrapper

7752745

need to expose this via either the `.add*` commands in `Traversal`, a class attribute on `Traversal` or a global. Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

allow adding StepAction and StepActionWithContextValue to Traversal a…

bdba29d

…s if_[not_]stopping() actions Signed-off-by: Max Chesterfield <max.chesterfield@zepben.com>

remove old redundant error and default arg

3cf1ee4

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

rewrapping was a terrible idea, lets not do that

9d821fe

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

fix some type hinting and docstrings

a983dbd

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

remove count from debug logging, fix network builder

8921115

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

simplify code and remove unrequired exceptions, params, etc

5167172

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

allow renaming of wrapped attrs

6a3000e

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

rename tests

9914e7a

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

fixed bad conflict resolutions

fb360cb

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

chestm007 force-pushed the debug-logging branch from d487d71 to fb360cb Compare June 19, 2025 10:35

chestm007 marked this pull request as ready for review June 23, 2025 00:47

charlta marked this pull request as draft June 23, 2025 09:14

charlta and others added 2 commits June 26, 2025 14:08

Added StepAction test to highlight issue with apply and _apply

1d2f9cc

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>

PR Changes

147e29e

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

chestm007 force-pushed the debug-logging branch from 406f816 to 147e29e Compare June 26, 2025 05:54

chestm007 marked this pull request as ready for review June 26, 2025 05:54

charlta added 2 commits July 1, 2025 11:08

Simplified phase codes with neutrals (e.g. PhaseCode.ABCN instead of …

431b355

…PhaseCode.ABC + PhaseCode.N) and removed last remaining **kwargs. Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>

Formatting fixes and removed unused imports.

ffe3278

Signed-off-by: Anthony Charlton <anthony.charlton@zepben.com>

charlta approved these changes Jul 1, 2025

View reviewed changes

charlta merged commit 9c4aa0b into main Jul 1, 2025
3 checks passed

charlta deleted the debug-logging branch July 1, 2025 06:38

Conversation

chestm007 commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Associated tasks

Test Steps

Checklist

Code

Documentation

Breaking Changes

Uh oh!

ryanjcoleman commented Jun 4, 2025

Uh oh!

chestm007 commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryanjcoleman commented Jun 5, 2025

Uh oh!

ryanjcoleman commented Jun 5, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

charlta commented Jun 19, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

chestm007 commented Jun 4, 2025 •

edited

Loading

chestm007 commented Jun 4, 2025 •

edited

Loading