Merged
Conversation
Rename "example_folder" to "data_folder"
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds automatic testing for the InOutModule by introducing a new test suite for ExcelReader/ExcelWriter, updating import statements to use relative paths instead of the InOutModule package prefix, and adding a CI workflow to run tests across multiple OS environments.
- Introduces tests for reading and writing Excel files.
- Updates module import paths to use relative imports.
- Adds a CI pipeline configuration.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| tests/test_ExcelReaderWriter.py | Adds tests for ExcelReader and ExcelWriter functionality. |
| printer.py | Moves a pyomo import to an internal scope to prevent circular imports. |
| environment.yml | Provides environment configuration for dependencies. |
| ExcelWriter.py | Updates import references and the cell style method signature. |
| ExcelReader.py | Updates import references for Printer. |
| CaseStudy.py | Refactors parameter name from example_folder to data_folder. |
| .github/workflows/ci.yaml | Adds CI workflow to run tests on multiple OS platforms. |
Comments suppressed due to low confidence (2)
CaseStudy.py:13
- The parameter was renamed from 'example_folder' to 'data_folder' in the signature, but corresponding docstrings or inline comments might not reflect this update. Consider reviewing and updating any documentation or comments to maintain consistency.
def __init__(self, data_folder: str, do_not_merge_single_node_buses: bool = False,
tests/test_ExcelReaderWriter.py:10
- [nitpick] The variable name 'ew' could be made more descriptive (e.g., 'excel_writer') to improve readability in the test code.
ew = ExcelWriter()
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.