Codestin Search App

radarhere · 2023-11-24T04:28:27Z

At the moment,

from PIL import Image
with Image.new("L", (1, 1)) as im:
  print(hasattr(im, "fp"))
print(hasattr(im, "fp"))

gives

False
True

im does not have an fp attribute inside the context manager, but once it leaves, it is set.

This PR keeps it unset.

akx · 2023-11-29T07:34:29Z

+        if hasattr(self, "fp"):
+            if getattr(self, "_exclusive_fp", False):
+                if getattr(self, "_fp", False):
+                    if self._fp != self.fp:
+                        self._fp.close()
+                    self._fp = DeferredError(ValueError("Operation on closed image"))
+                if self.fp:
+                    self.fp.close()
+            self.fp = None


Might be easier to read if the outermost layer of the pyramid was negated?

Suggested change

if hasattr(self, "fp"):

if getattr(self, "_exclusive_fp", False):

if getattr(self, "_fp", False):

if self._fp != self.fp:

self._fp.close()

self._fp = DeferredError(ValueError("Operation on closed image"))

if self.fp:

self.fp.close()

self.fp = None

if not hasattr(self, "fp"):

return

if getattr(self, "_exclusive_fp", False):

if getattr(self, "_fp", False):

if self._fp != self.fp:

self._fp.close()

self._fp = DeferredError(ValueError("Operation on closed image"))

if self.fp:

self.fp.close()

self.fp = None

Easier to read in isolation, yes, but I kind of like the fact that this version mirrors close() -

Pillow/src/PIL/Image.py

Lines 530 to 565 in 5431b15

def __exit__(self, *args):

if hasattr(self, "fp"):

if getattr(self, "_exclusive_fp", False):

if getattr(self, "_fp", False):

if self._fp != self.fp:

self._fp.close()

self._fp = DeferredError(ValueError("Operation on closed image"))

if self.fp:

self.fp.close()

self.fp = None

def close(self):

"""

Closes the file pointer, if possible.

This operation will destroy the image core and release its memory.

The image data will be unusable afterward.

This function is required to close images that have multiple frames or

have not had their file read and closed by the

:py:meth:`~PIL.Image.Image.load` method. See :ref:`file-handling` for

more information.

"""

if hasattr(self, "fp"):

try:

if getattr(self, "_fp", False):

if self._fp != self.fp:

self._fp.close()

self._fp = DeferredError(ValueError("Operation on closed image"))

if self.fp:

self.fp.close()

self.fp = None

except Exception as msg:

logger.debug("Error closing: %s", msg)

if getattr(self, "map", None):

Should that code be extracted from close() then and reused in both of these places? _close_fp()?

Ok, I've pushed a commit.

akx · 2023-11-29T09:11:06Z

-                self.fp.close()
-        self.fp = None
+        if hasattr(self, "fp"):
+            if getattr(self, "_exclusive_fp", False):


Out of curiosity: does exclusive_fp mean, like I think it does, "we own this fp because we opened it"? If so, does it make sense for .close() to also close FPs that aren't "owned" by this instance?

Out of curiosity: does exclusive_fp mean, like I think it does, "we own this fp because we opened it"?

Yes

Pillow/src/PIL/Image.py

Lines 3250 to 3258 in 697c24b

if filename:

fp = builtins.open(filename, "rb")

exclusive_fp = True

try:

fp.seek(0)

except (AttributeError, io.UnsupportedOperation):

fp = io.BytesIO(fp.read())

exclusive_fp = True

If so, does it make sense for .close() to also close FPs that aren't "owned" by this instance?

See #5309

Do not assign new fp attribute to image when exiting context manager

5431b15

radarhere changed the title ~~Do not assign new fp attribute to image when exiting context manager~~ Do not assign new fp attribute when exiting context manager Nov 24, 2023

akx reviewed Nov 29, 2023

View reviewed changes

Moved code closing fp and _fp into common method

5fb86c5

akx reviewed Nov 29, 2023

View reviewed changes

hugovk merged commit d71cf16 into python-pillow:main Dec 31, 2023

radarhere deleted the exit branch January 1, 2024 02:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Do not assign new fp attribute when exiting context manager#7566

Do not assign new fp attribute when exiting context manager#7566
hugovk merged 2 commits into
python-pillow:mainfrom
radarhere:exit

radarhere commented Nov 24, 2023

Uh oh!

akx Nov 29, 2023

Uh oh!

radarhere Nov 29, 2023

Uh oh!

akx Nov 29, 2023

Uh oh!

radarhere Nov 29, 2023

Uh oh!

akx Nov 29, 2023

Uh oh!

radarhere Nov 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	def __exit__(self, *args):
	if hasattr(self, "fp"):
	if getattr(self, "_exclusive_fp", False):
	if getattr(self, "_fp", False):
	if self._fp != self.fp:
	self._fp.close()
	self._fp = DeferredError(ValueError("Operation on closed image"))
	if self.fp:
	self.fp.close()
	self.fp = None

	def close(self):
	"""
	Closes the file pointer, if possible.

	This operation will destroy the image core and release its memory.
	The image data will be unusable afterward.

	This function is required to close images that have multiple frames or
	have not had their file read and closed by the
	:py:meth:`~PIL.Image.Image.load` method. See :ref:`file-handling` for
	more information.
	"""
	if hasattr(self, "fp"):
	try:
	if getattr(self, "_fp", False):
	if self._fp != self.fp:
	self._fp.close()
	self._fp = DeferredError(ValueError("Operation on closed image"))
	if self.fp:
	self.fp.close()
	self.fp = None
	except Exception as msg:
	logger.debug("Error closing: %s", msg)

	if getattr(self, "map", None):

	if filename:
	fp = builtins.open(filename, "rb")
	exclusive_fp = True

	try:
	fp.seek(0)
	except (AttributeError, io.UnsupportedOperation):
	fp = io.BytesIO(fp.read())
	exclusive_fp = True

Uh oh!

Uh oh!

Conversation

radarhere commented Nov 24, 2023

Uh oh!

akx Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

radarhere Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

akx Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

radarhere Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

akx Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

radarhere Nov 29, 2023

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants