Filesystem: Add reader for Excel XLSX files

[amotl]

About

A connector for reading spreadsheets from Excel XLSX workbook files was dearly missing. It uses Polars' read_excel.

References

• Discuss and resolve ambiguities with file and table formats #106
• ValueError: Unsupported source scheme: file #120

[read-the-docs-community]

Documentation build overview

📚 omniload | 🛠️ Build #33573931 | 📁 Comparing cf1c6a5 against latest (f74d292)

  🔍 Preview build  

37 files changed · + 20 added · ± 12 modified · - 5 deleted

+ Added

• getting-started/file-format-routing.html
• supported-sources/amqp.html
• supported-sources/azure-blob-storage.html
• supported-sources/azure-data-lake-storage.html
• supported-sources/bson.html
• supported-sources/cbor.html
• supported-sources/file.html
• supported-sources/google-analytics.html
• supported-sources/google-cloud-storage.html
• supported-sources/google-sheets.html
• and 10 more...

± Modified

• changelog.html
• commands/ingest.html
• getting-started/incremental-loading.html
• supported-sources/athena.html
• supported-sources/bigquery.html
• supported-sources/index.html
• supported-sources/intercom.html
• supported-sources/kafka.html
• supported-sources/kinesis.html
• supported-sources/rabbitmq.html
• and 2 more...

- Deleted

• supported-sources/custom_queries.html
• supported-sources/gcs.html
• supported-sources/google_analytics.html
• supported-sources/gsheets.html
• supported-sources/postgres.html

[codecov]

Codecov Report

❌ Patch coverage is 87.50000% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 54.40%. Comparing base (268143f) to head (ec5a2e1).

Files with missing lines	Patch %	Lines
omniload/source/filesystem/adapter.py	77.77%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #123      +/-   ##
==========================================
+ Coverage   54.33%   54.40%   +0.06%     
==========================================
  Files         203      203              
  Lines        9574     9582       +8     
==========================================
+ Hits         5202     5213      +11     
+ Misses       4372     4369       -3     

☔ View full report in Codecov by Harness.
📢 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.

[coderabbitai]

Warning

Review limit reached

@amotl, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 28 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: fe18fd53-753f-4358-8c55-7cb95f0c38df

📥 Commits

Reviewing files that changed from the base of the PR and between a6682b1 and cf1c6a5.

📒 Files selected for processing (16)

• docs/changelog.md
• docs/supported-sources/file.md
• docs/supported-sources/xlsx.md
• omniload/source/filesystem/adapter.py
• omniload/source/filesystem/format/readers.py
• omniload/source/filesystem/format/registry.py
• omniload/source/filesystem/impl/local.py
• omniload/source/filesystem/model.py
• omniload/source/filesystem/router.py
• omniload/target/filesystem/local.py
• omniload/target/model.py
• pyproject.toml
• tests/main/filesystem/test_local_write.py
• tests/main/filesystem/test_remote.py
• tests/main/filesystem/test_source_hints.py
• tests/warehouse/filesystem/test_excel.py

Walkthrough

Adds XLSX ingestion to filesystem sources, including format detection, worksheet hints, Polars-based reading, local destination naming, runtime dependencies, integration tests, and documentation updates.

Changes

XLSX filesystem support

Layer / File(s)	Summary
Reader and adapter wiring omniload/source/filesystem/format/readers.py, omniload/source/filesystem/adapter.py	Adds read_excel, exposes it through the reader resource, and binds XLSX reader hints such as sheet_name.
Format registration and hint contract omniload/source/filesystem/format/registry.py, omniload/source/filesystem/router.py, omniload/source/filesystem/model.py, omniload/source/filesystem/impl/local.py, tests/main/filesystem/*	Maps xlsx to read_excel and updates filesystem hint examples and expectations from sheet to sheet_name.
Destination filename handling omniload/target/model.py, omniload/target/filesystem/local.py	Adds the default public dataset and derives the destination table name from the URI filename when no table is supplied.
Dependencies and ingestion validation pyproject.toml, tests/warehouse/filesystem/test_excel.py, tests/main/filesystem/test_remote.py	Adds Excel runtime dependencies and tests explicit, default, and invalid worksheet selection.
XLSX documentation docs/supported-sources/file.md, docs/supported-sources/xlsx.md, docs/changelog.md	Documents XLSX detection, hints, supported source schemes, ingestion behavior, examples, and the in-progress changelog entry.

Estimated code review effort: 3 (Moderate) | ~25 minutes

Sequence Diagram(s)

sequenceDiagram
  participant SourceURI
  participant FilesystemAdapter
  participant ExcelReader
  participant Polars
  SourceURI->>FilesystemAdapter: Parse xlsx format and sheet_name hint
  FilesystemAdapter->>ExcelReader: Select read_excel and bind hints
  ExcelReader->>Polars: Read workbook bytes
  Polars-->>ExcelReader: Return worksheet rows
  ExcelReader-->>FilesystemAdapter: Yield named records

Loading

Possibly related PRs

• panodata/omniload#160: Related reader and resource_for_reader wiring in the filesystem adapter.
• panodata/omniload#166: Related local filesystem destination implementation.

Suggested reviewers: hampsterx

Poem

I’m a rabbit with a workbook to read,
Hopping through sheets at lightning speed.
XLSX rows bloom, hints point the way,
DuckDB welcomes the harvest today.
Hop, hop—Excel joins the array!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 64.71% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: adding XLSX file reading support.
Description check	✅ Passed	The description matches the changeset by describing new XLSX spreadsheet reading support.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch excel

---

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

_{Comment @coderabbitai help to get the list of available commands.}

[amotl]

Just a few more comments from self-review.

[amotl]

Forwarding omniload reader hints to Polars read_xyz kwargs 1:1 currently just barely works for string argument types, so this basic implementation does not support forwarding all arguments just yet.

Because no type conversion takes place, it is currently not possible to convey int, float, bool, or container types. It could be another candidate for a more thorough approach using Pydantic in the long run.

Short-term, in order to forward all kwargs to polars.read_excel properly, let's either supply a custom mapper, or introspect the target read_excel function to learn about relevant types at runtime to be able to automatically cast them to their expected types.

For list and dict types, let's use compact JSON as serialized representation (no whitespace), when possible.

[amotl]

• Deferred to Filesystem: Properly forward omniload reader hints to Polars read_xyz kwargs #214

[amotl]

Not all arguments of polars.read_excel can be forwarded yet. Currently, that works only for str types, see my last comment.