-
Notifications
You must be signed in to change notification settings - Fork 62
Fix file handle leaks in DFS/DFSU readers and generic functions #921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
8
commits into
main
Choose a base branch
from
copilot/fix-file-handle-leak
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
41e8275
Initial plan
Copilot 962bd06
Close file handles after use to prevent resource leaks
Copilot 8f56eff
Improve file handle leak tests to properly expose the bug
Copilot 7b1b10e
Use try-finally in sanity check test to ensure file handle is closed
Copilot c33343e
Move file handle leak tests into existing test files
Copilot 0c4ebba
Add Dfs2 file handle leak tests to test_dfs2.py
Copilot b09f230
Fix test_dfs2_read_closes_file_handle failing in isolation
Copilot 9613ce5
Merge remote-tracking branch 'origin/main' into copilot/fix-file-hand…
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| """Tests verifying that file handles are properly closed after use.""" | ||
|
|
||
| import gc | ||
| import os | ||
| import platform | ||
|
|
||
| import pytest | ||
|
|
||
| import mikeio | ||
|
|
||
|
|
||
| def _count_open_fds() -> int: | ||
| """Count open file descriptors on Linux via /proc/self/fd.""" | ||
| return len(os.listdir("/proc/self/fd")) | ||
|
|
||
|
|
||
| pytestmark = pytest.mark.skipif( | ||
| platform.system() != "Linux", | ||
| reason="File descriptor counting via /proc only works on Linux", | ||
| ) | ||
|
|
||
|
|
||
| def test_dfs1_init_closes_file_handle() -> None: | ||
| gc.collect() | ||
| baseline = _count_open_fds() | ||
| for _ in range(50): | ||
| mikeio.Dfs1("tests/testdata/random.dfs1") | ||
| gc.collect() | ||
| assert _count_open_fds() - baseline == 0 | ||
|
|
||
|
|
||
| def test_dfs3_init_closes_file_handle() -> None: | ||
| gc.collect() | ||
| baseline = _count_open_fds() | ||
| for _ in range(50): | ||
| mikeio.Dfs3("tests/testdata/Grid1.dfs3") | ||
| gc.collect() | ||
| assert _count_open_fds() - baseline == 0 | ||
|
|
||
|
|
||
| def test_dfsu_read_closes_file_handle() -> None: | ||
| gc.collect() | ||
| baseline = _count_open_fds() | ||
| for _ in range(50): | ||
| dfs = mikeio.open("tests/testdata/HD2D.dfsu") | ||
| dfs.read() | ||
| gc.collect() | ||
| assert _count_open_fds() - baseline == 0 | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check that _count_open_fds() is actually working as expected
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added
test_count_open_fds_sanity_checkin 8f56eff which verifies that_count_open_fds()detects mikecore file handles: opening aDfsFileincreases the FD count by 1, and closing it restores it. Also updated the other tests to hold references to the created instances (preventing GC from masking the leak) and removedgc.collect()before assertions so leaks are caught deterministically.