Skip to content

feat!: move fastexcel to optional [excel] extra - #302

Open
ArdaTkn wants to merge 1 commit into
SkyeAv:mainfrom
ArdaTkn:feat/excel-extra
Open

ArdaTkn wants to merge 1 commit into
SkyeAv:mainfrom
ArdaTkn:feat/excel-extra

Conversation

@ArdaTkn

@ArdaTkn ArdaTkn commented Nov 19, 2026

Copy link
Copy Markdown
Contributor

Closes #300.

Summary

  • Move fastexcel>=0.21.0 from project.dependencies to [project.optional-dependencies].excel in pyproject.toml and regenerate uv.lock.
  • Register "excel": {"fastexcel": "fastexcel"} in EXTRA_PACKAGES and "excel": "Excel input" in FEATURES in src/tablassert/extras.py.
  • Preflight extras.require("excel", required_by="Excel input") in lib.excel() only when engine == "calamine", raising MissingExtraError before calling pl.read_excel() while leaving explicit engines such as openpyxl independent.
  • Add --extra excel to Makefile, .github/workflows/ci.yml, .github/workflows/security.yml, CONTRIBUTING.md, README.md, docs/installation.md, and llms.txt, and add an Unreleased ### Changed entry in CHANGELOG.md.
  • Extend tests/test_extras.py and tests/test_cover_lib.py with [excel] registry coverage, MissingExtraError preflight checks, and openpyxl independence when fastexcel is absent.

Local gate

  • uv lock --check: pass
  • scripts/check_changelog.py --base upstream/main: PASS
  • ruff check . / ruff format --check src tests docs: clean
  • pyright: 0 errors
  • vulture / deptry .: clean
  • mkdocs build --strict: clean
  • pytest tests/test_extras.py tests/test_cover_lib.py tests/test_docs_source_of_truth.py tests/test_docs_style.py: 255 passed

@coderabbitai

coderabbitai Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: be589676-bdb7-4ef8-9c7a-4300dd0587cf
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@SkyeAv SkyeAv left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks for the contribution, @ArdaTkn! The extra, the preflight check and the tests look good, and CI passes. One docs update before merging:

  • Excel Source docs: docs/configuration/table.md:90 should say that kind: excel with the default calamine engine now needs tablassert[excel]. Config authors will look there first, and tablassert[cli] users with Excel tables will hit MissingExtraError after upgrading. A short note with the install command and a link to the extras section in docs/installation.md would cover it.

Thanks again!

@ArdaTkn

ArdaTkn commented Nov 19, 2026

Copy link
Copy Markdown
Contributor Author

Added the [excel] extra callout under #### Excel Source in docs/configuration/table.md (e2e1e85), noting the pip install "tablassert[excel]" / uv tool install "tablassert[excel]" requirement for the default calamine engine and linking to docs/installation.md#optional-extras.

Verified locally with mkdocs build --strict and pytest tests/test_docs_style.py tests/test_docs_source_of_truth.py (203 passed).

@SkyeAv

SkyeAv commented Nov 20, 2026

Copy link
Copy Markdown
Owner

Thanks, @ArdaTkn! The Excel Source callout looks good. I found two remaining setup commands that need --extra excel so fresh development installs include fastexcel:

  • docs/development.md:11: append --extra excel to the uv sync command.
  • AGENTS.md:7: make the same update in the expanded make setup command.

Both currently end at --extra log; they should match the updated Makefile and CONTRIBUTING.md instructions. The functional checks are green, so this should be ready after these two documentation fixes.

This branch has not been deployed

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

move fastexcel to an optional [excel] extra with missing-extra checks

2 participants