allow prodml files without gauge length #518

d-chambers · 2025-08-23T13:00:39Z

Description

Turns out the request in #501 was super easy to implement. We just need to loosen the ProdML attrs we are looking for to allow files without GaugeLength. After doing that, DASCore can read the prodml files included in the mentioned data.

Checklist

I have (if applicable):

referenced the GitHub issue this PR closes.
documented the new feature with docstrings or appropriate doc page.
included a test. See testing guidelines.
your name has been added to the contributors page (docs/contributors.md).
added the "ready_for_review" tag once the PR is ready to be reviewed.

Summary by CodeRabbit

Bug Fixes
- Improved ProdML file compatibility by relaxing the required attributes for detection. Files missing GaugeLength are now correctly recognized as ProdML.
- Reduces false negatives when opening or identifying ProdML datasets, improving import reliability without affecting version reporting.
- No user action needed; previously rejected files should now open as expected.

coderabbitai · 2025-08-23T13:00:46Z

Walkthrough

Removed "GaugeLength" from EXPECTED_ATTRS in ProdML utils, reducing required attributes for is_prodml. Fingerprint now checks PulseRate, PulseWidth, NumberOfLoci, schemaVersion, and uuid. _get_prodml_version_str behavior is unchanged: returns version when is_prodml is true, else an empty string.

Changes

Cohort / File(s)	Summary
ProdML utils `dascore/io/prodml/utils.py`	Modified EXPECTED_ATTRS to drop "GaugeLength", updating is_prodml fingerprint requirement; no other logic changes.

Sequence Diagram(s)

sequenceDiagram
  participant Caller
  participant Utils as prodml.utils
  Caller->>Utils: is_prodml(attrs)
  Utils->>Utils: Check required attrs {PulseRate, PulseWidth, NumberOfLoci, schemaVersion, uuid}
  alt All present
    Utils-->>Caller: true
    Caller->>Utils: _get_prodml_version_str(attrs)
    Utils-->>Caller: schemaVersion
  else Missing any
    Utils-->>Caller: false
    Caller->>Utils: _get_prodml_version_str(attrs)
    Utils-->>Caller: ""
  end

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

bug

Poem

I nibbled one field from the checklist line,
GaugeLength hopped off—now the rest align.
Pulse beats, width sings, loci in view,
Schema and uuid—that’ll do!
With lighter paws our parser will run,
Hippity-hop, one less to shun. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a89ff7b and 6ea8d41.

📒 Files selected for processing (1)

dascore/io/prodml/utils.py (0 hunks)

💤 Files with no reviewable changes (1)

dascore/io/prodml/utils.py

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (15)

GitHub Check: test_code (windows-latest, 3.10)
GitHub Check: test_code (windows-latest, 3.11)
GitHub Check: test_code (windows-latest, 3.12)
GitHub Check: test_code (macos-latest, 3.11)
GitHub Check: test_code (ubuntu-latest, 3.11)
GitHub Check: test_code (ubuntu-latest, 3.10)
GitHub Check: test_code_min_deps (windows-latest, 3.13)
GitHub Check: test_code (macos-latest, 3.12)
GitHub Check: test_code (ubuntu-latest, 3.12)
GitHub Check: test_code (macos-latest, 3.10)
GitHub Check: test_code_min_deps (ubuntu-latest, 3.13)
GitHub Check: test_code_min_deps (macos-latest, 3.12)
GitHub Check: test_code_min_deps (windows-latest, 3.12)
GitHub Check: test_code_min_deps (ubuntu-latest, 3.12)
GitHub Check: test_code_min_deps (macos-latest, 3.13)

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix_501

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-08-23T13:03:06Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.87%. Comparing base (a89ff7b) to head (6ea8d41).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #518   +/-   ##
=======================================
  Coverage   99.87%   99.87%           
=======================================
  Files         118      118           
  Lines        9732     9732           
=======================================
  Hits         9720     9720           
  Misses         12       12

Flag	Coverage Δ
unittests	`99.87% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

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

allow prodml files without gauge length

6ea8d41

d-chambers added the IO Work for reading/writing different formats label Aug 23, 2025

d-chambers merged commit a8fd0bc into master Aug 23, 2025
20 checks passed

d-chambers deleted the fix_501 branch August 23, 2025 13:25

d-chambers mentioned this pull request Aug 23, 2025

Extended file format handling #501

Closed

coderabbitai bot mentioned this pull request Sep 9, 2025

add prodml pulse width units #531

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

allow prodml files without gauge length #518

allow prodml files without gauge length #518

Uh oh!

d-chambers commented Aug 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Aug 23, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

codecov bot commented Aug 23, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

allow prodml files without gauge length #518

allow prodml files without gauge length #518

Uh oh!

Conversation

d-chambers commented Aug 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested labels

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

codecov bot commented Aug 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

d-chambers commented Aug 23, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Aug 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Aug 23, 2025 •

edited

Loading