feat: keep track of line numbers when making exceptions

[clintval]

Closes #12

Summary by CodeRabbit

• Bug Fixes
  • Improved error messages during data processing to clearly indicate the exact location of issues.
  • Refined data record formatting to ensure consistent output without extra formatting artifacts.

[coderabbitai]

Walkthrough

This pull request makes adjustments to tests and core file reader/writer modules. In the tests, newline characters have been removed from header and data rows, and the expected error message is updated to include the line number. In the reader module, a new _line_count attribute is added to track processed lines, type annotations are tightened, a line terminator is set for the DictReader, and the error message now includes line information. The writer module has been refactored for clarity: header initialization now reuses the existing field list, comments and docstrings are simplified, and error messages are reformatted as a single string.

Changes

File	Change Summary
tests/test_reader.py	Removed newline characters from header and data rows; updated expected error message to explicitly reference "line 2" in the exception handling.
typeline/_reader.py	Introduced _line_count to track processed lines; updated JSONDecoder type to JSONDecoder[dict[str, JsonType]]; added lineterminator to DictReader initialization; enhanced error messages with line count; updated call to convert with the str_keys=True argument.
typeline/_writer.py	Revised comments to indicate only fields and names are saved; streamlined header initialization by reusing _fields; updated the _encode method’s docstring; reformatted the error message in the write method into a single continuous string.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as "Data Reader Caller"
    participant Reader as "DelimitedDataReader"
    participant Filter as "_filter_out_comments"
    participant Decoder as "JSONDecoder"
    participant Converter as "convert"

    Caller->>Reader: Initiate data reading
    Reader->>Filter: Process input lines (increment _line_count)
    Filter-->>Reader: Return filtered lines
    Reader->>Decoder: Decode data record
    alt Successful decode
        Decoder-->>Reader: Decoded record
        Reader->>Converter: Convert record with str_keys=True
        Converter-->>Reader: Converted record
        Reader-->>Caller: Yield processed record
    else Decode error occurs
        Decoder-->>Reader: Return error
        Reader-->>Caller: Raise error detailing current _line_count
    end

Loading

Possibly related PRs

• feat: enhance exception message on conversion error #2: Updates error handling and messaging in the DelimitedStructReader class, which connects closely with the revised error messages and line tracking changes featured in this PR.

Poem

In code meadows, I hop and play,
Tweaking errors in a clever way.
I count each line with a rhythmic beat,
Reforming strings to make tests neat.
With carrot-keen eyes on every fix,
This rabbit cheers for code that clicks!
🥕🐇 Happy hopping in every line!

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1220078 and 102ee9f.

📒 Files selected for processing (3)

• tests/test_reader.py (2 hunks)
• typeline/_reader.py (6 hunks)
• typeline/_writer.py (2 hunks)

🧰 Additional context used

🪛 GitHub Check: unit-tests (3.11)

typeline/_writer.py

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.12)

typeline/_writer.py

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.10)

typeline/_writer.py

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.13)

typeline/_writer.py

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🔇 Additional comments (16)

tests/test_reader.py (2)

210-211: LGTM: Removing unnecessary newlines.

Removing the newline characters from the test data simplifies the test and helps focus on testing the core functionality.

---

220-220: Proper update to reflect line number tracking.

The error message assertion now correctly expects the line number in the error message, which aligns with the PR's objective of including line numbers in exceptions.

typeline/_writer.py (6)

47-48: Simplified comment for better clarity.

The comment now more accurately reflects what's being saved, focusing just on fields and field names.

🧰 Tools

🪛 GitHub Check: unit-tests (3.11)

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.12)

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.10)

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

🪛 GitHub Check: unit-tests (3.13)

[warning] 48-48:
Type Any is not allowed (reportExplicitAny)

---

49-50: Memory optimization by reusing existing field list.

Good optimization by using the already populated _fields attribute instead of calling fields_of(record_type) again.

---

51-52: Improved comment clarity for JSON encoder.

The comment now more accurately describes the purpose of the JSON encoder.

---

54-55: Clarified comment for DictWriter configuration.

The comment now correctly explains that platform-dependent newlines will be used.

---

87-88: Simplified docstring for better readability.

The docstring now concisely explains what the method does without unnecessary details.

---

94-95: Reformatted error message for better readability.

Converting multi-line error message to a single line improves code consistency and readability.

typeline/_reader.py (8)

12-12: Added necessary import for line terminator consistency.

This import is needed for the new lineterminator parameter used in the DictReader initialization.

---

66-66: Core feature: Line number tracking implementation.

This new attribute implements the primary feature of this PR - tracking the current line number during file processing, which allows for more informative error messages.

---

76-76: Improved type annotation specificity.

The more specific type annotation for the JSON decoder increases type safety by clearly defining the expected structure of decoded data.

---

82-83: Enhanced DictReader configuration.

Adding the lineterminator parameter ensures consistent handling of line endings across platforms, which improves reliability.

---

89-89: Improved conditional check clarity.

Using explicit comparison with is not None makes the code more readable and follows Python best practices.

---

117-118: Core feature: Incrementing line counter.

This is where the line counter is actually incremented for each processed line, enabling the line number tracking feature.

---

130-130: Added string keys parameter for consistency.

Adding str_keys=True ensures dictionary keys are consistently handled as strings, which is important for proper JSON conversion.

---

156-156: Core feature: Enhanced error message with line information.

This change accomplishes the main goal of the PR by including the line number in the error message, providing users with more context about where errors occur.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

Documentation and Community

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