bpo-29110: Fix file object leak in `aifc.open`. #162

Uberi · 2017-02-18T23:42:12Z

When given an invalid AIFF file, aifc.open doesn't clean up after itself. This patch makes it close the file object if it was opened by the library.

Also, it adds one unit test, test.aifc_test.AifcMiscTest.test_close_opened_files_on_error. The patch can be verified with ./python -m test -j0 test_aifc.

methane · 2017-02-21T12:51:03Z

Lib/test/test_aifc.py

+                # that `aifc.open` will fail.
+                f = self.f = aifc.open(non_aifc_file, 'rb')
+            except:
+                pass


Could you use with self.assertRaises(aifc.Error): instead of try ~ except: pass?

methane

Please add an entry at Lib section in Misc/NEWS.

methane · 2017-02-22T03:23:20Z

Lib/test/test_aifc.py

@@ -1,4 +1,4 @@
-from test.support import findfile, TESTFN, unlink
+from test.support import check_no_resource_warning, findfile, TESTFN, unlink


Please wrap at 79 columns

It seems to be 77 characters over here. Is there something I'm missing?

Uh, I'm sorry. no problem.

methane · 2017-02-22T03:23:20Z

Lib/test/test_aifc.py

+        with check_no_resource_warning(self):
+            with self.assertRaises(aifc.Error):
+                # Try opening a non-AIFC file, with the expectation
+                # that `aifc.open` will fail (without raising a ResourceWarning)


Uberi · 2017-02-22T05:01:32Z

Rebased and squashed on upstream, added NEWS entry, and fixed the style thing noted above!

methane · 2017-02-22T05:12:10Z

Misc/NEWS

@@ -242,6 +242,9 @@ Library
 - bpo-29532: Altering a kwarg dictionary passed to functools.partial()
  no longer affects a partial object after creation.

+- bpo-29110: Fix file object leak in aifc.open() when file is given as a
+  filesystem path and is not in valid AIFF format.
+


Please add credit like Patch by <your name> at the end.

…F file.

Uberi · 2017-02-22T05:15:26Z

Added and squashed!

methane · 2017-02-22T05:25:07Z

We use "Squash and merge" in Github. So squash is not needed for next time.
Normal commit make it easy to review changes from last commit.

BTW, since this is bugfix, would you create backport (cherry-pick) pull request for 3.5 and 3.6 branch?
I can do it for you, but "cherry pick + pull request + squash merge" workflow drops original author.

serhiy-storchaka · 2017-02-23T10:53:21Z

Lib/aifc.py

+                raise
+
+            # treat .aiff file extensions as non-compressed audio
+            if f.endswith('.aiff'):


This is unrelated change and it introduces a regression. self._aifc is not defined if the file have non .aiff extension.

self.initfp(file_object) initializes self._aifc = 1.

Ah, sorry, I missed this. It would be better to write just self._aifc = not f.endswith('.aiff') if you want to modernize this code.

But now it looks to me that initfp() never fails. All changes of Aifc_write were not needed.

MemoryError and MaxRecursionError can happen, but that's very unlikely and hard to test.
That's why I didn't request testing Aifc_write.

serhiy-storchaka · 2017-02-23T10:58:11Z

Lib/test/test_aifc.py

@@ -149,6 +149,14 @@ def test_skipunknown(self):
        #This file contains chunk types aifc doesn't recognize.
        self.f = aifc.open(findfile('Sine-1000Hz-300ms.aif'))

+    def test_close_opened_files_on_error(self):


The test tests only Aifc_read. Needed a test for Aifc_write.

Is it possible to make tests common for aifc, sunau and wave?

#293 adds test for Aifc_write.

Since this type of test is depending on implementation (raise Exception on Edge case),
I didn't tried to make this generic.

follow up of GH-162

…F file. (pythonGH-162) (cherry picked from commit 03f68b6)

follow up of pythonGH-162 (cherry picked from commit 5dc33ee)

…F file. (pythonGH-162) (cherry picked from commit 03f68b6)

follow up of pythonGH-162 (cherry picked from commit 5dc33ee)

(cherry picked from commit 03f68b6) (GH-162) (cherry picked from commit 5dc33ee) (GH-293)

Fixes #162

the-knights-who-say-ni added the CLA signed label Feb 18, 2017

serhiy-storchaka added the type-bug An unexpected behavior, bug, or error label Feb 19, 2017

methane reviewed Feb 21, 2017

View changes

