hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-27 20:33:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

Simplify handling of wrapper classes and exception flow + improve qldoc and annotate tests.

Browse Source
This commit is contained in:
Joe Farebrother
2025-03-20 09:52:56 +00:00
parent f8a0b1c5f9
commit b2acfbcf87
5 changed files with 38 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
python/ql/src/Resources/FileNotAlwaysClosed.qhelp
View File

@@ -4,13 +4,16 @@
<qhelp>
<overview>
<p>When a file is opened, it should always be closed. Failure to close files could result in loss of data or resource leaks.</p>
<p>When a file is opened, it should always be closed.
</p>
<p>A file opened for writing that is not closed when the application exits may result in data loss, where not all of the data written may be saved to the file.
A file opened for reading or writing that is not closed may also use up file descriptors, which is a resource leak that in long running applications could lead to a failure to open additional files.
</p>
</overview>
<recommendation>
<p>Ensure that opened files are always closed, including when an exception could be raised.
The best practice is to use a <code>with</code> statement to automatically clean up resources.
The best practice is often to use a <code>with</code> statement to automatically clean up resources.
Otherwise, ensure that <code>.close()</code> is called in a <code>try...except</code> or <code>try...finally</code>
block to handle any possible exceptions.
</p>