simonsobs / simonsobs/ocs

Log more detail when "Block structure does not match" in feed

Open
#336 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
19
Forks
7
PR merge metrics
No merged PRs in 30d

Description

In ocs_feed.py, Block object raises exceptions if "Block structure does not match", in the append/extend methods. However, no detail is provided in these (such as which keys are offending). Since it's often hardware failure / reconnection issues that lead to this happening, and such situations are difficult to efficiently (re-)produce, it would be helpful to increase verbosity in those error messages!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in ocs_feed.py and inspect the Block object's append and extend methods, where the "Block structure does not match" exceptions are raised. Update the error details so the offending structure or keys can be identified, then verify that both methods report useful diagnostic information when the mismatch occurs.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
distributed-systems
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.