methane requested changes Feb 22, 2017

View changes

Uberi force-pushed the bpo-29110 branch from 932ef31 to 96fa443 Compare Feb 22, 2017

methane reviewed Feb 22, 2017

View changes

bpo-29110: Fix file object leak in aifc.open when given invalid AIF…

e09c582

…F file.

Uberi force-pushed the bpo-29110 branch from 96fa443 to e09c582 Compare Feb 22, 2017

methane approved these changes Feb 22, 2017

View changes

methane added needs backport to 3.5 labels Feb 22, 2017

methane merged commit 03f68b6 into python:master Feb 22, 2017

serhiy-storchaka reviewed Feb 23, 2017

View changes

methane added a commit that referenced this pull request Feb 26, 2017

bpo-29110: add test for Aifc_write. (GH-293)

5dc33ee

follow up of GH-162

methane pushed a commit to methane/cpython that referenced this pull request Feb 26, 2017

bpo-29110: Fix file object leak in aifc.open when given invalid AIF…

0a8c34e

…F file. (pythonGH-162) (cherry picked from commit 03f68b6)

methane added a commit to methane/cpython that referenced this pull request Feb 26, 2017

bpo-29110: add test for Aifc_write. (pythonGH-293)

09d29fc

follow up of pythonGH-162 (cherry picked from commit 5dc33ee)

This was referenced Feb 26, 2017

[3.6] bpo-29110: Fix file object leak in aifc.open #310

Merged

[3.5] bpo-29110: Fix file object leak in aifc.open #311

Merged

methane pushed a commit to methane/cpython that referenced this pull request Feb 26, 2017

bpo-29110: Fix file object leak in aifc.open when given invalid AIF…

c9cb89d

…F file. (pythonGH-162) (cherry picked from commit 03f68b6)

methane added a commit to methane/cpython that referenced this pull request Feb 26, 2017

bpo-29110: add test for Aifc_write. (pythonGH-293)

7d3913a

follow up of pythonGH-162 (cherry picked from commit 5dc33ee)

methane added a commit that referenced this pull request Feb 26, 2017

[3.6] bpo-29110: Fix file object leak in aifc.open (#310)

c9131b6

(cherry picked from commit 03f68b6) (GH-162) (cherry picked from commit 5dc33ee) (GH-293)

methane removed the needs backport to 3.6 label Feb 26, 2017

methane added a commit that referenced this pull request Feb 26, 2017

bpo-29110: Fix file object leak in aifc.open (GH-311)

b7fb1e2

(cherry picked from commit 03f68b6) (GH-162) (cherry picked from commit 5dc33ee) (GH-293)

methane removed the needs backport to 3.5 label Feb 26, 2017

methane mentioned this pull request Feb 28, 2017

[2.7] bpo-29110: Fix file object leak in aifc.open #356

Merged

jaraco pushed a commit that referenced this pull request Dec 2, 2022

Remove BPO link and strip newlines from commit body (#314)

dfb0d1f

Fixes #162

bpo-29110: Fix file object leak in `aifc.open`. #162

bpo-29110: Fix file object leak in `aifc.open`. #162

Uberi commented Feb 18, 2017

methane Feb 21, 2017

Uberi Feb 21, 2017

methane left a comment

methane Feb 22, 2017

Uberi Feb 22, 2017

methane Feb 22, 2017

methane Feb 22, 2017

Uberi commented Feb 22, 2017

methane Feb 22, 2017

Uberi commented Feb 22, 2017

methane commented Feb 22, 2017

serhiy-storchaka Feb 23, 2017

methane Feb 23, 2017 •

edited

serhiy-storchaka Feb 23, 2017

methane Feb 23, 2017

serhiy-storchaka Feb 23, 2017

methane Feb 25, 2017

		@@ -1,4 +1,4 @@
		from test.support import findfile, TESTFN, unlink
		from test.support import check_no_resource_warning, findfile, TESTFN, unlink

bpo-29110: Fix file object leak in aifc.open. #162

bpo-29110: Fix file object leak in aifc.open. #162

Conversation

Uberi commented Feb 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

methane left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uberi commented Feb 22, 2017

Choose a reason for hiding this comment

Uberi commented Feb 22, 2017

methane commented Feb 22, 2017

Choose a reason for hiding this comment

methane Feb 23, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bpo-29110: Fix file object leak in `aifc.open`. #162

bpo-29110: Fix file object leak in `aifc.open`. #162

methane Feb 23, 2017 •

edited