Skip to content

Conversation

lmichel
Copy link
Contributor

@lmichel lmichel commented Sep 4, 2025

This MR only relates to the annotation readout.

Code cleaning:

  • Unused module XmlViewer + dependencies has been removed
  • Glossary has been cleaned up

MivotViewer:

  • Able to process TEMPLATES with multiple INSTANCES. This is necessary for those who want to use MANGO in sparse mode (see the spec)
  • Give access to global INSTANCEs as MivotInstances

This PR improves the current API. It will be extended with model specific modules once MANGO will be a REC. At that time new MANGO-specific features will be completed.

@codecov
Copy link

codecov bot commented Sep 4, 2025

Codecov Report

❌ Patch coverage is 89.76378% with 13 lines in your changes missing coverage. Please review.
✅ Project coverage is 84.04%. Comparing base (e892b23) to head (d71cdeb).
⚠️ Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
pyvo/mivot/features/sky_coord_builder.py 85.52% 11 Missing ⚠️
pyvo/mivot/viewer/mivot_viewer.py 95.45% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #698      +/-   ##
==========================================
- Coverage   84.09%   84.04%   -0.06%     
==========================================
  Files          80       79       -1     
  Lines        8556     8535      -21     
==========================================
- Hits         7195     7173      -22     
- Misses       1361     1362       +1     

☔ 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.

@lmichel lmichel marked this pull request as ready for review October 8, 2025 08:51
Copy link
Member

@bsipocz bsipocz left a comment

Choose a reason for hiding this comment

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

Some minor nitpicking comments

Copy link
Member

Choose a reason for hiding this comment

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

Does this file still needed or remained/renamed here as an accident?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

File removed, this was probably due to an unfortunate git add -A

sparse: boolean, optional (default to False)
If True, all properties are added in a independent way to the the TEMPLATES.
They are packed in a MangoObject otherwise.
schema_check: boolean, optional (default to True)
Copy link
Member

Choose a reason for hiding this comment

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

We need to run a docs format checker (to be done separately from this PR), this is just a reminder mostly to myself to do it (these white spaces affect the actual API docs rendering)

Suggested change
schema_check: boolean, optional (default to True)
schema_check : boolean, optional (default to True)

Copy link
Contributor Author

@lmichel lmichel Oct 9, 2025

Choose a reason for hiding this comment

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

Fixed, but I found out tens of occurrences of this pattern (/[a-z]: /) in many files. I prefer to have your green light before to increase the number of modified files. Could this be done in a specific PR?

Copy link
Member

Choose a reason for hiding this comment

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

yes, let's not mix those changes into this PR but do it separately, and I'll also try to remember to pick a tool that does that linting for us.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll open a dedicated PR once this one will be merged.



@prototype_feature('MIVOT')
class XMLViewer:
Copy link
Member

Choose a reason for hiding this comment

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

This was a prototype, so I suppose changing the API without any prior notice is fine and thus this can be removed without deprecation. But this class was mentioned in the narrative docs, so it's just something to be aware of.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

made it more explicit in the change log

Comment on lines 306 to 309
raise MivotError(
"Can't find " + Ele.INSTANCE
+ " in " + Ele.TEMPLATES
)
Copy link
Member

Choose a reason for hiding this comment

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

absolute nitpicking, but I feel this could all fit in one line; we're quite liberal with line lengths and allow them to be up to 110 characters

Copy link
Member

Choose a reason for hiding this comment

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

A bunch of public methods and attributes have changed here. As the whole module was marked as a prototype I feel it's totally fine, but it is still something we need to keep in mind and maybe explicitly mention in the docs/changelog.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made the changelog more explicit while ensuring that it remains compact. I added an attention notice on the top of viewer.rst

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants