Skip to content

Conversation

@mwouts
Copy link
Owner

@mwouts mwouts commented Aug 31, 2025

The location and content of the ITables configuration file corresponding to a given directory is given by python -m itables.show_config.

@mwouts mwouts added this to the 2.5.0 milestone Aug 31, 2025
@github-actions
Copy link

github-actions bot commented Aug 31, 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 Aug 31, 2025

Codecov Report

❌ Patch coverage is 93.61702% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 88.09%. Comparing base (3c83bd7) to head (b5e5685).

Files with missing lines Patch % Lines
src/itables/config.py 75.00% 2 Missing ⚠️
src/itables/show_config.py 92.30% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #434      +/-   ##
==========================================
+ Coverage   88.03%   88.09%   +0.06%     
==========================================
  Files          52       54       +2     
  Lines        2106     2142      +36     
==========================================
+ Hits         1854     1887      +33     
- Misses        252      255       +3     

☔ 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 requested a review from Copilot August 31, 2025 21:02
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 adds a new command-line utility to display ITables configuration file location and contents, accessible via python -m itables.show_config. It also improves error handling in the configuration loading process.

  • Adds a new show_config module with functionality to display configuration file location and parsed options
  • Enhances error handling in load_config_file with more descriptive error messages for parsing and validation failures
  • Updates documentation to inform users about the new configuration inspection command

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
src/itables/show_config.py New module implementing the show_config functionality
src/itables/config.py Enhanced error handling with try-catch blocks and descriptive error messages
src/itables/init.py Exports the config module for public API access
tests/test_show_config.py Test coverage for the new show_config functionality
tests/test_config.py Added test for improved error handling and removed duplicate fixture
tests/conftest.py Moved shared fixture to conftest for reuse across test modules
docs/options/options.md Documentation update explaining the new show_config command
docs/py/options/options.py Documentation update in Python format

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

@mwouts mwouts force-pushed the config_file_documentation branch from 80a5490 to b5e5685 Compare August 31, 2025 21:14
@mwouts mwouts merged commit 5eb76d1 into main Aug 31, 2025
14 checks passed
@mwouts mwouts deleted the config_file_documentation branch August 31, 2025 21:23
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.

3 participants