Skip to content

Conversation

@mwouts
Copy link
Owner

@mwouts mwouts commented Sep 1, 2025

Closes #437

@github-actions
Copy link

github-actions bot commented Sep 1, 2025

Thank you for making this pull request.

Did you know? You can try it on Binder: Binder:lab.

Also, the version of ITables developed in this PR is available as a wheel artifact 📦 for easy installation.
Download it here, unzip it and then run pip install itables-xxx.whl in the unzipped directory.

@codecov-commenter
Copy link

codecov-commenter commented Sep 1, 2025

Codecov Report

❌ Patch coverage is 72.72727% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.03%. Comparing base (0960e88) to head (87f4f50).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/itables/show_config.py 50.00% 2 Missing ⚠️
src/itables/config.py 83.33% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #439      +/-   ##
==========================================
- Coverage   94.12%   94.03%   -0.10%     
==========================================
  Files          43       43              
  Lines        1873     1878       +5     
==========================================
+ Hits         1763     1766       +3     
- Misses        110      112       +2     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mwouts mwouts force-pushed the platformdirs_as_extra_dependency branch from cdae3e0 to f0119f4 Compare September 1, 2025 23:22
@mwouts mwouts requested a review from Copilot September 1, 2025 23:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR makes platformdirs an optional dependency to resolve issue #437. The change allows ITables to gracefully handle cases where the platformdirs library is not installed, while still providing the configuration file functionality when the optional dependencies are available.

  • Adds platformdirs to the optional config dependencies group
  • Implements graceful fallback when platformdirs is not available
  • Updates documentation to clarify the optional dependency requirement

Reviewed Changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/itables/version.py Bumps version to 2.5.2-dev
src/itables/config.py Adds try/except for platformdirs import and guards user_config_path usage
src/itables/show_config.py Adds dependency check and user-friendly error message
pyproject.toml Adds platformdirs to config optional dependencies
docs/py/options/options.py Updates documentation to mention optional dependencies
docs/options/options.md Updates documentation to mention optional dependencies
docs/changelog.md Documents the fix in changelog

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@mwouts mwouts merged commit 282e22c into main Sep 1, 2025
13 checks passed
@mwouts mwouts deleted the platformdirs_as_extra_dependency branch September 1, 2025 23:30
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.

[platformdirs](https://pypi.org/project/platformdirs/) should be added as a dependency:

3 participants