Skip to content

Commonlines Class Reorg#1322

Merged
j-c-c merged 4 commits intodevelopfrom
CL_reorg
Nov 14, 2025
Merged

Commonlines Class Reorg#1322
j-c-c merged 4 commits intodevelopfrom
CL_reorg

Conversation

@j-c-c
Copy link
Collaborator

@j-c-c j-c-c commented Sep 4, 2025

Reorganization of CL class hierarchy. This PR decouples the commonline C2, C3C4, and Cn classes, with all now inheriting from the base class CLOrient3D. This was accomplished by:

  • Creating a commonline_utils.py file to hold shared helper functions
  • Making a JSync class to provide J-synchronization via composition
  • Move shared sync_voting method into the SyncVotingMixin
  • init cleanups

There is still some cleanup and self review work needed.

This PR is to be followed up by a PR creating a CLMatrix class (a subclass of the CL base class CLOrient3D) to deploy a commonlines matrix build to only the class that uses it.

@j-c-c j-c-c self-assigned this Sep 4, 2025
@j-c-c j-c-c added the cleanup label Sep 4, 2025
@codecov
Copy link

codecov bot commented Sep 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.65%. Comparing base (5cc94ee) to head (0628396).
⚠️ Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1322      +/-   ##
===========================================
- Coverage    90.65%   90.65%   -0.01%     
===========================================
  Files          133      134       +1     
  Lines        14433    14431       -2     
===========================================
- Hits         13084    13082       -2     
  Misses        1349     1349              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Collaborator

@garrettwrong garrettwrong left a comment

Choose a reason for hiding this comment

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

Okay, took a look around. Main concern is written out regarding the sync voting component. Couple other minor questions. Nothing unexpected.

I did not meticulously check the interfaces and docs etc yet. I think the code might still change a bit. I was surprised no minor updates were required for interfaces/params/defaults, but perhaps we've gotten most of them over time. That would be great.

I do think you'll need to overhaul the docs, if only to clean them up and make consistent from five authors and multiple doc styles.... but I will let you decide whether you want to do that stage wise or as an additional round at the end (probably most efficient). Keep track of the architecture as you work each project stage, because the entirety of it should be documented at the end.

@j-c-c j-c-c force-pushed the CL_reorg branch 3 times, most recently from e360209 to 03a70a5 Compare September 26, 2025 18:11
@j-c-c j-c-c requested a review from garrettwrong September 26, 2025 18:11
@j-c-c
Copy link
Collaborator Author

j-c-c commented Sep 26, 2025

@garrettwrong this is ready for another look. The main changes are giving JSync it's own file, converting the SyncVotingMixin to a module of functions, and some clean up related to your other comments.

@j-c-c
Copy link
Collaborator Author

j-c-c commented Sep 26, 2025

Hmm, haven't seen that failure before. Will rerun CI once it finishes.

@garrettwrong
Copy link
Collaborator

@j-c-c Is this good for another look? Thanks

@j-c-c
Copy link
Collaborator Author

j-c-c commented Nov 4, 2025

@j-c-c Is this good for another look? Thanks

@garrettwrong yes, this is ready for another look. Thanks

Copy link
Collaborator

@garrettwrong garrettwrong left a comment

Choose a reason for hiding this comment

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

Cool, thanks. I didn't review the doc changes because I expect you'll get those all together later.

@j-c-c j-c-c marked this pull request as ready for review November 6, 2025 12:34
@j-c-c j-c-c requested a review from janden as a code owner November 6, 2025 12:34
Copy link
Collaborator

@janden janden left a comment

Choose a reason for hiding this comment

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

Nice! Looks like quite a lot of code deduplication…

@j-c-c j-c-c merged commit 34f82da into develop Nov 14, 2025
64 of 65 checks passed
@j-c-c j-c-c mentioned this pull request Nov 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants